@itwin/presentation-common 3.0.0-extension.1 → 3.1.0-dev.6

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.
Files changed (60) hide show
  1. package/CHANGELOG.md +76 -1
  2. package/LICENSE.md +1 -1
  3. package/Ruleset.schema.json +43 -4
  4. package/lib/cjs/presentation-common/KeySet.d.ts +1 -1
  5. package/lib/cjs/presentation-common/KeySet.js.map +1 -1
  6. package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts +14 -1
  7. package/lib/cjs/presentation-common/PresentationManagerOptions.d.ts.map +1 -1
  8. package/lib/cjs/presentation-common/PresentationManagerOptions.js.map +1 -1
  9. package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts +18 -20
  10. package/lib/cjs/presentation-common/PresentationRpcInterface.d.ts.map +1 -1
  11. package/lib/cjs/presentation-common/PresentationRpcInterface.js +3 -0
  12. package/lib/cjs/presentation-common/PresentationRpcInterface.js.map +1 -1
  13. package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts +6 -3
  14. package/lib/cjs/presentation-common/RpcRequestsHandler.d.ts.map +1 -1
  15. package/lib/cjs/presentation-common/RpcRequestsHandler.js +6 -3
  16. package/lib/cjs/presentation-common/RpcRequestsHandler.js.map +1 -1
  17. package/lib/cjs/presentation-common/rules/ClassSpecifications.d.ts +4 -9
  18. package/lib/cjs/presentation-common/rules/ClassSpecifications.d.ts.map +1 -1
  19. package/lib/cjs/presentation-common/rules/ClassSpecifications.js.map +1 -1
  20. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +9 -1
  21. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts.map +1 -1
  22. package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map +1 -1
  23. package/lib/cjs/presentation-common/rules/content/ContentSpecification.d.ts +5 -0
  24. package/lib/cjs/presentation-common/rules/content/ContentSpecification.d.ts.map +1 -1
  25. package/lib/cjs/presentation-common/rules/content/ContentSpecification.js.map +1 -1
  26. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +0 -5
  27. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts.map +1 -1
  28. package/lib/cjs/presentation-common/rules/content/SelectedNodeInstancesSpecification.js.map +1 -1
  29. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +7 -1
  30. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts.map +1 -1
  31. package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js.map +1 -1
  32. package/lib/esm/presentation-common/KeySet.d.ts +1 -1
  33. package/lib/esm/presentation-common/KeySet.js.map +1 -1
  34. package/lib/esm/presentation-common/PresentationManagerOptions.d.ts +14 -1
  35. package/lib/esm/presentation-common/PresentationManagerOptions.d.ts.map +1 -1
  36. package/lib/esm/presentation-common/PresentationManagerOptions.js.map +1 -1
  37. package/lib/esm/presentation-common/PresentationRpcInterface.d.ts +18 -20
  38. package/lib/esm/presentation-common/PresentationRpcInterface.d.ts.map +1 -1
  39. package/lib/esm/presentation-common/PresentationRpcInterface.js +3 -0
  40. package/lib/esm/presentation-common/PresentationRpcInterface.js.map +1 -1
  41. package/lib/esm/presentation-common/RpcRequestsHandler.d.ts +6 -3
  42. package/lib/esm/presentation-common/RpcRequestsHandler.d.ts.map +1 -1
  43. package/lib/esm/presentation-common/RpcRequestsHandler.js +6 -3
  44. package/lib/esm/presentation-common/RpcRequestsHandler.js.map +1 -1
  45. package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts +4 -9
  46. package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts.map +1 -1
  47. package/lib/esm/presentation-common/rules/ClassSpecifications.js.map +1 -1
  48. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts +9 -1
  49. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.d.ts.map +1 -1
  50. package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map +1 -1
  51. package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts +5 -0
  52. package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts.map +1 -1
  53. package/lib/esm/presentation-common/rules/content/ContentSpecification.js.map +1 -1
  54. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts +0 -5
  55. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.d.ts.map +1 -1
  56. package/lib/esm/presentation-common/rules/content/SelectedNodeInstancesSpecification.js.map +1 -1
  57. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts +7 -1
  58. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts.map +1 -1
  59. package/lib/esm/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js.map +1 -1
  60. package/package.json +13 -12
@@ -1 +1 @@
1
- {"version":3,"file":"SelectedNodeInstancesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/SelectedNodeInstancesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAE7F;;;;;;;GAOG;AACH,MAAM,WAAW,kCAAmC,SAAQ,wBAAwB;IAClF,oCAAoC;IACpC,QAAQ,EAAE,yBAAyB,CAAC,qBAAqB,CAAC;IAE1D;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;;OAGG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B"}
1
+ {"version":3,"file":"SelectedNodeInstancesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/SelectedNodeInstancesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAE7F;;;;;;;GAOG;AACH,MAAM,WAAW,kCAAmC,SAAQ,wBAAwB;IAClF,oCAAoC;IACpC,QAAQ,EAAE,yBAAyB,CAAC,qBAAqB,CAAC;IAE1D;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;;OAGG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC"}
@@ -1 +1 @@
1
- {"version":3,"file":"SelectedNodeInstancesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/SelectedNodeInstancesSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 PresentationRules\r\n */\r\n\r\nimport { ContentSpecificationBase, ContentSpecificationTypes } from \"./ContentSpecification\";\r\n\r\n/**\r\n * Creates content for current selection.\r\n *\r\n * **Note:** No data is returned for selected custom nodes.\r\n *\r\n * @see [More details]($docs/presentation/Content/SelectedNodeInstances.md)\r\n * @public\r\n */\r\nexport interface SelectedNodeInstancesSpecification extends ContentSpecificationBase {\r\n /** Used for serializing to JSON. */\r\n specType: ContentSpecificationTypes.SelectedNodeInstances;\r\n\r\n /**\r\n * Filter selected nodes by specified schema name. All schemas are\r\n * accepted if not specified.\r\n *\r\n * @pattern ^[\\w\\d]+$\r\n */\r\n acceptableSchemaName?: string;\r\n\r\n /**\r\n * Filter selected nodes by specified class names. All classes are\r\n * accepted if not specified.\r\n */\r\n acceptableClassNames?: string[];\r\n\r\n /**\r\n * Should [[acceptableClassNames]] property be checked polymorphically. If true, all derived\r\n * classes are accepted as well.\r\n */\r\n acceptablePolymorphically?: boolean;\r\n\r\n /**\r\n * Identifies whether we should ignore this specification if there is already an existing specification\r\n * with higher `priority` that already provides content.\r\n */\r\n onlyIfNotHandled?: boolean;\r\n}\r\n"]}
1
+ {"version":3,"file":"SelectedNodeInstancesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/SelectedNodeInstancesSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 PresentationRules\r\n */\r\n\r\nimport { ContentSpecificationBase, ContentSpecificationTypes } from \"./ContentSpecification\";\r\n\r\n/**\r\n * Creates content for current selection.\r\n *\r\n * **Note:** No data is returned for selected custom nodes.\r\n *\r\n * @see [More details]($docs/presentation/Content/SelectedNodeInstances.md)\r\n * @public\r\n */\r\nexport interface SelectedNodeInstancesSpecification extends ContentSpecificationBase {\r\n /** Used for serializing to JSON. */\r\n specType: ContentSpecificationTypes.SelectedNodeInstances;\r\n\r\n /**\r\n * Filter selected nodes by specified schema name. All schemas are\r\n * accepted if not specified.\r\n *\r\n * @pattern ^[\\w\\d]+$\r\n */\r\n acceptableSchemaName?: string;\r\n\r\n /**\r\n * Filter selected nodes by specified class names. All classes are\r\n * accepted if not specified.\r\n */\r\n acceptableClassNames?: string[];\r\n\r\n /**\r\n * Should [[acceptableClassNames]] property be checked polymorphically. If true, all derived\r\n * classes are accepted as well.\r\n */\r\n acceptablePolymorphically?: boolean;\r\n}\r\n"]}
@@ -17,7 +17,13 @@ export interface InstanceNodesOfSpecificClassesSpecification extends ChildNodeSp
17
17
  */
18
18
  classes: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];
19
19
  /**
20
- * Should all [[classes]] be handled polymorphically.
20
+ * Specifications of ECClasses whose instances should be excluded.
21
+ */
22
+ excludedClasses?: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];
23
+ /**
24
+ * Whether to get instances from derived `classes`.
25
+ * Acts as default value for [[classes.arePolymorphic]] and [[excludedClasses.arePolymorphic]].
26
+ * @deprecated Specify polymorphism value inside [[classes.arePolymorphic]] or [[excludedClasses.arePolymorphic]].
21
27
  */
22
28
  arePolymorphic?: boolean;
23
29
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"InstanceNodesOfSpecificClassesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,+BAA+B,EAAE,MAAM,wBAAwB,CAAC;AACzE,OAAO,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,kCAAkC,EAAE,MAAM,0BAA0B,CAAC;AAEvI;;;;;GAKG;AACH,MAAM,WAAW,2CAA4C,SAAQ,0BAA0B,EAAE,kCAAkC;IACjI,oCAAoC;IACpC,QAAQ,EAAE,2BAA2B,CAAC,8BAA8B,CAAC;IAErE;;OAEG;IACH,OAAO,EAAE,+BAA+B,GAAG,+BAA+B,EAAE,CAAC;IAE7E;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB"}
1
+ {"version":3,"file":"InstanceNodesOfSpecificClassesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,+BAA+B,EAAE,MAAM,wBAAwB,CAAC;AACzE,OAAO,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,kCAAkC,EAAE,MAAM,0BAA0B,CAAC;AAEvI;;;;;GAKG;AACH,MAAM,WAAW,2CAA4C,SAAQ,0BAA0B,EAAE,kCAAkC;IACjI,oCAAoC;IACpC,QAAQ,EAAE,2BAA2B,CAAC,8BAA8B,CAAC;IAErE;;OAEG;IACH,OAAO,EAAE,+BAA+B,GAAG,+BAA+B,EAAE,CAAC;IAE7E;;OAEG;IACH,eAAe,CAAC,EAAE,+BAA+B,GAAG,+BAA+B,EAAE,CAAC;IAEtF;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB"}
@@ -1 +1 @@
1
- {"version":3,"file":"InstanceNodesOfSpecificClassesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 PresentationRules\r\n */\r\n\r\nimport { MultiSchemaClassesSpecification } from \"../ClassSpecifications\";\r\nimport { ChildNodeSpecificationBase, ChildNodeSpecificationTypes, DefaultGroupingPropertiesContainer } from \"./ChildNodeSpecification\";\r\n\r\n/**\r\n * Creates nodes for all instances of specified ECClasses.\r\n *\r\n * @see [More details]($docs/presentation/Hierarchies/InstanceNodesOfSpecificClasses.md)\r\n * @public\r\n */\r\nexport interface InstanceNodesOfSpecificClassesSpecification extends ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer {\r\n /** Used for serializing to JSON. */\r\n specType: ChildNodeSpecificationTypes.InstanceNodesOfSpecificClasses;\r\n\r\n /**\r\n * Specifications of ECClasses whose instances should be returned.\r\n */\r\n classes: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\r\n\r\n /**\r\n * Should all [[classes]] be handled polymorphically.\r\n */\r\n arePolymorphic?: boolean;\r\n\r\n /**\r\n * Condition for filtering instances of defined classes.\r\n *\r\n * **See:** [ECExpressions Available in InstanceFilter]($docs/presentation/Hierarchies/ECExpressions.md#instance-filter).\r\n */\r\n instanceFilter?: string;\r\n}\r\n"]}
1
+ {"version":3,"file":"InstanceNodesOfSpecificClassesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 PresentationRules\r\n */\r\n\r\nimport { MultiSchemaClassesSpecification } from \"../ClassSpecifications\";\r\nimport { ChildNodeSpecificationBase, ChildNodeSpecificationTypes, DefaultGroupingPropertiesContainer } from \"./ChildNodeSpecification\";\r\n\r\n/**\r\n * Creates nodes for all instances of specified ECClasses.\r\n *\r\n * @see [More details]($docs/presentation/Hierarchies/InstanceNodesOfSpecificClasses.md)\r\n * @public\r\n */\r\nexport interface InstanceNodesOfSpecificClassesSpecification extends ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer {\r\n /** Used for serializing to JSON. */\r\n specType: ChildNodeSpecificationTypes.InstanceNodesOfSpecificClasses;\r\n\r\n /**\r\n * Specifications of ECClasses whose instances should be returned.\r\n */\r\n classes: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\r\n\r\n /**\r\n * Specifications of ECClasses whose instances should be excluded.\r\n */\r\n excludedClasses?: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\r\n\r\n /**\r\n * Whether to get instances from derived `classes`.\r\n * Acts as default value for [[classes.arePolymorphic]] and [[excludedClasses.arePolymorphic]].\r\n * @deprecated Specify polymorphism value inside [[classes.arePolymorphic]] or [[excludedClasses.arePolymorphic]].\r\n */\r\n arePolymorphic?: boolean;\r\n\r\n /**\r\n * Condition for filtering instances of defined classes.\r\n *\r\n * **See:** [ECExpressions Available in InstanceFilter]($docs/presentation/Hierarchies/ECExpressions.md#instance-filter).\r\n */\r\n instanceFilter?: string;\r\n}\r\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@itwin/presentation-common",
3
- "version": "3.0.0-extension.1",
3
+ "version": "3.1.0-dev.6",
4
4
  "description": "Common pieces for iModel.js presentation packages",
5
5
  "imodeljsSharedLibrary": true,
6
6
  "license": "MIT",
@@ -12,7 +12,7 @@
12
12
  "Bentley",
13
13
  "EC",
14
14
  "Presentation",
15
- "iModelJS"
15
+ "iTwin.js"
16
16
  ],
17
17
  "author": {
18
18
  "name": "Bentley Systems, Inc.",
@@ -22,16 +22,16 @@
22
22
  "module": "lib/esm/presentation-common.js",
23
23
  "typings": "lib/cjs/presentation-common",
24
24
  "peerDependencies": {
25
- "@itwin/core-bentley": "^3.0.0-extension.1",
26
- "@itwin/core-common": "^3.0.0-extension.1",
27
- "@itwin/core-quantity": "^3.0.0-extension.1"
25
+ "@itwin/core-bentley": "^3.1.0-dev.6",
26
+ "@itwin/core-common": "^3.1.0-dev.6",
27
+ "@itwin/core-quantity": "^3.1.0-dev.6"
28
28
  },
29
29
  "devDependencies": {
30
- "@itwin/core-bentley": "3.0.0-extension.1",
31
- "@itwin/build-tools": "3.0.0-extension.1",
32
- "@itwin/eslint-plugin": "3.0.0-extension.1",
33
- "@itwin/core-common": "3.0.0-extension.1",
34
- "@itwin/core-quantity": "3.0.0-extension.1",
30
+ "@itwin/build-tools": "3.1.0-dev.6",
31
+ "@itwin/core-bentley": "3.1.0-dev.6",
32
+ "@itwin/core-common": "3.1.0-dev.6",
33
+ "@itwin/core-quantity": "3.1.0-dev.6",
34
+ "@itwin/eslint-plugin": "3.1.0-dev.6",
35
35
  "@types/chai": "^4.1.4",
36
36
  "@types/chai-as-promised": "^7",
37
37
  "@types/chai-jest-snapshot": "^1.3.0",
@@ -46,7 +46,7 @@
46
46
  "chai-as-promised": "^7",
47
47
  "chai-jest-snapshot": "^2.0.0",
48
48
  "chai-subset": "1.6.0",
49
- "cpx": "^1.5.0",
49
+ "cpx2": "^3.0.0",
50
50
  "cross-env": "^5.1.4",
51
51
  "deep-equal": "^1",
52
52
  "eslint": "^7.11.0",
@@ -95,5 +95,6 @@
95
95
  "pseudolocalize:public": "betools pseudolocalize --englishDir ./assets/locales/en --out ./lib/public/locales/en-PSEUDO",
96
96
  "test": "mocha --config ../.mocharc.json --file ./lib/cjs/test/index.test.js \"./lib/cjs/test/**/*.test.js\"",
97
97
  "test:watch": "npm -s test -- --reporter min --watch-extensions ts --watch"
98
- }
98
+ },
99
+ "readme": "# @itwin/presentation-common\r\n\r\nCopyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md for license terms and full copyright notice.\r\n\r\n## Description\r\n\r\nThe __@itwin/presentation-common__ package contains types and classes for working with\r\niModel presentation data. The package can be used in both the frontend and backend.\r\n\r\n## Documentation\r\n\r\nSee the [iTwin.js](https://www.itwinjs.org) documentation for more information.\r\n"
99
100
  }