sovrium 0.0.2

package/src/domain/models/app/table/foreign-keys.ts

@@ -0,0 +1,111 @@
+/**
+ * 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'
+
+/**
+ * Foreign Key Constraint Schema
+ *
+ * Defines a composite foreign key constraint that references multiple columns
+ * in another table. Used for multi-column relationships where the uniqueness
+ * constraint spans multiple fields.
+ *
+ * @example Composite foreign key
+ * ```typescript
+ * {
+ *   name: 'fk_permissions_tenant_user',
+ *   fields: ['tenant_id', 'user_id'],
+ *   referencedTable: 'tenant_users',
+ *   referencedFields: ['tenant_id', 'user_id']
+ * }
+ * ```
+ */
+export const ForeignKeySchema = Schema.Struct({
+  /**
+   * Constraint name (used in PostgreSQL constraint naming)
+   * @example "fk_permissions_tenant_user"
+   */
+  name: Schema.String.pipe(
+    Schema.minLength(1),
+    Schema.maxLength(63),
+    Schema.pattern(/^[a-z_][a-z0-9_]*$/),
+    Schema.annotations({
+      title: 'Foreign Key Name',
+      description:
+        'Constraint name following PostgreSQL naming conventions (lowercase, underscores, max 63 chars)',
+    })
+  ),
+
+  /**
+   * Local column names that form the foreign key
+   * @example ["tenant_id", "user_id"]
+   */
+  fields: Schema.Array(Schema.String).pipe(
+    Schema.minItems(1),
+    Schema.annotations({
+      title: 'Foreign Key Fields',
+      description: 'Local columns that reference the parent table',
+    })
+  ),
+
+  /**
+   * Referenced table name
+   * @example "tenant_users"
+   */
+  referencedTable: Schema.String.pipe(
+    Schema.minLength(1),
+    Schema.annotations({
+      title: 'Referenced Table',
+      description: 'Parent table name that contains the referenced columns',
+    })
+  ),
+
+  /**
+   * Referenced column names in the parent table
+   * @example ["tenant_id", "user_id"]
+   */
+  referencedFields: Schema.Array(Schema.String).pipe(
+    Schema.minItems(1),
+    Schema.annotations({
+      title: 'Referenced Fields',
+      description: 'Columns in the parent table that are referenced',
+    })
+  ),
+
+  /**
+   * Action to take on DELETE
+   * @default "restrict"
+   */
+  onDelete: Schema.optional(
+    Schema.Literal('cascade', 'set-null', 'restrict', 'no-action').pipe(
+      Schema.annotations({
+        title: 'On Delete Action',
+        description: 'Referential action when parent row is deleted',
+      })
+    )
+  ),
+
+  /**
+   * Action to take on UPDATE
+   * @default "no-action"
+   */
+  onUpdate: Schema.optional(
+    Schema.Literal('cascade', 'set-null', 'restrict', 'no-action').pipe(
+      Schema.annotations({
+        title: 'On Update Action',
+        description: 'Referential action when parent primary key is updated',
+      })
+    )
+  ),
+}).pipe(
+  Schema.annotations({
+    title: 'Foreign Key',
+    description: 'Composite foreign key constraint for multi-column relationships between tables',
+  })
+)
+
+export type ForeignKey = Schema.Schema.Type<typeof ForeignKeySchema>

package/src/domain/models/app/table/formula-keywords.ts

@@ -0,0 +1,326 @@
+/**
+ * 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.
+ */
+
+/**
+ * Common SQL/formula keywords and functions organized by category.
+ * These should be excluded from field references when parsing formulas.
+ *
+ * Defined as constants to avoid recreating Sets on every function call.
+ * Exported from a separate module to reduce main table index file size.
+ */
+
+// ============================================================================
+// SQL Keywords
+// ============================================================================
+
+/**
+ * SQL keywords used in queries (SELECT, JOIN, WHERE, etc.)
+ */
+export const SQL_KEYWORDS: ReadonlySet<string> = new Set([
+  'as',
+  'from',
+  'where',
+  'on',
+  'join',
+  'left',
+  'right',
+  'inner',
+  'outer',
+  'distinct',
+  'all',
+  'any',
+  'some',
+  'between',
+  'in',
+  'like',
+  'ilike',
+  'is',
+  'to',
+  'for',
+  'with',
+  'desc',
+  'asc',
+  'by',
+  'order',
+  'group',
+  'having',
+  'limit',
+  'offset',
+  'select',
+])
+
+/**
+ * Logical operators for boolean expressions
+ */
+export const LOGICAL_OPERATORS: ReadonlySet<string> = new Set([
+  'if',
+  'then',
+  'else',
+  'and',
+  'or',
+  'not',
+])
+
+/**
+ * Boolean and null literals
+ */
+export const LITERALS: ReadonlySet<string> = new Set(['true', 'false', 'null'])
+
+/**
+ * Control flow keywords (CASE/WHEN/END)
+ */
+export const CONTROL_FLOW: ReadonlySet<string> = new Set(['case', 'when', 'end'])
+
+// ============================================================================
+// Functions by Category
+// ============================================================================
+
+/**
+ * String manipulation functions
+ */
+export const STRING_FUNCTIONS: ReadonlySet<string> = new Set([
+  'concat',
+  'upper',
+  'lower',
+  'trim',
+  'length',
+  'substr',
+  'substring',
+  'replace',
+  'overlay',
+  'repeat',
+  'strpos',
+  'string_to_array',
+  'array_to_string',
+  'chr',
+  'ascii',
+  'encode',
+  'decode',
+  'initcap',
+  'placing',
+])
+
+/**
+ * Mathematical functions
+ */
+export const MATH_FUNCTIONS: ReadonlySet<string> = new Set([
+  'round',
+  'ceil',
+  'floor',
+  'abs',
+  'power',
+  'sqrt',
+  'mod',
+  'greatest',
+  'least',
+  'exp',
+  'trunc',
+  'log',
+  'ln',
+  'sign',
+])
+
+/**
+ * Aggregate functions for grouping operations
+ */
+export const AGGREGATE_FUNCTIONS: ReadonlySet<string> = new Set([
+  'sum',
+  'avg',
+  'max',
+  'min',
+  'count',
+  'counta',
+  'countall',
+])
+
+/**
+ * Date and time functions
+ */
+export const DATE_FUNCTIONS: ReadonlySet<string> = new Set([
+  'current_date',
+  'current_time',
+  'current_timestamp',
+  'now',
+  'extract',
+  'date_add',
+  'date_sub',
+  'date_diff',
+  'date_trunc',
+  'to_char',
+  'to_date',
+  'to_timestamp',
+  'age',
+  'year',
+  'month',
+  'day',
+  'hour',
+  'minute',
+  'second',
+])
+
+/**
+ * Date part keywords used with EXTRACT
+ */
+export const DATE_PART_KEYWORDS: ReadonlySet<string> = new Set([
+  'dow',
+  'week',
+  'doy',
+  'epoch',
+  'isodow',
+  'isoweek',
+  'isoyear',
+  'julian',
+  'quarter',
+  'timezone',
+])
+
+/**
+ * Type conversion functions
+ */
+export const TYPE_CONVERSIONS: ReadonlySet<string> = new Set(['cast', 'coalesce', 'nullif'])
+
+/**
+ * PostgreSQL data type names
+ */
+export const DATA_TYPES: ReadonlySet<string> = new Set([
+  'numeric',
+  'integer',
+  'int',
+  'decimal',
+  'text',
+  'varchar',
+  'char',
+  'boolean',
+  'bool',
+  'date',
+  'timestamp',
+  'timestamptz',
+  'time',
+  'interval',
+  'bytea',
+])
+
+/**
+ * Array manipulation functions
+ */
+export const ARRAY_FUNCTIONS: ReadonlySet<string> = new Set([
+  'array',
+  'array_length',
+  'array_remove',
+  'cardinality',
+  'arrayunique',
+  'unnest',
+  'flatten',
+])
+
+/**
+ * Regular expression functions
+ */
+export const REGEX_FUNCTIONS: ReadonlySet<string> = new Set(['regexp_match', 'regexp_replace'])
+
+/**
+ * Binary and encoding functions
+ */
+export const BINARY_FUNCTIONS: ReadonlySet<string> = new Set(['convert_from'])
+
+// ============================================================================
+// Combined Export (Backward Compatible)
+// ============================================================================
+
+/**
+ * All formula keywords combined.
+ * This is the main export for backward compatibility.
+ *
+ * Used to filter out SQL keywords when extracting field references from formulas.
+ */
+export const FORMULA_KEYWORDS = new Set([
+  ...SQL_KEYWORDS,
+  ...LOGICAL_OPERATORS,
+  ...LITERALS,
+  ...CONTROL_FLOW,
+  ...STRING_FUNCTIONS,
+  ...MATH_FUNCTIONS,
+  ...AGGREGATE_FUNCTIONS,
+  ...DATE_FUNCTIONS,
+  ...DATE_PART_KEYWORDS,
+  ...TYPE_CONVERSIONS,
+  ...DATA_TYPES,
+  ...ARRAY_FUNCTIONS,
+  ...REGEX_FUNCTIONS,
+  ...BINARY_FUNCTIONS,
+])
+
+// ============================================================================
+// Category Groups for Programmatic Access
+// ============================================================================
+
+/**
+ * All keyword categories organized for programmatic access and iteration.
+ *
+ * This object groups all SQL keywords, operators, functions, and data types
+ * by their semantic category. Each category is a ReadonlySet<string> containing
+ * lowercase keyword strings.
+ *
+ * @remarks
+ * Use this export when you need to:
+ * - Iterate over all keyword categories programmatically
+ * - Access keywords by specific category (e.g., only string functions)
+ * - Build category-specific validation or autocomplete features
+ * - Generate documentation or UI based on keyword categories
+ *
+ * For simple keyword filtering in formulas, prefer the `FORMULA_KEYWORDS`
+ * combined export which merges all categories into a single Set.
+ *
+ * @example
+ * ```typescript
+ * // Iterate over all categories
+ * Object.entries(KEYWORD_CATEGORIES).forEach(([name, keywords]) => {
+ *   console.log(`${name}: ${keywords.size} keywords`)
+ * })
+ *
+ * // Access specific category
+ * const stringFuncs = KEYWORD_CATEGORIES.STRING_FUNCTIONS
+ * console.log(stringFuncs.has('concat')) // true
+ *
+ * // Build category-specific autocomplete
+ * function getAutocomplete(category: keyof typeof KEYWORD_CATEGORIES) {
+ *   return Array.from(KEYWORD_CATEGORIES[category])
+ * }
+ * ```
+ *
+ * @see {@link FORMULA_KEYWORDS} - Combined set of all keywords for filtering
+ */
+export const KEYWORD_CATEGORIES = {
+  /** SQL query keywords (SELECT, JOIN, WHERE, etc.) */
+  SQL_KEYWORDS,
+  /** Logical operators for boolean expressions (AND, OR, NOT, IF/THEN/ELSE) */
+  LOGICAL_OPERATORS,
+  /** Boolean and null literals (true, false, null) */
+  LITERALS,
+  /** Control flow keywords (CASE, WHEN, END) */
+  CONTROL_FLOW,
+  /** String manipulation functions (CONCAT, UPPER, TRIM, etc.) */
+  STRING_FUNCTIONS,
+  /** Mathematical functions (ROUND, ABS, SQRT, etc.) */
+  MATH_FUNCTIONS,
+  /** Aggregate functions for grouping (SUM, AVG, COUNT, etc.) */
+  AGGREGATE_FUNCTIONS,
+  /** Date and time functions (NOW, EXTRACT, DATE_ADD, etc.) */
+  DATE_FUNCTIONS,
+  /** Date part keywords used with EXTRACT (YEAR, MONTH, DOW, etc.) */
+  DATE_PART_KEYWORDS,
+  /** Type conversion functions (CAST, COALESCE, NULLIF) */
+  TYPE_CONVERSIONS,
+  /** PostgreSQL data type names (INTEGER, TEXT, TIMESTAMP, etc.) */
+  DATA_TYPES,
+  /** Array manipulation functions (ARRAY, ARRAY_LENGTH, UNNEST, etc.) */
+  ARRAY_FUNCTIONS,
+  /** Regular expression functions (REGEXP_MATCH, REGEXP_REPLACE) */
+  REGEX_FUNCTIONS,
+  /** Binary and encoding functions (CONVERT_FROM) */
+  BINARY_FUNCTIONS,
+} as const

package/src/domain/models/app/table/id.ts

@@ -0,0 +1,31 @@
+/**
+ * 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'
+
+/**
+ * Table ID
+ *
+ * Unique identifier for the table
+ *
+ * @example
+ * ```typescript
+ * 1
+ * ```
+ */
+export const IdSchema = Schema.Int.pipe(
+  Schema.greaterThanOrEqualTo(1),
+  Schema.lessThanOrEqualTo(9_007_199_254_740_991),
+  Schema.annotations({
+    title: 'ID',
+    description:
+      'Unique positive integer identifier for entities. IDs are system-generated, auto-incrementing, and immutable. Must be unique within the parent collection (e.g., field IDs unique within a table, table IDs unique within the application). IDs are read-only and assigned automatically when entities are created. Range: 1 to 9,007,199,254,740,991 (JavaScript MAX_SAFE_INTEGER).',
+    examples: [1, 2, 3, 100, 1000],
+  })
+)
+
+export type Id = Schema.Schema.Type<typeof IdSchema>