npm - @itwin/presentation-backend - Versions diffs - 4.0.0-dev.8 → 4.0.0-dev.80 - Mend

@itwin/presentation-backend 4.0.0-dev.8 → 4.0.0-dev.80

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (59) hide show

package/lib/cjs/presentation-backend/Presentation.d.ts CHANGED Viewed

@@ -1,107 +1,107 @@
-/** @packageDocumentation
- * @module Core
- */
-import { PresentationManager, PresentationManagerProps } from "./PresentationManager";
-/**
- * Base props for initializing the [[Presentation]] library.
- *
- * @public
- */
-export interface PresentationPropsBase extends PresentationManagerProps {
-    /**
-     * Time in milliseconds after which the request will timeout.
-     */
-    requestTimeout?: number;
-    /**
-     * Should schemas preloading be enabled. If true, [[Presentation]] library listens
-     * for `BriefcaseDb.onOpened` event and force pre-loads all ECSchemas.
-     */
-    enableSchemasPreload?: boolean;
-}
-/**
- * Props for initializing the [[Presentation]] library for using multiple [[PresentationManager]]
- * instances, one for each frontend.
- *
- * @public
- */
-export interface MultiManagerPresentationProps extends PresentationPropsBase {
-    /**
-     * Factory method for creating separate managers for each client
-     * @internal
-     */
-    clientManagerFactory?: (clientId: string, props: PresentationManagerProps) => PresentationManager;
-    /**
-     * How much time should an unused client manager be stored in memory
-     * before it's disposed.
-     */
-    unusedClientLifetime?: number;
-}
-/**
- * Props for initializing the [[Presentation]] library with ability to use a single
- * [[PresentationManager]] instance for handling all requests.
- *
- * @public
- */
-export interface SingleManagerPresentationProps extends PresentationPropsBase {
-    /**
-     * Specifies to use single manager for all clients.
-     * @alpha
-     */
-    useSingleManager?: boolean;
-}
-/**
- * Properties that can be used to configure [[Presentation]] API
- * @public
- */
-export declare type PresentationProps = MultiManagerPresentationProps | SingleManagerPresentationProps;
-/**
- * Static class used to statically set up Presentation library for the backend.
- * Basically what it does is:
- * - Register a RPC implementation
- * - Create a singleton [[PresentationManager]] instance
- * - Subscribe for [IModelHost.onBeforeShutdown]($core-backend) event and terminate
- *   the presentation manager when that happens.
- *
- * @public
- */
-export declare class Presentation {
-    private static _initProps;
-    private static _clientsStorage;
-    private static _disposeIpcHandler;
-    private static _shutdownListener;
-    private static _disposeIModelOpenedListener;
-    private static _manager;
-    private static _rpcImpl;
-    private constructor();
-    /** Properties used to initialize the presentation framework */
-    static get initProps(): PresentationProps | undefined;
-    /**
-     * Initializes Presentation library for the backend.
-     *
-     * See [Setting up iTwin.js Presentation library documentation page]($docs/presentation/setup/index.md#backend) for an example.
-     *
-     * **Important:** The method should be called after a call to [IModelHost.startup]($core-backend)
-     *
-     * @param props Optional properties for [[PresentationManager]]
-     */
-    static initialize(props?: PresentationProps): void;
-    /**
-     * Terminates Presentation. Consumers don't need to call this as it's automatically
-     * called on [IModelHost.onBeforeShutdown]($core-backend) event.
-     */
-    static terminate(): void;
-    private static createClientManager;
-    private static disposeClientManager;
-    /**
-     * Get an instance of [[PresentationManager]] for specific client
-     * @param clientId ID of the client requesting presentation data. If no
-     *        ID is provided, the default [[PresentationManager]] is returned.
-     */
-    static getManager(clientId?: string): PresentationManager;
-    /**
-     * Get the time in milliseconds that backend should respond in .
-     */
-    static getRequestTimeout(): number;
-    private static onIModelOpened;
-}
+/** @packageDocumentation
+ * @module Core
+ */
+import { PresentationManager, PresentationManagerProps } from "./PresentationManager";
+/**
+ * Base props for initializing the [[Presentation]] library.
+ *
+ * @public
+ */
+export interface PresentationPropsBase extends PresentationManagerProps {
+    /**
+     * Time in milliseconds after which the request will timeout.
+     */
+    requestTimeout?: number;
+    /**
+     * Should schemas preloading be enabled. If true, [[Presentation]] library listens
+     * for `BriefcaseDb.onOpened` event and force pre-loads all ECSchemas.
+     */
+    enableSchemasPreload?: boolean;
+}
+/**
+ * Props for initializing the [[Presentation]] library for using multiple [[PresentationManager]]
+ * instances, one for each frontend.
+ *
+ * @public
+ */
+export interface MultiManagerPresentationProps extends PresentationPropsBase {
+    /**
+     * Factory method for creating separate managers for each client
+     * @internal
+     */
+    clientManagerFactory?: (clientId: string, props: PresentationManagerProps) => PresentationManager;
+    /**
+     * How much time should an unused client manager be stored in memory
+     * before it's disposed.
+     */
+    unusedClientLifetime?: number;
+}
+/**
+ * Props for initializing the [[Presentation]] library with ability to use a single
+ * [[PresentationManager]] instance for handling all requests.
+ *
+ * @public
+ */
+export interface SingleManagerPresentationProps extends PresentationPropsBase {
+    /**
+     * Specifies to use single manager for all clients.
+     * @alpha
+     */
+    useSingleManager?: boolean;
+}
+/**
+ * Properties that can be used to configure [[Presentation]] API
+ * @public
+ */
+export type PresentationProps = MultiManagerPresentationProps | SingleManagerPresentationProps;
+/**
+ * Static class used to statically set up Presentation library for the backend.
+ * Basically what it does is:
+ * - Register a RPC implementation
+ * - Create a singleton [[PresentationManager]] instance
+ * - Subscribe for [IModelHost.onBeforeShutdown]($core-backend) event and terminate
+ *   the presentation manager when that happens.
+ *
+ * @public
+ */
+export declare class Presentation {
+    private static _initProps;
+    private static _clientsStorage;
+    private static _disposeIpcHandler;
+    private static _shutdownListener;
+    private static _disposeIModelOpenedListener;
+    private static _manager;
+    private static _rpcImpl;
+    private constructor();
+    /** Properties used to initialize the presentation framework */
+    static get initProps(): PresentationProps | undefined;
+    /**
+     * Initializes Presentation library for the backend.
+     *
+     * See [Setting up iTwin.js Presentation library documentation page]($docs/presentation/setup/index.md#backend) for an example.
+     *
+     * **Important:** The method should be called after a call to [IModelHost.startup]($core-backend)
+     *
+     * @param props Optional properties for [[PresentationManager]]
+     */
+    static initialize(props?: PresentationProps): void;
+    /**
+     * Terminates Presentation. Consumers don't need to call this as it's automatically
+     * called on [IModelHost.onBeforeShutdown]($core-backend) event.
+     */
+    static terminate(): void;
+    private static createClientManager;
+    private static disposeClientManager;
+    /**
+     * Get an instance of [[PresentationManager]] for specific client
+     * @param clientId ID of the client requesting presentation data. If no
+     *        ID is provided, the default [[PresentationManager]] is returned.
+     */
+    static getManager(clientId?: string): PresentationManager;
+    /**
+     * Get the time in milliseconds that backend should respond in .
+     */
+    static getRequestTimeout(): number;
+    private static onIModelOpened;
+}
 //# sourceMappingURL=Presentation.d.ts.map

package/lib/cjs/presentation-backend/Presentation.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"Presentation.d.ts","sourceRoot":"","sources":["../../../src/presentation-backend/Presentation.ts"],"names":[],"mappings":"AAIA;;GAEG;AAQH,OAAO,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;~~AAMtF~~;;;;GAIG;AACH,MAAM,WAAW,qBAAsB,SAAQ,wBAAwB;IACrE;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;;GAKG;AACH,MAAM,WAAW,6BAA8B,SAAQ,qBAAqB;IAC1E;;;OAGG;IACH,oBAAoB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,wBAAwB,KAAK,mBAAmB,CAAC;IAElG;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;GAKG;AACH,MAAM,WAAW,8BAA+B,SAAQ,qBAAqB;IAC3E;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;;GAGG;AACH,~~oBAAY~~,iBAAiB,GAAG,6BAA6B,GAAG,8BAA8B,CAAC;AAM/F;;;;;;;;;GASG;AACH,qBAAa,YAAY;IAEvB,OAAO,CAAC,MAAM,CAAC,UAAU,CAAgC;IACzD,OAAO,CAAC,MAAM,CAAC,eAAe,CAA4D;IAC1F,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAA0B;IAC3D,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAA0B;IAC1D,OAAO,CAAC,MAAM,CAAC,4BAA4B,CAA0B;IACrE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAkC;IACzD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAkC;IAGzD,OAAO;IAEP,+DAA+D;IAC/D,WAAkB,SAAS,kCAA8B;IAEzD;;;;;;;;OAQG;WACW,UAAU,CAAC,KAAK,CAAC,EAAE,iBAAiB,GAAG,IAAI;IAkCzD;;;OAGG;WACW,SAAS,IAAI,IAAI;IA4B/B,OAAO,CAAC,MAAM,CAAC,mBAAmB;IASlC,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAInC;;;;OAIG;WACW,UAAU,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,mBAAmB;IAShE;;OAEG;WACW,iBAAiB,IAAI,MAAM;IAMzC,OAAO,CAAC,MAAM,CAAC,cAAc,CAK3B;CACH"}
1	+ {"version":3,"file":"Presentation.d.ts","sourceRoot":"","sources":["../../../src/presentation-backend/Presentation.ts"],"names":[],"mappings":"AAIA;;GAEG;AAQH,OAAO,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AAItF;;;;GAIG;AACH,MAAM,WAAW,qBAAsB,SAAQ,wBAAwB;IACrE;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;;GAKG;AACH,MAAM,WAAW,6BAA8B,SAAQ,qBAAqB;IAC1E;;;OAGG;IACH,oBAAoB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,wBAAwB,KAAK,mBAAmB,CAAC;IAElG;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;GAKG;AACH,MAAM,WAAW,8BAA+B,SAAQ,qBAAqB;IAC3E;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,6BAA6B,GAAG,8BAA8B,CAAC;AAM/F;;;;;;;;;GASG;AACH,qBAAa,YAAY;IAEvB,OAAO,CAAC,MAAM,CAAC,UAAU,CAAgC;IACzD,OAAO,CAAC,MAAM,CAAC,eAAe,CAA4D;IAC1F,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAA0B;IAC3D,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAA0B;IAC1D,OAAO,CAAC,MAAM,CAAC,4BAA4B,CAA0B;IACrE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAkC;IACzD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAkC;IAGzD,OAAO;IAEP,+DAA+D;IAC/D,WAAkB,SAAS,kCAA8B;IAEzD;;;;;;;;OAQG;WACW,UAAU,CAAC,KAAK,CAAC,EAAE,iBAAiB,GAAG,IAAI;IAkCzD;;;OAGG;WACW,SAAS,IAAI,IAAI;IA4B/B,OAAO,CAAC,MAAM,CAAC,mBAAmB;IASlC,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAInC;;;;OAIG;WACW,UAAU,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,mBAAmB;IAShE;;OAEG;WACW,iBAAiB,IAAI,MAAM;IAMzC,OAAO,CAAC,MAAM,CAAC,cAAc,CAK3B;CACH"}

package/lib/cjs/presentation-backend/Presentation.js CHANGED Viewed

@@ -1,151 +1,149 @@
-"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 Core
- */
-var _a;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Presentation = void 0;
-const core_backend_1 = require("@itwin/core-backend");
-const core_bentley_1 = require("@itwin/core-bentley");
-const core_common_1 = require("@itwin/core-common");
-const presentation_common_1 = require("@itwin/presentation-common");
-const BackendLoggerCategory_1 = require("./BackendLoggerCategory");
-const PresentationIpcHandler_1 = require("./PresentationIpcHandler");
-const PresentationManager_1 = require("./PresentationManager");
-const PresentationRpcImpl_1 = require("./PresentationRpcImpl");
-const TemporaryStorage_1 = require("./TemporaryStorage");
-const defaultRequestTimeout = 90000;
-/**
- * Static class used to statically set up Presentation library for the backend.
- * Basically what it does is:
- * - Register a RPC implementation
- * - Create a singleton [[PresentationManager]] instance
- * - Subscribe for [IModelHost.onBeforeShutdown]($core-backend) event and terminate
- *   the presentation manager when that happens.
- *
- * @public
- */
-class Presentation {
-    /* istanbul ignore next */
-    constructor() { }
-    /** Properties used to initialize the presentation framework */
-    static get initProps() { return this._initProps; }
-    /**
-     * Initializes Presentation library for the backend.
-     *
-     * See [Setting up iTwin.js Presentation library documentation page]($docs/presentation/setup/index.md#backend) for an example.
-     *
-     * **Important:** The method should be called after a call to [IModelHost.startup]($core-backend)
-     *
-     * @param props Optional properties for [[PresentationManager]]
-     */
-    static initialize(props) {
-        var _b, _c;
-        this._initProps = props || {};
-        this._shutdownListener = core_backend_1.IModelHost.onBeforeShutdown.addListener(() => Presentation.terminate());
-        this._rpcImpl = new PresentationRpcImpl_1.PresentationRpcImpl({
-            requestTimeout: (_b = this._initProps.requestTimeout) !== null && _b !== void 0 ? _b : defaultRequestTimeout,
-        });
-        core_common_1.RpcManager.registerImpl(presentation_common_1.PresentationRpcInterface, PresentationRpcImpl_1.PresentationRpcImpl);
-        core_common_1.RpcManager.supplyImplInstance(presentation_common_1.PresentationRpcInterface, this._rpcImpl);
-        if (core_backend_1.IpcHost.isValid) {
-            this._disposeIpcHandler = PresentationIpcHandler_1.PresentationIpcHandler.register();
-        }
-        if (isSingleManagerProps(this._initProps)) {
-            this._manager = new PresentationManager_1.PresentationManager(Presentation._initProps);
-        }
-        else {
-            this._clientsStorage = new TemporaryStorage_1.FactoryBasedTemporaryStorage({
-                factory: this.createClientManager.bind(this),
-                cleanupHandler: this.disposeClientManager,
-                // cleanup unused managers every minute
-                cleanupInterval: 60 * 1000,
-                // by default, manager is disposed after 1 hour of being unused
-                unusedValueLifetime: (_c = this._initProps.unusedClientLifetime) !== null && _c !== void 0 ? _c : 60 * 60 * 1000,
-                // add some logging
-                onDisposedSingle: /* istanbul ignore next */ (id) => core_bentley_1.Logger.logInfo(BackendLoggerCategory_1.PresentationBackendLoggerCategory.PresentationManager, `Disposed PresentationManager instance with ID: ${id}. Total instances: ${this._clientsStorage.values.length}.`),
-                onDisposedAll: /* istanbul ignore next */ () => core_bentley_1.Logger.logInfo(BackendLoggerCategory_1.PresentationBackendLoggerCategory.PresentationManager, `Disposed all PresentationManager instances.`),
-            });
-        }
-        if (this._initProps.enableSchemasPreload)
-            this._disposeIModelOpenedListener = core_backend_1.BriefcaseDb.onOpened.addListener(this.onIModelOpened);
-    }
-    /**
-     * Terminates Presentation. Consumers don't need to call this as it's automatically
-     * called on [IModelHost.onBeforeShutdown]($core-backend) event.
-     */
-    static terminate() {
-        if (this._clientsStorage) {
-            this._clientsStorage.dispose();
-            this._clientsStorage = undefined;
-        }
-        if (this._disposeIModelOpenedListener) {
-            this._disposeIModelOpenedListener();
-            this._disposeIModelOpenedListener = undefined;
-        }
-        if (this._shutdownListener) {
-            this._shutdownListener();
-            this._shutdownListener = undefined;
-        }
-        if (this._manager) {
-            this._manager.dispose();
-            this._manager = undefined;
-        }
-        core_common_1.RpcManager.unregisterImpl(presentation_common_1.PresentationRpcInterface);
-        if (this._rpcImpl) {
-            this._rpcImpl.dispose();
-            this._rpcImpl = undefined;
-        }
-        if (this._disposeIpcHandler) {
-            this._disposeIpcHandler();
-        }
-        this._initProps = undefined;
-    }
-    static createClientManager(clientId, onManagerUsed) {
-        const manager = (Presentation._initProps && !isSingleManagerProps(Presentation._initProps) && Presentation._initProps.clientManagerFactory)
-            ? Presentation._initProps.clientManagerFactory(clientId, Presentation._initProps)
-            : new PresentationManager_1.PresentationManager(Presentation._initProps);
-        manager.setOnManagerUsedHandler(onManagerUsed);
-        core_bentley_1.Logger.logInfo(BackendLoggerCategory_1.PresentationBackendLoggerCategory.PresentationManager, `Created a PresentationManager instance with ID: ${clientId}. Total instances: ${this._clientsStorage.values.length}.`);
-        return { manager };
-    }
-    static disposeClientManager(_id, storeItem) {
-        storeItem.manager.dispose();
-    }
-    /**
-     * Get an instance of [[PresentationManager]] for specific client
-     * @param clientId ID of the client requesting presentation data. If no
-     *        ID is provided, the default [[PresentationManager]] is returned.
-     */
-    static getManager(clientId) {
-        if (this._initProps && isSingleManagerProps(this._initProps) && this._manager)
-            return this._manager;
-        if (this._clientsStorage)
-            return this._clientsStorage.getValue(clientId || "").manager;
-        throw new presentation_common_1.PresentationError(presentation_common_1.PresentationStatus.NotInitialized, "Presentation must be first initialized by calling Presentation.initialize");
-    }
-    /**
-     * Get the time in milliseconds that backend should respond in .
-     */
-    static getRequestTimeout() {
-        if (this._rpcImpl === undefined)
-            throw new presentation_common_1.PresentationError(presentation_common_1.PresentationStatus.NotInitialized, "Presentation must be first initialized by calling Presentation.initialize");
-        return this._rpcImpl.requestTimeout;
-    }
-}
-exports.Presentation = Presentation;
-_a = Presentation;
-Presentation.onIModelOpened = (imodel) => {
-    const manager = _a.getManager();
-    const imodelAddon = manager.getNativePlatform().getImodelAddon(imodel);
-    // eslint-disable-next-line @typescript-eslint/no-floating-promises
-    manager.getNativePlatform().forceLoadSchemas(imodelAddon);
-};
-function isSingleManagerProps(props) {
-    return !!props.useSingleManager;
-}
+"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 Core
+ */
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Presentation = void 0;
+const core_backend_1 = require("@itwin/core-backend");
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const presentation_common_1 = require("@itwin/presentation-common");
+const BackendLoggerCategory_1 = require("./BackendLoggerCategory");
+const PresentationIpcHandler_1 = require("./PresentationIpcHandler");
+const PresentationManager_1 = require("./PresentationManager");
+const PresentationRpcImpl_1 = require("./PresentationRpcImpl");
+const TemporaryStorage_1 = require("./TemporaryStorage");
+/**
+ * Static class used to statically set up Presentation library for the backend.
+ * Basically what it does is:
+ * - Register a RPC implementation
+ * - Create a singleton [[PresentationManager]] instance
+ * - Subscribe for [IModelHost.onBeforeShutdown]($core-backend) event and terminate
+ *   the presentation manager when that happens.
+ *
+ * @public
+ */
+class Presentation {
+    /* istanbul ignore next */
+    constructor() { }
+    /** Properties used to initialize the presentation framework */
+    static get initProps() { return this._initProps; }
+    /**
+     * Initializes Presentation library for the backend.
+     *
+     * See [Setting up iTwin.js Presentation library documentation page]($docs/presentation/setup/index.md#backend) for an example.
+     *
+     * **Important:** The method should be called after a call to [IModelHost.startup]($core-backend)
+     *
+     * @param props Optional properties for [[PresentationManager]]
+     */
+    static initialize(props) {
+        this._initProps = props || {};
+        this._shutdownListener = core_backend_1.IModelHost.onBeforeShutdown.addListener(() => Presentation.terminate());
+        this._rpcImpl = new PresentationRpcImpl_1.PresentationRpcImpl({
+            requestTimeout: this._initProps.requestTimeout,
+        });
+        core_common_1.RpcManager.registerImpl(presentation_common_1.PresentationRpcInterface, PresentationRpcImpl_1.PresentationRpcImpl);
+        core_common_1.RpcManager.supplyImplInstance(presentation_common_1.PresentationRpcInterface, this._rpcImpl);
+        if (core_backend_1.IpcHost.isValid) {
+            this._disposeIpcHandler = PresentationIpcHandler_1.PresentationIpcHandler.register();
+        }
+        if (isSingleManagerProps(this._initProps)) {
+            this._manager = new PresentationManager_1.PresentationManager(Presentation._initProps);
+        }
+        else {
+            this._clientsStorage = new TemporaryStorage_1.FactoryBasedTemporaryStorage({
+                factory: this.createClientManager.bind(this),
+                cleanupHandler: this.disposeClientManager,
+                // cleanup unused managers every minute
+                cleanupInterval: 60 * 1000,
+                // by default, manager is disposed after 1 hour of being unused
+                unusedValueLifetime: this._initProps.unusedClientLifetime ?? 60 * 60 * 1000,
+                // add some logging
+                onDisposedSingle: /* istanbul ignore next */ (id) => core_bentley_1.Logger.logInfo(BackendLoggerCategory_1.PresentationBackendLoggerCategory.PresentationManager, `Disposed PresentationManager instance with ID: ${id}. Total instances: ${this._clientsStorage.values.length}.`),
+                onDisposedAll: /* istanbul ignore next */ () => core_bentley_1.Logger.logInfo(BackendLoggerCategory_1.PresentationBackendLoggerCategory.PresentationManager, `Disposed all PresentationManager instances.`),
+            });
+        }
+        if (this._initProps.enableSchemasPreload)
+            this._disposeIModelOpenedListener = core_backend_1.BriefcaseDb.onOpened.addListener(this.onIModelOpened);
+    }
+    /**
+     * Terminates Presentation. Consumers don't need to call this as it's automatically
+     * called on [IModelHost.onBeforeShutdown]($core-backend) event.
+     */
+    static terminate() {
+        if (this._clientsStorage) {
+            this._clientsStorage.dispose();
+            this._clientsStorage = undefined;
+        }
+        if (this._disposeIModelOpenedListener) {
+            this._disposeIModelOpenedListener();
+            this._disposeIModelOpenedListener = undefined;
+        }
+        if (this._shutdownListener) {
+            this._shutdownListener();
+            this._shutdownListener = undefined;
+        }
+        if (this._manager) {
+            this._manager.dispose();
+            this._manager = undefined;
+        }
+        core_common_1.RpcManager.unregisterImpl(presentation_common_1.PresentationRpcInterface);
+        if (this._rpcImpl) {
+            this._rpcImpl.dispose();
+            this._rpcImpl = undefined;
+        }
+        if (this._disposeIpcHandler) {
+            this._disposeIpcHandler();
+        }
+        this._initProps = undefined;
+    }
+    static createClientManager(clientId, onManagerUsed) {
+        const manager = (Presentation._initProps && !isSingleManagerProps(Presentation._initProps) && Presentation._initProps.clientManagerFactory)
+            ? Presentation._initProps.clientManagerFactory(clientId, Presentation._initProps)
+            : new PresentationManager_1.PresentationManager(Presentation._initProps);
+        manager.setOnManagerUsedHandler(onManagerUsed);
+        core_bentley_1.Logger.logInfo(BackendLoggerCategory_1.PresentationBackendLoggerCategory.PresentationManager, `Created a PresentationManager instance with ID: ${clientId}. Total instances: ${this._clientsStorage.values.length}.`);
+        return { manager };
+    }
+    static disposeClientManager(_id, storeItem) {
+        storeItem.manager.dispose();
+    }
+    /**
+     * Get an instance of [[PresentationManager]] for specific client
+     * @param clientId ID of the client requesting presentation data. If no
+     *        ID is provided, the default [[PresentationManager]] is returned.
+     */
+    static getManager(clientId) {
+        if (this._initProps && isSingleManagerProps(this._initProps) && this._manager)
+            return this._manager;
+        if (this._clientsStorage)
+            return this._clientsStorage.getValue(clientId || "").manager;
+        throw new presentation_common_1.PresentationError(presentation_common_1.PresentationStatus.NotInitialized, "Presentation must be first initialized by calling Presentation.initialize");
+    }
+    /**
+     * Get the time in milliseconds that backend should respond in .
+     */
+    static getRequestTimeout() {
+        if (this._rpcImpl === undefined)
+            throw new presentation_common_1.PresentationError(presentation_common_1.PresentationStatus.NotInitialized, "Presentation must be first initialized by calling Presentation.initialize");
+        return this._rpcImpl.requestTimeout;
+    }
+}
+_a = Presentation;
+Presentation.onIModelOpened = (imodel) => {
+    const manager = _a.getManager();
+    const imodelAddon = manager.getNativePlatform().getImodelAddon(imodel);
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    manager.getNativePlatform().forceLoadSchemas(imodelAddon);
+};
+exports.Presentation = Presentation;
+function isSingleManagerProps(props) {
+    return !!props.useSingleManager;
+}
 //# sourceMappingURL=Presentation.js.map

package/lib/cjs/presentation-backend/Presentation.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"Presentation.js","sourceRoot":"","sources":["../../../src/presentation-backend/Presentation.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;;AAEH,sDAAuE;AACvE,sDAA0D;AAC1D,oDAAgD;AAChD,oEAA6G;AAC7G,mEAA4E;AAC5E,qEAAkE;AAClE,+DAAsF;AACtF,+DAA4D;AAC5D,yDAAkE;AAElE,MAAM,qBAAqB,GAAW,KAAK,CAAC;AAgE5C;;;;;;;;;GASG;AACH,MAAa,YAAY;IAUvB,0BAA0B;IAC1B,gBAAwB,CAAC;IAEzB,+DAA+D;IACxD,MAAM,KAAK,SAAS,KAAK,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAEzD;;;;;;;;OAQG;IACI,MAAM,CAAC,UAAU,CAAC,KAAyB;;QAChD,IAAI,CAAC,UAAU,GAAG,KAAK,IAAI,EAAE,CAAC;QAC9B,IAAI,CAAC,iBAAiB,GAAG,yBAAU,CAAC,gBAAgB,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,CAAC;QAEjG,IAAI,CAAC,QAAQ,GAAG,IAAI,yCAAmB,CAAC;YACtC,cAAc,EAAE,MAAA,IAAI,CAAC,UAAU,CAAC,cAAc,mCAAI,qBAAqB;SACxE,CAAC,CAAC;QACH,wBAAU,CAAC,YAAY,CAAC,8CAAwB,EAAE,yCAAmB,CAAC,CAAC;QACvE,wBAAU,CAAC,kBAAkB,CAAC,8CAAwB,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEvE,IAAI,sBAAO,CAAC,OAAO,EAAE;YACnB,IAAI,CAAC,kBAAkB,GAAG,+CAAsB,CAAC,QAAQ,EAAE,CAAC;SAC7D;QAED,IAAI,oBAAoB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YACzC,IAAI,CAAC,QAAQ,GAAG,IAAI,yCAAmB,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;SAClE;aAAM;YACL,IAAI,CAAC,eAAe,GAAG,IAAI,+CAA4B,CAAkB;gBACvE,OAAO,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC5C,cAAc,EAAE,IAAI,CAAC,oBAAoB;gBACzC,uCAAuC;gBACvC,eAAe,EAAE,EAAE,GAAG,IAAI;gBAC1B,+DAA+D;gBAC/D,mBAAmB,EAAE,MAAA,IAAI,CAAC,UAAU,CAAC,oBAAoB,mCAAI,EAAE,GAAG,EAAE,GAAG,IAAI;gBAC3E,mBAAmB;gBACnB,gBAAgB,EAAE,0BAA0B,CAAA,CAAC,EAAU,EAAE,EAAE,CAAC,qBAAM,CAAC,OAAO,CAAC,yDAAiC,CAAC,mBAAmB,EAAE,kDAAkD,EAAE,sBAAsB,IAAI,CAAC,eAAgB,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;gBACnP,aAAa,EAAE,0BAA0B,CAAA,GAAG,EAAE,CAAC,qBAAM,CAAC,OAAO,CAAC,yDAAiC,CAAC,mBAAmB,EAAE,6CAA6C,CAAC;aACpK,CAAC,CAAC;SACJ;QAED,IAAI,IAAI,CAAC,UAAU,CAAC,oBAAoB;YACtC,IAAI,CAAC,4BAA4B,GAAG,0BAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC9F,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,SAAS;QACrB,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;YAC/B,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;SAClC;QACD,IAAI,IAAI,CAAC,4BAA4B,EAAE;YACrC,IAAI,CAAC,4BAA4B,EAAE,CAAC;YACpC,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAC;SAC/C;QACD,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACzB,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;SACpC;QACD,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACxB,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;SAC3B;QACD,wBAAU,CAAC,cAAc,CAAC,8CAAwB,CAAC,CAAC;QACpD,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACxB,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;SAC3B;QACD,IAAI,IAAI,CAAC,kBAAkB,EAAE;YAC3B,IAAI,CAAC,kBAAkB,EAAE,CAAC;SAC3B;QACD,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,QAAgB,EAAE,aAAyB;QAC5E,MAAM,OAAO,GAAG,CAAC,YAAY,CAAC,UAAU,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,YAAY,CAAC,UAAU,CAAC,oBAAoB,CAAC;YACzI,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,oBAAoB,CAAC,QAAQ,EAAE,YAAY,CAAC,UAAU,CAAC;YACjF,CAAC,CAAC,IAAI,yCAAmB,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QACrD,OAAO,CAAC,uBAAuB,CAAC,aAAa,CAAC,CAAC;QAC/C,qBAAM,CAAC,OAAO,CAAC,yDAAiC,CAAC,mBAAmB,EAAE,mDAAmD,QAAQ,sBAAsB,IAAI,CAAC,eAAgB,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;QAC/L,OAAO,EAAE,OAAO,EAAE,CAAC;IACrB,CAAC;IAEO,MAAM,CAAC,oBAAoB,CAAC,GAAW,EAAE,SAA0B;QACzE,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,QAAiB;QACxC,IAAI,IAAI,CAAC,UAAU,IAAI,oBAAoB,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,QAAQ;YAC3E,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,IAAI,IAAI,CAAC,eAAe;YACtB,OAAO,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC;QAE/D,MAAM,IAAI,uCAAiB,CAAC,wCAAkB,CAAC,cAAc,EAAE,2EAA2E,CAAC,CAAC;IAC9I,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB;QAC7B,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;YAC7B,MAAM,IAAI,uCAAiB,CAAC,wCAAkB,CAAC,cAAc,EAAE,2EAA2E,CAAC,CAAC;QAC9I,OAAO,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC;IACtC,CAAC;;AA7HH,oCAqIC;;AANgB,2BAAc,GAAG,CAAC,MAAmB,EAAE,EAAE;IACtD,MAAM,OAAO,GAAG,EAAI,CAAC,UAAU,EAAE,CAAC;IAClC,MAAM,WAAW,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IACvE,mEAAmE;IACnE,OAAO,CAAC,iBAAiB,EAAE,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;AAC5D,CAAE,CAAA;AAGJ,SAAS,oBAAoB,CAAC,KAAwB;IACpD,OAAO,CAAC,CAAE,KAAwC,CAAC,gBAAgB,CAAC;AACtE,CAAC","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 Core\r\n /\r\n\r\nimport { BriefcaseDb, IModelHost, IpcHost } from \"@itwin/core-backend\";\r\nimport { DisposeFunc, Logger } from \"@itwin/core-bentley\";\r\nimport { RpcManager } from \"@itwin/core-common\";\r\nimport { PresentationError, PresentationRpcInterface, PresentationStatus } from \"@itwin/presentation-common\";\r\nimport { PresentationBackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { PresentationIpcHandler } from \"./PresentationIpcHandler\";\r\nimport { PresentationManager, PresentationManagerProps } from \"./PresentationManager\";\r\nimport { PresentationRpcImpl } from \"./PresentationRpcImpl\";\r\nimport { FactoryBasedTemporaryStorage } from \"./TemporaryStorage\";\r\n\r\nconst defaultRequestTimeout: number = 90000;\r\n\r\n/\r\n Base props for initializing the [[Presentation]] library.\r\n \r\n @public\r\n /\r\nexport interface PresentationPropsBase extends PresentationManagerProps {\r\n /\r\n Time in milliseconds after which the request will timeout.\r\n /\r\n requestTimeout?: number;\r\n\r\n /\r\n Should schemas preloading be enabled. If true, [[Presentation]] library listens\r\n * for `BriefcaseDb.onOpened` event and force pre-loads all ECSchemas.\r\n /\r\n enableSchemasPreload?: boolean;\r\n}\r\n\r\n/\r\n Props for initializing the [[Presentation]] library for using multiple [[PresentationManager]]\r\n * instances, one for each frontend.\r\n \r\n @public\r\n /\r\nexport interface MultiManagerPresentationProps extends PresentationPropsBase {\r\n /\r\n Factory method for creating separate managers for each client\r\n * @internal\r\n /\r\n clientManagerFactory?: (clientId: string, props: PresentationManagerProps) => PresentationManager;\r\n\r\n /\r\n How much time should an unused client manager be stored in memory\r\n * before it's disposed.\r\n /\r\n unusedClientLifetime?: number;\r\n}\r\n\r\n/\r\n Props for initializing the [[Presentation]] library with ability to use a single\r\n * [[PresentationManager]] instance for handling all requests.\r\n \r\n @public\r\n /\r\nexport interface SingleManagerPresentationProps extends PresentationPropsBase {\r\n /\r\n Specifies to use single manager for all clients.\r\n * @alpha\r\n /\r\n useSingleManager?: boolean;\r\n}\r\n\r\n/\r\n Properties that can be used to configure [[Presentation]] API\r\n * @public\r\n /\r\nexport type PresentationProps = MultiManagerPresentationProps \| SingleManagerPresentationProps;\r\n\r\ninterface ClientStoreItem {\r\n manager: PresentationManager;\r\n}\r\n\r\n/\r\n Static class used to statically set up Presentation library for the backend.\r\n * Basically what it does is:\r\n * - Register a RPC implementation\r\n * - Create a singleton [[PresentationManager]] instance\r\n * - Subscribe for [IModelHost.onBeforeShutdown]($core-backend) event and terminate\r\n * the presentation manager when that happens.\r\n \r\n @public\r\n /\r\nexport class Presentation {\r\n\r\n private static _initProps: PresentationProps \| undefined;\r\n private static _clientsStorage: FactoryBasedTemporaryStorage<ClientStoreItem> \| undefined;\r\n private static _disposeIpcHandler: DisposeFunc \| undefined;\r\n private static _shutdownListener: DisposeFunc \| undefined;\r\n private static _disposeIModelOpenedListener: DisposeFunc \| undefined;\r\n private static _manager: PresentationManager \| undefined;\r\n private static _rpcImpl: PresentationRpcImpl \| undefined;\r\n\r\n / istanbul ignore next /\r\n private constructor() { }\r\n\r\n /* Properties used to initialize the presentation framework /\r\n public static get initProps() { return this._initProps; }\r\n\r\n /\r\n Initializes Presentation library for the backend.\r\n \r\n See [Setting up iTwin.js Presentation library documentation page]($docs/presentation/setup/index.md#backend) for an example.\r\n \r\n Important: The method should be called after a call to [IModelHost.startup]($core-backend)\r\n \r\n @param props Optional properties for [[PresentationManager]]\r\n /\r\n public static initialize(props?: PresentationProps): void {\r\n this._initProps = props \|\| {};\r\n this._shutdownListener = IModelHost.onBeforeShutdown.addListener(() => Presentation.terminate());\r\n\r\n this._rpcImpl = new PresentationRpcImpl({\r\n requestTimeout: this._initProps.requestTimeout ?? defaultRequestTimeout,\r\n });\r\n RpcManager.registerImpl(PresentationRpcInterface, PresentationRpcImpl);\r\n RpcManager.supplyImplInstance(PresentationRpcInterface, this._rpcImpl);\r\n\r\n if (IpcHost.isValid) {\r\n this._disposeIpcHandler = PresentationIpcHandler.register();\r\n }\r\n\r\n if (isSingleManagerProps(this._initProps)) {\r\n this._manager = new PresentationManager(Presentation._initProps);\r\n } else {\r\n this._clientsStorage = new FactoryBasedTemporaryStorage<ClientStoreItem>({\r\n factory: this.createClientManager.bind(this),\r\n cleanupHandler: this.disposeClientManager,\r\n // cleanup unused managers every minute\r\n cleanupInterval: 60 1000,\r\n // by default, manager is disposed after 1 hour of being unused\r\n unusedValueLifetime: this._initProps.unusedClientLifetime ?? 60 * 60 * 1000,\r\n // add some logging\r\n onDisposedSingle: /* istanbul ignore next /(id: string) => Logger.logInfo(PresentationBackendLoggerCategory.PresentationManager, `Disposed PresentationManager instance with ID: ${id}. Total instances: ${this._clientsStorage!.values.length}.`),\r\n onDisposedAll: / istanbul ignore next /() => Logger.logInfo(PresentationBackendLoggerCategory.PresentationManager, `Disposed all PresentationManager instances.`),\r\n });\r\n }\r\n\r\n if (this._initProps.enableSchemasPreload)\r\n this._disposeIModelOpenedListener = BriefcaseDb.onOpened.addListener(this.onIModelOpened);\r\n }\r\n\r\n /\r\n Terminates Presentation. Consumers don't need to call this as it's automatically\r\n * called on [IModelHost.onBeforeShutdown]($core-backend) event.\r\n /\r\n public static terminate(): void {\r\n if (this._clientsStorage) {\r\n this._clientsStorage.dispose();\r\n this._clientsStorage = undefined;\r\n }\r\n if (this._disposeIModelOpenedListener) {\r\n this._disposeIModelOpenedListener();\r\n this._disposeIModelOpenedListener = undefined;\r\n }\r\n if (this._shutdownListener) {\r\n this._shutdownListener();\r\n this._shutdownListener = undefined;\r\n }\r\n if (this._manager) {\r\n this._manager.dispose();\r\n this._manager = undefined;\r\n }\r\n RpcManager.unregisterImpl(PresentationRpcInterface);\r\n if (this._rpcImpl) {\r\n this._rpcImpl.dispose();\r\n this._rpcImpl = undefined;\r\n }\r\n if (this._disposeIpcHandler) {\r\n this._disposeIpcHandler();\r\n }\r\n this._initProps = undefined;\r\n }\r\n\r\n private static createClientManager(clientId: string, onManagerUsed: () => void): ClientStoreItem {\r\n const manager = (Presentation._initProps && !isSingleManagerProps(Presentation._initProps) && Presentation._initProps.clientManagerFactory)\r\n ? Presentation._initProps.clientManagerFactory(clientId, Presentation._initProps)\r\n : new PresentationManager(Presentation._initProps);\r\n manager.setOnManagerUsedHandler(onManagerUsed);\r\n Logger.logInfo(PresentationBackendLoggerCategory.PresentationManager, `Created a PresentationManager instance with ID: ${clientId}. Total instances: ${this._clientsStorage!.values.length}.`);\r\n return { manager };\r\n }\r\n\r\n private static disposeClientManager(_id: string, storeItem: ClientStoreItem) {\r\n storeItem.manager.dispose();\r\n }\r\n\r\n /\r\n Get an instance of [[PresentationManager]] for specific client\r\n * @param clientId ID of the client requesting presentation data. If no\r\n * ID is provided, the default [[PresentationManager]] is returned.\r\n /\r\n public static getManager(clientId?: string): PresentationManager {\r\n if (this._initProps && isSingleManagerProps(this._initProps) && this._manager)\r\n return this._manager;\r\n if (this._clientsStorage)\r\n return this._clientsStorage.getValue(clientId \|\| \"\").manager;\r\n\r\n throw new PresentationError(PresentationStatus.NotInitialized, \"Presentation must be first initialized by calling Presentation.initialize\");\r\n }\r\n\r\n /\r\n Get the time in milliseconds that backend should respond in .\r\n */\r\n public static getRequestTimeout(): number {\r\n if (this._rpcImpl === undefined)\r\n throw new PresentationError(PresentationStatus.NotInitialized, \"Presentation must be first initialized by calling Presentation.initialize\");\r\n return this._rpcImpl.requestTimeout;\r\n }\r\n\r\n private static onIModelOpened = (imodel: BriefcaseDb) => {\r\n const manager = this.getManager();\r\n const imodelAddon = manager.getNativePlatform().getImodelAddon(imodel);\r\n // eslint-disable-next-line @typescript-eslint/no-floating-promises\r\n manager.getNativePlatform().forceLoadSchemas(imodelAddon);\r\n };\r\n}\r\n\r\nfunction isSingleManagerProps(props: PresentationProps): props is SingleManagerPresentationProps {\r\n return !!(props as SingleManagerPresentationProps).useSingleManager;\r\n}\r\n"]}
1	+ {"version":3,"file":"Presentation.js","sourceRoot":"","sources":["../../../src/presentation-backend/Presentation.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;;AAEH,sDAAuE;AACvE,sDAA0D;AAC1D,oDAAgD;AAChD,oEAA6G;AAC7G,mEAA4E;AAC5E,qEAAkE;AAClE,+DAAsF;AACtF,+DAA4D;AAC5D,yDAAkE;AAgElE;;;;;;;;;GASG;AACH,MAAa,YAAY;IAUvB,0BAA0B;IAC1B,gBAAwB,CAAC;IAEzB,+DAA+D;IACxD,MAAM,KAAK,SAAS,KAAK,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAEzD;;;;;;;;OAQG;IACI,MAAM,CAAC,UAAU,CAAC,KAAyB;QAChD,IAAI,CAAC,UAAU,GAAG,KAAK,IAAI,EAAE,CAAC;QAC9B,IAAI,CAAC,iBAAiB,GAAG,yBAAU,CAAC,gBAAgB,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,CAAC;QAEjG,IAAI,CAAC,QAAQ,GAAG,IAAI,yCAAmB,CAAC;YACtC,cAAc,EAAE,IAAI,CAAC,UAAU,CAAC,cAAc;SAC/C,CAAC,CAAC;QACH,wBAAU,CAAC,YAAY,CAAC,8CAAwB,EAAE,yCAAmB,CAAC,CAAC;QACvE,wBAAU,CAAC,kBAAkB,CAAC,8CAAwB,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEvE,IAAI,sBAAO,CAAC,OAAO,EAAE;YACnB,IAAI,CAAC,kBAAkB,GAAG,+CAAsB,CAAC,QAAQ,EAAE,CAAC;SAC7D;QAED,IAAI,oBAAoB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YACzC,IAAI,CAAC,QAAQ,GAAG,IAAI,yCAAmB,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;SAClE;aAAM;YACL,IAAI,CAAC,eAAe,GAAG,IAAI,+CAA4B,CAAkB;gBACvE,OAAO,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC5C,cAAc,EAAE,IAAI,CAAC,oBAAoB;gBACzC,uCAAuC;gBACvC,eAAe,EAAE,EAAE,GAAG,IAAI;gBAC1B,+DAA+D;gBAC/D,mBAAmB,EAAE,IAAI,CAAC,UAAU,CAAC,oBAAoB,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI;gBAC3E,mBAAmB;gBACnB,gBAAgB,EAAE,0BAA0B,CAAA,CAAC,EAAU,EAAE,EAAE,CAAC,qBAAM,CAAC,OAAO,CAAC,yDAAiC,CAAC,mBAAmB,EAAE,kDAAkD,EAAE,sBAAsB,IAAI,CAAC,eAAgB,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;gBACnP,aAAa,EAAE,0BAA0B,CAAA,GAAG,EAAE,CAAC,qBAAM,CAAC,OAAO,CAAC,yDAAiC,CAAC,mBAAmB,EAAE,6CAA6C,CAAC;aACpK,CAAC,CAAC;SACJ;QAED,IAAI,IAAI,CAAC,UAAU,CAAC,oBAAoB;YACtC,IAAI,CAAC,4BAA4B,GAAG,0BAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC9F,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,SAAS;QACrB,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;YAC/B,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;SAClC;QACD,IAAI,IAAI,CAAC,4BAA4B,EAAE;YACrC,IAAI,CAAC,4BAA4B,EAAE,CAAC;YACpC,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAC;SAC/C;QACD,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACzB,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;SACpC;QACD,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACxB,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;SAC3B;QACD,wBAAU,CAAC,cAAc,CAAC,8CAAwB,CAAC,CAAC;QACpD,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACxB,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;SAC3B;QACD,IAAI,IAAI,CAAC,kBAAkB,EAAE;YAC3B,IAAI,CAAC,kBAAkB,EAAE,CAAC;SAC3B;QACD,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,QAAgB,EAAE,aAAyB;QAC5E,MAAM,OAAO,GAAG,CAAC,YAAY,CAAC,UAAU,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,YAAY,CAAC,UAAU,CAAC,oBAAoB,CAAC;YACzI,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,oBAAoB,CAAC,QAAQ,EAAE,YAAY,CAAC,UAAU,CAAC;YACjF,CAAC,CAAC,IAAI,yCAAmB,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QACrD,OAAO,CAAC,uBAAuB,CAAC,aAAa,CAAC,CAAC;QAC/C,qBAAM,CAAC,OAAO,CAAC,yDAAiC,CAAC,mBAAmB,EAAE,mDAAmD,QAAQ,sBAAsB,IAAI,CAAC,eAAgB,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;QAC/L,OAAO,EAAE,OAAO,EAAE,CAAC;IACrB,CAAC;IAEO,MAAM,CAAC,oBAAoB,CAAC,GAAW,EAAE,SAA0B;QACzE,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,QAAiB;QACxC,IAAI,IAAI,CAAC,UAAU,IAAI,oBAAoB,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,QAAQ;YAC3E,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,IAAI,IAAI,CAAC,eAAe;YACtB,OAAO,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC;QAE/D,MAAM,IAAI,uCAAiB,CAAC,wCAAkB,CAAC,cAAc,EAAE,2EAA2E,CAAC,CAAC;IAC9I,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB;QAC7B,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;YAC7B,MAAM,IAAI,uCAAiB,CAAC,wCAAkB,CAAC,cAAc,EAAE,2EAA2E,CAAC,CAAC;QAC9I,OAAO,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC;IACtC,CAAC;;;AAEc,2BAAc,GAAG,CAAC,MAAmB,EAAE,EAAE;IACtD,MAAM,OAAO,GAAG,EAAI,CAAC,UAAU,EAAE,CAAC;IAClC,MAAM,WAAW,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IACvE,mEAAmE;IACnE,OAAO,CAAC,iBAAiB,EAAE,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;AAC5D,CAAC,AAL4B,CAK3B;AApIS,oCAAY;AAuIzB,SAAS,oBAAoB,CAAC,KAAwB;IACpD,OAAO,CAAC,CAAE,KAAwC,CAAC,gBAAgB,CAAC;AACtE,CAAC","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 Core\r\n /\r\n\r\nimport { BriefcaseDb, IModelHost, IpcHost } from \"@itwin/core-backend\";\r\nimport { DisposeFunc, Logger } from \"@itwin/core-bentley\";\r\nimport { RpcManager } from \"@itwin/core-common\";\r\nimport { PresentationError, PresentationRpcInterface, PresentationStatus } from \"@itwin/presentation-common\";\r\nimport { PresentationBackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { PresentationIpcHandler } from \"./PresentationIpcHandler\";\r\nimport { PresentationManager, PresentationManagerProps } from \"./PresentationManager\";\r\nimport { PresentationRpcImpl } from \"./PresentationRpcImpl\";\r\nimport { FactoryBasedTemporaryStorage } from \"./TemporaryStorage\";\r\n\r\n/\r\n Base props for initializing the [[Presentation]] library.\r\n \r\n @public\r\n /\r\nexport interface PresentationPropsBase extends PresentationManagerProps {\r\n /\r\n Time in milliseconds after which the request will timeout.\r\n /\r\n requestTimeout?: number;\r\n\r\n /\r\n Should schemas preloading be enabled. If true, [[Presentation]] library listens\r\n * for `BriefcaseDb.onOpened` event and force pre-loads all ECSchemas.\r\n /\r\n enableSchemasPreload?: boolean;\r\n}\r\n\r\n/\r\n Props for initializing the [[Presentation]] library for using multiple [[PresentationManager]]\r\n * instances, one for each frontend.\r\n \r\n @public\r\n /\r\nexport interface MultiManagerPresentationProps extends PresentationPropsBase {\r\n /\r\n Factory method for creating separate managers for each client\r\n * @internal\r\n /\r\n clientManagerFactory?: (clientId: string, props: PresentationManagerProps) => PresentationManager;\r\n\r\n /\r\n How much time should an unused client manager be stored in memory\r\n * before it's disposed.\r\n /\r\n unusedClientLifetime?: number;\r\n}\r\n\r\n/\r\n Props for initializing the [[Presentation]] library with ability to use a single\r\n * [[PresentationManager]] instance for handling all requests.\r\n \r\n @public\r\n /\r\nexport interface SingleManagerPresentationProps extends PresentationPropsBase {\r\n /\r\n Specifies to use single manager for all clients.\r\n * @alpha\r\n /\r\n useSingleManager?: boolean;\r\n}\r\n\r\n/\r\n Properties that can be used to configure [[Presentation]] API\r\n * @public\r\n /\r\nexport type PresentationProps = MultiManagerPresentationProps \| SingleManagerPresentationProps;\r\n\r\ninterface ClientStoreItem {\r\n manager: PresentationManager;\r\n}\r\n\r\n/\r\n Static class used to statically set up Presentation library for the backend.\r\n * Basically what it does is:\r\n * - Register a RPC implementation\r\n * - Create a singleton [[PresentationManager]] instance\r\n * - Subscribe for [IModelHost.onBeforeShutdown]($core-backend) event and terminate\r\n * the presentation manager when that happens.\r\n \r\n @public\r\n /\r\nexport class Presentation {\r\n\r\n private static _initProps: PresentationProps \| undefined;\r\n private static _clientsStorage: FactoryBasedTemporaryStorage<ClientStoreItem> \| undefined;\r\n private static _disposeIpcHandler: DisposeFunc \| undefined;\r\n private static _shutdownListener: DisposeFunc \| undefined;\r\n private static _disposeIModelOpenedListener: DisposeFunc \| undefined;\r\n private static _manager: PresentationManager \| undefined;\r\n private static _rpcImpl: PresentationRpcImpl \| undefined;\r\n\r\n / istanbul ignore next /\r\n private constructor() { }\r\n\r\n /* Properties used to initialize the presentation framework /\r\n public static get initProps() { return this._initProps; }\r\n\r\n /\r\n Initializes Presentation library for the backend.\r\n \r\n See [Setting up iTwin.js Presentation library documentation page]($docs/presentation/setup/index.md#backend) for an example.\r\n \r\n Important: The method should be called after a call to [IModelHost.startup]($core-backend)\r\n \r\n @param props Optional properties for [[PresentationManager]]\r\n /\r\n public static initialize(props?: PresentationProps): void {\r\n this._initProps = props \|\| {};\r\n this._shutdownListener = IModelHost.onBeforeShutdown.addListener(() => Presentation.terminate());\r\n\r\n this._rpcImpl = new PresentationRpcImpl({\r\n requestTimeout: this._initProps.requestTimeout,\r\n });\r\n RpcManager.registerImpl(PresentationRpcInterface, PresentationRpcImpl);\r\n RpcManager.supplyImplInstance(PresentationRpcInterface, this._rpcImpl);\r\n\r\n if (IpcHost.isValid) {\r\n this._disposeIpcHandler = PresentationIpcHandler.register();\r\n }\r\n\r\n if (isSingleManagerProps(this._initProps)) {\r\n this._manager = new PresentationManager(Presentation._initProps);\r\n } else {\r\n this._clientsStorage = new FactoryBasedTemporaryStorage<ClientStoreItem>({\r\n factory: this.createClientManager.bind(this),\r\n cleanupHandler: this.disposeClientManager,\r\n // cleanup unused managers every minute\r\n cleanupInterval: 60 1000,\r\n // by default, manager is disposed after 1 hour of being unused\r\n unusedValueLifetime: this._initProps.unusedClientLifetime ?? 60 * 60 * 1000,\r\n // add some logging\r\n onDisposedSingle: /* istanbul ignore next /(id: string) => Logger.logInfo(PresentationBackendLoggerCategory.PresentationManager, `Disposed PresentationManager instance with ID: ${id}. Total instances: ${this._clientsStorage!.values.length}.`),\r\n onDisposedAll: / istanbul ignore next /() => Logger.logInfo(PresentationBackendLoggerCategory.PresentationManager, `Disposed all PresentationManager instances.`),\r\n });\r\n }\r\n\r\n if (this._initProps.enableSchemasPreload)\r\n this._disposeIModelOpenedListener = BriefcaseDb.onOpened.addListener(this.onIModelOpened);\r\n }\r\n\r\n /\r\n Terminates Presentation. Consumers don't need to call this as it's automatically\r\n * called on [IModelHost.onBeforeShutdown]($core-backend) event.\r\n /\r\n public static terminate(): void {\r\n if (this._clientsStorage) {\r\n this._clientsStorage.dispose();\r\n this._clientsStorage = undefined;\r\n }\r\n if (this._disposeIModelOpenedListener) {\r\n this._disposeIModelOpenedListener();\r\n this._disposeIModelOpenedListener = undefined;\r\n }\r\n if (this._shutdownListener) {\r\n this._shutdownListener();\r\n this._shutdownListener = undefined;\r\n }\r\n if (this._manager) {\r\n this._manager.dispose();\r\n this._manager = undefined;\r\n }\r\n RpcManager.unregisterImpl(PresentationRpcInterface);\r\n if (this._rpcImpl) {\r\n this._rpcImpl.dispose();\r\n this._rpcImpl = undefined;\r\n }\r\n if (this._disposeIpcHandler) {\r\n this._disposeIpcHandler();\r\n }\r\n this._initProps = undefined;\r\n }\r\n\r\n private static createClientManager(clientId: string, onManagerUsed: () => void): ClientStoreItem {\r\n const manager = (Presentation._initProps && !isSingleManagerProps(Presentation._initProps) && Presentation._initProps.clientManagerFactory)\r\n ? Presentation._initProps.clientManagerFactory(clientId, Presentation._initProps)\r\n : new PresentationManager(Presentation._initProps);\r\n manager.setOnManagerUsedHandler(onManagerUsed);\r\n Logger.logInfo(PresentationBackendLoggerCategory.PresentationManager, `Created a PresentationManager instance with ID: ${clientId}. Total instances: ${this._clientsStorage!.values.length}.`);\r\n return { manager };\r\n }\r\n\r\n private static disposeClientManager(_id: string, storeItem: ClientStoreItem) {\r\n storeItem.manager.dispose();\r\n }\r\n\r\n /\r\n Get an instance of [[PresentationManager]] for specific client\r\n * @param clientId ID of the client requesting presentation data. If no\r\n * ID is provided, the default [[PresentationManager]] is returned.\r\n /\r\n public static getManager(clientId?: string): PresentationManager {\r\n if (this._initProps && isSingleManagerProps(this._initProps) && this._manager)\r\n return this._manager;\r\n if (this._clientsStorage)\r\n return this._clientsStorage.getValue(clientId \|\| \"\").manager;\r\n\r\n throw new PresentationError(PresentationStatus.NotInitialized, \"Presentation must be first initialized by calling Presentation.initialize\");\r\n }\r\n\r\n /\r\n Get the time in milliseconds that backend should respond in .\r\n */\r\n public static getRequestTimeout(): number {\r\n if (this._rpcImpl === undefined)\r\n throw new PresentationError(PresentationStatus.NotInitialized, \"Presentation must be first initialized by calling Presentation.initialize\");\r\n return this._rpcImpl.requestTimeout;\r\n }\r\n\r\n private static onIModelOpened = (imodel: BriefcaseDb) => {\r\n const manager = this.getManager();\r\n const imodelAddon = manager.getNativePlatform().getImodelAddon(imodel);\r\n // eslint-disable-next-line @typescript-eslint/no-floating-promises\r\n manager.getNativePlatform().forceLoadSchemas(imodelAddon);\r\n };\r\n}\r\n\r\nfunction isSingleManagerProps(props: PresentationProps): props is SingleManagerPresentationProps {\r\n return !!(props as SingleManagerPresentationProps).useSingleManager;\r\n}\r\n"]}

package/lib/cjs/presentation-backend/PresentationIpcHandler.d.ts CHANGED Viewed

@@ -1,13 +1,13 @@
-/** @packageDocumentation
- * @module RPC
- */
-import { IpcHandler } from "@itwin/core-backend";
-import { NodeKey, PresentationIpcInterface, RulesetVariableJSON, SetRulesetVariableParams, UnsetRulesetVariableParams, UpdateHierarchyStateParams } from "@itwin/presentation-common";
-/** @internal */
-export declare class PresentationIpcHandler extends IpcHandler implements PresentationIpcInterface {
-    channelName: string;
-    setRulesetVariable(params: SetRulesetVariableParams<RulesetVariableJSON>): Promise<void>;
-    unsetRulesetVariable(params: UnsetRulesetVariableParams): Promise<void>;
-    updateHierarchyState(params: UpdateHierarchyStateParams<NodeKey>): Promise<void>;
-}
+/** @packageDocumentation
+ * @module RPC
+ */
+import { IpcHandler } from "@itwin/core-backend";
+import { NodeKey, PresentationIpcInterface, RulesetVariableJSON, SetRulesetVariableParams, UnsetRulesetVariableParams, UpdateHierarchyStateParams } from "@itwin/presentation-common";
+/** @internal */
+export declare class PresentationIpcHandler extends IpcHandler implements PresentationIpcInterface {
+    channelName: string;
+    setRulesetVariable(params: SetRulesetVariableParams<RulesetVariableJSON>): Promise<void>;
+    unsetRulesetVariable(params: UnsetRulesetVariableParams): Promise<void>;
+    updateHierarchyState(params: UpdateHierarchyStateParams<NodeKey>): Promise<void>;
+}
 //# sourceMappingURL=PresentationIpcHandler.d.ts.map