@itwin/core-backend/lib/cjs/workspace/SettingsEditor.js

iTwin.js backend components

"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 Workspace
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.SettingsContainers = exports.SettingsEditor = exports.settingsResourceName = void 0;
const core_common_1 = require("@itwin/core-common");
const BlobContainerService_1 = require("../BlobContainerService");
const IModelHost_1 = require("../IModelHost");
const SettingsEditorImpl_1 = require("../internal/workspace/SettingsEditorImpl");
const Settings_1 = require("./Settings");
const SettingsDb_1 = require("./SettingsDb");
/** The default resource name used to store settings in a [[WorkspaceDb]].
 * This is the key under which all settings are stored in the SQLite `strings` table.
 * When loading settings at runtime via [[Workspace.loadSettingsDictionary]], the `resourceName` defaults
 * to this value, ensuring the read and write paths always agree on which key to use.
 * @internal
 */
exports.settingsResourceName = "settingsDictionary";
/** @internal */
var SettingsEditor;
(function (SettingsEditor) {
    /** The type of workspace container used to store settings. */
    SettingsEditor.containerType = "settings";
    /**
     * Create a new [[SettingsEditor]] for creating new versions of [[SettingsDb]]s.
     * @note The caller becomes the owner of the SettingsEditor and is responsible for calling [[SettingsEditor.close]] on it when finished.
     * @note It is illegal to have more than one SettingsEditor active in a single session.
     */
    async function constructForITwin(iTwinId) {
        return (0, SettingsEditorImpl_1.constructSettingsEditorForITwin)(iTwinId);
    }
    SettingsEditor.constructForITwin = constructForITwin;
    /**
     * Obtain a [[SettingsEditor]] for the existing settings container associated with an iTwin.
     * @returns The editor and container, or `undefined` if no settings container exists for the iTwin.
     * @note The caller becomes the owner of the SettingsEditor and is responsible for calling [[SettingsEditor.close]] on it when finished.
     * @note It is illegal to have more than one SettingsEditor active in a single session.
     */
    async function getForITwin(iTwinId) {
        return (0, SettingsEditorImpl_1.getSettingsEditorForITwin)(iTwinId);
    }
    SettingsEditor.getForITwin = getForITwin;
})(SettingsEditor || (exports.SettingsEditor = SettingsEditor = {}));
/**
 * Help locate and obtain access to known containers with type "settings".
 * @internal
 */
var SettingsContainers;
(function (SettingsContainers) {
    /**
     * Query the [[BlobContainer]] service for all settings containers associated with a given iTwin.
     * Automatically filters by `containerType: "settings"`.
     * @note Requires [[IModelHost.authorizationClient]] to be configured.
     */
    async function queryContainers(args) {
        if (undefined === BlobContainerService_1.BlobContainer.service)
            core_common_1.ITwinSettingsError.throwError("blob-service-unavailable", { message: "BlobContainer.service is not available." });
        const userToken = await IModelHost_1.IModelHost.getAccessToken();
        return BlobContainerService_1.BlobContainer.service.queryContainersMetadata(userToken, { ...args, containerType: SettingsEditor.containerType });
    }
    /**
     * Query the [[BlobContainer]] service for the single settings container associated with a given iTwin.
     * @returns The containerId, or `undefined` if no container exists.
     * @throws if more than one settings container is found.
     */
    async function getITwinContainerId(iTwinId) {
        const containers = await queryContainers({ iTwinId });
        if (containers.length > 1) {
            core_common_1.ITwinSettingsError.throwError("multiple-itwin-settings-containers", {
                message: `Multiple iTwin settings containers were found for '${iTwinId}', so a container cannot be automatically selected.`,
                iTwinId,
            });
        }
        return containers[0]?.containerId;
    }
    SettingsContainers.getITwinContainerId = getITwinContainerId;
    /**
     * Look up settings containers for an iTwin and its account iTwin and obtain read-only access tokens.
     * @returns Container props needed by [[IModelHost.getITwinWorkspace]]. The requested iTwin's settings
     * container is returned at [[SettingsPriority.iTwin]]; the account iTwin container is returned at
     * [[SettingsPriority.organization]].
     * @note Requires [[IModelHost.authorizationClient]] to be configured.
     * @note Requires [[BlobContainer.service]] to be configured.
     */
    async function getITwinSettingsSources(iTwinId) {
        if (undefined === BlobContainerService_1.BlobContainer.service)
            core_common_1.ITwinSettingsError.throwError("blob-service-unavailable", { message: "BlobContainer.service is not available." });
        const userToken = await IModelHost_1.IModelHost.getAccessToken();
        const containers = await queryContainers({ iTwinId, includeParentITwins: { filter: "accountOnly" } });
        if (containers.length === 0)
            return undefined;
        const seenITwins = new Set();
        const results = [];
        for (const container of containers) {
            const ownerITwinId = container.iTwinId;
            if (undefined === ownerITwinId) {
                core_common_1.ITwinSettingsError.throwError("missing-container-itwinid", {
                    message: `Settings container '${container.containerId}' has no iTwinId. Please upgrade to a newer version of the BlobContainer service that populates iTwinId in query results.`,
                    iTwinId,
                });
            }
            if (seenITwins.has(ownerITwinId)) {
                core_common_1.ITwinSettingsError.throwError("multiple-itwin-settings-containers", {
                    message: `Multiple iTwin settings containers were found for '${ownerITwinId}', so a container cannot be automatically selected.`,
                    iTwinId: ownerITwinId,
                });
            }
            seenITwins.add(ownerITwinId);
            const priority = container.accountITwinId === ownerITwinId ? Settings_1.SettingsPriority.organization : Settings_1.SettingsPriority.iTwin;
            const tokenProps = await BlobContainerService_1.BlobContainer.service.requestToken({ containerId: container.containerId, accessLevel: "read", userToken });
            results.push({
                baseUri: tokenProps.baseUri,
                containerId: container.containerId,
                storageType: tokenProps.provider,
                accessToken: tokenProps.token,
                priority,
                dbName: SettingsDb_1.settingsWorkspaceDbName,
                includePrerelease: true,
            });
        }
        return results;
    }
    SettingsContainers.getITwinSettingsSources = getITwinSettingsSources;
})(SettingsContainers || (exports.SettingsContainers = SettingsContainers = {}));
//# sourceMappingURL=SettingsEditor.js.map