@itwin/presentation-testing 4.0.0-dev.7 → 4.0.0-dev.9
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/CHANGELOG.md +927 -959
- package/LICENSE.md +9 -9
- package/README.md +7 -7
- package/lib/cjs/presentation-testing/ContentBuilder.d.ts +92 -89
- package/lib/cjs/presentation-testing/ContentBuilder.d.ts.map +1 -1
- package/lib/cjs/presentation-testing/ContentBuilder.js +178 -149
- package/lib/cjs/presentation-testing/ContentBuilder.js.map +1 -1
- package/lib/cjs/presentation-testing/Helpers.d.ts +45 -42
- package/lib/cjs/presentation-testing/Helpers.d.ts.map +1 -1
- package/lib/cjs/presentation-testing/Helpers.js +138 -139
- package/lib/cjs/presentation-testing/Helpers.js.map +1 -1
- package/lib/cjs/presentation-testing/HierarchyBuilder.d.ts +69 -66
- package/lib/cjs/presentation-testing/HierarchyBuilder.d.ts.map +1 -1
- package/lib/cjs/presentation-testing/HierarchyBuilder.js +78 -67
- package/lib/cjs/presentation-testing/HierarchyBuilder.js.map +1 -1
- package/lib/cjs/presentation-testing/IModelUtilities.d.ts +46 -46
- package/lib/cjs/presentation-testing/IModelUtilities.d.ts.map +1 -1
- package/lib/cjs/presentation-testing/IModelUtilities.js +83 -77
- package/lib/cjs/presentation-testing/IModelUtilities.js.map +1 -1
- package/lib/cjs/presentation-testing.d.ts +28 -28
- package/lib/cjs/presentation-testing.d.ts.map +1 -1
- package/lib/cjs/presentation-testing.js +44 -44
- package/lib/cjs/presentation-testing.js.map +1 -1
- package/lib/esm/presentation-testing/ContentBuilder.d.ts +92 -89
- package/lib/esm/presentation-testing/ContentBuilder.d.ts.map +1 -1
- package/lib/esm/presentation-testing/ContentBuilder.js +174 -145
- package/lib/esm/presentation-testing/ContentBuilder.js.map +1 -1
- package/lib/esm/presentation-testing/Helpers.d.ts +45 -42
- package/lib/esm/presentation-testing/Helpers.d.ts.map +1 -1
- package/lib/esm/presentation-testing/Helpers.js +113 -114
- package/lib/esm/presentation-testing/Helpers.js.map +1 -1
- package/lib/esm/presentation-testing/HierarchyBuilder.d.ts +69 -66
- package/lib/esm/presentation-testing/HierarchyBuilder.d.ts.map +1 -1
- package/lib/esm/presentation-testing/HierarchyBuilder.js +73 -62
- package/lib/esm/presentation-testing/HierarchyBuilder.js.map +1 -1
- package/lib/esm/presentation-testing/IModelUtilities.d.ts +46 -46
- package/lib/esm/presentation-testing/IModelUtilities.d.ts.map +1 -1
- package/lib/esm/presentation-testing/IModelUtilities.js +75 -69
- package/lib/esm/presentation-testing/IModelUtilities.js.map +1 -1
- package/lib/esm/presentation-testing.d.ts +28 -28
- package/lib/esm/presentation-testing.d.ts.map +1 -1
- package/lib/esm/presentation-testing.js +32 -32
- package/lib/esm/presentation-testing.js.map +1 -1
- package/package.json +53 -53
|
@@ -1,29 +1,29 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @module Hierarchies
|
|
3
|
-
*
|
|
4
|
-
* @docs-group-description Hierarchies
|
|
5
|
-
* Types for testing hierarchies.
|
|
6
|
-
*/
|
|
7
|
-
export * from "./presentation-testing/HierarchyBuilder";
|
|
8
|
-
/**
|
|
9
|
-
* @module Content
|
|
10
|
-
*
|
|
11
|
-
* @docs-group-description Content
|
|
12
|
-
* Types for testing content.
|
|
13
|
-
*/
|
|
14
|
-
export * from "./presentation-testing/ContentBuilder";
|
|
15
|
-
/**
|
|
16
|
-
* @module Helpers
|
|
17
|
-
*
|
|
18
|
-
* @docs-group-description Helpers
|
|
19
|
-
* Various test helpers.
|
|
20
|
-
*/
|
|
21
|
-
export * from "./presentation-testing/Helpers";
|
|
22
|
-
/**
|
|
23
|
-
* @module IModel
|
|
24
|
-
*
|
|
25
|
-
* @docs-group-description IModel
|
|
26
|
-
* Utilities for creating test iModels that can be used to exercise presentation rules.
|
|
27
|
-
*/
|
|
28
|
-
export * from "./presentation-testing/IModelUtilities";
|
|
1
|
+
/**
|
|
2
|
+
* @module Hierarchies
|
|
3
|
+
*
|
|
4
|
+
* @docs-group-description Hierarchies
|
|
5
|
+
* Types for testing hierarchies.
|
|
6
|
+
*/
|
|
7
|
+
export * from "./presentation-testing/HierarchyBuilder";
|
|
8
|
+
/**
|
|
9
|
+
* @module Content
|
|
10
|
+
*
|
|
11
|
+
* @docs-group-description Content
|
|
12
|
+
* Types for testing content.
|
|
13
|
+
*/
|
|
14
|
+
export * from "./presentation-testing/ContentBuilder";
|
|
15
|
+
/**
|
|
16
|
+
* @module Helpers
|
|
17
|
+
*
|
|
18
|
+
* @docs-group-description Helpers
|
|
19
|
+
* Various test helpers.
|
|
20
|
+
*/
|
|
21
|
+
export * from "./presentation-testing/Helpers";
|
|
22
|
+
/**
|
|
23
|
+
* @module IModel
|
|
24
|
+
*
|
|
25
|
+
* @docs-group-description IModel
|
|
26
|
+
* Utilities for creating test iModels that can be used to exercise presentation rules.
|
|
27
|
+
*/
|
|
28
|
+
export * from "./presentation-testing/IModelUtilities";
|
|
29
29
|
//# sourceMappingURL=presentation-testing.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"presentation-testing.d.ts","sourceRoot":"","sources":["../../src/presentation-testing.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"presentation-testing.d.ts","sourceRoot":"","sources":["../../src/presentation-testing.ts"],"names":[],"mappings":"AAKA;;;;;GAKG;AACH,cAAc,yCAAyC,CAAC;AAExD;;;;;GAKG;AACH,cAAc,uCAAuC,CAAC;AAEtD;;;;;GAKG;AACH,cAAc,gCAAgC,CAAC;AAE/C;;;;;GAKG;AACH,cAAc,wCAAwC,CAAC"}
|
|
@@ -1,45 +1,45 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
})
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
/**
|
|
18
|
-
* @module Hierarchies
|
|
19
|
-
*
|
|
20
|
-
* @docs-group-description Hierarchies
|
|
21
|
-
* Types for testing hierarchies.
|
|
22
|
-
*/
|
|
23
|
-
__exportStar(require("./presentation-testing/HierarchyBuilder"), exports);
|
|
24
|
-
/**
|
|
25
|
-
* @module Content
|
|
26
|
-
*
|
|
27
|
-
* @docs-group-description Content
|
|
28
|
-
* Types for testing content.
|
|
29
|
-
*/
|
|
30
|
-
__exportStar(require("./presentation-testing/ContentBuilder"), exports);
|
|
31
|
-
/**
|
|
32
|
-
* @module Helpers
|
|
33
|
-
*
|
|
34
|
-
* @docs-group-description Helpers
|
|
35
|
-
* Various test helpers.
|
|
36
|
-
*/
|
|
37
|
-
__exportStar(require("./presentation-testing/Helpers"), exports);
|
|
38
|
-
/**
|
|
39
|
-
* @module IModel
|
|
40
|
-
*
|
|
41
|
-
* @docs-group-description IModel
|
|
42
|
-
* Utilities for creating test iModels that can be used to exercise presentation rules.
|
|
43
|
-
*/
|
|
44
|
-
__exportStar(require("./presentation-testing/IModelUtilities"), exports);
|
|
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
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
7
|
+
if (k2 === undefined) k2 = k;
|
|
8
|
+
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
/**
|
|
18
|
+
* @module Hierarchies
|
|
19
|
+
*
|
|
20
|
+
* @docs-group-description Hierarchies
|
|
21
|
+
* Types for testing hierarchies.
|
|
22
|
+
*/
|
|
23
|
+
__exportStar(require("./presentation-testing/HierarchyBuilder"), exports);
|
|
24
|
+
/**
|
|
25
|
+
* @module Content
|
|
26
|
+
*
|
|
27
|
+
* @docs-group-description Content
|
|
28
|
+
* Types for testing content.
|
|
29
|
+
*/
|
|
30
|
+
__exportStar(require("./presentation-testing/ContentBuilder"), exports);
|
|
31
|
+
/**
|
|
32
|
+
* @module Helpers
|
|
33
|
+
*
|
|
34
|
+
* @docs-group-description Helpers
|
|
35
|
+
* Various test helpers.
|
|
36
|
+
*/
|
|
37
|
+
__exportStar(require("./presentation-testing/Helpers"), exports);
|
|
38
|
+
/**
|
|
39
|
+
* @module IModel
|
|
40
|
+
*
|
|
41
|
+
* @docs-group-description IModel
|
|
42
|
+
* Utilities for creating test iModels that can be used to exercise presentation rules.
|
|
43
|
+
*/
|
|
44
|
+
__exportStar(require("./presentation-testing/IModelUtilities"), exports);
|
|
45
45
|
//# sourceMappingURL=presentation-testing.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"presentation-testing.js","sourceRoot":"","sources":["../../src/presentation-testing.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"presentation-testing.js","sourceRoot":"","sources":["../../src/presentation-testing.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;;;;;;;;;;AAE/F;;;;;GAKG;AACH,0EAAwD;AAExD;;;;;GAKG;AACH,wEAAsD;AAEtD;;;;;GAKG;AACH,iEAA+C;AAE/C;;;;;GAKG;AACH,yEAAuD","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\n/**\n * @module Hierarchies\n *\n * @docs-group-description Hierarchies\n * Types for testing hierarchies.\n */\nexport * from \"./presentation-testing/HierarchyBuilder\";\n\n/**\n * @module Content\n *\n * @docs-group-description Content\n * Types for testing content.\n */\nexport * from \"./presentation-testing/ContentBuilder\";\n\n/**\n * @module Helpers\n *\n * @docs-group-description Helpers\n * Various test helpers.\n */\nexport * from \"./presentation-testing/Helpers\";\n\n/**\n * @module IModel\n *\n * @docs-group-description IModel\n * Utilities for creating test iModels that can be used to exercise presentation rules.\n */\nexport * from \"./presentation-testing/IModelUtilities\";\n"]}
|
|
@@ -1,90 +1,93 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
records
|
|
25
|
-
|
|
26
|
-
/**
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
* @
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
* @
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
1
|
+
/** @packageDocumentation
|
|
2
|
+
* @module Content
|
|
3
|
+
*/
|
|
4
|
+
import { PropertyRecord } from "@itwin/appui-abstract";
|
|
5
|
+
import { IModelConnection } from "@itwin/core-frontend";
|
|
6
|
+
import { Content, InstanceKey, KeySet, PageOptions, Ruleset } from "@itwin/presentation-common";
|
|
7
|
+
/**
|
|
8
|
+
* Interface for a data provider, which is used by ContentBuilder.
|
|
9
|
+
* @public
|
|
10
|
+
*/
|
|
11
|
+
export interface IContentBuilderDataProvider {
|
|
12
|
+
/** Keys the data provider is creating content for */
|
|
13
|
+
keys: Readonly<KeySet>;
|
|
14
|
+
/** Get the size of content result set */
|
|
15
|
+
getContentSetSize: () => Promise<number>;
|
|
16
|
+
/** Get the content */
|
|
17
|
+
getContent: (options?: PageOptions) => Promise<Readonly<Content> | undefined>;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Property records grouped under a single className
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
23
|
+
export interface ContentBuilderResult {
|
|
24
|
+
/** Full name of ECClass whose records are contained in this data structure */
|
|
25
|
+
className: string;
|
|
26
|
+
/** Property records for the ECClass instance */
|
|
27
|
+
records: PropertyRecord[];
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Properties for creating a `ContentBuilder` instance.
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
export interface ContentBuilderProps {
|
|
34
|
+
/** The iModel to pull data from */
|
|
35
|
+
imodel: IModelConnection;
|
|
36
|
+
/** Custom data provider that allows mocking data ContentBuilder receives */
|
|
37
|
+
dataProvider?: IContentBuilderDataProvider;
|
|
38
|
+
/**
|
|
39
|
+
* Decimal precision or numeric types.
|
|
40
|
+
*
|
|
41
|
+
* Raw numeric values with high precision may slightly differ from platform to platform due to
|
|
42
|
+
* rounding differences on different platforms. This may be a problem when used with snapshot testing,
|
|
43
|
+
* in which case this attribute may be set to supply the maximum precision of raw numeric values.
|
|
44
|
+
*
|
|
45
|
+
* By default no rounding is applied.
|
|
46
|
+
*/
|
|
47
|
+
decimalPrecision?: number;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* A class that constructs content from specified imodel and ruleset.
|
|
51
|
+
* @public
|
|
52
|
+
*/
|
|
53
|
+
export declare class ContentBuilder {
|
|
54
|
+
private readonly _iModel;
|
|
55
|
+
private _dataProvider;
|
|
56
|
+
private _decimalPrecision?;
|
|
57
|
+
/**
|
|
58
|
+
* Constructor
|
|
59
|
+
* @param iModel
|
|
60
|
+
* @param dataProvider
|
|
61
|
+
*/
|
|
62
|
+
constructor(props: ContentBuilderProps);
|
|
63
|
+
private doCreateContent;
|
|
64
|
+
/**
|
|
65
|
+
* Create a list of property records using the supplied presentation ruleset.
|
|
66
|
+
* @param rulesetOrId Either a [[Ruleset]] object or a ruleset id.
|
|
67
|
+
* @param instanceKeys Keys of instances that should be queried.
|
|
68
|
+
* @param displayType Type of content container display. For example:
|
|
69
|
+
* "PropertyPane", "Grid", "List" etc.
|
|
70
|
+
*/
|
|
71
|
+
createContent(rulesetOrId: Ruleset | string, instanceKeys: InstanceKey[], displayType?: string): Promise<PropertyRecord[]>;
|
|
72
|
+
private getECClassNames;
|
|
73
|
+
private createContentForClasses;
|
|
74
|
+
/**
|
|
75
|
+
* Create a list of grouped property records using the supplied presentation ruleset.
|
|
76
|
+
* Each group includes all of the class instances.
|
|
77
|
+
* @param rulesetOrId Either a [[Ruleset]] object or a ruleset id.
|
|
78
|
+
* @param displayType Type of content container display. For example:
|
|
79
|
+
* "PropertyPane", "Grid", "List" etc.
|
|
80
|
+
* @deprecated in 3.x. This method turned out to be useless as it creates content for too many instances. Should use [[createContent]] instead.
|
|
81
|
+
*/
|
|
82
|
+
createContentForAllInstances(rulesetOrId: Ruleset | string, displayType?: string): Promise<ContentBuilderResult[]>;
|
|
83
|
+
/**
|
|
84
|
+
* Create a list of grouped property records using the supplied presentation ruleset.
|
|
85
|
+
* Each group includes at most one class instance.
|
|
86
|
+
* @param rulesetOrId Either a [[Ruleset]] object or a ruleset id.
|
|
87
|
+
* @param displayType Type of content container display. For example:
|
|
88
|
+
* "PropertyPane", "Grid", "List" etc.
|
|
89
|
+
* @deprecated in 3.x. This method turned out to be useless as it creates content for too many instances. Should use [[createContent]] instead.
|
|
90
|
+
*/
|
|
91
|
+
createContentForInstancePerClass(rulesetOrId: Ruleset | string, displayType?: string): Promise<ContentBuilderResult[]>;
|
|
92
|
+
}
|
|
90
93
|
//# sourceMappingURL=ContentBuilder.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ContentBuilder.d.ts","sourceRoot":"","sources":["../../../src/presentation-testing/ContentBuilder.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"ContentBuilder.d.ts","sourceRoot":"","sources":["../../../src/presentation-testing/ContentBuilder.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAGvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EACL,OAAO,EAA8B,WAAW,EAAE,MAAM,EAAE,WAAW,EAAiD,OAAO,EAE9H,MAAM,4BAA4B,CAAC;AAIpC;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,qDAAqD;IACrD,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IACvB,yCAAyC;IACzC,iBAAiB,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IACzC,sBAAsB;IACtB,UAAU,EAAE,CAAC,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC,CAAC;CAC/E;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,8EAA8E;IAC9E,SAAS,EAAE,MAAM,CAAC;IAClB,gDAAgD;IAChD,OAAO,EAAE,cAAc,EAAE,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,mCAAmC;IACnC,MAAM,EAAE,gBAAgB,CAAC;IAEzB,4EAA4E;IAC5E,YAAY,CAAC,EAAE,2BAA2B,CAAC;IAE3C;;;;;;;;OAQG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAmB;IAC3C,OAAO,CAAC,aAAa,CAA0C;IAC/D,OAAO,CAAC,iBAAiB,CAAC,CAAS;IAEnC;;;;OAIG;gBACS,KAAK,EAAE,mBAAmB;YAMxB,eAAe;IAa7B;;;;;;OAMG;IACU,aAAa,CAAC,WAAW,EAAE,OAAO,GAAG,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,EAAE,WAAW,GAAE,MAAgD;YAStI,eAAe;YAaf,uBAAuB;IA4BrC;;;;;;;OAOG;IACU,4BAA4B,CAAC,WAAW,EAAE,OAAO,GAAG,MAAM,EAAE,WAAW,GAAE,MAAgD;IAItI;;;;;;;OAOG;IACU,gCAAgC,CAAC,WAAW,EAAE,OAAO,GAAG,MAAM,EAAE,WAAW,GAAE,MAAgD;CAG3I"}
|