@api-client/core 0.15.1 → 0.16.0

package/build/src/modeling/Semantics.js

@@ -4,12 +4,16 @@
  */
 export var SemanticType;
 (function (SemanticType) {
+    //
     // Entity-Level Semantics
+    //
     /**
      * Designates a Data Entity that represents users of the system.
      */
     SemanticType["User"] = "Semantic#User";
+    //
     // Property-Level Semantics
+    //
     /**
      * Annotates the field as the user password.
      * The runtime should treat this field with special care,
@@ -40,11 +44,19 @@ export var SemanticType;
      */
     SemanticType["DeletedFlag"] = "Semantic#DeletedFlag";
     /**
-     * Designates a Data Property as a unique public identifier for a resource.
+     * Designates a Data Property as a unique public identifier for a resource (the slug).
      * This is often used in URLs to provide a user-friendly way to access the resource.
      * For example, a blog post might have a public unique name like "my-first-post".
+     * A URL-friendly text field. The runtime automatically generates a unique, URL-safe string from another field (like a title or name). The user needs to specify which field is used to generate
+     * the slug.
      */
     SemanticType["PublicUniqueName"] = "Semantic#PublicUniqueName";
+    /**
+     * A semantic that describes a title of an article, blog post, and so on. This semantic is used with
+     * the `PublicUniqueName` to determine which field is responsible for the slug generation. However,
+     * we may add more automation related to the `title` property in the future.
+     */
+    SemanticType["Title"] = "Semantic#Title";
     /**
      * Designates a Data Property as the `role` of a user within the system.
      * This is used to define the user's permissions and access levels.
@@ -53,13 +65,131 @@ export var SemanticType;
      * Roles are defined on the entity as enums, or as a string property with a controlled vocabulary.
      */
     SemanticType["UserRole"] = "Semantic#UserRole";
+    /**
+     * A text or enum field to represent the state of a record (e.g., `draft`, `published`, `pending_review`, `archived`).
+     *
+     * Defined behaviors:
+     * - State-Based Filtering: Automatically prevents public users from seeing records in a draft state.
+     * - State Transitions: In principle, the runtime should prevent the user from skipping some states.
+     * For example, when the record is in the `draft` state, it cannot be moved to the `archived` state without publishing it first. However,
+     * we do not have enough customer feedback to design this functionality correctly right now, so
+     * it serves as a placeholder semantic annotation.
+     */
+    SemanticType["Status"] = "Semantic#Status";
+    /**
+     * Annotates an integer field that automatically increments.
+     * The runtime automatically increments this number on every update, providing a simple way
+     * to track changes and implement optimistic locking to prevent mid-air collisions.
+     */
+    SemanticType["Version"] = "Semantic#Version";
+    /**
+     * Annotates a field that holds a reference to an image data via an URL.
+     * The application + runtime should validate that the input is a well-formed URL.
+     */
+    SemanticType["ImageURL"] = "Semantic#ImageURL";
+    /**
+     * Annotates a field that holds a reference to a file object via an URL. Ity is distinct from the
+     * `ImageURL` semantic as it implicitly states that the target is non-image, binary data (an attachment, for example).
+     */
+    SemanticType["FileURL"] = "Semantic#FileURL";
+    /**
+     * Annotates the field as a markdown-interpreted field.
+     * When an object is created, the runtime performs additional sanitization to prevent XSS attacks.
+     *
+     * The annotation describes whether the data should be translated to the HTML output when
+     * record is read or the original MD content should be returned.
+     */
+    SemanticType["Markdown"] = "Semantic#Markdown";
+    /**
+     * Annotates the field as containing HTML content.
+     * The runtime performs sanitization to prevent XSS attacks and validates HTML structure.
+     *
+     * The annotation describes whether the data should be rendered as HTML output when
+     * record is read or the original HTML content should be returned.
+     */
+    SemanticType["HTML"] = "Semantic#HTML";
+    /**
+     * Annotates a field that holds geospatial coordinate data (latitude/longitude).
+     * The runtime automatically generates API capabilities for location-based queries,
+     * such as "find all restaurants within a 5-mile radius."
+     *
+     * The field should contain coordinate data in a standard format:
+     * - "40.7128,-74.0060" (lat,lon)
+     * - "POINT(-74.0060 40.7128)" (PostGIS format)
+     * - "40.7128°N, 74.0060°W" (degree format)
+     *
+     * Defined behaviors:
+     * - Spatial Indexing: The runtime automatically creates spatial indexes for efficient location-based queries
+     * - Distance Queries: Enables API endpoints for finding records within specified distances
+     * - Coordinate Validation: Validates that the input follows proper coordinate format
+     * - PostGIS Integration: When using PostgreSQL, automatically maps to PostGIS geometry types
+     */
+    SemanticType["GeospatialCoordinates"] = "Semantic#GeospatialCoordinates";
+    /**
+     * Annotates a field as an email address with validation and verification options.
+     */
+    SemanticType["Email"] = "Semantic#Email";
+    /**
+     * Annotates a field as a phone number with validation and formatting options.
+     */
+    SemanticType["Phone"] = "Semantic#Phone";
+    /**
+     * Annotates a field as a monetary value with currency support and precision control.
+     * Can store simple decimal amounts or complex objects with amount and currency.
+     * Enforces proper decimal handling to avoid floating-point errors.
+     */
+    SemanticType["Price"] = "Semantic#Price";
+    /**
+     * Annotates a field as a URL with validation and allowed protocols.
+     */
+    SemanticType["URL"] = "Semantic#URL";
+    /**
+     * Annotates a field as a Stock Keeping Unit (SKU).
+     * Enforces uniqueness at the database level, critical for product catalogs.
+     * Provides automatic validation and formatting for product identification codes.
+     */
+    SemanticType["SKU"] = "Semantic#SKU";
+    /**
+     * Annotates a field as a long-form description.
+     */
+    SemanticType["Description"] = "Semantic#Description";
+    /**
+     * Annotates a field as a short summary.
+     */
+    SemanticType["Summary"] = "Semantic#Summary";
+    /**
+     * Annotates a field as a calculated value based on a formula.
+     */
+    SemanticType["Calculated"] = "Semantic#Calculated";
+    /**
+     * Annotates a field as derived from other fields.
+     */
+    SemanticType["Derived"] = "Semantic#Derived";
+    //
     // Association-Level Semantics
+    //
     /**
      * Designates an association that links a resource to a "User" entity instance.
      * This is used to indicate ownership of the resource for access control purposes.
      * For example, a blog post might have a resource owner identifier that points to the user who created it.
+     *
+     * Defined behaviors:
+     * - Automatic Ownership: When a new record is created, this field is automatically populated with the ID of the authenticated user. It also creates a foreign relationship to the `User` semantic object.
+     * - Scoped Access: The runtime automatically filters list and read operations to show only records where the Owner matches the current user. update and delete operations are similarly restricted.
      */
     SemanticType["ResourceOwnerIdentifier"] = "Semantic#ResourceOwnerIdentifier";
+    /**
+     * Annotates an association as supporting tag functionality.
+     * Applied to associations between entities to enable tagging behavior.
+     * For example, a Product-Category association with Tags semantic enables product tagging.
+     */
+    SemanticType["Tags"] = "Semantic#Tags";
+    /**
+     * Annotates an association as supporting category functionality.
+     * Applied to associations between entities to enable categorization behavior.
+     * For example, a Product-Category association with Categories semantic enables product categorization.
+     */
+    SemanticType["Categories"] = "Semantic#Categories";
 })(SemanticType || (SemanticType = {}));
 /**
  * Defines the scope at which a semantic can be applied.
@@ -99,14 +229,18 @@ export const isAssociationSemantic = (semantic) => semantic.scope === SemanticSc
  * This acts as a central registry for the application.
  */
 export const DataSemantics = {
+    //
     // Entity-Level Definitions
+    //
     [SemanticType.User]: {
         id: SemanticType.User,
         displayName: 'User Entity',
         scope: SemanticScope.Entity,
         description: 'Designates an entity that represents system users, crucial for authentication and authorization.',
     },
+    //
     // Property-Level Definitions
+    //
     [SemanticType.Password]: {
         id: SemanticType.Password,
         displayName: 'User Password',
@@ -135,6 +269,55 @@ export const DataSemantics = {
         description: "Marks a field as the field that contains object's deletion timestamp.",
         applicableDataTypes: ['datetime'],
     },
+    [SemanticType.PublicUniqueName]: {
+        id: SemanticType.PublicUniqueName,
+        displayName: 'Public Unique Name (Slug)',
+        scope: SemanticScope.Property,
+        description: 'A user-friendly, unique public identifier for a resource, often used in URLs.',
+        applicableDataTypes: ['string'],
+    },
+    [SemanticType.Title]: {
+        id: SemanticType.Title,
+        displayName: 'Record Title',
+        scope: SemanticScope.Property,
+        description: 'A title for the record. Used as a source for the PublicUniqueName semantic.',
+        applicableDataTypes: ['string'],
+    },
+    [SemanticType.UserRole]: {
+        id: SemanticType.UserRole,
+        displayName: 'User Role Field',
+        scope: SemanticScope.Property,
+        description: "A text or enum field that defines the user's role for role-based authorization.",
+        applicableDataTypes: ['string'],
+    },
+    [SemanticType.Status]: {
+        id: SemanticType.Status,
+        displayName: 'Record Status',
+        scope: SemanticScope.Property,
+        description: 'A text or enum field to represent the state of a record.',
+        applicableDataTypes: ['string'],
+    },
+    [SemanticType.Version]: {
+        id: SemanticType.Version,
+        displayName: 'Version Number',
+        scope: SemanticScope.Property,
+        description: 'An integer field that automatically increments on every update.',
+        applicableDataTypes: ['number'],
+    },
+    [SemanticType.ImageURL]: {
+        id: SemanticType.ImageURL,
+        displayName: 'Image URL',
+        scope: SemanticScope.Property,
+        description: 'Annotates a field that holds a reference to an image data via an URL.',
+        applicableDataTypes: ['string'],
+    },
+    [SemanticType.FileURL]: {
+        id: SemanticType.FileURL,
+        displayName: 'File URL',
+        scope: SemanticScope.Property,
+        description: 'Annotates a field that holds a reference to a file object via an URL (non-image binary data).',
+        applicableDataTypes: ['string'],
+    },
     [SemanticType.DeletedFlag]: {
         id: SemanticType.DeletedFlag,
         displayName: 'Soft Delete Flag',
@@ -142,25 +325,110 @@ export const DataSemantics = {
         description: 'A boolean property that marks the object as deleted without physically removing it.',
         applicableDataTypes: ['boolean'],
     },
+    [SemanticType.Markdown]: {
+        id: SemanticType.Markdown,
+        displayName: 'Markdown Content',
+        scope: SemanticScope.Property,
+        description: 'A text field that contains markdown content.',
+        applicableDataTypes: ['string'],
+    },
+    [SemanticType.HTML]: {
+        id: SemanticType.HTML,
+        displayName: 'HTML Content',
+        scope: SemanticScope.Property,
+        description: 'Annotates a field that contains HTML content.',
+        applicableDataTypes: ['string'],
+    },
+    [SemanticType.GeospatialCoordinates]: {
+        id: SemanticType.GeospatialCoordinates,
+        displayName: 'Geospatial Coordinates',
+        scope: SemanticScope.Property,
+        description: 'Annotates a field that holds geospatial coordinate data (latitude/longitude).',
+        applicableDataTypes: ['string'],
+    },
+    [SemanticType.Email]: {
+        id: SemanticType.Email,
+        displayName: 'Email',
+        scope: SemanticScope.Property,
+        description: 'Annotates a field as an email address with validation and verification options.',
+        applicableDataTypes: ['string'],
+    },
+    [SemanticType.Phone]: {
+        id: SemanticType.Phone,
+        displayName: 'Phone',
+        scope: SemanticScope.Property,
+        description: 'Annotates a field as a phone number with validation and formatting options.',
+        applicableDataTypes: ['string'],
+    },
+    [SemanticType.Price]: {
+        id: SemanticType.Price,
+        displayName: 'Price',
+        scope: SemanticScope.Property,
+        description: 'Annotates a field as a monetary value with currency support and precision control.',
+        applicableDataTypes: ['number', 'string'],
+    },
+    [SemanticType.URL]: {
+        id: SemanticType.URL,
+        displayName: 'URL',
+        scope: SemanticScope.Property,
+        description: 'Annotates a field as a URL with validation and allowed protocols.',
+        applicableDataTypes: ['string'],
+    },
+    [SemanticType.SKU]: {
+        id: SemanticType.SKU,
+        displayName: 'SKU',
+        scope: SemanticScope.Property,
+        description: 'Annotates a field as a Stock Keeping Unit (SKU). Enforces uniqueness at the database level, critical for product catalogs. Provides automatic validation and formatting for product identification codes.',
+        applicableDataTypes: ['string'],
+    },
+    [SemanticType.Description]: {
+        id: SemanticType.Description,
+        displayName: 'Description',
+        scope: SemanticScope.Property,
+        description: 'Annotates a field as a long-form description.',
+        applicableDataTypes: ['string'],
+    },
+    [SemanticType.Summary]: {
+        id: SemanticType.Summary,
+        displayName: 'Summary',
+        scope: SemanticScope.Property,
+        description: 'Annotates a field as a short summary.',
+        applicableDataTypes: ['string'],
+    },
+    [SemanticType.Calculated]: {
+        id: SemanticType.Calculated,
+        displayName: 'Calculated',
+        scope: SemanticScope.Property,
+        description: 'Annotates a field as a calculated value based on a formula.',
+        applicableDataTypes: ['string'],
+    },
+    [SemanticType.Derived]: {
+        id: SemanticType.Derived,
+        displayName: 'Derived',
+        scope: SemanticScope.Property,
+        description: 'Annotates a field as derived from other fields.',
+        applicableDataTypes: ['string'],
+    },
+    //
+    // Association-Level Definitions
+    //
     [SemanticType.ResourceOwnerIdentifier]: {
         id: SemanticType.ResourceOwnerIdentifier,
         displayName: 'Resource Owner Identifier',
         scope: SemanticScope.Association,
         description: 'Links a resource to a "User" entity instance, indicating ownership for access control.',
     },
-    [SemanticType.PublicUniqueName]: {
-        id: SemanticType.PublicUniqueName,
-        displayName: 'Public Unique Name (Slug)',
-        scope: SemanticScope.Property,
-        description: 'A user-friendly, unique public identifier for a resource, often used in URLs.',
-        applicableDataTypes: ['string'],
+    [SemanticType.Tags]: {
+        id: SemanticType.Tags,
+        displayName: 'Tags',
+        scope: SemanticScope.Association,
+        description: 'Annotates an association as supporting tag functionality.',
     },
-    [SemanticType.UserRole]: {
-        id: SemanticType.UserRole,
-        displayName: 'User Role Field',
-        scope: SemanticScope.Property,
-        description: 'A text field that is recognized by the runtime as a role of a user in the API. Used with the role-based authorization strategy.',
-        applicableDataTypes: ['string'],
+    [SemanticType.Categories]: {
+        id: SemanticType.Categories,
+        displayName: 'Categories',
+        scope: SemanticScope.Association,
+        description: 'Annotates an association as supporting category functionality.',
     },
 };
 //# sourceMappingURL=Semantics.js.map

package/build/src/modeling/Semantics.js.map

@@ -1 +1 @@
-{"version":3,"file":"Semantics.js","sourceRoot":"","sources":["../../../src/modeling/Semantics.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,MAAM,CAAN,IAAY,YA0DX;AA1DD,WAAY,YAAY;IACtB,yBAAyB;IACzB;;OAEG;IACH,sCAAsB,CAAA;IAEtB,2BAA2B;IAC3B;;;;OAIG;IACH,8CAA8B,CAAA;IAC9B;;;OAGG;IACH,8DAA8C,CAAA;IAC9C;;;OAGG;IACH,8DAA8C,CAAA;IAC9C;;;;;OAKG;IACH,8DAA8C,CAAA;IAC9C;;;;OAIG;IACH,oDAAoC,CAAA;IACpC;;;;OAIG;IACH,8DAA8C,CAAA;IAC9C;;;;;;OAMG;IACH,8CAA8B,CAAA;IAC9B,8BAA8B;IAC9B;;;;OAIG;IACH,4EAA4D,CAAA;AAC9D,CAAC,EA1DW,YAAY,KAAZ,YAAY,QA0DvB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,aAgBX;AAhBD,WAAY,aAAa;IACvB;;;OAGG;IACH,kCAAiB,CAAA;IACjB;;;OAGG;IACH,sCAAqB,CAAA;IACrB;;;OAGG;IACH,4CAA2B,CAAA;AAC7B,CAAC,EAhBW,aAAa,KAAb,aAAa,QAgBxB;AAqDD;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,QAAsB,EAA8B,EAAE,CACrF,QAAQ,CAAC,KAAK,KAAK,aAAa,CAAC,MAAM,CAAA;AAEzC;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,QAAsB,EAAgC,EAAE,CACzF,QAAQ,CAAC,KAAK,KAAK,aAAa,CAAC,QAAQ,CAAA;AAE3C;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,QAAsB,EAAmC,EAAE,CAC/F,QAAQ,CAAC,KAAK,KAAK,aAAa,CAAC,WAAW,CAAA;AAO9C;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAuC;IAC/D,2BAA2B;IAC3B,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE;QACnB,EAAE,EAAE,YAAY,CAAC,IAAI;QACrB,WAAW,EAAE,aAAa;QAC1B,KAAK,EAAE,aAAa,CAAC,MAAM;QAC3B,WAAW,EAAE,kGAAkG;KAChH;IAED,6BAA6B;IAC7B,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE;QACvB,EAAE,EAAE,YAAY,CAAC,QAAQ;QACzB,WAAW,EAAE,eAAe;QAC5B,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EACT,6JAA6J;QAC/J,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;IACD,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE;QAC/B,EAAE,EAAE,YAAY,CAAC,gBAAgB;QACjC,WAAW,EAAE,oBAAoB;QACjC,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,yEAAyE;QACtF,mBAAmB,EAAE,CAAC,UAAU,CAAC;KAClC;IACD,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE;QAC/B,EAAE,EAAE,YAAY,CAAC,gBAAgB;QACjC,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,gFAAgF;QAC7F,mBAAmB,EAAE,CAAC,UAAU,CAAC;KAClC;IACD,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE;QAC/B,EAAE,EAAE,YAAY,CAAC,gBAAgB;QACjC,WAAW,EAAE,uBAAuB;QACpC,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,uEAAuE;QACpF,mBAAmB,EAAE,CAAC,UAAU,CAAC;KAClC;IACD,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE;QAC1B,EAAE,EAAE,YAAY,CAAC,WAAW;QAC5B,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,qFAAqF;QAClG,mBAAmB,EAAE,CAAC,SAAS,CAAC;KACjC;IACD,CAAC,YAAY,CAAC,uBAAuB,CAAC,EAAE;QACtC,EAAE,EAAE,YAAY,CAAC,uBAAuB;QACxC,WAAW,EAAE,2BAA2B;QACxC,KAAK,EAAE,aAAa,CAAC,WAAW;QAChC,WAAW,EAAE,wFAAwF;KACtG;IACD,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE;QAC/B,EAAE,EAAE,YAAY,CAAC,gBAAgB;QACjC,WAAW,EAAE,2BAA2B;QACxC,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,+EAA+E;QAC5F,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;IACD,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE;QACvB,EAAE,EAAE,YAAY,CAAC,QAAQ;QACzB,WAAW,EAAE,iBAAiB;QAC9B,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EACT,iIAAiI;QACnI,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;CACF,CAAA","sourcesContent":["/* eslint-disable max-len */\nimport type { DomainPropertyType } from './DataFormat.js'\n\n/**\n * Defines the names for all available data semantics.\n * Using a string enum makes it easy to add or remove semantics in a single place.\n */\nexport enum SemanticType {\n  // Entity-Level Semantics\n  /**\n   * Designates a Data Entity that represents users of the system.\n   */\n  User = 'Semantic#User',\n\n  // Property-Level Semantics\n  /**\n   * Annotates the field as the user password.\n   * The runtime should treat this field with special care,\n   * ensuring it is encrypted and not exposed in API responses.\n   */\n  Password = 'Semantic#Password',\n  /**\n   * Designates a Data Property as the `createdAt` timestamp of an entity.\n   * This is used to track when the entity was first created.\n   */\n  CreatedTimestamp = 'Semantic#CreatedTimestamp',\n  /**\n   * Designates a Data Property as the `updatedAt` timestamp of an entity.\n   * This is used to track when the entity was last modified.\n   */\n  UpdatedTimestamp = 'Semantic#UpdatedTimestamp',\n  /**\n   * Designates a Data Property as the `deletedAt` timestamp of an entity.\n   * This is used to track when the entity was soft-deleted.\n   * Soft-deletion means the entity is not physically removed from the database,\n   * but marked as deleted for logical deletion purposes.\n   */\n  DeletedTimestamp = 'Semantic#DeletedTimestamp',\n  /**\n   * Designates a Data Property as a boolean flag indicating whether the entity is deleted.\n   * This is used for soft-deletion, where the entity is not physically removed from the database,\n   * but marked as deleted.\n   */\n  DeletedFlag = 'Semantic#DeletedFlag',\n  /**\n   * Designates a Data Property as a unique public identifier for a resource.\n   * This is often used in URLs to provide a user-friendly way to access the resource.\n   * For example, a blog post might have a public unique name like \"my-first-post\".\n   */\n  PublicUniqueName = 'Semantic#PublicUniqueName',\n  /**\n   * Designates a Data Property as the `role` of a user within the system.\n   * This is used to define the user's permissions and access levels.\n   * For example, a user with the role of \"admin\" would have elevated permissions\n   * compared to a user with the role of \"guest\".\n   * Roles are defined on the entity as enums, or as a string property with a controlled vocabulary.\n   */\n  UserRole = 'Semantic#UserRole',\n  // Association-Level Semantics\n  /**\n   * Designates an association that links a resource to a \"User\" entity instance.\n   * This is used to indicate ownership of the resource for access control purposes.\n   * For example, a blog post might have a resource owner identifier that points to the user who created it.\n   */\n  ResourceOwnerIdentifier = 'Semantic#ResourceOwnerIdentifier',\n}\n\n/**\n * Defines the scope at which a semantic can be applied.\n */\nexport enum SemanticScope {\n  /**\n   * The semantic applies to an entire Data Entity.\n   * This is used for semantics that provide context or constraints at the entity level.\n   */\n  Entity = 'Entity',\n  /**\n   * The semantic applies to a single Data Property.\n   * This is used for semantics that provide context or constraints at the property level.\n   */\n  Property = 'Property',\n  /**\n   * The semantic applies to an Association between Data Entities.\n   * This is used for semantics that provide context or constraints at the association level.\n   */\n  Association = 'Association',\n}\n\n/**\n * A base interface for all Data Semantics, containing common properties.\n * A semantic is an annotation applied to a Data Entity, Property, or Association\n * to provide additional context or constraints.\n * This interface is extended by more specific semantic types.\n */\ninterface BaseDataSemantic {\n  /**\n   * A unique identifier for the semantic definition.\n   */\n  id: SemanticType\n  /**\n   * A human-readable name for the semantic.\n   */\n  displayName: string\n  /**\n   * A description of the semantic's purpose and impact.\n   */\n  description: string\n  /**\n   * Specifies whether the semantic applies to an Entity, Property, or Association.\n   */\n  scope: SemanticScope\n}\n\n/**\n * Represents a semantic that can be applied to an entire Data Entity.\n */\nexport interface EntitySemantic extends BaseDataSemantic {\n  scope: SemanticScope.Entity\n}\n\n/**\n * Represents a semantic that can be applied to a single property.\n */\nexport interface PropertySemantic extends BaseDataSemantic {\n  scope: SemanticScope.Property\n  /**\n   * Optional array of data types this semantic can be applied to.\n   * Enforces constraints, e.g., DeletedTimestamp on a DateTime property.\n   */\n  applicableDataTypes?: DomainPropertyType[]\n}\n\n/**\n * Represents a semantic that can be applied to an association between entities.\n */\nexport interface AssociationSemantic extends BaseDataSemantic {\n  scope: SemanticScope.Association\n}\n\n/**\n * A type guard to check if a semantic is an EntitySemantic.\n */\nexport const isEntitySemantic = (semantic: DataSemantic): semantic is EntitySemantic =>\n  semantic.scope === SemanticScope.Entity\n\n/**\n * A type guard to check if a semantic is a PropertySemantic.\n */\nexport const isPropertySemantic = (semantic: DataSemantic): semantic is PropertySemantic =>\n  semantic.scope === SemanticScope.Property\n\n/**\n * A type guard to check if a semantic is a AssociationSemantic.\n */\nexport const isAssociationSemantic = (semantic: DataSemantic): semantic is AssociationSemantic =>\n  semantic.scope === SemanticScope.Association\n\n/**\n * Union type for any kind of data semantic\n */\nexport type DataSemantic = EntitySemantic | PropertySemantic | AssociationSemantic\n\n/**\n * A map to store the definitions of all available data semantics.\n * This acts as a central registry for the application.\n */\nexport const DataSemantics: Record<SemanticType, DataSemantic> = {\n  // Entity-Level Definitions\n  [SemanticType.User]: {\n    id: SemanticType.User,\n    displayName: 'User Entity',\n    scope: SemanticScope.Entity,\n    description: 'Designates an entity that represents system users, crucial for authentication and authorization.',\n  },\n\n  // Property-Level Definitions\n  [SemanticType.Password]: {\n    id: SemanticType.Password,\n    displayName: 'User Password',\n    scope: SemanticScope.Property,\n    description:\n      'Annotates the field as the user password. The runtime should treat this field with special care, ensuring it is encrypted and not exposed in API responses.',\n    applicableDataTypes: ['string'],\n  },\n  [SemanticType.CreatedTimestamp]: {\n    id: SemanticType.CreatedTimestamp,\n    displayName: 'Creation Timestamp',\n    scope: SemanticScope.Property,\n    description: \"Marks a field as the one that contains the object's creation timestamp.\",\n    applicableDataTypes: ['datetime'],\n  },\n  [SemanticType.UpdatedTimestamp]: {\n    id: SemanticType.UpdatedTimestamp,\n    displayName: 'Update Timestamp',\n    scope: SemanticScope.Property,\n    description: \"Marks a field as the field that contains object's last modification timestamp.\",\n    applicableDataTypes: ['datetime'],\n  },\n  [SemanticType.DeletedTimestamp]: {\n    id: SemanticType.DeletedTimestamp,\n    displayName: 'Soft Delete Timestamp',\n    scope: SemanticScope.Property,\n    description: \"Marks a field as the field that contains object's deletion timestamp.\",\n    applicableDataTypes: ['datetime'],\n  },\n  [SemanticType.DeletedFlag]: {\n    id: SemanticType.DeletedFlag,\n    displayName: 'Soft Delete Flag',\n    scope: SemanticScope.Property,\n    description: 'A boolean property that marks the object as deleted without physically removing it.',\n    applicableDataTypes: ['boolean'],\n  },\n  [SemanticType.ResourceOwnerIdentifier]: {\n    id: SemanticType.ResourceOwnerIdentifier,\n    displayName: 'Resource Owner Identifier',\n    scope: SemanticScope.Association,\n    description: 'Links a resource to a \"User\" entity instance, indicating ownership for access control.',\n  },\n  [SemanticType.PublicUniqueName]: {\n    id: SemanticType.PublicUniqueName,\n    displayName: 'Public Unique Name (Slug)',\n    scope: SemanticScope.Property,\n    description: 'A user-friendly, unique public identifier for a resource, often used in URLs.',\n    applicableDataTypes: ['string'],\n  },\n  [SemanticType.UserRole]: {\n    id: SemanticType.UserRole,\n    displayName: 'User Role Field',\n    scope: SemanticScope.Property,\n    description:\n      'A text field that is recognized by the runtime as a role of a user in the API. Used with the role-based authorization strategy.',\n    applicableDataTypes: ['string'],\n  },\n}\n\n/**\n * Represents the application of a data semantic to a specific\n * entity or property within a user's data model.\n */\nexport interface AppliedDataSemantic {\n  /**\n   * The unique identifier of the semantic being applied.\n   */\n  id: SemanticType\n\n  /**\n   * Optional configuration or values specific to this application.\n   */\n  config?: Record<string, unknown>\n}\n"]}
+{"version":3,"file":"Semantics.js","sourceRoot":"","sources":["../../../src/modeling/Semantics.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,MAAM,CAAN,IAAY,YAuMX;AAvMD,WAAY,YAAY;IACtB,EAAE;IACF,yBAAyB;IACzB,EAAE;IAEF;;OAEG;IACH,sCAAsB,CAAA;IAEtB,EAAE;IACF,2BAA2B;IAC3B,EAAE;IAEF;;;;OAIG;IACH,8CAA8B,CAAA;IAC9B;;;OAGG;IACH,8DAA8C,CAAA;IAC9C;;;OAGG;IACH,8DAA8C,CAAA;IAC9C;;;;;OAKG;IACH,8DAA8C,CAAA;IAC9C;;;;OAIG;IACH,oDAAoC,CAAA;IACpC;;;;;;OAMG;IACH,8DAA8C,CAAA;IAC9C;;;;OAIG;IACH,wCAAwB,CAAA;IACxB;;;;;;OAMG;IACH,8CAA8B,CAAA;IAC9B;;;;;;;;;OASG;IACH,0CAA0B,CAAA;IAE1B;;;;OAIG;IACH,4CAA4B,CAAA;IAE5B;;;OAGG;IACH,8CAA8B,CAAA;IAE9B;;;OAGG;IACH,4CAA4B,CAAA;IAE5B;;;;;;OAMG;IACH,8CAA8B,CAAA;IAE9B;;;;;;OAMG;IACH,sCAAsB,CAAA;IAEtB;;;;;;;;;;;;;;;OAeG;IACH,wEAAwD,CAAA;IAExD;;OAEG;IACH,wCAAwB,CAAA;IACxB;;OAEG;IACH,wCAAwB,CAAA;IACxB;;;;OAIG;IACH,wCAAwB,CAAA;IACxB;;OAEG;IACH,oCAAoB,CAAA;IACpB;;;;OAIG;IACH,oCAAoB,CAAA;IACpB;;OAEG;IACH,oDAAoC,CAAA;IACpC;;OAEG;IACH,4CAA4B,CAAA;IAC5B;;OAEG;IACH,kDAAkC,CAAA;IAClC;;OAEG;IACH,4CAA4B,CAAA;IAE5B,EAAE;IACF,8BAA8B;IAC9B,EAAE;IAEF;;;;;;;;OAQG;IACH,4EAA4D,CAAA;IAC5D;;;;OAIG;IACH,sCAAsB,CAAA;IACtB;;;;OAIG;IACH,kDAAkC,CAAA;AACpC,CAAC,EAvMW,YAAY,KAAZ,YAAY,QAuMvB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,aAgBX;AAhBD,WAAY,aAAa;IACvB;;;OAGG;IACH,kCAAiB,CAAA;IACjB;;;OAGG;IACH,sCAAqB,CAAA;IACrB;;;OAGG;IACH,4CAA2B,CAAA;AAC7B,CAAC,EAhBW,aAAa,KAAb,aAAa,QAgBxB;AAqDD;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,QAAsB,EAA8B,EAAE,CACrF,QAAQ,CAAC,KAAK,KAAK,aAAa,CAAC,MAAM,CAAA;AAEzC;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,QAAsB,EAAgC,EAAE,CACzF,QAAQ,CAAC,KAAK,KAAK,aAAa,CAAC,QAAQ,CAAA;AAE3C;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,QAAsB,EAAmC,EAAE,CAC/F,QAAQ,CAAC,KAAK,KAAK,aAAa,CAAC,WAAW,CAAA;AAO9C;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAuC;IAC/D,EAAE;IACF,2BAA2B;IAC3B,EAAE;IAEF,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE;QACnB,EAAE,EAAE,YAAY,CAAC,IAAI;QACrB,WAAW,EAAE,aAAa;QAC1B,KAAK,EAAE,aAAa,CAAC,MAAM;QAC3B,WAAW,EAAE,kGAAkG;KAChH;IAED,EAAE;IACF,6BAA6B;IAC7B,EAAE;IAEF,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE;QACvB,EAAE,EAAE,YAAY,CAAC,QAAQ;QACzB,WAAW,EAAE,eAAe;QAC5B,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EACT,6JAA6J;QAC/J,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;IACD,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE;QAC/B,EAAE,EAAE,YAAY,CAAC,gBAAgB;QACjC,WAAW,EAAE,oBAAoB;QACjC,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,yEAAyE;QACtF,mBAAmB,EAAE,CAAC,UAAU,CAAC;KAClC;IACD,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE;QAC/B,EAAE,EAAE,YAAY,CAAC,gBAAgB;QACjC,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,gFAAgF;QAC7F,mBAAmB,EAAE,CAAC,UAAU,CAAC;KAClC;IACD,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE;QAC/B,EAAE,EAAE,YAAY,CAAC,gBAAgB;QACjC,WAAW,EAAE,uBAAuB;QACpC,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,uEAAuE;QACpF,mBAAmB,EAAE,CAAC,UAAU,CAAC;KAClC;IACD,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE;QAC/B,EAAE,EAAE,YAAY,CAAC,gBAAgB;QACjC,WAAW,EAAE,2BAA2B;QACxC,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,+EAA+E;QAC5F,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;IACD,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;QACpB,EAAE,EAAE,YAAY,CAAC,KAAK;QACtB,WAAW,EAAE,cAAc;QAC3B,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,6EAA6E;QAC1F,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;IACD,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE;QACvB,EAAE,EAAE,YAAY,CAAC,QAAQ;QACzB,WAAW,EAAE,iBAAiB;QAC9B,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,iFAAiF;QAC9F,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;IACD,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE;QACrB,EAAE,EAAE,YAAY,CAAC,MAAM;QACvB,WAAW,EAAE,eAAe;QAC5B,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,0DAA0D;QACvE,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;IACD,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE;QACtB,EAAE,EAAE,YAAY,CAAC,OAAO;QACxB,WAAW,EAAE,gBAAgB;QAC7B,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,iEAAiE;QAC9E,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;IACD,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE;QACvB,EAAE,EAAE,YAAY,CAAC,QAAQ;QACzB,WAAW,EAAE,WAAW;QACxB,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,uEAAuE;QACpF,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;IACD,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE;QACtB,EAAE,EAAE,YAAY,CAAC,OAAO;QACxB,WAAW,EAAE,UAAU;QACvB,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,+FAA+F;QAC5G,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;IACD,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE;QAC1B,EAAE,EAAE,YAAY,CAAC,WAAW;QAC5B,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,qFAAqF;QAClG,mBAAmB,EAAE,CAAC,SAAS,CAAC;KACjC;IACD,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE;QACvB,EAAE,EAAE,YAAY,CAAC,QAAQ;QACzB,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,8CAA8C;QAC3D,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;IACD,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE;QACnB,EAAE,EAAE,YAAY,CAAC,IAAI;QACrB,WAAW,EAAE,cAAc;QAC3B,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,+CAA+C;QAC5D,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;IACD,CAAC,YAAY,CAAC,qBAAqB,CAAC,EAAE;QACpC,EAAE,EAAE,YAAY,CAAC,qBAAqB;QACtC,WAAW,EAAE,wBAAwB;QACrC,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,+EAA+E;QAC5F,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;IACD,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;QACpB,EAAE,EAAE,YAAY,CAAC,KAAK;QACtB,WAAW,EAAE,OAAO;QACpB,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,iFAAiF;QAC9F,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;IACD,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;QACpB,EAAE,EAAE,YAAY,CAAC,KAAK;QACtB,WAAW,EAAE,OAAO;QACpB,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,6EAA6E;QAC1F,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;IACD,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;QACpB,EAAE,EAAE,YAAY,CAAC,KAAK;QACtB,WAAW,EAAE,OAAO;QACpB,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,oFAAoF;QACjG,mBAAmB,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC;KAC1C;IACD,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE;QAClB,EAAE,EAAE,YAAY,CAAC,GAAG;QACpB,WAAW,EAAE,KAAK;QAClB,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,mEAAmE;QAChF,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;IACD,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE;QAClB,EAAE,EAAE,YAAY,CAAC,GAAG;QACpB,WAAW,EAAE,KAAK;QAClB,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EACT,2MAA2M;QAC7M,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;IACD,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE;QAC1B,EAAE,EAAE,YAAY,CAAC,WAAW;QAC5B,WAAW,EAAE,aAAa;QAC1B,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,+CAA+C;QAC5D,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;IACD,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE;QACtB,EAAE,EAAE,YAAY,CAAC,OAAO;QACxB,WAAW,EAAE,SAAS;QACtB,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,uCAAuC;QACpD,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;IACD,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE;QACzB,EAAE,EAAE,YAAY,CAAC,UAAU;QAC3B,WAAW,EAAE,YAAY;QACzB,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,6DAA6D;QAC1E,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;IACD,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE;QACtB,EAAE,EAAE,YAAY,CAAC,OAAO;QACxB,WAAW,EAAE,SAAS;QACtB,KAAK,EAAE,aAAa,CAAC,QAAQ;QAC7B,WAAW,EAAE,iDAAiD;QAC9D,mBAAmB,EAAE,CAAC,QAAQ,CAAC;KAChC;IAED,EAAE;IACF,gCAAgC;IAChC,EAAE;IAEF,CAAC,YAAY,CAAC,uBAAuB,CAAC,EAAE;QACtC,EAAE,EAAE,YAAY,CAAC,uBAAuB;QACxC,WAAW,EAAE,2BAA2B;QACxC,KAAK,EAAE,aAAa,CAAC,WAAW;QAChC,WAAW,EAAE,wFAAwF;KACtG;IACD,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE;QACnB,EAAE,EAAE,YAAY,CAAC,IAAI;QACrB,WAAW,EAAE,MAAM;QACnB,KAAK,EAAE,aAAa,CAAC,WAAW;QAChC,WAAW,EAAE,2DAA2D;KACzE;IACD,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE;QACzB,EAAE,EAAE,YAAY,CAAC,UAAU;QAC3B,WAAW,EAAE,YAAY;QACzB,KAAK,EAAE,aAAa,CAAC,WAAW;QAChC,WAAW,EAAE,gEAAgE;KAC9E;CACF,CAAA","sourcesContent":["/* eslint-disable max-len */\nimport type { DomainPropertyType } from './DataFormat.js'\n\n/**\n * Defines the names for all available data semantics.\n * Using a string enum makes it easy to add or remove semantics in a single place.\n */\nexport enum SemanticType {\n  //\n  // Entity-Level Semantics\n  //\n\n  /**\n   * Designates a Data Entity that represents users of the system.\n   */\n  User = 'Semantic#User',\n\n  //\n  // Property-Level Semantics\n  //\n\n  /**\n   * Annotates the field as the user password.\n   * The runtime should treat this field with special care,\n   * ensuring it is encrypted and not exposed in API responses.\n   */\n  Password = 'Semantic#Password',\n  /**\n   * Designates a Data Property as the `createdAt` timestamp of an entity.\n   * This is used to track when the entity was first created.\n   */\n  CreatedTimestamp = 'Semantic#CreatedTimestamp',\n  /**\n   * Designates a Data Property as the `updatedAt` timestamp of an entity.\n   * This is used to track when the entity was last modified.\n   */\n  UpdatedTimestamp = 'Semantic#UpdatedTimestamp',\n  /**\n   * Designates a Data Property as the `deletedAt` timestamp of an entity.\n   * This is used to track when the entity was soft-deleted.\n   * Soft-deletion means the entity is not physically removed from the database,\n   * but marked as deleted for logical deletion purposes.\n   */\n  DeletedTimestamp = 'Semantic#DeletedTimestamp',\n  /**\n   * Designates a Data Property as a boolean flag indicating whether the entity is deleted.\n   * This is used for soft-deletion, where the entity is not physically removed from the database,\n   * but marked as deleted.\n   */\n  DeletedFlag = 'Semantic#DeletedFlag',\n  /**\n   * Designates a Data Property as a unique public identifier for a resource (the slug).\n   * This is often used in URLs to provide a user-friendly way to access the resource.\n   * For example, a blog post might have a public unique name like \"my-first-post\".\n   * A URL-friendly text field. The runtime automatically generates a unique, URL-safe string from another field (like a title or name). The user needs to specify which field is used to generate\n   * the slug.\n   */\n  PublicUniqueName = 'Semantic#PublicUniqueName',\n  /**\n   * A semantic that describes a title of an article, blog post, and so on. This semantic is used with\n   * the `PublicUniqueName` to determine which field is responsible for the slug generation. However,\n   * we may add more automation related to the `title` property in the future.\n   */\n  Title = 'Semantic#Title',\n  /**\n   * Designates a Data Property as the `role` of a user within the system.\n   * This is used to define the user's permissions and access levels.\n   * For example, a user with the role of \"admin\" would have elevated permissions\n   * compared to a user with the role of \"guest\".\n   * Roles are defined on the entity as enums, or as a string property with a controlled vocabulary.\n   */\n  UserRole = 'Semantic#UserRole',\n  /**\n   * A text or enum field to represent the state of a record (e.g., `draft`, `published`, `pending_review`, `archived`).\n   *\n   * Defined behaviors:\n   * - State-Based Filtering: Automatically prevents public users from seeing records in a draft state.\n   * - State Transitions: In principle, the runtime should prevent the user from skipping some states.\n   * For example, when the record is in the `draft` state, it cannot be moved to the `archived` state without publishing it first. However,\n   * we do not have enough customer feedback to design this functionality correctly right now, so\n   * it serves as a placeholder semantic annotation.\n   */\n  Status = 'Semantic#Status',\n\n  /**\n   * Annotates an integer field that automatically increments.\n   * The runtime automatically increments this number on every update, providing a simple way\n   * to track changes and implement optimistic locking to prevent mid-air collisions.\n   */\n  Version = 'Semantic#Version',\n\n  /**\n   * Annotates a field that holds a reference to an image data via an URL.\n   * The application + runtime should validate that the input is a well-formed URL.\n   */\n  ImageURL = 'Semantic#ImageURL',\n\n  /**\n   * Annotates a field that holds a reference to a file object via an URL. Ity is distinct from the\n   * `ImageURL` semantic as it implicitly states that the target is non-image, binary data (an attachment, for example).\n   */\n  FileURL = 'Semantic#FileURL',\n\n  /**\n   * Annotates the field as a markdown-interpreted field.\n   * When an object is created, the runtime performs additional sanitization to prevent XSS attacks.\n   *\n   * The annotation describes whether the data should be translated to the HTML output when\n   * record is read or the original MD content should be returned.\n   */\n  Markdown = 'Semantic#Markdown',\n\n  /**\n   * Annotates the field as containing HTML content.\n   * The runtime performs sanitization to prevent XSS attacks and validates HTML structure.\n   *\n   * The annotation describes whether the data should be rendered as HTML output when\n   * record is read or the original HTML content should be returned.\n   */\n  HTML = 'Semantic#HTML',\n\n  /**\n   * Annotates a field that holds geospatial coordinate data (latitude/longitude).\n   * The runtime automatically generates API capabilities for location-based queries,\n   * such as \"find all restaurants within a 5-mile radius.\"\n   *\n   * The field should contain coordinate data in a standard format:\n   * - \"40.7128,-74.0060\" (lat,lon)\n   * - \"POINT(-74.0060 40.7128)\" (PostGIS format)\n   * - \"40.7128°N, 74.0060°W\" (degree format)\n   *\n   * Defined behaviors:\n   * - Spatial Indexing: The runtime automatically creates spatial indexes for efficient location-based queries\n   * - Distance Queries: Enables API endpoints for finding records within specified distances\n   * - Coordinate Validation: Validates that the input follows proper coordinate format\n   * - PostGIS Integration: When using PostgreSQL, automatically maps to PostGIS geometry types\n   */\n  GeospatialCoordinates = 'Semantic#GeospatialCoordinates',\n\n  /**\n   * Annotates a field as an email address with validation and verification options.\n   */\n  Email = 'Semantic#Email',\n  /**\n   * Annotates a field as a phone number with validation and formatting options.\n   */\n  Phone = 'Semantic#Phone',\n  /**\n   * Annotates a field as a monetary value with currency support and precision control.\n   * Can store simple decimal amounts or complex objects with amount and currency.\n   * Enforces proper decimal handling to avoid floating-point errors.\n   */\n  Price = 'Semantic#Price',\n  /**\n   * Annotates a field as a URL with validation and allowed protocols.\n   */\n  URL = 'Semantic#URL',\n  /**\n   * Annotates a field as a Stock Keeping Unit (SKU).\n   * Enforces uniqueness at the database level, critical for product catalogs.\n   * Provides automatic validation and formatting for product identification codes.\n   */\n  SKU = 'Semantic#SKU',\n  /**\n   * Annotates a field as a long-form description.\n   */\n  Description = 'Semantic#Description',\n  /**\n   * Annotates a field as a short summary.\n   */\n  Summary = 'Semantic#Summary',\n  /**\n   * Annotates a field as a calculated value based on a formula.\n   */\n  Calculated = 'Semantic#Calculated',\n  /**\n   * Annotates a field as derived from other fields.\n   */\n  Derived = 'Semantic#Derived',\n\n  //\n  // Association-Level Semantics\n  //\n\n  /**\n   * Designates an association that links a resource to a \"User\" entity instance.\n   * This is used to indicate ownership of the resource for access control purposes.\n   * For example, a blog post might have a resource owner identifier that points to the user who created it.\n   *\n   * Defined behaviors:\n   * - Automatic Ownership: When a new record is created, this field is automatically populated with the ID of the authenticated user. It also creates a foreign relationship to the `User` semantic object.\n   * - Scoped Access: The runtime automatically filters list and read operations to show only records where the Owner matches the current user. update and delete operations are similarly restricted.\n   */\n  ResourceOwnerIdentifier = 'Semantic#ResourceOwnerIdentifier',\n  /**\n   * Annotates an association as supporting tag functionality.\n   * Applied to associations between entities to enable tagging behavior.\n   * For example, a Product-Category association with Tags semantic enables product tagging.\n   */\n  Tags = 'Semantic#Tags',\n  /**\n   * Annotates an association as supporting category functionality.\n   * Applied to associations between entities to enable categorization behavior.\n   * For example, a Product-Category association with Categories semantic enables product categorization.\n   */\n  Categories = 'Semantic#Categories',\n}\n\n/**\n * Defines the scope at which a semantic can be applied.\n */\nexport enum SemanticScope {\n  /**\n   * The semantic applies to an entire Data Entity.\n   * This is used for semantics that provide context or constraints at the entity level.\n   */\n  Entity = 'Entity',\n  /**\n   * The semantic applies to a single Data Property.\n   * This is used for semantics that provide context or constraints at the property level.\n   */\n  Property = 'Property',\n  /**\n   * The semantic applies to an Association between Data Entities.\n   * This is used for semantics that provide context or constraints at the association level.\n   */\n  Association = 'Association',\n}\n\n/**\n * A base interface for all Data Semantics, containing common properties.\n * A semantic is an annotation applied to a Data Entity, Property, or Association\n * to provide additional context or constraints.\n * This interface is extended by more specific semantic types.\n */\ninterface BaseDataSemantic {\n  /**\n   * A unique identifier for the semantic definition.\n   */\n  id: SemanticType\n  /**\n   * A human-readable name for the semantic.\n   */\n  displayName: string\n  /**\n   * A description of the semantic's purpose and impact.\n   */\n  description: string\n  /**\n   * Specifies whether the semantic applies to an Entity, Property, or Association.\n   */\n  scope: SemanticScope\n}\n\n/**\n * Represents a semantic that can be applied to an entire Data Entity.\n */\nexport interface EntitySemantic extends BaseDataSemantic {\n  scope: SemanticScope.Entity\n}\n\n/**\n * Represents a semantic that can be applied to a single property.\n */\nexport interface PropertySemantic extends BaseDataSemantic {\n  scope: SemanticScope.Property\n  /**\n   * Optional array of data types this semantic can be applied to.\n   * Enforces constraints, e.g., DeletedTimestamp on a DateTime property.\n   */\n  applicableDataTypes?: DomainPropertyType[]\n}\n\n/**\n * Represents a semantic that can be applied to an association between entities.\n */\nexport interface AssociationSemantic extends BaseDataSemantic {\n  scope: SemanticScope.Association\n}\n\n/**\n * A type guard to check if a semantic is an EntitySemantic.\n */\nexport const isEntitySemantic = (semantic: DataSemantic): semantic is EntitySemantic =>\n  semantic.scope === SemanticScope.Entity\n\n/**\n * A type guard to check if a semantic is a PropertySemantic.\n */\nexport const isPropertySemantic = (semantic: DataSemantic): semantic is PropertySemantic =>\n  semantic.scope === SemanticScope.Property\n\n/**\n * A type guard to check if a semantic is a AssociationSemantic.\n */\nexport const isAssociationSemantic = (semantic: DataSemantic): semantic is AssociationSemantic =>\n  semantic.scope === SemanticScope.Association\n\n/**\n * Union type for any kind of data semantic\n */\nexport type DataSemantic = EntitySemantic | PropertySemantic | AssociationSemantic\n\n/**\n * A map to store the definitions of all available data semantics.\n * This acts as a central registry for the application.\n */\nexport const DataSemantics: Record<SemanticType, DataSemantic> = {\n  //\n  // Entity-Level Definitions\n  //\n\n  [SemanticType.User]: {\n    id: SemanticType.User,\n    displayName: 'User Entity',\n    scope: SemanticScope.Entity,\n    description: 'Designates an entity that represents system users, crucial for authentication and authorization.',\n  },\n\n  //\n  // Property-Level Definitions\n  //\n\n  [SemanticType.Password]: {\n    id: SemanticType.Password,\n    displayName: 'User Password',\n    scope: SemanticScope.Property,\n    description:\n      'Annotates the field as the user password. The runtime should treat this field with special care, ensuring it is encrypted and not exposed in API responses.',\n    applicableDataTypes: ['string'],\n  },\n  [SemanticType.CreatedTimestamp]: {\n    id: SemanticType.CreatedTimestamp,\n    displayName: 'Creation Timestamp',\n    scope: SemanticScope.Property,\n    description: \"Marks a field as the one that contains the object's creation timestamp.\",\n    applicableDataTypes: ['datetime'],\n  },\n  [SemanticType.UpdatedTimestamp]: {\n    id: SemanticType.UpdatedTimestamp,\n    displayName: 'Update Timestamp',\n    scope: SemanticScope.Property,\n    description: \"Marks a field as the field that contains object's last modification timestamp.\",\n    applicableDataTypes: ['datetime'],\n  },\n  [SemanticType.DeletedTimestamp]: {\n    id: SemanticType.DeletedTimestamp,\n    displayName: 'Soft Delete Timestamp',\n    scope: SemanticScope.Property,\n    description: \"Marks a field as the field that contains object's deletion timestamp.\",\n    applicableDataTypes: ['datetime'],\n  },\n  [SemanticType.PublicUniqueName]: {\n    id: SemanticType.PublicUniqueName,\n    displayName: 'Public Unique Name (Slug)',\n    scope: SemanticScope.Property,\n    description: 'A user-friendly, unique public identifier for a resource, often used in URLs.',\n    applicableDataTypes: ['string'],\n  },\n  [SemanticType.Title]: {\n    id: SemanticType.Title,\n    displayName: 'Record Title',\n    scope: SemanticScope.Property,\n    description: 'A title for the record. Used as a source for the PublicUniqueName semantic.',\n    applicableDataTypes: ['string'],\n  },\n  [SemanticType.UserRole]: {\n    id: SemanticType.UserRole,\n    displayName: 'User Role Field',\n    scope: SemanticScope.Property,\n    description: \"A text or enum field that defines the user's role for role-based authorization.\",\n    applicableDataTypes: ['string'],\n  },\n  [SemanticType.Status]: {\n    id: SemanticType.Status,\n    displayName: 'Record Status',\n    scope: SemanticScope.Property,\n    description: 'A text or enum field to represent the state of a record.',\n    applicableDataTypes: ['string'],\n  },\n  [SemanticType.Version]: {\n    id: SemanticType.Version,\n    displayName: 'Version Number',\n    scope: SemanticScope.Property,\n    description: 'An integer field that automatically increments on every update.',\n    applicableDataTypes: ['number'],\n  },\n  [SemanticType.ImageURL]: {\n    id: SemanticType.ImageURL,\n    displayName: 'Image URL',\n    scope: SemanticScope.Property,\n    description: 'Annotates a field that holds a reference to an image data via an URL.',\n    applicableDataTypes: ['string'],\n  },\n  [SemanticType.FileURL]: {\n    id: SemanticType.FileURL,\n    displayName: 'File URL',\n    scope: SemanticScope.Property,\n    description: 'Annotates a field that holds a reference to a file object via an URL (non-image binary data).',\n    applicableDataTypes: ['string'],\n  },\n  [SemanticType.DeletedFlag]: {\n    id: SemanticType.DeletedFlag,\n    displayName: 'Soft Delete Flag',\n    scope: SemanticScope.Property,\n    description: 'A boolean property that marks the object as deleted without physically removing it.',\n    applicableDataTypes: ['boolean'],\n  },\n  [SemanticType.Markdown]: {\n    id: SemanticType.Markdown,\n    displayName: 'Markdown Content',\n    scope: SemanticScope.Property,\n    description: 'A text field that contains markdown content.',\n    applicableDataTypes: ['string'],\n  },\n  [SemanticType.HTML]: {\n    id: SemanticType.HTML,\n    displayName: 'HTML Content',\n    scope: SemanticScope.Property,\n    description: 'Annotates a field that contains HTML content.',\n    applicableDataTypes: ['string'],\n  },\n  [SemanticType.GeospatialCoordinates]: {\n    id: SemanticType.GeospatialCoordinates,\n    displayName: 'Geospatial Coordinates',\n    scope: SemanticScope.Property,\n    description: 'Annotates a field that holds geospatial coordinate data (latitude/longitude).',\n    applicableDataTypes: ['string'],\n  },\n  [SemanticType.Email]: {\n    id: SemanticType.Email,\n    displayName: 'Email',\n    scope: SemanticScope.Property,\n    description: 'Annotates a field as an email address with validation and verification options.',\n    applicableDataTypes: ['string'],\n  },\n  [SemanticType.Phone]: {\n    id: SemanticType.Phone,\n    displayName: 'Phone',\n    scope: SemanticScope.Property,\n    description: 'Annotates a field as a phone number with validation and formatting options.',\n    applicableDataTypes: ['string'],\n  },\n  [SemanticType.Price]: {\n    id: SemanticType.Price,\n    displayName: 'Price',\n    scope: SemanticScope.Property,\n    description: 'Annotates a field as a monetary value with currency support and precision control.',\n    applicableDataTypes: ['number', 'string'],\n  },\n  [SemanticType.URL]: {\n    id: SemanticType.URL,\n    displayName: 'URL',\n    scope: SemanticScope.Property,\n    description: 'Annotates a field as a URL with validation and allowed protocols.',\n    applicableDataTypes: ['string'],\n  },\n  [SemanticType.SKU]: {\n    id: SemanticType.SKU,\n    displayName: 'SKU',\n    scope: SemanticScope.Property,\n    description:\n      'Annotates a field as a Stock Keeping Unit (SKU). Enforces uniqueness at the database level, critical for product catalogs. Provides automatic validation and formatting for product identification codes.',\n    applicableDataTypes: ['string'],\n  },\n  [SemanticType.Description]: {\n    id: SemanticType.Description,\n    displayName: 'Description',\n    scope: SemanticScope.Property,\n    description: 'Annotates a field as a long-form description.',\n    applicableDataTypes: ['string'],\n  },\n  [SemanticType.Summary]: {\n    id: SemanticType.Summary,\n    displayName: 'Summary',\n    scope: SemanticScope.Property,\n    description: 'Annotates a field as a short summary.',\n    applicableDataTypes: ['string'],\n  },\n  [SemanticType.Calculated]: {\n    id: SemanticType.Calculated,\n    displayName: 'Calculated',\n    scope: SemanticScope.Property,\n    description: 'Annotates a field as a calculated value based on a formula.',\n    applicableDataTypes: ['string'],\n  },\n  [SemanticType.Derived]: {\n    id: SemanticType.Derived,\n    displayName: 'Derived',\n    scope: SemanticScope.Property,\n    description: 'Annotates a field as derived from other fields.',\n    applicableDataTypes: ['string'],\n  },\n\n  //\n  // Association-Level Definitions\n  //\n\n  [SemanticType.ResourceOwnerIdentifier]: {\n    id: SemanticType.ResourceOwnerIdentifier,\n    displayName: 'Resource Owner Identifier',\n    scope: SemanticScope.Association,\n    description: 'Links a resource to a \"User\" entity instance, indicating ownership for access control.',\n  },\n  [SemanticType.Tags]: {\n    id: SemanticType.Tags,\n    displayName: 'Tags',\n    scope: SemanticScope.Association,\n    description: 'Annotates an association as supporting tag functionality.',\n  },\n  [SemanticType.Categories]: {\n    id: SemanticType.Categories,\n    displayName: 'Categories',\n    scope: SemanticScope.Association,\n    description: 'Annotates an association as supporting category functionality.',\n  },\n}\n\n/**\n * Represents the application of a data semantic to a specific\n * entity or property within a user's data model.\n */\nexport interface AppliedDataSemantic {\n  /**\n   * The unique identifier of the semantic being applied.\n   */\n  id: SemanticType\n\n  /**\n   * Optional configuration or values specific to this application.\n   */\n  config?: Record<string, unknown>\n}\n"]}

package/build/src/modeling/definitions/Calculated.d.ts

@@ -0,0 +1,54 @@
+import type { AppliedDataSemantic } from '../Semantics.js';
+import { SemanticType } from '../Semantics.js';
+/**
+ * Configuration options for the Calculated semantic.
+ * Controls formula, dependencies, and recalculation behavior.
+ *
+ * Use Calculated when you need mathematical operations, aggregations, or complex business logic.
+ */
+export interface CalculatedConfig {
+    /**
+     * Formula to calculate the value (e.g., 'price * quantity').
+     */
+    formula: string;
+    /**
+     * List of field names this calculation depends on.
+     */
+    dependencies?: string[];
+    /**
+     * Whether to recalculate the value on update (default: true).
+     */
+    recalculateOnUpdate?: boolean;
+    /**
+     * Whether to allow manual override of the calculated value.
+     */
+    allowManualOverride?: boolean;
+    /**
+     * Custom metadata for the calculated field.
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * Index signature to allow additional properties.
+     */
+    [key: string]: unknown;
+}
+/**
+ * Type-safe configuration for Calculated semantic.
+ */
+export interface AppliedCalculatedSemantic extends AppliedDataSemantic {
+    id: SemanticType.Calculated;
+    config?: CalculatedConfig;
+}
+/**
+ * Type guard to check if a semantic is a Calculated semantic.
+ */
+export declare const isCalculatedSemantic: (semantic: AppliedDataSemantic) => semantic is AppliedCalculatedSemantic;
+/**
+ * Helper function to create a Calculated semantic with configuration.
+ */
+export declare const createCalculatedSemantic: (config: CalculatedConfig) => AppliedCalculatedSemantic;
+/**
+ * Default configuration for Calculated semantic.
+ */
+export declare const DEFAULT_CALCULATED_CONFIG: Partial<CalculatedConfig>;
+//# sourceMappingURL=Calculated.d.ts.map

package/build/src/modeling/definitions/Calculated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Calculated.d.ts","sourceRoot":"","sources":["../../../../src/modeling/definitions/Calculated.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAE9C;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClC;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,mBAAmB;IACpE,EAAE,EAAE,YAAY,CAAC,UAAU,CAAA;IAC3B,MAAM,CAAC,EAAE,gBAAgB,CAAA;CAC1B;AAED;;GAEG;AACH,eAAO,MAAM,oBAAoB,GAAI,UAAU,mBAAmB,KAAG,QAAQ,IAAI,yBAEhF,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,wBAAwB,GAAI,QAAQ,gBAAgB,KAAG,yBAanE,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,yBAAyB,EAAE,OAAO,CAAC,gBAAgB,CAG/D,CAAA"}

package/build/src/modeling/definitions/Calculated.js

@@ -0,0 +1,31 @@
+import { SemanticType } from '../Semantics.js';
+/**
+ * Type guard to check if a semantic is a Calculated semantic.
+ */
+export const isCalculatedSemantic = (semantic) => {
+    return semantic.id === SemanticType.Calculated;
+};
+/**
+ * Helper function to create a Calculated semantic with configuration.
+ */
+export const createCalculatedSemantic = (config) => {
+    const mergedConfig = {
+        ...DEFAULT_CALCULATED_CONFIG,
+        ...config,
+    };
+    if (config.metadata) {
+        mergedConfig.metadata = { ...config.metadata };
+    }
+    return {
+        id: SemanticType.Calculated,
+        config: mergedConfig,
+    };
+};
+/**
+ * Default configuration for Calculated semantic.
+ */
+export const DEFAULT_CALCULATED_CONFIG = {
+    recalculateOnUpdate: true,
+    allowManualOverride: false,
+};
+//# sourceMappingURL=Calculated.js.map

package/build/src/modeling/definitions/Calculated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Calculated.js","sourceRoot":"","sources":["../../../../src/modeling/definitions/Calculated.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AA2C9C;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,QAA6B,EAAyC,EAAE;IAC3G,OAAO,QAAQ,CAAC,EAAE,KAAK,YAAY,CAAC,UAAU,CAAA;AAChD,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,MAAwB,EAA6B,EAAE;IAC9F,MAAM,YAAY,GAAG;QACnB,GAAG,yBAAyB;QAC5B,GAAG,MAAM;KACV,CAAA;IACD,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QACpB,YAAY,CAAC,QAAQ,GAAG,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAA;IAChD,CAAC;IAED,OAAO;QACL,EAAE,EAAE,YAAY,CAAC,UAAU;QAC3B,MAAM,EAAE,YAAY;KACrB,CAAA;AACH,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAA8B;IAClE,mBAAmB,EAAE,IAAI;IACzB,mBAAmB,EAAE,KAAK;CAC3B,CAAA","sourcesContent":["import type { AppliedDataSemantic } from '../Semantics.js'\nimport { SemanticType } from '../Semantics.js'\n\n/**\n * Configuration options for the Calculated semantic.\n * Controls formula, dependencies, and recalculation behavior.\n *\n * Use Calculated when you need mathematical operations, aggregations, or complex business logic.\n */\nexport interface CalculatedConfig {\n  /**\n   * Formula to calculate the value (e.g., 'price * quantity').\n   */\n  formula: string\n  /**\n   * List of field names this calculation depends on.\n   */\n  dependencies?: string[]\n  /**\n   * Whether to recalculate the value on update (default: true).\n   */\n  recalculateOnUpdate?: boolean\n  /**\n   * Whether to allow manual override of the calculated value.\n   */\n  allowManualOverride?: boolean\n  /**\n   * Custom metadata for the calculated field.\n   */\n  metadata?: Record<string, unknown>\n  /**\n   * Index signature to allow additional properties.\n   */\n  [key: string]: unknown\n}\n\n/**\n * Type-safe configuration for Calculated semantic.\n */\nexport interface AppliedCalculatedSemantic extends AppliedDataSemantic {\n  id: SemanticType.Calculated\n  config?: CalculatedConfig\n}\n\n/**\n * Type guard to check if a semantic is a Calculated semantic.\n */\nexport const isCalculatedSemantic = (semantic: AppliedDataSemantic): semantic is AppliedCalculatedSemantic => {\n  return semantic.id === SemanticType.Calculated\n}\n\n/**\n * Helper function to create a Calculated semantic with configuration.\n */\nexport const createCalculatedSemantic = (config: CalculatedConfig): AppliedCalculatedSemantic => {\n  const mergedConfig = {\n    ...DEFAULT_CALCULATED_CONFIG,\n    ...config,\n  }\n  if (config.metadata) {\n    mergedConfig.metadata = { ...config.metadata }\n  }\n\n  return {\n    id: SemanticType.Calculated,\n    config: mergedConfig,\n  }\n}\n\n/**\n * Default configuration for Calculated semantic.\n */\nexport const DEFAULT_CALCULATED_CONFIG: Partial<CalculatedConfig> = {\n  recalculateOnUpdate: true,\n  allowManualOverride: false,\n}\n"]}

package/build/src/modeling/definitions/Categories.d.ts

@@ -0,0 +1,60 @@
+import type { AppliedDataSemantic } from '../Semantics.js';
+import { SemanticType } from '../Semantics.js';
+/**
+ * Configuration options for the Categories semantic.
+ * Controls allowed categories, hierarchy, and formatting for associations.
+ */
+export interface CategoriesConfig {
+    /**
+     * List of allowed categories.
+     */
+    allowedCategories?: string[];
+    /**
+     * Whether to allow custom categories not in the allowedCategories list.
+     */
+    allowCustomCategories?: boolean;
+    /**
+     * Whether to allow hierarchical categories (tree structure).
+     */
+    allowHierarchy?: boolean;
+    /**
+     * Maximum depth of the category hierarchy.
+     */
+    maxDepth?: number;
+    /**
+     * Whether categories are case sensitive.
+     */
+    caseSensitive?: boolean;
+    /**
+     * Whether to allow Unicode characters in categories.
+     */
+    allowUnicode?: boolean;
+    /**
+     * Custom metadata for the categories association.
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * Index signature to allow additional properties.
+     */
+    [key: string]: unknown;
+}
+/**
+ * Type-safe configuration for Categories semantic.
+ */
+export interface AppliedCategoriesSemantic extends AppliedDataSemantic {
+    id: SemanticType.Categories;
+    config?: CategoriesConfig;
+}
+/**
+ * Type guard to check if a semantic is a Categories semantic.
+ */
+export declare const isCategoriesSemantic: (semantic: AppliedDataSemantic) => semantic is AppliedCategoriesSemantic;
+/**
+ * Helper function to create a Categories semantic with configuration.
+ */
+export declare const createCategoriesSemantic: (config?: CategoriesConfig) => AppliedCategoriesSemantic;
+/**
+ * Default configuration for Categories semantic.
+ */
+export declare const DEFAULT_CATEGORIES_CONFIG: CategoriesConfig;
+//# sourceMappingURL=Categories.d.ts.map

package/build/src/modeling/definitions/Categories.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Categories.d.ts","sourceRoot":"","sources":["../../../../src/modeling/definitions/Categories.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAE9C;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC5B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClC;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,mBAAmB;IACpE,EAAE,EAAE,YAAY,CAAC,UAAU,CAAA;IAC3B,MAAM,CAAC,EAAE,gBAAgB,CAAA;CAC1B;AAED;;GAEG;AACH,eAAO,MAAM,oBAAoB,GAAI,UAAU,mBAAmB,KAAG,QAAQ,IAAI,yBAEhF,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,wBAAwB,GAAI,SAAQ,gBAAqB,KAAG,yBAaxE,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,yBAAyB,EAAE,gBAKvC,CAAA"}