@itwin/core-backend 4.0.0-dev.10 → 4.0.0-dev.101

package/lib/cjs/BisCoreSchema.js

@@ -1,61 +1,61 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BisCoreSchema = void 0;
-const path = require("path");
-const categoryMod = require("./Category");
-const ClassRegistry_1 = require("./ClassRegistry");
-const elementMod = require("./Element");
-const aspectMod = require("./ElementAspect");
-const externalSourceMod = require("./ExternalSource");
-const IModelHost_1 = require("./IModelHost");
-const materialMod = require("./Material");
-const modelMod = require("./Model");
-const linkMod = require("./Relationship");
-const Schema_1 = require("./Schema");
-const textureMod = require("./Texture");
-const viewMod = require("./ViewDefinition");
-const displayStyleMod = require("./DisplayStyle");
-/**
- * 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
- */
-class BisCoreSchema extends Schema_1.Schema {
-    static get schemaName() { return "BisCore"; }
-    static get schemaFilePath() { return path.join(IModelHost_1.KnownLocations.nativeAssetsDir, "ECSchemas", "Dgn", `${BisCoreSchema.schemaName}.ecschema.xml`); }
-    /** @internal */
-    static registerSchema() {
-        if (this === Schema_1.Schemas.getRegisteredSchema(this.schemaName))
-            return;
-        Schema_1.Schemas.unregisterSchema(this.schemaName);
-        Schema_1.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,
-        ].forEach((module) => ClassRegistry_1.ClassRegistry.registerModule(module, this));
-    }
-}
-exports.BisCoreSchema = BisCoreSchema;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BisCoreSchema = void 0;
+const path = require("path");
+const categoryMod = require("./Category");
+const ClassRegistry_1 = require("./ClassRegistry");
+const elementMod = require("./Element");
+const aspectMod = require("./ElementAspect");
+const externalSourceMod = require("./ExternalSource");
+const IModelHost_1 = require("./IModelHost");
+const materialMod = require("./Material");
+const modelMod = require("./Model");
+const linkMod = require("./Relationship");
+const Schema_1 = require("./Schema");
+const textureMod = require("./Texture");
+const viewMod = require("./ViewDefinition");
+const displayStyleMod = require("./DisplayStyle");
+/**
+ * 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
+ */
+class BisCoreSchema extends Schema_1.Schema {
+    static get schemaName() { return "BisCore"; }
+    static get schemaFilePath() { return path.join(IModelHost_1.KnownLocations.nativeAssetsDir, "ECSchemas", "Dgn", `${BisCoreSchema.schemaName}.ecschema.xml`); }
+    /** @internal */
+    static registerSchema() {
+        if (this === Schema_1.Schemas.getRegisteredSchema(this.schemaName))
+            return;
+        Schema_1.Schemas.unregisterSchema(this.schemaName);
+        Schema_1.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,
+        ].forEach((module) => ClassRegistry_1.ClassRegistry.registerModule(module, this));
+    }
+}
+exports.BisCoreSchema = BisCoreSchema;
 //# sourceMappingURL=BisCoreSchema.js.map

package/lib/cjs/BisCoreSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"BisCoreSchema.js","sourceRoot":"","sources":["../../src/BisCoreSchema.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,6BAA6B;AAC7B,0CAA0C;AAC1C,mDAAgD;AAChD,wCAAwC;AACxC,6CAA6C;AAC7C,sDAAsD;AACtD,6CAA8C;AAC9C,0CAA0C;AAC1C,oCAAoC;AACpC,0CAA0C;AAC1C,qCAA2C;AAC3C,wCAAwC;AACxC,4CAA4C;AAC5C,kDAAkD;AAElD;;;;;;;;;;GAUG;AACH,MAAa,aAAc,SAAQ,eAAM;IAChC,MAAM,KAAc,UAAU,KAAa,OAAO,SAAS,CAAC,CAAC,CAAC;IAC9D,MAAM,KAAK,cAAc,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,2BAAc,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,gBAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC;YACvD,OAAO;QAET,gBAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC1C,gBAAO,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;SAChB,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,6BAAa,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IACpE,CAAC;CACF;AA1BD,sCA0BC","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\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    ].forEach((module) => ClassRegistry.registerModule(module, this));\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"BisCoreSchema.js","sourceRoot":"","sources":["../../src/BisCoreSchema.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,6BAA6B;AAC7B,0CAA0C;AAC1C,mDAAgD;AAChD,wCAAwC;AACxC,6CAA6C;AAC7C,sDAAsD;AACtD,6CAA8C;AAC9C,0CAA0C;AAC1C,oCAAoC;AACpC,0CAA0C;AAC1C,qCAA2C;AAC3C,wCAAwC;AACxC,4CAA4C;AAC5C,kDAAkD;AAElD;;;;;;;;;;GAUG;AACH,MAAa,aAAc,SAAQ,eAAM;IAChC,MAAM,KAAc,UAAU,KAAa,OAAO,SAAS,CAAC,CAAC,CAAC;IAC9D,MAAM,KAAK,cAAc,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,2BAAc,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,gBAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC;YACvD,OAAO;QAET,gBAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC1C,gBAAO,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;SAChB,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,6BAAa,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IACpE,CAAC;CACF;AA1BD,sCA0BC","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/** @packageDocumentation\n * @module Schema\n */\n\nimport * as path from \"path\";\nimport * as categoryMod from \"./Category\";\nimport { ClassRegistry } from \"./ClassRegistry\";\nimport * as elementMod from \"./Element\";\nimport * as aspectMod from \"./ElementAspect\";\nimport * as externalSourceMod from \"./ExternalSource\";\nimport { KnownLocations } from \"./IModelHost\";\nimport * as materialMod from \"./Material\";\nimport * as modelMod from \"./Model\";\nimport * as linkMod from \"./Relationship\";\nimport { Schema, Schemas } from \"./Schema\";\nimport * as textureMod from \"./Texture\";\nimport * as viewMod from \"./ViewDefinition\";\nimport * as displayStyleMod from \"./DisplayStyle\";\n\n/**\n * The [BisCore]($docs/bis/guide/fundamentals/schemas-domains.md) schema is the lowest level Schema in an iModel.\n *\n * It is automatically registered when [[IModelHost.startup]] is called.\n *\n * ** Example:**\n * ``` ts\n * [[include:BisCore.registerSchemaAndGetClass]]\n * ```\n * @public\n */\nexport class BisCoreSchema extends Schema {\n  public static override get schemaName(): string { return \"BisCore\"; }\n  public static get schemaFilePath(): string { return path.join(KnownLocations.nativeAssetsDir, \"ECSchemas\", \"Dgn\", `${BisCoreSchema.schemaName}.ecschema.xml`); }\n\n  /** @internal */\n  public static registerSchema() {\n    if (this === Schemas.getRegisteredSchema(this.schemaName))\n      return;\n\n    Schemas.unregisterSchema(this.schemaName);\n    Schemas.registerSchema(this);\n\n    // this list should include all backend .ts files with implementations of Entity-based classes. Order does not matter.\n    [\n      elementMod,\n      aspectMod,\n      modelMod,\n      categoryMod,\n      viewMod,\n      linkMod,\n      textureMod,\n      materialMod,\n      externalSourceMod,\n      displayStyleMod,\n    ].forEach((module) => ClassRegistry.registerModule(module, this));\n  }\n}\n"]}

package/lib/cjs/BlobContainerService.d.ts

@@ -0,0 +1,120 @@
+/** @packageDocumentation
+ * @module BlobContainers
+ */
+import { AccessToken, Id64String } from "@itwin/core-bentley";
+/**
+ * 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" | "aws";
+    /** 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;
+    }
+    /**
+     * 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 important (to them) properties "on" their containers
+     */
+    interface Metadata {
+        /** 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;
+        /** a machine-readable string that describes the "format" of the data in this container (e.g. "CloudSqlite") */
+        format: string;
+        /** an identifier of the application that uses this this container */
+        application: string;
+        /** Additional properties stored on the container */
+        [propertyName: string]: 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;
+    }
+    /** The URI and Id of the container. */
+    interface Address {
+        uri: string;
+        id: ContainerId;
+    }
+    /** Information required to access an existing container. */
+    interface AccessContainerProps {
+        address: Address;
+        userToken: UserToken;
+    }
+    /** Information required to request an access token for a container. */
+    interface RequestTokenProps extends AccessContainerProps {
+        /** If true, token should provide write access.
+         * @note if write access is requested and the user is authorized for read but not write, an exception will be thrown (i.e. a read token is *not* returned).
+         */
+        forWriteAccess?: boolean;
+        /** 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
+         */
+        id?: ContainerId;
+    }
+    /** 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<Address>;
+        /**
+         * Delete an existing blob container.
+         * @note This method requires that the user be authorized with "delete container" RBAC role for the iTwin.
+         */
+        delete(props: AccessContainerProps): Promise<void>;
+        /**
+         * Request a `ContainerToken` for a container. Throws on failure.
+         */
+        requestToken(props: RequestTokenProps): Promise<TokenProps>;
+    }
+}
+//# sourceMappingURL=BlobContainerService.d.ts.map

package/lib/cjs/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,MAAM,qBAAqB,CAAC;AAE9D;;;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,GAAG,KAAK,CAAC;IAElD,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;KACvB;IAED;;;;;;OAMG;IACH,UAAiB,QAAQ;QACvB,yJAAyJ;QACzJ,WAAW,EAAE,MAAM,CAAC;QACpB,+GAA+G;QAC/G,MAAM,EAAE,MAAM,CAAC;QACf,qEAAqE;QACrE,WAAW,EAAE,MAAM,CAAC;QACpB,oDAAoD;QACpD,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;KAChC;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;KACpB;IAED,uCAAuC;IACvC,UAAiB,OAAO;QACtB,GAAG,EAAE,MAAM,CAAC;QACZ,EAAE,EAAE,WAAW,CAAC;KACjB;IAED,4DAA4D;IAC5D,UAAiB,oBAAoB;QACnC,OAAO,EAAE,OAAO,CAAC;QACjB,SAAS,EAAE,SAAS,CAAC;KACtB;IAED,uEAAuE;IACvE,UAAiB,iBAAkB,SAAQ,oBAAoB;QAC7D;;WAEG;QACH,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB;;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,EAAE,CAAC,EAAE,WAAW,CAAC;KAClB;IAED,6DAA6D;IAC7D,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,MAAM,CAAC,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;QAEzD;;;WAGG;QACH,MAAM,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAEnD;;WAEG;QACH,YAAY,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;KAC7D;CACF"}

package/lib/cjs/BlobContainerService.js

@@ -0,0 +1,18 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlobContainer = void 0;
+/**
+ * Types and functions for creating, deleting and authorizing access to cloud-based blob containers for an iTwin.
+ * @beta
+ */
+var BlobContainer;
+(function (BlobContainer) {
+})(BlobContainer = exports.BlobContainer || (exports.BlobContainer = {}));
+//# sourceMappingURL=BlobContainerService.js.map

package/lib/cjs/BlobContainerService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BlobContainerService.js","sourceRoot":"","sources":["../../src/BlobContainerService.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAMH;;;GAGG;AACH,IAAiB,aAAa,CA6H7B;AA7HD,WAAiB,aAAa;AA6H9B,CAAC,EA7HgB,aAAa,GAAb,qBAAa,KAAb,qBAAa,QA6H7B","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/** @packageDocumentation\n * @module BlobContainers\n */\n\n// spell:ignore datacenter\n\nimport { AccessToken, Id64String } from \"@itwin/core-bentley\";\n\n/**\n * Types and functions for creating, deleting and authorizing access to cloud-based blob containers for an iTwin.\n * @beta\n */\nexport namespace BlobContainer {\n\n  /** Object that implements the methods to create, delete, and request access to a container. */\n  export let service: BlobContainer.ContainerService | undefined;\n\n  /** name of cloud provider for a container. */\n  export type Provider = \"azure\" | \"google\" | \"aws\";\n\n  /** the name of the container within its `Scope` */\n  export type ContainerId = string;\n\n  /** token that authenticates a user. This token is required to obtain a `ContainerToken`. */\n  export type UserToken = AccessToken;\n\n  /** token that authenticates access to a container for either read or write. */\n  export type ContainerToken = AccessToken;\n\n  /**\n   * The scope for a container. This determines:\n   *  - the \"owner\" organization, including the contract that governs its legal and commercial terms and obligations\n   *  - the administrators who may configure RBAC permissions\n   *  - the datacenter for the container. Every container resides in a datacenter as determined by the iTwinId. This\n   * determines the region for data residency requirements.\n   *  - the lifecycle constraints for the container. No container can outlive its iTwin or its iModel (if defined). That is,\n   * when the iTwin/iModel is deleted (either explicitly or due to contract expiration), the container is also deleted.\n   */\n  export interface Scope {\n    /** iTwinId of the owner of this container. */\n    iTwinId: Id64String;\n    /** optionally, an iModelId within the iTwin. If present, container is deleted when the iModel is deleted. */\n    iModelId?: Id64String;\n  }\n\n  /**\n   * Metadata about the use of a container so that:\n   *  - administrators can understand why a container exists for assigning RBAC permissions appropriately\n   *  - usage reports can aggregate types of containers\n   *  - applications can identify their containers\n   *  - applications can store important (to them) properties \"on\" their containers\n   */\n  export interface Metadata {\n    /** Human readable explanation of the information held in the container. This will be displayed in the administrator RBAC panel, and on usage reports. */\n    description: string;\n    /** a machine-readable string that describes the \"format\" of the data in this container (e.g. \"CloudSqlite\") */\n    format: string;\n    /** an identifier of the application that uses this this container */\n    application: string;\n    /** Additional properties stored on the container */\n    [propertyName: string]: string;\n  }\n\n  /** Properties returned by `Service.requestToken` */\n  export interface TokenProps {\n    /**\n     * expiring token that provides the requested access to the container. Should be used in all subsequent requests for blobs within the container,\n     * and must be refreshed before it expires\n     */\n    token: ContainerToken;\n    /** scope of the container. */\n    scope: Scope;\n    /** name of the blob storage provider. */\n    provider: Provider;\n    /** Time at which the token will expire. The token should be refreshed (that is, a new token should be requested) before this time. */\n    expiration: Date;\n    /** Metadata of the container. */\n    metadata: Metadata;\n  }\n\n  /** The URI and Id of the container. */\n  export interface Address {\n    uri: string;\n    id: ContainerId;\n  }\n\n  /** Information required to access an existing container. */\n  export interface AccessContainerProps {\n    address: Address;\n    userToken: UserToken;\n  }\n\n  /** Information required to request an access token for a container. */\n  export interface RequestTokenProps extends AccessContainerProps {\n    /** If true, token should provide write access.\n     * @note if write access is requested and the user is authorized for read but not write, an exception will be thrown (i.e. a read token is *not* returned).\n     */\n    forWriteAccess?: boolean;\n    /** the number of seconds before the token should expire.\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.\n     */\n    durationSeconds?: number;\n  }\n\n  /** Information required to create a new container. */\n  export interface CreateNewContainerProps {\n    /** the scope of the new container */\n    scope: Scope;\n    /** metadata to be stored on the new container */\n    metadata: Metadata;\n    /** The user's access token. The user must be authorized with \"create container\" RBAC role for the iTwin. */\n    userToken: UserToken;\n    /**\n     * the id for the container. Useful for tests.\n     * @internal\n     */\n    id?: ContainerId;\n  }\n\n  /** Methods to create, delete, and access blob containers. */\n  export interface ContainerService {\n    /**\n     * Create a new blob container. Throws on failure (e.g. access denied or container already exists.)\n     */\n    create(props: CreateNewContainerProps): Promise<Address>;\n\n    /**\n     * Delete an existing blob container.\n     * @note This method requires that the user be authorized with \"delete container\" RBAC role for the iTwin.\n     */\n    delete(props: AccessContainerProps): Promise<void>;\n\n    /**\n     * Request a `ContainerToken` for a container. Throws on failure.\n     */\n    requestToken(props: RequestTokenProps): Promise<TokenProps>;\n  }\n}\n"]}