chore: wip

Author: glennmichael123

storage/framework/core/commerce/src/payments/fetch.ts

@@ -0,0 +1,258 @@
+import { db, sql } from '@stacksjs/database'
+
+/**
+ * Payment statistics response interface
+ */
+export interface PaymentStats {
+  total_transactions: number
+  total_revenue: number
+  average_transaction: number
+  successful_rate: number
+  comparison: {
+    transactions: {
+      difference: number
+      percentage: number
+      is_increase: boolean
+    }
+    revenue: {
+      difference: number
+      percentage: number
+      is_increase: boolean
+    }
+    average: {
+      difference: number
+      percentage: number
+      is_increase: boolean
+    }
+  }
+}
+
+/**
+ * Fetch payment statistics for a specific time period
+ *
+ * @param daysRange Number of days to look back (7, 30, 60, etc.)
+ */
+export async function fetchPaymentStats(daysRange: number = 30): Promise<PaymentStats> {
+  const today = new Date()
+
+  // Current period (last N days)
+  const currentPeriodStart = new Date(today)
+  currentPeriodStart.setDate(today.getDate() - daysRange)
+
+  // Previous period (N days before the current period)
+  const previousPeriodEnd = new Date(currentPeriodStart)
+  previousPeriodEnd.setDate(previousPeriodEnd.getDate() - 1)
+
+  const previousPeriodStart = new Date(previousPeriodEnd)
+  previousPeriodStart.setDate(previousPeriodEnd.getDate() - daysRange)
+
+  // Get current period stats for completed payments
+  const currentStats = await db
+    .selectFrom('payments')
+    .select([
+      db.fn.count('id').as('transaction_count'),
+      db.fn.sum('amount').as('total_revenue'),
+    ])
+    .where('date', '>=', currentPeriodStart)
+    .where('date', '<=', today)
+    .where('status', '=', 'completed')
+    .executeTakeFirst()
+
+  // Get previous period stats for completed payments
+  const previousStats = await db
+    .selectFrom('payments')
+    .select([
+      db.fn.count('id').as('transaction_count'),
+      db.fn.sum('amount').as('total_revenue'),
+    ])
+    .where('date', '>=', previousPeriodStart)
+    .where('date', '<=', previousPeriodEnd)
+    .where('status', '=', 'completed')
+    .executeTakeFirst()
+
+  // Get total transactions count (including non-completed ones) for calculating success rate
+  const totalTransactions = await db
+    .selectFrom('payments')
+    .select(db.fn.count('id').as('count'))
+    .where('date', '>=', currentPeriodStart)
+    .where('date', '<=', today)
+    .executeTakeFirst()
+
+  // Calculate current period stats
+  const currentTransactions = Number(currentStats?.transaction_count || 0)
+  const currentRevenue = Number(currentStats?.total_revenue || 0)
+  const currentAverage = currentTransactions > 0 ? currentRevenue / currentTransactions : 0
+
+  // Calculate previous period stats
+  const previousTransactions = Number(previousStats?.transaction_count || 0)
+  const previousRevenue = Number(previousStats?.total_revenue || 0)
+  const previousAverage = previousTransactions > 0 ? previousRevenue / previousTransactions : 0
+
+  // Calculate differences
+  const transactionDifference = currentTransactions - previousTransactions
+  const revenueDifference = currentRevenue - previousRevenue
+  const averageDifference = currentAverage - previousAverage
+
+  // Calculate percentage changes
+  const transactionPercentage = previousTransactions > 0
+    ? (transactionDifference / previousTransactions) * 100
+    : (currentTransactions > 0 ? 100 : 0)
+
+  const revenuePercentage = previousRevenue > 0
+    ? (revenueDifference / previousRevenue) * 100
+    : (currentRevenue > 0 ? 100 : 0)
+
+  const averagePercentage = previousAverage > 0
+    ? (averageDifference / previousAverage) * 100
+    : (currentAverage > 0 ? 100 : 0)
+
+  // Calculate success rate
+  const allTransactions = Number(totalTransactions?.count || 0)
+  const successRate = allTransactions > 0
+    ? (currentTransactions / allTransactions) * 100
+    : 0
+
+  return {
+    total_transactions: currentTransactions,
+    total_revenue: currentRevenue,
+    average_transaction: currentAverage,
+    successful_rate: successRate,
+    comparison: {
+      transactions: {
+        difference: transactionDifference,
+        percentage: Math.abs(transactionPercentage),
+        is_increase: transactionDifference >= 0,
+      },
+      revenue: {
+        difference: revenueDifference,
+        percentage: Math.abs(revenuePercentage),
+        is_increase: revenueDifference >= 0,
+      },
+      average: {
+        difference: averageDifference,
+        percentage: Math.abs(averagePercentage),
+        is_increase: averageDifference >= 0,
+      },
+    },
+  }
+}
+
+/**
+ * Fetch payment statistics by payment method
+ *
+ * @param daysRange Number of days to look back
+ */
+export async function fetchPaymentStatsByMethod(daysRange: number = 30): Promise<Record<string, {
+  count: number
+  revenue: number
+  percentage_of_total: number
+}>> {
+  const today = new Date()
+  const startDate = new Date(today)
+  startDate.setDate(today.getDate() - daysRange)
+
+  // Get total stats for the period
+  const totalStats = await db
+    .selectFrom('payments')
+    .select([
+      db.fn.count('id').as('total_count'),
+      db.fn.sum('amount').as('total_revenue'),
+    ])
+    .where('date', '>=', startDate)
+    .where('date', '<=', today)
+    .where('status', '=', 'completed')
+    .executeTakeFirst()
+
+  const totalCount = Number(totalStats?.total_count || 0)
+  const totalRevenue = Number(totalStats?.total_revenue || 0)
+
+  // Get stats grouped by payment method
+  const methodStats = await db
+    .selectFrom('payments')
+    .select([
+      'method',
+      db.fn.count('id').as('count'),
+      db.fn.sum('amount').as('revenue'),
+    ])
+    .where('date', '>=', startDate)
+    .where('date', '<=', today)
+    .where('status', '=', 'completed')
+    .groupBy('method')
+    .execute()
+
+  // Format the results
+  const result: Record<string, {
+    count: number
+    revenue: number
+    percentage_of_total: number
+  }> = {}
+
+  methodStats.forEach((item) => {
+    const count = Number(item.count || 0)
+    const revenue = Number(item.revenue || 0)
+    const percentageOfTotal = totalCount > 0 ? (count / totalCount) * 100 : 0
+
+    result[item.method] = {
+      count,
+      revenue,
+      percentage_of_total: percentageOfTotal,
+    }
+  })
+
+  return result
+}
+
+/**
+ * Fetch monthly payment trends for the last 12 months
+ */
+export async function fetchMonthlyPaymentTrends(): Promise<Array<{
+  month: string
+  year: number
+  transactions: number
+  revenue: number
+  average: number
+}>> {
+  // Calculate date 12 months ago
+  const today = new Date()
+  const twelveMonthsAgo = new Date(today)
+  twelveMonthsAgo.setMonth(today.getMonth() - 11)
+
+  // Set to first day of that month
+  twelveMonthsAgo.setDate(1)
+
+  // Use the query builder with expressions instead of raw SQL
+  const monthlyData = await db
+    .selectFrom('payments')
+    .select([
+      sql`EXTRACT(YEAR FROM date)`.as('year'),
+      sql`EXTRACT(MONTH FROM date)`.as('month'),
+      db.fn.count('id').as('transactions'),
+      db.fn.sum('amount').as('revenue'),
+    ])
+    .where('date', '>=', twelveMonthsAgo)
+    .where('status', '=', 'completed')
+    .groupBy(sql`year`)
+    .groupBy(sql`month`)
+    .orderBy('year', 'asc')
+    .orderBy('month', 'asc')
+    .execute()
+
+  // Format the results
+  return monthlyData.map((item) => {
+    const transactions = Number(item.transactions || 0)
+    const revenue = Number(item.revenue || 0)
+    const average = transactions > 0 ? revenue / transactions : 0
+
+    // Format month name
+    const monthDate = new Date(Number(item.year), Number(item.month) - 1, 1)
+    const monthName = monthDate.toLocaleString('default', { month: 'short' })
+
+    return {
+      month: monthName,
+      year: Number(item.year),
+      transactions,
+      revenue,
+      average,
+    }
+  })
+}

storage/framework/defaults/models/Payment.ts

@@ -32,26 +32,6 @@ export default {
   belongsTo: ['Order', 'User'], // For order_id and customer_id
 
   attributes: {
-    order_id: {
-      required: true,
-      order: 1,
-      fillable: true,
-      validation: {
-        rule: schema.string(),
-      },
-      factory: faker => faker.string.uuid(),
-    },
-
-    customer_id: {
-      required: true,
-      order: 2,
-      fillable: true,
-      validation: {
-        rule: schema.string(),
-      },
-      factory: faker => faker.string.uuid(),
-    },
-
     amount: {
       required: true,
       order: 3,

storage/framework/orm/src/models/Payment.ts

@@ -18,7 +18,6 @@ export interface PaymentsTable {
   id: Generated<number>
   order_id: number
   user_id: number
-  order_id: string
   customer_id: string
   amount: number
   method: string
@@ -70,7 +69,7 @@ interface QueryOptions {
 
 export class PaymentModel {
   private readonly hidden: Array<keyof PaymentJsonResponse> = []
-  private readonly fillable: Array<keyof PaymentJsonResponse> = ['order_id', 'customer_id', 'amount', 'method', 'status', 'date', 'currency', 'reference_number', 'card_last_four', 'card_brand', 'billing_email', 'transaction_id', 'payment_provider', 'refund_amount', 'notes', 'uuid']
+  private readonly fillable: Array<keyof PaymentJsonResponse> = ['customer_id', 'amount', 'method', 'status', 'date', 'currency', 'reference_number', 'card_last_four', 'card_brand', 'billing_email', 'transaction_id', 'payment_provider', 'refund_amount', 'notes', 'uuid']
   private readonly guarded: Array<keyof PaymentJsonResponse> = []
   protected attributes = {} as PaymentJsonResponse
   protected originalAttributes = {} as PaymentJsonResponse
@@ -172,10 +171,6 @@ export class PaymentModel {
     return this.attributes.uuid
   }
 
-  get order_id(): string {
-    return this.attributes.order_id
-  }
-
   get customer_id(): string {
     return this.attributes.customer_id
   }
@@ -244,10 +239,6 @@ export class PaymentModel {
     this.attributes.uuid = value
   }
 
-  set order_id(value: string) {
-    this.attributes.order_id = value
-  }
-
   set customer_id(value: string) {
     this.attributes.customer_id = value
   }
@@ -1251,14 +1242,6 @@ export class PaymentModel {
     return instance
   }
 
-  static whereOrderId(value: string): PaymentModel {
-    const instance = new PaymentModel(undefined)
-
-    instance.selectFromQuery = instance.selectFromQuery.where('order_id', '=', value)
-
-    return instance
-  }
-
   static whereCustomerId(value: string): PaymentModel {
     const instance = new PaymentModel(undefined)
 
@@ -1931,7 +1914,6 @@ export class PaymentModel {
       uuid: this.uuid,
 
       id: this.id,
-      order_id: this.order_id,
       customer_id: this.customer_id,
       amount: this.amount,
       method: this.method,
@@ -2005,13 +1987,6 @@ export async function remove(id: number): Promise<void> {
     .execute()
 }
 
-export async function whereOrderId(value: string): Promise<PaymentModel[]> {
-  const query = DB.instance.selectFrom('payments').where('order_id', '=', value)
-  const results: PaymentJsonResponse = await query.execute()
-
-  return results.map((modelItem: PaymentJsonResponse) => new PaymentModel(modelItem))
-}
-
 export async function whereCustomerId(value: string): Promise<PaymentModel[]> {
   const query = DB.instance.selectFrom('payments').where('customer_id', '=', value)
   const results: PaymentJsonResponse = await query.execute()

storage/framework/requests/PaymentRequest.ts

@@ -13,7 +13,6 @@ interface CustomAttributes {
 }
 interface RequestDataPayment {
   id: number
-  order_id: string
   customer_id: string
   amount: number
   method: string
@@ -33,7 +32,6 @@ interface RequestDataPayment {
 }
 export class PaymentRequest extends Request<RequestDataPayment> implements PaymentRequestType {
   public id = 1
-  public order_id = ''
   public customer_id = ''
   public amount = 0
   public method = ''

storage/framework/types/attributes.ts

@@ -29,7 +29,6 @@ export interface Attributes {
   password: string
   title: string
   body: string
-  order_id: string
   customer_id: string
   amount: number
   method: string