@itwin/presentation-shared 2.0.0-alpha.8 → 2.0.0

package/README.md

@@ -16,47 +16,48 @@ The namespace defines all the [EC](https://www.itwinjs.org/bis/ec/) types that P
 
 ### `ECSchemaProvider` & `getClass`
 
-- `ECSchemaProvider` is an interface for something that knows how to get an [ECSchema](https://www.itwinjs.org/bis/ec/ec-schema/) from an iModel. The package itself doesn't provide an implementation for this interface and instead relies on `@itwin/presentation-core-interop` to do that.
+- `ECSchemaProvider` is an interface for something that knows how to get an [ECSchema](https://www.itwinjs.org/bis/ec/ec-schema/) from an iModel, or check if one class is the same as, or derives from, another. The package itself doesn't provide an implementation for this interface and instead relies on `@itwin/presentation-core-interop` to do that.
 
 - `getClass` is an utility function that makes it easier to get an `EC.Class`, given an `ECSchemaProvider` and a full class name.
 
 Example usage:
 
 ```ts
-import { SchemaContext } from "@itwin/ecschema-metadata";
+import { IModelConnection } from "@itwin/core-frontend";
 import { createECSchemaProvider } from "@itwin/presentation-core-interop";
 import { ECSchemaProvider, getClass } from "@itwin/presentation-shared";
 
-const schemas = new SchemaContext();
-const schemaProvider: ECSchemaProvider = createECSchemaProvider(schemas);
+const iModelConnection: IModelConnection = ...; // obtain the IModelConnection instance
+const schemaProvider: ECSchemaProvider = createECSchemaProvider(iModelConnection);
 
 // get schema and a class from it
 const ecSchema = await schemaProvider.getSchema("MySchema");
-const ecClassFromSchema = await ecSchema.getClass("MyClass");
+const ecClassFromSchema = ecSchema.getClass("MyClass");
 
 // ... or use the `getClass` utility to get straight to the class
 const ecClassFromUtility = await getClass(schemaProvider, "MySchema.MyClass");
+
+// check whether one class derives from another
+const isGeometricElement = await schemaProvider.classDerivesFrom("MySchema.MyClass", "BisCore.GeometricElement");
 ```
 
-### `ECClassHierarchyInspector` & `createCachingECClassHierarchyInspector`
+### Hidden classes
 
-- `ECClassHierarchyInspector` is an interface for something that knows how to check whether one `EC.Class` derives from another. While that can be achieved through `ECSchemaProvider` by getting an `EC.Class` and calling its `is` method, using this interface provides a more streamlined and, possibly, more efficient way to do the check. In addition, the `ECClassHierarchyInspector.classDerivesFrom` returns a `Promise<boolean> | boolean`, which lets the implementation return the result synchronously, if it's already known.
+Classes may be hidden from users through `CoreCustomAttributes.HiddenClass` and `CoreCustomAttributes.HiddenSchema` custom attributes. Instances of such classes shouldn't be shown in the UI, unless their class is selected explicitly.
 
-- `createCachingECClassHierarchyInspector` is a factory method that creates `ECClassHierarchyInspector` instance that uses a LRU cache to store the check results. In Presentation library use cases, class inheritance checks are done very frequently to warrant caching these results.
+- `ECSchemaProvider.getHiddenClassesTree` returns a `HiddenClassesTreeNode` tree of classes, derived from the given class, whose visibility differs from their base class. The given class is the visibility boundary: `HiddenClass` attributes on it and on its base classes are ignored. The tree includes both hidden classes and their explicitly shown descendants. Building the tree requires traversing the whole derived classes' hierarchy, so implementations are expected to cache the result. The provider created by `createECSchemaProvider` from `@itwin/presentation-core-interop` caches it for the provider's lifetime. Create one provider per iModel and share it between consumers; after schema changes, recreate the provider and consumers holding it.
 
-Example usage:
+- `createHiddenClassesTree` builds the tree for `ECSchemaProvider.getHiddenClassesTree` implementations. It doesn't cache the result.
 
-```ts
-import { createCachingECClassHierarchyInspector, ECClassHierarchyInspector } from "@itwin/presentation-shared";
+Use `ECSql.createHiddenClassesFilter` to exclude instances of hidden classes in ECSQL queries.
 
-const classHierarchyInspector: ECClassHierarchyInspector = createCachingECClassHierarchyInspector({
-  // provide `ECSchemaProvider` that will be used to access iModels schemas
-  schemaProvider: getMetadataProvider(),
-  // tell how many entries should be cached in LRU cache (0 or `undefined` stand for "no caching")
-  cacheSize: 100,
-});
-const isGeometricElement = await classHierarchyInspector.classDerivesFrom("MySchema.MyClass", "BisCore.GeometricElement");
-```
+### `ECClassHierarchyInspector` & `createCachingECClassHierarchyInspector` (deprecated)
+
+> **Deprecated:** `ECClassHierarchyInspector` and `createCachingECClassHierarchyInspector` are deprecated. `ECSchemaProvider` now exposes a `classDerivesFrom` method directly, so a separate class hierarchy inspector is no longer needed.
+
+- `ECClassHierarchyInspector` is an interface for something that knows how to check whether one `EC.Class` derives from another. The same capability is now available directly on `ECSchemaProvider` via its `classDerivesFrom` method. Like the inspector, `ECSchemaProvider.classDerivesFrom` returns a `Promise<boolean> | boolean`, which lets the implementation return the result synchronously when it's already known.
+
+- `createCachingECClassHierarchyInspector` is a factory method that creates an `ECClassHierarchyInspector` instance that uses a LRU cache to store the check results. It is no longer needed - use `ECSchemaProvider.classDerivesFrom` instead.
 
 ## ECSql
 
@@ -265,6 +266,19 @@ The ECSql utilities group contains a number of functions to help create complex
   // `
   ```
 
+- `createHiddenClassesFilter` - creates a filter that excludes instances of classes, derived from the given base class and hidden through `HiddenClass` or `HiddenSchema` custom attributes. The base class is the visibility boundary: it's never excluded, `HiddenClass` attributes on it and on its base classes are ignored, and classes outside its hierarchy are not affected. The hidden classes tree is requested from the schema provider once (see `ECSchemaProvider.getHiddenClassesTree`), and the filter can create conditions for multiple class aliases. Each condition is an empty string when nothing needs to be excluded.
+
+  Example usage:
+
+  ```ts
+  import { ECSql } from "@itwin/presentation-shared";
+
+  const filter = await ECSql.createHiddenClassesFilter({ schemaProvider, baseClassName: "MySchema.MyClass" });
+  const condition = filter.createWhereClause("x");
+  // condition = "[x].[ECClassId] IS NOT ([MySchema].[MyHiddenClass])"
+  const ecsql = `SELECT x.ECInstanceId FROM MySchema.MyClass x ${condition ? `WHERE ${condition}` : ""}`;
+  ```
+
 ## Values
 
 The APIs in Values group contain various value types and utilities to work with them.
@@ -312,7 +326,7 @@ The APIs in Values group contain various value types and utilities to work with
   }
   ```
 
-The package delivers 3 implementations of `IInstanceLabelSelectClauseFactory` that can be created using the following factory methods: `createDefaultInstanceLabelSelectClauseFactory`, `createClassBasedInstanceLabelSelectClauseFactory`, `createBisInstanceLabelSelectClauseFactory`.
+The package delivers 4 implementations of `IInstanceLabelSelectClauseFactory` that can be created using the following factory methods: `createDefaultInstanceLabelSelectClauseFactory`, `createClassBasedInstanceLabelSelectClauseFactory`, `createBisInstanceLabelSelectClauseFactory`, `createIModelInstanceLabelSelectClauseFactory`.
 
 ### `createDefaultInstanceLabelSelectClauseFactory`
 
@@ -340,11 +354,11 @@ This label selectors factory doesn't create labels on its own, but allows assign
 Example usage:
 
 ```ts
-import { createClassBasedInstanceLabelSelectClauseFactory, ECClassHierarchyInspector } from "@itwin/presentation-shared";
+import { createClassBasedInstanceLabelSelectClauseFactory, ECSchemaProvider } from "@itwin/presentation-shared";
 
-const classHierarchyInspector: ECClassHierarchyInspector = getClassHierarchyInspector();
+const imodelAccess: ECSchemaProvider = getSchemaProvider();
 const labelsFactory = createClassBasedInstanceLabelSelectClauseFactory({
-  classHierarchyInspector,
+  imodelAccess,
   clauses: [
     {
       className: "MySchema.MyClass",
@@ -371,10 +385,28 @@ This label selectors factory creates labels according to [BIS instance label rul
 Example usage:
 
 ```ts
-import { createBisInstanceLabelSelectClauseFactory, ECClassHierarchyInspector } from "@itwin/presentation-shared";
+import { createBisInstanceLabelSelectClauseFactory, ECSchemaProvider } from "@itwin/presentation-shared";
+
+const imodelAccess: ECSchemaProvider = getSchemaProvider();
+const labelsFactory = createBisInstanceLabelSelectClauseFactory({ imodelAccess });
+const ecsql = `SELECT ${await labelsFactory.createSelectClause({ classAlias: "element" })} AS [Label] FROM [BisCore].[Element] AS [element]`;
+// ...
+```
+
+### `createIModelInstanceLabelSelectClauseFactory`
+
+This label selectors factory reads `InstanceLabelOverride` rules from `PresentationRules` rulesets embedded in
+the iModel and compiles them into ECSQL label selectors. Rules are loaded lazily on first use and cached per
+factory instance. When the `PresentationRules` schema is absent from the iModel, the factory transparently
+falls back to a configurable default (by default `createBisInstanceLabelSelectClauseFactory`).
+
+Example usage:
+
+```ts
+import { createIModelInstanceLabelSelectClauseFactory } from "@itwin/presentation-shared";
 
-const classHierarchyInspector: ECClassHierarchyInspector = getClassHierarchyInspector();
-const labelsFactory = createBisInstanceLabelSelectClauseFactory({ classHierarchyInspector });
+// `imodelAccess` must satisfy `ECSqlQueryExecutor & ECSchemaProvider`
+const labelsFactory = createIModelInstanceLabelSelectClauseFactory({ imodelAccess });
 const ecsql = `SELECT ${await labelsFactory.createSelectClause({ classAlias: "element" })} AS [Label] FROM [BisCore].[Element] AS [element]`;
 // ...
 ```
@@ -388,8 +420,8 @@ Example usage:
 ```ts
 import { Logger as ITwinJsLogger } from "@itwin/core-bentley";
 import { createLogger } from "@itwin/presentation-core-interop";
-import { ILogger } from "@itwin/presentation-shared";
 import { setLogger as setHierarchiesLogger } from "@itwin/presentation-hierarchies";
+import { ILogger } from "@itwin/presentation-shared";
 
 // create an `ILogger` from iTwin.js `Logger`
 const logger: ILogger = createLogger(ITwinJsLogger);

package/lib/presentation-shared.d.ts

@@ -0,0 +1,24 @@
+export * as ECSql from "./shared/ecsql-snippets/index.js";
+export { ConcatenatedValue, ConcatenatedValuePart } from "./shared/ConcatenatedValue.js";
+export { eachValueFrom } from "./shared/EachValueFrom.js";
+export { ECSqlBinding } from "./shared/ECSqlCore.js";
+export type { ECSqlQueryDef, ECSqlQueryExecutor, ECSqlQueryReaderOptions, ECSqlQueryRow } from "./shared/ECSqlCore.js";
+export type { IPrimitiveValueFormatter } from "./shared/Formatting.js";
+export { createDefaultValueFormatter, formatConcatenatedValue } from "./shared/Formatting.js";
+export type { IInstanceLabelSelectClauseFactory } from "./shared/InstanceLabelSelectClauseFactory.js";
+export { parseInstanceLabel } from "./shared/InstanceLabelSelectClauseFactory.js";
+export { createDefaultInstanceLabelSelectClauseFactory } from "./shared/instance-label-factory-impls/DefaultInstanceLabelSelectClauseFactory.js";
+export { createClassBasedInstanceLabelSelectClauseFactory } from "./shared/instance-label-factory-impls/ClassBasedInstanceLabelSelectClauseFactory.js";
+export { createBisInstanceLabelSelectClauseFactory } from "./shared/instance-label-factory-impls/BisInstanceLabelSelectClauseFactory.js";
+export { createIModelInstanceLabelSelectClauseFactory } from "./shared/instance-label-factory-impls/IModelInstanceLabelSelectClauseFactory.js";
+export type { ILogger, LogFunction, LogLevel } from "./shared/Logging.js";
+export { NOOP_LOGGER } from "./shared/Logging.js";
+export type { ArrayElement, DeepReadonly, OmitOverUnion, Props } from "./shared/MappedTypes.js";
+export type { ArrayValueDescriptor, EC, ECClassHierarchyInspector, ECSchemaProvider, HiddenClassesTreeNode, NavigationValueDescriptor, PrimitiveValueDescriptor, PrimitiveValueType, RelationshipPath, StructValueDescriptor, ValueDescriptor, } from "./shared/Metadata.js";
+export { createCachingECClassHierarchyInspector, getClass, } from "./shared/Metadata.js";
+export { createHiddenClassesTree } from "./shared/HiddenClasses.js";
+export { createMainThreadReleaseOnTimePassedHandler, julianToDateTime, normalizeFullClassName, parseFullClassName, releaseMainThread, trimWhitespace, } from "./shared/Utils.js";
+export { InstanceKey, PrimitiveValue, TypedPrimitiveValue } from "./shared/Values.js";
+export type { ArrayValue, StructValue, NavigationValue, Value, Point2dValue, Point3dValue } from "./shared/Values.js";
+export type { Event, RaisableEvent, EventArgs, EventListener } from "./shared/Event.js";
+//# sourceMappingURL=presentation-shared.d.ts.map

package/lib/presentation-shared.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"presentation-shared.d.ts","sourceRoot":"","sources":["../src/presentation-shared.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,KAAK,MAAM,kCAAkC,CAAC;AAE1D,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AACzF,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,YAAY,EAAE,aAAa,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACvH,YAAY,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC;AACvE,OAAO,EAAE,2BAA2B,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAC9F,YAAY,EAAE,iCAAiC,EAAE,MAAM,8CAA8C,CAAC;AACtG,OAAO,EAAE,kBAAkB,EAAE,MAAM,8CAA8C,CAAC;AAClF,OAAO,EAAE,6CAA6C,EAAE,MAAM,kFAAkF,CAAC;AACjJ,OAAO,EAAE,gDAAgD,EAAE,MAAM,qFAAqF,CAAC;AACvJ,OAAO,EAAE,yCAAyC,EAAE,MAAM,8EAA8E,CAAC;AACzI,OAAO,EAAE,4CAA4C,EAAE,MAAM,iFAAiF,CAAC;AAC/I,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAChG,YAAY,EACV,oBAAoB,EACpB,EAAE,EAEF,yBAAyB,EACzB,gBAAgB,EAChB,qBAAqB,EACrB,yBAAyB,EACzB,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,qBAAqB,EACrB,eAAe,GAChB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAEL,sCAAsC,EACtC,QAAQ,GACT,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EACL,0CAA0C,EAC1C,gBAAgB,EAChB,sBAAsB,EACtB,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,GACf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACtF,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACtH,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC"}

package/lib/presentation-shared.js

@@ -0,0 +1,22 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+export * as ECSql from "./shared/ecsql-snippets/index.js";
+export { ConcatenatedValue, ConcatenatedValuePart } from "./shared/ConcatenatedValue.js";
+export { eachValueFrom } from "./shared/EachValueFrom.js";
+export { ECSqlBinding } from "./shared/ECSqlCore.js";
+export { createDefaultValueFormatter, formatConcatenatedValue } from "./shared/Formatting.js";
+export { parseInstanceLabel } from "./shared/InstanceLabelSelectClauseFactory.js";
+export { createDefaultInstanceLabelSelectClauseFactory } from "./shared/instance-label-factory-impls/DefaultInstanceLabelSelectClauseFactory.js";
+export { createClassBasedInstanceLabelSelectClauseFactory } from "./shared/instance-label-factory-impls/ClassBasedInstanceLabelSelectClauseFactory.js";
+export { createBisInstanceLabelSelectClauseFactory } from "./shared/instance-label-factory-impls/BisInstanceLabelSelectClauseFactory.js";
+export { createIModelInstanceLabelSelectClauseFactory } from "./shared/instance-label-factory-impls/IModelInstanceLabelSelectClauseFactory.js";
+export { NOOP_LOGGER } from "./shared/Logging.js";
+export { 
+// eslint-disable-next-line @typescript-eslint/no-deprecated
+createCachingECClassHierarchyInspector, getClass, } from "./shared/Metadata.js";
+export { createHiddenClassesTree } from "./shared/HiddenClasses.js";
+export { createMainThreadReleaseOnTimePassedHandler, julianToDateTime, normalizeFullClassName, parseFullClassName, releaseMainThread, trimWhitespace, } from "./shared/Utils.js";
+export { InstanceKey, PrimitiveValue, TypedPrimitiveValue } from "./shared/Values.js";
+//# sourceMappingURL=presentation-shared.js.map

package/lib/presentation-shared.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"presentation-shared.js","sourceRoot":"","sources":["../src/presentation-shared.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,KAAK,KAAK,MAAM,kCAAkC,CAAC;AAE1D,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AACzF,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAGrD,OAAO,EAAE,2BAA2B,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAE9F,OAAO,EAAE,kBAAkB,EAAE,MAAM,8CAA8C,CAAC;AAClF,OAAO,EAAE,6CAA6C,EAAE,MAAM,kFAAkF,CAAC;AACjJ,OAAO,EAAE,gDAAgD,EAAE,MAAM,qFAAqF,CAAC;AACvJ,OAAO,EAAE,yCAAyC,EAAE,MAAM,8EAA8E,CAAC;AACzI,OAAO,EAAE,4CAA4C,EAAE,MAAM,iFAAiF,CAAC;AAE/I,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAgBlD,OAAO;AACL,4DAA4D;AAC5D,sCAAsC,EACtC,QAAQ,GACT,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EACL,0CAA0C,EAC1C,gBAAgB,EAChB,sBAAsB,EACtB,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,GACf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC"}

package/lib/shared/ConcatenatedValue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConcatenatedValue.d.ts","sourceRoot":"","sources":["../../src/shared/ConcatenatedValue.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAEvD;;;;;;;;;GASG;AACH,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,GAAG,mBAAmB,GAAG,MAAM,CAAC;AAErF,cAAc;AAEd,yBAAiB,qBAAqB,CAAC;IACrC,cAAc;IACd,SAAgB,QAAQ,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI,IAAI,MAAM,CAEpE;IAED,cAAc;IACd,SAAgB,WAAW,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI,IAAI,mBAAmB,CAEpF;IAED,cAAc;IACd,SAAgB,mBAAmB,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI,IAAI,iBAAiB,CAE1F;CACF;AAED;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,qBAAqB,EAAE,CAAC;AAExD,cAAc;AAEd,yBAAiB,iBAAiB,CAAC;IACjC;;;;;OAKG;IACH,SAAsB,SAAS,CAAC,KAAK,EAAE;QACrC,yBAAyB;QACzB,KAAK,EAAE,iBAAiB,CAAC;QACzB,qDAAqD;QACrD,aAAa,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,qBAAqB,EAAE,iBAAiB,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;QAC5F,6EAA6E;QAC7E,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,MAAM,CAAC,CAYlB;CACF"}

package/lib/shared/ConcatenatedValue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConcatenatedValue.js","sourceRoot":"","sources":["../../src/shared/ConcatenatedValue.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAgBhG,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,qBAAqB,CAerC;AAfD,WAAiB,qBAAqB;IACpC,cAAc;IACd,SAAgB,QAAQ,CAAC,IAA2B;QAClD,OAAO,OAAO,IAAI,KAAK,QAAQ,CAAC;IAClC,CAAC;IAFe,sBAAA,QAAQ,WAEvB,CAAA;IAED,cAAc;IACd,SAAgB,WAAW,CAAC,IAA2B;QACrD,OAAO,CAAC,CAAE,IAA4B,CAAC,IAAI,CAAC;IAC9C,CAAC;IAFe,sBAAA,WAAW,cAE1B,CAAA;IAED,cAAc;IACd,SAAgB,mBAAmB,CAAC,IAA2B;QAC7D,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAFe,sBAAA,mBAAmB,sBAElC,CAAA;AACH,CAAC,EAfgB,qBAAqB,KAArB,qBAAqB,QAerC;AAUD,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,iBAAiB,CA2BjC;AA3BD,WAAiB,iBAAiB;IAChC;;;;;OAKG;IACI,KAAK,UAAU,SAAS,CAAC,KAO/B;QACC,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC;QAClD,OAAO,CACL,MAAM,OAAO,CAAC,GAAG,CACf,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YACvB,IAAI,qBAAqB,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACpD,OAAO,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC,CAAC;YAC9D,CAAC;YACD,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC,CAAC,CACH,CACF,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;IAC1B,CAAC;IAnBqB,kBAAA,SAAS,YAmB9B,CAAA;AACH,CAAC,EA3BgB,iBAAiB,KAAjB,iBAAiB,QA2BjC"}

package/lib/{cjs/shared → shared}/ECSqlCore.d.ts

@@ -1,4 +1,5 @@
 import type { Id64String } from "@itwin/core-bentley";
+import type { TypedPrimitiveValue } from "./Values.js";
 /**
  * Defines an ECSql binding consisting of a value and its type. Necessary to differentiate between numeric
  * types and `Id64String` vs `string`.
@@ -16,7 +17,7 @@ export type ECSqlBinding = {
     value?: Id64String;
 } | {
     type: "idset";
-    value?: Id64String[];
+    value?: ReadonlyArray<Id64String> | ReadonlySet<Id64String>;
 } | {
     type: "string";
     value?: string;
@@ -34,6 +35,14 @@ export type ECSqlBinding = {
         z: number;
     };
 };
+/**
+ * Helpers for creating ECSQL bindings.
+ * @public
+ */
+export declare namespace ECSqlBinding {
+    /** Creates an ECSQL binding for the supplied typed primitive value. */
+    function create({ value, type }: TypedPrimitiveValue): ECSqlBinding;
+}
 /**
  * Defines an ECSQL query and its bindings.
  * @public
@@ -48,9 +57,14 @@ export interface ECSqlQueryDef {
     ecsql: string;
     /**
      * Values to bind to the query.
+     *
+     * Provide bindings either as an array or as a record:
+     * - `ECSqlBinding[]` binds values by parameter position.
+     * - `Record<string, ECSqlBinding>` binds values by parameter name, where each key is the ECSQL parameter name.
+     *
      * @see https://www.itwinjs.org/learning/ecsql/#ecsql-parameters
      */
-    bindings?: ECSqlBinding[];
+    bindings?: ECSqlBinding[] | Record<string, ECSqlBinding>;
 }
 /**
  * Defines requested ECSQL result row format.

package/lib/shared/ECSqlCore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ECSqlCore.d.ts","sourceRoot":"","sources":["../../src/shared/ECSqlCore.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAEvD;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GACpB;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,GACpC;IAAE,IAAI,EAAE,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GACnD;IAAE,IAAI,EAAE,IAAI,CAAC;IAAC,KAAK,CAAC,EAAE,UAAU,CAAA;CAAE,GAClC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,GAAG,WAAW,CAAC,UAAU,CAAC,CAAA;CAAE,GAC9E;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GAClC;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,CAAC,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACrD;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,CAAC,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAAC;AAErE;;;GAGG;AAEH,yBAAiB,YAAY,CAAC;IAC5B,uEAAuE;IACvE,SAAgB,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,mBAAmB,GAAG,YAAY,CAqBzE;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;CAC1D;AAED;;;;GAIG;AACH,KAAK,mBAAmB,GAAG,oBAAoB,GAAG,SAAS,CAAC;AAE5D;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,CAAC,YAAY,EAAE,MAAM,GAAG,GAAG,CAAC;IAC5B,CAAC,aAAa,EAAE,MAAM,GAAG,GAAG,CAAC;CAC9B;AAED;;;;GAIG;AACH,KAAK,gBAAgB,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;AAE7D;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,iBAAiB,CAAC,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,EAAE,uBAAuB,GAAG,gBAAgB,CAAC;CAC7F"}

package/lib/shared/ECSqlCore.js

@@ -0,0 +1,37 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/**
+ * Helpers for creating ECSQL bindings.
+ * @public
+ */
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export var ECSqlBinding;
+(function (ECSqlBinding) {
+    /** Creates an ECSQL binding for the supplied typed primitive value. */
+    function create({ value, type }) {
+        switch (type) {
+            case "Boolean":
+                return { type: "boolean", value };
+            case "Integer":
+                return { type: "int", value };
+            case "Long":
+                return { type: "long", value };
+            case "Double":
+                return { type: "double", value };
+            case "Id":
+                return { type: "id", value };
+            case "String":
+                return { type: "string", value };
+            case "DateTime":
+                return { type: "string", value: value instanceof Date ? value.toISOString() : value.toString() };
+            case "Point2d":
+                return { type: "point2d", value };
+            case "Point3d":
+                return { type: "point3d", value };
+        }
+    }
+    ECSqlBinding.create = create;
+})(ECSqlBinding || (ECSqlBinding = {}));
+//# sourceMappingURL=ECSqlCore.js.map

package/lib/shared/ECSqlCore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ECSqlCore.js","sourceRoot":"","sources":["../../src/shared/ECSqlCore.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAoBhG;;;GAGG;AACH,2DAA2D;AAC3D,MAAM,KAAW,YAAY,CAwB5B;AAxBD,WAAiB,YAAY;IAC3B,uEAAuE;IACvE,SAAgB,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,EAAuB;QACzD,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,SAAS;gBACZ,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;YACpC,KAAK,SAAS;gBACZ,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;YAChC,KAAK,MAAM;gBACT,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;YACjC,KAAK,QAAQ;gBACX,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;YACnC,KAAK,IAAI;gBACP,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YAC/B,KAAK,QAAQ;gBACX,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;YACnC,KAAK,UAAU;gBACb,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,YAAY,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC;YACnG,KAAK,SAAS;gBACZ,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;YACpC,KAAK,SAAS;gBACZ,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;QACtC,CAAC;IACH,CAAC;IArBe,aAAA,MAAM,SAqBrB,CAAA;AACH,CAAC,EAxBgB,YAAY,KAAZ,YAAY,QAwB5B"}

package/lib/shared/EachValueFrom.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The subscription operations required by `eachValueFrom`.
+ *
+ * @public
+ */
+export interface Subscribable<T> {
+    /**
+     * Subscribes to stream notifications.
+     */
+    subscribe(observer: {
+        next: (value: T) => void;
+        error: (reason: unknown) => void;
+        complete: () => void;
+    }): {
+        unsubscribe: () => void;
+    };
+}
+/**
+ * Converts a subscribable stream into an async iterator.
+ *
+ * This is pretty much a combination of:
+ * - https://github.com/benlesh/rxjs-for-await/blob/94f9cf9cb015ac3700dfd1850eb81d36962eb70f/src/index.ts#L33,
+ * - https://github.com/ReactiveX/rxjs/blob/2587ee852eb43eeb0883a7787bac2944d823392b/packages/observable/src/observable.ts#L922.
+ *
+ * Our implementation uses a linked list rather than an array to store values, which is more efficient.
+ *
+ * @public
+ */
+export declare function eachValueFrom<T>(source: Subscribable<T>): AsyncIterableIterator<T>;
+//# sourceMappingURL=EachValueFrom.d.ts.map

package/lib/shared/EachValueFrom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EachValueFrom.d.ts","sourceRoot":"","sources":["../../src/shared/EachValueFrom.ts"],"names":[],"mappings":"AAMA;;;;GAIG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC;IAC7B;;OAEG;IACH,SAAS,CAAC,QAAQ,EAAE;QAAE,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;QAAC,KAAK,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;QAAC,QAAQ,EAAE,MAAM,IAAI,CAAA;KAAE,GAAG;QACzG,WAAW,EAAE,MAAM,IAAI,CAAC;KACzB,CAAC;CACH;AAED;;;;;;;;;;GAUG;AACH,wBAAuB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC,CA0DzF"}

package/lib/shared/EachValueFrom.js

@@ -0,0 +1,115 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+// cspell:words deferreds
+/**
+ * Converts a subscribable stream into an async iterator.
+ *
+ * This is pretty much a combination of:
+ * - https://github.com/benlesh/rxjs-for-await/blob/94f9cf9cb015ac3700dfd1850eb81d36962eb70f/src/index.ts#L33,
+ * - https://github.com/ReactiveX/rxjs/blob/2587ee852eb43eeb0883a7787bac2944d823392b/packages/observable/src/observable.ts#L922.
+ *
+ * Our implementation uses a linked list rather than an array to store values, which is more efficient.
+ *
+ * @public
+ */
+export async function* eachValueFrom(source) {
+    const deferreds = new Queue();
+    const values = new Queue();
+    let error;
+    let completed = false;
+    const subs = source.subscribe({
+        next: (value) => {
+            const deferred = deferreds.pop();
+            if (deferred) {
+                deferred.resolve({ value, done: false });
+            }
+            else {
+                values.push(value);
+            }
+        },
+        error: (err) => {
+            error = err;
+            for (let deferred = deferreds.pop(); deferred !== undefined; deferred = deferreds.pop()) {
+                deferred.reject(err);
+            }
+        },
+        complete: () => {
+            completed = true;
+            for (let deferred = deferreds.pop(); deferred !== undefined; deferred = deferreds.pop()) {
+                deferred.resolve({ value: undefined, done: true });
+            }
+        },
+    });
+    try {
+        while (true) {
+            if (!values.isEmpty) {
+                // The queue is non-empty, so this is an actual buffered value — possibly a legitimately
+                // emitted `undefined`, which is why emptiness is checked explicitly rather than by
+                // comparing the popped value to `undefined`.
+                yield values.pop();
+                continue;
+            }
+            // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+            if (completed) {
+                return;
+            }
+            // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+            if (error) {
+                // eslint-disable-next-line @typescript-eslint/only-throw-error
+                throw error;
+            }
+            const result = await new Promise((resolve, reject) => {
+                deferreds.push({ resolve, reject });
+            });
+            if (result.done) {
+                return;
+            }
+            yield result.value;
+        }
+    }
+    catch (err) {
+        throw err;
+    }
+    finally {
+        subs.unsubscribe();
+    }
+}
+class QueueEntry {
+    value;
+    next;
+    constructor(value, next) {
+        this.value = value;
+        this.next = next;
+    }
+}
+class Queue {
+    _front;
+    _back;
+    get isEmpty() {
+        return this._front === undefined;
+    }
+    push(item) {
+        const entry = new QueueEntry(item);
+        if (this._back) {
+            this._back.next = entry;
+        }
+        this._back = entry;
+        if (!this._front) {
+            this._front = entry;
+        }
+    }
+    pop() {
+        if (!this._front) {
+            return undefined;
+        }
+        const value = this._front.value;
+        this._front = this._front.next;
+        if (!this._front) {
+            this._back = undefined;
+        }
+        return value;
+    }
+}
+//# sourceMappingURL=EachValueFrom.js.map

package/lib/shared/EachValueFrom.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EachValueFrom.js","sourceRoot":"","sources":["../../src/shared/EachValueFrom.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG,yBAAyB;AAgBzB;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,aAAa,CAAI,MAAuB;IAC7D,MAAM,SAAS,GAAG,IAAI,KAAK,EAAsF,CAAC;IAClH,MAAM,MAAM,GAAG,IAAI,KAAK,EAAK,CAAC;IAC9B,IAAI,KAAK,CAAC;IACV,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC;QAC5B,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;YACd,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,EAAE,CAAC;YACjC,IAAI,QAAQ,EAAE,CAAC;gBACb,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;QACD,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE;YACb,KAAK,GAAG,GAAG,CAAC;YACZ,KAAK,IAAI,QAAQ,GAAG,SAAS,CAAC,GAAG,EAAE,EAAE,QAAQ,KAAK,SAAS,EAAE,QAAQ,GAAG,SAAS,CAAC,GAAG,EAAE,EAAE,CAAC;gBACxF,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;QACD,QAAQ,EAAE,GAAG,EAAE;YACb,SAAS,GAAG,IAAI,CAAC;YACjB,KAAK,IAAI,QAAQ,GAAG,SAAS,CAAC,GAAG,EAAE,EAAE,QAAQ,KAAK,SAAS,EAAE,QAAQ,GAAG,SAAS,CAAC,GAAG,EAAE,EAAE,CAAC;gBACxF,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YACrD,CAAC;QACH,CAAC;KACF,CAAC,CAAC;IACH,IAAI,CAAC;QACH,OAAO,IAAI,EAAE,CAAC;YACZ,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACpB,wFAAwF;gBACxF,mFAAmF;gBACnF,6CAA6C;gBAC7C,MAAM,MAAM,CAAC,GAAG,EAAO,CAAC;gBACxB,SAAS;YACX,CAAC;YACD,uEAAuE;YACvE,IAAI,SAAS,EAAE,CAAC;gBACd,OAAO;YACT,CAAC;YACD,uEAAuE;YACvE,IAAI,KAAK,EAAE,CAAC;gBACV,+DAA+D;gBAC/D,MAAM,KAAK,CAAC;YACd,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,IAAI,OAAO,CAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACtE,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;YACtC,CAAC,CAAC,CAAC;YACH,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;gBAChB,OAAO;YACT,CAAC;YACD,MAAM,MAAM,CAAC,KAAK,CAAC;QACrB,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,GAAG,CAAC;IACZ,CAAC;YAAS,CAAC;QACT,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;AACH,CAAC;AAED,MAAM,UAAU;IAEI,KAAK;IACd,IAAI;IAFb,YACkB,KAAQ,EACjB,IAAoB;qBADX,KAAK;oBACd,IAAI;IACV,CAAC;CACL;AAED,MAAM,KAAK;IACD,MAAM,CAAiB;IACvB,KAAK,CAAiB;IAE9B,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC;IACnC,CAAC;IAEM,IAAI,CAAC,IAAO;QACjB,MAAM,KAAK,GAAG,IAAI,UAAU,CAAI,IAAI,CAAC,CAAC;QACtC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC;QAC1B,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACtB,CAAC;IACH,CAAC;IAEM,GAAG;QACR,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;QAChC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QACzB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}

package/lib/shared/Event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Event.d.ts","sourceRoot":"","sources":["../../src/shared/Event.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAE9C;;;GAGG;AACH,MAAM,WAAW,KAAK,CAAC,SAAS,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,MAAM,IAAI;IAC5E,WAAW,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,MAAM,IAAI,CAAC;IACjD,cAAc,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,IAAI,CAAC;CAC/C;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa,CAAC,SAAS,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,MAAM,IAAI,CAAE,SAAQ,KAAK,CAAC,SAAS,CAAC;IAC9G,UAAU,EAAE,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC;CACtD;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,MAAM,SAAS,EAAE,IAAI,MAAM,SAAS,KAAK,CAAC,MAAM,SAAS,CAAC,GAAG,SAAS,GAAG,KAAK,CAAC;AAEzG;;;GAGG;AACH,MAAM,MAAM,SAAS,CAAC,MAAM,SAAS,EAAE,IAAI,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC"}

package/lib/{esm/shared → shared}/Event.js.map

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

package/lib/shared/Formatting.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Formatting.d.ts","sourceRoot":"","sources":["../../src/shared/Formatting.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,iBAAiB,EAAyB,MAAM,wBAAwB,CAAC;AAGlF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAEvD;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,KAAK,EAAE,mBAAmB,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAEvF;;;;;GAKG;AACH,wBAAsB,uBAAuB,CAAC,KAAK,EAAE;IACnD,KAAK,EAAE,iBAAiB,GAAG,MAAM,CAAC;IAClC,cAAc,EAAE,wBAAwB,CAAC;CAC1C,GAAG,OAAO,CAAC,MAAM,CAAC,CAgBlB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,2BAA2B,IAAI,wBAAwB,CAkBtE"}

package/lib/{esm/shared → shared}/Formatting.js

@@ -21,10 +21,7 @@ export async function formatConcatenatedValue(props) {
         partFormatter: async (part) => {
             // strings are converted to typed strings
             if (ConcatenatedValuePart.isString(part)) {
-                part = {
-                    value: part,
-                    type: "String",
-                };
+                part = { value: part, type: "String" };
             }
             // finally, use provided value formatter to create a string from `TypedPrimitiveValue`
             return valueFormatter(part);
@@ -64,7 +61,10 @@ export function createDefaultValueFormatter() {
                 return result;
             }
         }
-        assert(typeof value.value === "undefined" || typeof value.value === "boolean" || typeof value.value === "number" || typeof value.value === "string");
+        assert(typeof value.value === "undefined" ||
+            typeof value.value === "boolean" ||
+            typeof value.value === "number" ||
+            typeof value.value === "string");
         return value.value.toString();
     };
 }
@@ -85,7 +85,11 @@ function applyNumericFormatting(value) {
 }
 function applyDatesFormatting(value) {
     function getDate(julianOrDate) {
-        return typeof julianOrDate === "number" ? julianToDateTime(julianOrDate) : typeof julianOrDate === "string" ? new Date(julianOrDate) : julianOrDate;
+        return typeof julianOrDate === "number"
+            ? julianToDateTime(julianOrDate)
+            : typeof julianOrDate === "string"
+                ? new Date(julianOrDate)
+                : julianOrDate;
     }
     if (value.type !== "DateTime") {
         return undefined;

package/lib/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,wBAAwB,CAAC;AAClF,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAW9C;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,KAG7C;IACC,MAAM,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC;IACxC,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,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;YACzC,CAAC;YACD,sFAAsF;YACtF,OAAO,cAAc,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;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,CACJ,OAAO,KAAK,CAAC,KAAK,KAAK,WAAW;YAChC,OAAO,KAAK,CAAC,KAAK,KAAK,SAAS;YAChC,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ;YAC/B,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,CAClC,CAAC;QACF,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;YACrC,CAAC,CAAC,gBAAgB,CAAC,YAAY,CAAC;YAChC,CAAC,CAAC,OAAO,YAAY,KAAK,QAAQ;gBAChC,CAAC,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC;gBACxB,CAAC,CAAC,YAAY,CAAC;IACrB,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/shared/HiddenClasses.d.ts

@@ -0,0 +1,21 @@
+import type { EC, ECSchemaProvider, HiddenClassesTreeNode } from "./Metadata.js";
+/**
+ * Creates a tree of classes, derived from the given class, whose visibility is changed through `HiddenClass`
+ * or `HiddenSchema` custom attributes. See `HiddenClassesTreeNode` for details on the tree structure.
+ * The selected class is the visibility boundary: `HiddenClass` attributes on it and on its base classes are ignored, so
+ * it and its descendants are visible unless a descendant is hidden through its own `HiddenClass` attribute or
+ * the `HiddenSchema` attribute of its schema.
+ *
+ * The function traverses the whole derived classes' hierarchy of the given class, which may be expensive. It's
+ * meant to be used by `ECSchemaProvider.getHiddenClassesTree` implementations, which are expected to cache the result.
+ *
+ * @throws Error if the selected class or any of its derived classes' schemas can't be found.
+ * @public
+ */
+export declare function createHiddenClassesTree(props: {
+    /** Schema provider used to look up the selected class and its derived classes. */
+    schemaProvider: Pick<ECSchemaProvider, "getSchema">;
+    /** Full name of the class whose derived classes should be inspected. */
+    selectClassName: EC.FullClassNameDotNotation;
+}): Promise<HiddenClassesTreeNode[]>;
+//# sourceMappingURL=HiddenClasses.d.ts.map

package/lib/shared/HiddenClasses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HiddenClasses.d.ts","sourceRoot":"","sources":["../../src/shared/HiddenClasses.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,EAAE,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAEjF;;;;;;;;;;;;GAYG;AACH,wBAAsB,uBAAuB,CAAC,KAAK,EAAE;IACnD,kFAAkF;IAClF,cAAc,EAAE,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAC;IACpD,wEAAwE;IACxE,eAAe,EAAE,EAAE,CAAC,wBAAwB,CAAC;CAC9C,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAGnC"}

package/lib/shared/HiddenClasses.js

@@ -0,0 +1,52 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { firstValueFrom, from, groupBy, map, mergeMap, ReplaySubject, toArray } from "rxjs";
+import { getClass } from "./Metadata.js";
+import { parseFullClassName } from "./Utils.js";
+/**
+ * Creates a tree of classes, derived from the given class, whose visibility is changed through `HiddenClass`
+ * or `HiddenSchema` custom attributes. See `HiddenClassesTreeNode` for details on the tree structure.
+ * The selected class is the visibility boundary: `HiddenClass` attributes on it and on its base classes are ignored, so
+ * it and its descendants are visible unless a descendant is hidden through its own `HiddenClass` attribute or
+ * the `HiddenSchema` attribute of its schema.
+ *
+ * The function traverses the whole derived classes' hierarchy of the given class, which may be expensive. It's
+ * meant to be used by `ECSchemaProvider.getHiddenClassesTree` implementations, which are expected to cache the result.
+ *
+ * @throws Error if the selected class or any of its derived classes' schemas can't be found.
+ * @public
+ */
+export async function createHiddenClassesTree(props) {
+    const selectClass = await getClass(props.schemaProvider, props.selectClassName);
+    return firstValueFrom(collectHiddenClassesTreeNodes(props.schemaProvider, selectClass, "show").pipe(toArray()));
+}
+function collectHiddenClassesTreeNodes(schemaProvider, parentClass, parentState) {
+    return from(parentClass.getDerivedClassNames({ onlyDirect: true })).pipe(map(parseFullClassName), groupBy(({ schemaName }) => schemaName, {
+        element: ({ className }) => className,
+        connector: () => new ReplaySubject(),
+    }), mergeMap((classNames) => from(schemaProvider.getSchema(classNames.key)).pipe(mergeMap((schema) => {
+        if (!schema) {
+            throw new Error(`Schema "${classNames.key}" not found.`);
+        }
+        return classNames.pipe(mergeMap((className) => {
+            const ecClass = schema.getClass(className);
+            if (!ecClass) {
+                throw new Error(`Class "${className}" not found in schema "${classNames.key}".`);
+            }
+            const schemaState = schema.isHidden ? "hide" : undefined;
+            const classState = ecClass.isHidden === true ? "hide" : ecClass.isHidden === false ? "show" : undefined;
+            const effectiveState = classState ?? schemaState ?? parentState;
+            if (effectiveState === parentState) {
+                return collectHiddenClassesTreeNodes(schemaProvider, ecClass, parentState);
+            }
+            return collectHiddenClassesTreeNodes(schemaProvider, ecClass, effectiveState).pipe(toArray(), map((children) => ({
+                fullName: ecClass.fullName,
+                state: effectiveState,
+                children,
+            })));
+        }));
+    }))));
+}
+//# sourceMappingURL=HiddenClasses.js.map

package/lib/shared/HiddenClasses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HiddenClasses.js","sourceRoot":"","sources":["../../src/shared/HiddenClasses.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC5F,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAKhD;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,KAK7C;IACC,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,cAAc,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAChF,OAAO,cAAc,CAAC,6BAA6B,CAAC,KAAK,CAAC,cAAc,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;AAClH,CAAC;AAOD,SAAS,6BAA6B,CACpC,cAAmD,EACnD,WAAqB,EACrB,WAAyB;IAEzB,OAAO,IAAI,CAAC,WAAW,CAAC,oBAAoB,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CACtE,GAAG,CAAC,kBAAkB,CAAC,EACvB,OAAO,CAAC,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,UAAU,EAAE;QACtC,OAAO,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,SAAS;QACrC,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,aAAa,EAAU;KAC7C,CAAC,EACF,QAAQ,CAAC,CAAC,UAAU,EAAE,EAAE,CACtB,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CACjD,QAAQ,CAAC,CAAC,MAAM,EAAE,EAAE;QAClB,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,WAAW,UAAU,CAAC,GAAG,cAAc,CAAC,CAAC;QAC3D,CAAC;QACD,OAAO,UAAU,CAAC,IAAI,CACpB,QAAQ,CAAC,CAAC,SAAS,EAAE,EAAE;YACrB,MAAM,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;YAC3C,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,MAAM,IAAI,KAAK,CAAC,UAAU,SAAS,0BAA0B,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;YACnF,CAAC;YACD,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAE,MAAgB,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YACxG,MAAM,cAAc,GAAG,UAAU,IAAI,WAAW,IAAI,WAAW,CAAC;YAChE,IAAI,cAAc,KAAK,WAAW,EAAE,CAAC;gBACnC,OAAO,6BAA6B,CAAC,cAAc,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;YAC7E,CAAC;YACD,OAAO,6BAA6B,CAAC,cAAc,EAAE,OAAO,EAAE,cAAc,CAAC,CAAC,IAAI,CAChF,OAAO,EAAE,EACT,GAAG,CACD,CAAC,QAAQ,EAAE,EAAE,CACX,CAAC;gBACC,QAAQ,EAAE,OAAO,CAAC,QAAQ;gBAC1B,KAAK,EAAE,cAAc;gBACrB,QAAQ;aACT,CAAqD,CACzD,CACF,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;IACJ,CAAC,CAAC,CACH,CACF,CACF,CAAC;AACJ,CAAC"}