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

package/lib/esm/presentation-backend/Presentation.d.ts

@@ -0,0 +1,97 @@
+/** @packageDocumentation
+ * @module Core
+ */
+import { PresentationManager, PresentationManagerProps } from "./PresentationManager.js";
+/**
+ * Properties that can be used to configure [[Presentation]] API.
+ * @public
+ */
+export interface PresentationProps extends Omit<PresentationManagerProps, "enableSchemasPreload"> {
+    /**
+     * 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;
+    /**
+     * How much time should an unused client manager be stored in memory
+     * before it's disposed.
+     */
+    unusedClientLifetime?: number;
+}
+/**
+ * Props for initializing the [[Presentation]] library for using multiple [[PresentationManager]]
+ * instances, one for each frontend.
+ *
+ * @public
+ * @deprecated in 4.8 - use [[PresentationProps]] instead.
+ */
+export type MultiManagerPresentationProps = PresentationProps;
+/**
+ * Base props for initializing the [[Presentation]] library.
+ *
+ * @public
+ * @deprecated in 4.8 - use [[PresentationProps]] instead.
+ */
+export type PresentationPropsBase = PresentationProps;
+/**
+ * Props for initializing the [[Presentation]] library with ability to use a single
+ * [[PresentationManager]] instance for handling all requests.
+ *
+ * @public
+ * @deprecated in 4.8 - use [[PresentationProps]] instead.
+ */
+export type SingleManagerPresentationProps = Omit<PresentationProps, "unusedClientLifetime">;
+/**
+ * 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 _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/esm/presentation-backend/Presentation.d.ts.map

@@ -0,0 +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,0BAA0B,CAAC;AAKzF;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,IAAI,CAAC,wBAAwB,EAAE,sBAAsB,CAAC;IAC/F;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AASD;;;;;;GAMG;AACH,MAAM,MAAM,6BAA6B,GAAG,iBAAiB,CAAC;AAE9D;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,CAAC;AAEtD;;;;;;GAMG;AACH,MAAM,MAAM,8BAA8B,GAAG,IAAI,CAAC,iBAAiB,EAAE,sBAAsB,CAAC,CAAC;AAM7F;;;;;;;;;GASG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAC,UAAU,CAA8D;IACvF,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;IAGzD,OAAO;IAEP,+DAA+D;IAC/D,WAAkB,SAAS,IAAI,iBAAiB,GAAG,SAAS,CAE3D;IAED;;;;;;;;OAQG;WACW,UAAU,CAAC,KAAK,CAAC,EAAE,iBAAiB,GAAG,IAAI;IAqCzD;;;OAGG;WACW,SAAS,IAAI,IAAI;IAwB/B,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAiBlC,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAInC;;;;OAIG;WACW,UAAU,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,mBAAmB;IAOhE;;OAEG;WACW,iBAAiB,IAAI,MAAM;IAOzC,OAAO,CAAC,MAAM,CAAC,cAAc,CAK3B;CACH"}

package/lib/esm/presentation-backend/Presentation.js

@@ -0,0 +1,147 @@
+/*---------------------------------------------------------------------------------------------
+ * 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
+ */
+import { BriefcaseDb, IModelHost, IpcHost } from "@itwin/core-backend";
+import { Logger } from "@itwin/core-bentley";
+import { RpcManager } from "@itwin/core-common";
+import { PresentationError, PresentationRpcInterface, PresentationStatus } from "@itwin/presentation-common";
+import { PresentationBackendLoggerCategory } from "./BackendLoggerCategory.js";
+import { PresentationIpcHandler } from "./PresentationIpcHandler.js";
+import { PresentationManager } from "./PresentationManager.js";
+import { PresentationRpcImpl } from "./PresentationRpcImpl.js";
+import { FactoryBasedTemporaryStorage } from "./TemporaryStorage.js";
+import { _presentation_manager_detail } from "./InternalSymbols.js";
+/**
+ * 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 class Presentation {
+    static _initProps;
+    static _clientsStorage;
+    static _disposeIpcHandler;
+    static _shutdownListener;
+    static _disposeIModelOpenedListener;
+    static _rpcImpl;
+    /* c8 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 = IModelHost.onBeforeShutdown.addListener(() => Presentation.terminate());
+        this._rpcImpl = new PresentationRpcImpl({
+            requestTimeout: this._initProps.requestTimeout,
+        });
+        RpcManager.registerImpl(PresentationRpcInterface, PresentationRpcImpl);
+        RpcManager.supplyImplInstance(PresentationRpcInterface, this._rpcImpl);
+        if (IpcHost.isValid) {
+            this._disposeIpcHandler = PresentationIpcHandler.register();
+        }
+        this._clientsStorage = new FactoryBasedTemporaryStorage({
+            factory: this.createClientManager.bind(this),
+            cleanupHandler: (_id, storeItem) => this.disposeClientManager(_id, storeItem),
+            // 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
+            /* c8 ignore next 5 */
+            onDisposedSingle: (id) => Logger.logInfo(PresentationBackendLoggerCategory.PresentationManager, `Disposed PresentationManager instance with ID: ${id}. Total instances: ${this._clientsStorage.values.length}.`),
+            /* c8 ignore next */
+            onDisposedAll: () => Logger.logInfo(PresentationBackendLoggerCategory.PresentationManager, `Disposed all PresentationManager instances.`),
+        });
+        if (this._initProps.enableSchemasPreload) {
+            this._disposeIModelOpenedListener = 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[Symbol.dispose]();
+            this._clientsStorage = undefined;
+        }
+        if (this._disposeIModelOpenedListener) {
+            this._disposeIModelOpenedListener();
+            this._disposeIModelOpenedListener = undefined;
+        }
+        if (this._shutdownListener) {
+            this._shutdownListener();
+            this._shutdownListener = undefined;
+        }
+        RpcManager.unregisterImpl(PresentationRpcInterface);
+        if (this._rpcImpl) {
+            this._rpcImpl[Symbol.dispose]();
+            this._rpcImpl = undefined;
+        }
+        if (this._disposeIpcHandler) {
+            this._disposeIpcHandler();
+        }
+        this._initProps = undefined;
+    }
+    static createClientManager(clientId, onManagerUsed) {
+        const manager = Presentation._initProps && Presentation._initProps.clientManagerFactory
+            ? Presentation._initProps.clientManagerFactory(clientId, Presentation._initProps)
+            : new PresentationManager({
+                ...Presentation._initProps,
+                // @ts-expect-error internal prop
+                id: clientId,
+            });
+        manager.onUsed.addListener(onManagerUsed);
+        Logger.logInfo(PresentationBackendLoggerCategory.PresentationManager, `Created a PresentationManager instance with ID: ${clientId}. Total instances: ${this._clientsStorage.values.length}.`);
+        return { manager };
+    }
+    static disposeClientManager(_id, storeItem) {
+        storeItem.manager[Symbol.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._clientsStorage) {
+            return this._clientsStorage.getValue(clientId || "").manager;
+        }
+        throw new PresentationError(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 PresentationError(PresentationStatus.NotInitialized, "Presentation must be first initialized by calling Presentation.initialize");
+        }
+        return this._rpcImpl.requestTimeout;
+    }
+    static onIModelOpened = (imodel) => {
+        const manager = this.getManager();
+        const imodelAddon = manager[_presentation_manager_detail].getNativePlatform().getImodelAddon(imodel);
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        manager[_presentation_manager_detail].getNativePlatform().forceLoadSchemas(imodelAddon);
+    };
+}
+//# sourceMappingURL=Presentation.js.map

package/lib/esm/presentation-backend/Presentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Presentation.js","sourceRoot":"","sources":["../../../src/presentation-backend/Presentation.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAe,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAC7G,OAAO,EAAE,iCAAiC,EAAE,MAAM,4BAA4B,CAAC;AAC/E,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAA4B,MAAM,0BAA0B,CAAC;AACzF,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,4BAA4B,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,EAAE,4BAA4B,EAAE,MAAM,sBAAsB,CAAC;AA8DpE;;;;;;;;;GASG;AACH,MAAM,OAAO,YAAY;IACf,MAAM,CAAC,UAAU,CAA8D;IAC/E,MAAM,CAAC,eAAe,CAA4D;IAClF,MAAM,CAAC,kBAAkB,CAA0B;IACnD,MAAM,CAAC,iBAAiB,CAA0B;IAClD,MAAM,CAAC,4BAA4B,CAA0B;IAC7D,MAAM,CAAC,QAAQ,CAAkC;IAEzD,oBAAoB;IACpB,gBAAuB,CAAC;IAExB,+DAA+D;IACxD,MAAM,KAAK,SAAS;QACzB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,UAAU,CAAC,KAAyB;QAChD,IAAI,CAAC,UAAU,GAAG,KAAK,IAAI,EAAE,CAAC;QAC9B,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC,gBAAgB,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,CAAC;QAEjG,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAmB,CAAC;YACtC,cAAc,EAAE,IAAI,CAAC,UAAU,CAAC,cAAc;SAC/C,CAAC,CAAC;QACH,UAAU,CAAC,YAAY,CAAC,wBAAwB,EAAE,mBAAmB,CAAC,CAAC;QACvE,UAAU,CAAC,kBAAkB,CAAC,wBAAwB,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEvE,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,IAAI,CAAC,kBAAkB,GAAG,sBAAsB,CAAC,QAAQ,EAAE,CAAC;QAC9D,CAAC;QAED,IAAI,CAAC,eAAe,GAAG,IAAI,4BAA4B,CAAkB;YACvE,OAAO,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC;YAC5C,cAAc,EAAE,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,GAAG,EAAE,SAAS,CAAC;YAC7E,uCAAuC;YACvC,eAAe,EAAE,EAAE,GAAG,IAAI;YAC1B,+DAA+D;YAC/D,mBAAmB,EAAE,IAAI,CAAC,UAAU,CAAC,oBAAoB,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI;YAC3E,mBAAmB;YACnB,sBAAsB;YACtB,gBAAgB,EAAE,CAAC,EAAU,EAAE,EAAE,CAC/B,MAAM,CAAC,OAAO,CACZ,iCAAiC,CAAC,mBAAmB,EACrD,kDAAkD,EAAE,sBAAsB,IAAI,CAAC,eAAgB,CAAC,MAAM,CAAC,MAAM,GAAG,CACjH;YACH,oBAAoB;YACpB,aAAa,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,iCAAiC,CAAC,mBAAmB,EAAE,6CAA6C,CAAC;SAC1I,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC;YACzC,IAAI,CAAC,4BAA4B,GAAG,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC5F,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,SAAS;QACrB,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YACzB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YACvC,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACnC,CAAC;QACD,IAAI,IAAI,CAAC,4BAA4B,EAAE,CAAC;YACtC,IAAI,CAAC,4BAA4B,EAAE,CAAC;YACpC,IAAI,CAAC,4BAA4B,GAAG,SAAS,CAAC;QAChD,CAAC;QACD,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC3B,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACzB,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;QACrC,CAAC;QACD,UAAU,CAAC,cAAc,CAAC,wBAAwB,CAAC,CAAC;QACpD,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YAChC,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC5B,CAAC;QACD,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC5B,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC5B,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,QAAgB,EAAE,aAAyB;QAC5E,MAAM,OAAO,GACX,YAAY,CAAC,UAAU,IAAI,YAAY,CAAC,UAAU,CAAC,oBAAoB;YACrE,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,oBAAoB,CAAC,QAAQ,EAAE,YAAY,CAAC,UAAU,CAAC;YACjF,CAAC,CAAC,IAAI,mBAAmB,CAAC;gBACtB,GAAG,YAAY,CAAC,UAAU;gBAC1B,iCAAiC;gBACjC,EAAE,EAAE,QAAQ;aACb,CAAC,CAAC;QACT,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;QAC1C,MAAM,CAAC,OAAO,CACZ,iCAAiC,CAAC,mBAAmB,EACrD,mDAAmD,QAAQ,sBAAsB,IAAI,CAAC,eAAgB,CAAC,MAAM,CAAC,MAAM,GAAG,CACxH,CAAC;QACF,OAAO,EAAE,OAAO,EAAE,CAAC;IACrB,CAAC;IAEO,MAAM,CAAC,oBAAoB,CAAC,GAAW,EAAE,SAA0B;QACzE,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,QAAiB;QACxC,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC;QAC/D,CAAC;QACD,MAAM,IAAI,iBAAiB,CAAC,kBAAkB,CAAC,cAAc,EAAE,2EAA2E,CAAC,CAAC;IAC9I,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB;QAC7B,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,IAAI,iBAAiB,CAAC,kBAAkB,CAAC,cAAc,EAAE,2EAA2E,CAAC,CAAC;QAC9I,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC;IACtC,CAAC;IAEO,MAAM,CAAC,cAAc,GAAG,CAAC,MAAmB,EAAE,EAAE;QACtD,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,WAAW,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC,iBAAiB,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACrG,mEAAmE;QACnE,OAAO,CAAC,4BAA4B,CAAC,CAAC,iBAAiB,EAAE,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAC1F,CAAC,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.js\";\r\nimport { PresentationIpcHandler } from \"./PresentationIpcHandler.js\";\r\nimport { PresentationManager, PresentationManagerProps } from \"./PresentationManager.js\";\r\nimport { PresentationRpcImpl } from \"./PresentationRpcImpl.js\";\r\nimport { FactoryBasedTemporaryStorage } from \"./TemporaryStorage.js\";\r\nimport { _presentation_manager_detail } from \"./InternalSymbols.js\";\r\n\r\n/**\r\n * Properties that can be used to configure [[Presentation]] API.\r\n * @public\r\n */\r\nexport interface PresentationProps extends Omit<PresentationManagerProps, \"enableSchemasPreload\"> {\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   * 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\ninterface PresentationInternalProps {\r\n  /**\r\n   * Factory method for creating separate managers for each client\r\n   */\r\n  clientManagerFactory?: (clientId: string, props: PresentationManagerProps) => PresentationManager;\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 * @deprecated in 4.8 - use [[PresentationProps]] instead.\r\n */\r\nexport type MultiManagerPresentationProps = PresentationProps;\r\n\r\n/**\r\n * Base props for initializing the [[Presentation]] library.\r\n *\r\n * @public\r\n * @deprecated in 4.8 - use [[PresentationProps]] instead.\r\n */\r\nexport type PresentationPropsBase = PresentationProps;\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 * @deprecated in 4.8 - use [[PresentationProps]] instead.\r\n */\r\nexport type SingleManagerPresentationProps = Omit<PresentationProps, \"unusedClientLifetime\">;\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  private static _initProps: (PresentationProps & PresentationInternalProps) | 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 _rpcImpl: PresentationRpcImpl | undefined;\r\n\r\n  /* c8 ignore next */\r\n  private constructor() {}\r\n\r\n  /** Properties used to initialize the presentation framework */\r\n  public static get initProps(): PresentationProps | undefined {\r\n    return this._initProps;\r\n  }\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    this._clientsStorage = new FactoryBasedTemporaryStorage<ClientStoreItem>({\r\n      factory: this.createClientManager.bind(this),\r\n      cleanupHandler: (_id, storeItem) => this.disposeClientManager(_id, storeItem),\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      /* c8 ignore next 5 */\r\n      onDisposedSingle: (id: string) =>\r\n        Logger.logInfo(\r\n          PresentationBackendLoggerCategory.PresentationManager,\r\n          `Disposed PresentationManager instance with ID: ${id}. Total instances: ${this._clientsStorage!.values.length}.`,\r\n        ),\r\n      /* c8 ignore next */\r\n      onDisposedAll: () => Logger.logInfo(PresentationBackendLoggerCategory.PresentationManager, `Disposed all PresentationManager instances.`),\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  /**\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[Symbol.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    RpcManager.unregisterImpl(PresentationRpcInterface);\r\n    if (this._rpcImpl) {\r\n      this._rpcImpl[Symbol.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 =\r\n      Presentation._initProps && Presentation._initProps.clientManagerFactory\r\n        ? Presentation._initProps.clientManagerFactory(clientId, Presentation._initProps)\r\n        : new PresentationManager({\r\n            ...Presentation._initProps,\r\n            // @ts-expect-error internal prop\r\n            id: clientId,\r\n          });\r\n    manager.onUsed.addListener(onManagerUsed);\r\n    Logger.logInfo(\r\n      PresentationBackendLoggerCategory.PresentationManager,\r\n      `Created a PresentationManager instance with ID: ${clientId}. Total instances: ${this._clientsStorage!.values.length}.`,\r\n    );\r\n    return { manager };\r\n  }\r\n\r\n  private static disposeClientManager(_id: string, storeItem: ClientStoreItem) {\r\n    storeItem.manager[Symbol.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._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    }\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[_presentation_manager_detail].getNativePlatform().getImodelAddon(imodel);\r\n    // eslint-disable-next-line @typescript-eslint/no-floating-promises\r\n    manager[_presentation_manager_detail].getNativePlatform().forceLoadSchemas(imodelAddon);\r\n  };\r\n}\r\n"]}

package/lib/esm/presentation-backend/PresentationIpcHandler.d.ts

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

package/lib/esm/presentation-backend/PresentationIpcHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PresentationIpcHandler.d.ts","sourceRoot":"","sources":["../../../src/presentation-backend/PresentationIpcHandler.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,OAAO,EAAiC,wBAAwB,EAAE,MAAM,qCAAqC,CAAC;AAG9G,gBAAgB;AAChB,qBAAa,sBAAuB,SAAQ,UAAW,YAAW,wBAAwB;IACjF,WAAW,SAAiC;IAEtC,kBAAkB,CAAC,MAAM,EAAE,UAAU,CAAC,wBAAwB,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAMxG,oBAAoB,CAAC,MAAM,EAAE,UAAU,CAAC,wBAAwB,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAI1H"}

package/lib/esm/presentation-backend/PresentationIpcHandler.js

@@ -0,0 +1,25 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module RPC
+ */
+import { IpcHandler } from "@itwin/core-backend";
+import { RulesetVariable } from "@itwin/presentation-common";
+import { PRESENTATION_IPC_CHANNEL_NAME } from "@itwin/presentation-common/internal";
+import { Presentation } from "./Presentation.js";
+/** @internal */
+export class PresentationIpcHandler extends IpcHandler {
+    channelName = PRESENTATION_IPC_CHANNEL_NAME;
+    async setRulesetVariable(params) {
+        const { clientId, rulesetId, variable } = params;
+        const parsedVariable = RulesetVariable.fromJSON(variable);
+        Presentation.getManager(clientId).vars(rulesetId).setValue(parsedVariable.id, parsedVariable.type, parsedVariable.value);
+    }
+    async unsetRulesetVariable(params) {
+        const { clientId, rulesetId, variableId } = params;
+        Presentation.getManager(clientId).vars(rulesetId).unset(variableId);
+    }
+}
+//# sourceMappingURL=PresentationIpcHandler.js.map

package/lib/esm/presentation-backend/PresentationIpcHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PresentationIpcHandler.js","sourceRoot":"","sources":["../../../src/presentation-backend/PresentationIpcHandler.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,6BAA6B,EAA4B,MAAM,qCAAqC,CAAC;AAC9G,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,gBAAgB;AAChB,MAAM,OAAO,sBAAuB,SAAQ,UAAU;IAC7C,WAAW,GAAG,6BAA6B,CAAC;IAE5C,KAAK,CAAC,kBAAkB,CAAC,MAAqE;QACnG,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QACjD,MAAM,cAAc,GAAG,eAAe,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC1D,YAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,EAAE,cAAc,CAAC,IAAI,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC;IAC3H,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,MAAuE;QACvG,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QACnD,YAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACtE,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 RPC\r\n */\r\n\r\nimport { IpcHandler } from \"@itwin/core-backend\";\r\nimport { RulesetVariable } from \"@itwin/presentation-common\";\r\nimport { PRESENTATION_IPC_CHANNEL_NAME, PresentationIpcInterface } from \"@itwin/presentation-common/internal\";\r\nimport { Presentation } from \"./Presentation.js\";\r\n\r\n/** @internal */\r\nexport class PresentationIpcHandler extends IpcHandler implements PresentationIpcInterface {\r\n  public channelName = PRESENTATION_IPC_CHANNEL_NAME;\r\n\r\n  public async setRulesetVariable(params: Parameters<PresentationIpcInterface[\"setRulesetVariable\"]>[0]): Promise<void> {\r\n    const { clientId, rulesetId, variable } = params;\r\n    const parsedVariable = RulesetVariable.fromJSON(variable);\r\n    Presentation.getManager(clientId).vars(rulesetId).setValue(parsedVariable.id, parsedVariable.type, parsedVariable.value);\r\n  }\r\n\r\n  public async unsetRulesetVariable(params: Parameters<PresentationIpcInterface[\"unsetRulesetVariable\"]>[0]): Promise<void> {\r\n    const { clientId, rulesetId, variableId } = params;\r\n    Presentation.getManager(clientId).vars(rulesetId).unset(variableId);\r\n  }\r\n}\r\n"]}