@itwin/presentation-common 4.0.0-dev.52 → 4.0.0-dev.55
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/cjs/presentation-common/AsyncTasks.d.ts +22 -22
- package/lib/cjs/presentation-common/AsyncTasks.js +38 -38
- package/lib/cjs/presentation-common/CommonLoggerCategory.d.ts +12 -12
- package/lib/cjs/presentation-common/CommonLoggerCategory.js +20 -20
- package/lib/cjs/presentation-common/Diagnostics.d.ts +125 -125
- package/lib/cjs/presentation-common/Diagnostics.d.ts.map +1 -1
- package/lib/cjs/presentation-common/Diagnostics.js +72 -72
- package/lib/cjs/presentation-common/EC.d.ts +350 -350
- package/lib/cjs/presentation-common/EC.d.ts.map +1 -1
- package/lib/cjs/presentation-common/EC.js +290 -290
- package/lib/cjs/presentation-common/ElementProperties.d.ts +123 -123
- package/lib/cjs/presentation-common/ElementProperties.d.ts.map +1 -1
- package/lib/cjs/presentation-common/ElementProperties.js +9 -9
- package/lib/cjs/presentation-common/Error.d.ts +47 -47
- package/lib/cjs/presentation-common/Error.js +64 -64
- package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts +93 -93
- package/lib/cjs/presentation-common/InstanceFilterDefinition.d.ts.map +1 -1
- package/lib/cjs/presentation-common/InstanceFilterDefinition.js +9 -9
- package/lib/cjs/presentation-common/KeySet.d.ts +146 -146
- package/lib/cjs/presentation-common/KeySet.d.ts.map +1 -1
- package/lib/cjs/presentation-common/KeySet.js +428 -428
- package/lib/cjs/presentation-common/LabelDefinition.d.ts +93 -93
- package/lib/cjs/presentation-common/LabelDefinition.d.ts.map +1 -1
- package/lib/cjs/presentation-common/LabelDefinition.js +78 -78
- package/lib/cjs/presentation-common/LocalizationHelper.d.ts +29 -29
- package/lib/cjs/presentation-common/LocalizationHelper.js +110 -110
- package/lib/cjs/presentation-common/PresentationIpcInterface.d.ts +40 -40
- package/lib/cjs/presentation-common/PresentationIpcInterface.js +12 -12
- package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts +273 -273
- package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts.map +1 -1
- package/lib/cjs/presentation-common/PresentationManagerOptions.js +23 -23
- package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts +186 -186
- package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts.map +1 -1
- package/lib/cjs/presentation-common/PresentationRpcInterface.js +108 -104
- package/lib/cjs/presentation-common/PresentationRpcInterface.js.map +1 -1
- package/lib/cjs/presentation-common/PropertyFormatter.d.ts +30 -30
- package/lib/cjs/presentation-common/PropertyFormatter.js +198 -198
- package/lib/cjs/presentation-common/RegisteredRuleset.d.ts +26 -26
- package/lib/cjs/presentation-common/RegisteredRuleset.js +33 -33
- package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts +82 -82
- package/lib/cjs/presentation-common/RpcRequestsHandler.js +166 -166
- package/lib/cjs/presentation-common/RulesetVariables.d.ts +171 -171
- package/lib/cjs/presentation-common/RulesetVariables.d.ts.map +1 -1
- package/lib/cjs/presentation-common/RulesetVariables.js +55 -55
- package/lib/cjs/presentation-common/RulesetsFactory.d.ts +44 -44
- package/lib/cjs/presentation-common/RulesetsFactory.d.ts.map +1 -1
- package/lib/cjs/presentation-common/RulesetsFactory.js +223 -223
- package/lib/cjs/presentation-common/Update.d.ts +213 -213
- package/lib/cjs/presentation-common/Update.d.ts.map +1 -1
- package/lib/cjs/presentation-common/Update.js +226 -226
- package/lib/cjs/presentation-common/Utils.d.ts +62 -62
- package/lib/cjs/presentation-common/Utils.d.ts.map +1 -1
- package/lib/cjs/presentation-common/Utils.js +43 -43
- package/lib/cjs/presentation-common/content/Category.d.ts +49 -49
- package/lib/cjs/presentation-common/content/Category.js +48 -48
- package/lib/cjs/presentation-common/content/Content.d.ts +38 -38
- package/lib/cjs/presentation-common/content/Content.js +56 -56
- package/lib/cjs/presentation-common/content/ContentTraverser.d.ts +271 -271
- package/lib/cjs/presentation-common/content/ContentTraverser.js +437 -437
- package/lib/cjs/presentation-common/content/Descriptor.d.ts +328 -328
- package/lib/cjs/presentation-common/content/Descriptor.js +191 -191
- package/lib/cjs/presentation-common/content/DisplayTypes.d.ts +21 -21
- package/lib/cjs/presentation-common/content/DisplayTypes.js +29 -29
- package/lib/cjs/presentation-common/content/Editor.d.ts +15 -15
- package/lib/cjs/presentation-common/content/Editor.js +9 -9
- package/lib/cjs/presentation-common/content/Fields.d.ts +298 -298
- package/lib/cjs/presentation-common/content/Fields.d.ts.map +1 -1
- package/lib/cjs/presentation-common/content/Fields.js +393 -393
- package/lib/cjs/presentation-common/content/Item.d.ts +85 -85
- package/lib/cjs/presentation-common/content/Item.js +84 -84
- package/lib/cjs/presentation-common/content/Property.d.ts +57 -57
- package/lib/cjs/presentation-common/content/Property.d.ts.map +1 -1
- package/lib/cjs/presentation-common/content/Property.js +40 -40
- package/lib/cjs/presentation-common/content/Renderer.d.ts +11 -11
- package/lib/cjs/presentation-common/content/Renderer.js +9 -9
- package/lib/cjs/presentation-common/content/TypeDescription.d.ts +72 -72
- package/lib/cjs/presentation-common/content/TypeDescription.d.ts.map +1 -1
- package/lib/cjs/presentation-common/content/TypeDescription.js +23 -23
- package/lib/cjs/presentation-common/content/Value.d.ts +189 -189
- package/lib/cjs/presentation-common/content/Value.d.ts.map +1 -1
- package/lib/cjs/presentation-common/content/Value.js +273 -273
- package/lib/cjs/presentation-common/hierarchy/HierarchyLevel.d.ts +37 -37
- package/lib/cjs/presentation-common/hierarchy/HierarchyLevel.js +31 -31
- package/lib/cjs/presentation-common/hierarchy/Key.d.ts +246 -246
- package/lib/cjs/presentation-common/hierarchy/Key.d.ts.map +1 -1
- package/lib/cjs/presentation-common/hierarchy/Key.js +121 -121
- package/lib/cjs/presentation-common/hierarchy/Node.d.ts +154 -154
- package/lib/cjs/presentation-common/hierarchy/Node.d.ts.map +1 -1
- package/lib/cjs/presentation-common/hierarchy/Node.js +106 -106
- package/lib/cjs/presentation-common/hierarchy/NodePathElement.d.ts +96 -96
- package/lib/cjs/presentation-common/hierarchy/NodePathElement.js +122 -122
- package/lib/cjs/presentation-common/rules/ClassSpecifications.d.ts +45 -45
- package/lib/cjs/presentation-common/rules/ClassSpecifications.js +9 -9
- package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
- package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/RelationshipDirection.d.ts +13 -13
- package/lib/cjs/presentation-common/rules/RelationshipDirection.js +21 -21
- package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts +56 -56
- package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/Rule.d.ts +76 -76
- package/lib/cjs/presentation-common/rules/Rule.js +35 -35
- package/lib/cjs/presentation-common/rules/Ruleset.d.ts +65 -65
- package/lib/cjs/presentation-common/rules/Ruleset.js +9 -9
- package/lib/cjs/presentation-common/rules/SchemasSpecification.d.ts +41 -41
- package/lib/cjs/presentation-common/rules/SchemasSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/Variables.d.ts +58 -58
- package/lib/cjs/presentation-common/rules/Variables.js +25 -25
- package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
- package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
- package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/content/ContentRule.d.ts +30 -30
- package/lib/cjs/presentation-common/rules/content/ContentRule.js +9 -9
- package/lib/cjs/presentation-common/rules/content/ContentSpecification.d.ts +58 -58
- package/lib/cjs/presentation-common/rules/content/ContentSpecification.js +20 -20
- package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
- package/lib/cjs/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +9 -9
- package/lib/cjs/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
- package/lib/cjs/presentation-common/rules/content/PropertySpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
- package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
- package/lib/cjs/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
- package/lib/cjs/presentation-common/rules/content/modifiers/ContentModifier.js +9 -9
- package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
- package/lib/cjs/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
- package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +108 -108
- package/lib/cjs/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +21 -21
- package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +96 -96
- package/lib/cjs/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +43 -43
- package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
- package/lib/cjs/presentation-common/rules/customization/CheckBoxRule.js +9 -9
- package/lib/cjs/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
- package/lib/cjs/presentation-common/rules/customization/CustomizationRule.js +9 -9
- package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
- package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js +9 -9
- package/lib/cjs/presentation-common/rules/customization/GroupingRule.d.ts +207 -207
- package/lib/cjs/presentation-common/rules/customization/GroupingRule.js +51 -51
- package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
- package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js +9 -9
- package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts +158 -158
- package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js +25 -25
- package/lib/cjs/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
- package/lib/cjs/presentation-common/rules/customization/LabelOverride.js +9 -9
- package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts +58 -58
- package/lib/cjs/presentation-common/rules/customization/SortingRule.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/customization/SortingRule.js +9 -9
- package/lib/cjs/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
- package/lib/cjs/presentation-common/rules/customization/StyleOverride.js +9 -9
- package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +14 -14
- package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeRule.js +9 -9
- package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +98 -98
- package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js +21 -21
- package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
- package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +79 -79
- package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +19 -19
- package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
- package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
- package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts.map +1 -1
- package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js +9 -9
- package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
- package/lib/cjs/presentation-common/rules/hierarchy/NodeArtifactsRule.js +9 -9
- package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
- package/lib/cjs/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +9 -9
- package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.d.ts +16 -16
- package/lib/cjs/presentation-common/rules/hierarchy/RootNodeRule.js +9 -9
- package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.d.ts +35 -35
- package/lib/cjs/presentation-common/rules/hierarchy/SubCondition.js +9 -9
- package/lib/cjs/presentation-common/selection/SelectionScope.d.ts +38 -38
- package/lib/cjs/presentation-common/selection/SelectionScope.d.ts.map +1 -1
- package/lib/cjs/presentation-common/selection/SelectionScope.js +9 -9
- package/lib/cjs/presentation-common.d.ts +113 -113
- package/lib/cjs/presentation-common.js +133 -129
- package/lib/cjs/presentation-common.js.map +1 -1
- package/lib/esm/presentation-common/AsyncTasks.d.ts +22 -22
- package/lib/esm/presentation-common/AsyncTasks.js +34 -34
- package/lib/esm/presentation-common/CommonLoggerCategory.d.ts +12 -12
- package/lib/esm/presentation-common/CommonLoggerCategory.js +17 -17
- package/lib/esm/presentation-common/Diagnostics.d.ts +125 -125
- package/lib/esm/presentation-common/Diagnostics.d.ts.map +1 -1
- package/lib/esm/presentation-common/Diagnostics.js +67 -67
- package/lib/esm/presentation-common/EC.d.ts +350 -350
- package/lib/esm/presentation-common/EC.d.ts.map +1 -1
- package/lib/esm/presentation-common/EC.js +287 -287
- package/lib/esm/presentation-common/ElementProperties.d.ts +123 -123
- package/lib/esm/presentation-common/ElementProperties.d.ts.map +1 -1
- package/lib/esm/presentation-common/ElementProperties.js +8 -8
- package/lib/esm/presentation-common/Error.d.ts +47 -47
- package/lib/esm/presentation-common/Error.js +60 -60
- package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts +93 -93
- package/lib/esm/presentation-common/InstanceFilterDefinition.d.ts.map +1 -1
- package/lib/esm/presentation-common/InstanceFilterDefinition.js +8 -8
- package/lib/esm/presentation-common/KeySet.d.ts +146 -146
- package/lib/esm/presentation-common/KeySet.d.ts.map +1 -1
- package/lib/esm/presentation-common/KeySet.js +424 -424
- package/lib/esm/presentation-common/LabelDefinition.d.ts +93 -93
- package/lib/esm/presentation-common/LabelDefinition.d.ts.map +1 -1
- package/lib/esm/presentation-common/LabelDefinition.js +75 -75
- package/lib/esm/presentation-common/LocalizationHelper.d.ts +29 -29
- package/lib/esm/presentation-common/LocalizationHelper.js +106 -106
- package/lib/esm/presentation-common/PresentationIpcInterface.d.ts +40 -40
- package/lib/esm/presentation-common/PresentationIpcInterface.js +9 -9
- package/lib/esm/presentation-common/PresentationManagerOptions.d.ts +273 -273
- package/lib/esm/presentation-common/PresentationManagerOptions.d.ts.map +1 -1
- package/lib/esm/presentation-common/PresentationManagerOptions.js +18 -18
- package/lib/esm/presentation-common/PresentationRpcInterface.d.ts +186 -186
- package/lib/esm/presentation-common/PresentationRpcInterface.d.ts.map +1 -1
- package/lib/esm/presentation-common/PresentationRpcInterface.js +105 -100
- package/lib/esm/presentation-common/PresentationRpcInterface.js.map +1 -1
- package/lib/esm/presentation-common/PropertyFormatter.d.ts +30 -30
- package/lib/esm/presentation-common/PropertyFormatter.js +193 -193
- package/lib/esm/presentation-common/RegisteredRuleset.d.ts +26 -26
- package/lib/esm/presentation-common/RegisteredRuleset.js +29 -29
- package/lib/esm/presentation-common/RpcRequestsHandler.d.ts +82 -82
- package/lib/esm/presentation-common/RpcRequestsHandler.js +162 -162
- package/lib/esm/presentation-common/RulesetVariables.d.ts +171 -171
- package/lib/esm/presentation-common/RulesetVariables.d.ts.map +1 -1
- package/lib/esm/presentation-common/RulesetVariables.js +52 -52
- package/lib/esm/presentation-common/RulesetsFactory.d.ts +44 -44
- package/lib/esm/presentation-common/RulesetsFactory.d.ts.map +1 -1
- package/lib/esm/presentation-common/RulesetsFactory.js +219 -219
- package/lib/esm/presentation-common/Update.d.ts +213 -213
- package/lib/esm/presentation-common/Update.d.ts.map +1 -1
- package/lib/esm/presentation-common/Update.js +223 -223
- package/lib/esm/presentation-common/Utils.d.ts +62 -62
- package/lib/esm/presentation-common/Utils.d.ts.map +1 -1
- package/lib/esm/presentation-common/Utils.js +39 -39
- package/lib/esm/presentation-common/content/Category.d.ts +49 -49
- package/lib/esm/presentation-common/content/Category.js +45 -45
- package/lib/esm/presentation-common/content/Content.d.ts +38 -38
- package/lib/esm/presentation-common/content/Content.js +52 -52
- package/lib/esm/presentation-common/content/ContentTraverser.d.ts +271 -271
- package/lib/esm/presentation-common/content/ContentTraverser.js +427 -427
- package/lib/esm/presentation-common/content/Descriptor.d.ts +328 -328
- package/lib/esm/presentation-common/content/Descriptor.js +187 -187
- package/lib/esm/presentation-common/content/DisplayTypes.d.ts +21 -21
- package/lib/esm/presentation-common/content/DisplayTypes.js +26 -26
- package/lib/esm/presentation-common/content/Editor.d.ts +15 -15
- package/lib/esm/presentation-common/content/Editor.js +8 -8
- package/lib/esm/presentation-common/content/Fields.d.ts +298 -298
- package/lib/esm/presentation-common/content/Fields.d.ts.map +1 -1
- package/lib/esm/presentation-common/content/Fields.js +386 -386
- package/lib/esm/presentation-common/content/Item.d.ts +85 -85
- package/lib/esm/presentation-common/content/Item.js +80 -80
- package/lib/esm/presentation-common/content/Property.d.ts +57 -57
- package/lib/esm/presentation-common/content/Property.d.ts.map +1 -1
- package/lib/esm/presentation-common/content/Property.js +37 -37
- package/lib/esm/presentation-common/content/Renderer.d.ts +11 -11
- package/lib/esm/presentation-common/content/Renderer.js +8 -8
- package/lib/esm/presentation-common/content/TypeDescription.d.ts +72 -72
- package/lib/esm/presentation-common/content/TypeDescription.d.ts.map +1 -1
- package/lib/esm/presentation-common/content/TypeDescription.js +20 -20
- package/lib/esm/presentation-common/content/Value.d.ts +189 -189
- package/lib/esm/presentation-common/content/Value.d.ts.map +1 -1
- package/lib/esm/presentation-common/content/Value.js +270 -270
- package/lib/esm/presentation-common/hierarchy/HierarchyLevel.d.ts +37 -37
- package/lib/esm/presentation-common/hierarchy/HierarchyLevel.js +28 -28
- package/lib/esm/presentation-common/hierarchy/Key.d.ts +246 -246
- package/lib/esm/presentation-common/hierarchy/Key.d.ts.map +1 -1
- package/lib/esm/presentation-common/hierarchy/Key.js +118 -118
- package/lib/esm/presentation-common/hierarchy/Node.d.ts +154 -154
- package/lib/esm/presentation-common/hierarchy/Node.d.ts.map +1 -1
- package/lib/esm/presentation-common/hierarchy/Node.js +103 -103
- package/lib/esm/presentation-common/hierarchy/NodePathElement.d.ts +96 -96
- package/lib/esm/presentation-common/hierarchy/NodePathElement.js +119 -119
- package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts +45 -45
- package/lib/esm/presentation-common/rules/ClassSpecifications.js +8 -8
- package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts +31 -31
- package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/RelationshipDirection.d.ts +13 -13
- package/lib/esm/presentation-common/rules/RelationshipDirection.js +18 -18
- package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts +56 -56
- package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/Rule.d.ts +76 -76
- package/lib/esm/presentation-common/rules/Rule.js +32 -32
- package/lib/esm/presentation-common/rules/Ruleset.d.ts +65 -65
- package/lib/esm/presentation-common/rules/Ruleset.js +8 -8
- package/lib/esm/presentation-common/rules/SchemasSpecification.d.ts +41 -41
- package/lib/esm/presentation-common/rules/SchemasSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/Variables.d.ts +58 -58
- package/lib/esm/presentation-common/rules/Variables.js +22 -22
- package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +41 -41
- package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.d.ts +25 -25
- package/lib/esm/presentation-common/rules/content/ContentRelatedInstancesSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/content/ContentRule.d.ts +30 -30
- package/lib/esm/presentation-common/rules/content/ContentRule.js +8 -8
- package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts +58 -58
- package/lib/esm/presentation-common/rules/content/ContentSpecification.js +17 -17
- package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.d.ts +19 -19
- package/lib/esm/presentation-common/rules/content/DefaultPropertyCategoryOverride.js +8 -8
- package/lib/esm/presentation-common/rules/content/PropertySpecification.d.ts +86 -86
- package/lib/esm/presentation-common/rules/content/PropertySpecification.js +8 -8
- package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +28 -28
- package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts +25 -25
- package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.d.ts +57 -57
- package/lib/esm/presentation-common/rules/content/modifiers/ContentModifier.js +8 -8
- package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.d.ts +17 -17
- package/lib/esm/presentation-common/rules/content/modifiers/CustomRendererSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts +107 -107
- package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/content/modifiers/PropertyCategorySpecification.js +8 -8
- package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.d.ts +108 -108
- package/lib/esm/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.js +18 -18
- package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts +96 -96
- package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js +40 -40
- package/lib/esm/presentation-common/rules/customization/CheckBoxRule.d.ts +44 -44
- package/lib/esm/presentation-common/rules/customization/CheckBoxRule.js +8 -8
- package/lib/esm/presentation-common/rules/customization/CustomizationRule.d.ts +36 -36
- package/lib/esm/presentation-common/rules/customization/CustomizationRule.js +8 -8
- package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.d.ts +27 -27
- package/lib/esm/presentation-common/rules/customization/ExtendedDataRule.js +8 -8
- package/lib/esm/presentation-common/rules/customization/GroupingRule.d.ts +207 -207
- package/lib/esm/presentation-common/rules/customization/GroupingRule.js +48 -48
- package/lib/esm/presentation-common/rules/customization/ImageIdOverride.d.ts +29 -29
- package/lib/esm/presentation-common/rules/customization/ImageIdOverride.js +8 -8
- package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts +158 -158
- package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js +22 -22
- package/lib/esm/presentation-common/rules/customization/LabelOverride.d.ts +40 -40
- package/lib/esm/presentation-common/rules/customization/LabelOverride.js +8 -8
- package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts +58 -58
- package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/customization/SortingRule.js +8 -8
- package/lib/esm/presentation-common/rules/customization/StyleOverride.d.ts +48 -48
- package/lib/esm/presentation-common/rules/customization/StyleOverride.js +8 -8
- package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.d.ts +14 -14
- package/lib/esm/presentation-common/rules/hierarchy/ChildNodeRule.js +8 -8
- package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts +98 -98
- package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/ChildNodeSpecification.js +18 -18
- package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts +31 -31
- package/lib/esm/presentation-common/rules/hierarchy/CustomNodeSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts +79 -79
- package/lib/esm/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js +16 -16
- package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +39 -39
- package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts +50 -50
- package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.d.ts.map +1 -1
- package/lib/esm/presentation-common/rules/hierarchy/NavigationRule.js +8 -8
- package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.d.ts +27 -27
- package/lib/esm/presentation-common/rules/hierarchy/NodeArtifactsRule.js +8 -8
- package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.d.ts +27 -27
- package/lib/esm/presentation-common/rules/hierarchy/RelatedInstanceNodesSpecification.js +8 -8
- package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.d.ts +16 -16
- package/lib/esm/presentation-common/rules/hierarchy/RootNodeRule.js +8 -8
- package/lib/esm/presentation-common/rules/hierarchy/SubCondition.d.ts +35 -35
- package/lib/esm/presentation-common/rules/hierarchy/SubCondition.js +8 -8
- package/lib/esm/presentation-common/selection/SelectionScope.d.ts +38 -38
- package/lib/esm/presentation-common/selection/SelectionScope.d.ts.map +1 -1
- package/lib/esm/presentation-common/selection/SelectionScope.js +8 -8
- package/lib/esm/presentation-common.d.ts +113 -113
- package/lib/esm/presentation-common.js +117 -117
- package/package.json +12 -12
|
@@ -1,83 +1,83 @@
|
|
|
1
|
-
/** @packageDocumentation
|
|
2
|
-
* @module RPC
|
|
3
|
-
*/
|
|
4
|
-
import { IModelRpcProps } from "@itwin/core-common";
|
|
5
|
-
import { DescriptorJSON, DescriptorOverrides } from "./content/Descriptor";
|
|
6
|
-
import { ItemJSON } from "./content/Item";
|
|
7
|
-
import { DisplayValueGroupJSON } from "./content/Value";
|
|
8
|
-
import { ClientDiagnosticsAttribute } from "./Diagnostics";
|
|
9
|
-
import { InstanceKey } from "./EC";
|
|
10
|
-
import { ElementProperties } from "./ElementProperties";
|
|
11
|
-
import { NodeKey } from "./hierarchy/Key";
|
|
12
|
-
import { NodeJSON } from "./hierarchy/Node";
|
|
13
|
-
import { NodePathElementJSON } from "./hierarchy/NodePathElement";
|
|
14
|
-
import { KeySetJSON } from "./KeySet";
|
|
15
|
-
import { LabelDefinition } from "./LabelDefinition";
|
|
16
|
-
import { ComputeSelectionRequestOptions, ContentDescriptorRequestOptions, ContentInstanceKeysRequestOptions, ContentRequestOptions, ContentSourcesRequestOptions, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DistinctValuesRequestOptions, FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, HierarchyLevelDescriptorRequestOptions, HierarchyRequestOptions, Paged, RequestOptions, SelectionScopeRequestOptions, SingleElementPropertiesRequestOptions } from "./PresentationManagerOptions";
|
|
17
|
-
import { ContentSourcesRpcResult, PresentationRpcRequestOptions, PresentationRpcResponse } from "./PresentationRpcInterface";
|
|
18
|
-
import { RulesetVariableJSON } from "./RulesetVariables";
|
|
19
|
-
import { SelectionScope } from "./selection/SelectionScope";
|
|
20
|
-
import { PagedResponse } from "./Utils";
|
|
21
|
-
/**
|
|
22
|
-
* Configuration parameters for [[RpcRequestsHandler]].
|
|
23
|
-
*
|
|
24
|
-
* @internal
|
|
25
|
-
*/
|
|
26
|
-
export interface RpcRequestsHandlerProps {
|
|
27
|
-
/**
|
|
28
|
-
* Optional ID used to identify client that requests data. If not specified,
|
|
29
|
-
* the handler creates a unique GUID as a client id.
|
|
30
|
-
* @internal
|
|
31
|
-
*/
|
|
32
|
-
clientId?: string;
|
|
33
|
-
/** @internal */
|
|
34
|
-
timeout?: number;
|
|
35
|
-
}
|
|
36
|
-
/**
|
|
37
|
-
* RPC requests handler that wraps [[PresentationRpcInterface]] and
|
|
38
|
-
* adds handling for cases when backend needs to be synced with client
|
|
39
|
-
* state.
|
|
40
|
-
*
|
|
41
|
-
* @internal
|
|
42
|
-
*/
|
|
43
|
-
export declare class RpcRequestsHandler {
|
|
44
|
-
/** Timeout for how long the handler going to wait for RPC request to be fulfilled before throwing a timeout error. */
|
|
45
|
-
readonly timeout: number;
|
|
46
|
-
/** ID that identifies this handler as a client */
|
|
47
|
-
readonly clientId: string;
|
|
48
|
-
constructor(props?: RpcRequestsHandlerProps);
|
|
49
|
-
private get rpcClient();
|
|
50
|
-
private requestWithTimeout;
|
|
51
|
-
/**
|
|
52
|
-
* Send the request to backend.
|
|
53
|
-
*
|
|
54
|
-
* If the backend responds with [[PresentationStatus.BackendTimeout]], the request is repeated until we hit `timeout` or get
|
|
55
|
-
* a response. If the response is other than [[PresentationStatus.BackendTimeout]] or [[PresentationStatus.Success]], a [[PresentationError]]
|
|
56
|
-
* is thrown with the details from the response.
|
|
57
|
-
*/
|
|
58
|
-
request<TResult, TOptions extends (RequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute), TArg = any>(func: (token: IModelRpcProps, options: PresentationRpcRequestOptions<TOptions>, ...args: TArg[]) => PresentationRpcResponse<TResult>, options: TOptions, ...additionalOptions: TArg[]): Promise<TResult>;
|
|
59
|
-
getNodesCount(options: HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number>;
|
|
60
|
-
getPagedNodes(options: Paged<HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON>> & ClientDiagnosticsAttribute): Promise<PagedResponse<NodeJSON>>;
|
|
61
|
-
getNodesDescriptor(options: HierarchyLevelDescriptorRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined>;
|
|
62
|
-
getNodePaths(options: FilterByInstancePathsHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]>;
|
|
63
|
-
getFilteredNodePaths(options: FilterByTextHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]>;
|
|
64
|
-
getContentSources(options: ContentSourcesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ContentSourcesRpcResult>;
|
|
65
|
-
getContentDescriptor(options: ContentDescriptorRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined>;
|
|
66
|
-
getContentSetSize(options: ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number>;
|
|
67
|
-
getPagedContent(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>): Promise<{
|
|
68
|
-
descriptor: DescriptorJSON;
|
|
69
|
-
contentSet: PagedResponse<ItemJSON>;
|
|
70
|
-
} | undefined>;
|
|
71
|
-
getPagedContentSet(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>): Promise<PagedResponse<ItemJSON>>;
|
|
72
|
-
getPagedDistinctValues(options: DistinctValuesRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<PagedResponse<DisplayValueGroupJSON>>;
|
|
73
|
-
getElementProperties(options: SingleElementPropertiesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ElementProperties | undefined>;
|
|
74
|
-
getContentInstanceKeys(options: ContentInstanceKeysRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<{
|
|
75
|
-
total: number;
|
|
76
|
-
items: KeySetJSON;
|
|
77
|
-
}>;
|
|
78
|
-
getDisplayLabelDefinition(options: DisplayLabelRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute): Promise<LabelDefinition>;
|
|
79
|
-
getPagedDisplayLabelDefinitions(options: DisplayLabelsRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute): Promise<PagedResponse<LabelDefinition>>;
|
|
80
|
-
getSelectionScopes(options: SelectionScopeRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<SelectionScope[]>;
|
|
81
|
-
computeSelection(options: ComputeSelectionRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<KeySetJSON>;
|
|
82
|
-
}
|
|
1
|
+
/** @packageDocumentation
|
|
2
|
+
* @module RPC
|
|
3
|
+
*/
|
|
4
|
+
import { IModelRpcProps } from "@itwin/core-common";
|
|
5
|
+
import { DescriptorJSON, DescriptorOverrides } from "./content/Descriptor";
|
|
6
|
+
import { ItemJSON } from "./content/Item";
|
|
7
|
+
import { DisplayValueGroupJSON } from "./content/Value";
|
|
8
|
+
import { ClientDiagnosticsAttribute } from "./Diagnostics";
|
|
9
|
+
import { InstanceKey } from "./EC";
|
|
10
|
+
import { ElementProperties } from "./ElementProperties";
|
|
11
|
+
import { NodeKey } from "./hierarchy/Key";
|
|
12
|
+
import { NodeJSON } from "./hierarchy/Node";
|
|
13
|
+
import { NodePathElementJSON } from "./hierarchy/NodePathElement";
|
|
14
|
+
import { KeySetJSON } from "./KeySet";
|
|
15
|
+
import { LabelDefinition } from "./LabelDefinition";
|
|
16
|
+
import { ComputeSelectionRequestOptions, ContentDescriptorRequestOptions, ContentInstanceKeysRequestOptions, ContentRequestOptions, ContentSourcesRequestOptions, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DistinctValuesRequestOptions, FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, HierarchyLevelDescriptorRequestOptions, HierarchyRequestOptions, Paged, RequestOptions, SelectionScopeRequestOptions, SingleElementPropertiesRequestOptions } from "./PresentationManagerOptions";
|
|
17
|
+
import { ContentSourcesRpcResult, PresentationRpcRequestOptions, PresentationRpcResponse } from "./PresentationRpcInterface";
|
|
18
|
+
import { RulesetVariableJSON } from "./RulesetVariables";
|
|
19
|
+
import { SelectionScope } from "./selection/SelectionScope";
|
|
20
|
+
import { PagedResponse } from "./Utils";
|
|
21
|
+
/**
|
|
22
|
+
* Configuration parameters for [[RpcRequestsHandler]].
|
|
23
|
+
*
|
|
24
|
+
* @internal
|
|
25
|
+
*/
|
|
26
|
+
export interface RpcRequestsHandlerProps {
|
|
27
|
+
/**
|
|
28
|
+
* Optional ID used to identify client that requests data. If not specified,
|
|
29
|
+
* the handler creates a unique GUID as a client id.
|
|
30
|
+
* @internal
|
|
31
|
+
*/
|
|
32
|
+
clientId?: string;
|
|
33
|
+
/** @internal */
|
|
34
|
+
timeout?: number;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* RPC requests handler that wraps [[PresentationRpcInterface]] and
|
|
38
|
+
* adds handling for cases when backend needs to be synced with client
|
|
39
|
+
* state.
|
|
40
|
+
*
|
|
41
|
+
* @internal
|
|
42
|
+
*/
|
|
43
|
+
export declare class RpcRequestsHandler {
|
|
44
|
+
/** Timeout for how long the handler going to wait for RPC request to be fulfilled before throwing a timeout error. */
|
|
45
|
+
readonly timeout: number;
|
|
46
|
+
/** ID that identifies this handler as a client */
|
|
47
|
+
readonly clientId: string;
|
|
48
|
+
constructor(props?: RpcRequestsHandlerProps);
|
|
49
|
+
private get rpcClient();
|
|
50
|
+
private requestWithTimeout;
|
|
51
|
+
/**
|
|
52
|
+
* Send the request to backend.
|
|
53
|
+
*
|
|
54
|
+
* If the backend responds with [[PresentationStatus.BackendTimeout]], the request is repeated until we hit `timeout` or get
|
|
55
|
+
* a response. If the response is other than [[PresentationStatus.BackendTimeout]] or [[PresentationStatus.Success]], a [[PresentationError]]
|
|
56
|
+
* is thrown with the details from the response.
|
|
57
|
+
*/
|
|
58
|
+
request<TResult, TOptions extends (RequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute), TArg = any>(func: (token: IModelRpcProps, options: PresentationRpcRequestOptions<TOptions>, ...args: TArg[]) => PresentationRpcResponse<TResult>, options: TOptions, ...additionalOptions: TArg[]): Promise<TResult>;
|
|
59
|
+
getNodesCount(options: HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number>;
|
|
60
|
+
getPagedNodes(options: Paged<HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON>> & ClientDiagnosticsAttribute): Promise<PagedResponse<NodeJSON>>;
|
|
61
|
+
getNodesDescriptor(options: HierarchyLevelDescriptorRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined>;
|
|
62
|
+
getNodePaths(options: FilterByInstancePathsHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]>;
|
|
63
|
+
getFilteredNodePaths(options: FilterByTextHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]>;
|
|
64
|
+
getContentSources(options: ContentSourcesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ContentSourcesRpcResult>;
|
|
65
|
+
getContentDescriptor(options: ContentDescriptorRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined>;
|
|
66
|
+
getContentSetSize(options: ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number>;
|
|
67
|
+
getPagedContent(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>): Promise<{
|
|
68
|
+
descriptor: DescriptorJSON;
|
|
69
|
+
contentSet: PagedResponse<ItemJSON>;
|
|
70
|
+
} | undefined>;
|
|
71
|
+
getPagedContentSet(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>): Promise<PagedResponse<ItemJSON>>;
|
|
72
|
+
getPagedDistinctValues(options: DistinctValuesRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<PagedResponse<DisplayValueGroupJSON>>;
|
|
73
|
+
getElementProperties(options: SingleElementPropertiesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ElementProperties | undefined>;
|
|
74
|
+
getContentInstanceKeys(options: ContentInstanceKeysRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<{
|
|
75
|
+
total: number;
|
|
76
|
+
items: KeySetJSON;
|
|
77
|
+
}>;
|
|
78
|
+
getDisplayLabelDefinition(options: DisplayLabelRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute): Promise<LabelDefinition>;
|
|
79
|
+
getPagedDisplayLabelDefinitions(options: DisplayLabelsRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute): Promise<PagedResponse<LabelDefinition>>;
|
|
80
|
+
getSelectionScopes(options: SelectionScopeRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<SelectionScope[]>;
|
|
81
|
+
computeSelection(options: ComputeSelectionRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<KeySetJSON>;
|
|
82
|
+
}
|
|
83
83
|
//# sourceMappingURL=RpcRequestsHandler.d.ts.map
|
|
@@ -1,167 +1,167 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/*---------------------------------------------------------------------------------------------
|
|
3
|
-
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
|
|
4
|
-
* See LICENSE.md in the project root for license terms and full copyright notice.
|
|
5
|
-
*--------------------------------------------------------------------------------------------*/
|
|
6
|
-
/** @packageDocumentation
|
|
7
|
-
* @module RPC
|
|
8
|
-
*/
|
|
9
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
10
|
-
exports.RpcRequestsHandler = void 0;
|
|
11
|
-
const core_bentley_1 = require("@itwin/core-bentley");
|
|
12
|
-
const core_common_1 = require("@itwin/core-common");
|
|
13
|
-
const CommonLoggerCategory_1 = require("./CommonLoggerCategory");
|
|
14
|
-
const Error_1 = require("./Error");
|
|
15
|
-
const PresentationRpcInterface_1 = require("./PresentationRpcInterface");
|
|
16
|
-
/**
|
|
17
|
-
* Default timeout for how long we're going to wait for RPC request to be fulfilled before throwing
|
|
18
|
-
* a timeout error.
|
|
19
|
-
*/
|
|
20
|
-
const DEFAULT_REQUEST_TIMEOUT = 10 * 60 * 1000; // 10 minutes
|
|
21
|
-
/**
|
|
22
|
-
* RPC requests handler that wraps [[PresentationRpcInterface]] and
|
|
23
|
-
* adds handling for cases when backend needs to be synced with client
|
|
24
|
-
* state.
|
|
25
|
-
*
|
|
26
|
-
* @internal
|
|
27
|
-
*/
|
|
28
|
-
class RpcRequestsHandler {
|
|
29
|
-
constructor(props) {
|
|
30
|
-
this.clientId = props?.clientId ?? core_bentley_1.Guid.createValue();
|
|
31
|
-
this.timeout = props?.timeout ?? DEFAULT_REQUEST_TIMEOUT;
|
|
32
|
-
}
|
|
33
|
-
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
34
|
-
get rpcClient() { return core_common_1.RpcManager.getClientForInterface(PresentationRpcInterface_1.PresentationRpcInterface); }
|
|
35
|
-
async requestWithTimeout(func, diagnosticsHandler) {
|
|
36
|
-
const start = core_bentley_1.BeTimePoint.now();
|
|
37
|
-
const timeout = core_bentley_1.BeDuration.fromMilliseconds(this.timeout);
|
|
38
|
-
let diagnostics;
|
|
39
|
-
while (start.plus(timeout).isInFuture) {
|
|
40
|
-
try {
|
|
41
|
-
const response = await func();
|
|
42
|
-
diagnostics = response.diagnostics;
|
|
43
|
-
switch (response.statusCode) {
|
|
44
|
-
case Error_1.PresentationStatus.Success: return response.result;
|
|
45
|
-
case Error_1.PresentationStatus.BackendTimeout: break;
|
|
46
|
-
default: throw new Error_1.PresentationError(response.statusCode, response.errorMessage);
|
|
47
|
-
}
|
|
48
|
-
}
|
|
49
|
-
finally {
|
|
50
|
-
diagnosticsHandler && diagnostics && diagnosticsHandler(diagnostics);
|
|
51
|
-
}
|
|
52
|
-
}
|
|
53
|
-
throw new Error_1.PresentationError(Error_1.PresentationStatus.BackendTimeout);
|
|
54
|
-
}
|
|
55
|
-
/**
|
|
56
|
-
* Send the request to backend.
|
|
57
|
-
*
|
|
58
|
-
* If the backend responds with [[PresentationStatus.BackendTimeout]], the request is repeated until we hit `timeout` or get
|
|
59
|
-
* a response. If the response is other than [[PresentationStatus.BackendTimeout]] or [[PresentationStatus.Success]], a [[PresentationError]]
|
|
60
|
-
* is thrown with the details from the response.
|
|
61
|
-
*/
|
|
62
|
-
async request(func, options, ...additionalOptions) {
|
|
63
|
-
const { imodel, diagnostics, ...optionsNoIModel } = options;
|
|
64
|
-
const { handler: diagnosticsHandler, ...diagnosticsOptions } = diagnostics ?? {};
|
|
65
|
-
if (isOptionsWithRuleset(optionsNoIModel)) {
|
|
66
|
-
optionsNoIModel.rulesetOrId = cleanupRuleset(optionsNoIModel.rulesetOrId);
|
|
67
|
-
}
|
|
68
|
-
const rpcOptions = {
|
|
69
|
-
...optionsNoIModel,
|
|
70
|
-
clientId: this.clientId,
|
|
71
|
-
};
|
|
72
|
-
if (diagnostics) {
|
|
73
|
-
rpcOptions.diagnostics = diagnosticsOptions;
|
|
74
|
-
}
|
|
75
|
-
const doRequest = async () => func(imodel, rpcOptions, ...additionalOptions);
|
|
76
|
-
return this.requestWithTimeout(doRequest, diagnosticsHandler);
|
|
77
|
-
}
|
|
78
|
-
async getNodesCount(options) {
|
|
79
|
-
return this.request(this.rpcClient.getNodesCount.bind(this.rpcClient), options);
|
|
80
|
-
}
|
|
81
|
-
// eslint-disable-next-line deprecation/deprecation
|
|
82
|
-
async getPagedNodes(options) {
|
|
83
|
-
// eslint-disable-next-line deprecation/deprecation
|
|
84
|
-
return this.request(this.rpcClient.getPagedNodes.bind(this.rpcClient), options);
|
|
85
|
-
}
|
|
86
|
-
async getNodesDescriptor(options) {
|
|
87
|
-
const response = await this.request(this.rpcClient.getNodesDescriptor.bind(this.rpcClient), options);
|
|
88
|
-
if (typeof response === "string")
|
|
89
|
-
return JSON.parse(response);
|
|
90
|
-
return response;
|
|
91
|
-
}
|
|
92
|
-
// eslint-disable-next-line deprecation/deprecation
|
|
93
|
-
async getNodePaths(options) {
|
|
94
|
-
// eslint-disable-next-line deprecation/deprecation
|
|
95
|
-
return this.request(this.rpcClient.getNodePaths.bind(this.rpcClient), options);
|
|
96
|
-
}
|
|
97
|
-
// eslint-disable-next-line deprecation/deprecation
|
|
98
|
-
async getFilteredNodePaths(options) {
|
|
99
|
-
// eslint-disable-next-line deprecation/deprecation
|
|
100
|
-
return this.request(this.rpcClient.getFilteredNodePaths.bind(this.rpcClient), options);
|
|
101
|
-
}
|
|
102
|
-
async getContentSources(options) {
|
|
103
|
-
return this.request(this.rpcClient.getContentSources.bind(this.rpcClient), options);
|
|
104
|
-
}
|
|
105
|
-
async getContentDescriptor(options) {
|
|
106
|
-
return this.request(this.rpcClient.getContentDescriptor.bind(this.rpcClient), options);
|
|
107
|
-
}
|
|
108
|
-
async getContentSetSize(options) {
|
|
109
|
-
return this.request(this.rpcClient.getContentSetSize.bind(this.rpcClient), options);
|
|
110
|
-
}
|
|
111
|
-
async getPagedContent(options) {
|
|
112
|
-
return this.request(this.rpcClient.getPagedContent.bind(this.rpcClient), options);
|
|
113
|
-
}
|
|
114
|
-
async getPagedContentSet(options) {
|
|
115
|
-
return this.request(this.rpcClient.getPagedContentSet.bind(this.rpcClient), options);
|
|
116
|
-
}
|
|
117
|
-
// eslint-disable-next-line deprecation/deprecation
|
|
118
|
-
async getPagedDistinctValues(options) {
|
|
119
|
-
// eslint-disable-next-line deprecation/deprecation
|
|
120
|
-
return this.request(this.rpcClient.getPagedDistinctValues.bind(this.rpcClient), options);
|
|
121
|
-
}
|
|
122
|
-
async getElementProperties(options) {
|
|
123
|
-
return this.request(this.rpcClient.getElementProperties.bind(this.rpcClient), options);
|
|
124
|
-
}
|
|
125
|
-
async getContentInstanceKeys(options) {
|
|
126
|
-
return this.request(this.rpcClient.getContentInstanceKeys.bind(this.rpcClient), options);
|
|
127
|
-
}
|
|
128
|
-
async getDisplayLabelDefinition(options) {
|
|
129
|
-
return this.request(this.rpcClient.getDisplayLabelDefinition.bind(this.rpcClient), options);
|
|
130
|
-
}
|
|
131
|
-
async getPagedDisplayLabelDefinitions(options) {
|
|
132
|
-
return this.request(this.rpcClient.getPagedDisplayLabelDefinitions.bind(this.rpcClient), options);
|
|
133
|
-
}
|
|
134
|
-
async getSelectionScopes(options) {
|
|
135
|
-
return this.request(this.rpcClient.getSelectionScopes.bind(this.rpcClient), options);
|
|
136
|
-
}
|
|
137
|
-
async computeSelection(options) {
|
|
138
|
-
return this.request(
|
|
139
|
-
// eslint-disable-next-line deprecation/deprecation
|
|
140
|
-
this.rpcClient.computeSelection.bind(this.rpcClient), options);
|
|
141
|
-
}
|
|
142
|
-
}
|
|
143
|
-
exports.RpcRequestsHandler = RpcRequestsHandler;
|
|
144
|
-
function isOptionsWithRuleset(options) {
|
|
145
|
-
return (typeof options.rulesetOrId === "object");
|
|
146
|
-
}
|
|
147
|
-
const RULESET_SUPPORTED_PROPERTIES_OBJ = {
|
|
148
|
-
id: true,
|
|
149
|
-
rules: true,
|
|
150
|
-
version: true,
|
|
151
|
-
requiredSchemas: true,
|
|
152
|
-
supplementationInfo: true,
|
|
153
|
-
vars: true,
|
|
154
|
-
};
|
|
155
|
-
function cleanupRuleset(ruleset) {
|
|
156
|
-
const cleanedUpRuleset = { ...ruleset };
|
|
157
|
-
for (const propertyKey of Object.keys(cleanedUpRuleset)) {
|
|
158
|
-
if (!RULESET_SUPPORTED_PROPERTIES_OBJ.hasOwnProperty(propertyKey)) {
|
|
159
|
-
if (propertyKey === "$schema")
|
|
160
|
-
delete cleanedUpRuleset[propertyKey];
|
|
161
|
-
else
|
|
162
|
-
core_bentley_1.Logger.logWarning(CommonLoggerCategory_1.PresentationCommonLoggerCategory.Package, `Provided ruleset contains unrecognized attribute '${propertyKey}'. It either doesn't exist or may be no longer supported.`);
|
|
163
|
-
}
|
|
164
|
-
}
|
|
165
|
-
return cleanedUpRuleset;
|
|
166
|
-
}
|
|
1
|
+
"use strict";
|
|
2
|
+
/*---------------------------------------------------------------------------------------------
|
|
3
|
+
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
|
|
4
|
+
* See LICENSE.md in the project root for license terms and full copyright notice.
|
|
5
|
+
*--------------------------------------------------------------------------------------------*/
|
|
6
|
+
/** @packageDocumentation
|
|
7
|
+
* @module RPC
|
|
8
|
+
*/
|
|
9
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
10
|
+
exports.RpcRequestsHandler = void 0;
|
|
11
|
+
const core_bentley_1 = require("@itwin/core-bentley");
|
|
12
|
+
const core_common_1 = require("@itwin/core-common");
|
|
13
|
+
const CommonLoggerCategory_1 = require("./CommonLoggerCategory");
|
|
14
|
+
const Error_1 = require("./Error");
|
|
15
|
+
const PresentationRpcInterface_1 = require("./PresentationRpcInterface");
|
|
16
|
+
/**
|
|
17
|
+
* Default timeout for how long we're going to wait for RPC request to be fulfilled before throwing
|
|
18
|
+
* a timeout error.
|
|
19
|
+
*/
|
|
20
|
+
const DEFAULT_REQUEST_TIMEOUT = 10 * 60 * 1000; // 10 minutes
|
|
21
|
+
/**
|
|
22
|
+
* RPC requests handler that wraps [[PresentationRpcInterface]] and
|
|
23
|
+
* adds handling for cases when backend needs to be synced with client
|
|
24
|
+
* state.
|
|
25
|
+
*
|
|
26
|
+
* @internal
|
|
27
|
+
*/
|
|
28
|
+
class RpcRequestsHandler {
|
|
29
|
+
constructor(props) {
|
|
30
|
+
this.clientId = props?.clientId ?? core_bentley_1.Guid.createValue();
|
|
31
|
+
this.timeout = props?.timeout ?? DEFAULT_REQUEST_TIMEOUT;
|
|
32
|
+
}
|
|
33
|
+
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
34
|
+
get rpcClient() { return core_common_1.RpcManager.getClientForInterface(PresentationRpcInterface_1.PresentationRpcInterface); }
|
|
35
|
+
async requestWithTimeout(func, diagnosticsHandler) {
|
|
36
|
+
const start = core_bentley_1.BeTimePoint.now();
|
|
37
|
+
const timeout = core_bentley_1.BeDuration.fromMilliseconds(this.timeout);
|
|
38
|
+
let diagnostics;
|
|
39
|
+
while (start.plus(timeout).isInFuture) {
|
|
40
|
+
try {
|
|
41
|
+
const response = await func();
|
|
42
|
+
diagnostics = response.diagnostics;
|
|
43
|
+
switch (response.statusCode) {
|
|
44
|
+
case Error_1.PresentationStatus.Success: return response.result;
|
|
45
|
+
case Error_1.PresentationStatus.BackendTimeout: break;
|
|
46
|
+
default: throw new Error_1.PresentationError(response.statusCode, response.errorMessage);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
finally {
|
|
50
|
+
diagnosticsHandler && diagnostics && diagnosticsHandler(diagnostics);
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
throw new Error_1.PresentationError(Error_1.PresentationStatus.BackendTimeout);
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Send the request to backend.
|
|
57
|
+
*
|
|
58
|
+
* If the backend responds with [[PresentationStatus.BackendTimeout]], the request is repeated until we hit `timeout` or get
|
|
59
|
+
* a response. If the response is other than [[PresentationStatus.BackendTimeout]] or [[PresentationStatus.Success]], a [[PresentationError]]
|
|
60
|
+
* is thrown with the details from the response.
|
|
61
|
+
*/
|
|
62
|
+
async request(func, options, ...additionalOptions) {
|
|
63
|
+
const { imodel, diagnostics, ...optionsNoIModel } = options;
|
|
64
|
+
const { handler: diagnosticsHandler, ...diagnosticsOptions } = diagnostics ?? {};
|
|
65
|
+
if (isOptionsWithRuleset(optionsNoIModel)) {
|
|
66
|
+
optionsNoIModel.rulesetOrId = cleanupRuleset(optionsNoIModel.rulesetOrId);
|
|
67
|
+
}
|
|
68
|
+
const rpcOptions = {
|
|
69
|
+
...optionsNoIModel,
|
|
70
|
+
clientId: this.clientId,
|
|
71
|
+
};
|
|
72
|
+
if (diagnostics) {
|
|
73
|
+
rpcOptions.diagnostics = diagnosticsOptions;
|
|
74
|
+
}
|
|
75
|
+
const doRequest = async () => func(imodel, rpcOptions, ...additionalOptions);
|
|
76
|
+
return this.requestWithTimeout(doRequest, diagnosticsHandler);
|
|
77
|
+
}
|
|
78
|
+
async getNodesCount(options) {
|
|
79
|
+
return this.request(this.rpcClient.getNodesCount.bind(this.rpcClient), options);
|
|
80
|
+
}
|
|
81
|
+
// eslint-disable-next-line deprecation/deprecation
|
|
82
|
+
async getPagedNodes(options) {
|
|
83
|
+
// eslint-disable-next-line deprecation/deprecation
|
|
84
|
+
return this.request(this.rpcClient.getPagedNodes.bind(this.rpcClient), options);
|
|
85
|
+
}
|
|
86
|
+
async getNodesDescriptor(options) {
|
|
87
|
+
const response = await this.request(this.rpcClient.getNodesDescriptor.bind(this.rpcClient), options);
|
|
88
|
+
if (typeof response === "string")
|
|
89
|
+
return JSON.parse(response);
|
|
90
|
+
return response;
|
|
91
|
+
}
|
|
92
|
+
// eslint-disable-next-line deprecation/deprecation
|
|
93
|
+
async getNodePaths(options) {
|
|
94
|
+
// eslint-disable-next-line deprecation/deprecation
|
|
95
|
+
return this.request(this.rpcClient.getNodePaths.bind(this.rpcClient), options);
|
|
96
|
+
}
|
|
97
|
+
// eslint-disable-next-line deprecation/deprecation
|
|
98
|
+
async getFilteredNodePaths(options) {
|
|
99
|
+
// eslint-disable-next-line deprecation/deprecation
|
|
100
|
+
return this.request(this.rpcClient.getFilteredNodePaths.bind(this.rpcClient), options);
|
|
101
|
+
}
|
|
102
|
+
async getContentSources(options) {
|
|
103
|
+
return this.request(this.rpcClient.getContentSources.bind(this.rpcClient), options);
|
|
104
|
+
}
|
|
105
|
+
async getContentDescriptor(options) {
|
|
106
|
+
return this.request(this.rpcClient.getContentDescriptor.bind(this.rpcClient), options);
|
|
107
|
+
}
|
|
108
|
+
async getContentSetSize(options) {
|
|
109
|
+
return this.request(this.rpcClient.getContentSetSize.bind(this.rpcClient), options);
|
|
110
|
+
}
|
|
111
|
+
async getPagedContent(options) {
|
|
112
|
+
return this.request(this.rpcClient.getPagedContent.bind(this.rpcClient), options);
|
|
113
|
+
}
|
|
114
|
+
async getPagedContentSet(options) {
|
|
115
|
+
return this.request(this.rpcClient.getPagedContentSet.bind(this.rpcClient), options);
|
|
116
|
+
}
|
|
117
|
+
// eslint-disable-next-line deprecation/deprecation
|
|
118
|
+
async getPagedDistinctValues(options) {
|
|
119
|
+
// eslint-disable-next-line deprecation/deprecation
|
|
120
|
+
return this.request(this.rpcClient.getPagedDistinctValues.bind(this.rpcClient), options);
|
|
121
|
+
}
|
|
122
|
+
async getElementProperties(options) {
|
|
123
|
+
return this.request(this.rpcClient.getElementProperties.bind(this.rpcClient), options);
|
|
124
|
+
}
|
|
125
|
+
async getContentInstanceKeys(options) {
|
|
126
|
+
return this.request(this.rpcClient.getContentInstanceKeys.bind(this.rpcClient), options);
|
|
127
|
+
}
|
|
128
|
+
async getDisplayLabelDefinition(options) {
|
|
129
|
+
return this.request(this.rpcClient.getDisplayLabelDefinition.bind(this.rpcClient), options);
|
|
130
|
+
}
|
|
131
|
+
async getPagedDisplayLabelDefinitions(options) {
|
|
132
|
+
return this.request(this.rpcClient.getPagedDisplayLabelDefinitions.bind(this.rpcClient), options);
|
|
133
|
+
}
|
|
134
|
+
async getSelectionScopes(options) {
|
|
135
|
+
return this.request(this.rpcClient.getSelectionScopes.bind(this.rpcClient), options);
|
|
136
|
+
}
|
|
137
|
+
async computeSelection(options) {
|
|
138
|
+
return this.request(
|
|
139
|
+
// eslint-disable-next-line deprecation/deprecation
|
|
140
|
+
this.rpcClient.computeSelection.bind(this.rpcClient), options);
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
exports.RpcRequestsHandler = RpcRequestsHandler;
|
|
144
|
+
function isOptionsWithRuleset(options) {
|
|
145
|
+
return (typeof options.rulesetOrId === "object");
|
|
146
|
+
}
|
|
147
|
+
const RULESET_SUPPORTED_PROPERTIES_OBJ = {
|
|
148
|
+
id: true,
|
|
149
|
+
rules: true,
|
|
150
|
+
version: true,
|
|
151
|
+
requiredSchemas: true,
|
|
152
|
+
supplementationInfo: true,
|
|
153
|
+
vars: true,
|
|
154
|
+
};
|
|
155
|
+
function cleanupRuleset(ruleset) {
|
|
156
|
+
const cleanedUpRuleset = { ...ruleset };
|
|
157
|
+
for (const propertyKey of Object.keys(cleanedUpRuleset)) {
|
|
158
|
+
if (!RULESET_SUPPORTED_PROPERTIES_OBJ.hasOwnProperty(propertyKey)) {
|
|
159
|
+
if (propertyKey === "$schema")
|
|
160
|
+
delete cleanedUpRuleset[propertyKey];
|
|
161
|
+
else
|
|
162
|
+
core_bentley_1.Logger.logWarning(CommonLoggerCategory_1.PresentationCommonLoggerCategory.Package, `Provided ruleset contains unrecognized attribute '${propertyKey}'. It either doesn't exist or may be no longer supported.`);
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
return cleanedUpRuleset;
|
|
166
|
+
}
|
|
167
167
|
//# sourceMappingURL=RpcRequestsHandler.js.map
|