@itwin/presentation-shared 2.0.0-alpha.1 → 2.0.0-alpha.11

package/lib/cjs/shared/instance-label-factory-impls/BisInstanceLabelSelectClauseFactory.js

@@ -0,0 +1,54 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createBisInstanceLabelSelectClauseFactory = createBisInstanceLabelSelectClauseFactory;
+const ECSqlValueSelectorSnippets_js_1 = require("../ecsql-snippets/ECSqlValueSelectorSnippets.js");
+const ClassBasedInstanceLabelSelectClauseFactory_js_1 = require("./ClassBasedInstanceLabelSelectClauseFactory.js");
+const Utils_js_1 = require("./Utils.js");
+/**
+ * Creates a label select clause according to BIS instance label rules.
+ * @see https://www.itwinjs.org/presentation/advanced/defaultbisrules/#label-overrides
+ * @public
+ */
+function createBisInstanceLabelSelectClauseFactory(props) {
+    const clauses = [];
+    const factory = (0, ClassBasedInstanceLabelSelectClauseFactory_js_1.createClassBasedInstanceLabelSelectClauseFactory)({
+        classHierarchyInspector: props.classHierarchyInspector,
+        clauses,
+    });
+    clauses.push({
+        className: "BisCore.GeometricElement",
+        clause: async ({ classAlias, ...rest }) => `
+        COALESCE(
+          ${(0, ECSqlValueSelectorSnippets_js_1.createRawPropertyValueSelector)(classAlias, "CodeValue")},
+          ${(0, Utils_js_1.concatenate)(rest, [
+            { selector: (0, ECSqlValueSelectorSnippets_js_1.createRawPropertyValueSelector)(classAlias, "UserLabel") },
+            ...(0, Utils_js_1.createECInstanceIdSuffixSelectors)(classAlias),
+        ], `${(0, ECSqlValueSelectorSnippets_js_1.createRawPropertyValueSelector)(classAlias, "UserLabel")} IS NOT NULL`)}
+        )
+      `,
+    }, {
+        className: "BisCore.Element",
+        clause: async ({ classAlias }) => `
+        COALESCE(
+          ${(0, ECSqlValueSelectorSnippets_js_1.createRawPropertyValueSelector)(classAlias, "UserLabel")},
+          ${(0, ECSqlValueSelectorSnippets_js_1.createRawPropertyValueSelector)(classAlias, "CodeValue")}
+        )
+      `,
+    }, {
+        className: "BisCore.Model",
+        clause: async ({ classAlias, ...rest }) => {
+            const elementAlias = `${Utils_js_1.ALIAS_PREFIX}e`;
+            return `(
+        SELECT ${await factory.createSelectClause({ ...rest, classAlias: elementAlias, className: "BisCore.Element" })}
+        FROM [bis].[Element] AS ${elementAlias}
+        WHERE ${elementAlias}.[ECInstanceId] = ${(0, ECSqlValueSelectorSnippets_js_1.createRawPropertyValueSelector)(classAlias, "ModeledElement", "Id")}
+      )`;
+        },
+    });
+    return factory;
+}
+//# sourceMappingURL=BisInstanceLabelSelectClauseFactory.js.map

package/lib/cjs/shared/instance-label-factory-impls/BisInstanceLabelSelectClauseFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BisInstanceLabelSelectClauseFactory.js","sourceRoot":"","sources":["../../../../src/shared/instance-label-factory-impls/BisInstanceLabelSelectClauseFactory.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;AAuBhG,8FA+CC;AApED,mGAAiG;AACjG,mHAAmH;AACnH,yCAA0F;AAc1F;;;;GAIG;AACH,SAAgB,yCAAyC,CACvD,KAA+C;IAE/C,MAAM,OAAO,GAAkC,EAAE,CAAC;IAClD,MAAM,OAAO,GAAG,IAAA,gGAAgD,EAAC;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,IAAA,8DAA8B,EAAC,UAAU,EAAE,WAAW,CAAC;YACvD,IAAA,sBAAW,EACX,IAAI,EACJ;YACE,EAAE,QAAQ,EAAE,IAAA,8DAA8B,EAAC,UAAU,EAAE,WAAW,CAAC,EAAE;YACrE,GAAG,IAAA,4CAAiC,EAAC,UAAU,CAAC;SACjD,EACD,GAAG,IAAA,8DAA8B,EAAC,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,IAAA,8DAA8B,EAAC,UAAU,EAAE,WAAW,CAAC;YACvD,IAAA,8DAA8B,EAAC,UAAU,EAAE,WAAW,CAAC;;OAE5D;KACF,EACD;QACE,SAAS,EAAE,eAAe;QAC1B,MAAM,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE;YACxC,MAAM,YAAY,GAAG,GAAG,uBAAY,GAAG,CAAC;YACxC,OAAO;iBACE,MAAM,OAAO,CAAC,kBAAkB,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,YAAY,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC;kCACpF,YAAY;gBAC9B,YAAY,qBAAqB,IAAA,8DAA8B,EAAC,UAAU,EAAE,gBAAgB,EAAE,IAAI,CAAC;QAC3G,CAAC;QACH,CAAC;KACF,CACF,CAAC;IACF,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/lib/cjs/shared/instance-label-factory-impls/ClassBasedInstanceLabelSelectClauseFactory.d.ts

@@ -0,0 +1,39 @@
+import type { CreateInstanceLabelSelectClauseProps, IInstanceLabelSelectClauseFactory } from "../InstanceLabelSelectClauseFactory.js";
+import type { EC, ECClassHierarchyInspector } from "../Metadata.js";
+/**
+ * An association of a class and an instance label select clause factory method.
+ * @public
+ */
+export interface ClassBasedLabelSelectClause {
+    /** Full class name */
+    className: EC.FullClassName;
+    /** A factory method to create an instance label select clause */
+    clause: (props: CreateInstanceLabelSelectClauseProps) => Promise<string>;
+}
+/**
+ * Props for `createClassBasedInstanceLabelSelectClauseFactory`.
+ * @public
+ */
+export 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.
+ * @public
+ */
+export declare function createClassBasedInstanceLabelSelectClauseFactory(props: ClassBasedInstanceLabelSelectClauseFactoryProps): IInstanceLabelSelectClauseFactory;
+//# sourceMappingURL=ClassBasedInstanceLabelSelectClauseFactory.d.ts.map

package/lib/cjs/shared/instance-label-factory-impls/ClassBasedInstanceLabelSelectClauseFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClassBasedInstanceLabelSelectClauseFactory.d.ts","sourceRoot":"","sources":["../../../../src/shared/instance-label-factory-impls/ClassBasedInstanceLabelSelectClauseFactory.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EACV,oCAAoC,EACpC,iCAAiC,EAClC,MAAM,wCAAwC,CAAC;AAChD,OAAO,KAAK,EAAE,EAAE,EAAE,yBAAyB,EAAE,MAAM,gBAAgB,CAAC;AAEpE;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,sBAAsB;IACtB,SAAS,EAAE,EAAE,CAAC,aAAa,CAAC;IAC5B,iEAAiE;IACjE,MAAM,EAAE,CAAC,KAAK,EAAE,oCAAoC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CAC1E;AAED;;;GAGG;AACH,MAAM,WAAW,+CAA+C;IAC9D,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,CAC9D,KAAK,EAAE,+CAA+C,GACrD,iCAAiC,CAyDnC"}

package/lib/cjs/shared/instance-label-factory-impls/ClassBasedInstanceLabelSelectClauseFactory.js

@@ -0,0 +1,63 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createClassBasedInstanceLabelSelectClauseFactory = createClassBasedInstanceLabelSelectClauseFactory;
+const ECSqlValueSelectorSnippets_js_1 = require("../ecsql-snippets/ECSqlValueSelectorSnippets.js");
+const DefaultInstanceLabelSelectClauseFactory_js_1 = require("./DefaultInstanceLabelSelectClauseFactory.js");
+/**
+ * Creates an instance label select clause based on its class.
+ * @public
+ */
+function createClassBasedInstanceLabelSelectClauseFactory(props) {
+    const { classHierarchyInspector, clauses: labelClausesByClass } = props;
+    const defaultClauseFactory = props.defaultClauseFactory ?? (0, DefaultInstanceLabelSelectClauseFactory_js_1.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(
+                ${(0, ECSqlValueSelectorSnippets_js_1.createRawPropertyValueSelector)(clauseProps.classAlias, "ECClassId")} IS (${className}),
+                ${clause.trim()},
+                NULL
+              )
+            `.trim())
+                .join(", ")},
+        ${await defaultClauseFactory.createSelectClause(clauseProps)}
+      )`;
+        },
+    };
+}
+//# sourceMappingURL=ClassBasedInstanceLabelSelectClauseFactory.js.map

package/lib/cjs/shared/instance-label-factory-impls/ClassBasedInstanceLabelSelectClauseFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClassBasedInstanceLabelSelectClauseFactory.js","sourceRoot":"","sources":["../../../../src/shared/instance-label-factory-impls/ClassBasedInstanceLabelSelectClauseFactory.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;AAkDhG,4GA2DC;AA3GD,mGAAiG;AACjG,6GAA6G;AA2C7G;;;GAGG;AACH,SAAgB,gDAAgD,CAC9D,KAAsD;IAEtD,MAAM,EAAE,uBAAuB,EAAE,OAAO,EAAE,mBAAmB,EAAE,GAAG,KAAK,CAAC;IACxE,MAAM,oBAAoB,GAAG,KAAK,CAAC,oBAAoB,IAAI,IAAA,0FAA6C,GAAE,CAAC;IAC3G,KAAK,UAAU,uBAAuB,CAAC,cAAgC;QACrE,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;gBAC/C,CAAC,CAAC,MAAM,uBAAuB,CAAC,WAAW,CAAC,SAAS,CAAC;gBACtD,CAAC,CAAC,mBAAmB,CAAC;YACxB,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,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAC7G,CAAC;YAEF,OAAO;UACH,YAAY;iBACX,GAAG,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,CAC7B;;kBAEM,IAAA,8DAA8B,EAAC,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"}

package/lib/cjs/shared/instance-label-factory-impls/DefaultInstanceLabelSelectClauseFactory.d.ts

@@ -0,0 +1,12 @@
+import type { IInstanceLabelSelectClauseFactory } from "../InstanceLabelSelectClauseFactory.js";
+/**
+ * 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
+ * @public
+ */
+export declare function createDefaultInstanceLabelSelectClauseFactory(): IInstanceLabelSelectClauseFactory;
+//# sourceMappingURL=DefaultInstanceLabelSelectClauseFactory.d.ts.map

package/lib/cjs/shared/instance-label-factory-impls/DefaultInstanceLabelSelectClauseFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultInstanceLabelSelectClauseFactory.d.ts","sourceRoot":"","sources":["../../../../src/shared/instance-label-factory-impls/DefaultInstanceLabelSelectClauseFactory.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;AAEhG;;;;;;;;GAQG;AACH,wBAAgB,6CAA6C,IAAI,iCAAiC,CAoBjG"}

package/lib/cjs/shared/instance-label-factory-impls/DefaultInstanceLabelSelectClauseFactory.js

@@ -0,0 +1,40 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDefaultInstanceLabelSelectClauseFactory = createDefaultInstanceLabelSelectClauseFactory;
+const ECSqlValueSelectorSnippets_js_1 = require("../ecsql-snippets/ECSqlValueSelectorSnippets.js");
+const Utils_js_1 = require("./Utils.js");
+/**
+ * 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
+ * @public
+ */
+function createDefaultInstanceLabelSelectClauseFactory() {
+    const alias = `${Utils_js_1.ALIAS_PREFIX}c`;
+    return {
+        async createSelectClause(props) {
+            return `(
+        SELECT
+          ${(0, Utils_js_1.concatenate)(props, [
+                {
+                    selector: `COALESCE(
+                ${(0, ECSqlValueSelectorSnippets_js_1.createRawPropertyValueSelector)(alias, "DisplayLabel")},
+                ${(0, ECSqlValueSelectorSnippets_js_1.createRawPropertyValueSelector)(alias, "Name")}
+              )`,
+                },
+                ...(0, Utils_js_1.createECInstanceIdSuffixSelectors)(props.classAlias),
+            ])}
+        FROM [meta].[ECClassDef] AS ${alias}
+        WHERE ${alias}.[ECInstanceId] = ${(0, ECSqlValueSelectorSnippets_js_1.createRawPropertyValueSelector)(props.classAlias, "ECClassId")}
+      )`;
+        },
+    };
+}
+//# sourceMappingURL=DefaultInstanceLabelSelectClauseFactory.js.map

package/lib/cjs/shared/instance-label-factory-impls/DefaultInstanceLabelSelectClauseFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultInstanceLabelSelectClauseFactory.js","sourceRoot":"","sources":["../../../../src/shared/instance-label-factory-impls/DefaultInstanceLabelSelectClauseFactory.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;AAgBhG,sGAoBC;AAlCD,mGAAiG;AACjG,yCAA0F;AAI1F;;;;;;;;GAQG;AACH,SAAgB,6CAA6C;IAC3D,MAAM,KAAK,GAAG,GAAG,uBAAY,GAAG,CAAC;IACjC,OAAO;QACL,KAAK,CAAC,kBAAkB,CAAC,KAAK;YAC5B,OAAO;;YAED,IAAA,sBAAW,EAAC,KAAK,EAAE;gBACnB;oBACE,QAAQ,EAAE;kBACN,IAAA,8DAA8B,EAAC,KAAK,EAAE,cAAc,CAAC;kBACrD,IAAA,8DAA8B,EAAC,KAAK,EAAE,MAAM,CAAC;gBAC/C;iBACH;gBACD,GAAG,IAAA,4CAAiC,EAAC,KAAK,CAAC,UAAU,CAAC;aACvD,CAAC;sCAC0B,KAAK;gBAC3B,KAAK,qBAAqB,IAAA,8DAA8B,EAAC,KAAK,CAAC,UAAU,EAAE,WAAW,CAAC;QAC/F,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC"}

package/lib/cjs/shared/instance-label-factory-impls/IModelInstanceLabelSelectClauseFactory.Rules.d.ts

@@ -0,0 +1,198 @@
+/**
+ * This module contains hard copies of the code from `@itwin/presentation-common` package.
+ */
+/**
+ * This specification is designed for specifying schema requirements for the [[Ruleset]] or specific
+ * presentation rules.
+ */
+export interface RequiredSchemaSpecification {
+    /** Specifies the schema to whom the requirement is being set. */
+    name: string;
+    /**
+     * Minimum required schema version (inclusive).
+     * Format: `{read version}.{write version}.{minor version}`, e.g. `2.1.15`.
+     *
+     * @pattern ^[\d]+\.[\d]+\.[\d]+$
+     */
+    minVersion?: string;
+    /**
+     * Maximum allowed schema version (exclusive).
+     * Format: `{read version}.{write version}.{minor version}`, e.g. `2.1.15`.
+     *
+     * @pattern ^[\d]+\.[\d]+\.[\d]+$
+     */
+    maxVersion?: string;
+}
+/**
+ * Base interface for all [[Rule]] implementations.
+ */
+export interface RuleBase {
+    /** Used for serializing to JSON. */
+    ruleType: string;
+    /**
+     * Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are
+     * equal, the rules are handled in the order they're defined.
+     *
+     * @type integer
+     */
+    priority?: number;
+    /**
+     * Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule
+     * priorities and definition order). This allows adding fallback rules which can be overridden by higher-priority rules.
+     */
+    onlyIfNotHandled?: boolean;
+    /**
+     * A list of [ECSchema requirements]($docs/presentation/RequiredSchemaSpecification.md) that need to be met for the rule to be used.
+     */
+    requiredSchemas?: RequiredSchemaSpecification[];
+}
+/**
+ * Instance label override rule provides a way to set instance label to one of its property values,
+ * other attributes and/or combination of them.
+ */
+export interface InstanceLabelOverride extends RuleBase {
+    /** Used for serializing to JSON. */
+    ruleType: "InstanceLabelOverride";
+    /**
+     * Specifies the ECClass to apply this rule to.
+     */
+    class: SingleSchemaClassSpecification;
+    /**
+     * Specifications of values used to override label. The first non-empty value is used as the actual label.
+     */
+    values: InstanceLabelOverrideValueSpecification[];
+}
+/**
+ * Types of possible [[InstanceLabelOverride]] label values.
+ */
+type InstanceLabelOverrideValueSpecificationType = "Composite" | "Property" | "ClassName" | "ClassLabel" | "BriefcaseId" | "LocalId" | "String" | "RelatedInstanceLabel";
+/**
+ * Base interface for all [[InstanceLabelOverrideValueSpecification]] implementations.
+ */
+export interface InstanceLabelOverrideValueSpecificationBase {
+    /** Type of the specification */
+    specType: `${InstanceLabelOverrideValueSpecificationType}`;
+}
+/**
+ * Specification allows creating a label value composited using multiple other specifications.
+ */
+export interface InstanceLabelOverrideCompositeValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
+    specType: "Composite";
+    /**
+     * Parts of the value.
+     *
+     * If any of the parts with `isRequired` flag evaluate to an empty string, the
+     * result of this specification is also an empty string.
+     */
+    parts: Array<{
+        spec: InstanceLabelOverrideValueSpecification;
+        isRequired?: boolean;
+    }>;
+    /** Separator to use when joining the parts. Defaults to a space character. */
+    separator?: string;
+}
+/**
+ * Specification uses property value as the label content.
+ */
+export interface InstanceLabelOverridePropertyValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
+    specType: "Property";
+    /**
+     * Name of the property whose value should be used.
+     * @note A property with this name must exist on the property class (see [[propertySource]]).
+     */
+    propertyName: string;
+    /**
+     * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from [[InstanceLabelOverride.class]]
+     * to class of the property. If omitted, [[InstanceLabelOverride.class]] is used as property class.
+     */
+    propertySource?: RelationshipPathSpecification;
+}
+/**
+ * Specification uses ECClass name as the label content.
+ */
+export interface InstanceLabelOverrideClassNameSpecification extends InstanceLabelOverrideValueSpecificationBase {
+    specType: "ClassName";
+    /** Should full (`{schemaName}.{className}`) class name be used */
+    full?: boolean;
+}
+/**
+ * Specification uses ECClass display label as the label content.
+ */
+export interface InstanceLabelOverrideClassLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {
+    specType: "ClassLabel";
+}
+/**
+ * Specification returns ECInstance's briefcase ID in base36 format.
+ */
+export interface InstanceLabelOverrideBriefcaseIdSpecification extends InstanceLabelOverrideValueSpecificationBase {
+    specType: "BriefcaseId";
+}
+/**
+ * Specification returns ECInstance's local ID in base36 format.
+ */
+export interface InstanceLabelOverrideLocalIdSpecification extends InstanceLabelOverrideValueSpecificationBase {
+    specType: "LocalId";
+}
+/**
+ * Specification uses the specified value as the label content.
+ */
+export interface InstanceLabelOverrideStringValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
+    specType: "String";
+    /** The value to use as the label content. */
+    value: string;
+}
+/**
+ * Specification uses label of another related instance as the label content.
+ */
+export interface InstanceLabelOverrideRelatedInstanceLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {
+    specType: "RelatedInstanceLabel";
+    /**
+     * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from `InstanceLabelOverride.class`
+     * to class of the related instance.
+     */
+    pathToRelatedInstance: RelationshipPathSpecification;
+}
+/**
+ * Specification to define how the label for [[InstanceLabelOverride]] should be created.
+ */
+export type InstanceLabelOverrideValueSpecification = InstanceLabelOverrideCompositeValueSpecification | InstanceLabelOverridePropertyValueSpecification | InstanceLabelOverrideStringValueSpecification | InstanceLabelOverrideClassNameSpecification | InstanceLabelOverrideClassLabelSpecification | InstanceLabelOverrideBriefcaseIdSpecification | InstanceLabelOverrideLocalIdSpecification | InstanceLabelOverrideRelatedInstanceLabelSpecification;
+/**
+ * Defines direction of a relationship that should be followed
+ */
+type RelationshipDirection = "Forward" | "Backward";
+/**
+ * Specification of a single step in [[RelationshipPathSpecification]].
+ */
+export interface RelationshipStepSpecification {
+    /** This attribute specifies the ECRelationship that should be used to traverse to target class. */
+    relationship: SingleSchemaClassSpecification;
+    /** This attribute specifies the direction in which the [[relationship]] should be followed. */
+    direction: `${RelationshipDirection}`;
+    /**
+     * This attribute may be used to specialize the target of the relationship.
+     */
+    targetClass?: SingleSchemaClassSpecification;
+}
+/**
+ * Relationship path specification is used to define a relationship path to an ECClass.
+ */
+export type RelationshipPathSpecification = RelationshipStepSpecification | RelationshipStepSpecification[];
+/**
+ * This specification is used to point to specific ECClass.
+ */
+export interface SingleSchemaClassSpecification {
+    /**
+     * Specifies name of the schema which contains the target class.
+     *
+     * @pattern ^[\w\d]+$
+     */
+    schemaName: string;
+    /**
+     * Specifies name of the target class.
+     *
+     * @pattern ^[\w\d]+$
+     */
+    className: string;
+}
+export {};
+//# sourceMappingURL=IModelInstanceLabelSelectClauseFactory.Rules.d.ts.map

package/lib/cjs/shared/instance-label-factory-impls/IModelInstanceLabelSelectClauseFactory.Rules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelInstanceLabelSelectClauseFactory.Rules.d.ts","sourceRoot":"","sources":["../../../../src/shared/instance-label-factory-impls/IModelInstanceLabelSelectClauseFactory.Rules.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE,2BAA2B,EAAE,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,QAAQ;IACrD,oCAAoC;IACpC,QAAQ,EAAE,uBAAuB,CAAC;IAElC;;OAEG;IACH,KAAK,EAAE,8BAA8B,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,uCAAuC,EAAE,CAAC;CACnD;AAED;;GAEG;AACH,KAAK,2CAA2C,GAC5C,WAAW,GACX,UAAU,GACV,WAAW,GACX,YAAY,GACZ,aAAa,GACb,SAAS,GACT,QAAQ,GACR,sBAAsB,CAAC;AAE3B;;GAEG;AACH,MAAM,WAAW,2CAA2C;IAC1D,gCAAgC;IAChC,QAAQ,EAAE,GAAG,2CAA2C,EAAE,CAAC;CAC5D;AAED;;GAEG;AACH,MAAM,WAAW,gDAAiD,SAAQ,2CAA2C;IACnH,QAAQ,EAAE,WAAW,CAAC;IAEtB;;;;;OAKG;IACH,KAAK,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,uCAAuC,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAEtF,8EAA8E;IAC9E,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,+CAAgD,SAAQ,2CAA2C;IAClH,QAAQ,EAAE,UAAU,CAAC;IAErB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,cAAc,CAAC,EAAE,6BAA6B,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,2CAA4C,SAAQ,2CAA2C;IAC9G,QAAQ,EAAE,WAAW,CAAC;IAEtB,kEAAkE;IAClE,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,4CAA6C,SAAQ,2CAA2C;IAC/G,QAAQ,EAAE,YAAY,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,6CAA8C,SAAQ,2CAA2C;IAChH,QAAQ,EAAE,aAAa,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,yCAA0C,SAAQ,2CAA2C;IAC5G,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,6CAA8C,SAAQ,2CAA2C;IAChH,QAAQ,EAAE,QAAQ,CAAC;IAEnB,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,sDAAuD,SAAQ,2CAA2C;IACzH,QAAQ,EAAE,sBAAsB,CAAC;IAEjC;;;OAGG;IACH,qBAAqB,EAAE,6BAA6B,CAAC;CACtD;AAED;;GAEG;AACH,MAAM,MAAM,uCAAuC,GAC/C,gDAAgD,GAChD,+CAA+C,GAC/C,6CAA6C,GAC7C,2CAA2C,GAC3C,4CAA4C,GAC5C,6CAA6C,GAC7C,yCAAyC,GACzC,sDAAsD,CAAC;AAE3D;;GAEG;AACH,KAAK,qBAAqB,GAAG,SAAS,GAAG,UAAU,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,mGAAmG;IACnG,YAAY,EAAE,8BAA8B,CAAC;IAE7C,+FAA+F;IAC/F,SAAS,EAAE,GAAG,qBAAqB,EAAE,CAAC;IAEtC;;OAEG;IACH,WAAW,CAAC,EAAE,8BAA8B,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,6BAA6B,GAAG,6BAA6B,EAAE,CAAC;AAE5G;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB"}

package/lib/cjs/shared/instance-label-factory-impls/IModelInstanceLabelSelectClauseFactory.Rules.js

@@ -0,0 +1,10 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/**
+ * This module contains hard copies of the code from `@itwin/presentation-common` package.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IModelInstanceLabelSelectClauseFactory.Rules.js.map

package/lib/cjs/shared/instance-label-factory-impls/IModelInstanceLabelSelectClauseFactory.Rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelInstanceLabelSelectClauseFactory.Rules.js","sourceRoot":"","sources":["../../../../src/shared/instance-label-factory-impls/IModelInstanceLabelSelectClauseFactory.Rules.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG"}

package/lib/cjs/shared/instance-label-factory-impls/IModelInstanceLabelSelectClauseFactory.d.ts

@@ -0,0 +1,34 @@
+import type { ECSqlQueryExecutor } from "../ECSqlCore.js";
+import type { IInstanceLabelSelectClauseFactory } from "../InstanceLabelSelectClauseFactory.js";
+import type { ECClassHierarchyInspector, ECSchemaProvider } from "../Metadata.js";
+/**
+ * Props for `createIModelInstanceLabelSelectClauseFactory`.
+ * @public
+ */
+interface IModelInstanceLabelSelectClauseFactoryProps {
+    /**
+     * Combined access to the iModel for querying PresentationRules rulesets and inspecting class hierarchy.
+     * Follows the same combined-access pattern as other iModel-backed factories in this package.
+     */
+    imodelAccess: ECSqlQueryExecutor & ECClassHierarchyInspector & ECSchemaProvider;
+    /**
+     * A fallback label clause factory used when no applicable `InstanceLabelOverride` rules are found
+     * or when the `PresentationRules` schema is absent from the iModel.
+     * Defaults to the result of `createBisInstanceLabelSelectClauseFactory`.
+     */
+    defaultClauseFactory?: IInstanceLabelSelectClauseFactory;
+}
+/**
+ * Creates an instance label select clause factory that reads `InstanceLabelOverride` rules from
+ * `PresentationRules` rulesets stored in the iModel and compiles them into ECSQL label selectors.
+ *
+ * Rules are loaded lazily on first use and cached per factory instance. Rulesets are discovered
+ * by querying `PresentationRules.Ruleset`. When the `PresentationRules` schema is not imported
+ * into the iModel the factory transparently falls back to `defaultClauseFactory` (defaults
+ * to `createBisInstanceLabelSelectClauseFactory`).
+ *
+ * @public
+ */
+export declare function createIModelInstanceLabelSelectClauseFactory(props: IModelInstanceLabelSelectClauseFactoryProps): IInstanceLabelSelectClauseFactory;
+export {};
+//# sourceMappingURL=IModelInstanceLabelSelectClauseFactory.d.ts.map

package/lib/cjs/shared/instance-label-factory-impls/IModelInstanceLabelSelectClauseFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelInstanceLabelSelectClauseFactory.d.ts","sourceRoot":"","sources":["../../../../src/shared/instance-label-factory-impls/IModelInstanceLabelSelectClauseFactory.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC1D,OAAO,KAAK,EAEV,iCAAiC,EAClC,MAAM,wCAAwC,CAAC;AAChD,OAAO,KAAK,EAAM,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAWtF;;;GAGG;AACH,UAAU,2CAA2C;IACnD;;;OAGG;IACH,YAAY,EAAE,kBAAkB,GAAG,yBAAyB,GAAG,gBAAgB,CAAC;IAEhF;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,iCAAiC,CAAC;CAC1D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,4CAA4C,CAC1D,KAAK,EAAE,2CAA2C,GACjD,iCAAiC,CAenC"}