@api-client/core 0.11.6 → 0.11.8

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.6",
+  "version": "0.11.8",
   "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"
@@ -49,8 +49,6 @@
     "url": "https://github.com/api-client/core/issues"
   },
   "dependencies": {
-    "@adonisjs/transmit-client": "^1.0.0",
-    "@api-client/graph": "^0.2.0",
     "@api-client/json": "^0.2.0",
     "@esm-bundle/chai": "^4.3.4-fix.0",
     "@material/web": "^2.2.0",
@@ -60,12 +58,6 @@
     "@xmldom/xmldom": "^0.9.7",
     "amf-json-ld-lib": "^0.0.15",
     "console-table-printer": "^2.11.2",
-    "dompurify": "^3.1.5",
-    "idb-keyval": "^6.2.1",
-    "lit": "^3.1.4",
-    "marked": "^15.0.7",
-    "monaco-editor": "^0.52.2",
-    "prismjs": "^1.29.0",
     "ws": "^8.12.0",
     "xpath": "^0.0.34"
   },
@@ -78,21 +70,16 @@
     "@japa/browser-client": "^2.1.1",
     "@japa/expect-type": "^2.0.3",
     "@japa/runner": "^4.2.0",
-    "@open-wc/semantic-dom-diff": "^0.20.1",
-    "@open-wc/testing": "^4.0.0",
     "@rollup/plugin-typescript": "^12.1.2",
     "@types/cors": "^2.8.12",
-    "@types/dompurify": "^3.0.5",
     "@types/express-ntlm": "^2.3.3",
     "@types/jsdom": "^21.1.7",
     "@types/mocha": "^10.0.10",
     "@types/node": "^22.13.4",
-    "@types/prismjs": "^1.26.4",
     "@types/sinon": "^17.0.1",
     "@web/dev-server": "^0.4.6",
     "@web/dev-server-rollup": "^0.6.4",
     "@web/test-runner": "^0.20.0",
-    "@web/test-runner-commands": "^0.9.0",
     "@web/test-runner-playwright": "^0.11.0",
     "amf-client-js": "^5.7.0",
     "c8": "^10.1.3",
@@ -101,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",
@@ -113,7 +100,6 @@
     "playwright": "^1.50.1",
     "prettier": "^3.5.1",
     "sinon": "^20.0.0",
-    "ssl-root-cas": "^1.3.1",
     "ts-lit-plugin": "^2.0.2",
     "ts-node-maintained": "^10.9.5",
     "typescript": "^5.5.2",
@@ -133,6 +119,7 @@
     "test:browser": "node --import ts-node-maintained/register/esm --enable-source-maps bin/test-web.ts --playwright --browsers chromium",
     "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 --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",
@@ -143,6 +130,9 @@
   },
   "wireit": {
     "test": {
+      "command": "npm run test:node && npm run test:browser"
+    },
+    "test:coverage": {
       "command": "npm run test:node:coverage && npm run test:browser"
     },
     "tsc:watch": {

package/src/amf/definitions/Shapes.ts

@@ -68,7 +68,7 @@ export interface IApiAssociationShape {
    * - anyOf - To validate against `anyOf`, the given data must be valid against
    *   any (one or more) of the given sub-schemas. When generation a schema, it takes first union schema.
    * - oneOf - To validate against `oneOf`, the given data must be valid against
-   *   exactly one of the given sub-schemas. It behaves the same as `oneOf` when generating a schema
+   *   exactly one of the given sub-schemas. It behaves the same as `anyOf` when generating a schema
    * - not - The `not` keyword declares that an instance validates if it doesn’t
    *   validate against the given sub-schema. It has no use when generating a schema.
    *

package/src/modeling/DataAssociation.ts

@@ -402,6 +402,19 @@ export class DataAssociation {
         namespace = typed.root.key
       }
     }
+    if (this.targets.some((i) => i.key === key)) {
+      const message = `Target ${key} already exists.`
+      throw new ValidationError(
+        [
+          {
+            field: 'targets',
+            message,
+            rule: 'unique',
+          },
+        ],
+        { message }
+      )
+    }
     if (namespace && namespace !== this.root.key) {
       const foreignNamespace = this.root.foreign.find((ns) => ns.key === namespace)
       if (!foreignNamespace) {
@@ -480,9 +493,9 @@ export class DataAssociation {
   }
 
   /**
-   * Checks whether the passed value is one of the supported data proprty attributes.
+   * Checks whether the passed value is one of the supported data property attributes.
    * @param value The value to test
-   * @returns True when the passed value is one of the supported data proprty attributes.
+   * @returns True when the passed value is one of the supported data property attributes.
    */
   static isValidAttribute(value: unknown): value is DataAttributeAttribute {
     if (typeof value !== 'string') {
@@ -513,4 +526,25 @@ export class DataAssociation {
     const item = this.bindings.find((i) => i.type === type) as AssociationBinding
     return item?.schema
   }
+
+  /**
+   * Checks whether the association is a child of the given namespace, data model, or an entity.
+   * The relationship doesn't have to be direct, as long as the association is in the hierarchy it will return true.
+   *
+   * @param key The key of the parent to check.
+   * @returns True if this data association is a child of the given namespace, data model, or an entity
+   */
+  isChildOf(key: string): boolean {
+    if (this.key === key) {
+      return false
+    }
+    const parent = this.getParentInstance()
+    if (!parent) {
+      return false
+    }
+    if (parent.key === key) {
+      return true
+    }
+    return parent.isChildOf(key)
+  }
 }

package/src/modeling/DataEntity.ts

@@ -16,9 +16,16 @@ import { RemoveAssociationException } from '../exceptions/remove_association_exc
 import { ValidationError, type FieldValidationMessage } from '../exceptions/validation_error.js'
 import { RemoveEntityException } from '../exceptions/remove_entity_exception.js'
 import { ForeignAssociationException } from '../exceptions/foreign_association_exception.js'
+import type { DataDomainRemoveOptions } from './types.js'
 
 interface OrderedItem {
+  /**
+   * The type of the ordered item.
+   */
   type: 'property' | 'association'
+  /**
+   * The key of the ordered item.
+   */
   key: string
 }
 
@@ -556,6 +563,7 @@ export class DataEntity {
 
   /**
    * Computes a list of entities that are associated with the current entity.
+   * This is the association-out (out-edge) direction.
    */
   getComputedAssociations(): DataEntity[] {
     const { associations } = this
@@ -577,23 +585,43 @@ export class DataEntity {
   /**
    * Removes self from the namespace with all properties and attributes.
    */
-  remove(): void {
+  remove(opts: DataDomainRemoveOptions = {}): void {
     const { key, properties, associations, root } = this
     // check if some entity has reference to this entity as a target
-    const associationsToEntity = this.root.definitions.associations.filter((a) =>
-      a.targets.some((t) => t.key === this.key)
-    )
-    if (associationsToEntity.length > 0) {
-      const entitiesNames = associationsToEntity.reduce<string[]>((acc, association) => {
+    const toEdges = this.root.definitions.associations.filter((a) => a.targets.some((t) => t.key === this.key))
+    if (toEdges.length > 0) {
+      const result = toEdges.reduce<{ entity: DataEntity; association: DataAssociation }[]>((acc, association) => {
         const entity = root.definitions.entities.find((e) => e.associations.some((a) => a.key === association.key))
         if (entity) {
-          acc.push(entity.info.name as string)
+          acc.push({ entity, association })
         }
         return acc
       }, [])
-      throw new RemoveEntityException(
-        `Cannot remove entity ${this.info.name} because it is used as a target in associations in entities: ${entitiesNames.join(', ')}.`
-      )
+      if (opts.force) {
+        // remove the association from the entity
+        result.forEach(({ entity: item, association }) => {
+          item.removeAssociation(association.key)
+        })
+      } else {
+        const entitiesNames = result.map(({ entity }) => entity.info.renderLabel || entity.key)
+        throw new RemoveEntityException(
+          `Cannot remove entity ${this.info.renderLabel} because it is used as a target in associations in entities: ${entitiesNames.join(', ')}.`
+        )
+      }
+    }
+
+    const children = this.getComputedChildren()
+    if (children.length > 0) {
+      if (opts.force) {
+        children.forEach((child) => {
+          child.parents = child.parents.filter((i) => i !== this.key)
+        })
+      } else {
+        const childrenNames = children.map((i) => i.info.renderLabel || i.key)
+        throw new RemoveEntityException(
+          `Cannot remove entity ${this.info.renderLabel} because it is a parent for the following entities: ${childrenNames.join(', ')}.`
+        )
+      }
     }
 
     // remove own stuff
@@ -615,7 +643,7 @@ export class DataEntity {
   /**
    * @deprecated Use the `getParentInstance()` method instead.
    */
-  // This method name colides with the `getParents()` method.
+  // This method name collides with the `getParents()` method.
   getParent(): DataModel | undefined {
     return this.getParentInstance()
   }
@@ -685,7 +713,7 @@ export class DataEntity {
           {
             field: 'parents',
             message,
-            rule: 'exists',
+            rule: 'unique',
           },
         ],
         { message }
@@ -695,6 +723,33 @@ export class DataEntity {
     return this
   }
 
+  /**
+   * Removes a parent reference from this entity.
+   * It keeps the parent as is.
+   *
+   * @param key The key of the parent entity to remove.
+   * @throws ValidationError when the parent is not found.
+   * @returns Self for chaining.
+   */
+  removeParent(key: string): this {
+    const index = this.parents.findIndex((i) => i === key)
+    if (index < 0) {
+      const message = `Parent ${key} not found.`
+      throw new ValidationError(
+        [
+          {
+            field: 'parents',
+            message,
+            rule: 'not-found',
+          },
+        ],
+        { message }
+      )
+    }
+    this.parents.splice(index, 1)
+    return this
+  }
+
   /**
    * Checks if the entity has a circular parent relationship when attempting to add a new parent.
    * @param key The key of the parent being added.
@@ -935,4 +990,25 @@ export class DataEntity {
     }
     return false
   }
+
+  /**
+   * Checks whether the entity is a child of the given namespace or data model.
+   * The relationship doesn't have to be direct, as long as the entity is in the hierarchy it will return true.
+   *
+   * @param key The key of the parent to check.
+   * @returns True if this entity is a child of the given namespace or data model.
+   */
+  isChildOf(key: string): boolean {
+    if (this.key === key) {
+      return false
+    }
+    const parent = this.getParentInstance()
+    if (!parent) {
+      return false
+    }
+    if (parent.key === key) {
+      return true
+    }
+    return parent.isChildOf(key)
+  }
 }

package/src/modeling/DataModel.ts

@@ -4,6 +4,7 @@ import { DataEntity, IDataEntity } from './DataEntity.js'
 import type { DataItemAdaptingOptions, DataNamespace } from './DataNamespace.js'
 import { FileBreadcrumb } from '../models/store/File.js'
 import { DataModelKind } from '../models/kinds.js'
+import type { DataDomainRemoveOptions } from './types.js'
 
 /**
  * Data model creates a logical structure around data entities.
@@ -129,10 +130,10 @@ export class DataModel {
   /**
    * Removes self from the namespace with all entities.
    */
-  remove(): void {
+  remove(opts?: DataDomainRemoveOptions): void {
     const { key, entities, root } = this
     // remove children
-    entities.forEach((e) => e.remove())
+    entities.forEach((e) => e.remove(opts))
 
     // remove self from the parent
     const parent = this.getParentInstance()
@@ -249,4 +250,25 @@ export class DataModel {
     })
     return result.reverse()
   }
+
+  /**
+   * 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: string): boolean {
+    if (this.key === key) {
+      return false
+    }
+    const parent = this.getParentInstance()
+    if (!parent) {
+      return false
+    }
+    if (parent.key === key) {
+      return true
+    }
+    return parent.isChildOf(key)
+  }
 }