@api-client/core 0.14.9 → 0.15.0

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

@@ -42062,10 +42062,10 @@
 "@id": "#209"
 },
 {
-"@id": "#197"
+"@id": "#191"
 },
 {
-"@id": "#191"
+"@id": "#197"
 },
 {
 "@id": "#194"
@@ -42813,10 +42813,10 @@
 "@id": "#210"
 },
 {
-"@id": "#216"
+"@id": "#213"
 },
 {
-"@id": "#213"
+"@id": "#216"
 },
 {
 "@id": "#219"
@@ -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": [
 {
@@ -43478,7 +43478,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "countryCode: \"BE\"\ngraydonEnterpriseId: 1057155523\nregistrationId: \"0422319093\"\nvatNumber: \"BE0422319093\"\ngraydonCompanyId: \"0422319093\"\nisBranchOffice: false\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": [
 {
@@ -44253,7 +44253,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "-\n  type: 'GENERAL'\n  value: 'info@company.be'\n-\n  type: 'IT_DEPT'\n  value: 'it-service@company.be'\n",
+"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '21'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)21 302099'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44274,7 +44274,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '21'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)21 302099'\n",
+"doc:raw": "-\n  type: 'GENERAL'\n  value: 'info@company.be'\n-\n  type: 'IT_DEPT'\n  value: 'it-service@company.be'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44756,7 +44756,7 @@
 {
 "@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",
@@ -44766,7 +44766,7 @@
 {
 "@id": "#199/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#199",
-"sourcemaps:value": "[(1,0)-(7,0)]"
+"sourcemaps:value": "[(1,0)-(10,0)]"
 },
 {
 "@id": "#202/source-map/lexical/element_0",
@@ -45121,12 +45121,12 @@
 {
 "@id": "#215/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#215",
-"sourcemaps:value": "[(1,0)-(7,0)]"
+"sourcemaps:value": "[(1,0)-(6,0)]"
 },
 {
 "@id": "#218/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#218",
-"sourcemaps:value": "[(1,0)-(6,0)]"
+"sourcemaps:value": "[(1,0)-(7,0)]"
 },
 {
 "@id": "#221/source-map/lexical/element_0",

package/noop.ts

@@ -0,0 +1,3 @@
+// Dummy file to satisfy @web/dev-server-rollup plugin requirements
+// This file is used as a placeholder input for rollup configuration
+export default {}

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.14.9",
+  "version": "0.15.0",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {
@@ -106,6 +106,7 @@
     "@japa/browser-client": "^2.1.1",
     "@japa/expect-type": "^2.0.3",
     "@japa/runner": "^4.2.0",
+    "@pawel-up/semver": "^0.1.4",
     "@rollup/plugin-typescript": "^12.1.2",
     "@types/cors": "^2.8.12",
     "@types/express-ntlm": "^2.3.3",
@@ -119,6 +120,7 @@
     "@web/test-runner-playwright": "^0.11.0",
     "amf-client-js": "^5.7.0",
     "c8": "^10.1.3",
+    "conventional-changelog-cli": "^5.0.0",
     "cors": "^2.8.5",
     "eslint": "^9.20.1",
     "eslint-config-prettier": "^10.0.1",
@@ -133,7 +135,6 @@
     "lint-staged": "^16.0.0",
     "nock": "^14.0.1",
     "oauth2-mock-server": "^8.0.0",
-    "playwright": "^1.50.1",
     "prettier": "^3.5.1",
     "sinon": "^21.0.0",
     "ts-lit-plugin": "^2.0.2",
@@ -146,7 +147,7 @@
     "build:browser": "wireit",
     "build:ts": "wireit",
     "build:node": "wireit",
-    "build": "npm run build:ts && npm run lint && npm run copy:assets",
+    "build": "npm run build:ts && npm run copy:assets",
     "prepare": "husky && npm run fixes && npm run build:ts && npm run build:api-models",
     "fixes": "node scripts/fix-rollup-plugin.js",
     "tsc": "wireit",
@@ -165,7 +166,11 @@
     "lint:prettier": "wireit",
     "format": "npm run format:prettier && npm run format:prettier",
     "format:prettier": "wireit",
-    "format:eslint": "wireit"
+    "format:eslint": "wireit",
+    "release": "node scripts/release.js",
+    "release:patch": "node scripts/release.js patch",
+    "release:minor": "node scripts/release.js minor",
+    "release:major": "node scripts/release.js major"
   },
   "wireit": {
     "test": {

package/src/events/authorization/AuthorizationEvents.ts

@@ -66,7 +66,7 @@ class OidcEvents {
    * @param target A node on which to dispatch the event.
    * @returns Promise resolved when the token is removed
    */
-  static async removeToken(config: ITokenRemoveOptions, target: EventTarget = window): Promise<void> {
+  static async removeTokens(config: ITokenRemoveOptions, target: EventTarget = window): Promise<void> {
     const e = new ContextEvent<ITokenRemoveOptions, void>(AuthorizationEventTypes.Oidc.removeTokens, config)
     target.dispatchEvent(e)
     return e.detail.result

package/src/events/cookies/CookieEvents.ts

@@ -38,7 +38,7 @@ export class CookieEvents {
    * @param target The target on which to dispatch the event
    * @returns The list of project index objects.
    */
-  static async listAll(target: EventTarget): Promise<IHttpCookie[] | undefined> {
+  static async listAll(target: EventTarget = window): Promise<IHttpCookie[] | undefined> {
     const detail: ContextEventDetailWithResult<IHttpCookie[]> = {}
     const e = new CustomEvent(CookieEventTypes.listAll, {
       bubbles: true,

package/src/modeling/DataDomain.ts

@@ -394,6 +394,33 @@ export class DataDomain extends DependentModel {
     }
   }
 
+  /**
+   * Lists all namespaces in the graph that are part of specified domain.
+   *
+   * @param namespace The foreign namespace to search in. When not found, it throws an error.
+   * @returns A generator that yields each `DomainNamespace`.
+   * @throws Error When the foreign domain is not found.
+   * @example
+   * ```typescript
+   * for (const ns of dataDomain.listForeignNamespaces('foreignDomainKey')) {
+   *   console.log(ns.key);
+   * }
+   * ```
+   */
+  *listForeignNamespaces(namespace: string): Generator<DomainNamespace> {
+    const foreignDomain = this.dependencies.get(namespace)
+    if (!foreignDomain) {
+      throw new Error(`Foreign domain ${namespace} not found`)
+    }
+    for (const node of foreignDomain.listNamespaces()) {
+      const key = `${namespace}:${node.key}`
+      const value = this.graph.node(key)
+      if (value) {
+        yield node
+      }
+    }
+  }
+
   /**
    * Checks if this data domain has any namespaces.
    *
@@ -661,8 +688,8 @@ export class DataDomain extends DependentModel {
    * @returns A generator that yields each `DomainModel`.
    * @example
    * ```typescript
-   * for (const ns of namespace.listModels()) {
-   *   console.log(ns.key);
+   * for (const model of namespace.listModels()) {
+   *   console.log(model.key);
    * }
    * ```
    */
@@ -679,6 +706,33 @@ export class DataDomain extends DependentModel {
     }
   }
 
+  /**
+   * Lists all models in the graph that are part of specified domain.
+   *
+   * @param namespace The foreign namespace to search in. When not found, it throws an error.
+   * @returns A generator that yields each `DomainModel`.
+   * @throws Error When the foreign domain is not found.
+   * @example
+   * ```typescript
+   * for (const model of dataDomain.listForeignModels('foreignDomainKey')) {
+   *   console.log(model.key);
+   * }
+   * ```
+   */
+  *listForeignModels(namespace: string): Generator<DomainModel> {
+    const foreignDomain = this.dependencies.get(namespace)
+    if (!foreignDomain) {
+      throw new Error(`Foreign domain ${namespace} not found`)
+    }
+    for (const node of foreignDomain.listModels()) {
+      const key = `${namespace}:${node.key}`
+      const value = this.graph.node(key)
+      if (value) {
+        yield node
+      }
+    }
+  }
+
   /**
    * Checks if this data domain has any direct models.
    *
@@ -893,10 +947,37 @@ export class DataDomain extends DependentModel {
     }
   }
 
+  /**
+   * Lists all entities in the graph that are part of specified domain.
+   *
+   * @param namespace The foreign namespace to search in. When not found, it throws an error.
+   * @returns A generator that yields each `DomainEntity`.
+   * @throws Error When the foreign domain is not found.
+   * @example
+   * ```typescript
+   * for (const model of dataDomain.listForeignEntities('foreignDomainKey')) {
+   *   console.log(model.key);
+   * }
+   * ```
+   */
+  *listForeignEntities(namespace: string): Generator<DomainEntity> {
+    const foreignDomain = this.dependencies.get(namespace)
+    if (!foreignDomain) {
+      throw new Error(`Foreign domain ${namespace} not found`)
+    }
+    for (const node of foreignDomain.listEntities()) {
+      const key = `${namespace}:${node.key}`
+      const value = this.graph.node(key)
+      if (value) {
+        yield node
+      }
+    }
+  }
+
   /**
    * Lists all entities in the graph that are not part of this domain.
    */
-  *listForeignEntities(): Generator<DomainEntity> {
+  *listAllForeignEntities(): Generator<DomainEntity> {
     for (const node of this.graph.nodes()) {
       const value = this.graph.node(node) as DomainGraphNodeType
       if (value.kind === DomainEntityKind && value.domain.key !== this.key) {

package/src/modeling/DomainElement.ts

@@ -39,6 +39,18 @@ export abstract class DomainElement implements DomainElementSchema {
     return this.#key
   }
 
+  #namespace: string
+
+  /**
+   * The key of the DataDomain this element belongs to.
+   * In a data domain that has foreign namespaces, this is the key of the namespace this element originally belongs to.
+   *
+   * It might be different from the `domain.key` if the element is a foreign object.
+   */
+  get namespace(): string {
+    return this.#namespace
+  }
+
   /**
    * @param root The root DataDomain instance.
    * @param key The unique key of the domain element.
@@ -46,5 +58,9 @@ export abstract class DomainElement implements DomainElementSchema {
   constructor(root: DataDomain, key: string) {
     this.root = root
     this.#key = key
+    // When dependencies are loaded, they all first belong to the root domain.
+    // When the foreign domain is merged, the object is transferred to the other domain,
+    // but the namespace is still the root domain key.
+    this.#namespace = root.key
   }
 }