@api-client/core 0.18.52 → 0.18.54

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

@@ -42068,10 +42068,10 @@
 "@id": "#194"
 },
 {
-"@id": "#200"
+"@id": "#197"
 },
 {
-"@id": "#197"
+"@id": "#200"
 },
 {
 "@id": "#203"
@@ -42810,16 +42810,16 @@
 "@id": "#219"
 },
 {
-"@id": "#219"
+"@id": "#210"
 },
 {
-"@id": "#210"
+"@id": "#216"
 },
 {
 "@id": "#213"
 },
 {
-"@id": "#216"
+"@id": "#219"
 }
 ],
 "doc:root": false,
@@ -43478,7 +43478,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "class: '3'\ndescription: '150 - 300'\nnumberOfFte: 5500\nnumberOfEmployees: 5232\n",
+"doc:raw": "code: '5'\ndescription: 'Limited company'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43499,7 +43499,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": [
 {
@@ -44232,7 +44232,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": [
 {
@@ -44274,7 +44274,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": [
 {
@@ -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": [
 {
@@ -44766,12 +44766,12 @@
 {
 "@id": "#199/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#199",
-"sourcemaps:value": "[(1,0)-(5,0)]"
+"sourcemaps:value": "[(1,0)-(3,0)]"
 },
 {
 "@id": "#202/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#202",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(5,0)]"
 },
 {
 "@id": "#205/source-map/lexical/element_0",
@@ -45126,12 +45126,12 @@
 {
 "@id": "#218/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#218",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(6,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.18.52",
+  "version": "0.18.54",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {

package/src/amf/definitions/Shapes.ts

@@ -26,7 +26,7 @@ export type IShapeUnion =
 
 export interface IApiAssociationShape {
   /**
-   * This is custom property not available in AMF and used with data associations.
+   * This is a custom property that not available in the AMF library and is used with data associations.
    *
    * Whether the target entity should be embedded under the property name.
    * When false, this association is just an information that one entity depend on another.

package/src/modeling/Semantics.ts

@@ -71,6 +71,12 @@ export enum SemanticType {
    * we may add more automation related to the `title` property in the future.
    */
   Title = 'Semantic#Title',
+  /**
+   * A semantic that describes a name of a person or pet. This semantic is used with
+   * the `PublicUniqueName` to determine which field is responsible for the slug generation. However,
+   * we may add more automation related to the `name` property in the future.
+   */
+  Name = 'Semantic#Name',
   /**
    * Designates a Data Property as the `role` of a user within the system.
    * This is used to define the user's permissions and access levels.
@@ -314,9 +320,13 @@ export enum SemanticOperation {
   Update = 'Update',
   Delete = 'Delete',
   /**
-   * Special operation for list/query operations
+   * Special operation for list operations
    */
   List = 'List',
+  /**
+   * Special operation for search operations
+   */
+  Search = 'Search',
 }
 
 /**
@@ -814,6 +824,19 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
       operations: [],
     },
   },
+  [SemanticType.Name]: {
+    id: SemanticType.Name,
+    displayName: 'Name',
+    scope: SemanticScope.Property,
+    description: 'A person or pet name',
+    category: SemanticCategory.Content,
+    applicableDataTypes: ['string'],
+    hasConfig: false,
+    runtime: {
+      timing: SemanticTiming.None,
+      operations: [],
+    },
+  },
   [SemanticType.Description]: {
     id: SemanticType.Description,
     displayName: 'Description',

package/src/modeling/helpers/Intelisense.ts

@@ -29,6 +29,8 @@ export function addAutoField(entity: DomainEntity, autoField: string): DomainEle
       return addEmailField(entity)
     case 'name':
       return addNameField(entity)
+    case 'display-name':
+      return addDisplayNameField(entity)
     case 'description':
       return addDescriptionField(entity)
     case 'status':
@@ -49,6 +51,8 @@ export function addAutoField(entity: DomainEntity, autoField: string): DomainEle
       return addIsDeletedField(entity)
     case 'deleted':
       return addDeletedAtField(entity)
+    case 'role':
+      return addRoleField(entity)
     case 'first-name':
       return addFirstNameField(entity)
     case 'last-name':
@@ -70,8 +74,12 @@ export function addAutoField(entity: DomainEntity, autoField: string): DomainEle
     case 'images':
       return addImagesField(entity)
     case 'session-id':
+      // This was removed from the UI. We will not support session id configuration
+      // as the platform will handle it to separate the business logic from the transport layer.
       return addSessionIdField(entity)
     case 'expires-at':
+      // This was removed from the UI. We will not support expires at configuration
+      // as the platform will handle it to separate the business logic from the transport layer.
       return addExpiresAtField(entity)
     case 'unit-price':
       return addUnitPriceField(entity)
@@ -198,6 +206,21 @@ export function addNameField(entity: DomainEntity, info: Partial<IThing> = {}):
   return prop
 }
 
+export function addDisplayNameField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+  const existing = findDisplayNameField(entity, true)
+  if (existing) {
+    return existing
+  }
+  const prop = entity.addProperty({
+    info: { name: 'display-name', displayName: 'Display Name', ...info },
+    type: 'string',
+  })
+  prop.addSemantic({
+    id: SemanticType.Name,
+  })
+  return prop
+}
+
 /**
  * Adds a description field to the specified entity.
  * If a description field already exists, it returns the existing field.
@@ -472,6 +495,24 @@ export function addDeletedAtField(entity: DomainEntity, info: Partial<IThing> =
   return prop
 }
 
+export function addRoleField(entity: DomainEntity, info: Partial<IThing> = {}): DomainProperty {
+  const existing = findRoleField(entity, true)
+  if (existing) {
+    return existing
+  }
+  const prop = entity.addProperty({
+    info: { name: 'role', displayName: 'Role', ...info },
+    type: 'string',
+    required: true,
+    index: true,
+    schema: { defaultValue: { type: 'literal', value: 'user' }, enum: ['user', 'admin'] },
+  })
+  prop.addSemantic({
+    id: SemanticType.UserRole,
+  })
+  return prop
+}
+
 /**
  * Adds an is_deleted field to the specified entity.
  * If an is_deleted field already exists, it returns the existing field.
@@ -1134,6 +1175,10 @@ function findNameField(entity: DomainEntity, direct = false): DomainProperty | u
   return findPropertyField(entity, (property) => property.hasSemantic(SemanticType.Title), direct)
 }
 
+function findDisplayNameField(entity: DomainEntity, direct = false): DomainProperty | undefined {
+  return findPropertyField(entity, (property) => property.hasSemantic(SemanticType.Name), direct)
+}
+
 function findDescriptionField(entity: DomainEntity, direct = false): DomainProperty | undefined {
   return findPropertyField(entity, (property) => property.hasSemantic(SemanticType.Description), direct)
 }
@@ -1196,6 +1241,10 @@ function findDeletedAtField(entity: DomainEntity, direct = false): DomainPropert
   )
 }
 
+function findRoleField(entity: DomainEntity, direct = false): DomainProperty | undefined {
+  return findPropertyField(entity, (property) => property.hasSemantic(SemanticType.UserRole), direct)
+}
+
 function findIsDeletedField(entity: DomainEntity, direct = false): DomainProperty | undefined {
   return findPropertyField(entity, (property) => property.hasSemantic(SemanticType.DeletedFlag), direct)
 }

package/tests/unit/modeling/helpers/intellisense.spec.ts

@@ -32,6 +32,8 @@ import {
   addUnitPriceField,
   addCurrencyAmountField,
   addRecommendedFields,
+  addDisplayNameField,
+  addRoleField,
 } from '../../../../src/modeling/helpers/Intelisense.js'
 import { SemanticType } from '../../../../src/modeling/Semantics.js'
 
@@ -402,6 +404,33 @@ test.group('addNameField()', () => {
   })
 })
 
+test.group('addDisplayNameField()', () => {
+  test('creates new display name field when none exists', ({ assert }) => {
+    const entity = createTestEntity()
+    const field = addDisplayNameField(entity) as DomainProperty
+    assert.instanceOf(field, DomainProperty)
+    assert.equal(field.info.name, 'display-name')
+    assert.equal(field.info.displayName, 'Display Name')
+    assert.equal(field.type, 'string')
+    assert.isTrue(field.semantics.length > 0)
+  })
+
+  test('returns existing display name field when one exists', ({ assert }) => {
+    const entity = createTestEntity()
+    const firstField = addDisplayNameField(entity) as DomainProperty
+    const secondField = addDisplayNameField(entity) as DomainProperty
+    assert.equal(firstField, secondField)
+    assert.lengthOf([...entity.properties], 1)
+  })
+
+  test('adds semantic annotation', ({ assert }) => {
+    const entity = createTestEntity()
+    const field = addDisplayNameField(entity) as DomainProperty
+    const hasSemantic = field.hasSemantic(SemanticType.Name)
+    assert.isTrue(hasSemantic)
+  })
+})
+
 test.group('addDescriptionField()', () => {
   test('creates new description field when none exists', ({ assert }) => {
     const entity = createTestEntity()
@@ -568,6 +597,36 @@ test.group('addDeletedAtField()', () => {
   })
 })
 
+test.group('addRoleField()', () => {
+  test('creates new role field when none exists', ({ assert }) => {
+    const entity = createTestEntity()
+    const field = addRoleField(entity)
+    assert.instanceOf(field, DomainProperty)
+    assert.equal(field.info.name, 'role')
+    assert.equal(field.info.displayName, 'Role')
+    assert.equal(field.type, 'string')
+    assert.isTrue(field.index)
+    assert.deepEqual(field.schema?.defaultValue, { type: 'literal', value: 'user' })
+    assert.deepEqual(field.schema?.enum, ['user', 'admin'])
+    assert.isTrue(field.hasSemantic(SemanticType.UserRole))
+  })
+
+  test('returns existing role field when one exists', ({ assert }) => {
+    const entity = createTestEntity()
+    const firstField = addRoleField(entity)
+    const secondField = addRoleField(entity)
+    assert.equal(firstField, secondField)
+    assert.lengthOf([...entity.properties], 1)
+  })
+
+  test('merges custom info with defaults', ({ assert }) => {
+    const entity = createTestEntity()
+    const field = addRoleField(entity, { description: 'User role' })
+    assert.equal(field.info.name, 'role')
+    assert.equal(field.info.description, 'User role')
+  })
+})
+
 test.group('addIsDeletedField()', () => {
   test('creates new is deleted field when none exists', ({ assert }) => {
     const entity = createTestEntity()