@api-client/core 0.17.2 → 0.17.4

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.2",
+  "version": "0.17.4",
   "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'
 
@@ -292,6 +293,11 @@ interface BaseDataSemantic {
    * The category this semantic belongs to for UI organization.
    */
   category: SemanticCategory
+  /**
+   * Whether the semantic has a configuration or additional options.
+   * This is used to determine if the semantic requires additional setup or configuration.
+   */
+  hasConfig: boolean
 }
 
 /**
@@ -358,6 +364,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     scope: SemanticScope.Entity,
     description: 'System users and accounts',
     category: SemanticCategory.Identity,
+    hasConfig: false,
   },
   [SemanticType.Password]: {
     id: SemanticType.Password,
@@ -366,6 +373,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'Secure password field',
     category: SemanticCategory.Identity,
     applicableDataTypes: ['string'],
+    hasConfig: true,
   },
   [SemanticType.UserRole]: {
     id: SemanticType.UserRole,
@@ -374,6 +382,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'User permissions and access level',
     category: SemanticCategory.Identity,
     applicableDataTypes: ['string'],
+    hasConfig: false,
   },
   [SemanticType.ResourceOwnerIdentifier]: {
     id: SemanticType.ResourceOwnerIdentifier,
@@ -381,6 +390,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     scope: SemanticScope.Association,
     description: 'Links record to owner user',
     category: SemanticCategory.Identity,
+    hasConfig: false,
   },
 
   //
@@ -394,6 +404,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'When record was created',
     category: SemanticCategory.Lifecycle,
     applicableDataTypes: ['datetime'],
+    hasConfig: false,
   },
   [SemanticType.UpdatedTimestamp]: {
     id: SemanticType.UpdatedTimestamp,
@@ -402,6 +413,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'When record was last modified',
     category: SemanticCategory.Lifecycle,
     applicableDataTypes: ['datetime'],
+    hasConfig: false,
   },
   [SemanticType.DeletedTimestamp]: {
     id: SemanticType.DeletedTimestamp,
@@ -410,6 +422,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'When record was marked deleted',
     category: SemanticCategory.Lifecycle,
     applicableDataTypes: ['datetime'],
+    hasConfig: false,
   },
   [SemanticType.DeletedFlag]: {
     id: SemanticType.DeletedFlag,
@@ -418,6 +431,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'Mark record as deleted',
     category: SemanticCategory.Lifecycle,
     applicableDataTypes: ['boolean'],
+    hasConfig: false,
   },
   [SemanticType.Version]: {
     id: SemanticType.Version,
@@ -426,6 +440,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'Auto-incrementing version counter',
     category: SemanticCategory.Lifecycle,
     applicableDataTypes: ['number'],
+    hasConfig: false,
   },
 
   //
@@ -439,6 +454,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'Main title or heading',
     category: SemanticCategory.Content,
     applicableDataTypes: ['string'],
+    hasConfig: false,
   },
   [SemanticType.Description]: {
     id: SemanticType.Description,
@@ -447,6 +463,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'Detailed description text',
     category: SemanticCategory.Content,
     applicableDataTypes: ['string'],
+    hasConfig: true,
   },
   [SemanticType.Summary]: {
     id: SemanticType.Summary,
@@ -455,6 +472,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'Brief summary text',
     category: SemanticCategory.Content,
     applicableDataTypes: ['string'],
+    hasConfig: true,
   },
   [SemanticType.Markdown]: {
     id: SemanticType.Markdown,
@@ -463,6 +481,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'Formatted text content',
     category: SemanticCategory.Content,
     applicableDataTypes: ['string'],
+    hasConfig: true,
   },
   [SemanticType.HTML]: {
     id: SemanticType.HTML,
@@ -471,6 +490,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'Rich HTML content',
     category: SemanticCategory.Content,
     applicableDataTypes: ['string'],
+    hasConfig: true,
   },
   [SemanticType.ImageURL]: {
     id: SemanticType.ImageURL,
@@ -479,6 +499,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'Link to image file',
     category: SemanticCategory.Content,
     applicableDataTypes: ['string'],
+    hasConfig: false,
   },
   [SemanticType.FileURL]: {
     id: SemanticType.FileURL,
@@ -487,6 +508,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'Link to file attachment',
     category: SemanticCategory.Content,
     applicableDataTypes: ['string'],
+    hasConfig: false,
   },
 
   //
@@ -500,6 +522,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'Current state of record',
     category: SemanticCategory.Business,
     applicableDataTypes: ['string'],
+    hasConfig: true,
   },
   [SemanticType.Price]: {
     id: SemanticType.Price,
@@ -508,6 +531,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'Monetary value with currency',
     category: SemanticCategory.Business,
     applicableDataTypes: ['number', 'string'],
+    hasConfig: true,
   },
   [SemanticType.SKU]: {
     id: SemanticType.SKU,
@@ -516,6 +540,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'Product identification code',
     category: SemanticCategory.Business,
     applicableDataTypes: ['string'],
+    hasConfig: true,
   },
 
   //
@@ -529,6 +554,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'Email address',
     category: SemanticCategory.Contact,
     applicableDataTypes: ['string'],
+    hasConfig: true,
   },
   [SemanticType.Phone]: {
     id: SemanticType.Phone,
@@ -537,6 +563,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'Phone number',
     category: SemanticCategory.Contact,
     applicableDataTypes: ['string'],
+    hasConfig: true,
   },
   [SemanticType.URL]: {
     id: SemanticType.URL,
@@ -545,6 +572,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'Web address or link',
     category: SemanticCategory.Contact,
     applicableDataTypes: ['string'],
+    hasConfig: true,
   },
 
   //
@@ -558,6 +586,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'URL-friendly unique identifier',
     category: SemanticCategory.Organization,
     applicableDataTypes: ['string'],
+    hasConfig: true,
   },
   [SemanticType.Tags]: {
     id: SemanticType.Tags,
@@ -565,6 +594,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     scope: SemanticScope.Association,
     description: 'Enable tagging functionality',
     category: SemanticCategory.Organization,
+    hasConfig: true,
   },
   [SemanticType.Categories]: {
     id: SemanticType.Categories,
@@ -572,6 +602,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     scope: SemanticScope.Association,
     description: 'Enable categorization functionality',
     category: SemanticCategory.Organization,
+    hasConfig: true,
   },
 
   //
@@ -585,6 +616,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'Location coordinates',
     category: SemanticCategory.Location,
     applicableDataTypes: ['string'],
+    hasConfig: true,
   },
 
   //
@@ -598,6 +630,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'Auto-calculated field value',
     category: SemanticCategory.Computed,
     applicableDataTypes: ['string'],
+    hasConfig: true,
   },
   [SemanticType.Derived]: {
     id: SemanticType.Derived,
@@ -606,16 +639,24 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'Value derived from other fields',
     category: SemanticCategory.Computed,
     applicableDataTypes: ['string'],
+    hasConfig: true,
   },
 }
 
+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 = (scope?: SemanticScope): Record<SemanticCategory, DataSemantic[]> => {
+export function getSemanticsByCategory(scope?: SemanticScope): Record<SemanticCategory, DataSemantic[]> {
   const result: Record<SemanticCategory, DataSemantic[]> = {
     [SemanticCategory.Identity]: [],
     [SemanticCategory.Lifecycle]: [],