chore: wip

Author: glennmichael123

storage/framework/core/commerce/src/gift-cards/destroy.ts

@@ -0,0 +1,86 @@
+import { db } from '@stacksjs/database'
+import { fetchById } from './fetch'
+
+/**
+ * Delete a gift card by ID
+ * @param id The ID of the gift card to delete
+ * @returns A boolean indicating whether the deletion was successful
+ */
+export async function remove(id: number): Promise<boolean> {
+  // First check if the gift card exists
+  const giftCard = await fetchById(id)
+
+  if (!giftCard) {
+    throw new Error(`Gift card with ID ${id} not found`)
+  }
+
+  // Delete the gift card
+  const result = await db
+    .deleteFrom('gift_cards')
+    .where('id', '=', id)
+    .executeTakeFirst()
+
+  return !!result
+}
+
+/**
+ * Bulk delete multiple gift cards
+ * @param ids Array of gift card IDs to delete
+ * @returns Number of gift cards successfully deleted
+ */
+export async function bulkRemove(ids: number[]): Promise<number> {
+  if (!ids.length) {
+    return 0
+  }
+
+  // Delete all gift cards in the array
+  const result = await db
+    .deleteFrom('gift_cards')
+    .where('id', 'in', ids)
+    .executeTakeFirst()
+
+  return Number(result?.numDeletedRows) || 0
+}
+
+/**
+ * Delete expired gift cards
+ * @returns Number of gift cards deleted
+ */
+export async function removeExpired(): Promise<number> {
+  const currentDate = new Date().toISOString().split('T')[0]
+
+  // Delete expired gift cards
+  const result = await db
+    .deleteFrom('gift_cards')
+    .where('expiry_date', '<', currentDate)
+    .executeTakeFirst()
+
+  return Number(result?.numDeletedRows) || 0
+}
+
+/**
+ * Deactivate a gift card (set is_active to false)
+ * @param id The ID of the gift card to deactivate
+ * @returns A boolean indicating whether the deactivation was successful
+ */
+export async function deactivate(id: number): Promise<boolean> {
+  // First check if the gift card exists
+  const giftCard = await fetchById(id)
+
+  if (!giftCard) {
+    throw new Error(`Gift card with ID ${id} not found`)
+  }
+
+  // Update the gift card status
+  const result = await db
+    .updateTable('gift_cards')
+    .set({
+      is_active: false,
+      status: 'DEACTIVATED',
+      updated_at: new Date(),
+    })
+    .where('id', '=', id)
+    .executeTakeFirst()
+
+  return !!result
+}

storage/framework/core/commerce/src/gift-cards/index.ts

@@ -0,0 +1,35 @@
+// Export types that might be needed elsewhere
+export type {
+  GiftCardJsonResponse,
+  GiftCardsTable,
+  NewGiftCard,
+} from '../../../../orm/src/models/GiftCard'
+
+// Export functions from delete.ts
+export {
+  bulkRemove,
+  deactivate,
+  remove,
+  removeExpired,
+} from './destroy'
+
+// Export functions from fetch.ts
+export {
+  checkBalance,
+  fetchActive,
+  fetchByCode,
+  fetchById,
+  fetchPaginated,
+  fetchStats,
+} from './fetch'
+
+// Export functions from store.ts
+export {
+  store,
+} from './store'
+
+// Export functions from update.ts
+export {
+  update,
+  updateBalance,
+} from './update'

storage/framework/core/commerce/src/gift-cards/store.ts

@@ -0,0 +1,63 @@
+import type { GiftCardRequestType } from '@stacksjs/orm'
+import type { GiftCardJsonResponse, NewGiftCard } from '../../../../orm/src/models/GiftCard'
+import { db } from '@stacksjs/database'
+
+/**
+ * Create a new gift card
+ *
+ * @param request The gift card data to store
+ * @returns The newly created gift card record
+ */
+export async function store(request: GiftCardRequestType): Promise<GiftCardJsonResponse | undefined> {
+  await request.validate()
+
+  const giftCardData: NewGiftCard = {
+    code: request.get<string>('code'),
+    initial_balance: request.get<number>('initial_balance'),
+    current_balance: request.get<number>('initial_balance'), // Initially set to same as initial balance
+    currency: request.get<string>('currency'),
+    status: request.get<string>('status') || 'ACTIVE',
+    user_id: request.get<number>('user_id'),
+    purchaser_id: request.get<string>('purchaser_id'),
+    recipient_email: request.get<string>('recipient_email'),
+    recipient_name: request.get<string>('recipient_name'),
+    personal_message: request.get<string>('personal_message'),
+    is_digital: request.get<boolean>('is_digital'),
+    is_reloadable: request.get<boolean>('is_reloadable'),
+    is_active: request.get<boolean>('is_active') ?? true,
+    expiry_date: request.get<string>('expiry_date'),
+    template_id: request.get<string>('template_id'),
+  }
+
+  try {
+    // Insert the gift card record
+    const createdGiftCard = await db
+      .insertInto('gift_cards')
+      .values(giftCardData)
+      .executeTakeFirst()
+
+    // If insert was successful, retrieve the newly created gift card
+    if (createdGiftCard.insertId) {
+      const giftCard = await db
+        .selectFrom('gift_cards')
+        .where('id', '=', Number(createdGiftCard.insertId))
+        .selectAll()
+        .executeTakeFirst()
+
+      return giftCard
+    }
+
+    return undefined
+  }
+  catch (error) {
+    if (error instanceof Error) {
+      if (error.message.includes('Duplicate entry') && error.message.includes('code')) {
+        throw new Error('A gift card with this code already exists')
+      }
+
+      throw new Error(`Failed to create gift card: ${error.message}`)
+    }
+
+    throw error
+  }
+}

storage/framework/core/commerce/src/gift-cards/update.ts

@@ -0,0 +1,131 @@
+import type { GiftCardRequestType } from '@stacksjs/orm'
+import type { GiftCardJsonResponse } from '../../../../orm/src/models/GiftCard'
+import { db } from '@stacksjs/database'
+import { fetchById } from './fetch'
+
+/**
+ * Update a gift card by ID
+ *
+ * @param id The ID of the gift card to update
+ * @param request The updated gift card data
+ * @returns The updated gift card record
+ */
+export async function update(id: number, request: GiftCardRequestType): Promise<GiftCardJsonResponse | undefined> {
+  // Validate the request data
+  await request.validate()
+
+  // Check if gift card exists
+  const existingGiftCard = await fetchById(id)
+  if (!existingGiftCard) {
+    throw new Error(`Gift card with ID ${id} not found`)
+  }
+
+  // Create update data object using request fields
+  const updateData: Record<string, any> = {
+    code: request.get<string>('code'),
+    initial_balance: request.get<number>('initial_balance'),
+    current_balance: request.get<number>('current_balance'),
+    currency: request.get<string>('currency'),
+    status: request.get<string>('status'),
+    user_id: request.get<number>('user_id'),
+    purchaser_id: request.get<string>('purchaser_id'),
+    recipient_email: request.get<string>('recipient_email'),
+    recipient_name: request.get<string>('recipient_name'),
+    personal_message: request.get<string>('personal_message'),
+    is_digital: request.get<boolean>('is_digital'),
+    is_reloadable: request.get<boolean>('is_reloadable'),
+    is_active: request.get<boolean>('is_active'),
+    expiry_date: request.get<string>('expiry_date'),
+    last_used_date: request.get<string>('last_used_date'),
+    template_id: request.get<string>('template_id'),
+    updated_at: new Date(),
+  }
+
+  // Remove undefined fields to avoid overwriting with null values
+  Object.keys(updateData).forEach((key) => {
+    if (updateData[key] === undefined) {
+      delete updateData[key]
+    }
+  })
+
+  // If no fields to update, just return the existing gift card
+  if (Object.keys(updateData).length === 0) {
+    return existingGiftCard
+  }
+
+  try {
+    // Update the gift card
+    await db
+      .updateTable('gift_cards')
+      .set(updateData)
+      .where('id', '=', id)
+      .execute()
+
+    // Fetch and return the updated gift card
+    return await fetchById(id)
+  }
+  catch (error) {
+    if (error instanceof Error) {
+      // Handle duplicate code error
+      if (error.message.includes('Duplicate entry') && error.message.includes('code')) {
+        throw new Error('A gift card with this code already exists')
+      }
+
+      throw new Error(`Failed to update gift card: ${error.message}`)
+    }
+
+    throw error
+  }
+}
+
+/**
+ * Update a gift card's balance
+ *
+ * @param id The ID of the gift card
+ * @param amount The amount to adjust (positive to add, negative to deduct)
+ * @returns The updated gift card with new balance
+ */
+export async function updateBalance(id: number, amount: number): Promise<GiftCardJsonResponse | undefined> {
+  // Check if gift card exists and is active
+  const giftCard = await fetchById(id)
+
+  if (!giftCard) {
+    throw new Error(`Gift card with ID ${id} not found`)
+  }
+
+  if (!giftCard.is_active || giftCard.status !== 'ACTIVE') {
+    throw new Error(`Gift card is not active`)
+  }
+
+  // Calculate new balance
+  const newBalance = giftCard.current_balance + amount
+
+  // Make sure balance doesn't go below zero
+  if (newBalance < 0) {
+    throw new Error(`Insufficient gift card balance`)
+  }
+
+  try {
+    // Update the gift card balance
+    await db
+      .updateTable('gift_cards')
+      .set({
+        current_balance: newBalance,
+        last_used_date: new Date().toISOString(),
+        status: newBalance === 0 ? 'USED' : 'ACTIVE',
+        updated_at: new Date(),
+      })
+      .where('id', '=', id)
+      .execute()
+
+    // Fetch the updated gift card
+    return await fetchById(id)
+  }
+  catch (error) {
+    if (error instanceof Error) {
+      throw new TypeError(`Failed to update gift card balance: ${error.message}`)
+    }
+
+    throw error
+  }
+}