@itwin/presentation-core-interop 0.1.0

package/.mocharc.json

@@ -0,0 +1,8 @@
+{
+  "checkLeaks": true,
+  "timeout": 60000,
+  "file": ["./lib/cjs/test/index.js"],
+  "exclude": ["./lib/test/coverage/**/*"],
+  "reporter": ["node_modules/@itwin/build-tools/mocha-reporter"],
+  "reporterOptions": ["mochaFile=lib/test/junit_results.xml"]
+}

package/.nycrc

@@ -0,0 +1,14 @@
+{
+  "check-coverage": true,
+  "statements": 100,
+  "functions": 100,
+  "branches": 100,
+  "lines": 100,
+  "all": true,
+  "include": ["src/**/*", "lib/cjs/**/*"],
+  "exclude": ["src/presentation-core-interop.ts", "src/test/**", "lib/cjs/test/**"],
+  "extension": [".ts"],
+  "temp-dir": "./lib/test/coverage/.nyc_output",
+  "report-dir": "./lib/test/coverage",
+  "reporter": ["text-summary", "lcov", "cobertura"]
+}

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# @itwin/presentation-core-interop
+
+## 0.1.0
+
+### Minor Changes
+
+- [#554](https://github.com/iTwin/presentation/pull/554): Initial package release.
+
+### Patch Changes
+
+- Updated dependencies:
+  - @itwin/presentation-shared@0.1.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+# MIT License
+
+Copyright © 2017-2024 Bentley Systems, Incorporated. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,99 @@
+# @itwin/presentation-core-interop
+
+Copyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md for license terms and full copyright notice.
+
+The `@itwin/presentation-core-interop` package acts as a layer between [`itwinjs-core` packages](https://www.itwinjs.org/reference/) and `presentation` packages:
+
+- `@itwin/presentation-hierarchies`
+- `@itwin/unified-selection`
+
+Having this interop layer helps us evolve both sides without affecting one another in a major way.
+
+## API
+
+### `createECSqlQueryExecutor`
+
+Maps an iModel in the form of `itwinjs-core` [IModelDb](https://www.itwinjs.org/reference/core-backend/imodels/imodeldb/) or [IModelConnection](https://www.itwinjs.org/reference/core-frontend/imodelconnection/imodelconnection/) to an instance of `ECSqlQueryExecutor`, used in `@itwin/presentation-hierarchies` and `@itwin/unified-selection` packages.
+
+Example:
+
+```ts
+import { IModelDb } from "@itwin/core-backend";
+import { createECSqlQueryExecutor } from "@itwin/presentation-core-interop";
+
+const imodel: IModelDb = getIModelDb();
+const executor = createECSqlQueryExecutor(imodel);
+for await (const row of executor.createQueryReader(MY_QUERY)) {
+  // TODO: do something with `row`
+}
+```
+
+### `createECSchemaProvider`
+
+Maps an instance of `itwinjs-core` [SchemaContext](https://www.itwinjs.org/reference/ecschema-metadata/context/schemacontext/) class to an instance of `ECSchemaProvider`, used in `@itwin/presentation-hierarchies` and `@itwin/unified-selection` packages.
+
+Example:
+
+```ts
+import { SchemaContext } from "@itwin/ecschema-metadata";
+import { createECSchemaProvider } from "@itwin/presentation-core-interop";
+
+const schemas = new SchemaContext();
+const schemaProvider = createECSchemaProvider(schemas);
+// the created schema provider may be used in `@itwin/presentation-hierarchies` or `@itwin/unified-selection` packages
+```
+
+### `createValueFormatter`
+
+Creates an instance of `IPrimitiveValueFormatter` that knows how to format primitive property values using their units' information. That information is retrieved from an iModel through `itwinjs-core` [SchemaContext](https://www.itwinjs.org/reference/ecschema-metadata/context/schemacontext/).
+
+Example:
+
+```ts
+import { SchemaContext } from "@itwin/ecschema-metadata";
+import { createValueFormatter } from "@itwin/presentation-core-interop";
+
+const schemaContext = new SchemaContext();
+const formatter = createValueFormatter({ schemaContext, unitSystem: "metric" });
+const formattedValue = await formatter({ type: "Double", value: 1.234, koqName: "MySchema.LengthKindOfQuantity" });
+```
+
+### `registerTxnListeners`
+
+Registers a number of transaction listeners on either the backend [TxnManager](https://www.itwinjs.org/reference/core-backend/imodels/txnmanager/) or the frontend [BriefcaseTxns](https://www.itwinjs.org/reference/core-frontend/imodelconnection/briefcasetxns/) and calls the given `onChange` function whenever there's a change in an iModel holding the transaction manager.
+
+Example:
+
+```ts
+import { BriefcaseDb } from "@itwin/core-backend";
+import { registerTxnListeners } from "@itwin/presentation-core-interop";
+import { HierarchyProvider } from "@itwin/presentation-hierarchies";
+
+// get iModel and hierarchy provider from arbitrary sources
+const db: BriefcaseDb = getIModel();
+const provider: HierarchyProvider = getHierarchyProvider();
+
+// register the listeners
+const unregister = registerTxnListeners(db.txns, () => {
+  // notify provided about the changed data
+  provider.notifyDataSourceChanged();
+  // TODO: force the components using `provider` to reload
+});
+
+// clean up on iModel close
+db.onClosed.addOnce(() => unregister());
+```
+
+### `createLogger`
+
+Maps the `itwinjs-core` [Logger](https://www.itwinjs.org/reference/core-bentley/logging/logger/) class to an `ILogger` interface used by Presentation packages.
+
+Example:
+
+```ts
+import { Logger as CoreLogger } from "@itwin/core-bentley";
+import { createLogger as createPresentationLogger } from "@itwin/presentation-core-interop";
+import { setLogger as setPresentationLogger } from "@itwin/presentation-hierarchies";
+
+setPresentationLogger(createPresentationLogger(CoreLogger));
+```

package/api/presentation-core-interop.api.md

@@ -0,0 +1,38 @@
+## API Report File for "@itwin/presentation-core-interop"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ECSchemaProvider } from '@itwin/presentation-shared';
+import { ECSqlQueryExecutor } from '@itwin/presentation-shared';
+import { ECSqlReader } from '@itwin/core-common';
+import { Event } from '@itwin/presentation-shared';
+import { ILogger } from '@itwin/presentation-shared';
+import { IPrimitiveValueFormatter } from '@itwin/presentation-shared';
+import { LogLevel } from '@itwin/core-bentley';
+import { QueryBinder } from '@itwin/core-common';
+import { QueryOptions } from '@itwin/core-common';
+import { Schema } from '@itwin/ecschema-metadata';
+import { SchemaContext } from '@itwin/ecschema-metadata';
+import { SchemaKey } from '@itwin/ecschema-metadata';
+import { UnitSystemKey } from '@itwin/core-quantity';
+
+// @beta
+export function createECSchemaProvider(schemaContext: CoreSchemaContext): ECSchemaProvider;
+
+// @beta
+export function createECSqlQueryExecutor(imodel: CoreECSqlReaderFactory): ECSqlQueryExecutor;
+
+// @beta
+export function createLogger(coreLogger: ICoreLogger): ILogger;
+
+// @beta
+export function createValueFormatter(props: CreateValueFormatterProps): IPrimitiveValueFormatter;
+
+// @beta
+export function registerTxnListeners(txns: ICoreTxnManager, onChanged: () => void): () => void;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/api/presentation-core-interop.exports.csv

@@ -0,0 +1,7 @@
+sep=;
+Release Tag;API Item
+beta;createECSchemaProvider(schemaContext: CoreSchemaContext): ECSchemaProvider
+beta;createECSqlQueryExecutor(imodel: CoreECSqlReaderFactory): ECSqlQueryExecutor
+beta;createLogger(coreLogger: ICoreLogger): ILogger
+beta;createValueFormatter(props: CreateValueFormatterProps): IPrimitiveValueFormatter
+beta;registerTxnListeners(txns: ICoreTxnManager, onChanged: () => void): () => void

package/eslint.config.js

@@ -0,0 +1,14 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+const iTwinPlugin = require("@itwin/eslint-plugin");
+const eslintBaseConfig = require("../../eslint.base.config");
+
+module.exports = [
+  {
+    files: ["**/*.ts"],
+    ...iTwinPlugin.configs.iTwinjsRecommendedConfig,
+  },
+  ...eslintBaseConfig,
+];

package/lib/cjs/core-interop/Formatting.d.ts

@@ -0,0 +1,44 @@
+import { UnitSystemKey } from "@itwin/core-quantity";
+import { SchemaContext } from "@itwin/ecschema-metadata";
+import { IPrimitiveValueFormatter } from "@itwin/presentation-shared";
+/**
+ * Props for `createValueFormatter` function.
+ */
+interface CreateValueFormatterProps {
+    /**
+     * An instance of [SchemaContext](https://www.itwinjs.org/reference/ecschema-metadata/context/schemacontext/) for
+     * getting units information.
+     */
+    schemaContext: SchemaContext;
+    /**
+     * An optional unit system to use for formatting property values. If not provided, default presentation units are used. If a property
+     * doesn't have a default presentation unit, then persistence unit is used. Finally, if a property doesn't have a unit assigned at all,
+     * `baseFormatter` is used to format the property value.
+     */
+    unitSystem?: UnitSystemKey;
+    /**
+     * Base primitive value formatter for cases when a property doesn't have any units' information. Defaults to the result of `createDefaultValueFormatter`
+     * from `@itwin/presentation-hierarchies` package.
+     */
+    baseFormatter?: IPrimitiveValueFormatter;
+}
+/**
+ * Creates an instance of `IPrimitiveValueFormatter` that knows how to format values of properties with assigned kind of quantity. In
+ * case the property does not have an assigned kind of quantity, the base formatter is used.
+ *
+ * Usage example:
+ *
+ * ```ts
+ * import { SchemaContext } from "@itwin/ecschema-metadata";
+ * import { createValueFormatter } from "@itwin/presentation-core-interop";
+ *
+ * const schemaContext = new SchemaContext();
+ * const formatter = createValueFormatter({ schemaContext, unitSystem: "metric" });
+ * const formattedValue = await formatter({ type: "Double", value: 1.234, koqName: "MySchema.LengthKindOfQuantity" });
+ * ```
+ *
+ * @beta
+ */
+export declare function createValueFormatter(props: CreateValueFormatterProps): IPrimitiveValueFormatter;
+export {};
+//# sourceMappingURL=Formatting.d.ts.map

package/lib/cjs/core-interop/Formatting.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Formatting.d.ts","sourceRoot":"","sources":["../../../src/core-interop/Formatting.ts"],"names":[],"mappings":"AAKA,OAAO,EAAuE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAC1H,OAAO,EAKL,aAAa,EAKd,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAA+B,wBAAwB,EAA2C,MAAM,4BAA4B,CAAC;AAE5I;;GAEG;AACH,UAAU,yBAAyB;IACjC;;;OAGG;IACH,aAAa,EAAE,aAAa,CAAC;IAE7B;;;;OAIG;IACH,UAAU,CAAC,EAAE,aAAa,CAAC;IAE3B;;;OAGG;IACH,aAAa,CAAC,EAAE,wBAAwB,CAAC;CAC1C;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,yBAAyB,GAAG,wBAAwB,CAc/F"}

package/lib/cjs/core-interop/Formatting.js

@@ -0,0 +1,147 @@
+"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.createValueFormatter = void 0;
+const core_quantity_1 = require("@itwin/core-quantity");
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+const presentation_shared_1 = require("@itwin/presentation-shared");
+/**
+ * Creates an instance of `IPrimitiveValueFormatter` that knows how to format values of properties with assigned kind of quantity. In
+ * case the property does not have an assigned kind of quantity, the base formatter is used.
+ *
+ * Usage example:
+ *
+ * ```ts
+ * import { SchemaContext } from "@itwin/ecschema-metadata";
+ * import { createValueFormatter } from "@itwin/presentation-core-interop";
+ *
+ * const schemaContext = new SchemaContext();
+ * const formatter = createValueFormatter({ schemaContext, unitSystem: "metric" });
+ * const formattedValue = await formatter({ type: "Double", value: 1.234, koqName: "MySchema.LengthKindOfQuantity" });
+ * ```
+ *
+ * @beta
+ */
+function createValueFormatter(props) {
+    const { schemaContext, unitSystem } = props;
+    const baseFormatter = props.baseFormatter ?? /* istanbul ignore next */ (0, presentation_shared_1.createDefaultValueFormatter)();
+    const unitsProvider = new ecschema_metadata_1.SchemaUnitProvider(schemaContext);
+    return async function (value) {
+        if (value.type === "Double" && !!value.koqName) {
+            const koq = await getKindOfQuantity(schemaContext, value.koqName);
+            const spec = await getFormatterSpec(unitsProvider, koq, unitSystem);
+            if (spec) {
+                return spec.applyFormatting(value.value);
+            }
+        }
+        return baseFormatter(value);
+    };
+}
+exports.createValueFormatter = createValueFormatter;
+async function getKindOfQuantity(schemas, fullName) {
+    const { schemaName, className: koqName } = (0, presentation_shared_1.parseFullClassName)(fullName);
+    const schema = await schemas.getSchema(new ecschema_metadata_1.SchemaKey(schemaName), ecschema_metadata_1.SchemaMatchType.Latest);
+    if (!schema) {
+        throw new Error(`Invalid schema "${schemaName}" specified in KoQ full name "${fullName}"`);
+    }
+    const koq = await schema.getItem(koqName);
+    if (!koq) {
+        throw new Error(`Invalid kind of quantity "${koqName}" specified in KoQ full name "${fullName}" - it does not exist in schema "${schemaName}"`);
+    }
+    return koq;
+}
+async function getFormatterSpec(unitsProvider, koq, unitSystem) {
+    const formattingProps = await getFormattingProps(koq, unitSystem);
+    if (!formattingProps) {
+        return undefined;
+    }
+    const { formatProps, persistenceUnitName } = formattingProps;
+    const persistenceUnit = await unitsProvider.findUnitByName(persistenceUnitName);
+    const format = await core_quantity_1.Format.createFromJSON("", unitsProvider, formatProps);
+    return core_quantity_1.FormatterSpec.create("", format, unitsProvider, persistenceUnit);
+}
+async function getFormattingProps(koq, unitSystem) {
+    const persistenceUnit = await koq.persistenceUnit;
+    // istanbul ignore if
+    if (!persistenceUnit) {
+        return undefined;
+    }
+    const formatProps = await getKoqFormatProps(koq, persistenceUnit, unitSystem);
+    if (!formatProps) {
+        return undefined;
+    }
+    return { formatProps, persistenceUnitName: persistenceUnit.fullName };
+}
+async function getKoqFormatProps(koq, persistenceUnit, unitSystem) {
+    const unitSystems = getUnitSystemGroupNames(unitSystem);
+    // use one of KOQ presentation format that matches requested unit system
+    const presentationFormat = await getKoqPresentationFormat(koq, unitSystems);
+    if (presentationFormat) {
+        return getFormatProps(presentationFormat);
+    }
+    // use persistence unit format if it matches requested unit system and matching presentation format was not found
+    const persistenceUnitSystem = await persistenceUnit.unitSystem;
+    if (persistenceUnitSystem && unitSystems.includes(persistenceUnitSystem.name.toUpperCase())) {
+        return getPersistenceUnitFormatProps(persistenceUnit);
+    }
+    // use default presentation format if persistence unit does not match requested unit system
+    if (koq.defaultPresentationFormat) {
+        return getFormatProps(koq.defaultPresentationFormat);
+    }
+    return undefined;
+}
+async function getKoqPresentationFormat(koq, unitSystems) {
+    const presentationFormats = koq.presentationFormats;
+    for (const system of unitSystems) {
+        for (const format of presentationFormats) {
+            const unit = format.units && format.units[0][0];
+            // istanbul ignore if
+            if (!unit) {
+                continue;
+            }
+            const currentUnitSystem = await unit.unitSystem;
+            if (currentUnitSystem && currentUnitSystem.name.toUpperCase() === system) {
+                return format;
+            }
+        }
+    }
+    return undefined;
+}
+function getFormatProps(format) {
+    return format instanceof ecschema_metadata_1.OverrideFormat ? format.getFormatProps() : format.toJSON();
+}
+function getPersistenceUnitFormatProps(persistenceUnit) {
+    // Same as Format "DefaultRealU" in Formats ecschema
+    return {
+        formatTraits: ["keepSingleZero", "keepDecimalPoint", "showUnitLabel"],
+        precision: 6,
+        type: "Decimal",
+        uomSeparator: " ",
+        decimalSeparator: ".",
+        composite: {
+            units: [
+                {
+                    name: persistenceUnit.fullName,
+                    label: persistenceUnit.label,
+                },
+            ],
+        },
+    };
+}
+function getUnitSystemGroupNames(unitSystem) {
+    switch (unitSystem) {
+        case "imperial":
+            return ["IMPERIAL", "USCUSTOM", "INTERNATIONAL", "FINANCE"];
+        case "metric":
+            return ["SI", "METRIC", "INTERNATIONAL", "FINANCE"];
+        case "usCustomary":
+            return ["USCUSTOM", "INTERNATIONAL", "FINANCE"];
+        case "usSurvey":
+            return ["USSURVEY", "USCUSTOM", "INTERNATIONAL", "FINANCE"];
+    }
+    return [];
+}
+//# sourceMappingURL=Formatting.js.map

package/lib/cjs/core-interop/Formatting.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Formatting.js","sourceRoot":"","sources":["../../../src/core-interop/Formatting.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,wDAA0H;AAC1H,gEAUkC;AAClC,oEAA4I;AA0B5I;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,oBAAoB,CAAC,KAAgC;IACnE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;IAC5C,MAAM,aAAa,GAAG,KAAK,CAAC,aAAa,IAAI,0BAA0B,CAAC,IAAA,iDAA2B,GAAE,CAAC;IACtG,MAAM,aAAa,GAAG,IAAI,sCAAkB,CAAC,aAAa,CAAC,CAAC;IAC5D,OAAO,KAAK,WAAW,KAA0B;QAC/C,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YAC/C,MAAM,GAAG,GAAG,MAAM,iBAAiB,CAAC,aAAa,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;YAClE,MAAM,IAAI,GAAG,MAAM,gBAAgB,CAAC,aAAa,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;YACpE,IAAI,IAAI,EAAE,CAAC;gBACT,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;QACD,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC,CAAC;AACJ,CAAC;AAdD,oDAcC;AAED,KAAK,UAAU,iBAAiB,CAAC,OAAsB,EAAE,QAAgB;IACvE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAA,wCAAkB,EAAC,QAAQ,CAAC,CAAC;IACxE,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,6BAAS,CAAC,UAAU,CAAC,EAAE,mCAAe,CAAC,MAAM,CAAC,CAAC;IAC1F,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,mBAAmB,UAAU,iCAAiC,QAAQ,GAAG,CAAC,CAAC;IAC7F,CAAC;IACD,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,OAAO,CAAiB,OAAO,CAAC,CAAC;IAC1D,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CAAC,6BAA6B,OAAO,iCAAiC,QAAQ,oCAAoC,UAAU,GAAG,CAAC,CAAC;IAClJ,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,KAAK,UAAU,gBAAgB,CAAC,aAA4B,EAAE,GAAmB,EAAE,UAA0B;IAC3G,MAAM,eAAe,GAAG,MAAM,kBAAkB,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;IAClE,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,EAAE,WAAW,EAAE,mBAAmB,EAAE,GAAG,eAAe,CAAC;IAC7D,MAAM,eAAe,GAAG,MAAM,aAAa,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;IAChF,MAAM,MAAM,GAAG,MAAM,sBAAc,CAAC,cAAc,CAAC,EAAE,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;IACnF,OAAO,6BAAa,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,eAAe,CAAC,CAAC;AAC1E,CAAC;AAOD,KAAK,UAAU,kBAAkB,CAAC,GAAmB,EAAE,UAA0B;IAC/E,MAAM,eAAe,GAAG,MAAM,GAAG,CAAC,eAAe,CAAC;IAClD,qBAAqB;IACrB,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,WAAW,GAAG,MAAM,iBAAiB,CAAC,GAAG,EAAE,eAAe,EAAE,UAAU,CAAC,CAAC;IAC9E,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,eAAe,CAAC,QAAQ,EAAE,CAAC;AACxE,CAAC;AAED,KAAK,UAAU,iBAAiB,CAAC,GAAmB,EAAE,eAAoC,EAAE,UAA0B;IACpH,MAAM,WAAW,GAAG,uBAAuB,CAAC,UAAU,CAAC,CAAC;IACxD,wEAAwE;IACxE,MAAM,kBAAkB,GAAG,MAAM,wBAAwB,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IAC5E,IAAI,kBAAkB,EAAE,CAAC;QACvB,OAAO,cAAc,CAAC,kBAAkB,CAAC,CAAC;IAC5C,CAAC;IAED,iHAAiH;IACjH,MAAM,qBAAqB,GAAG,MAAM,eAAe,CAAC,UAAU,CAAC;IAC/D,IAAI,qBAAqB,IAAI,WAAW,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;QAC5F,OAAO,6BAA6B,CAAC,eAAe,CAAC,CAAC;IACxD,CAAC;IAED,2FAA2F;IAC3F,IAAI,GAAG,CAAC,yBAAyB,EAAE,CAAC;QAClC,OAAO,cAAc,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;IACvD,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,KAAK,UAAU,wBAAwB,CAAC,GAAmB,EAAE,WAAqB;IAChF,MAAM,mBAAmB,GAAG,GAAG,CAAC,mBAAmB,CAAC;IACpD,KAAK,MAAM,MAAM,IAAI,WAAW,EAAE,CAAC;QACjC,KAAK,MAAM,MAAM,IAAI,mBAAmB,EAAE,CAAC;YACzC,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAChD,qBAAqB;YACrB,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,SAAS;YACX,CAAC;YACD,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;YAChD,IAAI,iBAAiB,IAAI,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;gBACzE,OAAO,MAAM,CAAC;YAChB,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,cAAc,CAAC,MAA+B;IACrD,OAAO,MAAM,YAAY,kCAAc,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;AACtF,CAAC;AAED,SAAS,6BAA6B,CAAC,eAAoC;IACzE,oDAAoD;IACpD,OAAO;QACL,YAAY,EAAE,CAAC,gBAAgB,EAAE,kBAAkB,EAAE,eAAe,CAAC;QACrE,SAAS,EAAE,CAAC;QACZ,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,GAAG;QACjB,gBAAgB,EAAE,GAAG;QACrB,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,eAAe,CAAC,QAAQ;oBAC9B,KAAK,EAAE,eAAe,CAAC,KAAK;iBAC7B;aACF;SACF;KACF,CAAC;AACJ,CAAC;AAED,SAAS,uBAAuB,CAAC,UAA0B;IACzD,QAAQ,UAAU,EAAE,CAAC;QACnB,KAAK,UAAU;YACb,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;QAC9D,KAAK,QAAQ;YACX,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;QACtD,KAAK,aAAa;YAChB,OAAO,CAAC,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;QAClD,KAAK,UAAU;YACb,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;IAChE,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\nimport { FormatProps, FormatterSpec, Format as QuantityFormat, UnitsProvider, UnitSystemKey } from \"@itwin/core-quantity\";\nimport {\n  Format,\n  InvertedUnit,\n  KindOfQuantity,\n  OverrideFormat,\n  SchemaContext,\n  SchemaKey,\n  SchemaMatchType,\n  SchemaUnitProvider,\n  Unit,\n} from \"@itwin/ecschema-metadata\";\nimport { createDefaultValueFormatter, IPrimitiveValueFormatter, parseFullClassName, TypedPrimitiveValue } from \"@itwin/presentation-shared\";\n\n/**\n * Props for `createValueFormatter` function.\n */\ninterface CreateValueFormatterProps {\n  /**\n   * An instance of [SchemaContext](https://www.itwinjs.org/reference/ecschema-metadata/context/schemacontext/) for\n   * getting units information.\n   */\n  schemaContext: SchemaContext;\n\n  /**\n   * An optional unit system to use for formatting property values. If not provided, default presentation units are used. If a property\n   * doesn't have a default presentation unit, then persistence unit is used. Finally, if a property doesn't have a unit assigned at all,\n   * `baseFormatter` is used to format the property value.\n   */\n  unitSystem?: UnitSystemKey;\n\n  /**\n   * Base primitive value formatter for cases when a property doesn't have any units' information. Defaults to the result of `createDefaultValueFormatter`\n   * from `@itwin/presentation-hierarchies` package.\n   */\n  baseFormatter?: IPrimitiveValueFormatter;\n}\n\n/**\n * Creates an instance of `IPrimitiveValueFormatter` that knows how to format values of properties with assigned kind of quantity. In\n * case the property does not have an assigned kind of quantity, the base formatter is used.\n *\n * Usage example:\n *\n * ```ts\n * import { SchemaContext } from \"@itwin/ecschema-metadata\";\n * import { createValueFormatter } from \"@itwin/presentation-core-interop\";\n *\n * const schemaContext = new SchemaContext();\n * const formatter = createValueFormatter({ schemaContext, unitSystem: \"metric\" });\n * const formattedValue = await formatter({ type: \"Double\", value: 1.234, koqName: \"MySchema.LengthKindOfQuantity\" });\n * ```\n *\n * @beta\n */\nexport function createValueFormatter(props: CreateValueFormatterProps): IPrimitiveValueFormatter {\n  const { schemaContext, unitSystem } = props;\n  const baseFormatter = props.baseFormatter ?? /* istanbul ignore next */ createDefaultValueFormatter();\n  const unitsProvider = new SchemaUnitProvider(schemaContext);\n  return async function (value: TypedPrimitiveValue): Promise<string> {\n    if (value.type === \"Double\" && !!value.koqName) {\n      const koq = await getKindOfQuantity(schemaContext, value.koqName);\n      const spec = await getFormatterSpec(unitsProvider, koq, unitSystem);\n      if (spec) {\n        return spec.applyFormatting(value.value);\n      }\n    }\n    return baseFormatter(value);\n  };\n}\n\nasync function getKindOfQuantity(schemas: SchemaContext, fullName: string) {\n  const { schemaName, className: koqName } = parseFullClassName(fullName);\n  const schema = await schemas.getSchema(new SchemaKey(schemaName), SchemaMatchType.Latest);\n  if (!schema) {\n    throw new Error(`Invalid schema \"${schemaName}\" specified in KoQ full name \"${fullName}\"`);\n  }\n  const koq = await schema.getItem<KindOfQuantity>(koqName);\n  if (!koq) {\n    throw new Error(`Invalid kind of quantity \"${koqName}\" specified in KoQ full name \"${fullName}\" - it does not exist in schema \"${schemaName}\"`);\n  }\n  return koq;\n}\n\nasync function getFormatterSpec(unitsProvider: UnitsProvider, koq: KindOfQuantity, unitSystem?: UnitSystemKey) {\n  const formattingProps = await getFormattingProps(koq, unitSystem);\n  if (!formattingProps) {\n    return undefined;\n  }\n  const { formatProps, persistenceUnitName } = formattingProps;\n  const persistenceUnit = await unitsProvider.findUnitByName(persistenceUnitName);\n  const format = await QuantityFormat.createFromJSON(\"\", unitsProvider, formatProps);\n  return FormatterSpec.create(\"\", format, unitsProvider, persistenceUnit);\n}\n\ninterface FormattingProps {\n  formatProps: FormatProps;\n  persistenceUnitName: string;\n}\n\nasync function getFormattingProps(koq: KindOfQuantity, unitSystem?: UnitSystemKey): Promise<FormattingProps | undefined> {\n  const persistenceUnit = await koq.persistenceUnit;\n  // istanbul ignore if\n  if (!persistenceUnit) {\n    return undefined;\n  }\n  const formatProps = await getKoqFormatProps(koq, persistenceUnit, unitSystem);\n  if (!formatProps) {\n    return undefined;\n  }\n  return { formatProps, persistenceUnitName: persistenceUnit.fullName };\n}\n\nasync function getKoqFormatProps(koq: KindOfQuantity, persistenceUnit: Unit | InvertedUnit, unitSystem?: UnitSystemKey) {\n  const unitSystems = getUnitSystemGroupNames(unitSystem);\n  // use one of KOQ presentation format that matches requested unit system\n  const presentationFormat = await getKoqPresentationFormat(koq, unitSystems);\n  if (presentationFormat) {\n    return getFormatProps(presentationFormat);\n  }\n\n  // use persistence unit format if it matches requested unit system and matching presentation format was not found\n  const persistenceUnitSystem = await persistenceUnit.unitSystem;\n  if (persistenceUnitSystem && unitSystems.includes(persistenceUnitSystem.name.toUpperCase())) {\n    return getPersistenceUnitFormatProps(persistenceUnit);\n  }\n\n  // use default presentation format if persistence unit does not match requested unit system\n  if (koq.defaultPresentationFormat) {\n    return getFormatProps(koq.defaultPresentationFormat);\n  }\n\n  return undefined;\n}\n\nasync function getKoqPresentationFormat(koq: KindOfQuantity, unitSystems: string[]) {\n  const presentationFormats = koq.presentationFormats;\n  for (const system of unitSystems) {\n    for (const format of presentationFormats) {\n      const unit = format.units && format.units[0][0];\n      // istanbul ignore if\n      if (!unit) {\n        continue;\n      }\n      const currentUnitSystem = await unit.unitSystem;\n      if (currentUnitSystem && currentUnitSystem.name.toUpperCase() === system) {\n        return format;\n      }\n    }\n  }\n  return undefined;\n}\n\nfunction getFormatProps(format: Format | OverrideFormat): FormatProps {\n  return format instanceof OverrideFormat ? format.getFormatProps() : format.toJSON();\n}\n\nfunction getPersistenceUnitFormatProps(persistenceUnit: Unit | InvertedUnit): FormatProps {\n  // Same as Format \"DefaultRealU\" in Formats ecschema\n  return {\n    formatTraits: [\"keepSingleZero\", \"keepDecimalPoint\", \"showUnitLabel\"],\n    precision: 6,\n    type: \"Decimal\",\n    uomSeparator: \" \",\n    decimalSeparator: \".\",\n    composite: {\n      units: [\n        {\n          name: persistenceUnit.fullName,\n          label: persistenceUnit.label,\n        },\n      ],\n    },\n  };\n}\n\nfunction getUnitSystemGroupNames(unitSystem?: UnitSystemKey) {\n  switch (unitSystem) {\n    case \"imperial\":\n      return [\"IMPERIAL\", \"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"];\n    case \"metric\":\n      return [\"SI\", \"METRIC\", \"INTERNATIONAL\", \"FINANCE\"];\n    case \"usCustomary\":\n      return [\"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"];\n    case \"usSurvey\":\n      return [\"USSURVEY\", \"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"];\n  }\n  return [];\n}\n"]}

package/lib/cjs/core-interop/Logging.d.ts

@@ -0,0 +1,32 @@
+import { LogLevel as CoreLogLevel } from "@itwin/core-bentley";
+import { ILogger } from "@itwin/presentation-shared";
+/**
+ * Defines input for `createLogger`. Generally, this is the [Logger](https://www.itwinjs.org/reference/core-bentley/logging/logger/)
+ * class from `@itwin/core-bentley` package.
+ */
+interface ICoreLogger {
+    isEnabled(category: string, level: CoreLogLevel): boolean;
+    logError(category: string, message: string): void;
+    logWarning(category: string, message: string): void;
+    logInfo(category: string, message: string): void;
+    logTrace(category: string, message: string): void;
+}
+/**
+ * Creates a presentation `ILogger` instance that forwards all logging calls to the
+ * [Logger](https://www.itwinjs.org/reference/core-bentley/logging/logger/) API.
+ *
+ * Usage example:
+ *
+ * ```ts
+ * import { Logger } from "@itwin/core-bentley";
+ * import { createLogger } from "@itwin/presentation-core-interop";
+ * import { setLogger } from "@itwin/presentation-hierarchies";
+ *
+ * setLogger(createLogger(Logger));
+ * ```
+ *
+ * @beta
+ */
+export declare function createLogger(coreLogger: ICoreLogger): ILogger;
+export {};
+//# sourceMappingURL=Logging.d.ts.map

package/lib/cjs/core-interop/Logging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Logging.d.ts","sourceRoot":"","sources":["../../../src/core-interop/Logging.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,QAAQ,IAAI,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAY,MAAM,4BAA4B,CAAC;AAE/D;;;GAGG;AACH,UAAU,WAAW;IACnB,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC;IAC1D,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAClD,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACpD,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACjD,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACnD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,YAAY,CAAC,UAAU,EAAE,WAAW,GAAG,OAAO,CAQ7D"}

package/lib/cjs/core-interop/Logging.js

@@ -0,0 +1,47 @@
+"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.createLogger = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+/**
+ * Creates a presentation `ILogger` instance that forwards all logging calls to the
+ * [Logger](https://www.itwinjs.org/reference/core-bentley/logging/logger/) API.
+ *
+ * Usage example:
+ *
+ * ```ts
+ * import { Logger } from "@itwin/core-bentley";
+ * import { createLogger } from "@itwin/presentation-core-interop";
+ * import { setLogger } from "@itwin/presentation-hierarchies";
+ *
+ * setLogger(createLogger(Logger));
+ * ```
+ *
+ * @beta
+ */
+function createLogger(coreLogger) {
+    return {
+        isEnabled: (category, level) => coreLogger.isEnabled(category, getCoreLogLevel(level)),
+        logError: (category, msg) => coreLogger.logError(category, msg),
+        logWarning: (category, msg) => coreLogger.logWarning(category, msg),
+        logInfo: (category, msg) => coreLogger.logInfo(category, msg),
+        logTrace: (category, msg) => coreLogger.logTrace(category, msg),
+    };
+}
+exports.createLogger = createLogger;
+function getCoreLogLevel(level) {
+    switch (level) {
+        case "error":
+            return core_bentley_1.LogLevel.Error;
+        case "warning":
+            return core_bentley_1.LogLevel.Warning;
+        case "info":
+            return core_bentley_1.LogLevel.Info;
+        case "trace":
+            return core_bentley_1.LogLevel.Trace;
+    }
+}
+//# sourceMappingURL=Logging.js.map

package/lib/cjs/core-interop/Logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Logging.js","sourceRoot":"","sources":["../../../src/core-interop/Logging.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,sDAA+D;AAe/D;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,YAAY,CAAC,UAAuB;IAClD,OAAO;QACL,SAAS,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;QACtF,QAAQ,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC;QAC/D,UAAU,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC;QACnE,OAAO,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC;QAC7D,QAAQ,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC;KAChE,CAAC;AACJ,CAAC;AARD,oCAQC;AAED,SAAS,eAAe,CAAC,KAAe;IACtC,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,OAAO;YACV,OAAO,uBAAY,CAAC,KAAK,CAAC;QAC5B,KAAK,SAAS;YACZ,OAAO,uBAAY,CAAC,OAAO,CAAC;QAC9B,KAAK,MAAM;YACT,OAAO,uBAAY,CAAC,IAAI,CAAC;QAC3B,KAAK,OAAO;YACV,OAAO,uBAAY,CAAC,KAAK,CAAC;IAC9B,CAAC;AACH,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\nimport { LogLevel as CoreLogLevel } from \"@itwin/core-bentley\";\nimport { ILogger, LogLevel } from \"@itwin/presentation-shared\";\n\n/**\n * Defines input for `createLogger`. Generally, this is the [Logger](https://www.itwinjs.org/reference/core-bentley/logging/logger/)\n * class from `@itwin/core-bentley` package.\n */\ninterface ICoreLogger {\n  isEnabled(category: string, level: CoreLogLevel): boolean;\n  logError(category: string, message: string): void;\n  logWarning(category: string, message: string): void;\n  logInfo(category: string, message: string): void;\n  logTrace(category: string, message: string): void;\n}\n\n/**\n * Creates a presentation `ILogger` instance that forwards all logging calls to the\n * [Logger](https://www.itwinjs.org/reference/core-bentley/logging/logger/) API.\n *\n * Usage example:\n *\n * ```ts\n * import { Logger } from \"@itwin/core-bentley\";\n * import { createLogger } from \"@itwin/presentation-core-interop\";\n * import { setLogger } from \"@itwin/presentation-hierarchies\";\n *\n * setLogger(createLogger(Logger));\n * ```\n *\n * @beta\n */\nexport function createLogger(coreLogger: ICoreLogger): ILogger {\n  return {\n    isEnabled: (category, level) => coreLogger.isEnabled(category, getCoreLogLevel(level)),\n    logError: (category, msg) => coreLogger.logError(category, msg),\n    logWarning: (category, msg) => coreLogger.logWarning(category, msg),\n    logInfo: (category, msg) => coreLogger.logInfo(category, msg),\n    logTrace: (category, msg) => coreLogger.logTrace(category, msg),\n  };\n}\n\nfunction getCoreLogLevel(level: LogLevel): CoreLogLevel {\n  switch (level) {\n    case \"error\":\n      return CoreLogLevel.Error;\n    case \"warning\":\n      return CoreLogLevel.Warning;\n    case \"info\":\n      return CoreLogLevel.Info;\n    case \"trace\":\n      return CoreLogLevel.Trace;\n  }\n}\n"]}

package/lib/cjs/core-interop/Metadata.d.ts

@@ -0,0 +1,28 @@
+import { Schema as CoreSchema, SchemaKey as CoreSchemaKey } from "@itwin/ecschema-metadata";
+import { ECSchemaProvider } from "@itwin/presentation-shared";
+/**
+ * Defines input for `createECSchemaProvider`. Generally, this is an instance of [SchemaContext](https://www.itwinjs.org/reference/ecschema-metadata/context/schemacontext/)
+ * class from `@itwin/ecschema-metadata` package.
+ */
+interface CoreSchemaContext {
+    getSchema(key: CoreSchemaKey): Promise<CoreSchema | undefined>;
+}
+/**
+ * Creates an `ECSchemaProvider` for given [SchemaContext](https://www.itwinjs.org/reference/ecschema-metadata/context/schemacontext/).
+ *
+ * Usage example:
+ *
+ * ```ts
+ * import { SchemaContext } from "@itwin/ecschema-metadata";
+ * import { createECSchemaProvider } from "@itwin/presentation-core-interop";
+ *
+ * const schemaContext = new SchemaContext();
+ * const schemaProvider = createECSchemaProvider(schemas);
+ * // the created schema provider may be used in `@itwin/presentation-hierarchies` and other Presentation packages
+ * ```
+ *
+ * @beta
+ */
+export declare function createECSchemaProvider(schemaContext: CoreSchemaContext): ECSchemaProvider;
+export {};
+//# sourceMappingURL=Metadata.d.ts.map

package/lib/cjs/core-interop/Metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Metadata.d.ts","sourceRoot":"","sources":["../../../src/core-interop/Metadata.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,IAAI,UAAU,EAAE,SAAS,IAAI,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAC5F,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAG9D;;;GAGG;AACH,UAAU,iBAAiB;IACzB,SAAS,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;CAChE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,sBAAsB,CAAC,aAAa,EAAE,iBAAiB,GAAG,gBAAgB,CAsBzF"}

package/lib/cjs/core-interop/Metadata.js

@@ -0,0 +1,51 @@
+"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.createECSchemaProvider = void 0;
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+const MetadataInternal_1 = require("./MetadataInternal");
+/**
+ * Creates an `ECSchemaProvider` for given [SchemaContext](https://www.itwinjs.org/reference/ecschema-metadata/context/schemacontext/).
+ *
+ * Usage example:
+ *
+ * ```ts
+ * import { SchemaContext } from "@itwin/ecschema-metadata";
+ * import { createECSchemaProvider } from "@itwin/presentation-core-interop";
+ *
+ * const schemaContext = new SchemaContext();
+ * const schemaProvider = createECSchemaProvider(schemas);
+ * // the created schema provider may be used in `@itwin/presentation-hierarchies` and other Presentation packages
+ * ```
+ *
+ * @beta
+ */
+function createECSchemaProvider(schemaContext) {
+    async function getSchemaUnprotected(schemaName) {
+        const coreSchema = await schemaContext.getSchema(new ecschema_metadata_1.SchemaKey(schemaName));
+        return coreSchema ? (0, MetadataInternal_1.createECSchema)(coreSchema) : undefined;
+    }
+    async function getSchemaProtected(schemaName, handledExistingSchemaErrors) {
+        // workaround for https://github.com/iTwin/itwinjs-core/issues/6542
+        try {
+            return await getSchemaUnprotected(schemaName);
+        }
+        catch (e) {
+            if (e instanceof Error && e.message.includes("already exists within this cache") && !handledExistingSchemaErrors.has(schemaName)) {
+                handledExistingSchemaErrors.add(schemaName);
+                return getSchemaProtected(schemaName, handledExistingSchemaErrors);
+            }
+            throw e;
+        }
+    }
+    return {
+        async getSchema(name) {
+            return getSchemaProtected(name, new Set());
+        },
+    };
+}
+exports.createECSchemaProvider = createECSchemaProvider;
+//# sourceMappingURL=Metadata.js.map

package/lib/cjs/core-interop/Metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Metadata.js","sourceRoot":"","sources":["../../../src/core-interop/Metadata.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,gEAA4F;AAE5F,yDAAoD;AAUpD;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,sBAAsB,CAAC,aAAgC;IACrE,KAAK,UAAU,oBAAoB,CAAC,UAAkB;QACpD,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,SAAS,CAAC,IAAI,6BAAa,CAAC,UAAU,CAAC,CAAC,CAAC;QAChF,OAAO,UAAU,CAAC,CAAC,CAAC,IAAA,iCAAc,EAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7D,CAAC;IACD,KAAK,UAAU,kBAAkB,CAAC,UAAkB,EAAE,2BAAwC;QAC5F,mEAAmE;QACnE,IAAI,CAAC;YACH,OAAO,MAAM,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAChD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,kCAAkC,CAAC,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;gBACjI,2BAA2B,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;gBAC5C,OAAO,kBAAkB,CAAC,UAAU,EAAE,2BAA2B,CAAC,CAAC;YACrE,CAAC;YACD,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IACD,OAAO;QACL,KAAK,CAAC,SAAS,CAAC,IAAI;YAClB,OAAO,kBAAkB,CAAC,IAAI,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;QAC7C,CAAC;KACF,CAAC;AACJ,CAAC;AAtBD,wDAsBC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\nimport { Schema as CoreSchema, SchemaKey as CoreSchemaKey } from \"@itwin/ecschema-metadata\";\nimport { ECSchemaProvider } from \"@itwin/presentation-shared\";\nimport { createECSchema } from \"./MetadataInternal\";\n\n/**\n * Defines input for `createECSchemaProvider`. Generally, this is an instance of [SchemaContext](https://www.itwinjs.org/reference/ecschema-metadata/context/schemacontext/)\n * class from `@itwin/ecschema-metadata` package.\n */\ninterface CoreSchemaContext {\n  getSchema(key: CoreSchemaKey): Promise<CoreSchema | undefined>;\n}\n\n/**\n * Creates an `ECSchemaProvider` for given [SchemaContext](https://www.itwinjs.org/reference/ecschema-metadata/context/schemacontext/).\n *\n * Usage example:\n *\n * ```ts\n * import { SchemaContext } from \"@itwin/ecschema-metadata\";\n * import { createECSchemaProvider } from \"@itwin/presentation-core-interop\";\n *\n * const schemaContext = new SchemaContext();\n * const schemaProvider = createECSchemaProvider(schemas);\n * // the created schema provider may be used in `@itwin/presentation-hierarchies` and other Presentation packages\n * ```\n *\n * @beta\n */\nexport function createECSchemaProvider(schemaContext: CoreSchemaContext): ECSchemaProvider {\n  async function getSchemaUnprotected(schemaName: string) {\n    const coreSchema = await schemaContext.getSchema(new CoreSchemaKey(schemaName));\n    return coreSchema ? createECSchema(coreSchema) : undefined;\n  }\n  async function getSchemaProtected(schemaName: string, handledExistingSchemaErrors: Set<string>) {\n    // workaround for https://github.com/iTwin/itwinjs-core/issues/6542\n    try {\n      return await getSchemaUnprotected(schemaName);\n    } catch (e) {\n      if (e instanceof Error && e.message.includes(\"already exists within this cache\") && !handledExistingSchemaErrors.has(schemaName)) {\n        handledExistingSchemaErrors.add(schemaName);\n        return getSchemaProtected(schemaName, handledExistingSchemaErrors);\n      }\n      throw e;\n    }\n  }\n  return {\n    async getSchema(name) {\n      return getSchemaProtected(name, new Set());\n    },\n  };\n}\n"]}

package/lib/cjs/core-interop/MetadataInternal.d.ts

@@ -0,0 +1,9 @@
+import { ECClass as CoreClass, Property as CoreProperty, Schema as CoreSchema } from "@itwin/ecschema-metadata";
+import { EC } from "@itwin/presentation-shared";
+/** @internal */
+export declare function createECSchema(schema: CoreSchema): EC.Schema;
+/** @internal */
+export declare function createECClass(coreClass: CoreClass, schema?: EC.Schema): EC.Class;
+/** @internal */
+export declare function createECProperty(coreProperty: CoreProperty, ecClass: EC.Class): EC.Property;
+//# sourceMappingURL=MetadataInternal.d.ts.map

package/lib/cjs/core-interop/MetadataInternal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MetadataInternal.d.ts","sourceRoot":"","sources":["../../../src/core-interop/MetadataInternal.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,OAAO,IAAI,SAAS,EAUpB,QAAQ,IAAI,YAAY,EAGxB,MAAM,IAAI,UAAU,EASrB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,EAAE,EAAE,MAAM,4BAA4B,CAAC;AAEhD,gBAAgB;AAChB,wBAAgB,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,EAAE,CAAC,MAAM,CAQ5D;AAwBD,gBAAgB;AAChB,wBAAgB,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,KAAK,CAYhF;AAoFD,gBAAgB;AAChB,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,EAAE,CAAC,KAAK,GAAG,EAAE,CAAC,QAAQ,CAqB3F"}