@itwin/presentation-backend 3.0.0-dev.100

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

@@ -0,0 +1,86 @@
+/** @packageDocumentation
+ * @module Core
+ */
+import { IModelDb, IModelJsNative } from "@itwin/core-backend";
+import { IDisposable } from "@itwin/core-bentley";
+import { FormatProps } from "@itwin/core-quantity";
+import { DiagnosticsScopeLogs, NodeKeyJSON, UpdateInfoJSON, VariableValue, VariableValueTypes } from "@itwin/presentation-common";
+import { PresentationManagerMode } from "./PresentationManager";
+/** @internal */
+export declare enum NativePlatformRequestTypes {
+    GetRootNodes = "GetRootNodes",
+    GetRootNodesCount = "GetRootNodesCount",
+    GetChildren = "GetChildren",
+    GetChildrenCount = "GetChildrenCount",
+    GetNodePaths = "GetNodePaths",
+    GetFilteredNodePaths = "GetFilteredNodePaths",
+    GetContentSources = "GetContentSources",
+    GetContentDescriptor = "GetContentDescriptor",
+    GetContentSetSize = "GetContentSetSize",
+    GetContent = "GetContent",
+    GetDistinctValues = "GetDistinctValues",
+    GetPagedDistinctValues = "GetPagedDistinctValues",
+    GetDisplayLabel = "GetDisplayLabel",
+    CompareHierarchies = "CompareHierarchies"
+}
+/**
+ * Enumeration of unit systems supported by native presentation manager.
+ * @internal
+ */
+export declare enum NativePresentationUnitSystem {
+    Metric = "metric",
+    BritishImperial = "british-imperial",
+    UsCustomary = "us-customary",
+    UsSurvey = "us-survey"
+}
+/** @internal */
+export interface NativePresentationDefaultUnitFormats {
+    [phenomenon: string]: {
+        unitSystems: NativePresentationUnitSystem[];
+        format: FormatProps;
+    };
+}
+/** @internal */
+export interface NativePresentationKeySetJSON {
+    instanceKeys: Array<[string, string[]]>;
+    nodeKeys: NodeKeyJSON[];
+}
+/** @internal */
+export interface NativePlatformResponse<TResult> {
+    result: TResult;
+    diagnostics?: DiagnosticsScopeLogs;
+}
+/** @internal */
+export interface NativePlatformDefinition extends IDisposable {
+    getImodelAddon(imodel: IModelDb): any;
+    setupRulesetDirectories(directories: string[]): NativePlatformResponse<void>;
+    setupSupplementalRulesetDirectories(directories: string[]): NativePlatformResponse<void>;
+    forceLoadSchemas(db: any): Promise<NativePlatformResponse<void>>;
+    getRulesets(rulesetId: string): NativePlatformResponse<string>;
+    addRuleset(serializedRulesetJson: string): NativePlatformResponse<string>;
+    removeRuleset(rulesetId: string, hash: string): NativePlatformResponse<boolean>;
+    clearRulesets(): NativePlatformResponse<void>;
+    handleRequest(db: any, options: string): Promise<NativePlatformResponse<string>>;
+    getRulesetVariableValue(rulesetId: string, variableId: string, type: VariableValueTypes): NativePlatformResponse<VariableValue>;
+    setRulesetVariableValue(rulesetId: string, variableId: string, type: VariableValueTypes, value: VariableValue): NativePlatformResponse<void>;
+    unsetRulesetVariableValue(rulesetId: string, variableId: string): NativePlatformResponse<void>;
+    getUpdateInfo(): NativePlatformResponse<UpdateInfoJSON | undefined>;
+    updateHierarchyState(db: any, rulesetId: string, changeType: "nodesExpanded" | "nodesCollapsed", serializedKeys: string): NativePlatformResponse<void>;
+}
+/** @internal */
+export interface DefaultNativePlatformProps {
+    id: string;
+    localeDirectories: string[];
+    taskAllocationsMap: {
+        [priority: number]: number;
+    };
+    mode: PresentationManagerMode;
+    isChangeTrackingEnabled: boolean;
+    cacheConfig?: IModelJsNative.ECPresentationHierarchyCacheConfig;
+    contentCacheSize?: number;
+    defaultFormats?: NativePresentationDefaultUnitFormats;
+    useMmap?: boolean | number;
+}
+/** @internal */
+export declare const createDefaultNativePlatform: (props: DefaultNativePlatformProps) => new () => NativePlatformDefinition;
+//# sourceMappingURL=NativePlatform.d.ts.map

package/lib/cjs/presentation-backend/NativePlatform.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NativePlatform.d.ts","sourceRoot":"","sources":["../../../src/presentation-backend/NativePlatform.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAc,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EACL,oBAAoB,EAAE,WAAW,EAAyC,cAAc,EAAE,aAAa,EAAqB,kBAAkB,EAC/I,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAsB,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAEpF,gBAAgB;AAChB,oBAAY,0BAA0B;IACpC,YAAY,iBAAiB;IAC7B,iBAAiB,sBAAsB;IACvC,WAAW,gBAAgB;IAC3B,gBAAgB,qBAAqB;IACrC,YAAY,iBAAiB;IAC7B,oBAAoB,yBAAyB;IAC7C,iBAAiB,sBAAsB;IACvC,oBAAoB,yBAAyB;IAC7C,iBAAiB,sBAAsB;IACvC,UAAU,eAAe;IACzB,iBAAiB,sBAAsB;IACvC,sBAAsB,2BAA2B;IACjD,eAAe,oBAAoB;IACnC,kBAAkB,uBAAuB;CAC1C;AAED;;;GAGG;AACH,oBAAY,4BAA4B;IACtC,MAAM,WAAW;IACjB,eAAe,qBAAqB;IACpC,WAAW,iBAAiB;IAC5B,QAAQ,cAAc;CACvB;AAED,gBAAgB;AAChB,MAAM,WAAW,oCAAoC;IACnD,CAAC,UAAU,EAAE,MAAM,GAAG;QACpB,WAAW,EAAE,4BAA4B,EAAE,CAAC;QAC5C,MAAM,EAAE,WAAW,CAAC;KACrB,CAAC;CACH;AAED,gBAAgB;AAChB,MAAM,WAAW,4BAA4B;IAC3C,YAAY,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IACxC,QAAQ,EAAE,WAAW,EAAE,CAAC;CACzB;AAED,gBAAgB;AAChB,MAAM,WAAW,sBAAsB,CAAC,OAAO;IAC7C,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,oBAAoB,CAAC;CACpC;AAED,gBAAgB;AAChB,MAAM,WAAW,wBAAyB,SAAQ,WAAW;IAC3D,cAAc,CAAC,MAAM,EAAE,QAAQ,GAAG,GAAG,CAAC;IAEtC,uBAAuB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAC7E,mCAAmC,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAEzF,gBAAgB,CAAC,EAAE,EAAE,GAAG,GAAG,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC;IAEjE,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAC/D,UAAU,CAAC,qBAAqB,EAAE,MAAM,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAC1E,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAC;IAChF,aAAa,IAAI,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAE9C,aAAa,CAAC,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC,CAAC;IAEjF,uBAAuB,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,GAAG,sBAAsB,CAAC,aAAa,CAAC,CAAC;IAChI,uBAAuB,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,KAAK,EAAE,aAAa,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAC7I,yBAAyB,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAE/F,aAAa,IAAI,sBAAsB,CAAC,cAAc,GAAG,SAAS,CAAC,CAAC;IACpE,oBAAoB,CAAC,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,GAAG,gBAAgB,EAAE,cAAc,EAAE,MAAM,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC;CACxJ;AAED,gBAAgB;AAChB,MAAM,WAAW,0BAA0B;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,kBAAkB,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACnD,IAAI,EAAE,uBAAuB,CAAC;IAC9B,uBAAuB,EAAE,OAAO,CAAC;IACjC,WAAW,CAAC,EAAE,cAAc,CAAC,kCAAkC,CAAC;IAChE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,cAAc,CAAC,EAAE,oCAAoC,CAAC;IACtD,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;CAC5B;AAED,gBAAgB;AAChB,eAAO,MAAM,2BAA2B,UAAW,0BAA0B,KAAG,UAAU,wBAiHzF,CAAC"}

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

@@ -0,0 +1,153 @@
+"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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDefaultNativePlatform = exports.NativePresentationUnitSystem = exports.NativePlatformRequestTypes = void 0;
+const core_backend_1 = require("@itwin/core-backend");
+const presentation_common_1 = require("@itwin/presentation-common");
+const PresentationManager_1 = require("./PresentationManager");
+/** @internal */
+var NativePlatformRequestTypes;
+(function (NativePlatformRequestTypes) {
+    NativePlatformRequestTypes["GetRootNodes"] = "GetRootNodes";
+    NativePlatformRequestTypes["GetRootNodesCount"] = "GetRootNodesCount";
+    NativePlatformRequestTypes["GetChildren"] = "GetChildren";
+    NativePlatformRequestTypes["GetChildrenCount"] = "GetChildrenCount";
+    NativePlatformRequestTypes["GetNodePaths"] = "GetNodePaths";
+    NativePlatformRequestTypes["GetFilteredNodePaths"] = "GetFilteredNodePaths";
+    NativePlatformRequestTypes["GetContentSources"] = "GetContentSources";
+    NativePlatformRequestTypes["GetContentDescriptor"] = "GetContentDescriptor";
+    NativePlatformRequestTypes["GetContentSetSize"] = "GetContentSetSize";
+    NativePlatformRequestTypes["GetContent"] = "GetContent";
+    NativePlatformRequestTypes["GetDistinctValues"] = "GetDistinctValues";
+    NativePlatformRequestTypes["GetPagedDistinctValues"] = "GetPagedDistinctValues";
+    NativePlatformRequestTypes["GetDisplayLabel"] = "GetDisplayLabel";
+    NativePlatformRequestTypes["CompareHierarchies"] = "CompareHierarchies";
+})(NativePlatformRequestTypes = exports.NativePlatformRequestTypes || (exports.NativePlatformRequestTypes = {}));
+/**
+ * Enumeration of unit systems supported by native presentation manager.
+ * @internal
+ */
+var NativePresentationUnitSystem;
+(function (NativePresentationUnitSystem) {
+    NativePresentationUnitSystem["Metric"] = "metric";
+    NativePresentationUnitSystem["BritishImperial"] = "british-imperial";
+    NativePresentationUnitSystem["UsCustomary"] = "us-customary";
+    NativePresentationUnitSystem["UsSurvey"] = "us-survey";
+})(NativePresentationUnitSystem = exports.NativePresentationUnitSystem || (exports.NativePresentationUnitSystem = {}));
+/** @internal */
+const createDefaultNativePlatform = (props) => {
+    // note the implementation is constructed here to make PresentationManager
+    // usable without loading the actual addon (if addon is set to something other)
+    return class {
+        constructor() {
+            var _a;
+            const mode = (props.mode === PresentationManager_1.PresentationManagerMode.ReadOnly) ? "ro" /* ReadOnly */ : "rw" /* ReadWrite */;
+            const cacheConfig = (_a = props.cacheConfig) !== null && _a !== void 0 ? _a : { mode: PresentationManager_1.HierarchyCacheMode.Disk, directory: "" };
+            const defaultFormats = props.defaultFormats ? this.getSerializedDefaultFormatsMap(props.defaultFormats) : {};
+            this._nativeAddon = new core_backend_1.IModelHost.platform.ECPresentationManager({ ...props, mode, cacheConfig, defaultFormats });
+        }
+        getStatus(responseStatus) {
+            switch (responseStatus) {
+                case 65537 /* InvalidArgument */: return presentation_common_1.PresentationStatus.InvalidArgument;
+                case 1 /* Canceled */: return presentation_common_1.PresentationStatus.Canceled;
+                default: return presentation_common_1.PresentationStatus.Error;
+            }
+        }
+        getSerializedDefaultFormatsMap(defaultMap) {
+            const res = {};
+            Object.keys(defaultMap).forEach((key) => {
+                const value = defaultMap[key];
+                res[key] = { unitSystems: value.unitSystems, serializedFormat: JSON.stringify(value.format) };
+            });
+            return res;
+        }
+        createSuccessResponse(response) {
+            const retValue = { result: response.result };
+            if (response.diagnostics)
+                retValue.diagnostics = response.diagnostics;
+            return retValue;
+        }
+        handleResult(response) {
+            if (response.error)
+                throw new presentation_common_1.PresentationError(this.getStatus(response.error.status), response.error.message);
+            return this.createSuccessResponse(response);
+        }
+        handleVoidResult(response) {
+            if (response.error)
+                throw new presentation_common_1.PresentationError(this.getStatus(response.error.status), response.error.message);
+            return this.createSuccessResponse(response);
+        }
+        dispose() {
+            this._nativeAddon.dispose();
+        }
+        async forceLoadSchemas(db) {
+            const response = await this._nativeAddon.forceLoadSchemas(db);
+            if (response.error)
+                throw new presentation_common_1.PresentationError(presentation_common_1.PresentationStatus.Error, response.error.message);
+            return this.createSuccessResponse(response);
+        }
+        setupRulesetDirectories(directories) {
+            return this.handleVoidResult(this._nativeAddon.setupRulesetDirectories(directories));
+        }
+        setupSupplementalRulesetDirectories(directories) {
+            return this.handleVoidResult(this._nativeAddon.setupSupplementalRulesetDirectories(directories));
+        }
+        getImodelAddon(imodel) {
+            if (!imodel.nativeDb)
+                throw new presentation_common_1.PresentationError(presentation_common_1.PresentationStatus.InvalidArgument, "imodel");
+            return imodel.nativeDb;
+        }
+        getRulesets(rulesetId) {
+            return this.handleResult(this._nativeAddon.getRulesets(rulesetId));
+        }
+        addRuleset(serializedRulesetJson) {
+            return this.handleResult(this._nativeAddon.addRuleset(serializedRulesetJson));
+        }
+        removeRuleset(rulesetId, hash) {
+            return this.handleResult(this._nativeAddon.removeRuleset(rulesetId, hash));
+        }
+        clearRulesets() {
+            return this.handleVoidResult(this._nativeAddon.clearRulesets());
+        }
+        async handleRequest(db, options) {
+            const requestGuid = this.handleResult(this._nativeAddon.queueRequest(db, options)).result;
+            return new Promise((resolve, reject) => {
+                const interval = setInterval(() => {
+                    const pollResult = this._nativeAddon.pollResponse(requestGuid);
+                    if (pollResult.error) {
+                        if (pollResult.error.status !== 2 /* Pending */) {
+                            reject(new presentation_common_1.PresentationError(this.getStatus(pollResult.error.status), pollResult.error.message));
+                            clearInterval(interval);
+                        }
+                        return; // ignore 'pending' responses
+                    }
+                    resolve(this.createSuccessResponse(pollResult));
+                    clearInterval(interval);
+                }, 20);
+            });
+        }
+        getRulesetVariableValue(rulesetId, variableId, type) {
+            return this.handleResult(this._nativeAddon.getRulesetVariableValue(rulesetId, variableId, type));
+        }
+        setRulesetVariableValue(rulesetId, variableId, type, value) {
+            return this.handleVoidResult(this._nativeAddon.setRulesetVariableValue(rulesetId, variableId, type, value));
+        }
+        unsetRulesetVariableValue(rulesetId, variableId) {
+            return this.handleVoidResult(this._nativeAddon.unsetRulesetVariableValue(rulesetId, variableId));
+        }
+        getUpdateInfo() {
+            return this.handleResult(this._nativeAddon.getUpdateInfo());
+        }
+        updateHierarchyState(db, rulesetId, changeType, serializedKeys) {
+            return this.handleResult(this._nativeAddon.updateHierarchyState(db, rulesetId, changeType, serializedKeys));
+        }
+    };
+};
+exports.createDefaultNativePlatform = createDefaultNativePlatform;
+//# sourceMappingURL=NativePlatform.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"NativePlatform.js","sourceRoot":"","sources":["../../../src/presentation-backend/NativePlatform.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA2E;AAG3E,oEAEoC;AACpC,+DAAoF;AAEpF,gBAAgB;AAChB,IAAY,0BAeX;AAfD,WAAY,0BAA0B;IACpC,2DAA6B,CAAA;IAC7B,qEAAuC,CAAA;IACvC,yDAA2B,CAAA;IAC3B,mEAAqC,CAAA;IACrC,2DAA6B,CAAA;IAC7B,2EAA6C,CAAA;IAC7C,qEAAuC,CAAA;IACvC,2EAA6C,CAAA;IAC7C,qEAAuC,CAAA;IACvC,uDAAyB,CAAA;IACzB,qEAAuC,CAAA;IACvC,+EAAiD,CAAA;IACjD,iEAAmC,CAAA;IACnC,uEAAyC,CAAA;AAC3C,CAAC,EAfW,0BAA0B,GAA1B,kCAA0B,KAA1B,kCAA0B,QAerC;AAED;;;GAGG;AACH,IAAY,4BAKX;AALD,WAAY,4BAA4B;IACtC,iDAAiB,CAAA;IACjB,oEAAoC,CAAA;IACpC,4DAA4B,CAAA;IAC5B,sDAAsB,CAAA;AACxB,CAAC,EALW,4BAA4B,GAA5B,oCAA4B,KAA5B,oCAA4B,QAKvC;AA2DD,gBAAgB;AACT,MAAM,2BAA2B,GAAG,CAAC,KAAiC,EAAsC,EAAE;IACnH,0EAA0E;IAC1E,+EAA+E;IAC/E,OAAO;QAEL;;YACE,MAAM,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,6CAAuB,CAAC,QAAQ,CAAC,CAAC,CAAC,qBAAmD,CAAC,qBAAmD,CAAC;YACxK,MAAM,WAAW,GAAG,MAAA,KAAK,CAAC,WAAW,mCAAI,EAAE,IAAI,EAAE,wCAAkB,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;YAC1F,MAAM,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,8BAA8B,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7G,IAAI,CAAC,YAAY,GAAG,IAAI,yBAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;QACrH,CAAC;QACO,SAAS,CAAC,cAAmD;YACnE,QAAQ,cAAc,EAAE;gBACtB,gCAAwD,CAAC,CAAC,OAAO,wCAAkB,CAAC,eAAe,CAAC;gBACpG,qBAAiD,CAAC,CAAC,OAAO,wCAAkB,CAAC,QAAQ,CAAC;gBACtF,OAAO,CAAC,CAAC,OAAO,wCAAkB,CAAC,KAAK,CAAC;aAC1C;QACH,CAAC;QACO,8BAA8B,CAAC,UAAgD;YACrF,MAAM,GAAG,GAKL,EAAE,CAAC;YACP,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBACtC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;gBAC9B,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YAChG,CAAC,CAAC,CAAC;YAEH,OAAO,GAAG,CAAC;QACb,CAAC;QACO,qBAAqB,CAAI,QAAyD;YACxF,MAAM,QAAQ,GAA8B,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAO,EAAE,CAAC;YACzE,IAAI,QAAQ,CAAC,WAAW;gBACtB,QAAQ,CAAC,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;YAC9C,OAAO,QAAQ,CAAC;QAClB,CAAC;QACO,YAAY,CAAI,QAAyD;YAC/E,IAAI,QAAQ,CAAC,KAAK;gBAChB,MAAM,IAAI,uCAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC7F,OAAO,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;QAC9C,CAAC;QACO,gBAAgB,CAAC,QAA4D;YACnF,IAAI,QAAQ,CAAC,KAAK;gBAChB,MAAM,IAAI,uCAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC7F,OAAO,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;QAC9C,CAAC;QACM,OAAO;YACZ,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;QAC9B,CAAC;QACM,KAAK,CAAC,gBAAgB,CAAC,EAAO;YACnC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;YAC9D,IAAI,QAAQ,CAAC,KAAK;gBAChB,MAAM,IAAI,uCAAiB,CAAC,wCAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAChF,OAAO,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;QAC9C,CAAC;QACM,uBAAuB,CAAC,WAAqB;YAClD,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC,CAAC;QACvF,CAAC;QACM,mCAAmC,CAAC,WAAqB;YAC9D,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,mCAAmC,CAAC,WAAW,CAAC,CAAC,CAAC;QACnG,CAAC;QACM,cAAc,CAAC,MAAgB;YACpC,IAAI,CAAC,MAAM,CAAC,QAAQ;gBAClB,MAAM,IAAI,uCAAiB,CAAC,wCAAkB,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;YAC5E,OAAO,MAAM,CAAC,QAAQ,CAAC;QACzB,CAAC;QACM,WAAW,CAAC,SAAiB;YAClC,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;QACrE,CAAC;QACM,UAAU,CAAC,qBAA6B;YAC7C,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC,CAAC;QAChF,CAAC;QACM,aAAa,CAAC,SAAiB,EAAE,IAAY;YAClD,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;QAC7E,CAAC;QACM,aAAa;YAClB,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC,CAAC;QAClE,CAAC;QACM,KAAK,CAAC,aAAa,CAAC,EAAO,EAAE,OAAe;YACjD,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;YAC1F,OAAO,IAAI,OAAO,CAAC,CAAC,OAAsD,EAAE,MAAM,EAAE,EAAE;gBACpF,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,EAAE;oBAChC,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;oBAC/D,IAAI,UAAU,CAAC,KAAK,EAAE;wBACpB,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,oBAAgD,EAAE;4BAC3E,MAAM,CAAC,IAAI,uCAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;4BACjG,aAAa,CAAC,QAAQ,CAAC,CAAC;yBACzB;wBACD,OAAO,CAAC,6BAA6B;qBACtC;oBACD,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC,CAAC;oBAChD,aAAa,CAAC,QAAQ,CAAC,CAAC;gBAC1B,CAAC,EAAE,EAAE,CAAC,CAAC;YACT,CAAC,CAAC,CAAC;QACL,CAAC;QACM,uBAAuB,CAAC,SAAiB,EAAE,UAAkB,EAAE,IAAwB;YAC5F,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,uBAAuB,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC;QACnG,CAAC;QACM,uBAAuB,CAAC,SAAiB,EAAE,UAAkB,EAAE,IAAwB,EAAE,KAAwB;YACtH,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,uBAAuB,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QAC9G,CAAC;QACM,yBAAyB,CAAC,SAAiB,EAAE,UAAkB;YACpE,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,yBAAyB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC;QACnG,CAAC;QACM,aAAa;YAClB,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC,CAAC;QAC9D,CAAC;QACM,oBAAoB,CAAC,EAAO,EAAE,SAAiB,EAAE,UAA8C,EAAE,cAAsB;YAC5H,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,EAAE,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC,CAAC;QAC9G,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAjHW,QAAA,2BAA2B,+BAiHtC","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 { IModelDb, IModelHost, IModelJsNative } from \"@itwin/core-backend\";\r\nimport { IDisposable } from \"@itwin/core-bentley\";\r\nimport { FormatProps } from \"@itwin/core-quantity\";\r\nimport {\r\n  DiagnosticsScopeLogs, NodeKeyJSON, PresentationError, PresentationStatus, UpdateInfoJSON, VariableValue, VariableValueJSON, VariableValueTypes,\r\n} from \"@itwin/presentation-common\";\r\nimport { HierarchyCacheMode, PresentationManagerMode } from \"./PresentationManager\";\r\n\r\n/** @internal */\r\nexport enum NativePlatformRequestTypes {\r\n  GetRootNodes = \"GetRootNodes\",\r\n  GetRootNodesCount = \"GetRootNodesCount\",\r\n  GetChildren = \"GetChildren\",\r\n  GetChildrenCount = \"GetChildrenCount\",\r\n  GetNodePaths = \"GetNodePaths\",\r\n  GetFilteredNodePaths = \"GetFilteredNodePaths\",\r\n  GetContentSources = \"GetContentSources\",\r\n  GetContentDescriptor = \"GetContentDescriptor\",\r\n  GetContentSetSize = \"GetContentSetSize\",\r\n  GetContent = \"GetContent\",\r\n  GetDistinctValues = \"GetDistinctValues\",\r\n  GetPagedDistinctValues = \"GetPagedDistinctValues\",\r\n  GetDisplayLabel = \"GetDisplayLabel\",\r\n  CompareHierarchies = \"CompareHierarchies\",\r\n}\r\n\r\n/**\r\n * Enumeration of unit systems supported by native presentation manager.\r\n * @internal\r\n */\r\nexport enum NativePresentationUnitSystem {\r\n  Metric = \"metric\",\r\n  BritishImperial = \"british-imperial\",\r\n  UsCustomary = \"us-customary\",\r\n  UsSurvey = \"us-survey\",\r\n}\r\n\r\n/** @internal */\r\nexport interface NativePresentationDefaultUnitFormats {\r\n  [phenomenon: string]: {\r\n    unitSystems: NativePresentationUnitSystem[];\r\n    format: FormatProps;\r\n  };\r\n}\r\n\r\n/** @internal */\r\nexport interface NativePresentationKeySetJSON {\r\n  instanceKeys: Array<[string, string[]]>;\r\n  nodeKeys: NodeKeyJSON[];\r\n}\r\n\r\n/** @internal */\r\nexport interface NativePlatformResponse<TResult> {\r\n  result: TResult;\r\n  diagnostics?: DiagnosticsScopeLogs;\r\n}\r\n\r\n/** @internal */\r\nexport interface NativePlatformDefinition extends IDisposable {\r\n  getImodelAddon(imodel: IModelDb): any;\r\n\r\n  setupRulesetDirectories(directories: string[]): NativePlatformResponse<void>;\r\n  setupSupplementalRulesetDirectories(directories: string[]): NativePlatformResponse<void>;\r\n\r\n  forceLoadSchemas(db: any): Promise<NativePlatformResponse<void>>;\r\n\r\n  getRulesets(rulesetId: string): NativePlatformResponse<string>;\r\n  addRuleset(serializedRulesetJson: string): NativePlatformResponse<string>;\r\n  removeRuleset(rulesetId: string, hash: string): NativePlatformResponse<boolean>;\r\n  clearRulesets(): NativePlatformResponse<void>;\r\n\r\n  handleRequest(db: any, options: string): Promise<NativePlatformResponse<string>>;\r\n\r\n  getRulesetVariableValue(rulesetId: string, variableId: string, type: VariableValueTypes): NativePlatformResponse<VariableValue>;\r\n  setRulesetVariableValue(rulesetId: string, variableId: string, type: VariableValueTypes, value: VariableValue): NativePlatformResponse<void>;\r\n  unsetRulesetVariableValue(rulesetId: string, variableId: string): NativePlatformResponse<void>;\r\n\r\n  getUpdateInfo(): NativePlatformResponse<UpdateInfoJSON | undefined>;\r\n  updateHierarchyState(db: any, rulesetId: string, changeType: \"nodesExpanded\" | \"nodesCollapsed\", serializedKeys: string): NativePlatformResponse<void>;\r\n}\r\n\r\n/** @internal */\r\nexport interface DefaultNativePlatformProps {\r\n  id: string;\r\n  localeDirectories: string[];\r\n  taskAllocationsMap: { [priority: number]: number };\r\n  mode: PresentationManagerMode;\r\n  isChangeTrackingEnabled: boolean;\r\n  cacheConfig?: IModelJsNative.ECPresentationHierarchyCacheConfig;\r\n  contentCacheSize?: number;\r\n  defaultFormats?: NativePresentationDefaultUnitFormats;\r\n  useMmap?: boolean | number;\r\n}\r\n\r\n/** @internal */\r\nexport const createDefaultNativePlatform = (props: DefaultNativePlatformProps): new () => NativePlatformDefinition => {\r\n  // note the implementation is constructed here to make PresentationManager\r\n  // usable without loading the actual addon (if addon is set to something other)\r\n  return class implements NativePlatformDefinition {\r\n    private _nativeAddon: IModelJsNative.ECPresentationManager;\r\n    public constructor() {\r\n      const mode = (props.mode === PresentationManagerMode.ReadOnly) ? IModelJsNative.ECPresentationManagerMode.ReadOnly : IModelJsNative.ECPresentationManagerMode.ReadWrite;\r\n      const cacheConfig = props.cacheConfig ?? { mode: HierarchyCacheMode.Disk, directory: \"\" };\r\n      const defaultFormats = props.defaultFormats ? this.getSerializedDefaultFormatsMap(props.defaultFormats) : {};\r\n      this._nativeAddon = new IModelHost.platform.ECPresentationManager({ ...props, mode, cacheConfig, defaultFormats });\r\n    }\r\n    private getStatus(responseStatus: IModelJsNative.ECPresentationStatus): PresentationStatus {\r\n      switch (responseStatus) {\r\n        case IModelJsNative.ECPresentationStatus.InvalidArgument: return PresentationStatus.InvalidArgument;\r\n        case IModelJsNative.ECPresentationStatus.Canceled: return PresentationStatus.Canceled;\r\n        default: return PresentationStatus.Error;\r\n      }\r\n    }\r\n    private getSerializedDefaultFormatsMap(defaultMap: NativePresentationDefaultUnitFormats) {\r\n      const res: {\r\n        [phenomenon: string]: {\r\n          unitSystems: string[];\r\n          serializedFormat: string;\r\n        };\r\n      } = {};\r\n      Object.keys(defaultMap).forEach((key) => {\r\n        const value = defaultMap[key];\r\n        res[key] = { unitSystems: value.unitSystems, serializedFormat: JSON.stringify(value.format) };\r\n      });\r\n\r\n      return res;\r\n    }\r\n    private createSuccessResponse<T>(response: IModelJsNative.ECPresentationManagerResponse<T>): NativePlatformResponse<T> {\r\n      const retValue: NativePlatformResponse<T> = { result: response.result! };\r\n      if (response.diagnostics)\r\n        retValue.diagnostics = response.diagnostics;\r\n      return retValue;\r\n    }\r\n    private handleResult<T>(response: IModelJsNative.ECPresentationManagerResponse<T>): NativePlatformResponse<T> {\r\n      if (response.error)\r\n        throw new PresentationError(this.getStatus(response.error.status), response.error.message);\r\n      return this.createSuccessResponse(response);\r\n    }\r\n    private handleVoidResult(response: IModelJsNative.ECPresentationManagerResponse<void>): NativePlatformResponse<void> {\r\n      if (response.error)\r\n        throw new PresentationError(this.getStatus(response.error.status), response.error.message);\r\n      return this.createSuccessResponse(response);\r\n    }\r\n    public dispose() {\r\n      this._nativeAddon.dispose();\r\n    }\r\n    public async forceLoadSchemas(db: any): Promise<NativePlatformResponse<void>> {\r\n      const response = await this._nativeAddon.forceLoadSchemas(db);\r\n      if (response.error)\r\n        throw new PresentationError(PresentationStatus.Error, response.error.message);\r\n      return this.createSuccessResponse(response);\r\n    }\r\n    public setupRulesetDirectories(directories: string[]) {\r\n      return this.handleVoidResult(this._nativeAddon.setupRulesetDirectories(directories));\r\n    }\r\n    public setupSupplementalRulesetDirectories(directories: string[]) {\r\n      return this.handleVoidResult(this._nativeAddon.setupSupplementalRulesetDirectories(directories));\r\n    }\r\n    public getImodelAddon(imodel: IModelDb): any {\r\n      if (!imodel.nativeDb)\r\n        throw new PresentationError(PresentationStatus.InvalidArgument, \"imodel\");\r\n      return imodel.nativeDb;\r\n    }\r\n    public getRulesets(rulesetId: string) {\r\n      return this.handleResult(this._nativeAddon.getRulesets(rulesetId));\r\n    }\r\n    public addRuleset(serializedRulesetJson: string) {\r\n      return this.handleResult(this._nativeAddon.addRuleset(serializedRulesetJson));\r\n    }\r\n    public removeRuleset(rulesetId: string, hash: string) {\r\n      return this.handleResult(this._nativeAddon.removeRuleset(rulesetId, hash));\r\n    }\r\n    public clearRulesets() {\r\n      return this.handleVoidResult(this._nativeAddon.clearRulesets());\r\n    }\r\n    public async handleRequest(db: any, options: string) {\r\n      const requestGuid = this.handleResult(this._nativeAddon.queueRequest(db, options)).result;\r\n      return new Promise((resolve: (result: NativePlatformResponse<any>) => void, reject) => {\r\n        const interval = setInterval(() => {\r\n          const pollResult = this._nativeAddon.pollResponse(requestGuid);\r\n          if (pollResult.error) {\r\n            if (pollResult.error.status !== IModelJsNative.ECPresentationStatus.Pending) {\r\n              reject(new PresentationError(this.getStatus(pollResult.error.status), pollResult.error.message));\r\n              clearInterval(interval);\r\n            }\r\n            return; // ignore 'pending' responses\r\n          }\r\n          resolve(this.createSuccessResponse(pollResult));\r\n          clearInterval(interval);\r\n        }, 20);\r\n      });\r\n    }\r\n    public getRulesetVariableValue(rulesetId: string, variableId: string, type: VariableValueTypes) {\r\n      return this.handleResult(this._nativeAddon.getRulesetVariableValue(rulesetId, variableId, type));\r\n    }\r\n    public setRulesetVariableValue(rulesetId: string, variableId: string, type: VariableValueTypes, value: VariableValueJSON) {\r\n      return this.handleVoidResult(this._nativeAddon.setRulesetVariableValue(rulesetId, variableId, type, value));\r\n    }\r\n    public unsetRulesetVariableValue(rulesetId: string, variableId: string) {\r\n      return this.handleVoidResult(this._nativeAddon.unsetRulesetVariableValue(rulesetId, variableId));\r\n    }\r\n    public getUpdateInfo() {\r\n      return this.handleResult(this._nativeAddon.getUpdateInfo());\r\n    }\r\n    public updateHierarchyState(db: any, rulesetId: string, changeType: \"nodesExpanded\" | \"nodesCollapsed\", serializedKeys: string) {\r\n      return this.handleResult(this._nativeAddon.updateHierarchyState(db, rulesetId, changeType, serializedKeys));\r\n    }\r\n  };\r\n};\r\n"]}

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

@@ -0,0 +1,98 @@
+/** @packageDocumentation
+ * @module Core
+ */
+import { PresentationManager, PresentationManagerProps } from "./PresentationManager";
+/**
+ * Props for initializing the [[Presentation]] library for using multiple [[PresentationManager]]
+ * instances, one for each frontend.
+ *
+ * @public
+ */
+export interface MultiManagerPresentationProps extends PresentationManagerProps {
+    /**
+     * Factory method for creating separate managers for each client
+     * @internal
+     */
+    clientManagerFactory?: (clientId: string, props: PresentationManagerProps) => PresentationManager;
+    /**
+     * Time in milliseconds after which the request will timeout.
+     */
+    requestTimeout?: number;
+    /**
+     * 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 PresentationManagerProps {
+    /**
+     * How much time should an unused client manager be stored in memory
+     * before it's disposed.
+     */
+    requestTimeout?: number;
+    /**
+     * 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 _requestTimeout;
+    private static _disposeIpcHandler;
+    private static _shutdownListener;
+    private static _manager;
+    private constructor();
+    /** Properties used to initialize the presentation framework */
+    static get initProps(): PresentationProps | undefined;
+    /**
+     * Initializes Presentation library for the backend.
+     *
+     * See [this]($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;
+}
+//# sourceMappingURL=Presentation.d.ts.map

package/lib/cjs/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,uBAAuB,CAAC;AAMtF;;;;;GAKG;AACH,MAAM,WAAW,6BAA8B,SAAQ,wBAAwB;IAC7E;;;OAGG;IACH,oBAAoB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,wBAAwB,KAAK,mBAAmB,CAAC;IAElG;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;GAKG;AACH,MAAM,WAAW,8BAA+B,SAAQ,wBAAwB;IAC9E;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;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,CAAgD;IAC9E,OAAO,CAAC,MAAM,CAAC,eAAe,CAAqB;IACnD,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAA0B;IAC3D,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAA0B;IAC1D,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;IA6BzD;;;OAGG;WACW,SAAS,IAAI,IAAI;IAsB/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;CAK1C"}

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

@@ -0,0 +1,135 @@
+"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
+ */
+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 [this]($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 _a;
+        core_common_1.RpcManager.registerImpl(presentation_common_1.PresentationRpcInterface, PresentationRpcImpl_1.PresentationRpcImpl);
+        if (core_backend_1.IpcHost.isValid) {
+            this._disposeIpcHandler = PresentationIpcHandler_1.PresentationIpcHandler.register();
+        }
+        this._initProps = props || {};
+        this._shutdownListener = core_backend_1.IModelHost.onBeforeShutdown.addListener(() => Presentation.terminate());
+        this._requestTimeout = (props && props.requestTimeout !== undefined)
+            ? props.requestTimeout
+            : defaultRequestTimeout;
+        if (isSingleManagerProps(this._initProps)) {
+            this._manager = new PresentationManager_1.PresentationManager(Presentation._initProps);
+        }
+        else {
+            this._clientsStorage = new TemporaryStorage_1.TemporaryStorage({
+                factory: this.createClientManager,
+                cleanupHandler: this.disposeClientManager,
+                // cleanup unused managers every minute
+                cleanupInterval: 60 * 1000,
+                // by default, manager is disposed after 1 hour of being unused
+                valueLifetime: (_a = this._initProps.unusedClientLifetime) !== null && _a !== void 0 ? _a : 60 * 60 * 1000,
+                // add some logging
+                onCreated: /* istanbul ignore next */ (id) => { var _a; return core_bentley_1.Logger.logInfo(BackendLoggerCategory_1.PresentationBackendLoggerCategory.PresentationManager, `Created a PresentationManager instance with ID: ${id}. Total instances: ${(_a = this._clientsStorage) === null || _a === void 0 ? void 0 : _a.values.length}.`); },
+                onDisposedSingle: /* istanbul ignore next */ (id) => { var _a; return core_bentley_1.Logger.logInfo(BackendLoggerCategory_1.PresentationBackendLoggerCategory.PresentationManager, `Disposed PresentationManager instance with ID: ${id}. Total instances: ${(_a = this._clientsStorage) === null || _a === void 0 ? void 0 : _a.values.length}.`); },
+                onDisposedAll: /* istanbul ignore next */ () => core_bentley_1.Logger.logInfo(BackendLoggerCategory_1.PresentationBackendLoggerCategory.PresentationManager, `Disposed all PresentationManager instances.`),
+            });
+        }
+    }
+    /**
+     * 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._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._disposeIpcHandler) {
+            this._disposeIpcHandler();
+        }
+        this._initProps = undefined;
+        if (this._requestTimeout)
+            this._requestTimeout = undefined;
+    }
+    static createClientManager(clientId) {
+        let manager;
+        if (Presentation._initProps && !isSingleManagerProps(Presentation._initProps) && Presentation._initProps.clientManagerFactory)
+            manager = Presentation._initProps.clientManagerFactory(clientId, Presentation._initProps);
+        else
+            manager = new PresentationManager_1.PresentationManager(Presentation._initProps);
+        return { manager };
+    }
+    static disposeClientManager(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._requestTimeout === undefined)
+            throw new presentation_common_1.PresentationError(presentation_common_1.PresentationStatus.NotInitialized, "Presentation must be first initialized by calling Presentation.initialize");
+        return this._requestTimeout;
+    }
+}
+exports.Presentation = Presentation;
+function isSingleManagerProps(props) {
+    return !!props.useSingleManager;
+}
+//# sourceMappingURL=Presentation.js.map

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

@@ -0,0 +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,yDAAsD;AAEtD,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,wBAAU,CAAC,YAAY,CAAC,8CAAwB,EAAE,yCAAmB,CAAC,CAAC;QACvE,IAAI,sBAAO,CAAC,OAAO,EAAE;YACnB,IAAI,CAAC,kBAAkB,GAAG,+CAAsB,CAAC,QAAQ,EAAE,CAAC;SAC7D;QACD,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;QACjG,IAAI,CAAC,eAAe,GAAG,CAAC,KAAK,IAAI,KAAK,CAAC,cAAc,KAAK,SAAS,CAAC;YAClE,CAAC,CAAC,KAAK,CAAC,cAAc;YACtB,CAAC,CAAC,qBAAqB,CAAC;QAE1B,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,mCAAgB,CAAkB;gBAC3D,OAAO,EAAE,IAAI,CAAC,mBAAmB;gBACjC,cAAc,EAAE,IAAI,CAAC,oBAAoB;gBACzC,uCAAuC;gBACvC,eAAe,EAAE,EAAE,GAAG,IAAI;gBAC1B,+DAA+D;gBAC/D,aAAa,EAAE,MAAA,IAAI,CAAC,UAAU,CAAC,oBAAoB,mCAAI,EAAE,GAAG,EAAE,GAAG,IAAI;gBACrE,mBAAmB;gBACnB,SAAS,EAAE,0BAA0B,CAAC,CAAC,EAAU,EAAE,EAAE,WAAC,OAAA,qBAAM,CAAC,OAAO,CAAC,yDAAiC,CAAC,mBAAmB,EAAE,mDAAmD,EAAE,sBAAsB,MAAA,IAAI,CAAC,eAAe,0CAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAA,EAAA;gBAC9O,gBAAgB,EAAE,0BAA0B,CAAC,CAAC,EAAU,EAAE,EAAE,WAAC,OAAA,qBAAM,CAAC,OAAO,CAAC,yDAAiC,CAAC,mBAAmB,EAAE,kDAAkD,EAAE,sBAAsB,MAAA,IAAI,CAAC,eAAe,0CAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAA,EAAA;gBACpP,aAAa,EAAE,0BAA0B,CAAC,GAAG,EAAE,CAAC,qBAAM,CAAC,OAAO,CAAC,yDAAiC,CAAC,mBAAmB,EAAE,6CAA6C,CAAC;aACrK,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,kBAAkB,EAAE;YAC3B,IAAI,CAAC,kBAAkB,EAAE,CAAC;SAC3B;QACD,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,IAAI,CAAC,eAAe;YACtB,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;IACrC,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,QAAgB;QACjD,IAAI,OAA4B,CAAC;QACjC,IAAI,YAAY,CAAC,UAAU,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,YAAY,CAAC,UAAU,CAAC,oBAAoB;YAC3H,OAAO,GAAG,YAAY,CAAC,UAAU,CAAC,oBAAoB,CAAC,QAAQ,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC;;YAE1F,OAAO,GAAG,IAAI,yCAAmB,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAC7D,OAAO,EAAE,OAAO,EAAE,CAAC;IACrB,CAAC;IAEO,MAAM,CAAC,oBAAoB,CAAC,SAA0B;QAC5D,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,eAAe,KAAK,SAAS;YACpC,MAAM,IAAI,uCAAiB,CAAC,wCAAkB,CAAC,cAAc,EAAE,2EAA2E,CAAC,CAAC;QAC9I,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;CACF;AAlHD,oCAkHC;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 { TemporaryStorage } 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: TemporaryStorage<ClientStoreItem> | undefined;\r\n  private static _requestTimeout: number | undefined;\r\n  private static _disposeIpcHandler: DisposeFunc | undefined;\r\n  private static _shutdownListener: DisposeFunc | undefined;\r\n  private static _manager: PresentationManager | 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    RpcManager.registerImpl(PresentationRpcInterface, PresentationRpcImpl);\r\n    if (IpcHost.isValid) {\r\n      this._disposeIpcHandler = PresentationIpcHandler.register();\r\n    }\r\n    this._initProps = props || {};\r\n    this._shutdownListener = IModelHost.onBeforeShutdown.addListener(() => Presentation.terminate());\r\n    this._requestTimeout = (props && props.requestTimeout !== undefined)\r\n      ? props.requestTimeout\r\n      : defaultRequestTimeout;\r\n\r\n    if (isSingleManagerProps(this._initProps)) {\r\n      this._manager = new PresentationManager(Presentation._initProps);\r\n    } else {\r\n      this._clientsStorage = new TemporaryStorage<ClientStoreItem>({\r\n        factory: this.createClientManager,\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        valueLifetime: this._initProps.unusedClientLifetime ?? 60 * 60 * 1000,\r\n        // add some logging\r\n        onCreated: /* istanbul ignore next */ (id: string) => Logger.logInfo(PresentationBackendLoggerCategory.PresentationManager, `Created a PresentationManager instance with ID: ${id}. Total instances: ${this._clientsStorage?.values.length}.`),\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._disposeIpcHandler) {\r\n      this._disposeIpcHandler();\r\n    }\r\n    this._initProps = undefined;\r\n    if (this._requestTimeout)\r\n      this._requestTimeout = undefined;\r\n  }\r\n\r\n  private static createClientManager(clientId: string): ClientStoreItem {\r\n    let manager: PresentationManager;\r\n    if (Presentation._initProps && !isSingleManagerProps(Presentation._initProps) && Presentation._initProps.clientManagerFactory)\r\n      manager = Presentation._initProps.clientManagerFactory(clientId, Presentation._initProps);\r\n    else\r\n      manager = new PresentationManager(Presentation._initProps);\r\n    return { manager };\r\n  }\r\n\r\n  private static disposeClientManager(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._requestTimeout === undefined)\r\n      throw new PresentationError(PresentationStatus.NotInitialized, \"Presentation must be first initialized by calling Presentation.initialize\");\r\n    return this._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/lib/cjs/presentation-backend/PresentationIpcHandler.d.ts

@@ -0,0 +1,13 @@
+/** @packageDocumentation
+ * @module RPC
+ */
+import { IpcHandler } from "@itwin/core-backend";
+import { NodeKeyJSON, 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<NodeKeyJSON>): Promise<void>;
+}
+//# sourceMappingURL=PresentationIpcHandler.d.ts.map

package/lib/cjs/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;AAGH,OAAO,EAAY,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EACL,WAAW,EAAiC,wBAAwB,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,0BAA0B,EAC/I,0BAA0B,EAC3B,MAAM,4BAA4B,CAAC;AAIpC,gBAAgB;AAChB,qBAAa,sBAAuB,SAAQ,UAAW,YAAW,wBAAwB;IACjF,WAAW,SAAiC;IAEtC,kBAAkB,CAAC,MAAM,EAAE,wBAAwB,CAAC,mBAAmB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAKxF,oBAAoB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC;IAKvE,oBAAoB,CAAC,MAAM,EAAE,0BAA0B,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAUlG"}

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

@@ -0,0 +1,41 @@
+"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 RPC
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PresentationIpcHandler = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_backend_1 = require("@itwin/core-backend");
+const presentation_common_1 = require("@itwin/presentation-common");
+const BackendLoggerCategory_1 = require("./BackendLoggerCategory");
+const Presentation_1 = require("./Presentation");
+/** @internal */
+class PresentationIpcHandler extends core_backend_1.IpcHandler {
+    constructor() {
+        super(...arguments);
+        this.channelName = presentation_common_1.PRESENTATION_IPC_CHANNEL_NAME;
+    }
+    async setRulesetVariable(params) {
+        const { clientId, rulesetId, variable } = params;
+        Presentation_1.Presentation.getManager(clientId).vars(rulesetId).setValue(variable.id, variable.type, variable.value);
+    }
+    async unsetRulesetVariable(params) {
+        const { clientId, rulesetId, variableId } = params;
+        Presentation_1.Presentation.getManager(clientId).vars(rulesetId).unset(variableId);
+    }
+    async updateHierarchyState(params) {
+        const { clientId, imodelKey, rulesetId, changeType, nodeKeys } = params;
+        const imodelDb = core_backend_1.IModelDb.tryFindByKey(imodelKey);
+        if (!imodelDb) {
+            core_bentley_1.Logger.logError(BackendLoggerCategory_1.PresentationBackendLoggerCategory.Ipc, "Could not find IModelDb to perform hierarchy state update");
+            return;
+        }
+        Presentation_1.Presentation.getManager(clientId).getNativePlatform().updateHierarchyState(imodelDb.nativeDb, rulesetId, changeType, JSON.stringify(nodeKeys));
+    }
+}
+exports.PresentationIpcHandler = PresentationIpcHandler;
+//# sourceMappingURL=PresentationIpcHandler.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PresentationIpcHandler.js","sourceRoot":"","sources":["../../../src/presentation-backend/PresentationIpcHandler.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6C;AAC7C,sDAA2D;AAC3D,oEAGoC;AACpC,mEAA4E;AAC5E,iDAA8C;AAE9C,gBAAgB;AAChB,MAAa,sBAAuB,SAAQ,yBAAU;IAAtD;;QACS,gBAAW,GAAG,mDAA6B,CAAC;IAsBrD,CAAC;IApBQ,KAAK,CAAC,kBAAkB,CAAC,MAAqD;QACnF,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QACjD,2BAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;IACzG,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,MAAkC;QAClE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QACnD,2BAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACtE,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,MAA+C;QAC/E,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QACxE,MAAM,QAAQ,GAAG,uBAAQ,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,QAAQ,EAAE;YACb,qBAAM,CAAC,QAAQ,CAAC,yDAAiC,CAAC,GAAG,EAAE,2DAA2D,CAAC,CAAC;YAEpH,OAAO;SACR;QACD,2BAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,iBAAiB,EAAE,CAAC,oBAAoB,CAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IACjJ,CAAC;CACF;AAvBD,wDAuBC","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 { Logger } from \"@itwin/core-bentley\";\r\nimport { IModelDb, IpcHandler } from \"@itwin/core-backend\";\r\nimport {\r\n  NodeKeyJSON, PRESENTATION_IPC_CHANNEL_NAME, PresentationIpcInterface, RulesetVariableJSON, SetRulesetVariableParams, UnsetRulesetVariableParams,\r\n  UpdateHierarchyStateParams,\r\n} from \"@itwin/presentation-common\";\r\nimport { PresentationBackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { Presentation } from \"./Presentation\";\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: SetRulesetVariableParams<RulesetVariableJSON>): Promise<void> {\r\n    const { clientId, rulesetId, variable } = params;\r\n    Presentation.getManager(clientId).vars(rulesetId).setValue(variable.id, variable.type, variable.value);\r\n  }\r\n\r\n  public async unsetRulesetVariable(params: UnsetRulesetVariableParams): Promise<void> {\r\n    const { clientId, rulesetId, variableId } = params;\r\n    Presentation.getManager(clientId).vars(rulesetId).unset(variableId);\r\n  }\r\n\r\n  public async updateHierarchyState(params: UpdateHierarchyStateParams<NodeKeyJSON>): Promise<void> {\r\n    const { clientId, imodelKey, rulesetId, changeType, nodeKeys } = params;\r\n    const imodelDb = IModelDb.tryFindByKey(imodelKey);\r\n    if (!imodelDb) {\r\n      Logger.logError(PresentationBackendLoggerCategory.Ipc, \"Could not find IModelDb to perform hierarchy state update\");\r\n\r\n      return;\r\n    }\r\n    Presentation.getManager(clientId).getNativePlatform().updateHierarchyState(imodelDb.nativeDb, rulesetId, changeType, JSON.stringify(nodeKeys));\r\n  }\r\n}\r\n"]}