@opensaas/stack-core 0.9.0 → 0.11.0

package/src/fields/index.ts

@@ -2,6 +2,7 @@ import { z } from 'zod'
 import type {
   TextField,
   IntegerField,
+  DecimalField,
   CheckboxField,
   TimestampField,
   PasswordField,
@@ -64,7 +65,7 @@ export function text<
 
       return !isRequired ? withMax.optional().nullable() : withMax
     },
-    getPrismaType: () => {
+    getPrismaType: (_fieldName: string) => {
       const validation = options?.validation
       const isRequired = validation?.isRequired
       let modifiers = ''
@@ -81,6 +82,11 @@ export function text<
         modifiers += ' @index'
       }
 
+      // Map modifier
+      if (options?.db?.map) {
+        modifiers += ` @map("${options.db.map}")`
+      }
+
       return {
         type: 'String',
         modifiers: modifiers || undefined,
@@ -130,12 +136,23 @@ export function integer<
         ? withMax.optional().nullable()
         : withMax
     },
-    getPrismaType: () => {
+    getPrismaType: (_fieldName: string) => {
       const isRequired = options?.validation?.isRequired
+      let modifiers = ''
+
+      // Optional modifier
+      if (!isRequired) {
+        modifiers += '?'
+      }
+
+      // Map modifier
+      if (options?.db?.map) {
+        modifiers += ` @map("${options.db.map}")`
+      }
 
       return {
         type: 'Int',
-        modifiers: isRequired ? undefined : '?',
+        modifiers: modifiers || undefined,
       }
     },
     getTypeScriptType: () => {
@@ -149,6 +166,172 @@ export function integer<
   }
 }
 
+/**
+ * Decimal field for precise numeric values (e.g., currency, measurements)
+ *
+ * **Features:**
+ * - Stores decimal numbers with configurable precision and scale
+ * - Uses Prisma's Decimal type (backed by decimal.js for precision)
+ * - Default precision: 18 digits, scale: 4 decimal places
+ * - Validation for min/max values
+ * - Optional database column mapping and nullability control
+ * - Index support (boolean or 'unique')
+ *
+ * **Usage Example:**
+ * ```typescript
+ * // In opensaas.config.ts
+ * fields: {
+ *   price: decimal({
+ *     precision: 10,
+ *     scale: 2,
+ *     validation: {
+ *       isRequired: true,
+ *       min: '0',
+ *       max: '999999.99'
+ *     }
+ *   }),
+ *   coordinates: decimal({
+ *     precision: 18,
+ *     scale: 8,
+ *     db: { map: 'coord_value' }
+ *   })
+ * }
+ *
+ * // Creating with decimal values
+ * const product = await context.db.product.create({
+ *   data: {
+ *     price: '19.99', // Can use string
+ *     // price: 19.99,  // or number (converted to Decimal)
+ *   }
+ * })
+ * ```
+ *
+ * @param options - Field configuration options
+ * @returns Decimal field configuration
+ */
+export function decimal<
+  TTypeInfo extends import('../config/types.js').TypeInfo = import('../config/types.js').TypeInfo,
+>(options?: Omit<DecimalField<TTypeInfo>, 'type'>): DecimalField<TTypeInfo> {
+  const precision = options?.precision ?? 18
+  const scale = options?.scale ?? 4
+
+  return {
+    type: 'decimal',
+    precision,
+    scale,
+    ...options,
+    getZodSchema: (fieldName: string, operation: 'create' | 'update') => {
+      // Decimal values can be provided as strings or numbers
+      // Prisma will convert them to Decimal instances
+      const baseSchema = z.union(
+        [
+          z.string({
+            message: `${formatFieldName(fieldName)} must be a decimal value (string or number)`,
+          }),
+          z.number({
+            message: `${formatFieldName(fieldName)} must be a decimal value (string or number)`,
+          }),
+        ],
+        {
+          message: `${formatFieldName(fieldName)} must be a decimal value`,
+        },
+      )
+
+      let schema = baseSchema
+
+      // Add min validation if specified
+      if (options?.validation?.min !== undefined) {
+        const minValue = parseFloat(options.validation.min)
+        schema = schema.refine(
+          (val) => {
+            const numVal = typeof val === 'string' ? parseFloat(val) : val
+            return !isNaN(numVal) && numVal >= minValue
+          },
+          {
+            message: `${formatFieldName(fieldName)} must be at least ${options.validation.min}`,
+          },
+        )
+      }
+
+      // Add max validation if specified
+      if (options?.validation?.max !== undefined) {
+        const maxValue = parseFloat(options.validation.max)
+        schema = schema.refine(
+          (val) => {
+            const numVal = typeof val === 'string' ? parseFloat(val) : val
+            return !isNaN(numVal) && numVal <= maxValue
+          },
+          {
+            message: `${formatFieldName(fieldName)} must be at most ${options.validation.max}`,
+          },
+        )
+      }
+
+      return !options?.validation?.isRequired || operation === 'update'
+        ? schema.optional().nullable()
+        : schema
+    },
+    getPrismaType: (_fieldName: string) => {
+      const validation = options?.validation
+      const db = options?.db
+      const isRequired = validation?.isRequired
+      const isNullable = db?.isNullable ?? !isRequired
+
+      let modifiers = ''
+
+      // Optional modifier
+      if (isNullable) {
+        modifiers += '?'
+      }
+
+      // Precision and scale
+      modifiers += ` @db.Decimal(${precision}, ${scale})`
+
+      // Default value if provided
+      if (options?.defaultValue !== undefined) {
+        modifiers += ` @default(${options.defaultValue})`
+      }
+
+      // Database mapping
+      if (db?.map) {
+        modifiers += ` @map("${db.map}")`
+      }
+
+      // Unique/index modifiers
+      if (options?.isIndexed === 'unique') {
+        modifiers += ' @unique'
+      } else if (options?.isIndexed === true) {
+        modifiers += ' @index'
+      }
+
+      return {
+        type: 'Decimal',
+        modifiers: modifiers.trimStart() || undefined,
+      }
+    },
+    getTypeScriptType: () => {
+      const validation = options?.validation
+      const db = options?.db
+      const isRequired = validation?.isRequired
+      const isNullable = db?.isNullable ?? !isRequired
+
+      return {
+        type: "import('decimal.js').Decimal",
+        optional: isNullable,
+      }
+    },
+    getTypeScriptImports: () => {
+      return [
+        {
+          names: ['Decimal'],
+          from: 'decimal.js',
+          typeOnly: true,
+        },
+      ]
+    },
+  }
+}
+
 /**
  * Checkbox (boolean) field
  */
@@ -161,7 +344,7 @@ export function checkbox<
     getZodSchema: () => {
       return z.boolean().optional().nullable()
     },
-    getPrismaType: () => {
+    getPrismaType: (_fieldName: string) => {
       const hasDefault = options?.defaultValue !== undefined
       let modifiers = ''
 
@@ -169,6 +352,11 @@ export function checkbox<
         modifiers = ` @default(${options.defaultValue})`
       }
 
+      // Map modifier
+      if (options?.db?.map) {
+        modifiers += ` @map("${options.db.map}")`
+      }
+
       return {
         type: 'Boolean',
         modifiers: modifiers || undefined,
@@ -195,7 +383,7 @@ export function timestamp<
     getZodSchema: () => {
       return z.union([z.date(), z.iso.datetime()]).optional().nullable()
     },
-    getPrismaType: () => {
+    getPrismaType: (_fieldName: string) => {
       let modifiers = '?'
 
       // Check for default value
@@ -208,6 +396,11 @@ export function timestamp<
         modifiers = ' @default(now())'
       }
 
+      // Map modifier
+      if (options?.db?.map) {
+        modifiers += ` @map("${options.db.map}")`
+      }
+
       return {
         type: 'DateTime',
         modifiers,
@@ -360,12 +553,23 @@ export function password<TTypeInfo extends import('../config/types.js').TypeInfo
           .nullable()
       }
     },
-    getPrismaType: () => {
+    getPrismaType: (_fieldName: string) => {
       const isRequired = options?.validation?.isRequired
+      let modifiers = ''
+
+      // Optional modifier
+      if (!isRequired) {
+        modifiers += '?'
+      }
+
+      // Map modifier
+      if (options?.db?.map) {
+        modifiers += ` @map("${options.db.map}")`
+      }
 
       return {
         type: 'String',
-        modifiers: isRequired ? undefined : '?',
+        modifiers: modifiers || undefined,
       }
     },
     getTypeScriptType: () => {
@@ -404,17 +608,28 @@ export function select<
 
       return schema
     },
-    getPrismaType: () => {
-      let modifiers = '?'
+    getPrismaType: (_fieldName: string) => {
+      const isRequired = options.validation?.isRequired
+      let modifiers = ''
+
+      // Required fields don't get the ? modifier
+      if (!isRequired) {
+        modifiers = '?'
+      }
 
       // Add default value if provided
       if (options.defaultValue !== undefined) {
         modifiers = ` @default("${options.defaultValue}")`
       }
 
+      // Map modifier
+      if (options.db?.map) {
+        modifiers += ` @map("${options.db.map}")`
+      }
+
       return {
         type: 'String',
-        modifiers,
+        modifiers: modifiers || undefined,
       }
     },
     getTypeScriptType: () => {
@@ -447,6 +662,25 @@ export function relationship<
     )
   }
 
+  // Validate db.foreignKey usage
+  if (options.db?.foreignKey !== undefined) {
+    // Can only be used on single relationships (not many)
+    if (options.many) {
+      throw new Error(
+        'db.foreignKey can only be used on single relationships (many: false or undefined). ' +
+          'Many-side of a relationship never stores the foreign key.',
+      )
+    }
+
+    // Can only be used on bidirectional relationships (with target field)
+    if (refParts.length === 1) {
+      throw new Error(
+        'db.foreignKey can only be used on bidirectional relationships (ref: "ListName.fieldName"). ' +
+          'List-only refs (ref: "ListName") always create foreign keys automatically.',
+      )
+    }
+  }
+
   return {
     type: 'relationship',
     ...options,
@@ -520,12 +754,23 @@ export function json<
         return baseSchema.optional().nullable()
       }
     },
-    getPrismaType: () => {
+    getPrismaType: (_fieldName: string) => {
       const isRequired = options?.validation?.isRequired
+      let modifiers = ''
+
+      // Optional modifier
+      if (!isRequired) {
+        modifiers += '?'
+      }
+
+      // Map modifier
+      if (options?.db?.map) {
+        modifiers += ` @map("${options.db.map}")`
+      }
 
       return {
         type: 'Json',
-        modifiers: isRequired ? undefined : '?',
+        modifiers: modifiers || undefined,
       }
     },
     getTypeScriptType: () => {

package/src/hooks/index.ts

@@ -48,13 +48,13 @@ export async function executeResolveInput<
     | {
         operation: 'create'
         resolvedData: TCreateInput
-        item?: undefined
+        item: undefined
         context: AccessContext
       }
     | {
         operation: 'update'
         resolvedData: TUpdateInput
-        item?: TOutput
+        item: TOutput
         context: AccessContext
       },
 ): Promise<TCreateInput | TUpdateInput> {
@@ -62,9 +62,7 @@ export async function executeResolveInput<
     return args.resolvedData
   }
 
-  // Type assertion is safe because we've constrained the args type
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const result = await hooks.resolveInput(args as any)
+  const result = await hooks.resolveInput(args)
   return result
 }
 
@@ -78,12 +76,19 @@ export async function executeValidateInput<
   TUpdateInput = Record<string, unknown>,
 >(
   hooks: Hooks<TOutput, TCreateInput, TUpdateInput> | undefined,
-  args: {
-    operation: 'create' | 'update'
-    resolvedData: TCreateInput | TUpdateInput
-    item?: TOutput
-    context: AccessContext
-  },
+  args:
+    | {
+        operation: 'create'
+        resolvedData: TCreateInput
+        item: undefined
+        context: AccessContext
+      }
+    | {
+        operation: 'update'
+        resolvedData: TUpdateInput
+        item: TOutput
+        context: AccessContext
+      },
 ): Promise<void> {
   if (!hooks?.validateInput) {
     return
@@ -109,18 +114,18 @@ export async function executeValidateInput<
  * Execute beforeOperation hook
  * Runs before database operation (cannot modify data)
  */
-export async function executeBeforeOperation<
-  TOutput = Record<string, unknown>,
-  TCreateInput = Record<string, unknown>,
-  TUpdateInput = Record<string, unknown>,
->(
-  hooks: Hooks<TOutput, TCreateInput, TUpdateInput> | undefined,
-  args: {
-    operation: 'create' | 'update' | 'delete'
-    resolvedData?: TCreateInput | TUpdateInput
-    item?: TOutput
-    context: AccessContext
-  },
+export async function executeBeforeOperation<TOutput = Record<string, unknown>>(
+  hooks: Hooks<TOutput> | undefined,
+  args:
+    | {
+        operation: 'create'
+        context: AccessContext
+      }
+    | {
+        operation: 'update' | 'delete'
+        item: TOutput
+        context: AccessContext
+      },
 ): Promise<void> {
   if (!hooks?.beforeOperation) {
     return
@@ -133,18 +138,21 @@ export async function executeBeforeOperation<
  * Execute afterOperation hook
  * Runs after database operation
  */
-export async function executeAfterOperation<
-  TOutput = Record<string, unknown>,
-  TCreateInput = Record<string, unknown>,
-  TUpdateInput = Record<string, unknown>,
->(
-  hooks: Hooks<TOutput, TCreateInput, TUpdateInput> | undefined,
-  args: {
-    operation: 'create' | 'update' | 'delete'
-    resolvedData?: TCreateInput | TUpdateInput
-    item: TOutput
-    context: AccessContext
-  },
+export async function executeAfterOperation<TOutput = Record<string, unknown>>(
+  hooks: Hooks<TOutput> | undefined,
+  args:
+    | {
+        operation: 'create'
+        item: TOutput
+        originalItem: undefined
+        context: AccessContext
+      }
+    | {
+        operation: 'update' | 'delete'
+        item: TOutput
+        originalItem: TOutput
+        context: AccessContext
+      },
 ): Promise<void> {
   if (!hooks?.afterOperation) {
     return

package/tests/hooks.test.ts

@@ -252,6 +252,70 @@ describe('Hooks', () => {
         context: mockContext,
       })
     })
+
+    it('should pass originalItem to afterOperation hook for update operation', async () => {
+      const originalItem = { id: '1', name: 'John' }
+      const updatedItem = { id: '1', name: 'Jane' }
+      const hooks: Hooks = {
+        afterOperation: vi.fn(async () => {}),
+      }
+
+      await executeAfterOperation(hooks, {
+        operation: 'update',
+        item: updatedItem,
+        originalItem,
+        context: mockContext,
+      })
+
+      expect(hooks.afterOperation).toHaveBeenCalledWith({
+        operation: 'update',
+        item: updatedItem,
+        originalItem,
+        context: mockContext,
+      })
+    })
+
+    it('should pass originalItem to afterOperation hook for delete operation', async () => {
+      const item = { id: '1', name: 'John' }
+      const hooks: Hooks = {
+        afterOperation: vi.fn(async () => {}),
+      }
+
+      await executeAfterOperation(hooks, {
+        operation: 'delete',
+        item,
+        originalItem: item,
+        context: mockContext,
+      })
+
+      expect(hooks.afterOperation).toHaveBeenCalledWith({
+        operation: 'delete',
+        item,
+        originalItem: item,
+        context: mockContext,
+      })
+    })
+
+    it('should pass undefined originalItem for create operation', async () => {
+      const item = { id: '1', name: 'John' }
+      const hooks: Hooks = {
+        afterOperation: vi.fn(async () => {}),
+      }
+
+      await executeAfterOperation(hooks, {
+        operation: 'create',
+        item,
+        originalItem: undefined,
+        context: mockContext,
+      })
+
+      expect(hooks.afterOperation).toHaveBeenCalledWith({
+        operation: 'create',
+        item,
+        originalItem: undefined,
+        context: mockContext,
+      })
+    })
   })
 
   describe('validateFieldRules', () => {