@itwin/presentation-common 4.0.0-dev.48 → 4.0.0-dev.50

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;;;AA+OH,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   *\n   * **Note:** May only be used on hierarchy levels that support filtering - check [[NavNode.supportsFiltering]] before\n   * requesting filtered children.\n   *\n   * @beta\n   */\n  instanceFilter?: InstanceFilterDefinition;\n\n  /**\n   * A limit to how many instances at most should be loaded for a hierarchy level. If the limit is exceeded,\n   * the request fails with [[PresentationError]] having [[PresentationStatus.ResultSetTooLarge]] error number.\n   *\n   * Specifying the limit is useful when creating unlimited size result sets is not meaningful - this allows the library\n   * to return early as soon as the limit is reached, instead of creating a very large result that's possibly too large to\n   * be useful to be displayed to end users.\n   *\n   * @see [Hierarchies' filtering and limiting]($docs/presentation/hierarchies/FilteringLimiting.md)\n   * @beta\n   */\n  sizeLimit?: number;\n}\n\n/**\n * Params for hierarchy level descriptor requests.\n * @beta\n */\nexport interface HierarchyLevelDescriptorRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  /** Key of the parent node to get hierarchy level 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 * @public\n */\nexport interface ContentSourcesRequestOptions<TIModel> extends RequestOptions<TIModel> {\n  /** Full names of classes to get content sources for. Format for a full class name: `SchemaName:ClassName`. */\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 * @public\n */\nexport type ElementPropertiesRequestOptions<TIModel> = SingleElementPropertiesRequestOptions<TIModel> | MultiElementPropertiesRequestOptions<TIModel>;\n\n/**\n * Request type for single element properties requests.\n * @public\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 * @public\n */\nexport interface MultiElementPropertiesRequestOptions<TIModel> extends RequestOptions<TIModel> {\n  /**\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>\" or\n   * \"<schema name or alias>:<class_name>\".\n   */\n  elementClasses?: string[];\n}\n\n/**\n * Request type for content instance keys' requests.\n * @public\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 given instance keys and selection scope.\n * @public\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 * @internal\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;;;AA+OH,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   *\r\n   * **Note:** May only be used on hierarchy levels that support filtering - check [[NavNode.supportsFiltering]] before\r\n   * requesting filtered children.\r\n   *\r\n   * @beta\r\n   */\r\n  instanceFilter?: InstanceFilterDefinition;\r\n\r\n  /**\r\n   * A limit to how many instances at most should be loaded for a hierarchy level. If the limit is exceeded,\r\n   * the request fails with [[PresentationError]] having [[PresentationStatus.ResultSetTooLarge]] error number.\r\n   *\r\n   * Specifying the limit is useful when creating unlimited size result sets is not meaningful - this allows the library\r\n   * to return early as soon as the limit is reached, instead of creating a very large result that's possibly too large to\r\n   * be useful to be displayed to end users.\r\n   *\r\n   * @see [Hierarchies' filtering and limiting]($docs/presentation/hierarchies/FilteringLimiting.md)\r\n   * @beta\r\n   */\r\n  sizeLimit?: number;\r\n}\r\n\r\n/**\r\n * Params for hierarchy level descriptor requests.\r\n * @beta\r\n */\r\nexport interface HierarchyLevelDescriptorRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable> extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\r\n  /** Key of the parent node to get hierarchy level 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 * @public\r\n */\r\nexport interface ContentSourcesRequestOptions<TIModel> extends RequestOptions<TIModel> {\r\n  /** Full names of classes to get content sources for. Format for a full class name: `SchemaName:ClassName`. */\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 * @public\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 * @public\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 * @public\r\n */\r\nexport interface MultiElementPropertiesRequestOptions<TIModel> extends RequestOptions<TIModel> {\r\n  /**\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>\" or\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 * @public\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 given instance keys and selection scope.\r\n * @public\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 * @internal\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"]}

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

@@ -1,187 +1,187 @@
-/** @packageDocumentation
- * @module RPC
- */
-import { Id64String } from "@itwin/core-bentley";
-import { IModelRpcProps, RpcInterface } from "@itwin/core-common";
-import { DescriptorJSON, DescriptorOverrides, SelectClassInfoJSON } from "./content/Descriptor";
-import { ItemJSON } from "./content/Item";
-import { DisplayValueGroupJSON } from "./content/Value";
-import { ClientDiagnostics, ClientDiagnosticsOptions } from "./Diagnostics";
-import { CompressedClassInfoJSON, InstanceKey } from "./EC";
-import { ElementProperties } from "./ElementProperties";
-import { PresentationStatus } from "./Error";
-import { NodeKey } from "./hierarchy/Key";
-import { NodeJSON } from "./hierarchy/Node";
-import { NodePathElementJSON } from "./hierarchy/NodePathElement";
-import { KeySetJSON } from "./KeySet";
-import { LabelDefinition } from "./LabelDefinition";
-import { ComputeSelectionRequestOptions, ContentDescriptorRequestOptions, ContentInstanceKeysRequestOptions, ContentRequestOptions, ContentSourcesRequestOptions, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DistinctValuesRequestOptions, FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, HierarchyLevelDescriptorRequestOptions, HierarchyRequestOptions, Paged, SelectionScopeRequestOptions, SingleElementPropertiesRequestOptions } from "./PresentationManagerOptions";
-import { RulesetVariableJSON } from "./RulesetVariables";
-import { SelectionScope } from "./selection/SelectionScope";
-import { Omit, PagedResponse } from "./Utils";
-/**
- * Base options for all presentation RPC requests.
- * @public
- */
-export declare type PresentationRpcRequestOptions<TManagerRequestOptions> = Omit<TManagerRequestOptions, "imodel" | "diagnostics"> & {
-    /** @internal ID of the client requesting data */
-    clientId?: string;
-    /**
-     * RPC request diagnostics options.
-     * @beta
-     */
-    diagnostics?: RpcDiagnosticsOptions;
-};
-/**
- * Data structure for presentation RPC responses
- * @public
- */
-export interface PresentationRpcResponseData<TResult = undefined> {
-    /** Response status code */
-    statusCode: PresentationStatus;
-    /** In case of an error response, the error message */
-    errorMessage?: string;
-    /** In case of a success response, the result */
-    result?: TResult;
-    /**
-     * Diagnostics response.
-     * @beta
-     */
-    diagnostics?: ClientDiagnostics;
-}
-/**
- * Data structure for RPC diagnostics options.
- * @beta
- */
-export declare type RpcDiagnosticsOptions = Omit<ClientDiagnosticsOptions, "handler">;
-/**
- * A promise of [[PresentationRpcResponseData]].
- * @public
- */
-export declare type PresentationRpcResponse<TResult = undefined> = Promise<PresentationRpcResponseData<TResult>>;
-/**
- * Data structure for hierarchy request options.
- * @public
- */
-export declare type HierarchyRpcRequestOptions = PresentationRpcRequestOptions<HierarchyRequestOptions<never, NodeKey, RulesetVariableJSON>>;
-/**
- * Data structure for hierarchy level descriptor RPC request options.
- * @beta
- */
-export declare type HierarchyLevelDescriptorRpcRequestOptions = PresentationRpcRequestOptions<HierarchyLevelDescriptorRequestOptions<never, NodeKey, RulesetVariableJSON>>;
-/**
- * Data structure for filtering hierarchy by ECInstance paths request options.
- * @public
- */
-export declare type FilterByInstancePathsHierarchyRpcRequestOptions = PresentationRpcRequestOptions<FilterByInstancePathsHierarchyRequestOptions<never, RulesetVariableJSON>>;
-/**
- * Data structure for filtering hierarchy by text request options.
- * @public
- */
-export declare type FilterByTextHierarchyRpcRequestOptions = PresentationRpcRequestOptions<FilterByTextHierarchyRequestOptions<never, RulesetVariableJSON>>;
-/**
- * Data structure for content sources RPC request options.
- * @public
- */
-export declare type ContentSourcesRpcRequestOptions = PresentationRpcRequestOptions<ContentSourcesRequestOptions<never>>;
-/**
- * Data structure for content sources RPC response.
- * @public
- */
-export interface ContentSourcesRpcResult {
-    /** A list of objects containing content source information. */
-    sources: SelectClassInfoJSON<Id64String>[];
-    /** An `ECClassId` => [[CompressedClassInfoJSON]] map for deserializing [[sources]]. */
-    classesMap: {
-        [id: string]: CompressedClassInfoJSON;
-    };
-}
-/**
- * Data structure for content descriptor RPC request options.
- * @public
- */
-export declare type ContentDescriptorRpcRequestOptions = PresentationRpcRequestOptions<ContentDescriptorRequestOptions<never, KeySetJSON, RulesetVariableJSON>>;
-/**
- * Data structure for content RPC request options.
- * @public
- */
-export declare type ContentRpcRequestOptions = PresentationRpcRequestOptions<ContentRequestOptions<never, DescriptorOverrides, KeySetJSON, RulesetVariableJSON>>;
-/**
- * Data structure for single element properties RPC request options.
- * @public
- */
-export declare type SingleElementPropertiesRpcRequestOptions = PresentationRpcRequestOptions<SingleElementPropertiesRequestOptions<never>>;
-/**
- * Data structure for distinct values' request options.
- * @public
- */
-export declare type DistinctValuesRpcRequestOptions = PresentationRpcRequestOptions<DistinctValuesRequestOptions<never, DescriptorOverrides, KeySetJSON, RulesetVariableJSON>>;
-/**
- * Data structure for content instance keys' request options.
- * @public
- */
-export declare type ContentInstanceKeysRpcRequestOptions = PresentationRpcRequestOptions<ContentInstanceKeysRequestOptions<never, KeySetJSON, RulesetVariableJSON>>;
-/**
- * Data structure for label request options.
- * @public
- */
-export declare type DisplayLabelRpcRequestOptions = PresentationRpcRequestOptions<DisplayLabelRequestOptions<never, InstanceKey>>;
-/**
- * Data structure for labels request options.
- * @public
- */
-export declare type DisplayLabelsRpcRequestOptions = PresentationRpcRequestOptions<DisplayLabelsRequestOptions<never, InstanceKey>>;
-/**
- * Data structure for selection scope request options.
- * @public
- */
-export declare type SelectionScopeRpcRequestOptions = PresentationRpcRequestOptions<SelectionScopeRequestOptions<never>>;
-/**
- * Request options data structure for computing selection based on given selection scope and element IDs.
- * @public
- */
-export declare type ComputeSelectionRpcRequestOptions = PresentationRpcRequestOptions<ComputeSelectionRequestOptions<never>>;
-/**
- * Interface used for communication between Presentation backend and frontend.
- * @public
- */
-export declare class PresentationRpcInterface extends RpcInterface {
-    /** The immutable name of the interface. */
-    static readonly interfaceName = "PresentationRpcInterface";
-    /** The semantic version of the interface. */
-    static interfaceVersion: string;
-    getNodesCount(_token: IModelRpcProps, _options: HierarchyRpcRequestOptions): PresentationRpcResponse<number>;
-    getPagedNodes(_token: IModelRpcProps, _options: Paged<HierarchyRpcRequestOptions>): PresentationRpcResponse<PagedResponse<NodeJSON>>;
-    /** @beta */
-    getNodesDescriptor(_token: IModelRpcProps, _options: HierarchyLevelDescriptorRpcRequestOptions): PresentationRpcResponse<string | DescriptorJSON | undefined>;
-    getNodePaths(_token: IModelRpcProps, _options: FilterByInstancePathsHierarchyRpcRequestOptions): PresentationRpcResponse<NodePathElementJSON[]>;
-    getFilteredNodePaths(_token: IModelRpcProps, _options: FilterByTextHierarchyRpcRequestOptions): PresentationRpcResponse<NodePathElementJSON[]>;
-    getContentSources(_token: IModelRpcProps, _options: ContentSourcesRpcRequestOptions): PresentationRpcResponse<ContentSourcesRpcResult>;
-    getContentDescriptor(_token: IModelRpcProps, _options: ContentDescriptorRpcRequestOptions): PresentationRpcResponse<DescriptorJSON | undefined>;
-    getContentSetSize(_token: IModelRpcProps, _options: ContentRpcRequestOptions): PresentationRpcResponse<number>;
-    getPagedContent(_token: IModelRpcProps, _options: Paged<ContentRpcRequestOptions>): PresentationRpcResponse<{
-        descriptor: DescriptorJSON;
-        contentSet: PagedResponse<ItemJSON>;
-    } | undefined>;
-    getPagedContentSet(_token: IModelRpcProps, _options: Paged<ContentRpcRequestOptions>): PresentationRpcResponse<PagedResponse<ItemJSON>>;
-    getElementProperties(_token: IModelRpcProps, _options: SingleElementPropertiesRpcRequestOptions): PresentationRpcResponse<ElementProperties | undefined>;
-    getPagedDistinctValues(_token: IModelRpcProps, _options: DistinctValuesRpcRequestOptions): PresentationRpcResponse<PagedResponse<DisplayValueGroupJSON>>;
-    getContentInstanceKeys(_token: IModelRpcProps, _options: ContentInstanceKeysRpcRequestOptions): PresentationRpcResponse<{
-        total: number;
-        items: KeySetJSON;
-    }>;
-    getDisplayLabelDefinition(_token: IModelRpcProps, _options: DisplayLabelRpcRequestOptions): PresentationRpcResponse<LabelDefinition>;
-    getPagedDisplayLabelDefinitions(_token: IModelRpcProps, _options: DisplayLabelsRpcRequestOptions): PresentationRpcResponse<PagedResponse<LabelDefinition>>;
-    getSelectionScopes(_token: IModelRpcProps, _options: SelectionScopeRpcRequestOptions): PresentationRpcResponse<SelectionScope[]>;
-    /** @deprecated in 3.x. Use the override with [[ComputeSelectionRpcRequestOptions]]. */
-    computeSelection(_token: IModelRpcProps, _options: SelectionScopeRpcRequestOptions, _ids: Id64String[], _scopeId: string): PresentationRpcResponse<KeySetJSON>;
-    computeSelection(_token: IModelRpcProps, _options: ComputeSelectionRpcRequestOptions): PresentationRpcResponse<KeySetJSON>;
-}
-/** @internal */
-export declare enum PresentationIpcEvents {
-    /**
-     * ID of an event that's emitted when backend detects changes in presented data.
-     */
-    Update = "presentation.onUpdate"
-}
+/** @packageDocumentation
+ * @module RPC
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { IModelRpcProps, RpcInterface } from "@itwin/core-common";
+import { DescriptorJSON, DescriptorOverrides, SelectClassInfoJSON } from "./content/Descriptor";
+import { ItemJSON } from "./content/Item";
+import { DisplayValueGroupJSON } from "./content/Value";
+import { ClientDiagnostics, ClientDiagnosticsOptions } from "./Diagnostics";
+import { CompressedClassInfoJSON, InstanceKey } from "./EC";
+import { ElementProperties } from "./ElementProperties";
+import { PresentationStatus } from "./Error";
+import { NodeKey } from "./hierarchy/Key";
+import { NodeJSON } from "./hierarchy/Node";
+import { NodePathElementJSON } from "./hierarchy/NodePathElement";
+import { KeySetJSON } from "./KeySet";
+import { LabelDefinition } from "./LabelDefinition";
+import { ComputeSelectionRequestOptions, ContentDescriptorRequestOptions, ContentInstanceKeysRequestOptions, ContentRequestOptions, ContentSourcesRequestOptions, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DistinctValuesRequestOptions, FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, HierarchyLevelDescriptorRequestOptions, HierarchyRequestOptions, Paged, SelectionScopeRequestOptions, SingleElementPropertiesRequestOptions } from "./PresentationManagerOptions";
+import { RulesetVariableJSON } from "./RulesetVariables";
+import { SelectionScope } from "./selection/SelectionScope";
+import { Omit, PagedResponse } from "./Utils";
+/**
+ * Base options for all presentation RPC requests.
+ * @public
+ */
+export declare type PresentationRpcRequestOptions<TManagerRequestOptions> = Omit<TManagerRequestOptions, "imodel" | "diagnostics"> & {
+    /** @internal ID of the client requesting data */
+    clientId?: string;
+    /**
+     * RPC request diagnostics options.
+     * @beta
+     */
+    diagnostics?: RpcDiagnosticsOptions;
+};
+/**
+ * Data structure for presentation RPC responses
+ * @public
+ */
+export interface PresentationRpcResponseData<TResult = undefined> {
+    /** Response status code */
+    statusCode: PresentationStatus;
+    /** In case of an error response, the error message */
+    errorMessage?: string;
+    /** In case of a success response, the result */
+    result?: TResult;
+    /**
+     * Diagnostics response.
+     * @beta
+     */
+    diagnostics?: ClientDiagnostics;
+}
+/**
+ * Data structure for RPC diagnostics options.
+ * @beta
+ */
+export declare type RpcDiagnosticsOptions = Omit<ClientDiagnosticsOptions, "handler">;
+/**
+ * A promise of [[PresentationRpcResponseData]].
+ * @public
+ */
+export declare type PresentationRpcResponse<TResult = undefined> = Promise<PresentationRpcResponseData<TResult>>;
+/**
+ * Data structure for hierarchy request options.
+ * @public
+ */
+export declare type HierarchyRpcRequestOptions = PresentationRpcRequestOptions<HierarchyRequestOptions<never, NodeKey, RulesetVariableJSON>>;
+/**
+ * Data structure for hierarchy level descriptor RPC request options.
+ * @beta
+ */
+export declare type HierarchyLevelDescriptorRpcRequestOptions = PresentationRpcRequestOptions<HierarchyLevelDescriptorRequestOptions<never, NodeKey, RulesetVariableJSON>>;
+/**
+ * Data structure for filtering hierarchy by ECInstance paths request options.
+ * @public
+ */
+export declare type FilterByInstancePathsHierarchyRpcRequestOptions = PresentationRpcRequestOptions<FilterByInstancePathsHierarchyRequestOptions<never, RulesetVariableJSON>>;
+/**
+ * Data structure for filtering hierarchy by text request options.
+ * @public
+ */
+export declare type FilterByTextHierarchyRpcRequestOptions = PresentationRpcRequestOptions<FilterByTextHierarchyRequestOptions<never, RulesetVariableJSON>>;
+/**
+ * Data structure for content sources RPC request options.
+ * @public
+ */
+export declare type ContentSourcesRpcRequestOptions = PresentationRpcRequestOptions<ContentSourcesRequestOptions<never>>;
+/**
+ * Data structure for content sources RPC response.
+ * @public
+ */
+export interface ContentSourcesRpcResult {
+    /** A list of objects containing content source information. */
+    sources: SelectClassInfoJSON<Id64String>[];
+    /** An `ECClassId` => [[CompressedClassInfoJSON]] map for deserializing [[sources]]. */
+    classesMap: {
+        [id: string]: CompressedClassInfoJSON;
+    };
+}
+/**
+ * Data structure for content descriptor RPC request options.
+ * @public
+ */
+export declare type ContentDescriptorRpcRequestOptions = PresentationRpcRequestOptions<ContentDescriptorRequestOptions<never, KeySetJSON, RulesetVariableJSON>>;
+/**
+ * Data structure for content RPC request options.
+ * @public
+ */
+export declare type ContentRpcRequestOptions = PresentationRpcRequestOptions<ContentRequestOptions<never, DescriptorOverrides, KeySetJSON, RulesetVariableJSON>>;
+/**
+ * Data structure for single element properties RPC request options.
+ * @public
+ */
+export declare type SingleElementPropertiesRpcRequestOptions = PresentationRpcRequestOptions<SingleElementPropertiesRequestOptions<never>>;
+/**
+ * Data structure for distinct values' request options.
+ * @public
+ */
+export declare type DistinctValuesRpcRequestOptions = PresentationRpcRequestOptions<DistinctValuesRequestOptions<never, DescriptorOverrides, KeySetJSON, RulesetVariableJSON>>;
+/**
+ * Data structure for content instance keys' request options.
+ * @public
+ */
+export declare type ContentInstanceKeysRpcRequestOptions = PresentationRpcRequestOptions<ContentInstanceKeysRequestOptions<never, KeySetJSON, RulesetVariableJSON>>;
+/**
+ * Data structure for label request options.
+ * @public
+ */
+export declare type DisplayLabelRpcRequestOptions = PresentationRpcRequestOptions<DisplayLabelRequestOptions<never, InstanceKey>>;
+/**
+ * Data structure for labels request options.
+ * @public
+ */
+export declare type DisplayLabelsRpcRequestOptions = PresentationRpcRequestOptions<DisplayLabelsRequestOptions<never, InstanceKey>>;
+/**
+ * Data structure for selection scope request options.
+ * @public
+ */
+export declare type SelectionScopeRpcRequestOptions = PresentationRpcRequestOptions<SelectionScopeRequestOptions<never>>;
+/**
+ * Request options data structure for computing selection based on given selection scope and element IDs.
+ * @public
+ */
+export declare type ComputeSelectionRpcRequestOptions = PresentationRpcRequestOptions<ComputeSelectionRequestOptions<never>>;
+/**
+ * Interface used for communication between Presentation backend and frontend.
+ * @public
+ */
+export declare class PresentationRpcInterface extends RpcInterface {
+    /** The immutable name of the interface. */
+    static readonly interfaceName = "PresentationRpcInterface";
+    /** The semantic version of the interface. */
+    static interfaceVersion: string;
+    getNodesCount(_token: IModelRpcProps, _options: HierarchyRpcRequestOptions): PresentationRpcResponse<number>;
+    getPagedNodes(_token: IModelRpcProps, _options: Paged<HierarchyRpcRequestOptions>): PresentationRpcResponse<PagedResponse<NodeJSON>>;
+    /** @beta */
+    getNodesDescriptor(_token: IModelRpcProps, _options: HierarchyLevelDescriptorRpcRequestOptions): PresentationRpcResponse<string | DescriptorJSON | undefined>;
+    getNodePaths(_token: IModelRpcProps, _options: FilterByInstancePathsHierarchyRpcRequestOptions): PresentationRpcResponse<NodePathElementJSON[]>;
+    getFilteredNodePaths(_token: IModelRpcProps, _options: FilterByTextHierarchyRpcRequestOptions): PresentationRpcResponse<NodePathElementJSON[]>;
+    getContentSources(_token: IModelRpcProps, _options: ContentSourcesRpcRequestOptions): PresentationRpcResponse<ContentSourcesRpcResult>;
+    getContentDescriptor(_token: IModelRpcProps, _options: ContentDescriptorRpcRequestOptions): PresentationRpcResponse<DescriptorJSON | undefined>;
+    getContentSetSize(_token: IModelRpcProps, _options: ContentRpcRequestOptions): PresentationRpcResponse<number>;
+    getPagedContent(_token: IModelRpcProps, _options: Paged<ContentRpcRequestOptions>): PresentationRpcResponse<{
+        descriptor: DescriptorJSON;
+        contentSet: PagedResponse<ItemJSON>;
+    } | undefined>;
+    getPagedContentSet(_token: IModelRpcProps, _options: Paged<ContentRpcRequestOptions>): PresentationRpcResponse<PagedResponse<ItemJSON>>;
+    getElementProperties(_token: IModelRpcProps, _options: SingleElementPropertiesRpcRequestOptions): PresentationRpcResponse<ElementProperties | undefined>;
+    getPagedDistinctValues(_token: IModelRpcProps, _options: DistinctValuesRpcRequestOptions): PresentationRpcResponse<PagedResponse<DisplayValueGroupJSON>>;
+    getContentInstanceKeys(_token: IModelRpcProps, _options: ContentInstanceKeysRpcRequestOptions): PresentationRpcResponse<{
+        total: number;
+        items: KeySetJSON;
+    }>;
+    getDisplayLabelDefinition(_token: IModelRpcProps, _options: DisplayLabelRpcRequestOptions): PresentationRpcResponse<LabelDefinition>;
+    getPagedDisplayLabelDefinitions(_token: IModelRpcProps, _options: DisplayLabelsRpcRequestOptions): PresentationRpcResponse<PagedResponse<LabelDefinition>>;
+    getSelectionScopes(_token: IModelRpcProps, _options: SelectionScopeRpcRequestOptions): PresentationRpcResponse<SelectionScope[]>;
+    /** @deprecated in 3.x. Use the override with [[ComputeSelectionRpcRequestOptions]]. */
+    computeSelection(_token: IModelRpcProps, _options: SelectionScopeRpcRequestOptions, _ids: Id64String[], _scopeId: string): PresentationRpcResponse<KeySetJSON>;
+    computeSelection(_token: IModelRpcProps, _options: ComputeSelectionRpcRequestOptions): PresentationRpcResponse<KeySetJSON>;
+}
+/** @internal */
+export declare enum PresentationIpcEvents {
+    /**
+     * ID of an event that's emitted when backend detects changes in presented data.
+     */
+    Update = "presentation.onUpdate"
+}
 //# sourceMappingURL=PresentationRpcInterface.d.ts.map