@itwin/core-common 5.14.0-dev.22 → 5.14.0-dev.23

package/lib/esm/annotation/TextField.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TextField.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextField.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG,YAAY,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,aAAa,CAAC;AAE3H;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,iBAAiB;IAChC,qGAAqG;IACrG,YAAY,EAAE,MAAM,CAAC;IACrB,kHAAkH;IAClH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;CACpC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,iBAAiB;IAChC,iEAAiE;IACjE,SAAS,EAAE,UAAU,CAAC;IACtB,+EAA+E;IAC/E,UAAU,EAAE,MAAM,CAAC;IACnB,6HAA6H;IAC7H,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC,4BAA4B,CAAC;IAC3C,mDAAmD;IACnD,aAAa,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC;CAC5C;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,8FAA8F;IAC9F,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,6FAA6F;IAC7F,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,0BAA0B,CAAC;CACvC"}
+{"version":3,"file":"TextField.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextField.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG,YAAY,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,aAAa,CAAC;AAE3H;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,WAAW,iBAAiB;IAChC,qGAAqG;IACrG,YAAY,EAAE,MAAM,CAAC;IACrB,kHAAkH;IAClH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;IACnC;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;CACxC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,iBAAiB;IAChC,iEAAiE;IACjE,SAAS,EAAE,UAAU,CAAC;IACtB,+EAA+E;IAC/E,UAAU,EAAE,MAAM,CAAC;IACnB,6HAA6H;IAC7H,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC,4BAA4B,CAAC;IAC3C,mDAAmD;IACnD,aAAa,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC;CAC5C;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,8FAA8F;IAC9F,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,6FAA6F;IAC7F,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,0BAA0B,CAAC;IACtC,oFAAoF;IACpF,QAAQ,CAAC,EAAE,0BAA0B,CAAC;CACvC"}

package/lib/esm/annotation/TextField.js.map

@@ -1 +1 @@
-{"version":3,"file":"TextField.js","sourceRoot":"","sources":["../../../src/annotation/TextField.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*----------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Annotation\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\n\r\n/** Enumerates the different kinds of [Property]($ecschema-metadata) values that can be used as the basis for a [[FieldRun]]'s display string.\r\n * A field's property type is derived from the property's [PrimitiveType]($ecschema-metadata) and other attributes like its [PrimitiveOrEnumPropertyBase.extendedTypeName]($ecschema-metadata).\r\n * The conversion of the raw property value into a display string can be customized by different [[FieldFormatOptions]] based on its type.\r\n * The following types are currently recognized:\r\n *  - \"quantity\": an often-unitized scalar value like a distance or area, formatted using a quantity [Format]($core-quantity).\r\n *  - \"coordinate\": a 2- or 3-dimensional point, with each component formatted as a \"quantity\".\r\n *  - \"boolean\": a true or false value.\r\n *  - \"datetime\": an ECMAScript [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date).\r\n *  - \"int-enum\": an integer [EnumerationProperty]($ecschema-metadata) formatted using the enum value's display label.\r\n *  - \"string-enum\": a string [EnumerationProperty]($ecschema-metadata) formatted using the enum value's display label.\r\n *  - \"string\": a value convertible to a string.\r\n * @note Currently, only formatting of \"string\" and \"datetime\" types is implemented. Other types are converted to and formatted as \"string\".\r\n * @beta\r\n */\r\nexport type FieldPropertyType = \"quantity\" | \"coordinate\" | \"string\" | \"boolean\" | \"datetime\" | \"int-enum\" | \"string-enum\";\r\n\r\n/** A chain of property accesses that resolves to a primitive value that forms the basis of the displayed content\r\n * of a [[FieldRun]].\r\n   * The simplest property paths consist of a [[propertyName]] and nothing else, where `propertyName` identifies\r\n   * a primitive property.\r\n   * If `propertyName` identifies a struct or array property, then additional [[accessors]] are required to identify the specific value.\r\n   * Some examples:\r\n   * ```\r\n   * | Access String | propertyName | accessors |\r\n   * | ------------- | ------------ | --------- |\r\n   * | name          | \"name\"       | undefined |\r\n   * | spouse.name   | \"spouse\"     | [name]    |\r\n   * | colors[2]     | \"colors\"     | [2]       |\r\n   * | spouse.favoriteRestaurants[1].address | \"spouse\" | [\"favoriteRestaurants\", 1, \"address\"] |\r\n   * ```\r\n * @beta\r\n */\r\nexport interface FieldPropertyPath {\r\n  /** The name of the BIS property of the [[FieldPropertyHost]] that serves as the root of the path. */\r\n  propertyName: string;\r\n  /** Property names and/or array indices describing the path from [[propertyName]] to the ultimate BIS property. */\r\n  accessors?: Array<string | number>;\r\n}\r\n\r\n/** Describes the source of the property value against which a [[FieldPropertyPath]] is evaluated.\r\n * A field property is always hosted by an [Element]($backend). It may refer to a property belonging to any of the following:\r\n * - The element's BIS class itself;\r\n * - One of the element's [ElementAspect]($backend)s;\r\n * - Or an [EC view]($docs/learning/ECSqlReference/Views.md) with the same ECInstanceId as the element.\r\n * The [[schemaName]] and [[className]] should always identify the exact class that contains [[FieldPropertyPath.propertyName]] - not a subclass thereof.\r\n * @beta\r\n */\r\nexport interface FieldPropertyHost {\r\n  /** The Id of the [Element]($backend) that hosts the property. */\r\n  elementId: Id64String;\r\n  /** The name of the schema containing the class identified by [[className]]. */\r\n  schemaName: string;\r\n  /** The name of the exact class (not a subclass) containing the property identified by [[FieldPropertyPath.propertyName]]. */\r\n  className: string;\r\n}\r\n\r\n/** As part of [[FieldFormatOptions]], specifies how to modify the case of the display string.\r\n * \"as-is\" leaves it unmodified. \"upper\" and \"lower\" convert it to all upper-case or all lower-case, respectively.\r\n * @beta\r\n */\r\nexport type FieldCase = \"as-is\" | \"upper\" | \"lower\";\r\n\r\n/** As part of a [[FieldFormatOptions]], specifies how to format properties of [[FieldPropertyType]] \"datetime\".\r\n * @beta\r\n */\r\nexport interface DateTimeFieldFormatOptions {\r\n  /** The locale with which to localize the display string.\r\n   * Default: \"en-US\".\r\n   */\r\n  locale?: Intl.UnicodeBCP47LocaleIdentifier;\r\n  /** Describes how to produce the display string. */\r\n  formatOptions?: Intl.DateTimeFormatOptions;\r\n}\r\n\r\n/** Customizes how to format the raw property value resolved by a [[FieldPropertyPath]] into a [[FieldRun]]'s display string.\r\n * The exact options used depend upon the [[FieldPropertyType]].\r\n * @beta\r\n */\r\nexport interface FieldFormatOptions {\r\n  /** A string inserted before the formatted string. This string is not affected by [[case]]. */\r\n  prefix?: string;\r\n  /** A string inserted after the formatted string. This string is not affected by [[case]]. */\r\n  suffix?: string;\r\n  /** Modifies the case of the formatted string. */\r\n  case?: FieldCase;\r\n  /** Formatting options for [[FieldPropertyType]] \"datetime\". */\r\n  dateTime?: DateTimeFieldFormatOptions;\r\n}\r\n"]}
+{"version":3,"file":"TextField.js","sourceRoot":"","sources":["../../../src/annotation/TextField.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*----------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Annotation\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\n\r\n/** Enumerates the different kinds of [Property]($ecschema-metadata) values that can be used as the basis for a [[FieldRun]]'s display string.\r\n * A field's property type is derived from the property's [PrimitiveType]($ecschema-metadata) and other attributes like its [PrimitiveOrEnumPropertyBase.extendedTypeName]($ecschema-metadata).\r\n * The conversion of the raw property value into a display string can be customized by different [[FieldFormatOptions]] based on its type.\r\n * The following types are currently recognized:\r\n *  - \"quantity\": an often-unitized scalar value like a distance or area, formatted using a quantity [Format]($core-quantity).\r\n *  - \"coordinate\": a 2- or 3-dimensional point, with each component formatted as a \"quantity\".\r\n *  - \"boolean\": a true or false value; currently converted via `toString()` (localized formatting not yet implemented).\r\n *  - \"datetime\": an ECMAScript [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date).\r\n *  - \"int-enum\": an integer [EnumerationProperty]($ecschema-metadata); currently converted via `toString()` (display-label lookup not yet implemented).\r\n *  - \"string-enum\": a string [EnumerationProperty]($ecschema-metadata); currently converted via `toString()` (display-label lookup not yet implemented).\r\n *  - \"string\": a value convertible to a string.\r\n * @note `\"quantity\"` and `\"coordinate\"` values format through the quantity pipeline when a\r\n * [Format]($core-quantity) resolves for the field, from the FormatSets configured via\r\n * [ElementDrivesTextAnnotation.registerFieldFormatting]($backend) or from the iModel's schemas.\r\n * Otherwise they render as `value.toString()` — a bare number, or `(x, y[, z])` for a coordinate.\r\n * @beta\r\n */\r\nexport type FieldPropertyType = \"quantity\" | \"coordinate\" | \"string\" | \"boolean\" | \"datetime\" | \"int-enum\" | \"string-enum\";\r\n\r\n/** A chain of property accesses that resolves to a primitive value that forms the basis of the displayed content\r\n * of a [[FieldRun]].\r\n   * The simplest property paths consist of a [[propertyName]] and nothing else, where `propertyName` identifies\r\n   * a primitive property.\r\n   * If `propertyName` identifies a struct or array property, then additional [[accessors]] are required to identify the specific value.\r\n   * If `propertyName` (including any [[accessors]]) resolves to a string property of extended type `Json`, such as `JsonProperties`,\r\n   * then additional [[jsonAccessors]] are required to identify a specific value within the serialized JSON.\r\n   * Some examples:\r\n   * ```\r\n   * | Access String | propertyName | accessors | jsonAccessors |\r\n   * | ------------- | ------------ | --------- | ------------- |\r\n   * | name          | \"name\"       | undefined | undefined     |\r\n   * | spouse.name   | \"spouse\"     | [name]    | undefined     |\r\n   * | colors[2]     | \"colors\"     | [2]       | undefined     |\r\n   * | spouse.favoriteRestaurants[1].address | \"spouse\" | [\"favoriteRestaurants\", 1, \"address\"] | undefined |\r\n   * | jsonProperties.contactInfo.email | \"jsonProperties\" | undefined | [\"contactInfo\", \"email\"] |\r\n   * | spouse.jsonProperties.contactInfo.phoneNumbers[0].areaCode | \"spouse\" | [\"jsonProperties\"] | [\"contactInfo\", \"phoneNumbers\", 0, \"areaCode\"] |\r\n   * ```\r\n   * A path using `jsonAccessors` must end on a scalar (string, number, or boolean); a path that ends on an object, an array,\r\n   * or a JSON `null` resolves to no value.\r\n   *\r\n   * For example, to display a value stored in an element's `JsonProperties`:\r\n   * ```ts\r\n   * [[include:TextFields_JsonAccessors]]\r\n   * ```\r\n   * Or, when the JSON property is reached through a struct member:\r\n   * ```ts\r\n   * [[include:TextFields_NestedJsonAccessors]]\r\n   * ```\r\n * @beta\r\n */\r\nexport interface FieldPropertyPath {\r\n  /** The name of the BIS property of the [[FieldPropertyHost]] that serves as the root of the path. */\r\n  propertyName: string;\r\n  /** Property names and/or array indices describing the path from [[propertyName]] to the ultimate BIS property. */\r\n  accessors?: Array<string | number>;\r\n  /** If [[propertyName]] and [[accessors]] (if defined) resolve to a BIS string property of extended type `Json`, property names and/or\r\n   * array indices for selecting a primitive value within the JSON.\r\n   */\r\n  jsonAccessors?: Array<string | number>;\r\n}\r\n\r\n/** Describes the source of the property value against which a [[FieldPropertyPath]] is evaluated.\r\n * A field property is always hosted by an [Element]($backend). It may refer to a property belonging to any of the following:\r\n * - The element's BIS class itself;\r\n * - One of the element's [ElementAspect]($backend)s;\r\n * - Or an [EC view]($docs/learning/ECSqlReference/Views.md) with the same ECInstanceId as the element.\r\n * The [[schemaName]] and [[className]] should always identify the exact class that contains [[FieldPropertyPath.propertyName]] - not a subclass thereof.\r\n * @beta\r\n */\r\nexport interface FieldPropertyHost {\r\n  /** The Id of the [Element]($backend) that hosts the property. */\r\n  elementId: Id64String;\r\n  /** The name of the schema containing the class identified by [[className]]. */\r\n  schemaName: string;\r\n  /** The name of the exact class (not a subclass) containing the property identified by [[FieldPropertyPath.propertyName]]. */\r\n  className: string;\r\n}\r\n\r\n/** As part of a [[FieldFormatOptions]], specifies how to modify the case of the display string.\r\n * \"as-is\" leaves it unmodified. \"upper\" and \"lower\" convert it to all upper-case or all lower-case, respectively.\r\n * @beta\r\n */\r\nexport type FieldCase = \"as-is\" | \"upper\" | \"lower\";\r\n\r\n/** As part of a [[FieldFormatOptions]], specifies how to format properties of [[FieldPropertyType]] \"datetime\".\r\n * @beta\r\n */\r\nexport interface DateTimeFieldFormatOptions {\r\n  /** The locale with which to localize the display string.\r\n   * Default: \"en-US\".\r\n   */\r\n  locale?: Intl.UnicodeBCP47LocaleIdentifier;\r\n  /** Describes how to produce the display string. */\r\n  formatOptions?: Intl.DateTimeFormatOptions;\r\n}\r\n\r\n/** As part of a [[FieldFormatOptions]], specifies how to format [[FieldPropertyType]]\r\n * `\"quantity\"` or `\"coordinate\"` values.\r\n *\r\n * [[kindOfQuantity]] and [[persistenceUnit]] are independent overrides: setting one falls\r\n * through to the property for the other, and an empty string counts as unset. A name the iModel's\r\n * schemas define may use any case and either `Schema.Item` or `Schema:Item` spelling; a\r\n * KindOfQuantity defined only by a FormatSet must match its key exactly. A field that resolves\r\n * no format renders its raw value.\r\n *\r\n * These property names are also the persisted form — a [[FieldRun]] serializes them verbatim\r\n * into its element's `TextAnnotationData` — so applications can query for annotations carrying\r\n * quantity overrides by the literal strings `\"kindOfQuantity\"` and `\"persistenceUnit\"`.\r\n * @see [Quantity formatting for text annotation fields]($docs/learning/backend/TextAnnotationFields.md)\r\n * for the full resolution order.\r\n * @beta\r\n */\r\nexport interface QuantityFieldFormatOptions {\r\n  /** Full name of a [Unit]($ecschema-metadata) (e.g. `\"Units.M\"`) the magnitude is expressed in,\r\n   * for a property that has no persistence unit of its own — a coordinate, a plain `double`, or a\r\n   * JSON leaf.\r\n   *\r\n   * Because this states what the value *means* rather than how it looks, the property's own\r\n   * persistence unit is authoritative when it has one: a `persistenceUnit` that names a different\r\n   * unit is ignored and a warning is logged.\r\n   */\r\n  persistenceUnit?: string;\r\n  /** Full name of a [KindOfQuantity]($ecschema-metadata) (e.g. `\"AecUnits.LENGTH\"`) to format\r\n   * through, overriding the property's own.\r\n   */\r\n  kindOfQuantity?: string;\r\n  /** Identifier of a FormatSet whose formats take precedence for this field, letting one iModel\r\n   * mix presentations such as metric and imperial callouts.\r\n   *\r\n   * Application-chosen, and matched against the ids supplied to\r\n   * [ElementDrivesTextAnnotation.registerFieldFormatting]($backend); iTwin.js does not\r\n   * resolve it against anything persisted in the iModel. A field naming an id that was never\r\n   * supplied resolves as if it named none: through the iModel's adopted FormatSet, then the\r\n   * schema presentation format.\r\n   */\r\n  formatSet?: string;\r\n}\r\n\r\n/** Customizes how to format the raw property value resolved by a [[FieldPropertyPath]] into a [[FieldRun]]'s display string.\r\n * The exact options used depend upon the [[FieldPropertyType]].\r\n * @beta\r\n */\r\nexport interface FieldFormatOptions {\r\n  /** A string inserted before the formatted string. This string is not affected by [[case]]. */\r\n  prefix?: string;\r\n  /** A string inserted after the formatted string. This string is not affected by [[case]]. */\r\n  suffix?: string;\r\n  /** Modifies the case of the formatted string. */\r\n  case?: FieldCase;\r\n  /** Formatting options for [[FieldPropertyType]] \"datetime\". */\r\n  dateTime?: DateTimeFieldFormatOptions;\r\n  /** Formatting options for [[FieldPropertyType]] `\"quantity\"` and `\"coordinate\"`. */\r\n  quantity?: QuantityFieldFormatOptions;\r\n}\r\n"]}

package/lib/esm/internal/annotations/FieldFormatter.d.ts

@@ -8,11 +8,40 @@ export type FieldPrimitiveValue = boolean | number | string | Date | XAndY | XYA
  * @internal
  */
 export interface FieldValue {
+    /** The raw property value, typed by [[type]]. For structured or array properties, this is
+     * the primitive scalar the [FieldRun]($common)'s propertyPath ultimately resolved to.
+     */
     value: FieldPrimitiveValue;
+    /** How [[value]] should be formatted; drives the per-type branch in [[formatFieldValue]]. */
     type: FieldPropertyType;
 }
-/** @internal */
-export declare function formatFieldValue(value: FieldValue, options: FieldFormatOptions | undefined): string | undefined;
-/** @internal */
+/** Renders one magnitude of a `"quantity"` or `"coordinate"` value — typically by applying a
+ * [FormatterSpec]($core-quantity) the caller resolved ahead of time. Supplying one is what lets
+ * field evaluation stay synchronous on paths that cannot await.
+ * @internal
+ */
+export type FormatMagnitude = (magnitude: number) => string;
+/** Arguments supplied to [[formatFieldValue]].
+ * @internal
+ */
+export interface FormatFieldValueArgs {
+    /** The resolved field value to render. */
+    value: FieldValue;
+    /** Prefix, suffix, case, and per-type options applied to the rendered string. */
+    options?: FieldFormatOptions;
+    /** Consulted only by the `"quantity"` and `"coordinate"` branches. */
+    formatMagnitude?: FormatMagnitude;
+}
+/** Formats `value` through the per-type entry in [[formatters]], wrapping the result with
+ * prefix/suffix/case.
+ *
+ * `formatMagnitude` is consulted only by the `"quantity"` and `"coordinate"` branches. Omitting
+ * it falls those values back to `value.toString()`.
+ * @internal
+ */
+export declare function formatFieldValue({ value, options, formatMagnitude }: FormatFieldValueArgs): string | undefined;
+/** Type guard for [[FieldPropertyType]] strings that have a built-in per-type formatter.
+ * @internal
+ */
 export declare function isKnownFieldPropertyType(type: string): type is FieldPropertyType;
 //# sourceMappingURL=FieldFormatter.d.ts.map

package/lib/esm/internal/annotations/FieldFormatter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FieldFormatter.d.ts","sourceRoot":"","sources":["../../../../src/internal/annotations/FieldFormatter.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAA8B,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAE/G;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,KAAK,GAAG,MAAM,GAAG,UAAU,CAAC;AAEjG;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,mBAAmB,CAAC;IAC3B,IAAI,EAAE,iBAAiB,CAAC;CACzB;AA6ED,gBAAgB;AAChB,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,kBAAkB,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAG/G;AAED,gBAAgB;AAChB,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,iBAAiB,CAEhF"}
+{"version":3,"file":"FieldFormatter.d.ts","sourceRoot":"","sources":["../../../../src/internal/annotations/FieldFormatter.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAA8B,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAE/G;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,KAAK,GAAG,MAAM,GAAG,UAAU,CAAC;AAEjG;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,KAAK,EAAE,mBAAmB,CAAC;IAC3B,6FAA6F;IAC7F,IAAI,EAAE,iBAAiB,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,SAAS,EAAE,MAAM,KAAK,MAAM,CAAC;AAsF5D;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,0CAA0C;IAC1C,KAAK,EAAE,UAAU,CAAC;IAClB,iFAAiF;IACjF,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B,sEAAsE;IACtE,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,EAAE,oBAAoB,GAAG,MAAM,GAAG,SAAS,CAG9G;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,iBAAiB,CAEhF"}

package/lib/esm/internal/annotations/FieldFormatter.js

@@ -6,9 +6,8 @@ const formatters = {
     // eslint-disable-next-line @typescript-eslint/no-base-to-string
     "string": (v, o) => formatString(v.toString(), o),
     "datetime": (v, o) => formatString(formatDateTime(v, o?.dateTime), o),
-    // eslint-disable-next-line @typescript-eslint/no-base-to-string
-    "quantity": (v, o) => formatString(v.toString(), o),
-    "coordinate": (v, o) => formatString(formatPointBasic(v), o),
+    "quantity": (v, o, fm) => formatString(formatMagnitudeValue(v, fm), o),
+    "coordinate": (v, o, fm) => formatString(formatPoint(v, fm), o),
     // eslint-disable-next-line @typescript-eslint/no-base-to-string
     "boolean": (v, o) => formatString(v.toString(), o),
     // eslint-disable-next-line @typescript-eslint/no-base-to-string
@@ -49,25 +48,56 @@ function formatDateTime(v, o) {
     }
     return undefined;
 }
-// ###TODO replace this with actual quantity coordinate formatting.
-function formatPointBasic(v) {
-    if (typeof v === "object" && "x" in v && "y" in v) {
-        const parts = [v.x, v.y];
-        const z = v.z;
-        if (undefined !== z) {
-            parts.push(z);
-        }
-        return `(${parts.join(", ")})`;
+/** A `"quantity"` magnitude rendered through `formatMagnitude`, or its raw string
+ * representation when no callback was supplied or the value is not a number.
+ */
+function formatMagnitudeValue(v, formatMagnitude) {
+    if (formatMagnitude && typeof v === "number") {
+        return formatMagnitude(v);
     }
-    return undefined;
+    // eslint-disable-next-line @typescript-eslint/no-base-to-string
+    return v.toString();
 }
-/** @internal */
-export function formatFieldValue(value, options) {
+/** A coordinate rendered as `(x, y[, z])`, each component passed through `formatMagnitude` when
+ * one is supplied. Without a callback the components render bare, with no unit labels — Core
+ * carries no built-in coordinate format.
+ */
+function formatPoint(v, formatMagnitude) {
+    const magnitudes = getCoordinateMagnitudes(v);
+    if (!magnitudes) {
+        return undefined;
+    }
+    return `(${magnitudes.map((m) => formatMagnitude ? formatMagnitude(m) : `${m}`).join(", ")})`;
+}
+/** Formats `value` through the per-type entry in [[formatters]], wrapping the result with
+ * prefix/suffix/case.
+ *
+ * `formatMagnitude` is consulted only by the `"quantity"` and `"coordinate"` branches. Omitting
+ * it falls those values back to `value.toString()`.
+ * @internal
+ */
+export function formatFieldValue({ value, options, formatMagnitude }) {
     const formatter = formatters[value.type];
-    return formatter ? formatter(value.value, options) : undefined;
+    return formatter ? formatter(value.value, options, formatMagnitude) : undefined;
 }
-/** @internal */
+/** Type guard for [[FieldPropertyType]] strings that have a built-in per-type formatter.
+ * @internal
+ */
 export function isKnownFieldPropertyType(type) {
     return type in formatters;
 }
+/** The `x`, `y` and (when present) `z` components of a coordinate value, or `undefined` if `v` is
+ * not one.
+ */
+function getCoordinateMagnitudes(v) {
+    if (typeof v !== "object" || !("x" in v) || !("y" in v)) {
+        return undefined;
+    }
+    const parts = [v.x, v.y];
+    const z = "z" in v ? v.z : undefined;
+    if (undefined !== z) {
+        parts.push(z);
+    }
+    return parts;
+}
 //# sourceMappingURL=FieldFormatter.js.map

package/lib/esm/internal/annotations/FieldFormatter.js.map

@@ -1 +1 @@
-{"version":3,"file":"FieldFormatter.js","sourceRoot":"","sources":["../../../../src/internal/annotations/FieldFormatter.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAoB/F,MAAM,UAAU,GAAmD;IACjE,gEAAgE;IAChE,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAEjD,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;IAErE,gEAAgE;IAChE,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAEnD,YAAY,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5D,gEAAgE;IAChE,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAClD,gEAAgE;IAChE,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACnD,gEAAgE;IAChE,aAAa,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;CACvD,CAAC;AAEF,SAAS,YAAY,CAAC,CAAqB,EAAE,CAAsB;IACjE,IAAI,SAAS,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QAC1B,OAAO,CAAC,CAAC;IACX,CAAC;IAED,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;QACf,KAAK,OAAO;YACV,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC;YACpB,MAAM;QACR,KAAK,OAAO;YACV,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC;YACpB,MAAM;IACV,CAAC;IAED,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;QACzB,CAAC,GAAG,GAAG,CAAC,CAAC,MAAM,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC;IAC/C,CAAC;IAED,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,cAAc,CAAC,CAAsB,EAAE,CAA8B;IAC5E,IAAI,CAAC,CAAC,CAAC,YAAY,IAAI,CAAC;QACtB,OAAO,SAAS,CAAC;IAEnB,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC,EAAE,aAAa,EAAE,CAAC;YACrB,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,IAAI,OAAO,CAAC;YACnC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBACpG,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,aAAa,CAAC,CAAC;YACnE,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;IACtB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,mEAAmE;AACnE,SAAS,gBAAgB,CAAC,CAAsB;IAC9C,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC;QAClD,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACzB,MAAM,CAAC,GAAI,CAAS,CAAC,CAAC,CAAC;QACvB,IAAI,SAAS,KAAK,CAAC,EAAE,CAAC;YACpB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChB,CAAC;QAED,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;IACjC,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,gBAAgB,CAAC,KAAiB,EAAE,OAAuC;IACzF,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACzC,OAAO,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACjE,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,wBAAwB,CAAC,IAAY;IACnD,OAAO,IAAI,IAAI,UAAU,CAAC;AAC5B,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport { XAndY, XYAndZ } from \"@itwin/core-geometry\";\r\nimport { DateTimeFieldFormatOptions, FieldFormatOptions, FieldPropertyType } from \"../../annotation/TextField\";\r\n\r\n/** A FieldPropertyPath must ultimately resolve to one of these primitive types.\r\n * @internal\r\n */\r\nexport type FieldPrimitiveValue = boolean | number | string | Date | XAndY | XYAndZ | Uint8Array;\r\n\r\n/** Resolved value of a field.\r\n * @internal\r\n */\r\nexport interface FieldValue {\r\n  value: FieldPrimitiveValue;\r\n  type: FieldPropertyType;\r\n}\r\n\r\ntype FieldFormatter = (value: FieldPrimitiveValue, options: FieldFormatOptions | undefined) => string | undefined;\r\n\r\nconst formatters: { [type: string]: FieldFormatter | undefined } = {\r\n  // eslint-disable-next-line @typescript-eslint/no-base-to-string\r\n  \"string\": (v, o) => formatString(v.toString(), o),\r\n\r\n  \"datetime\": (v, o) => formatString(formatDateTime(v, o?.dateTime), o),\r\n\r\n  // eslint-disable-next-line @typescript-eslint/no-base-to-string\r\n  \"quantity\": (v, o) => formatString(v.toString(), o),\r\n   \r\n  \"coordinate\": (v, o) => formatString(formatPointBasic(v), o),\r\n  // eslint-disable-next-line @typescript-eslint/no-base-to-string\r\n  \"boolean\": (v, o) => formatString(v.toString(), o),\r\n  // eslint-disable-next-line @typescript-eslint/no-base-to-string\r\n  \"int-enum\": (v, o) => formatString(v.toString(), o),\r\n  // eslint-disable-next-line @typescript-eslint/no-base-to-string\r\n  \"string-enum\": (v, o) => formatString(v.toString(), o),\r\n};\r\n\r\nfunction formatString(s: string | undefined, o?: FieldFormatOptions): string | undefined {\r\n  if (undefined === s || !o) {\r\n    return s;\r\n  }\r\n\r\n  switch (o.case) {\r\n    case \"upper\":\r\n      s = s.toUpperCase();\r\n      break;\r\n    case \"lower\":\r\n      s = s.toLowerCase();\r\n      break;\r\n  }\r\n\r\n  if (o.prefix || o.suffix) {\r\n    s = `${o.prefix ?? \"\"}${s}${o.suffix ?? \"\"}`;\r\n  }\r\n\r\n  return s;\r\n}\r\n\r\nfunction formatDateTime(v: FieldPrimitiveValue, o?: DateTimeFieldFormatOptions): string | undefined {\r\n  if (!(v instanceof Date))\r\n    return undefined;\r\n\r\n  if (!isNaN(v.getTime())) {\r\n    if (o?.formatOptions) {\r\n      const locale = o.locale ?? \"en-US\";\r\n      if (!Intl.DateTimeFormat.supportedLocalesOf([locale], { localeMatcher: \"lookup\" }).includes(locale)) {\r\n        return undefined;\r\n      }\r\n\r\n      const formatter = new Intl.DateTimeFormat(locale, o.formatOptions);\r\n      return formatter.format(v);\r\n    }\r\n    return v.toString();\r\n  }\r\n  return undefined;\r\n}\r\n\r\n// ###TODO replace this with actual quantity coordinate formatting.\r\nfunction formatPointBasic(v: FieldPrimitiveValue): string | undefined {\r\n  if (typeof v === \"object\" && \"x\" in v && \"y\" in v) {\r\n    const parts = [v.x, v.y];\r\n    const z = (v as any).z;\r\n    if (undefined !== z) {\r\n      parts.push(z);\r\n    }\r\n\r\n    return `(${parts.join(\", \")})`;\r\n  }\r\n\r\n  return undefined;\r\n}\r\n\r\n/** @internal */\r\nexport function formatFieldValue(value: FieldValue, options: FieldFormatOptions | undefined): string | undefined {\r\n  const formatter = formatters[value.type];\r\n  return formatter ? formatter(value.value, options) : undefined;\r\n}\r\n\r\n/** @internal */\r\nexport function isKnownFieldPropertyType(type: string): type is FieldPropertyType {\r\n  return type in formatters;\r\n}\r\n\r\n"]}
+{"version":3,"file":"FieldFormatter.js","sourceRoot":"","sources":["../../../../src/internal/annotations/FieldFormatter.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AA+B/F,MAAM,UAAU,GAAmD;IACjE,gEAAgE;IAChE,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAEjD,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;IAErE,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;IAEtE,YAAY,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;IAC/D,gEAAgE;IAChE,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAClD,gEAAgE;IAChE,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACnD,gEAAgE;IAChE,aAAa,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;CACvD,CAAC;AAEF,SAAS,YAAY,CAAC,CAAqB,EAAE,CAAsB;IACjE,IAAI,SAAS,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QAC1B,OAAO,CAAC,CAAC;IACX,CAAC;IAED,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;QACf,KAAK,OAAO;YACV,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC;YACpB,MAAM;QACR,KAAK,OAAO;YACV,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC;YACpB,MAAM;IACV,CAAC;IAED,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;QACzB,CAAC,GAAG,GAAG,CAAC,CAAC,MAAM,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC;IAC/C,CAAC;IAED,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,cAAc,CAAC,CAAsB,EAAE,CAA8B;IAC5E,IAAI,CAAC,CAAC,CAAC,YAAY,IAAI,CAAC;QACtB,OAAO,SAAS,CAAC;IAEnB,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC,EAAE,aAAa,EAAE,CAAC;YACrB,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,IAAI,OAAO,CAAC;YACnC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBACpG,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,aAAa,CAAC,CAAC;YACnE,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;IACtB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;GAEG;AACH,SAAS,oBAAoB,CAAC,CAAsB,EAAE,eAAiC;IACrF,IAAI,eAAe,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;QAC7C,OAAO,eAAe,CAAC,CAAC,CAAC,CAAC;IAC5B,CAAC;IAED,gEAAgE;IAChE,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;AACtB,CAAC;AAED;;;GAGG;AACH,SAAS,WAAW,CAAC,CAAsB,EAAE,eAAiC;IAC5E,MAAM,UAAU,GAAG,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAC9C,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;AAChG,CAAC;AAcD;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAwB;IACxF,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACzC,OAAO,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAClF,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,IAAY;IACnD,OAAO,IAAI,IAAI,UAAU,CAAC;AAC5B,CAAC;AAED;;GAEG;AACH,SAAS,uBAAuB,CAAC,CAAsB;IACrD,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC;QACxD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACzB,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACrC,IAAI,SAAS,KAAK,CAAC,EAAE,CAAC;QACpB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChB,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport { XAndY, XYAndZ } from \"@itwin/core-geometry\";\r\nimport { DateTimeFieldFormatOptions, FieldFormatOptions, FieldPropertyType } from \"../../annotation/TextField\";\r\n\r\n/** A FieldPropertyPath must ultimately resolve to one of these primitive types.\r\n * @internal\r\n */\r\nexport type FieldPrimitiveValue = boolean | number | string | Date | XAndY | XYAndZ | Uint8Array;\r\n\r\n/** Resolved value of a field.\r\n * @internal\r\n */\r\nexport interface FieldValue {\r\n  /** The raw property value, typed by [[type]]. For structured or array properties, this is\r\n   * the primitive scalar the [FieldRun]($common)'s propertyPath ultimately resolved to.\r\n   */\r\n  value: FieldPrimitiveValue;\r\n  /** How [[value]] should be formatted; drives the per-type branch in [[formatFieldValue]]. */\r\n  type: FieldPropertyType;\r\n}\r\n\r\n/** Renders one magnitude of a `\"quantity\"` or `\"coordinate\"` value — typically by applying a\r\n * [FormatterSpec]($core-quantity) the caller resolved ahead of time. Supplying one is what lets\r\n * field evaluation stay synchronous on paths that cannot await.\r\n * @internal\r\n */\r\nexport type FormatMagnitude = (magnitude: number) => string;\r\n\r\ntype FieldFormatter = (value: FieldPrimitiveValue, options: FieldFormatOptions | undefined, formatMagnitude?: FormatMagnitude) => string | undefined;\r\n\r\nconst formatters: { [type: string]: FieldFormatter | undefined } = {\r\n  // eslint-disable-next-line @typescript-eslint/no-base-to-string\r\n  \"string\": (v, o) => formatString(v.toString(), o),\r\n\r\n  \"datetime\": (v, o) => formatString(formatDateTime(v, o?.dateTime), o),\r\n\r\n  \"quantity\": (v, o, fm) => formatString(formatMagnitudeValue(v, fm), o),\r\n\r\n  \"coordinate\": (v, o, fm) => formatString(formatPoint(v, fm), o),\r\n  // eslint-disable-next-line @typescript-eslint/no-base-to-string\r\n  \"boolean\": (v, o) => formatString(v.toString(), o),\r\n  // eslint-disable-next-line @typescript-eslint/no-base-to-string\r\n  \"int-enum\": (v, o) => formatString(v.toString(), o),\r\n  // eslint-disable-next-line @typescript-eslint/no-base-to-string\r\n  \"string-enum\": (v, o) => formatString(v.toString(), o),\r\n};\r\n\r\nfunction formatString(s: string | undefined, o?: FieldFormatOptions): string | undefined {\r\n  if (undefined === s || !o) {\r\n    return s;\r\n  }\r\n\r\n  switch (o.case) {\r\n    case \"upper\":\r\n      s = s.toUpperCase();\r\n      break;\r\n    case \"lower\":\r\n      s = s.toLowerCase();\r\n      break;\r\n  }\r\n\r\n  if (o.prefix || o.suffix) {\r\n    s = `${o.prefix ?? \"\"}${s}${o.suffix ?? \"\"}`;\r\n  }\r\n\r\n  return s;\r\n}\r\n\r\nfunction formatDateTime(v: FieldPrimitiveValue, o?: DateTimeFieldFormatOptions): string | undefined {\r\n  if (!(v instanceof Date))\r\n    return undefined;\r\n\r\n  if (!isNaN(v.getTime())) {\r\n    if (o?.formatOptions) {\r\n      const locale = o.locale ?? \"en-US\";\r\n      if (!Intl.DateTimeFormat.supportedLocalesOf([locale], { localeMatcher: \"lookup\" }).includes(locale)) {\r\n        return undefined;\r\n      }\r\n\r\n      const formatter = new Intl.DateTimeFormat(locale, o.formatOptions);\r\n      return formatter.format(v);\r\n    }\r\n    return v.toString();\r\n  }\r\n  return undefined;\r\n}\r\n\r\n/** A `\"quantity\"` magnitude rendered through `formatMagnitude`, or its raw string\r\n * representation when no callback was supplied or the value is not a number.\r\n */\r\nfunction formatMagnitudeValue(v: FieldPrimitiveValue, formatMagnitude?: FormatMagnitude): string | undefined {\r\n  if (formatMagnitude && typeof v === \"number\") {\r\n    return formatMagnitude(v);\r\n  }\r\n\r\n  // eslint-disable-next-line @typescript-eslint/no-base-to-string\r\n  return v.toString();\r\n}\r\n\r\n/** A coordinate rendered as `(x, y[, z])`, each component passed through `formatMagnitude` when\r\n * one is supplied. Without a callback the components render bare, with no unit labels — Core\r\n * carries no built-in coordinate format.\r\n */\r\nfunction formatPoint(v: FieldPrimitiveValue, formatMagnitude?: FormatMagnitude): string | undefined {\r\n  const magnitudes = getCoordinateMagnitudes(v);\r\n  if (!magnitudes) {\r\n    return undefined;\r\n  }\r\n\r\n  return `(${magnitudes.map((m) => formatMagnitude ? formatMagnitude(m) : `${m}`).join(\", \")})`;\r\n}\r\n\r\n/** Arguments supplied to [[formatFieldValue]].\r\n * @internal\r\n */\r\nexport interface FormatFieldValueArgs {\r\n  /** The resolved field value to render. */\r\n  value: FieldValue;\r\n  /** Prefix, suffix, case, and per-type options applied to the rendered string. */\r\n  options?: FieldFormatOptions;\r\n  /** Consulted only by the `\"quantity\"` and `\"coordinate\"` branches. */\r\n  formatMagnitude?: FormatMagnitude;\r\n}\r\n\r\n/** Formats `value` through the per-type entry in [[formatters]], wrapping the result with\r\n * prefix/suffix/case.\r\n *\r\n * `formatMagnitude` is consulted only by the `\"quantity\"` and `\"coordinate\"` branches. Omitting\r\n * it falls those values back to `value.toString()`.\r\n * @internal\r\n */\r\nexport function formatFieldValue({ value, options, formatMagnitude }: FormatFieldValueArgs): string | undefined {\r\n  const formatter = formatters[value.type];\r\n  return formatter ? formatter(value.value, options, formatMagnitude) : undefined;\r\n}\r\n\r\n/** Type guard for [[FieldPropertyType]] strings that have a built-in per-type formatter.\r\n * @internal\r\n */\r\nexport function isKnownFieldPropertyType(type: string): type is FieldPropertyType {\r\n  return type in formatters;\r\n}\r\n\r\n/** The `x`, `y` and (when present) `z` components of a coordinate value, or `undefined` if `v` is\r\n * not one.\r\n */\r\nfunction getCoordinateMagnitudes(v: FieldPrimitiveValue): number[] | undefined {\r\n  if (typeof v !== \"object\" || !(\"x\" in v) || !(\"y\" in v)) {\r\n    return undefined;\r\n  }\r\n  const parts = [v.x, v.y];\r\n  const z = \"z\" in v ? v.z : undefined;\r\n  if (undefined !== z) {\r\n    parts.push(z);\r\n  }\r\n  return parts;\r\n}\r\n"]}

package/lib/esm/internal/cross-package.d.ts

@@ -4,5 +4,5 @@ export { MultiModelPackedFeatureTable, PackedFeatureModelTable, PackedFeatureTab
 export type { BackendReadable, BackendWritable, BackendBuffer } from "./BackendTypes";
 export { RenderMaterialParams } from "./RenderMaterialParams";
 export { RenderTextureParams } from "./RenderTextureParams";
-export { type FieldPrimitiveValue, type FieldValue, formatFieldValue, isKnownFieldPropertyType } from "./annotations/FieldFormatter";
+export { type FieldPrimitiveValue, type FieldValue, type FormatFieldValueArgs, type FormatMagnitude, formatFieldValue, isKnownFieldPropertyType } from "./annotations/FieldFormatter";
 //# sourceMappingURL=cross-package.d.ts.map

package/lib/esm/internal/cross-package.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cross-package.d.ts","sourceRoot":"","sources":["../../../src/internal/cross-package.ts"],"names":[],"mappings":"AAKA,YAAY,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/F,OAAO,EACL,KAAK,uBAAuB,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,YAAY,EAAE,KAAK,gBAAgB,EAAE,gBAAgB,EAAE,kBAAkB,EACvI,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,4BAA4B,EAAE,uBAAuB,EAAE,kBAAkB,EAC1E,MAAM,sBAAsB,CAAC;AAE9B,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACtF,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,KAAK,mBAAmB,EAAE,KAAK,UAAU,EAAE,gBAAgB,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC"}
+{"version":3,"file":"cross-package.d.ts","sourceRoot":"","sources":["../../../src/internal/cross-package.ts"],"names":[],"mappings":"AAKA,YAAY,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/F,OAAO,EACL,KAAK,uBAAuB,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,YAAY,EAAE,KAAK,gBAAgB,EAAE,gBAAgB,EAAE,kBAAkB,EACvI,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,4BAA4B,EAAE,uBAAuB,EAAE,kBAAkB,EAC1E,MAAM,sBAAsB,CAAC;AAE9B,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACtF,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,KAAK,mBAAmB,EAAE,KAAK,UAAU,EAAE,KAAK,oBAAoB,EAAE,KAAK,eAAe,EAAE,gBAAgB,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC"}

package/lib/esm/internal/cross-package.js.map

@@ -1 +1 @@
-{"version":3,"file":"cross-package.js","sourceRoot":"","sources":["../../../src/internal/cross-package.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAG/F,OAAO,EACyB,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,YAAY,EAAyB,gBAAgB,EAAE,kBAAkB,EACvI,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,4BAA4B,EAAE,uBAAuB,EAAE,kBAAkB,EAC1E,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAA6C,gBAAgB,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nexport type { DecorationGeometryProps, SnapRequestProps, SnapResponseProps } from \"./Snapping\";\r\nexport {\r\n  type EdgeAppearanceOverrides, EdgeArgs, MeshEdge, MeshEdges, MeshPolyline, type MeshPolylineList, PolylineEdgeArgs, SilhouetteEdgeArgs\r\n} from \"./RenderMesh\";\r\nexport {\r\n  MultiModelPackedFeatureTable, PackedFeatureModelTable, PackedFeatureTable\r\n} from \"./PackedFeatureTable\";\r\n// eslint-disable-next-line @typescript-eslint/no-deprecated\r\nexport type { BackendReadable, BackendWritable, BackendBuffer } from \"./BackendTypes\";\r\nexport { RenderMaterialParams } from \"./RenderMaterialParams\";\r\nexport { RenderTextureParams } from \"./RenderTextureParams\";\r\nexport { type FieldPrimitiveValue, type FieldValue, formatFieldValue, isKnownFieldPropertyType } from \"./annotations/FieldFormatter\";\r\n"]}
+{"version":3,"file":"cross-package.js","sourceRoot":"","sources":["../../../src/internal/cross-package.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAG/F,OAAO,EACyB,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,YAAY,EAAyB,gBAAgB,EAAE,kBAAkB,EACvI,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,4BAA4B,EAAE,uBAAuB,EAAE,kBAAkB,EAC1E,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAA8F,gBAAgB,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nexport type { DecorationGeometryProps, SnapRequestProps, SnapResponseProps } from \"./Snapping\";\r\nexport {\r\n  type EdgeAppearanceOverrides, EdgeArgs, MeshEdge, MeshEdges, MeshPolyline, type MeshPolylineList, PolylineEdgeArgs, SilhouetteEdgeArgs\r\n} from \"./RenderMesh\";\r\nexport {\r\n  MultiModelPackedFeatureTable, PackedFeatureModelTable, PackedFeatureTable\r\n} from \"./PackedFeatureTable\";\r\n// eslint-disable-next-line @typescript-eslint/no-deprecated\r\nexport type { BackendReadable, BackendWritable, BackendBuffer } from \"./BackendTypes\";\r\nexport { RenderMaterialParams } from \"./RenderMaterialParams\";\r\nexport { RenderTextureParams } from \"./RenderTextureParams\";\r\nexport { type FieldPrimitiveValue, type FieldValue, type FormatFieldValueArgs, type FormatMagnitude, formatFieldValue, isKnownFieldPropertyType } from \"./annotations/FieldFormatter\";\r\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/core-common",
-  "version": "5.14.0-dev.22",
+  "version": "5.14.0-dev.23",
   "description": "iTwin.js components common to frontend and backend",
   "main": "lib/cjs/core-common.js",
   "module": "lib/esm/core-common.js",
@@ -27,8 +27,8 @@
     "js-base64": "^3.6.1"
   },
   "peerDependencies": {
-    "@itwin/core-bentley": "5.14.0-dev.22",
-    "@itwin/core-geometry": "5.14.0-dev.22"
+    "@itwin/core-bentley": "5.14.0-dev.23",
+    "@itwin/core-geometry": "5.14.0-dev.23"
   },
   "devDependencies": {
     "@itwin/eslint-plugin": "^6.0.0",
@@ -40,9 +40,9 @@
     "rimraf": "^6.0.1",
     "typescript": "~5.6.2",
     "vitest": "^4.1.10",
-    "@itwin/build-tools": "5.14.0-dev.22",
-    "@itwin/core-bentley": "5.14.0-dev.22",
-    "@itwin/core-geometry": "5.14.0-dev.22"
+    "@itwin/core-bentley": "5.14.0-dev.23",
+    "@itwin/build-tools": "5.14.0-dev.23",
+    "@itwin/core-geometry": "5.14.0-dev.23"
   },
   "scripts": {
     "build": "npm run -s build:cjs && npm run -s build:esm",