@api-client/core 0.19.8 → 0.19.10

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

@@ -42810,16 +42810,16 @@
 "@id": "#219"
 },
 {
-"@id": "#219"
+"@id": "#213"
 },
 {
-"@id": "#216"
+"@id": "#210"
 },
 {
-"@id": "#210"
+"@id": "#216"
 },
 {
-"@id": "#213"
+"@id": "#219"
 }
 ],
 "doc:root": false,
@@ -44232,7 +44232,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": [
 {
@@ -44253,7 +44253,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: \"GENERAL\"\nvalue: \"www.company.be\"\n",
+"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '22'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)22 000000'\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": [
 {
@@ -44295,7 +44295,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '22'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)22 000000'\n",
+"doc:raw": "type: \"GENERAL\"\nvalue: \"www.company.be\"\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -45116,22 +45116,22 @@
 {
 "@id": "#212/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#212",
-"sourcemaps:value": "[(1,0)-(7,0)]"
+"sourcemaps:value": "[(1,0)-(6,0)]"
 },
 {
 "@id": "#215/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#215",
-"sourcemaps:value": "[(1,0)-(3,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",
 "sourcemaps:element": "amf://id#221",
-"sourcemaps:value": "[(1,0)-(6,0)]"
+"sourcemaps:value": "[(1,0)-(3,0)]"
 },
 {
 "@id": "#338/source-map/synthesized-field/element_1",

package/eslint.config.js

@@ -16,7 +16,6 @@ export const GLOBAL_IGNORE_LIST = [
   '.tmp/',
   '.rollup.cache/',
   '.vscode/',
-  '.wireit/',
   'amf-models/',
   'build/',
   'coverage/',

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.19.8",
+  "version": "0.19.10",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {
@@ -115,7 +115,6 @@
     "@japa/expect-type": "^2.0.3",
     "@japa/runner": "^5.3.0",
     "@pawel-up/semver": "^0.1.4",
-    "@rollup/plugin-typescript": "^12.1.2",
     "@types/chai-as-promised": "^8.0.2",
     "@types/cors": "^2.8.12",
     "@types/express-ntlm": "^2.3.3",
@@ -125,6 +124,7 @@
     "@types/node": "^25.0.6",
     "@types/sinon": "^21.0.0",
     "@web/dev-server": "^0.4.6",
+    "@web/dev-server-esbuild": "^1.0.5",
     "@web/dev-server-rollup": "^0.6.4",
     "@web/test-runner": "^0.20.0",
     "@web/test-runner-playwright": "^0.11.0",
@@ -151,143 +151,38 @@
     "ts-lit-plugin": "^2.0.2",
     "ts-node-maintained": "^10.9.5",
     "typescript": "^5.5.2",
-    "typescript-eslint": "^8.24.1",
-    "wireit": "^0.14.4"
+    "typescript-eslint": "^8.24.1"
   },
   "scripts": {
-    "build:browser": "wireit",
-    "build:ts": "wireit",
-    "build:node": "wireit",
+    "build:browser": "tsc --project tsconfig.browser.json",
+    "build:ts": "tsc --project tsconfig.json",
+    "build:node": "tsc --project tsconfig.node.json",
     "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",
-    "tsc:tests": "wireit",
-    "tsc:watch": "wireit",
-    "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",
+    "tsc": "tsc",
+    "tsc:tests": "tsc --project tsconfig.browser.json",
+    "tsc:watch": "tsc --watch --project tsconfig.json",
+    "test:browser": "wtr --playwright --browsers chromium",
+    "test:browser:watch": "wtr --watch --playwright --browsers chromium",
+    "test": "npm run test:node && npm run test:browser",
+    "test:coverage": "npm run test:node:coverage && npm run test:browser",
     "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",
     "build:api-models": "node data/model.js",
     "copy:assets": "cp -f ./oauth-popup.html ./build/oauth-popup.html",
     "start": "echo \"Use the npm run dev instead\"",
     "lint": "npm run lint:prettier && npm run lint:eslint",
-    "lint:eslint": "wireit",
-    "lint:prettier": "wireit",
+    "lint:eslint": "eslint --color --cache --cache-location .eslintcache .",
+    "lint:prettier": "prettier \"**/*.ts\" --check",
     "format": "npm run format:prettier && npm run format:prettier",
-    "format:prettier": "wireit",
-    "format:eslint": "wireit",
+    "format:prettier": "prettier \"**/*.ts\" --write",
+    "format:eslint": "eslint --color --cache --fix --cache-location .eslintcache .",
     "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": {
-      "command": "npm run test:node && npm run test:browser"
-    },
-    "test:coverage": {
-      "command": "npm run test:node:coverage && npm run test:browser"
-    },
-    "tsc:watch": {
-      "command": "tsc --watch --project tsconfig.json",
-      "files": [
-        "src/**/*.ts",
-        "tsconfig.json"
-      ],
-      "output": [
-        "build/**",
-        ".tsbuildinfo"
-      ]
-    },
-    "tsc": {
-      "command": "tsc",
-      "files": [
-        "src/**/*.ts",
-        "tsconfig.json"
-      ],
-      "output": [
-        "build/**",
-        ".tsbuildinfo"
-      ]
-    },
-    "tsc:tests": {
-      "command": "tsc --project tsconfig.browser.json",
-      "clean": "if-file-deleted",
-      "files": [
-        "src/**/*.ts",
-        "test/**/*.ts",
-        "tests/**/*.ts",
-        "tsconfig.browser.json"
-      ],
-      "output": [
-        ".tmp/**",
-        ".tmp/testing/tsconfig.browser.tsbuildinfo"
-      ]
-    },
-    "build:ts": {
-      "command": "tsc --project tsconfig.json",
-      "clean": "if-file-deleted",
-      "files": [
-        "src/**/*.ts",
-        "tsconfig.json"
-      ],
-      "output": [
-        "build/**",
-        "build/tsconfig.tsbuildinfo"
-      ]
-    },
-    "build:browser": {
-      "command": "tsc --project tsconfig.browser.json",
-      "clean": "if-file-deleted",
-      "files": [
-        "src/**/*.ts",
-        "test/**/*.ts",
-        "tsconfig.browser.json"
-      ],
-      "output": [
-        ".tmp/testing/**",
-        ".tmp/testing/tsconfig.browser.tsbuildinfo"
-      ]
-    },
-    "build:node": {
-      "command": "tsc --project tsconfig.node.json",
-      "clean": "if-file-deleted",
-      "files": [
-        "src/**/*.ts",
-        "tests/**/*.ts",
-        "tsconfig.node.json"
-      ],
-      "output": [
-        ".tmp/node/**",
-        ".tmp/node/tsconfig.node.tsbuildinfo"
-      ]
-    },
-    "lint:eslint": {
-      "command": "eslint --color --cache --cache-location .eslintcache .",
-      "files": [
-        "src/**/*.ts",
-        "eslint.config.js"
-      ],
-      "output": []
-    },
-    "lint:prettier": {
-      "command": "prettier \"**/*.ts\" --check"
-    },
-    "format:eslint": {
-      "command": "eslint --color --cache --fix --cache-location .eslintcache .",
-      "files": [
-        "src/**/*.ts",
-        "eslint.config.js"
-      ],
-      "output": []
-    },
-    "format:prettier": {
-      "command": "prettier \"**/*.ts\" --write"
-    }
-  },
   "lint-staged": {
     "*.ts": [
       "npm run format"

package/src/decorators/observed.ts

@@ -166,6 +166,75 @@ export function observed(config: ObserveConfig = {}): PropertyDecorator {
             return target
           }
           const value = Reflect.get(target, prop)
+          if (typeof value === 'function') {
+            if (target instanceof Map || target instanceof Set) {
+              if (['set', 'add', 'delete', 'clear'].includes(prop as string)) {
+                return (...args: any[]) => {
+                  if (prop === 'set' && (target as Map<any, any>).get(args[0]) === args[1]) {
+                    return target
+                  }
+                  if (prop === 'delete' && !target.has(args[0])) {
+                    return false
+                  }
+                  if (prop === 'clear' && target.size === 0) {
+                    return undefined
+                  }
+                  const result = value.apply(target, args)
+                  notifyChange()
+                  return result
+                }
+              }
+              if (prop === 'get') {
+                return (...args: any[]) => {
+                  const result = value.apply(target, args)
+                  return createDeepProxy.bind(targetObject)(result, notifyChange)
+                }
+              }
+              if (prop === 'values' || prop === 'keys' || prop === 'entries') {
+                return (...args: any[]) => {
+                  const iterator = value.apply(target, args)
+                  return {
+                    [Symbol.iterator]() {
+                      return this
+                    },
+                    next() {
+                      const result = iterator.next()
+                      if (result.done) return result
+                      if (prop === 'entries') {
+                        return {
+                          done: false,
+                          value: [result.value[0], createDeepProxy.bind(targetObject)(result.value[1], notifyChange)],
+                        }
+                      }
+                      if (prop === 'keys') {
+                        return result
+                      }
+                      return {
+                        done: false,
+                        value: createDeepProxy.bind(targetObject)(result.value, notifyChange),
+                      }
+                    },
+                  }
+                }
+              }
+              if (prop === 'forEach') {
+                return (callback: any, thisArg?: any) => {
+                  value.call(target, (val: any, k: any, m: any) => {
+                    callback.call(thisArg, createDeepProxy.bind(targetObject)(val, notifyChange), k, m)
+                  })
+                }
+              }
+              return value.bind(target)
+            }
+            if (
+              target instanceof WeakMap ||
+              target instanceof WeakSet ||
+              target instanceof Date ||
+              target instanceof RegExp
+            ) {
+              return value.bind(target)
+            }
+          }
           return createDeepProxy.bind(targetObject)(value, notifyChange)
         },
         set(target, prop, value) {
@@ -188,6 +257,28 @@ export function observed(config: ObserveConfig = {}): PropertyDecorator {
 
     if (kind === 'accessor') {
       return {
+        init(this: DomainInstance, initialValue: V): V {
+          let map = Reflect.get(this, reactiveSymbol)
+          if (!map) {
+            map = {}
+            Reflect.set(this, reactiveSymbol, map)
+          }
+          const notify = () => {
+            if (this.domain) {
+              this.domain.notifyChange()
+            } else if (this.notifyChange) {
+              this.notifyChange()
+            }
+          }
+          let value = initialValue
+          if (deep) {
+            value = createDeepProxy.bind(this)(initialValue, notify)
+          }
+          if (value !== undefined) {
+            map[context.name] = value
+          }
+          return value
+        },
         set(this: DomainInstance, value: V): void {
           let map = Reflect.get(this, reactiveSymbol)
           if (!map) {

package/src/modeling/ApiModel.ts

@@ -170,8 +170,10 @@ export class ApiModel extends DependentModel {
   /**
    * The specific subset of Data Entities to be exposed by this API.
    * These are the entities that are included in the data domain schema.
+   *
+   * The `key` is the key of the exposed entity. Using a Map to allow for quick lookups.
    */
-  @observed({ deep: true }) accessor exposes: ExposedEntity[]
+  @observed({ deep: true }) accessor exposes: Map<string, ExposedEntity>
   /**
    * Optional array of access rules that define the access control policies
    * for the API. These rules are used to enforce security and permissions
@@ -306,9 +308,9 @@ export class ApiModel extends DependentModel {
       this.session = structuredClone(init.session)
     }
     if (Array.isArray(init.exposes)) {
-      this.exposes = init.exposes.map((e) => new ExposedEntity(this, e))
+      this.exposes = new Map(init.exposes.map((e) => [e.key, new ExposedEntity(this, e)]))
     } else {
-      this.exposes = []
+      this.exposes = new Map()
     }
     if (Array.isArray(init.accessRule)) {
       this.accessRule = init.accessRule.map((rule) => restoreAccessRule(rule))
@@ -338,7 +340,7 @@ export class ApiModel extends DependentModel {
       kind: this.kind,
       key: this.key,
       info: this.info.toJSON(),
-      exposes: this.exposes.map((e) => e.toJSON()),
+      exposes: Array.from(this.exposes.values()).map((e) => e.toJSON()),
     }
     if (this.user) {
       result.user = { ...this.user }
@@ -408,9 +410,13 @@ export class ApiModel extends DependentModel {
       throw new Error(`No domain attached to API model`)
     }
     // checks whether the entity is already exposed as a root exposure.
-    const existing = this.exposes.find(
-      (e) => e.isRoot && e.entity.key === entity.key && e.entity.domain === entity.domain
-    )
+    let existing: ExposedEntity | undefined
+    for (const exp of this.exposes.values()) {
+      if (exp.isRoot && exp.entity.key === entity.key) {
+        existing = exp
+        break
+      }
+    }
     if (existing) {
       // quietly return the existing exposure
       // TBD: should we throw an error here?
@@ -428,7 +434,7 @@ export class ApiModel extends DependentModel {
     // Check for root path collision and resolve by appending a number
     let counter = 1
     const originalCollectionPath = relativeCollectionPath
-    while (this.exposes.some((e) => e.isRoot && e.collectionPath === relativeCollectionPath)) {
+    while (this.findCollectionPathCollision(relativeCollectionPath)) {
       relativeCollectionPath = `${originalCollectionPath}-${counter}`
       relativeResourcePath = `${relativeCollectionPath}/{id}`
       counter++
@@ -448,7 +454,7 @@ export class ApiModel extends DependentModel {
       newEntity.exposeOptions = { ...options }
     }
     const created = new ExposedEntity(this, newEntity)
-    this.exposes.push(created)
+    this.exposes.set(created.key, created)
 
     // Follow associations if requested
     if (options?.followAssociations) {
@@ -493,7 +499,13 @@ export class ApiModel extends DependentModel {
           }
 
           // Check if this entity is ALREADY exposed anywhere in the model
-          const existingExposure = this.getExposedEntity(target)
+          let existingExposure: ExposedEntity | undefined
+          for (const exp of this.exposes.values()) {
+            if (exp.entity.key === target.key) {
+              existingExposure = exp
+              break
+            }
+          }
 
           if (existingExposure) {
             // If it's already exposed and NOT root (i.e., it's currently a nested child of someone else),
@@ -509,7 +521,7 @@ export class ApiModel extends DependentModel {
 
                 let counter = 1
                 const originalCollectionPath = relativeCollectionPath
-                while (this.exposes.some((e) => e.isRoot && e.collectionPath === relativeCollectionPath)) {
+                while (this.findResourcePathCollision(relativeCollectionPath)) {
                   relativeCollectionPath = `${originalCollectionPath}-${counter}`
                   relativeResourcePath = `${relativeCollectionPath}/{id}`
                   counter++
@@ -556,7 +568,8 @@ export class ApiModel extends DependentModel {
             },
           }
 
-          this.exposes.push(new ExposedEntity(this, nestedExposure))
+          const inst = new ExposedEntity(this, nestedExposure)
+          this.exposes.set(inst.key, inst)
           if (depth + 1 >= maxDepth) {
             nestedExposure.truncated = true
           } else {
@@ -580,29 +593,25 @@ export class ApiModel extends DependentModel {
    * @param key The key of the exposed entity to remove.
    */
   removeExposedEntity(key: string): void {
-    const index = this.exposes.findIndex((e) => e.key === key)
-    if (index < 0) {
+    if (!this.exposes.has(key)) {
       throw new Error(`Exposed entity with key "${key}" not found.`)
     }
     this.removeWithChildren(key)
   }
 
   private removeWithChildren(key: string): void {
-    const index = this.exposes.findIndex((e) => e.key === key)
-    if (index < 0) {
+    if (!this.exposes.has(key)) {
       return
     }
     // Remove the parent itself
-    this.exposes.splice(index, 1)
+    this.exposes.delete(key)
     // Remove all children recursively
     const removeChildren = (parentKey: string) => {
       // Find all exposures whose parent.key matches parentKey
-      const children = this.exposes.filter((e) => e.parent?.key === parentKey)
-      for (const child of children) {
-        removeChildren(child.key)
-        const childIndex = this.exposes.findIndex((e) => e.key === child.key)
-        if (childIndex >= 0) {
-          this.exposes.splice(childIndex, 1)
+      for (const child of this.exposes.values()) {
+        if (child.parent?.key === parentKey) {
+          removeChildren(child.key)
+          this.exposes.delete(child.key)
         }
       }
     }
@@ -611,15 +620,6 @@ export class ApiModel extends DependentModel {
     this.notifyChange()
   }
 
-  /**
-   * Returns the exposed entity by its key.
-   * @param entityKey The key of the entity to find.
-   * @returns The exposed entity or undefined if not found.
-   */
-  getExposedEntity(entity: AssociationTarget): ExposedEntity | undefined {
-    return this.exposes.find((e) => e.entity.key === entity.key && e.entity.domain === entity.domain)
-  }
-
   /**
    * Clears the API model for a new data domain change.
    * This method resets the dependencies, exposes, user,
@@ -628,7 +628,7 @@ export class ApiModel extends DependentModel {
   cleanForDomainChange(): void {
     this.dependencies.clear()
     this.dependencyList = []
-    this.exposes = []
+    this.exposes = new Map()
     this.user = undefined
     if (this.session) {
       this.session.properties = []
@@ -659,4 +659,44 @@ export class ApiModel extends DependentModel {
     this.dependencyList = [{ key: domain.key, version: domain.info.version }]
     this.notifyChange()
   }
+
+  /**
+   * Finds an existing root exposed entity that has the given resource path.
+   * Useful for detecting path collisions when adding or updating an exposed entity.
+   *
+   * @param path The resource path to check for collisions.
+   * @param ignore Optional key of an exposed entity to ignore during the check (usually the entity being updated).
+   * @returns The colliding `ExposedEntity` if found, otherwise `undefined`.
+   */
+  findResourcePathCollision(path: string, ignore?: string): ExposedEntity | undefined {
+    for (const e of this.exposes.values()) {
+      if (ignore && e.key === ignore) {
+        continue
+      }
+      if (e.isRoot && e.resourcePath === path) {
+        return e
+      }
+    }
+    return undefined
+  }
+
+  /**
+   * Finds an existing root exposed entity that has the given collection path.
+   * Useful for detecting path collisions when adding or updating an exposed entity.
+   *
+   * @param path The collection path to check for collisions.
+   * @param ignore Optional key of an exposed entity to ignore during the check (usually the entity being updated).
+   * @returns The colliding `ExposedEntity` if found, otherwise `undefined`.
+   */
+  findCollectionPathCollision(path: string, ignore?: string): ExposedEntity | undefined {
+    for (const e of this.exposes.values()) {
+      if (ignore && e.key === ignore) {
+        continue
+      }
+      if (e.isRoot && e.hasCollection && e.collectionPath === path) {
+        return e
+      }
+    }
+    return undefined
+  }
 }

package/src/modeling/DomainValidation.ts

@@ -1,6 +1,6 @@
 import { DataDomainKind } from '../models/kinds.js'
 import { DataDomain } from './DataDomain.js'
-import { DomainImpactReport } from './types.js'
+import type { DomainImpactReport } from './types.js'
 import { AssociationValidation } from './validation/association_validation.js'
 import { EntityValidation } from './validation/entity_validation.js'
 import { PropertyValidation } from './validation/property_validation.js'