@api-client/core 0.18.62 → 0.18.64

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

@@ -42062,9 +42062,6 @@
 "@id": "#209"
 },
 {
-"@id": "#206"
-},
-{
 "@id": "#191"
 },
 {
@@ -42080,6 +42077,9 @@
 "@id": "#203"
 },
 {
+"@id": "#206"
+},
+{
 "@id": "#209"
 }
 ],
@@ -43436,7 +43436,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": "countryCode: \"BE\"\ngraydonEnterpriseId: 1057155523\nregistrationId: \"0422319093\"\nvatNumber: \"BE0422319093\"\ngraydonCompanyId: \"0422319093\"\nisBranchOffice: false\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43457,7 +43457,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "code: '5'\ndescription: 'Limited company'\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": [
 {
@@ -43478,7 +43478,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "class: '3'\ndescription: '150 - 300'\nnumberOfFte: 5500\nnumberOfEmployees: 5232\n",
+"doc:raw": "code: '5'\ndescription: 'Limited company'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43499,7 +43499,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "code: 'J'\ndescription: 'Information and communication'\n",
+"doc:raw": "class: '3'\ndescription: '150 - 300'\nnumberOfFte: 5500\nnumberOfEmployees: 5232\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43520,7 +43520,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": [
 {
@@ -43541,7 +43541,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "countryCode: \"BE\"\ngraydonEnterpriseId: 1057155523\nregistrationId: \"0422319093\"\nvatNumber: \"BE0422319093\"\ngraydonCompanyId: \"0422319093\"\nisBranchOffice: false\n",
+"doc:raw": "code: '7487'\ndescription: 'Financial and insurance activities'\ntype: \"PRIMARY\"\nclassificationCode: 'BE_NACEBEL2008'\nactivityGroupCode: 'ABCDE'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44756,32 +44756,32 @@
 {
 "@id": "#193/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#193",
-"sourcemaps:value": "[(1,0)-(10,0)]"
+"sourcemaps:value": "[(1,0)-(7,0)]"
 },
 {
 "@id": "#196/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#196",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(10,0)]"
 },
 {
 "@id": "#199/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#199",
-"sourcemaps:value": "[(1,0)-(5,0)]"
+"sourcemaps:value": "[(1,0)-(3,0)]"
 },
 {
 "@id": "#202/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#202",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(5,0)]"
 },
 {
 "@id": "#205/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#205",
-"sourcemaps:value": "[(1,0)-(6,0)]"
+"sourcemaps:value": "[(1,0)-(3,0)]"
 },
 {
 "@id": "#208/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#208",
-"sourcemaps:value": "[(1,0)-(7,0)]"
+"sourcemaps:value": "[(1,0)-(6,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.18.62",
+  "version": "0.18.64",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {
@@ -108,7 +108,7 @@
   "devDependencies": {
     "@commitlint/cli": "^20.1.0",
     "@commitlint/config-conventional": "^20.0.0",
-    "@eslint/js": "^9.20.0",
+    "@eslint/js": "^10.0.1",
     "@japa/api-client": "^3.0.3",
     "@japa/assert": "^4.0.1",
     "@japa/browser-client": "^2.1.1",
@@ -128,13 +128,13 @@
     "@web/dev-server-rollup": "^0.6.4",
     "@web/test-runner": "^0.20.0",
     "@web/test-runner-playwright": "^0.11.0",
-    "amf-client-js": "^5.9.1-3",
+    "amf-client-js": "^5.10.0-0",
     "c8": "^10.1.3",
     "chai-as-promised": "^8.0.2",
     "conventional-changelog": "^7.1.0",
     "conventional-changelog-conventionalcommits": "^9.1.0",
     "cors": "^2.8.5",
-    "eslint": "^9.20.1",
+    "eslint": "^10.0.1",
     "eslint-config-prettier": "^10.0.1",
     "eslint-plugin-no-only-tests": "^3.3.0",
     "eslint-plugin-prettier": "^5.2.3",

package/src/modeling/DataDomain.ts

@@ -9,7 +9,6 @@ import {
   DomainPropertyKind,
 } from '../models/kinds.js'
 import type {
-  AssociationAddOptions,
   DeserializationIssue,
   DeserializationMode,
   DomainGraphEdge,
@@ -22,7 +21,7 @@ import type {
 import { type DomainNamespaceSchema, DomainNamespace, type NamespaceOrderedItem } from './DomainNamespace.js'
 import { type DomainModelSchema, DomainModel } from './DomainModel.js'
 import { type DomainEntitySchema, DomainEntity } from './DomainEntity.js'
-import { DomainAssociation } from './DomainAssociation.js'
+import { DomainAssociation, DomainAssociationSchema } from './DomainAssociation.js'
 import { DomainProperty, DomainPropertySchema } from './DomainProperty.js'
 import { type IThing, Thing } from '../models/Thing.js'
 import { removeGraphNode } from './GraphUtils.js'
@@ -57,6 +56,7 @@ export interface DataDomainSchema extends DependentModelSchema {
  * -   **Root Container:** Holds all data elements within a domain.
  * -   **Graph-Based Structure:** Uses a graph to represent relationships between data elements.
  * -   **Namespace Management:** Supports creating and managing namespaces to organize data models.
+ *                               Namespaces are optional.
  * -   **Data Model Management:** Supports creating and managing data models to group entities.
  * -   **Entity Management:** Supports creating and managing entities, which define the structure of data.
  * -   **Property Management:** Supports creating and managing properties, which define the data elements
@@ -1084,17 +1084,17 @@ export class DataDomain extends DependentModel {
    * calls the `addAssociation` method on it.
    *
    * @param source The key of the source entity.
-   * @param init The association options.
+   * @param input The partial association schema.
    * @returns The created association.
    * @throws Error When the source entity does not exist.
    * @example
    * ```typescript
    * const addressAssociation = dataDomain.addAssociation(
-   *   'user', { key: 'address' }
+   *   'user-key', { targets: [{ key: 'address-key' }] }
    * );
    * ```
    */
-  addAssociation(source: string, init?: AssociationAddOptions): DomainAssociation {
+  addAssociation(source: string, input?: Partial<DomainAssociationSchema>): DomainAssociation {
     if (!this.graph.hasNode(source)) {
       throw new Error(`Source entity ${source} not found`)
     }
@@ -1105,7 +1105,7 @@ export class DataDomain extends DependentModel {
     if (entity.domain.key !== this.key) {
       throw new Error(`Cannot add an association to a foreign domain`)
     }
-    return entity.addAssociation(init)
+    return entity.addAssociation(input)
   }
 
   /**

package/src/modeling/DomainAssociation.ts

@@ -625,7 +625,7 @@ export class DomainAssociation extends DomainElement {
       copy.info = { name: newName }
     }
 
-    const result = parent.addAssociation({}, copy)
+    const result = parent.addAssociation(copy)
 
     // Copy the target entities
     for (const target of this.targets) {

package/src/modeling/DomainEntity.ts

@@ -8,7 +8,6 @@ import type { IShapeUnion } from '../amf/definitions/Shapes.js'
 import { DomainProperty, type DomainPropertySchema } from './DomainProperty.js'
 import { RemovePropertyException } from '../exceptions/remove_property_exception.js'
 import { DomainAssociation, DomainAssociationSchema } from './DomainAssociation.js'
-import type { AssociationAddOptions } from './types.js'
 import type { FileBreadcrumb } from '../models/store/File.js'
 import type { DomainModel } from './DomainModel.js'
 import type { DomainNamespace } from './DomainNamespace.js'
@@ -628,35 +627,54 @@ export class DomainEntity extends DomainElement {
   /**
    * Adds an association to this entity.
    *
-   * @param init The association options.
+   * Add rules:
+   * - If the target is specified, it has to exist in the graph.
+   * - The association targets can be local or foreign.
+   *
+   * Please note that you can't just add targets to the association schema.
+   * This function manipulates the graph to insert the required metadata.
+   *
    * @param input The partial association schema.
    * @returns The created `DomainAssociation` instance.
    * @throws Error When the target entity does not exist.
    * @example
    * ```typescript
-   * const association = entity.addAssociation({
-   *   key: 'address',
-   * });
+   * const association = entity.addAssociation({ info: { name: 'Address' }, targets: [{ key: 'address' }] });
    * ```
    */
-  addAssociation(init: AssociationAddOptions = {}, input?: Partial<DomainAssociationSchema>): DomainAssociation {
+  addAssociation(input: Partial<DomainAssociationSchema> = {}): DomainAssociation {
     const { graph } = this.root
-    if (init.domain && init.key) {
-      // target is foreign
-      const foreignKey = `${init.domain}:${init.key}`
-      if (!graph.hasNode(foreignKey)) {
-        throw new Error(`Foreign entity ${foreignKey} not found`)
-      }
-    } else if (init.key) {
-      if (!graph.hasNode(init.key)) {
-        throw new Error(`Target entity ${init.key} not found`)
+
+    // clean up any target information from the input
+    // so we won't break the graph and the app.
+    const inputCopy = { ...input }
+    const targets = inputCopy.targets
+    delete inputCopy.targets
+
+    const hasTargets = Array.isArray(targets) && targets.length
+    if (hasTargets) {
+      for (const target of targets) {
+        if (target.domain && target.key) {
+          // target is foreign
+          const foreignKey = `${target.domain}:${target.key}`
+          if (!graph.hasNode(foreignKey)) {
+            throw new Error(`Foreign entity ${foreignKey} not found`)
+          }
+        } else if (target.key) {
+          if (!graph.hasNode(target.key)) {
+            throw new Error(`Target entity ${target.key} not found`)
+          }
+        }
       }
     }
-    const item = new DomainAssociation(this.root, this.key, input)
+
+    const item = new DomainAssociation(this.root, this.key, inputCopy)
     graph.setNode(item.key, item)
     graph.setEdge(this.key, item.key, { type: 'association' })
-    if (init.key) {
-      item.addTarget(init.key, init.domain)
+    if (hasTargets) {
+      for (const target of targets) {
+        item.addTarget(target.key, target.domain)
+      }
     }
     this.fields.push({ type: 'association', key: item.key })
     this.root.notifyChange()