@api-client/core 0.14.9 → 0.15.0

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

@@ -1,80 +1,5 @@
-import { DomainNamespaceKind, DomainEntityKind, DomainModelKind, DomainPropertyKind, DomainAssociationKind, DataDomainKind } from '../models/kinds.js';
 import type { DataDomain } from './DataDomain.js';
-export type DomainImpactKinds = typeof DomainNamespaceKind | typeof DomainEntityKind | typeof DomainModelKind | typeof DomainPropertyKind | typeof DomainAssociationKind | typeof DataDomainKind;
-/**
- * The impact analysis report
- */
-export interface DomainImpactReport {
-    /**
-     * The key of the impacted data object.
-     * This is the key of the object that is being changed.
-     */
-    key: string;
-    /**
-     * The kind of the impacted data object.
-     * This is the kind of the object that is being changed.
-     */
-    kind: DomainImpactKinds;
-    /**
-     * The list of impacted data objects.
-     */
-    impact: DomainImpactItem[];
-    /**
-     * Whether it is possible to proceed with the change.
-     * If the change is not possible, the reason will be in the impact list.
-     */
-    canProceed: boolean;
-}
-export interface DomainImpactItem {
-    /**
-     * The key of the impacted data object.
-     */
-    key: string;
-    /**
-     * The kind of the impacted data object.
-     */
-    kind: string;
-    /**
-     * The type of the impact.
-     *
-     * - `delete` - The data object would be deleted.
-     */
-    type: 'delete' | 'publish';
-    /**
-     * The impact description.
-     * Explains what will happen to the impacted data object.
-     * This is a human-readable description of the impact.
-     * It should be clear and concise.
-     */
-    impact: string;
-    /**
-     * The severity of the impact.
-     *
-     * - `info` - The impact is informational.
-     * - `warning` - The impact can potentially cause problems but is not a blocker.
-     * - `error` - The impact is a blocker and needs to be resolved before proceeding.
-     */
-    severity: 'info' | 'warning' | 'error';
-    /**
-     * Whether the impact is blocking the operation.
-     * If true, the operation cannot proceed.
-     * @deprecated Use `severity` instead.
-     */
-    blocking: boolean;
-    /**
-     * The type of the relationship between two impacted objects.
-     */
-    relationship?: 'child';
-    /**
-     * The resolution of the conflict if the change will be forced.
-     */
-    resolution?: string;
-    /**
-     * The optional parent of the impacted data object.
-     * For example, if the impacted item is a property, this will be the entity it belongs to.
-     */
-    parent?: string;
-}
+import { DomainImpactItem, DomainImpactKinds, DomainImpactReport } from './types.js';
 /**
  * # DomainImpactAnalysis
  *
@@ -96,13 +21,13 @@ export interface DomainImpactItem {
  *     -   `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.
+ *     -   `severity`: The severity of the impact, which can be `info`, `warning`, or `error`.
  *
  * -   **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.
+ *     a blocking impact. Blocking impacts are indicated by the `severity` property set to `error`.
  *
  * -   **Non-Blocking Impacts:** Some impacts are informational and do not prevent the deletion. For example, deleting a
  *     property is not a blocking impact.
@@ -134,7 +59,7 @@ export interface DomainImpactItem {
  * 3.  **Interpreting the Report:** Examine the `DomainImpactReport` 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.
+ *     -   Pay special attention to `impact.severity` to identify impacts that require manual resolution.
  *
  *     ```typescript
  *     if (report.canProceed) {
@@ -143,7 +68,7 @@ export interface DomainImpactItem {
  *       console.warn('Deletion cannot proceed due to the following impacts:');
  *       report.impact.forEach((item) => {
  *         console.warn(`- ${item.impact}`);
- *         if (item.blocking) {
+ *         if (item.severity === 'error') {
  *           console.warn(`  - This impact is blocking.`);
  *           if (item.resolution) {
  *             console.warn(`  - Resolution: ${item.resolution}`);
@@ -195,7 +120,7 @@ export interface DomainImpactItem {
  *       "kind": "DomainEntityKind",
  *       "type": "delete",
  *       "impact": "The entity with key Product will be deleted.",
- *       "blocking": false
+ *       "severity": "warning"
  *     },
  *     {
  *       "key": "SpecialProduct",
@@ -203,7 +128,7 @@ export interface DomainImpactItem {
  *       "type": "delete",
  *       "impact": "The SpecialProduct entity will become an orphan because it is a child of Product.",
  *       "resolution": "The \"Product\" entity will be removed as the parent of the \"SpecialProduct\" entity.",
- *       "blocking": true,
+ *       "severity": "error",
  *       "relationship": "child"
  *     },
  *     {
@@ -212,14 +137,14 @@ export interface DomainImpactItem {
  *       "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
+ *       "severity": "error"
  *     },
  *     {
  *       "key": "name",
  *       "kind": "DomainPropertyKind",
  *       "type": "delete",
  *       "impact": "The property with key name will be deleted.",
- *       "blocking": false
+ *       "severity": "info"
  *     }
  *   ],
  *   "canProceed": false
@@ -247,27 +172,6 @@ export interface DomainImpactItem {
  *     - `DomainAssociationKind`
  *     - `DataDomainKind`
  *
- * ### `DomainImpactReport`
- *
- * -   **Description:** The structure of the impact analysis report.
- * -   **Properties:**
- *     -   `key` (`string`): The key of the object being deleted.
- *     -   `kind` (`DomainImpactKinds`): The kind of the object being deleted.
- *     -   `impact` (`DomainImpactItem[]`): The list of impacts.
- *     -   `canProceed` (`boolean`): Whether the deletion can proceed.
- *
- * ### `DomainImpactItem`
- *
- * -   **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 `DomainImpactReport` to communicate
@@ -277,7 +181,7 @@ export interface DomainImpactItem {
  *
  * - **Always Analyze Before Deleting:** Before deleting any data domain element, always use `DomainImpactAnalysis`
  *   to understand the consequences.
- * - **Handle Blocking Impacts:** Pay close attention to `blocking` impacts and implement appropriate
+ * - **Handle Blocking Impacts:** Pay close attention to `severity = "error"` 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.
@@ -291,7 +195,6 @@ export interface DomainImpactItem {
  * about data deletion and prevent unintended consequences.
  */
 export declare class DomainImpactAnalysis {
-    private report;
     private root;
     constructor(root: DataDomain);
     /**
@@ -308,18 +211,18 @@ export declare class DomainImpactAnalysis {
      */
     removeForeignNamespaceAnalysis(key: string): DomainImpactReport;
     /**
-     * Analyzes the data domain for publishing. Essentially, it performs a validation of the data domain
-     * and returns a report of the impact.
-     * @returns The publish impact analysis report.
-     */
-    publishAnalysis(): DomainImpactReport;
-    protected createDeleteImpact(key: string, kind: DomainImpactKinds, rootKey: string): void;
-    protected deleteNamespaceAnalysis(key: string, rootKey: string): void;
-    protected deleteModelAnalysis(key: string, rootKey: string): void;
-    protected deleteEntityAnalysis(key: string, rootKey: string): void;
-    protected deletePropertyAnalysis(key: string): void;
-    protected deleteAssociationAnalysis(key: string): void;
+     * Computes whether the deletion can proceed based on the impact report.
+     * @param impact The list of impacts from the analysis.
+     * @returns `true` if the deletion can proceed, `false` otherwise.
+     */
+    protected computeCanProceed(impact: DomainImpactItem[]): boolean;
+    protected createDeleteImpact(key: string, kind: DomainImpactKinds, rootKey: string, impact: DomainImpactItem[]): void;
+    protected deleteNamespaceAnalysis(key: string, rootKey: string, impact: DomainImpactItem[]): void;
+    protected deleteModelAnalysis(key: string, rootKey: string, impact: DomainImpactItem[]): void;
+    protected deleteEntityAnalysis(key: string, rootKey: string, impact: DomainImpactItem[]): void;
+    protected deletePropertyAnalysis(key: string, impact: DomainImpactItem[]): void;
+    protected deleteAssociationAnalysis(key: string, impact: DomainImpactItem[]): void;
     protected kindToLabel(kind: DomainImpactKinds): string;
-    protected createRemoveForeignNamespaceImpact(key: string): void;
+    protected createRemoveForeignNamespaceImpact(key: string, impact: DomainImpactItem[]): void;
 }
 //# sourceMappingURL=DomainImpactAnalysis.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"DomainImpactAnalysis.d.ts","sourceRoot":"","sources":["../../../src/modeling/DomainImpactAnalysis.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,gBAAgB,EAChB,eAAe,EACf,kBAAkB,EAClB,qBAAqB,EACrB,cAAc,EACf,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAKjD,MAAM,MAAM,iBAAiB,GACzB,OAAO,mBAAmB,GAC1B,OAAO,gBAAgB,GACvB,OAAO,eAAe,GACtB,OAAO,kBAAkB,GACzB,OAAO,qBAAqB,GAC5B,OAAO,cAAc,CAAA;AAEzB;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;;OAGG;IACH,IAAI,EAAE,iBAAiB,CAAA;IACvB;;OAEG;IACH,MAAM,EAAE,gBAAgB,EAAE,CAAA;IAC1B;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;;;OAIG;IACH,IAAI,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC1B;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;;;;;OAMG;IACH,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAA;IACtC;;;;OAIG;IACH,QAAQ,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsNG;AACH,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,MAAM,CAAoB;IAClC,OAAO,CAAC,IAAI,CAAY;gBAEZ,IAAI,EAAE,UAAU;IAU5B;;;;;OAKG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,kBAAkB;IAWxE;;;;OAIG;IACH,8BAA8B,CAAC,GAAG,EAAE,MAAM,GAAG,kBAAkB;IAW/D;;;;OAIG;IACH,eAAe,IAAI,kBAAkB;IAoErC,SAAS,CAAC,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAsBzF,SAAS,CAAC,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAqBrE,SAAS,CAAC,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAkBjE,SAAS,CAAC,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAkFlE,SAAS,CAAC,sBAAsB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAenD,SAAS,CAAC,yBAAyB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAetD,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,iBAAiB,GAAG,MAAM;IAiBtD,SAAS,CAAC,kCAAkC,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;CA8DhE"}
+{"version":3,"file":"DomainImpactAnalysis.d.ts","sourceRoot":"","sources":["../../../src/modeling/DomainImpactAnalysis.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAEpF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiMG;AACH,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,IAAI,CAAY;gBAEZ,IAAI,EAAE,UAAU;IAI5B;;;;;OAKG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,kBAAkB;IAYxE;;;;OAIG;IACH,8BAA8B,CAAC,GAAG,EAAE,MAAM,GAAG,kBAAkB;IAY/D;;;;OAIG;IACH,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,gBAAgB,EAAE,GAAG,OAAO;IAIhE,SAAS,CAAC,kBAAkB,CAC1B,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,iBAAiB,EACvB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,gBAAgB,EAAE,GACzB,IAAI;IAsBP,SAAS,CAAC,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI;IAoBjG,SAAS,CAAC,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI;IAiB7F,SAAS,CAAC,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI;IA6E9F,SAAS,CAAC,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI;IAc/E,SAAS,CAAC,yBAAyB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI;IAclF,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,iBAAiB,GAAG,MAAM;IAiBtD,SAAS,CAAC,kCAAkC,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI;CA0D5F"}