@itwin/presentation-backend 3.2.0-dev.23 → 3.2.0-dev.24

package/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Change Log - @itwin/presentation-backend
 
-This log was last generated on Thu, 10 Mar 2022 21:18:13 GMT and should not be manually modified.
+This log was last generated on Fri, 25 Mar 2022 15:10:02 GMT and should not be manually modified.
+
+## 3.0.3
+Fri, 25 Mar 2022 15:10:02 GMT
+
+_Version update only_
 
 ## 3.0.2
 Thu, 10 Mar 2022 21:18:13 GMT

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

@@ -70,7 +70,7 @@ export declare class Presentation {
     /**
      * Initializes Presentation library for the backend.
      *
-     * See [this]($docs/presentation/Setup/index.md#backend) for an example.
+     * 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)
      *

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

@@ -36,7 +36,7 @@ class Presentation {
     /**
      * Initializes Presentation library for the backend.
      *
-     * See [this]($docs/presentation/Setup/index.md#backend) for an example.
+     * 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)
      *

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

@@ -1 +1 @@
-{"version":3,"file":"Presentation.js","sourceRoot":"","sources":["../../../src/presentation-backend/Presentation.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA0D;AAC1D,sDAA0D;AAC1D,oDAAgD;AAChD,oEAA6G;AAC7G,mEAA4E;AAC5E,qEAAkE;AAClE,+DAAsF;AACtF,+DAA4D;AAC5D,yDAAkE;AAElE,MAAM,qBAAqB,GAAW,KAAK,CAAC;AAyD5C;;;;;;;;;GASG;AACH,MAAa,YAAY;IASvB,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;IACH,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,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;CACF;AAtHD,oCAsHC;AAED,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 { 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 * 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 PresentationManagerProps {\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   * Time in milliseconds after which the request will timeout.\r\n   */\r\n  requestTimeout?: number;\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 PresentationManagerProps {\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  requestTimeout?: number;\r\n\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 _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 [this]($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\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._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\r\nfunction isSingleManagerProps(props: PresentationProps): props is SingleManagerPresentationProps {\r\n  return !!(props as SingleManagerPresentationProps).useSingleManager;\r\n}\r\n"]}
+{"version":3,"file":"Presentation.js","sourceRoot":"","sources":["../../../src/presentation-backend/Presentation.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA0D;AAC1D,sDAA0D;AAC1D,oDAAgD;AAChD,oEAA6G;AAC7G,mEAA4E;AAC5E,qEAAkE;AAClE,+DAAsF;AACtF,+DAA4D;AAC5D,yDAAkE;AAElE,MAAM,qBAAqB,GAAW,KAAK,CAAC;AAyD5C;;;;;;;;;GASG;AACH,MAAa,YAAY;IASvB,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;IACH,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,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;CACF;AAtHD,oCAsHC;AAED,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 { 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 * 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 PresentationManagerProps {\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   * Time in milliseconds after which the request will timeout.\r\n   */\r\n  requestTimeout?: number;\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 PresentationManagerProps {\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  requestTimeout?: number;\r\n\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 _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\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._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\r\nfunction isSingleManagerProps(props: PresentationProps): props is SingleManagerPresentationProps {\r\n  return !!(props as SingleManagerPresentationProps).useSingleManager;\r\n}\r\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/presentation-backend",
-  "version": "3.2.0-dev.23",
+  "version": "3.2.0-dev.24",
   "description": "Backend of iTwin.js Presentation library",
   "license": "MIT",
   "repository": {
@@ -22,20 +22,20 @@
   "main": "lib/cjs/presentation-backend.js",
   "typings": "lib/cjs/presentation-backend",
   "peerDependencies": {
-    "@itwin/core-backend": "^3.2.0-dev.23",
-    "@itwin/core-bentley": "^3.2.0-dev.23",
-    "@itwin/core-common": "^3.2.0-dev.23",
-    "@itwin/core-quantity": "^3.2.0-dev.23",
-    "@itwin/presentation-common": "^3.2.0-dev.23"
+    "@itwin/core-backend": "^3.2.0-dev.24",
+    "@itwin/core-bentley": "^3.2.0-dev.24",
+    "@itwin/core-common": "^3.2.0-dev.24",
+    "@itwin/core-quantity": "^3.2.0-dev.24",
+    "@itwin/presentation-common": "^3.2.0-dev.24"
   },
   "devDependencies": {
-    "@itwin/build-tools": "3.2.0-dev.23",
-    "@itwin/core-backend": "3.2.0-dev.23",
-    "@itwin/core-bentley": "3.2.0-dev.23",
-    "@itwin/core-common": "3.2.0-dev.23",
-    "@itwin/core-quantity": "3.2.0-dev.23",
-    "@itwin/eslint-plugin": "3.2.0-dev.23",
-    "@itwin/presentation-common": "3.2.0-dev.23",
+    "@itwin/build-tools": "3.2.0-dev.24",
+    "@itwin/core-backend": "3.2.0-dev.24",
+    "@itwin/core-bentley": "3.2.0-dev.24",
+    "@itwin/core-common": "3.2.0-dev.24",
+    "@itwin/core-quantity": "3.2.0-dev.24",
+    "@itwin/eslint-plugin": "3.2.0-dev.24",
+    "@itwin/presentation-common": "3.2.0-dev.24",
     "@types/chai": "^4.1.4",
     "@types/chai-as-promised": "^7",
     "@types/chai-jest-snapshot": "^1.3.0",