@api-client/core 0.18.26 → 0.18.28

package/build/src/modeling/ApiModel.d.ts

@@ -1,6 +1,6 @@
 import { ApiModelKind } from '../models/kinds.js';
 import { type IThing, Thing } from '../models/Thing.js';
-import type { AccessRule, AssociationTarget, AuthenticationConfiguration, AuthorizationConfiguration, ExposedEntity, RateLimitingConfiguration, SessionConfiguration } from './types.js';
+import type { AccessRule, AssociationTarget, AuthenticationConfiguration, AuthorizationConfiguration, ExposedEntity, RateLimitingConfiguration, SessionConfiguration, ExposeOptions } from './types.js';
 import { DataDomain } from './DataDomain.js';
 import { DependentModel, type DependentModelSchema, type DomainDependency } from './DependentModel.js';
 /**
@@ -39,12 +39,12 @@ export interface ApiModelSchema extends DependentModelSchema {
      */
     kind: typeof ApiModelKind;
     /**
-     * The unique key of the data domain schema.
+     * The unique key of the API model schema.
      * This is a stable identifier that does not change across versions.
      */
     key: string;
     /**
-     * Contains the name, display name, description, and the version of the data domain schema.
+     * Contains the name, display name, description, and the version of the API model schema.
      */
     info: IThing;
     /**
@@ -190,21 +190,30 @@ export declare class ApiModel extends DependentModel {
     /**
      * Exposes a new entity in the API model.
      * If the entity already exists, it returns the existing one.
-     * @param entityKey The key of the entity to expose.
+     * @param entity The entity key and domain to expose.
      * @returns The exposed entity.
      */
-    exposeEntity(entityKey: string): ExposedEntity;
+    exposeEntity(entity: AssociationTarget, options?: ExposeOptions): ExposedEntity;
+    /**
+     * Follows associations for a newly exposed entity if configured to do so.
+     * This creates nested exposures based on the entity's associations.
+     *
+     * @param parentExposure The root exposure to follow associations from
+     * @param options The expose options containing follow configuration
+     */
+    private followEntityAssociations;
     /**
-     * Removes an entity from the API model.
-     * @param entityKey The key of the entity to remove.
+     * Removes an exposed entity from the API model.
+     * @param entity The entity to remove.
      */
-    removeEntity(entityKey: string): void;
+    removeEntity(entity: AssociationTarget): void;
+    private removeWithChildren;
     /**
      * Returns the exposed entity by its key.
      * @param entityKey The key of the entity to find.
      * @returns The exposed entity or undefined if not found.
      */
-    getExposedEntity(entityKey: string): ExposedEntity | undefined;
+    getExposedEntity(entity: AssociationTarget): ExposedEntity | undefined;
     /**
      * Clears the API model for a new entity change.
      * This method resets the dependencies, exposes, user,

package/build/src/modeling/ApiModel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ApiModel.d.ts","sourceRoot":"","sources":["../../../src/modeling/ApiModel.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAkB,MAAM,oBAAoB,CAAA;AACjE,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AACvD,OAAO,KAAK,EACV,UAAU,EACV,iBAAiB,EACjB,2BAA2B,EAC3B,0BAA0B,EAC1B,aAAa,EACb,yBAAyB,EAEzB,oBAAoB,EAErB,MAAM,YAAY,CAAA;AACnB,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,KAAK,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AAGtG;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,cAAe,SAAQ,oBAAoB;IAC1D;;OAEG;IACH,IAAI,EAAE,OAAO,YAAY,CAAA;IACzB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;;;;OAKG;IACH,IAAI,CAAC,EAAE,iBAAiB,CAAA;IAExB;;;OAGG;IACH,cAAc,CAAC,EAAE,2BAA2B,CAAA;IAE5C;;;OAGG;IACH,aAAa,CAAC,EAAE,0BAA0B,CAAA;IAE1C;;;OAGG;IACH,OAAO,CAAC,EAAE,oBAAoB,CAAA;IAC9B;;;OAGG;IACH,OAAO,EAAE,aAAa,EAAE,CAAA;IAExB;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,UAAU,EAAE,CAAA;IACzB;;;OAGG;IACH,YAAY,CAAC,EAAE,yBAAyB,CAAA;IACxC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,CAAA;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,CAAA;CACrB;AAED,qBAAa,QAAS,SAAQ,cAAc;;IAC1C;;OAEG;IACH,IAAI,EAAE,OAAO,YAAY,CAAA;IACzB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,IAAI,EAAE,KAAK,CAAA;IACX;;;;;OAKG;IACH,IAAI,CAAC,EAAE,iBAAiB,CAAA;IAExB;;;OAGG;IACH,cAAc,CAAC,EAAE,2BAA2B,CAAA;IAE5C;;;OAGG;IACH,aAAa,CAAC,EAAE,0BAA0B,CAAA;IAE1C;;;OAGG;IACH,OAAO,CAAC,EAAE,oBAAoB,CAAA;IAC9B;;;OAGG;IACH,OAAO,EAAE,aAAa,EAAE,CAAA;IACxB;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,UAAU,EAAE,CAAA;IACzB;;;OAGG;IACH,YAAY,CAAC,EAAE,yBAAyB,CAAA;IACxC;;OAEG;IACS,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAA;IACvD;;OAEG;IACuB,QAAQ,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,CAAA;IAClE;;OAEG;IACuB,QAAQ,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,CAAA;IAgBlE;;;;;;;OAOG;IACH,IAAI,MAAM,IAAI,UAAU,GAAG,SAAS,CAMnC;IAED,MAAM,CAAC,YAAY,CAAC,KAAK,GAAE,OAAO,CAAC,cAAc,CAAM,GAAG,cAAc;gBA0C5D,KAAK,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,EAAE,gBAAgB;IAkDtE,MAAM,IAAI,cAAc;IAwCxB;;;;OAIG;IACH,YAAY;IAYZ;;;;;OAKG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,aAAa;IAc9C;;;OAGG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAOrC;;;;OAIG;IACH,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS;IAI9D;;;;OAIG;IACH,oBAAoB,IAAI,IAAI;IAkB5B;;;;;;OAMG;IACH,gBAAgB,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI;CAS3C"}
+{"version":3,"file":"ApiModel.d.ts","sourceRoot":"","sources":["../../../src/modeling/ApiModel.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAkB,MAAM,oBAAoB,CAAA;AACjE,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AACvD,OAAO,KAAK,EACV,UAAU,EACV,iBAAiB,EACjB,2BAA2B,EAC3B,0BAA0B,EAC1B,aAAa,EACb,yBAAyB,EAEzB,oBAAoB,EAEpB,aAAa,EACd,MAAM,YAAY,CAAA;AACnB,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,KAAK,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AAKtG;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,cAAe,SAAQ,oBAAoB;IAC1D;;OAEG;IACH,IAAI,EAAE,OAAO,YAAY,CAAA;IACzB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;;;;OAKG;IACH,IAAI,CAAC,EAAE,iBAAiB,CAAA;IAExB;;;OAGG;IACH,cAAc,CAAC,EAAE,2BAA2B,CAAA;IAE5C;;;OAGG;IACH,aAAa,CAAC,EAAE,0BAA0B,CAAA;IAE1C;;;OAGG;IACH,OAAO,CAAC,EAAE,oBAAoB,CAAA;IAC9B;;;OAGG;IACH,OAAO,EAAE,aAAa,EAAE,CAAA;IAExB;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,UAAU,EAAE,CAAA;IACzB;;;OAGG;IACH,YAAY,CAAC,EAAE,yBAAyB,CAAA;IACxC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,CAAA;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,CAAA;CACrB;AAED,qBAAa,QAAS,SAAQ,cAAc;;IAC1C;;OAEG;IACH,IAAI,EAAE,OAAO,YAAY,CAAA;IACzB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,IAAI,EAAE,KAAK,CAAA;IACX;;;;;OAKG;IACH,IAAI,CAAC,EAAE,iBAAiB,CAAA;IAExB;;;OAGG;IACH,cAAc,CAAC,EAAE,2BAA2B,CAAA;IAE5C;;;OAGG;IACH,aAAa,CAAC,EAAE,0BAA0B,CAAA;IAE1C;;;OAGG;IACH,OAAO,CAAC,EAAE,oBAAoB,CAAA;IAC9B;;;OAGG;IACH,OAAO,EAAE,aAAa,EAAE,CAAA;IACxB;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,UAAU,EAAE,CAAA;IACzB;;;OAGG;IACH,YAAY,CAAC,EAAE,yBAAyB,CAAA;IACxC;;OAEG;IACS,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAA;IACvD;;OAEG;IACuB,QAAQ,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,CAAA;IAClE;;OAEG;IACuB,QAAQ,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,CAAA;IAgBlE;;;;;;;OAOG;IACH,IAAI,MAAM,IAAI,UAAU,GAAG,SAAS,CAMnC;IAED,MAAM,CAAC,YAAY,CAAC,KAAK,GAAE,OAAO,CAAC,cAAc,CAAM,GAAG,cAAc;gBA0C5D,KAAK,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,EAAE,gBAAgB;IAkDtE,MAAM,IAAI,cAAc;IAwCxB;;;;OAIG;IACH,YAAY;IAYZ;;;;;OAKG;IACH,YAAY,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,aAAa;IAyC/E;;;;;;OAMG;IACH,OAAO,CAAC,wBAAwB;IAiFhC;;;OAGG;IACH,YAAY,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;IAS7C,OAAO,CAAC,kBAAkB;IAwB1B;;;;OAIG;IACH,gBAAgB,CAAC,MAAM,EAAE,iBAAiB,GAAG,aAAa,GAAG,SAAS;IAItE;;;;OAIG;IACH,oBAAoB,IAAI,IAAI;IAkB5B;;;;;;OAMG;IACH,gBAAgB,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI;CAS3C"}

package/build/src/modeling/ApiModel.js

@@ -5,6 +5,8 @@ import { Thing } from '../models/Thing.js';
 import { DataDomain } from './DataDomain.js';
 import { DependentModel } from './DependentModel.js';
 import { observed, toRaw } from '../decorators/observed.js';
+import pluralize from '@jarrodek/pluralize';
+import { createDomainKey } from './helpers/keying.js';
 let ApiModel = (() => {
     let _classSuper = DependentModel;
     let _termsOfService_decorators;
@@ -277,40 +279,166 @@ let ApiModel = (() => {
         /**
          * Exposes a new entity in the API model.
          * If the entity already exists, it returns the existing one.
-         * @param entityKey The key of the entity to expose.
+         * @param entity The entity key and domain to expose.
          * @returns The exposed entity.
          */
-        exposeEntity(entityKey) {
-            const existing = this.exposes.find((e) => e.key === entityKey);
+        exposeEntity(entity, options) {
+            const domain = this.domain;
+            if (!domain) {
+                throw new Error(`No domain attached to API model`);
+            }
+            // checks whether the entity is already exposed as a root exposure.
+            const existing = this.exposes.find((e) => e.isRoot && e.entity.key === entity.key && e.entity.domain === entity.domain);
             if (existing) {
+                // quietly return the existing exposure
+                // TBD: should we throw an error here?
                 return existing;
             }
+            const domainEntity = domain.findEntity(entity.key, entity.domain);
+            if (!domainEntity) {
+                throw new Error(`Entity not found in domain: ${entity.key}`);
+            }
+            const name = domainEntity.info.name || '';
             const newEntity = {
-                key: entityKey,
+                key: nanoid(),
+                entity: { ...entity },
                 actions: [],
+                isRoot: true,
+                path: pluralize(name.toLocaleLowerCase()),
             };
+            if (options) {
+                newEntity.exposeOptions = { ...options };
+            }
             this.exposes.push(newEntity);
+            // Follow associations if requested
+            if (options?.followAssociations) {
+                if (options?.maxDepth === undefined || options.maxDepth > 0) {
+                    this.followEntityAssociations(newEntity, options);
+                }
+            }
             this.notifyChange();
             return newEntity;
         }
         /**
-         * Removes an entity from the API model.
-         * @param entityKey The key of the entity to remove.
+         * Follows associations for a newly exposed entity if configured to do so.
+         * This creates nested exposures based on the entity's associations.
+         *
+         * @param parentExposure The root exposure to follow associations from
+         * @param options The expose options containing follow configuration
          */
-        removeEntity(entityKey) {
-            const index = this.exposes.findIndex((e) => e.key === entityKey);
-            if (index !== -1) {
-                this.exposes.splice(index, 1);
-                this.notifyChange();
+        followEntityAssociations(parentExposure, options) {
+            const domain = this.domain;
+            if (!domain) {
+                return;
             }
+            const maxDepth = options.maxDepth ?? 6;
+            const visited = new Set();
+            // Add parent entity's key to the visited set so we won't skip it when traversing
+            // associations.
+            visited.add(createDomainKey(parentExposure.entity));
+            const follow = (currentEntity, parentKey, depth) => {
+                // Find the domain entity
+                const domainEntity = domain.findEntity(currentEntity.key, currentEntity.domain);
+                if (!domainEntity)
+                    return;
+                // Iterate through associations
+                for (const association of domainEntity.listAssociations()) {
+                    for (const target of association.targets) {
+                        // Skip self-referencing associations
+                        if (target.key === currentEntity.key && target.domain === currentEntity.domain) {
+                            continue;
+                        }
+                        // Create unique identifier for circular detection
+                        const visitKey = createDomainKey(target);
+                        if (visited.has(visitKey)) {
+                            continue; // Skip circular references
+                        }
+                        visited.add(visitKey);
+                        // Check if this nested exposure already exists
+                        const existingNested = this.exposes.find((e) => !e.isRoot &&
+                            e.entity.key === target.key &&
+                            e.entity.domain === target.domain &&
+                            e.parent?.key === parentKey);
+                        if (existingNested) {
+                            continue; // Already exposed under this parent
+                        }
+                        // Find the target domain entity for path generation
+                        const targetDomainEntity = domain.findEntity(target.key, target.domain);
+                        if (!targetDomainEntity)
+                            continue;
+                        const name = association.info.name || '';
+                        // Create nested exposure
+                        const nestedExposure = {
+                            key: nanoid(),
+                            entity: { ...target },
+                            actions: [],
+                            isRoot: false,
+                            path: pluralize(name.toLocaleLowerCase()),
+                            parent: {
+                                key: parentKey,
+                                association: {
+                                    key: association.key,
+                                    domain: currentEntity.domain,
+                                },
+                                depth: depth + 1,
+                            },
+                        };
+                        this.exposes.push(nestedExposure);
+                        if (depth + 1 >= maxDepth) {
+                            nestedExposure.truncated = true;
+                        }
+                        else {
+                            // Recursively follow associations
+                            follow(target, nestedExposure.key, depth + 1);
+                        }
+                    }
+                }
+            };
+            // Start following from the root exposure
+            follow(parentExposure.entity, parentExposure.key, 0);
+        }
+        /**
+         * Removes an exposed entity from the API model.
+         * @param entity The entity to remove.
+         */
+        removeEntity(entity) {
+            const current = this.exposes.find((e) => e.entity.key === entity.key && e.entity.domain === entity.domain);
+            if (!current) {
+                return;
+            }
+            this.removeWithChildren(current.key);
+            this.notifyChange();
+        }
+        removeWithChildren(key) {
+            const index = this.exposes.findIndex((e) => e.key === key);
+            if (index < 0) {
+                return;
+            }
+            // Remove the parent itself
+            this.exposes.splice(index, 1);
+            // Remove all children recursively
+            const removeChildren = (parentKey) => {
+                // Find all exposures whose parent.key matches parentKey
+                const children = this.exposes.filter((e) => e.parent?.key === parentKey);
+                for (const child of children) {
+                    removeChildren(child.key);
+                    const childIndex = this.exposes.findIndex((e) => e.key === child.key);
+                    if (childIndex >= 0) {
+                        this.exposes.splice(childIndex, 1);
+                    }
+                }
+            };
+            // Then also remove children
+            removeChildren(key);
+            this.notifyChange();
         }
         /**
          * Returns the exposed entity by its key.
          * @param entityKey The key of the entity to find.
          * @returns The exposed entity or undefined if not found.
          */
-        getExposedEntity(entityKey) {
-            return this.exposes.find((e) => e.key === entityKey);
+        getExposedEntity(entity) {
+            return this.exposes.find((e) => e.entity.key === entity.key && e.entity.domain === entity.domain);
         }
         /**
          * Clears the API model for a new entity change.

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

@@ -1 +1 @@
-{"version":3,"file":"ApiModel.js","sourceRoot":"","sources":["../../../src/modeling/ApiModel.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACjE,OAAO,EAAe,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAYvD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,cAAc,EAAoD,MAAM,qBAAqB,CAAA;AACtG,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAA;IA4G9C,QAAQ;sBAAS,cAAc;;;;;;;;;;iBAA/B,QAAS,SAAQ,WAAc;;;0CA8DzC,QAAQ,EAAE;mCAIV,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;mCAIxB,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;YARb,+LAAS,cAAc,6BAAd,cAAc,uGAAoB;YAI7B,0KAAS,OAAO,6BAAP,OAAO,yFAAwB;YAIxC,0KAAS,OAAO,6BAAP,OAAO,yFAAwB;;;QArElE;;WAEG;QACH,IAAI,CAAqB;QACzB;;;WAGG;QACH,GAAG,CAAQ;QAEX;;WAEG;QACH,IAAI,CAAO;QACX;;;;;WAKG;QACH,IAAI,CAAoB;QAExB;;;WAGG;QACH,cAAc,CAA8B;QAE5C;;;WAGG;QACH,aAAa,CAA6B;QAE1C;;;WAGG;QACH,OAAO,CAAuB;QAC9B;;;WAGG;QACH,OAAO,CAAiB;QACxB;;;;;;;WAOG;QACH,UAAU,CAAe;QACzB;;;WAGG;QACH,YAAY,CAA4B;QAI5B,iGAA2C;QAHvD;;WAEG;QACS,IAAS,cAAc,oDAAoB;QAA3C,IAAS,cAAc,0DAAoB;QAI7B,iJAAwC;QAHlE;;WAEG;QACuB,IAAS,OAAO,6CAAwB;QAAxC,IAAS,OAAO,mDAAwB;QAIxC,0IAAwC;QAHlE;;WAEG;QACuB,IAAS,OAAO,6CAAwB;QAAxC,IAAS,OAAO,mDAAwB;QAElE;;;WAGG;QACH,aAAa,yDAAG,IAAI,EAAA;QAEpB;;;;;WAKG;QACH,UAAU,GAAG,KAAK,CAAA;QAElB;;;;;;;WAOG;QACH,IAAI,MAAM;YACR,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACrC,OAAO,SAAS,CAAA;YAClB,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAA;YACrC,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAC1C,CAAC;QAED,MAAM,CAAC,YAAY,CAAC,QAAiC,EAAE;YACrD,MAAM,EAAE,GAAG,GAAG,MAAM,EAAE,EAAE,OAAO,GAAG,EAAE,EAAE,GAAG,KAAK,CAAA;YAC9C,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAA;YACzE,MAAM,MAAM,GAAmB;gBAC7B,IAAI,EAAE,YAAY;gBAClB,GAAG;gBACH,IAAI;gBACJ,OAAO;aACR,CAAA;YACD,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;gBACf,MAAM,CAAC,IAAI,GAAG,EAAE,GAAG,KAAK,CAAC,IAAI,EAAE,CAAA;YACjC,CAAC;YACD,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;gBACzB,MAAM,CAAC,cAAc,GAAG,eAAe,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;YAC/D,CAAC;YACD,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;gBACzB,MAAM,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAA;YAC9C,CAAC;YACD,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;gBACxB,MAAM,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAA;YAC5C,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;gBAClB,MAAM,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAA;YAChC,CAAC;YACD,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;gBACrB,MAAM,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAA;YACtC,CAAC;YACD,IAAI,KAAK,CAAC,YAAY,EAAE,CAAC;gBACvB,MAAM,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAA;YAC1C,CAAC;YACD,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;gBACzB,MAAM,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAA;YAC9C,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;gBAClB,MAAM,CAAC,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;YACjD,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;gBAClB,MAAM,CAAC,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;YACjD,CAAC;YACD,OAAO,MAAM,CAAA;QACf,CAAC;QAED,YAAY,KAA+B,EAAE,MAAyB;YACpE,MAAM,IAAI,GAAG,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,CAAA;YACzC,MAAM,SAAS,GAAiB,EAAE,CAAA;YAClC,IAAI,MAAM,YAAY,UAAU,EAAE,CAAC;gBACjC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YACxB,CAAC;iBAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;gBACxE,SAAS,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC,CAAA;YACxC,CAAC;iBAAM,IAAI,MAAM,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAA;YACvF,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC,CAAA;YACrC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;YACrB,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAA;YACnB,IAAI,CAAC,IAAI,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YAChC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;YACrB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBACxB,IAAI,CAAC,cAAc,GAAG,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;YAC5D,CAAC;YACD,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;gBACvB,IAAI,CAAC,aAAa,GAAG,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;YAC1D,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjB,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC9C,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;gBAChC,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC9C,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;YACnB,CAAC;YACD,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACpB,IAAI,CAAC,UAAU,GAAG,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YACpD,CAAC;YACD,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;gBACtB,IAAI,CAAC,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;YACxD,CAAC;YACD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBACxB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAA;YAC3C,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;YAC7B,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;YAC7B,CAAC;YACD,IAAI,CAAC,aAAa,GAAG,KAAK,CAAA;YAC1B,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,GAAG,EAAE;gBACxC,IAAI,CAAC,YAAY,EAAE,CAAA;YACrB,CAAC,CAAC,CAAA;QACJ,CAAC;QAED,MAAM;YACJ,MAAM,MAAM,GAAmB;gBAC7B,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBACxB,OAAO,EAAE,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC;aACvC,CAAA;YACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACd,MAAM,CAAC,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAA;YAChC,CAAC;YACD,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACnC,MAAM,CAAC,cAAc,GAAG,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;YAC9D,CAAC;YACD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBACxB,MAAM,CAAC,cAAc,GAAG,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;YAC9D,CAAC;YACD,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;gBACvB,MAAM,CAAC,aAAa,GAAG,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;YAC5D,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjB,MAAM,CAAC,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAChD,CAAC;YACD,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACpB,MAAM,CAAC,UAAU,GAAG,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YACtD,CAAC;YACD,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;gBACtB,MAAM,CAAC,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;YAC1D,CAAC;YACD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBACxB,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAA;YAC7C,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjB,MAAM,CAAC,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;YAC7D,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjB,MAAM,CAAC,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;YAC7D,CAAC;YACD,OAAO,MAAM,CAAA;QACf,CAAC;QAED;;;;WAIG;QACH,YAAY;YACV,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;gBAC1C,OAAM;YACR,CAAC;YACD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAA;YACtB,cAAc,CAAC,GAAG,EAAE;gBAClB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;gBACvB,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAA;gBACjC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;YAC3B,CAAC,CAAC,CAAA;QACJ,CAAC;QAED;;;;;WAKG;QACH,YAAY,CAAC,SAAiB;YAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,SAAS,CAAC,CAAA;YAC9D,IAAI,QAAQ,EAAE,CAAC;gBACb,OAAO,QAAQ,CAAA;YACjB,CAAC;YACD,MAAM,SAAS,GAAkB;gBAC/B,GAAG,EAAE,SAAS;gBACd,OAAO,EAAE,EAAE;aACZ,CAAA;YACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YAC5B,IAAI,CAAC,YAAY,EAAE,CAAA;YACnB,OAAO,SAAS,CAAA;QAClB,CAAC;QAED;;;WAGG;QACH,YAAY,CAAC,SAAiB;YAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,SAAS,CAAC,CAAA;YAChE,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBACjB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;gBAC7B,IAAI,CAAC,YAAY,EAAE,CAAA;YACrB,CAAC;QACH,CAAC;QACD;;;;WAIG;QACH,gBAAgB,CAAC,SAAiB;YAChC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,SAAS,CAAC,CAAA;QACtD,CAAC;QAED;;;;WAIG;QACH,oBAAoB;YAClB,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAA;YACzB,IAAI,CAAC,cAAc,GAAG,EAAE,CAAA;YACxB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;YACjB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAA;YACrB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjB,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG,EAAE,CAAA;YAC9B,CAAC;YACD,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,KAAK,kBAAkB,EAAE,CAAC;gBAC/E,MAAM,KAAK,GAAG,IAAI,CAAC,cAA+C,CAAA;gBAClE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;YAC/B,CAAC;YACD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,IAAI,MAAM,EAAE,CAAC;gBAChE,MAAM,KAAK,GAAG,IAAI,CAAC,aAAwC,CAAA;gBAC3D,KAAK,CAAC,OAAO,GAAG,EAAE,CAAA;YACpB,CAAC;QACH,CAAC;QAED;;;;;;WAMG;QACH,gBAAgB,CAAC,MAAkB;YACjC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CAAC,wFAAwF,CAAC,CAAA;YAC3G,CAAC;YACD,IAAI,CAAC,oBAAoB,EAAE,CAAA;YAC3B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;YACzC,IAAI,CAAC,cAAc,GAAG,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;YACzE,IAAI,CAAC,YAAY,EAAE,CAAA;QACrB,CAAC;;;SAzUU,QAAQ","sourcesContent":["import { nanoid } from '../nanoid.js'\nimport { ApiModelKind, DataDomainKind } from '../models/kinds.js'\nimport { type IThing, Thing } from '../models/Thing.js'\nimport type {\n  AccessRule,\n  AssociationTarget,\n  AuthenticationConfiguration,\n  AuthorizationConfiguration,\n  ExposedEntity,\n  RateLimitingConfiguration,\n  RolesBasedAccessControl,\n  SessionConfiguration,\n  UsernamePasswordConfiguration,\n} from './types.js'\nimport { DataDomain } from './DataDomain.js'\nimport { DependentModel, type DependentModelSchema, type DomainDependency } from './DependentModel.js'\nimport { observed, toRaw } from '../decorators/observed.js'\n\n/**\n * Contact information for the exposed API.\n */\nexport interface ApiContact {\n  /**\n   * The identifying name of the contact person/organization.\n   */\n  name?: string\n  /**\n   * The URL pointing to the contact information. MUST be in the format of a URL.\n   */\n  url?: string\n  /**\n   * The email address of the contact person/organization. MUST be in the format of an email address.\n   */\n  email?: string\n}\n\n/**\n * License information for the exposed API.\n */\nexport interface ApiLicense {\n  /**\n   * The license name used for the API. It is recommended to be an SPDX license identifier.\n   */\n  name: string\n  /**\n   * A URL to the license used for the API. MUST be in the format of a URL.\n   */\n  url?: string\n}\n\nexport interface ApiModelSchema extends DependentModelSchema {\n  /**\n   * The data domain kind recognizable by the ecosystem.\n   */\n  kind: typeof ApiModelKind\n  /**\n   * The unique key of the data domain schema.\n   * This is a stable identifier that does not change across versions.\n   */\n  key: string\n  /**\n   * Contains the name, display name, description, and the version of the data domain schema.\n   */\n  info: IThing\n\n  /**\n   * The designated Data Entity that represents a \"User\".\n   * This entity should be marked with the \"User\" semantic in the Data Modeler.\n   *\n   * This property is required to publish the API.\n   */\n  user?: AssociationTarget\n\n  /**\n   * Configuration for how users prove their identity.\n   * The API model is invalid if this is not set.\n   */\n  authentication?: AuthenticationConfiguration\n\n  /**\n   * Configuration for what authenticated users are allowed to do.\n   * The API model is invalid if this is not set.\n   */\n  authorization?: AuthorizationConfiguration\n\n  /**\n   * Configuration for the transport and payload of the user session.\n   * The API model is invalid if this is not set.\n   */\n  session?: SessionConfiguration\n  /**\n   * The specific subset of Data Entities to be exposed by this API.\n   * These are the entities that are included in the data domain schema.\n   */\n  exposes: ExposedEntity[]\n\n  /**\n   * Optional array of access rules that define the access control policies\n   * for the API. These rules are used to enforce security and permissions\n   * on the exposed entities.\n   *\n   * These rules apply to all exposed entities and actions. An API action\n   * can declare its own access rules, which will override these.\n   */\n  accessRule?: AccessRule[]\n  /**\n   * Optional configuration for API-wide rate limiting and throttling.\n   * Defines rules to protect the API from overuse.\n   */\n  rateLimiting?: RateLimitingConfiguration\n  /**\n   * A URL to the Terms of Service for the API.\n   */\n  termsOfService?: string\n  /**\n   * The contact information for the exposed API.\n   */\n  contact?: ApiContact\n  /**\n   * The license information for the API.\n   */\n  license?: ApiLicense\n}\n\nexport class ApiModel extends DependentModel {\n  /**\n   * The data domain kind recognizable by the ecosystem.\n   */\n  kind: typeof ApiModelKind\n  /**\n   * The unique key of the data domain schema.\n   * This is a stable identifier that does not change across versions.\n   */\n  key: string\n\n  /**\n   * The description of the domain property.\n   */\n  info: Thing\n  /**\n   * The designated Data Entity that represents a \"User\".\n   * This entity must be marked with the \"User\" semantic in the Data Modeler.\n   *\n   * This property is required to publish the API.\n   */\n  user?: AssociationTarget\n\n  /**\n   * Configuration for how users prove their identity.\n   * The API model is invalid if this is not set.\n   */\n  authentication?: AuthenticationConfiguration\n\n  /**\n   * Configuration for what authenticated users are allowed to do.\n   * The API model is invalid if this is not set.\n   */\n  authorization?: AuthorizationConfiguration\n\n  /**\n   * Configuration for the transport and payload of the user session.\n   * The API model is invalid if this is not set.\n   */\n  session?: SessionConfiguration\n  /**\n   * The specific subset of Data Entities to be exposed by this API.\n   * These are the entities that are included in the data domain schema.\n   */\n  exposes: ExposedEntity[]\n  /**\n   * Optional array of access rules that define the access control policies\n   * for the API. These rules are used to enforce security and permissions\n   * on the exposed entities.\n   *\n   * These rules apply to all exposed entities and actions. An API action\n   * can declare its own access rules, which will override these.\n   */\n  accessRule?: AccessRule[]\n  /**\n   * Optional configuration for API-wide rate limiting and throttling.\n   * Defines rules to protect the API from overuse.\n   */\n  rateLimiting?: RateLimitingConfiguration\n  /**\n   * A URL to the Terms of Service for the API.\n   */\n  @observed() accessor termsOfService: string | undefined\n  /**\n   * The contact information for the exposed API.\n   */\n  @observed({ deep: true }) accessor contact: ApiContact | undefined\n  /**\n   * The license information for the API.\n   */\n  @observed({ deep: true }) accessor license: ApiLicense | undefined\n\n  /**\n   * When the initializing flag is set to true,\n   * the domain is not notified of changes.\n   */\n  #initializing = true\n\n  /**\n   * When the notifying flag is set to true,\n   * the domain is pending a notification.\n   * No other notifications will be sent until\n   * the current notification is sent.\n   */\n  #notifying = false\n\n  /**\n   * A convenience getter that returns the DataDomain associated with this API model.\n   * Since the API model can have only one DataDomain,\n   * this getter returns the first dependency in the list.\n   *\n   * The parent interface `DependentModel` allows for multiple dependencies,\n   * to unify the dependency management across different models.\n   */\n  get domain(): DataDomain | undefined {\n    if (this.dependencyList.length === 0) {\n      return undefined\n    }\n    const domain = this.dependencyList[0]\n    return this.dependencies.get(domain.key)\n  }\n\n  static createSchema(input: Partial<ApiModelSchema> = {}): ApiModelSchema {\n    const { key = nanoid(), exposes = [] } = input\n    const info = Thing.fromJSON(input.info, { name: 'Unnamed API' }).toJSON()\n    const result: ApiModelSchema = {\n      kind: ApiModelKind,\n      key,\n      info,\n      exposes,\n    }\n    if (input.user) {\n      result.user = { ...input.user }\n    }\n    if (input.dependencyList) {\n      result.dependencyList = structuredClone(input.dependencyList)\n    }\n    if (input.authentication) {\n      result.authentication = input.authentication\n    }\n    if (input.authorization) {\n      result.authorization = input.authorization\n    }\n    if (input.session) {\n      result.session = input.session\n    }\n    if (input.accessRule) {\n      result.accessRule = input.accessRule\n    }\n    if (input.rateLimiting) {\n      result.rateLimiting = input.rateLimiting\n    }\n    if (input.termsOfService) {\n      result.termsOfService = input.termsOfService\n    }\n    if (input.contact) {\n      result.contact = structuredClone(input.contact)\n    }\n    if (input.license) {\n      result.license = structuredClone(input.license)\n    }\n    return result\n  }\n\n  constructor(state?: Partial<ApiModelSchema>, domain?: DomainDependency) {\n    const init = ApiModel.createSchema(state)\n    const instances: DataDomain[] = []\n    if (domain instanceof DataDomain) {\n      instances.push(domain)\n    } else if (typeof domain === 'object' && domain.kind === DataDomainKind) {\n      instances.push(new DataDomain(domain))\n    } else if (domain) {\n      throw new Error(`Invalid domain provided. Expected a DataDomain instance or schema.`)\n    }\n    super(init.dependencyList, instances)\n    this.kind = init.kind\n    this.key = init.key\n    this.info = new Thing(init.info)\n    this.user = init.user\n    if (init.authentication) {\n      this.authentication = structuredClone(init.authentication)\n    }\n    if (init.authorization) {\n      this.authorization = structuredClone(init.authorization)\n    }\n    if (init.session) {\n      this.session = structuredClone(init.session)\n    }\n    if (Array.isArray(init.exposes)) {\n      this.exposes = structuredClone(init.exposes)\n    } else {\n      this.exposes = []\n    }\n    if (init.accessRule) {\n      this.accessRule = structuredClone(init.accessRule)\n    }\n    if (init.rateLimiting) {\n      this.rateLimiting = structuredClone(init.rateLimiting)\n    }\n    if (init.termsOfService) {\n      this.termsOfService = init.termsOfService\n    }\n    if (init.contact) {\n      this.contact = init.contact\n    }\n    if (init.license) {\n      this.license = init.license\n    }\n    this.#initializing = false\n    this.info.addEventListener('change', () => {\n      this.notifyChange()\n    })\n  }\n\n  toJSON(): ApiModelSchema {\n    const result: ApiModelSchema = {\n      kind: this.kind,\n      key: this.key,\n      info: this.info.toJSON(),\n      exposes: structuredClone(this.exposes),\n    }\n    if (this.user) {\n      result.user = { ...this.user }\n    }\n    if (this.dependencyList.length > 0) {\n      result.dependencyList = structuredClone(this.dependencyList)\n    }\n    if (this.authentication) {\n      result.authentication = structuredClone(this.authentication)\n    }\n    if (this.authorization) {\n      result.authorization = structuredClone(this.authorization)\n    }\n    if (this.session) {\n      result.session = structuredClone(this.session)\n    }\n    if (this.accessRule) {\n      result.accessRule = structuredClone(this.accessRule)\n    }\n    if (this.rateLimiting) {\n      result.rateLimiting = structuredClone(this.rateLimiting)\n    }\n    if (this.termsOfService) {\n      result.termsOfService = this.termsOfService\n    }\n    if (this.contact) {\n      result.contact = structuredClone(toRaw(this, this.contact))\n    }\n    if (this.license) {\n      result.license = structuredClone(toRaw(this, this.license))\n    }\n    return result\n  }\n\n  /**\n   * This function is used internally by all domain elements to notify that something has changed.\n   * Since we want to notify listeners after the operation commits, we use microtask\n   * to ensure that the event is dispatched after the current operation.\n   */\n  notifyChange() {\n    if (this.#notifying || this.#initializing) {\n      return\n    }\n    this.#notifying = true\n    queueMicrotask(() => {\n      this.#notifying = false\n      const event = new Event('change')\n      this.dispatchEvent(event)\n    })\n  }\n\n  /**\n   * Exposes a new entity in the API model.\n   * If the entity already exists, it returns the existing one.\n   * @param entityKey The key of the entity to expose.\n   * @returns The exposed entity.\n   */\n  exposeEntity(entityKey: string): ExposedEntity {\n    const existing = this.exposes.find((e) => e.key === entityKey)\n    if (existing) {\n      return existing\n    }\n    const newEntity: ExposedEntity = {\n      key: entityKey,\n      actions: [],\n    }\n    this.exposes.push(newEntity)\n    this.notifyChange()\n    return newEntity\n  }\n\n  /**\n   * Removes an entity from the API model.\n   * @param entityKey The key of the entity to remove.\n   */\n  removeEntity(entityKey: string): void {\n    const index = this.exposes.findIndex((e) => e.key === entityKey)\n    if (index !== -1) {\n      this.exposes.splice(index, 1)\n      this.notifyChange()\n    }\n  }\n  /**\n   * Returns the exposed entity by its key.\n   * @param entityKey The key of the entity to find.\n   * @returns The exposed entity or undefined if not found.\n   */\n  getExposedEntity(entityKey: string): ExposedEntity | undefined {\n    return this.exposes.find((e) => e.key === entityKey)\n  }\n\n  /**\n   * Clears the API model for a new entity change.\n   * This method resets the dependencies, exposes, user,\n   * authentication, authorization, and session properties.\n   */\n  cleanForEntityChange(): void {\n    this.dependencies.clear()\n    this.dependencyList = []\n    this.exposes = []\n    this.user = undefined\n    if (this.session) {\n      this.session.properties = []\n    }\n    if (this.authentication && this.authentication.strategy === 'UsernamePassword') {\n      const typed = this.authentication as UsernamePasswordConfiguration\n      typed.passwordKey = undefined\n    }\n    if (this.authorization && this.authorization.strategy == 'RBAC') {\n      const typed = this.authorization as RolesBasedAccessControl\n      typed.roleKey = ''\n    }\n  }\n\n  /**\n   * Attaches a DataDomain to this API model.\n   * This method clears any existing dependencies and sets the new domain.\n   *\n   * @param domain The DataDomain to attach to this API model.\n   * @throws Error if the domain does not have a version set in its info.\n   */\n  attachDataDomain(domain: DataDomain): void {\n    if (!domain.info.version) {\n      throw new Error(`Cannot attach DataDomain without a version. Please set the version in the domain info.`)\n    }\n    this.cleanForEntityChange()\n    this.dependencies.set(domain.key, domain)\n    this.dependencyList = [{ key: domain.key, version: domain.info.version }]\n    this.notifyChange()\n  }\n}\n"]}
+{"version":3,"file":"ApiModel.js","sourceRoot":"","sources":["../../../src/modeling/ApiModel.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACjE,OAAO,EAAe,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAavD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,cAAc,EAAoD,MAAM,qBAAqB,CAAA;AACtG,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAA;AAC3D,OAAO,SAAS,MAAM,qBAAqB,CAAA;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;IA4GxC,QAAQ;sBAAS,cAAc;;;;;;;;;;iBAA/B,QAAS,SAAQ,WAAc;;;0CA8DzC,QAAQ,EAAE;mCAIV,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;mCAIxB,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;YARb,+LAAS,cAAc,6BAAd,cAAc,uGAAoB;YAI7B,0KAAS,OAAO,6BAAP,OAAO,yFAAwB;YAIxC,0KAAS,OAAO,6BAAP,OAAO,yFAAwB;;;QArElE;;WAEG;QACH,IAAI,CAAqB;QACzB;;;WAGG;QACH,GAAG,CAAQ;QAEX;;WAEG;QACH,IAAI,CAAO;QACX;;;;;WAKG;QACH,IAAI,CAAoB;QAExB;;;WAGG;QACH,cAAc,CAA8B;QAE5C;;;WAGG;QACH,aAAa,CAA6B;QAE1C;;;WAGG;QACH,OAAO,CAAuB;QAC9B;;;WAGG;QACH,OAAO,CAAiB;QACxB;;;;;;;WAOG;QACH,UAAU,CAAe;QACzB;;;WAGG;QACH,YAAY,CAA4B;QAI5B,iGAA2C;QAHvD;;WAEG;QACS,IAAS,cAAc,oDAAoB;QAA3C,IAAS,cAAc,0DAAoB;QAI7B,iJAAwC;QAHlE;;WAEG;QACuB,IAAS,OAAO,6CAAwB;QAAxC,IAAS,OAAO,mDAAwB;QAIxC,0IAAwC;QAHlE;;WAEG;QACuB,IAAS,OAAO,6CAAwB;QAAxC,IAAS,OAAO,mDAAwB;QAElE;;;WAGG;QACH,aAAa,yDAAG,IAAI,EAAA;QAEpB;;;;;WAKG;QACH,UAAU,GAAG,KAAK,CAAA;QAElB;;;;;;;WAOG;QACH,IAAI,MAAM;YACR,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACrC,OAAO,SAAS,CAAA;YAClB,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAA;YACrC,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAC1C,CAAC;QAED,MAAM,CAAC,YAAY,CAAC,QAAiC,EAAE;YACrD,MAAM,EAAE,GAAG,GAAG,MAAM,EAAE,EAAE,OAAO,GAAG,EAAE,EAAE,GAAG,KAAK,CAAA;YAC9C,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAA;YACzE,MAAM,MAAM,GAAmB;gBAC7B,IAAI,EAAE,YAAY;gBAClB,GAAG;gBACH,IAAI;gBACJ,OAAO;aACR,CAAA;YACD,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;gBACf,MAAM,CAAC,IAAI,GAAG,EAAE,GAAG,KAAK,CAAC,IAAI,EAAE,CAAA;YACjC,CAAC;YACD,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;gBACzB,MAAM,CAAC,cAAc,GAAG,eAAe,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;YAC/D,CAAC;YACD,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;gBACzB,MAAM,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAA;YAC9C,CAAC;YACD,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;gBACxB,MAAM,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAA;YAC5C,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;gBAClB,MAAM,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAA;YAChC,CAAC;YACD,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;gBACrB,MAAM,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAA;YACtC,CAAC;YACD,IAAI,KAAK,CAAC,YAAY,EAAE,CAAC;gBACvB,MAAM,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAA;YAC1C,CAAC;YACD,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;gBACzB,MAAM,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAA;YAC9C,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;gBAClB,MAAM,CAAC,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;YACjD,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;gBAClB,MAAM,CAAC,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;YACjD,CAAC;YACD,OAAO,MAAM,CAAA;QACf,CAAC;QAED,YAAY,KAA+B,EAAE,MAAyB;YACpE,MAAM,IAAI,GAAG,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,CAAA;YACzC,MAAM,SAAS,GAAiB,EAAE,CAAA;YAClC,IAAI,MAAM,YAAY,UAAU,EAAE,CAAC;gBACjC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YACxB,CAAC;iBAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;gBACxE,SAAS,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC,CAAA;YACxC,CAAC;iBAAM,IAAI,MAAM,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAA;YACvF,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC,CAAA;YACrC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;YACrB,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAA;YACnB,IAAI,CAAC,IAAI,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YAChC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;YACrB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBACxB,IAAI,CAAC,cAAc,GAAG,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;YAC5D,CAAC;YACD,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;gBACvB,IAAI,CAAC,aAAa,GAAG,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;YAC1D,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjB,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC9C,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;gBAChC,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC9C,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;YACnB,CAAC;YACD,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACpB,IAAI,CAAC,UAAU,GAAG,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YACpD,CAAC;YACD,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;gBACtB,IAAI,CAAC,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;YACxD,CAAC;YACD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBACxB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAA;YAC3C,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;YAC7B,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;YAC7B,CAAC;YACD,IAAI,CAAC,aAAa,GAAG,KAAK,CAAA;YAC1B,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,GAAG,EAAE;gBACxC,IAAI,CAAC,YAAY,EAAE,CAAA;YACrB,CAAC,CAAC,CAAA;QACJ,CAAC;QAED,MAAM;YACJ,MAAM,MAAM,GAAmB;gBAC7B,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBACxB,OAAO,EAAE,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC;aACvC,CAAA;YACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACd,MAAM,CAAC,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAA;YAChC,CAAC;YACD,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACnC,MAAM,CAAC,cAAc,GAAG,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;YAC9D,CAAC;YACD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBACxB,MAAM,CAAC,cAAc,GAAG,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;YAC9D,CAAC;YACD,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;gBACvB,MAAM,CAAC,aAAa,GAAG,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;YAC5D,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjB,MAAM,CAAC,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAChD,CAAC;YACD,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACpB,MAAM,CAAC,UAAU,GAAG,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YACtD,CAAC;YACD,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;gBACtB,MAAM,CAAC,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;YAC1D,CAAC;YACD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBACxB,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAA;YAC7C,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjB,MAAM,CAAC,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;YAC7D,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjB,MAAM,CAAC,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;YAC7D,CAAC;YACD,OAAO,MAAM,CAAA;QACf,CAAC;QAED;;;;WAIG;QACH,YAAY;YACV,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;gBAC1C,OAAM;YACR,CAAC;YACD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAA;YACtB,cAAc,CAAC,GAAG,EAAE;gBAClB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;gBACvB,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAA;gBACjC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;YAC3B,CAAC,CAAC,CAAA;QACJ,CAAC;QAED;;;;;WAKG;QACH,YAAY,CAAC,MAAyB,EAAE,OAAuB;YAC7D,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;YAC1B,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;YACpD,CAAC;YACD,mEAAmE;YACnE,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAChC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,CACpF,CAAA;YACD,IAAI,QAAQ,EAAE,CAAC;gBACb,uCAAuC;gBACvC,sCAAsC;gBACtC,OAAO,QAAQ,CAAA;YACjB,CAAC;YACD,MAAM,YAAY,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,CAAA;YACjE,IAAI,CAAC,YAAY,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CAAC,+BAA+B,MAAM,CAAC,GAAG,EAAE,CAAC,CAAA;YAC9D,CAAC;YACD,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAA;YACzC,MAAM,SAAS,GAAkB;gBAC/B,GAAG,EAAE,MAAM,EAAE;gBACb,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE;gBACrB,OAAO,EAAE,EAAE;gBACX,MAAM,EAAE,IAAI;gBACZ,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;aAC1C,CAAA;YACD,IAAI,OAAO,EAAE,CAAC;gBACZ,SAAS,CAAC,aAAa,GAAG,EAAE,GAAG,OAAO,EAAE,CAAA;YAC1C,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YAE5B,mCAAmC;YACnC,IAAI,OAAO,EAAE,kBAAkB,EAAE,CAAC;gBAChC,IAAI,OAAO,EAAE,QAAQ,KAAK,SAAS,IAAI,OAAO,CAAC,QAAQ,GAAG,CAAC,EAAE,CAAC;oBAC5D,IAAI,CAAC,wBAAwB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;gBACnD,CAAC;YACH,CAAC;YACD,IAAI,CAAC,YAAY,EAAE,CAAA;YACnB,OAAO,SAAS,CAAA;QAClB,CAAC;QAED;;;;;;WAMG;QACK,wBAAwB,CAAC,cAA6B,EAAE,OAAsB;YACpF,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;YAC1B,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAM;YACR,CAAC;YACD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,CAAC,CAAA;YACtC,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAA;YACjC,iFAAiF;YACjF,gBAAgB;YAChB,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAA;YAEnD,MAAM,MAAM,GAAG,CAAC,aAAgC,EAAE,SAAiB,EAAE,KAAa,EAAE,EAAE;gBACpF,yBAAyB;gBACzB,MAAM,YAAY,GAAG,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC,GAAG,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;gBAC/E,IAAI,CAAC,YAAY;oBAAE,OAAM;gBAEzB,+BAA+B;gBAC/B,KAAK,MAAM,WAAW,IAAI,YAAY,CAAC,gBAAgB,EAAE,EAAE,CAAC;oBAC1D,KAAK,MAAM,MAAM,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;wBACzC,qCAAqC;wBACrC,IAAI,MAAM,CAAC,GAAG,KAAK,aAAa,CAAC,GAAG,IAAI,MAAM,CAAC,MAAM,KAAK,aAAa,CAAC,MAAM,EAAE,CAAC;4BAC/E,SAAQ;wBACV,CAAC;wBAED,kDAAkD;wBAClD,MAAM,QAAQ,GAAG,eAAe,CAAC,MAAM,CAAC,CAAA;wBACxC,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;4BAC1B,SAAQ,CAAC,2BAA2B;wBACtC,CAAC;wBACD,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;wBAErB,+CAA+C;wBAC/C,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CACtC,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,CAAC,CAAC,MAAM;4BACT,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,MAAM,CAAC,GAAG;4BAC3B,CAAC,CAAC,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM;4BACjC,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,SAAS,CAC9B,CAAA;wBAED,IAAI,cAAc,EAAE,CAAC;4BACnB,SAAQ,CAAC,oCAAoC;wBAC/C,CAAC;wBAED,oDAAoD;wBACpD,MAAM,kBAAkB,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,CAAA;wBACvE,IAAI,CAAC,kBAAkB;4BAAE,SAAQ;wBAEjC,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAA;wBACxC,yBAAyB;wBACzB,MAAM,cAAc,GAAkB;4BACpC,GAAG,EAAE,MAAM,EAAE;4BACb,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE;4BACrB,OAAO,EAAE,EAAE;4BACX,MAAM,EAAE,KAAK;4BACb,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;4BACzC,MAAM,EAAE;gCACN,GAAG,EAAE,SAAS;gCACd,WAAW,EAAE;oCACX,GAAG,EAAE,WAAW,CAAC,GAAG;oCACpB,MAAM,EAAE,aAAa,CAAC,MAAM;iCAC7B;gCACD,KAAK,EAAE,KAAK,GAAG,CAAC;6BACjB;yBACF,CAAA;wBAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;wBACjC,IAAI,KAAK,GAAG,CAAC,IAAI,QAAQ,EAAE,CAAC;4BAC1B,cAAc,CAAC,SAAS,GAAG,IAAI,CAAA;wBACjC,CAAC;6BAAM,CAAC;4BACN,kCAAkC;4BAClC,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,EAAE,KAAK,GAAG,CAAC,CAAC,CAAA;wBAC/C,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC,CAAA;YAED,yCAAyC;YACzC,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;QACtD,CAAC;QAED;;;WAGG;QACH,YAAY,CAAC,MAAyB;YACpC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,CAAA;YAC1G,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,OAAM;YACR,CAAC;YACD,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;YACpC,IAAI,CAAC,YAAY,EAAE,CAAA;QACrB,CAAC;QAEO,kBAAkB,CAAC,GAAW;YACpC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAA;YAC1D,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACd,OAAM;YACR,CAAC;YACD,2BAA2B;YAC3B,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;YAC7B,kCAAkC;YAClC,MAAM,cAAc,GAAG,CAAC,SAAiB,EAAE,EAAE;gBAC3C,wDAAwD;gBACxD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,SAAS,CAAC,CAAA;gBACxE,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;oBAC7B,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;oBACzB,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,KAAK,CAAC,GAAG,CAAC,CAAA;oBACrE,IAAI,UAAU,IAAI,CAAC,EAAE,CAAC;wBACpB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAA;oBACpC,CAAC;gBACH,CAAC;YACH,CAAC,CAAA;YACD,4BAA4B;YAC5B,cAAc,CAAC,GAAG,CAAC,CAAA;YACnB,IAAI,CAAC,YAAY,EAAE,CAAA;QACrB,CAAC;QAED;;;;WAIG;QACH,gBAAgB,CAAC,MAAyB;YACxC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,CAAA;QACnG,CAAC;QAED;;;;WAIG;QACH,oBAAoB;YAClB,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAA;YACzB,IAAI,CAAC,cAAc,GAAG,EAAE,CAAA;YACxB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;YACjB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAA;YACrB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjB,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG,EAAE,CAAA;YAC9B,CAAC;YACD,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,KAAK,kBAAkB,EAAE,CAAC;gBAC/E,MAAM,KAAK,GAAG,IAAI,CAAC,cAA+C,CAAA;gBAClE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;YAC/B,CAAC;YACD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,IAAI,MAAM,EAAE,CAAC;gBAChE,MAAM,KAAK,GAAG,IAAI,CAAC,aAAwC,CAAA;gBAC3D,KAAK,CAAC,OAAO,GAAG,EAAE,CAAA;YACpB,CAAC;QACH,CAAC;QAED;;;;;;WAMG;QACH,gBAAgB,CAAC,MAAkB;YACjC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CAAC,wFAAwF,CAAC,CAAA;YAC3G,CAAC;YACD,IAAI,CAAC,oBAAoB,EAAE,CAAA;YAC3B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;YACzC,IAAI,CAAC,cAAc,GAAG,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;YACzE,IAAI,CAAC,YAAY,EAAE,CAAA;QACrB,CAAC;;;SAtdU,QAAQ","sourcesContent":["import { nanoid } from '../nanoid.js'\nimport { ApiModelKind, DataDomainKind } from '../models/kinds.js'\nimport { type IThing, Thing } from '../models/Thing.js'\nimport type {\n  AccessRule,\n  AssociationTarget,\n  AuthenticationConfiguration,\n  AuthorizationConfiguration,\n  ExposedEntity,\n  RateLimitingConfiguration,\n  RolesBasedAccessControl,\n  SessionConfiguration,\n  UsernamePasswordConfiguration,\n  ExposeOptions,\n} from './types.js'\nimport { DataDomain } from './DataDomain.js'\nimport { DependentModel, type DependentModelSchema, type DomainDependency } from './DependentModel.js'\nimport { observed, toRaw } from '../decorators/observed.js'\nimport pluralize from '@jarrodek/pluralize'\nimport { createDomainKey } from './helpers/keying.js'\n\n/**\n * Contact information for the exposed API.\n */\nexport interface ApiContact {\n  /**\n   * The identifying name of the contact person/organization.\n   */\n  name?: string\n  /**\n   * The URL pointing to the contact information. MUST be in the format of a URL.\n   */\n  url?: string\n  /**\n   * The email address of the contact person/organization. MUST be in the format of an email address.\n   */\n  email?: string\n}\n\n/**\n * License information for the exposed API.\n */\nexport interface ApiLicense {\n  /**\n   * The license name used for the API. It is recommended to be an SPDX license identifier.\n   */\n  name: string\n  /**\n   * A URL to the license used for the API. MUST be in the format of a URL.\n   */\n  url?: string\n}\n\nexport interface ApiModelSchema extends DependentModelSchema {\n  /**\n   * The data domain kind recognizable by the ecosystem.\n   */\n  kind: typeof ApiModelKind\n  /**\n   * The unique key of the API model schema.\n   * This is a stable identifier that does not change across versions.\n   */\n  key: string\n  /**\n   * Contains the name, display name, description, and the version of the API model schema.\n   */\n  info: IThing\n\n  /**\n   * The designated Data Entity that represents a \"User\".\n   * This entity should be marked with the \"User\" semantic in the Data Modeler.\n   *\n   * This property is required to publish the API.\n   */\n  user?: AssociationTarget\n\n  /**\n   * Configuration for how users prove their identity.\n   * The API model is invalid if this is not set.\n   */\n  authentication?: AuthenticationConfiguration\n\n  /**\n   * Configuration for what authenticated users are allowed to do.\n   * The API model is invalid if this is not set.\n   */\n  authorization?: AuthorizationConfiguration\n\n  /**\n   * Configuration for the transport and payload of the user session.\n   * The API model is invalid if this is not set.\n   */\n  session?: SessionConfiguration\n  /**\n   * The specific subset of Data Entities to be exposed by this API.\n   * These are the entities that are included in the data domain schema.\n   */\n  exposes: ExposedEntity[]\n\n  /**\n   * Optional array of access rules that define the access control policies\n   * for the API. These rules are used to enforce security and permissions\n   * on the exposed entities.\n   *\n   * These rules apply to all exposed entities and actions. An API action\n   * can declare its own access rules, which will override these.\n   */\n  accessRule?: AccessRule[]\n  /**\n   * Optional configuration for API-wide rate limiting and throttling.\n   * Defines rules to protect the API from overuse.\n   */\n  rateLimiting?: RateLimitingConfiguration\n  /**\n   * A URL to the Terms of Service for the API.\n   */\n  termsOfService?: string\n  /**\n   * The contact information for the exposed API.\n   */\n  contact?: ApiContact\n  /**\n   * The license information for the API.\n   */\n  license?: ApiLicense\n}\n\nexport class ApiModel extends DependentModel {\n  /**\n   * The data domain kind recognizable by the ecosystem.\n   */\n  kind: typeof ApiModelKind\n  /**\n   * The unique key of the data domain schema.\n   * This is a stable identifier that does not change across versions.\n   */\n  key: string\n\n  /**\n   * The description of the domain property.\n   */\n  info: Thing\n  /**\n   * The designated Data Entity that represents a \"User\".\n   * This entity must be marked with the \"User\" semantic in the Data Modeler.\n   *\n   * This property is required to publish the API.\n   */\n  user?: AssociationTarget\n\n  /**\n   * Configuration for how users prove their identity.\n   * The API model is invalid if this is not set.\n   */\n  authentication?: AuthenticationConfiguration\n\n  /**\n   * Configuration for what authenticated users are allowed to do.\n   * The API model is invalid if this is not set.\n   */\n  authorization?: AuthorizationConfiguration\n\n  /**\n   * Configuration for the transport and payload of the user session.\n   * The API model is invalid if this is not set.\n   */\n  session?: SessionConfiguration\n  /**\n   * The specific subset of Data Entities to be exposed by this API.\n   * These are the entities that are included in the data domain schema.\n   */\n  exposes: ExposedEntity[]\n  /**\n   * Optional array of access rules that define the access control policies\n   * for the API. These rules are used to enforce security and permissions\n   * on the exposed entities.\n   *\n   * These rules apply to all exposed entities and actions. An API action\n   * can declare its own access rules, which will override these.\n   */\n  accessRule?: AccessRule[]\n  /**\n   * Optional configuration for API-wide rate limiting and throttling.\n   * Defines rules to protect the API from overuse.\n   */\n  rateLimiting?: RateLimitingConfiguration\n  /**\n   * A URL to the Terms of Service for the API.\n   */\n  @observed() accessor termsOfService: string | undefined\n  /**\n   * The contact information for the exposed API.\n   */\n  @observed({ deep: true }) accessor contact: ApiContact | undefined\n  /**\n   * The license information for the API.\n   */\n  @observed({ deep: true }) accessor license: ApiLicense | undefined\n\n  /**\n   * When the initializing flag is set to true,\n   * the domain is not notified of changes.\n   */\n  #initializing = true\n\n  /**\n   * When the notifying flag is set to true,\n   * the domain is pending a notification.\n   * No other notifications will be sent until\n   * the current notification is sent.\n   */\n  #notifying = false\n\n  /**\n   * A convenience getter that returns the DataDomain associated with this API model.\n   * Since the API model can have only one DataDomain,\n   * this getter returns the first dependency in the list.\n   *\n   * The parent interface `DependentModel` allows for multiple dependencies,\n   * to unify the dependency management across different models.\n   */\n  get domain(): DataDomain | undefined {\n    if (this.dependencyList.length === 0) {\n      return undefined\n    }\n    const domain = this.dependencyList[0]\n    return this.dependencies.get(domain.key)\n  }\n\n  static createSchema(input: Partial<ApiModelSchema> = {}): ApiModelSchema {\n    const { key = nanoid(), exposes = [] } = input\n    const info = Thing.fromJSON(input.info, { name: 'Unnamed API' }).toJSON()\n    const result: ApiModelSchema = {\n      kind: ApiModelKind,\n      key,\n      info,\n      exposes,\n    }\n    if (input.user) {\n      result.user = { ...input.user }\n    }\n    if (input.dependencyList) {\n      result.dependencyList = structuredClone(input.dependencyList)\n    }\n    if (input.authentication) {\n      result.authentication = input.authentication\n    }\n    if (input.authorization) {\n      result.authorization = input.authorization\n    }\n    if (input.session) {\n      result.session = input.session\n    }\n    if (input.accessRule) {\n      result.accessRule = input.accessRule\n    }\n    if (input.rateLimiting) {\n      result.rateLimiting = input.rateLimiting\n    }\n    if (input.termsOfService) {\n      result.termsOfService = input.termsOfService\n    }\n    if (input.contact) {\n      result.contact = structuredClone(input.contact)\n    }\n    if (input.license) {\n      result.license = structuredClone(input.license)\n    }\n    return result\n  }\n\n  constructor(state?: Partial<ApiModelSchema>, domain?: DomainDependency) {\n    const init = ApiModel.createSchema(state)\n    const instances: DataDomain[] = []\n    if (domain instanceof DataDomain) {\n      instances.push(domain)\n    } else if (typeof domain === 'object' && domain.kind === DataDomainKind) {\n      instances.push(new DataDomain(domain))\n    } else if (domain) {\n      throw new Error(`Invalid domain provided. Expected a DataDomain instance or schema.`)\n    }\n    super(init.dependencyList, instances)\n    this.kind = init.kind\n    this.key = init.key\n    this.info = new Thing(init.info)\n    this.user = init.user\n    if (init.authentication) {\n      this.authentication = structuredClone(init.authentication)\n    }\n    if (init.authorization) {\n      this.authorization = structuredClone(init.authorization)\n    }\n    if (init.session) {\n      this.session = structuredClone(init.session)\n    }\n    if (Array.isArray(init.exposes)) {\n      this.exposes = structuredClone(init.exposes)\n    } else {\n      this.exposes = []\n    }\n    if (init.accessRule) {\n      this.accessRule = structuredClone(init.accessRule)\n    }\n    if (init.rateLimiting) {\n      this.rateLimiting = structuredClone(init.rateLimiting)\n    }\n    if (init.termsOfService) {\n      this.termsOfService = init.termsOfService\n    }\n    if (init.contact) {\n      this.contact = init.contact\n    }\n    if (init.license) {\n      this.license = init.license\n    }\n    this.#initializing = false\n    this.info.addEventListener('change', () => {\n      this.notifyChange()\n    })\n  }\n\n  toJSON(): ApiModelSchema {\n    const result: ApiModelSchema = {\n      kind: this.kind,\n      key: this.key,\n      info: this.info.toJSON(),\n      exposes: structuredClone(this.exposes),\n    }\n    if (this.user) {\n      result.user = { ...this.user }\n    }\n    if (this.dependencyList.length > 0) {\n      result.dependencyList = structuredClone(this.dependencyList)\n    }\n    if (this.authentication) {\n      result.authentication = structuredClone(this.authentication)\n    }\n    if (this.authorization) {\n      result.authorization = structuredClone(this.authorization)\n    }\n    if (this.session) {\n      result.session = structuredClone(this.session)\n    }\n    if (this.accessRule) {\n      result.accessRule = structuredClone(this.accessRule)\n    }\n    if (this.rateLimiting) {\n      result.rateLimiting = structuredClone(this.rateLimiting)\n    }\n    if (this.termsOfService) {\n      result.termsOfService = this.termsOfService\n    }\n    if (this.contact) {\n      result.contact = structuredClone(toRaw(this, this.contact))\n    }\n    if (this.license) {\n      result.license = structuredClone(toRaw(this, this.license))\n    }\n    return result\n  }\n\n  /**\n   * This function is used internally by all domain elements to notify that something has changed.\n   * Since we want to notify listeners after the operation commits, we use microtask\n   * to ensure that the event is dispatched after the current operation.\n   */\n  notifyChange() {\n    if (this.#notifying || this.#initializing) {\n      return\n    }\n    this.#notifying = true\n    queueMicrotask(() => {\n      this.#notifying = false\n      const event = new Event('change')\n      this.dispatchEvent(event)\n    })\n  }\n\n  /**\n   * Exposes a new entity in the API model.\n   * If the entity already exists, it returns the existing one.\n   * @param entity The entity key and domain to expose.\n   * @returns The exposed entity.\n   */\n  exposeEntity(entity: AssociationTarget, options?: ExposeOptions): ExposedEntity {\n    const domain = this.domain\n    if (!domain) {\n      throw new Error(`No domain attached to API model`)\n    }\n    // checks whether the entity is already exposed as a root exposure.\n    const existing = this.exposes.find(\n      (e) => e.isRoot && e.entity.key === entity.key && e.entity.domain === entity.domain\n    )\n    if (existing) {\n      // quietly return the existing exposure\n      // TBD: should we throw an error here?\n      return existing\n    }\n    const domainEntity = domain.findEntity(entity.key, entity.domain)\n    if (!domainEntity) {\n      throw new Error(`Entity not found in domain: ${entity.key}`)\n    }\n    const name = domainEntity.info.name || ''\n    const newEntity: ExposedEntity = {\n      key: nanoid(),\n      entity: { ...entity },\n      actions: [],\n      isRoot: true,\n      path: pluralize(name.toLocaleLowerCase()),\n    }\n    if (options) {\n      newEntity.exposeOptions = { ...options }\n    }\n    this.exposes.push(newEntity)\n\n    // Follow associations if requested\n    if (options?.followAssociations) {\n      if (options?.maxDepth === undefined || options.maxDepth > 0) {\n        this.followEntityAssociations(newEntity, options)\n      }\n    }\n    this.notifyChange()\n    return newEntity\n  }\n\n  /**\n   * Follows associations for a newly exposed entity if configured to do so.\n   * This creates nested exposures based on the entity's associations.\n   *\n   * @param parentExposure The root exposure to follow associations from\n   * @param options The expose options containing follow configuration\n   */\n  private followEntityAssociations(parentExposure: ExposedEntity, options: ExposeOptions): void {\n    const domain = this.domain\n    if (!domain) {\n      return\n    }\n    const maxDepth = options.maxDepth ?? 6\n    const visited = new Set<string>()\n    // Add parent entity's key to the visited set so we won't skip it when traversing\n    // associations.\n    visited.add(createDomainKey(parentExposure.entity))\n\n    const follow = (currentEntity: AssociationTarget, parentKey: string, depth: number) => {\n      // Find the domain entity\n      const domainEntity = domain.findEntity(currentEntity.key, currentEntity.domain)\n      if (!domainEntity) return\n\n      // Iterate through associations\n      for (const association of domainEntity.listAssociations()) {\n        for (const target of association.targets) {\n          // Skip self-referencing associations\n          if (target.key === currentEntity.key && target.domain === currentEntity.domain) {\n            continue\n          }\n\n          // Create unique identifier for circular detection\n          const visitKey = createDomainKey(target)\n          if (visited.has(visitKey)) {\n            continue // Skip circular references\n          }\n          visited.add(visitKey)\n\n          // Check if this nested exposure already exists\n          const existingNested = this.exposes.find(\n            (e) =>\n              !e.isRoot &&\n              e.entity.key === target.key &&\n              e.entity.domain === target.domain &&\n              e.parent?.key === parentKey\n          )\n\n          if (existingNested) {\n            continue // Already exposed under this parent\n          }\n\n          // Find the target domain entity for path generation\n          const targetDomainEntity = domain.findEntity(target.key, target.domain)\n          if (!targetDomainEntity) continue\n\n          const name = association.info.name || ''\n          // Create nested exposure\n          const nestedExposure: ExposedEntity = {\n            key: nanoid(),\n            entity: { ...target },\n            actions: [],\n            isRoot: false,\n            path: pluralize(name.toLocaleLowerCase()),\n            parent: {\n              key: parentKey,\n              association: {\n                key: association.key,\n                domain: currentEntity.domain,\n              },\n              depth: depth + 1,\n            },\n          }\n\n          this.exposes.push(nestedExposure)\n          if (depth + 1 >= maxDepth) {\n            nestedExposure.truncated = true\n          } else {\n            // Recursively follow associations\n            follow(target, nestedExposure.key, depth + 1)\n          }\n        }\n      }\n    }\n\n    // Start following from the root exposure\n    follow(parentExposure.entity, parentExposure.key, 0)\n  }\n\n  /**\n   * Removes an exposed entity from the API model.\n   * @param entity The entity to remove.\n   */\n  removeEntity(entity: AssociationTarget): void {\n    const current = this.exposes.find((e) => e.entity.key === entity.key && e.entity.domain === entity.domain)\n    if (!current) {\n      return\n    }\n    this.removeWithChildren(current.key)\n    this.notifyChange()\n  }\n\n  private removeWithChildren(key: string): void {\n    const index = this.exposes.findIndex((e) => e.key === key)\n    if (index < 0) {\n      return\n    }\n    // Remove the parent itself\n    this.exposes.splice(index, 1)\n    // Remove all children recursively\n    const removeChildren = (parentKey: string) => {\n      // Find all exposures whose parent.key matches parentKey\n      const children = this.exposes.filter((e) => e.parent?.key === parentKey)\n      for (const child of children) {\n        removeChildren(child.key)\n        const childIndex = this.exposes.findIndex((e) => e.key === child.key)\n        if (childIndex >= 0) {\n          this.exposes.splice(childIndex, 1)\n        }\n      }\n    }\n    // Then also remove children\n    removeChildren(key)\n    this.notifyChange()\n  }\n\n  /**\n   * Returns the exposed entity by its key.\n   * @param entityKey The key of the entity to find.\n   * @returns The exposed entity or undefined if not found.\n   */\n  getExposedEntity(entity: AssociationTarget): ExposedEntity | undefined {\n    return this.exposes.find((e) => e.entity.key === entity.key && e.entity.domain === entity.domain)\n  }\n\n  /**\n   * Clears the API model for a new entity change.\n   * This method resets the dependencies, exposes, user,\n   * authentication, authorization, and session properties.\n   */\n  cleanForEntityChange(): void {\n    this.dependencies.clear()\n    this.dependencyList = []\n    this.exposes = []\n    this.user = undefined\n    if (this.session) {\n      this.session.properties = []\n    }\n    if (this.authentication && this.authentication.strategy === 'UsernamePassword') {\n      const typed = this.authentication as UsernamePasswordConfiguration\n      typed.passwordKey = undefined\n    }\n    if (this.authorization && this.authorization.strategy == 'RBAC') {\n      const typed = this.authorization as RolesBasedAccessControl\n      typed.roleKey = ''\n    }\n  }\n\n  /**\n   * Attaches a DataDomain to this API model.\n   * This method clears any existing dependencies and sets the new domain.\n   *\n   * @param domain The DataDomain to attach to this API model.\n   * @throws Error if the domain does not have a version set in its info.\n   */\n  attachDataDomain(domain: DataDomain): void {\n    if (!domain.info.version) {\n      throw new Error(`Cannot attach DataDomain without a version. Please set the version in the domain info.`)\n    }\n    this.cleanForEntityChange()\n    this.dependencies.set(domain.key, domain)\n    this.dependencyList = [{ key: domain.key, version: domain.info.version }]\n    this.notifyChange()\n  }\n}\n"]}

package/build/src/modeling/Semantics.d.ts

@@ -14,6 +14,13 @@ export declare enum SemanticType {
      * ensuring it is encrypted and not exposed in API responses.
      */
     Password = "Semantic#Password",
+    /**
+     * Annotates the field as the username for user authentication.
+     * This identifies which field should be used for login purposes.
+     * Can be applied to dedicated username fields or email fields that serve as usernames.
+     * The runtime uses this for authentication, password reset, and user lookup operations.
+     */
+    Username = "Semantic#Username",
     /**
      * Designates a Data Property as the `createdAt` timestamp of an entity.
      * This is used to track when the entity was first created.

package/build/src/modeling/Semantics.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Semantics.d.ts","sourceRoot":"","sources":["../../../src/modeling/Semantics.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAEzD;;;GAGG;AACH,oBAAY,YAAY;IAKtB;;OAEG;IACH,IAAI,kBAAkB;IAMtB;;;;OAIG;IACH,QAAQ,sBAAsB;IAC9B;;;OAGG;IACH,gBAAgB,8BAA8B;IAC9C;;;OAGG;IACH,gBAAgB,8BAA8B;IAC9C;;;;;OAKG;IACH,gBAAgB,8BAA8B;IAC9C;;;;OAIG;IACH,WAAW,yBAAyB;IACpC;;;;;;;OAOG;IACH,gBAAgB,8BAA8B;IAC9C;;;;OAIG;IACH,KAAK,mBAAmB;IACxB;;;;;;OAMG;IACH,QAAQ,sBAAsB;IAC9B;;;;;;;;;OASG;IACH,MAAM,oBAAoB;IAE1B;;;;OAIG;IACH,OAAO,qBAAqB;IAE5B;;;OAGG;IACH,QAAQ,sBAAsB;IAE9B;;;OAGG;IACH,OAAO,qBAAqB;IAE5B;;;;;;OAMG;IACH,QAAQ,sBAAsB;IAE9B;;;;;;OAMG;IACH,IAAI,kBAAkB;IAEtB;;;;;;;;;;;;;;;OAeG;IACH,qBAAqB,mCAAmC;IAExD;;OAEG;IACH,KAAK,mBAAmB;IACxB;;OAEG;IACH,KAAK,mBAAmB;IACxB;;;;;;;OAOG;IACH,QAAQ,sBAAsB;IAC9B;;OAEG;IACH,GAAG,iBAAiB;IACpB;;;;OAIG;IACH,GAAG,iBAAiB;IACpB;;OAEG;IACH,WAAW,yBAAyB;IACpC;;OAEG;IACH,OAAO,qBAAqB;IAC5B;;OAEG;IACH,UAAU,wBAAwB;IAClC;;OAEG;IACH,OAAO,qBAAqB;IAC5B;;;;OAIG;IACH,eAAe,6BAA6B;IAM5C;;;;;;;;OAQG;IACH,uBAAuB,qCAAqC;IAC5D;;;;OAIG;IACH,IAAI,kBAAkB;IACtB;;;;OAIG;IACH,UAAU,wBAAwB;CACnC;AAED;;GAEG;AACH,oBAAY,aAAa;IACvB;;;OAGG;IACH,MAAM,WAAW;IACjB;;;OAGG;IACH,QAAQ,aAAa;IACrB;;;OAGG;IACH,WAAW,gBAAgB;CAC5B;AAED;;GAEG;AACH,oBAAY,gBAAgB;IAC1B;;OAEG;IACH,QAAQ,8BAA8B;IACtC;;OAEG;IACH,SAAS,4BAA4B;IACrC;;OAEG;IACH,OAAO,oBAAoB;IAC3B;;OAEG;IACH,QAAQ,kBAAkB;IAC1B;;OAEG;IACH,OAAO,wBAAwB;IAC/B;;OAEG;IACH,YAAY,kCAAkC;IAC9C;;OAEG;IACH,QAAQ,yBAAyB;IACjC;;OAEG;IACH,QAAQ,oBAAoB;CAC7B;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,KAAK,UAAU;IACf;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,IAAI,SAAS;CACd;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB;;OAEG;IACH,IAAI,SAAS;CACd;AAED;;GAEG;AACH,oBAAY,qBAAqB;IAC/B;;OAEG;IACH,WAAW,gBAAgB;IAC3B;;OAEG;IACH,YAAY,iBAAiB;IAC7B;;OAEG;IACH,UAAU,eAAe;CAC1B;AAED;;GAEG;AACH,oBAAY,0BAA0B;IACpC;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,IAAI,SAAS;CACd;AAED;;GAEG;AACH,oBAAY,qBAAqB;IAC/B;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,MAAM,WAAW;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,cAAc,CAAA;IACtB;;OAEG;IACH,UAAU,EAAE,iBAAiB,EAAE,CAAA;IAC/B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;;;OAIG;IACH,aAAa,CAAC,EAAE,qBAAqB,CAAA;IACrC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,0BAA0B,CAAA;IAC/C;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,EAAE,CAAA;IAC7B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;IAC1B;;OAEG;IACH,aAAa,CAAC,EAAE,qBAAqB,CAAA;IACrC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,iBAAiB,CAAA;IAC7B;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAChC;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAA;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAA;CACrC;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,YAAY,EAAE,OAAO,CAAA;IACrB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;CACtB;AAED;;;;;GAKG;AACH,UAAU,gBAAgB;IACxB;;OAEG;IACH,EAAE,EAAE,YAAY,CAAA;IAChB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,KAAK,EAAE,aAAa,CAAA;IACpB;;OAEG;IACH,QAAQ,EAAE,gBAAgB,CAAA;IAC1B;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,OAAO,EAAE,qBAAqB,CAAA;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD,KAAK,EAAE,aAAa,CAAC,MAAM,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAA;IAC7B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,kBAAkB,EAAE,CAAA;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D,KAAK,EAAE,aAAa,CAAC,WAAW,CAAA;CACjC;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,GAAI,UAAU,YAAY,KAAG,QAAQ,IAAI,cAC7B,CAAA;AAEzC;;GAEG;AACH,eAAO,MAAM,kBAAkB,GAAI,UAAU,YAAY,KAAG,QAAQ,IAAI,gBAC7B,CAAA;AAE3C;;GAEG;AACH,eAAO,MAAM,qBAAqB,GAAI,UAAU,YAAY,KAAG,QAAQ,IAAI,mBAC7B,CAAA;AAE9C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,cAAc,GAAG,gBAAgB,GAAG,mBAAmB,CAAA;AAElF;;;GAGG;AACH,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,YAAY,EAAE,YAAY,CAse5D,CAAA;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,SAAS,EAAE,mBAAmB,EAAE,EAChC,SAAS,EAAE,iBAAiB,EAC5B,MAAM,EAAE,cAAc,GACrB,mBAAmB,EAAE,CAwBvB;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAGzE;AAED,wBAAgB,sBAAsB,IAAI,MAAM,CAAC,gBAAgB,EAAE,YAAY,EAAE,CAAC,CAAA;AAClF,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,aAAa,CAAC,MAAM,GAAG,MAAM,CAAC,gBAAgB,EAAE,cAAc,EAAE,CAAC,CAAA;AAC/G,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,aAAa,CAAC,QAAQ,GAAG,MAAM,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,CAAC,CAAA;AACnH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,aAAa,CAAC,WAAW,GAC/B,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,EAAE,CAAC,CAAA;AA+BlD;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,GAAI,UAAU,gBAAgB,KAAG,YAAY,EAEnF,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,YAAY,CAAA;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACjC"}
+{"version":3,"file":"Semantics.d.ts","sourceRoot":"","sources":["../../../src/modeling/Semantics.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAEzD;;;GAGG;AACH,oBAAY,YAAY;IAKtB;;OAEG;IACH,IAAI,kBAAkB;IAMtB;;;;OAIG;IACH,QAAQ,sBAAsB;IAC9B;;;;;OAKG;IACH,QAAQ,sBAAsB;IAC9B;;;OAGG;IACH,gBAAgB,8BAA8B;IAC9C;;;OAGG;IACH,gBAAgB,8BAA8B;IAC9C;;;;;OAKG;IACH,gBAAgB,8BAA8B;IAC9C;;;;OAIG;IACH,WAAW,yBAAyB;IACpC;;;;;;;OAOG;IACH,gBAAgB,8BAA8B;IAC9C;;;;OAIG;IACH,KAAK,mBAAmB;IACxB;;;;;;OAMG;IACH,QAAQ,sBAAsB;IAC9B;;;;;;;;;OASG;IACH,MAAM,oBAAoB;IAE1B;;;;OAIG;IACH,OAAO,qBAAqB;IAE5B;;;OAGG;IACH,QAAQ,sBAAsB;IAE9B;;;OAGG;IACH,OAAO,qBAAqB;IAE5B;;;;;;OAMG;IACH,QAAQ,sBAAsB;IAE9B;;;;;;OAMG;IACH,IAAI,kBAAkB;IAEtB;;;;;;;;;;;;;;;OAeG;IACH,qBAAqB,mCAAmC;IAExD;;OAEG;IACH,KAAK,mBAAmB;IACxB;;OAEG;IACH,KAAK,mBAAmB;IACxB;;;;;;;OAOG;IACH,QAAQ,sBAAsB;IAC9B;;OAEG;IACH,GAAG,iBAAiB;IACpB;;;;OAIG;IACH,GAAG,iBAAiB;IACpB;;OAEG;IACH,WAAW,yBAAyB;IACpC;;OAEG;IACH,OAAO,qBAAqB;IAC5B;;OAEG;IACH,UAAU,wBAAwB;IAClC;;OAEG;IACH,OAAO,qBAAqB;IAC5B;;;;OAIG;IACH,eAAe,6BAA6B;IAM5C;;;;;;;;OAQG;IACH,uBAAuB,qCAAqC;IAC5D;;;;OAIG;IACH,IAAI,kBAAkB;IACtB;;;;OAIG;IACH,UAAU,wBAAwB;CACnC;AAED;;GAEG;AACH,oBAAY,aAAa;IACvB;;;OAGG;IACH,MAAM,WAAW;IACjB;;;OAGG;IACH,QAAQ,aAAa;IACrB;;;OAGG;IACH,WAAW,gBAAgB;CAC5B;AAED;;GAEG;AACH,oBAAY,gBAAgB;IAC1B;;OAEG;IACH,QAAQ,8BAA8B;IACtC;;OAEG;IACH,SAAS,4BAA4B;IACrC;;OAEG;IACH,OAAO,oBAAoB;IAC3B;;OAEG;IACH,QAAQ,kBAAkB;IAC1B;;OAEG;IACH,OAAO,wBAAwB;IAC/B;;OAEG;IACH,YAAY,kCAAkC;IAC9C;;OAEG;IACH,QAAQ,yBAAyB;IACjC;;OAEG;IACH,QAAQ,oBAAoB;CAC7B;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,KAAK,UAAU;IACf;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,IAAI,SAAS;CACd;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB;;OAEG;IACH,IAAI,SAAS;CACd;AAED;;GAEG;AACH,oBAAY,qBAAqB;IAC/B;;OAEG;IACH,WAAW,gBAAgB;IAC3B;;OAEG;IACH,YAAY,iBAAiB;IAC7B;;OAEG;IACH,UAAU,eAAe;CAC1B;AAED;;GAEG;AACH,oBAAY,0BAA0B;IACpC;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,IAAI,SAAS;CACd;AAED;;GAEG;AACH,oBAAY,qBAAqB;IAC/B;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,MAAM,WAAW;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,cAAc,CAAA;IACtB;;OAEG;IACH,UAAU,EAAE,iBAAiB,EAAE,CAAA;IAC/B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;;;OAIG;IACH,aAAa,CAAC,EAAE,qBAAqB,CAAA;IACrC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,0BAA0B,CAAA;IAC/C;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,EAAE,CAAA;IAC7B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;IAC1B;;OAEG;IACH,aAAa,CAAC,EAAE,qBAAqB,CAAA;IACrC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,iBAAiB,CAAA;IAC7B;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAChC;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAA;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,CAAA;CACrC;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,YAAY,EAAE,OAAO,CAAA;IACrB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;CACtB;AAED;;;;;GAKG;AACH,UAAU,gBAAgB;IACxB;;OAEG;IACH,EAAE,EAAE,YAAY,CAAA;IAChB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,KAAK,EAAE,aAAa,CAAA;IACpB;;OAEG;IACH,QAAQ,EAAE,gBAAgB,CAAA;IAC1B;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,OAAO,EAAE,qBAAqB,CAAA;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD,KAAK,EAAE,aAAa,CAAC,MAAM,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAA;IAC7B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,kBAAkB,EAAE,CAAA;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D,KAAK,EAAE,aAAa,CAAC,WAAW,CAAA;CACjC;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,GAAI,UAAU,YAAY,KAAG,QAAQ,IAAI,cAC7B,CAAA;AAEzC;;GAEG;AACH,eAAO,MAAM,kBAAkB,GAAI,UAAU,YAAY,KAAG,QAAQ,IAAI,gBAC7B,CAAA;AAE3C;;GAEG;AACH,eAAO,MAAM,qBAAqB,GAAI,UAAU,YAAY,KAAG,QAAQ,IAAI,mBAC7B,CAAA;AAE9C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,cAAc,GAAG,gBAAgB,GAAG,mBAAmB,CAAA;AAElF;;;GAGG;AACH,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,YAAY,EAAE,YAAY,CAsf5D,CAAA;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,SAAS,EAAE,mBAAmB,EAAE,EAChC,SAAS,EAAE,iBAAiB,EAC5B,MAAM,EAAE,cAAc,GACrB,mBAAmB,EAAE,CAwBvB;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAGzE;AAED,wBAAgB,sBAAsB,IAAI,MAAM,CAAC,gBAAgB,EAAE,YAAY,EAAE,CAAC,CAAA;AAClF,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,aAAa,CAAC,MAAM,GAAG,MAAM,CAAC,gBAAgB,EAAE,cAAc,EAAE,CAAC,CAAA;AAC/G,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,aAAa,CAAC,QAAQ,GAAG,MAAM,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,CAAC,CAAA;AACnH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,aAAa,CAAC,WAAW,GAC/B,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,EAAE,CAAC,CAAA;AA+BlD;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,GAAI,UAAU,gBAAgB,KAAG,YAAY,EAEnF,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,YAAY,CAAA;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACjC"}

package/build/src/modeling/Semantics.js

@@ -20,6 +20,13 @@ export var SemanticType;
      * ensuring it is encrypted and not exposed in API responses.
      */
     SemanticType["Password"] = "Semantic#Password";
+    /**
+     * Annotates the field as the username for user authentication.
+     * This identifies which field should be used for login purposes.
+     * Can be applied to dedicated username fields or email fields that serve as usernames.
+     * The runtime uses this for authentication, password reset, and user lookup operations.
+     */
+    SemanticType["Username"] = "Semantic#Username";
     /**
      * Designates a Data Property as the `createdAt` timestamp of an entity.
      * This is used to track when the entity was first created.
@@ -408,6 +415,22 @@ export const DataSemantics = {
             ],
         },
     },
+    [SemanticType.Username]: {
+        id: SemanticType.Username,
+        displayName: 'Username',
+        scope: SemanticScope.Property,
+        description: 'User authentication identifier',
+        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,
         displayName: 'User Role Field',