@api-client/core 0.12.0 → 0.12.2

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

@@ -41728,13 +41728,13 @@
 "@id": "#194"
 },
 {
-"@id": "#197"
+"@id": "#200"
 },
 {
-"@id": "#203"
+"@id": "#197"
 },
 {
-"@id": "#200"
+"@id": "#203"
 },
 {
 "@id": "#206"
@@ -42470,16 +42470,16 @@
 "@id": "#219"
 },
 {
-"@id": "#219"
+"@id": "#210"
 },
 {
-"@id": "#216"
+"@id": "#213"
 },
 {
-"@id": "#210"
+"@id": "#216"
 },
 {
-"@id": "#213"
+"@id": "#219"
 }
 ],
 "doc:root": false,
@@ -43138,7 +43138,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "code: '5'\ndescription: 'Limited company'\n",
+"doc:raw": "class: '3'\ndescription: '150 - 300'\nnumberOfFte: 5500\nnumberOfEmployees: 5232\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43159,7 +43159,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "code: 'J'\ndescription: 'Information and communication'\n",
+"doc:raw": "code: '5'\ndescription: 'Limited company'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43180,7 +43180,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "class: '3'\ndescription: '150 - 300'\nnumberOfFte: 5500\nnumberOfEmployees: 5232\n",
+"doc:raw": "code: 'J'\ndescription: 'Information and communication'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43892,7 +43892,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 : '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": "type: \"GENERAL\"\nvalue: \"www.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 : '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": [
 {
@@ -43955,7 +43955,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": [
 {
@@ -44426,7 +44426,7 @@
 {
 "@id": "#199/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#199",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(5,0)]"
 },
 {
 "@id": "#202/source-map/lexical/element_0",
@@ -44436,7 +44436,7 @@
 {
 "@id": "#205/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#205",
-"sourcemaps:value": "[(1,0)-(5,0)]"
+"sourcemaps:value": "[(1,0)-(3,0)]"
 },
 {
 "@id": "#208/source-map/lexical/element_0",
@@ -44776,22 +44776,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/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.12.0",
+  "version": "0.12.2",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {

package/src/amf/AmfShapeGenerator.ts

@@ -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'
 
@@ -318,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,
@@ -330,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/DataValueGenerator.ts

@@ -1,5 +1,5 @@
+import { nanoid } from 'nanoid'
 import uuidV4 from '../lib/uuid.js'
-import { randomString } from '../lib/math/Random.js'
 import { DomainPropertyType } from '../modeling/DataFormat.js'
 
 export const noValue = Symbol('noValue')
@@ -53,7 +53,8 @@ export class DataValueGenerator {
   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:

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/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/DataDomain.ts

@@ -1,4 +1,4 @@
-import v4 from '../lib/uuid.js'
+import { nanoid } from 'nanoid'
 import { Graph } from '@api-client/graph'
 import {
   DomainAssociationKind,
@@ -165,8 +165,7 @@ export class DataDomain extends EventTarget {
   accessor fields: NamespaceOrderedItem[]
 
   static createSchema(input: Partial<DataDomainSchema> = {}): DataDomainSchema {
-    // We have to stay with UUID for data domains as the API expects it for File keys.
-    const { key = v4(), fields } = input
+    const { key = nanoid(), fields } = input
     const info = Thing.fromJSON(input.info, { name: 'Unnamed domain' }).toJSON()
     const result: DataDomainSchema = {
       kind: DataDomainKind,
@@ -869,6 +868,18 @@ export class DataDomain extends EventTarget {
     }
   }
 
+  /**
+   * Lists all entities in the graph that are not part of this domain.
+   */
+  *listForeignEntities(): 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) {
+        yield value
+      }
+    }
+  }
+
   /**
    * Finds an entity by its key.
    *

package/src/modeling/DomainAssociation.ts

@@ -150,7 +150,7 @@ export class DomainAssociation extends DomainElement {
    */
   static createSchema(input: Partial<DomainAssociationSchema> = {}): DomainAssociationSchema {
     const { key = nanoid() } = input
-    const info = Thing.fromJSON(input.info, { name: 'New association' }).toJSON()
+    const info = Thing.fromJSON(input.info, { name: 'new_association' }).toJSON()
     const result: DomainAssociationSchema = {
       kind: DomainAssociationKind,
       key,

package/src/modeling/DomainEntity.ts

@@ -92,6 +92,35 @@ export interface DomainEntitySchema extends DomainElementSchema {
  * const userModel = dataDomain.addModel({ key: 'userModel' });
  * const userEntity = userModel.addEntity({ key: 'user' });
  * ```
+ *
+ * Entity Validation Rules:
+ *
+ * - **Primary Key:** An entity must have a primary key selected. This can come from a parent
+ *   entity or be defined in the current entity.
+ * - **Parent Entity:** The parent entity must exist in the graph.
+ * - **Circular Dependency:** Adding a parent entity that creates a circular dependency is not allowed.
+ * - **Unique Parent:** An entity cannot have the same parent more than once.
+ * - **Property Shadowing:** A property can shadow a parent property. This means that if a property
+ *   with the same key exists in both the parent and child entity, the child property will take precedence.
+ * - **Association Shadowing:** An association can shadow a parent association. This means that if an
+ *   association with the same key exists in both the parent and child entity,
+ *   the child association will take precedence.
+ * - **Property Resolution:** When the same property exists more than one parent and the child entity,
+ *   doesn't explicitly define the property, then:
+ *   - The last parent entity (iterating from the first entity to the last) that has the property
+ *     will be used as the source of the property.
+ * - **Association Resolution:** When the same association exists more than one parent and the child entity,
+ *   doesn't explicitly define the association, then:
+ *   - The last parent entity (iterating from the first entity to the last) that has the association
+ *     will be used as the source of the association.
+ * - **Minimum Required Properties:** An entity must have at least one property defined. Entities without properties
+ *   are ignored in the system.
+ * - **Entity Name**:
+ *   - An entity must have a name defined.
+ *   - The name has to follow the same rules as the names in a SQL database. This means that the name must be unique
+ *     within the data domain and cannot contain special characters.
+ * - **Association Targets:** An association must have a target entity defined.
+ *   This means that the association must point to at least one entity.
  */
 export class DomainEntity extends DomainElement {
   /**
@@ -291,6 +320,13 @@ export class DomainEntity extends DomainElement {
     this.root.notifyChange()
   }
 
+  /**
+   * A shortcut to `listProperties()`.
+   */
+  get properties(): Generator<DomainProperty> {
+    return this.listProperties()
+  }
+
   /**
    * Lists all properties of this entity.
    *
@@ -333,6 +369,13 @@ export class DomainEntity extends DomainElement {
     return this.fields.some((item) => item.type === 'property')
   }
 
+  /**
+   * A shortcut to `listParents()`.
+   */
+  get parents(): Generator<DomainEntity> {
+    return this.listParents()
+  }
+
   /**
    * Lists all parent entities of this entity.
    *
@@ -622,6 +665,13 @@ export class DomainEntity extends DomainElement {
     this.root.notifyChange()
   }
 
+  /**
+   * A shortcut to `listAssociations()`.
+   */
+  get associations(): Generator<DomainAssociation> {
+    return this.listAssociations()
+  }
+
   /**
    * Lists all associations of this entity.
    *
@@ -766,4 +816,29 @@ export class DomainEntity extends DomainElement {
     }
     return parent.isChildOf(key)
   }
+
+  /**
+   * Finds the primary key property of this entity.
+   * @returns The primary key property of this entity or undefined if not found.
+   */
+  primaryKey(): DomainProperty | undefined {
+    for (const property of this.properties) {
+      if (property.primary) {
+        return property
+      }
+    }
+    let property: DomainProperty | undefined
+    for (const parent of this.listParents()) {
+      const prop = parent.primaryKey()
+      if (prop) {
+        // According to the validation rules, the last parent
+        // that has the property will be used as the source of
+        // the property.
+        // In the future, we may add a schema definition to the entity that
+        // will explicitly define which property to use.
+        property = prop
+      }
+    }
+    return property
+  }
 }

package/src/modeling/DomainFile.ts

@@ -1,4 +1,4 @@
-import v4 from '../lib/uuid.js'
+import { nanoid } from 'nanoid'
 import { File, type IFile } from '../models/store/File.js'
 import { Thing } from '../models/Thing.js'
 import type { DataDomain, DataDomainSchema } from './DataDomain.js'
@@ -55,7 +55,7 @@ export class DomainFile extends File {
     } else {
       init = {
         kind: DomainFileKind,
-        key: v4(),
+        key: nanoid(),
         organization: '',
         info: Thing.fromName('').toJSON(),
         parents: [],