@combeenation/3d-viewer 12.4.1 → 13.0.1

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 (213) hide show
  1. package/dist/lib-cjs/buildinfo.json +1 -1
  2. package/dist/lib-cjs/commonjs.tsconfig.tsbuildinfo +1 -1
  3. package/dist/lib-cjs/index.d.ts +63 -63
  4. package/dist/lib-cjs/index.js +81 -114
  5. package/dist/lib-cjs/index.js.map +1 -1
  6. package/dist/lib-cjs/internal/cbn-custom-babylon-loader-plugin.d.ts +10 -0
  7. package/dist/lib-cjs/internal/cbn-custom-babylon-loader-plugin.js +132 -0
  8. package/dist/lib-cjs/internal/cbn-custom-babylon-loader-plugin.js.map +1 -0
  9. package/dist/lib-cjs/internal/cloning-helper.d.ts +19 -0
  10. package/dist/lib-cjs/internal/cloning-helper.js +164 -0
  11. package/dist/lib-cjs/internal/cloning-helper.js.map +1 -0
  12. package/dist/lib-cjs/internal/device-helper.d.ts +9 -0
  13. package/dist/lib-cjs/{api/util/deviceHelper.js → internal/device-helper.js} +7 -11
  14. package/dist/lib-cjs/internal/device-helper.js.map +1 -0
  15. package/dist/lib-cjs/internal/geometry-helper.d.ts +21 -0
  16. package/dist/lib-cjs/{api/util/geometryHelper.js → internal/geometry-helper.js} +58 -25
  17. package/dist/lib-cjs/internal/geometry-helper.js.map +1 -0
  18. package/dist/lib-cjs/internal/metadata-helper.d.ts +26 -0
  19. package/dist/lib-cjs/internal/metadata-helper.js +51 -0
  20. package/dist/lib-cjs/internal/metadata-helper.js.map +1 -0
  21. package/dist/lib-cjs/internal/paintable-helper.d.ts +40 -0
  22. package/dist/lib-cjs/internal/paintable-helper.js +287 -0
  23. package/dist/lib-cjs/internal/paintable-helper.js.map +1 -0
  24. package/dist/lib-cjs/internal/tags-helper.d.ts +12 -0
  25. package/dist/lib-cjs/internal/tags-helper.js +38 -0
  26. package/dist/lib-cjs/internal/tags-helper.js.map +1 -0
  27. package/dist/lib-cjs/manager/camera-manager.d.ts +51 -0
  28. package/dist/lib-cjs/manager/camera-manager.js +154 -0
  29. package/dist/lib-cjs/manager/camera-manager.js.map +1 -0
  30. package/dist/lib-cjs/manager/debug-manager.d.ts +60 -0
  31. package/dist/lib-cjs/manager/debug-manager.js +218 -0
  32. package/dist/lib-cjs/manager/debug-manager.js.map +1 -0
  33. package/dist/lib-cjs/manager/event-manager.d.ts +52 -0
  34. package/dist/lib-cjs/manager/event-manager.js +72 -0
  35. package/dist/lib-cjs/manager/event-manager.js.map +1 -0
  36. package/dist/lib-cjs/{api/manager/gltfExportManager.d.ts → manager/gltf-export-manager.d.ts} +29 -34
  37. package/dist/lib-cjs/{api/manager/gltfExportManager.js → manager/gltf-export-manager.js} +103 -124
  38. package/dist/lib-cjs/manager/gltf-export-manager.js.map +1 -0
  39. package/dist/lib-cjs/manager/material-manager.d.ts +35 -0
  40. package/dist/lib-cjs/manager/material-manager.js +126 -0
  41. package/dist/lib-cjs/manager/material-manager.js.map +1 -0
  42. package/dist/lib-cjs/manager/model-manager.d.ts +145 -0
  43. package/dist/lib-cjs/manager/model-manager.js +383 -0
  44. package/dist/lib-cjs/manager/model-manager.js.map +1 -0
  45. package/dist/lib-cjs/manager/parameter-manager.d.ts +210 -0
  46. package/dist/lib-cjs/manager/parameter-manager.js +515 -0
  47. package/dist/lib-cjs/manager/parameter-manager.js.map +1 -0
  48. package/dist/lib-cjs/manager/scene-manager.d.ts +45 -0
  49. package/dist/lib-cjs/manager/scene-manager.js +65 -0
  50. package/dist/lib-cjs/manager/scene-manager.js.map +1 -0
  51. package/dist/lib-cjs/manager/screenshot-manager.d.ts +36 -0
  52. package/dist/lib-cjs/manager/screenshot-manager.js +40 -0
  53. package/dist/lib-cjs/manager/screenshot-manager.js.map +1 -0
  54. package/dist/lib-cjs/manager/texture-manager.d.ts +12 -0
  55. package/dist/lib-cjs/manager/texture-manager.js +44 -0
  56. package/dist/lib-cjs/manager/texture-manager.js.map +1 -0
  57. package/dist/lib-cjs/{api/classes/viewerError.d.ts → viewer-error.d.ts} +6 -1
  58. package/dist/lib-cjs/{api/classes/viewerError.js → viewer-error.js} +7 -2
  59. package/dist/lib-cjs/viewer-error.js.map +1 -0
  60. package/dist/lib-cjs/viewer.d.ts +117 -0
  61. package/dist/lib-cjs/viewer.js +222 -0
  62. package/dist/lib-cjs/viewer.js.map +1 -0
  63. package/package.json +10 -11
  64. package/src/dev.ts +14 -37
  65. package/src/{types.d.ts → global-types.d.ts} +8 -18
  66. package/src/index.ts +79 -113
  67. package/src/internal/cbn-custom-babylon-loader-plugin.ts +159 -0
  68. package/src/internal/cloning-helper.ts +225 -0
  69. package/src/internal/device-helper.ts +25 -0
  70. package/src/{api/util/geometryHelper.ts → internal/geometry-helper.ts} +63 -24
  71. package/src/internal/metadata-helper.ts +63 -0
  72. package/src/internal/paintable-helper.ts +310 -0
  73. package/src/internal/tags-helper.ts +41 -0
  74. package/src/manager/camera-manager.ts +236 -0
  75. package/src/manager/debug-manager.ts +245 -0
  76. package/src/manager/event-manager.ts +72 -0
  77. package/src/{api/manager/gltfExportManager.ts → manager/gltf-export-manager.ts} +132 -125
  78. package/src/manager/material-manager.ts +135 -0
  79. package/src/manager/model-manager.ts +458 -0
  80. package/src/manager/parameter-manager.ts +652 -0
  81. package/src/manager/scene-manager.ts +101 -0
  82. package/src/manager/screenshot-manager.ts +59 -0
  83. package/src/manager/texture-manager.ts +32 -0
  84. package/src/{api/classes/viewerError.ts → viewer-error.ts} +6 -1
  85. package/src/viewer.ts +296 -0
  86. package/dist/lib-cjs/api/classes/animationInterface.d.ts +0 -8
  87. package/dist/lib-cjs/api/classes/animationInterface.js +0 -3
  88. package/dist/lib-cjs/api/classes/animationInterface.js.map +0 -1
  89. package/dist/lib-cjs/api/classes/dottedPath.d.ts +0 -79
  90. package/dist/lib-cjs/api/classes/dottedPath.js +0 -167
  91. package/dist/lib-cjs/api/classes/dottedPath.js.map +0 -1
  92. package/dist/lib-cjs/api/classes/element.d.ts +0 -153
  93. package/dist/lib-cjs/api/classes/element.js +0 -703
  94. package/dist/lib-cjs/api/classes/element.js.map +0 -1
  95. package/dist/lib-cjs/api/classes/event.d.ts +0 -401
  96. package/dist/lib-cjs/api/classes/event.js +0 -425
  97. package/dist/lib-cjs/api/classes/event.js.map +0 -1
  98. package/dist/lib-cjs/api/classes/eventBroadcaster.d.ts +0 -26
  99. package/dist/lib-cjs/api/classes/eventBroadcaster.js +0 -50
  100. package/dist/lib-cjs/api/classes/eventBroadcaster.js.map +0 -1
  101. package/dist/lib-cjs/api/classes/fuzzyMap.d.ts +0 -7
  102. package/dist/lib-cjs/api/classes/fuzzyMap.js +0 -22
  103. package/dist/lib-cjs/api/classes/fuzzyMap.js.map +0 -1
  104. package/dist/lib-cjs/api/classes/parameter.d.ts +0 -410
  105. package/dist/lib-cjs/api/classes/parameter.js +0 -643
  106. package/dist/lib-cjs/api/classes/parameter.js.map +0 -1
  107. package/dist/lib-cjs/api/classes/parameterObservable.d.ts +0 -36
  108. package/dist/lib-cjs/api/classes/parameterObservable.js +0 -73
  109. package/dist/lib-cjs/api/classes/parameterObservable.js.map +0 -1
  110. package/dist/lib-cjs/api/classes/parameterizable.d.ts +0 -15
  111. package/dist/lib-cjs/api/classes/parameterizable.js +0 -103
  112. package/dist/lib-cjs/api/classes/parameterizable.js.map +0 -1
  113. package/dist/lib-cjs/api/classes/placementAnimation.d.ts +0 -45
  114. package/dist/lib-cjs/api/classes/placementAnimation.js +0 -177
  115. package/dist/lib-cjs/api/classes/placementAnimation.js.map +0 -1
  116. package/dist/lib-cjs/api/classes/variant.d.ts +0 -261
  117. package/dist/lib-cjs/api/classes/variant.js +0 -873
  118. package/dist/lib-cjs/api/classes/variant.js.map +0 -1
  119. package/dist/lib-cjs/api/classes/variantInstance.d.ts +0 -53
  120. package/dist/lib-cjs/api/classes/variantInstance.js +0 -126
  121. package/dist/lib-cjs/api/classes/variantInstance.js.map +0 -1
  122. package/dist/lib-cjs/api/classes/variantParameterizable.d.ts +0 -17
  123. package/dist/lib-cjs/api/classes/variantParameterizable.js +0 -87
  124. package/dist/lib-cjs/api/classes/variantParameterizable.js.map +0 -1
  125. package/dist/lib-cjs/api/classes/viewer.d.ts +0 -215
  126. package/dist/lib-cjs/api/classes/viewer.js +0 -709
  127. package/dist/lib-cjs/api/classes/viewer.js.map +0 -1
  128. package/dist/lib-cjs/api/classes/viewerError.js.map +0 -1
  129. package/dist/lib-cjs/api/classes/viewerLight.d.ts +0 -66
  130. package/dist/lib-cjs/api/classes/viewerLight.js +0 -345
  131. package/dist/lib-cjs/api/classes/viewerLight.js.map +0 -1
  132. package/dist/lib-cjs/api/internal/lensRendering.d.ts +0 -8
  133. package/dist/lib-cjs/api/internal/lensRendering.js +0 -12
  134. package/dist/lib-cjs/api/internal/lensRendering.js.map +0 -1
  135. package/dist/lib-cjs/api/internal/sceneSetup.d.ts +0 -13
  136. package/dist/lib-cjs/api/internal/sceneSetup.js +0 -228
  137. package/dist/lib-cjs/api/internal/sceneSetup.js.map +0 -1
  138. package/dist/lib-cjs/api/manager/animationManager.d.ts +0 -30
  139. package/dist/lib-cjs/api/manager/animationManager.js +0 -127
  140. package/dist/lib-cjs/api/manager/animationManager.js.map +0 -1
  141. package/dist/lib-cjs/api/manager/gltfExportManager.js.map +0 -1
  142. package/dist/lib-cjs/api/manager/sceneManager.d.ts +0 -33
  143. package/dist/lib-cjs/api/manager/sceneManager.js +0 -129
  144. package/dist/lib-cjs/api/manager/sceneManager.js.map +0 -1
  145. package/dist/lib-cjs/api/manager/tagManager.d.ts +0 -118
  146. package/dist/lib-cjs/api/manager/tagManager.js +0 -531
  147. package/dist/lib-cjs/api/manager/tagManager.js.map +0 -1
  148. package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +0 -22
  149. package/dist/lib-cjs/api/manager/textureLoadManager.js +0 -108
  150. package/dist/lib-cjs/api/manager/textureLoadManager.js.map +0 -1
  151. package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +0 -106
  152. package/dist/lib-cjs/api/manager/variantInstanceManager.js +0 -291
  153. package/dist/lib-cjs/api/manager/variantInstanceManager.js.map +0 -1
  154. package/dist/lib-cjs/api/store/specStorage.d.ts +0 -32
  155. package/dist/lib-cjs/api/store/specStorage.js +0 -66
  156. package/dist/lib-cjs/api/store/specStorage.js.map +0 -1
  157. package/dist/lib-cjs/api/util/babylonHelper.d.ts +0 -238
  158. package/dist/lib-cjs/api/util/babylonHelper.js +0 -826
  159. package/dist/lib-cjs/api/util/babylonHelper.js.map +0 -1
  160. package/dist/lib-cjs/api/util/debugHelper.d.ts +0 -9
  161. package/dist/lib-cjs/api/util/debugHelper.js +0 -94
  162. package/dist/lib-cjs/api/util/debugHelper.js.map +0 -1
  163. package/dist/lib-cjs/api/util/deviceHelper.d.ts +0 -9
  164. package/dist/lib-cjs/api/util/deviceHelper.js.map +0 -1
  165. package/dist/lib-cjs/api/util/geometryHelper.d.ts +0 -17
  166. package/dist/lib-cjs/api/util/geometryHelper.js.map +0 -1
  167. package/dist/lib-cjs/api/util/globalTypes.d.ts +0 -490
  168. package/dist/lib-cjs/api/util/globalTypes.js +0 -2
  169. package/dist/lib-cjs/api/util/globalTypes.js.map +0 -1
  170. package/dist/lib-cjs/api/util/resourceHelper.d.ts +0 -58
  171. package/dist/lib-cjs/api/util/resourceHelper.js +0 -215
  172. package/dist/lib-cjs/api/util/resourceHelper.js.map +0 -1
  173. package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +0 -58
  174. package/dist/lib-cjs/api/util/sceneLoaderHelper.js +0 -229
  175. package/dist/lib-cjs/api/util/sceneLoaderHelper.js.map +0 -1
  176. package/dist/lib-cjs/api/util/stringHelper.d.ts +0 -13
  177. package/dist/lib-cjs/api/util/stringHelper.js +0 -33
  178. package/dist/lib-cjs/api/util/stringHelper.js.map +0 -1
  179. package/dist/lib-cjs/api/util/structureHelper.d.ts +0 -9
  180. package/dist/lib-cjs/api/util/structureHelper.js +0 -58
  181. package/dist/lib-cjs/api/util/structureHelper.js.map +0 -1
  182. package/src/api/classes/animationInterface.ts +0 -10
  183. package/src/api/classes/dottedPath.ts +0 -181
  184. package/src/api/classes/element.ts +0 -766
  185. package/src/api/classes/event.ts +0 -457
  186. package/src/api/classes/eventBroadcaster.ts +0 -52
  187. package/src/api/classes/fuzzyMap.ts +0 -21
  188. package/src/api/classes/parameter.ts +0 -686
  189. package/src/api/classes/parameterObservable.ts +0 -73
  190. package/src/api/classes/parameterizable.ts +0 -87
  191. package/src/api/classes/placementAnimation.ts +0 -162
  192. package/src/api/classes/variant.ts +0 -965
  193. package/src/api/classes/variantInstance.ts +0 -123
  194. package/src/api/classes/variantParameterizable.ts +0 -83
  195. package/src/api/classes/viewer.ts +0 -751
  196. package/src/api/classes/viewerLight.ts +0 -335
  197. package/src/api/internal/debugViewer.ts +0 -90
  198. package/src/api/internal/lensRendering.ts +0 -9
  199. package/src/api/internal/sceneSetup.ts +0 -208
  200. package/src/api/manager/animationManager.ts +0 -143
  201. package/src/api/manager/sceneManager.ts +0 -134
  202. package/src/api/manager/tagManager.ts +0 -572
  203. package/src/api/manager/textureLoadManager.ts +0 -107
  204. package/src/api/manager/variantInstanceManager.ts +0 -306
  205. package/src/api/store/specStorage.ts +0 -68
  206. package/src/api/util/babylonHelper.ts +0 -915
  207. package/src/api/util/debugHelper.ts +0 -121
  208. package/src/api/util/deviceHelper.ts +0 -31
  209. package/src/api/util/globalTypes.ts +0 -566
  210. package/src/api/util/resourceHelper.ts +0 -201
  211. package/src/api/util/sceneLoaderHelper.ts +0 -247
  212. package/src/api/util/stringHelper.ts +0 -30
  213. package/src/api/util/structureHelper.ts +0 -62
@@ -1 +0,0 @@
1
- {"version":3,"file":"structureHelper.js","sourceRoot":"","sources":["../../../../src/api/util/structureHelper.ts"],"names":[],"mappings":";;;AAAA,gDAA6C;AAC7C,gDAA6C;AAC7C,gEAA6D;AAC7D,wEAAqE;AACrE,oDAAiD;AAEjD;;;;;GAKG;AACH,MAAM,6BAA6B,GAAG,UACpC,IAAmB,EACnB,IAA0B,EAC1B,eAAyB;IAEzB,MAAM,SAAS,GAAG,CAAC,SAAwB,EAAE,WAA0B,EAAE,EAAE;QACzE,OAAO,SAAS,CAAC,IAAI,KAAK,WAAW,CAAC,IAAI,CAAC;IAC7C,CAAC,CAAC;IACF,MAAM,YAAY,GAAG,CAAC,OAAgB,EAAE,WAA0B,EAAE,EAAE;QACpE,OAAO,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC;IAChE,CAAC,CAAC;IACF,MAAM,YAAY,GAAG,CAAC,YAAqB,EAAE,WAA0B,EAAE,EAAE;QACzE,OAAO,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC;IACzE,CAAC,CAAC;IACF,MAAM,oBAAoB,GAAG,CAAC,YAA6B,EAAE,WAA0B,EAAE,EAAE;QACzF,OAAO,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC;IACjF,CAAC,CAAC;IACF,MAAM,sBAAsB,GAAG,CAAC,YAA+B,EAAE,WAA0B,EAAE,EAAE;QAC7F,MAAM,WAAW,GAAG,YAAY,CAAC,QAAQ,IAAI,YAAY,CAAC,QAAQ,KAAK,WAAW,CAAC,IAAI,CAAC;QACxF,MAAM,UAAU,GAAG,YAAY,CAAC,OAAO,IAAI,WAAI,CAAC,YAAY,CAAC,WAAW,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;QAChG,OAAO,WAAW,IAAI,UAAU,CAAC;IACnC,CAAC,CAAC;IACF,MAAM,KAAK,GAAG,CAAC,iBAAmC,EAAE,IAAmB,EAAE,EAAE;QACzE,IAAI,iBAAiB,YAAY,iCAAe,EAAE;YAChD,OAAO,oBAAoB,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;SACtD;QACD,IAAI,iBAAiB,YAAY,iBAAO,EAAE;YACxC,OAAO,YAAY,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;SAC9C;QACD,IAAI,iBAAiB,YAAY,iBAAO,EAAE;YACxC,OAAO,YAAY,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;SAC9C;QACD,IAAI,iBAAiB,YAAY,6BAAa,EAAE;YAC9C,OAAO,SAAS,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;SAC3C;QACD,IAAK,iBAAuC,CAAC,OAAO,IAAK,iBAAuC,CAAC,QAAQ,EAAE;YACzG,OAAO,sBAAsB,CAAC,iBAAsC,EAAE,IAAI,CAAC,CAAC;SAC7E;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,IAAI,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC,KAAK,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC,CAAC;IAChF,IAAI,CAAC,UAAU,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,MAAM,YAAY,6BAAa,EAAE;QAC3E,UAAU,GAAG,6BAA6B,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;KAC/D;IAED,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEO,sEAA6B"}
@@ -1,10 +0,0 @@
1
- /**
2
- * An Interface defining the basic functionality of an animation.
3
- */
4
- export interface AnimationInterface {
5
- play(): Promise<AnimationInterface>;
6
-
7
- pause(): AnimationInterface;
8
-
9
- kill(): AnimationInterface;
10
- }
@@ -1,181 +0,0 @@
1
- export class DottedPath {
2
- static DELIMITER: string = '.';
3
-
4
- static SAFE_CHAR: string = '·';
5
-
6
- public parts: string[] = [];
7
-
8
- /**
9
- * Magic factory function that creates a DottedPath based on the argument type.
10
- */
11
- public static create(dottedPath?: DottedPathArgument): DottedPath {
12
- if (dottedPath?.constructor === DottedPath) {
13
- return (dottedPath as DottedPath).clone();
14
- }
15
- if (dottedPath?.constructor === String) {
16
- return DottedPath.createFromPath(dottedPath as string);
17
- }
18
- if (dottedPath?.constructor === Array) {
19
- return DottedPath.createFromParts(dottedPath as string[]);
20
- }
21
- return DottedPath.createEmpty();
22
- }
23
-
24
- /**
25
- * Creates a DottedPath from a string.
26
- * Allows patterns with unsafe characters wrapped in apostrophes or quotes.
27
- * E.g. "part1.part2.'part.3'.part_4"
28
- */
29
- public static createFromPath(path: string): DottedPath {
30
- if (path.length === 0) {
31
- return this.createEmpty();
32
- }
33
- if (path.indexOf("'") > -1 || path.indexOf('"') > -1) {
34
- const bd = '[\'|"]';
35
- const search = new RegExp(`${bd}(.*)${bd}`, 'g');
36
- let matches = search.exec(path);
37
- while (matches !== null) {
38
- const _search = new RegExp(`${bd}${matches[1]}${bd}`, 'g');
39
- path = path.replace(_search, this.sanitizePart(matches[1]));
40
- matches = search.exec(path);
41
- }
42
- }
43
- return this.createFromParts(path.split(DottedPath.DELIMITER));
44
- }
45
-
46
- /**
47
- * Creates a DottedPath from a string list.
48
- */
49
- public static createFromParts(parts: string[]): DottedPath {
50
- const dottedPath = new DottedPath();
51
- parts.forEach(part => dottedPath.addPart(part));
52
- return dottedPath;
53
- }
54
-
55
- /**
56
- * Creates an empty DottedPath.
57
- */
58
- public static createEmpty(): DottedPath {
59
- return new DottedPath();
60
- }
61
-
62
- /**
63
- * Sanitizes given part: replaces all characters like {@link DottedPath.DELIMITER}
64
- * with a "safe" character like {@link DottedPath.SAFE_CHAR}.
65
- * (i) Does not trim whitespace.
66
- */
67
- public static sanitizePart(part: string): string {
68
- return part.split(DottedPath.DELIMITER).join(DottedPath.SAFE_CHAR);
69
- }
70
-
71
- /**
72
- * Constructor
73
- */
74
- private constructor() {}
75
-
76
- /**
77
- * The path.
78
- * (i) Does not return an empty dot for no path.
79
- */
80
- get path(): string {
81
- return this.parts.length > 0 ? this.parts.join(DottedPath.DELIMITER) : '';
82
- }
83
-
84
- /**
85
- * The first part.
86
- */
87
- get firstPart(): string | null {
88
- if (this.parts.length > 0) {
89
- return this.parts[0];
90
- }
91
- return null;
92
- }
93
-
94
- /**
95
- * The last part.
96
- */
97
- get lastPart(): string | null {
98
- if (this.parts.length > 0) {
99
- return this.parts[this.parts.length - 1];
100
- }
101
- return null;
102
- }
103
-
104
- /**
105
- * Gets the tokens to each leaf of the DottedPath tree.
106
- * E.g. "part1.part2.part_3" will return an array like
107
- * ["part1", "part1.part2", "part1.part2.part_3"]
108
- */
109
- get leafTokens(): string[] {
110
- const parents: string[] = [];
111
- return this.parts.map(part => {
112
- parents.push(part);
113
- return DottedPath.create(parents).path;
114
- });
115
- }
116
-
117
- /**
118
- * Removes the first part and returns it.
119
- */
120
- public shiftPart(): string | undefined {
121
- return this.parts.shift();
122
- }
123
-
124
- /**
125
- * Adds part to the beginning of parts list.
126
- */
127
- public unshiftPart(part: string, duplicateCheck: boolean = false): DottedPath {
128
- part = DottedPath.sanitizePart(part);
129
- if (duplicateCheck && this.firstPart === part) {
130
- return this;
131
- }
132
- this.parts.unshift(part);
133
- return this;
134
- }
135
-
136
- /**
137
- * Adds part to the end of parts list.
138
- * (i) Does not add a part if the last char already is the delimiter or if an empty string was passed.
139
- */
140
- public addPart(part: string, duplicateCheck: boolean = false): DottedPath {
141
- if (part.length < 1 || this.lastPart === DottedPath.DELIMITER) {
142
- return this;
143
- }
144
- part = DottedPath.sanitizePart(part);
145
- if (duplicateCheck && this.lastPart === part) {
146
- return this;
147
- }
148
- this.parts.push(part);
149
- return this;
150
- }
151
-
152
- /**
153
- * Adds multiple parts to the end of parts list.
154
- */
155
- public addParts(parts: string[], duplicateCheck: boolean = false): DottedPath {
156
- parts.forEach(part => this.addPart(part, duplicateCheck));
157
- return this;
158
- }
159
-
160
- /**
161
- * Removes the last part and returns it.
162
- */
163
- public popPart(): string | undefined {
164
- return this.parts.pop();
165
- }
166
-
167
- public toString(): string {
168
- return this.path;
169
- }
170
-
171
- public valueOf(): string {
172
- return this.path;
173
- }
174
-
175
- /**
176
- * Clones the DottedPath.
177
- */
178
- public clone(): DottedPath {
179
- return DottedPath.createFromParts(this.parts);
180
- }
181
- }