@itwin/presentation-common 3.2.0-dev.0 → 3.2.0-dev.5
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/rules/RelatedInstanceSpecification.d.ts +1 -1
- package/lib/cjs/presentation-common/rules/RelatedInstanceSpecification.js.map +1 -1
- package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.d.ts +2 -2
- package/lib/cjs/presentation-common/rules/RelationshipPathSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts +1 -1
- package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js.map +1 -1
- package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts +2 -2
- package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js.map +1 -1
- package/package.json +9 -9
|
@@ -55,7 +55,7 @@ import { RelationshipPathSpecification } from "./RelationshipPathSpecification";
|
|
|
55
55
|
* - The `LabelOverride` rule to use `modeledElement` alias to access properties of the joined related instance.
|
|
56
56
|
* - The `GroupingRule` to be applied because it's grouping `BisCore:Element` which is now part of the generated nodes.
|
|
57
57
|
*
|
|
58
|
-
* @see [More details]($docs/presentation/
|
|
58
|
+
* @see [More details]($docs/presentation/RelatedInstanceSpecification.md)
|
|
59
59
|
* @public
|
|
60
60
|
*/
|
|
61
61
|
export interface RelatedInstanceSpecification {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RelatedInstanceSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelatedInstanceSpecification.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 { RelationshipPathSpecification } from \"./RelationshipPathSpecification\";\r\n\r\n/**\r\n * This sub-specification allows joining the primary node instance with any number of related instances and creating\r\n * hierarchies based on a mix of those related instances.\r\n *\r\n * The related instance property values can be accessed from multiple different places:\r\n * - Instance filter\r\n * - Customization rule value\r\n * - Grouping rule\r\n *\r\n * **Example:**\r\n * ```JSON\r\n * {\r\n * \"id\": \"related_instance_example\",\r\n * \"rules\": [{\r\n * \"ruleType\": \"LabelOverride\",\r\n * \"condition\": \"ThisNode.IsInstanceNode ANDALSO this.IsOfClass(\\\"Model\\\", \\\"BisCore\\\")\",\r\n * \"label\": \"modeledElement.UserLabel\"\r\n * }, {\r\n * \"ruleType\": \"Grouping\",\r\n * \"condition\": \"ParentNode.IsNull\",\r\n * \"class\": {\r\n * \"schemaName\": \"BisCore\",\r\n * \"className\": \"Element\"\r\n * },\r\n * \"groups\": [{\r\n * \"specType\": \"Property\",\r\n * \"propertyName\": \"CodeValue\",\r\n * \"createGroupForSingleItem\": true\r\n * }]\r\n * }, {\r\n * \"ruleType\": \"RootNodes\",\r\n * \"specifications\": [{\r\n * \"specType\": \"InstanceNodesOfSpecificClasses\",\r\n * \"classes\": { \"schemaName\": \"BisCore\", \"classNames\": [\"GeometricModel\"] },\r\n * \"arePolymorphic\": true,\r\n * \"instanceFilter\": \"modeledElement.CodeNamespace = 1\",\r\n * \"relatedInstances\": [{\r\n * \"relationshipPath\": [{\r\n * \"relationship\": { \"schemaName\": \"BisCore\", \"className\": \"ModelModelsElement\" },\r\n * \"direction\": \"Forward\",\r\n * }],\r\n * \"class\": { \"schemaName\": \"BisCore\", \"className\": \"Element\" },\r\n * \"alias\": \"modeledElement\"\r\n * }]\r\n * }]\r\n * }]\r\n * }\r\n * ```\r\n * Here `BisCore:GeometricModel` instances are joined with `BisCore:Element` instances to create the hierarchy. This allows:\r\n * - Related `BisCore:Element` properties to be accessed in `InstanceFilter` using `modeledElement` alias.\r\n * - The `LabelOverride` rule to use `modeledElement` alias to access properties of the joined related instance.\r\n * - The `GroupingRule` to be applied because it's grouping `BisCore:Element` which is now part of the generated nodes.\r\n *\r\n * @see [More details]($docs/presentation/
|
|
1
|
+
{"version":3,"file":"RelatedInstanceSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelatedInstanceSpecification.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 { RelationshipPathSpecification } from \"./RelationshipPathSpecification\";\r\n\r\n/**\r\n * This sub-specification allows joining the primary node instance with any number of related instances and creating\r\n * hierarchies based on a mix of those related instances.\r\n *\r\n * The related instance property values can be accessed from multiple different places:\r\n * - Instance filter\r\n * - Customization rule value\r\n * - Grouping rule\r\n *\r\n * **Example:**\r\n * ```JSON\r\n * {\r\n * \"id\": \"related_instance_example\",\r\n * \"rules\": [{\r\n * \"ruleType\": \"LabelOverride\",\r\n * \"condition\": \"ThisNode.IsInstanceNode ANDALSO this.IsOfClass(\\\"Model\\\", \\\"BisCore\\\")\",\r\n * \"label\": \"modeledElement.UserLabel\"\r\n * }, {\r\n * \"ruleType\": \"Grouping\",\r\n * \"condition\": \"ParentNode.IsNull\",\r\n * \"class\": {\r\n * \"schemaName\": \"BisCore\",\r\n * \"className\": \"Element\"\r\n * },\r\n * \"groups\": [{\r\n * \"specType\": \"Property\",\r\n * \"propertyName\": \"CodeValue\",\r\n * \"createGroupForSingleItem\": true\r\n * }]\r\n * }, {\r\n * \"ruleType\": \"RootNodes\",\r\n * \"specifications\": [{\r\n * \"specType\": \"InstanceNodesOfSpecificClasses\",\r\n * \"classes\": { \"schemaName\": \"BisCore\", \"classNames\": [\"GeometricModel\"] },\r\n * \"arePolymorphic\": true,\r\n * \"instanceFilter\": \"modeledElement.CodeNamespace = 1\",\r\n * \"relatedInstances\": [{\r\n * \"relationshipPath\": [{\r\n * \"relationship\": { \"schemaName\": \"BisCore\", \"className\": \"ModelModelsElement\" },\r\n * \"direction\": \"Forward\",\r\n * }],\r\n * \"class\": { \"schemaName\": \"BisCore\", \"className\": \"Element\" },\r\n * \"alias\": \"modeledElement\"\r\n * }]\r\n * }]\r\n * }]\r\n * }\r\n * ```\r\n * Here `BisCore:GeometricModel` instances are joined with `BisCore:Element` instances to create the hierarchy. This allows:\r\n * - Related `BisCore:Element` properties to be accessed in `InstanceFilter` using `modeledElement` alias.\r\n * - The `LabelOverride` rule to use `modeledElement` alias to access properties of the joined related instance.\r\n * - The `GroupingRule` to be applied because it's grouping `BisCore:Element` which is now part of the generated nodes.\r\n *\r\n * @see [More details]($docs/presentation/RelatedInstanceSpecification.md)\r\n * @public\r\n */\r\nexport interface RelatedInstanceSpecification {\r\n /**\r\n * Relationship path to find the related instance.\r\n */\r\n relationshipPath: RelationshipPathSpecification;\r\n\r\n /**\r\n * The alias to give for the joined related instance. Used to reference the related instance in\r\n * instance filter and customization rules.\r\n *\r\n * **The value must be unique per-specification!**\r\n *\r\n * @pattern ^\\w[\\w\\d]*$\r\n */\r\n alias: string;\r\n\r\n /**\r\n * Is the related instance required to exist. If yes, primary instance won't be returned\r\n * if the related instance doesn't exist. If not, primary instance will be returned, but related\r\n * instance will be null.\r\n *\r\n * In SQL terms in can be compared to INNER JOIN vs OUTER JOIN.\r\n */\r\n isRequired?: boolean;\r\n}\r\n"]}
|
|
@@ -33,14 +33,14 @@ export interface RepeatableRelationshipStepSpecification extends RelationshipSte
|
|
|
33
33
|
/**
|
|
34
34
|
* Specification of a relationship path.
|
|
35
35
|
*
|
|
36
|
-
* @see [More details]($docs/presentation/
|
|
36
|
+
* @see [More details]($docs/presentation/RelationshipPathSpecification.md)
|
|
37
37
|
* @public
|
|
38
38
|
*/
|
|
39
39
|
export declare type RelationshipPathSpecification = RelationshipStepSpecification | RelationshipStepSpecification[];
|
|
40
40
|
/**
|
|
41
41
|
* Specification of a repeatable relationship path.
|
|
42
42
|
*
|
|
43
|
-
* @see [More details]($docs/presentation/
|
|
43
|
+
* @see [More details]($docs/presentation/RepeatableRelationshipPathSpecification.md)
|
|
44
44
|
* @public
|
|
45
45
|
*/
|
|
46
46
|
export declare type RepeatableRelationshipPathSpecification = RepeatableRelationshipStepSpecification | RepeatableRelationshipStepSpecification[];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RelationshipPathSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelationshipPathSpecification.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 { SingleSchemaClassSpecification } from \"./ClassSpecifications\";\r\nimport { RelationshipDirection } from \"./RelationshipDirection\";\r\n\r\n/**\r\n * Specification of a single relationship path step.\r\n * @public\r\n */\r\nexport interface RelationshipStepSpecification {\r\n /** Specification of the relationship to use for joining the related instance. */\r\n relationship: SingleSchemaClassSpecification;\r\n\r\n /** Relationship direction that should be followed to find the target class. */\r\n direction: RelationshipDirection.Forward | RelationshipDirection.Backward;\r\n\r\n /**\r\n * Specification of the target class. Either relationship's source or target class is used (based\r\n * on specified direction) if more specific target class is not specified by this attribute.\r\n */\r\n targetClass?: SingleSchemaClassSpecification;\r\n}\r\n\r\n/**\r\n * Specification of a single relationship path step.\r\n * @public\r\n */\r\nexport interface RepeatableRelationshipStepSpecification extends RelationshipStepSpecification {\r\n /**\r\n * Number of relationship steps that should be taken. Special `*` value means that\r\n * relationship is traversed recursively and all matching instances are accumulated.\r\n * Defaults to `1`.\r\n */\r\n count?: number | \"*\";\r\n}\r\n\r\n/**\r\n * Specification of a relationship path.\r\n *\r\n * @see [More details]($docs/presentation/
|
|
1
|
+
{"version":3,"file":"RelationshipPathSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelationshipPathSpecification.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 { SingleSchemaClassSpecification } from \"./ClassSpecifications\";\r\nimport { RelationshipDirection } from \"./RelationshipDirection\";\r\n\r\n/**\r\n * Specification of a single relationship path step.\r\n * @public\r\n */\r\nexport interface RelationshipStepSpecification {\r\n /** Specification of the relationship to use for joining the related instance. */\r\n relationship: SingleSchemaClassSpecification;\r\n\r\n /** Relationship direction that should be followed to find the target class. */\r\n direction: RelationshipDirection.Forward | RelationshipDirection.Backward;\r\n\r\n /**\r\n * Specification of the target class. Either relationship's source or target class is used (based\r\n * on specified direction) if more specific target class is not specified by this attribute.\r\n */\r\n targetClass?: SingleSchemaClassSpecification;\r\n}\r\n\r\n/**\r\n * Specification of a single relationship path step.\r\n * @public\r\n */\r\nexport interface RepeatableRelationshipStepSpecification extends RelationshipStepSpecification {\r\n /**\r\n * Number of relationship steps that should be taken. Special `*` value means that\r\n * relationship is traversed recursively and all matching instances are accumulated.\r\n * Defaults to `1`.\r\n */\r\n count?: number | \"*\";\r\n}\r\n\r\n/**\r\n * Specification of a relationship path.\r\n *\r\n * @see [More details]($docs/presentation/RelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport type RelationshipPathSpecification = RelationshipStepSpecification | RelationshipStepSpecification[];\r\n\r\n/**\r\n * Specification of a repeatable relationship path.\r\n *\r\n * @see [More details]($docs/presentation/RepeatableRelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport type RepeatableRelationshipPathSpecification = RepeatableRelationshipStepSpecification | RepeatableRelationshipStepSpecification[];\r\n"]}
|
|
@@ -55,7 +55,7 @@ import { RelationshipPathSpecification } from "./RelationshipPathSpecification";
|
|
|
55
55
|
* - The `LabelOverride` rule to use `modeledElement` alias to access properties of the joined related instance.
|
|
56
56
|
* - The `GroupingRule` to be applied because it's grouping `BisCore:Element` which is now part of the generated nodes.
|
|
57
57
|
*
|
|
58
|
-
* @see [More details]($docs/presentation/
|
|
58
|
+
* @see [More details]($docs/presentation/RelatedInstanceSpecification.md)
|
|
59
59
|
* @public
|
|
60
60
|
*/
|
|
61
61
|
export interface RelatedInstanceSpecification {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RelatedInstanceSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelatedInstanceSpecification.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 { RelationshipPathSpecification } from \"./RelationshipPathSpecification\";\r\n\r\n/**\r\n * This sub-specification allows joining the primary node instance with any number of related instances and creating\r\n * hierarchies based on a mix of those related instances.\r\n *\r\n * The related instance property values can be accessed from multiple different places:\r\n * - Instance filter\r\n * - Customization rule value\r\n * - Grouping rule\r\n *\r\n * **Example:**\r\n * ```JSON\r\n * {\r\n * \"id\": \"related_instance_example\",\r\n * \"rules\": [{\r\n * \"ruleType\": \"LabelOverride\",\r\n * \"condition\": \"ThisNode.IsInstanceNode ANDALSO this.IsOfClass(\\\"Model\\\", \\\"BisCore\\\")\",\r\n * \"label\": \"modeledElement.UserLabel\"\r\n * }, {\r\n * \"ruleType\": \"Grouping\",\r\n * \"condition\": \"ParentNode.IsNull\",\r\n * \"class\": {\r\n * \"schemaName\": \"BisCore\",\r\n * \"className\": \"Element\"\r\n * },\r\n * \"groups\": [{\r\n * \"specType\": \"Property\",\r\n * \"propertyName\": \"CodeValue\",\r\n * \"createGroupForSingleItem\": true\r\n * }]\r\n * }, {\r\n * \"ruleType\": \"RootNodes\",\r\n * \"specifications\": [{\r\n * \"specType\": \"InstanceNodesOfSpecificClasses\",\r\n * \"classes\": { \"schemaName\": \"BisCore\", \"classNames\": [\"GeometricModel\"] },\r\n * \"arePolymorphic\": true,\r\n * \"instanceFilter\": \"modeledElement.CodeNamespace = 1\",\r\n * \"relatedInstances\": [{\r\n * \"relationshipPath\": [{\r\n * \"relationship\": { \"schemaName\": \"BisCore\", \"className\": \"ModelModelsElement\" },\r\n * \"direction\": \"Forward\",\r\n * }],\r\n * \"class\": { \"schemaName\": \"BisCore\", \"className\": \"Element\" },\r\n * \"alias\": \"modeledElement\"\r\n * }]\r\n * }]\r\n * }]\r\n * }\r\n * ```\r\n * Here `BisCore:GeometricModel` instances are joined with `BisCore:Element` instances to create the hierarchy. This allows:\r\n * - Related `BisCore:Element` properties to be accessed in `InstanceFilter` using `modeledElement` alias.\r\n * - The `LabelOverride` rule to use `modeledElement` alias to access properties of the joined related instance.\r\n * - The `GroupingRule` to be applied because it's grouping `BisCore:Element` which is now part of the generated nodes.\r\n *\r\n * @see [More details]($docs/presentation/
|
|
1
|
+
{"version":3,"file":"RelatedInstanceSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelatedInstanceSpecification.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 { RelationshipPathSpecification } from \"./RelationshipPathSpecification\";\r\n\r\n/**\r\n * This sub-specification allows joining the primary node instance with any number of related instances and creating\r\n * hierarchies based on a mix of those related instances.\r\n *\r\n * The related instance property values can be accessed from multiple different places:\r\n * - Instance filter\r\n * - Customization rule value\r\n * - Grouping rule\r\n *\r\n * **Example:**\r\n * ```JSON\r\n * {\r\n * \"id\": \"related_instance_example\",\r\n * \"rules\": [{\r\n * \"ruleType\": \"LabelOverride\",\r\n * \"condition\": \"ThisNode.IsInstanceNode ANDALSO this.IsOfClass(\\\"Model\\\", \\\"BisCore\\\")\",\r\n * \"label\": \"modeledElement.UserLabel\"\r\n * }, {\r\n * \"ruleType\": \"Grouping\",\r\n * \"condition\": \"ParentNode.IsNull\",\r\n * \"class\": {\r\n * \"schemaName\": \"BisCore\",\r\n * \"className\": \"Element\"\r\n * },\r\n * \"groups\": [{\r\n * \"specType\": \"Property\",\r\n * \"propertyName\": \"CodeValue\",\r\n * \"createGroupForSingleItem\": true\r\n * }]\r\n * }, {\r\n * \"ruleType\": \"RootNodes\",\r\n * \"specifications\": [{\r\n * \"specType\": \"InstanceNodesOfSpecificClasses\",\r\n * \"classes\": { \"schemaName\": \"BisCore\", \"classNames\": [\"GeometricModel\"] },\r\n * \"arePolymorphic\": true,\r\n * \"instanceFilter\": \"modeledElement.CodeNamespace = 1\",\r\n * \"relatedInstances\": [{\r\n * \"relationshipPath\": [{\r\n * \"relationship\": { \"schemaName\": \"BisCore\", \"className\": \"ModelModelsElement\" },\r\n * \"direction\": \"Forward\",\r\n * }],\r\n * \"class\": { \"schemaName\": \"BisCore\", \"className\": \"Element\" },\r\n * \"alias\": \"modeledElement\"\r\n * }]\r\n * }]\r\n * }]\r\n * }\r\n * ```\r\n * Here `BisCore:GeometricModel` instances are joined with `BisCore:Element` instances to create the hierarchy. This allows:\r\n * - Related `BisCore:Element` properties to be accessed in `InstanceFilter` using `modeledElement` alias.\r\n * - The `LabelOverride` rule to use `modeledElement` alias to access properties of the joined related instance.\r\n * - The `GroupingRule` to be applied because it's grouping `BisCore:Element` which is now part of the generated nodes.\r\n *\r\n * @see [More details]($docs/presentation/RelatedInstanceSpecification.md)\r\n * @public\r\n */\r\nexport interface RelatedInstanceSpecification {\r\n /**\r\n * Relationship path to find the related instance.\r\n */\r\n relationshipPath: RelationshipPathSpecification;\r\n\r\n /**\r\n * The alias to give for the joined related instance. Used to reference the related instance in\r\n * instance filter and customization rules.\r\n *\r\n * **The value must be unique per-specification!**\r\n *\r\n * @pattern ^\\w[\\w\\d]*$\r\n */\r\n alias: string;\r\n\r\n /**\r\n * Is the related instance required to exist. If yes, primary instance won't be returned\r\n * if the related instance doesn't exist. If not, primary instance will be returned, but related\r\n * instance will be null.\r\n *\r\n * In SQL terms in can be compared to INNER JOIN vs OUTER JOIN.\r\n */\r\n isRequired?: boolean;\r\n}\r\n"]}
|
|
@@ -33,14 +33,14 @@ export interface RepeatableRelationshipStepSpecification extends RelationshipSte
|
|
|
33
33
|
/**
|
|
34
34
|
* Specification of a relationship path.
|
|
35
35
|
*
|
|
36
|
-
* @see [More details]($docs/presentation/
|
|
36
|
+
* @see [More details]($docs/presentation/RelationshipPathSpecification.md)
|
|
37
37
|
* @public
|
|
38
38
|
*/
|
|
39
39
|
export declare type RelationshipPathSpecification = RelationshipStepSpecification | RelationshipStepSpecification[];
|
|
40
40
|
/**
|
|
41
41
|
* Specification of a repeatable relationship path.
|
|
42
42
|
*
|
|
43
|
-
* @see [More details]($docs/presentation/
|
|
43
|
+
* @see [More details]($docs/presentation/RepeatableRelationshipPathSpecification.md)
|
|
44
44
|
* @public
|
|
45
45
|
*/
|
|
46
46
|
export declare type RepeatableRelationshipPathSpecification = RepeatableRelationshipStepSpecification | RepeatableRelationshipStepSpecification[];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RelationshipPathSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelationshipPathSpecification.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 { SingleSchemaClassSpecification } from \"./ClassSpecifications\";\r\nimport { RelationshipDirection } from \"./RelationshipDirection\";\r\n\r\n/**\r\n * Specification of a single relationship path step.\r\n * @public\r\n */\r\nexport interface RelationshipStepSpecification {\r\n /** Specification of the relationship to use for joining the related instance. */\r\n relationship: SingleSchemaClassSpecification;\r\n\r\n /** Relationship direction that should be followed to find the target class. */\r\n direction: RelationshipDirection.Forward | RelationshipDirection.Backward;\r\n\r\n /**\r\n * Specification of the target class. Either relationship's source or target class is used (based\r\n * on specified direction) if more specific target class is not specified by this attribute.\r\n */\r\n targetClass?: SingleSchemaClassSpecification;\r\n}\r\n\r\n/**\r\n * Specification of a single relationship path step.\r\n * @public\r\n */\r\nexport interface RepeatableRelationshipStepSpecification extends RelationshipStepSpecification {\r\n /**\r\n * Number of relationship steps that should be taken. Special `*` value means that\r\n * relationship is traversed recursively and all matching instances are accumulated.\r\n * Defaults to `1`.\r\n */\r\n count?: number | \"*\";\r\n}\r\n\r\n/**\r\n * Specification of a relationship path.\r\n *\r\n * @see [More details]($docs/presentation/
|
|
1
|
+
{"version":3,"file":"RelationshipPathSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelationshipPathSpecification.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 { SingleSchemaClassSpecification } from \"./ClassSpecifications\";\r\nimport { RelationshipDirection } from \"./RelationshipDirection\";\r\n\r\n/**\r\n * Specification of a single relationship path step.\r\n * @public\r\n */\r\nexport interface RelationshipStepSpecification {\r\n /** Specification of the relationship to use for joining the related instance. */\r\n relationship: SingleSchemaClassSpecification;\r\n\r\n /** Relationship direction that should be followed to find the target class. */\r\n direction: RelationshipDirection.Forward | RelationshipDirection.Backward;\r\n\r\n /**\r\n * Specification of the target class. Either relationship's source or target class is used (based\r\n * on specified direction) if more specific target class is not specified by this attribute.\r\n */\r\n targetClass?: SingleSchemaClassSpecification;\r\n}\r\n\r\n/**\r\n * Specification of a single relationship path step.\r\n * @public\r\n */\r\nexport interface RepeatableRelationshipStepSpecification extends RelationshipStepSpecification {\r\n /**\r\n * Number of relationship steps that should be taken. Special `*` value means that\r\n * relationship is traversed recursively and all matching instances are accumulated.\r\n * Defaults to `1`.\r\n */\r\n count?: number | \"*\";\r\n}\r\n\r\n/**\r\n * Specification of a relationship path.\r\n *\r\n * @see [More details]($docs/presentation/RelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport type RelationshipPathSpecification = RelationshipStepSpecification | RelationshipStepSpecification[];\r\n\r\n/**\r\n * Specification of a repeatable relationship path.\r\n *\r\n * @see [More details]($docs/presentation/RepeatableRelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport type RepeatableRelationshipPathSpecification = RepeatableRelationshipStepSpecification | RepeatableRelationshipStepSpecification[];\r\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@itwin/presentation-common",
|
|
3
|
-
"version": "3.2.0-dev.
|
|
3
|
+
"version": "3.2.0-dev.5",
|
|
4
4
|
"description": "Common pieces for iModel.js presentation packages",
|
|
5
5
|
"imodeljsSharedLibrary": true,
|
|
6
6
|
"license": "MIT",
|
|
@@ -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.2.0-dev.
|
|
26
|
-
"@itwin/core-common": "^3.2.0-dev.
|
|
27
|
-
"@itwin/core-quantity": "^3.2.0-dev.
|
|
25
|
+
"@itwin/core-bentley": "^3.2.0-dev.5",
|
|
26
|
+
"@itwin/core-common": "^3.2.0-dev.5",
|
|
27
|
+
"@itwin/core-quantity": "^3.2.0-dev.5"
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
30
|
-
"@itwin/build-tools": "3.2.0-dev.
|
|
31
|
-
"@itwin/core-bentley": "3.2.0-dev.
|
|
32
|
-
"@itwin/core-common": "3.2.0-dev.
|
|
33
|
-
"@itwin/core-quantity": "3.2.0-dev.
|
|
34
|
-
"@itwin/eslint-plugin": "3.2.0-dev.
|
|
30
|
+
"@itwin/build-tools": "3.2.0-dev.5",
|
|
31
|
+
"@itwin/core-bentley": "3.2.0-dev.5",
|
|
32
|
+
"@itwin/core-common": "3.2.0-dev.5",
|
|
33
|
+
"@itwin/core-quantity": "3.2.0-dev.5",
|
|
34
|
+
"@itwin/eslint-plugin": "3.2.0-dev.5",
|
|
35
35
|
"@types/chai": "^4.1.4",
|
|
36
36
|
"@types/chai-as-promised": "^7",
|
|
37
37
|
"@types/chai-jest-snapshot": "^1.3.0",
|