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

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;;;+FAG+F;AAC/F;;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;AAO1E,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAYhE,OAAO,EACoB,wBAAwB,GAClD,MAAM,4BAA4B,CAAC;AAMpC;;;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,KAA+B,OAAO,UAAU,CAAC,qBAAqB,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC;IAEhH,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;YACrC,IAAI;gBACF,MAAM,QAAQ,GAAG,MAAM,IAAI,EAAE,CAAC;gBAC9B,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;gBACnC,QAAQ,QAAQ,CAAC,UAAU,EAAE;oBAC3B,KAAK,kBAAkB,CAAC,OAAO,CAAC,CAAC,OAAO,QAAQ,CAAC,MAAO,CAAC;oBACzD,KAAK,kBAAkB,CAAC,cAAc,CAAC,CAAC,MAAM;oBAC9C,OAAO,CAAC,CAAC,MAAM,IAAI,iBAAiB,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;iBAClF;aACF;oBAAS;gBACR,kBAAkB,IAAI,WAAW,IAAI,kBAAkB,CAAC,WAAW,CAAC,CAAC;aACtE;SACF;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;YACzC,eAAe,CAAC,WAAW,GAAG,cAAc,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;SAC3E;QACD,MAAM,UAAU,GAA4C;YAC1D,GAAG,eAAe;YAClB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;QACF,IAAI,WAAW,EAAE;YACf,UAAU,CAAC,WAAW,GAAG,kBAAkB,CAAC;SAC7C;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,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IACD,mDAAmD;IAC5C,KAAK,CAAC,aAAa,CAAC,OAAkH;QAC3I,mDAAmD;QACnD,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,OAA0H;QACxJ,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;QACnE,IAAI,OAAO,QAAQ,KAAK,QAAQ;YAC9B,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,mDAAmD;IAC5C,KAAK,CAAC,YAAY,CAAC,OAAuH;QAC/I,mDAAmD;QACnD,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IACD,mDAAmD;IAC5C,KAAK,CAAC,oBAAoB,CAAC,OAA8G;QAC9I,mDAAmD;QACnD,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,OAAkF;QAC/G,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IACM,KAAK,CAAC,oBAAoB,CAAC,OAAsH;QACtJ,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IACM,KAAK,CAAC,iBAAiB,CAAC,OAAiI;QAC9J,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IACM,KAAK,CAAC,eAAe,CAAC,OAAwI;QACnK,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IACM,KAAK,CAAC,kBAAkB,CAAC,OAAwI;QACtK,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED,mDAAmD;IAC5C,KAAK,CAAC,sBAAsB,CAAC,OAAwI;QAC1K,mDAAmD;QACnD,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,OAA2F;QAC3H,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAEM,KAAK,CAAC,sBAAsB,CAAC,OAAwH;QAC1J,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,OAA6F;QAClI,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IACM,KAAK,CAAC,+BAA+B,CAAC,OAA8F;QACzI,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,+BAA+B,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,OAAkF;QAChH,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IACM,KAAK,CAAC,gBAAgB,CAAC,OAAoF;QAChH,OAAO,IAAI,CAAC,OAAO;QACjB,mDAAmD;QACnD,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AAED,SAAS,oBAAoB,CAAC,OAAe;IAC3C,OAAO,CAAC,OAAQ,OAA+C,CAAC,WAAW,KAAK,QAAQ,CAAC,CAAC;AAC5F,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;QACvD,IAAI,CAAC,gCAAgC,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE;YACjE,IAAI,WAAW,KAAK,SAAS;gBAC3B,OAAQ,gBAAwB,CAAC,WAAW,CAAC,CAAC;;gBAE9C,MAAM,CAAC,UAAU,CAAC,gCAAgC,CAAC,OAAO,EAAE,qDAAqD,WAAW,2DAA2D,CAAC,CAAC;SAC5L;KACF;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 { ElementProperties } from \"./ElementProperties\";\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, ContentDescriptorRequestOptions, ContentInstanceKeysRequestOptions, ContentRequestOptions,\n  ContentSourcesRequestOptions, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DistinctValuesRequestOptions,\n  FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, HierarchyLevelDescriptorRequestOptions, HierarchyRequestOptions,\n  Paged, RequestOptions, RequestOptionsWithRuleset, SelectionScopeRequestOptions, SingleElementPropertiesRequestOptions,\n} from \"./PresentationManagerOptions\";\nimport {\n  ContentSourcesRpcResult, PresentationRpcInterface, PresentationRpcRequestOptions, PresentationRpcResponse,\n} 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 { return RpcManager.getClientForInterface(PresentationRpcInterface); }\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: return response.result!;\n          case PresentationStatus.BackendTimeout: break;\n          default: 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    return this.request<number, typeof options>(\n      this.rpcClient.getNodesCount.bind(this.rpcClient), options);\n  }\n  // eslint-disable-next-line deprecation/deprecation\n  public async getPagedNodes(options: Paged<HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON>> & ClientDiagnosticsAttribute): Promise<PagedResponse<NodeJSON>> {\n    // eslint-disable-next-line deprecation/deprecation\n    return this.request<PagedResponse<NodeJSON>, typeof options>(\n      this.rpcClient.getPagedNodes.bind(this.rpcClient), options);\n  }\n\n  public async getNodesDescriptor(options: HierarchyLevelDescriptorRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined> {\n    const response = await this.request<string | DescriptorJSON | undefined, typeof options>(\n      this.rpcClient.getNodesDescriptor.bind(this.rpcClient), options);\n    if (typeof response === \"string\")\n      return JSON.parse(response);\n    return response;\n  }\n\n  // eslint-disable-next-line deprecation/deprecation\n  public async getNodePaths(options: FilterByInstancePathsHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]> {\n    // eslint-disable-next-line deprecation/deprecation\n    return this.request<NodePathElementJSON[], typeof options>(\n      this.rpcClient.getNodePaths.bind(this.rpcClient), options);\n  }\n  // eslint-disable-next-line deprecation/deprecation\n  public async getFilteredNodePaths(options: FilterByTextHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]> {\n    // eslint-disable-next-line deprecation/deprecation\n    return this.request<NodePathElementJSON[], typeof options>(\n      this.rpcClient.getFilteredNodePaths.bind(this.rpcClient), options);\n  }\n\n  public async getContentSources(options: ContentSourcesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ContentSourcesRpcResult> {\n    return this.request<ContentSourcesRpcResult, typeof options>(\n      this.rpcClient.getContentSources.bind(this.rpcClient), options);\n  }\n  public async getContentDescriptor(options: ContentDescriptorRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined> {\n    return this.request<DescriptorJSON | undefined, typeof options>(\n      this.rpcClient.getContentDescriptor.bind(this.rpcClient), options);\n  }\n  public async getContentSetSize(options: ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number> {\n    return this.request<number, typeof options>(\n      this.rpcClient.getContentSetSize.bind(this.rpcClient), options);\n  }\n  public async getPagedContent(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>) {\n    return this.request<{ descriptor: DescriptorJSON, contentSet: PagedResponse<ItemJSON> } | undefined, typeof options>(\n      this.rpcClient.getPagedContent.bind(this.rpcClient), options);\n  }\n  public async getPagedContentSet(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>) {\n    return this.request<PagedResponse<ItemJSON>, typeof options>(\n      this.rpcClient.getPagedContentSet.bind(this.rpcClient), options);\n  }\n\n  // eslint-disable-next-line deprecation/deprecation\n  public async getPagedDistinctValues(options: DistinctValuesRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<PagedResponse<DisplayValueGroupJSON>> {\n    // eslint-disable-next-line deprecation/deprecation\n    return this.request<PagedResponse<DisplayValueGroupJSON>, typeof options>(\n      this.rpcClient.getPagedDistinctValues.bind(this.rpcClient), options);\n  }\n\n  public async getElementProperties(options: SingleElementPropertiesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ElementProperties | undefined> {\n    return this.request<ElementProperties | undefined, typeof options>(\n      this.rpcClient.getElementProperties.bind(this.rpcClient), options);\n  }\n\n  public async getContentInstanceKeys(options: ContentInstanceKeysRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<{ total: number, items: KeySetJSON }> {\n    return this.request<{ total: number, items: KeySetJSON }, typeof options>(\n      this.rpcClient.getContentInstanceKeys.bind(this.rpcClient), options);\n  }\n\n  public async getDisplayLabelDefinition(options: DisplayLabelRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute): Promise<LabelDefinition> {\n    return this.request<LabelDefinition, typeof options>(\n      this.rpcClient.getDisplayLabelDefinition.bind(this.rpcClient), options);\n  }\n  public async getPagedDisplayLabelDefinitions(options: DisplayLabelsRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute): Promise<PagedResponse<LabelDefinition>> {\n    return this.request<PagedResponse<LabelDefinition>, typeof options>(\n      this.rpcClient.getPagedDisplayLabelDefinitions.bind(this.rpcClient), options);\n  }\n\n  public async getSelectionScopes(options: SelectionScopeRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<SelectionScope[]> {\n    return this.request<SelectionScope[], typeof options>(\n      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 deprecation/deprecation\n      this.rpcClient.computeSelection.bind(this.rpcClient), options);\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(PresentationCommonLoggerCategory.Package, `Provided ruleset contains unrecognized attribute '${propertyKey}'. It either doesn't exist or may be no longer supported.`);\n    }\n  }\n\n  return cleanedUpRuleset;\n}\n"]}
+{"version":3,"file":"RpcRequestsHandler.js","sourceRoot":"","sources":["../../../src/presentation-common/RpcRequestsHandler.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;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;AAO1E,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAYhE,OAAO,EACoB,wBAAwB,GAClD,MAAM,4BAA4B,CAAC;AAMpC;;;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,KAA+B,OAAO,UAAU,CAAC,qBAAqB,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC;IAEhH,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;YACrC,IAAI;gBACF,MAAM,QAAQ,GAAG,MAAM,IAAI,EAAE,CAAC;gBAC9B,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;gBACnC,QAAQ,QAAQ,CAAC,UAAU,EAAE;oBAC3B,KAAK,kBAAkB,CAAC,OAAO,CAAC,CAAC,OAAO,QAAQ,CAAC,MAAO,CAAC;oBACzD,KAAK,kBAAkB,CAAC,cAAc,CAAC,CAAC,MAAM;oBAC9C,OAAO,CAAC,CAAC,MAAM,IAAI,iBAAiB,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;iBAClF;aACF;oBAAS;gBACR,kBAAkB,IAAI,WAAW,IAAI,kBAAkB,CAAC,WAAW,CAAC,CAAC;aACtE;SACF;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;YACzC,eAAe,CAAC,WAAW,GAAG,cAAc,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;SAC3E;QACD,MAAM,UAAU,GAA4C;YAC1D,GAAG,eAAe;YAClB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;QACF,IAAI,WAAW,EAAE;YACf,UAAU,CAAC,WAAW,GAAG,kBAAkB,CAAC;SAC7C;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,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IACD,mDAAmD;IAC5C,KAAK,CAAC,aAAa,CAAC,OAAkH;QAC3I,mDAAmD;QACnD,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,OAA0H;QACxJ,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;QACnE,IAAI,OAAO,QAAQ,KAAK,QAAQ;YAC9B,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,mDAAmD;IAC5C,KAAK,CAAC,YAAY,CAAC,OAAuH;QAC/I,mDAAmD;QACnD,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IACD,mDAAmD;IAC5C,KAAK,CAAC,oBAAoB,CAAC,OAA8G;QAC9I,mDAAmD;QACnD,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,OAAkF;QAC/G,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IACM,KAAK,CAAC,oBAAoB,CAAC,OAAsH;QACtJ,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IACM,KAAK,CAAC,iBAAiB,CAAC,OAAiI;QAC9J,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IACM,KAAK,CAAC,eAAe,CAAC,OAAwI;QACnK,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IACM,KAAK,CAAC,kBAAkB,CAAC,OAAwI;QACtK,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED,mDAAmD;IAC5C,KAAK,CAAC,sBAAsB,CAAC,OAAwI;QAC1K,mDAAmD;QACnD,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,OAA2F;QAC3H,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAEM,KAAK,CAAC,sBAAsB,CAAC,OAAwH;QAC1J,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,OAA6F;QAClI,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IACM,KAAK,CAAC,+BAA+B,CAAC,OAA8F;QACzI,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,+BAA+B,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,OAAkF;QAChH,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IACM,KAAK,CAAC,gBAAgB,CAAC,OAAoF;QAChH,OAAO,IAAI,CAAC,OAAO;QACjB,mDAAmD;QACnD,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AAED,SAAS,oBAAoB,CAAC,OAAe;IAC3C,OAAO,CAAC,OAAQ,OAA+C,CAAC,WAAW,KAAK,QAAQ,CAAC,CAAC;AAC5F,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;QACvD,IAAI,CAAC,gCAAgC,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE;YACjE,IAAI,WAAW,KAAK,SAAS;gBAC3B,OAAQ,gBAAwB,CAAC,WAAW,CAAC,CAAC;;gBAE9C,MAAM,CAAC,UAAU,CAAC,gCAAgC,CAAC,OAAO,EAAE,qDAAqD,WAAW,2DAA2D,CAAC,CAAC;SAC5L;KACF;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 { ElementProperties } from \"./ElementProperties\";\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, ContentDescriptorRequestOptions, ContentInstanceKeysRequestOptions, ContentRequestOptions,\r\n  ContentSourcesRequestOptions, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DistinctValuesRequestOptions,\r\n  FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, HierarchyLevelDescriptorRequestOptions, HierarchyRequestOptions,\r\n  Paged, RequestOptions, RequestOptionsWithRuleset, SelectionScopeRequestOptions, SingleElementPropertiesRequestOptions,\r\n} from \"./PresentationManagerOptions\";\r\nimport {\r\n  ContentSourcesRpcResult, PresentationRpcInterface, PresentationRpcRequestOptions, PresentationRpcResponse,\r\n} 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 { return RpcManager.getClientForInterface(PresentationRpcInterface); }\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: return response.result!;\r\n          case PresentationStatus.BackendTimeout: break;\r\n          default: 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    return this.request<number, typeof options>(\r\n      this.rpcClient.getNodesCount.bind(this.rpcClient), options);\r\n  }\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  public async getPagedNodes(options: Paged<HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON>> & ClientDiagnosticsAttribute): Promise<PagedResponse<NodeJSON>> {\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return this.request<PagedResponse<NodeJSON>, typeof options>(\r\n      this.rpcClient.getPagedNodes.bind(this.rpcClient), options);\r\n  }\r\n\r\n  public async getNodesDescriptor(options: HierarchyLevelDescriptorRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined> {\r\n    const response = await this.request<string | DescriptorJSON | undefined, typeof options>(\r\n      this.rpcClient.getNodesDescriptor.bind(this.rpcClient), options);\r\n    if (typeof response === \"string\")\r\n      return JSON.parse(response);\r\n    return response;\r\n  }\r\n\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  public async getNodePaths(options: FilterByInstancePathsHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]> {\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return this.request<NodePathElementJSON[], typeof options>(\r\n      this.rpcClient.getNodePaths.bind(this.rpcClient), options);\r\n  }\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  public async getFilteredNodePaths(options: FilterByTextHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]> {\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return this.request<NodePathElementJSON[], typeof options>(\r\n      this.rpcClient.getFilteredNodePaths.bind(this.rpcClient), options);\r\n  }\r\n\r\n  public async getContentSources(options: ContentSourcesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ContentSourcesRpcResult> {\r\n    return this.request<ContentSourcesRpcResult, typeof options>(\r\n      this.rpcClient.getContentSources.bind(this.rpcClient), options);\r\n  }\r\n  public async getContentDescriptor(options: ContentDescriptorRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined> {\r\n    return this.request<DescriptorJSON | undefined, typeof options>(\r\n      this.rpcClient.getContentDescriptor.bind(this.rpcClient), options);\r\n  }\r\n  public async getContentSetSize(options: ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number> {\r\n    return this.request<number, typeof options>(\r\n      this.rpcClient.getContentSetSize.bind(this.rpcClient), options);\r\n  }\r\n  public async getPagedContent(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>) {\r\n    return this.request<{ descriptor: DescriptorJSON, contentSet: PagedResponse<ItemJSON> } | undefined, typeof options>(\r\n      this.rpcClient.getPagedContent.bind(this.rpcClient), options);\r\n  }\r\n  public async getPagedContentSet(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>) {\r\n    return this.request<PagedResponse<ItemJSON>, typeof options>(\r\n      this.rpcClient.getPagedContentSet.bind(this.rpcClient), options);\r\n  }\r\n\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  public async getPagedDistinctValues(options: DistinctValuesRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<PagedResponse<DisplayValueGroupJSON>> {\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return this.request<PagedResponse<DisplayValueGroupJSON>, typeof options>(\r\n      this.rpcClient.getPagedDistinctValues.bind(this.rpcClient), options);\r\n  }\r\n\r\n  public async getElementProperties(options: SingleElementPropertiesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ElementProperties | undefined> {\r\n    return this.request<ElementProperties | undefined, typeof options>(\r\n      this.rpcClient.getElementProperties.bind(this.rpcClient), options);\r\n  }\r\n\r\n  public async getContentInstanceKeys(options: ContentInstanceKeysRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<{ total: number, items: KeySetJSON }> {\r\n    return this.request<{ total: number, items: KeySetJSON }, typeof options>(\r\n      this.rpcClient.getContentInstanceKeys.bind(this.rpcClient), options);\r\n  }\r\n\r\n  public async getDisplayLabelDefinition(options: DisplayLabelRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute): Promise<LabelDefinition> {\r\n    return this.request<LabelDefinition, typeof options>(\r\n      this.rpcClient.getDisplayLabelDefinition.bind(this.rpcClient), options);\r\n  }\r\n  public async getPagedDisplayLabelDefinitions(options: DisplayLabelsRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute): Promise<PagedResponse<LabelDefinition>> {\r\n    return this.request<PagedResponse<LabelDefinition>, typeof options>(\r\n      this.rpcClient.getPagedDisplayLabelDefinitions.bind(this.rpcClient), options);\r\n  }\r\n\r\n  public async getSelectionScopes(options: SelectionScopeRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<SelectionScope[]> {\r\n    return this.request<SelectionScope[], typeof options>(\r\n      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 deprecation/deprecation\r\n      this.rpcClient.computeSelection.bind(this.rpcClient), options);\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(PresentationCommonLoggerCategory.Package, `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  return cleanedUpRuleset;\r\n}\r\n"]}

package/lib/esm/presentation-common/RulesetVariables.d.ts

@@ -1,172 +1,172 @@
-/** @packageDocumentation
- * @module Core
- */
-import { CompressedId64Set, Id64String } from "@itwin/core-bentley";
-/**
- * Possible variable value types
- * @public
- */
-export declare enum VariableValueTypes {
-    /** Integer value */
-    Int = "int",
-    /** Array of integer values */
-    IntArray = "int[]",
-    /** Boolean value */
-    Bool = "bool",
-    /** String value */
-    String = "string",
-    /** Id64String value */
-    Id64 = "id64",
-    /** Array of Id64String values */
-    Id64Array = "id64[]"
-}
-/**
- * Union of all supported variable value types
- * @public
- */
-export declare type VariableValue = boolean | string | number | number[] | Id64String | Id64String[];
-/**
- * JSON representation of [[VariableValue]]
- * @public
- */
-export declare type VariableValueJSON = boolean | string | number | number[] | Id64String | Id64String[] | CompressedId64Set;
-/**
- * Base data structure for representing ruleset variables.
- * @public
- */
-export interface RulesetVariableBase {
-    id: string;
-    type: VariableValueTypes;
-    value: VariableValue;
-}
-/**
- * Data structure for representing boolean ruleset variables.
- * @public
- */
-export interface BooleanRulesetVariable extends RulesetVariableBase {
-    type: VariableValueTypes.Bool;
-    value: boolean;
-}
-/**
- * Data structure for representing string ruleset variables.
- * @public
- */
-export interface StringRulesetVariable extends RulesetVariableBase {
-    type: VariableValueTypes.String;
-    value: string;
-}
-/**
- * Data structure for representing int ruleset variables.
- * @public
- */
-export interface IntRulesetVariable extends RulesetVariableBase {
-    type: VariableValueTypes.Int;
-    value: number;
-}
-/**
- * Data structure for representing int array ruleset variables.
- * @public
- */
-export interface IntsRulesetVariable extends RulesetVariableBase {
-    type: VariableValueTypes.IntArray;
-    value: number[];
-}
-/**
- * Data structure for representing ID ruleset variables.
- * @public
- */
-export interface Id64RulesetVariable extends RulesetVariableBase {
-    type: VariableValueTypes.Id64;
-    value: Id64String;
-}
-/**
- * Data structure for representing ID array ruleset variables.
- * @public
- */
-export interface Id64sRulesetVariable extends RulesetVariableBase {
-    type: VariableValueTypes.Id64Array;
-    value: Id64String[];
-}
-/**
- * Data structure for representing ruleset variables.
- * @public
- */
-export declare type RulesetVariable = BooleanRulesetVariable | StringRulesetVariable | IntRulesetVariable | IntsRulesetVariable | Id64RulesetVariable | Id64sRulesetVariable;
-/**
- * JSON representation of [[RulesetVariableBase]].
- * @public
- */
-export interface RulesetVariableBaseJSON {
-    id: string;
-    type: VariableValueTypes;
-    value: VariableValueJSON;
-}
-/**
- * JSON representation of [[BooleanRulesetVariable]].
- * @public
- * @deprecated in 3.x. Use [[BooleanRulesetVariable]]
- */
-export interface BooleanRulesetVariableJSON extends RulesetVariableBaseJSON {
-    type: VariableValueTypes.Bool;
-    value: boolean;
-}
-/**
- * JSON representation of [[StringRulesetVariable]].
- * @public
- * @deprecated in 3.x. Use [[StringRulesetVariable]]
- */
-export interface StringRulesetVariableJSON extends RulesetVariableBaseJSON {
-    type: VariableValueTypes.String;
-    value: string;
-}
-/**
- * JSON representation of [[IntRulesetVariable]].
- * @public
- * @deprecated in 3.x. Use [[IntRulesetVariable]]
- */
-export interface IntRulesetVariableJSON extends RulesetVariableBaseJSON {
-    type: VariableValueTypes.Int;
-    value: number;
-}
-/**
- * JSON representation of [[IntsRulesetVariable]].
- * @public
- * @deprecated in 3.x. Use [[IntsRulesetVariable]]
- */
-export interface IntsRulesetVariableJSON extends RulesetVariableBaseJSON {
-    type: VariableValueTypes.IntArray;
-    value: number[];
-}
-/**
- * JSON representation of [[Id64RulesetVariable]].
- * @public
- * @deprecated in 3.x. Use [[Id64RulesetVariable]]
- */
-export interface Id64RulesetVariableJSON extends RulesetVariableBaseJSON {
-    type: VariableValueTypes.Id64;
-    value: Id64String;
-}
-/**
- * JSON representation of [[Id64sRulesetVariable]].
- * @public
- */
-export interface Id64sRulesetVariableJSON extends RulesetVariableBaseJSON {
-    type: VariableValueTypes.Id64Array;
-    value: Id64String[] | CompressedId64Set;
-}
-/**
- * JSON representation of [[RulesetVariable]].
- * @public
- */
-export declare type RulesetVariableJSON = BooleanRulesetVariableJSON | StringRulesetVariableJSON | IntRulesetVariableJSON | IntsRulesetVariableJSON | Id64RulesetVariableJSON | Id64sRulesetVariableJSON;
-/** @public */
-export declare namespace RulesetVariable {
-    /**
-     * Serialize given RulesetVariable to JSON.
-     * Note: In case of [[Id64sRulesetVariable]], this method expects IDs are sorted. See [[OrderedId64Iterable.sortArray]].
-     */
-    function toJSON(variable: RulesetVariable): RulesetVariableJSON;
-    /** Deserialize [[RulesetVariable]] from JSON. */
-    function fromJSON(json: RulesetVariableJSON): RulesetVariable;
-}
+/** @packageDocumentation
+ * @module Core
+ */
+import { CompressedId64Set, Id64String } from "@itwin/core-bentley";
+/**
+ * Possible variable value types
+ * @public
+ */
+export declare enum VariableValueTypes {
+    /** Integer value */
+    Int = "int",
+    /** Array of integer values */
+    IntArray = "int[]",
+    /** Boolean value */
+    Bool = "bool",
+    /** String value */
+    String = "string",
+    /** Id64String value */
+    Id64 = "id64",
+    /** Array of Id64String values */
+    Id64Array = "id64[]"
+}
+/**
+ * Union of all supported variable value types
+ * @public
+ */
+export declare type VariableValue = boolean | string | number | number[] | Id64String | Id64String[];
+/**
+ * JSON representation of [[VariableValue]]
+ * @public
+ */
+export declare type VariableValueJSON = boolean | string | number | number[] | Id64String | Id64String[] | CompressedId64Set;
+/**
+ * Base data structure for representing ruleset variables.
+ * @public
+ */
+export interface RulesetVariableBase {
+    id: string;
+    type: VariableValueTypes;
+    value: VariableValue;
+}
+/**
+ * Data structure for representing boolean ruleset variables.
+ * @public
+ */
+export interface BooleanRulesetVariable extends RulesetVariableBase {
+    type: VariableValueTypes.Bool;
+    value: boolean;
+}
+/**
+ * Data structure for representing string ruleset variables.
+ * @public
+ */
+export interface StringRulesetVariable extends RulesetVariableBase {
+    type: VariableValueTypes.String;
+    value: string;
+}
+/**
+ * Data structure for representing int ruleset variables.
+ * @public
+ */
+export interface IntRulesetVariable extends RulesetVariableBase {
+    type: VariableValueTypes.Int;
+    value: number;
+}
+/**
+ * Data structure for representing int array ruleset variables.
+ * @public
+ */
+export interface IntsRulesetVariable extends RulesetVariableBase {
+    type: VariableValueTypes.IntArray;
+    value: number[];
+}
+/**
+ * Data structure for representing ID ruleset variables.
+ * @public
+ */
+export interface Id64RulesetVariable extends RulesetVariableBase {
+    type: VariableValueTypes.Id64;
+    value: Id64String;
+}
+/**
+ * Data structure for representing ID array ruleset variables.
+ * @public
+ */
+export interface Id64sRulesetVariable extends RulesetVariableBase {
+    type: VariableValueTypes.Id64Array;
+    value: Id64String[];
+}
+/**
+ * Data structure for representing ruleset variables.
+ * @public
+ */
+export declare type RulesetVariable = BooleanRulesetVariable | StringRulesetVariable | IntRulesetVariable | IntsRulesetVariable | Id64RulesetVariable | Id64sRulesetVariable;
+/**
+ * JSON representation of [[RulesetVariableBase]].
+ * @public
+ */
+export interface RulesetVariableBaseJSON {
+    id: string;
+    type: VariableValueTypes;
+    value: VariableValueJSON;
+}
+/**
+ * JSON representation of [[BooleanRulesetVariable]].
+ * @public
+ * @deprecated in 3.x. Use [[BooleanRulesetVariable]]
+ */
+export interface BooleanRulesetVariableJSON extends RulesetVariableBaseJSON {
+    type: VariableValueTypes.Bool;
+    value: boolean;
+}
+/**
+ * JSON representation of [[StringRulesetVariable]].
+ * @public
+ * @deprecated in 3.x. Use [[StringRulesetVariable]]
+ */
+export interface StringRulesetVariableJSON extends RulesetVariableBaseJSON {
+    type: VariableValueTypes.String;
+    value: string;
+}
+/**
+ * JSON representation of [[IntRulesetVariable]].
+ * @public
+ * @deprecated in 3.x. Use [[IntRulesetVariable]]
+ */
+export interface IntRulesetVariableJSON extends RulesetVariableBaseJSON {
+    type: VariableValueTypes.Int;
+    value: number;
+}
+/**
+ * JSON representation of [[IntsRulesetVariable]].
+ * @public
+ * @deprecated in 3.x. Use [[IntsRulesetVariable]]
+ */
+export interface IntsRulesetVariableJSON extends RulesetVariableBaseJSON {
+    type: VariableValueTypes.IntArray;
+    value: number[];
+}
+/**
+ * JSON representation of [[Id64RulesetVariable]].
+ * @public
+ * @deprecated in 3.x. Use [[Id64RulesetVariable]]
+ */
+export interface Id64RulesetVariableJSON extends RulesetVariableBaseJSON {
+    type: VariableValueTypes.Id64;
+    value: Id64String;
+}
+/**
+ * JSON representation of [[Id64sRulesetVariable]].
+ * @public
+ */
+export interface Id64sRulesetVariableJSON extends RulesetVariableBaseJSON {
+    type: VariableValueTypes.Id64Array;
+    value: Id64String[] | CompressedId64Set;
+}
+/**
+ * JSON representation of [[RulesetVariable]].
+ * @public
+ */
+export declare type RulesetVariableJSON = BooleanRulesetVariableJSON | StringRulesetVariableJSON | IntRulesetVariableJSON | IntsRulesetVariableJSON | Id64RulesetVariableJSON | Id64sRulesetVariableJSON;
+/** @public */
+export declare namespace RulesetVariable {
+    /**
+     * Serialize given RulesetVariable to JSON.
+     * Note: In case of [[Id64sRulesetVariable]], this method expects IDs are sorted. See [[OrderedId64Iterable.sortArray]].
+     */
+    function toJSON(variable: RulesetVariable): RulesetVariableJSON;
+    /** Deserialize [[RulesetVariable]] from JSON. */
+    function fromJSON(json: RulesetVariableJSON): RulesetVariable;
+}
 //# sourceMappingURL=RulesetVariables.d.ts.map

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

@@ -1,53 +1,53 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Core
- */
-import { CompressedId64Set } from "@itwin/core-bentley";
-/**
- * Possible variable value types
- * @public
- */
-export var VariableValueTypes;
-(function (VariableValueTypes) {
-    /** Integer value */
-    VariableValueTypes["Int"] = "int";
-    /** Array of integer values */
-    VariableValueTypes["IntArray"] = "int[]";
-    /** Boolean value */
-    VariableValueTypes["Bool"] = "bool";
-    /** String value */
-    VariableValueTypes["String"] = "string";
-    /** Id64String value */
-    VariableValueTypes["Id64"] = "id64";
-    /** Array of Id64String values */
-    VariableValueTypes["Id64Array"] = "id64[]";
-})(VariableValueTypes || (VariableValueTypes = {}));
-/** @public */
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export var RulesetVariable;
-(function (RulesetVariable) {
-    /**
-     * Serialize given RulesetVariable to JSON.
-     * Note: In case of [[Id64sRulesetVariable]], this method expects IDs are sorted. See [[OrderedId64Iterable.sortArray]].
-     */
-    function toJSON(variable) {
-        if (variable.type === VariableValueTypes.Id64Array)
-            return { ...variable, value: CompressedId64Set.compressArray(variable.value) };
-        return variable;
-    }
-    RulesetVariable.toJSON = toJSON;
-    /** Deserialize [[RulesetVariable]] from JSON. */
-    function fromJSON(json) {
-        if (json.type === VariableValueTypes.Id64Array) {
-            if (typeof json.value === "string")
-                return { ...json, value: CompressedId64Set.decompressArray(json.value) };
-            return json; // for some reason TS doesn't understand that `json.value` is always an array here
-        }
-        return json;
-    }
-    RulesetVariable.fromJSON = fromJSON;
-})(RulesetVariable || (RulesetVariable = {}));
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Core
+ */
+import { CompressedId64Set } from "@itwin/core-bentley";
+/**
+ * Possible variable value types
+ * @public
+ */
+export var VariableValueTypes;
+(function (VariableValueTypes) {
+    /** Integer value */
+    VariableValueTypes["Int"] = "int";
+    /** Array of integer values */
+    VariableValueTypes["IntArray"] = "int[]";
+    /** Boolean value */
+    VariableValueTypes["Bool"] = "bool";
+    /** String value */
+    VariableValueTypes["String"] = "string";
+    /** Id64String value */
+    VariableValueTypes["Id64"] = "id64";
+    /** Array of Id64String values */
+    VariableValueTypes["Id64Array"] = "id64[]";
+})(VariableValueTypes || (VariableValueTypes = {}));
+/** @public */
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export var RulesetVariable;
+(function (RulesetVariable) {
+    /**
+     * Serialize given RulesetVariable to JSON.
+     * Note: In case of [[Id64sRulesetVariable]], this method expects IDs are sorted. See [[OrderedId64Iterable.sortArray]].
+     */
+    function toJSON(variable) {
+        if (variable.type === VariableValueTypes.Id64Array)
+            return { ...variable, value: CompressedId64Set.compressArray(variable.value) };
+        return variable;
+    }
+    RulesetVariable.toJSON = toJSON;
+    /** Deserialize [[RulesetVariable]] from JSON. */
+    function fromJSON(json) {
+        if (json.type === VariableValueTypes.Id64Array) {
+            if (typeof json.value === "string")
+                return { ...json, value: CompressedId64Set.decompressArray(json.value) };
+            return json; // for some reason TS doesn't understand that `json.value` is always an array here
+        }
+        return json;
+    }
+    RulesetVariable.fromJSON = fromJSON;
+})(RulesetVariable || (RulesetVariable = {}));
 //# sourceMappingURL=RulesetVariables.js.map

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;;;+FAG+F;AAC/F;;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;AAkJD,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,eAAe,CAoB/B;AApBD,WAAiB,eAAe;IAC9B;;;OAGG;IACH,SAAgB,MAAM,CAAC,QAAyB;QAC9C,IAAI,QAAQ,CAAC,IAAI,KAAK,kBAAkB,CAAC,SAAS;YAChD,OAAO,EAAE,GAAG,QAAQ,EAAE,KAAK,EAAE,iBAAiB,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACjF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAJe,sBAAM,SAIrB,CAAA;IAED,iDAAiD;IACjD,SAAgB,QAAQ,CAAC,IAAyB;QAChD,IAAI,IAAI,CAAC,IAAI,KAAK,kBAAkB,CAAC,SAAS,EAAE;YAC9C,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ;gBAChC,OAAO,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3E,OAAO,IAAW,CAAC,CAAC,kFAAkF;SACvG;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAPe,wBAAQ,WAOvB,CAAA;AACH,CAAC,EApBgB,eAAe,KAAf,eAAe,QAoB/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 = BooleanRulesetVariable | StringRulesetVariable | IntRulesetVariable | IntsRulesetVariable | Id64RulesetVariable | 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// eslint-disable-next-line deprecation/deprecation\nexport type RulesetVariableJSON = BooleanRulesetVariableJSON | StringRulesetVariableJSON | IntRulesetVariableJSON | IntsRulesetVariableJSON | Id64RulesetVariableJSON | 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    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      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;;;+FAG+F;AAC/F;;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;AAkJD,cAAc;AACd,2DAA2D;AAC3D,MAAM,KAAW,eAAe,CAoB/B;AApBD,WAAiB,eAAe;IAC9B;;;OAGG;IACH,SAAgB,MAAM,CAAC,QAAyB;QAC9C,IAAI,QAAQ,CAAC,IAAI,KAAK,kBAAkB,CAAC,SAAS;YAChD,OAAO,EAAE,GAAG,QAAQ,EAAE,KAAK,EAAE,iBAAiB,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACjF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAJe,sBAAM,SAIrB,CAAA;IAED,iDAAiD;IACjD,SAAgB,QAAQ,CAAC,IAAyB;QAChD,IAAI,IAAI,CAAC,IAAI,KAAK,kBAAkB,CAAC,SAAS,EAAE;YAC9C,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ;gBAChC,OAAO,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3E,OAAO,IAAW,CAAC,CAAC,kFAAkF;SACvG;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAPe,wBAAQ,WAOvB,CAAA;AACH,CAAC,EApBgB,eAAe,KAAf,eAAe,QAoB/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 = BooleanRulesetVariable | StringRulesetVariable | IntRulesetVariable | IntsRulesetVariable | Id64RulesetVariable | 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// eslint-disable-next-line deprecation/deprecation\r\nexport type RulesetVariableJSON = BooleanRulesetVariableJSON | StringRulesetVariableJSON | IntRulesetVariableJSON | IntsRulesetVariableJSON | Id64RulesetVariableJSON | 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    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      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"]}