@itwin/core-backend 5.0.0-dev.11 → 5.0.0-dev.110

package/lib/esm/BackendLoggerCategory.d.ts

@@ -0,0 +1,88 @@
+/** @packageDocumentation
+ * @module Logging
+ */
+/** Logger categories used by this package
+ * @note All logger categories in this package start with the `core-backend` prefix.
+ * @see [Logger]($bentley)
+ * @public
+ */
+export declare enum BackendLoggerCategory {
+    /** The logger category used by API related to authorization */
+    Authorization = "core-backend.Authorization",
+    /** The logger category used by the following classes:
+     * - [[CodeSpecs]]
+     */
+    CodeSpecs = "core-backend.CodeSpecs",
+    /** The logger category used by the following classes:
+     * - [[CustomViewState3dCreator]]
+     */
+    CustomViewState3dCreator = "core-backend.CustomViewState3dCreator",
+    /** The logger category used by the [[DevTools]] class and related classes.
+     * @internal
+     */
+    DevTools = "core-backend.DevTools",
+    /** The logger category used by the following classes:
+     * - [[ChangeSummaryManager]]
+     * - [[ECDb]]
+     * - [[ECSqlStatement]]
+     */
+    ECDb = "core-backend.ECDb",
+    /** The logger category used by the following classes:
+     * - [[Functional]]
+     */
+    Functional = "core-backend.Functional",
+    /** The logger category used by the following classes:
+     * - [[LinearReferencing]]
+     */
+    LinearReferencing = "core-backend.LinearReferencing",
+    /** The logger category used by the following classes:
+     * - BriefcaseManager
+     * - [[IModelDb]]
+     */
+    IModelDb = "core-backend.IModelDb",
+    /** The logger category used by the following classes:
+     * - [[IModelHost]]
+     */
+    IModelHost = "core-backend.IModelHost",
+    /** The logger category used by the following classes:
+     * - TileRequestMemoizer
+     */
+    IModelTileRequestRpc = "core-backend.IModelTileRequestRpc",
+    /** The logger category used by the following classes:
+     * - IModelTileRpcImpl (Tile Uploading)
+     */
+    IModelTileUpload = "core-backend.IModelTileUpload",
+    /** The logger category used by the following classes:
+     * - TileStorage (tile upload/download)
+     */
+    IModelTileStorage = "core-backend.IModelTileStorage",
+    /** The logger category used by the following classes:
+     * - [[Relationship]]
+     */
+    Relationship = "core-backend.Relationship",
+    /** The logger category used by the following classes:
+     * - [[Schemas]]
+     */
+    Schemas = "core-backend.Schemas",
+    /** The logger category used by the following classes:
+     * - [[PromiseMemoizer]]
+     */
+    PromiseMemoizer = "core-backend.PromiseMemoizer",
+    /** The logger category used by the following classes:
+     * - [[EventSink]]
+     */
+    EventSink = "core-backend.EventSink",
+    /** The logger category used by the following classes:
+     * - [[NativeHost]], [[NativeAppStorage]]
+     * @internal
+     */
+    NativeApp = "core-backend.NativeApp",
+    /** The logger category used by the following classes:
+     * - [[ViewStateHydrator]]
+     * @internal
+     */
+    ViewStateHydrator = "core-backend.ViewStateHydrator",
+    /** @internal */
+    Workspace = "core-backend.Workspace"
+}
+//# sourceMappingURL=BackendLoggerCategory.d.ts.map

package/lib/esm/BackendLoggerCategory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackendLoggerCategory.d.ts","sourceRoot":"","sources":["../../src/BackendLoggerCategory.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;GAIG;AACH,oBAAY,qBAAqB;IAC/B,+DAA+D;IAC/D,aAAa,+BAA+B;IAE5C;;OAEG;IACH,SAAS,2BAA2B;IAEpC;;OAEG;IACH,wBAAwB,0CAA0C;IAElE;;OAEG;IACH,QAAQ,0BAA0B;IAElC;;;;OAIG;IACH,IAAI,sBAAsB;IAE1B;;OAEG;IACH,UAAU,4BAA4B;IAEtC;;OAEG;IACH,iBAAiB,mCAAmC;IAEpD;;;OAGG;IACH,QAAQ,0BAA0B;IAElC;;OAEG;IACH,UAAU,4BAA4B;IAEtC;;OAEG;IACH,oBAAoB,sCAAsC;IAE1D;;OAEG;IACH,gBAAgB,kCAAkC;IAElD;;OAEG;IACH,iBAAiB,mCAAmC;IAEpD;;OAEG;IACH,YAAY,8BAA8B;IAE1C;;OAEG;IACH,OAAO,yBAAyB;IAEhC;;OAEG;IACH,eAAe,iCAAiC;IAChD;;OAEG;IACH,SAAS,2BAA2B;IAEpC;;;OAGG;IACH,SAAS,2BAA2B;IAEpC;;;OAGG;IACH,iBAAiB,mCAAmC;IAEpD,gBAAgB;IAChB,SAAS,2BAA2B;CACrC"}

package/lib/esm/BackendLoggerCategory.js

@@ -0,0 +1,93 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Logging
+ */
+/** Logger categories used by this package
+ * @note All logger categories in this package start with the `core-backend` prefix.
+ * @see [Logger]($bentley)
+ * @public
+ */
+export var BackendLoggerCategory;
+(function (BackendLoggerCategory) {
+    /** The logger category used by API related to authorization */
+    BackendLoggerCategory["Authorization"] = "core-backend.Authorization";
+    /** The logger category used by the following classes:
+     * - [[CodeSpecs]]
+     */
+    BackendLoggerCategory["CodeSpecs"] = "core-backend.CodeSpecs";
+    /** The logger category used by the following classes:
+     * - [[CustomViewState3dCreator]]
+     */
+    BackendLoggerCategory["CustomViewState3dCreator"] = "core-backend.CustomViewState3dCreator";
+    /** The logger category used by the [[DevTools]] class and related classes.
+     * @internal
+     */
+    BackendLoggerCategory["DevTools"] = "core-backend.DevTools";
+    /** The logger category used by the following classes:
+     * - [[ChangeSummaryManager]]
+     * - [[ECDb]]
+     * - [[ECSqlStatement]]
+     */
+    BackendLoggerCategory["ECDb"] = "core-backend.ECDb";
+    /** The logger category used by the following classes:
+     * - [[Functional]]
+     */
+    BackendLoggerCategory["Functional"] = "core-backend.Functional";
+    /** The logger category used by the following classes:
+     * - [[LinearReferencing]]
+     */
+    BackendLoggerCategory["LinearReferencing"] = "core-backend.LinearReferencing";
+    /** The logger category used by the following classes:
+     * - BriefcaseManager
+     * - [[IModelDb]]
+     */
+    BackendLoggerCategory["IModelDb"] = "core-backend.IModelDb";
+    /** The logger category used by the following classes:
+     * - [[IModelHost]]
+     */
+    BackendLoggerCategory["IModelHost"] = "core-backend.IModelHost";
+    /** The logger category used by the following classes:
+     * - TileRequestMemoizer
+     */
+    BackendLoggerCategory["IModelTileRequestRpc"] = "core-backend.IModelTileRequestRpc";
+    /** The logger category used by the following classes:
+     * - IModelTileRpcImpl (Tile Uploading)
+     */
+    BackendLoggerCategory["IModelTileUpload"] = "core-backend.IModelTileUpload";
+    /** The logger category used by the following classes:
+     * - TileStorage (tile upload/download)
+     */
+    BackendLoggerCategory["IModelTileStorage"] = "core-backend.IModelTileStorage";
+    /** The logger category used by the following classes:
+     * - [[Relationship]]
+     */
+    BackendLoggerCategory["Relationship"] = "core-backend.Relationship";
+    /** The logger category used by the following classes:
+     * - [[Schemas]]
+     */
+    BackendLoggerCategory["Schemas"] = "core-backend.Schemas";
+    /** The logger category used by the following classes:
+     * - [[PromiseMemoizer]]
+     */
+    BackendLoggerCategory["PromiseMemoizer"] = "core-backend.PromiseMemoizer";
+    /** The logger category used by the following classes:
+     * - [[EventSink]]
+     */
+    BackendLoggerCategory["EventSink"] = "core-backend.EventSink";
+    /** The logger category used by the following classes:
+     * - [[NativeHost]], [[NativeAppStorage]]
+     * @internal
+     */
+    BackendLoggerCategory["NativeApp"] = "core-backend.NativeApp";
+    /** The logger category used by the following classes:
+     * - [[ViewStateHydrator]]
+     * @internal
+     */
+    BackendLoggerCategory["ViewStateHydrator"] = "core-backend.ViewStateHydrator";
+    /** @internal */
+    BackendLoggerCategory["Workspace"] = "core-backend.Workspace";
+})(BackendLoggerCategory || (BackendLoggerCategory = {}));
+//# sourceMappingURL=BackendLoggerCategory.js.map

package/lib/esm/BackendLoggerCategory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackendLoggerCategory.js","sourceRoot":"","sources":["../../src/BackendLoggerCategory.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH;;;;GAIG;AACH,MAAM,CAAN,IAAY,qBA+FX;AA/FD,WAAY,qBAAqB;IAC/B,+DAA+D;IAC/D,qEAA4C,CAAA;IAE5C;;OAEG;IACH,6DAAoC,CAAA;IAEpC;;OAEG;IACH,2FAAkE,CAAA;IAElE;;OAEG;IACH,2DAAkC,CAAA;IAElC;;;;OAIG;IACH,mDAA0B,CAAA;IAE1B;;OAEG;IACH,+DAAsC,CAAA;IAEtC;;OAEG;IACH,6EAAoD,CAAA;IAEpD;;;OAGG;IACH,2DAAkC,CAAA;IAElC;;OAEG;IACH,+DAAsC,CAAA;IAEtC;;OAEG;IACH,mFAA0D,CAAA;IAE1D;;OAEG;IACH,2EAAkD,CAAA;IAElD;;OAEG;IACH,6EAAoD,CAAA;IAEpD;;OAEG;IACH,mEAA0C,CAAA;IAE1C;;OAEG;IACH,yDAAgC,CAAA;IAEhC;;OAEG;IACH,yEAAgD,CAAA;IAChD;;OAEG;IACH,6DAAoC,CAAA;IAEpC;;;OAGG;IACH,6DAAoC,CAAA;IAEpC;;;OAGG;IACH,6EAAoD,CAAA;IAEpD,gBAAgB;IAChB,6DAAoC,CAAA;AACtC,CAAC,EA/FW,qBAAqB,KAArB,qBAAqB,QA+FhC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Logging\r\n */\r\n\r\n/** Logger categories used by this package\r\n * @note All logger categories in this package start with the `core-backend` prefix.\r\n * @see [Logger]($bentley)\r\n * @public\r\n */\r\nexport enum BackendLoggerCategory {\r\n  /** The logger category used by API related to authorization */\r\n  Authorization = \"core-backend.Authorization\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[CodeSpecs]]\r\n   */\r\n  CodeSpecs = \"core-backend.CodeSpecs\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[CustomViewState3dCreator]]\r\n   */\r\n  CustomViewState3dCreator = \"core-backend.CustomViewState3dCreator\",\r\n\r\n  /** The logger category used by the [[DevTools]] class and related classes.\r\n   * @internal\r\n   */\r\n  DevTools = \"core-backend.DevTools\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[ChangeSummaryManager]]\r\n   * - [[ECDb]]\r\n   * - [[ECSqlStatement]]\r\n   */\r\n  ECDb = \"core-backend.ECDb\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[Functional]]\r\n   */\r\n  Functional = \"core-backend.Functional\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[LinearReferencing]]\r\n   */\r\n  LinearReferencing = \"core-backend.LinearReferencing\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - BriefcaseManager\r\n   * - [[IModelDb]]\r\n   */\r\n  IModelDb = \"core-backend.IModelDb\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[IModelHost]]\r\n   */\r\n  IModelHost = \"core-backend.IModelHost\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - TileRequestMemoizer\r\n   */\r\n  IModelTileRequestRpc = \"core-backend.IModelTileRequestRpc\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - IModelTileRpcImpl (Tile Uploading)\r\n   */\r\n  IModelTileUpload = \"core-backend.IModelTileUpload\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - TileStorage (tile upload/download)\r\n   */\r\n  IModelTileStorage = \"core-backend.IModelTileStorage\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[Relationship]]\r\n   */\r\n  Relationship = \"core-backend.Relationship\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[Schemas]]\r\n   */\r\n  Schemas = \"core-backend.Schemas\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[PromiseMemoizer]]\r\n   */\r\n  PromiseMemoizer = \"core-backend.PromiseMemoizer\",\r\n  /** The logger category used by the following classes:\r\n   * - [[EventSink]]\r\n   */\r\n  EventSink = \"core-backend.EventSink\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[NativeHost]], [[NativeAppStorage]]\r\n   * @internal\r\n   */\r\n  NativeApp = \"core-backend.NativeApp\",\r\n\r\n  /** The logger category used by the following classes:\r\n   * - [[ViewStateHydrator]]\r\n   * @internal\r\n   */\r\n  ViewStateHydrator = \"core-backend.ViewStateHydrator\",\r\n\r\n  /** @internal */\r\n  Workspace = \"core-backend.Workspace\",\r\n}\r\n"]}

package/lib/esm/BisCoreSchema.d.ts

@@ -0,0 +1,22 @@
+/** @packageDocumentation
+ * @module Schema
+ */
+import { Schema } from "./Schema";
+/**
+ * The [BisCore]($docs/bis/guide/fundamentals/schemas-domains.md) schema is the lowest level Schema in an iModel.
+ *
+ * It is automatically registered when [[IModelHost.startup]] is called.
+ *
+ * Example:
+ * ``` ts
+ * [[include:BisCore.registerSchemaAndGetClass]]
+ * ```
+ * @public
+ */
+export declare class BisCoreSchema extends Schema {
+    static get schemaName(): string;
+    static get schemaFilePath(): string;
+    /** @internal */
+    static registerSchema(): void;
+}
+//# sourceMappingURL=BisCoreSchema.d.ts.map

package/lib/esm/BisCoreSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BisCoreSchema.d.ts","sourceRoot":"","sources":["../../src/BisCoreSchema.ts"],"names":[],"mappings":"AAIA;;GAEG;AAYH,OAAO,EAAE,MAAM,EAAW,MAAM,UAAU,CAAC;AAO3C;;;;;;;;;;GAUG;AACH,qBAAa,aAAc,SAAQ,MAAM;IACvC,WAA2B,UAAU,IAAI,MAAM,CAAsB;IACrE,WAAkB,cAAc,IAAI,MAAM,CAAsH;IAEhK,gBAAgB;WACF,cAAc;CAuB7B"}

package/lib/esm/BisCoreSchema.js

@@ -0,0 +1,61 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Schema
+ */
+import * as path from "path";
+import * as categoryMod from "./Category";
+import { ClassRegistry } from "./ClassRegistry";
+import * as elementMod from "./Element";
+import * as aspectMod from "./ElementAspect";
+import * as externalSourceMod from "./ExternalSource";
+import { KnownLocations } from "./IModelHost";
+import * as materialMod from "./Material";
+import * as modelMod from "./Model";
+import * as linkMod from "./Relationship";
+import { Schema, Schemas } from "./Schema";
+import * as textureMod from "./Texture";
+import * as viewMod from "./ViewDefinition";
+import * as displayStyleMod from "./DisplayStyle";
+import * as annotationsMod from "./TextAnnotationElement";
+import * as sheetIndex from "./SheetIndex";
+/**
+ * The [BisCore]($docs/bis/guide/fundamentals/schemas-domains.md) schema is the lowest level Schema in an iModel.
+ *
+ * It is automatically registered when [[IModelHost.startup]] is called.
+ *
+ * Example:
+ * ``` ts
+ * [[include:BisCore.registerSchemaAndGetClass]]
+ * ```
+ * @public
+ */
+export class BisCoreSchema extends Schema {
+    static get schemaName() { return "BisCore"; }
+    static get schemaFilePath() { return path.join(KnownLocations.nativeAssetsDir, "ECSchemas", "Dgn", `${BisCoreSchema.schemaName}.ecschema.xml`); }
+    /** @internal */
+    static registerSchema() {
+        if (this === Schemas.getRegisteredSchema(this.schemaName))
+            return;
+        Schemas.unregisterSchema(this.schemaName);
+        Schemas.registerSchema(this);
+        // this list should include all backend .ts files with implementations of Entity-based classes. Order does not matter.
+        [
+            elementMod,
+            aspectMod,
+            modelMod,
+            categoryMod,
+            viewMod,
+            linkMod,
+            textureMod,
+            materialMod,
+            externalSourceMod,
+            displayStyleMod,
+            annotationsMod,
+            sheetIndex
+        ].forEach((module) => ClassRegistry.registerModule(module, this));
+    }
+}
+//# sourceMappingURL=BisCoreSchema.js.map

package/lib/esm/BisCoreSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BisCoreSchema.js","sourceRoot":"","sources":["../../src/BisCoreSchema.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,UAAU,MAAM,WAAW,CAAC;AACxC,OAAO,KAAK,SAAS,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,iBAAiB,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AACpC,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,KAAK,UAAU,MAAM,WAAW,CAAC;AACxC,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC;AAC5C,OAAO,KAAK,eAAe,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,cAAc,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAE3C;;;;;;;;;;GAUG;AACH,MAAM,OAAO,aAAc,SAAQ,MAAM;IAChC,MAAM,KAAc,UAAU,KAAa,OAAO,SAAS,CAAC,CAAC,CAAC;IAC9D,MAAM,KAAK,cAAc,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,eAAe,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,aAAa,CAAC,UAAU,eAAe,CAAC,CAAC,CAAC,CAAC;IAEhK,gBAAgB;IACT,MAAM,CAAC,cAAc;QAC1B,IAAI,IAAI,KAAK,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC;YACvD,OAAO;QAET,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC1C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAE7B,sHAAsH;QACtH;YACE,UAAU;YACV,SAAS;YACT,QAAQ;YACR,WAAW;YACX,OAAO;YACP,OAAO;YACP,UAAU;YACV,WAAW;YACX,iBAAiB;YACjB,eAAe;YACf,cAAc;YACd,UAAU;SACX,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,aAAa,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IACpE,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Schema\r\n */\r\n\r\nimport * as path from \"path\";\r\nimport * as categoryMod from \"./Category\";\r\nimport { ClassRegistry } from \"./ClassRegistry\";\r\nimport * as elementMod from \"./Element\";\r\nimport * as aspectMod from \"./ElementAspect\";\r\nimport * as externalSourceMod from \"./ExternalSource\";\r\nimport { KnownLocations } from \"./IModelHost\";\r\nimport * as materialMod from \"./Material\";\r\nimport * as modelMod from \"./Model\";\r\nimport * as linkMod from \"./Relationship\";\r\nimport { Schema, Schemas } from \"./Schema\";\r\nimport * as textureMod from \"./Texture\";\r\nimport * as viewMod from \"./ViewDefinition\";\r\nimport * as displayStyleMod from \"./DisplayStyle\";\r\nimport * as annotationsMod from \"./TextAnnotationElement\";\r\nimport * as sheetIndex from \"./SheetIndex\";\r\n\r\n/**\r\n * The [BisCore]($docs/bis/guide/fundamentals/schemas-domains.md) schema is the lowest level Schema in an iModel.\r\n *\r\n * It is automatically registered when [[IModelHost.startup]] is called.\r\n *\r\n * Example:\r\n * ``` ts\r\n * [[include:BisCore.registerSchemaAndGetClass]]\r\n * ```\r\n * @public\r\n */\r\nexport class BisCoreSchema extends Schema {\r\n  public static override get schemaName(): string { return \"BisCore\"; }\r\n  public static get schemaFilePath(): string { return path.join(KnownLocations.nativeAssetsDir, \"ECSchemas\", \"Dgn\", `${BisCoreSchema.schemaName}.ecschema.xml`); }\r\n\r\n  /** @internal */\r\n  public static registerSchema() {\r\n    if (this === Schemas.getRegisteredSchema(this.schemaName))\r\n      return;\r\n\r\n    Schemas.unregisterSchema(this.schemaName);\r\n    Schemas.registerSchema(this);\r\n\r\n    // this list should include all backend .ts files with implementations of Entity-based classes. Order does not matter.\r\n    [\r\n      elementMod,\r\n      aspectMod,\r\n      modelMod,\r\n      categoryMod,\r\n      viewMod,\r\n      linkMod,\r\n      textureMod,\r\n      materialMod,\r\n      externalSourceMod,\r\n      displayStyleMod,\r\n      annotationsMod,\r\n      sheetIndex\r\n    ].forEach((module) => ClassRegistry.registerModule(module, this));\r\n  }\r\n}\r\n"]}

package/lib/esm/BlobContainerService.d.ts

@@ -0,0 +1,159 @@
+/** @packageDocumentation
+ * @module BlobContainers
+ */
+import { AccessToken, GuidString, Id64String } from "@itwin/core-bentley";
+import { SettingsContainer } from "./workspace/Settings";
+/**
+ * Types and functions for creating, deleting and authorizing access to cloud-based blob containers for an iTwin.
+ * @beta
+ */
+export declare namespace BlobContainer {
+    /** Object that implements the methods to create, delete, and request access to a container. */
+    let service: BlobContainer.ContainerService | undefined;
+    /** name of cloud provider for a container. */
+    type Provider = "azure" | "google";
+    /** the name of the container within its `Scope` */
+    type ContainerId = string;
+    /** token that authenticates a user. This token is required to obtain a `ContainerToken`. */
+    type UserToken = AccessToken;
+    /** token that authenticates access to a container for either read or write. */
+    type ContainerToken = AccessToken;
+    /**
+     * The scope for a container. This determines:
+     *  - the "owner" organization, including the contract that governs its legal and commercial terms and obligations
+     *  - the administrators who may configure RBAC permissions
+     *  - the datacenter for the container. Every container resides in a datacenter as determined by the iTwinId. This
+     * determines the region for data residency requirements.
+     *  - the lifecycle constraints for the container. No container can outlive its iTwin or its iModel (if defined). That is,
+     * when the iTwin/iModel is deleted (either explicitly or due to contract expiration), the container is also deleted.
+     */
+    interface Scope {
+        /** iTwinId of the owner of this container. */
+        iTwinId: Id64String;
+        /** optionally, an iModelId within the iTwin. If present, container is deleted when the iModel is deleted. */
+        iModelId?: Id64String;
+        /** the user GUID an individual, if this container is private. */
+        ownerGuid?: GuidString;
+    }
+    /**
+     * Metadata about the use of a container so that:
+     *  - administrators can understand why a container exists for assigning RBAC permissions appropriately
+     *  - usage reports can aggregate types of containers
+     *  - applications can identify their containers
+     *  - applications can store properties about their containers
+     */
+    interface Metadata {
+        /** The machine-readable string that describes what the container is being used for (e.g. "workspace"). Always lowercase and singular. */
+        containerType: string;
+        /** Human-readable name for the container. This will be displayed in the administrator RBAC panel, and on usage reports. Not required to be unique.*/
+        label: string;
+        /** Optional human-readable explanation of the information held in the container. This will be displayed in the administrator RBAC panel, and on usage reports. */
+        description?: string;
+        /** optional properties for the container */
+        json?: SettingsContainer;
+    }
+    /**
+     * Properties returned by queryContainersMetadata
+     */
+    interface MetadataResponse extends Metadata {
+        containerId: string;
+    }
+    /** Properties returned by `Service.requestToken` */
+    interface TokenProps {
+        /**
+         * Expiring token that provides the requested access to the container. Should be used in all subsequent requests for blobs within the container,
+         * and must be refreshed before it expires
+         */
+        token: ContainerToken;
+        /** Scope of the container. */
+        scope: Scope;
+        /** Name of the blob storage provider. */
+        provider: Provider;
+        /** Time at which the token will expire. The token should be refreshed (that is, a new token should be requested) before this time. */
+        expiration: Date;
+        /** Metadata of the container. */
+        metadata: Metadata;
+        /** Base URI of the storage account that hosts the container */
+        baseUri: string;
+    }
+    /** The URI and Id of the container. */
+    interface UriAndId {
+        baseUri: string;
+        containerId: ContainerId;
+    }
+    /** Information required to access an existing container. */
+    interface AccessContainerProps extends UriAndId {
+        userToken: UserToken;
+    }
+    /** Information about a newly created container. */
+    interface CreatedContainerProps extends UriAndId {
+        /** name of the blob storage provider. */
+        provider: Provider;
+    }
+    /**
+     * Access level to request for token.
+     * - `"write"`: request a writeable AccessToken.
+     * - `"read"`:  request a read-only AccessToken.
+     * - `"admin"`:  request a admin AccessToken.
+     * - `"writeIfPossible"`: first request a writeable AccessToken. If the user is not authorized for write, request a read-only AccessToken.
+     * If the user is not authorized for the level requested, an exception is thrown.
+     */
+    type RequestAccessLevel = "write" | "read" | "admin" | "writeIfPossible";
+    /** Information required to request an access token for a container. */
+    interface RequestTokenProps extends Omit<AccessContainerProps, "baseUri"> {
+        /** the level of access requested. If not specified, defaults to `"writeIfPossible"`. */
+        accessLevel?: RequestAccessLevel;
+        /** the number of seconds before the token should expire.
+         * @note A maximum duration is determined by the service. If no value is supplied, or the value is larger than the maximum, the maximum duration is used.
+         */
+        durationSeconds?: number;
+    }
+    /** Information required to create a new container. */
+    interface CreateNewContainerProps {
+        /** the scope of the new container */
+        scope: Scope;
+        /** metadata to be stored on the new container */
+        metadata: Metadata;
+        /** The user's access token. The user must be authorized with "create container" RBAC role for the iTwin. */
+        userToken: UserToken;
+        /**
+         * the id for the container. Useful for tests.
+         * @internal
+         */
+        containerId?: ContainerId;
+    }
+    /**
+     * Query Parameters for querying containers
+     */
+    interface QueryContainerProps {
+        /** the iTwinId of the containers to query */
+        iTwinId: GuidString;
+        /** optional iModelId of the containers to query */
+        iModelId?: GuidString;
+        /** optional containerType of the containers to query */
+        containerType?: GuidString;
+        /** optional label of the containers to query */
+        label?: GuidString;
+    }
+    /** Methods to create, delete, and access blob containers. */
+    interface ContainerService {
+        /**  Create a new blob container. Throws on failure (e.g. access denied or container already exists.) */
+        create(props: CreateNewContainerProps): Promise<CreatedContainerProps>;
+        /**
+         * Delete an existing blob container.
+         * @note This method requires that the user be authorized with "delete container" RBAC role for the iTwin.
+         */
+        delete(container: AccessContainerProps): Promise<void>;
+        /** query the Scope for a container */
+        queryScope(container: AccessContainerProps): Promise<Scope>;
+        /** query the Metadata for a specific container */
+        queryMetadata(container: AccessContainerProps): Promise<Metadata>;
+        /** Returns all containers and their metadata associated with a given iTwinId. Can be further queried by label and containerType. */
+        queryContainersMetadata(userToken: UserToken, args: QueryContainerProps): Promise<MetadataResponse[]>;
+        /** update the json properties of this container */
+        updateJson(container: AccessContainerProps, json: SettingsContainer): Promise<void>;
+        /** Request a `ContainerToken` for a container. Throws on failure. */
+        requestToken(props: RequestTokenProps): Promise<TokenProps>;
+    }
+}
+//# sourceMappingURL=BlobContainerService.d.ts.map

package/lib/esm/BlobContainerService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BlobContainerService.d.ts","sourceRoot":"","sources":["../../src/BlobContainerService.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAEzD;;;GAGG;AACH,yBAAiB,aAAa,CAAC;IAE7B,+FAA+F;IACxF,IAAI,OAAO,EAAE,aAAa,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAE/D,8CAA8C;IAC9C,KAAY,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;IAE1C,mDAAmD;IACnD,KAAY,WAAW,GAAG,MAAM,CAAC;IAEjC,4FAA4F;IAC5F,KAAY,SAAS,GAAG,WAAW,CAAC;IAEpC,+EAA+E;IAC/E,KAAY,cAAc,GAAG,WAAW,CAAC;IAEzC;;;;;;;;OAQG;IACH,UAAiB,KAAK;QACpB,8CAA8C;QAC9C,OAAO,EAAE,UAAU,CAAC;QACpB,6GAA6G;QAC7G,QAAQ,CAAC,EAAE,UAAU,CAAC;QACtB,iEAAiE;QACjE,SAAS,CAAC,EAAE,UAAU,CAAC;KACxB;IAED;;;;;;OAMG;IACH,UAAiB,QAAQ;QACvB,yIAAyI;QACzI,aAAa,EAAE,MAAM,CAAC;QACtB,qJAAqJ;QACrJ,KAAK,EAAE,MAAM,CAAC;QACd,kKAAkK;QAClK,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,4CAA4C;QAC5C,IAAI,CAAC,EAAE,iBAAiB,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,gBAAiB,SAAQ,QAAQ;QAChD,WAAW,EAAE,MAAM,CAAC;KACrB;IAED,oDAAoD;IACpD,UAAiB,UAAU;QACzB;;;WAGG;QACH,KAAK,EAAE,cAAc,CAAC;QACtB,8BAA8B;QAC9B,KAAK,EAAE,KAAK,CAAC;QACb,yCAAyC;QACzC,QAAQ,EAAE,QAAQ,CAAC;QACnB,sIAAsI;QACtI,UAAU,EAAE,IAAI,CAAC;QACjB,iCAAiC;QACjC,QAAQ,EAAE,QAAQ,CAAC;QACnB,+DAA+D;QAC/D,OAAO,EAAE,MAAM,CAAC;KACjB;IAED,uCAAuC;IACvC,UAAiB,QAAQ;QACvB,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,EAAE,WAAW,CAAC;KAC1B;IAED,4DAA4D;IAC5D,UAAiB,oBAAqB,SAAQ,QAAQ;QACpD,SAAS,EAAE,SAAS,CAAC;KACtB;IAED,mDAAmD;IACnD,UAAiB,qBAAsB,SAAQ,QAAQ;QACrD,yCAAyC;QACzC,QAAQ,EAAE,QAAQ,CAAC;KACpB;IAED;;;;;;;OAOG;IACH,KAAY,kBAAkB,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,iBAAiB,CAAC;IAEhF,uEAAuE;IACvE,UAAiB,iBAAkB,SAAQ,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC;QAC9E,wFAAwF;QACxF,WAAW,CAAC,EAAE,kBAAkB,CAAC;QACjC;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAED,sDAAsD;IACtD,UAAiB,uBAAuB;QACtC,qCAAqC;QACrC,KAAK,EAAE,KAAK,CAAC;QACb,iDAAiD;QACjD,QAAQ,EAAE,QAAQ,CAAC;QACnB,4GAA4G;QAC5G,SAAS,EAAE,SAAS,CAAC;QACrB;;;WAGG;QACH,WAAW,CAAC,EAAE,WAAW,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,mBAAmB;QAClC,6CAA6C;QAC7C,OAAO,EAAE,UAAU,CAAC;QACpB,mDAAmD;QACnD,QAAQ,CAAC,EAAE,UAAU,CAAC;QACtB,wDAAwD;QACxD,aAAa,CAAC,EAAE,UAAU,CAAC;QAC3B,gDAAgD;QAChD,KAAK,CAAC,EAAE,UAAU,CAAC;KACpB;IAED,6DAA6D;IAC7D,UAAiB,gBAAgB;QAC/B,wGAAwG;QACxG,MAAM,CAAC,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;QAEvE;;;WAGG;QACH,MAAM,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAEvD,sCAAsC;QACtC,UAAU,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QAE5D,kDAAkD;QAClD,aAAa,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;QAElE,oIAAoI;QACpI,uBAAuB,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;QAEtG,mDAAmD;QACnD,UAAU,CAAC,SAAS,EAAE,oBAAoB,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAEpF,qEAAqE;QACrE,YAAY,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;KAC7D;CACF"}

package/lib/esm/BlobContainerService.js

@@ -0,0 +1,15 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module BlobContainers
+ */
+/**
+ * Types and functions for creating, deleting and authorizing access to cloud-based blob containers for an iTwin.
+ * @beta
+ */
+export var BlobContainer;
+(function (BlobContainer) {
+})(BlobContainer || (BlobContainer = {}));
+//# sourceMappingURL=BlobContainerService.js.map

package/lib/esm/BlobContainerService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BlobContainerService.js","sourceRoot":"","sources":["../../src/BlobContainerService.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAOH;;;GAGG;AACH,MAAM,KAAW,aAAa,CA2K7B;AA3KD,WAAiB,aAAa;AA2K9B,CAAC,EA3KgB,aAAa,KAAb,aAAa,QA2K7B","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module BlobContainers\r\n */\r\n\r\n// spell:ignore datacenter\r\n\r\nimport { AccessToken, GuidString, Id64String } from \"@itwin/core-bentley\";\r\nimport { SettingsContainer } from \"./workspace/Settings\";\r\n\r\n/**\r\n * Types and functions for creating, deleting and authorizing access to cloud-based blob containers for an iTwin.\r\n * @beta\r\n */\r\nexport namespace BlobContainer {\r\n\r\n  /** Object that implements the methods to create, delete, and request access to a container. */\r\n  export let service: BlobContainer.ContainerService | undefined;\r\n\r\n  /** name of cloud provider for a container. */\r\n  export type Provider = \"azure\" | \"google\";\r\n\r\n  /** the name of the container within its `Scope` */\r\n  export type ContainerId = string;\r\n\r\n  /** token that authenticates a user. This token is required to obtain a `ContainerToken`. */\r\n  export type UserToken = AccessToken;\r\n\r\n  /** token that authenticates access to a container for either read or write. */\r\n  export type ContainerToken = AccessToken;\r\n\r\n  /**\r\n   * The scope for a container. This determines:\r\n   *  - the \"owner\" organization, including the contract that governs its legal and commercial terms and obligations\r\n   *  - the administrators who may configure RBAC permissions\r\n   *  - the datacenter for the container. Every container resides in a datacenter as determined by the iTwinId. This\r\n   * determines the region for data residency requirements.\r\n   *  - the lifecycle constraints for the container. No container can outlive its iTwin or its iModel (if defined). That is,\r\n   * when the iTwin/iModel is deleted (either explicitly or due to contract expiration), the container is also deleted.\r\n   */\r\n  export interface Scope {\r\n    /** iTwinId of the owner of this container. */\r\n    iTwinId: Id64String;\r\n    /** optionally, an iModelId within the iTwin. If present, container is deleted when the iModel is deleted. */\r\n    iModelId?: Id64String;\r\n    /** the user GUID an individual, if this container is private. */\r\n    ownerGuid?: GuidString;\r\n  }\r\n\r\n  /**\r\n   * Metadata about the use of a container so that:\r\n   *  - administrators can understand why a container exists for assigning RBAC permissions appropriately\r\n   *  - usage reports can aggregate types of containers\r\n   *  - applications can identify their containers\r\n   *  - applications can store properties about their containers\r\n   */\r\n  export interface Metadata {\r\n    /** The machine-readable string that describes what the container is being used for (e.g. \"workspace\"). Always lowercase and singular. */\r\n    containerType: string;\r\n    /** Human-readable name for the container. This will be displayed in the administrator RBAC panel, and on usage reports. Not required to be unique.*/\r\n    label: string;\r\n    /** Optional human-readable explanation of the information held in the container. This will be displayed in the administrator RBAC panel, and on usage reports. */\r\n    description?: string;\r\n    /** optional properties for the container */\r\n    json?: SettingsContainer;\r\n  }\r\n\r\n  /**\r\n   * Properties returned by queryContainersMetadata\r\n   */\r\n  export interface MetadataResponse extends Metadata {\r\n    containerId: string;\r\n  }\r\n\r\n  /** Properties returned by `Service.requestToken` */\r\n  export interface TokenProps {\r\n    /**\r\n     * Expiring token that provides the requested access to the container. Should be used in all subsequent requests for blobs within the container,\r\n     * and must be refreshed before it expires\r\n     */\r\n    token: ContainerToken;\r\n    /** Scope of the container. */\r\n    scope: Scope;\r\n    /** Name of the blob storage provider. */\r\n    provider: Provider;\r\n    /** Time at which the token will expire. The token should be refreshed (that is, a new token should be requested) before this time. */\r\n    expiration: Date;\r\n    /** Metadata of the container. */\r\n    metadata: Metadata;\r\n    /** Base URI of the storage account that hosts the container */\r\n    baseUri: string;\r\n  }\r\n\r\n  /** The URI and Id of the container. */\r\n  export interface UriAndId {\r\n    baseUri: string;\r\n    containerId: ContainerId;\r\n  }\r\n\r\n  /** Information required to access an existing container. */\r\n  export interface AccessContainerProps extends UriAndId {\r\n    userToken: UserToken;\r\n  }\r\n\r\n  /** Information about a newly created container. */\r\n  export interface CreatedContainerProps extends UriAndId {\r\n    /** name of the blob storage provider. */\r\n    provider: Provider;\r\n  }\r\n\r\n  /**\r\n   * Access level to request for token.\r\n   * - `\"write\"`: request a writeable AccessToken.\r\n   * - `\"read\"`:  request a read-only AccessToken.\r\n   * - `\"admin\"`:  request a admin AccessToken.\r\n   * - `\"writeIfPossible\"`: first request a writeable AccessToken. If the user is not authorized for write, request a read-only AccessToken.\r\n   * If the user is not authorized for the level requested, an exception is thrown.\r\n   */\r\n  export type RequestAccessLevel = \"write\" | \"read\" | \"admin\" | \"writeIfPossible\";\r\n\r\n  /** Information required to request an access token for a container. */\r\n  export interface RequestTokenProps extends Omit<AccessContainerProps, \"baseUri\"> {\r\n    /** the level of access requested. If not specified, defaults to `\"writeIfPossible\"`. */\r\n    accessLevel?: RequestAccessLevel;\r\n    /** the number of seconds before the token should expire.\r\n     * @note A maximum duration is determined by the service. If no value is supplied, or the value is larger than the maximum, the maximum duration is used.\r\n     */\r\n    durationSeconds?: number;\r\n  }\r\n\r\n  /** Information required to create a new container. */\r\n  export interface CreateNewContainerProps {\r\n    /** the scope of the new container */\r\n    scope: Scope;\r\n    /** metadata to be stored on the new container */\r\n    metadata: Metadata;\r\n    /** The user's access token. The user must be authorized with \"create container\" RBAC role for the iTwin. */\r\n    userToken: UserToken;\r\n    /**\r\n     * the id for the container. Useful for tests.\r\n     * @internal\r\n     */\r\n    containerId?: ContainerId;\r\n  }\r\n\r\n  /**\r\n   * Query Parameters for querying containers\r\n   */\r\n  export interface QueryContainerProps {\r\n    /** the iTwinId of the containers to query */\r\n    iTwinId: GuidString;\r\n    /** optional iModelId of the containers to query */\r\n    iModelId?: GuidString;\r\n    /** optional containerType of the containers to query */\r\n    containerType?: GuidString;\r\n    /** optional label of the containers to query */\r\n    label?: GuidString;\r\n  }\r\n\r\n  /** Methods to create, delete, and access blob containers. */\r\n  export interface ContainerService {\r\n    /**  Create a new blob container. Throws on failure (e.g. access denied or container already exists.) */\r\n    create(props: CreateNewContainerProps): Promise<CreatedContainerProps>;\r\n\r\n    /**\r\n     * Delete an existing blob container.\r\n     * @note This method requires that the user be authorized with \"delete container\" RBAC role for the iTwin.\r\n     */\r\n    delete(container: AccessContainerProps): Promise<void>;\r\n\r\n    /** query the Scope for a container */\r\n    queryScope(container: AccessContainerProps): Promise<Scope>;\r\n\r\n    /** query the Metadata for a specific container */\r\n    queryMetadata(container: AccessContainerProps): Promise<Metadata>;\r\n\r\n    /** Returns all containers and their metadata associated with a given iTwinId. Can be further queried by label and containerType. */\r\n    queryContainersMetadata(userToken: UserToken, args: QueryContainerProps): Promise<MetadataResponse[]>;\r\n\r\n    /** update the json properties of this container */\r\n    updateJson(container: AccessContainerProps, json: SettingsContainer): Promise<void>;\r\n\r\n    /** Request a `ContainerToken` for a container. Throws on failure. */\r\n    requestToken(props: RequestTokenProps): Promise<TokenProps>;\r\n  }\r\n}\r\n"]}