@api-client/core 0.17.3 → 0.17.5

package/tests/unit/modeling/semantic-configs.spec.ts

@@ -69,12 +69,12 @@ import {
 } from '../../../src/modeling/definitions/URL.js'
 
 import {
-  createPriceSemantic,
-  isPriceSemantic,
-  type PriceConfig,
-  DEFAULT_PRICE_CONFIG,
-  PRICE_PRESETS,
-} from '../../../src/modeling/definitions/Price.js'
+  createCurrencySemantic,
+  isCurrencySemantic,
+  type CurrencyConfig,
+  DEFAULT_CURRENCY_CONFIG,
+  CURRENCY_PRESETS,
+} from '../../../src/modeling/definitions/Currency.js'
 
 import {
   createSKUSemantic,
@@ -322,27 +322,27 @@ test.group('Semantic Configurations', () => {
     assert.isTrue(isURLSemantic(semantic))
   })
 
-  test('Price: should create semantic with default config', ({ assert }) => {
-    const semantic = createPriceSemantic()
-    assert.equal(semantic.id, SemanticType.Price)
-    assert.deepEqual(semantic.config, DEFAULT_PRICE_CONFIG)
+  test('Currency: should create semantic with default config', ({ assert }) => {
+    const semantic = createCurrencySemantic()
+    assert.equal(semantic.id, SemanticType.Currency)
+    assert.deepEqual(semantic.config, DEFAULT_CURRENCY_CONFIG)
   })
 
-  test('Price: should create semantic with custom config', ({ assert }) => {
-    const config: PriceConfig = {
+  test('Currency: should create semantic with custom config', ({ assert }) => {
+    const config: CurrencyConfig = {
       storageFormat: 'complex_object',
       allowedCurrencies: ['USD', 'EUR'],
       decimalPlaces: 4,
       allowNegative: true,
     }
-    const semantic = createPriceSemantic(config)
-    assert.equal(semantic.id, SemanticType.Price)
-    assert.deepEqual(semantic.config, { ...DEFAULT_PRICE_CONFIG, ...config })
+    const semantic = createCurrencySemantic(config)
+    assert.equal(semantic.id, SemanticType.Currency)
+    assert.deepEqual(semantic.config, { ...DEFAULT_CURRENCY_CONFIG, ...config })
   })
 
-  test('Price: should identify price semantic', ({ assert }) => {
-    const semantic = createPriceSemantic()
-    assert.isTrue(isPriceSemantic(semantic))
+  test('Currency: should identify currency semantic', ({ assert }) => {
+    const semantic = createCurrencySemantic()
+    assert.isTrue(isCurrencySemantic(semantic))
   })
 
   test('SKU: should create semantic with default config', ({ assert }) => {
@@ -491,33 +491,33 @@ test.group('Semantic Configurations', () => {
     assert.isTrue(isCategoriesSemantic(semantic))
   })
 
-  test('Price: should create semantic with default config', ({ assert }) => {
-    const semantic = createPriceSemantic()
-    assert.equal(semantic.id, SemanticType.Price)
-    assert.deepEqual(semantic.config, DEFAULT_PRICE_CONFIG)
+  test('Currency: should create semantic with default config', ({ assert }) => {
+    const semantic = createCurrencySemantic()
+    assert.equal(semantic.id, SemanticType.Currency)
+    assert.deepEqual(semantic.config, DEFAULT_CURRENCY_CONFIG)
   })
 
-  test('Price: should create semantic with custom config', ({ assert }) => {
-    const config: PriceConfig = {
+  test('Currency: should create semantic with custom config', ({ assert }) => {
+    const config: CurrencyConfig = {
       storageFormat: 'complex_object',
       allowedCurrencies: ['USD', 'EUR'],
       decimalPlaces: 4,
       allowNegative: true,
     }
-    const semantic = createPriceSemantic(config)
-    assert.equal(semantic.id, SemanticType.Price)
-    assert.deepEqual(semantic.config, { ...DEFAULT_PRICE_CONFIG, ...config })
+    const semantic = createCurrencySemantic(config)
+    assert.equal(semantic.id, SemanticType.Currency)
+    assert.deepEqual(semantic.config, { ...DEFAULT_CURRENCY_CONFIG, ...config })
   })
 
-  test('Price: should identify price semantic', ({ assert }) => {
-    const semantic = createPriceSemantic()
-    assert.isTrue(isPriceSemantic(semantic))
+  test('Currency: should identify currency semantic', ({ assert }) => {
+    const semantic = createCurrencySemantic()
+    assert.isTrue(isCurrencySemantic(semantic))
   })
 
-  test('Price: presets should be valid', ({ assert }) => {
-    Object.values(PRICE_PRESETS).forEach((preset) => {
-      assert.isTrue(isPriceSemantic(preset))
-      assert.equal(preset.id, SemanticType.Price)
+  test('Currency: presets should be valid', ({ assert }) => {
+    Object.values(CURRENCY_PRESETS).forEach((preset) => {
+      assert.isTrue(isCurrencySemantic(preset))
+      assert.equal(preset.id, SemanticType.Currency)
     })
   })
 
@@ -532,38 +532,38 @@ test.group('Semantic Configurations', () => {
     const emailSemantic = createEmailSemantic()
     const phoneSemantic = createPhoneSemantic()
     const statusSemantic = createStatusSemantic()
-    const priceSemantic = createPriceSemantic()
+    const currencySemantic = createCurrencySemantic()
     const skuSemantic = createSKUSemantic()
 
     // Each should only be identified as its own type
     assert.isTrue(isEmailSemantic(emailSemantic))
     assert.isFalse(isEmailSemantic(phoneSemantic))
     assert.isFalse(isEmailSemantic(statusSemantic))
-    assert.isFalse(isEmailSemantic(priceSemantic))
+    assert.isFalse(isEmailSemantic(currencySemantic))
     assert.isFalse(isEmailSemantic(skuSemantic))
 
     assert.isFalse(isPhoneSemantic(emailSemantic))
     assert.isTrue(isPhoneSemantic(phoneSemantic))
     assert.isFalse(isPhoneSemantic(statusSemantic))
-    assert.isFalse(isPhoneSemantic(priceSemantic))
+    assert.isFalse(isPhoneSemantic(currencySemantic))
     assert.isFalse(isPhoneSemantic(skuSemantic))
 
     assert.isFalse(isStatusSemantic(emailSemantic))
     assert.isFalse(isStatusSemantic(phoneSemantic))
     assert.isTrue(isStatusSemantic(statusSemantic))
-    assert.isFalse(isStatusSemantic(priceSemantic))
+    assert.isFalse(isStatusSemantic(currencySemantic))
     assert.isFalse(isStatusSemantic(skuSemantic))
 
-    assert.isFalse(isPriceSemantic(emailSemantic))
-    assert.isFalse(isPriceSemantic(phoneSemantic))
-    assert.isFalse(isPriceSemantic(statusSemantic))
-    assert.isTrue(isPriceSemantic(priceSemantic))
-    assert.isFalse(isPriceSemantic(skuSemantic))
+    assert.isFalse(isCurrencySemantic(emailSemantic))
+    assert.isFalse(isCurrencySemantic(phoneSemantic))
+    assert.isFalse(isCurrencySemantic(statusSemantic))
+    assert.isTrue(isCurrencySemantic(currencySemantic))
+    assert.isFalse(isCurrencySemantic(skuSemantic))
 
     assert.isFalse(isSKUSemantic(emailSemantic))
     assert.isFalse(isSKUSemantic(phoneSemantic))
     assert.isFalse(isSKUSemantic(statusSemantic))
-    assert.isFalse(isSKUSemantic(priceSemantic))
+    assert.isFalse(isSKUSemantic(currencySemantic))
     assert.isTrue(isSKUSemantic(skuSemantic))
   })
 })

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

@@ -31,7 +31,7 @@ test.group('Semantics', () => {
     assert.equal(SemanticType.FileURL, 'Semantic#FileURL')
     assert.equal(SemanticType.Markdown, 'Semantic#Markdown')
     assert.equal(SemanticType.GeospatialCoordinates, 'Semantic#GeospatialCoordinates')
-    assert.equal(SemanticType.Price, 'Semantic#Price')
+    assert.equal(SemanticType.Currency, 'Semantic#Currency')
     assert.equal(SemanticType.ResourceOwnerIdentifier, 'Semantic#ResourceOwnerIdentifier')
     assert.equal(SemanticType.SKU, 'Semantic#SKU')
   })
@@ -49,6 +49,7 @@ test.group('Semantics', () => {
       description: 'Test',
       scope: SemanticScope.Entity,
       category: SemanticCategory.Identity,
+      hasConfig: false,
     }
     const propertySemantic: PropertySemantic = {
       id: SemanticType.CreatedTimestamp,
@@ -56,6 +57,7 @@ test.group('Semantics', () => {
       description: 'Test',
       scope: SemanticScope.Property,
       category: SemanticCategory.Lifecycle,
+      hasConfig: false,
     }
     const associationSemantic: AssociationSemantic = {
       id: SemanticType.ResourceOwnerIdentifier,
@@ -63,6 +65,7 @@ test.group('Semantics', () => {
       description: 'Test',
       scope: SemanticScope.Association,
       category: SemanticCategory.Identity,
+      hasConfig: false,
     }
 
     assert.isTrue(isEntitySemantic(entitySemantic))
@@ -77,6 +80,7 @@ test.group('Semantics', () => {
       description: 'Test',
       scope: SemanticScope.Entity,
       category: SemanticCategory.Identity,
+      hasConfig: false,
     }
     const propertySemantic: PropertySemantic = {
       id: SemanticType.CreatedTimestamp,
@@ -84,6 +88,7 @@ test.group('Semantics', () => {
       description: 'Test',
       scope: SemanticScope.Property,
       category: SemanticCategory.Lifecycle,
+      hasConfig: false,
     }
     const associationSemantic: AssociationSemantic = {
       id: SemanticType.ResourceOwnerIdentifier,
@@ -91,6 +96,7 @@ test.group('Semantics', () => {
       description: 'Test',
       scope: SemanticScope.Association,
       category: SemanticCategory.Identity,
+      hasConfig: false,
     }
 
     assert.isFalse(isPropertySemantic(entitySemantic))
@@ -105,6 +111,7 @@ test.group('Semantics', () => {
       description: 'Test',
       scope: SemanticScope.Entity,
       category: SemanticCategory.Identity,
+      hasConfig: false,
     }
     const propertySemantic: PropertySemantic = {
       id: SemanticType.CreatedTimestamp,
@@ -112,6 +119,7 @@ test.group('Semantics', () => {
       description: 'Test',
       scope: SemanticScope.Property,
       category: SemanticCategory.Lifecycle,
+      hasConfig: false,
     }
     const associationSemantic: AssociationSemantic = {
       id: SemanticType.ResourceOwnerIdentifier,
@@ -119,6 +127,7 @@ test.group('Semantics', () => {
       description: 'Test',
       scope: SemanticScope.Association,
       category: SemanticCategory.Identity,
+      hasConfig: false,
     }
 
     assert.isFalse(isAssociationSemantic(entitySemantic))

package/build/src/modeling/definitions/Price.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Price.d.ts","sourceRoot":"","sources":["../../../../src/modeling/definitions/Price.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAE9C;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,eAAe,GAAG,gBAAgB,CAAA;AAE/E;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,kBAAkB,CAAA;IAElC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IAE5B;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAElC;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAC/D,EAAE,EAAE,YAAY,CAAC,KAAK,CAAA;IACtB,MAAM,CAAC,EAAE,WAAW,CAAA;CACrB;AAED;;GAEG;AACH,eAAO,MAAM,eAAe,GAAI,UAAU,mBAAmB,KAAG,QAAQ,IAAI,oBAE3E,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,GAAI,SAAQ,WAAgB,KAAG,oBAe9D,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,oBAAoB,EAAE,WAMlC,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,aAAa;IACxB;;OAEG;;IAQH;;OAEG;;IAQH;;OAEG;;IAQH;;OAEG;;IAQH;;OAEG;;CAOK,CAAA;AAEV;;GAEG;AACH,eAAO,MAAM,mBAAmB,GAAI,QAAQ,WAAW,KAAG,MAAM,EAY/D,CAAA"}

package/build/src/modeling/definitions/Price.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Price.js","sourceRoot":"","sources":["../../../../src/modeling/definitions/Price.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAqE9C;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,QAA6B,EAAoC,EAAE;IACjG,OAAO,QAAQ,CAAC,EAAE,KAAK,YAAY,CAAC,KAAK,CAAA;AAC3C,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,SAAsB,EAAE,EAAwB,EAAE;IACpF,MAAM,YAAY,GAAG;QACnB,GAAG,oBAAoB;QACvB,GAAG,MAAM;KACV,CAAA;IAED,4BAA4B;IAC5B,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QACpB,YAAY,CAAC,QAAQ,GAAG,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAA;IAChD,CAAC;IAED,OAAO;QACL,EAAE,EAAE,YAAY,CAAC,KAAK;QACtB,MAAM,EAAE,YAAY;KACrB,CAAA;AACH,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAgB;IAC/C,aAAa,EAAE,SAAS;IACxB,eAAe,EAAE,KAAK;IACtB,aAAa,EAAE,CAAC;IAChB,aAAa,EAAE,KAAK;IACpB,oBAAoB,EAAE,IAAI;CAC3B,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B;;OAEG;IACH,WAAW,EAAE,mBAAmB,CAAC;QAC/B,aAAa,EAAE,SAAS;QACxB,eAAe,EAAE,KAAK;QACtB,aAAa,EAAE,CAAC;QAChB,aAAa,EAAE,KAAK;KACrB,CAAC;IAEF;;OAEG;IACH,SAAS,EAAE,mBAAmB,CAAC;QAC7B,aAAa,EAAE,eAAe;QAC9B,eAAe,EAAE,KAAK;QACtB,aAAa,EAAE,CAAC;QAChB,aAAa,EAAE,KAAK;KACrB,CAAC;IAEF;;OAEG;IACH,cAAc,EAAE,mBAAmB,CAAC;QAClC,aAAa,EAAE,gBAAgB;QAC/B,iBAAiB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QACtD,aAAa,EAAE,CAAC;QAChB,aAAa,EAAE,KAAK;KACrB,CAAC;IAEF;;OAEG;IACH,cAAc,EAAE,mBAAmB,CAAC;QAClC,aAAa,EAAE,SAAS;QACxB,eAAe,EAAE,KAAK;QACtB,aAAa,EAAE,CAAC;QAChB,aAAa,EAAE,IAAI;KACpB,CAAC;IAEF;;OAEG;IACH,cAAc,EAAE,mBAAmB,CAAC;QAClC,aAAa,EAAE,SAAS;QACxB,eAAe,EAAE,KAAK;QACtB,aAAa,EAAE,CAAC;QAChB,aAAa,EAAE,KAAK;KACrB,CAAC;CACM,CAAA;AAEV;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,MAAmB,EAAY,EAAE;IACnE,MAAM,MAAM,GAAa,EAAE,CAAA;IAE3B,IAAI,MAAM,CAAC,aAAa,KAAK,gBAAgB,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;QACzE,MAAM,CAAC,IAAI,CAAC,sEAAsE,CAAC,CAAA;IACrF,CAAC;IAED,IAAI,MAAM,CAAC,aAAa,KAAK,SAAS,IAAI,MAAM,CAAC,aAAa,GAAG,CAAC,EAAE,CAAC;QACnE,MAAM,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAA;IACnD,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC,CAAA","sourcesContent":["import type { AppliedDataSemantic } from '../Semantics.js'\nimport { SemanticType } from '../Semantics.js'\n\n/**\n * Supported storage formats for monetary values.\n */\nexport type PriceStorageFormat = 'decimal' | 'integer_cents' | 'complex_object'\n\n/**\n * Configuration options for the Price semantic.\n * Controls monetary value storage, validation, currency handling, and precision.\n */\nexport interface PriceConfig {\n  /**\n   * How the monetary value is stored in the database.\n   *\n   * - 'decimal': Store as DECIMAL/NUMERIC type (e.g., 19.99)\n   * - 'integer_cents': Store as INTEGER in smallest currency unit (e.g., 1999 for $19.99)\n   * - 'complex_object': Store as JSON/JSONB with amount and currency (e.g., {\"amount\": 1999, \"currency\": \"USD\"})\n   */\n  storageFormat?: PriceStorageFormat\n\n  /**\n   * Default currency code (ISO 4217) when not specified.\n   * Required when using 'decimal' or 'integer_cents' format.\n   */\n  defaultCurrency?: string\n\n  /**\n   * List of allowed currency codes (ISO 4217).\n   * If not specified, all valid ISO 4217 currencies are allowed.\n   */\n  allowedCurrencies?: string[]\n\n  /**\n   * Number of decimal places for precision.\n   * Default: 2 (for most currencies like USD, EUR)\n   * Some currencies may need 0 (JPY, KRW) or 3 (BHD, KWD)\n   */\n  decimalPlaces?: number\n\n  /**\n   * Whether negative values are allowed (for refunds, discounts, etc.).\n   */\n  allowNegative?: boolean\n\n  /**\n   * Whether to automatically validate currency codes against ISO 4217.\n   */\n  validateCurrencyCode?: boolean\n\n  /**\n   * Custom metadata for the price field.\n   */\n  metadata?: Record<string, unknown>\n\n  /**\n   * Index signature to allow additional properties.\n   */\n  [key: string]: unknown\n}\n\n/**\n * Type-safe configuration for Price semantic.\n */\nexport interface AppliedPriceSemantic extends AppliedDataSemantic {\n  id: SemanticType.Price\n  config?: PriceConfig\n}\n\n/**\n * Type guard to check if a semantic is a Price semantic.\n */\nexport const isPriceSemantic = (semantic: AppliedDataSemantic): semantic is AppliedPriceSemantic => {\n  return semantic.id === SemanticType.Price\n}\n\n/**\n * Helper function to create a Price semantic with configuration.\n */\nexport const createPriceSemantic = (config: PriceConfig = {}): AppliedPriceSemantic => {\n  const mergedConfig = {\n    ...DEFAULT_PRICE_CONFIG,\n    ...config,\n  }\n\n  // Merge metadata separately\n  if (config.metadata) {\n    mergedConfig.metadata = { ...config.metadata }\n  }\n\n  return {\n    id: SemanticType.Price,\n    config: mergedConfig,\n  }\n}\n\n/**\n * Default configuration for Price semantic.\n * Optimized for common e-commerce use cases with USD currency.\n */\nexport const DEFAULT_PRICE_CONFIG: PriceConfig = {\n  storageFormat: 'decimal',\n  defaultCurrency: 'USD',\n  decimalPlaces: 2,\n  allowNegative: false,\n  validateCurrencyCode: true,\n}\n\n/**\n * Predefined configurations for common use cases.\n */\nexport const PRICE_PRESETS = {\n  /**\n   * Simple USD decimal storage - good for most e-commerce sites.\n   */\n  USD_DECIMAL: createPriceSemantic({\n    storageFormat: 'decimal',\n    defaultCurrency: 'USD',\n    decimalPlaces: 2,\n    allowNegative: false,\n  }),\n\n  /**\n   * Integer cents storage - avoids floating point issues, good for financial calculations.\n   */\n  USD_CENTS: createPriceSemantic({\n    storageFormat: 'integer_cents',\n    defaultCurrency: 'USD',\n    decimalPlaces: 2,\n    allowNegative: false,\n  }),\n\n  /**\n   * Multi-currency support with complex object storage.\n   */\n  MULTI_CURRENCY: createPriceSemantic({\n    storageFormat: 'complex_object',\n    allowedCurrencies: ['USD', 'EUR', 'GBP', 'JPY', 'CAD'],\n    decimalPlaces: 2,\n    allowNegative: false,\n  }),\n\n  /**\n   * Configuration that allows negative values for refunds, discounts, etc.\n   */\n  WITH_NEGATIVES: createPriceSemantic({\n    storageFormat: 'decimal',\n    defaultCurrency: 'USD',\n    decimalPlaces: 2,\n    allowNegative: true,\n  }),\n\n  /**\n   * High-precision configuration for cryptocurrency or precious metals.\n   */\n  HIGH_PRECISION: createPriceSemantic({\n    storageFormat: 'decimal',\n    defaultCurrency: 'BTC',\n    decimalPlaces: 8,\n    allowNegative: false,\n  }),\n} as const\n\n/**\n * Helper function to validate a price configuration.\n */\nexport const validatePriceConfig = (config: PriceConfig): string[] => {\n  const errors: string[] = []\n\n  if (config.storageFormat !== 'complex_object' && !config.defaultCurrency) {\n    errors.push('defaultCurrency is required when storageFormat is not complex_object')\n  }\n\n  if (config.decimalPlaces !== undefined && config.decimalPlaces < 0) {\n    errors.push('decimalPlaces must be non-negative')\n  }\n\n  return errors\n}\n"]}