@api-client/core 0.11.7 → 0.11.9

package/build/src/modeling/DomainImpactAnalysis.js

@@ -0,0 +1,437 @@
+import { DataNamespaceKind, DataEntityKind, DataModelKind, DataPropertyKind, DataAssociationKind, } from '../models/kinds.js';
+/**
+ * # DomainImpactAnalysis
+ *
+ * The `DomainImpactAnalysis` class is a powerful tool for analyzing the consequences of deleting data domain objects
+ * within a `DataNamespace`.
+ * It helps developers understand the ripple effects of removing a namespace, data model, entity, property,
+ * or association, ensuring data integrity and preventing unintended side effects.
+ *
+ * ## Core Concepts
+ *
+ * -   **Impact Report:** The central output of the `DomainImpactAnalysis` class is an `DomainImpactReport`.
+ *     This report details the potential consequences of a deletion operation, including:
+ *     -   The object being deleted (`key`, `kind`).
+ *     -   A list of `ImpactItem` objects, each describing a specific consequence.
+ *     -   Whether the deletion can proceed safely (`canProceed`).
+ *
+ * -   **ImpactItem:** Each `ImpactItem` describes a specific consequence of the deletion. Key properties include:
+ *     -   `key`: The key of the impacted object.
+ *     -   `kind`: The kind of the impacted object.
+ *     -   `type`: The type of impact (currently only `delete`).
+ *     -   `impact`: A human-readable description of the impact.
+ *     -   `blocking`: Whether this impact prevents the deletion from proceeding.
+ *     -   `relationship`: The type of relationship between the deleted object and the impacted object (e.g., `child`).
+ *     -   `resolution`: A description of how the impact will be resolved if the deletion is forced.
+ *
+ * -   **Blocking Impacts:** Some impacts are considered "blocking," meaning they prevent the deletion from proceeding
+ *     without manual intervention. For example, deleting an entity that is a parent to other entities is
+ *     a blocking impact.
+ *
+ * -   **Non-Blocking Impacts:** Some impacts are informational and do not prevent the deletion. For example, deleting a
+ *     property is not a blocking impact.
+ *
+ * ## Usage
+ *
+ * 1.  **Instantiation:** Create an instance of `DomainImpactAnalysis`, passing the root `DataNamespace` as an argument.
+ *
+ *     ```typescript
+ *     import { DataNamespace } from './DataNamespace';
+ *     import { DomainImpactAnalysis } from './DomainImpactAnalysis';
+ *
+ *     const rootNamespace = new DataNamespace();
+ *     // ... add some data to the namespace
+ *     const analyzer = new DomainImpactAnalysis(rootNamespace);
+ *     ```
+ *
+ * 2.  **Performing Analysis:** Use the `deleteAnalysis()` method to generate an `ImpactReport` for a specific deletion.
+ *     Provide the `key` and `kind` of the object to be deleted.
+ *
+ *     ```typescript
+ *     import { DataEntityKind } from '../models/kinds.js';
+ *     // ...
+ *     const entityKey = 'some-entity-key';
+ *     const report = analyzer.deleteAnalysis(entityKey, DataEntityKind);
+ *     ```
+ *
+ * 3.  **Interpreting the Report:** Examine the `ImpactReport` to understand the consequences of the deletion.
+ *     -   Check `report.canProceed` to see if the deletion is safe.
+ *     -   Iterate through `report.impact` to understand each consequence.
+ *     -   Pay special attention to `impact.blocking` to identify impacts that require manual resolution.
+ *
+ *     ```typescript
+ *     if (report.canProceed) {
+ *       // Proceed with deletion
+ *     } else {
+ *       console.warn('Deletion cannot proceed due to the following impacts:');
+ *       report.impact.forEach((item) => {
+ *         console.warn(`- ${item.impact}`);
+ *         if (item.blocking) {
+ *           console.warn(`  - This impact is blocking.`);
+ *           if (item.resolution) {
+ *             console.warn(`  - Resolution: ${item.resolution}`);
+ *           }
+ *         }
+ *       });
+ *       // Handle blocking impacts (e.g., prompt the user, modify the data, etc.)
+ *     }
+ *     ```
+ *
+ * ## Supported Deletion Scenarios
+ *
+ * The `DomainImpactAnalysis` class supports analyzing the deletion of the following data domain object types:
+ *
+ * -   **Namespaces (`DataNamespaceKind`):** Deleting a namespace also impacts all its child namespaces,
+ *     data models, entities, properties, and associations.
+ * -   **Data Models (`DataModelKind`):** Deleting a data model impacts all its entities, properties, and associations.
+ * -   **Entities (`DataEntityKind`):** Deleting an entity impacts its properties, associations, and any other
+ *     entities that have it as a parent or target in an association.
+ * -   **Properties (`DataPropertyKind`):** Deleting a property impacts the entity it belongs to.
+ * -   **Associations (`DataAssociationKind`):** Deleting an association impacts the entity it belongs to.
+ *
+ * ## Example: Deleting an Entity
+ *
+ * Consider the following scenario:
+ *
+ * -   Namespace: `MyNamespace`
+ *     -   Data Model: `ProductModel`
+ *         -   Entity: `Product`
+ *             -   Property: `name`
+ *             -   Association: `category` (targets `Category` entity)
+ *         -   Entity: `Category`
+ *             - Property: `name`
+ *         - Entity: `SpecialProduct` (parent: `Product`)
+ *
+ * If you attempt to delete the `Product` entity, the `DomainImpactAnalysis` will generate a report similar to this:
+ *
+ * ```json
+ * {
+ *   "key": "Product",
+ *   "kind": "DataEntityKind",
+ *   "impact": [
+ *     {
+ *       "key": "Product",
+ *       "kind": "DataEntityKind",
+ *       "type": "delete",
+ *       "impact": "The entity with key Product will be deleted.",
+ *       "blocking": false
+ *     },
+ *     {
+ *       "key": "SpecialProduct",
+ *       "kind": "DataEntityKind",
+ *       "type": "delete",
+ *       "impact": "The SpecialProduct entity will become an orphan because it is a child of Product.",
+ *       "resolution": "The Product will be removed as the parent parent of SpecialProduct.",
+ *       "blocking": true,
+ *       "relationship": "child"
+ *     },
+ *     {
+ *       "key": "category",
+ *       "kind": "DataAssociationKind",
+ *       "type": "delete",
+ *       "impact": "The association with key category will be broken because it has a target to Product.",
+ *       "resolution": "The association with key category will be removed from Product.",
+ *       "blocking": true
+ *     },
+ *     {
+ *       "key": "name",
+ *       "kind": "DataPropertyKind",
+ *       "type": "delete",
+ *       "impact": "The property with key name will be deleted.",
+ *       "blocking": false
+ *     }
+ *   ],
+ *   "canProceed": false
+ * }
+ * ```
+ *
+ * This report indicates that:
+ *
+ * -   The `Product` entity will be deleted.
+ * -   The `SpecialProduct` entity will become an orphan (blocking).
+ * -   The `category` association will be broken (blocking).
+ * -   The `name` property will be deleted.
+ * -   The deletion cannot proceed without addressing the blocking impacts.
+ *
+ * ## Types
+ *
+ * ### `ImpactKinds`
+ *
+ * -   **Description:** A type alias for the kinds of data domain objects that can be analyzed.
+ * -   **Values:**
+ *     -   `DataNamespaceKind`
+ *     -   `DataEntityKind`
+ *     -   `DataModelKind`
+ *     -   `DataPropertyKind`
+ *     -   `DataAssociationKind`
+ *
+ * ### `ImpactReport`
+ *
+ * -   **Description:** The structure of the impact analysis report.
+ * -   **Properties:**
+ *     -   `key` (`string`): The key of the object being deleted.
+ *     -   `kind` (`ImpactKinds`): The kind of the object being deleted.
+ *     -   `impact` (`ImpactItem[]`): The list of impacts.
+ *     -   `canProceed` (`boolean`): Whether the deletion can proceed.
+ *
+ * ### `ImpactItem`
+ *
+ * -   **Description:** The structure of an individual impact item.
+ * -   **Properties:**
+ *     -   `key` (`string`): The key of the impacted object.
+ *     -   `kind` (`string`): The kind of the impacted object.
+ *     -   `type` (`'delete'`): The type of impact.
+ *     -   `impact` (`string`): The impact description.
+ *     -   `blocking` (`boolean`): Whether the impact is blocking.
+ *     -   `relationship` (`'child'`, optional): The relationship type.
+ *     -   `resolution` (`string`, optional): The resolution description.
+ *
+ * ## Error Handling
+ *
+ * The `DomainImpactAnalysis` class does not throw errors. Instead, it uses the `ImpactReport` to communicate
+ * the results of the analysis, including any blocking impacts.
+ *
+ * ## Best Practices
+ *
+ * - **Always Analyze Before Deleting:** Before deleting any data domain object, always use `DomainImpactAnalysis`
+ *   to understand the consequences.
+ * - **Handle Blocking Impacts:** Pay close attention to `blocking` impacts and implement appropriate
+ *   logic to handle them.
+ * - **Inform the User:** If a deletion cannot proceed, inform the user about the blocking impacts and provide
+ *   guidance on how to resolve them.
+ * - **Consider Forced Deletion:** In some cases, you may want to allow users to force a deletion even if there are
+ *   blocking impacts. In such cases, you should clearly communicate the risks to the user.
+ *
+ * ## Conclusion
+ *
+ * The `DomainImpactAnalysis` class is an essential tool for maintaining data integrity when working with complex
+ * data domain models. By providing detailed impact reports, it empowers developers to make informed decisions
+ * about data deletion and prevent unintended consequences.
+ */
+export class DomainImpactAnalysis {
+    report;
+    root;
+    constructor(root) {
+        this.root = root;
+        this.report = {
+            key: '',
+            kind: DataNamespaceKind,
+            impact: [],
+            canProceed: false,
+        };
+    }
+    /**
+     * Generates a report of how the data domain will be impacted by the deletion of a data domain object.
+     * @param key The key of the impacted data domain object.
+     * @param kind The kind of the impacted data object.
+     * @returns The delete impact analysis report.
+     */
+    deleteAnalysis(key, kind) {
+        this.report = {
+            key,
+            kind,
+            impact: [],
+            canProceed: true,
+        };
+        this.report.impact = this.createDeleteImpact(key, kind, key);
+        // this.report.impact.unshift({
+        //   key,
+        //   kind,
+        //   type: 'delete',
+        //   impact: `The ${this.kindToLabel(kind)} with key ${key} will be deleted.`,
+        //   blocking: false,
+        // })
+        return this.report;
+    }
+    createDeleteImpact(key, kind, rootKey) {
+        switch (kind) {
+            case DataNamespaceKind:
+                return this.deleteNamespaceAnalysis(key, rootKey);
+            case DataModelKind:
+                return this.deleteDataModelAnalysis(key, rootKey);
+            case DataEntityKind:
+                return this.deleteEntityAnalysis(key, rootKey);
+            case DataPropertyKind:
+                return this.deletePropertyAnalysis(key);
+            case DataAssociationKind:
+                return this.deleteAssociationAnalysis(key);
+            default:
+                return [];
+        }
+    }
+    deleteNamespaceAnalysis(key, rootKey) {
+        const result = [];
+        const ns = this.root.findNamespace(key);
+        if (!ns) {
+            return result;
+        }
+        result.push({
+            key: ns.key,
+            kind: ns.kind,
+            type: 'delete',
+            impact: `The ${ns.info.renderLabel} ${this.kindToLabel(DataNamespaceKind)} will be deleted.`,
+            blocking: false,
+        });
+        const namespaces = ns.listNamespaces();
+        namespaces.forEach((child) => {
+            const items = this.deleteNamespaceAnalysis(child.key, rootKey);
+            result.push(...items);
+        });
+        const models = ns.listDataModels();
+        models.forEach((child) => {
+            const items = this.deleteDataModelAnalysis(child.key, rootKey);
+            result.push(...items);
+        });
+        return result;
+    }
+    deleteDataModelAnalysis(key, rootKey) {
+        const result = [];
+        const model = this.root.findDataModel(key);
+        if (!model) {
+            return result;
+        }
+        result.push({
+            key: model.key,
+            kind: model.kind,
+            type: 'delete',
+            impact: `The ${model.info.renderLabel} ${this.kindToLabel(DataModelKind)} will be deleted.`,
+            blocking: false,
+        });
+        model.entities.forEach((child) => {
+            const items = this.deleteEntityAnalysis(child.key, rootKey);
+            result.push(...items);
+        });
+        return result;
+    }
+    deleteEntityAnalysis(key, rootKey) {
+        const result = [];
+        const entity = this.root.findEntity(key);
+        if (!entity) {
+            return result;
+        }
+        result.push({
+            key: entity.key,
+            kind: entity.kind,
+            type: 'delete',
+            impact: `The ${entity.info.renderLabel} ${this.kindToLabel(DataEntityKind)} will be deleted.`,
+            blocking: false,
+        });
+        // We need to know whether the entity is a parent of another entity
+        const children = this.root.definitions.entities.filter((domainEntity) => {
+            if (domainEntity.key === entity.key) {
+                // ignore self
+                return false;
+            }
+            if (!domainEntity.parents.includes(entity.key)) {
+                // no relationship
+                return false;
+            }
+            if (domainEntity.isChildOf(rootKey)) {
+                // No need to include this parent as it itself is being deleted
+                return false;
+            }
+            // the entity has a parent-child relationship to the deleted entity.
+            return true;
+        });
+        if (children.length) {
+            children.forEach((child) => {
+                result.push({
+                    key: child.key,
+                    kind: child.kind,
+                    type: 'delete',
+                    impact: `The ${child.info.renderLabel} ${this.kindToLabel(DataEntityKind)} will become an orphan because it is a child of ${entity.info.renderLabel}.`,
+                    resolution: `The ${entity.info.renderLabel} will be removed as the parent parent of ${child.info.renderLabel}.`,
+                    blocking: true,
+                    relationship: 'child',
+                });
+            });
+            this.report.canProceed = false;
+        }
+        // We need to know whether there's another entity that has an association to this entity.
+        const inAssociations = this.root.definitions.associations.filter((association) => {
+            return association.targets.some((item) => {
+                if (item.key === entity.key) {
+                    const related = association.getParentInstance();
+                    if (!related) {
+                        return false;
+                    }
+                    if (related.isChildOf(rootKey)) {
+                        // No need to include this association as the related entity itself is being deleted
+                        return false;
+                    }
+                    return true;
+                }
+                return false;
+            });
+        });
+        if (inAssociations.length) {
+            inAssociations.forEach((association) => {
+                result.push({
+                    key: association.key,
+                    kind: association.kind,
+                    type: 'delete',
+                    impact: `The ${association.info.renderLabel} ${this.kindToLabel(DataAssociationKind)} will be broken because it has a target to ${entity.info.renderLabel}.`,
+                    resolution: `The ${association.info.renderLabel} ${this.kindToLabel(DataAssociationKind)} will be removed from ${entity.info.renderLabel}.`,
+                    blocking: true,
+                });
+            });
+            this.report.canProceed = false;
+        }
+        entity.properties.forEach((child) => {
+            const items = this.deletePropertyAnalysis(child.key);
+            result.push(...items);
+        });
+        entity.associations.forEach((child) => {
+            const items = this.deleteAssociationAnalysis(child.key);
+            result.push(...items);
+        });
+        return result;
+    }
+    deletePropertyAnalysis(key) {
+        const result = [];
+        const property = this.root.findProperty(key);
+        if (!property) {
+            return result;
+        }
+        result.push({
+            key: property.key,
+            kind: property.kind,
+            type: 'delete',
+            impact: `The ${property.info.renderLabel} ${this.kindToLabel(DataPropertyKind)} will be deleted.`,
+            blocking: false,
+        });
+        return result;
+    }
+    deleteAssociationAnalysis(key) {
+        const result = [];
+        const association = this.root.findAssociation(key);
+        if (!association) {
+            return result;
+        }
+        result.push({
+            key: association.key,
+            kind: association.kind,
+            type: 'delete',
+            impact: `The ${association.info.renderLabel} ${this.kindToLabel(DataAssociationKind)} will be deleted.`,
+            blocking: false,
+        });
+        return result;
+    }
+    kindToLabel(kind) {
+        switch (kind) {
+            case DataNamespaceKind:
+                return 'namespace';
+            case DataEntityKind:
+                return 'entity';
+            case DataModelKind:
+                return 'data model';
+            case DataPropertyKind:
+                return 'property';
+            case DataAssociationKind:
+                return 'association';
+            default:
+                return 'unknown';
+        }
+    }
+}
+//# sourceMappingURL=DomainImpactAnalysis.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DomainImpactAnalysis.js","sourceRoot":"","sources":["../../../src/modeling/DomainImpactAnalysis.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,oBAAoB,CAAA;AAqE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgNG;AACH,MAAM,OAAO,oBAAoB;IACvB,MAAM,CAAoB;IAC1B,IAAI,CAAe;IAE3B,YAAY,IAAmB;QAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,MAAM,GAAG;YACZ,GAAG,EAAE,EAAE;YACP,IAAI,EAAE,iBAAiB;YACvB,MAAM,EAAE,EAAE;YACV,UAAU,EAAE,KAAK;SAClB,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,GAAW,EAAE,IAAuB;QACjD,IAAI,CAAC,MAAM,GAAG;YACZ,GAAG;YACH,IAAI;YACJ,MAAM,EAAE,EAAE;YACV,UAAU,EAAE,IAAI;SACjB,CAAA;QACD,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;QAC5D,+BAA+B;QAC/B,SAAS;QACT,UAAU;QACV,oBAAoB;QACpB,8EAA8E;QAC9E,qBAAqB;QACrB,KAAK;QACL,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAES,kBAAkB,CAAC,GAAW,EAAE,IAAuB,EAAE,OAAe;QAChF,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,iBAAiB;gBACpB,OAAO,IAAI,CAAC,uBAAuB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;YACnD,KAAK,aAAa;gBAChB,OAAO,IAAI,CAAC,uBAAuB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;YACnD,KAAK,cAAc;gBACjB,OAAO,IAAI,CAAC,oBAAoB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;YAChD,KAAK,gBAAgB;gBACnB,OAAO,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAA;YACzC,KAAK,mBAAmB;gBACtB,OAAO,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAA;YAC5C;gBACE,OAAO,EAAE,CAAA;QACb,CAAC;IACH,CAAC;IAES,uBAAuB,CAAC,GAAW,EAAE,OAAe;QAC5D,MAAM,MAAM,GAAuB,EAAE,CAAA;QACrC,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAA;QACvC,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,OAAO,MAAM,CAAA;QACf,CAAC;QACD,MAAM,CAAC,IAAI,CAAC;YACV,GAAG,EAAE,EAAE,CAAC,GAAG;YACX,IAAI,EAAE,EAAE,CAAC,IAAI;YACb,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,mBAAmB;YAC5F,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAA;QACF,MAAM,UAAU,GAAG,EAAE,CAAC,cAAc,EAAE,CAAA;QACtC,UAAU,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;YAC9D,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAA;QACvB,CAAC,CAAC,CAAA;QACF,MAAM,MAAM,GAAG,EAAE,CAAC,cAAc,EAAE,CAAA;QAClC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACvB,MAAM,KAAK,GAAG,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;YAC9D,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAA;QACvB,CAAC,CAAC,CAAA;QACF,OAAO,MAAM,CAAA;IACf,CAAC;IAES,uBAAuB,CAAC,GAAW,EAAE,OAAe;QAC5D,MAAM,MAAM,GAAuB,EAAE,CAAA;QACrC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAA;QAC1C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,MAAM,CAAA;QACf,CAAC;QACD,MAAM,CAAC,IAAI,CAAC;YACV,GAAG,EAAE,KAAK,CAAC,GAAG;YACd,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,OAAO,KAAK,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,mBAAmB;YAC3F,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAA;QACF,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;YAC3D,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAA;QACvB,CAAC,CAAC,CAAA;QACF,OAAO,MAAM,CAAA;IACf,CAAC;IAES,oBAAoB,CAAC,GAAW,EAAE,OAAe;QACzD,MAAM,MAAM,GAAuB,EAAE,CAAA;QACrC,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;QACxC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,MAAM,CAAA;QACf,CAAC;QACD,MAAM,CAAC,IAAI,CAAC;YACV,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,OAAO,MAAM,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,mBAAmB;YAC7F,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAA;QACF,mEAAmE;QACnE,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,EAAE;YACtE,IAAI,YAAY,CAAC,GAAG,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC;gBACpC,cAAc;gBACd,OAAO,KAAK,CAAA;YACd,CAAC;YACD,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC/C,kBAAkB;gBAClB,OAAO,KAAK,CAAA;YACd,CAAC;YACD,IAAI,YAAY,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;gBACpC,+DAA+D;gBAC/D,OAAO,KAAK,CAAA;YACd,CAAC;YACD,oEAAoE;YACpE,OAAO,IAAI,CAAA;QACb,CAAC,CAAC,CAAA;QACF,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;YACpB,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBACzB,MAAM,CAAC,IAAI,CAAC;oBACV,GAAG,EAAE,KAAK,CAAC,GAAG;oBACd,IAAI,EAAE,KAAK,CAAC,IAAI;oBAChB,IAAI,EAAE,QAAQ;oBACd,MAAM,EAAE,OAAO,KAAK,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,mDAAmD,MAAM,CAAC,IAAI,CAAC,WAAW,GAAG;oBACtJ,UAAU,EAAE,OAAO,MAAM,CAAC,IAAI,CAAC,WAAW,4CAA4C,KAAK,CAAC,IAAI,CAAC,WAAW,GAAG;oBAC/G,QAAQ,EAAE,IAAI;oBACd,YAAY,EAAE,OAAO;iBACtB,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;YACF,IAAI,CAAC,MAAM,CAAC,UAAU,GAAG,KAAK,CAAA;QAChC,CAAC;QACD,yFAAyF;QACzF,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE;YAC/E,OAAO,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;gBACvC,IAAI,IAAI,CAAC,GAAG,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC;oBAC5B,MAAM,OAAO,GAAG,WAAW,CAAC,iBAAiB,EAAE,CAAA;oBAC/C,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,OAAO,KAAK,CAAA;oBACd,CAAC;oBACD,IAAI,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;wBAC/B,oFAAoF;wBACpF,OAAO,KAAK,CAAA;oBACd,CAAC;oBACD,OAAO,IAAI,CAAA;gBACb,CAAC;gBACD,OAAO,KAAK,CAAA;YACd,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QACF,IAAI,cAAc,CAAC,MAAM,EAAE,CAAC;YAC1B,cAAc,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;gBACrC,MAAM,CAAC,IAAI,CAAC;oBACV,GAAG,EAAE,WAAW,CAAC,GAAG;oBACpB,IAAI,EAAE,WAAW,CAAC,IAAI;oBACtB,IAAI,EAAE,QAAQ;oBACd,MAAM,EAAE,OAAO,WAAW,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,8CAA8C,MAAM,CAAC,IAAI,CAAC,WAAW,GAAG;oBAC5J,UAAU,EAAE,OAAO,WAAW,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,yBAAyB,MAAM,CAAC,IAAI,CAAC,WAAW,GAAG;oBAC3I,QAAQ,EAAE,IAAI;iBACf,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;YACF,IAAI,CAAC,MAAM,CAAC,UAAU,GAAG,KAAK,CAAA;QAChC,CAAC;QACD,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAClC,MAAM,KAAK,GAAG,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YACpD,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAA;QACvB,CAAC,CAAC,CAAA;QACF,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACpC,MAAM,KAAK,GAAG,IAAI,CAAC,yBAAyB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YACvD,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAA;QACvB,CAAC,CAAC,CAAA;QACF,OAAO,MAAM,CAAA;IACf,CAAC;IAES,sBAAsB,CAAC,GAAW;QAC1C,MAAM,MAAM,GAAuB,EAAE,CAAA;QACrC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;QAC5C,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,MAAM,CAAA;QACf,CAAC;QACD,MAAM,CAAC,IAAI,CAAC;YACV,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,OAAO,QAAQ,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,mBAAmB;YACjG,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAA;QACF,OAAO,MAAM,CAAA;IACf,CAAC;IAES,yBAAyB,CAAC,GAAW;QAC7C,MAAM,MAAM,GAAuB,EAAE,CAAA;QACrC,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAA;QAClD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO,MAAM,CAAA;QACf,CAAC;QACD,MAAM,CAAC,IAAI,CAAC;YACV,GAAG,EAAE,WAAW,CAAC,GAAG;YACpB,IAAI,EAAE,WAAW,CAAC,IAAI;YACtB,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,OAAO,WAAW,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,mBAAmB;YACvG,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAA;QACF,OAAO,MAAM,CAAA;IACf,CAAC;IAES,WAAW,CAAC,IAAuB;QAC3C,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,iBAAiB;gBACpB,OAAO,WAAW,CAAA;YACpB,KAAK,cAAc;gBACjB,OAAO,QAAQ,CAAA;YACjB,KAAK,aAAa;gBAChB,OAAO,YAAY,CAAA;YACrB,KAAK,gBAAgB;gBACnB,OAAO,UAAU,CAAA;YACnB,KAAK,mBAAmB;gBACtB,OAAO,aAAa,CAAA;YACtB;gBACE,OAAO,SAAS,CAAA;QACpB,CAAC;IACH,CAAC;CACF","sourcesContent":["import {\n  DataNamespaceKind,\n  DataEntityKind,\n  DataModelKind,\n  DataPropertyKind,\n  DataAssociationKind,\n} from '../models/kinds.js'\nimport type { DataNamespace } from './DataNamespace.js'\n\nexport type DomainImpactKinds =\n  | typeof DataNamespaceKind\n  | typeof DataEntityKind\n  | typeof DataModelKind\n  | typeof DataPropertyKind\n  | typeof DataAssociationKind\n\n/**\n * The impact analysis report\n */\nexport interface DomainImpactReport {\n  /**\n   * The key of the impacted data object.\n   * This is the key of the object that is being changed.\n   */\n  key: string\n  /**\n   * The kind of the impacted data object.\n   * This is the kind of the object that is being changed.\n   */\n  kind: DomainImpactKinds\n  /**\n   * The list of impacted data objects.\n   */\n  impact: DomainImpactItem[]\n  /**\n   * Whether it is possible to proceed with the change.\n   * If the change is not possible, the reason will be in the impact list.\n   */\n  canProceed: boolean\n}\n\nexport interface DomainImpactItem {\n  /**\n   * The key of the impacted data object.\n   */\n  key: string\n  /**\n   * The kind of the impacted data object.\n   */\n  kind: string\n  /**\n   * The type of the impact.\n   *\n   * - `delete` - The data object would be deleted.\n   */\n  type: 'delete'\n  /**\n   * The impact description.\n   */\n  impact: string\n  /**\n   * Whether the impact is blocking the operation.\n   * If true, the operation cannot proceed.\n   */\n  blocking: boolean\n  /**\n   * The type of the relationship between two impacted objects.\n   */\n  relationship?: 'child'\n  /**\n   * The resolution of the conflict if the change will be forced.\n   */\n  resolution?: string\n}\n\n/**\n * # DomainImpactAnalysis\n *\n * The `DomainImpactAnalysis` class is a powerful tool for analyzing the consequences of deleting data domain objects\n * within a `DataNamespace`.\n * It helps developers understand the ripple effects of removing a namespace, data model, entity, property,\n * or association, ensuring data integrity and preventing unintended side effects.\n *\n * ## Core Concepts\n *\n * -   **Impact Report:** The central output of the `DomainImpactAnalysis` class is an `DomainImpactReport`.\n *     This report details the potential consequences of a deletion operation, including:\n *     -   The object being deleted (`key`, `kind`).\n *     -   A list of `ImpactItem` objects, each describing a specific consequence.\n *     -   Whether the deletion can proceed safely (`canProceed`).\n *\n * -   **ImpactItem:** Each `ImpactItem` describes a specific consequence of the deletion. Key properties include:\n *     -   `key`: The key of the impacted object.\n *     -   `kind`: The kind of the impacted object.\n *     -   `type`: The type of impact (currently only `delete`).\n *     -   `impact`: A human-readable description of the impact.\n *     -   `blocking`: Whether this impact prevents the deletion from proceeding.\n *     -   `relationship`: The type of relationship between the deleted object and the impacted object (e.g., `child`).\n *     -   `resolution`: A description of how the impact will be resolved if the deletion is forced.\n *\n * -   **Blocking Impacts:** Some impacts are considered \"blocking,\" meaning they prevent the deletion from proceeding\n *     without manual intervention. For example, deleting an entity that is a parent to other entities is\n *     a blocking impact.\n *\n * -   **Non-Blocking Impacts:** Some impacts are informational and do not prevent the deletion. For example, deleting a\n *     property is not a blocking impact.\n *\n * ## Usage\n *\n * 1.  **Instantiation:** Create an instance of `DomainImpactAnalysis`, passing the root `DataNamespace` as an argument.\n *\n *     ```typescript\n *     import { DataNamespace } from './DataNamespace';\n *     import { DomainImpactAnalysis } from './DomainImpactAnalysis';\n *\n *     const rootNamespace = new DataNamespace();\n *     // ... add some data to the namespace\n *     const analyzer = new DomainImpactAnalysis(rootNamespace);\n *     ```\n *\n * 2.  **Performing Analysis:** Use the `deleteAnalysis()` method to generate an `ImpactReport` for a specific deletion.\n *     Provide the `key` and `kind` of the object to be deleted.\n *\n *     ```typescript\n *     import { DataEntityKind } from '../models/kinds.js';\n *     // ...\n *     const entityKey = 'some-entity-key';\n *     const report = analyzer.deleteAnalysis(entityKey, DataEntityKind);\n *     ```\n *\n * 3.  **Interpreting the Report:** Examine the `ImpactReport` to understand the consequences of the deletion.\n *     -   Check `report.canProceed` to see if the deletion is safe.\n *     -   Iterate through `report.impact` to understand each consequence.\n *     -   Pay special attention to `impact.blocking` to identify impacts that require manual resolution.\n *\n *     ```typescript\n *     if (report.canProceed) {\n *       // Proceed with deletion\n *     } else {\n *       console.warn('Deletion cannot proceed due to the following impacts:');\n *       report.impact.forEach((item) => {\n *         console.warn(`- ${item.impact}`);\n *         if (item.blocking) {\n *           console.warn(`  - This impact is blocking.`);\n *           if (item.resolution) {\n *             console.warn(`  - Resolution: ${item.resolution}`);\n *           }\n *         }\n *       });\n *       // Handle blocking impacts (e.g., prompt the user, modify the data, etc.)\n *     }\n *     ```\n *\n * ## Supported Deletion Scenarios\n *\n * The `DomainImpactAnalysis` class supports analyzing the deletion of the following data domain object types:\n *\n * -   **Namespaces (`DataNamespaceKind`):** Deleting a namespace also impacts all its child namespaces,\n *     data models, entities, properties, and associations.\n * -   **Data Models (`DataModelKind`):** Deleting a data model impacts all its entities, properties, and associations.\n * -   **Entities (`DataEntityKind`):** Deleting an entity impacts its properties, associations, and any other\n *     entities that have it as a parent or target in an association.\n * -   **Properties (`DataPropertyKind`):** Deleting a property impacts the entity it belongs to.\n * -   **Associations (`DataAssociationKind`):** Deleting an association impacts the entity it belongs to.\n *\n * ## Example: Deleting an Entity\n *\n * Consider the following scenario:\n *\n * -   Namespace: `MyNamespace`\n *     -   Data Model: `ProductModel`\n *         -   Entity: `Product`\n *             -   Property: `name`\n *             -   Association: `category` (targets `Category` entity)\n *         -   Entity: `Category`\n *             - Property: `name`\n *         - Entity: `SpecialProduct` (parent: `Product`)\n *\n * If you attempt to delete the `Product` entity, the `DomainImpactAnalysis` will generate a report similar to this:\n *\n * ```json\n * {\n *   \"key\": \"Product\",\n *   \"kind\": \"DataEntityKind\",\n *   \"impact\": [\n *     {\n *       \"key\": \"Product\",\n *       \"kind\": \"DataEntityKind\",\n *       \"type\": \"delete\",\n *       \"impact\": \"The entity with key Product will be deleted.\",\n *       \"blocking\": false\n *     },\n *     {\n *       \"key\": \"SpecialProduct\",\n *       \"kind\": \"DataEntityKind\",\n *       \"type\": \"delete\",\n *       \"impact\": \"The SpecialProduct entity will become an orphan because it is a child of Product.\",\n *       \"resolution\": \"The Product will be removed as the parent parent of SpecialProduct.\",\n *       \"blocking\": true,\n *       \"relationship\": \"child\"\n *     },\n *     {\n *       \"key\": \"category\",\n *       \"kind\": \"DataAssociationKind\",\n *       \"type\": \"delete\",\n *       \"impact\": \"The association with key category will be broken because it has a target to Product.\",\n *       \"resolution\": \"The association with key category will be removed from Product.\",\n *       \"blocking\": true\n *     },\n *     {\n *       \"key\": \"name\",\n *       \"kind\": \"DataPropertyKind\",\n *       \"type\": \"delete\",\n *       \"impact\": \"The property with key name will be deleted.\",\n *       \"blocking\": false\n *     }\n *   ],\n *   \"canProceed\": false\n * }\n * ```\n *\n * This report indicates that:\n *\n * -   The `Product` entity will be deleted.\n * -   The `SpecialProduct` entity will become an orphan (blocking).\n * -   The `category` association will be broken (blocking).\n * -   The `name` property will be deleted.\n * -   The deletion cannot proceed without addressing the blocking impacts.\n *\n * ## Types\n *\n * ### `ImpactKinds`\n *\n * -   **Description:** A type alias for the kinds of data domain objects that can be analyzed.\n * -   **Values:**\n *     -   `DataNamespaceKind`\n *     -   `DataEntityKind`\n *     -   `DataModelKind`\n *     -   `DataPropertyKind`\n *     -   `DataAssociationKind`\n *\n * ### `ImpactReport`\n *\n * -   **Description:** The structure of the impact analysis report.\n * -   **Properties:**\n *     -   `key` (`string`): The key of the object being deleted.\n *     -   `kind` (`ImpactKinds`): The kind of the object being deleted.\n *     -   `impact` (`ImpactItem[]`): The list of impacts.\n *     -   `canProceed` (`boolean`): Whether the deletion can proceed.\n *\n * ### `ImpactItem`\n *\n * -   **Description:** The structure of an individual impact item.\n * -   **Properties:**\n *     -   `key` (`string`): The key of the impacted object.\n *     -   `kind` (`string`): The kind of the impacted object.\n *     -   `type` (`'delete'`): The type of impact.\n *     -   `impact` (`string`): The impact description.\n *     -   `blocking` (`boolean`): Whether the impact is blocking.\n *     -   `relationship` (`'child'`, optional): The relationship type.\n *     -   `resolution` (`string`, optional): The resolution description.\n *\n * ## Error Handling\n *\n * The `DomainImpactAnalysis` class does not throw errors. Instead, it uses the `ImpactReport` to communicate\n * the results of the analysis, including any blocking impacts.\n *\n * ## Best Practices\n *\n * - **Always Analyze Before Deleting:** Before deleting any data domain object, always use `DomainImpactAnalysis`\n *   to understand the consequences.\n * - **Handle Blocking Impacts:** Pay close attention to `blocking` impacts and implement appropriate\n *   logic to handle them.\n * - **Inform the User:** If a deletion cannot proceed, inform the user about the blocking impacts and provide\n *   guidance on how to resolve them.\n * - **Consider Forced Deletion:** In some cases, you may want to allow users to force a deletion even if there are\n *   blocking impacts. In such cases, you should clearly communicate the risks to the user.\n *\n * ## Conclusion\n *\n * The `DomainImpactAnalysis` class is an essential tool for maintaining data integrity when working with complex\n * data domain models. By providing detailed impact reports, it empowers developers to make informed decisions\n * about data deletion and prevent unintended consequences.\n */\nexport class DomainImpactAnalysis {\n  private report: DomainImpactReport\n  private root: DataNamespace\n\n  constructor(root: DataNamespace) {\n    this.root = root\n    this.report = {\n      key: '',\n      kind: DataNamespaceKind,\n      impact: [],\n      canProceed: false,\n    }\n  }\n\n  /**\n   * Generates a report of how the data domain will be impacted by the deletion of a data domain object.\n   * @param key The key of the impacted data domain object.\n   * @param kind The kind of the impacted data object.\n   * @returns The delete impact analysis report.\n   */\n  deleteAnalysis(key: string, kind: DomainImpactKinds): DomainImpactReport {\n    this.report = {\n      key,\n      kind,\n      impact: [],\n      canProceed: true,\n    }\n    this.report.impact = this.createDeleteImpact(key, kind, key)\n    // this.report.impact.unshift({\n    //   key,\n    //   kind,\n    //   type: 'delete',\n    //   impact: `The ${this.kindToLabel(kind)} with key ${key} will be deleted.`,\n    //   blocking: false,\n    // })\n    return this.report\n  }\n\n  protected createDeleteImpact(key: string, kind: DomainImpactKinds, rootKey: string): DomainImpactItem[] {\n    switch (kind) {\n      case DataNamespaceKind:\n        return this.deleteNamespaceAnalysis(key, rootKey)\n      case DataModelKind:\n        return this.deleteDataModelAnalysis(key, rootKey)\n      case DataEntityKind:\n        return this.deleteEntityAnalysis(key, rootKey)\n      case DataPropertyKind:\n        return this.deletePropertyAnalysis(key)\n      case DataAssociationKind:\n        return this.deleteAssociationAnalysis(key)\n      default:\n        return []\n    }\n  }\n\n  protected deleteNamespaceAnalysis(key: string, rootKey: string): DomainImpactItem[] {\n    const result: DomainImpactItem[] = []\n    const ns = this.root.findNamespace(key)\n    if (!ns) {\n      return result\n    }\n    result.push({\n      key: ns.key,\n      kind: ns.kind,\n      type: 'delete',\n      impact: `The ${ns.info.renderLabel} ${this.kindToLabel(DataNamespaceKind)} will be deleted.`,\n      blocking: false,\n    })\n    const namespaces = ns.listNamespaces()\n    namespaces.forEach((child) => {\n      const items = this.deleteNamespaceAnalysis(child.key, rootKey)\n      result.push(...items)\n    })\n    const models = ns.listDataModels()\n    models.forEach((child) => {\n      const items = this.deleteDataModelAnalysis(child.key, rootKey)\n      result.push(...items)\n    })\n    return result\n  }\n\n  protected deleteDataModelAnalysis(key: string, rootKey: string): DomainImpactItem[] {\n    const result: DomainImpactItem[] = []\n    const model = this.root.findDataModel(key)\n    if (!model) {\n      return result\n    }\n    result.push({\n      key: model.key,\n      kind: model.kind,\n      type: 'delete',\n      impact: `The ${model.info.renderLabel} ${this.kindToLabel(DataModelKind)} will be deleted.`,\n      blocking: false,\n    })\n    model.entities.forEach((child) => {\n      const items = this.deleteEntityAnalysis(child.key, rootKey)\n      result.push(...items)\n    })\n    return result\n  }\n\n  protected deleteEntityAnalysis(key: string, rootKey: string): DomainImpactItem[] {\n    const result: DomainImpactItem[] = []\n    const entity = this.root.findEntity(key)\n    if (!entity) {\n      return result\n    }\n    result.push({\n      key: entity.key,\n      kind: entity.kind,\n      type: 'delete',\n      impact: `The ${entity.info.renderLabel} ${this.kindToLabel(DataEntityKind)} will be deleted.`,\n      blocking: false,\n    })\n    // We need to know whether the entity is a parent of another entity\n    const children = this.root.definitions.entities.filter((domainEntity) => {\n      if (domainEntity.key === entity.key) {\n        // ignore self\n        return false\n      }\n      if (!domainEntity.parents.includes(entity.key)) {\n        // no relationship\n        return false\n      }\n      if (domainEntity.isChildOf(rootKey)) {\n        // No need to include this parent as it itself is being deleted\n        return false\n      }\n      // the entity has a parent-child relationship to the deleted entity.\n      return true\n    })\n    if (children.length) {\n      children.forEach((child) => {\n        result.push({\n          key: child.key,\n          kind: child.kind,\n          type: 'delete',\n          impact: `The ${child.info.renderLabel} ${this.kindToLabel(DataEntityKind)} will become an orphan because it is a child of ${entity.info.renderLabel}.`,\n          resolution: `The ${entity.info.renderLabel} will be removed as the parent parent of ${child.info.renderLabel}.`,\n          blocking: true,\n          relationship: 'child',\n        })\n      })\n      this.report.canProceed = false\n    }\n    // We need to know whether there's another entity that has an association to this entity.\n    const inAssociations = this.root.definitions.associations.filter((association) => {\n      return association.targets.some((item) => {\n        if (item.key === entity.key) {\n          const related = association.getParentInstance()\n          if (!related) {\n            return false\n          }\n          if (related.isChildOf(rootKey)) {\n            // No need to include this association as the related entity itself is being deleted\n            return false\n          }\n          return true\n        }\n        return false\n      })\n    })\n    if (inAssociations.length) {\n      inAssociations.forEach((association) => {\n        result.push({\n          key: association.key,\n          kind: association.kind,\n          type: 'delete',\n          impact: `The ${association.info.renderLabel} ${this.kindToLabel(DataAssociationKind)} will be broken because it has a target to ${entity.info.renderLabel}.`,\n          resolution: `The ${association.info.renderLabel} ${this.kindToLabel(DataAssociationKind)} will be removed from ${entity.info.renderLabel}.`,\n          blocking: true,\n        })\n      })\n      this.report.canProceed = false\n    }\n    entity.properties.forEach((child) => {\n      const items = this.deletePropertyAnalysis(child.key)\n      result.push(...items)\n    })\n    entity.associations.forEach((child) => {\n      const items = this.deleteAssociationAnalysis(child.key)\n      result.push(...items)\n    })\n    return result\n  }\n\n  protected deletePropertyAnalysis(key: string): DomainImpactItem[] {\n    const result: DomainImpactItem[] = []\n    const property = this.root.findProperty(key)\n    if (!property) {\n      return result\n    }\n    result.push({\n      key: property.key,\n      kind: property.kind,\n      type: 'delete',\n      impact: `The ${property.info.renderLabel} ${this.kindToLabel(DataPropertyKind)} will be deleted.`,\n      blocking: false,\n    })\n    return result\n  }\n\n  protected deleteAssociationAnalysis(key: string): DomainImpactItem[] {\n    const result: DomainImpactItem[] = []\n    const association = this.root.findAssociation(key)\n    if (!association) {\n      return result\n    }\n    result.push({\n      key: association.key,\n      kind: association.kind,\n      type: 'delete',\n      impact: `The ${association.info.renderLabel} ${this.kindToLabel(DataAssociationKind)} will be deleted.`,\n      blocking: false,\n    })\n    return result\n  }\n\n  protected kindToLabel(kind: DomainImpactKinds): string {\n    switch (kind) {\n      case DataNamespaceKind:\n        return 'namespace'\n      case DataEntityKind:\n        return 'entity'\n      case DataModelKind:\n        return 'data model'\n      case DataPropertyKind:\n        return 'property'\n      case DataAssociationKind:\n        return 'association'\n      default:\n        return 'unknown'\n    }\n  }\n}\n"]}

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

@@ -0,0 +1,14 @@
+export interface DataDomainRemoveOptions {
+    /**
+     * When true, the object will be forcebly removed.
+     * The resolution defined in the `ImpactResolution` class will be applied.
+     *
+     * For example, when removing an entity that is a parent to another entity, it will
+     * removed itself as a parent from the child entity.
+     *
+     * Note, this option should only be used when the DomainImpactAnalysis has been performed
+     * and the user was informed of the impact.
+     */
+    force?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/modeling/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,uBAAuB;IACtC;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB"}

package/build/src/modeling/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/modeling/types.ts"],"names":[],"mappings":"","sourcesContent":["export interface DataDomainRemoveOptions {\n  /**\n   * When true, the object will be forcebly removed.\n   * The resolution defined in the `ImpactResolution` class will be applied.\n   *\n   * For example, when removing an entity that is a parent to another entity, it will\n   * removed itself as a parent from the child entity.\n   *\n   * Note, this option should only be used when the DomainImpactAnalysis has been performed\n   * and the user was informed of the impact.\n   */\n  force?: boolean\n}\n"]}

package/data/models/example-generator-api.json

@@ -41725,21 +41725,21 @@
 "@id": "#191"
 },
 {
+"@id": "#200"
+},
+{
 "@id": "#194"
 },
 {
 "@id": "#197"
 },
 {
-"@id": "#200"
+"@id": "#206"
 },
 {
 "@id": "#203"
 },
 {
-"@id": "#206"
-},
-{
 "@id": "#209"
 }
 ],
@@ -43117,7 +43117,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "addressType: 'REGISTERED-OFFICE-ADDRESS'\nstreetName: 'UITBREIDINGSTRAAT'\nhouseNumber: '84'\nhouseNumberAddition: '/1'\npostalCode: '2600'\ncity: 'BERCHEM (ANTWERPEN)'\ncountry: 'Belgium'\ncountryCode: 'BE'\nfullFormatedAddress: \"UITBREIDINGSTRAAT 84 /1, 2600 BERCHEM (ANTWERPEN), BELIUM\"\n",
+"doc:raw": "code: '5'\ndescription: 'Limited company'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43138,7 +43138,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "code: '5'\ndescription: 'Limited company'\n",
+"doc:raw": "class: '3'\ndescription: '150 - 300'\nnumberOfFte: 5500\nnumberOfEmployees: 5232\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43159,7 +43159,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "class: '3'\ndescription: '150 - 300'\nnumberOfFte: 5500\nnumberOfEmployees: 5232\n",
+"doc:raw": "addressType: 'REGISTERED-OFFICE-ADDRESS'\nstreetName: 'UITBREIDINGSTRAAT'\nhouseNumber: '84'\nhouseNumberAddition: '/1'\npostalCode: '2600'\ncity: 'BERCHEM (ANTWERPEN)'\ncountry: 'Belgium'\ncountryCode: 'BE'\nfullFormatedAddress: \"UITBREIDINGSTRAAT 84 /1, 2600 BERCHEM (ANTWERPEN), BELIUM\"\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43180,7 +43180,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "code: 'J'\ndescription: 'Information and communication'\n",
+"doc:raw": "code: '7487'\ndescription: 'Financial and insurance activities'\ntype: \"PRIMARY\"\nclassificationCode: 'BE_NACEBEL2008'\nactivityGroupCode: 'ABCDE'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43201,7 +43201,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "code: '7487'\ndescription: 'Financial and insurance activities'\ntype: \"PRIMARY\"\nclassificationCode: 'BE_NACEBEL2008'\nactivityGroupCode: 'ABCDE'\n",
+"doc:raw": "code: 'J'\ndescription: 'Information and communication'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44421,27 +44421,27 @@
 {
 "@id": "#196/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#196",
-"sourcemaps:value": "[(1,0)-(10,0)]"
+"sourcemaps:value": "[(1,0)-(3,0)]"
 },
 {
 "@id": "#199/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#199",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(5,0)]"
 },
 {
 "@id": "#202/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#202",
-"sourcemaps:value": "[(1,0)-(5,0)]"
+"sourcemaps:value": "[(1,0)-(10,0)]"
 },
 {
 "@id": "#205/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#205",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(6,0)]"
 },
 {
 "@id": "#208/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#208",
-"sourcemaps:value": "[(1,0)-(6,0)]"
+"sourcemaps:value": "[(1,0)-(3,0)]"
 },
 {
 "@id": "#223/source-map/lexical/element_0",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-client/core",
   "description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
-  "version": "0.11.7",
+  "version": "0.11.9",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {
@@ -31,9 +31,9 @@
     "#proxy/*": "./src/proxy/*",
     "#ui/*": "./src/ui/*"
   },
-  "main": "./build/index.js",
-  "browser": "./build/browser.js",
-  "module": "./build/index.js",
+  "main": "./build/src/index.js",
+  "browser": "./build/src/browser.js",
+  "module": "./build/src/index.js",
   "type": "module",
   "author": {
     "name": "Pawel Uchida-Psztyc"
@@ -88,7 +88,7 @@
     "eslint-config-prettier": "^10.0.1",
     "eslint-plugin-no-only-tests": "^3.3.0",
     "eslint-plugin-prettier": "^5.2.3",
-    "express": "^4.17.1",
+    "express": "^5.1.0",
     "express-ntlm": "^2.6.1",
     "get-port": "^7.0.0",
     "globals": "^16.0.0",
@@ -120,7 +120,7 @@
     "test:browser:watch": "node --import ts-node-maintained/register/esm --enable-source-maps bin/test-web.ts --watch --playwright --browsers chromium",
     "test": "wireit",
     "test:coverage": "wireit",
-    "test:node": "node --import ts-node-maintained/register/esm bin/test.ts",
+    "test:node": "node --import ts-node-maintained/register/esm --enable-source-maps bin/test.ts",
     "test:node:coverage": "c8 --reporter lcov --reporter text node --import ts-node-maintained/register/esm --enable-source-maps bin/test.ts",
     "test:node:watch": "node --import ts-node-maintained/register/esm --enable-source-maps bin/test.ts --watch",
     "build:api-models": "node data/model.js",