@api-client/core 0.14.0 → 0.14.1

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

@@ -1,443 +0,0 @@
-import { AmfShapeGenerator } from '../../amf/AmfShapeGenerator.js';
-import { nanoid } from '../../nanoid.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
- * property name in the context of the parent entity, and it connects to a set of `targets`
- * representing the associated entities.
- *
- * An association can have multiple targets to allow describing the model as `allOf`, `anyOf`, or `oneOf`
- * schemas. When the association has only one target, then the 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 it can be referenced via a primary key.
- *
- * ## Key Concepts
- *
- * - **Targets**: An association's `targets` specify the entities that this association points to.
- *     Each target is defined by:
- *     -   `key`: The key of the target entity.
- *     -   `namespace` (optional): The key of the namespace where the target entity is defined.
- *         If not specified, it defaults to the current namespace.
- *
- * -   **Cardinality**:
- *     -   `multiple` (boolean): Indicates whether the association allows multiple target entities.
- *         If `true`, it's a to-many relationship; otherwise, it's a to-one relationship.
- *
- * -   **Schema**:
- *     -   `schema` (optional): A custom schema for the association, allowing manual definition of the
- *         association's structure in specific formats (e.g., JSON, RAML, XML).
- *         When provided, this schema overrides the automatically generated schema based on the
- *         target entities.
- *         -   **Important**: If a custom schema is defined and changes are made to the referenced
- *             entities, those changes **will not** be automatically propagated to the custom schema.
- *             This means the custom schema may become outdated and no longer accurately reflect the
- *             structure of the target entities.
- *
- * - **Hidden**:
- *  - `hidden`: (boolean) Defines if this association is a part of the schema or not.
- * @deprecated
- */
-export class DataAssociation {
-    root;
-    kind = DataAssociationKind;
-    key = '';
-    /**
-     * The description of the data association.
-     */
-    info = Thing.fromName('');
-    /**
-     * Wether the data association is required.
-     */
-    required;
-    /**
-     * Whether the data association allows multiple items.
-     */
-    multiple;
-    /**
-     * 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.
-     * When multiple associations are set then we are dealing with an union.
-     */
-    targets = [];
-    /**
-     * The schema allowing to translate the model into a specific format (like JSON, RAML, XML, etc.)
-     *
-     * 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.
-     */
-    schema;
-    /**
-     * The list of bindings for this property.
-     *
-     * A binding defines a translation from a data model to a specific format.
-     * For example allows to define properties required to generate AMF shape and therefore RAML/OAS shapes for web APIs
-     * or a protocol buffer schema.
-     */
-    bindings = [];
-    /**
-     * 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.
-     * @param namespace The optional key of the target association when different to the current one.
-     * @returns A new `DataAssociation` instance.
-     */
-    static fromTarget(root, target, namespace) {
-        const assoc = new DataAssociation(root);
-        const info = {
-            key: target,
-        };
-        if (namespace) {
-            info.namespace = namespace;
-        }
-        assoc.targets = [info];
-        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.
-     * @returns A new `DataAssociation` instance.
-     */
-    static fromName(root, name) {
-        const assoc = new DataAssociation(root);
-        assoc.info = Thing.fromName(name);
-        return assoc;
-    }
-    /**
-     * @param input The data association definition to restore.
-     */
-    constructor(root, input) {
-        this.root = root;
-        let init;
-        if (typeof input === 'string') {
-            try {
-                init = JSON.parse(input);
-            }
-            catch {
-                throw new ValidationError([
-                    {
-                        field: '',
-                        message: 'Unable to parse the data association input as JSON.',
-                        rule: 'object_required',
-                    },
-                ]);
-            }
-        }
-        else if (typeof input === 'object') {
-            init = input;
-        }
-        else {
-            init = {
-                kind: DataAssociationKind,
-                key: nanoid(),
-                info: Thing.fromName('Unnamed association').toJSON(),
-            };
-        }
-        this.new(init);
-    }
-    /**
-     * Initializes the association using provided data.
-     *
-     * @param init - The data association definition to restore.
-     */
-    new(init) {
-        DataAssociation.validate(init);
-        const { info, key = nanoid(), kind = DataAssociationKind, schema, multiple, required, targets, bindings } = init;
-        this.kind = kind;
-        this.key = key;
-        if (info) {
-            this.info = new Thing(info);
-        }
-        else {
-            this.info = Thing.fromName('');
-        }
-        if (schema) {
-            this.schema = structuredClone(schema);
-        }
-        else {
-            this.schema = undefined;
-        }
-        if (typeof multiple === 'boolean') {
-            this.multiple = multiple;
-        }
-        else {
-            this.multiple = undefined;
-        }
-        if (typeof required === 'boolean') {
-            this.required = required;
-        }
-        else {
-            this.required = undefined;
-        }
-        if (Array.isArray(targets)) {
-            this.targets = targets.map((i) => ({ ...i }));
-        }
-        else {
-            this.targets = [];
-        }
-        if (Array.isArray(bindings)) {
-            this.bindings = bindings.map((i) => structuredClone(i));
-        }
-        else {
-            this.bindings = [];
-        }
-        return this;
-    }
-    /**
-     * Validates if the input object is a valid `DataAssociation` definition.
-     * Throws a `ValidationError` if the input is invalid.
-     *
-     * @param input The object to validate.
-     * @throws {ValidationError} When the validation fails.
-     * @deprecated
-     */
-    static validate(input) {
-        const typed = input;
-        const messages = [];
-        if (!typed) {
-            messages.push({
-                field: '',
-                message: 'The input is required. None given',
-                rule: 'required',
-            });
-            throw new ValidationError(messages);
-        }
-        if (typed.kind !== DataAssociationKind) {
-            messages.push({
-                field: 'kind',
-                message: `The kind property must be ${DataAssociationKind}`,
-                rule: 'invalid',
-            });
-        }
-        if (typed.info && typeof typed.info !== 'object') {
-            messages.push({
-                field: 'info',
-                message: 'The info property must be an object',
-                rule: 'invalid',
-            });
-        }
-        if (messages.length) {
-            throw new ValidationError(messages);
-        }
-    }
-    /**
-     * Generates an object representing the association, suitable for serialization.
-     *
-     * @returns A plain object representation of the `DataAssociation`.
-     */
-    toJSON() {
-        const result = {
-            kind: DataAssociationKind,
-            key: this.key,
-            info: this.info.toJSON(),
-        };
-        if (this.schema) {
-            result.schema = structuredClone(this.schema);
-        }
-        if (typeof this.multiple === 'boolean') {
-            result.multiple = this.multiple;
-        }
-        if (typeof this.required === 'boolean') {
-            result.required = this.required;
-        }
-        if (Array.isArray(this.targets) && this.targets.length) {
-            result.targets = this.targets.map((i) => ({ ...i }));
-        }
-        if (Array.isArray(this.bindings) && this.bindings.length) {
-            result.bindings = this.bindings.map((i) => structuredClone(i));
-        }
-        return result;
-    }
-    /**
-     * Retrieves the list of target entities.
-     *
-     * @returns An array of `DataEntity` instances representing the targets of this association.
-     */
-    getTargets() {
-        const { targets } = this;
-        return this.root.findAssociatedEntities(targets).filter((i) => !!i);
-    }
-    /**
-     * Removes self from the parent entity and the namespace definition.
-     */
-    remove() {
-        const { root } = this;
-        const entity = root.definitions.entities.find((i) => i.associations.some((j) => j.key === this.key));
-        if (entity) {
-            const assocIndex = entity.associations.findIndex((i) => i.key === this.key);
-            entity.associations.splice(assocIndex, 1);
-        }
-        const defIndex = this.root.definitions.associations.findIndex((i) => i.key === this.key);
-        if (defIndex >= 0) {
-            this.root.definitions.associations.splice(defIndex, 1);
-        }
-    }
-    /**
-     * @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;
-        if (typeof init === 'string') {
-            key = init;
-        }
-        else {
-            key = init.key;
-            const typed = init;
-            if (!namespace && typed.root && typed.root !== this.root) {
-                namespace = typed.root.key;
-            }
-        }
-        if (this.targets.some((i) => i.key === key)) {
-            const message = `Target ${key} already exists.`;
-            throw new ValidationError([
-                {
-                    field: 'targets',
-                    message,
-                    rule: 'unique',
-                },
-            ], { message });
-        }
-        if (namespace && namespace !== this.root.key) {
-            const foreignNamespace = this.root.foreign.find((ns) => ns.key === namespace);
-            if (!foreignNamespace) {
-                throw new Error(`Foreign namespace "${namespace}" does not exist.`);
-            }
-        }
-        const info = {
-            key,
-        };
-        if (namespace) {
-            info.namespace = namespace;
-        }
-        this.targets.push(info);
-    }
-    /**
-     * 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.findIndex((i) => i.key === 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);
-    }
-    /**
-     * @deprecated Use the `getParentInstance()` method instead.
-     */
-    getParent() {
-        return this.getParentInstance();
-    }
-    /**
-     * Retrieves the parent entity of this association.
-     *
-     * @returns The `DataEntity` instance that contains this association.
-     */
-    getParentInstance() {
-        // this is forced as an association is only created when an entity is created
-        // so it has to be defined.
-        return this.root.definitions.entities.find((i) => i.associations.some((a) => a.key === this.key));
-    }
-    /**
-     * Creates the `schema` object if missing and returns it.
-     * @returns The schema object.
-     */
-    ensureSchema() {
-        if (!this.schema) {
-            this.schema = {};
-        }
-        return this.schema;
-    }
-    /**
-     * Checks whether the passed value is one of the supported data property attributes.
-     * @param value The value to test
-     * @returns True when the passed value is one of the supported data property attributes.
-     * @deprecated
-     */
-    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
-     */
-    getWebBinding() {
-        let object = this.bindings.find((i) => i.type === 'web');
-        if (!object) {
-            object = { type: 'web', schema: {} };
-            this.bindings.push(object);
-        }
-        return object.schema;
-    }
-    /**
-     * Returns the schema value of the binding, if any was created.
-     * @param type The type of the binding to read.
-     * @returns The binding schema, if any
-     */
-    readBinding(type) {
-        const item = this.bindings.find((i) => i.type === type);
-        return item?.schema;
-    }
-    /**
-     * Checks whether the association is a child of the given namespace, data model, or an entity.
-     * The relationship doesn't have to be direct, as long as the association is in the hierarchy it will return true.
-     *
-     * @param key The key of the parent to check.
-     * @returns True if this data association is a child of the given namespace, data model, or an entity
-     */
-    isChildOf(key) {
-        if (this.key === key) {
-            return false;
-        }
-        const parent = this.getParentInstance();
-        if (!parent) {
-            return false;
-        }
-        if (parent.key === key) {
-            return true;
-        }
-        return parent.isChildOf(key);
-    }
-}
-//# sourceMappingURL=DataAssociation.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"DataAssociation.js","sourceRoot":"","sources":["../../../../src/modeling/legacy/DataAssociation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAElE,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,EAAU,KAAK,EAAE,MAAM,uBAAuB,CAAA;AAGrD,OAAO,EAA+B,eAAe,EAAE,MAAM,sCAAsC,CAAA;AACnG,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAE3D,OAAO,EAAE,uBAAuB,EAA+B,MAAM,kBAAkB,CAAA;AAyEvF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;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,MAAM,EAAE;gBACb,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,MAAM,EAAE,EAAE,IAAI,GAAG,mBAAmB,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAA;QAChH,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,eAAe,CAAC,MAAM,CAAC,CAAA;QACvC,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,eAAe,CAAC,CAAC,CAAC,CAAC,CAAA;QACzD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAA;QACpB,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;OAOG;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,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC9C,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,eAAe,CAAC,CAAC,CAAC,CAAC,CAAA;QAChE,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,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;QACpG,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,CAAC,CAAA;YAC3E,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,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,EAAE,CAAC;YAC5C,MAAM,OAAO,GAAG,UAAU,GAAG,kBAAkB,CAAA;YAC/C,MAAM,IAAI,eAAe,CACvB;gBACE;oBACE,KAAK,EAAE,SAAS;oBAChB,OAAO;oBACP,IAAI,EAAE,QAAQ;iBACf;aACF,EACD,EAAE,OAAO,EAAE,CACZ,CAAA;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;;OAEG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAA;IACjC,CAAC;IAED;;;;OAIG;IACH,iBAAiB;QACf,6EAA6E;QAC7E,2BAA2B;QAC3B,OAAO,IAAI,CAAC,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,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,CAAC,CAAe,CAAA;IACjH,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;;;;;OAKG;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;IAED;;;;;;OAMG;IACH,SAAS,CAAC,GAAW;QACnB,IAAI,IAAI,CAAC,GAAG,KAAK,GAAG,EAAE,CAAC;YACrB,OAAO,KAAK,CAAA;QACd,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACvC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,KAAK,CAAA;QACd,CAAC;QACD,IAAI,MAAM,CAAC,GAAG,KAAK,GAAG,EAAE,CAAC;YACvB,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;IAC9B,CAAC;CACF","sourcesContent":["import { AmfShapeGenerator } from '../../amf/AmfShapeGenerator.js'\nimport { IApiAssociationShape, IApiPropertyShape } from '../../amf/definitions/Shapes.js'\nimport { nanoid } from '../../nanoid.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 * @deprecated\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 * @deprecated\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 * @deprecated\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: nanoid(),\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 = nanoid(), 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 = structuredClone(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) => structuredClone(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   * @deprecated\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 = structuredClone(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) => structuredClone(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.key === this.key))\n    if (entity) {\n      const assocIndex = entity.associations.findIndex((i) => i.key === this.key)\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 (this.targets.some((i) => i.key === key)) {\n      const message = `Target ${key} already exists.`\n      throw new ValidationError(\n        [\n          {\n            field: 'targets',\n            message,\n            rule: 'unique',\n          },\n        ],\n        { message }\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   * @deprecated Use the `getParentInstance()` method instead.\n   */\n  getParent(): DataEntity {\n    return this.getParentInstance()\n  }\n\n  /**\n   * Retrieves the parent entity of this association.\n   *\n   * @returns The `DataEntity` instance that contains this association.\n   */\n  getParentInstance(): 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.some((a) => a.key === this.key)) 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 property attributes.\n   * @param value The value to test\n   * @returns True when the passed value is one of the supported data property attributes.\n   * @deprecated\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  /**\n   * Checks whether the association is a child of the given namespace, data model, or an entity.\n   * The relationship doesn't have to be direct, as long as the association is in the hierarchy it will return true.\n   *\n   * @param key The key of the parent to check.\n   * @returns True if this data association is a child of the given namespace, data model, or an entity\n   */\n  isChildOf(key: string): boolean {\n    if (this.key === key) {\n      return false\n    }\n    const parent = this.getParentInstance()\n    if (!parent) {\n      return false\n    }\n    if (parent.key === key) {\n      return true\n    }\n    return parent.isChildOf(key)\n  }\n}\n"]}