@api-client/core 0.11.1 → 0.11.3

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

@@ -4,6 +4,7 @@ import { DataEntity, IDataEntity } from './DataEntity.js';
 import { DataNamespace } from './DataNamespace.js';
 import { DataAssociationKind } from '../models/kinds.js';
 import type { AssociationBinding, AssociationBindings, AssociationWebBindings } from './Bindings.js';
+import { type DataAttributeAttribute } from './DataFormat.js';
 /**
  * Describes association target of an entity
  */
@@ -218,17 +219,11 @@ export declare class DataAssociation {
      */
     addTarget(entity: IDataEntity | string, namespace?: string): void;
     /**
-     * Removes a target entity from the association.
+     * Removes a target entity from the targets list.
      *
-     * @param entity - The `DataEntity` or `IDataEntity` instance to remove.
+     * @param init The key of an entity, its instance, or schema.
      */
-    removeTarget(entity: DataEntity | IDataEntity): void;
-    /**
-     * Removes a target entity from the association.
-     *
-     * @param key - The key of the target entity to remove.
-     */
-    removeTarget(key: string): void;
+    removeTarget(init: string | DataEntity | IDataEntity): void;
     /**
      * Creates a Property Shape of AMF.
      * The property itself is auto-generated. If the `schema` is defined then it is used
@@ -251,6 +246,12 @@ export declare class DataAssociation {
      * @returns The schema object.
      */
     ensureSchema(): IApiAssociationShape;
+    /**
+     * Checks whether the passed value is one of the supported data proprty attributes.
+     * @param value The value to test
+     * @returns True when the passed value is one of the supported data proprty attributes.
+     */
+    static isValidAttribute(value: unknown): value is DataAttributeAttribute;
     /**
      * Creates if not existing and returns web bindings definition.
      * @returns The web binding definition

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

@@ -1 +1 @@
-{"version":3,"file":"DataAssociation.d.ts","sourceRoot":"","sources":["../../../src/modeling/DataAssociation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AAEtF,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAElD,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACxD,OAAO,KAAK,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAA;AAEpG;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,OAAO,mBAAmB,CAAA;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;;;OAIG;IACH,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAC7B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAA;IAC7B;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAA;CAChC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBAAa,eAAe;IA0FjB,IAAI,EAAE,aAAa;IAzF5B,IAAI,SAAsB;IAE1B,GAAG,SAAK;IAER;;OAEG;IACH,IAAI,EAAE,KAAK,CAAqB;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;OAIG;IACH,OAAO,EAAE,iBAAiB,EAAE,CAAK;IAEjC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAA;IAE7B;;;;;;OAMG;IACH,QAAQ,EAAE,kBAAkB,EAAE,CAAK;IAEnC;;OAEG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,eAAe;IAY3F;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,GAAG,eAAe;IAMnE;;OAEG;gBAEM,IAAI,EAAE,aAAa,EAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,gBAAgB;IA2BnC;;;;OAIG;IACH,GAAG,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAsCjC;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IA8BrC;;;;OAIG;IACH,MAAM,IAAI,gBAAgB;IAwB1B;;;;OAIG;IACH,UAAU,IAAI,UAAU,EAAE;IAK1B;;OAEG;IACH,MAAM,IAAI,IAAI;IAad;;;;;OAKG;IACH,SAAS,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI;IAEnC;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI;IA+BjE;;;;OAIG;IACH,YAAY,CAAC,MAAM,EAAE,UAAU,GAAG,WAAW,GAAG,IAAI;IAEpD;;;;OAIG;IAEH,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAoB/B;;;;;;;;;OASG;IACH,UAAU,IAAI,iBAAiB;IAK/B;;;;OAIG;IACH,SAAS,IAAI,UAAU;IAMvB;;;OAGG;IACH,YAAY,IAAI,oBAAoB;IAOpC;;;OAGG;IACH,aAAa,IAAI,sBAAsB;IASvC;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,KAAK,GAAG,UAAU,GAAG,mBAAmB,GAAG,SAAS;CAIvE"}
+{"version":3,"file":"DataAssociation.d.ts","sourceRoot":"","sources":["../../../src/modeling/DataAssociation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AAEtF,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAElD,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACxD,OAAO,KAAK,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAA;AACpG,OAAO,EAA2B,KAAK,sBAAsB,EAAE,MAAM,iBAAiB,CAAA;AAEtF;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,OAAO,mBAAmB,CAAA;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;;;OAIG;IACH,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAC7B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAA;IAC7B;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAA;CAChC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBAAa,eAAe;IA0FjB,IAAI,EAAE,aAAa;IAzF5B,IAAI,SAAsB;IAE1B,GAAG,SAAK;IAER;;OAEG;IACH,IAAI,EAAE,KAAK,CAAqB;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;OAIG;IACH,OAAO,EAAE,iBAAiB,EAAE,CAAK;IAEjC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAA;IAE7B;;;;;;OAMG;IACH,QAAQ,EAAE,kBAAkB,EAAE,CAAK;IAEnC;;OAEG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,eAAe;IAY3F;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,GAAG,eAAe;IAMnE;;OAEG;gBAEM,IAAI,EAAE,aAAa,EAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,gBAAgB;IA2BnC;;;;OAIG;IACH,GAAG,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAsCjC;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IA8BrC;;;;OAIG;IACH,MAAM,IAAI,gBAAgB;IAwB1B;;;;OAIG;IACH,UAAU,IAAI,UAAU,EAAE;IAK1B;;OAEG;IACH,MAAM,IAAI,IAAI;IAad;;;;;OAKG;IACH,SAAS,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI;IAEnC;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI;IAiCjE;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,IAAI;IAa3D;;;;;;;;;OASG;IACH,UAAU,IAAI,iBAAiB;IAK/B;;;;OAIG;IACH,SAAS,IAAI,UAAU;IAMvB;;;OAGG;IACH,YAAY,IAAI,oBAAoB;IAOpC;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,sBAAsB;IAOxE;;;OAGG;IACH,aAAa,IAAI,sBAAsB;IASvC;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,KAAK,GAAG,UAAU,GAAG,mBAAmB,GAAG,SAAS;CAIvE"}

package/build/src/modeling/DataAssociation.js

@@ -4,6 +4,7 @@ import v4 from '../lib/uuid.js';
 import { Thing } from '../models/Thing.js';
 import { ValidationError } from '../exceptions/validation_error.js';
 import { DataAssociationKind } from '../models/kinds.js';
+import { DataAttributeAttributes } from './DataFormat.js';
 /**
  * Describes an association between entities. An association is a relationship defined on an entity
  * that links it to one or more other entities. The association has a `name` which is used as the
@@ -287,6 +288,8 @@ export class DataAssociation {
     }
     /**
      * @param init The key of an entity, its instance, or schema.
+     * @param namespace - The key of the foreign namespace this entity belongs to.
+     *      Do not set this value for local entities.
      */
     addTarget(init, namespace) {
         let key;
@@ -366,6 +369,17 @@ export class DataAssociation {
         }
         return this.schema;
     }
+    /**
+     * Checks whether the passed value is one of the supported data proprty attributes.
+     * @param value The value to test
+     * @returns True when the passed value is one of the supported data proprty attributes.
+     */
+    static isValidAttribute(value) {
+        if (typeof value !== 'string') {
+            return false;
+        }
+        return DataAttributeAttributes.includes(value);
+    }
     /**
      * Creates if not existing and returns web bindings definition.
      * @returns The web binding definition

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

@@ -1 +1 @@
-{"version":3,"file":"DataAssociation.js","sourceRoot":"","sources":["../../../src/modeling/DataAssociation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAA;AACvC,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAA;AAE/D,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAC/B,OAAO,EAAU,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAGlD,OAAO,EAA+B,eAAe,EAAE,MAAM,mCAAmC,CAAA;AAChG,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAwExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,OAAO,eAAe;IA0FjB;IAzFT,IAAI,GAAG,mBAAmB,CAAA;IAE1B,GAAG,GAAG,EAAE,CAAA;IAER;;OAEG;IACH,IAAI,GAAU,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;IAEhC;;OAEG;IACH,QAAQ,CAAU;IAElB;;OAEG;IACH,QAAQ,CAAU;IAElB;;;;OAIG;IACH,OAAO,GAAwB,EAAE,CAAA;IAEjC;;;;;;OAMG;IACH,MAAM,CAAuB;IAE7B;;;;;;OAMG;IACH,QAAQ,GAAyB,EAAE,CAAA;IAEnC;;OAEG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAU,CAAC,IAAmB,EAAE,MAAc,EAAE,SAAkB;QACvE,MAAM,KAAK,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAA;QACvC,MAAM,IAAI,GAAsB;YAC9B,GAAG,EAAE,MAAM;SACZ,CAAA;QACD,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC5B,CAAC;QACD,KAAK,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA;QACtB,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAmB,EAAE,IAAY;QAC/C,MAAM,KAAK,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAA;QACvC,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QACjC,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;OAEG;IACH,YACS,IAAmB,EAC1B,KAAiC;QAD1B,SAAI,GAAJ,IAAI,CAAe;QAG1B,IAAI,IAAsB,CAAA;QAC1B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,IAAI,CAAC;gBACH,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;YAC1B,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,IAAI,eAAe,CAAC;oBACxB;wBACE,KAAK,EAAE,EAAE;wBACT,OAAO,EAAE,qDAAqD;wBAC9D,IAAI,EAAE,iBAAiB;qBACxB;iBACF,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACrC,IAAI,GAAG,KAAK,CAAA;QACd,CAAC;aAAM,CAAC;YACN,IAAI,GAAG;gBACL,IAAI,EAAE,mBAAmB;gBACzB,GAAG,EAAE,EAAE,EAAE;gBACT,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC,MAAM,EAAE;aACrD,CAAA;QACH,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAChB,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,IAAsB;QACxB,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QAC9B,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,EAAE,EAAE,EAAE,IAAI,GAAG,mBAAmB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAA;QAC5G,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,IAAI,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,CAAA;QAC7B,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;QAChC,CAAC;QACD,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QAClC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,GAAG,SAAS,CAAA;QACzB,CAAC;QACD,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE,CAAC;YAClC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QAC1B,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAA;QAC3B,CAAC;QACD,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE,CAAC;YAClC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QAC1B,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAA;QAC3B,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;QAC/C,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;QACnB,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;QACpD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAA;QACpB,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,KAAc;QAC5B,MAAM,KAAK,GAAG,KAAyB,CAAA;QACvC,MAAM,QAAQ,GAA6B,EAAE,CAAA;QAC7C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,QAAQ,CAAC,IAAI,CAAC;gBACZ,KAAK,EAAE,EAAE;gBACT,OAAO,EAAE,mCAAmC;gBAC5C,IAAI,EAAE,UAAU;aACjB,CAAC,CAAA;YACF,MAAM,IAAI,eAAe,CAAC,QAAQ,CAAC,CAAA;QACrC,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;YACvC,QAAQ,CAAC,IAAI,CAAC;gBACZ,KAAK,EAAE,MAAM;gBACb,OAAO,EAAE,6BAA6B,mBAAmB,EAAE;gBAC3D,IAAI,EAAE,SAAS;aAChB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACjD,QAAQ,CAAC,IAAI,CAAC;gBACZ,KAAK,EAAE,MAAM;gBACb,OAAO,EAAE,qCAAqC;gBAC9C,IAAI,EAAE,SAAS;aAChB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;YACpB,MAAM,IAAI,eAAe,CAAC,QAAQ,CAAC,CAAA;QACrC,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,MAAM,GAAqB;YAC/B,IAAI,EAAE,mBAAmB;YACzB,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;SACzB,CAAA;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACzC,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACvC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;QACjC,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACvC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;QACjC,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACvD,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;QACtD,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACzD,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;QAC3D,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;OAIG;IACH,UAAU;QACR,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAiB,CAAA;IACrF,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAA;QACrB,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAA;QAC5F,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAA;YACnE,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAA;QAC3C,CAAC;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,CAAC,CAAA;QACxF,IAAI,QAAQ,IAAI,CAAC,EAAE,CAAC;YAClB,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAA;QACxD,CAAC;IACH,CAAC;IAmBD;;OAEG;IACH,SAAS,CAAC,IAAuC,EAAE,SAAkB;QACnE,IAAI,GAAW,CAAA;QACf,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,GAAG,GAAG,IAAI,CAAA;QACZ,CAAC;aAAM,CAAC;YACN,GAAG,GAAG,IAAI,CAAC,GAAG,CAAA;YACd,MAAM,KAAK,GAAG,IAA8C,CAAA;YAC5D,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;gBACzD,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAA;YAC5B,CAAC;QACH,CAAC;QACD,IAAI,SAAS,IAAI,SAAS,KAAK,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YAC7C,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,KAAK,SAAS,CAAC,CAAA;YAC7E,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACtB,MAAM,IAAI,KAAK,CAAC,sBAAsB,SAAS,mBAAmB,CAAC,CAAA;YACrE,CAAC;QACH,CAAC;QACD,MAAM,IAAI,GAAsB;YAC9B,GAAG;SACJ,CAAA;QACD,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC5B,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACzB,CAAC;IAiBD;;;;OAIG;IACH,YAAY,CAAC,IAAuC;QAClD,IAAI,GAAW,CAAA;QACf,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,GAAG,GAAG,IAAI,CAAA;QACZ,CAAC;aAAM,CAAC;YACN,GAAG,GAAG,IAAI,CAAC,GAAG,CAAA;QAChB,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAA;QAC1D,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;QAC/B,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU;QACR,MAAM,UAAU,GAAG,IAAI,iBAAiB,EAAE,CAAA;QAC1C,OAAO,UAAU,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;IAC7C,CAAC;IAED;;;;OAIG;IACH,SAAS;QACP,6EAA6E;QAC7E,2BAA2B;QAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAe,CAAA;IAChG,CAAC;IAED;;;OAGG;IACH,YAAY;QACV,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,MAAM,GAAG,EAAE,CAAA;QAClB,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,IAAI,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAmC,CAAA;QAC1F,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAwB,CAAA;YAC1D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC5B,CAAC;QACD,OAAO,MAAM,CAAC,MAAgC,CAAA;IAChD,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,IAAwB;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAuB,CAAA;QAC7E,OAAO,IAAI,EAAE,MAAM,CAAA;IACrB,CAAC;CACF","sourcesContent":["import { Json } from '@api-client/json'\nimport { AmfShapeGenerator } from '../amf/AmfShapeGenerator.js'\nimport { IApiAssociationShape, IApiPropertyShape } from '../amf/definitions/Shapes.js'\nimport v4 from '../lib/uuid.js'\nimport { IThing, Thing } from '../models/Thing.js'\nimport { DataEntity, IDataEntity } from './DataEntity.js'\nimport { DataNamespace } from './DataNamespace.js'\nimport { type FieldValidationMessage, ValidationError } from '../exceptions/validation_error.js'\nimport { DataAssociationKind } from '../models/kinds.js'\nimport type { AssociationBinding, AssociationBindings, AssociationWebBindings } from './Bindings.js'\n\n/**\n * Describes association target of an entity\n */\nexport interface AssociationTarget {\n  /**\n   * The key of the associated entity.\n   */\n  key: string\n  /**\n   * The key of the namespace to look for entities.\n   * By default it is the current (root) namespace. When this is set the program\n   * will look into `foreign` of the root namespace for the definition\n   * of the entity.\n   */\n  namespace?: string\n}\n\n/**\n * Describes an association between entities. An association is another property of an entity.\n * The `name` is the name of the property and the value is the associated target or targets.\n *\n * An association can have multiple targets to allow describing the model as `allOf`, `anyOf` and `oneOf` schemas.\n * When the association has only one target, then generated schema cannot have union types.\n *\n * Depending on the schema translation an association can be embedded as a sub-object in the generated schema\n * or can be references via a primary key.\n */\nexport interface IDataAssociation {\n  kind: typeof DataAssociationKind\n  /**\n   * The key of the association.\n   */\n  key: string\n  /**\n   * The data association description.\n   */\n  info: IThing\n  /**\n   * Wether the data association is required.\n   */\n  required?: boolean\n  /**\n   * Whether the data association allows multiple items.\n   */\n  multiple?: boolean\n  /**\n   * The list of keys associated with the entity through this association.\n   * An association without a target is considered invalid and discarded when processing the values.\n   * When multiple associations are set then we are dealing with an union.\n   */\n  targets?: AssociationTarget[]\n  /**\n   * The schema allowing to translate the model into a specific format (like JSON, RAML, XML, etc.)\n   *\n   * When this is defined then it is used as the schema. When this is not defined it uses\n   * referenced entities schemas. Note, changes in the referenced entities may not be propagated\n   * to schemas altered by the user.\n   */\n  schema?: IApiAssociationShape\n  /**\n   * The list of bindings for this property.\n   *\n   * A binding defines a translation from a data model to a specific format.\n   * For example allows to define properties required to generate AMF shape and therefore RAML/OAS shapes for web APIs\n   * or a protocol buffer schema.\n   */\n  bindings?: AssociationBinding[]\n}\n\n/**\n * Describes an association between entities. An association is a relationship defined on an entity\n * that links it to one or more other entities. The association has a `name` which is used as the\n * property name in the context of the parent entity, and it connects to a set of `targets`\n * representing the associated entities.\n *\n * An association can have multiple targets to allow describing the model as `allOf`, `anyOf`, or `oneOf`\n * schemas. When the association has only one target, then the generated schema cannot have union types.\n *\n * Depending on the schema translation, an association can be embedded as a sub-object in the generated\n * schema, or it can be referenced via a primary key.\n *\n * ## Key Concepts\n *\n * - **Targets**: An association's `targets` specify the entities that this association points to.\n *     Each target is defined by:\n *     -   `key`: The key of the target entity.\n *     -   `namespace` (optional): The key of the namespace where the target entity is defined.\n *         If not specified, it defaults to the current namespace.\n *\n * -   **Cardinality**:\n *     -   `multiple` (boolean): Indicates whether the association allows multiple target entities.\n *         If `true`, it's a to-many relationship; otherwise, it's a to-one relationship.\n *\n * -   **Schema**:\n *     -   `schema` (optional): A custom schema for the association, allowing manual definition of the\n *         association's structure in specific formats (e.g., JSON, RAML, XML).\n *         When provided, this schema overrides the automatically generated schema based on the\n *         target entities.\n *         -   **Important**: If a custom schema is defined and changes are made to the referenced\n *             entities, those changes **will not** be automatically propagated to the custom schema.\n *             This means the custom schema may become outdated and no longer accurately reflect the\n *             structure of the target entities.\n *\n * - **Hidden**:\n *  - `hidden`: (boolean) Defines if this association is a part of the schema or not.\n */\nexport class DataAssociation {\n  kind = DataAssociationKind\n\n  key = ''\n\n  /**\n   * The description of the data association.\n   */\n  info: Thing = Thing.fromName('')\n\n  /**\n   * Wether the data association is required.\n   */\n  required?: boolean\n\n  /**\n   * Whether the data association allows multiple items.\n   */\n  multiple?: boolean\n\n  /**\n   * The list of keys associated with the entity through this association.\n   * An association without a target is considered invalid and discarded when processing the values.\n   * When multiple associations are set then we are dealing with an union.\n   */\n  targets: AssociationTarget[] = []\n\n  /**\n   * The schema allowing to translate the model into a specific format (like JSON, RAML, XML, etc.)\n   *\n   * When this is defined then it is used as the schema. When this is not defined it uses\n   * referenced entities schemas. Note, changes in the referenced entities may not be propagated\n   * to schemas altered by the user.\n   */\n  schema?: IApiAssociationShape\n\n  /**\n   * The list of bindings for this property.\n   *\n   * A binding defines a translation from a data model to a specific format.\n   * For example allows to define properties required to generate AMF shape and therefore RAML/OAS shapes for web APIs\n   * or a protocol buffer schema.\n   */\n  bindings: AssociationBinding[] = []\n\n  /**\n   * Returns true when the association has 0 or 1 targets.\n   */\n  get isSingle(): boolean {\n    return this.targets.length < 2\n  }\n\n  /**\n   * Creates an instance of DataAssociation from a target entity key.\n   * Note, this entity will have no name. The default name is used instead.\n   *\n   * @param root The namespace root.\n   * @param target The target entity key.\n   * @param namespace The optional key of the target association when different to the current one.\n   * @returns A new `DataAssociation` instance.\n   */\n  static fromTarget(root: DataNamespace, target: string, namespace?: string): DataAssociation {\n    const assoc = new DataAssociation(root)\n    const info: AssociationTarget = {\n      key: target,\n    }\n    if (namespace) {\n      info.namespace = namespace\n    }\n    assoc.targets = [info]\n    return assoc\n  }\n\n  /**\n   * Creates an instance of DataAssociation from a name, without defining a target.\n   *\n   * @param root The namespace root.\n   * @param name The name of the association.\n   * @returns A new `DataAssociation` instance.\n   */\n  static fromName(root: DataNamespace, name: string): DataAssociation {\n    const assoc = new DataAssociation(root)\n    assoc.info = Thing.fromName(name)\n    return assoc\n  }\n\n  /**\n   * @param input The data association definition to restore.\n   */\n  constructor(\n    public root: DataNamespace,\n    input?: string | IDataAssociation\n  ) {\n    let init: IDataAssociation\n    if (typeof input === 'string') {\n      try {\n        init = JSON.parse(input)\n      } catch {\n        throw new ValidationError([\n          {\n            field: '',\n            message: 'Unable to parse the data association input as JSON.',\n            rule: 'object_required',\n          },\n        ])\n      }\n    } else if (typeof input === 'object') {\n      init = input\n    } else {\n      init = {\n        kind: DataAssociationKind,\n        key: v4(),\n        info: Thing.fromName('Unnamed association').toJSON(),\n      }\n    }\n    this.new(init)\n  }\n\n  /**\n   * Initializes the association using provided data.\n   *\n   * @param init - The data association definition to restore.\n   */\n  new(init: IDataAssociation): this {\n    DataAssociation.validate(init)\n    const { info, key = v4(), kind = DataAssociationKind, schema, multiple, required, targets, bindings } = init\n    this.kind = kind\n    this.key = key\n    if (info) {\n      this.info = new Thing(info)\n    } else {\n      this.info = Thing.fromName('')\n    }\n    if (schema) {\n      this.schema = Json.clone(schema)\n    } else {\n      this.schema = undefined\n    }\n    if (typeof multiple === 'boolean') {\n      this.multiple = multiple\n    } else {\n      this.multiple = undefined\n    }\n    if (typeof required === 'boolean') {\n      this.required = required\n    } else {\n      this.required = undefined\n    }\n    if (Array.isArray(targets)) {\n      this.targets = targets.map((i) => ({ ...i }))\n    } else {\n      this.targets = []\n    }\n    if (Array.isArray(bindings)) {\n      this.bindings = bindings.map((i) => Json.clone(i))\n    } else {\n      this.bindings = []\n    }\n    return this\n  }\n\n  /**\n   * Validates if the input object is a valid `DataAssociation` definition.\n   * Throws a `ValidationError` if the input is invalid.\n   *\n   * @param input The object to validate.\n   * @throws {ValidationError} When the validation fails.\n   */\n  static validate(input: unknown): void {\n    const typed = input as IDataAssociation\n    const messages: FieldValidationMessage[] = []\n    if (!typed) {\n      messages.push({\n        field: '',\n        message: 'The input is required. None given',\n        rule: 'required',\n      })\n      throw new ValidationError(messages)\n    }\n    if (typed.kind !== DataAssociationKind) {\n      messages.push({\n        field: 'kind',\n        message: `The kind property must be ${DataAssociationKind}`,\n        rule: 'invalid',\n      })\n    }\n    if (typed.info && typeof typed.info !== 'object') {\n      messages.push({\n        field: 'info',\n        message: 'The info property must be an object',\n        rule: 'invalid',\n      })\n    }\n    if (messages.length) {\n      throw new ValidationError(messages)\n    }\n  }\n\n  /**\n   * Generates an object representing the association, suitable for serialization.\n   *\n   * @returns A plain object representation of the `DataAssociation`.\n   */\n  toJSON(): IDataAssociation {\n    const result: IDataAssociation = {\n      kind: DataAssociationKind,\n      key: this.key,\n      info: this.info.toJSON(),\n    }\n    if (this.schema) {\n      result.schema = Json.clone(this.schema)\n    }\n    if (typeof this.multiple === 'boolean') {\n      result.multiple = this.multiple\n    }\n    if (typeof this.required === 'boolean') {\n      result.required = this.required\n    }\n    if (Array.isArray(this.targets) && this.targets.length) {\n      result.targets = this.targets.map((i) => ({ ...i }))\n    }\n    if (Array.isArray(this.bindings) && this.bindings.length) {\n      result.bindings = this.bindings.map((i) => Json.clone(i))\n    }\n    return result\n  }\n\n  /**\n   * Retrieves the list of target entities.\n   *\n   * @returns An array of `DataEntity` instances representing the targets of this association.\n   */\n  getTargets(): DataEntity[] {\n    const { targets } = this\n    return this.root.findAssociatedEntities(targets).filter((i) => !!i) as DataEntity[]\n  }\n\n  /**\n   * Removes self from the parent entity and the namespace definition.\n   */\n  remove(): void {\n    const { root } = this\n    const entity = root.definitions.entities.find((i) => i.associations.some((j) => j === this))\n    if (entity) {\n      const assocIndex = entity.associations.findIndex((i) => i === this)\n      entity.associations.splice(assocIndex, 1)\n    }\n    const defIndex = this.root.definitions.associations.findIndex((i) => i.key === this.key)\n    if (defIndex >= 0) {\n      this.root.definitions.associations.splice(defIndex, 1)\n    }\n  }\n\n  /**\n   * Adds a target entity to the association.\n   * If the entity comes from another namespace then it is set as a foreign entity.\n   *\n   * @param entity - The `DataEntity` instance to add.\n   */\n  addTarget(entity: DataEntity): void\n\n  /**\n   * Adds a target entity to the association.\n   *\n   * @param entity - The `IDataEntity` definition or just its key.\n   * @param namespace - The key of the foreign namespace this entity belongs to.\n   *      Do not set this value for local entities.\n   */\n  addTarget(entity: IDataEntity | string, namespace?: string): void\n\n  /**\n   * @param init The key of an entity, its instance, or schema.\n   */\n  addTarget(init: string | DataEntity | IDataEntity, namespace?: string): void {\n    let key: string\n    if (typeof init === 'string') {\n      key = init\n    } else {\n      key = init.key\n      const typed = init as IDataEntity & { root?: DataNamespace }\n      if (!namespace && typed.root && typed.root !== this.root) {\n        namespace = typed.root.key\n      }\n    }\n    if (namespace && namespace !== this.root.key) {\n      const foreignNamespace = this.root.foreign.find((ns) => ns.key === namespace)\n      if (!foreignNamespace) {\n        throw new Error(`Foreign namespace \"${namespace}\" does not exist.`)\n      }\n    }\n    const info: AssociationTarget = {\n      key,\n    }\n    if (namespace) {\n      info.namespace = namespace\n    }\n    this.targets.push(info)\n  }\n\n  /**\n   * Removes a target entity from the association.\n   *\n   * @param entity - The `DataEntity` or `IDataEntity` instance to remove.\n   */\n  removeTarget(entity: DataEntity | IDataEntity): void\n\n  /**\n   * Removes a target entity from the association.\n   *\n   * @param key - The key of the target entity to remove.\n   */\n  // eslint-disable-next-line @typescript-eslint/unified-signatures\n  removeTarget(key: string): void\n\n  /**\n   * Removes a target entity from the targets list.\n   *\n   * @param init The key of an entity, its instance, or schema.\n   */\n  removeTarget(init: string | DataEntity | IDataEntity): void {\n    let key: string\n    if (typeof init === 'string') {\n      key = init\n    } else {\n      key = init.key\n    }\n    const index = this.targets.findIndex((i) => i.key === key)\n    if (index >= 0) {\n      this.targets.splice(index, 1)\n    }\n  }\n\n  /**\n   * Creates a Property Shape of AMF.\n   * The property itself is auto-generated. If the `schema` is defined then it is used\n   * as the `range` of the property. Otherwise basic shape is generated for the range.\n   *\n   * This is a preferred way of reading the AMF shape as this synchronizes changed\n   * data properties with the shape definition.\n   *\n   * @returns AMF property shape definition.\n   */\n  toApiShape(): IApiPropertyShape {\n    const serializer = new AmfShapeGenerator()\n    return serializer.associationProperty(this)\n  }\n\n  /**\n   * Retrieves the parent entity of this association.\n   *\n   * @returns The `DataEntity` instance that contains this association.\n   */\n  getParent(): DataEntity {\n    // this is forced as an association is only created when an entity is created\n    // so it has to be defined.\n    return this.root.definitions.entities.find((i) => i.associations.includes(this)) as DataEntity\n  }\n\n  /**\n   * Creates the `schema` object if missing and returns it.\n   * @returns The schema object.\n   */\n  ensureSchema(): IApiAssociationShape {\n    if (!this.schema) {\n      this.schema = {}\n    }\n    return this.schema\n  }\n\n  /**\n   * Creates if not existing and returns web bindings definition.\n   * @returns The web binding definition\n   */\n  getWebBinding(): AssociationWebBindings {\n    let object = this.bindings.find((i) => i.type === 'web') as AssociationBinding | undefined\n    if (!object) {\n      object = { type: 'web', schema: {} } as AssociationBinding\n      this.bindings.push(object)\n    }\n    return object.schema as AssociationWebBindings\n  }\n\n  /**\n   * Returns the schema value of the binding, if any was created.\n   * @param type The type of the binding to read.\n   * @returns The binding schema, if any\n   */\n  readBinding(type: 'web' | 'protobuf'): AssociationBindings | undefined {\n    const item = this.bindings.find((i) => i.type === type) as AssociationBinding\n    return item?.schema\n  }\n}\n"]}
+{"version":3,"file":"DataAssociation.js","sourceRoot":"","sources":["../../../src/modeling/DataAssociation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAA;AACvC,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAA;AAE/D,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAC/B,OAAO,EAAU,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAGlD,OAAO,EAA+B,eAAe,EAAE,MAAM,mCAAmC,CAAA;AAChG,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAExD,OAAO,EAAE,uBAAuB,EAA+B,MAAM,iBAAiB,CAAA;AAuEtF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,OAAO,eAAe;IA0FjB;IAzFT,IAAI,GAAG,mBAAmB,CAAA;IAE1B,GAAG,GAAG,EAAE,CAAA;IAER;;OAEG;IACH,IAAI,GAAU,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;IAEhC;;OAEG;IACH,QAAQ,CAAU;IAElB;;OAEG;IACH,QAAQ,CAAU;IAElB;;;;OAIG;IACH,OAAO,GAAwB,EAAE,CAAA;IAEjC;;;;;;OAMG;IACH,MAAM,CAAuB;IAE7B;;;;;;OAMG;IACH,QAAQ,GAAyB,EAAE,CAAA;IAEnC;;OAEG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAU,CAAC,IAAmB,EAAE,MAAc,EAAE,SAAkB;QACvE,MAAM,KAAK,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAA;QACvC,MAAM,IAAI,GAAsB;YAC9B,GAAG,EAAE,MAAM;SACZ,CAAA;QACD,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC5B,CAAC;QACD,KAAK,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA;QACtB,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAmB,EAAE,IAAY;QAC/C,MAAM,KAAK,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAA;QACvC,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QACjC,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;OAEG;IACH,YACS,IAAmB,EAC1B,KAAiC;QAD1B,SAAI,GAAJ,IAAI,CAAe;QAG1B,IAAI,IAAsB,CAAA;QAC1B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,IAAI,CAAC;gBACH,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;YAC1B,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,IAAI,eAAe,CAAC;oBACxB;wBACE,KAAK,EAAE,EAAE;wBACT,OAAO,EAAE,qDAAqD;wBAC9D,IAAI,EAAE,iBAAiB;qBACxB;iBACF,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACrC,IAAI,GAAG,KAAK,CAAA;QACd,CAAC;aAAM,CAAC;YACN,IAAI,GAAG;gBACL,IAAI,EAAE,mBAAmB;gBACzB,GAAG,EAAE,EAAE,EAAE;gBACT,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC,MAAM,EAAE;aACrD,CAAA;QACH,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAChB,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,IAAsB;QACxB,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QAC9B,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,EAAE,EAAE,EAAE,IAAI,GAAG,mBAAmB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAA;QAC5G,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,IAAI,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,CAAA;QAC7B,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;QAChC,CAAC;QACD,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QAClC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,GAAG,SAAS,CAAA;QACzB,CAAC;QACD,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE,CAAC;YAClC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QAC1B,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAA;QAC3B,CAAC;QACD,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE,CAAC;YAClC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QAC1B,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAA;QAC3B,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;QAC/C,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;QACnB,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;QACpD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAA;QACpB,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,KAAc;QAC5B,MAAM,KAAK,GAAG,KAAyB,CAAA;QACvC,MAAM,QAAQ,GAA6B,EAAE,CAAA;QAC7C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,QAAQ,CAAC,IAAI,CAAC;gBACZ,KAAK,EAAE,EAAE;gBACT,OAAO,EAAE,mCAAmC;gBAC5C,IAAI,EAAE,UAAU;aACjB,CAAC,CAAA;YACF,MAAM,IAAI,eAAe,CAAC,QAAQ,CAAC,CAAA;QACrC,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;YACvC,QAAQ,CAAC,IAAI,CAAC;gBACZ,KAAK,EAAE,MAAM;gBACb,OAAO,EAAE,6BAA6B,mBAAmB,EAAE;gBAC3D,IAAI,EAAE,SAAS;aAChB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACjD,QAAQ,CAAC,IAAI,CAAC;gBACZ,KAAK,EAAE,MAAM;gBACb,OAAO,EAAE,qCAAqC;gBAC9C,IAAI,EAAE,SAAS;aAChB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;YACpB,MAAM,IAAI,eAAe,CAAC,QAAQ,CAAC,CAAA;QACrC,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,MAAM,GAAqB;YAC/B,IAAI,EAAE,mBAAmB;YACzB,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;SACzB,CAAA;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACzC,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACvC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;QACjC,CAAC;QACD,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACvC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;QACjC,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACvD,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;QACtD,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACzD,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;QAC3D,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;OAIG;IACH,UAAU;QACR,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAiB,CAAA;IACrF,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAA;QACrB,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAA;QAC5F,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAA;YACnE,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAA;QAC3C,CAAC;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,CAAC,CAAA;QACxF,IAAI,QAAQ,IAAI,CAAC,EAAE,CAAC;YAClB,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAA;QACxD,CAAC;IACH,CAAC;IAmBD;;;;OAIG;IACH,SAAS,CAAC,IAAuC,EAAE,SAAkB;QACnE,IAAI,GAAW,CAAA;QACf,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,GAAG,GAAG,IAAI,CAAA;QACZ,CAAC;aAAM,CAAC;YACN,GAAG,GAAG,IAAI,CAAC,GAAG,CAAA;YACd,MAAM,KAAK,GAAG,IAA8C,CAAA;YAC5D,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;gBACzD,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAA;YAC5B,CAAC;QACH,CAAC;QACD,IAAI,SAAS,IAAI,SAAS,KAAK,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YAC7C,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,KAAK,SAAS,CAAC,CAAA;YAC7E,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACtB,MAAM,IAAI,KAAK,CAAC,sBAAsB,SAAS,mBAAmB,CAAC,CAAA;YACrE,CAAC;QACH,CAAC;QACD,MAAM,IAAI,GAAsB;YAC9B,GAAG;SACJ,CAAA;QACD,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC5B,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACzB,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,IAAuC;QAClD,IAAI,GAAW,CAAA;QACf,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,GAAG,GAAG,IAAI,CAAA;QACZ,CAAC;aAAM,CAAC;YACN,GAAG,GAAG,IAAI,CAAC,GAAG,CAAA;QAChB,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAA;QAC1D,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;QAC/B,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU;QACR,MAAM,UAAU,GAAG,IAAI,iBAAiB,EAAE,CAAA;QAC1C,OAAO,UAAU,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;IAC7C,CAAC;IAED;;;;OAIG;IACH,SAAS;QACP,6EAA6E;QAC7E,2BAA2B;QAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAe,CAAA;IAChG,CAAC;IAED;;;OAGG;IACH,YAAY;QACV,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,MAAM,GAAG,EAAE,CAAA;QAClB,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,KAAc;QACpC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAA;QACd,CAAC;QACD,OAAO,uBAAuB,CAAC,QAAQ,CAAC,KAA+B,CAAC,CAAA;IAC1E,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,IAAI,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAmC,CAAA;QAC1F,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAwB,CAAA;YAC1D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC5B,CAAC;QACD,OAAO,MAAM,CAAC,MAAgC,CAAA;IAChD,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,IAAwB;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAuB,CAAA;QAC7E,OAAO,IAAI,EAAE,MAAM,CAAA;IACrB,CAAC;CACF","sourcesContent":["import { Json } from '@api-client/json'\nimport { AmfShapeGenerator } from '../amf/AmfShapeGenerator.js'\nimport { IApiAssociationShape, IApiPropertyShape } from '../amf/definitions/Shapes.js'\nimport v4 from '../lib/uuid.js'\nimport { IThing, Thing } from '../models/Thing.js'\nimport { DataEntity, IDataEntity } from './DataEntity.js'\nimport { DataNamespace } from './DataNamespace.js'\nimport { type FieldValidationMessage, ValidationError } from '../exceptions/validation_error.js'\nimport { DataAssociationKind } from '../models/kinds.js'\nimport type { AssociationBinding, AssociationBindings, AssociationWebBindings } from './Bindings.js'\nimport { DataAttributeAttributes, type DataAttributeAttribute } from './DataFormat.js'\n\n/**\n * Describes association target of an entity\n */\nexport interface AssociationTarget {\n  /**\n   * The key of the associated entity.\n   */\n  key: string\n  /**\n   * The key of the namespace to look for entities.\n   * By default it is the current (root) namespace. When this is set the program\n   * will look into `foreign` of the root namespace for the definition\n   * of the entity.\n   */\n  namespace?: string\n}\n\n/**\n * Describes an association between entities. An association is another property of an entity.\n * The `name` is the name of the property and the value is the associated target or targets.\n *\n * An association can have multiple targets to allow describing the model as `allOf`, `anyOf` and `oneOf` schemas.\n * When the association has only one target, then generated schema cannot have union types.\n *\n * Depending on the schema translation an association can be embedded as a sub-object in the generated schema\n * or can be references via a primary key.\n */\nexport interface IDataAssociation {\n  kind: typeof DataAssociationKind\n  /**\n   * The key of the association.\n   */\n  key: string\n  /**\n   * The data association description.\n   */\n  info: IThing\n  /**\n   * Wether the data association is required.\n   */\n  required?: boolean\n  /**\n   * Whether the data association allows multiple items.\n   */\n  multiple?: boolean\n  /**\n   * The list of keys associated with the entity through this association.\n   * An association without a target is considered invalid and discarded when processing the values.\n   * When multiple associations are set then we are dealing with an union.\n   */\n  targets?: AssociationTarget[]\n  /**\n   * The schema allowing to translate the model into a specific format (like JSON, RAML, XML, etc.)\n   *\n   * When this is defined then it is used as the schema. When this is not defined it uses\n   * referenced entities schemas. Note, changes in the referenced entities may not be propagated\n   * to schemas altered by the user.\n   */\n  schema?: IApiAssociationShape\n  /**\n   * The list of bindings for this property.\n   *\n   * A binding defines a translation from a data model to a specific format.\n   * For example allows to define properties required to generate AMF shape and therefore RAML/OAS shapes for web APIs\n   * or a protocol buffer schema.\n   */\n  bindings?: AssociationBinding[]\n}\n\n/**\n * Describes an association between entities. An association is a relationship defined on an entity\n * that links it to one or more other entities. The association has a `name` which is used as the\n * property name in the context of the parent entity, and it connects to a set of `targets`\n * representing the associated entities.\n *\n * An association can have multiple targets to allow describing the model as `allOf`, `anyOf`, or `oneOf`\n * schemas. When the association has only one target, then the generated schema cannot have union types.\n *\n * Depending on the schema translation, an association can be embedded as a sub-object in the generated\n * schema, or it can be referenced via a primary key.\n *\n * ## Key Concepts\n *\n * - **Targets**: An association's `targets` specify the entities that this association points to.\n *     Each target is defined by:\n *     -   `key`: The key of the target entity.\n *     -   `namespace` (optional): The key of the namespace where the target entity is defined.\n *         If not specified, it defaults to the current namespace.\n *\n * -   **Cardinality**:\n *     -   `multiple` (boolean): Indicates whether the association allows multiple target entities.\n *         If `true`, it's a to-many relationship; otherwise, it's a to-one relationship.\n *\n * -   **Schema**:\n *     -   `schema` (optional): A custom schema for the association, allowing manual definition of the\n *         association's structure in specific formats (e.g., JSON, RAML, XML).\n *         When provided, this schema overrides the automatically generated schema based on the\n *         target entities.\n *         -   **Important**: If a custom schema is defined and changes are made to the referenced\n *             entities, those changes **will not** be automatically propagated to the custom schema.\n *             This means the custom schema may become outdated and no longer accurately reflect the\n *             structure of the target entities.\n *\n * - **Hidden**:\n *  - `hidden`: (boolean) Defines if this association is a part of the schema or not.\n */\nexport class DataAssociation {\n  kind = DataAssociationKind\n\n  key = ''\n\n  /**\n   * The description of the data association.\n   */\n  info: Thing = Thing.fromName('')\n\n  /**\n   * Wether the data association is required.\n   */\n  required?: boolean\n\n  /**\n   * Whether the data association allows multiple items.\n   */\n  multiple?: boolean\n\n  /**\n   * The list of keys associated with the entity through this association.\n   * An association without a target is considered invalid and discarded when processing the values.\n   * When multiple associations are set then we are dealing with an union.\n   */\n  targets: AssociationTarget[] = []\n\n  /**\n   * The schema allowing to translate the model into a specific format (like JSON, RAML, XML, etc.)\n   *\n   * When this is defined then it is used as the schema. When this is not defined it uses\n   * referenced entities schemas. Note, changes in the referenced entities may not be propagated\n   * to schemas altered by the user.\n   */\n  schema?: IApiAssociationShape\n\n  /**\n   * The list of bindings for this property.\n   *\n   * A binding defines a translation from a data model to a specific format.\n   * For example allows to define properties required to generate AMF shape and therefore RAML/OAS shapes for web APIs\n   * or a protocol buffer schema.\n   */\n  bindings: AssociationBinding[] = []\n\n  /**\n   * Returns true when the association has 0 or 1 targets.\n   */\n  get isSingle(): boolean {\n    return this.targets.length < 2\n  }\n\n  /**\n   * Creates an instance of DataAssociation from a target entity key.\n   * Note, this entity will have no name. The default name is used instead.\n   *\n   * @param root The namespace root.\n   * @param target The target entity key.\n   * @param namespace The optional key of the target association when different to the current one.\n   * @returns A new `DataAssociation` instance.\n   */\n  static fromTarget(root: DataNamespace, target: string, namespace?: string): DataAssociation {\n    const assoc = new DataAssociation(root)\n    const info: AssociationTarget = {\n      key: target,\n    }\n    if (namespace) {\n      info.namespace = namespace\n    }\n    assoc.targets = [info]\n    return assoc\n  }\n\n  /**\n   * Creates an instance of DataAssociation from a name, without defining a target.\n   *\n   * @param root The namespace root.\n   * @param name The name of the association.\n   * @returns A new `DataAssociation` instance.\n   */\n  static fromName(root: DataNamespace, name: string): DataAssociation {\n    const assoc = new DataAssociation(root)\n    assoc.info = Thing.fromName(name)\n    return assoc\n  }\n\n  /**\n   * @param input The data association definition to restore.\n   */\n  constructor(\n    public root: DataNamespace,\n    input?: string | IDataAssociation\n  ) {\n    let init: IDataAssociation\n    if (typeof input === 'string') {\n      try {\n        init = JSON.parse(input)\n      } catch {\n        throw new ValidationError([\n          {\n            field: '',\n            message: 'Unable to parse the data association input as JSON.',\n            rule: 'object_required',\n          },\n        ])\n      }\n    } else if (typeof input === 'object') {\n      init = input\n    } else {\n      init = {\n        kind: DataAssociationKind,\n        key: v4(),\n        info: Thing.fromName('Unnamed association').toJSON(),\n      }\n    }\n    this.new(init)\n  }\n\n  /**\n   * Initializes the association using provided data.\n   *\n   * @param init - The data association definition to restore.\n   */\n  new(init: IDataAssociation): this {\n    DataAssociation.validate(init)\n    const { info, key = v4(), kind = DataAssociationKind, schema, multiple, required, targets, bindings } = init\n    this.kind = kind\n    this.key = key\n    if (info) {\n      this.info = new Thing(info)\n    } else {\n      this.info = Thing.fromName('')\n    }\n    if (schema) {\n      this.schema = Json.clone(schema)\n    } else {\n      this.schema = undefined\n    }\n    if (typeof multiple === 'boolean') {\n      this.multiple = multiple\n    } else {\n      this.multiple = undefined\n    }\n    if (typeof required === 'boolean') {\n      this.required = required\n    } else {\n      this.required = undefined\n    }\n    if (Array.isArray(targets)) {\n      this.targets = targets.map((i) => ({ ...i }))\n    } else {\n      this.targets = []\n    }\n    if (Array.isArray(bindings)) {\n      this.bindings = bindings.map((i) => Json.clone(i))\n    } else {\n      this.bindings = []\n    }\n    return this\n  }\n\n  /**\n   * Validates if the input object is a valid `DataAssociation` definition.\n   * Throws a `ValidationError` if the input is invalid.\n   *\n   * @param input The object to validate.\n   * @throws {ValidationError} When the validation fails.\n   */\n  static validate(input: unknown): void {\n    const typed = input as IDataAssociation\n    const messages: FieldValidationMessage[] = []\n    if (!typed) {\n      messages.push({\n        field: '',\n        message: 'The input is required. None given',\n        rule: 'required',\n      })\n      throw new ValidationError(messages)\n    }\n    if (typed.kind !== DataAssociationKind) {\n      messages.push({\n        field: 'kind',\n        message: `The kind property must be ${DataAssociationKind}`,\n        rule: 'invalid',\n      })\n    }\n    if (typed.info && typeof typed.info !== 'object') {\n      messages.push({\n        field: 'info',\n        message: 'The info property must be an object',\n        rule: 'invalid',\n      })\n    }\n    if (messages.length) {\n      throw new ValidationError(messages)\n    }\n  }\n\n  /**\n   * Generates an object representing the association, suitable for serialization.\n   *\n   * @returns A plain object representation of the `DataAssociation`.\n   */\n  toJSON(): IDataAssociation {\n    const result: IDataAssociation = {\n      kind: DataAssociationKind,\n      key: this.key,\n      info: this.info.toJSON(),\n    }\n    if (this.schema) {\n      result.schema = Json.clone(this.schema)\n    }\n    if (typeof this.multiple === 'boolean') {\n      result.multiple = this.multiple\n    }\n    if (typeof this.required === 'boolean') {\n      result.required = this.required\n    }\n    if (Array.isArray(this.targets) && this.targets.length) {\n      result.targets = this.targets.map((i) => ({ ...i }))\n    }\n    if (Array.isArray(this.bindings) && this.bindings.length) {\n      result.bindings = this.bindings.map((i) => Json.clone(i))\n    }\n    return result\n  }\n\n  /**\n   * Retrieves the list of target entities.\n   *\n   * @returns An array of `DataEntity` instances representing the targets of this association.\n   */\n  getTargets(): DataEntity[] {\n    const { targets } = this\n    return this.root.findAssociatedEntities(targets).filter((i) => !!i) as DataEntity[]\n  }\n\n  /**\n   * Removes self from the parent entity and the namespace definition.\n   */\n  remove(): void {\n    const { root } = this\n    const entity = root.definitions.entities.find((i) => i.associations.some((j) => j === this))\n    if (entity) {\n      const assocIndex = entity.associations.findIndex((i) => i === this)\n      entity.associations.splice(assocIndex, 1)\n    }\n    const defIndex = this.root.definitions.associations.findIndex((i) => i.key === this.key)\n    if (defIndex >= 0) {\n      this.root.definitions.associations.splice(defIndex, 1)\n    }\n  }\n\n  /**\n   * Adds a target entity to the association.\n   * If the entity comes from another namespace then it is set as a foreign entity.\n   *\n   * @param entity - The `DataEntity` instance to add.\n   */\n  addTarget(entity: DataEntity): void\n\n  /**\n   * Adds a target entity to the association.\n   *\n   * @param entity - The `IDataEntity` definition or just its key.\n   * @param namespace - The key of the foreign namespace this entity belongs to.\n   *      Do not set this value for local entities.\n   */\n  addTarget(entity: IDataEntity | string, namespace?: string): void\n\n  /**\n   * @param init The key of an entity, its instance, or schema.\n   * @param namespace - The key of the foreign namespace this entity belongs to.\n   *      Do not set this value for local entities.\n   */\n  addTarget(init: string | DataEntity | IDataEntity, namespace?: string): void {\n    let key: string\n    if (typeof init === 'string') {\n      key = init\n    } else {\n      key = init.key\n      const typed = init as IDataEntity & { root?: DataNamespace }\n      if (!namespace && typed.root && typed.root !== this.root) {\n        namespace = typed.root.key\n      }\n    }\n    if (namespace && namespace !== this.root.key) {\n      const foreignNamespace = this.root.foreign.find((ns) => ns.key === namespace)\n      if (!foreignNamespace) {\n        throw new Error(`Foreign namespace \"${namespace}\" does not exist.`)\n      }\n    }\n    const info: AssociationTarget = {\n      key,\n    }\n    if (namespace) {\n      info.namespace = namespace\n    }\n    this.targets.push(info)\n  }\n\n  /**\n   * Removes a target entity from the targets list.\n   *\n   * @param init The key of an entity, its instance, or schema.\n   */\n  removeTarget(init: string | DataEntity | IDataEntity): void {\n    let key: string\n    if (typeof init === 'string') {\n      key = init\n    } else {\n      key = init.key\n    }\n    const index = this.targets.findIndex((i) => i.key === key)\n    if (index >= 0) {\n      this.targets.splice(index, 1)\n    }\n  }\n\n  /**\n   * Creates a Property Shape of AMF.\n   * The property itself is auto-generated. If the `schema` is defined then it is used\n   * as the `range` of the property. Otherwise basic shape is generated for the range.\n   *\n   * This is a preferred way of reading the AMF shape as this synchronizes changed\n   * data properties with the shape definition.\n   *\n   * @returns AMF property shape definition.\n   */\n  toApiShape(): IApiPropertyShape {\n    const serializer = new AmfShapeGenerator()\n    return serializer.associationProperty(this)\n  }\n\n  /**\n   * Retrieves the parent entity of this association.\n   *\n   * @returns The `DataEntity` instance that contains this association.\n   */\n  getParent(): DataEntity {\n    // this is forced as an association is only created when an entity is created\n    // so it has to be defined.\n    return this.root.definitions.entities.find((i) => i.associations.includes(this)) as DataEntity\n  }\n\n  /**\n   * Creates the `schema` object if missing and returns it.\n   * @returns The schema object.\n   */\n  ensureSchema(): IApiAssociationShape {\n    if (!this.schema) {\n      this.schema = {}\n    }\n    return this.schema\n  }\n\n  /**\n   * Checks whether the passed value is one of the supported data proprty attributes.\n   * @param value The value to test\n   * @returns True when the passed value is one of the supported data proprty attributes.\n   */\n  static isValidAttribute(value: unknown): value is DataAttributeAttribute {\n    if (typeof value !== 'string') {\n      return false\n    }\n    return DataAttributeAttributes.includes(value as DataAttributeAttribute)\n  }\n\n  /**\n   * Creates if not existing and returns web bindings definition.\n   * @returns The web binding definition\n   */\n  getWebBinding(): AssociationWebBindings {\n    let object = this.bindings.find((i) => i.type === 'web') as AssociationBinding | undefined\n    if (!object) {\n      object = { type: 'web', schema: {} } as AssociationBinding\n      this.bindings.push(object)\n    }\n    return object.schema as AssociationWebBindings\n  }\n\n  /**\n   * Returns the schema value of the binding, if any was created.\n   * @param type The type of the binding to read.\n   * @returns The binding schema, if any\n   */\n  readBinding(type: 'web' | 'protobuf'): AssociationBindings | undefined {\n    const item = this.bindings.find((i) => i.type === type) as AssociationBinding\n    return item?.schema\n  }\n}\n"]}

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

@@ -8,6 +8,10 @@ import { DataEntityKind } from '../models/kinds.js';
 import { DataModel } from './DataModel.js';
 import { IApiNodeShape, IShapeUnion } from '../amf/definitions/Shapes.js';
 import { IShapeRenderOptions } from '../amf/shape/ShapeBase.js';
+interface OrderedItem {
+    type: 'property' | 'association';
+    key: string;
+}
 /**
  * Data entity is the smallest description of a data in the system
  * It contains properties and associations. At least one entity describe a data model.
@@ -40,6 +44,13 @@ export interface IDataEntity {
      * The list of keys of associations that belong to this entity.
      */
     associations?: string[];
+    /**
+     * The ordered list of fields (properties and associations) in the schema.
+     * These only keep references to the properties and associations.
+     * The order of the fields is important as it defines the order of the
+     * properties in the schema.
+     */
+    fields?: OrderedItem[];
     /**
      * The list of keys of entities that are parents to this entity.
      *
@@ -48,6 +59,9 @@ export interface IDataEntity {
      * with the same name to shadow parent property. When the property is
      * not shadowed this may cause unexpected results as the processing could result
      * with inconsistent definition of a schema because the last read property wins.
+     *
+     * @todo(jarrodek): This should also hold a reference to a namespace to support
+     * foreign entities as parents.
      */
     parents?: string[];
     /**
@@ -89,6 +103,13 @@ export declare class DataEntity {
      * The list of keys of associations that belong to this entity.
      */
     associations: DataAssociation[];
+    /**
+     * The ordered list of fields (properties and associations) in the schema.
+     * These only keep references to the properties and associations.
+     * The order of the fields is important as it defines the order of the
+     * properties in the schema.
+     */
+    fields: OrderedItem[];
     /**
      * The list of keys of entities that are parents to this entity.
      *
@@ -109,6 +130,7 @@ export declare class DataEntity {
      */
     constructor(root: DataNamespace, input?: string | IDataEntity);
     new(init: IDataEntity): void;
+    private createOrderedFields;
     static validate(input: unknown): void;
     toJSON(): IDataEntity;
     protected _readAssociation(key: string): DataAssociation | undefined;
@@ -130,11 +152,29 @@ export declare class DataEntity {
      * @param key The key of the property to remove.
      */
     removeProperty(key: string): void;
+    private removeField;
     /**
      * Lists all properties for this Entity.
      * @returns The list of properties that belong to this entity.
      */
     listProperties(): DataProperty[];
+    /**
+     * Lists all associations for this Entity.
+     * @returns The list of associations that belong to this entity.
+     */
+    listAssociations(): DataAssociation[];
+    /**
+     * Generates an ordered list of fields (properties and associations) for this entity.
+     *
+     * @returns The list of fields (properties and associations) that belong to this entity.
+     */
+    listFields(): (DataAssociation | DataProperty)[];
+    /**
+     * Moves the field to a new index.
+     * @param key The key of the field to move.
+     * @param toIndex The new index to which move the field to.
+     */
+    moveField(key: string, toIndex: number): void;
     /**
      * Creates an association for a given name, adds it to definitions, and returns it.
      * @param name The name of the association
@@ -186,6 +226,12 @@ export declare class DataEntity {
      * Returns a parent data model where this entity exist.
      */
     getParent(): DataModel | undefined;
+    /**
+     * Adds a parent reference to this entity.
+     * This will not add the parent to the namespace. It only adds a reference to the parent.
+     * @param key The key of the parent entity to add.
+     * @returns `this` for chaining.
+     */
     addParent(key: string): this;
     /**
      * Checks if the entity has a circular parent relationship when attempting to add a new parent.
@@ -215,22 +261,30 @@ export declare class DataEntity {
      */
     associationPath(toEntity: string): Generator<string[]>;
     /**
-     * Returns a list of entities that are associated with this entity through an association
-     * that the target property points to this entity.
+     * Returns a list of entities that are associated with this entity as a target.
+     *
+     * This method identifies entities that have an association where this entity is a target.
+     * In other words, it finds entities that "point to" this entity through an association.
      *
-     * In other words, if entity `A` has association target with `B`, then asking `B` for related entities will
-     * result with `[A]`.
+     * For example, consider the following relationships:
      *
      * ```plain
-     * A -> B -> C
-     * D -> C
+     * A -> B  (A has an association that targets B)
+     * C -> B  (C has an association that targets B)
+     * B -> D  (B has an association that targets D)
      *
-     * C => [B, D]
-     * B => [A, C]
+     * Calling `getRelatedEntities()` on B would return [A, C]
+     * Calling `getRelatedEntities()` on D would return [B]
+     * Calling `getRelatedEntities()` on A would return []
      * ```
+     *
+     * Note, this method only returns entities that are directly associated with this entity as a target.
+     * It does not traverse the association graph to find indirectly related entities.
+     *
+     * @returns An array of `DataEntity` instances that have an association targeting this entity.
      */
     getRelatedEntities(): DataEntity[];
-    static getRelatedEntities(namespace: DataNamespace, entity: string): DataEntity[];
+    static getRelatedEntities(namespace: DataNamespace, entityKey: string): DataEntity[];
     /**
      * Creates breadcrumbs from this entity to the root namespace.
      */
@@ -266,4 +320,5 @@ export declare class DataEntity {
     toExample(mime: string, opts?: IShapeRenderOptions): string | number | boolean | null | undefined;
     hasClosedCycle(rootEntity: string, targetEntity: string): boolean;
 }
+export {};
 //# sourceMappingURL=DataEntity.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"DataEntity.d.ts","sourceRoot":"","sources":["../../../src/modeling/DataEntity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAElD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAGzE,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AAO/D;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,OAAO,cAAc,CAAA;IAC3B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IAEf;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IAEvB;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,CAAA;CACvB;AAED;;;GAGG;AACH,qBAAa,UAAU;IA0DZ,IAAI,EAAE,aAAa;IAzD5B,IAAI,SAAiB;IAErB,GAAG,SAAK;IAER;;OAEG;IACH,IAAI,EAAE,KAAK,CAAqB;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAK;IAEnB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAK;IAEvB;;OAEG;IACH,UAAU,EAAE,YAAY,EAAE,CAAK;IAE/B;;OAEG;IACH,YAAY,EAAE,eAAe,EAAE,CAAK;IAEpC;;;;;;;;OAQG;IACH,OAAO,EAAE,MAAM,EAAE,CAAK;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;IAM9D;;OAEG;gBAEM,IAAI,EAAE,aAAa,EAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW;IAiB9B,GAAG,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI;IA4D5B,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAuBrC,MAAM,IAAI,WAAW;IA2BrB,SAAS,CAAC,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAIpE,SAAS,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAI9D;;;;OAIG;IACH,gBAAgB,CAAC,IAAI,EAAE,gBAAgB,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,YAAY;IAUrE;;;;OAIG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY;IAO5C;;;OAGG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAcjC;;;OAGG;IACH,cAAc,IAAI,YAAY,EAAE;IAWhC;;;;OAIG;IACH,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe;IAOlD;;;;;;;OAOG;IACH,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,eAAe;IAgBjF;;;;;;OAMG;IACH,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,eAAe;IAqBrG;;;OAGG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAepC;;;;OAIG;IACH,kBAAkB,CAAC,SAAS,CAAC,EAAE,OAAO,GAAG,UAAU,EAAE;IAerD;;;OAGG;IACH,mBAAmB,IAAI,UAAU,EAAE;IAKnC;;OAEG;IACH,uBAAuB,IAAI,UAAU,EAAE;IAiBvC;;OAEG;IACH,MAAM,IAAI,IAAI;IAmCd;;OAEG;IACH,SAAS,IAAI,SAAS,GAAG,SAAS;IAIlC,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAgD5B;;;;OAIG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAsBvC;;;;;;OAMG;IACH,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO;IAItE;;;;OAIG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAMrC;;;;;OAKG;IACF,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC;IAOvD;;;;;;;;;;;;;;OAcG;IACH,kBAAkB,IAAI,UAAU,EAAE;IAclC,MAAM,CAAC,kBAAkB,CAAC,SAAS,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,GAAG,UAAU,EAAE;IAYjF;;OAEG;IACH,WAAW,IAAI,cAAc,EAAE;IAgC/B;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAgBzB;;;;OAIG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAY5B;;;;;;;;;OASG;IACH,UAAU,IAAI,WAAW;IAKzB;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,mBAAwB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS;IAWrG,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO;CAyBlE"}
+{"version":3,"file":"DataEntity.d.ts","sourceRoot":"","sources":["../../../src/modeling/DataEntity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAElD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAGzE,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AAO/D,UAAU,WAAW;IACnB,IAAI,EAAE,UAAU,GAAG,aAAa,CAAA;IAChC,GAAG,EAAE,MAAM,CAAA;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,OAAO,cAAc,CAAA;IAC3B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IAEf;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IAEvB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,WAAW,EAAE,CAAA;IAEtB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,CAAA;CACvB;AAED;;;GAGG;AACH,qBAAa,UAAU;IAkEZ,IAAI,EAAE,aAAa;IAjE5B,IAAI,SAAiB;IAErB,GAAG,SAAK;IAER;;OAEG;IACH,IAAI,EAAE,KAAK,CAAqB;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAK;IAEnB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAK;IAEvB;;OAEG;IACH,UAAU,EAAE,YAAY,EAAE,CAAK;IAE/B;;OAEG;IACH,YAAY,EAAE,eAAe,EAAE,CAAK;IAEpC;;;;;OAKG;IACH,MAAM,EAAE,WAAW,EAAE,CAAK;IAE1B;;;;;;;;OAQG;IACH,OAAO,EAAE,MAAM,EAAE,CAAK;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;IAM9D;;OAEG;gBAEM,IAAI,EAAE,aAAa,EAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW;IAiB9B,GAAG,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI;IAkE5B,OAAO,CAAC,mBAAmB;IAiB3B,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAuBrC,MAAM,IAAI,WAAW;IAoCrB,SAAS,CAAC,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAIpE,SAAS,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAI9D;;;;OAIG;IACH,gBAAgB,CAAC,IAAI,EAAE,gBAAgB,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,YAAY;IAWrE;;;;OAIG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY;IAQ5C;;;OAGG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAejC,OAAO,CAAC,WAAW;IAInB;;;OAGG;IACH,cAAc,IAAI,YAAY,EAAE;IAIhC;;;OAGG;IACH,gBAAgB,IAAI,eAAe,EAAE;IAIrC;;;;OAIG;IACH,UAAU,IAAI,CAAC,eAAe,GAAG,YAAY,CAAC,EAAE;IAkBhD;;;;OAIG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAY7C;;;;OAIG;IACH,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe;IAQlD;;;;;;;OAOG;IACH,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,eAAe;IAiBjF;;;;;;OAMG;IACH,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,eAAe;IAsBrG;;;OAGG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAgBpC;;;;OAIG;IACH,kBAAkB,CAAC,SAAS,CAAC,EAAE,OAAO,GAAG,UAAU,EAAE;IAerD;;;OAGG;IACH,mBAAmB,IAAI,UAAU,EAAE;IAKnC;;OAEG;IACH,uBAAuB,IAAI,UAAU,EAAE;IAiBvC;;OAEG;IACH,MAAM,IAAI,IAAI;IAmCd;;OAEG;IACH,SAAS,IAAI,SAAS,GAAG,SAAS;IAIlC;;;;;OAKG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IA8D5B;;;;OAIG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAsBvC;;;;;;OAMG;IACH,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO;IAItE;;;;OAIG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAMrC;;;;;OAKG;IACF,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC;IAOvD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,kBAAkB,IAAI,UAAU,EAAE;IAclC,MAAM,CAAC,kBAAkB,CAAC,SAAS,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,GAAG,UAAU,EAAE;IAYpF;;OAEG;IACH,WAAW,IAAI,cAAc,EAAE;IAgC/B;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAgBzB;;;;OAIG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAY5B;;;;;;;;;OASG;IACH,UAAU,IAAI,WAAW;IAKzB;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,mBAAwB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS;IAWrG,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO;CAyBlE"}

package/build/src/modeling/DataEntity.js

@@ -40,6 +40,13 @@ export class DataEntity {
      * The list of keys of associations that belong to this entity.
      */
     associations = [];
+    /**
+     * The ordered list of fields (properties and associations) in the schema.
+     * These only keep references to the properties and associations.
+     * The order of the fields is important as it defines the order of the
+     * properties in the schema.
+     */
+    fields = [];
     /**
      * The list of keys of entities that are parents to this entity.
      *
@@ -82,7 +89,7 @@ export class DataEntity {
     }
     new(init) {
         DataEntity.validate(init);
-        const { info, key = v4(), kind = DataEntityKind, tags, taxonomy, parents, properties, associations, deprecated, } = init;
+        const { info, key = v4(), kind = DataEntityKind, tags, taxonomy, parents, properties, associations, fields, deprecated, } = init;
         this.kind = kind;
         this.key = key;
         if (info) {
@@ -127,6 +134,12 @@ export class DataEntity {
                 }
             });
         }
+        if (Array.isArray(fields)) {
+            this.fields = [...fields];
+        }
+        else {
+            this.fields = this.createOrderedFields();
+        }
         if (typeof deprecated === 'boolean') {
             this.deprecated = deprecated;
         }
@@ -134,6 +147,22 @@ export class DataEntity {
             this.deprecated = undefined;
         }
     }
+    createOrderedFields() {
+        const result = [];
+        this.properties.forEach((i) => {
+            result.push({
+                type: 'property',
+                key: i.key,
+            });
+        });
+        this.associations.forEach((i) => {
+            result.push({
+                type: 'association',
+                key: i.key,
+            });
+        });
+        return result;
+    }
     static validate(input) {
         const typed = input;
         const messages = [];
@@ -177,6 +206,15 @@ export class DataEntity {
         if (Array.isArray(this.associations) && this.associations.length) {
             result.associations = this.associations.map((i) => i.key);
         }
+        if (Array.isArray(this.fields) && this.fields.length) {
+            result.fields = [...this.fields];
+        }
+        if (Array.isArray(this.taxonomy) && this.taxonomy.length) {
+            result.taxonomy = [...this.taxonomy];
+        }
+        if (Array.isArray(this.tags) && this.tags.length) {
+            result.tags = [...this.tags];
+        }
         if (typeof this.deprecated === 'boolean') {
             result.deprecated = this.deprecated;
         }
@@ -200,6 +238,7 @@ export class DataEntity {
         }
         this.root.definitions.properties.push(property);
         this.properties.push(property);
+        this.fields.push({ type: 'property', key: property.key });
         return property;
     }
     /**
@@ -211,6 +250,7 @@ export class DataEntity {
         const property = DataProperty.fromName(this.root, name);
         this.root.definitions.properties.push(property);
         this.properties.push(property);
+        this.fields.push({ type: 'property', key: property.key });
         return property;
     }
     /**
@@ -228,22 +268,65 @@ export class DataEntity {
         if (defIndex >= 0) {
             this.root.definitions.properties.splice(defIndex, 1);
         }
+        this.removeField(key);
         propertyToRemove.remove();
     }
+    removeField(key) {
+        this.fields = this.fields.filter((item) => item.key !== key);
+    }
     /**
      * Lists all properties for this Entity.
      * @returns The list of properties that belong to this entity.
      */
     listProperties() {
+        return [...this.properties];
+    }
+    /**
+     * Lists all associations for this Entity.
+     * @returns The list of associations that belong to this entity.
+     */
+    listAssociations() {
+        return [...this.associations];
+    }
+    /**
+     * Generates an ordered list of fields (properties and associations) for this entity.
+     *
+     * @returns The list of fields (properties and associations) that belong to this entity.
+     */
+    listFields() {
         const result = [];
-        for (const prop of this.properties) {
-            this.root.definitions.properties.find((p) => p.key === prop.key);
-            if (prop) {
-                result.push(prop);
+        this.fields.forEach((i) => {
+            if (i.type === 'property') {
+                const property = this.properties.find((p) => p.key === i.key);
+                if (property) {
+                    result.push(property);
+                }
             }
-        }
+            else if (i.type === 'association') {
+                const association = this.associations.find((a) => a.key === i.key);
+                if (association) {
+                    result.push(association);
+                }
+            }
+        });
         return result;
     }
+    /**
+     * Moves the field to a new index.
+     * @param key The key of the field to move.
+     * @param toIndex The new index to which move the field to.
+     */
+    moveField(key, toIndex) {
+        const fromIndex = this.fields.findIndex((i) => i.key === key);
+        if (fromIndex < 0) {
+            throw new ValidationError([{ field: 'fields', message: `Field ${key} not found.`, rule: 'not-found' }]);
+        }
+        if (toIndex < 0 || toIndex >= this.fields.length) {
+            throw new ValidationError([{ field: 'fields', message: `Invalid index ${toIndex}.`, rule: 'invalid' }]);
+        }
+        const [item] = this.fields.splice(fromIndex, 1);
+        this.fields.splice(toIndex, 0, item);
+    }
     /**
      * Creates an association for a given name, adds it to definitions, and returns it.
      * @param name The name of the association
@@ -253,6 +336,7 @@ export class DataEntity {
         const result = DataAssociation.fromName(this.root, name);
         this.root.definitions.associations.push(result);
         this.associations.push(result);
+        this.fields.push({ type: 'association', key: result.key });
         return result;
     }
     /**
@@ -277,6 +361,7 @@ export class DataEntity {
         }
         this.root.definitions.associations.push(result);
         this.associations.push(result);
+        this.fields.push({ type: 'association', key: result.key });
         return result;
     }
     /**
@@ -303,6 +388,7 @@ export class DataEntity {
         }
         this.root.definitions.associations.push(result);
         this.associations.push(result);
+        this.fields.push({ type: 'association', key: result.key });
         return result;
     }
     /**
@@ -321,6 +407,7 @@ export class DataEntity {
         if (defIndex >= 0) {
             this.root.definitions.associations.splice(defIndex, 1);
         }
+        this.removeField(key);
         associationToRemove.remove();
     }
     /**
@@ -407,6 +494,12 @@ export class DataEntity {
     getParent() {
         return this.root.definitions.models.find((m) => m.entities.some((e) => e === this));
     }
+    /**
+     * Adds a parent reference to this entity.
+     * This will not add the parent to the namespace. It only adds a reference to the parent.
+     * @param key The key of the parent entity to add.
+     * @returns `this` for chaining.
+     */
     addParent(key) {
         // Prevent adding self as parent
         if (key === this.key) {
@@ -442,6 +535,17 @@ export class DataEntity {
                 },
             ], { message });
         }
+        const has = this.parents.some((i) => i === key);
+        if (has) {
+            const message = `Parent ${key} already exists.`;
+            throw new ValidationError([
+                {
+                    field: 'parents',
+                    message,
+                    rule: 'exists',
+                },
+            ], { message });
+        }
         this.parents.push(key);
         return this;
     }
@@ -504,19 +608,27 @@ export class DataEntity {
         }
     }
     /**
-     * Returns a list of entities that are associated with this entity through an association
-     * that the target property points to this entity.
+     * Returns a list of entities that are associated with this entity as a target.
      *
-     * In other words, if entity `A` has association target with `B`, then asking `B` for related entities will
-     * result with `[A]`.
+     * This method identifies entities that have an association where this entity is a target.
+     * In other words, it finds entities that "point to" this entity through an association.
+     *
+     * For example, consider the following relationships:
      *
      * ```plain
-     * A -> B -> C
-     * D -> C
+     * A -> B  (A has an association that targets B)
+     * C -> B  (C has an association that targets B)
+     * B -> D  (B has an association that targets D)
      *
-     * C => [B, D]
-     * B => [A, C]
+     * Calling `getRelatedEntities()` on B would return [A, C]
+     * Calling `getRelatedEntities()` on D would return [B]
+     * Calling `getRelatedEntities()` on A would return []
      * ```
+     *
+     * Note, this method only returns entities that are directly associated with this entity as a target.
+     * It does not traverse the association graph to find indirectly related entities.
+     *
+     * @returns An array of `DataEntity` instances that have an association targeting this entity.
      */
     getRelatedEntities() {
         const { key, root } = this;
@@ -531,9 +643,9 @@ export class DataEntity {
         });
         return result;
     }
-    static getRelatedEntities(namespace, entity) {
+    static getRelatedEntities(namespace, entityKey) {
         const result = [];
-        const inverse = namespace.definitions.associations.filter((i) => i.targets.some((j) => j.key === entity));
+        const inverse = namespace.definitions.associations.filter((i) => i.targets.some((j) => j.key === entityKey));
         inverse.forEach((assoc) => {
             const entity = namespace.definitions.entities.find((e) => e.associations.includes(assoc));
             if (entity && !result.includes(entity)) {