@itwin/presentation-shared 0.1.0

package/lib/esm/shared/Values.js

@@ -0,0 +1,153 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { compareStrings, Id64 } from "@itwin/core-bentley";
+/** @beta */
+export var InstanceKey;
+(function (InstanceKey) {
+    /**
+     * Checks whether the two given instance keys are equal.
+     * @beta
+     */
+    function equals(lhs, rhs) {
+        return lhs.className === rhs.className && lhs.id === rhs.id;
+    }
+    InstanceKey.equals = equals;
+    /**
+     * Compares two given instance keys.
+     * @returns
+     *- `0` if they are equal
+     *- `negative value` if lhs key is less than rhs key
+     *- `positive value` if lhs key is more than rhs key
+     */
+    function compare(lhs, rhs) {
+        const classNameCompareResult = compareStrings(lhs.className, rhs.className);
+        if (classNameCompareResult !== 0) {
+            return classNameCompareResult;
+        }
+        return compareStrings(lhs.id, rhs.id);
+    }
+    InstanceKey.compare = compare;
+})(InstanceKey || (InstanceKey = {}));
+/** @beta */
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export var PrimitiveValue;
+(function (PrimitiveValue) {
+    /**
+     * Checks whether the given value is a `Point2d`.
+     * @note Since `Point3d` is a superset of `Point2d`, this function will return `true` for `Point3d` as well.
+     * @beta
+     */
+    function isPoint2d(value) {
+        if (typeof value !== "object") {
+            return false;
+        }
+        const pt = value;
+        return pt.x !== undefined && pt.y !== undefined;
+    }
+    PrimitiveValue.isPoint2d = isPoint2d;
+    /**
+     * Checks whether the given value is a `Point3d`.
+     * @beta
+     */
+    function isPoint3d(value) {
+        if (typeof value !== "object") {
+            return false;
+        }
+        const pt = value;
+        return pt.x !== undefined && pt.y !== undefined && pt.z !== undefined;
+    }
+    PrimitiveValue.isPoint3d = isPoint3d;
+})(PrimitiveValue || (PrimitiveValue = {}));
+/** @beta */
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export var TypedPrimitiveValue;
+(function (TypedPrimitiveValue) {
+    /**
+     * A function for a creating a `TypedPrimitiveValue` object.
+     * @throws Error if primitive type and value are incompatible.
+     * @beta
+     */
+    function create(value, type, koqName, extendedType) {
+        switch (type) {
+            case "Integer":
+            case "Long":
+                if (typeof value === "number") {
+                    return {
+                        type,
+                        extendedType,
+                        value,
+                    };
+                }
+                break;
+            case "Double":
+                if (typeof value === "number") {
+                    return {
+                        type,
+                        koqName,
+                        extendedType,
+                        value,
+                    };
+                }
+                break;
+            case "Boolean":
+                if (typeof value === "boolean") {
+                    return {
+                        type,
+                        extendedType,
+                        value,
+                    };
+                }
+                break;
+            case "Id":
+                if (typeof value === "string" && Id64.isId64(value)) {
+                    return {
+                        type,
+                        extendedType,
+                        value,
+                    };
+                }
+                break;
+            case "String":
+                if (typeof value === "string") {
+                    return {
+                        type,
+                        extendedType,
+                        value,
+                    };
+                }
+                break;
+            case "DateTime":
+                if (typeof value === "string" || typeof value === "number" || value instanceof Date) {
+                    return {
+                        type,
+                        extendedType,
+                        value,
+                    };
+                }
+                break;
+            case "Point3d":
+                if (PrimitiveValue.isPoint3d(value)) {
+                    return {
+                        type,
+                        extendedType,
+                        value,
+                    };
+                }
+                break;
+            case "Point2d":
+                if (PrimitiveValue.isPoint2d(value)) {
+                    return {
+                        type,
+                        extendedType,
+                        value,
+                    };
+                }
+                break;
+        }
+        throw new Error(`PrimitiveValueType ${type} isn't compatible with value ${JSON.stringify(value)}`);
+    }
+    TypedPrimitiveValue.create = create;
+})(TypedPrimitiveValue || (TypedPrimitiveValue = {}));
+//# sourceMappingURL=Values.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Values.js","sourceRoot":"","sources":["../../../src/shared/Values.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,cAAc,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AAcvE,YAAY;AACZ,MAAM,KAAW,WAAW,CAsB3B;AAtBD,WAAiB,WAAW;IAC1B;;;OAGG;IACH,SAAgB,MAAM,CAAC,GAAgB,EAAE,GAAgB;QACvD,OAAO,GAAG,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,CAAC;IAC9D,CAAC;IAFe,kBAAM,SAErB,CAAA;IACD;;;;;;OAMG;IACH,SAAgB,OAAO,CAAC,GAAgB,EAAE,GAAgB;QACxD,MAAM,sBAAsB,GAAG,cAAc,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;QAC5E,IAAI,sBAAsB,KAAK,CAAC,EAAE,CAAC;YACjC,OAAO,sBAAsB,CAAC;QAChC,CAAC;QACD,OAAO,cAAc,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;IACxC,CAAC;IANe,mBAAO,UAMtB,CAAA;AACH,CAAC,EAtBgB,WAAW,KAAX,WAAW,QAsB3B;AA2BD,YAAY;AACZ,2DAA2D;AAC3D,MAAM,KAAW,cAAc,CAyB9B;AAzBD,WAAiB,cAAc;IAC7B;;;;OAIG;IACH,SAAgB,SAAS,CAAC,KAAqB;QAC7C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,EAAE,GAAG,KAAgB,CAAC;QAC5B,OAAO,EAAE,CAAC,CAAC,KAAK,SAAS,IAAI,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC;IAClD,CAAC;IANe,wBAAS,YAMxB,CAAA;IAED;;;OAGG;IACH,SAAgB,SAAS,CAAC,KAAqB;QAC7C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,EAAE,GAAG,KAAgB,CAAC;QAC5B,OAAO,EAAE,CAAC,CAAC,KAAK,SAAS,IAAI,EAAE,CAAC,CAAC,KAAK,SAAS,IAAI,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC;IACxE,CAAC;IANe,wBAAS,YAMxB,CAAA;AACH,CAAC,EAzBgB,cAAc,KAAd,cAAc,QAyB9B;AA6CD,YAAY;AACZ,2DAA2D;AAC3D,MAAM,KAAW,mBAAmB,CAqFnC;AArFD,WAAiB,mBAAmB;IAClC;;;;OAIG;IACH,SAAgB,MAAM,CAAC,KAAqB,EAAE,IAAwB,EAAE,OAAgB,EAAE,YAAqB;QAC7G,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,SAAS,CAAC;YACf,KAAK,MAAM;gBACT,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;oBAC9B,OAAO;wBACL,IAAI;wBACJ,YAAY;wBACZ,KAAK;qBACN,CAAC;gBACJ,CAAC;gBACD,MAAM;YACR,KAAK,QAAQ;gBACX,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;oBAC9B,OAAO;wBACL,IAAI;wBACJ,OAAO;wBACP,YAAY;wBACZ,KAAK;qBACN,CAAC;gBACJ,CAAC;gBACD,MAAM;YACR,KAAK,SAAS;gBACZ,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;oBAC/B,OAAO;wBACL,IAAI;wBACJ,YAAY;wBACZ,KAAK;qBACN,CAAC;gBACJ,CAAC;gBACD,MAAM;YACR,KAAK,IAAI;gBACP,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;oBACpD,OAAO;wBACL,IAAI;wBACJ,YAAY;wBACZ,KAAK;qBACN,CAAC;gBACJ,CAAC;gBACD,MAAM;YACR,KAAK,QAAQ;gBACX,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;oBAC9B,OAAO;wBACL,IAAI;wBACJ,YAAY;wBACZ,KAAK;qBACN,CAAC;gBACJ,CAAC;gBACD,MAAM;YACR,KAAK,UAAU;gBACb,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;oBACpF,OAAO;wBACL,IAAI;wBACJ,YAAY;wBACZ,KAAK;qBACN,CAAC;gBACJ,CAAC;gBACD,MAAM;YACR,KAAK,SAAS;gBACZ,IAAI,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;oBACpC,OAAO;wBACL,IAAI;wBACJ,YAAY;wBACZ,KAAK;qBACN,CAAC;gBACJ,CAAC;gBACD,MAAM;YACR,KAAK,SAAS;gBACZ,IAAI,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;oBACpC,OAAO;wBACL,IAAI;wBACJ,YAAY;wBACZ,KAAK;qBACN,CAAC;gBACJ,CAAC;gBACD,MAAM;QACV,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,sBAAsB,IAAI,gCAAgC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACrG,CAAC;IA9Ee,0BAAM,SA8ErB,CAAA;AACH,CAAC,EArFgB,mBAAmB,KAAnB,mBAAmB,QAqFnC"}

package/lib/esm/shared/ecsql-snippets/ECSqlJoinSnippets.d.ts

@@ -0,0 +1,48 @@
+import { ECSchemaProvider, RelationshipPath, RelationshipPathStep } from "../Metadata";
+/**
+ * Describes a single JOIN step from source to target through a relationship.
+ */
+interface JoinRelationshipPathStep extends RelationshipPathStep {
+    sourceAlias: string;
+    targetAlias: string;
+    relationshipAlias: string;
+    joinType?: "inner" | "outer";
+}
+/**
+ * Describes a path of JOINs from source to target.
+ */
+type JoinRelationshipPath = RelationshipPath<JoinRelationshipPathStep>;
+/**
+ * Props for `createRelationshipPathJoinClause`.
+ */
+interface CreateRelationshipPathJoinClauseProps {
+    schemaProvider: ECSchemaProvider;
+    path: JoinRelationshipPath;
+}
+/**
+ * Creates an ECSQL JOIN snippet for given relationships' path.
+ *
+ * Possible results:
+ * - When the relationship is represented by a navigation property on either source or target:
+ *   ```SQL
+ *   INNER JOIN [target_schema_name].[target_class_name] [target_alias] ON [target_alias].[navigation_property_name].[Id] = [source_alias].[ECInstanceId]
+ *   ```
+ * - When outer joining through a non-navigation-property relationship:
+ *   ```SQL
+ *   LEFT JOIN (
+ *     SELECT [relationship_alias].*
+ *     FROM [relationship_schema_name].[relationship_class_name] [relationship_alias]
+ *     INNER JOIN [target_schema_name].[target_class_name] [target_alias] ON [target_alias].[ECInstanceId] = [relationship_alias].[TargetECInstanceId]
+ *   ) [relationship_alias]
+ *   LEFT JOIN [target_schema_name].[target_class_name] [target_alias] ON [target_alias].[ECInstanceId] = [relationship_alias].[TargetECInstanceId]
+ *   ```
+ * - When inner joining through a non-navigation-property relationship:
+ *   ```SQL
+ *   INNER JOIN [relationship_schema_name].[relationship_class_name] [relationship_alias] ON [relationship_alias].[SourceECInstanceId] = [source_alias].[ECInstanceId]
+ *   INNER JOIN [target_schema_name].[target_class_name] [target_alias] ON [target_alias].[ECInstanceId] = [relationship_alias].[TargetECInstanceId]
+ *   ```
+ * @beta
+ */
+export declare function createRelationshipPathJoinClause(props: CreateRelationshipPathJoinClauseProps): Promise<string>;
+export {};
+//# sourceMappingURL=ECSqlJoinSnippets.d.ts.map

package/lib/esm/shared/ecsql-snippets/ECSqlJoinSnippets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ECSqlJoinSnippets.d.ts","sourceRoot":"","sources":["../../../../src/shared/ecsql-snippets/ECSqlJoinSnippets.ts"],"names":[],"mappings":"AAKA,OAAO,EAAM,gBAAgB,EAAY,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAGrG;;GAEG;AACH,UAAU,wBAAyB,SAAQ,oBAAoB;IAC7D,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,KAAK,oBAAoB,GAAG,gBAAgB,CAAC,wBAAwB,CAAC,CAAC;AAEvE;;GAEG;AACH,UAAU,qCAAqC;IAC7C,cAAc,EAAE,gBAAgB,CAAC;IACjC,IAAI,EAAE,oBAAoB,CAAC;CAC5B;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAsB,gCAAgC,CAAC,KAAK,EAAE,qCAAqC,mBAqElG"}

package/lib/esm/shared/ecsql-snippets/ECSqlJoinSnippets.js

@@ -0,0 +1,135 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { getClass } from "../Metadata";
+import { createRawPropertyValueSelector } from "./ECSqlValueSelectorSnippets";
+/**
+ * Creates an ECSQL JOIN snippet for given relationships' path.
+ *
+ * Possible results:
+ * - When the relationship is represented by a navigation property on either source or target:
+ *   ```SQL
+ *   INNER JOIN [target_schema_name].[target_class_name] [target_alias] ON [target_alias].[navigation_property_name].[Id] = [source_alias].[ECInstanceId]
+ *   ```
+ * - When outer joining through a non-navigation-property relationship:
+ *   ```SQL
+ *   LEFT JOIN (
+ *     SELECT [relationship_alias].*
+ *     FROM [relationship_schema_name].[relationship_class_name] [relationship_alias]
+ *     INNER JOIN [target_schema_name].[target_class_name] [target_alias] ON [target_alias].[ECInstanceId] = [relationship_alias].[TargetECInstanceId]
+ *   ) [relationship_alias]
+ *   LEFT JOIN [target_schema_name].[target_class_name] [target_alias] ON [target_alias].[ECInstanceId] = [relationship_alias].[TargetECInstanceId]
+ *   ```
+ * - When inner joining through a non-navigation-property relationship:
+ *   ```SQL
+ *   INNER JOIN [relationship_schema_name].[relationship_class_name] [relationship_alias] ON [relationship_alias].[SourceECInstanceId] = [source_alias].[ECInstanceId]
+ *   INNER JOIN [target_schema_name].[target_class_name] [target_alias] ON [target_alias].[ECInstanceId] = [relationship_alias].[TargetECInstanceId]
+ *   ```
+ * @beta
+ */
+export async function createRelationshipPathJoinClause(props) {
+    if (props.path.length === 0) {
+        return "";
+    }
+    let prev = {
+        alias: props.path[0].sourceAlias,
+        joinPropertyName: "ECInstanceId",
+        className: props.path[0].sourceClassName,
+    };
+    let clause = "";
+    for (const stepDef of props.path) {
+        const step = await getRelationshipPathStepClasses(props.schemaProvider, stepDef);
+        const navigationProperty = await getNavigationProperty(step);
+        if (navigationProperty) {
+            const propertyDirectionMatchesRelationshipDirection = navigationProperty.direction === step.relationship.direction;
+            clause += `
+        ${getJoinClause(step.joinType)} ${getClassSelectClause(step.target, step.targetAlias)}
+        ON ${propertyDirectionMatchesRelationshipDirection
+                ? createRawPropertyValueSelector(step.targetAlias, "ECInstanceId")
+                : createRawPropertyValueSelector(step.targetAlias, navigationProperty.name, "Id")}
+          = ${propertyDirectionMatchesRelationshipDirection
+                ? createRawPropertyValueSelector(prev.alias, navigationProperty.name, "Id")
+                : createRawPropertyValueSelector(prev.alias, prev.joinPropertyName)}
+      `;
+            prev = {
+                alias: step.targetAlias,
+                className: step.target.fullName,
+                joinPropertyName: "ECInstanceId",
+            };
+        }
+        else {
+            const relationshipJoinPropertyNames = !step.relationshipReverse
+                ? { this: "SourceECInstanceId", next: "TargetECInstanceId" }
+                : { this: "TargetECInstanceId", next: "SourceECInstanceId" };
+            if (step.joinType === "outer") {
+                clause += `
+          ${getJoinClause("outer")} (
+            SELECT [${step.relationshipAlias}].*
+            FROM ${getClassSelectClause(step.relationship, step.relationshipAlias)}
+            ${getJoinClause("inner")} ${getClassSelectClause(step.target, step.targetAlias)}
+              ON ${createRawPropertyValueSelector(step.targetAlias, "ECInstanceId")}
+                = ${createRawPropertyValueSelector(step.relationshipAlias, relationshipJoinPropertyNames.next)}
+          ) [${step.relationshipAlias}]
+          ON ${createRawPropertyValueSelector(step.relationshipAlias, relationshipJoinPropertyNames.this)}
+            = ${createRawPropertyValueSelector(prev.alias, prev.joinPropertyName)}
+        `;
+            }
+            else {
+                clause += `
+          ${getJoinClause("inner")} ${getClassSelectClause(step.relationship, step.relationshipAlias)}
+            ON ${createRawPropertyValueSelector(step.relationshipAlias, relationshipJoinPropertyNames.this)}
+              = ${createRawPropertyValueSelector(prev.alias, prev.joinPropertyName)}
+        `;
+            }
+            clause += `
+        ${getJoinClause(step.joinType)} ${getClassSelectClause(step.target, step.targetAlias)}
+          ON ${createRawPropertyValueSelector(step.targetAlias, "ECInstanceId")}
+            = ${createRawPropertyValueSelector(step.relationshipAlias, relationshipJoinPropertyNames.next)}
+      `;
+            prev = {
+                alias: step.targetAlias,
+                className: step.target.fullName,
+                joinPropertyName: "ECInstanceId",
+            };
+        }
+    }
+    return clause;
+}
+async function getRelationshipPathStepClasses(schemaProvider, step) {
+    const { sourceClassName, relationshipName, targetClassName, ...rest } = step;
+    return {
+        ...rest,
+        source: await getClass(schemaProvider, sourceClassName),
+        relationship: (await getClass(schemaProvider, relationshipName)),
+        target: await getClass(schemaProvider, targetClassName),
+    };
+}
+async function getNavigationProperty(step) {
+    const source = !step.relationshipReverse ? step.source : step.target;
+    const target = !step.relationshipReverse ? step.target : step.source;
+    for (const prop of await source.getProperties()) {
+        // istanbul ignore else
+        if (prop.isNavigation() && prop.direction === "Forward" && (await prop.relationshipClass).fullName === step.relationship.fullName) {
+            return prop;
+        }
+    }
+    for (const prop of await target.getProperties()) {
+        // istanbul ignore else
+        if (prop.isNavigation() && prop.direction === "Backward" && (await prop.relationshipClass).fullName === step.relationship.fullName) {
+            return prop;
+        }
+    }
+    return undefined;
+}
+function getJoinClause(type) {
+    if (type === "outer") {
+        return "OUTER JOIN";
+    }
+    return "INNER JOIN";
+}
+function getClassSelectClause(ecClass, alias) {
+    const classSelector = `[${ecClass.schema.name}].[${ecClass.name}]`;
+    return `${classSelector} [${alias}]`;
+}
+//# sourceMappingURL=ECSqlJoinSnippets.js.map

package/lib/esm/shared/ecsql-snippets/ECSqlJoinSnippets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ECSqlJoinSnippets.js","sourceRoot":"","sources":["../../../../src/shared/ecsql-snippets/ECSqlJoinSnippets.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAwB,QAAQ,EAA0C,MAAM,aAAa,CAAC;AACrG,OAAO,EAAE,8BAA8B,EAAE,MAAM,8BAA8B,CAAC;AAyB9E;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,KAAK,UAAU,gCAAgC,CAAC,KAA4C;IACjG,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,IAAI,GAAG;QACT,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW;QAChC,gBAAgB,EAAE,cAAc;QAChC,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe;KACzC,CAAC;IACF,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,MAAM,OAAO,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACjC,MAAM,IAAI,GAAG,MAAM,8BAA8B,CAAC,KAAK,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QACjF,MAAM,kBAAkB,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,kBAAkB,EAAE,CAAC;YACvB,MAAM,6CAA6C,GAAG,kBAAkB,CAAC,SAAS,KAAK,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC;YACnH,MAAM,IAAI;UACN,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,oBAAoB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC;aAEnF,6CAA6C;gBAC3C,CAAC,CAAC,8BAA8B,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC;gBAClE,CAAC,CAAC,8BAA8B,CAAC,IAAI,CAAC,WAAW,EAAE,kBAAkB,CAAC,IAAI,EAAE,IAAI,CACpF;cAEI,6CAA6C;gBAC3C,CAAC,CAAC,8BAA8B,CAAC,IAAI,CAAC,KAAK,EAAE,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC;gBAC3E,CAAC,CAAC,8BAA8B,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,gBAAgB,CACtE;OACH,CAAC;YACF,IAAI,GAAG;gBACL,KAAK,EAAE,IAAI,CAAC,WAAW;gBACvB,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;gBAC/B,gBAAgB,EAAE,cAAc;aACjC,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,6BAA6B,GAAG,CAAC,IAAI,CAAC,mBAAmB;gBAC7D,CAAC,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,IAAI,EAAE,oBAAoB,EAAE;gBAC5D,CAAC,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;YAC/D,IAAI,IAAI,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;gBAC9B,MAAM,IAAI;YACN,aAAa,CAAC,OAAO,CAAC;sBACZ,IAAI,CAAC,iBAAiB;mBACzB,oBAAoB,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,iBAAiB,CAAC;cACpE,aAAa,CAAC,OAAO,CAAC,IAAI,oBAAoB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC;mBACxE,8BAA8B,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC;oBAC/D,8BAA8B,CAAC,IAAI,CAAC,iBAAiB,EAAE,6BAA6B,CAAC,IAAI,CAAC;eAC/F,IAAI,CAAC,iBAAiB;eACtB,8BAA8B,CAAC,IAAI,CAAC,iBAAiB,EAAE,6BAA6B,CAAC,IAAI,CAAC;gBACzF,8BAA8B,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAAC;SACxE,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI;YACN,aAAa,CAAC,OAAO,CAAC,IAAI,oBAAoB,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,iBAAiB,CAAC;iBACpF,8BAA8B,CAAC,IAAI,CAAC,iBAAiB,EAAE,6BAA6B,CAAC,IAAI,CAAC;kBACzF,8BAA8B,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAAC;SAC1E,CAAC;YACJ,CAAC;YACD,MAAM,IAAI;UACN,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,oBAAoB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC;eAC9E,8BAA8B,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC;gBAC/D,8BAA8B,CAAC,IAAI,CAAC,iBAAiB,EAAE,6BAA6B,CAAC,IAAI,CAAC;OACnG,CAAC;YACF,IAAI,GAAG;gBACL,KAAK,EAAE,IAAI,CAAC,WAAW;gBACvB,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;gBAC/B,gBAAgB,EAAE,cAAc;aACjC,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAQD,KAAK,UAAU,8BAA8B,CAAC,cAAgC,EAAE,IAA8B;IAC5G,MAAM,EAAE,eAAe,EAAE,gBAAgB,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;IAC7E,OAAO;QACL,GAAG,IAAI;QACP,MAAM,EAAE,MAAM,QAAQ,CAAC,cAAc,EAAE,eAAe,CAAC;QACvD,YAAY,EAAE,CAAC,MAAM,QAAQ,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAyB;QACxF,MAAM,EAAE,MAAM,QAAQ,CAAC,cAAc,EAAE,eAAe,CAAC;KACxD,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,qBAAqB,CAAC,IAAkC;IACrE,MAAM,MAAM,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;IACrE,MAAM,MAAM,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;IACrE,KAAK,MAAM,IAAI,IAAI,MAAM,MAAM,CAAC,aAAa,EAAE,EAAE,CAAC;QAChD,uBAAuB;QACvB,IAAI,IAAI,CAAC,YAAY,EAAE,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,CAAC,MAAM,IAAI,CAAC,iBAAiB,CAAC,CAAC,QAAQ,KAAK,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;YAClI,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,MAAM,MAAM,CAAC,aAAa,EAAE,EAAE,CAAC;QAChD,uBAAuB;QACvB,IAAI,IAAI,CAAC,YAAY,EAAE,IAAI,IAAI,CAAC,SAAS,KAAK,UAAU,IAAI,CAAC,MAAM,IAAI,CAAC,iBAAiB,CAAC,CAAC,QAAQ,KAAK,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;YACnI,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,aAAa,CAAC,IAAmC;IACxD,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACrB,OAAO,YAAY,CAAC;IACtB,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAS,oBAAoB,CAAC,OAAiB,EAAE,KAAa;IAC5D,MAAM,aAAa,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,OAAO,CAAC,IAAI,GAAG,CAAC;IACnE,OAAO,GAAG,aAAa,KAAK,KAAK,GAAG,CAAC;AACvC,CAAC"}

package/lib/esm/shared/ecsql-snippets/ECSqlValueSelectorSnippets.d.ts

@@ -0,0 +1,116 @@
+import { PrimitiveValueType } from "../Metadata";
+import { PrimitiveValue, TypedPrimitiveValue } from "../Values";
+/**
+ * A union of property types that need special handling when creating a property value selector.
+ * For example, Guid values are stored as binary and need to be selected with `GuidToStr` function to
+ * get a meaningful value.
+ */
+type SpecialPropertyType = "Navigation" | "Guid" | "Point2d" | "Point3d";
+/**
+ * Props for selecting property value along with its metadata.
+ *
+ * It's recommended to only select properties with metadata only when they need additional formatting and
+ * otherwise use `createPropertyValueSelector` to select their value.
+ */
+interface PropertyValueSelectClauseProps {
+    /** Full class name of the property. Format: `SchemaName.ClassName`. */
+    propertyClassName: string;
+    /** Query alias of the class that contains the property. */
+    propertyClassAlias: string;
+    /** Name of the property. */
+    propertyName: string;
+    /** Special type of the property if it matches any. */
+    specialType?: SpecialPropertyType;
+}
+/**
+ * Props for selecting a primitive value using given ECSQL selector.
+ */
+interface PrimitiveValueSelectorProps {
+    /** ECSQL selector to query the value */
+    selector: string;
+    /** Type of the value. Defaults to `String`. */
+    type?: PrimitiveValueType;
+}
+/**
+ * A union of prop types for selecting a value and its metadata in ECSQL query.
+ * @internal This is an internal type used in public API.
+ */
+export type TypedValueSelectClauseProps = PropertyValueSelectClauseProps | TypedPrimitiveValue | PrimitiveValueSelectorProps;
+/** @internal */
+export declare namespace TypedValueSelectClauseProps {
+    /** @internal */
+    function isPropertySelector(props: TypedValueSelectClauseProps): props is PropertyValueSelectClauseProps;
+    /** @internal */
+    function isPrimitiveValue(props: TypedValueSelectClauseProps): props is TypedPrimitiveValue;
+    /** @internal */
+    function isPrimitiveValueSelector(props: TypedValueSelectClauseProps): props is PrimitiveValueSelectorProps;
+}
+/**
+ * Creates an ECSQL selector for raw property value, or, optionally - it's component. Example result:
+ * `[classAlias].[propertyName].[componentName]`.
+ *
+ * @beta
+ */
+export declare function createRawPropertyValueSelector(classAlias: string, propertyName: string, componentName?: string): string;
+/**
+ * Creates an ECSQL selector for a raw primitive value.
+ * - `undefined` is selected as `NULL`.
+ * - `Date` values are selected in julian day format.
+ * - `Point2d` and `Point3d` values are selected as serialized JSON objects, e.g. `{ x: 1, y: 2, z: 3 }`.
+ * - Other kinds of values are selected as-is.
+ *
+ * @beta
+ */
+export declare function createRawPrimitiveValueSelector(value: PrimitiveValue | undefined): string;
+/**
+ * Creates a clause for returning `NULL` when `checkSelector` returns a falsy value, or result of `valueSelector`
+ * otherwise. Example result: `IIF(CHECK_SELECTOR, VALUE_SELECTOR, NULL)`.
+ *
+ * @note In SQL `NULL` is not considered falsy, so when checking for `NULL` values, the `checkSelector` should
+ * be like `{selector} IS NOT NULL` rather than just `${selector}`.
+ *
+ * @beta
+ */
+export declare function createNullableSelector(props: {
+    checkSelector: string;
+    valueSelector: string;
+}): string;
+/**
+ * Create an ECSQL selector combined of multiple typed value selectors in a form of a JSON array. This allows handling results
+ * of each value selector individually when parsing query result.
+ *
+ * Example result: `json_array(VALUE_SELECTOR_1, VALUE_SELECTOR_2, ...)`.
+ *
+ * Optionally, the function also accepts a `checkSelector` argument, which can be used to make the selector return
+ * `NULL` result when the argument selector results in `NULL`. Example result with `checkSelector`:
+ * `IIF(CHECK_SELECTOR, json_array(VALUE_SELECTOR_1, VALUE_SELECTOR_2, ...), NULL)`.
+ *
+ * @note The resulting JSON is of `ConcatenatedValue` type and it's recommended to use `ConcatenatedValue.serialize` to
+ * handle each individual part.
+ *
+ * @see `ConcatenatedValue`
+ *
+ * @beta
+ */
+export declare function createConcatenatedValueJsonSelector(selectors: TypedValueSelectClauseProps[], checkSelector?: string): string;
+/**
+ * Create an ECSQL selector combined of multiple typed value selectors in a form of a string.
+ *
+ * Example result: `VALUE_SELECTOR_1 || VALUE_SELECTOR_2 || ...`.
+ *
+ * Optionally, the function also accepts a `checkSelector` argument, which can be used to make the selector return
+ * `NULL` result when `checkSelector` results in a falsy value. Example result with `checkSelector`:
+ * `IIF(CHECK_SELECTOR, VALUE_SELECTOR_1 || VALUE_SELECTOR_2 || ..., NULL)`.
+ *
+ * @note Not all types of `TypedValueSelectClauseProps` can be serialized to a user-friendly string, e.g. when
+ * selecting a numeric value with units, this function is going to select the raw value. To create properly formatted
+ * concatenated values:
+ * 1. They should be selected with `createConcatenatedValueJsonSelector`, which returns a serialized JSON object.
+ * 2. The JSON should be parsed from resulting string and passed to `ConcatenatedValue.serialize`, which additionally
+ *    takes a formatter. One can be created using `createDefaultValueFormatter`.
+ *
+ * @beta
+ */
+export declare function createConcatenatedValueStringSelector(selectors: TypedValueSelectClauseProps[], checkSelector?: string): string;
+export {};
+//# sourceMappingURL=ECSqlValueSelectorSnippets.d.ts.map

package/lib/esm/shared/ecsql-snippets/ECSqlValueSelectorSnippets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ECSqlValueSelectorSnippets.d.ts","sourceRoot":"","sources":["../../../../src/shared/ecsql-snippets/ECSqlValueSelectorSnippets.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAEhE;;;;GAIG;AACH,KAAK,mBAAmB,GAAG,YAAY,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;AAEzE;;;;;GAKG;AACH,UAAU,8BAA8B;IACtC,uEAAuE;IACvE,iBAAiB,EAAE,MAAM,CAAC;IAC1B,2DAA2D;IAC3D,kBAAkB,EAAE,MAAM,CAAC;IAC3B,4BAA4B;IAC5B,YAAY,EAAE,MAAM,CAAC;IACrB,sDAAsD;IACtD,WAAW,CAAC,EAAE,mBAAmB,CAAC;CACnC;AAED;;GAEG;AACH,UAAU,2BAA2B;IACnC,wCAAwC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,IAAI,CAAC,EAAE,kBAAkB,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG,8BAA8B,GAAG,mBAAmB,GAAG,2BAA2B,CAAC;AAE7H,gBAAgB;AAEhB,yBAAiB,2BAA2B,CAAC;IAC3C,gBAAgB;IAChB,SAAgB,kBAAkB,CAAC,KAAK,EAAE,2BAA2B,GAAG,KAAK,IAAI,8BAA8B,CAE9G;IACD,gBAAgB;IAChB,SAAgB,gBAAgB,CAAC,KAAK,EAAE,2BAA2B,GAAG,KAAK,IAAI,mBAAmB,CAEjG;IACD,gBAAgB;IAChB,SAAgB,wBAAwB,CAAC,KAAK,EAAE,2BAA2B,GAAG,KAAK,IAAI,2BAA2B,CAEjH;CACF;AAED;;;;;GAKG;AACH,wBAAgB,8BAA8B,CAAC,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,CAMvH;AAED;;;;;;;;GAQG;AACH,wBAAgB,+BAA+B,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS,UAqBhF;AAED;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE;IAAE,aAAa,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAEtG;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,mCAAmC,CAAC,SAAS,EAAE,2BAA2B,EAAE,EAAE,aAAa,CAAC,EAAE,MAAM,UAMnH;AAmED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,qCAAqC,CAAC,SAAS,EAAE,2BAA2B,EAAE,EAAE,aAAa,CAAC,EAAE,MAAM,UAMrH"}