@api-client/core 0.17.1 → 0.17.3

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

@@ -42062,10 +42062,10 @@
 "@id": "#209"
 },
 {
-"@id": "#194"
+"@id": "#191"
 },
 {
-"@id": "#191"
+"@id": "#194"
 },
 {
 "@id": "#197"
@@ -42816,10 +42816,10 @@
 "@id": "#213"
 },
 {
-"@id": "#219"
+"@id": "#216"
 },
 {
-"@id": "#216"
+"@id": "#219"
 }
 ],
 "doc:root": false,
@@ -43436,7 +43436,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "addressType: 'REGISTERED-OFFICE-ADDRESS'\nstreetName: 'UITBREIDINGSTRAAT'\nhouseNumber: '84'\nhouseNumberAddition: '/1'\npostalCode: '2600'\ncity: 'BERCHEM (ANTWERPEN)'\ncountry: 'Belgium'\ncountryCode: 'BE'\nfullFormatedAddress: \"UITBREIDINGSTRAAT 84 /1, 2600 BERCHEM (ANTWERPEN), BELIUM\"\n",
+"doc:raw": "countryCode: \"BE\"\ngraydonEnterpriseId: 1057155523\nregistrationId: \"0422319093\"\nvatNumber: \"BE0422319093\"\ngraydonCompanyId: \"0422319093\"\nisBranchOffice: false\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43457,7 +43457,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "countryCode: \"BE\"\ngraydonEnterpriseId: 1057155523\nregistrationId: \"0422319093\"\nvatNumber: \"BE0422319093\"\ngraydonCompanyId: \"0422319093\"\nisBranchOffice: false\n",
+"doc:raw": "addressType: 'REGISTERED-OFFICE-ADDRESS'\nstreetName: 'UITBREIDINGSTRAAT'\nhouseNumber: '84'\nhouseNumberAddition: '/1'\npostalCode: '2600'\ncity: 'BERCHEM (ANTWERPEN)'\ncountry: 'Belgium'\ncountryCode: 'BE'\nfullFormatedAddress: \"UITBREIDINGSTRAAT 84 /1, 2600 BERCHEM (ANTWERPEN), BELIUM\"\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": "-\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": "-\n  type: 'GENERAL'\n  value: 'info@company.be'\n-\n  type: 'IT_DEPT'\n  value: 'it-service@company.be'\n",
+"doc:raw": "type: \"GENERAL\"\nvalue: \"www.company.be\"\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44756,12 +44756,12 @@
 {
 "@id": "#193/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#193",
-"sourcemaps:value": "[(1,0)-(10,0)]"
+"sourcemaps:value": "[(1,0)-(7,0)]"
 },
 {
 "@id": "#196/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#196",
-"sourcemaps:value": "[(1,0)-(7,0)]"
+"sourcemaps:value": "[(1,0)-(10,0)]"
 },
 {
 "@id": "#199/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)-(7,0)]"
 },
 {
 "@id": "#221/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#221",
-"sourcemaps:value": "[(1,0)-(7,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.17.1",
+  "version": "0.17.3",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {

package/src/modeling/Semantics.ts

@@ -1,3 +1,4 @@
+/* eslint-disable no-redeclare */
 /* eslint-disable max-len */
 import type { DomainPropertyType } from './DataFormat.js'
 
@@ -609,11 +610,20 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
   },
 }
 
+export function getSemanticsByCategory(): Record<SemanticCategory, DataSemantic[]>
+export function getSemanticsByCategory(scope: SemanticScope.Entity): Record<SemanticCategory, EntitySemantic[]>
+export function getSemanticsByCategory(scope: SemanticScope.Property): Record<SemanticCategory, PropertySemantic[]>
+export function getSemanticsByCategory(
+  scope: SemanticScope.Association
+): Record<SemanticCategory, AssociationSemantic[]>
+
 /**
  * Helper function to get all semantics grouped by category.
  * Useful for organizing semantics in UI dropdowns and forms.
+ *
+ * @param scope Optional scope to filter semantics by (Entity, Property, Association)
  */
-export const getSemanticsByCategory = (): Record<SemanticCategory, DataSemantic[]> => {
+export function getSemanticsByCategory(scope?: SemanticScope): Record<SemanticCategory, DataSemantic[]> {
   const result: Record<SemanticCategory, DataSemantic[]> = {
     [SemanticCategory.Identity]: [],
     [SemanticCategory.Lifecycle]: [],
@@ -626,6 +636,10 @@ export const getSemanticsByCategory = (): Record<SemanticCategory, DataSemantic[
   }
 
   Object.values(DataSemantics).forEach((semantic) => {
+    // If a scope is provided, filter semantics by that scope
+    if (scope && semantic.scope !== scope) {
+      return
+    }
     result[semantic.category].push(semantic)
   })
 

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

@@ -247,6 +247,83 @@ test.group('Semantics', () => {
     assert.equal(totalSemantics, allSemantics, 'All semantics should be categorized')
   })
 
+  test('getSemanticsByCategory should filter by Entity scope', ({ assert }) => {
+    const semanticsByCategory = getSemanticsByCategory(SemanticScope.Entity)
+    const allEntitySemantics = Object.values(DataSemantics).filter((s) => s.scope === SemanticScope.Entity)
+
+    // Ensure only Entity scope semantics are present
+    Object.values(semanticsByCategory).forEach((categorySemantics) => {
+      categorySemantics.forEach((semantic) => {
+        assert.equal(semantic.scope, SemanticScope.Entity, 'Only Entity semantics should be returned')
+      })
+    })
+
+    // Ensure all Entity scope semantics are returned
+    const returnedEntitySemantics = Object.values(semanticsByCategory).flat()
+    assert.equal(returnedEntitySemantics.length, allEntitySemantics.length, 'All Entity semantics should be returned')
+    allEntitySemantics.forEach((expectedSemantic) => {
+      assert.include(
+        returnedEntitySemantics,
+        expectedSemantic,
+        `Expected Entity semantic ${expectedSemantic.id} not found`
+      )
+    })
+  })
+
+  test('getSemanticsByCategory should filter by Property scope', ({ assert }) => {
+    const semanticsByCategory = getSemanticsByCategory(SemanticScope.Property)
+    const allPropertySemantics = Object.values(DataSemantics).filter((s) => s.scope === SemanticScope.Property)
+
+    // Ensure only Property scope semantics are present
+    Object.values(semanticsByCategory).forEach((categorySemantics) => {
+      categorySemantics.forEach((semantic) => {
+        assert.equal(semantic.scope, SemanticScope.Property, 'Only Property semantics should be returned')
+      })
+    })
+
+    // Ensure all Property scope semantics are returned
+    const returnedPropertySemantics = Object.values(semanticsByCategory).flat()
+    assert.equal(
+      returnedPropertySemantics.length,
+      allPropertySemantics.length,
+      'All Property semantics should be returned'
+    )
+    allPropertySemantics.forEach((expectedSemantic) => {
+      assert.include(
+        returnedPropertySemantics,
+        expectedSemantic,
+        `Expected Property semantic ${expectedSemantic.id} not found`
+      )
+    })
+  })
+
+  test('getSemanticsByCategory should filter by Association scope', ({ assert }) => {
+    const semanticsByCategory = getSemanticsByCategory(SemanticScope.Association)
+    const allAssociationSemantics = Object.values(DataSemantics).filter((s) => s.scope === SemanticScope.Association)
+
+    // Ensure only Association scope semantics are present
+    Object.values(semanticsByCategory).forEach((categorySemantics) => {
+      categorySemantics.forEach((semantic) => {
+        assert.equal(semantic.scope, SemanticScope.Association, 'Only Association semantics should be returned')
+      })
+    })
+
+    // Ensure all Association scope semantics are returned
+    const returnedAssociationSemantics = Object.values(semanticsByCategory).flat()
+    assert.equal(
+      returnedAssociationSemantics.length,
+      allAssociationSemantics.length,
+      'All Association semantics should be returned'
+    )
+    allAssociationSemantics.forEach((expectedSemantic) => {
+      assert.include(
+        returnedAssociationSemantics,
+        expectedSemantic,
+        `Expected Association semantic ${expectedSemantic.id} not found`
+      )
+    })
+  })
+
   test('getSemanticsByCategoryType should filter semantics by category', ({ assert }) => {
     const identitySemantics = getSemanticsByCategoryType(SemanticCategory.Identity)