@itwin/presentation-common 5.0.0-dev.4 → 5.0.0-dev.41

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

@@ -1 +1 @@
-{"version":3,"file":"PresentationManagerOptions.js","sourceRoot":"","sources":["../../../src/presentation-common/PresentationManagerOptions.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAoRH,gBAAgB;AAChB,MAAM,UAAU,gCAAgC,CAC9C,OAAwF;IAExF,OAAO,CAAC,CAAE,OAAmD,CAAC,UAAU,CAAC;AAC3E,CAAC;AAgDD;;;GAGG;AACH,MAAM,UAAU,uCAAuC,CACrD,OAAuH;IAEvH,OAAQ,OAA0D,CAAC,SAAS,KAAK,SAAS,CAAC;AAC7F,CAAC","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 { Descriptor, SelectionInfo } from \"./content/Descriptor\";\nimport { FieldDescriptor } from \"./content/Fields\";\nimport { Item } from \"./content/Item\";\nimport { InstanceKey } from \"./EC\";\nimport { ElementProperties } from \"./ElementProperties\";\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  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   */\n  sizeLimit?: number;\n}\n\n/**\n * Params for hierarchy level descriptor requests.\n * @public\n */\nexport interface HierarchyLevelDescriptorRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable>\n  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>\n  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>\n  extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\n  /**\n   * Content display type.\n   * @see [[DefaultContentDisplayTypes]]\n   */\n  displayType: string;\n  /**\n   * Content flags used for content customization.\n   * @see [[ContentFlags]]\n   */\n  contentFlags?: number;\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>\n  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   * Flag that specifies whether value formatting should be omitted or not.\n   * Content is returned without `displayValues` when this is set to `true`.\n   */\n  omitFormattedValues?: boolean;\n}\n\n/**\n * Request type for distinct values' requests.\n * @public\n */\nexport interface DistinctValuesRequestOptions<TIModel, TDescriptor, TKeySet, TRulesetVariable = RulesetVariable>\n  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 * @deprecated in 4.x. Use [[SingleElementPropertiesRequestOptions]] or [[MultiElementPropertiesRequestOptions]] directly.\n */\nexport type ElementPropertiesRequestOptions<TIModel, TParsedContent = ElementProperties> =\n  | SingleElementPropertiesRequestOptions<TIModel>\n  | MultiElementPropertiesRequestOptions<TIModel, TParsedContent>;\n\n/**\n * Request type for single element properties requests.\n * @public\n */\nexport interface SingleElementPropertiesRequestOptions<TIModel, TParsedContent = ElementProperties> extends RequestOptions<TIModel> {\n  /** ID of the element to get properties for. */\n  elementId: Id64String;\n\n  /**\n   * Content parser that creates a result item based on given content descriptor and content item. Defaults\n   * to a parser that creates [[ElementProperties]] objects.\n   */\n  contentParser?: (descriptor: Descriptor, item: Item) => TParsedContent;\n}\n\n/**\n * Request type for multiple elements properties requests.\n * @public\n */\nexport interface MultiElementPropertiesRequestOptions<TIModel, TParsedContent = ElementProperties> 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   * Content parser that creates a result item based on given content descriptor and content item. Defaults\n   * to a parser that creates [[ElementProperties]] objects.\n   */\n  contentParser?: (descriptor: Descriptor, item: Item) => TParsedContent;\n\n  /**\n   * The properties of multiple elements are going to be retrieved and returned in batches. Depending on the batch\n   * size load on CPU vs MEMORY load may vary, so changing this attribute allows to fine tune the performance.\n   * Defaults to `1000`.\n   */\n  batchSize?: number;\n}\n\n/**\n * Request type for content instance keys' requests.\n * @public\n */\nexport interface ContentInstanceKeysRequestOptions<TIModel, TKeySet, TRulesetVariable = RulesetVariable>\n  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-object-type\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>(\n  options: ComputeSelectionRequestOptions<TIModel> | SelectionScopeRequestOptions<TIModel>,\n): 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 object> = 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 object> = 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, TParsedContent = any>(\n  options: SingleElementPropertiesRequestOptions<TIModel> | MultiElementPropertiesRequestOptions<TIModel, TParsedContent>,\n): 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 object> = 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;;;gGAGgG;AAChG;;GAEG;AA4SH,gBAAgB;AAChB,MAAM,UAAU,gCAAgC,CAC9C,OAAwF;IAExF,OAAO,CAAC,CAAE,OAAmD,CAAC,UAAU,CAAC;AAC3E,CAAC;AAgDD;;;GAGG;AACH,MAAM,UAAU,uCAAuC,CACrD,OAAuH;IAEvH,OAAQ,OAA0D,CAAC,SAAS,KAAK,SAAS,CAAC;AAC7F,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Core\r\n */\r\n\r\nimport { BeEvent, Id64String } from \"@itwin/core-bentley\";\r\nimport { UnitSystemKey } from \"@itwin/core-quantity\";\r\nimport { Descriptor, SelectionInfo } from \"./content/Descriptor\";\r\nimport { FieldDescriptor } from \"./content/Fields\";\r\nimport { Item } from \"./content/Item\";\r\nimport { InstanceKey } from \"./EC\";\r\nimport { ElementProperties } from \"./ElementProperties\";\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  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   */\r\n  sizeLimit?: number;\r\n}\r\n\r\n/**\r\n * Params for hierarchy level descriptor requests.\r\n * @public\r\n */\r\nexport interface HierarchyLevelDescriptorRequestOptions<TIModel, TNodeKey, TRulesetVariable = RulesetVariable>\r\n  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>\r\n  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>\r\n  extends RequestOptionsWithRuleset<TIModel, TRulesetVariable> {\r\n  /**\r\n   * Content display type.\r\n   * @see [[DefaultContentDisplayTypes]]\r\n   */\r\n  displayType: string;\r\n  /**\r\n   * Content flags used for content customization.\r\n   * @see [[ContentFlags]]\r\n   */\r\n  contentFlags?: number;\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>\r\n  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   * Flag that specifies whether value formatting should be omitted or not.\r\n   * Content is returned without `displayValues` when this is set to `true`.\r\n   */\r\n  omitFormattedValues?: boolean;\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>\r\n  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 * @deprecated in 4.x. Use [[SingleElementPropertiesRequestOptions]] or [[MultiElementPropertiesRequestOptions]] directly.\r\n */\r\nexport type ElementPropertiesRequestOptions<TIModel, TParsedContent = ElementProperties> =\r\n  | SingleElementPropertiesRequestOptions<TIModel>\r\n  | MultiElementPropertiesRequestOptions<TIModel, TParsedContent>;\r\n\r\n/**\r\n * Request type for single element properties requests.\r\n * @public\r\n */\r\nexport interface SingleElementPropertiesRequestOptions<TIModel, TParsedContent = ElementProperties> extends RequestOptions<TIModel> {\r\n  /** ID of the element to get properties for. */\r\n  elementId: Id64String;\r\n\r\n  /**\r\n   * Content parser that creates a result item based on given content descriptor and content item. Defaults\r\n   * to a parser that creates [[ElementProperties]] objects.\r\n   */\r\n  contentParser?: (descriptor: Descriptor, item: Item) => TParsedContent;\r\n}\r\n\r\n/**\r\n * Base request type for multiple elements properties requests.\r\n * @public\r\n */\r\nexport interface MultiElementPropertiesBaseRequestOptions<TIModel, TParsedContent = ElementProperties> extends RequestOptions<TIModel> {\r\n  /**\r\n   * Content parser that creates a result item based on given content descriptor and content item. Defaults\r\n   * to a parser that creates [[ElementProperties]] objects.\r\n   */\r\n  contentParser?: (descriptor: Descriptor, item: Item) => TParsedContent;\r\n\r\n  /**\r\n   * The properties of multiple elements are going to be retrieved and returned in batches. Depending on the batch\r\n   * size load on CPU vs MEMORY load may vary, so changing this attribute allows to fine tune the performance.\r\n   * Defaults to `1000`.\r\n   */\r\n  batchSize?: number;\r\n}\r\n/**\r\n * Request type for multiple elements properties requests, where elements are specified by class.\r\n * @public\r\n */\r\nexport interface MultiElementPropertiesByClassRequestOptions<TIModel, TParsedContent = ElementProperties>\r\n  extends MultiElementPropertiesBaseRequestOptions<TIModel, TParsedContent> {\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 * Request type for multiple elements properties requests, where elements are specified by element id.\r\n * @public\r\n */\r\nexport interface MultiElementPropertiesByIdsRequestOptions<TIModel, TParsedContent = ElementProperties>\r\n  extends MultiElementPropertiesBaseRequestOptions<TIModel, TParsedContent> {\r\n  /**\r\n   * A list of `bis.Element` IDs to get properties for.\r\n   */\r\n  elementIds?: Id64String[];\r\n}\r\n/**\r\n * Request type for multiple elements properties requests.\r\n * @public\r\n */\r\nexport type MultiElementPropertiesRequestOptions<TIModel, TParsedContent = ElementProperties> =\r\n  | MultiElementPropertiesByClassRequestOptions<TIModel, TParsedContent>\r\n  | MultiElementPropertiesByIdsRequestOptions<TIModel, TParsedContent>;\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>\r\n  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-object-type\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>(\r\n  options: ComputeSelectionRequestOptions<TIModel> | SelectionScopeRequestOptions<TIModel>,\r\n): 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 object> = 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 object> = 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, TParsedContent = any>(\r\n  options: SingleElementPropertiesRequestOptions<TIModel> | MultiElementPropertiesRequestOptions<TIModel, TParsedContent>,\r\n): 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 object> = TOptions & {\r\n  /** Event which is triggered when the request is canceled */\r\n  cancelEvent?: BeEvent<() => void>;\r\n};\r\n"]}

package/lib/esm/presentation-common/PresentationRpcInterface.js

@@ -12,6 +12,10 @@ import { PresentationStatus } from "./Error";
  * @public
  */
 export class PresentationRpcInterface extends RpcInterface {
+    /** The immutable name of the interface. */
+    static { this.interfaceName = "PresentationRpcInterface"; }
+    /** The semantic version of the interface. */
+    static { this.interfaceVersion = "4.1.0"; }
     /*===========================================================================================
       NOTE: Any add/remove/change to the methods below requires an update of the interface version.
       NOTE: Please consult the README in core/common/src/rpc for the semantic versioning rules.
@@ -95,10 +99,6 @@ export class PresentationRpcInterface extends RpcInterface {
         return this.forward(arguments);
     }
 }
-/** The immutable name of the interface. */
-PresentationRpcInterface.interfaceName = "PresentationRpcInterface";
-/** The semantic version of the interface. */
-PresentationRpcInterface.interfaceVersion = "4.1.0";
 /** @internal */
 export var PresentationIpcEvents;
 (function (PresentationIpcEvents) {

package/lib/esm/presentation-common/PresentationRpcInterface.js.map

@@ -1 +1 @@
-{"version":3,"file":"PresentationRpcInterface.js","sourceRoot":"","sources":["../../../src/presentation-common/PresentationRpcInterface.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAGH,OAAO,EAAkB,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAOlE,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAuK7C;;;GAGG;AACH,MAAM,OAAO,wBAAyB,SAAQ,YAAY;IAOxD;;;iGAG6F;IAE7F,4HAA4H;IACrH,KAAK,CAAC,aAAa,CAAC,MAAsB,EAAE,QAAoC;QACrF,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IAC5H,4DAA4D;IACrD,KAAK,CAAC,aAAa,CAAC,MAAsB,EAAE,QAA2C;QAC5F,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,kBAAkB,CAC7B,MAAsB,EACtB,QAAmD;QAEnD,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IAC5H,4CAA4C;IAC5C,4DAA4D;IACrD,KAAK,CAAC,YAAY,CAAC,MAAsB,EAAE,QAAyD;QACzG,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IAC5H,4CAA4C;IAC5C,4DAA4D;IACrD,KAAK,CAAC,oBAAoB,CAAC,MAAsB,EAAE,QAAgD;QACxG,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,iBAAiB,CAAC,MAAsB,EAAE,QAAyC;QAC9F,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,oBAAoB,CAAC,MAAsB,EAAE,QAA4C;QACpG,SAAS,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,CAAC;QAC/D,MAAM,QAAQ,GAAqE,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACjH,IAAI,QAAQ,CAAC,UAAU,KAAK,kBAAkB,CAAC,OAAO,IAAI,OAAO,QAAQ,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC9F,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,QAAmE,CAAC;IAC7E,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,iBAAiB,CAAC,MAAsB,EAAE,QAAkC;QACvF,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,eAAe,CAC1B,MAAsB,EACtB,QAAyC;QAEzC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,kBAAkB,CAAC,MAAsB,EAAE,QAAyC;QAC/F,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,oBAAoB,CAC/B,MAAsB,EACtB,QAAkD;QAElD,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,sBAAsB,CACjC,MAAsB,EACtB,QAAyC;QAGzC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,sBAAsB,CACjC,MAAsB,EACtB,QAA8C;QAE9C,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,yBAAyB,CAAC,MAAsB,EAAE,QAAuC;QACpG,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,+BAA+B,CAC1C,MAAsB,EACtB,QAAwC;QAExC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,kBAAkB,CAAC,MAAsB,EAAE,QAAyC;QAC/F,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAWD,4HAA4H;IACrH,KAAK,CAAC,gBAAgB,CAC3B,MAAsB,EACtB,QAA6E,EAC7E,IAAmB,EACnB,QAAiB;QAEjB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;;AAzID,2CAA2C;AACpB,sCAAa,GAAG,0BAA0B,CAAC;AAElE,6CAA6C;AAC/B,yCAAgB,GAAG,OAAO,CAAC;AAwI3C,gBAAgB;AAChB,MAAM,CAAN,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC/B;;OAEG;IACH,yDAAgC,CAAA;AAClC,CAAC,EALW,qBAAqB,KAArB,qBAAqB,QAKhC","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 RPC\n */\n\nimport { Id64String } from \"@itwin/core-bentley\";\nimport { IModelRpcProps, RpcInterface } from \"@itwin/core-common\";\nimport { DescriptorJSON, DescriptorOverrides, SelectClassInfoJSON } from \"./content/Descriptor\";\nimport { ItemJSON } from \"./content/Item\";\nimport { DisplayValueGroupJSON } from \"./content/Value\";\nimport { ClientDiagnostics, ClientDiagnosticsOptions } from \"./Diagnostics\";\nimport { CompressedClassInfoJSON, InstanceKey } from \"./EC\";\nimport { ElementProperties } from \"./ElementProperties\";\nimport { PresentationStatus } from \"./Error\";\nimport { NodeKey } from \"./hierarchy/Key\";\nimport { NodeJSON } from \"./hierarchy/Node\";\nimport { NodePathElementJSON } from \"./hierarchy/NodePathElement\";\nimport { KeySetJSON } from \"./KeySet\";\nimport { LabelDefinition } from \"./LabelDefinition\";\nimport {\n  ComputeSelectionRequestOptions,\n  ContentDescriptorRequestOptions,\n  ContentInstanceKeysRequestOptions,\n  ContentRequestOptions,\n  ContentSourcesRequestOptions,\n  DisplayLabelRequestOptions,\n  DisplayLabelsRequestOptions,\n  DistinctValuesRequestOptions,\n  FilterByInstancePathsHierarchyRequestOptions,\n  FilterByTextHierarchyRequestOptions,\n  HierarchyLevelDescriptorRequestOptions,\n  HierarchyRequestOptions,\n  Paged,\n  SelectionScopeRequestOptions,\n  SingleElementPropertiesRequestOptions,\n} from \"./PresentationManagerOptions\";\nimport { RulesetVariableJSON } from \"./RulesetVariables\";\nimport { SelectionScope } from \"./selection/SelectionScope\";\nimport { Omit, PagedResponse } from \"./Utils\";\n\n/**\n * Base options for all presentation RPC requests.\n * @public\n */\nexport type PresentationRpcRequestOptions<TManagerRequestOptions> = Omit<TManagerRequestOptions, \"imodel\" | \"diagnostics\"> & {\n  /** @internal ID of the client requesting data */\n  clientId?: string;\n  /** RPC request diagnostics options. */\n  diagnostics?: RpcDiagnosticsOptions;\n};\n\n/**\n * Data structure for presentation RPC responses\n * @public\n */\nexport interface PresentationRpcResponseData<TResult = undefined> {\n  /** Response status code */\n  statusCode: PresentationStatus;\n  /** In case of an error response, the error message */\n  errorMessage?: string;\n  /** In case of a success response, the result */\n  result?: TResult;\n  /** Diagnostics response. */\n  diagnostics?: ClientDiagnostics;\n}\n\n/**\n * Data structure for RPC diagnostics options.\n * @public\n */\nexport type RpcDiagnosticsOptions = Omit<ClientDiagnosticsOptions, \"handler\">;\n\n/**\n * A promise of [[PresentationRpcResponseData]].\n * @public\n */\nexport type PresentationRpcResponse<TResult = undefined> = Promise<PresentationRpcResponseData<TResult>>;\n\n/**\n * Data structure for hierarchy request options.\n * @public\n */\nexport type HierarchyRpcRequestOptions = PresentationRpcRequestOptions<HierarchyRequestOptions<never, NodeKey, RulesetVariableJSON>>;\n\n/**\n * Data structure for hierarchy level descriptor RPC request options.\n * @public\n */\nexport type HierarchyLevelDescriptorRpcRequestOptions = PresentationRpcRequestOptions<\n  HierarchyLevelDescriptorRequestOptions<never, NodeKey, RulesetVariableJSON>\n>;\n\n/**\n * Data structure for filtering hierarchy by ECInstance paths request options.\n * @public\n */\nexport type FilterByInstancePathsHierarchyRpcRequestOptions = PresentationRpcRequestOptions<\n  FilterByInstancePathsHierarchyRequestOptions<never, RulesetVariableJSON>\n>;\n\n/**\n * Data structure for filtering hierarchy by text request options.\n * @public\n */\nexport type FilterByTextHierarchyRpcRequestOptions = PresentationRpcRequestOptions<FilterByTextHierarchyRequestOptions<never, RulesetVariableJSON>>;\n\n/**\n * Data structure for content sources RPC request options.\n * @public\n */\nexport type ContentSourcesRpcRequestOptions = PresentationRpcRequestOptions<ContentSourcesRequestOptions<never>>;\n/**\n * Data structure for content sources RPC response.\n * @public\n */\nexport interface ContentSourcesRpcResult {\n  /** A list of objects containing content source information. */\n  sources: SelectClassInfoJSON<Id64String>[];\n  /** An `ECClassId` => [[CompressedClassInfoJSON]] map for deserializing [[sources]]. */\n  classesMap: { [id: string]: CompressedClassInfoJSON };\n}\n\n/**\n * Data structure for content descriptor RPC request options.\n * @public\n */\nexport type ContentDescriptorRpcRequestOptions = PresentationRpcRequestOptions<ContentDescriptorRequestOptions<never, KeySetJSON, RulesetVariableJSON>>;\n\n/**\n * Data structure for content RPC request options.\n * @public\n */\nexport type ContentRpcRequestOptions = PresentationRpcRequestOptions<ContentRequestOptions<never, DescriptorOverrides, KeySetJSON, RulesetVariableJSON>>;\n\n/**\n * Data structure for single element properties RPC request options.\n * @public\n */\nexport type SingleElementPropertiesRpcRequestOptions = PresentationRpcRequestOptions<\n  Omit<SingleElementPropertiesRequestOptions<never, never>, \"contentParser\">\n>;\n\n/**\n * Data structure for distinct values' request options.\n * @public\n */\nexport type DistinctValuesRpcRequestOptions = PresentationRpcRequestOptions<\n  DistinctValuesRequestOptions<never, DescriptorOverrides, KeySetJSON, RulesetVariableJSON>\n>;\n\n/**\n * Data structure for content instance keys' request options.\n * @public\n */\nexport type ContentInstanceKeysRpcRequestOptions = PresentationRpcRequestOptions<ContentInstanceKeysRequestOptions<never, KeySetJSON, RulesetVariableJSON>>;\n\n/**\n * Data structure for label request options.\n * @public\n */\nexport type DisplayLabelRpcRequestOptions = PresentationRpcRequestOptions<DisplayLabelRequestOptions<never, InstanceKey>>;\n\n/**\n * Data structure for labels request options.\n * @public\n */\nexport type DisplayLabelsRpcRequestOptions = PresentationRpcRequestOptions<DisplayLabelsRequestOptions<never, InstanceKey>>;\n\n/**\n * Data structure for selection scope request options.\n * @public\n */\nexport type SelectionScopeRpcRequestOptions = PresentationRpcRequestOptions<SelectionScopeRequestOptions<never>>;\n\n/**\n * Request options data structure for computing selection based on given selection scope and element IDs.\n * @public\n */\nexport type ComputeSelectionRpcRequestOptions = PresentationRpcRequestOptions<ComputeSelectionRequestOptions<never>>;\n\n/**\n * Interface used for communication between Presentation backend and frontend.\n * @public\n */\nexport class PresentationRpcInterface extends RpcInterface {\n  /** The immutable name of the interface. */\n  public static readonly interfaceName = \"PresentationRpcInterface\";\n\n  /** The semantic version of the interface. */\n  public static interfaceVersion = \"4.1.0\";\n\n  /*===========================================================================================\n    NOTE: Any add/remove/change to the methods below requires an update of the interface version.\n    NOTE: Please consult the README in core/common/src/rpc for the semantic versioning rules.\n  ===========================================================================================*/\n\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\n  public async getNodesCount(_token: IModelRpcProps, _options: HierarchyRpcRequestOptions): PresentationRpcResponse<number> {\n    return this.forward(arguments);\n  }\n\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public async getPagedNodes(_token: IModelRpcProps, _options: Paged<HierarchyRpcRequestOptions>): PresentationRpcResponse<PagedResponse<NodeJSON>> {\n    return this.forward(arguments);\n  }\n\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\n  public async getNodesDescriptor(\n    _token: IModelRpcProps,\n    _options: HierarchyLevelDescriptorRpcRequestOptions,\n  ): PresentationRpcResponse<string | DescriptorJSON | undefined> {\n    return this.forward(arguments);\n  }\n\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\n  // TODO: add paged version of this (#387280)\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public async getNodePaths(_token: IModelRpcProps, _options: FilterByInstancePathsHierarchyRpcRequestOptions): PresentationRpcResponse<NodePathElementJSON[]> {\n    return this.forward(arguments);\n  }\n\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\n  // TODO: add paged version of this (#387280)\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public async getFilteredNodePaths(_token: IModelRpcProps, _options: FilterByTextHierarchyRpcRequestOptions): PresentationRpcResponse<NodePathElementJSON[]> {\n    return this.forward(arguments);\n  }\n\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\n  public async getContentSources(_token: IModelRpcProps, _options: ContentSourcesRpcRequestOptions): PresentationRpcResponse<ContentSourcesRpcResult> {\n    return this.forward(arguments);\n  }\n\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\n  public async getContentDescriptor(_token: IModelRpcProps, _options: ContentDescriptorRpcRequestOptions): PresentationRpcResponse<DescriptorJSON | undefined> {\n    arguments[1] = { ...arguments[1], transport: \"unparsed-json\" };\n    const response: PresentationRpcResponseData<DescriptorJSON | string | undefined> = await this.forward(arguments);\n    if (response.statusCode === PresentationStatus.Success && typeof response.result === \"string\") {\n      response.result = JSON.parse(response.result);\n    }\n    return response as PresentationRpcResponseData<DescriptorJSON | undefined>;\n  }\n\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\n  public async getContentSetSize(_token: IModelRpcProps, _options: ContentRpcRequestOptions): PresentationRpcResponse<number> {\n    return this.forward(arguments);\n  }\n\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\n  public async getPagedContent(\n    _token: IModelRpcProps,\n    _options: Paged<ContentRpcRequestOptions>,\n  ): PresentationRpcResponse<{ descriptor: DescriptorJSON; contentSet: PagedResponse<ItemJSON> } | undefined> {\n    return this.forward(arguments);\n  }\n\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\n  public async getPagedContentSet(_token: IModelRpcProps, _options: Paged<ContentRpcRequestOptions>): PresentationRpcResponse<PagedResponse<ItemJSON>> {\n    return this.forward(arguments);\n  }\n\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\n  public async getElementProperties(\n    _token: IModelRpcProps,\n    _options: SingleElementPropertiesRpcRequestOptions,\n  ): PresentationRpcResponse<ElementProperties | undefined> {\n    return this.forward(arguments);\n  }\n\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\n  public async getPagedDistinctValues(\n    _token: IModelRpcProps,\n    _options: DistinctValuesRpcRequestOptions,\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n  ): PresentationRpcResponse<PagedResponse<DisplayValueGroupJSON>> {\n    return this.forward(arguments);\n  }\n\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\n  public async getContentInstanceKeys(\n    _token: IModelRpcProps,\n    _options: ContentInstanceKeysRpcRequestOptions,\n  ): PresentationRpcResponse<{ total: number; items: KeySetJSON }> {\n    return this.forward(arguments);\n  }\n\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\n  public async getDisplayLabelDefinition(_token: IModelRpcProps, _options: DisplayLabelRpcRequestOptions): PresentationRpcResponse<LabelDefinition> {\n    return this.forward(arguments);\n  }\n\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\n  public async getPagedDisplayLabelDefinitions(\n    _token: IModelRpcProps,\n    _options: DisplayLabelsRpcRequestOptions,\n  ): PresentationRpcResponse<PagedResponse<LabelDefinition>> {\n    return this.forward(arguments);\n  }\n\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\n  public async getSelectionScopes(_token: IModelRpcProps, _options: SelectionScopeRpcRequestOptions): PresentationRpcResponse<SelectionScope[]> {\n    return this.forward(arguments);\n  }\n\n  /** @deprecated in 3.x. Use the override with [[ComputeSelectionRpcRequestOptions]]. */\n  public async computeSelection(\n    _token: IModelRpcProps,\n    _options: SelectionScopeRpcRequestOptions,\n    _ids: Id64String[],\n    _scopeId: string,\n  ): PresentationRpcResponse<KeySetJSON>;\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\n  public async computeSelection(_token: IModelRpcProps, _options: ComputeSelectionRpcRequestOptions): PresentationRpcResponse<KeySetJSON>;\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\n  public async computeSelection(\n    _token: IModelRpcProps,\n    _options: ComputeSelectionRpcRequestOptions | SelectionScopeRpcRequestOptions,\n    _ids?: Id64String[],\n    _scopeId?: string,\n  ): PresentationRpcResponse<KeySetJSON> {\n    return this.forward(arguments);\n  }\n}\n\n/** @internal */\nexport enum PresentationIpcEvents {\n  /**\n   * ID of an event that's emitted when backend detects changes in presented data.\n   */\n  Update = \"presentation.onUpdate\",\n}\n"]}
+{"version":3,"file":"PresentationRpcInterface.js","sourceRoot":"","sources":["../../../src/presentation-common/PresentationRpcInterface.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAGH,OAAO,EAAkB,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAOlE,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAuK7C;;;GAGG;AACH,MAAM,OAAO,wBAAyB,SAAQ,YAAY;IACxD,2CAA2C;aACpB,kBAAa,GAAG,0BAA0B,CAAC;IAElE,6CAA6C;aAC/B,qBAAgB,GAAG,OAAO,CAAC;IAEzC;;;iGAG6F;IAE7F,4HAA4H;IACrH,KAAK,CAAC,aAAa,CAAC,MAAsB,EAAE,QAAoC;QACrF,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IAC5H,4DAA4D;IACrD,KAAK,CAAC,aAAa,CAAC,MAAsB,EAAE,QAA2C;QAC5F,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,kBAAkB,CAC7B,MAAsB,EACtB,QAAmD;QAEnD,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IAC5H,4CAA4C;IAC5C,4DAA4D;IACrD,KAAK,CAAC,YAAY,CAAC,MAAsB,EAAE,QAAyD;QACzG,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IAC5H,4CAA4C;IAC5C,4DAA4D;IACrD,KAAK,CAAC,oBAAoB,CAAC,MAAsB,EAAE,QAAgD;QACxG,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,iBAAiB,CAAC,MAAsB,EAAE,QAAyC;QAC9F,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,oBAAoB,CAAC,MAAsB,EAAE,QAA4C;QACpG,SAAS,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,CAAC;QAC/D,MAAM,QAAQ,GAAqE,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACjH,IAAI,QAAQ,CAAC,UAAU,KAAK,kBAAkB,CAAC,OAAO,IAAI,OAAO,QAAQ,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC9F,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,QAAmE,CAAC;IAC7E,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,iBAAiB,CAAC,MAAsB,EAAE,QAAkC;QACvF,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,eAAe,CAC1B,MAAsB,EACtB,QAAyC;QAEzC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,kBAAkB,CAAC,MAAsB,EAAE,QAAyC;QAC/F,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,oBAAoB,CAC/B,MAAsB,EACtB,QAAkD;QAElD,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,sBAAsB,CACjC,MAAsB,EACtB,QAAyC;QAGzC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,sBAAsB,CACjC,MAAsB,EACtB,QAA8C;QAE9C,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,yBAAyB,CAAC,MAAsB,EAAE,QAAuC;QACpG,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,+BAA+B,CAC1C,MAAsB,EACtB,QAAwC;QAExC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,4HAA4H;IACrH,KAAK,CAAC,kBAAkB,CAAC,MAAsB,EAAE,QAAyC;QAC/F,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAWD,4HAA4H;IACrH,KAAK,CAAC,gBAAgB,CAC3B,MAAsB,EACtB,QAA6E,EAC7E,IAAmB,EACnB,QAAiB;QAEjB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;;AAGH,gBAAgB;AAChB,MAAM,CAAN,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC/B;;OAEG;IACH,yDAAgC,CAAA;AAClC,CAAC,EALW,qBAAqB,KAArB,qBAAqB,QAKhC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module RPC\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { IModelRpcProps, RpcInterface } from \"@itwin/core-common\";\r\nimport { DescriptorJSON, DescriptorOverrides, SelectClassInfoJSON } from \"./content/Descriptor\";\r\nimport { ItemJSON } from \"./content/Item\";\r\nimport { DisplayValueGroupJSON } from \"./content/Value\";\r\nimport { ClientDiagnostics, ClientDiagnosticsOptions } from \"./Diagnostics\";\r\nimport { CompressedClassInfoJSON, InstanceKey } from \"./EC\";\r\nimport { ElementProperties } from \"./ElementProperties\";\r\nimport { PresentationStatus } from \"./Error\";\r\nimport { NodeKey } from \"./hierarchy/Key\";\r\nimport { NodeJSON } from \"./hierarchy/Node\";\r\nimport { NodePathElementJSON } from \"./hierarchy/NodePathElement\";\r\nimport { KeySetJSON } from \"./KeySet\";\r\nimport { LabelDefinition } from \"./LabelDefinition\";\r\nimport {\r\n  ComputeSelectionRequestOptions,\r\n  ContentDescriptorRequestOptions,\r\n  ContentInstanceKeysRequestOptions,\r\n  ContentRequestOptions,\r\n  ContentSourcesRequestOptions,\r\n  DisplayLabelRequestOptions,\r\n  DisplayLabelsRequestOptions,\r\n  DistinctValuesRequestOptions,\r\n  FilterByInstancePathsHierarchyRequestOptions,\r\n  FilterByTextHierarchyRequestOptions,\r\n  HierarchyLevelDescriptorRequestOptions,\r\n  HierarchyRequestOptions,\r\n  Paged,\r\n  SelectionScopeRequestOptions,\r\n  SingleElementPropertiesRequestOptions,\r\n} from \"./PresentationManagerOptions\";\r\nimport { RulesetVariableJSON } from \"./RulesetVariables\";\r\nimport { SelectionScope } from \"./selection/SelectionScope\";\r\nimport { Omit, PagedResponse } from \"./Utils\";\r\n\r\n/**\r\n * Base options for all presentation RPC requests.\r\n * @public\r\n */\r\nexport type PresentationRpcRequestOptions<TManagerRequestOptions> = Omit<TManagerRequestOptions, \"imodel\" | \"diagnostics\"> & {\r\n  /** @internal ID of the client requesting data */\r\n  clientId?: string;\r\n  /** RPC request diagnostics options. */\r\n  diagnostics?: RpcDiagnosticsOptions;\r\n};\r\n\r\n/**\r\n * Data structure for presentation RPC responses\r\n * @public\r\n */\r\nexport interface PresentationRpcResponseData<TResult = undefined> {\r\n  /** Response status code */\r\n  statusCode: PresentationStatus;\r\n  /** In case of an error response, the error message */\r\n  errorMessage?: string;\r\n  /** In case of a success response, the result */\r\n  result?: TResult;\r\n  /** Diagnostics response. */\r\n  diagnostics?: ClientDiagnostics;\r\n}\r\n\r\n/**\r\n * Data structure for RPC diagnostics options.\r\n * @public\r\n */\r\nexport type RpcDiagnosticsOptions = Omit<ClientDiagnosticsOptions, \"handler\">;\r\n\r\n/**\r\n * A promise of [[PresentationRpcResponseData]].\r\n * @public\r\n */\r\nexport type PresentationRpcResponse<TResult = undefined> = Promise<PresentationRpcResponseData<TResult>>;\r\n\r\n/**\r\n * Data structure for hierarchy request options.\r\n * @public\r\n */\r\nexport type HierarchyRpcRequestOptions = PresentationRpcRequestOptions<HierarchyRequestOptions<never, NodeKey, RulesetVariableJSON>>;\r\n\r\n/**\r\n * Data structure for hierarchy level descriptor RPC request options.\r\n * @public\r\n */\r\nexport type HierarchyLevelDescriptorRpcRequestOptions = PresentationRpcRequestOptions<\r\n  HierarchyLevelDescriptorRequestOptions<never, NodeKey, RulesetVariableJSON>\r\n>;\r\n\r\n/**\r\n * Data structure for filtering hierarchy by ECInstance paths request options.\r\n * @public\r\n */\r\nexport type FilterByInstancePathsHierarchyRpcRequestOptions = PresentationRpcRequestOptions<\r\n  FilterByInstancePathsHierarchyRequestOptions<never, RulesetVariableJSON>\r\n>;\r\n\r\n/**\r\n * Data structure for filtering hierarchy by text request options.\r\n * @public\r\n */\r\nexport type FilterByTextHierarchyRpcRequestOptions = PresentationRpcRequestOptions<FilterByTextHierarchyRequestOptions<never, RulesetVariableJSON>>;\r\n\r\n/**\r\n * Data structure for content sources RPC request options.\r\n * @public\r\n */\r\nexport type ContentSourcesRpcRequestOptions = PresentationRpcRequestOptions<ContentSourcesRequestOptions<never>>;\r\n/**\r\n * Data structure for content sources RPC response.\r\n * @public\r\n */\r\nexport interface ContentSourcesRpcResult {\r\n  /** A list of objects containing content source information. */\r\n  sources: SelectClassInfoJSON<Id64String>[];\r\n  /** An `ECClassId` => [[CompressedClassInfoJSON]] map for deserializing [[sources]]. */\r\n  classesMap: { [id: string]: CompressedClassInfoJSON };\r\n}\r\n\r\n/**\r\n * Data structure for content descriptor RPC request options.\r\n * @public\r\n */\r\nexport type ContentDescriptorRpcRequestOptions = PresentationRpcRequestOptions<ContentDescriptorRequestOptions<never, KeySetJSON, RulesetVariableJSON>>;\r\n\r\n/**\r\n * Data structure for content RPC request options.\r\n * @public\r\n */\r\nexport type ContentRpcRequestOptions = PresentationRpcRequestOptions<ContentRequestOptions<never, DescriptorOverrides, KeySetJSON, RulesetVariableJSON>>;\r\n\r\n/**\r\n * Data structure for single element properties RPC request options.\r\n * @public\r\n */\r\nexport type SingleElementPropertiesRpcRequestOptions = PresentationRpcRequestOptions<\r\n  Omit<SingleElementPropertiesRequestOptions<never, never>, \"contentParser\">\r\n>;\r\n\r\n/**\r\n * Data structure for distinct values' request options.\r\n * @public\r\n */\r\nexport type DistinctValuesRpcRequestOptions = PresentationRpcRequestOptions<\r\n  DistinctValuesRequestOptions<never, DescriptorOverrides, KeySetJSON, RulesetVariableJSON>\r\n>;\r\n\r\n/**\r\n * Data structure for content instance keys' request options.\r\n * @public\r\n */\r\nexport type ContentInstanceKeysRpcRequestOptions = PresentationRpcRequestOptions<ContentInstanceKeysRequestOptions<never, KeySetJSON, RulesetVariableJSON>>;\r\n\r\n/**\r\n * Data structure for label request options.\r\n * @public\r\n */\r\nexport type DisplayLabelRpcRequestOptions = PresentationRpcRequestOptions<DisplayLabelRequestOptions<never, InstanceKey>>;\r\n\r\n/**\r\n * Data structure for labels request options.\r\n * @public\r\n */\r\nexport type DisplayLabelsRpcRequestOptions = PresentationRpcRequestOptions<DisplayLabelsRequestOptions<never, InstanceKey>>;\r\n\r\n/**\r\n * Data structure for selection scope request options.\r\n * @public\r\n */\r\nexport type SelectionScopeRpcRequestOptions = PresentationRpcRequestOptions<SelectionScopeRequestOptions<never>>;\r\n\r\n/**\r\n * Request options data structure for computing selection based on given selection scope and element IDs.\r\n * @public\r\n */\r\nexport type ComputeSelectionRpcRequestOptions = PresentationRpcRequestOptions<ComputeSelectionRequestOptions<never>>;\r\n\r\n/**\r\n * Interface used for communication between Presentation backend and frontend.\r\n * @public\r\n */\r\nexport class PresentationRpcInterface extends RpcInterface {\r\n  /** The immutable name of the interface. */\r\n  public static readonly interfaceName = \"PresentationRpcInterface\";\r\n\r\n  /** The semantic version of the interface. */\r\n  public static interfaceVersion = \"4.1.0\";\r\n\r\n  /*===========================================================================================\r\n    NOTE: Any add/remove/change to the methods below requires an update of the interface version.\r\n    NOTE: Please consult the README in core/common/src/rpc for the semantic versioning rules.\r\n  ===========================================================================================*/\r\n\r\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\r\n  public async getNodesCount(_token: IModelRpcProps, _options: HierarchyRpcRequestOptions): PresentationRpcResponse<number> {\r\n    return this.forward(arguments);\r\n  }\r\n\r\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  public async getPagedNodes(_token: IModelRpcProps, _options: Paged<HierarchyRpcRequestOptions>): PresentationRpcResponse<PagedResponse<NodeJSON>> {\r\n    return this.forward(arguments);\r\n  }\r\n\r\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\r\n  public async getNodesDescriptor(\r\n    _token: IModelRpcProps,\r\n    _options: HierarchyLevelDescriptorRpcRequestOptions,\r\n  ): PresentationRpcResponse<string | DescriptorJSON | undefined> {\r\n    return this.forward(arguments);\r\n  }\r\n\r\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\r\n  // TODO: add paged version of this (#387280)\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  public async getNodePaths(_token: IModelRpcProps, _options: FilterByInstancePathsHierarchyRpcRequestOptions): PresentationRpcResponse<NodePathElementJSON[]> {\r\n    return this.forward(arguments);\r\n  }\r\n\r\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\r\n  // TODO: add paged version of this (#387280)\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  public async getFilteredNodePaths(_token: IModelRpcProps, _options: FilterByTextHierarchyRpcRequestOptions): PresentationRpcResponse<NodePathElementJSON[]> {\r\n    return this.forward(arguments);\r\n  }\r\n\r\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\r\n  public async getContentSources(_token: IModelRpcProps, _options: ContentSourcesRpcRequestOptions): PresentationRpcResponse<ContentSourcesRpcResult> {\r\n    return this.forward(arguments);\r\n  }\r\n\r\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\r\n  public async getContentDescriptor(_token: IModelRpcProps, _options: ContentDescriptorRpcRequestOptions): PresentationRpcResponse<DescriptorJSON | undefined> {\r\n    arguments[1] = { ...arguments[1], transport: \"unparsed-json\" };\r\n    const response: PresentationRpcResponseData<DescriptorJSON | string | undefined> = await this.forward(arguments);\r\n    if (response.statusCode === PresentationStatus.Success && typeof response.result === \"string\") {\r\n      response.result = JSON.parse(response.result);\r\n    }\r\n    return response as PresentationRpcResponseData<DescriptorJSON | undefined>;\r\n  }\r\n\r\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\r\n  public async getContentSetSize(_token: IModelRpcProps, _options: ContentRpcRequestOptions): PresentationRpcResponse<number> {\r\n    return this.forward(arguments);\r\n  }\r\n\r\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\r\n  public async getPagedContent(\r\n    _token: IModelRpcProps,\r\n    _options: Paged<ContentRpcRequestOptions>,\r\n  ): PresentationRpcResponse<{ descriptor: DescriptorJSON; contentSet: PagedResponse<ItemJSON> } | undefined> {\r\n    return this.forward(arguments);\r\n  }\r\n\r\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\r\n  public async getPagedContentSet(_token: IModelRpcProps, _options: Paged<ContentRpcRequestOptions>): PresentationRpcResponse<PagedResponse<ItemJSON>> {\r\n    return this.forward(arguments);\r\n  }\r\n\r\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\r\n  public async getElementProperties(\r\n    _token: IModelRpcProps,\r\n    _options: SingleElementPropertiesRpcRequestOptions,\r\n  ): PresentationRpcResponse<ElementProperties | undefined> {\r\n    return this.forward(arguments);\r\n  }\r\n\r\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\r\n  public async getPagedDistinctValues(\r\n    _token: IModelRpcProps,\r\n    _options: DistinctValuesRpcRequestOptions,\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  ): PresentationRpcResponse<PagedResponse<DisplayValueGroupJSON>> {\r\n    return this.forward(arguments);\r\n  }\r\n\r\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\r\n  public async getContentInstanceKeys(\r\n    _token: IModelRpcProps,\r\n    _options: ContentInstanceKeysRpcRequestOptions,\r\n  ): PresentationRpcResponse<{ total: number; items: KeySetJSON }> {\r\n    return this.forward(arguments);\r\n  }\r\n\r\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\r\n  public async getDisplayLabelDefinition(_token: IModelRpcProps, _options: DisplayLabelRpcRequestOptions): PresentationRpcResponse<LabelDefinition> {\r\n    return this.forward(arguments);\r\n  }\r\n\r\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\r\n  public async getPagedDisplayLabelDefinitions(\r\n    _token: IModelRpcProps,\r\n    _options: DisplayLabelsRpcRequestOptions,\r\n  ): PresentationRpcResponse<PagedResponse<LabelDefinition>> {\r\n    return this.forward(arguments);\r\n  }\r\n\r\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\r\n  public async getSelectionScopes(_token: IModelRpcProps, _options: SelectionScopeRpcRequestOptions): PresentationRpcResponse<SelectionScope[]> {\r\n    return this.forward(arguments);\r\n  }\r\n\r\n  /** @deprecated in 3.x. Use the override with [[ComputeSelectionRpcRequestOptions]]. */\r\n  public async computeSelection(\r\n    _token: IModelRpcProps,\r\n    _options: SelectionScopeRpcRequestOptions,\r\n    _ids: Id64String[],\r\n    _scopeId: string,\r\n  ): PresentationRpcResponse<KeySetJSON>;\r\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\r\n  public async computeSelection(_token: IModelRpcProps, _options: ComputeSelectionRpcRequestOptions): PresentationRpcResponse<KeySetJSON>;\r\n  /** @deprecated in 4.10. Use [PresentationManager]($presentation-frontend) instead of calling the RPC interface directly. */\r\n  public async computeSelection(\r\n    _token: IModelRpcProps,\r\n    _options: ComputeSelectionRpcRequestOptions | SelectionScopeRpcRequestOptions,\r\n    _ids?: Id64String[],\r\n    _scopeId?: string,\r\n  ): PresentationRpcResponse<KeySetJSON> {\r\n    return this.forward(arguments);\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport enum PresentationIpcEvents {\r\n  /**\r\n   * ID of an event that's emitted when backend detects changes in presented data.\r\n   */\r\n  Update = \"presentation.onUpdate\",\r\n}\r\n"]}

package/lib/esm/presentation-common/RegisteredRuleset.js.map

@@ -1 +1 @@
-{"version":3,"file":"RegisteredRuleset.js","sourceRoot":"","sources":["../../../src/presentation-common/RegisteredRuleset.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAOH;;;GAGG;AACH,MAAM,OAAO,iBAAiB;IAK5B,kCAAkC;IAClC,YAAmB,OAAgB,EAAE,gBAAwB,EAAE,WAAiD;QAC9G,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;IAC5C,CAAC;IAED,kCAAkC;IAC3B,OAAO;QACZ,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IACD,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC1B,CAAC;IACD,IAAW,mBAAmB;QAC5B,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC;IAC3C,CAAC;IACD,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;IAC7B,CAAC;IACD,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC5B,CAAC;IACM,MAAM;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;CACF","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 { IDisposable } from \"@itwin/core-bentley\";\nimport { Rule } from \"./rules/Rule\";\nimport { Ruleset, SupplementationInfo } from \"./rules/Ruleset\";\nimport { VariablesGroup } from \"./rules/Variables\";\n\n/**\n * A ruleset that is registered in a ruleset manager.\n * @public\n */\nexport class RegisteredRuleset implements IDisposable, Ruleset {\n  private _ruleset: Ruleset;\n  private _uniqueIdentifier: string;\n  private _disposeFunc: (ruleset: RegisteredRuleset) => void;\n\n  /** Create a registered ruleset */\n  public constructor(ruleset: Ruleset, uniqueIdentifier: string, disposeFunc: (ruleset: RegisteredRuleset) => void) {\n    this._disposeFunc = disposeFunc;\n    this._ruleset = ruleset;\n    this._uniqueIdentifier = uniqueIdentifier;\n  }\n\n  /** Dispose registered ruleset. */\n  public dispose() {\n    this._disposeFunc(this);\n  }\n\n  public get uniqueIdentifier() {\n    return this._uniqueIdentifier;\n  }\n  public get id(): string {\n    return this._ruleset.id;\n  }\n  public get supplementationInfo(): SupplementationInfo | undefined {\n    return this._ruleset.supplementationInfo;\n  }\n  public get rules(): Rule[] {\n    return this._ruleset.rules;\n  }\n  public get vars(): VariablesGroup[] | undefined {\n    return this._ruleset.vars;\n  }\n  public toJSON(): Ruleset {\n    return this._ruleset;\n  }\n}\n"]}
+{"version":3,"file":"RegisteredRuleset.js","sourceRoot":"","sources":["../../../src/presentation-common/RegisteredRuleset.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAOH;;;GAGG;AACH,MAAM,OAAO,iBAAiB;IAK5B,kCAAkC;IAClC,YAAmB,OAAgB,EAAE,gBAAwB,EAAE,WAAiD;QAC9G,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;IAC5C,CAAC;IAED,kCAAkC;IAC3B,OAAO;QACZ,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IACD,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC1B,CAAC;IACD,IAAW,mBAAmB;QAC5B,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC;IAC3C,CAAC;IACD,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;IAC7B,CAAC;IACD,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC5B,CAAC;IACM,MAAM;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;CACF","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 { IDisposable } from \"@itwin/core-bentley\";\r\nimport { Rule } from \"./rules/Rule\";\r\nimport { Ruleset, SupplementationInfo } from \"./rules/Ruleset\";\r\nimport { VariablesGroup } from \"./rules/Variables\";\r\n\r\n/**\r\n * A ruleset that is registered in a ruleset manager.\r\n * @public\r\n */\r\nexport class RegisteredRuleset implements IDisposable, Ruleset {\r\n  private _ruleset: Ruleset;\r\n  private _uniqueIdentifier: string;\r\n  private _disposeFunc: (ruleset: RegisteredRuleset) => void;\r\n\r\n  /** Create a registered ruleset */\r\n  public constructor(ruleset: Ruleset, uniqueIdentifier: string, disposeFunc: (ruleset: RegisteredRuleset) => void) {\r\n    this._disposeFunc = disposeFunc;\r\n    this._ruleset = ruleset;\r\n    this._uniqueIdentifier = uniqueIdentifier;\r\n  }\r\n\r\n  /** Dispose registered ruleset. */\r\n  public dispose() {\r\n    this._disposeFunc(this);\r\n  }\r\n\r\n  public get uniqueIdentifier() {\r\n    return this._uniqueIdentifier;\r\n  }\r\n  public get id(): string {\r\n    return this._ruleset.id;\r\n  }\r\n  public get supplementationInfo(): SupplementationInfo | undefined {\r\n    return this._ruleset.supplementationInfo;\r\n  }\r\n  public get rules(): Rule[] {\r\n    return this._ruleset.rules;\r\n  }\r\n  public get vars(): VariablesGroup[] | undefined {\r\n    return this._ruleset.vars;\r\n  }\r\n  public toJSON(): Ruleset {\r\n    return this._ruleset;\r\n  }\r\n}\r\n"]}

package/lib/esm/presentation-common/RpcRequestsHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"RpcRequestsHandler.js","sourceRoot":"","sources":["../../../src/presentation-common/RpcRequestsHandler.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC5E,OAAO,EAAkB,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,gCAAgC,EAAE,MAAM,wBAAwB,CAAC;AAM1E,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAwBhE,OAAO,EAA2B,wBAAwB,EAA0D,MAAM,4BAA4B,CAAC;AAMvJ;;;GAGG;AACH,MAAM,uBAAuB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,aAAa;AAmB7D;;;;;;GAMG;AACH,MAAM,OAAO,kBAAkB;IAO7B,YAAmB,KAA+B;QAChD,IAAI,CAAC,QAAQ,GAAG,KAAK,EAAE,QAAQ,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;QACtD,IAAI,CAAC,OAAO,GAAG,KAAK,EAAE,OAAO,IAAI,uBAAuB,CAAC;IAC3D,CAAC;IAED,gEAAgE;IAChE,IAAY,SAAS;QACnB,OAAO,UAAU,CAAC,qBAAqB,CAAC,wBAAwB,CAAC,CAAC;IACpE,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAU,IAA4C,EAAE,kBAA6C;QACnI,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAChC,MAAM,OAAO,GAAG,UAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,WAA0C,CAAC;QAC/C,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,CAAC;YACtC,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,IAAI,EAAE,CAAC;gBAC9B,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;gBACnC,QAAQ,QAAQ,CAAC,UAAU,EAAE,CAAC;oBAC5B,KAAK,kBAAkB,CAAC,OAAO;wBAC7B,OAAO,QAAQ,CAAC,MAAO,CAAC;oBAC1B,KAAK,kBAAkB,CAAC,cAAc;wBACpC,MAAM;oBACR;wBACE,MAAM,IAAI,iBAAiB,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;gBAC5E,CAAC;YACH,CAAC;oBAAS,CAAC;gBACT,kBAAkB,IAAI,WAAW,IAAI,kBAAkB,CAAC,WAAW,CAAC,CAAC;YACvE,CAAC;QACH,CAAC;QACD,MAAM,IAAI,iBAAiB,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,OAAO,CAClB,IAAoI,EACpI,OAAiB,EACjB,GAAG,iBAAyB;QAE5B,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAE,GAAG,OAAO,CAAC;QAC5D,MAAM,EAAE,OAAO,EAAE,kBAAkB,EAAE,GAAG,kBAAkB,EAAE,GAAG,WAAW,IAAI,EAAE,CAAC;QACjF,IAAI,oBAAoB,CAAC,eAAe,CAAC,EAAE,CAAC;YAC1C,eAAe,CAAC,WAAW,GAAG,cAAc,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QAC5E,CAAC;QACD,MAAM,UAAU,GAA4C;YAC1D,GAAG,eAAe;YAClB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;QACF,IAAI,WAAW,EAAE,CAAC;YAChB,UAAU,CAAC,WAAW,GAAG,kBAAkB,CAAC;QAC9C,CAAC;QACD,MAAM,SAAS,GAAG,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,iBAAiB,CAAC,CAAC;QAC7E,OAAO,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,OAA2G;QACpI,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAyB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC1G,CAAC;IAEM,KAAK,CAAC,aAAa,CACxB,OAAkH;QAGlH,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAA0C,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC3H,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAC7B,OAA0H;QAE1H,4DAA4D;QAC5D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAsD,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;QAC1J,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjC,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,YAAY,CACvB,OAAuH;QAGvH,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAwC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACxH,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAC/B,OAA8G;QAG9G,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAwC,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAChI,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,OAAkF;QAC/G,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAA0C,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/H,CAAC;IACM,KAAK,CAAC,oBAAoB,CAC/B,OAAsH;QAEtH,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAA6C,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACrI,CAAC;IACM,KAAK,CAAC,iBAAiB,CAC5B,OAAiI;QAEjI,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAyB,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC9G,CAAC;IACM,KAAK,CAAC,eAAe,CAC1B,OAAwI;QAExI,OAAO,IAAI,CAAC,OAAO;QACjB,4DAA4D;QAC5D,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EACnD,OAAO,CACR,CAAC;IACJ,CAAC;IACM,KAAK,CAAC,kBAAkB,CAC7B,OAAwI;QAExI,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAA0C,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAChI,CAAC;IAEM,KAAK,CAAC,sBAAsB,CACjC,OAAwI;QAGxI,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAuD,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACjJ,CAAC;IAEM,KAAK,CAAC,sBAAsB,CACjC,OAAwH;QAExH,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAuD,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACjJ,CAAC;IAEM,KAAK,CAAC,yBAAyB,CACpC,OAA6F;QAE7F,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAkC,IAAI,CAAC,SAAS,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/H,CAAC;IACM,KAAK,CAAC,+BAA+B,CAC1C,OAA8F;QAE9F,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAiD,IAAI,CAAC,SAAS,CAAC,+BAA+B,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACpJ,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,OAAkF;QAChH,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAmC,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACzH,CAAC;IACM,KAAK,CAAC,gBAAgB,CAAC,OAAoF;QAChH,OAAO,IAAI,CAAC,OAAO;QACjB,4DAA4D;QAC5D,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EACpD,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AAED,SAAS,oBAAoB,CAAC,OAAe;IAC3C,OAAO,OAAQ,OAA+C,CAAC,WAAW,KAAK,QAAQ,CAAC;AAC1F,CAAC;AAMD,MAAM,gCAAgC,GAAkC;IACtE,EAAE,EAAE,IAAI;IACR,KAAK,EAAE,IAAI;IACX,OAAO,EAAE,IAAI;IACb,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,IAAI,EAAE,IAAI;CACX,CAAC;AAEF,SAAS,cAAc,CAAC,OAAgB;IACtC,MAAM,gBAAgB,GAAY,EAAE,GAAG,OAAO,EAAE,CAAC;IAEjD,KAAK,MAAM,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACxD,IAAI,CAAC,gCAAgC,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE,CAAC;YAClE,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9B,OAAQ,gBAAwB,CAAC,WAAW,CAAC,CAAC;YAChD,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,UAAU,CACf,gCAAgC,CAAC,OAAO,EACxC,qDAAqD,WAAW,2DAA2D,CAC5H,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC","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 RPC\n */\n\nimport { BeDuration, BeTimePoint, Guid, Logger } from \"@itwin/core-bentley\";\nimport { IModelRpcProps, RpcManager } from \"@itwin/core-common\";\nimport { PresentationCommonLoggerCategory } from \"./CommonLoggerCategory\";\nimport { DescriptorJSON, DescriptorOverrides } from \"./content/Descriptor\";\nimport { ItemJSON } from \"./content/Item\";\nimport { DisplayValueGroupJSON } from \"./content/Value\";\nimport { ClientDiagnostics, ClientDiagnosticsAttribute, ClientDiagnosticsHandler } from \"./Diagnostics\";\nimport { InstanceKey } from \"./EC\";\nimport { PresentationError, PresentationStatus } from \"./Error\";\nimport { NodeKey } from \"./hierarchy/Key\";\nimport { NodeJSON } from \"./hierarchy/Node\";\nimport { NodePathElementJSON } from \"./hierarchy/NodePathElement\";\nimport { KeySetJSON } from \"./KeySet\";\nimport { LabelDefinition } from \"./LabelDefinition\";\nimport {\n  ComputeSelectionRequestOptions,\n  ContentDescriptorRequestOptions,\n  ContentInstanceKeysRequestOptions,\n  ContentRequestOptions,\n  ContentSourcesRequestOptions,\n  DisplayLabelRequestOptions,\n  DisplayLabelsRequestOptions,\n  DistinctValuesRequestOptions,\n  FilterByInstancePathsHierarchyRequestOptions,\n  FilterByTextHierarchyRequestOptions,\n  HierarchyLevelDescriptorRequestOptions,\n  HierarchyRequestOptions,\n  Paged,\n  RequestOptions,\n  RequestOptionsWithRuleset,\n  SelectionScopeRequestOptions,\n} from \"./PresentationManagerOptions\";\nimport { ContentSourcesRpcResult, PresentationRpcInterface, PresentationRpcRequestOptions, PresentationRpcResponse } from \"./PresentationRpcInterface\";\nimport { Ruleset } from \"./rules/Ruleset\";\nimport { RulesetVariableJSON } from \"./RulesetVariables\";\nimport { SelectionScope } from \"./selection/SelectionScope\";\nimport { PagedResponse } from \"./Utils\";\n\n/**\n * Default timeout for how long we're going to wait for RPC request to be fulfilled before throwing\n * a timeout error.\n */\nconst DEFAULT_REQUEST_TIMEOUT = 10 * 60 * 1000; // 10 minutes\n\n/**\n * Configuration parameters for [[RpcRequestsHandler]].\n *\n * @internal\n */\nexport interface RpcRequestsHandlerProps {\n  /**\n   * Optional ID used to identify client that requests data. If not specified,\n   * the handler creates a unique GUID as a client id.\n   * @internal\n   */\n  clientId?: string;\n\n  /** @internal */\n  timeout?: number;\n}\n\n/**\n * RPC requests handler that wraps [[PresentationRpcInterface]] and\n * adds handling for cases when backend needs to be synced with client\n * state.\n *\n * @internal\n */\nexport class RpcRequestsHandler {\n  /** Timeout for how long the handler going to wait for RPC request to be fulfilled before throwing a timeout error. */\n  public readonly timeout: number;\n\n  /** ID that identifies this handler as a client */\n  public readonly clientId: string;\n\n  public constructor(props?: RpcRequestsHandlerProps) {\n    this.clientId = props?.clientId ?? Guid.createValue();\n    this.timeout = props?.timeout ?? DEFAULT_REQUEST_TIMEOUT;\n  }\n\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  private get rpcClient(): PresentationRpcInterface {\n    return RpcManager.getClientForInterface(PresentationRpcInterface);\n  }\n\n  private async requestWithTimeout<TResult>(func: () => PresentationRpcResponse<TResult>, diagnosticsHandler?: ClientDiagnosticsHandler): Promise<TResult> {\n    const start = BeTimePoint.now();\n    const timeout = BeDuration.fromMilliseconds(this.timeout);\n    let diagnostics: ClientDiagnostics | undefined;\n    while (start.plus(timeout).isInFuture) {\n      try {\n        const response = await func();\n        diagnostics = response.diagnostics;\n        switch (response.statusCode) {\n          case PresentationStatus.Success:\n            return response.result!;\n          case PresentationStatus.BackendTimeout:\n            break;\n          default:\n            throw new PresentationError(response.statusCode, response.errorMessage);\n        }\n      } finally {\n        diagnosticsHandler && diagnostics && diagnosticsHandler(diagnostics);\n      }\n    }\n    throw new PresentationError(PresentationStatus.BackendTimeout);\n  }\n\n  /**\n   * Send the request to backend.\n   *\n   * If the backend responds with [[PresentationStatus.BackendTimeout]], the request is repeated until we hit `timeout` or get\n   * a response. If the response is other than [[PresentationStatus.BackendTimeout]] or [[PresentationStatus.Success]], a [[PresentationError]]\n   * is thrown with the details from the response.\n   */\n  public async request<TResult, TOptions extends RequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute, TArg = any>(\n    func: (token: IModelRpcProps, options: PresentationRpcRequestOptions<TOptions>, ...args: TArg[]) => PresentationRpcResponse<TResult>,\n    options: TOptions,\n    ...additionalOptions: TArg[]\n  ): Promise<TResult> {\n    const { imodel, diagnostics, ...optionsNoIModel } = options;\n    const { handler: diagnosticsHandler, ...diagnosticsOptions } = diagnostics ?? {};\n    if (isOptionsWithRuleset(optionsNoIModel)) {\n      optionsNoIModel.rulesetOrId = cleanupRuleset(optionsNoIModel.rulesetOrId);\n    }\n    const rpcOptions: PresentationRpcRequestOptions<TOptions> = {\n      ...optionsNoIModel,\n      clientId: this.clientId,\n    };\n    if (diagnostics) {\n      rpcOptions.diagnostics = diagnosticsOptions;\n    }\n    const doRequest = async () => func(imodel, rpcOptions, ...additionalOptions);\n    return this.requestWithTimeout(doRequest, diagnosticsHandler);\n  }\n\n  public async getNodesCount(options: HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number> {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return this.request<number, typeof options>(this.rpcClient.getNodesCount.bind(this.rpcClient), options);\n  }\n\n  public async getPagedNodes(\n    options: Paged<HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON>> & ClientDiagnosticsAttribute,\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n  ): Promise<PagedResponse<NodeJSON>> {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return this.request<PagedResponse<NodeJSON>, typeof options>(this.rpcClient.getPagedNodes.bind(this.rpcClient), options);\n  }\n\n  public async getNodesDescriptor(\n    options: HierarchyLevelDescriptorRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute,\n  ): Promise<DescriptorJSON | undefined> {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    const response = await this.request<string | DescriptorJSON | undefined, typeof options>(this.rpcClient.getNodesDescriptor.bind(this.rpcClient), options);\n    if (typeof response === \"string\") {\n      return JSON.parse(response);\n    }\n    return response;\n  }\n\n  public async getNodePaths(\n    options: FilterByInstancePathsHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute,\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n  ): Promise<NodePathElementJSON[]> {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return this.request<NodePathElementJSON[], typeof options>(this.rpcClient.getNodePaths.bind(this.rpcClient), options);\n  }\n\n  public async getFilteredNodePaths(\n    options: FilterByTextHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute,\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n  ): Promise<NodePathElementJSON[]> {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return this.request<NodePathElementJSON[], typeof options>(this.rpcClient.getFilteredNodePaths.bind(this.rpcClient), options);\n  }\n\n  public async getContentSources(options: ContentSourcesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ContentSourcesRpcResult> {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return this.request<ContentSourcesRpcResult, typeof options>(this.rpcClient.getContentSources.bind(this.rpcClient), options);\n  }\n  public async getContentDescriptor(\n    options: ContentDescriptorRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute,\n  ): Promise<DescriptorJSON | undefined> {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return this.request<DescriptorJSON | undefined, typeof options>(this.rpcClient.getContentDescriptor.bind(this.rpcClient), options);\n  }\n  public async getContentSetSize(\n    options: ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute,\n  ): Promise<number> {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return this.request<number, typeof options>(this.rpcClient.getContentSetSize.bind(this.rpcClient), options);\n  }\n  public async getPagedContent(\n    options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>,\n  ) {\n    return this.request<{ descriptor: DescriptorJSON; contentSet: PagedResponse<ItemJSON> } | undefined, typeof options>(\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\n      this.rpcClient.getPagedContent.bind(this.rpcClient),\n      options,\n    );\n  }\n  public async getPagedContentSet(\n    options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>,\n  ) {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return this.request<PagedResponse<ItemJSON>, typeof options>(this.rpcClient.getPagedContentSet.bind(this.rpcClient), options);\n  }\n\n  public async getPagedDistinctValues(\n    options: DistinctValuesRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute,\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n  ): Promise<PagedResponse<DisplayValueGroupJSON>> {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return this.request<PagedResponse<DisplayValueGroupJSON>, typeof options>(this.rpcClient.getPagedDistinctValues.bind(this.rpcClient), options);\n  }\n\n  public async getContentInstanceKeys(\n    options: ContentInstanceKeysRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute,\n  ): Promise<{ total: number; items: KeySetJSON }> {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return this.request<{ total: number; items: KeySetJSON }, typeof options>(this.rpcClient.getContentInstanceKeys.bind(this.rpcClient), options);\n  }\n\n  public async getDisplayLabelDefinition(\n    options: DisplayLabelRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute,\n  ): Promise<LabelDefinition> {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return this.request<LabelDefinition, typeof options>(this.rpcClient.getDisplayLabelDefinition.bind(this.rpcClient), options);\n  }\n  public async getPagedDisplayLabelDefinitions(\n    options: DisplayLabelsRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute,\n  ): Promise<PagedResponse<LabelDefinition>> {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return this.request<PagedResponse<LabelDefinition>, typeof options>(this.rpcClient.getPagedDisplayLabelDefinitions.bind(this.rpcClient), options);\n  }\n\n  public async getSelectionScopes(options: SelectionScopeRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<SelectionScope[]> {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return this.request<SelectionScope[], typeof options>(this.rpcClient.getSelectionScopes.bind(this.rpcClient), options);\n  }\n  public async computeSelection(options: ComputeSelectionRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<KeySetJSON> {\n    return this.request<KeySetJSON, typeof options>(\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\n      this.rpcClient.computeSelection.bind(this.rpcClient),\n      options,\n    );\n  }\n}\n\nfunction isOptionsWithRuleset(options: object): options is { rulesetOrId: Ruleset } {\n  return typeof (options as RequestOptionsWithRuleset<any, any>).rulesetOrId === \"object\";\n}\n\ntype RulesetWithRequiredProperties = {\n  [key in keyof Ruleset]-?: true;\n};\n\nconst RULESET_SUPPORTED_PROPERTIES_OBJ: RulesetWithRequiredProperties = {\n  id: true,\n  rules: true,\n  version: true,\n  requiredSchemas: true,\n  supplementationInfo: true,\n  vars: true,\n};\n\nfunction cleanupRuleset(ruleset: Ruleset): Ruleset {\n  const cleanedUpRuleset: Ruleset = { ...ruleset };\n\n  for (const propertyKey of Object.keys(cleanedUpRuleset)) {\n    if (!RULESET_SUPPORTED_PROPERTIES_OBJ.hasOwnProperty(propertyKey)) {\n      if (propertyKey === \"$schema\") {\n        delete (cleanedUpRuleset as any)[propertyKey];\n      } else {\n        Logger.logWarning(\n          PresentationCommonLoggerCategory.Package,\n          `Provided ruleset contains unrecognized attribute '${propertyKey}'. It either doesn't exist or may be no longer supported.`,\n        );\n      }\n    }\n  }\n\n  return cleanedUpRuleset;\n}\n"]}
+{"version":3,"file":"RpcRequestsHandler.js","sourceRoot":"","sources":["../../../src/presentation-common/RpcRequestsHandler.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC5E,OAAO,EAAkB,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,gCAAgC,EAAE,MAAM,wBAAwB,CAAC;AAM1E,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAwBhE,OAAO,EAA2B,wBAAwB,EAA0D,MAAM,4BAA4B,CAAC;AAMvJ;;;GAGG;AACH,MAAM,uBAAuB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,aAAa;AAmB7D;;;;;;GAMG;AACH,MAAM,OAAO,kBAAkB;IAO7B,YAAmB,KAA+B;QAChD,IAAI,CAAC,QAAQ,GAAG,KAAK,EAAE,QAAQ,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;QACtD,IAAI,CAAC,OAAO,GAAG,KAAK,EAAE,OAAO,IAAI,uBAAuB,CAAC;IAC3D,CAAC;IAED,gEAAgE;IAChE,IAAY,SAAS;QACnB,OAAO,UAAU,CAAC,qBAAqB,CAAC,wBAAwB,CAAC,CAAC;IACpE,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAU,IAA4C,EAAE,kBAA6C;QACnI,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAChC,MAAM,OAAO,GAAG,UAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,WAA0C,CAAC;QAC/C,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,CAAC;YACtC,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,IAAI,EAAE,CAAC;gBAC9B,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;gBACnC,QAAQ,QAAQ,CAAC,UAAU,EAAE,CAAC;oBAC5B,KAAK,kBAAkB,CAAC,OAAO;wBAC7B,OAAO,QAAQ,CAAC,MAAO,CAAC;oBAC1B,KAAK,kBAAkB,CAAC,cAAc;wBACpC,MAAM;oBACR;wBACE,MAAM,IAAI,iBAAiB,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;gBAC5E,CAAC;YACH,CAAC;oBAAS,CAAC;gBACT,kBAAkB,IAAI,WAAW,IAAI,kBAAkB,CAAC,WAAW,CAAC,CAAC;YACvE,CAAC;QACH,CAAC;QACD,MAAM,IAAI,iBAAiB,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,OAAO,CAClB,IAAoI,EACpI,OAAiB,EACjB,GAAG,iBAAyB;QAE5B,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAE,GAAG,OAAO,CAAC;QAC5D,MAAM,EAAE,OAAO,EAAE,kBAAkB,EAAE,GAAG,kBAAkB,EAAE,GAAG,WAAW,IAAI,EAAE,CAAC;QACjF,IAAI,oBAAoB,CAAC,eAAe,CAAC,EAAE,CAAC;YAC1C,eAAe,CAAC,WAAW,GAAG,cAAc,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QAC5E,CAAC;QACD,MAAM,UAAU,GAA4C;YAC1D,GAAG,eAAe;YAClB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;QACF,IAAI,WAAW,EAAE,CAAC;YAChB,UAAU,CAAC,WAAW,GAAG,kBAAkB,CAAC;QAC9C,CAAC;QACD,MAAM,SAAS,GAAG,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,iBAAiB,CAAC,CAAC;QAC7E,OAAO,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,OAA2G;QACpI,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAyB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC1G,CAAC;IAEM,KAAK,CAAC,aAAa,CACxB,OAAkH;QAGlH,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAA0C,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC3H,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAC7B,OAA0H;QAE1H,4DAA4D;QAC5D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAsD,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;QAC1J,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjC,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,YAAY,CACvB,OAAuH;QAGvH,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAwC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACxH,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAC/B,OAA8G;QAG9G,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAwC,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAChI,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,OAAkF;QAC/G,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAA0C,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/H,CAAC;IACM,KAAK,CAAC,oBAAoB,CAC/B,OAAsH;QAEtH,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAA6C,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACrI,CAAC;IACM,KAAK,CAAC,iBAAiB,CAC5B,OAAiI;QAEjI,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAyB,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC9G,CAAC;IACM,KAAK,CAAC,eAAe,CAC1B,OAAwI;QAExI,OAAO,IAAI,CAAC,OAAO;QACjB,4DAA4D;QAC5D,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EACnD,OAAO,CACR,CAAC;IACJ,CAAC;IACM,KAAK,CAAC,kBAAkB,CAC7B,OAAwI;QAExI,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAA0C,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAChI,CAAC;IAEM,KAAK,CAAC,sBAAsB,CACjC,OAAwI;QAGxI,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAuD,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACjJ,CAAC;IAEM,KAAK,CAAC,sBAAsB,CACjC,OAAwH;QAExH,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAuD,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACjJ,CAAC;IAEM,KAAK,CAAC,yBAAyB,CACpC,OAA6F;QAE7F,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAkC,IAAI,CAAC,SAAS,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/H,CAAC;IACM,KAAK,CAAC,+BAA+B,CAC1C,OAA8F;QAE9F,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAiD,IAAI,CAAC,SAAS,CAAC,+BAA+B,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACpJ,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,OAAkF;QAChH,4DAA4D;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAmC,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACzH,CAAC;IACM,KAAK,CAAC,gBAAgB,CAAC,OAAoF;QAChH,OAAO,IAAI,CAAC,OAAO;QACjB,4DAA4D;QAC5D,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EACpD,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AAED,SAAS,oBAAoB,CAAC,OAAe;IAC3C,OAAO,OAAQ,OAA+C,CAAC,WAAW,KAAK,QAAQ,CAAC;AAC1F,CAAC;AAMD,MAAM,gCAAgC,GAAkC;IACtE,EAAE,EAAE,IAAI;IACR,KAAK,EAAE,IAAI;IACX,OAAO,EAAE,IAAI;IACb,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,IAAI,EAAE,IAAI;CACX,CAAC;AAEF,SAAS,cAAc,CAAC,OAAgB;IACtC,MAAM,gBAAgB,GAAY,EAAE,GAAG,OAAO,EAAE,CAAC;IAEjD,KAAK,MAAM,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACxD,IAAI,CAAC,gCAAgC,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE,CAAC;YAClE,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9B,OAAQ,gBAAwB,CAAC,WAAW,CAAC,CAAC;YAChD,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,UAAU,CACf,gCAAgC,CAAC,OAAO,EACxC,qDAAqD,WAAW,2DAA2D,CAC5H,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module RPC\r\n */\r\n\r\nimport { BeDuration, BeTimePoint, Guid, Logger } from \"@itwin/core-bentley\";\r\nimport { IModelRpcProps, RpcManager } from \"@itwin/core-common\";\r\nimport { PresentationCommonLoggerCategory } from \"./CommonLoggerCategory\";\r\nimport { DescriptorJSON, DescriptorOverrides } from \"./content/Descriptor\";\r\nimport { ItemJSON } from \"./content/Item\";\r\nimport { DisplayValueGroupJSON } from \"./content/Value\";\r\nimport { ClientDiagnostics, ClientDiagnosticsAttribute, ClientDiagnosticsHandler } from \"./Diagnostics\";\r\nimport { InstanceKey } from \"./EC\";\r\nimport { PresentationError, PresentationStatus } from \"./Error\";\r\nimport { NodeKey } from \"./hierarchy/Key\";\r\nimport { NodeJSON } from \"./hierarchy/Node\";\r\nimport { NodePathElementJSON } from \"./hierarchy/NodePathElement\";\r\nimport { KeySetJSON } from \"./KeySet\";\r\nimport { LabelDefinition } from \"./LabelDefinition\";\r\nimport {\r\n  ComputeSelectionRequestOptions,\r\n  ContentDescriptorRequestOptions,\r\n  ContentInstanceKeysRequestOptions,\r\n  ContentRequestOptions,\r\n  ContentSourcesRequestOptions,\r\n  DisplayLabelRequestOptions,\r\n  DisplayLabelsRequestOptions,\r\n  DistinctValuesRequestOptions,\r\n  FilterByInstancePathsHierarchyRequestOptions,\r\n  FilterByTextHierarchyRequestOptions,\r\n  HierarchyLevelDescriptorRequestOptions,\r\n  HierarchyRequestOptions,\r\n  Paged,\r\n  RequestOptions,\r\n  RequestOptionsWithRuleset,\r\n  SelectionScopeRequestOptions,\r\n} from \"./PresentationManagerOptions\";\r\nimport { ContentSourcesRpcResult, PresentationRpcInterface, PresentationRpcRequestOptions, PresentationRpcResponse } from \"./PresentationRpcInterface\";\r\nimport { Ruleset } from \"./rules/Ruleset\";\r\nimport { RulesetVariableJSON } from \"./RulesetVariables\";\r\nimport { SelectionScope } from \"./selection/SelectionScope\";\r\nimport { PagedResponse } from \"./Utils\";\r\n\r\n/**\r\n * Default timeout for how long we're going to wait for RPC request to be fulfilled before throwing\r\n * a timeout error.\r\n */\r\nconst DEFAULT_REQUEST_TIMEOUT = 10 * 60 * 1000; // 10 minutes\r\n\r\n/**\r\n * Configuration parameters for [[RpcRequestsHandler]].\r\n *\r\n * @internal\r\n */\r\nexport interface RpcRequestsHandlerProps {\r\n  /**\r\n   * Optional ID used to identify client that requests data. If not specified,\r\n   * the handler creates a unique GUID as a client id.\r\n   * @internal\r\n   */\r\n  clientId?: string;\r\n\r\n  /** @internal */\r\n  timeout?: number;\r\n}\r\n\r\n/**\r\n * RPC requests handler that wraps [[PresentationRpcInterface]] and\r\n * adds handling for cases when backend needs to be synced with client\r\n * state.\r\n *\r\n * @internal\r\n */\r\nexport class RpcRequestsHandler {\r\n  /** Timeout for how long the handler going to wait for RPC request to be fulfilled before throwing a timeout error. */\r\n  public readonly timeout: number;\r\n\r\n  /** ID that identifies this handler as a client */\r\n  public readonly clientId: string;\r\n\r\n  public constructor(props?: RpcRequestsHandlerProps) {\r\n    this.clientId = props?.clientId ?? Guid.createValue();\r\n    this.timeout = props?.timeout ?? DEFAULT_REQUEST_TIMEOUT;\r\n  }\r\n\r\n  // eslint-disable-next-line @typescript-eslint/naming-convention\r\n  private get rpcClient(): PresentationRpcInterface {\r\n    return RpcManager.getClientForInterface(PresentationRpcInterface);\r\n  }\r\n\r\n  private async requestWithTimeout<TResult>(func: () => PresentationRpcResponse<TResult>, diagnosticsHandler?: ClientDiagnosticsHandler): Promise<TResult> {\r\n    const start = BeTimePoint.now();\r\n    const timeout = BeDuration.fromMilliseconds(this.timeout);\r\n    let diagnostics: ClientDiagnostics | undefined;\r\n    while (start.plus(timeout).isInFuture) {\r\n      try {\r\n        const response = await func();\r\n        diagnostics = response.diagnostics;\r\n        switch (response.statusCode) {\r\n          case PresentationStatus.Success:\r\n            return response.result!;\r\n          case PresentationStatus.BackendTimeout:\r\n            break;\r\n          default:\r\n            throw new PresentationError(response.statusCode, response.errorMessage);\r\n        }\r\n      } finally {\r\n        diagnosticsHandler && diagnostics && diagnosticsHandler(diagnostics);\r\n      }\r\n    }\r\n    throw new PresentationError(PresentationStatus.BackendTimeout);\r\n  }\r\n\r\n  /**\r\n   * Send the request to backend.\r\n   *\r\n   * If the backend responds with [[PresentationStatus.BackendTimeout]], the request is repeated until we hit `timeout` or get\r\n   * a response. If the response is other than [[PresentationStatus.BackendTimeout]] or [[PresentationStatus.Success]], a [[PresentationError]]\r\n   * is thrown with the details from the response.\r\n   */\r\n  public async request<TResult, TOptions extends RequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute, TArg = any>(\r\n    func: (token: IModelRpcProps, options: PresentationRpcRequestOptions<TOptions>, ...args: TArg[]) => PresentationRpcResponse<TResult>,\r\n    options: TOptions,\r\n    ...additionalOptions: TArg[]\r\n  ): Promise<TResult> {\r\n    const { imodel, diagnostics, ...optionsNoIModel } = options;\r\n    const { handler: diagnosticsHandler, ...diagnosticsOptions } = diagnostics ?? {};\r\n    if (isOptionsWithRuleset(optionsNoIModel)) {\r\n      optionsNoIModel.rulesetOrId = cleanupRuleset(optionsNoIModel.rulesetOrId);\r\n    }\r\n    const rpcOptions: PresentationRpcRequestOptions<TOptions> = {\r\n      ...optionsNoIModel,\r\n      clientId: this.clientId,\r\n    };\r\n    if (diagnostics) {\r\n      rpcOptions.diagnostics = diagnosticsOptions;\r\n    }\r\n    const doRequest = async () => func(imodel, rpcOptions, ...additionalOptions);\r\n    return this.requestWithTimeout(doRequest, diagnosticsHandler);\r\n  }\r\n\r\n  public async getNodesCount(options: HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number> {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    return this.request<number, typeof options>(this.rpcClient.getNodesCount.bind(this.rpcClient), options);\r\n  }\r\n\r\n  public async getPagedNodes(\r\n    options: Paged<HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON>> & ClientDiagnosticsAttribute,\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  ): Promise<PagedResponse<NodeJSON>> {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    return this.request<PagedResponse<NodeJSON>, typeof options>(this.rpcClient.getPagedNodes.bind(this.rpcClient), options);\r\n  }\r\n\r\n  public async getNodesDescriptor(\r\n    options: HierarchyLevelDescriptorRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute,\r\n  ): Promise<DescriptorJSON | undefined> {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    const response = await this.request<string | DescriptorJSON | undefined, typeof options>(this.rpcClient.getNodesDescriptor.bind(this.rpcClient), options);\r\n    if (typeof response === \"string\") {\r\n      return JSON.parse(response);\r\n    }\r\n    return response;\r\n  }\r\n\r\n  public async getNodePaths(\r\n    options: FilterByInstancePathsHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute,\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  ): Promise<NodePathElementJSON[]> {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    return this.request<NodePathElementJSON[], typeof options>(this.rpcClient.getNodePaths.bind(this.rpcClient), options);\r\n  }\r\n\r\n  public async getFilteredNodePaths(\r\n    options: FilterByTextHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute,\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  ): Promise<NodePathElementJSON[]> {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    return this.request<NodePathElementJSON[], typeof options>(this.rpcClient.getFilteredNodePaths.bind(this.rpcClient), options);\r\n  }\r\n\r\n  public async getContentSources(options: ContentSourcesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ContentSourcesRpcResult> {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    return this.request<ContentSourcesRpcResult, typeof options>(this.rpcClient.getContentSources.bind(this.rpcClient), options);\r\n  }\r\n  public async getContentDescriptor(\r\n    options: ContentDescriptorRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute,\r\n  ): Promise<DescriptorJSON | undefined> {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    return this.request<DescriptorJSON | undefined, typeof options>(this.rpcClient.getContentDescriptor.bind(this.rpcClient), options);\r\n  }\r\n  public async getContentSetSize(\r\n    options: ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute,\r\n  ): Promise<number> {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    return this.request<number, typeof options>(this.rpcClient.getContentSetSize.bind(this.rpcClient), options);\r\n  }\r\n  public async getPagedContent(\r\n    options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>,\r\n  ) {\r\n    return this.request<{ descriptor: DescriptorJSON; contentSet: PagedResponse<ItemJSON> } | undefined, typeof options>(\r\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n      this.rpcClient.getPagedContent.bind(this.rpcClient),\r\n      options,\r\n    );\r\n  }\r\n  public async getPagedContentSet(\r\n    options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>,\r\n  ) {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    return this.request<PagedResponse<ItemJSON>, typeof options>(this.rpcClient.getPagedContentSet.bind(this.rpcClient), options);\r\n  }\r\n\r\n  public async getPagedDistinctValues(\r\n    options: DistinctValuesRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute,\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  ): Promise<PagedResponse<DisplayValueGroupJSON>> {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    return this.request<PagedResponse<DisplayValueGroupJSON>, typeof options>(this.rpcClient.getPagedDistinctValues.bind(this.rpcClient), options);\r\n  }\r\n\r\n  public async getContentInstanceKeys(\r\n    options: ContentInstanceKeysRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute,\r\n  ): Promise<{ total: number; items: KeySetJSON }> {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    return this.request<{ total: number; items: KeySetJSON }, typeof options>(this.rpcClient.getContentInstanceKeys.bind(this.rpcClient), options);\r\n  }\r\n\r\n  public async getDisplayLabelDefinition(\r\n    options: DisplayLabelRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute,\r\n  ): Promise<LabelDefinition> {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    return this.request<LabelDefinition, typeof options>(this.rpcClient.getDisplayLabelDefinition.bind(this.rpcClient), options);\r\n  }\r\n  public async getPagedDisplayLabelDefinitions(\r\n    options: DisplayLabelsRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute,\r\n  ): Promise<PagedResponse<LabelDefinition>> {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    return this.request<PagedResponse<LabelDefinition>, typeof options>(this.rpcClient.getPagedDisplayLabelDefinitions.bind(this.rpcClient), options);\r\n  }\r\n\r\n  public async getSelectionScopes(options: SelectionScopeRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<SelectionScope[]> {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    return this.request<SelectionScope[], typeof options>(this.rpcClient.getSelectionScopes.bind(this.rpcClient), options);\r\n  }\r\n  public async computeSelection(options: ComputeSelectionRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<KeySetJSON> {\r\n    return this.request<KeySetJSON, typeof options>(\r\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n      this.rpcClient.computeSelection.bind(this.rpcClient),\r\n      options,\r\n    );\r\n  }\r\n}\r\n\r\nfunction isOptionsWithRuleset(options: object): options is { rulesetOrId: Ruleset } {\r\n  return typeof (options as RequestOptionsWithRuleset<any, any>).rulesetOrId === \"object\";\r\n}\r\n\r\ntype RulesetWithRequiredProperties = {\r\n  [key in keyof Ruleset]-?: true;\r\n};\r\n\r\nconst RULESET_SUPPORTED_PROPERTIES_OBJ: RulesetWithRequiredProperties = {\r\n  id: true,\r\n  rules: true,\r\n  version: true,\r\n  requiredSchemas: true,\r\n  supplementationInfo: true,\r\n  vars: true,\r\n};\r\n\r\nfunction cleanupRuleset(ruleset: Ruleset): Ruleset {\r\n  const cleanedUpRuleset: Ruleset = { ...ruleset };\r\n\r\n  for (const propertyKey of Object.keys(cleanedUpRuleset)) {\r\n    if (!RULESET_SUPPORTED_PROPERTIES_OBJ.hasOwnProperty(propertyKey)) {\r\n      if (propertyKey === \"$schema\") {\r\n        delete (cleanedUpRuleset as any)[propertyKey];\r\n      } else {\r\n        Logger.logWarning(\r\n          PresentationCommonLoggerCategory.Package,\r\n          `Provided ruleset contains unrecognized attribute '${propertyKey}'. It either doesn't exist or may be no longer supported.`,\r\n        );\r\n      }\r\n    }\r\n  }\r\n\r\n  return cleanedUpRuleset;\r\n}\r\n"]}

package/lib/esm/presentation-common/RulesetVariables.js.map

@@ -1 +1 @@
-{"version":3,"file":"RulesetVariables.js","sourceRoot":"","sources":["../../../src/presentation-common/RulesetVariables.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAc,MAAM,qBAAqB,CAAC;AAEpE;;;GAGG;AACH,MAAM,CAAN,IAAY,kBAkBX;AAlBD,WAAY,kBAAkB;IAC5B,oBAAoB;IACpB,iCAAW,CAAA;IAEX,8BAA8B;IAC9B,wCAAkB,CAAA;IAElB,oBAAoB;IACpB,mCAAa,CAAA;IAEb,mBAAmB;IACnB,uCAAiB,CAAA;IAEjB,uBAAuB;IACvB,mCAAa,CAAA;IAEb,iCAAiC;IACjC,0CAAoB,CAAA;AACtB,CAAC,EAlBW,kBAAkB,KAAlB,kBAAkB,QAkB7B;AA8JD,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,eAAe,CAsB/B;AAtBD,WAAiB,eAAe;IAC9B;;;OAGG;IACH,SAAgB,MAAM,CAAC,QAAyB;QAC9C,IAAI,QAAQ,CAAC,IAAI,KAAK,kBAAkB,CAAC,SAAS,EAAE,CAAC;YACnD,OAAO,EAAE,GAAG,QAAQ,EAAE,KAAK,EAAE,iBAAiB,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACjF,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IALe,sBAAM,SAKrB,CAAA;IAED,iDAAiD;IACjD,SAAgB,QAAQ,CAAC,IAAyB;QAChD,IAAI,IAAI,CAAC,IAAI,KAAK,kBAAkB,CAAC,SAAS,EAAE,CAAC;YAC/C,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACnC,OAAO,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3E,CAAC;YACD,OAAO,IAAW,CAAC,CAAC,kFAAkF;QACxG,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IARe,wBAAQ,WAQvB,CAAA;AACH,CAAC,EAtBgB,eAAe,KAAf,eAAe,QAsB/B","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 { CompressedId64Set, Id64String } from \"@itwin/core-bentley\";\n\n/**\n * Possible variable value types\n * @public\n */\nexport enum VariableValueTypes {\n  /** Integer value */\n  Int = \"int\",\n\n  /** Array of integer values */\n  IntArray = \"int[]\",\n\n  /** Boolean value */\n  Bool = \"bool\",\n\n  /** String value */\n  String = \"string\",\n\n  /** Id64String value */\n  Id64 = \"id64\",\n\n  /** Array of Id64String values */\n  Id64Array = \"id64[]\",\n}\n\n/**\n * Union of all supported variable value types\n * @public\n */\nexport type VariableValue = boolean | string | number | number[] | Id64String | Id64String[];\n\n/**\n * JSON representation of [[VariableValue]]\n * @public\n */\nexport type VariableValueJSON = boolean | string | number | number[] | Id64String | Id64String[] | CompressedId64Set;\n\n/**\n * Base data structure for representing ruleset variables.\n * @public\n */\nexport interface RulesetVariableBase {\n  id: string;\n  type: VariableValueTypes;\n  value: VariableValue;\n}\n/**\n * Data structure for representing boolean ruleset variables.\n * @public\n */\nexport interface BooleanRulesetVariable extends RulesetVariableBase {\n  type: VariableValueTypes.Bool;\n  value: boolean;\n}\n/**\n * Data structure for representing string ruleset variables.\n * @public\n */\nexport interface StringRulesetVariable extends RulesetVariableBase {\n  type: VariableValueTypes.String;\n  value: string;\n}\n/**\n * Data structure for representing int ruleset variables.\n * @public\n */\nexport interface IntRulesetVariable extends RulesetVariableBase {\n  type: VariableValueTypes.Int;\n  value: number;\n}\n/**\n * Data structure for representing int array ruleset variables.\n * @public\n */\nexport interface IntsRulesetVariable extends RulesetVariableBase {\n  type: VariableValueTypes.IntArray;\n  value: number[];\n}\n/**\n * Data structure for representing ID ruleset variables.\n * @public\n */\nexport interface Id64RulesetVariable extends RulesetVariableBase {\n  type: VariableValueTypes.Id64;\n  value: Id64String;\n}\n/**\n * Data structure for representing ID array ruleset variables.\n * @public\n */\nexport interface Id64sRulesetVariable extends RulesetVariableBase {\n  type: VariableValueTypes.Id64Array;\n  value: Id64String[];\n}\n/**\n * Data structure for representing ruleset variables.\n * @public\n */\nexport type RulesetVariable =\n  | BooleanRulesetVariable\n  | StringRulesetVariable\n  | IntRulesetVariable\n  | IntsRulesetVariable\n  | Id64RulesetVariable\n  | Id64sRulesetVariable;\n\n/**\n * JSON representation of [[RulesetVariableBase]].\n * @public\n */\nexport interface RulesetVariableBaseJSON {\n  id: string;\n  type: VariableValueTypes;\n  value: VariableValueJSON;\n}\n/**\n * JSON representation of [[BooleanRulesetVariable]].\n * @public\n * @deprecated in 3.x. Use [[BooleanRulesetVariable]]\n */\nexport interface BooleanRulesetVariableJSON extends RulesetVariableBaseJSON {\n  type: VariableValueTypes.Bool;\n  value: boolean;\n}\n/**\n * JSON representation of [[StringRulesetVariable]].\n * @public\n * @deprecated in 3.x. Use [[StringRulesetVariable]]\n */\nexport interface StringRulesetVariableJSON extends RulesetVariableBaseJSON {\n  type: VariableValueTypes.String;\n  value: string;\n}\n/**\n * JSON representation of [[IntRulesetVariable]].\n * @public\n * @deprecated in 3.x. Use [[IntRulesetVariable]]\n */\nexport interface IntRulesetVariableJSON extends RulesetVariableBaseJSON {\n  type: VariableValueTypes.Int;\n  value: number;\n}\n/**\n * JSON representation of [[IntsRulesetVariable]].\n * @public\n * @deprecated in 3.x. Use [[IntsRulesetVariable]]\n */\nexport interface IntsRulesetVariableJSON extends RulesetVariableBaseJSON {\n  type: VariableValueTypes.IntArray;\n  value: number[];\n}\n/**\n * JSON representation of [[Id64RulesetVariable]].\n * @public\n * @deprecated in 3.x. Use [[Id64RulesetVariable]]\n */\nexport interface Id64RulesetVariableJSON extends RulesetVariableBaseJSON {\n  type: VariableValueTypes.Id64;\n  value: Id64String;\n}\n/**\n * JSON representation of [[Id64sRulesetVariable]].\n * @public\n */\nexport interface Id64sRulesetVariableJSON extends RulesetVariableBaseJSON {\n  type: VariableValueTypes.Id64Array;\n  value: Id64String[] | CompressedId64Set;\n}\n/**\n * JSON representation of [[RulesetVariable]].\n * @public\n */\n\nexport type RulesetVariableJSON =\n  | BooleanRulesetVariableJSON // eslint-disable-line @typescript-eslint/no-deprecated\n  | StringRulesetVariableJSON // eslint-disable-line @typescript-eslint/no-deprecated\n  | IntRulesetVariableJSON // eslint-disable-line @typescript-eslint/no-deprecated\n  | IntsRulesetVariableJSON // eslint-disable-line @typescript-eslint/no-deprecated\n  | Id64RulesetVariableJSON // eslint-disable-line @typescript-eslint/no-deprecated\n  | Id64sRulesetVariableJSON;\n\n/** @public */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace RulesetVariable {\n  /**\n   * Serialize given RulesetVariable to JSON.\n   * Note: In case of [[Id64sRulesetVariable]], this method expects IDs are sorted. See [[OrderedId64Iterable.sortArray]].\n   */\n  export function toJSON(variable: RulesetVariable): RulesetVariableJSON {\n    if (variable.type === VariableValueTypes.Id64Array) {\n      return { ...variable, value: CompressedId64Set.compressArray(variable.value) };\n    }\n    return variable;\n  }\n\n  /** Deserialize [[RulesetVariable]] from JSON. */\n  export function fromJSON(json: RulesetVariableJSON): RulesetVariable {\n    if (json.type === VariableValueTypes.Id64Array) {\n      if (typeof json.value === \"string\") {\n        return { ...json, value: CompressedId64Set.decompressArray(json.value) };\n      }\n      return json as any; // for some reason TS doesn't understand that `json.value` is always an array here\n    }\n    return json;\n  }\n}\n"]}
+{"version":3,"file":"RulesetVariables.js","sourceRoot":"","sources":["../../../src/presentation-common/RulesetVariables.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAc,MAAM,qBAAqB,CAAC;AAEpE;;;GAGG;AACH,MAAM,CAAN,IAAY,kBAkBX;AAlBD,WAAY,kBAAkB;IAC5B,oBAAoB;IACpB,iCAAW,CAAA;IAEX,8BAA8B;IAC9B,wCAAkB,CAAA;IAElB,oBAAoB;IACpB,mCAAa,CAAA;IAEb,mBAAmB;IACnB,uCAAiB,CAAA;IAEjB,uBAAuB;IACvB,mCAAa,CAAA;IAEb,iCAAiC;IACjC,0CAAoB,CAAA;AACtB,CAAC,EAlBW,kBAAkB,KAAlB,kBAAkB,QAkB7B;AA8JD,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,eAAe,CAsB/B;AAtBD,WAAiB,eAAe;IAC9B;;;OAGG;IACH,SAAgB,MAAM,CAAC,QAAyB;QAC9C,IAAI,QAAQ,CAAC,IAAI,KAAK,kBAAkB,CAAC,SAAS,EAAE,CAAC;YACnD,OAAO,EAAE,GAAG,QAAQ,EAAE,KAAK,EAAE,iBAAiB,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACjF,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IALe,sBAAM,SAKrB,CAAA;IAED,iDAAiD;IACjD,SAAgB,QAAQ,CAAC,IAAyB;QAChD,IAAI,IAAI,CAAC,IAAI,KAAK,kBAAkB,CAAC,SAAS,EAAE,CAAC;YAC/C,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACnC,OAAO,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3E,CAAC;YACD,OAAO,IAAW,CAAC,CAAC,kFAAkF;QACxG,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IARe,wBAAQ,WAQvB,CAAA;AACH,CAAC,EAtBgB,eAAe,KAAf,eAAe,QAsB/B","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 { CompressedId64Set, Id64String } from \"@itwin/core-bentley\";\r\n\r\n/**\r\n * Possible variable value types\r\n * @public\r\n */\r\nexport enum VariableValueTypes {\r\n  /** Integer value */\r\n  Int = \"int\",\r\n\r\n  /** Array of integer values */\r\n  IntArray = \"int[]\",\r\n\r\n  /** Boolean value */\r\n  Bool = \"bool\",\r\n\r\n  /** String value */\r\n  String = \"string\",\r\n\r\n  /** Id64String value */\r\n  Id64 = \"id64\",\r\n\r\n  /** Array of Id64String values */\r\n  Id64Array = \"id64[]\",\r\n}\r\n\r\n/**\r\n * Union of all supported variable value types\r\n * @public\r\n */\r\nexport type VariableValue = boolean | string | number | number[] | Id64String | Id64String[];\r\n\r\n/**\r\n * JSON representation of [[VariableValue]]\r\n * @public\r\n */\r\nexport type VariableValueJSON = boolean | string | number | number[] | Id64String | Id64String[] | CompressedId64Set;\r\n\r\n/**\r\n * Base data structure for representing ruleset variables.\r\n * @public\r\n */\r\nexport interface RulesetVariableBase {\r\n  id: string;\r\n  type: VariableValueTypes;\r\n  value: VariableValue;\r\n}\r\n/**\r\n * Data structure for representing boolean ruleset variables.\r\n * @public\r\n */\r\nexport interface BooleanRulesetVariable extends RulesetVariableBase {\r\n  type: VariableValueTypes.Bool;\r\n  value: boolean;\r\n}\r\n/**\r\n * Data structure for representing string ruleset variables.\r\n * @public\r\n */\r\nexport interface StringRulesetVariable extends RulesetVariableBase {\r\n  type: VariableValueTypes.String;\r\n  value: string;\r\n}\r\n/**\r\n * Data structure for representing int ruleset variables.\r\n * @public\r\n */\r\nexport interface IntRulesetVariable extends RulesetVariableBase {\r\n  type: VariableValueTypes.Int;\r\n  value: number;\r\n}\r\n/**\r\n * Data structure for representing int array ruleset variables.\r\n * @public\r\n */\r\nexport interface IntsRulesetVariable extends RulesetVariableBase {\r\n  type: VariableValueTypes.IntArray;\r\n  value: number[];\r\n}\r\n/**\r\n * Data structure for representing ID ruleset variables.\r\n * @public\r\n */\r\nexport interface Id64RulesetVariable extends RulesetVariableBase {\r\n  type: VariableValueTypes.Id64;\r\n  value: Id64String;\r\n}\r\n/**\r\n * Data structure for representing ID array ruleset variables.\r\n * @public\r\n */\r\nexport interface Id64sRulesetVariable extends RulesetVariableBase {\r\n  type: VariableValueTypes.Id64Array;\r\n  value: Id64String[];\r\n}\r\n/**\r\n * Data structure for representing ruleset variables.\r\n * @public\r\n */\r\nexport type RulesetVariable =\r\n  | BooleanRulesetVariable\r\n  | StringRulesetVariable\r\n  | IntRulesetVariable\r\n  | IntsRulesetVariable\r\n  | Id64RulesetVariable\r\n  | Id64sRulesetVariable;\r\n\r\n/**\r\n * JSON representation of [[RulesetVariableBase]].\r\n * @public\r\n */\r\nexport interface RulesetVariableBaseJSON {\r\n  id: string;\r\n  type: VariableValueTypes;\r\n  value: VariableValueJSON;\r\n}\r\n/**\r\n * JSON representation of [[BooleanRulesetVariable]].\r\n * @public\r\n * @deprecated in 3.x. Use [[BooleanRulesetVariable]]\r\n */\r\nexport interface BooleanRulesetVariableJSON extends RulesetVariableBaseJSON {\r\n  type: VariableValueTypes.Bool;\r\n  value: boolean;\r\n}\r\n/**\r\n * JSON representation of [[StringRulesetVariable]].\r\n * @public\r\n * @deprecated in 3.x. Use [[StringRulesetVariable]]\r\n */\r\nexport interface StringRulesetVariableJSON extends RulesetVariableBaseJSON {\r\n  type: VariableValueTypes.String;\r\n  value: string;\r\n}\r\n/**\r\n * JSON representation of [[IntRulesetVariable]].\r\n * @public\r\n * @deprecated in 3.x. Use [[IntRulesetVariable]]\r\n */\r\nexport interface IntRulesetVariableJSON extends RulesetVariableBaseJSON {\r\n  type: VariableValueTypes.Int;\r\n  value: number;\r\n}\r\n/**\r\n * JSON representation of [[IntsRulesetVariable]].\r\n * @public\r\n * @deprecated in 3.x. Use [[IntsRulesetVariable]]\r\n */\r\nexport interface IntsRulesetVariableJSON extends RulesetVariableBaseJSON {\r\n  type: VariableValueTypes.IntArray;\r\n  value: number[];\r\n}\r\n/**\r\n * JSON representation of [[Id64RulesetVariable]].\r\n * @public\r\n * @deprecated in 3.x. Use [[Id64RulesetVariable]]\r\n */\r\nexport interface Id64RulesetVariableJSON extends RulesetVariableBaseJSON {\r\n  type: VariableValueTypes.Id64;\r\n  value: Id64String;\r\n}\r\n/**\r\n * JSON representation of [[Id64sRulesetVariable]].\r\n * @public\r\n */\r\nexport interface Id64sRulesetVariableJSON extends RulesetVariableBaseJSON {\r\n  type: VariableValueTypes.Id64Array;\r\n  value: Id64String[] | CompressedId64Set;\r\n}\r\n/**\r\n * JSON representation of [[RulesetVariable]].\r\n * @public\r\n */\r\n\r\nexport type RulesetVariableJSON =\r\n  | BooleanRulesetVariableJSON // eslint-disable-line @typescript-eslint/no-deprecated\r\n  | StringRulesetVariableJSON // eslint-disable-line @typescript-eslint/no-deprecated\r\n  | IntRulesetVariableJSON // eslint-disable-line @typescript-eslint/no-deprecated\r\n  | IntsRulesetVariableJSON // eslint-disable-line @typescript-eslint/no-deprecated\r\n  | Id64RulesetVariableJSON // eslint-disable-line @typescript-eslint/no-deprecated\r\n  | Id64sRulesetVariableJSON;\r\n\r\n/** @public */\r\n// eslint-disable-next-line @typescript-eslint/no-redeclare\r\nexport namespace RulesetVariable {\r\n  /**\r\n   * Serialize given RulesetVariable to JSON.\r\n   * Note: In case of [[Id64sRulesetVariable]], this method expects IDs are sorted. See [[OrderedId64Iterable.sortArray]].\r\n   */\r\n  export function toJSON(variable: RulesetVariable): RulesetVariableJSON {\r\n    if (variable.type === VariableValueTypes.Id64Array) {\r\n      return { ...variable, value: CompressedId64Set.compressArray(variable.value) };\r\n    }\r\n    return variable;\r\n  }\r\n\r\n  /** Deserialize [[RulesetVariable]] from JSON. */\r\n  export function fromJSON(json: RulesetVariableJSON): RulesetVariable {\r\n    if (json.type === VariableValueTypes.Id64Array) {\r\n      if (typeof json.value === \"string\") {\r\n        return { ...json, value: CompressedId64Set.decompressArray(json.value) };\r\n      }\r\n      return json as any; // for some reason TS doesn't understand that `json.value` is always an array here\r\n    }\r\n    return json;\r\n  }\r\n}\r\n"]}

package/lib/esm/presentation-common/RulesetsFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"RulesetsFactory.js","sourceRoot":"","sources":["../../../src/presentation-common/RulesetsFactory.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AAG7D,OAAO,EAA4B,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAC1F,OAAO,EAAgB,KAAK,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAA0B,gBAAgB,EAAE,MAAM,MAAM,CAAC;AAEhE,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AAEjF,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAGzC;;;;;GAKG;AACH,MAAM,OAAO,eAAe;IAClB,iCAAiC,CAAC,KAAY,EAAE,MAAY;QAClE,IAAI,CAAC,KAAK,CAAC,iBAAiB,EAAE,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,0EAA0E,CAAC,CAAC;QAC9F,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,CAAC,WAAW,KAAK,mBAAmB,CAAC,SAAS,EAAE,CAAC;YAC7D,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAC;QAC1F,CAAC;QACD,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAClE,CAAC;QACD,IAAI,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,4FAA4F,CAAC,CAAC;QAChH,CAAC;QACD,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,aAAa,GAAG,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACtD,MAAM,mBAAmB,GAAG,6BAA6B,CAAC,KAAK,CAAC,CAAC;QACjE,MAAM,YAAY,GAAG,mBAAmB,EAAE,KAAK,CAAC;QAChD,MAAM,OAAO,GAAY;YACvB,EAAE,EAAE,oBAAoB,YAAY,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE;YAC5D,KAAK,EAAE,EAAE;SACV,CAAC;QACF,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;YACjB,QAAQ,EAAE,SAAS,CAAC,OAAO;YAC3B,cAAc,EAAE;gBACd;oBACE,QAAQ,EAAE,yBAAyB,CAAC,iCAAiC;oBACrE,OAAO,EAAE,6BAA6B,CAAC,MAAM,CAAC,SAAS,CAAC;oBACxD,gBAAgB,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;oBACvE,cAAc,EAAE,oBAAoB,CAAC,mBAAmB,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,YAAY,EAAE,aAAa,CAAC,GAAG,CAAC;iBAC7G;aACF;SACF,CAAC,CAAC;QACH,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC;IAChE,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,6BAA6B,CACxC,KAAY,EACZ,MAAY,EACZ,mBAAiD;QAEjD,MAAM,IAAI,GAAG,IAAI,CAAC,iCAAiC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACnE,MAAM,WAAW,GAAG,MAAM,sBAAsB,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,EAAE,mBAAmB,CAAC,CAAC;QAC5H,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,WAAW,EAAE,CAAC;IAChD,CAAC;CACF;AAsBD,MAAM,QAAQ,GAAG,CAAC,YAAgC,EAAU,EAAE;IAC5D,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,OAAO,YAAY,CAAC,QAAQ,EAAE,CAAC;AACjC,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,MAAY,EAAE,YAAmC,EAAE,KAAY,EAAE,KAAa,EAAU,EAAE;IACnH,MAAM,SAAS,GAAG,YAAY,IAAI,MAAM,CAAC,SAAU,CAAC;IACpD,OAAO,IAAI,SAAS,CAAC,KAAK,MAAM,KAAK,CAAC,KAAK,OAAO,KAAK,EAAE,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,KAAK,EAClC,MAAY,EACZ,YAAmC,EACnC,KAAY,EACZ,KAAwB,EACxB,mBAAiD,EAChC,EAAE;IACnB,MAAM,YAAY,GAAG,mBAAmB,CAAC,CAAC,CAAC,MAAM,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC9I,OAAO,iBAAiB,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;AACtE,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,KAAsB,EAAE,EAAE;IACjD,IAAI,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC7C,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,KAAK,YAAY,EAAE,CAAC;QACzC,IAAI,IAAI,KAAK,CAAC;IAChB,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,KAAY,EAAmC,EAAE;IACjF,IAAI,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QACvB,IAAI,OAAO,KAAK,CAAC,CAAC,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,CAAC,KAAK,QAAQ,CAAC,EAAE,CAAC;YACzH,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ,EAAE,CAAC;YACxE,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,MAAY,EAAE,KAAY,EAAqB,EAAE;IACzE,MAAM,eAAe,GAAG,EAAE,CAAC;IAC3B,IAAI,SAAS,GAAsB,KAAK,CAAC;IACzC,OAAO,SAAS,EAAE,CAAC;QACjB,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACrC,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC;IAC/B,CAAC;IACD,IAAI,aAAa,GAAG,eAAe,CAAC,GAAG,EAAE,CAAC;IAC1C,IAAI,YAAY,GAAiB,MAAM,CAAC,aAAa,CAAC,aAAc,CAAC,CAAC;IACtE,IAAI,KAAK,GAAU,MAAM,CAAC,MAAM,CAAC,aAAc,CAAC,CAAC;IACjD,aAAa,GAAG,eAAe,CAAC,GAAG,EAAE,CAAC;IACtC,OAAO,aAAa,EAAE,CAAC;QACrB,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxD,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC1C,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,kGAAkG,CAAC,CAAC;QACtH,CAAC;QACD,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;QACD,YAAY,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QACrD,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACvC,aAAa,GAAG,eAAe,CAAC,GAAG,EAAE,CAAC;IACxC,CAAC;IACD,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,YAAY,KAAK,WAAW,IAAI,OAAO,YAAY,KAAK,QAAQ,CAAC,EAAE,CAAC;QACnH,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;IACtF,CAAC;IACD,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAC3B,mBAAuE,EACvE,YAAsC,EACtC,YAAoB,EACpB,aAAqC,EAC7B,EAAE;IACV,MAAM,KAAK,GAAG,mBAAmB,CAAC,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;IACvE,OAAO,gBAAgB,CAAC,YAAY,EAAE,GAAG,KAAK,IAAI,YAAY,EAAE,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC;AACxF,CAAC,CAAC;AAGF,MAAM,gBAAgB,GAAG,CAAC,IAA8B,EAAE,IAAY,EAAE,QAAkB,EAAE,KAA6B,EAAU,EAAE;IACnI,IAAI,YAAY,GAAG,EAAE,CAAC;IACtB,QAAQ,OAAO,KAAK,EAAE,CAAC;QACrB,KAAK,WAAW;YACd,YAAY,GAAG,MAAM,CAAC;YACtB,MAAM;QACR,KAAK,QAAQ;YACX,YAAY,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC;YAChD,MAAM;QACR,KAAK,SAAS;YACZ,YAAY,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;YACxC,MAAM;QACR,KAAK,QAAQ;YACX,YAAY,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;YAChC,MAAM;IACV,CAAC;IAED,IAAI,IAAI,CAAC,QAAQ,KAAK,YAAY,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAE,KAAqB,CAAC,EAAE,CAAC,EAAE,CAAC;QAC1G,uEAAuE;QACvE,YAAY,GAAG,QAAQ,CAAE,KAAqB,CAAC,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC/D,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QACtE,CAAC;QAED,MAAM,aAAa,GAA6B;YAC9C,WAAW,EAAE,mBAAmB,CAAC,SAAS;YAC1C,QAAQ,EAAE,QAAQ;SACnB,CAAC;QAEF,MAAM,UAAU,GAAG,KAAc,CAAC;QAClC,IAAI,UAAU,GAAG,GAAG,gBAAgB,CAAC,aAAa,EAAE,GAAG,IAAI,IAAI,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3F,UAAU,IAAI,QAAQ,gBAAgB,CAAC,aAAa,EAAE,GAAG,IAAI,IAAI,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7F,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,UAAU,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;YAC9D,UAAU,IAAI,QAAQ,gBAAgB,CAAC,aAAa,EAAE,GAAG,IAAI,IAAI,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/F,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,IAAI,IAAI,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,kBAAkB,IAAI,KAAK,YAAY,KAAK,QAAQ,IAAI,CAAC;IAClE,CAAC;IAED,IAAI,IAAI,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;QACjC,OAAO,oBAAoB,IAAI,KAAK,YAAY,KAAK,QAAQ,IAAI,CAAC;IACpE,CAAC;IAED,OAAO,GAAG,IAAI,IAAI,QAAQ,IAAI,YAAY,EAAE,CAAC;AAC/C,CAAC,CAAC;AAEF,MAAM,6BAA6B,GAAG,CAAC,SAA8B,EAAmC,EAAE;IACxG,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1D,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,SAAS,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC;AACvE,CAAC,CAAC;AAEF,MAAM,8BAA8B,GAAG,CAAC,SAA8B,EAAkC,EAAE;IACxG,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1D,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;AACnC,CAAC,CAAC;AAEF,MAAM,yBAAyB,GAAG,CAChC,6BAA+C,EAC/C,KAAa,EAC6C,EAAE,CAAC,CAAC;IAC9D,IAAI,EAAE;QACJ,gBAAgB,EAAE,6BAA6B,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC7D,YAAY,EAAE,8BAA8B,CAAC,IAAI,CAAC,gBAAgB,CAAC;YACnE,SAAS,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC,qBAAqB,CAAC,QAAQ;YACtG,WAAW,EAAE,8BAA8B,CAAC,IAAI,CAAC,eAAe,CAAC;SAClE,CAAC,CAAC;QACH,UAAU,EAAE,IAAI;QAChB,KAAK,EAAE,WAAW,KAAK,EAAE;KAC1B;IACD,KAAK,EAAE,6BAA6B,CAAC,6BAA6B,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,eAAe;CAC/F,CAAC,CAAC;AAEH,MAAM,mCAAmC,GAAG,CAAC,KAAsB,EAAoB,EAAE;IACvF,IAAI,SAAS,GAAU,KAAK,CAAC;IAC7B,MAAM,6BAA6B,GAAqB,EAAE,CAAC;IAC3D,OAAO,SAAS,CAAC,MAAM,EAAE,CAAC;QACxB,6BAA6B,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;QAC3E,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC;IAC/B,CAAC;IACD,OAAO,gBAAgB,CAAC,OAAO,CAAC,6BAA6B,CAAC,CAAC;AACjE,CAAC,CAAC;AAEF,MAAM,6BAA6B,GAAG,CAAC,KAAsB,EAAwE,EAAE;IACrI,MAAM,IAAI,GAAG,mCAAmC,CAAC,KAAK,CAAC,CAAC;IACxD,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,yBAAyB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACtE,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,EAAc,EAAE,EAAE;IAClC,MAAM,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IACnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;QACnC,IAAI,KAAK,GAAG,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YACvC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;YACnC,KAAK,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;YAC7B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAClB,CAAC;QACD,OAAO,KAAK,GAAG,CAAC,EAAE,CAAC;YACjB,MAAM,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC;YACxB,KAAK,GAAG,CAAC,KAAK,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACnC,CAAC,CAAC","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 { Guid, Id64, Id64String } from \"@itwin/core-bentley\";\nimport { Field, PropertiesField } from \"./content/Fields\";\nimport { Item } from \"./content/Item\";\nimport { PrimitiveTypeDescription, PropertyValueFormat } from \"./content/TypeDescription\";\nimport { DisplayValue, Value } from \"./content/Value\";\nimport { ClassInfo, InstanceKey, RelationshipPath } from \"./EC\";\nimport { MultiSchemaClassesSpecification, SingleSchemaClassSpecification } from \"./rules/ClassSpecifications\";\nimport { ContentSpecificationTypes } from \"./rules/content/ContentSpecification\";\nimport { RelatedInstanceSpecification } from \"./rules/RelatedInstanceSpecification\";\nimport { RelationshipDirection } from \"./rules/RelationshipDirection\";\nimport { RuleTypes } from \"./rules/Rule\";\nimport { Ruleset } from \"./rules/Ruleset\";\n\n/**\n * A factory class that can be used to create presentation rulesets targeted towards\n * specific use cases.\n *\n * @public\n */\nexport class RulesetsFactory {\n  private createSimilarInstancesRulesetInfo(field: Field, record: Item) {\n    if (!field.isPropertiesField()) {\n      throw new Error(\"Can only create 'similar instances' ruleset for properties-based records\");\n    }\n    if (field.type.valueFormat !== PropertyValueFormat.Primitive) {\n      throw new Error(\"Can only create 'similar instances' ruleset for primitive properties\");\n    }\n    if (field.properties.length === 0) {\n      throw new Error(\"Invalid properties' field with no properties\");\n    }\n    if (record.isFieldMerged(field.name)) {\n      throw new Error(\"Can't create 'similar instances' ruleset for merged values\");\n    }\n    if (!record.classInfo) {\n      throw new Error(\"Can't create 'similar instances' for records based on multiple different ECClass instances\");\n    }\n    const propertyName = getPropertyName(field);\n    const propertyValue = getPropertyValue(record, field);\n    const relatedInstanceInfo = createRelatedInstanceSpecInfo(field);\n    const relatedClass = relatedInstanceInfo?.class;\n    const ruleset: Ruleset = {\n      id: `SimilarInstances/${propertyName}/${Guid.createValue()}`,\n      rules: [],\n    };\n    ruleset.rules.push({\n      ruleType: RuleTypes.Content,\n      specifications: [\n        {\n          specType: ContentSpecificationTypes.ContentInstancesOfSpecificClasses,\n          classes: createMultiClassSpecification(record.classInfo),\n          relatedInstances: relatedInstanceInfo ? [relatedInstanceInfo.spec] : [],\n          instanceFilter: createInstanceFilter(relatedInstanceInfo?.spec, field.type, propertyName, propertyValue.raw),\n        },\n      ],\n    });\n    return { ruleset, relatedClass, propertyName, propertyValue };\n  }\n\n  /**\n   * Create a ruleset with content rules for getting instances are of the\n   * same ECClass and have the same property value as the provided `record`.\n   * @param field A field identifying which property of the record we should use\n   * @param record A record whose similar instances should be found\n   * @param computeDisplayValue Optional callback function to calculate display value that's\n   * used in ruleset's description. If not provided, display value from record is used instead.\n   */\n  public async createSimilarInstancesRuleset(\n    field: Field,\n    record: Item,\n    computeDisplayValue?: ComputeDisplayValueCallback,\n  ): Promise<{ ruleset: Ruleset; description: string }> {\n    const info = this.createSimilarInstancesRulesetInfo(field, record);\n    const description = await createDescriptionAsync(record, info.relatedClass, field, info.propertyValue, computeDisplayValue);\n    return { ruleset: info.ruleset, description };\n  }\n}\n\n/**\n * Definition of a function for calculating a display value.\n * @public\n */\nexport type ComputeDisplayValueCallback = (type: string, value: PrimitivePropertyValue, displayValue: string) => Promise<string>;\n\ninterface PrimitiveValueDef {\n  raw: PrimitivePropertyValue;\n  display: string;\n}\n\n/**\n * Value of a primitive property.\n * @public\n */\nexport type PrimitivePropertyValue = string | number | boolean | Point | InstanceKey | undefined;\n\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\ntype Point = { x: number; y: number; z?: number };\n\nconst toString = (displayValue: string | undefined): string => {\n  if (!displayValue) {\n    return \"NULL\";\n  }\n  return displayValue.toString();\n};\n\nconst createDescription = (record: Item, relatedClass: ClassInfo | undefined, field: Field, value: string): string => {\n  const classInfo = relatedClass ?? record.classInfo!;\n  return `[${classInfo.label}].[${field.label}] = ${value}`;\n};\n\nconst createDescriptionAsync = async (\n  record: Item,\n  relatedClass: ClassInfo | undefined,\n  field: Field,\n  value: PrimitiveValueDef,\n  computeDisplayValue?: ComputeDisplayValueCallback,\n): Promise<string> => {\n  const displayValue = computeDisplayValue ? await computeDisplayValue(field.type.typeName, value.raw, value.display) : toString(value.display);\n  return createDescription(record, relatedClass, field, displayValue);\n};\n\nconst getPropertyName = (field: PropertiesField) => {\n  let name = field.properties[0].property.name;\n  if (field.type.typeName === \"navigation\") {\n    name += \".Id\";\n  }\n  return name;\n};\n\nconst isPrimitivePropertyValue = (value: Value): value is PrimitivePropertyValue => {\n  if (Value.isPrimitive(value)) {\n    return true;\n  }\n\n  if (Value.isMap(value)) {\n    if (typeof value.x === \"number\" && typeof value.y === \"number\" && (value.z === undefined || typeof value.z === \"number\")) {\n      return true;\n    }\n\n    if (typeof value.className === \"string\" && typeof value.id === \"string\") {\n      return true;\n    }\n  }\n\n  return false;\n};\n\nconst getPropertyValue = (record: Item, field: Field): PrimitiveValueDef => {\n  const fieldNamesStack = [];\n  let currField: Field | undefined = field;\n  while (currField) {\n    fieldNamesStack.push(currField.name);\n    currField = currField.parent;\n  }\n  let currFieldName = fieldNamesStack.pop();\n  let displayValue: DisplayValue = record.displayValues[currFieldName!];\n  let value: Value = record.values[currFieldName!];\n  currFieldName = fieldNamesStack.pop();\n  while (currFieldName) {\n    if (!Value.isNestedContent(value) || value.length === 0) {\n      throw new Error(\"Invalid record value\");\n    }\n    if (value.length > 1) {\n      throw new Error(\"Can't create 'similar instances' for records related through many part of *-to-many relationship\");\n    }\n    if (value[0].mergedFieldNames.indexOf(currFieldName) !== -1) {\n      throw new Error(\"Can't create 'similar instances' ruleset for merged values\");\n    }\n    displayValue = value[0].displayValues[currFieldName];\n    value = value[0].values[currFieldName];\n    currFieldName = fieldNamesStack.pop();\n  }\n  if (!isPrimitivePropertyValue(value) || !(typeof displayValue === \"undefined\" || typeof displayValue === \"string\")) {\n    throw new Error(\"Can only create 'similar instances' ruleset for primitive values\");\n  }\n  return { raw: value, display: toString(displayValue) };\n};\n\nconst createInstanceFilter = (\n  relatedInstanceSpec: Readonly<RelatedInstanceSpecification> | undefined,\n  propertyType: PrimitiveTypeDescription,\n  propertyName: string,\n  propertyValue: PrimitivePropertyValue,\n): string => {\n  const alias = relatedInstanceSpec ? relatedInstanceSpec.alias : \"this\";\n  return createComparison(propertyType, `${alias}.${propertyName}`, \"=\", propertyValue);\n};\n\ntype Operator = \"=\" | \"!=\" | \">\" | \">=\" | \"<\" | \"<=\";\nconst createComparison = (type: PrimitiveTypeDescription, name: string, operator: Operator, value: PrimitivePropertyValue): string => {\n  let compareValue = \"\";\n  switch (typeof value) {\n    case \"undefined\":\n      compareValue = \"NULL\";\n      break;\n    case \"string\":\n      compareValue = `\"${value.replace(/\"/g, `\"\"`)}\"`;\n      break;\n    case \"boolean\":\n      compareValue = value ? \"TRUE\" : \"FALSE\";\n      break;\n    case \"number\":\n      compareValue = value.toString();\n      break;\n  }\n\n  if (type.typeName === \"navigation\" && typeof value === \"object\" && Id64.isId64((value as InstanceKey).id)) {\n    // note: this is temporary until we support hex ids in instance filters\n    compareValue = hexToDec((value as InstanceKey).id);\n  }\n\n  if (type.typeName === \"point2d\" || type.typeName === \"point3d\") {\n    if (typeof value !== \"object\") {\n      throw new Error(\"Expecting point values to be supplied as objects\");\n    }\n\n    const dimensionType: PrimitiveTypeDescription = {\n      valueFormat: PropertyValueFormat.Primitive,\n      typeName: \"double\",\n    };\n\n    const pointValue = value as Point;\n    let comparison = `${createComparison(dimensionType, `${name}.x`, operator, pointValue.x)}`;\n    comparison += ` AND ${createComparison(dimensionType, `${name}.y`, operator, pointValue.y)}`;\n    if (type.typeName === \"point3d\" && pointValue.z !== undefined) {\n      comparison += ` AND ${createComparison(dimensionType, `${name}.z`, operator, pointValue.z)}`;\n    }\n\n    return comparison;\n  }\n\n  if (type.typeName === \"double\") {\n    return `CompareDoubles(${name}, ${compareValue}) ${operator} 0`;\n  }\n\n  if (type.typeName === \"dateTime\") {\n    return `CompareDateTimes(${name}, ${compareValue}) ${operator} 0`;\n  }\n\n  return `${name} ${operator} ${compareValue}`;\n};\n\nconst createMultiClassSpecification = (classInfo: Readonly<ClassInfo>): MultiSchemaClassesSpecification => {\n  const [schemaName, className] = classInfo.name.split(\":\");\n  return { schemaName, classNames: [className], arePolymorphic: true };\n};\n\nconst createSingleClassSpecification = (classInfo: Readonly<ClassInfo>): SingleSchemaClassSpecification => {\n  const [schemaName, className] = classInfo.name.split(\":\");\n  return { schemaName, className };\n};\n\nconst createRelatedInstanceSpec = (\n  pathFromSelectToPropertyClass: RelationshipPath,\n  index: number,\n): { spec: RelatedInstanceSpecification; class: ClassInfo } => ({\n  spec: {\n    relationshipPath: pathFromSelectToPropertyClass.map((step) => ({\n      relationship: createSingleClassSpecification(step.relationshipInfo),\n      direction: step.isForwardRelationship ? RelationshipDirection.Forward : RelationshipDirection.Backward,\n      targetClass: createSingleClassSpecification(step.targetClassInfo),\n    })),\n    isRequired: true,\n    alias: `related_${index}`,\n  },\n  class: pathFromSelectToPropertyClass[pathFromSelectToPropertyClass.length - 1].targetClassInfo,\n});\n\nconst createPathFromSelectToPropertyClass = (field: PropertiesField): RelationshipPath => {\n  let currField: Field = field;\n  const pathFromPropertyToSelectClass: RelationshipPath = [];\n  while (currField.parent) {\n    pathFromPropertyToSelectClass.push(...currField.parent.pathToPrimaryClass);\n    currField = currField.parent;\n  }\n  return RelationshipPath.reverse(pathFromPropertyToSelectClass);\n};\n\nconst createRelatedInstanceSpecInfo = (field: PropertiesField): { spec: RelatedInstanceSpecification; class: ClassInfo } | undefined => {\n  const path = createPathFromSelectToPropertyClass(field);\n  return path.length ? createRelatedInstanceSpec(path, 0) : undefined;\n};\n\nconst hexToDec = (id: Id64String) => {\n  const digits = [0];\n  for (let i = 2; i < id.length; ++i) {\n    let carry = parseInt(id.charAt(i), 16);\n    for (let j = 0; j < digits.length; ++j) {\n      digits[j] = digits[j] * 16 + carry;\n      carry = (digits[j] / 10) | 0;\n      digits[j] %= 10;\n    }\n    while (carry > 0) {\n      digits.push(carry % 10);\n      carry = (carry / 10) | 0;\n    }\n  }\n  return digits.reverse().join(\"\");\n};\n"]}
+{"version":3,"file":"RulesetsFactory.js","sourceRoot":"","sources":["../../../src/presentation-common/RulesetsFactory.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AAG7D,OAAO,EAA4B,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAC1F,OAAO,EAAgB,KAAK,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAA0B,gBAAgB,EAAE,MAAM,MAAM,CAAC;AAEhE,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AAEjF,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAGzC;;;;;GAKG;AACH,MAAM,OAAO,eAAe;IAClB,iCAAiC,CAAC,KAAY,EAAE,MAAY;QAClE,IAAI,CAAC,KAAK,CAAC,iBAAiB,EAAE,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,0EAA0E,CAAC,CAAC;QAC9F,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,CAAC,WAAW,KAAK,mBAAmB,CAAC,SAAS,EAAE,CAAC;YAC7D,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAC;QAC1F,CAAC;QACD,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAClE,CAAC;QACD,IAAI,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,4FAA4F,CAAC,CAAC;QAChH,CAAC;QACD,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,aAAa,GAAG,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACtD,MAAM,mBAAmB,GAAG,6BAA6B,CAAC,KAAK,CAAC,CAAC;QACjE,MAAM,YAAY,GAAG,mBAAmB,EAAE,KAAK,CAAC;QAChD,MAAM,OAAO,GAAY;YACvB,EAAE,EAAE,oBAAoB,YAAY,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE;YAC5D,KAAK,EAAE,EAAE;SACV,CAAC;QACF,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;YACjB,QAAQ,EAAE,SAAS,CAAC,OAAO;YAC3B,cAAc,EAAE;gBACd;oBACE,QAAQ,EAAE,yBAAyB,CAAC,iCAAiC;oBACrE,OAAO,EAAE,6BAA6B,CAAC,MAAM,CAAC,SAAS,CAAC;oBACxD,gBAAgB,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;oBACvE,cAAc,EAAE,oBAAoB,CAAC,mBAAmB,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,YAAY,EAAE,aAAa,CAAC,GAAG,CAAC;iBAC7G;aACF;SACF,CAAC,CAAC;QACH,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC;IAChE,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,6BAA6B,CACxC,KAAY,EACZ,MAAY,EACZ,mBAAiD;QAEjD,MAAM,IAAI,GAAG,IAAI,CAAC,iCAAiC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACnE,MAAM,WAAW,GAAG,MAAM,sBAAsB,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,EAAE,mBAAmB,CAAC,CAAC;QAC5H,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,WAAW,EAAE,CAAC;IAChD,CAAC;CACF;AAsBD,MAAM,QAAQ,GAAG,CAAC,YAAgC,EAAU,EAAE;IAC5D,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,OAAO,YAAY,CAAC,QAAQ,EAAE,CAAC;AACjC,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,MAAY,EAAE,YAAmC,EAAE,KAAY,EAAE,KAAa,EAAU,EAAE;IACnH,MAAM,SAAS,GAAG,YAAY,IAAI,MAAM,CAAC,SAAU,CAAC;IACpD,OAAO,IAAI,SAAS,CAAC,KAAK,MAAM,KAAK,CAAC,KAAK,OAAO,KAAK,EAAE,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,KAAK,EAClC,MAAY,EACZ,YAAmC,EACnC,KAAY,EACZ,KAAwB,EACxB,mBAAiD,EAChC,EAAE;IACnB,MAAM,YAAY,GAAG,mBAAmB,CAAC,CAAC,CAAC,MAAM,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC9I,OAAO,iBAAiB,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;AACtE,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,KAAsB,EAAE,EAAE;IACjD,IAAI,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC7C,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,KAAK,YAAY,EAAE,CAAC;QACzC,IAAI,IAAI,KAAK,CAAC;IAChB,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,KAAY,EAAmC,EAAE;IACjF,IAAI,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QACvB,IAAI,OAAO,KAAK,CAAC,CAAC,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,CAAC,KAAK,QAAQ,CAAC,EAAE,CAAC;YACzH,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ,EAAE,CAAC;YACxE,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,MAAY,EAAE,KAAY,EAAqB,EAAE;IACzE,MAAM,eAAe,GAAG,EAAE,CAAC;IAC3B,IAAI,SAAS,GAAsB,KAAK,CAAC;IACzC,OAAO,SAAS,EAAE,CAAC;QACjB,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACrC,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC;IAC/B,CAAC;IACD,IAAI,aAAa,GAAG,eAAe,CAAC,GAAG,EAAE,CAAC;IAC1C,IAAI,YAAY,GAAiB,MAAM,CAAC,aAAa,CAAC,aAAc,CAAC,CAAC;IACtE,IAAI,KAAK,GAAU,MAAM,CAAC,MAAM,CAAC,aAAc,CAAC,CAAC;IACjD,aAAa,GAAG,eAAe,CAAC,GAAG,EAAE,CAAC;IACtC,OAAO,aAAa,EAAE,CAAC;QACrB,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxD,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC1C,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,kGAAkG,CAAC,CAAC;QACtH,CAAC;QACD,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;QACD,YAAY,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QACrD,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACvC,aAAa,GAAG,eAAe,CAAC,GAAG,EAAE,CAAC;IACxC,CAAC;IACD,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,YAAY,KAAK,WAAW,IAAI,OAAO,YAAY,KAAK,QAAQ,CAAC,EAAE,CAAC;QACnH,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;IACtF,CAAC;IACD,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAC3B,mBAAuE,EACvE,YAAsC,EACtC,YAAoB,EACpB,aAAqC,EAC7B,EAAE;IACV,MAAM,KAAK,GAAG,mBAAmB,CAAC,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;IACvE,OAAO,gBAAgB,CAAC,YAAY,EAAE,GAAG,KAAK,IAAI,YAAY,EAAE,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC;AACxF,CAAC,CAAC;AAGF,MAAM,gBAAgB,GAAG,CAAC,IAA8B,EAAE,IAAY,EAAE,QAAkB,EAAE,KAA6B,EAAU,EAAE;IACnI,IAAI,YAAY,GAAG,EAAE,CAAC;IACtB,QAAQ,OAAO,KAAK,EAAE,CAAC;QACrB,KAAK,WAAW;YACd,YAAY,GAAG,MAAM,CAAC;YACtB,MAAM;QACR,KAAK,QAAQ;YACX,YAAY,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC;YAChD,MAAM;QACR,KAAK,SAAS;YACZ,YAAY,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;YACxC,MAAM;QACR,KAAK,QAAQ;YACX,YAAY,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;YAChC,MAAM;IACV,CAAC;IAED,IAAI,IAAI,CAAC,QAAQ,KAAK,YAAY,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAE,KAAqB,CAAC,EAAE,CAAC,EAAE,CAAC;QAC1G,uEAAuE;QACvE,YAAY,GAAG,QAAQ,CAAE,KAAqB,CAAC,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC/D,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QACtE,CAAC;QAED,MAAM,aAAa,GAA6B;YAC9C,WAAW,EAAE,mBAAmB,CAAC,SAAS;YAC1C,QAAQ,EAAE,QAAQ;SACnB,CAAC;QAEF,MAAM,UAAU,GAAG,KAAc,CAAC;QAClC,IAAI,UAAU,GAAG,GAAG,gBAAgB,CAAC,aAAa,EAAE,GAAG,IAAI,IAAI,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3F,UAAU,IAAI,QAAQ,gBAAgB,CAAC,aAAa,EAAE,GAAG,IAAI,IAAI,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7F,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,UAAU,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;YAC9D,UAAU,IAAI,QAAQ,gBAAgB,CAAC,aAAa,EAAE,GAAG,IAAI,IAAI,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/F,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,IAAI,IAAI,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,kBAAkB,IAAI,KAAK,YAAY,KAAK,QAAQ,IAAI,CAAC;IAClE,CAAC;IAED,IAAI,IAAI,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;QACjC,OAAO,oBAAoB,IAAI,KAAK,YAAY,KAAK,QAAQ,IAAI,CAAC;IACpE,CAAC;IAED,OAAO,GAAG,IAAI,IAAI,QAAQ,IAAI,YAAY,EAAE,CAAC;AAC/C,CAAC,CAAC;AAEF,MAAM,6BAA6B,GAAG,CAAC,SAA8B,EAAmC,EAAE;IACxG,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1D,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC,SAAS,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC;AACvE,CAAC,CAAC;AAEF,MAAM,8BAA8B,GAAG,CAAC,SAA8B,EAAkC,EAAE;IACxG,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1D,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;AACnC,CAAC,CAAC;AAEF,MAAM,yBAAyB,GAAG,CAChC,6BAA+C,EAC/C,KAAa,EAC6C,EAAE,CAAC,CAAC;IAC9D,IAAI,EAAE;QACJ,gBAAgB,EAAE,6BAA6B,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC7D,YAAY,EAAE,8BAA8B,CAAC,IAAI,CAAC,gBAAgB,CAAC;YACnE,SAAS,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC,qBAAqB,CAAC,QAAQ;YACtG,WAAW,EAAE,8BAA8B,CAAC,IAAI,CAAC,eAAe,CAAC;SAClE,CAAC,CAAC;QACH,UAAU,EAAE,IAAI;QAChB,KAAK,EAAE,WAAW,KAAK,EAAE;KAC1B;IACD,KAAK,EAAE,6BAA6B,CAAC,6BAA6B,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,eAAe;CAC/F,CAAC,CAAC;AAEH,MAAM,mCAAmC,GAAG,CAAC,KAAsB,EAAoB,EAAE;IACvF,IAAI,SAAS,GAAU,KAAK,CAAC;IAC7B,MAAM,6BAA6B,GAAqB,EAAE,CAAC;IAC3D,OAAO,SAAS,CAAC,MAAM,EAAE,CAAC;QACxB,6BAA6B,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;QAC3E,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC;IAC/B,CAAC;IACD,OAAO,gBAAgB,CAAC,OAAO,CAAC,6BAA6B,CAAC,CAAC;AACjE,CAAC,CAAC;AAEF,MAAM,6BAA6B,GAAG,CAAC,KAAsB,EAAwE,EAAE;IACrI,MAAM,IAAI,GAAG,mCAAmC,CAAC,KAAK,CAAC,CAAC;IACxD,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,yBAAyB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACtE,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,EAAc,EAAE,EAAE;IAClC,MAAM,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IACnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;QACnC,IAAI,KAAK,GAAG,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YACvC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;YACnC,KAAK,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;YAC7B,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAClB,CAAC;QACD,OAAO,KAAK,GAAG,CAAC,EAAE,CAAC;YACjB,MAAM,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC;YACxB,KAAK,GAAG,CAAC,KAAK,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACnC,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Core\r\n */\r\n\r\nimport { Guid, Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport { Field, PropertiesField } from \"./content/Fields\";\r\nimport { Item } from \"./content/Item\";\r\nimport { PrimitiveTypeDescription, PropertyValueFormat } from \"./content/TypeDescription\";\r\nimport { DisplayValue, Value } from \"./content/Value\";\r\nimport { ClassInfo, InstanceKey, RelationshipPath } from \"./EC\";\r\nimport { MultiSchemaClassesSpecification, SingleSchemaClassSpecification } from \"./rules/ClassSpecifications\";\r\nimport { ContentSpecificationTypes } from \"./rules/content/ContentSpecification\";\r\nimport { RelatedInstanceSpecification } from \"./rules/RelatedInstanceSpecification\";\r\nimport { RelationshipDirection } from \"./rules/RelationshipDirection\";\r\nimport { RuleTypes } from \"./rules/Rule\";\r\nimport { Ruleset } from \"./rules/Ruleset\";\r\n\r\n/**\r\n * A factory class that can be used to create presentation rulesets targeted towards\r\n * specific use cases.\r\n *\r\n * @public\r\n */\r\nexport class RulesetsFactory {\r\n  private createSimilarInstancesRulesetInfo(field: Field, record: Item) {\r\n    if (!field.isPropertiesField()) {\r\n      throw new Error(\"Can only create 'similar instances' ruleset for properties-based records\");\r\n    }\r\n    if (field.type.valueFormat !== PropertyValueFormat.Primitive) {\r\n      throw new Error(\"Can only create 'similar instances' ruleset for primitive properties\");\r\n    }\r\n    if (field.properties.length === 0) {\r\n      throw new Error(\"Invalid properties' field with no properties\");\r\n    }\r\n    if (record.isFieldMerged(field.name)) {\r\n      throw new Error(\"Can't create 'similar instances' ruleset for merged values\");\r\n    }\r\n    if (!record.classInfo) {\r\n      throw new Error(\"Can't create 'similar instances' for records based on multiple different ECClass instances\");\r\n    }\r\n    const propertyName = getPropertyName(field);\r\n    const propertyValue = getPropertyValue(record, field);\r\n    const relatedInstanceInfo = createRelatedInstanceSpecInfo(field);\r\n    const relatedClass = relatedInstanceInfo?.class;\r\n    const ruleset: Ruleset = {\r\n      id: `SimilarInstances/${propertyName}/${Guid.createValue()}`,\r\n      rules: [],\r\n    };\r\n    ruleset.rules.push({\r\n      ruleType: RuleTypes.Content,\r\n      specifications: [\r\n        {\r\n          specType: ContentSpecificationTypes.ContentInstancesOfSpecificClasses,\r\n          classes: createMultiClassSpecification(record.classInfo),\r\n          relatedInstances: relatedInstanceInfo ? [relatedInstanceInfo.spec] : [],\r\n          instanceFilter: createInstanceFilter(relatedInstanceInfo?.spec, field.type, propertyName, propertyValue.raw),\r\n        },\r\n      ],\r\n    });\r\n    return { ruleset, relatedClass, propertyName, propertyValue };\r\n  }\r\n\r\n  /**\r\n   * Create a ruleset with content rules for getting instances are of the\r\n   * same ECClass and have the same property value as the provided `record`.\r\n   * @param field A field identifying which property of the record we should use\r\n   * @param record A record whose similar instances should be found\r\n   * @param computeDisplayValue Optional callback function to calculate display value that's\r\n   * used in ruleset's description. If not provided, display value from record is used instead.\r\n   */\r\n  public async createSimilarInstancesRuleset(\r\n    field: Field,\r\n    record: Item,\r\n    computeDisplayValue?: ComputeDisplayValueCallback,\r\n  ): Promise<{ ruleset: Ruleset; description: string }> {\r\n    const info = this.createSimilarInstancesRulesetInfo(field, record);\r\n    const description = await createDescriptionAsync(record, info.relatedClass, field, info.propertyValue, computeDisplayValue);\r\n    return { ruleset: info.ruleset, description };\r\n  }\r\n}\r\n\r\n/**\r\n * Definition of a function for calculating a display value.\r\n * @public\r\n */\r\nexport type ComputeDisplayValueCallback = (type: string, value: PrimitivePropertyValue, displayValue: string) => Promise<string>;\r\n\r\ninterface PrimitiveValueDef {\r\n  raw: PrimitivePropertyValue;\r\n  display: string;\r\n}\r\n\r\n/**\r\n * Value of a primitive property.\r\n * @public\r\n */\r\nexport type PrimitivePropertyValue = string | number | boolean | Point | InstanceKey | undefined;\r\n\r\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\r\ntype Point = { x: number; y: number; z?: number };\r\n\r\nconst toString = (displayValue: string | undefined): string => {\r\n  if (!displayValue) {\r\n    return \"NULL\";\r\n  }\r\n  return displayValue.toString();\r\n};\r\n\r\nconst createDescription = (record: Item, relatedClass: ClassInfo | undefined, field: Field, value: string): string => {\r\n  const classInfo = relatedClass ?? record.classInfo!;\r\n  return `[${classInfo.label}].[${field.label}] = ${value}`;\r\n};\r\n\r\nconst createDescriptionAsync = async (\r\n  record: Item,\r\n  relatedClass: ClassInfo | undefined,\r\n  field: Field,\r\n  value: PrimitiveValueDef,\r\n  computeDisplayValue?: ComputeDisplayValueCallback,\r\n): Promise<string> => {\r\n  const displayValue = computeDisplayValue ? await computeDisplayValue(field.type.typeName, value.raw, value.display) : toString(value.display);\r\n  return createDescription(record, relatedClass, field, displayValue);\r\n};\r\n\r\nconst getPropertyName = (field: PropertiesField) => {\r\n  let name = field.properties[0].property.name;\r\n  if (field.type.typeName === \"navigation\") {\r\n    name += \".Id\";\r\n  }\r\n  return name;\r\n};\r\n\r\nconst isPrimitivePropertyValue = (value: Value): value is PrimitivePropertyValue => {\r\n  if (Value.isPrimitive(value)) {\r\n    return true;\r\n  }\r\n\r\n  if (Value.isMap(value)) {\r\n    if (typeof value.x === \"number\" && typeof value.y === \"number\" && (value.z === undefined || typeof value.z === \"number\")) {\r\n      return true;\r\n    }\r\n\r\n    if (typeof value.className === \"string\" && typeof value.id === \"string\") {\r\n      return true;\r\n    }\r\n  }\r\n\r\n  return false;\r\n};\r\n\r\nconst getPropertyValue = (record: Item, field: Field): PrimitiveValueDef => {\r\n  const fieldNamesStack = [];\r\n  let currField: Field | undefined = field;\r\n  while (currField) {\r\n    fieldNamesStack.push(currField.name);\r\n    currField = currField.parent;\r\n  }\r\n  let currFieldName = fieldNamesStack.pop();\r\n  let displayValue: DisplayValue = record.displayValues[currFieldName!];\r\n  let value: Value = record.values[currFieldName!];\r\n  currFieldName = fieldNamesStack.pop();\r\n  while (currFieldName) {\r\n    if (!Value.isNestedContent(value) || value.length === 0) {\r\n      throw new Error(\"Invalid record value\");\r\n    }\r\n    if (value.length > 1) {\r\n      throw new Error(\"Can't create 'similar instances' for records related through many part of *-to-many relationship\");\r\n    }\r\n    if (value[0].mergedFieldNames.indexOf(currFieldName) !== -1) {\r\n      throw new Error(\"Can't create 'similar instances' ruleset for merged values\");\r\n    }\r\n    displayValue = value[0].displayValues[currFieldName];\r\n    value = value[0].values[currFieldName];\r\n    currFieldName = fieldNamesStack.pop();\r\n  }\r\n  if (!isPrimitivePropertyValue(value) || !(typeof displayValue === \"undefined\" || typeof displayValue === \"string\")) {\r\n    throw new Error(\"Can only create 'similar instances' ruleset for primitive values\");\r\n  }\r\n  return { raw: value, display: toString(displayValue) };\r\n};\r\n\r\nconst createInstanceFilter = (\r\n  relatedInstanceSpec: Readonly<RelatedInstanceSpecification> | undefined,\r\n  propertyType: PrimitiveTypeDescription,\r\n  propertyName: string,\r\n  propertyValue: PrimitivePropertyValue,\r\n): string => {\r\n  const alias = relatedInstanceSpec ? relatedInstanceSpec.alias : \"this\";\r\n  return createComparison(propertyType, `${alias}.${propertyName}`, \"=\", propertyValue);\r\n};\r\n\r\ntype Operator = \"=\" | \"!=\" | \">\" | \">=\" | \"<\" | \"<=\";\r\nconst createComparison = (type: PrimitiveTypeDescription, name: string, operator: Operator, value: PrimitivePropertyValue): string => {\r\n  let compareValue = \"\";\r\n  switch (typeof value) {\r\n    case \"undefined\":\r\n      compareValue = \"NULL\";\r\n      break;\r\n    case \"string\":\r\n      compareValue = `\"${value.replace(/\"/g, `\"\"`)}\"`;\r\n      break;\r\n    case \"boolean\":\r\n      compareValue = value ? \"TRUE\" : \"FALSE\";\r\n      break;\r\n    case \"number\":\r\n      compareValue = value.toString();\r\n      break;\r\n  }\r\n\r\n  if (type.typeName === \"navigation\" && typeof value === \"object\" && Id64.isId64((value as InstanceKey).id)) {\r\n    // note: this is temporary until we support hex ids in instance filters\r\n    compareValue = hexToDec((value as InstanceKey).id);\r\n  }\r\n\r\n  if (type.typeName === \"point2d\" || type.typeName === \"point3d\") {\r\n    if (typeof value !== \"object\") {\r\n      throw new Error(\"Expecting point values to be supplied as objects\");\r\n    }\r\n\r\n    const dimensionType: PrimitiveTypeDescription = {\r\n      valueFormat: PropertyValueFormat.Primitive,\r\n      typeName: \"double\",\r\n    };\r\n\r\n    const pointValue = value as Point;\r\n    let comparison = `${createComparison(dimensionType, `${name}.x`, operator, pointValue.x)}`;\r\n    comparison += ` AND ${createComparison(dimensionType, `${name}.y`, operator, pointValue.y)}`;\r\n    if (type.typeName === \"point3d\" && pointValue.z !== undefined) {\r\n      comparison += ` AND ${createComparison(dimensionType, `${name}.z`, operator, pointValue.z)}`;\r\n    }\r\n\r\n    return comparison;\r\n  }\r\n\r\n  if (type.typeName === \"double\") {\r\n    return `CompareDoubles(${name}, ${compareValue}) ${operator} 0`;\r\n  }\r\n\r\n  if (type.typeName === \"dateTime\") {\r\n    return `CompareDateTimes(${name}, ${compareValue}) ${operator} 0`;\r\n  }\r\n\r\n  return `${name} ${operator} ${compareValue}`;\r\n};\r\n\r\nconst createMultiClassSpecification = (classInfo: Readonly<ClassInfo>): MultiSchemaClassesSpecification => {\r\n  const [schemaName, className] = classInfo.name.split(\":\");\r\n  return { schemaName, classNames: [className], arePolymorphic: true };\r\n};\r\n\r\nconst createSingleClassSpecification = (classInfo: Readonly<ClassInfo>): SingleSchemaClassSpecification => {\r\n  const [schemaName, className] = classInfo.name.split(\":\");\r\n  return { schemaName, className };\r\n};\r\n\r\nconst createRelatedInstanceSpec = (\r\n  pathFromSelectToPropertyClass: RelationshipPath,\r\n  index: number,\r\n): { spec: RelatedInstanceSpecification; class: ClassInfo } => ({\r\n  spec: {\r\n    relationshipPath: pathFromSelectToPropertyClass.map((step) => ({\r\n      relationship: createSingleClassSpecification(step.relationshipInfo),\r\n      direction: step.isForwardRelationship ? RelationshipDirection.Forward : RelationshipDirection.Backward,\r\n      targetClass: createSingleClassSpecification(step.targetClassInfo),\r\n    })),\r\n    isRequired: true,\r\n    alias: `related_${index}`,\r\n  },\r\n  class: pathFromSelectToPropertyClass[pathFromSelectToPropertyClass.length - 1].targetClassInfo,\r\n});\r\n\r\nconst createPathFromSelectToPropertyClass = (field: PropertiesField): RelationshipPath => {\r\n  let currField: Field = field;\r\n  const pathFromPropertyToSelectClass: RelationshipPath = [];\r\n  while (currField.parent) {\r\n    pathFromPropertyToSelectClass.push(...currField.parent.pathToPrimaryClass);\r\n    currField = currField.parent;\r\n  }\r\n  return RelationshipPath.reverse(pathFromPropertyToSelectClass);\r\n};\r\n\r\nconst createRelatedInstanceSpecInfo = (field: PropertiesField): { spec: RelatedInstanceSpecification; class: ClassInfo } | undefined => {\r\n  const path = createPathFromSelectToPropertyClass(field);\r\n  return path.length ? createRelatedInstanceSpec(path, 0) : undefined;\r\n};\r\n\r\nconst hexToDec = (id: Id64String) => {\r\n  const digits = [0];\r\n  for (let i = 2; i < id.length; ++i) {\r\n    let carry = parseInt(id.charAt(i), 16);\r\n    for (let j = 0; j < digits.length; ++j) {\r\n      digits[j] = digits[j] * 16 + carry;\r\n      carry = (digits[j] / 10) | 0;\r\n      digits[j] %= 10;\r\n    }\r\n    while (carry > 0) {\r\n      digits.push(carry % 10);\r\n      carry = (carry / 10) | 0;\r\n    }\r\n  }\r\n  return digits.reverse().join(\"\");\r\n};\r\n"]}

package/lib/esm/presentation-common/Update.js.map

@@ -1 +1 @@
-{"version":3,"file":"Update.js","sourceRoot":"","sources":["../../../src/presentation-common/Update.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAe,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,IAAI,EAA0C,MAAM,kBAAkB,CAAC;AAEhF;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC;AA2ClC,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,4BAA4B,CAsE5C;AAtED,WAAiB,4BAA4B;IAC3C;;;OAGG;IACH,4DAA4D;IAC5D,SAAgB,MAAM,CAAC,GAAiC;QACtD,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;YACjB,KAAK,QAAQ;gBACX,OAAO;oBACL,IAAI,EAAE,QAAQ;oBACd,4DAA4D;oBAC5D,MAAM,EAAE,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;oBACzE,QAAQ,EAAE,GAAG,CAAC,QAAQ;oBACtB,4DAA4D;oBAC5D,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC;iBAC5B,CAAC;YAEJ,KAAK,QAAQ;gBACX,OAAO;oBACL,IAAI,EAAE,QAAQ;oBACd,4DAA4D;oBAC5D,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;oBAClC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC;iBACzC,CAAC;YAEJ,KAAK,QAAQ;gBACX,OAAO;oBACL,IAAI,EAAE,QAAQ;oBACd,4DAA4D;oBAC5D,MAAM,EAAE,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;oBACzE,QAAQ,EAAE,GAAG,CAAC,QAAQ;iBACvB,CAAC;QACN,CAAC;IACH,CAAC;IA5Be,mCAAM,SA4BrB,CAAA;IAED;;;OAGG;IACH,4DAA4D;IAC5D,SAAgB,QAAQ,CAAC,IAAsC;QAC7D,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,QAAQ;gBACX,OAAO;oBACL,IAAI,EAAE,QAAQ;oBACd,4DAA4D;oBAC5D,MAAM,EAAE,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC;oBAC7E,QAAQ,EAAE,IAAI,CAAC,QAAQ;oBACvB,4DAA4D;oBAC5D,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;iBAC/B,CAAC;YAEJ,KAAK,QAAQ;gBACX,OAAO;oBACL,IAAI,EAAE,QAAQ;oBACd,4DAA4D;oBAC5D,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC;oBACrC,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC;iBAC5C,CAAC;YAEJ,KAAK,QAAQ;gBACX,OAAO;oBACL,IAAI,EAAE,QAAQ;oBACd,4DAA4D;oBAC5D,MAAM,EAAE,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC;oBAC7E,QAAQ,EAAE,IAAI,CAAC,QAAQ;iBACxB,CAAC;QACN,CAAC;IACH,CAAC;IA5Be,qCAAQ,WA4BvB,CAAA;AACH,CAAC,EAtEgB,4BAA4B,KAA5B,4BAA4B,QAsE5C;AA6GD,cAAc;AACd,MAAM,KAAW,oBAAoB,CA0BpC;AA1BD,WAAiB,oBAAoB;IACnC;;;OAGG;IACH,4DAA4D;IAC5D,SAAgB,MAAM,CAAC,GAAyB;QAC9C,OAAO;YACL,GAAG,GAAG;YACN,4DAA4D;YAC5D,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,4BAA4B,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SAClF,CAAC;IACJ,CAAC;IANe,2BAAM,SAMrB,CAAA;IAED;;;OAGG;IACH,4DAA4D;IAC5D,SAAgB,QAAQ,CAAC,IAA8B;QACrD,OAAO;YACL,GAAG,IAAI;YACP,4DAA4D;YAC5D,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,4BAA4B,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SACrF,CAAC;IACJ,CAAC;IANe,6BAAQ,WAMvB,CAAA;AACH,CAAC,EA1BgB,oBAAoB,KAApB,oBAAoB,QA0BpC","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 { NodeKey, NodeKeyJSON } from \"./hierarchy/Key\";\nimport { Node, NodeJSON, PartialNode, PartialNodeJSON } from \"./hierarchy/Node\";\n\n/**\n * A constant for indicating that a full update is required.\n * @public\n */\nexport const UPDATE_FULL = \"FULL\";\n\n/**\n * A data structure that describes changes that need to be applied to the hierarchy and\n * content components due to some changes on the backend.\n *\n * @public\n */\nexport interface UpdateInfo {\n  [imodel: string]: {\n    [rulesetId: string]: {\n      hierarchy?: HierarchyUpdateInfo;\n      content?: ContentUpdateInfo;\n    };\n  };\n}\n\n/**\n * Information about a required hierarchy update.\n * @public\n */\nexport type HierarchyUpdateInfo = typeof UPDATE_FULL;\n\n/**\n * Information about a required content update.\n * @public\n */\nexport type ContentUpdateInfo = typeof UPDATE_FULL;\n\n/**\n * JSON representation of [[PartialHierarchyModification]].\n * @public\n * @deprecated in 3.x. Use [[PartialHierarchyModification]]\n */\n// eslint-disable-next-line @typescript-eslint/no-deprecated\nexport type PartialHierarchyModificationJSON = NodeInsertionInfoJSON | NodeDeletionInfoJSON | NodeUpdateInfoJSON;\n\n/**\n * Information about a hierarchy change: insertion, deletion or node update.\n * @public\n */\nexport type PartialHierarchyModification = NodeInsertionInfo | NodeDeletionInfo | NodeUpdateInfo;\n\n/** @public */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace PartialHierarchyModification {\n  /**\n   * Serialize given object to JSON.\n   * @deprecated in 3.x. Use [[PartialHierarchyModification]]\n   */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  export function toJSON(obj: PartialHierarchyModification): PartialHierarchyModificationJSON {\n    switch (obj.type) {\n      case \"Insert\":\n        return {\n          type: \"Insert\",\n          // eslint-disable-next-line @typescript-eslint/no-deprecated\n          parent: obj.parent === undefined ? undefined : NodeKey.toJSON(obj.parent),\n          position: obj.position,\n          // eslint-disable-next-line @typescript-eslint/no-deprecated\n          node: Node.toJSON(obj.node),\n        };\n\n      case \"Update\":\n        return {\n          type: \"Update\",\n          // eslint-disable-next-line @typescript-eslint/no-deprecated\n          target: NodeKey.toJSON(obj.target),\n          changes: Node.toPartialJSON(obj.changes),\n        };\n\n      case \"Delete\":\n        return {\n          type: \"Delete\",\n          // eslint-disable-next-line @typescript-eslint/no-deprecated\n          parent: obj.parent === undefined ? undefined : NodeKey.toJSON(obj.parent),\n          position: obj.position,\n        };\n    }\n  }\n\n  /**\n   * Deserialize given object from JSON\n   * @deprecated in 3.x. Use [[PartialHierarchyModification]]\n   */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  export function fromJSON(json: PartialHierarchyModificationJSON): PartialHierarchyModification {\n    switch (json.type) {\n      case \"Insert\":\n        return {\n          type: \"Insert\",\n          // eslint-disable-next-line @typescript-eslint/no-deprecated\n          parent: json.parent === undefined ? undefined : NodeKey.fromJSON(json.parent),\n          position: json.position,\n          // eslint-disable-next-line @typescript-eslint/no-deprecated\n          node: Node.fromJSON(json.node),\n        };\n\n      case \"Update\":\n        return {\n          type: \"Update\",\n          // eslint-disable-next-line @typescript-eslint/no-deprecated\n          target: NodeKey.fromJSON(json.target),\n          changes: Node.fromPartialJSON(json.changes),\n        };\n\n      case \"Delete\":\n        return {\n          type: \"Delete\",\n          // eslint-disable-next-line @typescript-eslint/no-deprecated\n          parent: json.parent === undefined ? undefined : NodeKey.fromJSON(json.parent),\n          position: json.position,\n        };\n    }\n  }\n}\n\n/**\n * Information about node insertion.\n * @public\n */\nexport interface NodeInsertionInfo {\n  type: \"Insert\";\n  /** Parent node key */\n  parent?: NodeKey;\n  /** Index of the new node under its parent */\n  position: number;\n  /** Inserted node */\n  node: Node;\n}\n\n/**\n * JSON representation of [[NodeInsertionInfo]].\n * @public\n * @deprecated in 3.x. Use [[NodeInsertionInfo]]\n */\nexport interface NodeInsertionInfoJSON {\n  type: \"Insert\";\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  parent?: NodeKeyJSON;\n  position: number;\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  node: NodeJSON;\n}\n\n/**\n * Information about node deletion.\n * @public\n */\nexport interface NodeDeletionInfo {\n  type: \"Delete\";\n  /** Parent of the deleted node */\n  parent?: NodeKey;\n  /** Position of the deleted node among its siblings in the initial, not updated tree */\n  position: number;\n}\n\n/**\n * JSON representation of [[NodeDeletionInfo]].\n * @public\n * @deprecated in 3.x. Use [[NodeDeletionInfo]]\n */\nexport interface NodeDeletionInfoJSON {\n  type: \"Delete\";\n  /** Parent of the deleted node */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  parent?: NodeKeyJSON;\n  /** Position of the deleted node among its siblings in the initial, not updated tree */\n  position: number;\n}\n\n/**\n * Information about node update.\n * @public\n */\nexport interface NodeUpdateInfo {\n  type: \"Update\";\n  /** Key of the updated node */\n  target: NodeKey;\n  /** Updated node attributes */\n  changes: PartialNode;\n}\n\n/**\n * JSON representation of [[NodeUpdateInfo]].\n * @public\n * @deprecated in 3.x. Use [[NodeUpdateInfo]]\n */\nexport interface NodeUpdateInfoJSON {\n  type: \"Update\";\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  target: NodeKeyJSON;\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  changes: PartialNodeJSON;\n}\n\n/**\n * JSON representation of [[HierarchyCompareInfo]].\n * @public\n * @deprecated in 3.x. Use [[HierarchyCompareInfo]].\n */\nexport interface HierarchyCompareInfoJSON {\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  changes: PartialHierarchyModificationJSON[];\n  continuationToken?: {\n    prevHierarchyNode: string;\n    currHierarchyNode: string;\n  };\n}\n\n/**\n * Information about hierarchy modification / differences.\n * @public\n */\nexport interface HierarchyCompareInfo {\n  /** A list of hierarchy changes */\n  changes: PartialHierarchyModification[];\n  /** Continuation token for requesting more changes. */\n  continuationToken?: {\n    prevHierarchyNode: string;\n    currHierarchyNode: string;\n  };\n}\n\n/** @public */\nexport namespace HierarchyCompareInfo {\n  /**\n   * Serialize given object to JSON.\n   * @deprecated in 3.x. Use [[HierarchyCompareInfo]]\n   */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  export function toJSON(obj: HierarchyCompareInfo): HierarchyCompareInfoJSON {\n    return {\n      ...obj,\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\n      changes: obj.changes.map((change) => PartialHierarchyModification.toJSON(change)),\n    };\n  }\n\n  /**\n   * Deserialize given object from JSON\n   * @deprecated in 3.x. Use [[HierarchyCompareInfo]]\n   */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  export function fromJSON(json: HierarchyCompareInfoJSON): HierarchyCompareInfo {\n    return {\n      ...json,\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\n      changes: json.changes.map((change) => PartialHierarchyModification.fromJSON(change)),\n    };\n  }\n}\n"]}
+{"version":3,"file":"Update.js","sourceRoot":"","sources":["../../../src/presentation-common/Update.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAe,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,IAAI,EAA0C,MAAM,kBAAkB,CAAC;AAEhF;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC;AA2ClC,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,4BAA4B,CAsE5C;AAtED,WAAiB,4BAA4B;IAC3C;;;OAGG;IACH,4DAA4D;IAC5D,SAAgB,MAAM,CAAC,GAAiC;QACtD,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;YACjB,KAAK,QAAQ;gBACX,OAAO;oBACL,IAAI,EAAE,QAAQ;oBACd,4DAA4D;oBAC5D,MAAM,EAAE,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;oBACzE,QAAQ,EAAE,GAAG,CAAC,QAAQ;oBACtB,4DAA4D;oBAC5D,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC;iBAC5B,CAAC;YAEJ,KAAK,QAAQ;gBACX,OAAO;oBACL,IAAI,EAAE,QAAQ;oBACd,4DAA4D;oBAC5D,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;oBAClC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC;iBACzC,CAAC;YAEJ,KAAK,QAAQ;gBACX,OAAO;oBACL,IAAI,EAAE,QAAQ;oBACd,4DAA4D;oBAC5D,MAAM,EAAE,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;oBACzE,QAAQ,EAAE,GAAG,CAAC,QAAQ;iBACvB,CAAC;QACN,CAAC;IACH,CAAC;IA5Be,mCAAM,SA4BrB,CAAA;IAED;;;OAGG;IACH,4DAA4D;IAC5D,SAAgB,QAAQ,CAAC,IAAsC;QAC7D,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,QAAQ;gBACX,OAAO;oBACL,IAAI,EAAE,QAAQ;oBACd,4DAA4D;oBAC5D,MAAM,EAAE,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC;oBAC7E,QAAQ,EAAE,IAAI,CAAC,QAAQ;oBACvB,4DAA4D;oBAC5D,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;iBAC/B,CAAC;YAEJ,KAAK,QAAQ;gBACX,OAAO;oBACL,IAAI,EAAE,QAAQ;oBACd,4DAA4D;oBAC5D,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC;oBACrC,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC;iBAC5C,CAAC;YAEJ,KAAK,QAAQ;gBACX,OAAO;oBACL,IAAI,EAAE,QAAQ;oBACd,4DAA4D;oBAC5D,MAAM,EAAE,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC;oBAC7E,QAAQ,EAAE,IAAI,CAAC,QAAQ;iBACxB,CAAC;QACN,CAAC;IACH,CAAC;IA5Be,qCAAQ,WA4BvB,CAAA;AACH,CAAC,EAtEgB,4BAA4B,KAA5B,4BAA4B,QAsE5C;AA6GD,cAAc;AACd,MAAM,KAAW,oBAAoB,CA0BpC;AA1BD,WAAiB,oBAAoB;IACnC;;;OAGG;IACH,4DAA4D;IAC5D,SAAgB,MAAM,CAAC,GAAyB;QAC9C,OAAO;YACL,GAAG,GAAG;YACN,4DAA4D;YAC5D,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,4BAA4B,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SAClF,CAAC;IACJ,CAAC;IANe,2BAAM,SAMrB,CAAA;IAED;;;OAGG;IACH,4DAA4D;IAC5D,SAAgB,QAAQ,CAAC,IAA8B;QACrD,OAAO;YACL,GAAG,IAAI;YACP,4DAA4D;YAC5D,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,4BAA4B,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SACrF,CAAC;IACJ,CAAC;IANe,6BAAQ,WAMvB,CAAA;AACH,CAAC,EA1BgB,oBAAoB,KAApB,oBAAoB,QA0BpC","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 { NodeKey, NodeKeyJSON } from \"./hierarchy/Key\";\r\nimport { Node, NodeJSON, PartialNode, PartialNodeJSON } from \"./hierarchy/Node\";\r\n\r\n/**\r\n * A constant for indicating that a full update is required.\r\n * @public\r\n */\r\nexport const UPDATE_FULL = \"FULL\";\r\n\r\n/**\r\n * A data structure that describes changes that need to be applied to the hierarchy and\r\n * content components due to some changes on the backend.\r\n *\r\n * @public\r\n */\r\nexport interface UpdateInfo {\r\n  [imodel: string]: {\r\n    [rulesetId: string]: {\r\n      hierarchy?: HierarchyUpdateInfo;\r\n      content?: ContentUpdateInfo;\r\n    };\r\n  };\r\n}\r\n\r\n/**\r\n * Information about a required hierarchy update.\r\n * @public\r\n */\r\nexport type HierarchyUpdateInfo = typeof UPDATE_FULL;\r\n\r\n/**\r\n * Information about a required content update.\r\n * @public\r\n */\r\nexport type ContentUpdateInfo = typeof UPDATE_FULL;\r\n\r\n/**\r\n * JSON representation of [[PartialHierarchyModification]].\r\n * @public\r\n * @deprecated in 3.x. Use [[PartialHierarchyModification]]\r\n */\r\n// eslint-disable-next-line @typescript-eslint/no-deprecated\r\nexport type PartialHierarchyModificationJSON = NodeInsertionInfoJSON | NodeDeletionInfoJSON | NodeUpdateInfoJSON;\r\n\r\n/**\r\n * Information about a hierarchy change: insertion, deletion or node update.\r\n * @public\r\n */\r\nexport type PartialHierarchyModification = NodeInsertionInfo | NodeDeletionInfo | NodeUpdateInfo;\r\n\r\n/** @public */\r\n// eslint-disable-next-line @typescript-eslint/no-redeclare\r\nexport namespace PartialHierarchyModification {\r\n  /**\r\n   * Serialize given object to JSON.\r\n   * @deprecated in 3.x. Use [[PartialHierarchyModification]]\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  export function toJSON(obj: PartialHierarchyModification): PartialHierarchyModificationJSON {\r\n    switch (obj.type) {\r\n      case \"Insert\":\r\n        return {\r\n          type: \"Insert\",\r\n          // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n          parent: obj.parent === undefined ? undefined : NodeKey.toJSON(obj.parent),\r\n          position: obj.position,\r\n          // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n          node: Node.toJSON(obj.node),\r\n        };\r\n\r\n      case \"Update\":\r\n        return {\r\n          type: \"Update\",\r\n          // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n          target: NodeKey.toJSON(obj.target),\r\n          changes: Node.toPartialJSON(obj.changes),\r\n        };\r\n\r\n      case \"Delete\":\r\n        return {\r\n          type: \"Delete\",\r\n          // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n          parent: obj.parent === undefined ? undefined : NodeKey.toJSON(obj.parent),\r\n          position: obj.position,\r\n        };\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Deserialize given object from JSON\r\n   * @deprecated in 3.x. Use [[PartialHierarchyModification]]\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  export function fromJSON(json: PartialHierarchyModificationJSON): PartialHierarchyModification {\r\n    switch (json.type) {\r\n      case \"Insert\":\r\n        return {\r\n          type: \"Insert\",\r\n          // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n          parent: json.parent === undefined ? undefined : NodeKey.fromJSON(json.parent),\r\n          position: json.position,\r\n          // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n          node: Node.fromJSON(json.node),\r\n        };\r\n\r\n      case \"Update\":\r\n        return {\r\n          type: \"Update\",\r\n          // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n          target: NodeKey.fromJSON(json.target),\r\n          changes: Node.fromPartialJSON(json.changes),\r\n        };\r\n\r\n      case \"Delete\":\r\n        return {\r\n          type: \"Delete\",\r\n          // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n          parent: json.parent === undefined ? undefined : NodeKey.fromJSON(json.parent),\r\n          position: json.position,\r\n        };\r\n    }\r\n  }\r\n}\r\n\r\n/**\r\n * Information about node insertion.\r\n * @public\r\n */\r\nexport interface NodeInsertionInfo {\r\n  type: \"Insert\";\r\n  /** Parent node key */\r\n  parent?: NodeKey;\r\n  /** Index of the new node under its parent */\r\n  position: number;\r\n  /** Inserted node */\r\n  node: Node;\r\n}\r\n\r\n/**\r\n * JSON representation of [[NodeInsertionInfo]].\r\n * @public\r\n * @deprecated in 3.x. Use [[NodeInsertionInfo]]\r\n */\r\nexport interface NodeInsertionInfoJSON {\r\n  type: \"Insert\";\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  parent?: NodeKeyJSON;\r\n  position: number;\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  node: NodeJSON;\r\n}\r\n\r\n/**\r\n * Information about node deletion.\r\n * @public\r\n */\r\nexport interface NodeDeletionInfo {\r\n  type: \"Delete\";\r\n  /** Parent of the deleted node */\r\n  parent?: NodeKey;\r\n  /** Position of the deleted node among its siblings in the initial, not updated tree */\r\n  position: number;\r\n}\r\n\r\n/**\r\n * JSON representation of [[NodeDeletionInfo]].\r\n * @public\r\n * @deprecated in 3.x. Use [[NodeDeletionInfo]]\r\n */\r\nexport interface NodeDeletionInfoJSON {\r\n  type: \"Delete\";\r\n  /** Parent of the deleted node */\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  parent?: NodeKeyJSON;\r\n  /** Position of the deleted node among its siblings in the initial, not updated tree */\r\n  position: number;\r\n}\r\n\r\n/**\r\n * Information about node update.\r\n * @public\r\n */\r\nexport interface NodeUpdateInfo {\r\n  type: \"Update\";\r\n  /** Key of the updated node */\r\n  target: NodeKey;\r\n  /** Updated node attributes */\r\n  changes: PartialNode;\r\n}\r\n\r\n/**\r\n * JSON representation of [[NodeUpdateInfo]].\r\n * @public\r\n * @deprecated in 3.x. Use [[NodeUpdateInfo]]\r\n */\r\nexport interface NodeUpdateInfoJSON {\r\n  type: \"Update\";\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  target: NodeKeyJSON;\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  changes: PartialNodeJSON;\r\n}\r\n\r\n/**\r\n * JSON representation of [[HierarchyCompareInfo]].\r\n * @public\r\n * @deprecated in 3.x. Use [[HierarchyCompareInfo]].\r\n */\r\nexport interface HierarchyCompareInfoJSON {\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  changes: PartialHierarchyModificationJSON[];\r\n  continuationToken?: {\r\n    prevHierarchyNode: string;\r\n    currHierarchyNode: string;\r\n  };\r\n}\r\n\r\n/**\r\n * Information about hierarchy modification / differences.\r\n * @public\r\n */\r\nexport interface HierarchyCompareInfo {\r\n  /** A list of hierarchy changes */\r\n  changes: PartialHierarchyModification[];\r\n  /** Continuation token for requesting more changes. */\r\n  continuationToken?: {\r\n    prevHierarchyNode: string;\r\n    currHierarchyNode: string;\r\n  };\r\n}\r\n\r\n/** @public */\r\nexport namespace HierarchyCompareInfo {\r\n  /**\r\n   * Serialize given object to JSON.\r\n   * @deprecated in 3.x. Use [[HierarchyCompareInfo]]\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  export function toJSON(obj: HierarchyCompareInfo): HierarchyCompareInfoJSON {\r\n    return {\r\n      ...obj,\r\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n      changes: obj.changes.map((change) => PartialHierarchyModification.toJSON(change)),\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Deserialize given object from JSON\r\n   * @deprecated in 3.x. Use [[HierarchyCompareInfo]]\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  export function fromJSON(json: HierarchyCompareInfoJSON): HierarchyCompareInfo {\r\n    return {\r\n      ...json,\r\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n      changes: json.changes.map((change) => PartialHierarchyModification.fromJSON(change)),\r\n    };\r\n  }\r\n}\r\n"]}

package/lib/esm/presentation-common/Utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../../src/presentation-common/Utils.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AA8C1C;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,IAAsB,EAAU,EAAE;IAClE,IAAI,KAAK,GAAG,IAAI,CAAC,iBAAiB,CAAC;IACnC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAY,EAAE,EAAE;QACrC,IAAI,OAAO,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC;YACpC,KAAK,IAAI,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC;QACnC,CAAC;aAAM,IAAI,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1C,KAAK,IAAI,GAAG,CAAC,qBAAqB,CAAC;QACrC,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,IAAI,CAAC","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 { NodeKey } from \"./hierarchy/Key\";\nimport { KeySet } from \"./KeySet\";\n\n/**\n * Create a type with `T` properties excluding properties listed in `K`.\n *\n * Usage example: `Omit<SomeType, \"exclude_prop1\" | \"exclude_prop2\">`\n *\n * @public\n */\nexport type Omit<T, K> = Pick<T, Exclude<keyof T, K>>;\n\n/**\n * Create a type with `T` properties excluding all properties in type `K`.\n *\n * Usage example: `Subtract<SomeType, ExcludePropertiesInThisType>`\n *\n * @public\n */\nexport type Subtract<T, K> = Omit<T, keyof K>;\n\n/**\n * Create a type from given type `T` and make specified properties optional.\n * @public\n */\nexport type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;\n\n/**\n * A dictionary data structure.\n * @public\n */\nexport interface ValuesDictionary<T> {\n  [key: string]: T;\n}\n\n/**\n * A structure for paged responses\n * @public\n */\nexport interface PagedResponse<T> {\n  /** Total number of items */\n  total: number;\n  /** Items for the requested page  */\n  items: T[];\n}\n\n/**\n * Get total number of instances included in the supplied key set. The\n * count is calculated by adding all of the following:\n * - `keys.instanceKeysCount`\n * - number of `keys.nodeKeys` which are *ECInstance* keys\n * - for every grouping node key in `keys.nodeKeys`, number of grouped instances\n *\n * E.g. if `keys` contains one instance key, one *ECInstance* node key\n * and one grouping node key which groups 3 instances, the result is 5.\n *\n * @public\n */\nexport const getInstancesCount = (keys: Readonly<KeySet>): number => {\n  let count = keys.instanceKeysCount;\n  keys.nodeKeys.forEach((key: NodeKey) => {\n    if (NodeKey.isInstancesNodeKey(key)) {\n      count += key.instanceKeys.length;\n    } else if (NodeKey.isGroupingNodeKey(key)) {\n      count += key.groupedInstancesCount;\n    }\n  });\n  return count;\n};\n\n/**\n * Default (recommended) keyset batch size for cases when it needs to be sent\n * over HTTP. Sending keys in batches helps avoid HTTP413 error.\n *\n * @public\n */\nexport const DEFAULT_KEYS_BATCH_SIZE = 5000;\n"]}
+{"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../../src/presentation-common/Utils.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AA8C1C;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,IAAsB,EAAU,EAAE;IAClE,IAAI,KAAK,GAAG,IAAI,CAAC,iBAAiB,CAAC;IACnC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAY,EAAE,EAAE;QACrC,IAAI,OAAO,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC;YACpC,KAAK,IAAI,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC;QACnC,CAAC;aAAM,IAAI,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1C,KAAK,IAAI,GAAG,CAAC,qBAAqB,CAAC;QACrC,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,IAAI,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n * See LICENSE.md in the project root for license terms and full copyright notice.\r\n *--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Core\r\n */\r\n\r\nimport { NodeKey } from \"./hierarchy/Key\";\r\nimport { KeySet } from \"./KeySet\";\r\n\r\n/**\r\n * Create a type with `T` properties excluding properties listed in `K`.\r\n *\r\n * Usage example: `Omit<SomeType, \"exclude_prop1\" | \"exclude_prop2\">`\r\n *\r\n * @public\r\n */\r\nexport type Omit<T, K> = Pick<T, Exclude<keyof T, K>>;\r\n\r\n/**\r\n * Create a type with `T` properties excluding all properties in type `K`.\r\n *\r\n * Usage example: `Subtract<SomeType, ExcludePropertiesInThisType>`\r\n *\r\n * @public\r\n */\r\nexport type Subtract<T, K> = Omit<T, keyof K>;\r\n\r\n/**\r\n * Create a type from given type `T` and make specified properties optional.\r\n * @public\r\n */\r\nexport type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;\r\n\r\n/**\r\n * A dictionary data structure.\r\n * @public\r\n */\r\nexport interface ValuesDictionary<T> {\r\n  [key: string]: T;\r\n}\r\n\r\n/**\r\n * A structure for paged responses\r\n * @public\r\n */\r\nexport interface PagedResponse<T> {\r\n  /** Total number of items */\r\n  total: number;\r\n  /** Items for the requested page  */\r\n  items: T[];\r\n}\r\n\r\n/**\r\n * Get total number of instances included in the supplied key set. The\r\n * count is calculated by adding all of the following:\r\n * - `keys.instanceKeysCount`\r\n * - number of `keys.nodeKeys` which are *ECInstance* keys\r\n * - for every grouping node key in `keys.nodeKeys`, number of grouped instances\r\n *\r\n * E.g. if `keys` contains one instance key, one *ECInstance* node key\r\n * and one grouping node key which groups 3 instances, the result is 5.\r\n *\r\n * @public\r\n */\r\nexport const getInstancesCount = (keys: Readonly<KeySet>): number => {\r\n  let count = keys.instanceKeysCount;\r\n  keys.nodeKeys.forEach((key: NodeKey) => {\r\n    if (NodeKey.isInstancesNodeKey(key)) {\r\n      count += key.instanceKeys.length;\r\n    } else if (NodeKey.isGroupingNodeKey(key)) {\r\n      count += key.groupedInstancesCount;\r\n    }\r\n  });\r\n  return count;\r\n};\r\n\r\n/**\r\n * Default (recommended) keyset batch size for cases when it needs to be sent\r\n * over HTTP. Sending keys in batches helps avoid HTTP413 error.\r\n *\r\n * @public\r\n */\r\nexport const DEFAULT_KEYS_BATCH_SIZE = 5000;\r\n"]}

package/lib/esm/presentation-common/content/Category.js.map

@@ -1 +1 @@
-{"version":3,"file":"Category.js","sourceRoot":"","sources":["../../../../src/presentation-common/content/Category.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAwBH,cAAc;AACd,MAAM,KAAW,mBAAmB,CAmCnC;AAnCD,WAAiB,mBAAmB;IAClC,uCAAuC;IACvC,SAAgB,MAAM,CAAC,QAA6B;QAClD,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,QAAQ,CAAC;QACrC,OAAO;YACL,GAAG,IAAI;YACP,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;SAClD,CAAC;IACJ,CAAC;IANe,0BAAM,SAMrB,CAAA;IAED;;;OAGG;IACH,SAAgB,QAAQ,CAAC,IAA6B;QACpD,6DAA6D;QAC7D,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAJe,4BAAQ,WAIvB,CAAA;IAED,SAAS,yBAAyB,CAAC,IAA6B,EAAE,aAA+C;QAC/G,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAE,CAAC;QAC/C,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,mDAAmD;YACnD,QAAQ,CAAC,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,+DAA+D;IAC/D,SAAgB,YAAY,CAAC,IAA+B;QAC1D,MAAM,aAAa,GAAG,IAAI,GAAG,EAA+B,CAAC;QAC7D,IAAI,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,mBAAmB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QACjH,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,yBAAyB,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC,CAAC;IAC5F,CAAC;IAJe,gCAAY,eAI3B,CAAA;AACH,CAAC,EAnCgB,mBAAmB,KAAnB,mBAAmB,QAmCnC","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 Content\n */\n\nimport { RendererDescription } from \"./Renderer\";\n\n/**\n * A data structure that describes a [[Field]] category.\n * @public\n */\nexport interface CategoryDescription {\n  /** Unique name */\n  name: string;\n  /** Display label */\n  label: string;\n  /** Extensive description */\n  description: string;\n  /** Priority. Categories with higher priority should appear higher in the UI */\n  priority: number;\n  /** Should this category be auto-expanded when it's displayed in the UI */\n  expand: boolean;\n  /** Parent category description */\n  parent?: CategoryDescription;\n  /** Custom renderer description */\n  renderer?: RendererDescription;\n}\n/** @public */\nexport namespace CategoryDescription {\n  /** Serialize given category to JSON */\n  export function toJSON(category: CategoryDescription): CategoryDescriptionJSON {\n    const { parent, ...rest } = category;\n    return {\n      ...rest,\n      ...(parent ? { parent: parent.name } : undefined),\n    };\n  }\n\n  /**\n   * Deserialize [[CategoryDescription]] from JSON. The `parent` is not assigned - use [[CategoryDescription.listFromJSON]]\n   * to deserialize the whole categories list and set parents.\n   */\n  export function fromJSON(json: CategoryDescriptionJSON): CategoryDescription {\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    const { parent, ...rest } = json;\n    return rest;\n  }\n\n  function createCategoriesHierarchy(json: CategoryDescriptionJSON, categoriesMap: Map<string, CategoryDescription>): CategoryDescription {\n    const category = categoriesMap.get(json.name)!;\n    if (json.parent) {\n      // note: mutating categories in the `categoriesMap`\n      category.parent = categoriesMap.get(json.parent);\n    }\n    return category;\n  }\n\n  /** Deserialize a list of [[CategoryDescription]] from JSON. */\n  export function listFromJSON(json: CategoryDescriptionJSON[]): CategoryDescription[] {\n    const categoriesMap = new Map<string, CategoryDescription>();\n    json.forEach((categoryJson) => categoriesMap.set(categoryJson.name, CategoryDescription.fromJSON(categoryJson)));\n    return json.map((categoryJson) => createCategoriesHierarchy(categoryJson, categoriesMap));\n  }\n}\n\n/**\n * Serialized [[CategoryDescription]] JSON representation.\n * @public\n */\nexport interface CategoryDescriptionJSON {\n  name: string;\n  label: string;\n  description: string;\n  priority: number;\n  expand: boolean;\n  parent?: string;\n  renderer?: RendererDescription;\n}\n"]}
+{"version":3,"file":"Category.js","sourceRoot":"","sources":["../../../../src/presentation-common/content/Category.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAwBH,cAAc;AACd,MAAM,KAAW,mBAAmB,CAmCnC;AAnCD,WAAiB,mBAAmB;IAClC,uCAAuC;IACvC,SAAgB,MAAM,CAAC,QAA6B;QAClD,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,QAAQ,CAAC;QACrC,OAAO;YACL,GAAG,IAAI;YACP,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;SAClD,CAAC;IACJ,CAAC;IANe,0BAAM,SAMrB,CAAA;IAED;;;OAGG;IACH,SAAgB,QAAQ,CAAC,IAA6B;QACpD,6DAA6D;QAC7D,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAJe,4BAAQ,WAIvB,CAAA;IAED,SAAS,yBAAyB,CAAC,IAA6B,EAAE,aAA+C;QAC/G,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAE,CAAC;QAC/C,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,mDAAmD;YACnD,QAAQ,CAAC,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,+DAA+D;IAC/D,SAAgB,YAAY,CAAC,IAA+B;QAC1D,MAAM,aAAa,GAAG,IAAI,GAAG,EAA+B,CAAC;QAC7D,IAAI,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,mBAAmB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QACjH,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,yBAAyB,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC,CAAC;IAC5F,CAAC;IAJe,gCAAY,eAI3B,CAAA;AACH,CAAC,EAnCgB,mBAAmB,KAAnB,mBAAmB,QAmCnC","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 Content\r\n */\r\n\r\nimport { RendererDescription } from \"./Renderer\";\r\n\r\n/**\r\n * A data structure that describes a [[Field]] category.\r\n * @public\r\n */\r\nexport interface CategoryDescription {\r\n  /** Unique name */\r\n  name: string;\r\n  /** Display label */\r\n  label: string;\r\n  /** Extensive description */\r\n  description: string;\r\n  /** Priority. Categories with higher priority should appear higher in the UI */\r\n  priority: number;\r\n  /** Should this category be auto-expanded when it's displayed in the UI */\r\n  expand: boolean;\r\n  /** Parent category description */\r\n  parent?: CategoryDescription;\r\n  /** Custom renderer description */\r\n  renderer?: RendererDescription;\r\n}\r\n/** @public */\r\nexport namespace CategoryDescription {\r\n  /** Serialize given category to JSON */\r\n  export function toJSON(category: CategoryDescription): CategoryDescriptionJSON {\r\n    const { parent, ...rest } = category;\r\n    return {\r\n      ...rest,\r\n      ...(parent ? { parent: parent.name } : undefined),\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Deserialize [[CategoryDescription]] from JSON. The `parent` is not assigned - use [[CategoryDescription.listFromJSON]]\r\n   * to deserialize the whole categories list and set parents.\r\n   */\r\n  export function fromJSON(json: CategoryDescriptionJSON): CategoryDescription {\r\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\r\n    const { parent, ...rest } = json;\r\n    return rest;\r\n  }\r\n\r\n  function createCategoriesHierarchy(json: CategoryDescriptionJSON, categoriesMap: Map<string, CategoryDescription>): CategoryDescription {\r\n    const category = categoriesMap.get(json.name)!;\r\n    if (json.parent) {\r\n      // note: mutating categories in the `categoriesMap`\r\n      category.parent = categoriesMap.get(json.parent);\r\n    }\r\n    return category;\r\n  }\r\n\r\n  /** Deserialize a list of [[CategoryDescription]] from JSON. */\r\n  export function listFromJSON(json: CategoryDescriptionJSON[]): CategoryDescription[] {\r\n    const categoriesMap = new Map<string, CategoryDescription>();\r\n    json.forEach((categoryJson) => categoriesMap.set(categoryJson.name, CategoryDescription.fromJSON(categoryJson)));\r\n    return json.map((categoryJson) => createCategoriesHierarchy(categoryJson, categoriesMap));\r\n  }\r\n}\r\n\r\n/**\r\n * Serialized [[CategoryDescription]] JSON representation.\r\n * @public\r\n */\r\nexport interface CategoryDescriptionJSON {\r\n  name: string;\r\n  label: string;\r\n  description: string;\r\n  priority: number;\r\n  expand: boolean;\r\n  parent?: string;\r\n  renderer?: RendererDescription;\r\n}\r\n"]}