@itwin/presentation-backend 4.0.0-dev.1 → 4.0.0-dev.100

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

@@ -1,141 +1,141 @@
-/** @packageDocumentation
- * @module Core
- */
-import { Id64String } from "@itwin/core-bentley";
-import { VariableValue, VariableValueTypes } from "@itwin/presentation-common";
-import { NativePlatformDefinition } from "./NativePlatform";
-/**
- * Presentation ruleset variables registry.
- * @public
- */
-export interface RulesetVariablesManager {
-    /** Gets a value of the specified type and ID */
-    getValue(variableId: string, type: VariableValueTypes): VariableValue;
-    /** Sets a value of the specified type */
-    setValue(variableId: string, type: VariableValueTypes, value: VariableValue): void;
-    /** Unsets variable with given id. */
-    unset(variableId: string): void;
-    /**
-     * Retrieves `string` variable value.
-     * Returns empty string if variable does not exist or does not convert to string.
-     */
-    getString(variableId: string): string;
-    /**
-     * Sets `string` variable value
-     */
-    setString(variableId: string, value: string): void;
-    /**
-     * Retrieves `boolean` variable value.
-     * Returns `false` if variable does not exist or does not convert to boolean.
-     */
-    getBool(variableId: string): boolean;
-    /**
-     * Sets `boolean` variable value
-     */
-    setBool(variableId: string, value: boolean): void;
-    /**
-     * Retrieves `number` variable value.
-     * Returns `0` if variable does not exist or does not convert to integer.
-     */
-    getInt(variableId: string): number;
-    /**
-     * Sets `number` variable value
-     */
-    setInt(variableId: string, value: number): void;
-    /**
-     * Retrieves `number[]` variable value.
-     * Returns empty array if variable does not exist or does not convert to integer array.
-     */
-    getInts(variableId: string): number[];
-    /**
-     * Sets `number[]` variable value
-     */
-    setInts(variableId: string, value: number[]): void;
-    /**
-     * Retrieves `Id64String` variable value.
-     * Returns invalid Id64String if variable does not exist or does not convert to Id64String.
-     */
-    getId64(variableId: string): Id64String;
-    /**
-     * Sets `Id64String` variable value
-     */
-    setId64(variableId: string, value: Id64String): void;
-    /**
-     * Retrieves `Id64String[]` variable value.
-     * Returns empty array if variable does not exist or does not convert to Id64String array.
-     */
-    getId64s(variableId: string): Id64String[];
-    /**
-     * Sets `Id64String[]` variable value
-     */
-    setId64s(variableId: string, value: Id64String[]): void;
-}
-/**
- * Presentation ruleset variables registry implementation.
- * @internal
- */
-export declare class RulesetVariablesManagerImpl implements RulesetVariablesManager {
-    private _getNativePlatform;
-    private _rulesetId;
-    constructor(getNativeAddon: () => NativePlatformDefinition, rulesetId: string);
-    setValueInternal(variableId: string, type: VariableValueTypes, value: VariableValue): void;
-    getValueInternal(variableId: string, type: VariableValueTypes): VariableValue;
-    setValue(variableId: string, type: VariableValueTypes, value: VariableValue): void;
-    unset(variableId: string): void;
-    getValue(variableId: string, type: VariableValueTypes): VariableValue;
-    /**
-     * Retrieves `string` variable value.
-     * Returns empty string if variable does not exist or does not convert to string.
-     */
-    getString(variableId: string): string;
-    /**
-     * Sets `string` variable value
-     */
-    setString(variableId: string, value: string): void;
-    /**
-     * Retrieves `boolean` variable value.
-     * Returns `false` if variable does not exist or does not convert to boolean.
-     */
-    getBool(variableId: string): boolean;
-    /**
-     * Sets `boolean` variable value
-     */
-    setBool(variableId: string, value: boolean): void;
-    /**
-     * Retrieves `number` variable value.
-     * Returns `0` if variable does not exist or does not convert to integer.
-     */
-    getInt(variableId: string): number;
-    /**
-     * Sets `number` variable value
-     */
-    setInt(variableId: string, value: number): void;
-    /**
-     * Retrieves `number[]` variable value.
-     * Returns empty array if variable does not exist or does not convert to integer array.
-     */
-    getInts(variableId: string): number[];
-    /**
-     * Sets `number[]` variable value
-     */
-    setInts(variableId: string, value: number[]): void;
-    /**
-     * Retrieves `Id64String` variable value.
-     * Returns invalid Id64String if variable does not exist or does not convert to Id64String.
-     */
-    getId64(variableId: string): Id64String;
-    /**
-     * Sets `Id64String` variable value
-     */
-    setId64(variableId: string, value: Id64String): void;
-    /**
-     * Retrieves `Id64String[]` variable value.
-     * Returns empty array if variable does not exist or does not convert to Id64String array.
-     */
-    getId64s(variableId: string): Id64String[];
-    /**
-     * Sets `Id64String[]` variable value
-     */
-    setId64s(variableId: string, value: Id64String[]): void;
-}
+/** @packageDocumentation
+ * @module Core
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { VariableValue, VariableValueTypes } from "@itwin/presentation-common";
+import { NativePlatformDefinition } from "./NativePlatform";
+/**
+ * Presentation ruleset variables registry.
+ * @public
+ */
+export interface RulesetVariablesManager {
+    /** Gets a value of the specified type and ID */
+    getValue(variableId: string, type: VariableValueTypes): VariableValue;
+    /** Sets a value of the specified type */
+    setValue(variableId: string, type: VariableValueTypes, value: VariableValue): void;
+    /** Unsets variable with given id. */
+    unset(variableId: string): void;
+    /**
+     * Retrieves `string` variable value.
+     * Returns empty string if variable does not exist or does not convert to string.
+     */
+    getString(variableId: string): string;
+    /**
+     * Sets `string` variable value
+     */
+    setString(variableId: string, value: string): void;
+    /**
+     * Retrieves `boolean` variable value.
+     * Returns `false` if variable does not exist or does not convert to boolean.
+     */
+    getBool(variableId: string): boolean;
+    /**
+     * Sets `boolean` variable value
+     */
+    setBool(variableId: string, value: boolean): void;
+    /**
+     * Retrieves `number` variable value.
+     * Returns `0` if variable does not exist or does not convert to integer.
+     */
+    getInt(variableId: string): number;
+    /**
+     * Sets `number` variable value
+     */
+    setInt(variableId: string, value: number): void;
+    /**
+     * Retrieves `number[]` variable value.
+     * Returns empty array if variable does not exist or does not convert to integer array.
+     */
+    getInts(variableId: string): number[];
+    /**
+     * Sets `number[]` variable value
+     */
+    setInts(variableId: string, value: number[]): void;
+    /**
+     * Retrieves `Id64String` variable value.
+     * Returns invalid Id64String if variable does not exist or does not convert to Id64String.
+     */
+    getId64(variableId: string): Id64String;
+    /**
+     * Sets `Id64String` variable value
+     */
+    setId64(variableId: string, value: Id64String): void;
+    /**
+     * Retrieves `Id64String[]` variable value.
+     * Returns empty array if variable does not exist or does not convert to Id64String array.
+     */
+    getId64s(variableId: string): Id64String[];
+    /**
+     * Sets `Id64String[]` variable value
+     */
+    setId64s(variableId: string, value: Id64String[]): void;
+}
+/**
+ * Presentation ruleset variables registry implementation.
+ * @internal
+ */
+export declare class RulesetVariablesManagerImpl implements RulesetVariablesManager {
+    private _getNativePlatform;
+    private _rulesetId;
+    constructor(getNativeAddon: () => NativePlatformDefinition, rulesetId: string);
+    setValueInternal(variableId: string, type: VariableValueTypes, value: VariableValue): void;
+    getValueInternal(variableId: string, type: VariableValueTypes): VariableValue;
+    setValue(variableId: string, type: VariableValueTypes, value: VariableValue): void;
+    unset(variableId: string): void;
+    getValue(variableId: string, type: VariableValueTypes): VariableValue;
+    /**
+     * Retrieves `string` variable value.
+     * Returns empty string if variable does not exist or does not convert to string.
+     */
+    getString(variableId: string): string;
+    /**
+     * Sets `string` variable value
+     */
+    setString(variableId: string, value: string): void;
+    /**
+     * Retrieves `boolean` variable value.
+     * Returns `false` if variable does not exist or does not convert to boolean.
+     */
+    getBool(variableId: string): boolean;
+    /**
+     * Sets `boolean` variable value
+     */
+    setBool(variableId: string, value: boolean): void;
+    /**
+     * Retrieves `number` variable value.
+     * Returns `0` if variable does not exist or does not convert to integer.
+     */
+    getInt(variableId: string): number;
+    /**
+     * Sets `number` variable value
+     */
+    setInt(variableId: string, value: number): void;
+    /**
+     * Retrieves `number[]` variable value.
+     * Returns empty array if variable does not exist or does not convert to integer array.
+     */
+    getInts(variableId: string): number[];
+    /**
+     * Sets `number[]` variable value
+     */
+    setInts(variableId: string, value: number[]): void;
+    /**
+     * Retrieves `Id64String` variable value.
+     * Returns invalid Id64String if variable does not exist or does not convert to Id64String.
+     */
+    getId64(variableId: string): Id64String;
+    /**
+     * Sets `Id64String` variable value
+     */
+    setId64(variableId: string, value: Id64String): void;
+    /**
+     * Retrieves `Id64String[]` variable value.
+     * Returns empty array if variable does not exist or does not convert to Id64String array.
+     */
+    getId64s(variableId: string): Id64String[];
+    /**
+     * Sets `Id64String[]` variable value
+     */
+    setId64s(variableId: string, value: Id64String[]): void;
+}
 //# sourceMappingURL=RulesetVariablesManager.d.ts.map

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

@@ -1,130 +1,130 @@
-"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.RulesetVariablesManagerImpl = void 0;
-const presentation_common_1 = require("@itwin/presentation-common");
-/**
- * Presentation ruleset variables registry implementation.
- * @internal
- */
-class RulesetVariablesManagerImpl {
-    constructor(getNativeAddon, rulesetId) {
-        this._getNativePlatform = getNativeAddon;
-        this._rulesetId = rulesetId;
-    }
-    setValueInternal(variableId, type, value) {
-        this._getNativePlatform().setRulesetVariableValue(this._rulesetId, variableId, type, value);
-    }
-    getValueInternal(variableId, type) {
-        return this._getNativePlatform().getRulesetVariableValue(this._rulesetId, variableId, type).result;
-    }
-    setValue(variableId, type, value) {
-        switch (type) {
-            case presentation_common_1.VariableValueTypes.Bool: return this.setBool(variableId, value);
-            case presentation_common_1.VariableValueTypes.Id64: return this.setId64(variableId, value);
-            case presentation_common_1.VariableValueTypes.Id64Array: return this.setId64s(variableId, value);
-            case presentation_common_1.VariableValueTypes.Int: return this.setInt(variableId, value);
-            case presentation_common_1.VariableValueTypes.IntArray: return this.setInts(variableId, value);
-            case presentation_common_1.VariableValueTypes.String: return this.setString(variableId, value);
-        }
-    }
-    unset(variableId) {
-        this._getNativePlatform().unsetRulesetVariableValue(this._rulesetId, variableId);
-    }
-    getValue(variableId, type) {
-        switch (type) {
-            case presentation_common_1.VariableValueTypes.Bool: return this.getBool(variableId);
-            case presentation_common_1.VariableValueTypes.Id64: return this.getId64(variableId);
-            case presentation_common_1.VariableValueTypes.Id64Array: return this.getId64s(variableId);
-            case presentation_common_1.VariableValueTypes.Int: return this.getInt(variableId);
-            case presentation_common_1.VariableValueTypes.IntArray: return this.getInts(variableId);
-            case presentation_common_1.VariableValueTypes.String: return this.getString(variableId);
-        }
-    }
-    /**
-     * Retrieves `string` variable value.
-     * Returns empty string if variable does not exist or does not convert to string.
-     */
-    getString(variableId) {
-        return (this.getValueInternal(variableId, presentation_common_1.VariableValueTypes.String));
-    }
-    /**
-     * Sets `string` variable value
-     */
-    setString(variableId, value) {
-        this.setValueInternal(variableId, presentation_common_1.VariableValueTypes.String, value);
-    }
-    /**
-     * Retrieves `boolean` variable value.
-     * Returns `false` if variable does not exist or does not convert to boolean.
-     */
-    getBool(variableId) {
-        return (this.getValueInternal(variableId, presentation_common_1.VariableValueTypes.Bool));
-    }
-    /**
-     * Sets `boolean` variable value
-     */
-    setBool(variableId, value) {
-        this.setValueInternal(variableId, presentation_common_1.VariableValueTypes.Bool, value);
-    }
-    /**
-     * Retrieves `number` variable value.
-     * Returns `0` if variable does not exist or does not convert to integer.
-     */
-    getInt(variableId) {
-        return (this.getValueInternal(variableId, presentation_common_1.VariableValueTypes.Int));
-    }
-    /**
-     * Sets `number` variable value
-     */
-    setInt(variableId, value) {
-        this.setValueInternal(variableId, presentation_common_1.VariableValueTypes.Int, value);
-    }
-    /**
-     * Retrieves `number[]` variable value.
-     * Returns empty array if variable does not exist or does not convert to integer array.
-     */
-    getInts(variableId) {
-        return (this.getValueInternal(variableId, presentation_common_1.VariableValueTypes.IntArray));
-    }
-    /**
-     * Sets `number[]` variable value
-     */
-    setInts(variableId, value) {
-        this.setValueInternal(variableId, presentation_common_1.VariableValueTypes.IntArray, value);
-    }
-    /**
-     * Retrieves `Id64String` variable value.
-     * Returns invalid Id64String if variable does not exist or does not convert to Id64String.
-     */
-    getId64(variableId) {
-        return (this.getValueInternal(variableId, presentation_common_1.VariableValueTypes.Id64));
-    }
-    /**
-     * Sets `Id64String` variable value
-     */
-    setId64(variableId, value) {
-        this.setValueInternal(variableId, presentation_common_1.VariableValueTypes.Id64, value);
-    }
-    /**
-     * Retrieves `Id64String[]` variable value.
-     * Returns empty array if variable does not exist or does not convert to Id64String array.
-     */
-    getId64s(variableId) {
-        return (this.getValueInternal(variableId, presentation_common_1.VariableValueTypes.Id64Array));
-    }
-    /**
-     * Sets `Id64String[]` variable value
-     */
-    setId64s(variableId, value) {
-        this.setValueInternal(variableId, presentation_common_1.VariableValueTypes.Id64Array, value);
-    }
-}
-exports.RulesetVariablesManagerImpl = RulesetVariablesManagerImpl;
+"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.RulesetVariablesManagerImpl = void 0;
+const presentation_common_1 = require("@itwin/presentation-common");
+/**
+ * Presentation ruleset variables registry implementation.
+ * @internal
+ */
+class RulesetVariablesManagerImpl {
+    constructor(getNativeAddon, rulesetId) {
+        this._getNativePlatform = getNativeAddon;
+        this._rulesetId = rulesetId;
+    }
+    setValueInternal(variableId, type, value) {
+        this._getNativePlatform().setRulesetVariableValue(this._rulesetId, variableId, type, value);
+    }
+    getValueInternal(variableId, type) {
+        return this._getNativePlatform().getRulesetVariableValue(this._rulesetId, variableId, type).result;
+    }
+    setValue(variableId, type, value) {
+        switch (type) {
+            case presentation_common_1.VariableValueTypes.Bool: return this.setBool(variableId, value);
+            case presentation_common_1.VariableValueTypes.Id64: return this.setId64(variableId, value);
+            case presentation_common_1.VariableValueTypes.Id64Array: return this.setId64s(variableId, value);
+            case presentation_common_1.VariableValueTypes.Int: return this.setInt(variableId, value);
+            case presentation_common_1.VariableValueTypes.IntArray: return this.setInts(variableId, value);
+            case presentation_common_1.VariableValueTypes.String: return this.setString(variableId, value);
+        }
+    }
+    unset(variableId) {
+        this._getNativePlatform().unsetRulesetVariableValue(this._rulesetId, variableId);
+    }
+    getValue(variableId, type) {
+        switch (type) {
+            case presentation_common_1.VariableValueTypes.Bool: return this.getBool(variableId);
+            case presentation_common_1.VariableValueTypes.Id64: return this.getId64(variableId);
+            case presentation_common_1.VariableValueTypes.Id64Array: return this.getId64s(variableId);
+            case presentation_common_1.VariableValueTypes.Int: return this.getInt(variableId);
+            case presentation_common_1.VariableValueTypes.IntArray: return this.getInts(variableId);
+            case presentation_common_1.VariableValueTypes.String: return this.getString(variableId);
+        }
+    }
+    /**
+     * Retrieves `string` variable value.
+     * Returns empty string if variable does not exist or does not convert to string.
+     */
+    getString(variableId) {
+        return (this.getValueInternal(variableId, presentation_common_1.VariableValueTypes.String));
+    }
+    /**
+     * Sets `string` variable value
+     */
+    setString(variableId, value) {
+        this.setValueInternal(variableId, presentation_common_1.VariableValueTypes.String, value);
+    }
+    /**
+     * Retrieves `boolean` variable value.
+     * Returns `false` if variable does not exist or does not convert to boolean.
+     */
+    getBool(variableId) {
+        return (this.getValueInternal(variableId, presentation_common_1.VariableValueTypes.Bool));
+    }
+    /**
+     * Sets `boolean` variable value
+     */
+    setBool(variableId, value) {
+        this.setValueInternal(variableId, presentation_common_1.VariableValueTypes.Bool, value);
+    }
+    /**
+     * Retrieves `number` variable value.
+     * Returns `0` if variable does not exist or does not convert to integer.
+     */
+    getInt(variableId) {
+        return (this.getValueInternal(variableId, presentation_common_1.VariableValueTypes.Int));
+    }
+    /**
+     * Sets `number` variable value
+     */
+    setInt(variableId, value) {
+        this.setValueInternal(variableId, presentation_common_1.VariableValueTypes.Int, value);
+    }
+    /**
+     * Retrieves `number[]` variable value.
+     * Returns empty array if variable does not exist or does not convert to integer array.
+     */
+    getInts(variableId) {
+        return (this.getValueInternal(variableId, presentation_common_1.VariableValueTypes.IntArray));
+    }
+    /**
+     * Sets `number[]` variable value
+     */
+    setInts(variableId, value) {
+        this.setValueInternal(variableId, presentation_common_1.VariableValueTypes.IntArray, value);
+    }
+    /**
+     * Retrieves `Id64String` variable value.
+     * Returns invalid Id64String if variable does not exist or does not convert to Id64String.
+     */
+    getId64(variableId) {
+        return (this.getValueInternal(variableId, presentation_common_1.VariableValueTypes.Id64));
+    }
+    /**
+     * Sets `Id64String` variable value
+     */
+    setId64(variableId, value) {
+        this.setValueInternal(variableId, presentation_common_1.VariableValueTypes.Id64, value);
+    }
+    /**
+     * Retrieves `Id64String[]` variable value.
+     * Returns empty array if variable does not exist or does not convert to Id64String array.
+     */
+    getId64s(variableId) {
+        return (this.getValueInternal(variableId, presentation_common_1.VariableValueTypes.Id64Array));
+    }
+    /**
+     * Sets `Id64String[]` variable value
+     */
+    setId64s(variableId, value) {
+        this.setValueInternal(variableId, presentation_common_1.VariableValueTypes.Id64Array, value);
+    }
+}
+exports.RulesetVariablesManagerImpl = RulesetVariablesManagerImpl;
 //# sourceMappingURL=RulesetVariablesManager.js.map

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

@@ -1,29 +1,29 @@
-/** @packageDocumentation
- * @module Core
- */
-import { IModelDb } from "@itwin/core-backend";
-import { Id64String } from "@itwin/core-bentley";
-import { ComputeSelectionRequestOptions, KeySet, SelectionScope, SelectionScopeRequestOptions } from "@itwin/presentation-common";
-/**
- * Contains helper methods for computing selection scopes. Will get removed
- * once rules-driven scopes are implemented.
- *
- * @internal
- */
-export declare class SelectionScopesHelper {
-    private constructor();
-    static getSelectionScopes(): SelectionScope[];
-    private static getElementKey;
-    private static computeElementSelection;
-    private static computeCategorySelection;
-    private static computeModelSelection;
-    private static getRelatedFunctionalElementKey;
-    private static findFirstRelatedFunctionalElementKey;
-    private static elementClassDerivesFrom;
-    private static computeFunctionalElementSelection;
-    private static computeFunctionalAssemblySelection;
-    private static computeFunctionalTopAssemblySelection;
-    static computeSelection(requestOptions: SelectionScopeRequestOptions<IModelDb>, ids: Id64String[], scopeId: string): Promise<KeySet>;
-    static computeSelection(requestOptions: ComputeSelectionRequestOptions<IModelDb>): Promise<KeySet>;
-}
+/** @packageDocumentation
+ * @module Core
+ */
+import { IModelDb } from "@itwin/core-backend";
+import { Id64String } from "@itwin/core-bentley";
+import { ComputeSelectionRequestOptions, KeySet, SelectionScope, SelectionScopeRequestOptions } from "@itwin/presentation-common";
+/**
+ * Contains helper methods for computing selection scopes. Will get removed
+ * once rules-driven scopes are implemented.
+ *
+ * @internal
+ */
+export declare class SelectionScopesHelper {
+    private constructor();
+    static getSelectionScopes(): SelectionScope[];
+    private static getElementKey;
+    private static computeElementSelection;
+    private static computeCategorySelection;
+    private static computeModelSelection;
+    private static getRelatedFunctionalElementKey;
+    private static findFirstRelatedFunctionalElementKey;
+    private static elementClassDerivesFrom;
+    private static computeFunctionalElementSelection;
+    private static computeFunctionalAssemblySelection;
+    private static computeFunctionalTopAssemblySelection;
+    static computeSelection(requestOptions: SelectionScopeRequestOptions<IModelDb>, ids: Id64String[], scopeId: string): Promise<KeySet>;
+    static computeSelection(requestOptions: ComputeSelectionRequestOptions<IModelDb>): Promise<KeySet>;
+}
 //# sourceMappingURL=SelectionScopesHelper.d.ts.map