sovrium 0.0.2

package/src/domain/models/app/table/field-types/date-time/date-field.ts

@@ -0,0 +1,95 @@
+/**
+ * Copyright (c) 2025 ESSENTIAL SERVICES
+ *
+ * This source code is licensed under the Business Source License 1.1
+ * found in the LICENSE.md file in the root directory of this source tree.
+ */
+
+import { Schema } from 'effect'
+import { BaseFieldSchema } from '../base-field'
+
+/**
+ * Date Field
+ *
+ * Stores date and optionally time values.
+ * Supports custom date formats, timezone configuration, and time inclusion.
+ * Can be marked as required, unique, or indexed for efficient date-based queries.
+ *
+ * @example
+ * ```typescript
+ * const field = {
+ *   id: 1,
+ *   name: 'due_date',
+ *   type: 'date',
+ *   required: true,
+ *   format: 'YYYY-MM-DD',
+ *   includeTime: false
+ * }
+ * ```
+ */
+export const DateFieldSchema = BaseFieldSchema.pipe(
+  Schema.extend(
+    Schema.Struct({
+      type: Schema.Literal('date', 'datetime', 'time'),
+      format: Schema.optional(
+        Schema.String.pipe(
+          Schema.annotations({
+            description: 'Date format string',
+            examples: ['YYYY-MM-DD', 'MM/DD/YYYY', 'DD-MM-YYYY'],
+          })
+        )
+      ),
+      dateFormat: Schema.optional(
+        Schema.Literal('US', 'European', 'ISO').pipe(
+          Schema.annotations({
+            description: 'Date display format preset',
+            examples: ['US', 'European', 'ISO'],
+          })
+        )
+      ),
+      timeFormat: Schema.optional(
+        Schema.Literal('12-hour', '24-hour').pipe(
+          Schema.annotations({
+            description: 'Time display format (12-hour with AM/PM or 24-hour)',
+            examples: ['12-hour', '24-hour'],
+          })
+        )
+      ),
+      includeTime: Schema.optional(Schema.Boolean),
+      timezone: Schema.optional(
+        Schema.String.pipe(
+          Schema.annotations({
+            description: 'Timezone for datetime fields',
+            examples: ['UTC', 'America/New_York', 'Europe/London'],
+          })
+        )
+      ),
+      timeZone: Schema.optional(
+        Schema.Union(Schema.Literal('local'), Schema.String).pipe(
+          Schema.annotations({
+            description: 'Timezone setting (specific timezone or "local" for browser timezone)',
+            examples: ['local', 'America/New_York', 'Europe/Paris'],
+          })
+        )
+      ),
+      default: Schema.optional(Schema.String),
+    })
+  ),
+  Schema.annotations({
+    title: 'Date Field',
+    description:
+      'Stores date and optionally time values. Supports custom formats, timezones, and time inclusion.',
+    examples: [
+      {
+        id: 1,
+        name: 'due_date',
+        type: 'date',
+        required: true,
+        format: 'YYYY-MM-DD',
+        includeTime: false,
+      },
+    ],
+  })
+)
+
+export type DateField = Schema.Schema.Type<typeof DateFieldSchema>

package/src/domain/models/app/table/field-types/date-time/deleted-at-field.ts

@@ -0,0 +1,56 @@
+/**
+ * Copyright (c) 2025 ESSENTIAL SERVICES
+ *
+ * This source code is licensed under the Business Source License 1.1
+ * found in the LICENSE.md file in the root directory of this source tree.
+ */
+
+import { Schema } from 'effect'
+import { BaseFieldSchema } from '../base-field'
+
+/**
+ * Deleted At Field
+ *
+ * Captures the timestamp when a record is soft-deleted.
+ * When NULL, the record is considered active (not deleted).
+ * When set, the record is considered soft-deleted and should be
+ * excluded from normal queries.
+ *
+ * This field enables soft delete functionality, allowing records
+ * to be "deleted" without permanent removal, supporting:
+ * - Record restoration
+ * - Audit trails
+ * - Data recovery
+ *
+ * @example
+ * ```typescript
+ * const field = {
+ *   id: 1,
+ *   name: 'deleted_at',
+ *   type: 'deleted-at',
+ *   indexed: true
+ * }
+ * ```
+ */
+export const DeletedAtFieldSchema = BaseFieldSchema.pipe(
+  Schema.extend(
+    Schema.Struct({
+      type: Schema.Literal('deleted-at'),
+    })
+  ),
+  Schema.annotations({
+    title: 'Deleted At Field',
+    description:
+      'Captures the timestamp when a record is soft-deleted. NULL indicates the record is active. Enables soft delete with record restoration capability.',
+    examples: [
+      {
+        id: 1,
+        name: 'deleted_at',
+        type: 'deleted-at',
+        indexed: true,
+      },
+    ],
+  })
+)
+
+export type DeletedAtField = Schema.Schema.Type<typeof DeletedAtFieldSchema>

package/src/domain/models/app/table/field-types/date-time/duration-field.ts

@@ -0,0 +1,73 @@
+/**
+ * Copyright (c) 2025 ESSENTIAL SERVICES
+ *
+ * This source code is licensed under the Business Source License 1.1
+ * found in the LICENSE.md file in the root directory of this source tree.
+ */
+
+import { Schema } from 'effect'
+import { BaseFieldSchema } from '../base-field'
+
+/**
+ * Duration Field
+ *
+ * Stores time duration values (e.g., hours, minutes, seconds).
+ * Used for tracking elapsed time, work hours, or time intervals.
+ * Supports custom display formats for presenting duration values.
+ *
+ * @example
+ * ```typescript
+ * const field = {
+ *   id: 1,
+ *   name: 'work_hours',
+ *   type: 'duration',
+ *   required: true,
+ *   format: 'h:mm'
+ * }
+ * ```
+ */
+export const DurationFieldSchema = BaseFieldSchema.pipe(
+  Schema.extend(
+    Schema.Struct({
+      type: Schema.Literal('duration'),
+      format: Schema.optional(
+        Schema.String.pipe(
+          Schema.annotations({
+            description: 'Display format for the duration',
+          })
+        )
+      ),
+      displayFormat: Schema.optional(
+        Schema.Literal('h:mm', 'h:mm:ss', 'decimal').pipe(
+          Schema.annotations({
+            description: 'Display format preset for duration values',
+            examples: ['h:mm', 'h:mm:ss', 'decimal'],
+          })
+        )
+      ),
+      default: Schema.optional(
+        Schema.Number.pipe(
+          Schema.annotations({
+            description: 'Default duration value in seconds when creating new records',
+          })
+        )
+      ),
+    })
+  ),
+  Schema.annotations({
+    title: 'Duration Field',
+    description:
+      'Stores time duration values. Used for tracking elapsed time or work hours with custom formats.',
+    examples: [
+      {
+        id: 1,
+        name: 'work_hours',
+        type: 'duration',
+        required: true,
+        format: 'h:mm',
+      },
+    ],
+  })
+)
+
+export type DurationField = Schema.Schema.Type<typeof DurationFieldSchema>

package/src/domain/models/app/table/field-types/date-time/index.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) 2025 ESSENTIAL SERVICES
+ *
+ * This source code is licensed under the Business Source License 1.1
+ * found in the LICENSE.md file in the root directory of this source tree.
+ */
+
+export * from './date-field'
+export * from './duration-field'
+export * from './created-at-field'
+export * from './updated-at-field'
+export * from './deleted-at-field'

package/src/domain/models/app/table/field-types/date-time/updated-at-field.ts

@@ -0,0 +1,50 @@
+/**
+ * Copyright (c) 2025 ESSENTIAL SERVICES
+ *
+ * This source code is licensed under the Business Source License 1.1
+ * found in the LICENSE.md file in the root directory of this source tree.
+ */
+
+import { Schema } from 'effect'
+import { BaseFieldSchema } from '../base-field'
+
+/**
+ * Updated At Field
+ *
+ * Automatically updates the timestamp whenever a record is modified.
+ * This field is system-managed and cannot be manually edited.
+ * Automatically updates on every record update operation.
+ * Commonly used for tracking last modification time and cache invalidation.
+ *
+ * @example
+ * ```typescript
+ * const field = {
+ *   id: 1,
+ *   name: 'updated_at',
+ *   type: 'updated-at',
+ *   indexed: true
+ * }
+ * ```
+ */
+export const UpdatedAtFieldSchema = BaseFieldSchema.pipe(
+  Schema.extend(
+    Schema.Struct({
+      type: Schema.Literal('updated-at'),
+    })
+  ),
+  Schema.annotations({
+    title: 'Updated At Field',
+    description:
+      'Automatically updates the timestamp whenever a record is modified. System-managed field that updates on every change.',
+    examples: [
+      {
+        id: 1,
+        name: 'updated_at',
+        type: 'updated-at',
+        indexed: true,
+      },
+    ],
+  })
+)
+
+export type UpdatedAtField = Schema.Schema.Type<typeof UpdatedAtFieldSchema>

package/src/domain/models/app/table/field-types/index.ts

@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) 2025 ESSENTIAL SERVICES
+ *
+ * This source code is licensed under the Business Source License 1.1
+ * found in the LICENSE.md file in the root directory of this source tree.
+ */
+
+// Re-export base field and validation utilities
+export * from './base-field'
+
+// Re-export all field types organized by category
+export * from './text'
+export * from './numeric'
+export * from './date-time'
+export * from './relational'
+export * from './selection'
+export * from './media'
+export * from './user'
+export * from './advanced'

package/src/domain/models/app/table/field-types/media/barcode-field.ts

@@ -0,0 +1,58 @@
+/**
+ * Copyright (c) 2025 ESSENTIAL SERVICES
+ *
+ * This source code is licensed under the Business Source License 1.1
+ * found in the LICENSE.md file in the root directory of this source tree.
+ */
+
+import { Schema } from 'effect'
+import { BaseFieldSchema } from '../base-field'
+
+/**
+ * Barcode Field
+ *
+ * Stores barcode values with support for various barcode formats.
+ * Used for product identification, inventory tracking, and asset management.
+ * Can be configured to support specific barcode standards (e.g., EAN, UPC, QR Code).
+ *
+ * @example
+ * ```typescript
+ * const field = {
+ *   id: 1,
+ *   name: 'product_barcode',
+ *   type: 'barcode',
+ *   required: true,
+ *   format: 'EAN-13'
+ * }
+ * ```
+ */
+export const BarcodeFieldSchema = BaseFieldSchema.pipe(
+  Schema.extend(
+    Schema.Struct({
+      type: Schema.Literal('barcode'),
+      format: Schema.optional(
+        Schema.String.pipe(
+          Schema.annotations({
+            description: 'Barcode format',
+          })
+        )
+      ),
+    })
+  ),
+  Schema.annotations({
+    title: 'Barcode Field',
+    description:
+      'Stores barcode values with various format support. Used for product identification and inventory.',
+    examples: [
+      {
+        id: 1,
+        name: 'product_barcode',
+        type: 'barcode',
+        required: true,
+        format: 'EAN-13',
+      },
+    ],
+  })
+)
+
+export type BarcodeField = Schema.Schema.Type<typeof BarcodeFieldSchema>

package/src/domain/models/app/table/field-types/media/index.ts

@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) 2025 ESSENTIAL SERVICES
+ *
+ * This source code is licensed under the Business Source License 1.1
+ * found in the LICENSE.md file in the root directory of this source tree.
+ */
+
+export * from './single-attachment-field'
+export * from './multiple-attachments-field'
+export * from './barcode-field'

package/src/domain/models/app/table/field-types/media/multiple-attachments-field.ts

@@ -0,0 +1,80 @@
+/**
+ * Copyright (c) 2025 ESSENTIAL SERVICES
+ *
+ * This source code is licensed under the Business Source License 1.1
+ * found in the LICENSE.md file in the root directory of this source tree.
+ */
+
+import { Schema } from 'effect'
+import { BaseFieldSchema } from '../base-field'
+
+export const MultipleAttachmentsFieldSchema = BaseFieldSchema.pipe(
+  Schema.extend(
+    Schema.Struct({
+      type: Schema.Literal('multiple-attachments'),
+      maxFiles: Schema.optional(
+        Schema.Int.pipe(
+          Schema.greaterThanOrEqualTo(1),
+          Schema.annotations({ description: 'Maximum number of files allowed' })
+        )
+      ),
+      allowedFileTypes: Schema.optional(
+        Schema.Array(Schema.String).pipe(
+          Schema.annotations({
+            description: 'Allowed MIME types for file uploads',
+            examples: [['application/pdf', 'application/msword']],
+          })
+        )
+      ),
+      maxFileSize: Schema.optional(
+        Schema.Int.pipe(
+          Schema.greaterThanOrEqualTo(1),
+          Schema.annotations({
+            description: 'Maximum file size in bytes per attachment',
+            examples: [10_485_760],
+          })
+        )
+      ),
+      generateThumbnails: Schema.optional(
+        Schema.Boolean.pipe(
+          Schema.annotations({
+            description: 'Whether to generate thumbnails for image attachments',
+          })
+        )
+      ),
+      storeMetadata: Schema.optional(
+        Schema.Boolean.pipe(
+          Schema.annotations({
+            description: 'Whether to store metadata for each attachment',
+          })
+        )
+      ),
+      storage: Schema.optional(
+        Schema.Struct({
+          provider: Schema.optional(
+            Schema.String.pipe(Schema.annotations({ description: 'Storage provider' }))
+          ),
+          bucket: Schema.optional(
+            Schema.String.pipe(
+              Schema.annotations({ description: 'S3 bucket name (required for s3 provider)' })
+            )
+          ),
+          maxSize: Schema.optional(
+            Schema.Int.pipe(
+              Schema.greaterThanOrEqualTo(1),
+              Schema.annotations({ description: 'Maximum file size in bytes per file' })
+            )
+          ),
+          allowedTypes: Schema.optional(Schema.Array(Schema.String)),
+        })
+      ),
+    })
+  ),
+  Schema.annotations({
+    title: 'Multiple Attachments Field',
+    description: 'Stores multiple file attachments with storage configuration.',
+    examples: [{ id: 1, name: 'documents', type: 'multiple-attachments', maxFiles: 10 }],
+  })
+)
+
+export type MultipleAttachmentsField = Schema.Schema.Type<typeof MultipleAttachmentsFieldSchema>

package/src/domain/models/app/table/field-types/media/single-attachment-field.ts

@@ -0,0 +1,81 @@
+/**
+ * Copyright (c) 2025 ESSENTIAL SERVICES
+ *
+ * This source code is licensed under the Business Source License 1.1
+ * found in the LICENSE.md file in the root directory of this source tree.
+ */
+
+import { Schema } from 'effect'
+import { BaseFieldSchema } from '../base-field'
+
+export const SingleAttachmentFieldSchema = BaseFieldSchema.pipe(
+  Schema.extend(
+    Schema.Struct({
+      type: Schema.Literal('single-attachment'),
+      allowedFileTypes: Schema.optional(
+        Schema.Array(Schema.String).pipe(
+          Schema.annotations({
+            description: 'Allowed MIME types for file uploads',
+            examples: [['image/png', 'image/jpeg', 'image/gif']],
+          })
+        )
+      ),
+      maxFileSize: Schema.optional(
+        Schema.Int.pipe(
+          Schema.greaterThanOrEqualTo(1),
+          Schema.annotations({
+            description: 'Maximum file size in bytes',
+            examples: [5_242_880],
+          })
+        )
+      ),
+      generateThumbnail: Schema.optional(
+        Schema.Boolean.pipe(
+          Schema.annotations({
+            description: 'Whether to generate thumbnails for image attachments',
+          })
+        )
+      ),
+      storeMetadata: Schema.optional(
+        Schema.Boolean.pipe(
+          Schema.annotations({
+            description: 'Whether to store metadata (dimensions for images, duration for videos)',
+          })
+        )
+      ),
+      storage: Schema.optional(
+        Schema.Struct({
+          provider: Schema.optional(
+            Schema.String.pipe(Schema.annotations({ description: 'Storage provider' }))
+          ),
+          bucket: Schema.optional(
+            Schema.String.pipe(
+              Schema.annotations({ description: 'S3 bucket name (required for s3 provider)' })
+            )
+          ),
+          maxSize: Schema.optional(
+            Schema.Int.pipe(
+              Schema.greaterThanOrEqualTo(1),
+              Schema.annotations({ description: 'Maximum file size in bytes' })
+            )
+          ),
+          allowedTypes: Schema.optional(Schema.Array(Schema.String)),
+        })
+      ),
+    })
+  ),
+  Schema.annotations({
+    title: 'Single Attachment Field',
+    description: 'Stores a single file attachment with storage configuration.',
+    examples: [
+      {
+        id: 1,
+        name: 'profile_pic',
+        type: 'single-attachment',
+        storage: { provider: 'local', maxSize: 5_242_880 },
+      },
+    ],
+  })
+)
+
+export type SingleAttachmentField = Schema.Schema.Type<typeof SingleAttachmentFieldSchema>

package/src/domain/models/app/table/field-types/numeric/currency-field.ts

@@ -0,0 +1,144 @@
+/**
+ * Copyright (c) 2025 ESSENTIAL SERVICES
+ *
+ * This source code is licensed under the Business Source License 1.1
+ * found in the LICENSE.md file in the root directory of this source tree.
+ */
+
+import { Schema } from 'effect'
+import { BaseFieldSchema } from '../base-field'
+import { validateMinMaxRange } from '../validation-utils'
+
+/**
+ * Currency Field
+ *
+ * Specialized numeric field for storing monetary values with currency information.
+ * Automatically formats values with currency symbols and stores precise decimal amounts.
+ * Supports configurable currency codes (USD, EUR, GBP, etc.) and precision (typically 2
+ * decimal places). Can be marked as required, unique, or indexed. Stored using DECIMAL
+ * database type to prevent rounding errors in financial calculations.
+ *
+ * Business Rules:
+ * - Currency code must be valid ISO 4217 three-letter code (USD, EUR, GBP, etc.)
+ * - Precision defaults to 2 decimal places (standard for most currencies)
+ * - DECIMAL storage ensures exact monetary amounts without floating-point errors
+ * - Min/max validation optional - useful for enforcing business rules (e.g., price >= 0)
+ * - Currency code stored with value to support multi-currency applications
+ * - Indexing recommended for fields used in financial reports and sorting
+ * - Constant value 'currency' ensures type safety and enables discriminated unions
+ *
+ * @example
+ * ```typescript
+ * const field = {
+ *   id: 1,
+ *   name: 'price',
+ *   type: 'currency',
+ *   required: true,
+ *   currency: 'USD',
+ *   precision: 2,
+ *   min: 0,
+ *   default: 0.00
+ * }
+ * ```
+ */
+export const CurrencyFieldSchema = BaseFieldSchema.pipe(
+  Schema.extend(
+    Schema.Struct({
+      type: Schema.Literal('currency').pipe(
+        Schema.annotations({
+          description: "Constant value 'currency' for type discrimination in discriminated unions",
+        })
+      ),
+      currency: Schema.String.pipe(
+        Schema.length(3),
+        Schema.pattern(/^[A-Z]{3}$/),
+        Schema.annotations({
+          description: 'ISO 4217 three-letter currency code (e.g., USD, EUR, GBP)',
+          examples: ['USD', 'EUR', 'GBP', 'JPY', 'CAD', 'AUD'],
+        })
+      ),
+      precision: Schema.optional(
+        Schema.Int.pipe(
+          Schema.greaterThanOrEqualTo(0),
+          Schema.lessThanOrEqualTo(10),
+          Schema.annotations({
+            description: 'Number of decimal places (0-10, default: 2 for most currencies)',
+          })
+        )
+      ),
+      min: Schema.optional(
+        Schema.Number.pipe(
+          Schema.annotations({
+            description: 'Minimum allowed value (inclusive)',
+          })
+        )
+      ),
+      max: Schema.optional(
+        Schema.Number.pipe(
+          Schema.annotations({
+            description: 'Maximum allowed value (inclusive)',
+          })
+        )
+      ),
+      symbolPosition: Schema.optional(
+        Schema.Literal('before', 'after').pipe(
+          Schema.annotations({
+            description: 'Position of currency symbol relative to the amount',
+            examples: ['before', 'after'],
+          })
+        )
+      ),
+      negativeFormat: Schema.optional(
+        Schema.Literal('minus', 'parentheses').pipe(
+          Schema.annotations({
+            description: 'Format for displaying negative amounts',
+            examples: ['minus', 'parentheses'],
+          })
+        )
+      ),
+      thousandsSeparator: Schema.optional(
+        Schema.Literal('comma', 'period', 'space', 'none').pipe(
+          Schema.annotations({
+            description: 'Character used to separate thousands',
+            examples: ['comma', 'period', 'space', 'none'],
+          })
+        )
+      ),
+      default: Schema.optional(
+        Schema.Number.pipe(
+          Schema.annotations({
+            description: 'Default currency value when creating new records',
+          })
+        )
+      ),
+    })
+  ),
+  Schema.filter(validateMinMaxRange),
+  Schema.annotations({
+    title: 'Currency Field',
+    description:
+      'Specialized numeric field for monetary values with currency codes (ISO 4217). Uses exact DECIMAL storage to prevent rounding errors in financial calculations.',
+    examples: [
+      {
+        id: 1,
+        name: 'price',
+        type: 'currency',
+        required: true,
+        currency: 'USD',
+        precision: 2,
+        min: 0,
+        default: 0.0,
+      },
+      {
+        id: 2,
+        name: 'total_cost',
+        type: 'currency',
+        required: true,
+        currency: 'EUR',
+        precision: 2,
+      },
+    ],
+  })
+)
+
+export type CurrencyField = Schema.Schema.Type<typeof CurrencyFieldSchema>