@combeenation/3d-viewer 12.4.1 → 12.4.2-rc1
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/README.md +9 -9
- package/dist/lib-cjs/api/classes/animationInterface.d.ts +8 -8
- package/dist/lib-cjs/api/classes/animationInterface.js +2 -2
- package/dist/lib-cjs/api/classes/dottedPath.d.ts +79 -79
- package/dist/lib-cjs/api/classes/dottedPath.js +166 -166
- package/dist/lib-cjs/api/classes/element.d.ts +153 -153
- package/dist/lib-cjs/api/classes/element.js +702 -702
- package/dist/lib-cjs/api/classes/event.d.ts +401 -401
- package/dist/lib-cjs/api/classes/event.js +424 -424
- package/dist/lib-cjs/api/classes/eventBroadcaster.d.ts +26 -26
- package/dist/lib-cjs/api/classes/eventBroadcaster.js +49 -49
- package/dist/lib-cjs/api/classes/fuzzyMap.d.ts +7 -7
- package/dist/lib-cjs/api/classes/fuzzyMap.js +21 -21
- package/dist/lib-cjs/api/classes/parameter.d.ts +410 -410
- package/dist/lib-cjs/api/classes/parameter.js +642 -642
- package/dist/lib-cjs/api/classes/parameterObservable.d.ts +36 -36
- package/dist/lib-cjs/api/classes/parameterObservable.js +72 -72
- package/dist/lib-cjs/api/classes/parameterizable.d.ts +15 -15
- package/dist/lib-cjs/api/classes/parameterizable.js +102 -102
- package/dist/lib-cjs/api/classes/placementAnimation.d.ts +45 -45
- package/dist/lib-cjs/api/classes/placementAnimation.js +176 -176
- package/dist/lib-cjs/api/classes/variant.d.ts +261 -261
- package/dist/lib-cjs/api/classes/variant.js +872 -872
- package/dist/lib-cjs/api/classes/variantInstance.d.ts +53 -53
- package/dist/lib-cjs/api/classes/variantInstance.js +125 -125
- package/dist/lib-cjs/api/classes/variantParameterizable.d.ts +17 -17
- package/dist/lib-cjs/api/classes/variantParameterizable.js +86 -86
- package/dist/lib-cjs/api/classes/viewer.d.ts +215 -215
- package/dist/lib-cjs/api/classes/viewer.js +708 -708
- package/dist/lib-cjs/api/classes/viewerError.d.ts +43 -43
- package/dist/lib-cjs/api/classes/viewerError.js +55 -55
- package/dist/lib-cjs/api/classes/viewerLight.d.ts +66 -66
- package/dist/lib-cjs/api/classes/viewerLight.js +344 -344
- package/dist/lib-cjs/api/internal/lensRendering.d.ts +8 -8
- package/dist/lib-cjs/api/internal/lensRendering.js +11 -11
- package/dist/lib-cjs/api/internal/sceneSetup.d.ts +13 -13
- package/dist/lib-cjs/api/internal/sceneSetup.js +227 -227
- package/dist/lib-cjs/api/manager/animationManager.d.ts +30 -30
- package/dist/lib-cjs/api/manager/animationManager.js +126 -126
- package/dist/lib-cjs/api/manager/gltfExportManager.d.ts +89 -80
- package/dist/lib-cjs/api/manager/gltfExportManager.js +311 -299
- package/dist/lib-cjs/api/manager/gltfExportManager.js.map +1 -1
- package/dist/lib-cjs/api/manager/sceneManager.d.ts +33 -33
- package/dist/lib-cjs/api/manager/sceneManager.js +128 -128
- package/dist/lib-cjs/api/manager/tagManager.d.ts +118 -118
- package/dist/lib-cjs/api/manager/tagManager.js +530 -530
- package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +22 -22
- package/dist/lib-cjs/api/manager/textureLoadManager.js +107 -107
- package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +106 -106
- package/dist/lib-cjs/api/manager/variantInstanceManager.js +290 -290
- package/dist/lib-cjs/api/store/specStorage.d.ts +32 -32
- package/dist/lib-cjs/api/store/specStorage.js +65 -65
- package/dist/lib-cjs/api/util/babylonHelper.d.ts +238 -238
- package/dist/lib-cjs/api/util/babylonHelper.js +825 -825
- package/dist/lib-cjs/api/util/debugHelper.d.ts +9 -9
- package/dist/lib-cjs/api/util/debugHelper.js +93 -93
- package/dist/lib-cjs/api/util/deviceHelper.d.ts +9 -9
- package/dist/lib-cjs/api/util/deviceHelper.js +28 -28
- package/dist/lib-cjs/api/util/geometryHelper.d.ts +17 -17
- package/dist/lib-cjs/api/util/geometryHelper.js +112 -112
- package/dist/lib-cjs/api/util/globalTypes.d.ts +490 -490
- package/dist/lib-cjs/api/util/globalTypes.js +1 -1
- package/dist/lib-cjs/api/util/resourceHelper.d.ts +58 -58
- package/dist/lib-cjs/api/util/resourceHelper.js +214 -214
- package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +58 -58
- package/dist/lib-cjs/api/util/sceneLoaderHelper.js +228 -228
- package/dist/lib-cjs/api/util/stringHelper.d.ts +13 -13
- package/dist/lib-cjs/api/util/stringHelper.js +32 -32
- package/dist/lib-cjs/api/util/structureHelper.d.ts +9 -9
- package/dist/lib-cjs/api/util/structureHelper.js +57 -57
- package/dist/lib-cjs/buildinfo.json +3 -3
- package/dist/lib-cjs/commonjs.tsconfig.tsbuildinfo +1 -1
- package/dist/lib-cjs/index.d.ts +63 -63
- package/dist/lib-cjs/index.js +128 -128
- package/package.json +92 -92
- package/src/api/classes/animationInterface.ts +10 -10
- package/src/api/classes/dottedPath.ts +181 -181
- package/src/api/classes/element.ts +766 -766
- package/src/api/classes/event.ts +457 -457
- package/src/api/classes/eventBroadcaster.ts +52 -52
- package/src/api/classes/fuzzyMap.ts +21 -21
- package/src/api/classes/parameter.ts +686 -686
- package/src/api/classes/parameterObservable.ts +73 -73
- package/src/api/classes/parameterizable.ts +87 -87
- package/src/api/classes/placementAnimation.ts +162 -162
- package/src/api/classes/variant.ts +965 -965
- package/src/api/classes/variantInstance.ts +123 -123
- package/src/api/classes/variantParameterizable.ts +83 -83
- package/src/api/classes/viewer.ts +751 -751
- package/src/api/classes/viewerError.ts +63 -63
- package/src/api/classes/viewerLight.ts +335 -335
- package/src/api/internal/debugViewer.ts +90 -90
- package/src/api/internal/lensRendering.ts +9 -9
- package/src/api/internal/sceneSetup.ts +208 -208
- package/src/api/manager/animationManager.ts +143 -143
- package/src/api/manager/gltfExportManager.ts +350 -334
- package/src/api/manager/sceneManager.ts +134 -134
- package/src/api/manager/tagManager.ts +572 -572
- package/src/api/manager/textureLoadManager.ts +107 -107
- package/src/api/manager/variantInstanceManager.ts +306 -306
- package/src/api/store/specStorage.ts +68 -68
- package/src/api/util/babylonHelper.ts +915 -915
- package/src/api/util/debugHelper.ts +121 -121
- package/src/api/util/deviceHelper.ts +31 -31
- package/src/api/util/geometryHelper.ts +142 -142
- package/src/api/util/globalTypes.ts +566 -566
- package/src/api/util/resourceHelper.ts +201 -201
- package/src/api/util/sceneLoaderHelper.ts +247 -247
- package/src/api/util/stringHelper.ts +30 -30
- package/src/api/util/structureHelper.ts +62 -62
- package/src/buildinfo.json +3 -3
- package/src/dev.ts +70 -70
- package/src/index.ts +116 -116
- package/src/types.d.ts +49 -49
package/README.md
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
# 3D viewer
|
|
2
|
-
|
|
3
|
-
## Basic setup
|
|
4
|
-
|
|
5
|
-
See [Combeenation docs](https://docs.combeenation.com/) (especially [this](https://docs.combeenation.com/v1/docs/3d-viewer-control) & [this](https://docs.combeenation.com/docs/3d-viewer-control-with-custom-js)) on how to setup a Combeenation configurator with the 3d viewer.
|
|
6
|
-
|
|
7
|
-
## API
|
|
8
|
-
|
|
9
|
-
The docs here contain detailed info about the viewer API which can be used from [Custom JS](https://docs.combeenation.com/v1/docs/custom-js) as explained [here](https://docs.combeenation.com/docs/3d-viewer-control-with-custom-js).
|
|
1
|
+
# 3D viewer
|
|
2
|
+
|
|
3
|
+
## Basic setup
|
|
4
|
+
|
|
5
|
+
See [Combeenation docs](https://docs.combeenation.com/) (especially [this](https://docs.combeenation.com/v1/docs/3d-viewer-control) & [this](https://docs.combeenation.com/docs/3d-viewer-control-with-custom-js)) on how to setup a Combeenation configurator with the 3d viewer.
|
|
6
|
+
|
|
7
|
+
## API
|
|
8
|
+
|
|
9
|
+
The docs here contain detailed info about the viewer API which can be used from [Custom JS](https://docs.combeenation.com/v1/docs/custom-js) as explained [here](https://docs.combeenation.com/docs/3d-viewer-control-with-custom-js).
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* An Interface defining the basic functionality of an animation.
|
|
3
|
-
*/
|
|
4
|
-
export interface AnimationInterface {
|
|
5
|
-
play(): Promise<AnimationInterface>;
|
|
6
|
-
pause(): AnimationInterface;
|
|
7
|
-
kill(): AnimationInterface;
|
|
8
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* An Interface defining the basic functionality of an animation.
|
|
3
|
+
*/
|
|
4
|
+
export interface AnimationInterface {
|
|
5
|
+
play(): Promise<AnimationInterface>;
|
|
6
|
+
pause(): AnimationInterface;
|
|
7
|
+
kill(): AnimationInterface;
|
|
8
|
+
}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
//# sourceMappingURL=animationInterface.js.map
|
|
@@ -1,79 +1,79 @@
|
|
|
1
|
-
export declare class DottedPath {
|
|
2
|
-
static DELIMITER: string;
|
|
3
|
-
static SAFE_CHAR: string;
|
|
4
|
-
parts: string[];
|
|
5
|
-
/**
|
|
6
|
-
* Magic factory function that creates a DottedPath based on the argument type.
|
|
7
|
-
*/
|
|
8
|
-
static create(dottedPath?: DottedPathArgument): DottedPath;
|
|
9
|
-
/**
|
|
10
|
-
* Creates a DottedPath from a string.
|
|
11
|
-
* Allows patterns with unsafe characters wrapped in apostrophes or quotes.
|
|
12
|
-
* E.g. "part1.part2.'part.3'.part_4"
|
|
13
|
-
*/
|
|
14
|
-
static createFromPath(path: string): DottedPath;
|
|
15
|
-
/**
|
|
16
|
-
* Creates a DottedPath from a string list.
|
|
17
|
-
*/
|
|
18
|
-
static createFromParts(parts: string[]): DottedPath;
|
|
19
|
-
/**
|
|
20
|
-
* Creates an empty DottedPath.
|
|
21
|
-
*/
|
|
22
|
-
static createEmpty(): DottedPath;
|
|
23
|
-
/**
|
|
24
|
-
* Sanitizes given part: replaces all characters like {@link DottedPath.DELIMITER}
|
|
25
|
-
* with a "safe" character like {@link DottedPath.SAFE_CHAR}.
|
|
26
|
-
* (i) Does not trim whitespace.
|
|
27
|
-
*/
|
|
28
|
-
static sanitizePart(part: string): string;
|
|
29
|
-
/**
|
|
30
|
-
* Constructor
|
|
31
|
-
*/
|
|
32
|
-
private constructor();
|
|
33
|
-
/**
|
|
34
|
-
* The path.
|
|
35
|
-
* (i) Does not return an empty dot for no path.
|
|
36
|
-
*/
|
|
37
|
-
get path(): string;
|
|
38
|
-
/**
|
|
39
|
-
* The first part.
|
|
40
|
-
*/
|
|
41
|
-
get firstPart(): string | null;
|
|
42
|
-
/**
|
|
43
|
-
* The last part.
|
|
44
|
-
*/
|
|
45
|
-
get lastPart(): string | null;
|
|
46
|
-
/**
|
|
47
|
-
* Gets the tokens to each leaf of the DottedPath tree.
|
|
48
|
-
* E.g. "part1.part2.part_3" will return an array like
|
|
49
|
-
* ["part1", "part1.part2", "part1.part2.part_3"]
|
|
50
|
-
*/
|
|
51
|
-
get leafTokens(): string[];
|
|
52
|
-
/**
|
|
53
|
-
* Removes the first part and returns it.
|
|
54
|
-
*/
|
|
55
|
-
shiftPart(): string | undefined;
|
|
56
|
-
/**
|
|
57
|
-
* Adds part to the beginning of parts list.
|
|
58
|
-
*/
|
|
59
|
-
unshiftPart(part: string, duplicateCheck?: boolean): DottedPath;
|
|
60
|
-
/**
|
|
61
|
-
* Adds part to the end of parts list.
|
|
62
|
-
* (i) Does not add a part if the last char already is the delimiter or if an empty string was passed.
|
|
63
|
-
*/
|
|
64
|
-
addPart(part: string, duplicateCheck?: boolean): DottedPath;
|
|
65
|
-
/**
|
|
66
|
-
* Adds multiple parts to the end of parts list.
|
|
67
|
-
*/
|
|
68
|
-
addParts(parts: string[], duplicateCheck?: boolean): DottedPath;
|
|
69
|
-
/**
|
|
70
|
-
* Removes the last part and returns it.
|
|
71
|
-
*/
|
|
72
|
-
popPart(): string | undefined;
|
|
73
|
-
toString(): string;
|
|
74
|
-
valueOf(): string;
|
|
75
|
-
/**
|
|
76
|
-
* Clones the DottedPath.
|
|
77
|
-
*/
|
|
78
|
-
clone(): DottedPath;
|
|
79
|
-
}
|
|
1
|
+
export declare class DottedPath {
|
|
2
|
+
static DELIMITER: string;
|
|
3
|
+
static SAFE_CHAR: string;
|
|
4
|
+
parts: string[];
|
|
5
|
+
/**
|
|
6
|
+
* Magic factory function that creates a DottedPath based on the argument type.
|
|
7
|
+
*/
|
|
8
|
+
static create(dottedPath?: DottedPathArgument): DottedPath;
|
|
9
|
+
/**
|
|
10
|
+
* Creates a DottedPath from a string.
|
|
11
|
+
* Allows patterns with unsafe characters wrapped in apostrophes or quotes.
|
|
12
|
+
* E.g. "part1.part2.'part.3'.part_4"
|
|
13
|
+
*/
|
|
14
|
+
static createFromPath(path: string): DottedPath;
|
|
15
|
+
/**
|
|
16
|
+
* Creates a DottedPath from a string list.
|
|
17
|
+
*/
|
|
18
|
+
static createFromParts(parts: string[]): DottedPath;
|
|
19
|
+
/**
|
|
20
|
+
* Creates an empty DottedPath.
|
|
21
|
+
*/
|
|
22
|
+
static createEmpty(): DottedPath;
|
|
23
|
+
/**
|
|
24
|
+
* Sanitizes given part: replaces all characters like {@link DottedPath.DELIMITER}
|
|
25
|
+
* with a "safe" character like {@link DottedPath.SAFE_CHAR}.
|
|
26
|
+
* (i) Does not trim whitespace.
|
|
27
|
+
*/
|
|
28
|
+
static sanitizePart(part: string): string;
|
|
29
|
+
/**
|
|
30
|
+
* Constructor
|
|
31
|
+
*/
|
|
32
|
+
private constructor();
|
|
33
|
+
/**
|
|
34
|
+
* The path.
|
|
35
|
+
* (i) Does not return an empty dot for no path.
|
|
36
|
+
*/
|
|
37
|
+
get path(): string;
|
|
38
|
+
/**
|
|
39
|
+
* The first part.
|
|
40
|
+
*/
|
|
41
|
+
get firstPart(): string | null;
|
|
42
|
+
/**
|
|
43
|
+
* The last part.
|
|
44
|
+
*/
|
|
45
|
+
get lastPart(): string | null;
|
|
46
|
+
/**
|
|
47
|
+
* Gets the tokens to each leaf of the DottedPath tree.
|
|
48
|
+
* E.g. "part1.part2.part_3" will return an array like
|
|
49
|
+
* ["part1", "part1.part2", "part1.part2.part_3"]
|
|
50
|
+
*/
|
|
51
|
+
get leafTokens(): string[];
|
|
52
|
+
/**
|
|
53
|
+
* Removes the first part and returns it.
|
|
54
|
+
*/
|
|
55
|
+
shiftPart(): string | undefined;
|
|
56
|
+
/**
|
|
57
|
+
* Adds part to the beginning of parts list.
|
|
58
|
+
*/
|
|
59
|
+
unshiftPart(part: string, duplicateCheck?: boolean): DottedPath;
|
|
60
|
+
/**
|
|
61
|
+
* Adds part to the end of parts list.
|
|
62
|
+
* (i) Does not add a part if the last char already is the delimiter or if an empty string was passed.
|
|
63
|
+
*/
|
|
64
|
+
addPart(part: string, duplicateCheck?: boolean): DottedPath;
|
|
65
|
+
/**
|
|
66
|
+
* Adds multiple parts to the end of parts list.
|
|
67
|
+
*/
|
|
68
|
+
addParts(parts: string[], duplicateCheck?: boolean): DottedPath;
|
|
69
|
+
/**
|
|
70
|
+
* Removes the last part and returns it.
|
|
71
|
+
*/
|
|
72
|
+
popPart(): string | undefined;
|
|
73
|
+
toString(): string;
|
|
74
|
+
valueOf(): string;
|
|
75
|
+
/**
|
|
76
|
+
* Clones the DottedPath.
|
|
77
|
+
*/
|
|
78
|
+
clone(): DottedPath;
|
|
79
|
+
}
|
|
@@ -1,167 +1,167 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.DottedPath = void 0;
|
|
4
|
-
class DottedPath {
|
|
5
|
-
/**
|
|
6
|
-
* Constructor
|
|
7
|
-
*/
|
|
8
|
-
constructor() {
|
|
9
|
-
this.parts = [];
|
|
10
|
-
}
|
|
11
|
-
/**
|
|
12
|
-
* Magic factory function that creates a DottedPath based on the argument type.
|
|
13
|
-
*/
|
|
14
|
-
static create(dottedPath) {
|
|
15
|
-
if ((dottedPath === null || dottedPath === void 0 ? void 0 : dottedPath.constructor) === DottedPath) {
|
|
16
|
-
return dottedPath.clone();
|
|
17
|
-
}
|
|
18
|
-
if ((dottedPath === null || dottedPath === void 0 ? void 0 : dottedPath.constructor) === String) {
|
|
19
|
-
return DottedPath.createFromPath(dottedPath);
|
|
20
|
-
}
|
|
21
|
-
if ((dottedPath === null || dottedPath === void 0 ? void 0 : dottedPath.constructor) === Array) {
|
|
22
|
-
return DottedPath.createFromParts(dottedPath);
|
|
23
|
-
}
|
|
24
|
-
return DottedPath.createEmpty();
|
|
25
|
-
}
|
|
26
|
-
/**
|
|
27
|
-
* Creates a DottedPath from a string.
|
|
28
|
-
* Allows patterns with unsafe characters wrapped in apostrophes or quotes.
|
|
29
|
-
* E.g. "part1.part2.'part.3'.part_4"
|
|
30
|
-
*/
|
|
31
|
-
static createFromPath(path) {
|
|
32
|
-
if (path.length === 0) {
|
|
33
|
-
return this.createEmpty();
|
|
34
|
-
}
|
|
35
|
-
if (path.indexOf("'") > -1 || path.indexOf('"') > -1) {
|
|
36
|
-
const bd = '[\'|"]';
|
|
37
|
-
const search = new RegExp(`${bd}(.*)${bd}`, 'g');
|
|
38
|
-
let matches = search.exec(path);
|
|
39
|
-
while (matches !== null) {
|
|
40
|
-
const _search = new RegExp(`${bd}${matches[1]}${bd}`, 'g');
|
|
41
|
-
path = path.replace(_search, this.sanitizePart(matches[1]));
|
|
42
|
-
matches = search.exec(path);
|
|
43
|
-
}
|
|
44
|
-
}
|
|
45
|
-
return this.createFromParts(path.split(DottedPath.DELIMITER));
|
|
46
|
-
}
|
|
47
|
-
/**
|
|
48
|
-
* Creates a DottedPath from a string list.
|
|
49
|
-
*/
|
|
50
|
-
static createFromParts(parts) {
|
|
51
|
-
const dottedPath = new DottedPath();
|
|
52
|
-
parts.forEach(part => dottedPath.addPart(part));
|
|
53
|
-
return dottedPath;
|
|
54
|
-
}
|
|
55
|
-
/**
|
|
56
|
-
* Creates an empty DottedPath.
|
|
57
|
-
*/
|
|
58
|
-
static createEmpty() {
|
|
59
|
-
return new DottedPath();
|
|
60
|
-
}
|
|
61
|
-
/**
|
|
62
|
-
* Sanitizes given part: replaces all characters like {@link DottedPath.DELIMITER}
|
|
63
|
-
* with a "safe" character like {@link DottedPath.SAFE_CHAR}.
|
|
64
|
-
* (i) Does not trim whitespace.
|
|
65
|
-
*/
|
|
66
|
-
static sanitizePart(part) {
|
|
67
|
-
return part.split(DottedPath.DELIMITER).join(DottedPath.SAFE_CHAR);
|
|
68
|
-
}
|
|
69
|
-
/**
|
|
70
|
-
* The path.
|
|
71
|
-
* (i) Does not return an empty dot for no path.
|
|
72
|
-
*/
|
|
73
|
-
get path() {
|
|
74
|
-
return this.parts.length > 0 ? this.parts.join(DottedPath.DELIMITER) : '';
|
|
75
|
-
}
|
|
76
|
-
/**
|
|
77
|
-
* The first part.
|
|
78
|
-
*/
|
|
79
|
-
get firstPart() {
|
|
80
|
-
if (this.parts.length > 0) {
|
|
81
|
-
return this.parts[0];
|
|
82
|
-
}
|
|
83
|
-
return null;
|
|
84
|
-
}
|
|
85
|
-
/**
|
|
86
|
-
* The last part.
|
|
87
|
-
*/
|
|
88
|
-
get lastPart() {
|
|
89
|
-
if (this.parts.length > 0) {
|
|
90
|
-
return this.parts[this.parts.length - 1];
|
|
91
|
-
}
|
|
92
|
-
return null;
|
|
93
|
-
}
|
|
94
|
-
/**
|
|
95
|
-
* Gets the tokens to each leaf of the DottedPath tree.
|
|
96
|
-
* E.g. "part1.part2.part_3" will return an array like
|
|
97
|
-
* ["part1", "part1.part2", "part1.part2.part_3"]
|
|
98
|
-
*/
|
|
99
|
-
get leafTokens() {
|
|
100
|
-
const parents = [];
|
|
101
|
-
return this.parts.map(part => {
|
|
102
|
-
parents.push(part);
|
|
103
|
-
return DottedPath.create(parents).path;
|
|
104
|
-
});
|
|
105
|
-
}
|
|
106
|
-
/**
|
|
107
|
-
* Removes the first part and returns it.
|
|
108
|
-
*/
|
|
109
|
-
shiftPart() {
|
|
110
|
-
return this.parts.shift();
|
|
111
|
-
}
|
|
112
|
-
/**
|
|
113
|
-
* Adds part to the beginning of parts list.
|
|
114
|
-
*/
|
|
115
|
-
unshiftPart(part, duplicateCheck = false) {
|
|
116
|
-
part = DottedPath.sanitizePart(part);
|
|
117
|
-
if (duplicateCheck && this.firstPart === part) {
|
|
118
|
-
return this;
|
|
119
|
-
}
|
|
120
|
-
this.parts.unshift(part);
|
|
121
|
-
return this;
|
|
122
|
-
}
|
|
123
|
-
/**
|
|
124
|
-
* Adds part to the end of parts list.
|
|
125
|
-
* (i) Does not add a part if the last char already is the delimiter or if an empty string was passed.
|
|
126
|
-
*/
|
|
127
|
-
addPart(part, duplicateCheck = false) {
|
|
128
|
-
if (part.length < 1 || this.lastPart === DottedPath.DELIMITER) {
|
|
129
|
-
return this;
|
|
130
|
-
}
|
|
131
|
-
part = DottedPath.sanitizePart(part);
|
|
132
|
-
if (duplicateCheck && this.lastPart === part) {
|
|
133
|
-
return this;
|
|
134
|
-
}
|
|
135
|
-
this.parts.push(part);
|
|
136
|
-
return this;
|
|
137
|
-
}
|
|
138
|
-
/**
|
|
139
|
-
* Adds multiple parts to the end of parts list.
|
|
140
|
-
*/
|
|
141
|
-
addParts(parts, duplicateCheck = false) {
|
|
142
|
-
parts.forEach(part => this.addPart(part, duplicateCheck));
|
|
143
|
-
return this;
|
|
144
|
-
}
|
|
145
|
-
/**
|
|
146
|
-
* Removes the last part and returns it.
|
|
147
|
-
*/
|
|
148
|
-
popPart() {
|
|
149
|
-
return this.parts.pop();
|
|
150
|
-
}
|
|
151
|
-
toString() {
|
|
152
|
-
return this.path;
|
|
153
|
-
}
|
|
154
|
-
valueOf() {
|
|
155
|
-
return this.path;
|
|
156
|
-
}
|
|
157
|
-
/**
|
|
158
|
-
* Clones the DottedPath.
|
|
159
|
-
*/
|
|
160
|
-
clone() {
|
|
161
|
-
return DottedPath.createFromParts(this.parts);
|
|
162
|
-
}
|
|
163
|
-
}
|
|
164
|
-
exports.DottedPath = DottedPath;
|
|
165
|
-
DottedPath.DELIMITER = '.';
|
|
166
|
-
DottedPath.SAFE_CHAR = '·';
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.DottedPath = void 0;
|
|
4
|
+
class DottedPath {
|
|
5
|
+
/**
|
|
6
|
+
* Constructor
|
|
7
|
+
*/
|
|
8
|
+
constructor() {
|
|
9
|
+
this.parts = [];
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* Magic factory function that creates a DottedPath based on the argument type.
|
|
13
|
+
*/
|
|
14
|
+
static create(dottedPath) {
|
|
15
|
+
if ((dottedPath === null || dottedPath === void 0 ? void 0 : dottedPath.constructor) === DottedPath) {
|
|
16
|
+
return dottedPath.clone();
|
|
17
|
+
}
|
|
18
|
+
if ((dottedPath === null || dottedPath === void 0 ? void 0 : dottedPath.constructor) === String) {
|
|
19
|
+
return DottedPath.createFromPath(dottedPath);
|
|
20
|
+
}
|
|
21
|
+
if ((dottedPath === null || dottedPath === void 0 ? void 0 : dottedPath.constructor) === Array) {
|
|
22
|
+
return DottedPath.createFromParts(dottedPath);
|
|
23
|
+
}
|
|
24
|
+
return DottedPath.createEmpty();
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Creates a DottedPath from a string.
|
|
28
|
+
* Allows patterns with unsafe characters wrapped in apostrophes or quotes.
|
|
29
|
+
* E.g. "part1.part2.'part.3'.part_4"
|
|
30
|
+
*/
|
|
31
|
+
static createFromPath(path) {
|
|
32
|
+
if (path.length === 0) {
|
|
33
|
+
return this.createEmpty();
|
|
34
|
+
}
|
|
35
|
+
if (path.indexOf("'") > -1 || path.indexOf('"') > -1) {
|
|
36
|
+
const bd = '[\'|"]';
|
|
37
|
+
const search = new RegExp(`${bd}(.*)${bd}`, 'g');
|
|
38
|
+
let matches = search.exec(path);
|
|
39
|
+
while (matches !== null) {
|
|
40
|
+
const _search = new RegExp(`${bd}${matches[1]}${bd}`, 'g');
|
|
41
|
+
path = path.replace(_search, this.sanitizePart(matches[1]));
|
|
42
|
+
matches = search.exec(path);
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
return this.createFromParts(path.split(DottedPath.DELIMITER));
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Creates a DottedPath from a string list.
|
|
49
|
+
*/
|
|
50
|
+
static createFromParts(parts) {
|
|
51
|
+
const dottedPath = new DottedPath();
|
|
52
|
+
parts.forEach(part => dottedPath.addPart(part));
|
|
53
|
+
return dottedPath;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Creates an empty DottedPath.
|
|
57
|
+
*/
|
|
58
|
+
static createEmpty() {
|
|
59
|
+
return new DottedPath();
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Sanitizes given part: replaces all characters like {@link DottedPath.DELIMITER}
|
|
63
|
+
* with a "safe" character like {@link DottedPath.SAFE_CHAR}.
|
|
64
|
+
* (i) Does not trim whitespace.
|
|
65
|
+
*/
|
|
66
|
+
static sanitizePart(part) {
|
|
67
|
+
return part.split(DottedPath.DELIMITER).join(DottedPath.SAFE_CHAR);
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* The path.
|
|
71
|
+
* (i) Does not return an empty dot for no path.
|
|
72
|
+
*/
|
|
73
|
+
get path() {
|
|
74
|
+
return this.parts.length > 0 ? this.parts.join(DottedPath.DELIMITER) : '';
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* The first part.
|
|
78
|
+
*/
|
|
79
|
+
get firstPart() {
|
|
80
|
+
if (this.parts.length > 0) {
|
|
81
|
+
return this.parts[0];
|
|
82
|
+
}
|
|
83
|
+
return null;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* The last part.
|
|
87
|
+
*/
|
|
88
|
+
get lastPart() {
|
|
89
|
+
if (this.parts.length > 0) {
|
|
90
|
+
return this.parts[this.parts.length - 1];
|
|
91
|
+
}
|
|
92
|
+
return null;
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* Gets the tokens to each leaf of the DottedPath tree.
|
|
96
|
+
* E.g. "part1.part2.part_3" will return an array like
|
|
97
|
+
* ["part1", "part1.part2", "part1.part2.part_3"]
|
|
98
|
+
*/
|
|
99
|
+
get leafTokens() {
|
|
100
|
+
const parents = [];
|
|
101
|
+
return this.parts.map(part => {
|
|
102
|
+
parents.push(part);
|
|
103
|
+
return DottedPath.create(parents).path;
|
|
104
|
+
});
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* Removes the first part and returns it.
|
|
108
|
+
*/
|
|
109
|
+
shiftPart() {
|
|
110
|
+
return this.parts.shift();
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* Adds part to the beginning of parts list.
|
|
114
|
+
*/
|
|
115
|
+
unshiftPart(part, duplicateCheck = false) {
|
|
116
|
+
part = DottedPath.sanitizePart(part);
|
|
117
|
+
if (duplicateCheck && this.firstPart === part) {
|
|
118
|
+
return this;
|
|
119
|
+
}
|
|
120
|
+
this.parts.unshift(part);
|
|
121
|
+
return this;
|
|
122
|
+
}
|
|
123
|
+
/**
|
|
124
|
+
* Adds part to the end of parts list.
|
|
125
|
+
* (i) Does not add a part if the last char already is the delimiter or if an empty string was passed.
|
|
126
|
+
*/
|
|
127
|
+
addPart(part, duplicateCheck = false) {
|
|
128
|
+
if (part.length < 1 || this.lastPart === DottedPath.DELIMITER) {
|
|
129
|
+
return this;
|
|
130
|
+
}
|
|
131
|
+
part = DottedPath.sanitizePart(part);
|
|
132
|
+
if (duplicateCheck && this.lastPart === part) {
|
|
133
|
+
return this;
|
|
134
|
+
}
|
|
135
|
+
this.parts.push(part);
|
|
136
|
+
return this;
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* Adds multiple parts to the end of parts list.
|
|
140
|
+
*/
|
|
141
|
+
addParts(parts, duplicateCheck = false) {
|
|
142
|
+
parts.forEach(part => this.addPart(part, duplicateCheck));
|
|
143
|
+
return this;
|
|
144
|
+
}
|
|
145
|
+
/**
|
|
146
|
+
* Removes the last part and returns it.
|
|
147
|
+
*/
|
|
148
|
+
popPart() {
|
|
149
|
+
return this.parts.pop();
|
|
150
|
+
}
|
|
151
|
+
toString() {
|
|
152
|
+
return this.path;
|
|
153
|
+
}
|
|
154
|
+
valueOf() {
|
|
155
|
+
return this.path;
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* Clones the DottedPath.
|
|
159
|
+
*/
|
|
160
|
+
clone() {
|
|
161
|
+
return DottedPath.createFromParts(this.parts);
|
|
162
|
+
}
|
|
163
|
+
}
|
|
164
|
+
exports.DottedPath = DottedPath;
|
|
165
|
+
DottedPath.DELIMITER = '.';
|
|
166
|
+
DottedPath.SAFE_CHAR = '·';
|
|
167
167
|
//# sourceMappingURL=dottedPath.js.map
|