@api-client/core 0.20.1 → 0.20.3

package/build/src/modeling/Semantics.js

@@ -300,104 +300,6 @@ export var SemanticCategory;
      */
     SemanticCategory["Computed"] = "Computed Values";
 })(SemanticCategory || (SemanticCategory = {}));
-/**
- * Defines when a semantic should execute in relation to database operations.
- */
-export var SemanticTiming;
-(function (SemanticTiming) {
-    /**
-     * Execute before the database operation (validation, preprocessing)
-     */
-    SemanticTiming["Before"] = "Before";
-    /**
-     * Execute after the database operation (cleanup, notifications, derived values)
-     */
-    SemanticTiming["After"] = "After";
-    /**
-     * Execute both before and after the operation
-     */
-    SemanticTiming["Both"] = "Both";
-    /**
-     * No automatic execution (manual/on-demand only)
-     */
-    SemanticTiming["None"] = "None";
-})(SemanticTiming || (SemanticTiming = {}));
-/**
- * Defines which database operations can trigger a semantic.
- */
-export var SemanticOperation;
-(function (SemanticOperation) {
-    SemanticOperation["Create"] = "Create";
-    SemanticOperation["Read"] = "Read";
-    SemanticOperation["Update"] = "Update";
-    SemanticOperation["Delete"] = "Delete";
-    /**
-     * Special operation for list operations
-     */
-    SemanticOperation["List"] = "List";
-    /**
-     * Special operation for search operations
-     */
-    SemanticOperation["Search"] = "Search";
-})(SemanticOperation || (SemanticOperation = {}));
-/**
- * Defines the execution mode for a semantic.
- */
-export var SemanticExecutionMode;
-(function (SemanticExecutionMode) {
-    /**
-     * Execute synchronously as part of the main operation
-     */
-    SemanticExecutionMode["Synchronous"] = "Synchronous";
-    /**
-     * Execute asynchronously after the main operation
-     */
-    SemanticExecutionMode["Asynchronous"] = "Asynchronous";
-    /**
-     * Execute in background/queue (fire and forget)
-     */
-    SemanticExecutionMode["Background"] = "Background";
-})(SemanticExecutionMode || (SemanticExecutionMode = {}));
-/**
- * Defines validation strategies for semantics.
- */
-export var SemanticValidationStrategy;
-(function (SemanticValidationStrategy) {
-    /**
-     * Fail the operation if semantic validation fails
-     */
-    SemanticValidationStrategy["Strict"] = "Strict";
-    /**
-     * Log warnings but continue operation
-     */
-    SemanticValidationStrategy["Warning"] = "Warning";
-    /**
-     * Skip validation entirely
-     */
-    SemanticValidationStrategy["Skip"] = "Skip";
-})(SemanticValidationStrategy || (SemanticValidationStrategy = {}));
-/**
- * Defines caching strategies for computed semantics.
- */
-export var SemanticCacheStrategy;
-(function (SemanticCacheStrategy) {
-    /**
-     * No caching - always compute
-     */
-    SemanticCacheStrategy["None"] = "None";
-    /**
-     * Cache until dependent fields change
-     */
-    SemanticCacheStrategy["Dependency"] = "Dependency";
-    /**
-     * Cache with TTL expiration
-     */
-    SemanticCacheStrategy["TimeToLive"] = "TimeToLive";
-    /**
-     * Cache until manually invalidated
-     */
-    SemanticCacheStrategy["Manual"] = "Manual";
-})(SemanticCacheStrategy || (SemanticCacheStrategy = {}));
 /**
  * A type guard to check if a semantic is an EntitySemantic.
  */
@@ -425,10 +327,6 @@ export const DataSemantics = {
         description: 'System users and accounts',
         category: SemanticCategory.Identity,
         hasConfig: false,
-        runtime: {
-            timing: SemanticTiming.None,
-            operations: [],
-        },
     },
     [SemanticType.Password]: {
         id: SemanticType.Password,
@@ -438,19 +336,6 @@ export const DataSemantics = {
         category: SemanticCategory.Identity,
         applicableDataTypes: ['string'],
         hasConfig: true,
-        runtime: {
-            timing: SemanticTiming.Before,
-            operations: [SemanticOperation.Create, SemanticOperation.Update],
-            priority: 10, // High priority for security
-            canDisable: false, // Security semantics cannot be disabled
-            timeoutMs: 2000, // Allow time for hashing
-            conditions: [
-                {
-                    expression: 'entity[semantics.Password] != null && entity[semantics.Password].length > 0',
-                    description: 'Only process when password field has a value',
-                },
-            ],
-        },
     },
     [SemanticType.Username]: {
         id: SemanticType.Username,
@@ -460,13 +345,6 @@ export const DataSemantics = {
         category: SemanticCategory.Identity,
         applicableDataTypes: ['string'],
         hasConfig: false,
-        runtime: {
-            timing: SemanticTiming.Before,
-            operations: [SemanticOperation.Create, SemanticOperation.Update, SemanticOperation.Read],
-            priority: 15, // High priority for authentication
-            canDisable: false, // Security semantics cannot be disabled
-            timeoutMs: 100, // Fast operation
-        },
     },
     [SemanticType.UserRole]: {
         id: SemanticType.UserRole,
@@ -476,17 +354,6 @@ export const DataSemantics = {
         category: SemanticCategory.Identity,
         applicableDataTypes: ['string'],
         hasConfig: false,
-        runtime: {
-            timing: SemanticTiming.Before,
-            operations: [
-                SemanticOperation.Create,
-                SemanticOperation.Read,
-                SemanticOperation.Update,
-                SemanticOperation.Delete,
-                SemanticOperation.List,
-            ],
-            priority: 20,
-        },
     },
     [SemanticType.ResourceOwnerIdentifier]: {
         id: SemanticType.ResourceOwnerIdentifier,
@@ -495,18 +362,6 @@ export const DataSemantics = {
         description: 'Links record to owner user',
         category: SemanticCategory.Identity,
         hasConfig: false,
-        runtime: {
-            timing: SemanticTiming.Before,
-            operations: [
-                SemanticOperation.Create,
-                SemanticOperation.Read,
-                SemanticOperation.Update,
-                SemanticOperation.Delete,
-                SemanticOperation.List,
-            ],
-            priority: 5, // Very high priority for access control
-            canDisable: false,
-        },
     },
     //
     // Timestamps & Versioning
@@ -519,18 +374,6 @@ export const DataSemantics = {
         category: SemanticCategory.Lifecycle,
         applicableDataTypes: ['datetime'],
         hasConfig: false,
-        runtime: {
-            timing: SemanticTiming.Before,
-            operations: [SemanticOperation.Create],
-            priority: 90,
-            timeoutMs: 100, // Very fast operation
-            conditions: [
-                {
-                    expression: 'entity[semantics.CreatedTimestamp] == null',
-                    description: 'Only set timestamp if not already provided',
-                },
-            ],
-        },
     },
     [SemanticType.UpdatedTimestamp]: {
         id: SemanticType.UpdatedTimestamp,
@@ -540,11 +383,6 @@ export const DataSemantics = {
         category: SemanticCategory.Lifecycle,
         applicableDataTypes: ['datetime'],
         hasConfig: false,
-        runtime: {
-            timing: SemanticTiming.Before,
-            operations: [SemanticOperation.Update],
-            priority: 90,
-        },
     },
     [SemanticType.DeletedTimestamp]: {
         id: SemanticType.DeletedTimestamp,
@@ -554,11 +392,6 @@ export const DataSemantics = {
         category: SemanticCategory.Lifecycle,
         applicableDataTypes: ['datetime'],
         hasConfig: false,
-        runtime: {
-            timing: SemanticTiming.Before,
-            operations: [SemanticOperation.Delete],
-            priority: 80,
-        },
     },
     [SemanticType.DeletedFlag]: {
         id: SemanticType.DeletedFlag,
@@ -568,11 +401,6 @@ export const DataSemantics = {
         category: SemanticCategory.Lifecycle,
         applicableDataTypes: ['boolean'],
         hasConfig: false,
-        runtime: {
-            timing: SemanticTiming.Before,
-            operations: [SemanticOperation.Delete, SemanticOperation.Read, SemanticOperation.List],
-            priority: 80,
-        },
     },
     //
     // Contact & Address
@@ -588,10 +416,6 @@ export const DataSemantics = {
         //  - validationProvider (enum): Options like None, GoogleMaps, or Loqate. This determines if the API returns an error for non-existent addresses.
         //  - strictness (enum): Lax (accept anything) vs. Strict (reject if not deliverable).
         hasConfig: false,
-        runtime: {
-            timing: SemanticTiming.None,
-            operations: [],
-        },
     },
     [SemanticType.StreetAddress]: {
         id: SemanticType.StreetAddress,
@@ -601,10 +425,6 @@ export const DataSemantics = {
         category: SemanticCategory.Contact,
         applicableDataTypes: ['string'],
         hasConfig: false,
-        runtime: {
-            timing: SemanticTiming.None,
-            operations: [],
-        },
     },
     [SemanticType.StreetAddressSupplemental]: {
         id: SemanticType.StreetAddressSupplemental,
@@ -614,10 +434,6 @@ export const DataSemantics = {
         category: SemanticCategory.Contact,
         applicableDataTypes: ['string'],
         hasConfig: false,
-        runtime: {
-            timing: SemanticTiming.None,
-            operations: [],
-        },
     },
     [SemanticType.City]: {
         id: SemanticType.City,
@@ -627,10 +443,6 @@ export const DataSemantics = {
         category: SemanticCategory.Contact,
         applicableDataTypes: ['string'],
         hasConfig: false,
-        runtime: {
-            timing: SemanticTiming.None,
-            operations: [],
-        },
     },
     [SemanticType.PostalCode]: {
         id: SemanticType.PostalCode,
@@ -640,10 +452,6 @@ export const DataSemantics = {
         category: SemanticCategory.Contact,
         applicableDataTypes: ['string'],
         hasConfig: true,
-        runtime: {
-            timing: SemanticTiming.None,
-            operations: [],
-        },
     },
     [SemanticType.Country]: {
         id: SemanticType.Country,
@@ -653,10 +461,6 @@ export const DataSemantics = {
         category: SemanticCategory.Contact,
         applicableDataTypes: ['string'],
         hasConfig: true,
-        runtime: {
-            timing: SemanticTiming.None,
-            operations: [],
-        },
     },
     [SemanticType.Region]: {
         id: SemanticType.Region,
@@ -666,10 +470,6 @@ export const DataSemantics = {
         category: SemanticCategory.Contact,
         applicableDataTypes: ['string'],
         hasConfig: false,
-        runtime: {
-            timing: SemanticTiming.None,
-            operations: [],
-        },
     },
     [SemanticType.Version]: {
         id: SemanticType.Version,
@@ -679,11 +479,6 @@ export const DataSemantics = {
         category: SemanticCategory.Lifecycle,
         applicableDataTypes: ['number'],
         hasConfig: false,
-        runtime: {
-            timing: SemanticTiming.Before,
-            operations: [SemanticOperation.Update],
-            priority: 85,
-        },
     },
     //
     // Content & Media
@@ -696,10 +491,6 @@ export const DataSemantics = {
         category: SemanticCategory.Content,
         applicableDataTypes: ['string'],
         hasConfig: false,
-        runtime: {
-            timing: SemanticTiming.None,
-            operations: [],
-        },
     },
     [SemanticType.Name]: {
         id: SemanticType.Name,
@@ -709,10 +500,6 @@ export const DataSemantics = {
         category: SemanticCategory.Content,
         applicableDataTypes: ['string'],
         hasConfig: false,
-        runtime: {
-            timing: SemanticTiming.None,
-            operations: [],
-        },
     },
     [SemanticType.Description]: {
         id: SemanticType.Description,
@@ -722,10 +509,6 @@ export const DataSemantics = {
         category: SemanticCategory.Content,
         applicableDataTypes: ['string'],
         hasConfig: false,
-        runtime: {
-            timing: SemanticTiming.None,
-            operations: [],
-        },
     },
     [SemanticType.Summary]: {
         id: SemanticType.Summary,
@@ -735,10 +518,6 @@ export const DataSemantics = {
         category: SemanticCategory.Content,
         applicableDataTypes: ['string'],
         hasConfig: false,
-        runtime: {
-            timing: SemanticTiming.None,
-            operations: [],
-        },
     },
     [SemanticType.Markdown]: {
         id: SemanticType.Markdown,
@@ -748,11 +527,6 @@ export const DataSemantics = {
         category: SemanticCategory.Content,
         applicableDataTypes: ['string'],
         hasConfig: true,
-        runtime: {
-            timing: SemanticTiming.Before,
-            operations: [SemanticOperation.Create, SemanticOperation.Update],
-            priority: 50, // Process before storage
-        },
     },
     [SemanticType.HTML]: {
         id: SemanticType.HTML,
@@ -762,11 +536,6 @@ export const DataSemantics = {
         category: SemanticCategory.Content,
         applicableDataTypes: ['string'],
         hasConfig: true,
-        runtime: {
-            timing: SemanticTiming.Before,
-            operations: [SemanticOperation.Create, SemanticOperation.Update],
-            priority: 50, // Process before storage for sanitization
-        },
     },
     [SemanticType.ImageURL]: {
         id: SemanticType.ImageURL,
@@ -776,11 +545,6 @@ export const DataSemantics = {
         category: SemanticCategory.Content,
         applicableDataTypes: ['string'],
         hasConfig: false,
-        runtime: {
-            timing: SemanticTiming.Before,
-            operations: [SemanticOperation.Create, SemanticOperation.Update],
-            priority: 60, // Validate URLs before storage
-        },
     },
     [SemanticType.FileURL]: {
         id: SemanticType.FileURL,
@@ -790,11 +554,6 @@ export const DataSemantics = {
         category: SemanticCategory.Content,
         applicableDataTypes: ['string'],
         hasConfig: false,
-        runtime: {
-            timing: SemanticTiming.Before,
-            operations: [SemanticOperation.Create, SemanticOperation.Update],
-            priority: 60, // Validate URLs before storage
-        },
     },
     //
     // Business Data
@@ -807,11 +566,6 @@ export const DataSemantics = {
         category: SemanticCategory.Business,
         applicableDataTypes: ['string'],
         hasConfig: true,
-        runtime: {
-            timing: SemanticTiming.Both,
-            operations: [SemanticOperation.Create, SemanticOperation.Update, SemanticOperation.Read, SemanticOperation.List],
-            priority: 30, // Validate state transitions before, filter by state after
-        },
     },
     [SemanticType.Currency]: {
         id: SemanticType.Currency,
@@ -821,11 +575,6 @@ export const DataSemantics = {
         category: SemanticCategory.Business,
         applicableDataTypes: ['number', 'string'],
         hasConfig: true,
-        runtime: {
-            timing: SemanticTiming.Before,
-            operations: [SemanticOperation.Create, SemanticOperation.Update],
-            priority: 70, // Validate currency format and precision
-        },
     },
     [SemanticType.SKU]: {
         id: SemanticType.SKU,
@@ -835,11 +584,6 @@ export const DataSemantics = {
         category: SemanticCategory.Business,
         applicableDataTypes: ['string'],
         hasConfig: true,
-        runtime: {
-            timing: SemanticTiming.Before,
-            operations: [SemanticOperation.Create, SemanticOperation.Update],
-            priority: 25, // High priority for uniqueness validation
-        },
     },
     //
     // Contact Information
@@ -852,11 +596,6 @@ export const DataSemantics = {
         category: SemanticCategory.Contact,
         applicableDataTypes: ['string'],
         hasConfig: true,
-        runtime: {
-            timing: SemanticTiming.Before,
-            operations: [SemanticOperation.Create, SemanticOperation.Update],
-            priority: 40, // Validate email format
-        },
     },
     [SemanticType.Phone]: {
         id: SemanticType.Phone,
@@ -866,11 +605,6 @@ export const DataSemantics = {
         category: SemanticCategory.Contact,
         applicableDataTypes: ['string'],
         hasConfig: true,
-        runtime: {
-            timing: SemanticTiming.Before,
-            operations: [SemanticOperation.Create, SemanticOperation.Update],
-            priority: 40, // Validate phone format
-        },
     },
     [SemanticType.URL]: {
         id: SemanticType.URL,
@@ -880,11 +614,6 @@ export const DataSemantics = {
         category: SemanticCategory.Contact,
         applicableDataTypes: ['string'],
         hasConfig: true,
-        runtime: {
-            timing: SemanticTiming.Before,
-            operations: [SemanticOperation.Create, SemanticOperation.Update],
-            priority: 40, // Validate URL format
-        },
     },
     [SemanticType.ClientIPAddress]: {
         id: SemanticType.ClientIPAddress,
@@ -894,18 +623,6 @@ export const DataSemantics = {
         category: SemanticCategory.Contact,
         applicableDataTypes: ['string'],
         hasConfig: false,
-        runtime: {
-            timing: SemanticTiming.Before,
-            operations: [SemanticOperation.Create, SemanticOperation.Update],
-            priority: 95, // Low priority, populate after other validations
-            timeoutMs: 100, // Very fast operation
-            conditions: [
-                {
-                    expression: 'entity[semantics.ClientIPAddress] == null',
-                    description: 'Only set IP address if not already provided',
-                },
-            ],
-        },
     },
     //
     // Classification & Organization
@@ -918,23 +635,6 @@ export const DataSemantics = {
         category: SemanticCategory.Organization,
         applicableDataTypes: ['string'],
         hasConfig: true,
-        runtime: {
-            timing: SemanticTiming.Before,
-            operations: [SemanticOperation.Create, SemanticOperation.Update],
-            priority: 30, // Generate slug from title, validate uniqueness
-            timeoutMs: 1000,
-            conditions: [
-                {
-                    expression: 'entity[semantics.PublicUniqueName] == null || entity[semantics.PublicUniqueName].length == 0',
-                    description: 'Only generate slug if not already provided',
-                },
-                // Let's not guess which field is marked as slug source in the `PublicUniqueName` configuration.
-                // {
-                //   expression: 'entity[semantics.Title] != null && entity[semantics.Title].length > 0',
-                //   description: 'Only generate slug if title field exists and has content',
-                // },
-            ],
-        },
     },
     [SemanticType.Tags]: {
         id: SemanticType.Tags,
@@ -943,11 +643,6 @@ export const DataSemantics = {
         description: 'Enable tagging functionality',
         category: SemanticCategory.Organization,
         hasConfig: true,
-        runtime: {
-            timing: SemanticTiming.After,
-            operations: [SemanticOperation.Create, SemanticOperation.Update, SemanticOperation.Delete],
-            priority: 200, // Process after main operation
-        },
     },
     [SemanticType.Categories]: {
         id: SemanticType.Categories,
@@ -956,11 +651,6 @@ export const DataSemantics = {
         description: 'Enable categorization functionality',
         category: SemanticCategory.Organization,
         hasConfig: true,
-        runtime: {
-            timing: SemanticTiming.After,
-            operations: [SemanticOperation.Create, SemanticOperation.Update, SemanticOperation.Delete],
-            priority: 200, // Process after main operation
-        },
     },
     //
     // Location & Geography
@@ -973,11 +663,6 @@ export const DataSemantics = {
         category: SemanticCategory.Location,
         applicableDataTypes: ['string'],
         hasConfig: true,
-        runtime: {
-            timing: SemanticTiming.Both,
-            operations: [SemanticOperation.Create, SemanticOperation.Update, SemanticOperation.Read, SemanticOperation.List],
-            priority: 60, // Validate coordinates before, enable spatial queries after
-        },
     },
     //
     // Computed Values
@@ -991,11 +676,6 @@ export const DataSemantics = {
         category: SemanticCategory.Computed,
         applicableDataTypes: ['string', 'number', 'boolean', 'date', 'datetime', 'time', 'binary'],
         hasConfig: true,
-        runtime: {
-            timing: SemanticTiming.Both,
-            operations: [SemanticOperation.Create, SemanticOperation.Update, SemanticOperation.Read],
-            priority: 150, // Calculate after other validations, recalculate on read if needed
-        },
     },
     [SemanticType.Derived]: {
         id: SemanticType.Derived,
@@ -1005,44 +685,8 @@ export const DataSemantics = {
         category: SemanticCategory.Computed,
         applicableDataTypes: ['string'],
         hasConfig: true,
-        runtime: {
-            timing: SemanticTiming.After,
-            operations: [SemanticOperation.Create, SemanticOperation.Update],
-            priority: 180, // Derive after all other processing
-        },
     },
 };
-/**
- * Get all semantics that should run for a specific operation and timing
- */
-export function getSemanticsForOperation(semantics, operation, timing) {
-    return semantics
-        .filter((semantic) => {
-        const definition = DataSemantics[semantic.id];
-        if (!definition?.runtime) {
-            return false;
-        }
-        const { timing: semanticTiming, operations } = definition.runtime;
-        // Check if timing matches
-        const timingMatches = semanticTiming === timing || semanticTiming === SemanticTiming.Both;
-        // Check if operation is included
-        const operationMatches = operations.includes(operation);
-        return timingMatches && operationMatches;
-    })
-        .sort((a, b) => {
-        // Sort by priority (lower number = higher priority)
-        const priorityA = DataSemantics[a.id]?.runtime?.priority ?? 100;
-        const priorityB = DataSemantics[b.id]?.runtime?.priority ?? 100;
-        return priorityA - priorityB;
-    });
-}
-/**
- * Check if a specific semantic can be disabled at runtime
- */
-export function canSemanticBeDisabled(semanticType) {
-    const definition = DataSemantics[semanticType];
-    return definition?.runtime?.canDisable !== false; // Default to true if not specified
-}
 /**
  * Helper function to get all semantics grouped by category.
  * Useful for organizing semantics in UI dropdowns and forms.