@api-client/core 0.17.4 → 0.17.6

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

@@ -42810,6 +42810,9 @@
 "@id": "#219"
 },
 {
+"@id": "#219"
+},
+{
 "@id": "#210"
 },
 {
@@ -42817,9 +42820,6 @@
 },
 {
 "@id": "#216"
-},
-{
-"@id": "#219"
 }
 ],
 "doc:root": false,
@@ -44232,7 +44232,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'\ncountryDialCode : '+32'\nareaCode : '21'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)21 302099'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44253,7 +44253,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": "-\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": [
 {
@@ -44274,7 +44274,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": [
 {
@@ -44295,7 +44295,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: \"GENERAL\"\nvalue: \"www.company.be\"\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": [
 {
@@ -45121,17 +45121,17 @@
 {
 "@id": "#215/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#215",
-"sourcemaps:value": "[(1,0)-(6,0)]"
+"sourcemaps:value": "[(1,0)-(7,0)]"
 },
 {
 "@id": "#218/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#218",
-"sourcemaps:value": "[(1,0)-(7,0)]"
+"sourcemaps:value": "[(1,0)-(3,0)]"
 },
 {
 "@id": "#221/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#221",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(6,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.4",
+  "version": "0.17.6",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {

package/src/modeling/Semantics.ts

@@ -50,11 +50,12 @@ export enum SemanticType {
    */
   DeletedFlag = 'Semantic#DeletedFlag',
   /**
-   * Designates a Data Property as a unique public identifier for a resource (the slug).
+   * Designates a Data Property as a public identifier for a resource (the slug).
    * This is often used in URLs to provide a user-friendly way to access the resource.
    * For example, a blog post might have a public unique name like "my-first-post".
-   * A URL-friendly text field. The runtime automatically generates a unique, URL-safe string from another field (like a title or name). The user needs to specify which field is used to generate
-   * the slug.
+   * The runtime automatically generates a URL-safe string from another field (like a title).
+   * By default, slugs are generated to be unique, but the configuration allows for duplicates
+   * in scenarios where uniqueness is handled by a combination of fields (e.g., year and slug).
    */
   PublicUniqueName = 'Semantic#PublicUniqueName',
   /**
@@ -149,9 +150,12 @@ export enum SemanticType {
   /**
    * Annotates a field as a monetary value with currency support and precision control.
    * Can store simple decimal amounts or complex objects with amount and currency.
-   * Enforces proper decimal handling to avoid floating-point errors.
+   *
+   * As a semantic, it provides flexibility by annotating a base `number` or `string` type,
+   * allowing for different storage strategies (e.g., decimal, integer cents, or a JSON object)
+   * while maintaining a consistent API for currency operations.
    */
-  Price = 'Semantic#Price',
+  Currency = 'Semantic#Currency',
   /**
    * Annotates a field as a URL with validation and allowed protocols.
    */
@@ -463,7 +467,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'Detailed description text',
     category: SemanticCategory.Content,
     applicableDataTypes: ['string'],
-    hasConfig: true,
+    hasConfig: false,
   },
   [SemanticType.Summary]: {
     id: SemanticType.Summary,
@@ -472,7 +476,7 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     description: 'Brief summary text',
     category: SemanticCategory.Content,
     applicableDataTypes: ['string'],
-    hasConfig: true,
+    hasConfig: false,
   },
   [SemanticType.Markdown]: {
     id: SemanticType.Markdown,
@@ -524,9 +528,9 @@ export const DataSemantics: Record<SemanticType, DataSemantic> = {
     applicableDataTypes: ['string'],
     hasConfig: true,
   },
-  [SemanticType.Price]: {
-    id: SemanticType.Price,
-    displayName: 'Price',
+  [SemanticType.Currency]: {
+    id: SemanticType.Currency,
+    displayName: 'Currency',
     scope: SemanticScope.Property,
     description: 'Monetary value with currency',
     category: SemanticCategory.Business,

package/src/modeling/definitions/{Price.examples.md → Currency.examples.md}

@@ -1,14 +1,14 @@
-# Price Semantic Examples
+# Currency Semantic Examples
 
-This document provides examples of how to use the Price semantic with different configurations.
+This document provides examples of how to use the Currency semantic with different configurations.
 
 ## Basic Usage
 
 ```typescript
-import { createPriceSemantic, PRICE_PRESETS } from './Price.js'
+import { createCurrencySemantic, CURRENCY_PRESETS } from './Currency.js'
 
 // Simple USD decimal storage
-const basicPrice = createPriceSemantic({
+const basicCurrency = createCurrencySemantic({
   storageFormat: 'decimal',
   defaultCurrency: 'USD',
   decimalPlaces: 2,
@@ -16,7 +16,7 @@ const basicPrice = createPriceSemantic({
 })
 
 // Using a preset
-const usdDecimal = PRICE_PRESETS.USD_DECIMAL
+const usdDecimal = CURRENCY_PRESETS.USD_DECIMAL
 ```
 
 ## Configuration Examples
@@ -24,7 +24,7 @@ const usdDecimal = PRICE_PRESETS.USD_DECIMAL
 ### 1. Simple E-commerce Store (USD only)
 
 ```typescript
-const ecommercePrice = createPriceSemantic({
+const ecommerceCurrency = createCurrencySemantic({
   storageFormat: 'decimal',
   defaultCurrency: 'USD',
   decimalPlaces: 2,
@@ -35,7 +35,7 @@ const ecommercePrice = createPriceSemantic({
 ### 2. International E-commerce (Multi-currency)
 
 ```typescript
-const internationalPrice = createPriceSemantic({
+const internationalCurrency = createCurrencySemantic({
   storageFormat: 'complex_object',
   allowedCurrencies: ['USD', 'EUR', 'GBP', 'JPY', 'CAD', 'AUD'],
   decimalPlaces: 2,
@@ -46,7 +46,7 @@ const internationalPrice = createPriceSemantic({
 ### 3. Financial System (High precision, allows negatives)
 
 ```typescript
-const financialPrice = createPriceSemantic({
+const financialCurrency = createCurrencySemantic({
   storageFormat: 'integer_cents',
   defaultCurrency: 'USD',
   decimalPlaces: 4,
@@ -57,7 +57,7 @@ const financialPrice = createPriceSemantic({
 ### 4. Cryptocurrency Trading
 
 ```typescript
-const cryptoPrice = createPriceSemantic({
+const cryptoCurrency = createCurrencySemantic({
   storageFormat: 'decimal',
   defaultCurrency: 'BTC',
   decimalPlaces: 8,
@@ -142,10 +142,10 @@ CREATE INDEX idx_products_price_currency ON products USING GIN ((price->>'curren
 
 ## Validation Examples
 
-The Price semantic includes built-in validation:
+The Currency semantic includes built-in validation:
 
 ```typescript
-import { validatePriceConfig } from './Price.js'
+import { validateCurrencyConfig } from './Currency.js'
 
 const config = {
   storageFormat: 'decimal' as const,
@@ -153,6 +153,6 @@ const config = {
   decimalPlaces: 2,
 }
 
-const errors = validatePriceConfig(config)
+const errors = validateCurrencyConfig(config)
 console.log(errors) // ['defaultCurrency is required when storageFormat is not complex_object']
 ```

package/src/modeling/definitions/{Price.ts → Currency.ts}

@@ -4,13 +4,13 @@ import { SemanticType } from '../Semantics.js'
 /**
  * Supported storage formats for monetary values.
  */
-export type PriceStorageFormat = 'decimal' | 'integer_cents' | 'complex_object'
+export type CurrencyStorageFormat = 'decimal' | 'integer_cents' | 'complex_object'
 
 /**
- * Configuration options for the Price semantic.
+ * Configuration options for the Currency semantic.
  * Controls monetary value storage, validation, currency handling, and precision.
  */
-export interface PriceConfig {
+export interface CurrencyConfig {
   /**
    * How the monetary value is stored in the database.
    *
@@ -18,7 +18,7 @@ export interface PriceConfig {
    * - 'integer_cents': Store as INTEGER in smallest currency unit (e.g., 1999 for $19.99)
    * - 'complex_object': Store as JSON/JSONB with amount and currency (e.g., {"amount": 1999, "currency": "USD"})
    */
-  storageFormat?: PriceStorageFormat
+  storageFormat?: CurrencyStorageFormat
 
   /**
    * Default currency code (ISO 4217) when not specified.
@@ -50,7 +50,7 @@ export interface PriceConfig {
   validateCurrencyCode?: boolean
 
   /**
-   * Custom metadata for the price field.
+   * Custom metadata for the currency field.
    */
   metadata?: Record<string, unknown>
 
@@ -61,26 +61,26 @@ export interface PriceConfig {
 }
 
 /**
- * Type-safe configuration for Price semantic.
+ * Type-safe configuration for Currency semantic.
  */
-export interface AppliedPriceSemantic extends AppliedDataSemantic {
-  id: SemanticType.Price
-  config?: PriceConfig
+export interface AppliedCurrencySemantic extends AppliedDataSemantic {
+  id: SemanticType.Currency
+  config?: CurrencyConfig
 }
 
 /**
- * Type guard to check if a semantic is a Price semantic.
+ * Type guard to check if a semantic is a Currency semantic.
  */
-export const isPriceSemantic = (semantic: AppliedDataSemantic): semantic is AppliedPriceSemantic => {
-  return semantic.id === SemanticType.Price
+export const isCurrencySemantic = (semantic: AppliedDataSemantic): semantic is AppliedCurrencySemantic => {
+  return semantic.id === SemanticType.Currency
 }
 
 /**
- * Helper function to create a Price semantic with configuration.
+ * Helper function to create a Currency semantic with configuration.
  */
-export const createPriceSemantic = (config: PriceConfig = {}): AppliedPriceSemantic => {
+export const createCurrencySemantic = (config: CurrencyConfig = {}): AppliedCurrencySemantic => {
   const mergedConfig = {
-    ...DEFAULT_PRICE_CONFIG,
+    ...DEFAULT_CURRENCY_CONFIG,
     ...config,
   }
 
@@ -90,16 +90,16 @@ export const createPriceSemantic = (config: PriceConfig = {}): AppliedPriceSeman
   }
 
   return {
-    id: SemanticType.Price,
+    id: SemanticType.Currency,
     config: mergedConfig,
   }
 }
 
 /**
- * Default configuration for Price semantic.
+ * Default configuration for Currency semantic.
  * Optimized for common e-commerce use cases with USD currency.
  */
-export const DEFAULT_PRICE_CONFIG: PriceConfig = {
+export const DEFAULT_CURRENCY_CONFIG: CurrencyConfig = {
   storageFormat: 'decimal',
   defaultCurrency: 'USD',
   decimalPlaces: 2,
@@ -110,11 +110,11 @@ export const DEFAULT_PRICE_CONFIG: PriceConfig = {
 /**
  * Predefined configurations for common use cases.
  */
-export const PRICE_PRESETS = {
+export const CURRENCY_PRESETS = {
   /**
    * Simple USD decimal storage - good for most e-commerce sites.
    */
-  USD_DECIMAL: createPriceSemantic({
+  USD_DECIMAL: createCurrencySemantic({
     storageFormat: 'decimal',
     defaultCurrency: 'USD',
     decimalPlaces: 2,
@@ -124,7 +124,7 @@ export const PRICE_PRESETS = {
   /**
    * Integer cents storage - avoids floating point issues, good for financial calculations.
    */
-  USD_CENTS: createPriceSemantic({
+  USD_CENTS: createCurrencySemantic({
     storageFormat: 'integer_cents',
     defaultCurrency: 'USD',
     decimalPlaces: 2,
@@ -134,7 +134,7 @@ export const PRICE_PRESETS = {
   /**
    * Multi-currency support with complex object storage.
    */
-  MULTI_CURRENCY: createPriceSemantic({
+  MULTI_CURRENCY: createCurrencySemantic({
     storageFormat: 'complex_object',
     allowedCurrencies: ['USD', 'EUR', 'GBP', 'JPY', 'CAD'],
     decimalPlaces: 2,
@@ -144,7 +144,7 @@ export const PRICE_PRESETS = {
   /**
    * Configuration that allows negative values for refunds, discounts, etc.
    */
-  WITH_NEGATIVES: createPriceSemantic({
+  WITH_NEGATIVES: createCurrencySemantic({
     storageFormat: 'decimal',
     defaultCurrency: 'USD',
     decimalPlaces: 2,
@@ -154,7 +154,7 @@ export const PRICE_PRESETS = {
   /**
    * High-precision configuration for cryptocurrency or precious metals.
    */
-  HIGH_PRECISION: createPriceSemantic({
+  HIGH_PRECISION: createCurrencySemantic({
     storageFormat: 'decimal',
     defaultCurrency: 'BTC',
     decimalPlaces: 8,
@@ -163,9 +163,9 @@ export const PRICE_PRESETS = {
 } as const
 
 /**
- * Helper function to validate a price configuration.
+ * Helper function to validate a currency configuration.
  */
-export const validatePriceConfig = (config: PriceConfig): string[] => {
+export const validateCurrencyConfig = (config: CurrencyConfig): string[] => {
   const errors: string[] = []
 
   if (config.storageFormat !== 'complex_object' && !config.defaultCurrency) {

package/src/modeling/definitions/Email.ts

@@ -15,9 +15,9 @@ export interface EmailConfig {
    */
   requireVerification?: boolean
   /**
-   * Method to use for verification: 'email', 'sms', or 'none'.
+   * Method to use for verification: 'email' or 'sms'.
    */
-  verificationMethod?: 'email' | 'sms' | 'none'
+  verificationMethod?: 'email' | 'sms'
   /**
    * Whether to allow subaddressing (user+tag@domain.com).
    */

package/src/modeling/definitions/GeospatialCoordinates.ts

@@ -97,12 +97,16 @@ export interface GeospatialCoordinatesConfig {
   /**
    * The spatial reference system (SRS) for the coordinates.
    * Defaults to WGS84 (EPSG:4326) if not specified.
+   *
+   * Note: If `format` is set to `GeoJSON`, this value is automatically locked to `WGS84`
+   * as per the GeoJSON specification (RFC 7946).
    */
   spatialReferenceSystem?: GeospatialSpatialReferenceSystem
 
   /**
    * The default distance unit for spatial queries.
    * Defaults to 'meters' if not specified.
+   * Only applicable when `enableDistanceQueries` is true.
    */
   defaultDistanceUnit?: GeospatialDistanceUnit
 
@@ -120,7 +124,8 @@ export interface GeospatialCoordinatesConfig {
 
   /**
    * Custom validation rules for coordinate bounds.
-   * If not specified, uses standard latitude (-90 to 90) and longitude (-180 to 180) bounds.
+   * Values are in decimal degrees.
+   * If not specified, uses standard latitude (-90.0 to 90.0) and longitude (-180.0 to 180.0) bounds.
    */
   validationBounds?: {
     /**
@@ -144,35 +149,55 @@ export interface GeospatialCoordinatesConfig {
   /**
    * Whether to enable automatic PostGIS integration when using PostgreSQL.
    * Defaults to true if not specified.
+   *
+   * This is an advanced setting. For UIs targeting non-technical users,
+   * it is safe to hide this option and keep it enabled. The backend should
+   * gracefully handle cases where the database is not PostgreSQL.
    */
   enablePostGISIntegration?: boolean
 
   /**
    * The PostGIS geometry type to use for storage.
    * Defaults to 'POINT' if not specified.
+   * This choice fundamentally defines the shape of the data and the types of queries that can be performed.
+   *
+   * - **POINT**: For single locations (e.g., a store, a user's location).
+   * - **LINESTRING**: For paths or routes (e.g., a delivery route, a hiking trail).
+   * - **POLYGON**: For defined areas (e.g., a delivery zone, a sales territory, a city boundary).
+   * - **MULTI***: For collections of the above types (e.g., all stores in a chain as a MULTIPOINT).
    */
   postGISGeometryType?: 'POINT' | 'LINESTRING' | 'POLYGON' | 'MULTIPOINT' | 'MULTILINESTRING' | 'MULTIPOLYGON'
 
   /**
    * Whether to enable distance-based query endpoints.
+   * This is not mutually exclusive with other query types and is useful for all geometry types.
    * Defaults to true if not specified.
+   *
+   * - For **POINT**: Finds points within a certain radius.
+   * - For **POLYGON**: Finds polygons that are within a certain distance of a point
+   *   (e.g., "find all parks within 5 miles").
+   * - For **LINESTRING**: Finds paths/routes within a certain distance of a point
+   *   (e.g., "find all subway lines near me").
    */
   enableDistanceQueries?: boolean
 
   /**
    * Maximum distance allowed in distance queries (in the default distance unit).
    * Defaults to 100000 (100km) if not specified.
+   * Only applicable when `enableDistanceQueries` is true.
    */
   maxQueryDistance?: number
 
   /**
    * Whether to enable bounding box query endpoints.
+   * This is not mutually exclusive with other query types.
    * Defaults to true if not specified.
    */
   enableBoundingBoxQueries?: boolean
 
   /**
    * Whether to enable polygon intersection query endpoints.
+   * This is not mutually exclusive with other query types.
    * Defaults to false if not specified.
    */
   enablePolygonQueries?: boolean
@@ -180,12 +205,26 @@ export interface GeospatialCoordinatesConfig {
   /**
    * Custom API endpoint prefix for geospatial queries.
    * Defaults to '/nearby' if not specified.
+   * Only applicable if `enableDistanceQueries`, `enableBoundingBoxQueries`,
+   * or `enablePolygonQueries` is true.
+   *
+   * The generated endpoints would be:
+   * - **Distance Query**: `GET {apiEndpointPrefix}`
+   * - **Bounding Box Query**: `GET {apiEndpointPrefix}/bbox`
+   * - **Polygon Query**: `POST {apiEndpointPrefix}/polygon`
    */
   apiEndpointPrefix?: string
 
   /**
    * Whether to include elevation data in coordinates (3D coordinates).
    * Defaults to false if not specified.
+   * When true, a third value for elevation is expected in the coordinate data.
+   *
+   * - **LatLon**: `"40.7128,-74.0060,10"` (latitude, longitude, elevation)
+   * - **PostGIS/WKT**: `"POINT Z (-74.0060 40.7128 10)"`
+   * - **GeoJSON**: `{"type": "Point", "coordinates": [-74.0060, 40.7128, 10]}`
+   *
+   * The unit for elevation is determined by `defaultDistanceUnit`.
    */
   includeElevation?: boolean
 
@@ -198,6 +237,12 @@ export interface GeospatialCoordinatesConfig {
   /**
    * Whether to enable reverse geocoding capabilities.
    * Defaults to false if not specified.
+   *
+   * When enabled, the system can convert geographic coordinates (e.g., `40.7128, -74.0060`)
+   * into a human-readable address (e.g., "New York, NY, USA").
+   *
+   * This often requires integration with an external geocoding service and may have
+   * associated costs or usage limits.
    */
   enableReverseGeocoding?: boolean
 

package/src/modeling/definitions/HTML.ts

@@ -10,12 +10,25 @@ export interface HTMLConfig {
    * List of allowed HTML tags in the content.
    */
   allowedTags?: string[]
-  /**
-   * Maximum length of the HTML content.
-   */
-  maxLength?: number
   /**
    * Render mode: 'html', 'text', or 'both'.
+   *
+   * - `html` - The API returns the HTML content as-is (after sanitization based on your other rules like allowedTags).
+   * - `text` - The API returns the text content, stripping out all HTML tags.
+   *    This is extremely useful for various backend and frontend tasks:
+   *    - **Search Indexing**: You can easily feed the plain text content into a search engine like Elasticsearch
+   *      without the noise of HTML tags.
+   *    - **Content Previews/Summaries**: Displaying a snippet of the content in a list view or a notification
+   *      where formatting is not desired.
+   *    - **Compatibility**: Sending the content to systems that don't support HTML, such as plain-text
+   *      emails or SMS notifications.
+   * - `both` - The API returns an object containing both the raw HTML and the plain text version. For example:
+   *   ```json
+   *   {
+   *     "html": "<p>Hello, <strong>world</strong>!</p>",
+   *     "text": "Hello, world!"
+   *   }
+   *   ```
    */
   renderMode?: 'html' | 'text' | 'both'
   /**
@@ -106,7 +119,6 @@ export const createHTMLSemantic = (config: HTMLConfig = {}): AppliedHTMLSemantic
  */
 export const DEFAULT_HTML_CONFIG: HTMLConfig = {
   allowedTags: ['b', 'i', 'em', 'strong', 'a', 'ul', 'ol', 'li', 'p', 'br', 'pre', 'code', 'div', 'span'],
-  maxLength: 10000,
   renderMode: 'html',
   sanitizeLevel: 'strict',
   allowImages: true,

package/src/modeling/definitions/Markdown.ts

@@ -10,12 +10,20 @@ export interface MarkdownConfig {
    * List of allowed HTML tags in the rendered output.
    */
   allowedTags?: string[]
-  /**
-   * Maximum length of the markdown content.
-   */
-  maxLength?: number
   /**
    * Render mode: 'html', 'text', or 'both'.
+   * This controls how the stored Markdown content is transformed and returned by the API.
+   *
+   * - `html` - The API converts the Markdown to HTML and returns the sanitized result.
+   * - `text` - The original Markdown as when created, but sanitized.
+   * - `both` - The API returns an object containing both the rendered HTML and the plain text version.
+   *   This provides maximum flexibility for client applications.
+   *   ```json
+   *   {
+   *     "html": "<h1>Title</h1><p>Some <strong>bold</strong> text.</p>",
+   *     "text": "Title Some bold text."
+   *   }
+   *   ```
    */
   renderMode?: 'html' | 'text' | 'both'
   /**
@@ -102,7 +110,6 @@ export const createMarkdownSemantic = (config: MarkdownConfig = {}): AppliedMark
  */
 export const DEFAULT_MARKDOWN_CONFIG: MarkdownConfig = {
   allowedTags: ['b', 'i', 'em', 'strong', 'a', 'ul', 'ol', 'li', 'p', 'br', 'pre', 'code'],
-  maxLength: 10000,
   renderMode: 'html',
   sanitizeLevel: 'strict',
   allowImages: true,

package/src/modeling/definitions/Phone.ts

@@ -15,18 +15,17 @@ export interface PhoneConfig {
 
   /**
    * Whether the phone number must include a country code.
-   * Defaults to true for E.164 format.
+   * Defaults to true for international format.
    */
   requireCountryCode?: boolean
 
   /**
    * Format for phone number validation and display.
-   * - 'E.164': International format with + prefix (e.g., +1234567890)
    * - 'national': Country-specific format without country code
-   * - 'international': International format with country code
+   * - 'international': E.164 international format with + prefix (e.g., +1234567890)
    * - 'custom': Use customFormat pattern
    */
-  format?: 'E.164' | 'national' | 'international' | 'custom'
+  format?: 'national' | 'international' | 'custom'
 
   /**
    * Custom format pattern for phone number validation.
@@ -51,9 +50,8 @@ export interface PhoneConfig {
    * Method to use for phone verification.
    * - 'sms': Send verification code via SMS
    * - 'call': Make verification call
-   * - 'none': No verification required
    */
-  verificationMethod?: 'sms' | 'call' | 'none'
+  verificationMethod?: 'sms' | 'call'
 
   /**
    * Custom metadata for the phone field.
@@ -105,11 +103,11 @@ export const createPhoneSemantic = (config: PhoneConfig = {}): AppliedPhoneSeman
 
 /**
  * Default configuration for Phone semantic.
- * Uses E.164 format with country code required and SMS verification.
+ * Uses international format with country code required and SMS verification.
  */
 export const DEFAULT_PHONE_CONFIG: PhoneConfig = {
   requireCountryCode: true,
-  format: 'E.164',
+  format: 'international',
   allowExtension: false,
   requireVerification: false,
   verificationMethod: 'sms',

package/src/modeling/definitions/PublicUniqueName.ts

@@ -7,7 +7,7 @@ import { SemanticType } from '../Semantics.js'
  */
 export interface PublicUniqueNameConfig {
   /**
-   * The source field to generate the slug from (e.g., 'title').
+   * The key of the source field to generate the slug from.
    * Default to the field that is annotated with the Title semantic.
    */
   sourceField?: string
@@ -15,10 +15,6 @@ export interface PublicUniqueNameConfig {
    * Separator character to use in the slug (default: '-').
    */
   separator?: string
-  /**
-   * Maximum length of the slug (default: 64).
-   */
-  maxLength?: number
   /**
    * Whether the slug is case sensitive (default: false).
    */
@@ -27,10 +23,6 @@ export interface PublicUniqueNameConfig {
    * Whether to allow Unicode characters in the slug (default: false).
    */
   allowUnicode?: boolean
-  /**
-   * Name of a custom generator function to use for slug creation.
-   */
-  customGenerator?: string
   /**
    * Whether to allow duplicate slugs (default: false).
    */
@@ -91,7 +83,6 @@ export const createPublicUniqueNameSemantic = (
  */
 export const DEFAULT_PUBLIC_UNIQUE_NAME_CONFIG: PublicUniqueNameConfig = {
   separator: '-',
-  maxLength: 64,
   caseSensitive: false,
   allowUnicode: false,
   allowDuplicates: false,