@itwin/presentation-shared 0.1.0

package/lib/esm/shared/Formatting.js

@@ -0,0 +1,127 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { assert } from "@itwin/core-bentley";
+import { ConcatenatedValue, ConcatenatedValuePart } from "./ConcatenatedValue";
+import { julianToDateTime } from "./InternalUtils";
+import { getClass } from "./Metadata";
+/**
+ * Formats a concatenated value into a string, taking into account different types of `ConcatenatedValuePart` that
+ * the value consists of.
+ *
+ * @throws Error if a `ConcatenatedValuePart` in given `ConcatenatedValue` references a non-primitive, `IGeometry` or `Binary` property.
+ * @beta
+ */
+export async function formatConcatenatedValue(props) {
+    const { value, schemaProvider, valueFormatter } = props;
+    if (typeof value === "string") {
+        return valueFormatter({ value, type: "String" });
+    }
+    return ConcatenatedValue.serialize({
+        parts: value,
+        partFormatter: async (part) => {
+            // strings are converted to typed strings
+            if (ConcatenatedValuePart.isString(part)) {
+                part = {
+                    value: part,
+                    type: "String",
+                };
+            }
+            // for property parts - find property metadata and create `TypedPrimitiveValue` for them.
+            if (ConcatenatedValuePart.isProperty(part)) {
+                const property = await getProperty(part, schemaProvider);
+                if (!property?.isPrimitive()) {
+                    throw new Error(`Concatenated values formatter expects a primitive property, but it's not.`);
+                }
+                if (property.primitiveType === "IGeometry") {
+                    throw new Error(`Concatenated values formatter does not support "IGeometry" values, but the provided ${part.className}.${part.propertyName} property is.`);
+                }
+                if (property.primitiveType === "Binary") {
+                    throw new Error(`Concatenated values formatter does not support "Binary" values, but the provided ${part.className}.${part.propertyName} property is.`);
+                }
+                part = {
+                    type: property.primitiveType,
+                    extendedType: property.extendedTypeName,
+                    koqName: (await property.kindOfQuantity)?.fullName,
+                    value: part.value,
+                };
+            }
+            // finally, use provided value formatter to create a string from `TypedPrimitiveValue`
+            return valueFormatter(part);
+        },
+    });
+}
+async function getProperty({ className, propertyName }, schemaProvider) {
+    const propertyClass = await getClass(schemaProvider, className);
+    return propertyClass.getProperty(propertyName);
+}
+/**
+ * A values' formatter that knows how to format the following types:
+ * - `Boolean` values are formatted to either "true" or "false".
+ * - `Integer` and `Long` values are rounded to the closest integer.
+ * - `Double` values are rounded to 2 decimal places.
+ * - `DateTime` values accept 2 formats in addition to `Date`:
+ *   - if the value is numeric, assume it's a julian day format,
+ *   - if the value is string, assume it's an ISO 8601 format.
+ *   If extended type is set to `ShortDate`, the date is formatted as locale date string. Otherwise, it's
+ *   formatted as locale date + time string.
+ * - `Point2d` values are formatted in `(x, y)` format.
+ * - `Point3d` values are formatted in `(x, y, z)` format.
+ * - `String` and `Id` values are turned as-is.
+ *
+ * @beta
+ */
+export function createDefaultValueFormatter() {
+    const formatters = [applyBooleanFormatting, applyNumericFormatting, applyDatesFormatting, applyPointsFormatting];
+    return async function (value) {
+        for (const formatter of formatters) {
+            const result = formatter(value);
+            if (!!result) {
+                return result;
+            }
+        }
+        assert(typeof value.value === "undefined" || typeof value.value === "boolean" || typeof value.value === "number" || typeof value.value === "string");
+        return value.value.toString();
+    };
+}
+function applyBooleanFormatting(value) {
+    if (value.type === "Boolean") {
+        return Boolean(value.value).toString();
+    }
+    return undefined;
+}
+function applyNumericFormatting(value) {
+    if (value.type === "Integer" || value.type === "Long") {
+        return Math.round(value.value).toLocaleString();
+    }
+    if (value.type === "Double") {
+        return value.value.toLocaleString(undefined, { minimumFractionDigits: 2, maximumFractionDigits: 2 });
+    }
+    return undefined;
+}
+function applyDatesFormatting(value) {
+    function getDate(julianOrDate) {
+        return typeof julianOrDate === "number" ? julianToDateTime(julianOrDate) : typeof julianOrDate === "string" ? new Date(julianOrDate) : julianOrDate;
+    }
+    if (value.type !== "DateTime") {
+        return undefined;
+    }
+    if (value.extendedType === "ShortDate") {
+        return getDate(value.value).toLocaleDateString();
+    }
+    return getDate(value.value).toLocaleString();
+}
+function applyPointsFormatting(value) {
+    function formatComponent(n) {
+        return applyNumericFormatting({ type: "Double", value: n });
+    }
+    if (value.type === "Point3d") {
+        return `(${formatComponent(value.value.x)}, ${formatComponent(value.value.y)}, ${formatComponent(value.value.z)})`;
+    }
+    if (value.type === "Point2d") {
+        return `(${formatComponent(value.value.x)}, ${formatComponent(value.value.y)})`;
+    }
+    return undefined;
+}
+//# sourceMappingURL=Formatting.js.map

package/lib/esm/shared/Formatting.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Formatting.js","sourceRoot":"","sources":["../../../src/shared/Formatting.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAoB,QAAQ,EAAE,MAAM,YAAY,CAAC;AAUxD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,KAI7C;IACC,MAAM,EAAE,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC;IACxD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,cAAc,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;IACnD,CAAC;IACD,OAAO,iBAAiB,CAAC,SAAS,CAAC;QACjC,KAAK,EAAE,KAAK;QACZ,aAAa,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YAC5B,yCAAyC;YACzC,IAAI,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzC,IAAI,GAAG;oBACL,KAAK,EAAE,IAAI;oBACX,IAAI,EAAE,QAAQ;iBACf,CAAC;YACJ,CAAC;YACD,yFAAyF;YACzF,IAAI,qBAAqB,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC3C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;gBACzD,IAAI,CAAC,QAAQ,EAAE,WAAW,EAAE,EAAE,CAAC;oBAC7B,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAC;gBAC/F,CAAC;gBACD,IAAI,QAAQ,CAAC,aAAa,KAAK,WAAW,EAAE,CAAC;oBAC3C,MAAM,IAAI,KAAK,CACb,uFAAuF,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,YAAY,eAAe,CAC1I,CAAC;gBACJ,CAAC;gBACD,IAAI,QAAQ,CAAC,aAAa,KAAK,QAAQ,EAAE,CAAC;oBACxC,MAAM,IAAI,KAAK,CACb,oFAAoF,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,YAAY,eAAe,CACvI,CAAC;gBACJ,CAAC;gBACD,IAAI,GAAG;oBACL,IAAI,EAAE,QAAQ,CAAC,aAAa;oBAC5B,YAAY,EAAE,QAAQ,CAAC,gBAAgB;oBACvC,OAAO,EAAE,CAAC,MAAM,QAAQ,CAAC,cAAc,CAAC,EAAE,QAAQ;oBAClD,KAAK,EAAE,IAAI,CAAC,KAAK;iBACK,CAAC;YAC3B,CAAC;YACD,sFAAsF;YACtF,OAAO,cAAc,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,EAAE,SAAS,EAAE,YAAY,EAA+C,EAAE,cAAgC;IACnI,MAAM,aAAa,GAAG,MAAM,QAAQ,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;IAChE,OAAO,aAAa,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,2BAA2B;IACzC,MAAM,UAAU,GAAG,CAAC,sBAAsB,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,qBAAqB,CAAC,CAAC;IACjH,OAAO,KAAK,WAAW,KAA0B;QAC/C,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;YAChC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;gBACb,OAAO,MAAM,CAAC;YAChB,CAAC;QACH,CAAC;QAED,MAAM,CAAC,OAAO,KAAK,CAAC,KAAK,KAAK,WAAW,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC;QACrJ,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;IAChC,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB,CAAC,KAA0B;IACxD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;IACzC,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,sBAAsB,CAAC,KAA0B;IACxD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QACtD,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,cAAc,EAAE,CAAC;IAClD,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,SAAS,EAAE,EAAE,qBAAqB,EAAE,CAAC,EAAE,qBAAqB,EAAE,CAAC,EAAE,CAAC,CAAC;IACvG,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,oBAAoB,CAAC,KAA0B;IACtD,SAAS,OAAO,CAAC,YAAoC;QACnD,OAAO,OAAO,YAAY,KAAK,QAAQ,CAAC,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,YAAY,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;IACtJ,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QAC9B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,KAAK,CAAC,YAAY,KAAK,WAAW,EAAE,CAAC;QACvC,OAAO,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,kBAAkB,EAAE,CAAC;IACnD,CAAC;IACD,OAAO,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,cAAc,EAAE,CAAC;AAC/C,CAAC;AAED,SAAS,qBAAqB,CAAC,KAA0B;IACvD,SAAS,eAAe,CAAC,CAAS;QAChC,OAAO,sBAAsB,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,CAAE,CAAC;IAC/D,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,IAAI,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;IACrH,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,IAAI,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;IAClF,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/lib/esm/shared/InstanceLabelSelectClauseFactory.d.ts

@@ -0,0 +1,129 @@
+import { ConcatenatedValue } from "./ConcatenatedValue";
+import { TypedValueSelectClauseProps } from "./ecsql-snippets/ECSqlValueSelectorSnippets";
+import { ECClassHierarchyInspector } from "./Metadata";
+/**
+ * Props for `IInstanceLabelSelectClauseFactory.createSelectClause`.
+ */
+interface CreateInstanceLabelSelectClauseProps {
+    /**
+     * Alias of an ECSQL class referring to the target instance whose label should be selected.
+     *
+     * Example:
+     * ```ts
+     * const selectClause = `
+     *   SELECT ${await factory.createSelectClause({ classAlias: "x" })}
+     *   FROM bis.GeometricElement3d AS x
+     * `;
+     * ```
+     */
+    classAlias: string;
+    /**
+     * An optional full name of the class whose instance label is to be selected.
+     *
+     * The attribute's purpose is purely for optimization and `IInstanceLabelSelectClauseFactory` should not
+     * rely on this to be set to a leaf class or set at all. However, when this name is provided, some factory
+     * implementations may be able to create a more efficient select clause (e.g. drop some pieces of clause
+     * that don't apply for given class).
+     */
+    className?: string;
+    /**
+     * An optional function for concatenating multiple `TypedValueSelectClauseProps`. Selectors' concatenation
+     * is used when a label consists of multiple pieces, e.g.:
+     * - `[` - string,
+     * - `this.PropertyX` - property value selector,
+     * - `]` - string.
+     *
+     * It's concatenator's job to serialize those pieces into a single selector and, depending on the use case,
+     * it may do that in multiple ways. For example:
+     *
+     * - `createConcatenatedValueJsonSelector` serializes parts into a JSON array selector. This allows the array to
+     *   be parsed after the query is run, where each part can be handled individually without losing its metadata.
+     *   This is the default value.
+     *
+     * - `createConcatenatedValueStringSelector` concatenates parts into a string using SQLite's `||` operator. While
+     *   this way of concatenation looses metadata (thus disabling formatting of the values), it tries to produce the
+     *   value to be as close as possible to the formatted one. This concatenator may be used to create a label for using
+     *   in the query `WHERE` clause.
+     *
+     * @see `createConcatenatedValueJsonSelector`
+     * @see `createConcatenatedValueStringSelector`
+     */
+    selectorsConcatenator?: (selectors: TypedValueSelectClauseProps[], checkSelector?: string) => string;
+}
+/**
+ * An interface for a factory that knows how create instance label select clauses.
+ * @see `createDefaultInstanceLabelSelectClauseFactory`
+ * @see `createClassBasedInstanceLabelSelectClauseFactory`
+ * @see `createBisInstanceLabelSelectClauseFactory`
+ * @beta
+ */
+export interface IInstanceLabelSelectClauseFactory {
+    /** Creates a select clause for an instance label. */
+    createSelectClause(props: CreateInstanceLabelSelectClauseProps): Promise<string>;
+}
+/**
+ * Parses an instance label from query result into a string or a `ConcatenatedValue`. The latter type of result
+ * is expected when label selector is created using `IInstanceLabelSelectClauseFactory.createSelectClause` with
+ * `createConcatenatedValueJsonSelector`.
+ *
+ * @beta
+ */
+export declare function parseInstanceLabel(value: string | undefined): ConcatenatedValue | string;
+/**
+ * Creates a label select clause in a format `Class label [base36(briefcase id)-base36(local id)]`, where
+ * local and briefcase IDs are calculated based on ECInstance ID:
+ * - `{briefcase id} = ECInstanceId >> 40`
+ * - `{local id} = ECInstanceId & (1 << 40 - 1)`
+ *
+ * @see https://www.itwinjs.org/presentation/advanced/defaultbisrules/#label-overrides
+ * @beta
+ */
+export declare function createDefaultInstanceLabelSelectClauseFactory(): IInstanceLabelSelectClauseFactory;
+/**
+ * An association of a class and an instance label select clause factory method.
+ */
+interface ClassBasedLabelSelectClause {
+    /** Full class name */
+    className: string;
+    /** A factory method to create an instance label select clause */
+    clause: (props: CreateInstanceLabelSelectClauseProps) => Promise<string>;
+}
+/**
+ * Props for `createClassBasedInstanceLabelSelectClauseFactory`.
+ */
+interface ClassBasedInstanceLabelSelectClauseFactoryProps {
+    /** Access to ECClass hierarchy in the iModel. */
+    classHierarchyInspector: ECClassHierarchyInspector;
+    /**
+     * A prioritized list of instance label selectors associated to classes they should be applied to.
+     *
+     * Because the list may contain clauses for classes in the same class hierarchy, and the factory
+     * handles them in given order, the order of clauses should be from the most specific class to the
+     * most general one.
+     */
+    clauses: ClassBasedLabelSelectClause[];
+    /**
+     * A fallback label clause factory for when class-based factory doesn't produce a label.
+     * Defaults to the result of `createDefaultInstanceLabelSelectClauseFactory`.
+     */
+    defaultClauseFactory?: IInstanceLabelSelectClauseFactory;
+}
+/**
+ * Creates an instance label select clause based on its class.
+ * @beta
+ */
+export declare function createClassBasedInstanceLabelSelectClauseFactory(props: ClassBasedInstanceLabelSelectClauseFactoryProps): IInstanceLabelSelectClauseFactory;
+/**
+ * Props for `createBisInstanceLabelSelectClauseFactory`.
+ */
+interface BisInstanceLabelSelectClauseFactoryProps {
+    classHierarchyInspector: ECClassHierarchyInspector;
+}
+/**
+ * Creates a label select clause according to BIS instance label rules.
+ * @see https://www.itwinjs.org/presentation/advanced/defaultbisrules/#label-overrides
+ * @beta
+ */
+export declare function createBisInstanceLabelSelectClauseFactory(props: BisInstanceLabelSelectClauseFactoryProps): IInstanceLabelSelectClauseFactory;
+export {};
+//# sourceMappingURL=InstanceLabelSelectClauseFactory.d.ts.map

package/lib/esm/shared/InstanceLabelSelectClauseFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InstanceLabelSelectClauseFactory.d.ts","sourceRoot":"","sources":["../../../src/shared/InstanceLabelSelectClauseFactory.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAuE,2BAA2B,EAAE,MAAM,6CAA6C,CAAC;AAC/J,OAAO,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAC;AAEvD;;GAEG;AACH,UAAU,oCAAoC;IAC5C;;;;;;;;;;OAUG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,qBAAqB,CAAC,EAAE,CAAC,SAAS,EAAE,2BAA2B,EAAE,EAAE,aAAa,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;CACtG;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iCAAiC;IAChD,qDAAqD;IACrD,kBAAkB,CAAC,KAAK,EAAE,oCAAoC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAClF;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,iBAAiB,GAAG,MAAM,CAaxF;AAED;;;;;;;;GAQG;AACH,wBAAgB,6CAA6C,IAAI,iCAAiC,CAmBjG;AAED;;GAEG;AACH,UAAU,2BAA2B;IACnC,sBAAsB;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,iEAAiE;IACjE,MAAM,EAAE,CAAC,KAAK,EAAE,oCAAoC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CAC1E;AAED;;GAEG;AACH,UAAU,+CAA+C;IACvD,iDAAiD;IACjD,uBAAuB,EAAE,yBAAyB,CAAC;IAEnD;;;;;;OAMG;IACH,OAAO,EAAE,2BAA2B,EAAE,CAAC;IAEvC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,iCAAiC,CAAC;CAC1D;AAED;;;GAGG;AACH,wBAAgB,gDAAgD,CAAC,KAAK,EAAE,+CAA+C,GAAG,iCAAiC,CA0D1J;AAED;;GAEG;AACH,UAAU,wCAAwC;IAChD,uBAAuB,EAAE,yBAAyB,CAAC;CACpD;AAED;;;;GAIG;AACH,wBAAgB,yCAAyC,CAAC,KAAK,EAAE,wCAAwC,GAAG,iCAAiC,CAuC5I"}

package/lib/esm/shared/InstanceLabelSelectClauseFactory.js

@@ -0,0 +1,160 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { createConcatenatedValueJsonSelector, createRawPropertyValueSelector } from "./ecsql-snippets/ECSqlValueSelectorSnippets";
+/**
+ * Parses an instance label from query result into a string or a `ConcatenatedValue`. The latter type of result
+ * is expected when label selector is created using `IInstanceLabelSelectClauseFactory.createSelectClause` with
+ * `createConcatenatedValueJsonSelector`.
+ *
+ * @beta
+ */
+export function parseInstanceLabel(value) {
+    if (!value) {
+        return "";
+    }
+    if ((value.startsWith("[") && value.endsWith("]")) || (value.startsWith("{") && value.endsWith("}"))) {
+        try {
+            return JSON.parse(value);
+        }
+        catch {
+            // fall through
+        }
+    }
+    // not a JSON object/array
+    return value;
+}
+/**
+ * Creates a label select clause in a format `Class label [base36(briefcase id)-base36(local id)]`, where
+ * local and briefcase IDs are calculated based on ECInstance ID:
+ * - `{briefcase id} = ECInstanceId >> 40`
+ * - `{local id} = ECInstanceId & (1 << 40 - 1)`
+ *
+ * @see https://www.itwinjs.org/presentation/advanced/defaultbisrules/#label-overrides
+ * @beta
+ */
+export function createDefaultInstanceLabelSelectClauseFactory() {
+    return {
+        async createSelectClause(props) {
+            return `(
+        SELECT
+          ${concatenate(props, [
+                {
+                    selector: `COALESCE(
+                ${createRawPropertyValueSelector("c", "DisplayLabel")},
+                ${createRawPropertyValueSelector("c", "Name")}
+              )`,
+                },
+                ...createECInstanceIdSuffixSelectors(props.classAlias),
+            ])}
+        FROM [meta].[ECClassDef] AS [c]
+        WHERE [c].[ECInstanceId] = ${createRawPropertyValueSelector(props.classAlias, "ECClassId")}
+      )`;
+        },
+    };
+}
+/**
+ * Creates an instance label select clause based on its class.
+ * @beta
+ */
+export function createClassBasedInstanceLabelSelectClauseFactory(props) {
+    const { classHierarchyInspector, clauses: labelClausesByClass } = props;
+    const defaultClauseFactory = props.defaultClauseFactory ?? createDefaultInstanceLabelSelectClauseFactory();
+    async function getLabelClausesForClass(queryClassName) {
+        const matchingLabelClauses = await Promise.all(labelClausesByClass.map(async (entry) => {
+            if (await classHierarchyInspector.classDerivesFrom(entry.className, queryClassName)) {
+                // label selector is intended for a more specific class than we're selecting from - need to include it
+                // as query results (on polymorphic select) are going to include more specific class instances too
+                return entry;
+            }
+            if (await classHierarchyInspector.classDerivesFrom(queryClassName, entry.className)) {
+                // label selector is intended for a base class of what query is selecting - need to include it as
+                // we want base class label selectors to apply to subclass instances
+                return entry;
+            }
+            return undefined;
+        }));
+        function filterNotUndefined(x) {
+            return !!x;
+        }
+        return matchingLabelClauses.filter(filterNotUndefined);
+    }
+    return {
+        async createSelectClause(clauseProps) {
+            if (labelClausesByClass.length === 0) {
+                return defaultClauseFactory.createSelectClause(clauseProps);
+            }
+            const labelClausePromises = clauseProps.className ? await getLabelClausesForClass(clauseProps.className) : labelClausesByClass;
+            if (labelClausePromises.length === 0) {
+                return defaultClauseFactory.createSelectClause(clauseProps);
+            }
+            const labelClauses = await Promise.all(labelClausePromises.map(async ({ className, clause }) => ({
+                className,
+                clause: await clause(clauseProps),
+            })));
+            return `COALESCE(
+        ${labelClauses
+                .map(({ className, clause }) => `
+              IIF(
+                ${createRawPropertyValueSelector(clauseProps.classAlias, "ECClassId")} IS (${className}),
+                ${clause.trim()},
+                NULL
+              )
+            `.trim())
+                .join(", ")},
+        ${await defaultClauseFactory.createSelectClause(clauseProps)}
+      )`;
+        },
+    };
+}
+/**
+ * Creates a label select clause according to BIS instance label rules.
+ * @see https://www.itwinjs.org/presentation/advanced/defaultbisrules/#label-overrides
+ * @beta
+ */
+export function createBisInstanceLabelSelectClauseFactory(props) {
+    const clauses = [];
+    const factory = createClassBasedInstanceLabelSelectClauseFactory({
+        classHierarchyInspector: props.classHierarchyInspector,
+        clauses,
+    });
+    clauses.push({
+        className: "BisCore.GeometricElement",
+        clause: async ({ classAlias, ...rest }) => `
+        COALESCE(
+          ${createRawPropertyValueSelector(classAlias, "CodeValue")},
+          ${concatenate(rest, [{ selector: createRawPropertyValueSelector(classAlias, "UserLabel") }, ...createECInstanceIdSuffixSelectors(classAlias)], `${createRawPropertyValueSelector(classAlias, "UserLabel")} IS NOT NULL`)}
+        )
+      `,
+    }, {
+        className: "BisCore.Element",
+        clause: async ({ classAlias }) => `
+        COALESCE(
+          ${createRawPropertyValueSelector(classAlias, "UserLabel")},
+          ${createRawPropertyValueSelector(classAlias, "CodeValue")}
+        )
+      `,
+    }, {
+        className: "BisCore.Model",
+        clause: async ({ classAlias, ...rest }) => `(
+        SELECT ${await factory.createSelectClause({ ...rest, classAlias: "e", className: "BisCore.Element" })}
+        FROM [bis].[Element] AS [e]
+        WHERE [e].[ECInstanceId] = ${createRawPropertyValueSelector(classAlias, "ModeledElement", "Id")}
+      )`,
+    });
+    return factory;
+}
+function createECInstanceIdSuffixSelectors(classAlias) {
+    return [
+        { value: ` [`, type: "String" },
+        { selector: `CAST(base36(${createRawPropertyValueSelector(classAlias, "ECInstanceId")} >> 40) AS TEXT)` },
+        { value: `-`, type: "String" },
+        { selector: `CAST(base36(${createRawPropertyValueSelector(classAlias, "ECInstanceId")} & ((1 << 40) - 1)) AS TEXT)` },
+        { value: `]`, type: "String" },
+    ];
+}
+function concatenate(props, selectors, checkSelector) {
+    return (props.selectorsConcatenator ?? createConcatenatedValueJsonSelector)(selectors, checkSelector);
+}
+//# sourceMappingURL=InstanceLabelSelectClauseFactory.js.map

package/lib/esm/shared/InstanceLabelSelectClauseFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InstanceLabelSelectClauseFactory.js","sourceRoot":"","sources":["../../../src/shared/InstanceLabelSelectClauseFactory.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAGhG,OAAO,EAAE,mCAAmC,EAAE,8BAA8B,EAA+B,MAAM,6CAA6C,CAAC;AAmE/J;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAyB;IAC1D,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;QACrG,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;QAAC,MAAM,CAAC;YACP,eAAe;QACjB,CAAC;IACH,CAAC;IACD,0BAA0B;IAC1B,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,6CAA6C;IAC3D,OAAO;QACL,KAAK,CAAC,kBAAkB,CAAC,KAA2C;YAClE,OAAO;;YAED,WAAW,CAAC,KAAK,EAAE;gBACnB;oBACE,QAAQ,EAAE;kBACN,8BAA8B,CAAC,GAAG,EAAE,cAAc,CAAC;kBACnD,8BAA8B,CAAC,GAAG,EAAE,MAAM,CAAC;gBAC7C;iBACH;gBACD,GAAG,iCAAiC,CAAC,KAAK,CAAC,UAAU,CAAC;aACvD,CAAC;;qCAEyB,8BAA8B,CAAC,KAAK,CAAC,UAAU,EAAE,WAAW,CAAC;QAC1F,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC;AAmCD;;;GAGG;AACH,MAAM,UAAU,gDAAgD,CAAC,KAAsD;IACrH,MAAM,EAAE,uBAAuB,EAAE,OAAO,EAAE,mBAAmB,EAAE,GAAG,KAAK,CAAC;IACxE,MAAM,oBAAoB,GAAG,KAAK,CAAC,oBAAoB,IAAI,6CAA6C,EAAE,CAAC;IAC3G,KAAK,UAAU,uBAAuB,CAAC,cAAsB;QAC3D,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,GAAG,CAC5C,mBAAmB,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACtC,IAAI,MAAM,uBAAuB,CAAC,gBAAgB,CAAC,KAAK,CAAC,SAAS,EAAE,cAAc,CAAC,EAAE,CAAC;gBACpF,sGAAsG;gBACtG,kGAAkG;gBAClG,OAAO,KAAK,CAAC;YACf,CAAC;YACD,IAAI,MAAM,uBAAuB,CAAC,gBAAgB,CAAC,cAAc,EAAE,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;gBACpF,iGAAiG;gBACjG,oEAAoE;gBACpE,OAAO,KAAK,CAAC;YACf,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CACH,CAAC;QACF,SAAS,kBAAkB,CAAI,CAAgB;YAC7C,OAAO,CAAC,CAAC,CAAC,CAAC;QACb,CAAC;QACD,OAAO,oBAAoB,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;IACzD,CAAC;IACD,OAAO;QACL,KAAK,CAAC,kBAAkB,CAAC,WAAiD;YACxE,IAAI,mBAAmB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACrC,OAAO,oBAAoB,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;YAC9D,CAAC;YAED,MAAM,mBAAmB,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,uBAAuB,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC;YAC/H,IAAI,mBAAmB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACrC,OAAO,oBAAoB,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;YAC9D,CAAC;YAED,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,GAAG,CACpC,mBAAmB,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC;gBACxD,SAAS;gBACT,MAAM,EAAE,MAAM,MAAM,CAAC,WAAW,CAAC;aAClC,CAAC,CAAC,CACJ,CAAC;YAEF,OAAO;UACH,YAAY;iBACX,GAAG,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,CAC7B;;kBAEM,8BAA8B,CAAC,WAAW,CAAC,UAAU,EAAE,WAAW,CAAC,QAAQ,SAAS;kBACpF,MAAM,CAAC,IAAI,EAAE;;;aAGlB,CAAC,IAAI,EAAE,CACT;iBACA,IAAI,CAAC,IAAI,CAAC;UACX,MAAM,oBAAoB,CAAC,kBAAkB,CAAC,WAAW,CAAC;QAC5D,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC;AASD;;;;GAIG;AACH,MAAM,UAAU,yCAAyC,CAAC,KAA+C;IACvG,MAAM,OAAO,GAAkC,EAAE,CAAC;IAClD,MAAM,OAAO,GAAG,gDAAgD,CAAC;QAC/D,uBAAuB,EAAE,KAAK,CAAC,uBAAuB;QACtD,OAAO;KACR,CAAC,CAAC;IACH,OAAO,CAAC,IAAI,CACV;QACE,SAAS,EAAE,0BAA0B;QACrC,MAAM,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,CAAC;;YAErC,8BAA8B,CAAC,UAAU,EAAE,WAAW,CAAC;YACvD,WAAW,CACX,IAAI,EACJ,CAAC,EAAE,QAAQ,EAAE,8BAA8B,CAAC,UAAU,EAAE,WAAW,CAAC,EAAE,EAAE,GAAG,iCAAiC,CAAC,UAAU,CAAC,CAAC,EACzH,GAAG,8BAA8B,CAAC,UAAU,EAAE,WAAW,CAAC,cAAc,CACzE;;OAEJ;KACF,EACD;QACE,SAAS,EAAE,iBAAiB;QAC5B,MAAM,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;;YAE5B,8BAA8B,CAAC,UAAU,EAAE,WAAW,CAAC;YACvD,8BAA8B,CAAC,UAAU,EAAE,WAAW,CAAC;;OAE5D;KACF,EACD;QACE,SAAS,EAAE,eAAe;QAC1B,MAAM,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,CAAC;iBAChC,MAAM,OAAO,CAAC,kBAAkB,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC;;qCAExE,8BAA8B,CAAC,UAAU,EAAE,gBAAgB,EAAE,IAAI,CAAC;QAC/F;KACH,CACF,CAAC;IACF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,iCAAiC,CAAC,UAAkB;IAC3D,OAAO;QACL,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC/B,EAAE,QAAQ,EAAE,eAAe,8BAA8B,CAAC,UAAU,EAAE,cAAc,CAAC,kBAAkB,EAAE;QACzG,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC9B,EAAE,QAAQ,EAAE,eAAe,8BAA8B,CAAC,UAAU,EAAE,cAAc,CAAC,8BAA8B,EAAE;QACrH,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE;KAC/B,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAClB,KAA+G,EAC/G,SAAwC,EACxC,aAAsB;IAEtB,OAAO,CAAC,KAAK,CAAC,qBAAqB,IAAI,mCAAmC,CAAC,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;AACxG,CAAC"}

package/lib/esm/shared/InternalUtils.d.ts

@@ -0,0 +1,3 @@
+/** @internal */
+export declare function julianToDateTime(julianDate: number): Date;
+//# sourceMappingURL=InternalUtils.d.ts.map

package/lib/esm/shared/InternalUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InternalUtils.d.ts","sourceRoot":"","sources":["../../../src/shared/InternalUtils.ts"],"names":[],"mappings":"AAKA,gBAAgB;AAChB,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAGzD"}

package/lib/esm/shared/InternalUtils.js

@@ -0,0 +1,10 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @internal */
+export function julianToDateTime(julianDate) {
+    const millis = (julianDate - 2440587.5) * 86400000;
+    return new Date(millis);
+}
+//# sourceMappingURL=InternalUtils.js.map

package/lib/esm/shared/InternalUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InternalUtils.js","sourceRoot":"","sources":["../../../src/shared/InternalUtils.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,gBAAgB;AAChB,MAAM,UAAU,gBAAgB,CAAC,UAAkB;IACjD,MAAM,MAAM,GAAG,CAAC,UAAU,GAAG,SAAS,CAAC,GAAG,QAAQ,CAAC;IACnD,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC;AAC1B,CAAC"}

package/lib/esm/shared/Logging.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Defines a type for a logging function.
+ * @beta
+ */
+export type LogFunction = (category: string, message: string) => void;
+/**
+ * Defines logging severities.
+ * @beta
+ */
+export type LogLevel = "error" | "warning" | "info" | "trace";
+/**
+ * An interface for a logger used by presentation packages.
+ * @beta
+ */
+export interface ILogger {
+    isEnabled: (category: string, level: LogLevel) => boolean;
+    logError: LogFunction;
+    logWarning: LogFunction;
+    logInfo: LogFunction;
+    logTrace: LogFunction;
+}
+/**
+ * A logger implementation that does nothing.
+ * @beta
+ */
+export declare const NOOP_LOGGER: ILogger;
+//# sourceMappingURL=Logging.d.ts.map

package/lib/esm/shared/Logging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Logging.d.ts","sourceRoot":"","sources":["../../../src/shared/Logging.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;AAEtE;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC;AAE9D;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,SAAS,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,KAAK,OAAO,CAAC;IAC1D,QAAQ,EAAE,WAAW,CAAC;IACtB,UAAU,EAAE,WAAW,CAAC;IACxB,OAAO,EAAE,WAAW,CAAC;IACrB,QAAQ,EAAE,WAAW,CAAC;CACvB;AAED;;;GAGG;AAEH,eAAO,MAAM,WAAW,EAAE,OAMzB,CAAC"}

package/lib/esm/shared/Logging.js

@@ -0,0 +1,17 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/**
+ * A logger implementation that does nothing.
+ * @beta
+ */
+// istanbul ignore next
+export const NOOP_LOGGER = {
+    isEnabled: () => false,
+    logError: () => { },
+    logWarning: () => { },
+    logInfo: () => { },
+    logTrace: () => { },
+};
+//# sourceMappingURL=Logging.js.map

package/lib/esm/shared/Logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Logging.js","sourceRoot":"","sources":["../../../src/shared/Logging.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AA0BhG;;;GAGG;AACH,uBAAuB;AACvB,MAAM,CAAC,MAAM,WAAW,GAAY;IAClC,SAAS,EAAE,GAAG,EAAE,CAAC,KAAK;IACtB,QAAQ,EAAE,GAAG,EAAE,GAAE,CAAC;IAClB,UAAU,EAAE,GAAG,EAAE,GAAE,CAAC;IACpB,OAAO,EAAE,GAAG,EAAE,GAAE,CAAC;IACjB,QAAQ,EAAE,GAAG,EAAE,GAAE,CAAC;CACnB,CAAC"}

package/lib/esm/shared/MappedTypes.d.ts

@@ -0,0 +1,11 @@
+/**
+ * An utility `Omit` type which works with union types.
+ * @beta
+ */
+export type OmitOverUnion<T, K extends PropertyKey> = T extends T ? Omit<T, K> : never;
+/**
+ * An utility generic type to get array element's type.
+ * @beta
+ */
+export type ArrayElement<ArrayType extends readonly unknown[]> = ArrayType extends readonly (infer ElementType)[] ? ElementType : never;
+//# sourceMappingURL=MappedTypes.d.ts.map

package/lib/esm/shared/MappedTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MappedTypes.d.ts","sourceRoot":"","sources":["../../../src/shared/MappedTypes.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC;AAEvF;;;GAGG;AACH,MAAM,MAAM,YAAY,CAAC,SAAS,SAAS,SAAS,OAAO,EAAE,IAAI,SAAS,SAAS,SAAS,CAAC,MAAM,WAAW,CAAC,EAAE,GAAG,WAAW,GAAG,KAAK,CAAC"}

package/lib/esm/shared/MappedTypes.js

@@ -0,0 +1,6 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+export {};
+//# sourceMappingURL=MappedTypes.js.map

package/lib/esm/shared/MappedTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MappedTypes.js","sourceRoot":"","sources":["../../../src/shared/MappedTypes.ts"],"names":[],"mappings":"AAAA;;;gGAGgG"}