@api-client/core 0.11.11 → 0.12.1

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

@@ -42470,15 +42470,15 @@
 "@id": "#219"
 },
 {
-"@id": "#216"
-},
-{
 "@id": "#210"
 },
 {
 "@id": "#213"
 },
 {
+"@id": "#216"
+},
+{
 "@id": "#219"
 }
 ],
@@ -43892,7 +43892,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": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '22'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)22 000000'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43913,7 +43913,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": [
 {
@@ -43934,7 +43934,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": "-\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": [
 {
@@ -44781,12 +44781,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/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.11",
+  "version": "0.12.1",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {
@@ -49,15 +49,16 @@
     "url": "https://github.com/api-client/core/issues"
   },
   "dependencies": {
+    "@api-client/graph": "^0.3.5",
     "@api-client/json": "^0.2.0",
     "@esm-bundle/chai": "^4.3.4-fix.0",
-    "@material/web": "^2.2.0",
     "@metrichor/jmespath": "^0.3.1",
     "@pawel-up/data-mock": "^0.3.2",
     "@pawel-up/jexl": "^3.0.0",
     "@xmldom/xmldom": "^0.9.7",
     "amf-json-ld-lib": "^0.0.15",
     "console-table-printer": "^2.11.2",
+    "nanoid": "^5.1.5",
     "ws": "^8.12.0",
     "xpath": "^0.0.34"
   },
@@ -107,8 +108,9 @@
     "wireit": "^0.14.4"
   },
   "scripts": {
-    "build:test": "wireit",
+    "build:browser": "wireit",
     "build:ts": "wireit",
+    "build:node": "wireit",
     "build": "npm run build:ts && npm run lint && npm run copy:assets",
     "lint": "wireit",
     "lint:old": "tsc --noEmit && eslint \"**/*.{js,ts}\" --quiet --fix",
@@ -125,8 +127,7 @@
     "test:node:watch": "node --import ts-node-maintained/register/esm --enable-source-maps bin/test.ts --watch",
     "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\"",
-    "dev": "node --import ts-node-maintained/register/esm --enable-source-maps bin/dev.ts --watch"
+    "start": "echo \"Use the npm run dev instead\""
   },
   "wireit": {
     "test": {
@@ -183,7 +184,7 @@
         ".tsbuildinfo"
       ]
     },
-    "build:test": {
+    "build:browser": {
       "command": "tsc --project tsconfig.browser.json",
       "clean": "if-file-deleted",
       "files": [
@@ -196,6 +197,19 @@
         ".tsbuildinfo"
       ]
     },
+    "build:node": {
+      "command": "tsc --project tsconfig.node.json",
+      "clean": "if-file-deleted",
+      "files": [
+        "src/**/*.ts",
+        "tests/**/*.ts",
+        "tsconfig.node.json"
+      ],
+      "output": [
+        ".tmp/node/**",
+        ".tsbuildinfo"
+      ]
+    },
     "lint": {
       "command": "eslint --color --cache --cache-location .eslintcache .",
       "files": [

package/readme.md

@@ -54,7 +54,7 @@ Tasks planned for the future releases.
 
 WTC can't work in watch mode with Typescript projects with `concurently`. Because of that, we need two processes running:
 
-- `npm run build:test:watch` to start TSC for tests in the watch mode.
+- `npm run build:watch` to start TSC for tests in the watch mode.
 - `npm run test:watch-only` to start the WTR process.
 
 It has a downside of not seeing both outputs at the same time so make sure you check the TSC output for errors.

package/src/amf/AmfShapeGenerator.ts

@@ -1,7 +1,7 @@
 import { type PropertyWebBindings } from '../modeling/Bindings.js'
-import { DataAssociation } from '../modeling/DataAssociation.js'
-import { DataEntity } from '../modeling/DataEntity.js'
-import { DataProperty, type DataPropertySchema } from '../modeling/DataProperty.js'
+import { DataAssociation } from '../modeling/legacy/DataAssociation.js'
+import { DataEntity } from '../modeling/legacy/DataEntity.js'
+import { DataProperty, type DataPropertySchema } from '../modeling/legacy/DataProperty.js'
 import { IAmfExampleTypes, modelTypeToAmfDataType } from './AmfTypes.js'
 import { AmfNamespace } from './definitions/Namespace.js'
 import {
@@ -25,7 +25,7 @@ import {
   unionShape,
 } from './definitions/Shapes.js'
 import { AmfDataNode } from './models/AmfDataNode.js'
-import v4 from '../lib/uuid.js'
+import { nanoid } from 'nanoid'
 import { DataEntityKind, DataPropertyKind } from '../models/kinds.js'
 import { DataValueGenerator } from './DataValueGenerator.js'
 
@@ -34,6 +34,9 @@ import { DataValueGenerator } from './DataValueGenerator.js'
  *
  * This is used when defining entities (according to the `DataEntity` schema)
  *  and then we want to translate this into AMF shapes.
+ *
+ * @deprecated This class refers to the deprecated old data domain model.
+ * Use the `ShapeGenerator` with the new domain model.
  */
 export class AmfShapeGenerator {
   #valueGenerator?: DataValueGenerator
@@ -253,7 +256,7 @@ export class AmfShapeGenerator {
       const { value } = schema.defaultValue
       if (dfFormat === 'function') {
         const tmp = this.valueGenerator.generate(value, input.type)
-        if (tmp !== DataValueGenerator.novalue) {
+        if (tmp !== DataValueGenerator.noValue) {
           const dt = AmfDataNode.scalar(tmp as string, dfFormat)
           result.defaultValue = dt.toJSON()
         }
@@ -315,7 +318,7 @@ export class AmfShapeGenerator {
     return examples.map((current) => {
       const value = AmfDataNode.scalar(current, type).toJSON()
       const item: IApiDataExample = {
-        id: v4(),
+        id: nanoid(),
         customDomainProperties: [],
         strict: true,
         types: IAmfExampleTypes,
@@ -327,7 +330,7 @@ export class AmfShapeGenerator {
 
   protected _generateArrayExamples(examples: string[], type: string): IApiDataExample[] {
     const item: IApiDataExample = {
-      id: v4(),
+      id: nanoid(),
       customDomainProperties: [],
       strict: true,
       types: IAmfExampleTypes,

package/src/amf/AmfTypes.ts

@@ -1,4 +1,4 @@
-import { type DataPropertyType } from '../modeling/DataFormat.js'
+import { type DomainPropertyType } from '../modeling/DataFormat.js'
 import { PropertyWebBindings } from '../modeling/Bindings.js'
 import { AmfNamespace } from './definitions/Namespace.js'
 
@@ -107,7 +107,7 @@ export const IAmfExampleTypes = [
  * @param type The property data type
  * @returns AMF shape dataType
  */
-export function modelTypeToAmfDataType(type: DataPropertyType, bindings?: PropertyWebBindings): string {
+export function modelTypeToAmfDataType(type: DomainPropertyType, bindings?: PropertyWebBindings): string {
   if (type === 'number') {
     if (bindings?.format === 'int32' || bindings?.format === 'int64') {
       return AmfNamespace.w3.xmlSchema.integer

package/src/amf/DataValueGenerator.ts

@@ -1,8 +1,8 @@
+import { nanoid } from 'nanoid'
 import uuidV4 from '../lib/uuid.js'
-import { randomString } from '../lib/math/Random.js'
-import { DataPropertyType } from '../modeling/DataFormat.js'
+import { DomainPropertyType } from '../modeling/DataFormat.js'
 
-export const novalue = Symbol('novalue')
+export const noValue = Symbol('noValue')
 
 /**
  * A class to be used for generating values from pre-defined functions.
@@ -18,15 +18,15 @@ export class DataValueGenerator {
    * A symbol representing the absence of a value.
    * Used as a return value when a function cannot generate a value of the requested type.
    */
-  static readonly novalue = novalue
+  static readonly noValue = noValue
 
   /**
    * Generates a value based on the provided function name and data type.
    * @param fn The name of the function to use for value generation (e.g., 'random', 'uuid-v4', 'incremental').
    * @param type The data type of the value to generate (e.g., 'string', 'number', 'date', 'time', 'datetime').
-   * @returns The generated value, or the `novalue` symbol if the function or type is not supported.
+   * @returns The generated value, or the `noValue` symbol if the function or type is not supported.
    */
-  generate(fn: string, type: DataPropertyType): string | typeof novalue {
+  generate(fn: string, type: DomainPropertyType): string | typeof noValue {
     if (type === 'string') {
       return this.generateString(fn)
     }
@@ -42,36 +42,37 @@ export class DataValueGenerator {
     if (type === 'datetime') {
       return this.generateDateTime(fn)
     }
-    return novalue
+    return noValue
   }
 
   /**
    * Generates a string value based on the function name.
    * @param fn The name of the string generation function.
-   * @returns The generated string value, or `novalue` if the function is not supported.
+   * @returns The generated string value, or `noValue` if the function is not supported.
    */
-  protected generateString(fn: string): string | typeof novalue {
+  protected generateString(fn: string): string | typeof noValue {
     switch (fn) {
       case 'random':
-        return randomString(8)
+        // TODO: we need more settings controlling the random string generation.
+        return nanoid(8)
       case 'uuid-v4':
         return uuidV4()
       default:
-        return novalue
+        return noValue
     }
   }
 
   /**
    * Generates a number value based on the function name.
    * @param fn The name of the number generation function.
-   * @returns The generated number value (as a string), or `novalue` if the function is not supported.
+   * @returns The generated number value (as a string), or `noValue` if the function is not supported.
    */
-  protected generateNumber(fn: string): string | typeof novalue {
+  protected generateNumber(fn: string): string | typeof noValue {
     switch (fn) {
       case 'incremental':
         return `${this.increment++}`
       default:
-        return novalue
+        return noValue
     }
   }
 
@@ -79,9 +80,9 @@ export class DataValueGenerator {
    * Generates a date value based on the function name.
    * @param fn The name of the date generation function.
    * @returns The generated date value (as a string in YYYY-MM-DD format),
-   * or `novalue` if the function is not supported.
+   * or `noValue` if the function is not supported.
    */
-  protected generateDate(fn: string): string | typeof novalue {
+  protected generateDate(fn: string): string | typeof noValue {
     if (fn === 'now') {
       // Returns YYYY-MM-DD
       // @TODO: Replace with Temporal when widely available.
@@ -91,15 +92,15 @@ export class DataValueGenerator {
       const day = `${d.getDate()}`.padStart(2, '0')
       return `${year}-${month}-${day}`
     }
-    return novalue
+    return noValue
   }
 
   /**
    * Generates a time value based on the function name.
    * @param fn The name of the time generation function.
-   * @returns The generated time value (as a string in HH:mm:ss format), or `novalue` if the function is not supported.
+   * @returns The generated time value (as a string in HH:mm:ss format), or `noValue` if the function is not supported.
    */
-  protected generateTime(fn: string): string | typeof novalue {
+  protected generateTime(fn: string): string | typeof noValue {
     if (fn === 'now') {
       // Returns HH:mm:ss
       // @TODO: Replace with Temporal when widely available.
@@ -109,16 +110,16 @@ export class DataValueGenerator {
       const second = `${d.getSeconds()}`.padStart(2, '0')
       return `${hour}:${minute}:${second}`
     }
-    return novalue
+    return noValue
   }
 
   /**
    * Generates a datetime value based on the function name.
    * @param fn The name of the datetime generation function.
    * @returns The generated datetime value (as a string in YYYY-MM-DDTHH:mm:ss format),
-   * or `novalue` if the function is not supported.
+   * or `noValue` if the function is not supported.
    */
-  protected generateDateTime(fn: string): string | typeof novalue {
+  protected generateDateTime(fn: string): string | typeof noValue {
     if (fn === 'now') {
       // Returns YYYY-MM-DDTHH:mm:ss
       // @TODO: Replace with Temporal when widely available.
@@ -131,6 +132,6 @@ export class DataValueGenerator {
       const second = `${d.getSeconds()}`.padStart(2, '0')
       return `${year}-${month}-${day}T${hour}:${minute}:${second}`
     }
-    return novalue
+    return noValue
   }
 }

package/src/amf/models/AmfDataNode.ts

@@ -1,4 +1,4 @@
-import v4 from '../../lib/uuid.js'
+import { nanoid } from 'nanoid'
 import { IAmfArrayNodeTypes, IAmfObjectNodeTypes, IAmfScalarNodeTypes } from '../AmfTypes.js'
 import { IApiCustomDomainProperty } from '../definitions/Base.js'
 import { AmfNamespace } from '../definitions/Namespace.js'
@@ -16,7 +16,7 @@ export type IDataNodeInit = 'scalar' | 'object' | 'array'
  * A class that manipulates the AMF's DataNode node.
  */
 export class AmfDataNode {
-  id = v4()
+  id = nanoid()
 
   /**
    * AMF domain types.

package/src/exceptions/attach_exception.ts

@@ -0,0 +1,11 @@
+import { Exception } from './exception.js'
+
+/**
+ * A generic exception for attaching objects.
+ */
+export class AttachException extends Exception {
+  static override code = 'E_ATTACH'
+  static override status = 500
+  static override message = 'Error attaching the object.'
+  static override help = 'Make sure you are attaching the right object.'
+}

package/src/exceptions/detach_exception.ts

@@ -0,0 +1,11 @@
+import { Exception } from './exception.js'
+
+/**
+ * A generic exception for detaching objects.
+ */
+export class DetachException extends Exception {
+  static override code = 'E_DETACH'
+  static override status = 500
+  static override message = 'Error detaching the object.'
+  static override help = 'Make sure you are detaching the right object.'
+}

package/src/exceptions/remove_model_exception.ts

@@ -0,0 +1,8 @@
+import { Exception } from './exception.js'
+
+export class RemoveModelException extends Exception {
+  static override code = 'E_REMOVE_MODEL'
+  static override status = 500
+  static override message = 'Error removing a domain model.'
+  static override help = 'Make sure the model exists and can be removed.'
+}

package/src/exceptions/remove_namespace_exception.ts

@@ -0,0 +1,8 @@
+import { Exception } from './exception.js'
+
+export class RemoveNamespaceException extends Exception {
+  static override code = 'E_REMOVE_NAMESPACE'
+  static override status = 500
+  static override message = 'Error removing a domain namespace.'
+  static override help = 'Make sure the namespace exists and can be removed.'
+}

package/src/lib/uuid.ts

@@ -8,7 +8,7 @@ for (let i = 0; i < 256; i++) {
  *
  * @see http://stackoverflow.com/a/21963136/1127848
  * @example "92329D39-6F5C-4520-ABFC-AAB64544E172"
- * @return {string} Generated value
+ * @return Generated value
  */
 export default function v4(): string {
   const d0 = (Math.random() * 0xffffffff) | 0

package/src/mocking/lib/History.ts

@@ -106,7 +106,7 @@ export class History {
     } else if (Array.isArray(init.user)) {
       result.user = this.random.pickOne(init.user)
     } else {
-      result.user = this.types.uuid()
+      result.user = this.types.string(21)
     }
 
     if (typeof init.project === 'string') {
@@ -114,7 +114,7 @@ export class History {
     } else if (Array.isArray(init.project)) {
       result.project = this.random.pickOne(init.project)
     } else if (init.project) {
-      result.project = this.types.uuid()
+      result.project = this.types.string(21)
     }
 
     if (typeof init.request === 'string') {
@@ -122,7 +122,7 @@ export class History {
     } else if (Array.isArray(init.request)) {
       result.request = this.random.pickOne(init.request)
     } else if (init.request) {
-      result.request = this.types.uuid()
+      result.request = this.types.string(21)
     }
 
     if (typeof init.app === 'string') {
@@ -130,7 +130,7 @@ export class History {
     } else if (Array.isArray(init.app)) {
       result.app = this.random.pickOne(init.app)
     } else if (init.app) {
-      result.app = this.types.uuid()
+      result.app = this.types.string(21)
     }
     return result
   }
@@ -141,7 +141,7 @@ export class History {
     if (usersSize && typeof init.user === 'undefined') {
       const users: string[] = []
       for (let i = 0; i < usersSize; i++) {
-        users.push(this.types.uuid())
+        users.push(this.types.string(21))
       }
       copy.user = users
     }
@@ -155,21 +155,21 @@ export class History {
     if (projectsSize && typeof init.project === 'undefined') {
       const project: string[] = []
       for (let i = 0; i < projectsSize; i++) {
-        project.push(this.types.uuid())
+        project.push(this.types.string(21))
       }
       copy.project = project
     }
     if (requestsSize && typeof init.request === 'undefined') {
       const requests: string[] = []
       for (let i = 0; i < requestsSize; i++) {
-        requests.push(this.types.uuid())
+        requests.push(this.types.string(21))
       }
       copy.request = requests
     }
     if (appsSize && typeof init.app === 'undefined') {
       const apps: string[] = []
       for (let i = 0; i < appsSize; i++) {
-        apps.push(this.types.uuid())
+        apps.push(this.types.string(21))
       }
       copy.app = apps
     }

package/src/mocking/lib/HostRules.ts

@@ -17,7 +17,7 @@ export class HostRules {
    */
   rule(): IHostRule {
     const result: IHostRule = {
-      key: this.types.uuid(),
+      key: this.types.string(21),
       from: this.internet.uri(),
       to: this.internet.uri(),
       enabled: this.types.boolean(),

package/src/mocking/lib/User.ts

@@ -23,7 +23,7 @@ export class User {
   user(init: IUserInit = {}): IUser {
     const result: IUser = {
       kind: UserKind,
-      key: this.types.uuid(),
+      key: this.types.string(21),
       name: this.person.name(),
     }
     if (!init.noEmail) {
@@ -41,7 +41,7 @@ export class User {
     }
     if (!init.noProvider) {
       result.provider = {
-        refreshToken: this.types.uuid(),
+        refreshToken: this.types.string(21),
       }
     }
     return result

package/src/modeling/Bindings.ts

@@ -1,5 +1,5 @@
 import { IApiXmlSerializer } from '../amf/definitions/Shapes.js'
-import { DataPropertyFormat } from './DataFormat.js'
+import { DomainPropertyFormat } from './DataFormat.js'
 
 interface Binding {
   /**
@@ -61,7 +61,7 @@ export interface PropertyWebBindings {
   /**
    * The format specifying the property data type.
    */
-  format?: DataPropertyFormat
+  format?: DomainPropertyFormat
   /**
    * When set it overrides the `name` of the property.
    */