@api-client/core 0.18.2 → 0.18.3

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.2",
+  "version": "0.18.3",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {

package/src/modeling/ApiModel.ts

@@ -3,6 +3,7 @@ import { ApiModelKind, DataDomainKind } from '../models/kinds.js'
 import { type IThing, Thing } from '../models/Thing.js'
 import type {
   AccessRule,
+  AssociationTarget,
   AuthenticationConfiguration,
   AuthorizationConfiguration,
   ExposedEntity,
@@ -64,11 +65,11 @@ export interface ApiModelSchema extends DependentModelSchema {
 
   /**
    * The designated Data Entity that represents a "User".
-   * This entity must be marked with the "User" semantic in the Data Modeler.
+   * This entity should be marked with the "User" semantic in the Data Modeler.
    *
    * This property is required to publish the API.
    */
-  userKey?: string
+  user?: AssociationTarget
 
   /**
    * Configuration for how users prove their identity.
@@ -142,7 +143,7 @@ export class ApiModel extends DependentModel {
    *
    * This property is required to publish the API.
    */
-  userKey?: string
+  user?: AssociationTarget
 
   /**
    * Configuration for how users prove their identity.
@@ -232,8 +233,8 @@ export class ApiModel extends DependentModel {
       info,
       exposes,
     }
-    if (input.userKey) {
-      result.userKey = input.userKey
+    if (input.user) {
+      result.user = { ...input.user }
     }
     if (input.dependencyList) {
       result.dependencyList = structuredClone(input.dependencyList)
@@ -279,7 +280,7 @@ export class ApiModel extends DependentModel {
     this.kind = init.kind
     this.key = init.key
     this.info = new Thing(init.info)
-    this.userKey = init.userKey
+    this.user = init.user
     if (init.authentication) {
       this.authentication = structuredClone(init.authentication)
     }
@@ -322,8 +323,8 @@ export class ApiModel extends DependentModel {
       info: this.info.toJSON(),
       exposes: structuredClone(this.exposes),
     }
-    if (this.userKey) {
-      result.userKey = this.userKey
+    if (this.user) {
+      result.user = { ...this.user }
     }
     if (this.dependencyList.length > 0) {
       result.dependencyList = structuredClone(this.dependencyList)
@@ -414,14 +415,14 @@ export class ApiModel extends DependentModel {
 
   /**
    * Clears the API model for a new entity change.
-   * This method resets the dependencies, exposes, userKey,
+   * This method resets the dependencies, exposes, user,
    * authentication, authorization, and session properties.
    */
   cleanForEntityChange(): void {
     this.dependencies.clear()
     this.dependencyList = []
     this.exposes = []
-    this.userKey = undefined
+    this.user = undefined
     if (this.session) {
       this.session.properties = []
     }

package/tests/unit/modeling/api_model.spec.ts

@@ -21,7 +21,7 @@ test.group('ApiModel.createSchema()', (g) => {
     assert.isNotEmpty(schema.key)
     assert.deepInclude(schema.info, { name: 'Unnamed API' })
     assert.deepEqual(schema.exposes, [])
-    assert.isUndefined(schema.userKey)
+    assert.isUndefined(schema.user)
     assert.isUndefined(schema.dependencyList)
     assert.isUndefined(schema.authentication)
     assert.isUndefined(schema.authorization)
@@ -38,7 +38,7 @@ test.group('ApiModel.createSchema()', (g) => {
       key: 'test-api',
       info: { name: 'Test API', description: 'A test API' },
       exposes: [{ key: 'entity1', actions: [] }],
-      userKey: 'user-entity',
+      user: { key: 'user-entity' },
       dependencyList: [{ key: 'domain1', version: '1.0.0' }],
       authentication: { strategy: 'UsernamePassword' },
       authorization: { strategy: 'RBAC', roleKey: 'role' } as RolesBasedAccessControl,
@@ -55,7 +55,7 @@ test.group('ApiModel.createSchema()', (g) => {
     assert.equal(schema.key, 'test-api')
     assert.deepInclude(schema.info, { name: 'Test API', description: 'A test API' })
     assert.deepEqual(schema.exposes, [{ key: 'entity1', actions: [] }])
-    assert.equal(schema.userKey, 'user-entity')
+    assert.deepEqual(schema.user, { key: 'user-entity' })
     assert.deepEqual(schema.dependencyList, [{ key: 'domain1', version: '1.0.0' }])
     assert.deepEqual(schema.authentication, { strategy: 'UsernamePassword' })
     assert.deepEqual(schema.authorization, { strategy: 'RBAC', roleKey: 'role' })
@@ -90,7 +90,7 @@ test.group('ApiModel.constructor()', (g) => {
     assert.isNotEmpty(model.key)
     assert.equal(model.info.name, 'Unnamed API')
     assert.deepEqual(model.exposes, [])
-    assert.isUndefined(model.userKey)
+    assert.isUndefined(model.user)
     assert.isUndefined(model.authentication)
     assert.isUndefined(model.authorization)
     assert.isUndefined(model.session)
@@ -108,7 +108,7 @@ test.group('ApiModel.constructor()', (g) => {
       key: 'test-api',
       info: { name: 'Test API', description: 'A test API' },
       exposes: [{ key: 'entity1', actions: [] }],
-      userKey: 'user-entity',
+      user: { key: 'user-entity' },
       dependencyList: [{ key: 'domain1', version: '1.0.0' }],
       authentication: { strategy: 'UsernamePassword' },
       authorization: { strategy: 'RBAC', roleKey: 'role' } as RolesBasedAccessControl,
@@ -124,7 +124,7 @@ test.group('ApiModel.constructor()', (g) => {
     assert.equal(model.key, 'test-api')
     assert.equal(model.info.name, 'Test API')
     assert.deepEqual(model.exposes, [{ key: 'entity1', actions: [] }])
-    assert.equal(model.userKey, 'user-entity')
+    assert.deepEqual(model.user, { key: 'user-entity' })
     assert.deepEqual(model.dependencyList, [{ key: 'domain1', version: '1.0.0' }])
     assert.deepEqual(model.authentication, { strategy: 'UsernamePassword' })
     assert.deepEqual(model.authorization, { strategy: 'RBAC', roleKey: 'role' })
@@ -172,7 +172,7 @@ test.group('ApiModel.toJSON()', (g) => {
     assert.equal(json.key, model.key)
     assert.deepInclude(json.info, { name: 'Unnamed API' })
     assert.deepEqual(json.exposes, [])
-    assert.isUndefined(json.userKey)
+    assert.isUndefined(json.user)
     assert.isUndefined(json.dependencyList)
     assert.isUndefined(json.authentication)
     assert.isUndefined(json.authorization)
@@ -190,7 +190,7 @@ test.group('ApiModel.toJSON()', (g) => {
       key: 'test-api',
       info: { name: 'Test API', description: 'A test API' },
       exposes: [{ key: 'entity1', actions: [] }],
-      userKey: 'user-entity',
+      user: { key: 'user-entity' },
       dependencyList: [{ key: 'domain1', version: '1.0.0' }],
       authentication: { strategy: 'UsernamePassword' },
       authorization: { strategy: 'RBAC', roleKey: 'role' } as RolesBasedAccessControl,
@@ -207,7 +207,7 @@ test.group('ApiModel.toJSON()', (g) => {
     assert.equal(json.key, 'test-api')
     assert.deepInclude(json.info, { name: 'Test API', description: 'A test API' })
     assert.deepEqual(json.exposes, [{ key: 'entity1', actions: [] }])
-    assert.equal(json.userKey, 'user-entity')
+    assert.deepEqual(json.user, { key: 'user-entity' })
     assert.deepEqual(json.dependencyList, [{ key: 'domain1', version: '1.0.0' }])
     assert.deepEqual(json.authentication, { strategy: 'UsernamePassword' })
     assert.deepEqual(json.authorization, { strategy: 'RBAC', roleKey: 'role' })