@itwin/presentation-common 3.6.0-dev.53 → 3.6.0-dev.55

package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts

@@ -1,257 +1,257 @@
-/** @packageDocumentation
- * @module Core
- */
-import { BeEvent, Id64String } from "@itwin/core-bentley";
-import { UnitSystemKey } from "@itwin/core-quantity";
-import { SelectionInfo } from "./content/Descriptor";
-import { FieldDescriptor } from "./content/Fields";
-import { InstanceKey } from "./EC";
-import { InstanceFilterDefinition } from "./InstanceFilterDefinition";
-import { Ruleset } from "./rules/Ruleset";
-import { RulesetVariable } from "./RulesetVariables";
-import { SelectionScopeProps } from "./selection/SelectionScope";
-/**
- * A generic request options type used for both hierarchy and content requests.
- * @public
- */
-export interface RequestOptions<TIModel> {
-    /** iModel to request data from */
-    imodel: TIModel;
-    /** Optional locale to use when formatting / localizing data */
-    locale?: string;
-    /**
-     * Unit system to use when formatting property values with units. Default presentation
-     * unit is used if unit system is not specified.
-     */
-    unitSystem?: UnitSystemKey;
-    /**
-     * Expected form of response. This property is set automatically on newer frontends.
-     * `unparsed-json` — deliver response from native addon without parsing it.
-     * @internal
-     */
-    transport?: "unparsed-json";
-}
-/**
- * Options for requests that require presentation ruleset. Not
- * meant to be used directly, see one of the subclasses.
- *
- * @public
- */
-export interface RequestOptionsWithRuleset<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptions<TIModel> {
-    /** Ruleset or id of the ruleset to use when requesting data */
-    rulesetOrId: Ruleset | string;
-    /** Ruleset variables to use when requesting data */
-    rulesetVariables?: TRulesetVariable[];
-}
-/**
- * Request type for hierarchy requests.
- * @public
- */
-export interface HierarchyRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
-    /** Key of the parent node to get children for */
-    parentKey?: TNodeKey;
-    /**
-     * An instance filter that should be applied for this hierarchy level.
-     * @alpha
-     */
-    instanceFilter?: InstanceFilterDefinition;
-}
-/**
- * Params for hierarchy level descriptor requests.
- * @alpha
- */
-export interface HierarchyLevelDescriptorRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
-    /** Key of the parent node to get descriptor for */
-    parentKey?: TNodeKey;
-}
-/**
- * Request type of filtering hierarchies by given ECInstance paths.
- * @public
- */
-export interface FilterByInstancePathsHierarchyRequestOptions<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
-    /** A list of paths from root ECInstance to target ECInstance. */
-    instancePaths: InstanceKey[][];
-    /**
-     * An optional index (`0 <= markedIndex < instancePaths.length`) to mark one of the instance paths. The
-     * path is marked using `NodePathElement.isMarked` flag in the result.
-     */
-    markedIndex?: number;
-}
-/**
- * Request type of filtering hierarchies by given text.
- * @public
- */
-export interface FilterByTextHierarchyRequestOptions<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
-    /** Text to filter the hierarchy by. */
-    filterText: string;
-}
-/**
- * Request type for content sources requests.
- * @beta
- */
-export interface ContentSourcesRequestOptions<TIModel> extends RequestOptions<TIModel> {
-    /** Full names of classes to get content sources for. */
-    classes: string[];
-}
-/**
- * Request type for content descriptor requests.
- * @public
- */
-export interface ContentDescriptorRequestOptions<TIModel, TKeySet, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
-    /**
-     * Content display type.
-     * @see [[DefaultContentDisplayTypes]]
-     */
-    displayType: string;
-    /** Input keys for getting the content */
-    keys: TKeySet;
-    /** Information about the selection event that was the cause of this content request */
-    selection?: SelectionInfo;
-}
-/**
- * Request type for content requests.
- * @public
- */
-export interface ContentRequestOptions<TIModel, TDescriptor, TKeySet, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
-    /** Content descriptor for customizing the returned content */
-    descriptor: TDescriptor;
-    /** Input keys for getting the content */
-    keys: TKeySet;
-}
-/**
- * Request type for distinct values' requests.
- * @public
- */
-export interface DistinctValuesRequestOptions<TIModel, TDescriptor, TKeySet, TRulesetVariable = RulesetVariable> extends Paged<RequestOptionsWithRuleset<TIModel, TRulesetVariable>> {
-    /** Content descriptor for customizing the returned content */
-    descriptor: TDescriptor;
-    /** Input keys for getting the content */
-    keys: TKeySet;
-    /** Descriptor for a field distinct values are requested for */
-    fieldDescriptor: FieldDescriptor;
-}
-/**
- * Request type for element properties requests
- * @beta
- */
-export declare type ElementPropertiesRequestOptions<TIModel> = SingleElementPropertiesRequestOptions<TIModel> | MultiElementPropertiesRequestOptions<TIModel>;
-/**
- * Request type for single element properties requests.
- * @beta
- */
-export interface SingleElementPropertiesRequestOptions<TIModel> extends RequestOptions<TIModel> {
-    /** ID of the element to get properties for. */
-    elementId: Id64String;
-}
-/**
- * Request type for multiple elements properties requests.
- * @beta
- */
-export interface MultiElementPropertiesRequestOptions<TIModel> extends RequestOptions<TIModel> {
-    /** Classes of the elements to get properties for. If `elementClasses` is undefined all classes
-     * are used. Classes should be specified in one of these formats: "<schema name or alias>.<class_name>",
-     * "<schema name or alias>:<class_name>".
-     */
-    elementClasses?: string[];
-}
-/**
- * Request type for content instance keys' requests.
- * @beta
- */
-export interface ContentInstanceKeysRequestOptions<TIModel, TKeySet, TRulesetVariable = RulesetVariable> extends Paged<RequestOptionsWithRuleset<TIModel, TRulesetVariable>> {
-    /**
-     * Content display type.
-     * @see [[DefaultContentDisplayTypes]]
-     */
-    displayType?: string;
-    /** Input keys for getting the content. */
-    keys: TKeySet;
-}
-/**
- * Request type for label requests
- * @public
- */
-export interface DisplayLabelRequestOptions<TIModel, TInstanceKey> extends RequestOptions<TIModel> {
-    /** Key of ECInstance to get label for */
-    key: TInstanceKey;
-}
-/**
- * Request type for labels requests
- * @public
- */
-export interface DisplayLabelsRequestOptions<TIModel, TInstanceKey> extends RequestOptions<TIModel> {
-    /** Keys of ECInstances to get labels for */
-    keys: TInstanceKey[];
-}
-/**
- * Request options used for selection scope related requests
- * @public
- */
-export interface SelectionScopeRequestOptions<TIModel> extends RequestOptions<TIModel> {
-}
-/**
- * Request options used for calculating selection based on picked instance ksy and selection scope
- * @alpha
- */
-export interface ComputeSelectionRequestOptions<TIModel> extends RequestOptions<TIModel> {
-    elementIds: Id64String[];
-    scope: SelectionScopeProps;
-}
-/** @internal */
-export declare function isComputeSelectionRequestOptions<TIModel>(options: ComputeSelectionRequestOptions<TIModel> | SelectionScopeRequestOptions<TIModel>): options is ComputeSelectionRequestOptions<TIModel>;
-/**
- * Data structure for comparing a hierarchy after ruleset or ruleset variable changes.
- * @public
- */
-export interface HierarchyCompareOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
-    prev: {
-        rulesetOrId?: Ruleset | string;
-        rulesetVariables?: TRulesetVariable[];
-    };
-    expandedNodeKeys?: TNodeKey[];
-    continuationToken?: {
-        prevHierarchyNode: string;
-        currHierarchyNode: string;
-    };
-    resultSetSize?: number;
-}
-/**
- * Paging options
- * @public
- */
-export interface PageOptions {
-    /** Inclusive start 0-based index of the page */
-    start?: number;
-    /** Maximum size of the page */
-    size?: number;
-}
-/**
- * A wrapper type that injects [[PageOptions]] into supplied type
- * @public
- */
-export declare type Paged<TOptions extends {}> = TOptions & {
-    /** Optional paging parameters */
-    paging?: PageOptions;
-};
-/**
- * A wrapper type that injects priority into supplied type.
- * @public
- */
-export declare type Prioritized<TOptions extends {}> = TOptions & {
-    /** Optional priority */
-    priority?: number;
-};
-/**
- * Checks if supplied request options are for single or multiple element properties.
- * @beta
- */
-export declare function isSingleElementPropertiesRequestOptions<TIModel>(options: ElementPropertiesRequestOptions<TIModel>): options is SingleElementPropertiesRequestOptions<TIModel>;
-/**
- * A wrapper type that injects cancelEvent into supplied type.
- * @public
- */
-export declare type WithCancelEvent<TOptions extends {}> = TOptions & {
-    /** Event which is triggered when the request is canceled */
-    cancelEvent?: BeEvent<() => void>;
-};
+/** @packageDocumentation
+ * @module Core
+ */
+import { BeEvent, Id64String } from "@itwin/core-bentley";
+import { UnitSystemKey } from "@itwin/core-quantity";
+import { SelectionInfo } from "./content/Descriptor";
+import { FieldDescriptor } from "./content/Fields";
+import { InstanceKey } from "./EC";
+import { InstanceFilterDefinition } from "./InstanceFilterDefinition";
+import { Ruleset } from "./rules/Ruleset";
+import { RulesetVariable } from "./RulesetVariables";
+import { SelectionScopeProps } from "./selection/SelectionScope";
+/**
+ * A generic request options type used for both hierarchy and content requests.
+ * @public
+ */
+export interface RequestOptions<TIModel> {
+    /** iModel to request data from */
+    imodel: TIModel;
+    /** Optional locale to use when formatting / localizing data */
+    locale?: string;
+    /**
+     * Unit system to use when formatting property values with units. Default presentation
+     * unit is used if unit system is not specified.
+     */
+    unitSystem?: UnitSystemKey;
+    /**
+     * Expected form of response. This property is set automatically on newer frontends.
+     * `unparsed-json` — deliver response from native addon without parsing it.
+     * @internal
+     */
+    transport?: "unparsed-json";
+}
+/**
+ * Options for requests that require presentation ruleset. Not
+ * meant to be used directly, see one of the subclasses.
+ *
+ * @public
+ */
+export interface RequestOptionsWithRuleset<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptions<TIModel> {
+    /** Ruleset or id of the ruleset to use when requesting data */
+    rulesetOrId: Ruleset | string;
+    /** Ruleset variables to use when requesting data */
+    rulesetVariables?: TRulesetVariable[];
+}
+/**
+ * Request type for hierarchy requests.
+ * @public
+ */
+export interface HierarchyRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
+    /** Key of the parent node to get children for */
+    parentKey?: TNodeKey;
+    /**
+     * An instance filter that should be applied for this hierarchy level.
+     * @alpha
+     */
+    instanceFilter?: InstanceFilterDefinition;
+}
+/**
+ * Params for hierarchy level descriptor requests.
+ * @alpha
+ */
+export interface HierarchyLevelDescriptorRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
+    /** Key of the parent node to get descriptor for */
+    parentKey?: TNodeKey;
+}
+/**
+ * Request type of filtering hierarchies by given ECInstance paths.
+ * @public
+ */
+export interface FilterByInstancePathsHierarchyRequestOptions<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
+    /** A list of paths from root ECInstance to target ECInstance. */
+    instancePaths: InstanceKey[][];
+    /**
+     * An optional index (`0 <= markedIndex < instancePaths.length`) to mark one of the instance paths. The
+     * path is marked using `NodePathElement.isMarked` flag in the result.
+     */
+    markedIndex?: number;
+}
+/**
+ * Request type of filtering hierarchies by given text.
+ * @public
+ */
+export interface FilterByTextHierarchyRequestOptions<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
+    /** Text to filter the hierarchy by. */
+    filterText: string;
+}
+/**
+ * Request type for content sources requests.
+ * @beta
+ */
+export interface ContentSourcesRequestOptions<TIModel> extends RequestOptions<TIModel> {
+    /** Full names of classes to get content sources for. */
+    classes: string[];
+}
+/**
+ * Request type for content descriptor requests.
+ * @public
+ */
+export interface ContentDescriptorRequestOptions<TIModel, TKeySet, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
+    /**
+     * Content display type.
+     * @see [[DefaultContentDisplayTypes]]
+     */
+    displayType: string;
+    /** Input keys for getting the content */
+    keys: TKeySet;
+    /** Information about the selection event that was the cause of this content request */
+    selection?: SelectionInfo;
+}
+/**
+ * Request type for content requests.
+ * @public
+ */
+export interface ContentRequestOptions<TIModel, TDescriptor, TKeySet, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
+    /** Content descriptor for customizing the returned content */
+    descriptor: TDescriptor;
+    /** Input keys for getting the content */
+    keys: TKeySet;
+}
+/**
+ * Request type for distinct values' requests.
+ * @public
+ */
+export interface DistinctValuesRequestOptions<TIModel, TDescriptor, TKeySet, TRulesetVariable = RulesetVariable> extends Paged<RequestOptionsWithRuleset<TIModel, TRulesetVariable>> {
+    /** Content descriptor for customizing the returned content */
+    descriptor: TDescriptor;
+    /** Input keys for getting the content */
+    keys: TKeySet;
+    /** Descriptor for a field distinct values are requested for */
+    fieldDescriptor: FieldDescriptor;
+}
+/**
+ * Request type for element properties requests
+ * @beta
+ */
+export declare type ElementPropertiesRequestOptions<TIModel> = SingleElementPropertiesRequestOptions<TIModel> | MultiElementPropertiesRequestOptions<TIModel>;
+/**
+ * Request type for single element properties requests.
+ * @beta
+ */
+export interface SingleElementPropertiesRequestOptions<TIModel> extends RequestOptions<TIModel> {
+    /** ID of the element to get properties for. */
+    elementId: Id64String;
+}
+/**
+ * Request type for multiple elements properties requests.
+ * @beta
+ */
+export interface MultiElementPropertiesRequestOptions<TIModel> extends RequestOptions<TIModel> {
+    /** Classes of the elements to get properties for. If `elementClasses` is undefined all classes
+     * are used. Classes should be specified in one of these formats: "<schema name or alias>.<class_name>",
+     * "<schema name or alias>:<class_name>".
+     */
+    elementClasses?: string[];
+}
+/**
+ * Request type for content instance keys' requests.
+ * @beta
+ */
+export interface ContentInstanceKeysRequestOptions<TIModel, TKeySet, TRulesetVariable = RulesetVariable> extends Paged<RequestOptionsWithRuleset<TIModel, TRulesetVariable>> {
+    /**
+     * Content display type.
+     * @see [[DefaultContentDisplayTypes]]
+     */
+    displayType?: string;
+    /** Input keys for getting the content. */
+    keys: TKeySet;
+}
+/**
+ * Request type for label requests
+ * @public
+ */
+export interface DisplayLabelRequestOptions<TIModel, TInstanceKey> extends RequestOptions<TIModel> {
+    /** Key of ECInstance to get label for */
+    key: TInstanceKey;
+}
+/**
+ * Request type for labels requests
+ * @public
+ */
+export interface DisplayLabelsRequestOptions<TIModel, TInstanceKey> extends RequestOptions<TIModel> {
+    /** Keys of ECInstances to get labels for */
+    keys: TInstanceKey[];
+}
+/**
+ * Request options used for selection scope related requests
+ * @public
+ */
+export interface SelectionScopeRequestOptions<TIModel> extends RequestOptions<TIModel> {
+}
+/**
+ * Request options used for calculating selection based on picked instance ksy and selection scope
+ * @alpha
+ */
+export interface ComputeSelectionRequestOptions<TIModel> extends RequestOptions<TIModel> {
+    elementIds: Id64String[];
+    scope: SelectionScopeProps;
+}
+/** @internal */
+export declare function isComputeSelectionRequestOptions<TIModel>(options: ComputeSelectionRequestOptions<TIModel> | SelectionScopeRequestOptions<TIModel>): options is ComputeSelectionRequestOptions<TIModel>;
+/**
+ * Data structure for comparing a hierarchy after ruleset or ruleset variable changes.
+ * @public
+ */
+export interface HierarchyCompareOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {
+    prev: {
+        rulesetOrId?: Ruleset | string;
+        rulesetVariables?: TRulesetVariable[];
+    };
+    expandedNodeKeys?: TNodeKey[];
+    continuationToken?: {
+        prevHierarchyNode: string;
+        currHierarchyNode: string;
+    };
+    resultSetSize?: number;
+}
+/**
+ * Paging options
+ * @public
+ */
+export interface PageOptions {
+    /** Inclusive start 0-based index of the page */
+    start?: number;
+    /** Maximum size of the page */
+    size?: number;
+}
+/**
+ * A wrapper type that injects [[PageOptions]] into supplied type
+ * @public
+ */
+export declare type Paged<TOptions extends {}> = TOptions & {
+    /** Optional paging parameters */
+    paging?: PageOptions;
+};
+/**
+ * A wrapper type that injects priority into supplied type.
+ * @public
+ */
+export declare type Prioritized<TOptions extends {}> = TOptions & {
+    /** Optional priority */
+    priority?: number;
+};
+/**
+ * Checks if supplied request options are for single or multiple element properties.
+ * @beta
+ */
+export declare function isSingleElementPropertiesRequestOptions<TIModel>(options: ElementPropertiesRequestOptions<TIModel>): options is SingleElementPropertiesRequestOptions<TIModel>;
+/**
+ * A wrapper type that injects cancelEvent into supplied type.
+ * @public
+ */
+export declare type WithCancelEvent<TOptions extends {}> = TOptions & {
+    /** Event which is triggered when the request is canceled */
+    cancelEvent?: BeEvent<() => void>;
+};
 //# sourceMappingURL=PresentationManagerOptions.d.ts.map

package/lib/cjs/presentation-common/PresentationManagerOptions.js

@@ -1,24 +1,24 @@
-"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.isSingleElementPropertiesRequestOptions = exports.isComputeSelectionRequestOptions = void 0;
-/** @internal */
-function isComputeSelectionRequestOptions(options) {
-    return !!options.elementIds;
-}
-exports.isComputeSelectionRequestOptions = isComputeSelectionRequestOptions;
-/**
- * Checks if supplied request options are for single or multiple element properties.
- * @beta
- */
-function isSingleElementPropertiesRequestOptions(options) {
-    return options.elementId !== undefined;
-}
-exports.isSingleElementPropertiesRequestOptions = isSingleElementPropertiesRequestOptions;
+"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.isSingleElementPropertiesRequestOptions = exports.isComputeSelectionRequestOptions = void 0;
+/** @internal */
+function isComputeSelectionRequestOptions(options) {
+    return !!options.elementIds;
+}
+exports.isComputeSelectionRequestOptions = isComputeSelectionRequestOptions;
+/**
+ * Checks if supplied request options are for single or multiple element properties.
+ * @beta
+ */
+function isSingleElementPropertiesRequestOptions(options) {
+    return options.elementId !== undefined;
+}
+exports.isSingleElementPropertiesRequestOptions = isSingleElementPropertiesRequestOptions;
 //# sourceMappingURL=PresentationManagerOptions.js.map

package/lib/cjs/presentation-common/PresentationManagerOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"PresentationManagerOptions.js","sourceRoot":"","sources":["../../../src/presentation-common/PresentationManagerOptions.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA6NH,gBAAgB;AAChB,SAAgB,gCAAgC,CAAU,OAAwF;IAChJ,OAAO,CAAC,CAAE,OAAmD,CAAC,UAAU,CAAC;AAC3E,CAAC;AAFD,4EAEC;AAgDD;;;GAGG;AACH,SAAgB,uCAAuC,CAAU,OAAiD;IAChH,OAAQ,OAA0D,CAAC,SAAS,KAAK,SAAS,CAAC;AAC7F,CAAC;AAFD,0FAEC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Core\n */\n\nimport { BeEvent, Id64String } from \"@itwin/core-bentley\";\nimport { UnitSystemKey } from \"@itwin/core-quantity\";\nimport { SelectionInfo } from \"./content/Descriptor\";\nimport { FieldDescriptor } from \"./content/Fields\";\nimport { InstanceKey } from \"./EC\";\nimport { InstanceFilterDefinition } from \"./InstanceFilterDefinition\";\nimport { Ruleset } from \"./rules/Ruleset\";\nimport { RulesetVariable } from \"./RulesetVariables\";\nimport { SelectionScopeProps } from \"./selection/SelectionScope\";\n\n/**\n * A generic request options type used for both hierarchy and content requests.\n * @public\n */\nexport interface RequestOptions<TIModel> {\n  /** iModel to request data from */\n  imodel: TIModel;\n\n  /** Optional locale to use when formatting / localizing data */\n  locale?: string;\n\n  /**\n   * Unit system to use when formatting property values with units. Default presentation\n   * unit is used if unit system is not specified.\n   */\n  unitSystem?: UnitSystemKey;\n\n  /**\n   * Expected form of response. This property is set automatically on newer frontends.\n   * `unparsed-json` — deliver response from native addon without parsing it.\n   * @internal\n   */\n  transport?: \"unparsed-json\";\n}\n\n/**\n * Options for requests that require presentation ruleset. Not\n * meant to be used directly, see one of the subclasses.\n *\n * @public\n */\nexport interface RequestOptionsWithRuleset<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptions<TIModel> {\n  /** Ruleset or id of the ruleset to use when requesting data */\n  rulesetOrId: Ruleset | string;\n\n  /** Ruleset variables to use when requesting data */\n  rulesetVariables?: TRulesetVariable[];\n}\n\n/**\n * Request type for hierarchy requests.\n * @public\n */\nexport interface HierarchyRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  /** Key of the parent node to get children for */\n  parentKey?: TNodeKey;\n\n  /**\n   * An instance filter that should be applied for this hierarchy level.\n   * @alpha\n   */\n  instanceFilter?: InstanceFilterDefinition;\n}\n\n/**\n * Params for hierarchy level descriptor requests.\n * @alpha\n */\nexport interface HierarchyLevelDescriptorRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  /** Key of the parent node to get descriptor for */\n  parentKey?: TNodeKey;\n}\n\n/**\n * Request type of filtering hierarchies by given ECInstance paths.\n * @public\n */\nexport interface FilterByInstancePathsHierarchyRequestOptions<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  /** A list of paths from root ECInstance to target ECInstance. */\n  instancePaths: InstanceKey[][];\n\n  /**\n   * An optional index (`0 <= markedIndex < instancePaths.length`) to mark one of the instance paths. The\n   * path is marked using `NodePathElement.isMarked` flag in the result.\n   */\n  markedIndex?: number;\n}\n\n/**\n * Request type of filtering hierarchies by given text.\n * @public\n */\nexport interface FilterByTextHierarchyRequestOptions<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  /** Text to filter the hierarchy by. */\n  filterText: string;\n}\n\n/**\n * Request type for content sources requests.\n * @beta\n */\nexport interface ContentSourcesRequestOptions<TIModel> extends RequestOptions<TIModel> {\n  /** Full names of classes to get content sources for. */\n  classes: string[];\n}\n\n/**\n * Request type for content descriptor requests.\n * @public\n */\nexport interface ContentDescriptorRequestOptions<TIModel, TKeySet, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  /**\n   * Content display type.\n   * @see [[DefaultContentDisplayTypes]]\n   */\n  displayType: string;\n  /** Input keys for getting the content */\n  keys: TKeySet;\n  /** Information about the selection event that was the cause of this content request */\n  selection?: SelectionInfo;\n}\n\n/**\n * Request type for content requests.\n * @public\n */\nexport interface ContentRequestOptions<TIModel, TDescriptor, TKeySet, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  /** Content descriptor for customizing the returned content */\n  descriptor: TDescriptor;\n  /** Input keys for getting the content */\n  keys: TKeySet;\n}\n\n/**\n * Request type for distinct values' requests.\n * @public\n */\nexport interface DistinctValuesRequestOptions<TIModel, TDescriptor, TKeySet, TRulesetVariable = RulesetVariable> extends Paged<RequestOptionsWithRuleset<TIModel, TRulesetVariable>> {\n  /** Content descriptor for customizing the returned content */\n  descriptor: TDescriptor;\n  /** Input keys for getting the content */\n  keys: TKeySet;\n  /** Descriptor for a field distinct values are requested for */\n  fieldDescriptor: FieldDescriptor;\n}\n\n/**\n * Request type for element properties requests\n * @beta\n */\nexport type ElementPropertiesRequestOptions<TIModel> = SingleElementPropertiesRequestOptions<TIModel> | MultiElementPropertiesRequestOptions<TIModel>;\n\n/**\n * Request type for single element properties requests.\n * @beta\n */\nexport interface SingleElementPropertiesRequestOptions<TIModel> extends RequestOptions<TIModel> {\n  /** ID of the element to get properties for. */\n  elementId: Id64String;\n}\n\n/**\n * Request type for multiple elements properties requests.\n * @beta\n */\nexport interface MultiElementPropertiesRequestOptions<TIModel> extends RequestOptions<TIModel> {\n  /** Classes of the elements to get properties for. If `elementClasses` is undefined all classes\n   * are used. Classes should be specified in one of these formats: \"<schema name or alias>.<class_name>\",\n   * \"<schema name or alias>:<class_name>\".\n   */\n  elementClasses?: string[];\n}\n\n/**\n * Request type for content instance keys' requests.\n * @beta\n */\nexport interface ContentInstanceKeysRequestOptions<TIModel, TKeySet, TRulesetVariable = RulesetVariable> extends Paged<RequestOptionsWithRuleset<TIModel, TRulesetVariable>> {\n  /**\n   * Content display type.\n   * @see [[DefaultContentDisplayTypes]]\n   */\n  displayType?: string;\n  /** Input keys for getting the content. */\n  keys: TKeySet;\n}\n\n/**\n * Request type for label requests\n * @public\n */\nexport interface DisplayLabelRequestOptions<TIModel, TInstanceKey> extends RequestOptions<TIModel> {\n  /** Key of ECInstance to get label for */\n  key: TInstanceKey;\n}\n\n/**\n * Request type for labels requests\n * @public\n */\nexport interface DisplayLabelsRequestOptions<TIModel, TInstanceKey> extends RequestOptions<TIModel> {\n  /** Keys of ECInstances to get labels for */\n  keys: TInstanceKey[];\n}\n\n/**\n * Request options used for selection scope related requests\n * @public\n */\nexport interface SelectionScopeRequestOptions<TIModel> extends RequestOptions<TIModel> { } // eslint-disable-line @typescript-eslint/no-empty-interface\n\n/**\n * Request options used for calculating selection based on picked instance ksy and selection scope\n * @alpha\n */\nexport interface ComputeSelectionRequestOptions<TIModel> extends RequestOptions<TIModel> {\n  elementIds: Id64String[];\n  scope: SelectionScopeProps;\n}\n/** @internal */\nexport function isComputeSelectionRequestOptions<TIModel>(options: ComputeSelectionRequestOptions<TIModel> | SelectionScopeRequestOptions<TIModel>): options is ComputeSelectionRequestOptions<TIModel> {\n  return !!(options as ComputeSelectionRequestOptions<TIModel>).elementIds;\n}\n\n/**\n * Data structure for comparing a hierarchy after ruleset or ruleset variable changes.\n * @public\n */\nexport interface HierarchyCompareOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  prev: {\n    rulesetOrId?: Ruleset | string;\n    rulesetVariables?: TRulesetVariable[];\n  };\n  expandedNodeKeys?: TNodeKey[];\n  continuationToken?: {\n    prevHierarchyNode: string;\n    currHierarchyNode: string;\n  };\n  resultSetSize?: number;\n}\n\n/**\n * Paging options\n * @public\n */\nexport interface PageOptions {\n  /** Inclusive start 0-based index of the page */\n  start?: number;\n  /** Maximum size of the page */\n  size?: number;\n}\n\n/**\n * A wrapper type that injects [[PageOptions]] into supplied type\n * @public\n */\nexport type Paged<TOptions extends {}> = TOptions & {\n  /** Optional paging parameters */\n  paging?: PageOptions;\n};\n\n/**\n * A wrapper type that injects priority into supplied type.\n * @public\n */\nexport type Prioritized<TOptions extends {}> = TOptions & {\n  /** Optional priority */\n  priority?: number;\n};\n\n/**\n * Checks if supplied request options are for single or multiple element properties.\n * @beta\n */\nexport function isSingleElementPropertiesRequestOptions<TIModel>(options: ElementPropertiesRequestOptions<TIModel>): options is SingleElementPropertiesRequestOptions<TIModel> {\n  return (options as SingleElementPropertiesRequestOptions<TIModel>).elementId !== undefined;\n}\n\n/**\n * A wrapper type that injects cancelEvent into supplied type.\n * @public\n */\nexport type WithCancelEvent<TOptions extends {}> = TOptions & {\n  /** Event which is triggered when the request is canceled */\n  cancelEvent?: BeEvent<() => void>;\n};\n"]}
+{"version":3,"file":"PresentationManagerOptions.js","sourceRoot":"","sources":["../../../src/presentation-common/PresentationManagerOptions.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA6NH,gBAAgB;AAChB,SAAgB,gCAAgC,CAAU,OAAwF;IAChJ,OAAO,CAAC,CAAE,OAAmD,CAAC,UAAU,CAAC;AAC3E,CAAC;AAFD,4EAEC;AAgDD;;;GAGG;AACH,SAAgB,uCAAuC,CAAU,OAAiD;IAChH,OAAQ,OAA0D,CAAC,SAAS,KAAK,SAAS,CAAC;AAC7F,CAAC;AAFD,0FAEC","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 { BeEvent, Id64String } from \"@itwin/core-bentley\";\r\nimport { UnitSystemKey } from \"@itwin/core-quantity\";\r\nimport { SelectionInfo } from \"./content/Descriptor\";\r\nimport { FieldDescriptor } from \"./content/Fields\";\r\nimport { InstanceKey } from \"./EC\";\r\nimport { InstanceFilterDefinition } from \"./InstanceFilterDefinition\";\r\nimport { Ruleset } from \"./rules/Ruleset\";\r\nimport { RulesetVariable } from \"./RulesetVariables\";\r\nimport { SelectionScopeProps } from \"./selection/SelectionScope\";\r\n\r\n/**\r\n * A generic request options type used for both hierarchy and content requests.\r\n * @public\r\n */\r\nexport interface RequestOptions<TIModel> {\r\n  /** iModel to request data from */\r\n  imodel: TIModel;\r\n\r\n  /** Optional locale to use when formatting / localizing data */\r\n  locale?: string;\r\n\r\n  /**\r\n   * Unit system to use when formatting property values with units. Default presentation\r\n   * unit is used if unit system is not specified.\r\n   */\r\n  unitSystem?: UnitSystemKey;\r\n\r\n  /**\r\n   * Expected form of response. This property is set automatically on newer frontends.\r\n   * `unparsed-json` — deliver response from native addon without parsing it.\r\n   * @internal\r\n   */\r\n  transport?: \"unparsed-json\";\r\n}\r\n\r\n/**\r\n * Options for requests that require presentation ruleset. Not\r\n * meant to be used directly, see one of the subclasses.\r\n *\r\n * @public\r\n */\r\nexport interface RequestOptionsWithRuleset<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptions<TIModel> {\r\n  /** Ruleset or id of the ruleset to use when requesting data */\r\n  rulesetOrId: Ruleset | string;\r\n\r\n  /** Ruleset variables to use when requesting data */\r\n  rulesetVariables?: TRulesetVariable[];\r\n}\r\n\r\n/**\r\n * Request type for hierarchy requests.\r\n * @public\r\n */\r\nexport interface HierarchyRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\r\n  /** Key of the parent node to get children for */\r\n  parentKey?: TNodeKey;\r\n\r\n  /**\r\n   * An instance filter that should be applied for this hierarchy level.\r\n   * @alpha\r\n   */\r\n  instanceFilter?: InstanceFilterDefinition;\r\n}\r\n\r\n/**\r\n * Params for hierarchy level descriptor requests.\r\n * @alpha\r\n */\r\nexport interface HierarchyLevelDescriptorRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\r\n  /** Key of the parent node to get descriptor for */\r\n  parentKey?: TNodeKey;\r\n}\r\n\r\n/**\r\n * Request type of filtering hierarchies by given ECInstance paths.\r\n * @public\r\n */\r\nexport interface FilterByInstancePathsHierarchyRequestOptions<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\r\n  /** A list of paths from root ECInstance to target ECInstance. */\r\n  instancePaths: InstanceKey[][];\r\n\r\n  /**\r\n   * An optional index (`0 <= markedIndex < instancePaths.length`) to mark one of the instance paths. The\r\n   * path is marked using `NodePathElement.isMarked` flag in the result.\r\n   */\r\n  markedIndex?: number;\r\n}\r\n\r\n/**\r\n * Request type of filtering hierarchies by given text.\r\n * @public\r\n */\r\nexport interface FilterByTextHierarchyRequestOptions<TIModel, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\r\n  /** Text to filter the hierarchy by. */\r\n  filterText: string;\r\n}\r\n\r\n/**\r\n * Request type for content sources requests.\r\n * @beta\r\n */\r\nexport interface ContentSourcesRequestOptions<TIModel> extends RequestOptions<TIModel> {\r\n  /** Full names of classes to get content sources for. */\r\n  classes: string[];\r\n}\r\n\r\n/**\r\n * Request type for content descriptor requests.\r\n * @public\r\n */\r\nexport interface ContentDescriptorRequestOptions<TIModel, TKeySet, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\r\n  /**\r\n   * Content display type.\r\n   * @see [[DefaultContentDisplayTypes]]\r\n   */\r\n  displayType: string;\r\n  /** Input keys for getting the content */\r\n  keys: TKeySet;\r\n  /** Information about the selection event that was the cause of this content request */\r\n  selection?: SelectionInfo;\r\n}\r\n\r\n/**\r\n * Request type for content requests.\r\n * @public\r\n */\r\nexport interface ContentRequestOptions<TIModel, TDescriptor, TKeySet, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\r\n  /** Content descriptor for customizing the returned content */\r\n  descriptor: TDescriptor;\r\n  /** Input keys for getting the content */\r\n  keys: TKeySet;\r\n}\r\n\r\n/**\r\n * Request type for distinct values' requests.\r\n * @public\r\n */\r\nexport interface DistinctValuesRequestOptions<TIModel, TDescriptor, TKeySet, TRulesetVariable = RulesetVariable> extends Paged<RequestOptionsWithRuleset<TIModel, TRulesetVariable>> {\r\n  /** Content descriptor for customizing the returned content */\r\n  descriptor: TDescriptor;\r\n  /** Input keys for getting the content */\r\n  keys: TKeySet;\r\n  /** Descriptor for a field distinct values are requested for */\r\n  fieldDescriptor: FieldDescriptor;\r\n}\r\n\r\n/**\r\n * Request type for element properties requests\r\n * @beta\r\n */\r\nexport type ElementPropertiesRequestOptions<TIModel> = SingleElementPropertiesRequestOptions<TIModel> | MultiElementPropertiesRequestOptions<TIModel>;\r\n\r\n/**\r\n * Request type for single element properties requests.\r\n * @beta\r\n */\r\nexport interface SingleElementPropertiesRequestOptions<TIModel> extends RequestOptions<TIModel> {\r\n  /** ID of the element to get properties for. */\r\n  elementId: Id64String;\r\n}\r\n\r\n/**\r\n * Request type for multiple elements properties requests.\r\n * @beta\r\n */\r\nexport interface MultiElementPropertiesRequestOptions<TIModel> extends RequestOptions<TIModel> {\r\n  /** Classes of the elements to get properties for. If `elementClasses` is undefined all classes\r\n   * are used. Classes should be specified in one of these formats: \"<schema name or alias>.<class_name>\",\r\n   * \"<schema name or alias>:<class_name>\".\r\n   */\r\n  elementClasses?: string[];\r\n}\r\n\r\n/**\r\n * Request type for content instance keys' requests.\r\n * @beta\r\n */\r\nexport interface ContentInstanceKeysRequestOptions<TIModel, TKeySet, TRulesetVariable = RulesetVariable> extends Paged<RequestOptionsWithRuleset<TIModel, TRulesetVariable>> {\r\n  /**\r\n   * Content display type.\r\n   * @see [[DefaultContentDisplayTypes]]\r\n   */\r\n  displayType?: string;\r\n  /** Input keys for getting the content. */\r\n  keys: TKeySet;\r\n}\r\n\r\n/**\r\n * Request type for label requests\r\n * @public\r\n */\r\nexport interface DisplayLabelRequestOptions<TIModel, TInstanceKey> extends RequestOptions<TIModel> {\r\n  /** Key of ECInstance to get label for */\r\n  key: TInstanceKey;\r\n}\r\n\r\n/**\r\n * Request type for labels requests\r\n * @public\r\n */\r\nexport interface DisplayLabelsRequestOptions<TIModel, TInstanceKey> extends RequestOptions<TIModel> {\r\n  /** Keys of ECInstances to get labels for */\r\n  keys: TInstanceKey[];\r\n}\r\n\r\n/**\r\n * Request options used for selection scope related requests\r\n * @public\r\n */\r\nexport interface SelectionScopeRequestOptions<TIModel> extends RequestOptions<TIModel> { } // eslint-disable-line @typescript-eslint/no-empty-interface\r\n\r\n/**\r\n * Request options used for calculating selection based on picked instance ksy and selection scope\r\n * @alpha\r\n */\r\nexport interface ComputeSelectionRequestOptions<TIModel> extends RequestOptions<TIModel> {\r\n  elementIds: Id64String[];\r\n  scope: SelectionScopeProps;\r\n}\r\n/** @internal */\r\nexport function isComputeSelectionRequestOptions<TIModel>(options: ComputeSelectionRequestOptions<TIModel> | SelectionScopeRequestOptions<TIModel>): options is ComputeSelectionRequestOptions<TIModel> {\r\n  return !!(options as ComputeSelectionRequestOptions<TIModel>).elementIds;\r\n}\r\n\r\n/**\r\n * Data structure for comparing a hierarchy after ruleset or ruleset variable changes.\r\n * @public\r\n */\r\nexport interface HierarchyCompareOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\r\n  prev: {\r\n    rulesetOrId?: Ruleset | string;\r\n    rulesetVariables?: TRulesetVariable[];\r\n  };\r\n  expandedNodeKeys?: TNodeKey[];\r\n  continuationToken?: {\r\n    prevHierarchyNode: string;\r\n    currHierarchyNode: string;\r\n  };\r\n  resultSetSize?: number;\r\n}\r\n\r\n/**\r\n * Paging options\r\n * @public\r\n */\r\nexport interface PageOptions {\r\n  /** Inclusive start 0-based index of the page */\r\n  start?: number;\r\n  /** Maximum size of the page */\r\n  size?: number;\r\n}\r\n\r\n/**\r\n * A wrapper type that injects [[PageOptions]] into supplied type\r\n * @public\r\n */\r\nexport type Paged<TOptions extends {}> = TOptions & {\r\n  /** Optional paging parameters */\r\n  paging?: PageOptions;\r\n};\r\n\r\n/**\r\n * A wrapper type that injects priority into supplied type.\r\n * @public\r\n */\r\nexport type Prioritized<TOptions extends {}> = TOptions & {\r\n  /** Optional priority */\r\n  priority?: number;\r\n};\r\n\r\n/**\r\n * Checks if supplied request options are for single or multiple element properties.\r\n * @beta\r\n */\r\nexport function isSingleElementPropertiesRequestOptions<TIModel>(options: ElementPropertiesRequestOptions<TIModel>): options is SingleElementPropertiesRequestOptions<TIModel> {\r\n  return (options as SingleElementPropertiesRequestOptions<TIModel>).elementId !== undefined;\r\n}\r\n\r\n/**\r\n * A wrapper type that injects cancelEvent into supplied type.\r\n * @public\r\n */\r\nexport type WithCancelEvent<TOptions extends {}> = TOptions & {\r\n  /** Event which is triggered when the request is canceled */\r\n  cancelEvent?: BeEvent<() => void>;\r\n};\r\n"]}