@api-client/core 0.11.11 → 0.12.1

package/build/src/modeling/DomainModel.js

@@ -0,0 +1,401 @@
+import { __esDecorate, __runInitializers } from "tslib";
+import { DomainEntityKind, DomainModelKind } from '../models/kinds.js';
+import { DomainElement } from './DomainElement.js';
+import { nanoid } from 'nanoid';
+import { Thing } from '../models/Thing.js';
+import { observed, retargetChange } from './observed.js';
+import { DomainEntity } from './DomainEntity.js';
+import { RemoveEntityException } from '../exceptions/remove_entity_exception.js';
+import { removeGraphNode } from './GraphUtils.js';
+import { AttachException } from '../exceptions/attach_exception.js';
+import { DetachException } from '../exceptions/detach_exception.js';
+/**
+ * Represents a data model within a data domain.
+ *
+ * A `DomainModel` groups related `DomainEntity` instances, providing a logical structure for organizing
+ * data. It acts as a container for entities that share a common purpose or context.
+ *
+ * **Key Features:**
+ *
+ * - **Entity Container:** Holds a collection of `DomainEntity` instances.
+ * - **Logical Grouping:** Organizes entities into meaningful groups.
+ * - **Metadata:** Supports a description for the data model.
+ * - **Namespace Integration:**  Belongs to a `DomainNamespace`, creating a hierarchical structure.
+ *
+ * **Usage:**
+ *
+ * The preferred way to create a `DomainModel` is through
+ * the `DomainNamespace.addModel()` or
+ * `DataDomain.addModel()` method.
+ *
+ * **Example:**
+ *
+ * ```typescript
+ * const dataDomain = new DataDomain();
+ * const dataNamespace = dataDomain.addNamespace({
+ *   key: 'myNamespace',
+ * });
+ * const userModel = dataNamespace.addModel({
+ *   key: 'userModel',
+ *   info: { name: 'User Model' },
+ * });
+ * ```
+ */
+let DomainModel = (() => {
+    let _classSuper = DomainElement;
+    let _info_decorators;
+    let _info_initializers = [];
+    let _info_extraInitializers = [];
+    let _deprecated_decorators;
+    let _deprecated_initializers = [];
+    let _deprecated_extraInitializers = [];
+    return class DomainModel extends _classSuper {
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            _info_decorators = [retargetChange()];
+            _deprecated_decorators = [observed()];
+            __esDecorate(this, null, _info_decorators, { kind: "accessor", name: "info", static: false, private: false, access: { has: obj => "info" in obj, get: obj => obj.info, set: (obj, value) => { obj.info = value; } }, metadata: _metadata }, _info_initializers, _info_extraInitializers);
+            __esDecorate(this, null, _deprecated_decorators, { kind: "accessor", name: "deprecated", static: false, private: false, access: { has: obj => "deprecated" in obj, get: obj => obj.deprecated, set: (obj, value) => { obj.deprecated = value; } }, metadata: _metadata }, _deprecated_initializers, _deprecated_extraInitializers);
+            if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        }
+        kind;
+        #info_accessor_storage = __runInitializers(this, _info_initializers, void 0);
+        /**
+         * The description of the domain model.
+         */
+        get info() { return this.#info_accessor_storage; }
+        set info(value) { this.#info_accessor_storage = value; }
+        #fields_accessor_storage = __runInitializers(this, _info_extraInitializers);
+        /**
+         * The ordered list of entities in the schema.
+         */
+        get fields() { return this.#fields_accessor_storage; }
+        set fields(value) { this.#fields_accessor_storage = value; }
+        #deprecated_accessor_storage = __runInitializers(this, _deprecated_initializers, void 0);
+        /**
+         * Whether this model is deprecated.
+         */
+        get deprecated() { return this.#deprecated_accessor_storage; }
+        set deprecated(value) { this.#deprecated_accessor_storage = value; }
+        /**
+         * Creates a full data model schema with defaults.
+         * @param input The partial data model schema.
+         * @returns The data model schema.
+         */
+        static createSchema(input = {}) {
+            const { key = nanoid(), fields, deprecated } = input;
+            const info = Thing.fromJSON(input.info, { name: 'New model' }).toJSON();
+            const result = {
+                kind: DomainModelKind,
+                key,
+                info,
+            };
+            if (Array.isArray(fields)) {
+                result.fields = [...fields];
+            }
+            if (typeof deprecated === 'boolean') {
+                result.deprecated = deprecated;
+            }
+            return result;
+        }
+        /**
+         * Creates a new model instance.
+         *
+         * You should use the `DomainNamespace.addModel()` or
+         * `DataDomain.addModel()` method instead.
+         *
+         * @param root A reference to the root DataDomain instance.
+         * @param input The partial model schema.
+         */
+        constructor(root, input) {
+            const init = DomainModel.createSchema(input);
+            super(root, init.key);
+            __runInitializers(this, _deprecated_extraInitializers);
+            this.kind = DomainModelKind;
+            this.info = new Thing(init.info);
+            if (Array.isArray(init.fields)) {
+                this.fields = [...init.fields];
+            }
+            else {
+                this.fields = [];
+            }
+            if (typeof init.deprecated === 'boolean') {
+                this.deprecated = init.deprecated;
+            }
+            else {
+                this.deprecated = undefined;
+            }
+        }
+        /**
+         * Generates a JSON representation of the data model.
+         *
+         * @returns A plain object representation of the
+         *   `DomainModel`.
+         * @example
+         * ```typescript
+         * const json = userModel.toJSON();
+         * console.log(json);
+         * ```
+         */
+        toJSON() {
+            const result = {
+                kind: this.kind,
+                key: this.key,
+                info: this.info.toJSON(),
+            };
+            if (Array.isArray(this.fields) && this.fields.length) {
+                result.fields = [...this.fields];
+            }
+            if (typeof this.deprecated === 'boolean') {
+                result.deprecated = this.deprecated;
+            }
+            return result;
+        }
+        /**
+         * Returns the parent namespace where this data model
+         * exists.
+         *
+         * @returns The parent `DomainNamespace`.
+         * @throws Error When no parent is found.
+         * @example
+         * ```typescript
+         * const parent = userModel.getParentInstance();
+         * console.log(parent.key);
+         * ```
+         */
+        getParentInstance() {
+            const parentKey = this.root.graph.parent(this.key);
+            if (!parentKey) {
+                return this.root;
+            }
+            return this.root.graph.node(parentKey);
+        }
+        /**
+         * Adds a child entity to the current model.
+         *
+         * @param value The partial entity schema.
+         * @returns The created entity instance.
+         * @example
+         * ```typescript
+         * const entity = model.addEntity({
+         *   key: 'address',
+         *   info: { name: 'Address' },
+         * })
+         * ```
+         */
+        addEntity(input) {
+            if (input && input.key && this.root.graph.hasNode(input.key)) {
+                throw new Error(`Entity with key ${input?.key} already exists`);
+            }
+            const item = new DomainEntity(this.root, input);
+            this.root.graph.setNode(item.key, item);
+            this.root.graph.setParent(item.key, this.key);
+            this.fields.push({
+                key: item.key,
+                type: 'entity',
+            });
+            this.root.notifyChange();
+            return item;
+        }
+        /**
+         * Removes an entity from the current model.
+         *
+         * @param key The key of the model to remove.
+         * @throws {RemoveEntityException} If the model does not exist.
+         * @example
+         * ```typescript
+         * model.removeEntity('address')
+         * ```
+         */
+        removeEntity(key) {
+            if (!this.root.graph.hasNode(key)) {
+                throw new RemoveEntityException(`Trying to remove the ${key} entity, but it doesn't exist`);
+            }
+            const node = this.root.graph.node(key);
+            if (!node || node.kind !== DomainEntityKind) {
+                throw new RemoveEntityException(`Trying to remove the ${key} entity, but it is not an entity`);
+            }
+            if (node.getParentInstance() !== this) {
+                throw new RemoveEntityException(`Trying to remove the ${key} entity, but it is not a child of this model`);
+            }
+            removeGraphNode(this.root.graph, key);
+            this.removeField(key);
+            this.root.notifyChange();
+        }
+        /**
+         * Attaches an entity to the current model. It changes the parent of the entity
+         * to the current model in the graph.
+         *
+         * The attached entity must be already a child of another model. It detaches the entity
+         * from the previous model.
+         *
+         * @param key The key of the entity to attach.
+         * @throws {AttachException} If the entity does not exist.
+         * @throws {AttachException} If passed key doesn't belong to an entity.
+         * @throws {AttachException} When the entity is already a child of the current model.
+         * @throws {AttachException} If the entity is not in the same domain.
+         * @example
+         * ```typescript
+         * model.attachEntity('address')
+         * ```
+         */
+        attachEntity(key) {
+            if (!this.root.graph.hasNode(key)) {
+                throw new AttachException(`Trying to attach the ${key} entity, but it doesn't exist`);
+            }
+            const node = this.root.graph.node(key);
+            if (!node || node.kind !== DomainEntityKind) {
+                throw new AttachException(`Trying to attach the ${key} entity, but it is not a entity`);
+            }
+            if (node.domain.key !== this.root.key) {
+                throw new AttachException(`Trying to attach the ${key} entity, but it is not in the same domain`);
+            }
+            const parent = node.getParentInstance();
+            if (parent === this) {
+                throw new AttachException(`Trying to attach the ${key} entity, but it is already a child of this model`);
+            }
+            parent.detachEntity(key);
+            this.fields.push({
+                type: 'entity',
+                key: key,
+            });
+            this.root.graph.setParent(key, this.key);
+            this.root.notifyChange();
+            return this;
+        }
+        /**
+         * Detaches an entity from the current model. It changes the parent of the entity
+         * to the root graph.
+         * Unlike remove, it doesn't remove the entity from the graph nor notifies the change.
+         * @param key The key of the entity to detach.
+         * @throws {DetachException} If the entity does not exist.
+         * @throws {DetachException} If passed key doesn't belong to an entity.
+         * @throws {DetachException} When the entity is not a child of the current model.
+         */
+        detachEntity(key) {
+            const index = this.fields.findIndex((item) => item.key === key);
+            if (index === -1) {
+                throw new DetachException(`Trying to detach the ${key} entity, but it doesn't exist`);
+            }
+            const node = this.root.graph.node(key);
+            if (!node || node.kind !== DomainEntityKind) {
+                throw new DetachException(`Trying to detach the ${key} entity, but it is not an entity`);
+            }
+            if (node.getParentInstance() !== this) {
+                throw new DetachException(`Trying to detach the ${key} entity, but it is not a child of this model`);
+            }
+            this.fields.splice(index, 1);
+            this.root.graph.setParent(key);
+            return this;
+        }
+        /**
+         * Lists all entities.
+         *
+         * Note, it accounts for the order of the entities as
+         * defined in the `fields` array.
+         *
+         * @returns A generator that yields each `DomainEntity`.
+         * @example
+         * ```typescript
+         * for (const entity of model.listEntities()) {
+         *   console.log(entity.key);
+         * }
+         * ```
+         */
+        *listEntities() {
+            for (const { key, type } of this.fields) {
+                if (type !== 'entity') {
+                    continue;
+                }
+                const node = this.root.graph.node(key);
+                if (!node || node.kind !== DomainEntityKind) {
+                    continue;
+                }
+                yield node;
+            }
+        }
+        /**
+         * Checks if this model has any entities.
+         *
+         * @returns True if the model has entities.
+         * @example
+         * ```typescript
+         * if (model.hasEntities()) {
+         *   // ...
+         * }
+         * ```
+         */
+        hasEntities() {
+            return this.fields.some((item) => item.type === 'entity');
+        }
+        /**
+         * Creates breadcrumbs from this data model to the root namespace.
+         */
+        breadcrumbs() {
+            const result = [];
+            result.push({
+                key: this.key,
+                name: this.info.getLabel('Unnamed model'),
+                kind: DomainModelKind,
+            });
+            let parent = this.getParentInstance();
+            while (parent && parent !== this.root) {
+                result.push({
+                    key: parent.key,
+                    kind: parent.kind,
+                    name: parent.info.getLabel('Unnamed namespace'),
+                });
+                const typed = parent;
+                parent = typed.getParentInstance();
+            }
+            result.push({
+                key: this.root.key,
+                name: this.root.info.getLabel('Unnamed data domain'),
+                kind: this.root.kind,
+            });
+            return result.reverse();
+        }
+        /**
+         * Checks if this model has any fields (entities).
+         *
+         * @returns True if the model has fields.
+         * @example
+         * ```typescript
+         * if (model.hasFields()) {
+         *   // ...
+         * }
+         * ```
+         */
+        hasFields() {
+            return this.fields.length > 0;
+        }
+        removeField(key) {
+            this.fields = this.fields.filter((item) => item.key !== key);
+        }
+        /**
+         * Checks whether the data model is a child of the given namespace.
+         * The relationship doesn't have to be direct, as long as the data model is in the hierarchy it will return true.
+         *
+         * @param key The key of the parent namespace to check.
+         * @returns True if this data model is a child of the given namespace.
+         */
+        isChildOf(key) {
+            if (this.key === key) {
+                return false;
+            }
+            const parent = this.getParentInstance();
+            if (!parent) {
+                return false;
+            }
+            if (parent.key === key) {
+                return true;
+            }
+            if (parent === this.root) {
+                return false;
+            }
+            return parent.isChildOf(key);
+        }
+    };
+})();
+export { DomainModel };
+//# sourceMappingURL=DomainModel.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DomainModel.js","sourceRoot":"","sources":["../../../src/modeling/DomainModel.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,EAAE,aAAa,EAAuB,MAAM,oBAAoB,CAAA;AACvE,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAC/B,OAAO,EAAe,KAAK,EAAE,MAAM,oBAAoB,CAAA;AACvD,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAGxD,OAAO,EAAE,YAAY,EAA2B,MAAM,mBAAmB,CAAA;AACzE,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAA;AAChF,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAA;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAA;AA+BnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;IACU,WAAW;sBAAS,aAAa;;;;;;;iBAAjC,WAAY,SAAQ,WAAa;;;gCAM3C,cAAc,EAAE;sCAShB,QAAQ,EAAE;YATO,iKAAS,IAAI,6BAAJ,IAAI,mFAAO;YAS1B,mLAAS,UAAU,6BAAV,UAAU,+FAAqB;;;QAd3C,IAAI,CAAwB;QAKnB,6EAAoB;QAHtC;;WAEG;QACe,IAAS,IAAI,0CAAO;QAApB,IAAS,IAAI,gDAAO;QAKtC,4EAAmC;QAHnC;;WAEG;QACH,IAAS,MAAM,4CAAoB;QAAnC,IAAS,MAAM,kDAAoB;QAIvB,yFAAwC;QAHpD;;WAEG;QACS,IAAS,UAAU,gDAAqB;QAAxC,IAAS,UAAU,sDAAqB;QAEpD;;;;WAIG;QACH,MAAM,CAAC,YAAY,CAAC,QAAoC,EAAE;YACxD,MAAM,EAAE,GAAG,GAAG,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,CAAA;YACpD,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAA;YACvE,MAAM,MAAM,GAAsB;gBAChC,IAAI,EAAE,eAAe;gBACrB,GAAG;gBACH,IAAI;aACL,CAAA;YACD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC1B,MAAM,CAAC,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,CAAA;YAC7B,CAAC;YACD,IAAI,OAAO,UAAU,KAAK,SAAS,EAAE,CAAC;gBACpC,MAAM,CAAC,UAAU,GAAG,UAAU,CAAA;YAChC,CAAC;YACD,OAAO,MAAM,CAAA;QACf,CAAC;QAED;;;;;;;;WAQG;QACH,YAAY,IAAgB,EAAE,KAAkC;YAC9D,MAAM,IAAI,GAAG,WAAW,CAAC,YAAY,CAAC,KAAK,CAAC,CAAA;YAC5C,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAA;;YACrB,IAAI,CAAC,IAAI,GAAG,eAAe,CAAA;YAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YAChC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC/B,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAA;YAChC,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,MAAM,GAAG,EAAE,CAAA;YAClB,CAAC;YACD,IAAI,OAAO,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;gBACzC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAA;YACnC,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,UAAU,GAAG,SAAS,CAAA;YAC7B,CAAC;SACF;QAED;;;;;;;;;;WAUG;QACH,MAAM;YACJ,MAAM,MAAM,GAAsB;gBAChC,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;aACzB,CAAA;YACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;gBACrD,MAAM,CAAC,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAA;YAClC,CAAC;YACD,IAAI,OAAO,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;gBACzC,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAA;YACrC,CAAC;YACD,OAAO,MAAM,CAAA;QACf,CAAC;QAED;;;;;;;;;;;WAWG;QACH,iBAAiB;YACf,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAClD,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO,IAAI,CAAC,IAAI,CAAA;YAClB,CAAC;YACD,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAoB,CAAA;QAC3D,CAAC;QAED;;;;;;;;;;;;WAYG;QACH,SAAS,CAAC,KAAmC;YAC3C,IAAI,KAAK,IAAI,KAAK,CAAC,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC7D,MAAM,IAAI,KAAK,CAAC,mBAAmB,KAAK,EAAE,GAAG,iBAAiB,CAAC,CAAA;YACjE,CAAC;YACD,MAAM,IAAI,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;YAC/C,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;YACvC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAA;YAC7C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;gBACf,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,IAAI,EAAE,QAAQ;aACf,CAAC,CAAA;YACF,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAA;YACxB,OAAO,IAAI,CAAA;QACb,CAAC;QAED;;;;;;;;;WASG;QACH,YAAY,CAAC,GAAW;YACtB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;gBAClC,MAAM,IAAI,qBAAqB,CAAC,wBAAwB,GAAG,+BAA+B,CAAC,CAAA;YAC7F,CAAC;YACD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YACtC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;gBAC5C,MAAM,IAAI,qBAAqB,CAAC,wBAAwB,GAAG,kCAAkC,CAAC,CAAA;YAChG,CAAC;YACD,IAAI,IAAI,CAAC,iBAAiB,EAAE,KAAK,IAAI,EAAE,CAAC;gBACtC,MAAM,IAAI,qBAAqB,CAAC,wBAAwB,GAAG,8CAA8C,CAAC,CAAA;YAC5G,CAAC;YACD,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;YACrC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;YACrB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAA;QAC1B,CAAC;QAED;;;;;;;;;;;;;;;;WAgBG;QACH,YAAY,CAAC,GAAW;YACtB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;gBAClC,MAAM,IAAI,eAAe,CAAC,wBAAwB,GAAG,+BAA+B,CAAC,CAAA;YACvF,CAAC;YACD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YACtC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;gBAC5C,MAAM,IAAI,eAAe,CAAC,wBAAwB,GAAG,iCAAiC,CAAC,CAAA;YACzF,CAAC;YACD,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,KAAK,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;gBACtC,MAAM,IAAI,eAAe,CAAC,wBAAwB,GAAG,2CAA2C,CAAC,CAAA;YACnG,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,EAAiB,CAAA;YACtD,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;gBACpB,MAAM,IAAI,eAAe,CAAC,wBAAwB,GAAG,kDAAkD,CAAC,CAAA;YAC1G,CAAC;YACD,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;YACxB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;gBACf,IAAI,EAAE,QAAQ;gBACd,GAAG,EAAE,GAAG;aACT,CAAC,CAAA;YACF,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAA;YACxC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAA;YACxB,OAAO,IAAI,CAAA;QACb,CAAC;QAED;;;;;;;;WAQG;QACH,YAAY,CAAC,GAAW;YACtB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,KAAK,GAAG,CAAC,CAAA;YAC/D,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBACjB,MAAM,IAAI,eAAe,CAAC,wBAAwB,GAAG,+BAA+B,CAAC,CAAA;YACvF,CAAC;YACD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YACtC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;gBAC5C,MAAM,IAAI,eAAe,CAAC,wBAAwB,GAAG,kCAAkC,CAAC,CAAA;YAC1F,CAAC;YACD,IAAI,IAAI,CAAC,iBAAiB,EAAE,KAAK,IAAI,EAAE,CAAC;gBACtC,MAAM,IAAI,eAAe,CAAC,wBAAwB,GAAG,8CAA8C,CAAC,CAAA;YACtG,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;YAC5B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;YAC9B,OAAO,IAAI,CAAA;QACb,CAAC;QAED;;;;;;;;;;;;;WAaG;QACH,CAAC,YAAY;YACX,KAAK,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBACxC,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;oBACtB,SAAQ;gBACV,CAAC;gBACD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;gBACtC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;oBAC5C,SAAQ;gBACV,CAAC;gBACD,MAAM,IAAI,CAAA;YACZ,CAAC;QACH,CAAC;QAED;;;;;;;;;;WAUG;QACH,WAAW;YACT,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAA;QAC3D,CAAC;QAED;;WAEG;QACH,WAAW;YACT,MAAM,MAAM,GAAqB,EAAE,CAAA;YACnC,MAAM,CAAC,IAAI,CAAC;gBACV,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC;gBACzC,IAAI,EAAE,eAAe;aACtB,CAAC,CAAA;YACF,IAAI,MAAM,GAAiC,IAAI,CAAC,iBAAiB,EAAE,CAAA;YACnE,OAAO,MAAM,IAAI,MAAM,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;gBACtC,MAAM,CAAC,IAAI,CAAC;oBACV,GAAG,EAAE,MAAM,CAAC,GAAG;oBACf,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC;iBAChD,CAAC,CAAA;gBACF,MAAM,KAAK,GAAG,MAAyB,CAAA;gBACvC,MAAM,GAAG,KAAK,CAAC,iBAAiB,EAAE,CAAA;YACpC,CAAC;YACD,MAAM,CAAC,IAAI,CAAC;gBACV,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG;gBAClB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAAC;gBACpD,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI;aACrB,CAAC,CAAA;YACF,OAAO,MAAM,CAAC,OAAO,EAAE,CAAA;QACzB,CAAC;QAED;;;;;;;;;;WAUG;QACH,SAAS;YACP,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAA;QAC/B,CAAC;QAEO,WAAW,CAAC,GAAW;YAC7B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,KAAK,GAAG,CAAC,CAAA;QAC9D,CAAC;QAED;;;;;;WAMG;QACH,SAAS,CAAC,GAAW;YACnB,IAAI,IAAI,CAAC,GAAG,KAAK,GAAG,EAAE,CAAC;gBACrB,OAAO,KAAK,CAAA;YACd,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAA;YACvC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,KAAK,CAAA;YACd,CAAC;YACD,IAAI,MAAM,CAAC,GAAG,KAAK,GAAG,EAAE,CAAC;gBACvB,OAAO,IAAI,CAAA;YACb,CAAC;YACD,IAAI,MAAM,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;gBACzB,OAAO,KAAK,CAAA;YACd,CAAC;YACD,OAAQ,MAA0B,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;QACnD,CAAC;;;SAxVU,WAAW","sourcesContent":["import type { DataDomain } from './DataDomain.js'\nimport { DomainEntityKind, DomainModelKind } from '../models/kinds.js'\nimport { DomainElement, DomainElementSchema } from './DomainElement.js'\nimport { nanoid } from 'nanoid'\nimport { type IThing, Thing } from '../models/Thing.js'\nimport { observed, retargetChange } from './observed.js'\nimport type { DomainNamespace } from './DomainNamespace.js'\nimport type { FileBreadcrumb } from '../models/store/File.js'\nimport { DomainEntity, type DomainEntitySchema } from './DomainEntity.js'\nimport { RemoveEntityException } from '../exceptions/remove_entity_exception.js'\nimport { removeGraphNode } from './GraphUtils.js'\nimport { AttachException } from '../exceptions/attach_exception.js'\nimport { DetachException } from '../exceptions/detach_exception.js'\n\nexport interface ModelOrderedItem {\n  /**\n   * The type of the ordered item.\n   */\n  type: 'entity'\n\n  /**\n   * The key of the ordered item.\n   */\n  key: string\n}\n\nexport interface DomainModelSchema extends DomainElementSchema {\n  kind: typeof DomainModelKind\n  /**\n   * The data model description.\n   */\n  info: IThing\n  /**\n   * The ordered list of entities in the schema.\n   */\n  fields?: ModelOrderedItem[]\n\n  /**\n   * Whether this model is deprecated.\n   */\n  deprecated?: boolean\n}\n\n/**\n * Represents a data model within a data domain.\n *\n * A `DomainModel` groups related `DomainEntity` instances, providing a logical structure for organizing\n * data. It acts as a container for entities that share a common purpose or context.\n *\n * **Key Features:**\n *\n * - **Entity Container:** Holds a collection of `DomainEntity` instances.\n * - **Logical Grouping:** Organizes entities into meaningful groups.\n * - **Metadata:** Supports a description for the data model.\n * - **Namespace Integration:**  Belongs to a `DomainNamespace`, creating a hierarchical structure.\n *\n * **Usage:**\n *\n * The preferred way to create a `DomainModel` is through\n * the `DomainNamespace.addModel()` or\n * `DataDomain.addModel()` method.\n *\n * **Example:**\n *\n * ```typescript\n * const dataDomain = new DataDomain();\n * const dataNamespace = dataDomain.addNamespace({\n *   key: 'myNamespace',\n * });\n * const userModel = dataNamespace.addModel({\n *   key: 'userModel',\n *   info: { name: 'User Model' },\n * });\n * ```\n */\nexport class DomainModel extends DomainElement {\n  override kind: typeof DomainModelKind\n\n  /**\n   * The description of the domain model.\n   */\n  @retargetChange() accessor info: Thing\n\n  /**\n   * The ordered list of entities in the schema.\n   */\n  accessor fields: ModelOrderedItem[]\n  /**\n   * Whether this model is deprecated.\n   */\n  @observed() accessor deprecated: boolean | undefined\n\n  /**\n   * Creates a full data model schema with defaults.\n   * @param input The partial data model schema.\n   * @returns The data model schema.\n   */\n  static createSchema(input: Partial<DomainModelSchema> = {}): DomainModelSchema {\n    const { key = nanoid(), fields, deprecated } = input\n    const info = Thing.fromJSON(input.info, { name: 'New model' }).toJSON()\n    const result: DomainModelSchema = {\n      kind: DomainModelKind,\n      key,\n      info,\n    }\n    if (Array.isArray(fields)) {\n      result.fields = [...fields]\n    }\n    if (typeof deprecated === 'boolean') {\n      result.deprecated = deprecated\n    }\n    return result\n  }\n\n  /**\n   * Creates a new model instance.\n   *\n   * You should use the `DomainNamespace.addModel()` or\n   * `DataDomain.addModel()` method instead.\n   *\n   * @param root A reference to the root DataDomain instance.\n   * @param input The partial model schema.\n   */\n  constructor(root: DataDomain, input?: Partial<DomainModelSchema>) {\n    const init = DomainModel.createSchema(input)\n    super(root, init.key)\n    this.kind = DomainModelKind\n    this.info = new Thing(init.info)\n    if (Array.isArray(init.fields)) {\n      this.fields = [...init.fields]\n    } else {\n      this.fields = []\n    }\n    if (typeof init.deprecated === 'boolean') {\n      this.deprecated = init.deprecated\n    } else {\n      this.deprecated = undefined\n    }\n  }\n\n  /**\n   * Generates a JSON representation of the data model.\n   *\n   * @returns A plain object representation of the\n   *   `DomainModel`.\n   * @example\n   * ```typescript\n   * const json = userModel.toJSON();\n   * console.log(json);\n   * ```\n   */\n  toJSON(): DomainModelSchema {\n    const result: DomainModelSchema = {\n      kind: this.kind,\n      key: this.key,\n      info: this.info.toJSON(),\n    }\n    if (Array.isArray(this.fields) && this.fields.length) {\n      result.fields = [...this.fields]\n    }\n    if (typeof this.deprecated === 'boolean') {\n      result.deprecated = this.deprecated\n    }\n    return result\n  }\n\n  /**\n   * Returns the parent namespace where this data model\n   * exists.\n   *\n   * @returns The parent `DomainNamespace`.\n   * @throws Error When no parent is found.\n   * @example\n   * ```typescript\n   * const parent = userModel.getParentInstance();\n   * console.log(parent.key);\n   * ```\n   */\n  getParentInstance(): DomainNamespace | DataDomain {\n    const parentKey = this.root.graph.parent(this.key)\n    if (!parentKey) {\n      return this.root\n    }\n    return this.root.graph.node(parentKey) as DomainNamespace\n  }\n\n  /**\n   * Adds a child entity to the current model.\n   *\n   * @param value The partial entity schema.\n   * @returns The created entity instance.\n   * @example\n   * ```typescript\n   * const entity = model.addEntity({\n   *   key: 'address',\n   *   info: { name: 'Address' },\n   * })\n   * ```\n   */\n  addEntity(input?: Partial<DomainEntitySchema>): DomainEntity {\n    if (input && input.key && this.root.graph.hasNode(input.key)) {\n      throw new Error(`Entity with key ${input?.key} already exists`)\n    }\n    const item = new DomainEntity(this.root, input)\n    this.root.graph.setNode(item.key, item)\n    this.root.graph.setParent(item.key, this.key)\n    this.fields.push({\n      key: item.key,\n      type: 'entity',\n    })\n    this.root.notifyChange()\n    return item\n  }\n\n  /**\n   * Removes an entity from the current model.\n   *\n   * @param key The key of the model to remove.\n   * @throws {RemoveEntityException} If the model does not exist.\n   * @example\n   * ```typescript\n   * model.removeEntity('address')\n   * ```\n   */\n  removeEntity(key: string): void {\n    if (!this.root.graph.hasNode(key)) {\n      throw new RemoveEntityException(`Trying to remove the ${key} entity, but it doesn't exist`)\n    }\n    const node = this.root.graph.node(key)\n    if (!node || node.kind !== DomainEntityKind) {\n      throw new RemoveEntityException(`Trying to remove the ${key} entity, but it is not an entity`)\n    }\n    if (node.getParentInstance() !== this) {\n      throw new RemoveEntityException(`Trying to remove the ${key} entity, but it is not a child of this model`)\n    }\n    removeGraphNode(this.root.graph, key)\n    this.removeField(key)\n    this.root.notifyChange()\n  }\n\n  /**\n   * Attaches an entity to the current model. It changes the parent of the entity\n   * to the current model in the graph.\n   *\n   * The attached entity must be already a child of another model. It detaches the entity\n   * from the previous model.\n   *\n   * @param key The key of the entity to attach.\n   * @throws {AttachException} If the entity does not exist.\n   * @throws {AttachException} If passed key doesn't belong to an entity.\n   * @throws {AttachException} When the entity is already a child of the current model.\n   * @throws {AttachException} If the entity is not in the same domain.\n   * @example\n   * ```typescript\n   * model.attachEntity('address')\n   * ```\n   */\n  attachEntity(key: string): this {\n    if (!this.root.graph.hasNode(key)) {\n      throw new AttachException(`Trying to attach the ${key} entity, but it doesn't exist`)\n    }\n    const node = this.root.graph.node(key)\n    if (!node || node.kind !== DomainEntityKind) {\n      throw new AttachException(`Trying to attach the ${key} entity, but it is not a entity`)\n    }\n    if (node.domain.key !== this.root.key) {\n      throw new AttachException(`Trying to attach the ${key} entity, but it is not in the same domain`)\n    }\n    const parent = node.getParentInstance() as DomainModel\n    if (parent === this) {\n      throw new AttachException(`Trying to attach the ${key} entity, but it is already a child of this model`)\n    }\n    parent.detachEntity(key)\n    this.fields.push({\n      type: 'entity',\n      key: key,\n    })\n    this.root.graph.setParent(key, this.key)\n    this.root.notifyChange()\n    return this\n  }\n\n  /**\n   * Detaches an entity from the current model. It changes the parent of the entity\n   * to the root graph.\n   * Unlike remove, it doesn't remove the entity from the graph nor notifies the change.\n   * @param key The key of the entity to detach.\n   * @throws {DetachException} If the entity does not exist.\n   * @throws {DetachException} If passed key doesn't belong to an entity.\n   * @throws {DetachException} When the entity is not a child of the current model.\n   */\n  detachEntity(key: string): this {\n    const index = this.fields.findIndex((item) => item.key === key)\n    if (index === -1) {\n      throw new DetachException(`Trying to detach the ${key} entity, but it doesn't exist`)\n    }\n    const node = this.root.graph.node(key)\n    if (!node || node.kind !== DomainEntityKind) {\n      throw new DetachException(`Trying to detach the ${key} entity, but it is not an entity`)\n    }\n    if (node.getParentInstance() !== this) {\n      throw new DetachException(`Trying to detach the ${key} entity, but it is not a child of this model`)\n    }\n    this.fields.splice(index, 1)\n    this.root.graph.setParent(key)\n    return this\n  }\n\n  /**\n   * Lists all entities.\n   *\n   * Note, it accounts for the order of the entities as\n   * defined in the `fields` array.\n   *\n   * @returns A generator that yields each `DomainEntity`.\n   * @example\n   * ```typescript\n   * for (const entity of model.listEntities()) {\n   *   console.log(entity.key);\n   * }\n   * ```\n   */\n  *listEntities(): Generator<DomainEntity> {\n    for (const { key, type } of this.fields) {\n      if (type !== 'entity') {\n        continue\n      }\n      const node = this.root.graph.node(key)\n      if (!node || node.kind !== DomainEntityKind) {\n        continue\n      }\n      yield node\n    }\n  }\n\n  /**\n   * Checks if this model has any entities.\n   *\n   * @returns True if the model has entities.\n   * @example\n   * ```typescript\n   * if (model.hasEntities()) {\n   *   // ...\n   * }\n   * ```\n   */\n  hasEntities(): boolean {\n    return this.fields.some((item) => item.type === 'entity')\n  }\n\n  /**\n   * Creates breadcrumbs from this data model to the root namespace.\n   */\n  breadcrumbs(): FileBreadcrumb[] {\n    const result: FileBreadcrumb[] = []\n    result.push({\n      key: this.key,\n      name: this.info.getLabel('Unnamed model'),\n      kind: DomainModelKind,\n    })\n    let parent: DomainNamespace | DataDomain = this.getParentInstance()\n    while (parent && parent !== this.root) {\n      result.push({\n        key: parent.key,\n        kind: parent.kind,\n        name: parent.info.getLabel('Unnamed namespace'),\n      })\n      const typed = parent as DomainNamespace\n      parent = typed.getParentInstance()\n    }\n    result.push({\n      key: this.root.key,\n      name: this.root.info.getLabel('Unnamed data domain'),\n      kind: this.root.kind,\n    })\n    return result.reverse()\n  }\n\n  /**\n   * Checks if this model has any fields (entities).\n   *\n   * @returns True if the model has fields.\n   * @example\n   * ```typescript\n   * if (model.hasFields()) {\n   *   // ...\n   * }\n   * ```\n   */\n  hasFields(): boolean {\n    return this.fields.length > 0\n  }\n\n  private removeField(key: string): void {\n    this.fields = this.fields.filter((item) => item.key !== key)\n  }\n\n  /**\n   * Checks whether the data model is a child of the given namespace.\n   * The relationship doesn't have to be direct, as long as the data model is in the hierarchy it will return true.\n   *\n   * @param key The key of the parent namespace to check.\n   * @returns True if this data model is a child of the given namespace.\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    if (parent === this.root) {\n      return false\n    }\n    return (parent as DomainNamespace).isChildOf(key)\n  }\n}\n"]}