@api-client/core 0.6.13 → 0.6.16

package/build/src/models/data/DataAssociation.js

@@ -1,12 +1,24 @@
+import { Core as JsonCore } from '@api-client/json';
+import { AmfShapeGenerator } from '../../amf/AmfShapeGenerator.js';
 import v4 from '../../lib/uuid.js';
 import { Thing } from "../Thing.js";
 export const Kind = 'Core#DataAssociation';
+/**
+ * Describes an association between entities. An association is another property of an entity. The `name` is the name of the
+ * property and the value is the associated target or targets.
+ *
+ * An association can have multiple targets to allow describing the model as `allOf`, `anyOf` and `oneOf` schemas.
+ * When the association has only one target, then generated schema cannot have union types.
+ *
+ * Depending on the schema translation an association can be embedded as a sub-object in the generated schema
+ * or can be references via a primary key.
+ */
 export class DataAssociation {
     root;
     kind = Kind;
     key = '';
     /**
-     * The description of the data namespace.
+     * The description of the data association.
      */
     info = Thing.fromName('');
     /**
@@ -18,22 +30,59 @@ export class DataAssociation {
      */
     multiple;
     /**
-     * The target entity of this association.
+     * Whether the attribute is hidden in the schema (not a part of it).
+     * The hidden attribute should only appear in the adapted attribute.
+     * Has no effect when added to the "main" attribute.
+     */
+    hidden;
+    /**
+     * The list of keys associated with the entity through this association.
      * An association without a target is considered invalid and discarded when processing the values.
      */
-    target;
+    targets = [];
     /**
      * The schema allowing to translate the model into a specific format (like JSON, RAML, XML, etc.)
      *
-     * Implementation note, when an entity is removed this property is not changed. The target can't
-     * be read but it can be tracked to a deleted entity.
+     * When this is defined then it is used as the schema. When this is not defined it uses
+     * referenced entities schemas. Note, changes in the referenced entities may not be propagated
+     * to schemas altered by the user.
+     *
+     * Note, schema can only occur on an adapted property. Has no effect on the "main"
+     * property.
      */
     schema;
+    /**
+     * The key of the association that is adapted by this association.
+     * Adapted associations can manipulate the shape of the schema for the association.
+     *
+     * Each value defined on the adapted association changes the original value defined on
+     * the association.
+     */
+    adapts;
+    /**
+     * Returns true when the association has 0 or 1 targets.
+     */
+    get isSingle() {
+        return this.targets.length < 2;
+    }
+    /**
+     * Creates an instance of DataAssociation from a target entity key.
+     * Note, this entity will have no name. The default name is used instead.
+     *
+     * @param root The namespace root.
+     * @param target The target entity key.
+     */
     static fromTarget(root, target) {
         const assoc = new DataAssociation(root);
-        assoc.target = target;
+        assoc.targets = [target];
         return assoc;
     }
+    /**
+     * Creates an instance of DataAssociation from a name, without defining a target.
+     *
+     * @param root The namespace root.
+     * @param name The name of the association.
+     */
     static fromName(root, name) {
         const assoc = new DataAssociation(root);
         assoc.info = Thing.fromName(name);
@@ -55,7 +104,7 @@ export class DataAssociation {
             init = {
                 kind: Kind,
                 key: v4(),
-                info: Thing.fromName('').toJSON(),
+                info: Thing.fromName('Unnamed association').toJSON(),
             };
         }
         this.new(init);
@@ -64,7 +113,7 @@ export class DataAssociation {
         if (!DataAssociation.isDataAssociation(init)) {
             throw new Error(`Not a data association.`);
         }
-        const { info, key = v4(), kind = Kind, schema, multiple, required, target } = init;
+        const { info, key = v4(), kind = Kind, schema, multiple, required, targets, adapts, hidden, } = init;
         this.kind = kind;
         this.key = key;
         if (info) {
@@ -74,7 +123,7 @@ export class DataAssociation {
             this.info = Thing.fromName('');
         }
         if (schema) {
-            this.schema = { ...schema };
+            this.schema = JsonCore.clone(schema);
         }
         else {
             this.schema = undefined;
@@ -91,11 +140,23 @@ export class DataAssociation {
         else {
             this.required = undefined;
         }
-        if (typeof target === 'string') {
-            this.target = target;
+        if (Array.isArray(targets)) {
+            this.targets = [...targets];
+        }
+        else {
+            this.targets = [];
+        }
+        if (typeof hidden === 'boolean') {
+            this.hidden = hidden;
+        }
+        else {
+            this.hidden = undefined;
+        }
+        if (typeof adapts === 'string') {
+            this.adapts = adapts;
         }
         else {
-            this.target = undefined;
+            this.adapts = undefined;
         }
     }
     static isDataAssociation(input) {
@@ -112,7 +173,7 @@ export class DataAssociation {
             info: this.info.toJSON(),
         };
         if (this.schema) {
-            result.schema = { ...this.schema };
+            result.schema = JsonCore.clone(this.schema);
         }
         if (typeof this.multiple === 'boolean') {
             result.multiple = this.multiple;
@@ -120,17 +181,23 @@ export class DataAssociation {
         if (typeof this.required === 'boolean') {
             result.required = this.required;
         }
-        if (typeof this.target === 'string') {
-            result.target = this.target;
+        if (Array.isArray(this.targets) && this.targets.length) {
+            result.targets = [...this.targets];
+        }
+        if (typeof this.hidden === 'boolean') {
+            result.hidden = this.hidden;
+        }
+        if (this.adapts) {
+            result.adapts = this.adapts;
         }
         return result;
     }
-    getTarget() {
-        const { root, target } = this;
-        if (!target) {
-            return undefined;
-        }
-        return root.definitions.entities.find(i => i.key === target);
+    /**
+     * @returns The list of DataEntity definitions for the current targets.
+     */
+    getTargets() {
+        const { root, targets } = this;
+        return root.definitions.entities.filter(item => targets.some(i => i === item.key));
     }
     /**
      * Removes self from the parent entity and the namespace definition.
@@ -147,5 +214,71 @@ export class DataAssociation {
             this.root.definitions.associations.splice(defIndex, 1);
         }
     }
+    /**
+     * @param init The key of an entity, its instance, or schema.
+     */
+    addTarget(init) {
+        if (typeof init === 'string') {
+            this.targets.push(init);
+        }
+        else {
+            const { key } = init;
+            this.targets.push(key);
+        }
+    }
+    /**
+     * Removes a target entity from the targets list.
+     *
+     * @param init The key of an entity, its instance, or schema.
+     */
+    removeTarget(init) {
+        let key;
+        if (typeof init === 'string') {
+            key = init;
+        }
+        else {
+            key = init.key;
+        }
+        const index = this.targets.indexOf(key);
+        if (index >= 0) {
+            this.targets.splice(index, 1);
+        }
+    }
+    /**
+     * Creates a Property Shape of AMF.
+     * The property itself is auto-generated. If the `schema` is defined then it is used
+     * as the `range` of the property. Otherwise basic shape is generated for the range.
+     *
+     * This is a preferred way of reading the AMF shape as this synchronizes changed
+     * data properties with the shape definition.
+     *
+     * @returns AMF property shape definition.
+     */
+    toApiShape() {
+        const serializer = new AmfShapeGenerator();
+        return serializer.associationProperty(this);
+    }
+    /**
+     * @returns The adapted association, if any
+     */
+    readAdapted() {
+        const { adapts } = this;
+        if (!adapts) {
+            return undefined;
+        }
+        return this.root.definitions.associations.find(i => i.key === adapts);
+    }
+    /**
+     * Creates new adapted association and associates it with this association.
+     * @returns The instance of the created association.
+     */
+    createAdapted() {
+        const association = new DataAssociation(this.root);
+        // disallow defaults as this would influence the schema generation
+        association.info.name = undefined;
+        this.root.definitions.associations.push(association);
+        this.adapts = association.key;
+        return association;
+    }
 }
 //# sourceMappingURL=DataAssociation.js.map

package/build/src/models/data/DataAssociation.js.map

@@ -1 +1 @@
-{"version":3,"file":"DataAssociation.js","sourceRoot":"","sources":["../../../../src/models/data/DataAssociation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACnC,OAAO,EAAU,KAAK,EAAE,MAAM,aAAa,CAAC;AAK5C,MAAM,CAAC,MAAM,IAAI,GAAG,sBAAsB,CAAC;AA+B3C,MAAM,OAAO,eAAe;IAiDJ;IAhDtB,IAAI,GAAG,IAAI,CAAC;IAEZ,GAAG,GAAG,EAAE,CAAC;IAET;;OAEG;IACH,IAAI,GAAU,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAW;IAEnB;;OAEG;IACH,QAAQ,CAAW;IAEnB;;;OAGG;IACH,MAAM,CAAU;IAEhB;;;;;OAKG;IACH,MAAM,CAA0B;IAEhC,MAAM,CAAC,UAAU,CAAC,IAAmB,EAAE,MAAc;QACnD,MAAM,KAAK,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;QACxC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;QACtB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,IAAmB,EAAE,IAAY;QAC/C,MAAM,KAAK,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;QACxC,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAClC,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACH,YAAsB,IAAmB,EAAE,KAAiC;QAAtD,SAAI,GAAJ,IAAI,CAAe;QACvC,IAAI,IAAsB,CAAC;QAC3B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SAC1B;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YACpC,IAAI,GAAG,KAAK,CAAC;SACd;aAAM;YACL,IAAI,GAAG;gBACL,IAAI,EAAE,IAAI;gBACV,GAAG,EAAE,EAAE,EAAE;gBACT,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;aAClC,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED,GAAG,CAAC,IAAsB;QACxB,IAAI,CAAC,eAAe,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE;YAC5C,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;SAC5C;QACD,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,EAAE,EAAE,EAAE,IAAI,GAAG,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACnF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,IAAI,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC;SAC7B;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;SAChC;QACD,IAAI,MAAM,EAAE;YACV,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC;SAC7B;aAAM;YACL,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;SACzB;QACD,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE;YACjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC1B;aAAM;YACL,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;SAC3B;QACD,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE;YACjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC1B;aAAM;YACL,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;SAC3B;QACD,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;YAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;SACtB;aAAM;YACL,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;SACzB;IACH,CAAC;IAED,MAAM,CAAC,iBAAiB,CAAC,KAAc;QACrC,MAAM,KAAK,GAAG,KAAyB,CAAC;QACxC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,EAAE;YACjC,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAqB;YAC/B,IAAI,EAAE,IAAI;YACV,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;SACzB,CAAC;QACF,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,MAAM,CAAC,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;SACpC;QACD,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;YACtC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;SACjC;QACD,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;YACtC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;SACjC;QACD,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,EAAE;YACnC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;SAC7B;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,SAAS;QACP,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAC9B,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QACtB,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;QACzF,IAAI,MAAM,EAAE;YACV,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;YAClE,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;SAC3C;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC;QACvF,IAAI,QAAQ,IAAI,CAAC,EAAE;YACjB,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;SACxD;IACH,CAAC;CACF"}
+{"version":3,"file":"DataAssociation.js","sourceRoot":"","sources":["../../../../src/models/data/DataAssociation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,IAAI,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AAEnE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACnC,OAAO,EAAU,KAAK,EAAE,MAAM,aAAa,CAAC;AAI5C,MAAM,CAAC,MAAM,IAAI,GAAG,sBAAsB,CAAC;AA8D3C;;;;;;;;;GASG;AACH,MAAM,OAAO,eAAe;IAyFP;IAxFnB,IAAI,GAAG,IAAI,CAAC;IAEZ,GAAG,GAAG,EAAE,CAAC;IAET;;OAEG;IACH,IAAI,GAAU,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAW;IAEnB;;OAEG;IACH,QAAQ,CAAW;IAEnB;;;;OAIG;IACH,MAAM,CAAW;IAEjB;;;OAGG;IACH,OAAO,GAAa,EAAE,CAAC;IAEvB;;;;;;;;;OASG;IACH,MAAM,CAAqB;IAE3B;;;;;;OAMG;IACH,MAAM,CAAU;IAEhB;;OAEG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAC,IAAmB,EAAE,MAAc;QACnD,MAAM,KAAK,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;QACxC,KAAK,CAAC,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC;QACzB,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAmB,EAAE,IAAY;QAC/C,MAAM,KAAK,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;QACxC,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAClC,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACH,YAAmB,IAAmB,EAAE,KAAiC;QAAtD,SAAI,GAAJ,IAAI,CAAe;QACpC,IAAI,IAAsB,CAAC;QAC3B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SAC1B;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YACpC,IAAI,GAAG,KAAK,CAAC;SACd;aAAM;YACL,IAAI,GAAG;gBACL,IAAI,EAAE,IAAI;gBACV,GAAG,EAAE,EAAE,EAAE;gBACT,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC,MAAM,EAAE;aACrD,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED,GAAG,CAAC,IAAsB;QACxB,IAAI,CAAC,eAAe,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE;YAC5C,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;SAC5C;QACD,MAAM,EACJ,IAAI,EAAE,GAAG,GAAG,EAAE,EAAE,EAAE,IAAI,GAAG,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAClE,MAAM,EAAE,MAAM,GACf,GAAG,IAAI,CAAC;QACT,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,IAAI,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC;SAC7B;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;SAChC;QACD,IAAI,MAAM,EAAE;YACV,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;SACtC;aAAM;YACL,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;SACzB;QACD,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE;YACjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC1B;aAAM;YACL,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;SAC3B;QACD,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE;YACjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC1B;aAAM;YACL,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;SAC3B;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YAC1B,IAAI,CAAC,OAAO,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC;SAC7B;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;SACnB;QACD,IAAI,OAAO,MAAM,KAAK,SAAS,EAAE;YAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;SACtB;aAAM;YACL,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;SACzB;QACD,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;YAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;SACtB;aAAM;YACL,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;SACzB;IACH,CAAC;IAED,MAAM,CAAC,iBAAiB,CAAC,KAAc;QACrC,MAAM,KAAK,GAAG,KAAyB,CAAC;QACxC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,EAAE;YACjC,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAqB;YAC/B,IAAI,EAAE,IAAI;YACV,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;SACzB,CAAC;QACF,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,MAAM,CAAC,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAC7C;QACD,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;YACtC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;SACjC;QACD,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;YACtC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;SACjC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YACtD,MAAM,CAAC,OAAO,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;SACpC;QACD,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YACpC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;SAC7B;QACD,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;SAC7B;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,UAAU;QACR,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAC/B,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QACtB,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;QACzF,IAAI,MAAM,EAAE;YACV,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;YAClE,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;SAC3C;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC;QACvF,IAAI,QAAQ,IAAI,CAAC,EAAE;YACjB,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;SACxD;IACH,CAAC;IAcD;;OAEG;IACH,SAAS,CAAC,IAAuC;QAC/C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACzB;aAAM;YACL,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;YACrB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACxB;IACH,CAAC;IAgBD;;;;OAIG;IACH,YAAY,CAAC,IAAuC;QAClD,IAAI,GAAW,CAAC;QAChB,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,GAAG,GAAG,IAAI,CAAC;SACZ;aAAM;YACL,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;SAChB;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,KAAK,IAAI,CAAC,EAAE;YACd,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;SAC/B;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU;QACR,MAAM,UAAU,GAAG,IAAI,iBAAiB,EAAE,CAAC;QAC3C,OAAO,UAAU,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACH,WAAW;QACT,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,MAAM,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,MAAM,WAAW,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnD,kEAAkE;QAClE,WAAW,CAAC,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QAClC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC;QAC9B,OAAO,WAAW,CAAC;IACrB,CAAC;CACF"}

package/build/src/models/data/DataAssociationSchema.d.ts

@@ -29,4 +29,40 @@ export interface IDataAssociationSchema {
      * ```
      */
     embedded?: boolean;
+    /**
+     * Describes XML specific serialization.
+     */
+    xml?: {
+        /**
+         * The name of the attribute or a wrapped property to use when serializing the property.
+         *
+         * ```
+         * <Person fullName="John Doe"></Person>
+         * ```
+         */
+        name?: string;
+        /**
+         * When the property is an array (has the `multiple` set to true)
+         * then it tells that the list of values should be wrapped with a parent
+         * element:
+         *
+         * ```
+         * <Person>
+         *  <Person fullName="John Doe"></Person>
+         * </Person>
+         * ```
+         *
+         * Use this with the combination with `name` to describe the name of the wrapped
+         * element
+         *
+         * ```
+         * <people>
+         *  <Person fullName="John Doe"></Person>
+         * </people>
+         * ```
+         *
+         * Note, this is mutually exclusive with `attribute`.
+         */
+        wrapped?: boolean;
+    };
 }

package/build/src/models/data/DataEntity.d.ts

@@ -4,6 +4,7 @@ import { DataProperty, DataPropertyType } from "./DataProperty.js";
 import { DataAssociation } from "./DataAssociation.js";
 import { IBreadcrumb } from "../store/Breadcrumb.js";
 import { DataModel } from "./DataModel.js";
+import { INodeShape, IShapeUnion } from "../../amf/definitions/Shapes.js";
 export declare const Kind = "Core#DataEntity";
 /**
  * Data entity is the smallest description of a data in the system
@@ -47,13 +48,33 @@ export interface IDataEntity {
      * with inconsistent definition of a schema because the last read property wins.
      */
     parents?: string[];
+    /**
+     * Whether this entity is deprecated.
+     */
+    deprecated?: boolean;
+    /**
+     * The schema allowing to translate the model into a specific format (like JSON, RAML, XML, etc.)
+     *
+     * Schema limitations:
+     *
+     * - can only occur on an adapted property. Has no effect on the "main" property.
+     */
+    schema?: INodeShape;
+    /**
+     * The key of the entity that is adapted by this entity.
+     * Adapted entities can manipulate the shape of the schema for the entity.
+     *
+     * Each value defined on the adapted entity changes the original value defined on
+     * the entity.
+     */
+    adapts?: 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.
  */
 export declare class DataEntity {
-    protected root: DataNamespace;
+    root: DataNamespace;
     kind: string;
     key: string;
     /**
@@ -88,6 +109,18 @@ export declare class DataEntity {
      * with inconsistent definition of a schema because the last read property wins.
      */
     parents: string[];
+    /**
+     * Whether this entity is deprecated.
+     */
+    deprecated?: boolean;
+    /**
+     * The key of the entity that is adapted by this entity.
+     * Adapted entities can manipulate the shape of the schema for the entity.
+     *
+     * Each value defined on the adapted entity changes the original value defined on
+     * the entity.
+     */
+    adapts?: string;
     static fromName(root: DataNamespace, name: string): DataEntity;
     /**
      * @param input The data entity definition to restore.
@@ -103,7 +136,7 @@ export declare class DataEntity {
      * @param type The type of the property
      * @returns The created property
      */
-    addTypedProperty(type: DataPropertyType): DataProperty;
+    addTypedProperty(type: DataPropertyType, name?: string): DataProperty;
     /**
      * Creates a property with a passed type.
      * @param name The name of the property.
@@ -126,7 +159,7 @@ export declare class DataEntity {
      * @param target The target entity key of the association
      * @returns The created association
      */
-    addTargetAssociation(target: string): DataAssociation;
+    addTargetAssociation(target: string, name?: string): DataAssociation;
     /**
      * Removes an association from the entity and namespace definitions.
      * @param key The key of the association to remove.
@@ -135,8 +168,9 @@ export declare class DataEntity {
     /**
      * Reads the list of parents for the entity, inside the root namespace. The computed list contains the list of all
      * parents in the inheritance chain in no particular order.
+     * @param recursive Whether to include parent parents as well.
      */
-    getComputedParents(): DataEntity[];
+    getComputedParents(recursive?: boolean): DataEntity[];
     /**
      * Computes list of all children, inside the root namespace, that extends this entity.
      * The children are not ordered.
@@ -192,4 +226,42 @@ export declare class DataEntity {
      * Creates breadcrumbs from this entity to the root namespace.
      */
     breadcrumbs(): IBreadcrumb[];
+    /**
+     * Adds a new tag to the property. It also populates the root namespace's tags when tag is new.
+     *
+     * Note, it does nothing when the tag is already defined.
+     *
+     * @param tag The tag to add.
+     */
+    addTag(tag: string): void;
+    /**
+     * Removes a tag from the property. Unlike the `addTag()` this won't remove a `tag` from the root namespace.
+     *
+     * @param tag The tag to remove.
+     */
+    removeTag(tag: string): void;
+    /**
+     * Creates a Shape of AMF.
+     * The property itself is auto-generated. If the `schema` is defined then it is used
+     * as the `range` of the property. Otherwise basic shape is generated for the range.
+     *
+     * This is a preferred way of reading the AMF shape as this synchronizes changed
+     * data properties with the shape definition.
+     *
+     * @returns AMF property shape definition.
+     */
+    toApiShape(): IShapeUnion;
+    /**
+     * Reads the schema of the Entity and generates an example for it.
+     */
+    toExample(mime: string): string | number | boolean | null | undefined;
+    /**
+     * @returns The adapted entity, if any
+     */
+    readAdapted(): DataEntity | undefined;
+    /**
+     * Creates new adapted entity and associates it with this entity.
+     * @returns The instance of the created entity.
+     */
+    createAdapted(): DataEntity;
 }

package/build/src/models/data/DataEntity.js

@@ -2,6 +2,8 @@ import { Thing } from "../Thing.js";
 import v4 from '../../lib/uuid.js';
 import { DataProperty } from "./DataProperty.js";
 import { DataAssociation } from "./DataAssociation.js";
+import { AmfShapeGenerator } from "../../amf/AmfShapeGenerator.js";
+import { ApiSchemaGenerator } from "../../amf/ApiSchemaGenerator.js";
 export const Kind = 'Core#DataEntity';
 /**
  * Data entity is the smallest description of a data in the system
@@ -43,6 +45,18 @@ export class DataEntity {
      * with inconsistent definition of a schema because the last read property wins.
      */
     parents = [];
+    /**
+     * Whether this entity is deprecated.
+     */
+    deprecated;
+    /**
+     * The key of the entity that is adapted by this entity.
+     * Adapted entities can manipulate the shape of the schema for the entity.
+     *
+     * Each value defined on the adapted entity changes the original value defined on
+     * the entity.
+     */
+    adapts;
     static fromName(root, name) {
         const entity = new DataEntity(root);
         entity.info = Thing.fromName(name);
@@ -73,7 +87,7 @@ export class DataEntity {
         if (!DataEntity.isDataEntity(init)) {
             throw new Error(`Not a data entity.`);
         }
-        const { info, key = v4(), kind = Kind, tags, taxonomy, parents, properties, associations } = init;
+        const { info, key = v4(), kind = Kind, tags, taxonomy, parents, properties, associations, deprecated, adapts, } = init;
         this.kind = kind;
         this.key = key;
         if (info) {
@@ -118,6 +132,18 @@ export class DataEntity {
                 }
             });
         }
+        if (typeof deprecated === 'boolean') {
+            this.deprecated = deprecated;
+        }
+        else {
+            this.deprecated = undefined;
+        }
+        if (typeof adapts === 'string') {
+            this.adapts = adapts;
+        }
+        else {
+            this.adapts = undefined;
+        }
     }
     static isDataEntity(input) {
         const typed = input;
@@ -147,6 +173,12 @@ export class DataEntity {
         if (Array.isArray(this.associations) && this.associations.length) {
             result.associations = this.associations.map(i => i.key);
         }
+        if (typeof this.deprecated === 'boolean') {
+            result.deprecated = this.deprecated;
+        }
+        if (this.adapts) {
+            result.adapts = this.adapts;
+        }
         return result;
     }
     _readAssociation(key) {
@@ -160,8 +192,11 @@ export class DataEntity {
      * @param type The type of the property
      * @returns The created property
      */
-    addTypedProperty(type) {
+    addTypedProperty(type, name) {
         const property = DataProperty.fromType(this.root, type);
+        if (name) {
+            property.info.name = name;
+        }
         this.root.definitions.properties.push(property);
         this.properties.push(property);
         return property;
@@ -208,8 +243,11 @@ export class DataEntity {
      * @param target The target entity key of the association
      * @returns The created association
      */
-    addTargetAssociation(target) {
+    addTargetAssociation(target, name) {
         const result = DataAssociation.fromTarget(this.root, target);
+        if (name) {
+            result.info.name = name;
+        }
         this.root.definitions.associations.push(result);
         this.associations.push(result);
         return result;
@@ -232,15 +270,18 @@ export class DataEntity {
     /**
      * Reads the list of parents for the entity, inside the root namespace. The computed list contains the list of all
      * parents in the inheritance chain in no particular order.
+     * @param recursive Whether to include parent parents as well.
      */
-    getComputedParents() {
+    getComputedParents(recursive) {
         const { entities } = this.root.definitions;
         let result = [];
         this.parents.forEach((key) => {
             const parent = entities.find(i => i.key === key);
             if (parent) {
                 result.push(parent);
-                result = result.concat(parent.getComputedParents());
+                if (recursive) {
+                    result = result.concat(parent.getComputedParents());
+                }
             }
         });
         return result;
@@ -261,10 +302,10 @@ export class DataEntity {
         const { entities } = root.definitions;
         const result = [];
         associations.forEach((assoc) => {
-            if (!assoc.target) {
+            if (!assoc.targets.length) {
                 return;
             }
-            const entity = entities.find(i => i.key === assoc.target);
+            const entity = entities.find(i => assoc.targets.includes(i.key));
             if (entity) {
                 result.push(entity);
             }
@@ -363,7 +404,7 @@ export class DataEntity {
         const graph = {};
         const { associations, entities } = this.root.definitions;
         for (const assoc of associations) {
-            if (!assoc.target) {
+            if (!assoc.targets.length) {
                 continue;
             }
             const srcEntity = entities.find(i => i.associations.some(a => a === assoc));
@@ -373,7 +414,7 @@ export class DataEntity {
             if (!graph[srcEntity.key]) {
                 graph[srcEntity.key] = [];
             }
-            graph[srcEntity.key].push(assoc.target);
+            graph[srcEntity.key].splice(0, 0, ...assoc.targets);
         }
         return graph;
     }
@@ -411,5 +452,91 @@ export class DataEntity {
         });
         return result.reverse();
     }
+    /**
+     * Adds a new tag to the property. It also populates the root namespace's tags when tag is new.
+     *
+     * Note, it does nothing when the tag is already defined.
+     *
+     * @param tag The tag to add.
+     */
+    addTag(tag) {
+        if (!tag) {
+            return;
+        }
+        const lower = tag.toLowerCase();
+        const { tags } = this;
+        if (tags.some(t => t.toLowerCase() === lower)) {
+            return;
+        }
+        tags.push(tag);
+        const { definitions } = this.root;
+        if (!definitions.tags.some(t => t.toLowerCase() === lower)) {
+            definitions.tags.push(tag);
+        }
+    }
+    /**
+     * Removes a tag from the property. Unlike the `addTag()` this won't remove a `tag` from the root namespace.
+     *
+     * @param tag The tag to remove.
+     */
+    removeTag(tag) {
+        if (!tag) {
+            return;
+        }
+        const lower = tag.toLowerCase();
+        const { tags } = this;
+        const index = tags.findIndex(t => t.toLowerCase() === lower);
+        if (index >= 0) {
+            tags.splice(index, 1);
+        }
+    }
+    /**
+     * Creates a Shape of AMF.
+     * The property itself is auto-generated. If the `schema` is defined then it is used
+     * as the `range` of the property. Otherwise basic shape is generated for the range.
+     *
+     * This is a preferred way of reading the AMF shape as this synchronizes changed
+     * data properties with the shape definition.
+     *
+     * @returns AMF property shape definition.
+     */
+    toApiShape() {
+        const serializer = new AmfShapeGenerator();
+        return serializer.entity(this);
+    }
+    /**
+     * Reads the schema of the Entity and generates an example for it.
+     */
+    toExample(mime) {
+        const shape = this.toApiShape();
+        const generator = new ApiSchemaGenerator(mime, {
+            renderExamples: true,
+            renderMocked: true,
+            renderOptional: true,
+        });
+        return generator.generate(shape);
+    }
+    /**
+     * @returns The adapted entity, if any
+     */
+    readAdapted() {
+        const { adapts } = this;
+        if (!adapts) {
+            return undefined;
+        }
+        return this.root.definitions.entities.find(i => i.key === adapts);
+    }
+    /**
+     * Creates new adapted entity and associates it with this entity.
+     * @returns The instance of the created entity.
+     */
+    createAdapted() {
+        const entity = new DataEntity(this.root);
+        // disallow defaults as this would influence the schema generation
+        entity.info.name = undefined;
+        this.root.definitions.entities.push(entity);
+        this.adapts = entity.key;
+        return entity;
+    }
 }
 //# sourceMappingURL=DataEntity.js.map