@lightningjs/renderer 2.9.0-beta3 → 2.9.0

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 (217) hide show
  1. package/LICENSE +202 -202
  2. package/NOTICE +3 -3
  3. package/README.md +147 -147
  4. package/dist/exports/core-api.d.ts +74 -0
  5. package/dist/exports/core-api.js +96 -0
  6. package/dist/exports/core-api.js.map +1 -0
  7. package/dist/exports/main-api.d.ts +30 -0
  8. package/dist/exports/main-api.js +45 -0
  9. package/dist/exports/main-api.js.map +1 -0
  10. package/dist/src/core/CoreExtension.d.ts +12 -0
  11. package/dist/src/core/CoreExtension.js +29 -0
  12. package/dist/src/core/CoreExtension.js.map +1 -0
  13. package/dist/src/core/CoreNode.d.ts +33 -7
  14. package/dist/src/core/CoreNode.js +113 -75
  15. package/dist/src/core/CoreNode.js.map +1 -1
  16. package/dist/src/core/CoreTextNode.d.ts +2 -2
  17. package/dist/src/core/CoreTextNode.js +7 -4
  18. package/dist/src/core/CoreTextNode.js.map +1 -1
  19. package/dist/src/core/CoreTextureManager.d.ts +24 -0
  20. package/dist/src/core/CoreTextureManager.js.map +1 -1
  21. package/dist/src/core/Stage.js +1 -0
  22. package/dist/src/core/Stage.js.map +1 -1
  23. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +45 -45
  24. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +61 -61
  25. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +93 -93
  26. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +63 -63
  27. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +62 -62
  28. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +15 -15
  29. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +6 -6
  30. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +15 -15
  31. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +15 -15
  32. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +15 -15
  33. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +42 -42
  34. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +44 -44
  35. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js +3 -3
  36. package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.js +22 -22
  37. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +28 -28
  38. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +12 -12
  39. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +37 -37
  40. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +19 -19
  41. package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js +6 -0
  42. package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js.map +1 -1
  43. package/dist/src/core/textures/Texture.d.ts +1 -1
  44. package/dist/src/core/textures/Texture.js +13 -5
  45. package/dist/src/core/textures/Texture.js.map +1 -1
  46. package/dist/src/main-api/ICoreDriver.d.ts +24 -0
  47. package/dist/src/main-api/ICoreDriver.js +20 -0
  48. package/dist/src/main-api/ICoreDriver.js.map +1 -0
  49. package/dist/src/main-api/RendererMain.d.ts +378 -0
  50. package/dist/src/main-api/RendererMain.js +367 -0
  51. package/dist/src/main-api/RendererMain.js.map +1 -0
  52. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.d.ts +9 -0
  53. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js +38 -0
  54. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js.map +1 -0
  55. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.d.ts +56 -0
  56. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js +101 -0
  57. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js.map +1 -0
  58. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.d.ts +32 -0
  59. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js +28 -0
  60. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js.map +1 -0
  61. package/dist/src/render-drivers/main/MainCoreDriver.d.ts +21 -0
  62. package/dist/src/render-drivers/main/MainCoreDriver.js +115 -0
  63. package/dist/src/render-drivers/main/MainCoreDriver.js.map +1 -0
  64. package/dist/src/render-drivers/main/MainOnlyNode.d.ts +101 -0
  65. package/dist/src/render-drivers/main/MainOnlyNode.js +425 -0
  66. package/dist/src/render-drivers/main/MainOnlyNode.js.map +1 -0
  67. package/dist/src/render-drivers/main/MainOnlyTextNode.d.ts +47 -0
  68. package/dist/src/render-drivers/main/MainOnlyTextNode.js +204 -0
  69. package/dist/src/render-drivers/main/MainOnlyTextNode.js.map +1 -0
  70. package/dist/src/render-drivers/threadx/NodeStruct.d.ts +93 -0
  71. package/dist/src/render-drivers/threadx/NodeStruct.js +290 -0
  72. package/dist/src/render-drivers/threadx/NodeStruct.js.map +1 -0
  73. package/dist/src/render-drivers/threadx/SharedNode.d.ts +40 -0
  74. package/dist/src/render-drivers/threadx/SharedNode.js +61 -0
  75. package/dist/src/render-drivers/threadx/SharedNode.js.map +1 -0
  76. package/dist/src/render-drivers/threadx/TextNodeStruct.d.ts +44 -0
  77. package/dist/src/render-drivers/threadx/TextNodeStruct.js +203 -0
  78. package/dist/src/render-drivers/threadx/TextNodeStruct.js.map +1 -0
  79. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.d.ts +25 -0
  80. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js +232 -0
  81. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js.map +1 -0
  82. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.d.ts +24 -0
  83. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js +113 -0
  84. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js.map +1 -0
  85. package/dist/src/render-drivers/threadx/ThreadXMainNode.d.ts +46 -0
  86. package/dist/src/render-drivers/threadx/ThreadXMainNode.js +160 -0
  87. package/dist/src/render-drivers/threadx/ThreadXMainNode.js.map +1 -0
  88. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.d.ts +28 -0
  89. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js +55 -0
  90. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js.map +1 -0
  91. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.d.ts +70 -0
  92. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js +32 -0
  93. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js.map +1 -0
  94. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.d.ts +19 -0
  95. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js +184 -0
  96. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js.map +1 -0
  97. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.d.ts +27 -0
  98. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js +109 -0
  99. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js.map +1 -0
  100. package/dist/src/render-drivers/threadx/worker/renderer.d.ts +1 -0
  101. package/dist/src/render-drivers/threadx/worker/renderer.js +147 -0
  102. package/dist/src/render-drivers/threadx/worker/renderer.js.map +1 -0
  103. package/dist/src/render-drivers/utils.d.ts +12 -0
  104. package/dist/src/render-drivers/utils.js +74 -0
  105. package/dist/src/render-drivers/utils.js.map +1 -0
  106. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  107. package/dist/tsconfig.tsbuildinfo +1 -0
  108. package/exports/canvas.ts +39 -39
  109. package/exports/index.ts +89 -89
  110. package/exports/inspector.ts +24 -24
  111. package/exports/utils.ts +44 -44
  112. package/exports/webgl.ts +38 -38
  113. package/package.json +1 -1
  114. package/scripts/please-use-pnpm.js +13 -13
  115. package/src/common/CommonTypes.ts +139 -139
  116. package/src/common/EventEmitter.ts +77 -77
  117. package/src/common/IAnimationController.ts +92 -92
  118. package/src/common/IEventEmitter.ts +28 -28
  119. package/src/core/CoreNode.test.ts +199 -95
  120. package/src/core/CoreNode.ts +2335 -2282
  121. package/src/core/CoreShaderManager.ts +292 -292
  122. package/src/core/CoreTextNode.ts +455 -450
  123. package/src/core/CoreTextureManager.ts +548 -522
  124. package/src/core/Stage.ts +700 -699
  125. package/src/core/TextureMemoryManager.ts +277 -277
  126. package/src/core/animations/AnimationManager.ts +38 -38
  127. package/src/core/animations/CoreAnimation.ts +340 -340
  128. package/src/core/animations/CoreAnimationController.ts +157 -157
  129. package/src/core/lib/ContextSpy.ts +41 -41
  130. package/src/core/lib/ImageWorker.ts +270 -270
  131. package/src/core/lib/Matrix3d.ts +244 -244
  132. package/src/core/lib/RenderCoords.ts +86 -86
  133. package/src/core/lib/WebGlContextWrapper.ts +1322 -1322
  134. package/src/core/lib/textureCompression.ts +152 -152
  135. package/src/core/lib/textureSvg.ts +78 -78
  136. package/src/core/lib/utils.ts +306 -306
  137. package/src/core/platform.ts +61 -61
  138. package/src/core/renderers/CoreContextTexture.ts +43 -43
  139. package/src/core/renderers/CoreRenderOp.ts +22 -22
  140. package/src/core/renderers/CoreRenderer.ts +114 -114
  141. package/src/core/renderers/CoreShader.ts +41 -41
  142. package/src/core/renderers/canvas/CanvasCoreRenderer.ts +364 -364
  143. package/src/core/renderers/canvas/CanvasCoreTexture.ts +150 -150
  144. package/src/core/renderers/canvas/internal/C2DShaderUtils.ts +231 -231
  145. package/src/core/renderers/canvas/internal/ColorUtils.ts +69 -69
  146. package/src/core/renderers/canvas/shaders/UnsupportedShader.ts +48 -48
  147. package/src/core/renderers/webgl/WebGlCoreCtxRenderTexture.ts +79 -79
  148. package/src/core/renderers/webgl/WebGlCoreCtxSubTexture.ts +50 -50
  149. package/src/core/renderers/webgl/WebGlCoreCtxTexture.ts +298 -298
  150. package/src/core/renderers/webgl/WebGlCoreRenderOp.ts +125 -125
  151. package/src/core/renderers/webgl/WebGlCoreRenderer.ts +805 -805
  152. package/src/core/renderers/webgl/WebGlCoreShader.ts +362 -362
  153. package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
  154. package/src/core/renderers/webgl/internal/ShaderUtils.ts +143 -143
  155. package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
  156. package/src/core/renderers/webgl/shaders/DefaultShader.ts +93 -93
  157. package/src/core/renderers/webgl/shaders/DefaultShaderBatched.ts +132 -132
  158. package/src/core/renderers/webgl/shaders/DynamicShader.ts +580 -580
  159. package/src/core/renderers/webgl/shaders/RoundedRectangle.ts +167 -167
  160. package/src/core/renderers/webgl/shaders/SdfShader.ts +204 -204
  161. package/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.ts +101 -101
  162. package/src/core/renderers/webgl/shaders/effects/BorderEffect.ts +87 -87
  163. package/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.ts +101 -101
  164. package/src/core/renderers/webgl/shaders/effects/BorderRightEffect.ts +101 -101
  165. package/src/core/renderers/webgl/shaders/effects/BorderTopEffect.ts +101 -101
  166. package/src/core/renderers/webgl/shaders/effects/EffectUtils.ts +159 -159
  167. package/src/core/renderers/webgl/shaders/effects/FadeOutEffect.ts +127 -127
  168. package/src/core/renderers/webgl/shaders/effects/GlitchEffect.ts +148 -148
  169. package/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.ts +67 -67
  170. package/src/core/renderers/webgl/shaders/effects/HolePunchEffect.ts +157 -157
  171. package/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.ts +171 -171
  172. package/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.ts +168 -168
  173. package/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.ts +187 -187
  174. package/src/core/renderers/webgl/shaders/effects/RadiusEffect.ts +110 -110
  175. package/src/core/renderers/webgl/shaders/effects/ShaderEffect.ts +196 -196
  176. package/src/core/text-rendering/TextRenderingUtils.ts +36 -36
  177. package/src/core/text-rendering/TextTextureRendererUtils.ts +263 -263
  178. package/src/core/text-rendering/TrFontManager.ts +183 -183
  179. package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +176 -169
  180. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +139 -139
  181. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +173 -173
  182. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +171 -171
  183. package/src/core/text-rendering/font-face-types/TrFontFace.ts +187 -187
  184. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +89 -89
  185. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +509 -509
  186. package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +798 -798
  187. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +853 -853
  188. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +48 -48
  189. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +66 -66
  190. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +52 -52
  191. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts +32 -32
  192. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +117 -117
  193. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +133 -133
  194. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts +38 -38
  195. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +403 -403
  196. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +49 -49
  197. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +52 -52
  198. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +205 -205
  199. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +93 -93
  200. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts +40 -40
  201. package/src/core/text-rendering/renderers/TextRenderer.ts +557 -557
  202. package/src/core/textures/ColorTexture.ts +102 -102
  203. package/src/core/textures/ImageTexture.ts +378 -378
  204. package/src/core/textures/NoiseTexture.ts +104 -104
  205. package/src/core/textures/RenderTexture.ts +85 -85
  206. package/src/core/textures/SubTexture.ts +171 -171
  207. package/src/core/textures/Texture.ts +423 -407
  208. package/src/core/utils.ts +227 -227
  209. package/src/env.d.ts +7 -7
  210. package/src/main-api/DynamicShaderController.ts +104 -104
  211. package/src/main-api/INode.ts +101 -101
  212. package/src/main-api/Inspector.ts +505 -505
  213. package/src/main-api/Renderer.ts +693 -693
  214. package/src/main-api/ShaderController.ts +80 -80
  215. package/src/main-api/utils.ts +45 -45
  216. package/src/utils.ts +248 -248
  217. package/COPYING +0 -1
@@ -1,80 +1,80 @@
1
- /*
2
- * If not stated otherwise in this file or this component's LICENSE file the
3
- * following copyright and licenses apply:
4
- *
5
- * Copyright 2024 Comcast Cable Communications Management, LLC.
6
- *
7
- * Licensed under the Apache License, Version 2.0 (the License);
8
- * you may not use this file except in compliance with the License.
9
- * You may obtain a copy of the License at
10
- *
11
- * http://www.apache.org/licenses/LICENSE-2.0
12
- *
13
- * Unless required by applicable law or agreed to in writing, software
14
- * distributed under the License is distributed on an "AS IS" BASIS,
15
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
- * See the License for the specific language governing permissions and
17
- * limitations under the License.
18
- */
19
- /* eslint-disable @typescript-eslint/no-explicit-any */
20
- import type { ShaderMap } from '../core/CoreShaderManager.js';
21
- import type { ExtractProps } from '../core/CoreTextureManager.js';
22
- import type { Stage } from '../core/Stage.js';
23
- import type { CoreShader } from '../core/renderers/CoreShader.js';
24
-
25
- /**
26
- * Shader Controller Base Interface
27
- *
28
- * @remarks
29
- * Used directly this interface is like an `any` type for Shader Controllers.
30
- * But it is also used as a base for more specific Shader Controller interfaces.
31
- */
32
- export interface BaseShaderController {
33
- type: keyof ShaderMap;
34
- shader: CoreShader;
35
- props: Record<string, any>;
36
- getResolvedProps: () => Record<string, any>;
37
- }
38
-
39
- /**
40
- * Shader Controller Class
41
- *
42
- * @remarks
43
- * This class is used to control shader props.
44
- */
45
-
46
- export class ShaderController<S extends keyof ShaderMap>
47
- implements BaseShaderController
48
- {
49
- private resolvedProps: ExtractProps<ShaderMap[S]>;
50
- props: ExtractProps<ShaderMap[S]>;
51
- constructor(
52
- readonly type: S,
53
- readonly shader: InstanceType<ShaderMap[S]>,
54
- props: ExtractProps<ShaderMap[S]>,
55
- stage: Stage,
56
- ) {
57
- this.resolvedProps = props;
58
- const keys = Object.keys(props);
59
- const l = keys.length;
60
-
61
- const definedProps = {};
62
- for (let i = 0; i < l; i++) {
63
- const name = keys[i]!;
64
- Object.defineProperty(definedProps, name, {
65
- get: () => {
66
- return this.resolvedProps[name as keyof ExtractProps<ShaderMap[S]>];
67
- },
68
- set: (value) => {
69
- this.resolvedProps[name as keyof ExtractProps<ShaderMap[S]>] = value;
70
- stage.requestRender();
71
- },
72
- });
73
- }
74
- this.props = definedProps as ExtractProps<ShaderMap[S]>;
75
- }
76
-
77
- getResolvedProps() {
78
- return this.resolvedProps;
79
- }
80
- }
1
+ /*
2
+ * If not stated otherwise in this file or this component's LICENSE file the
3
+ * following copyright and licenses apply:
4
+ *
5
+ * Copyright 2024 Comcast Cable Communications Management, LLC.
6
+ *
7
+ * Licensed under the Apache License, Version 2.0 (the License);
8
+ * you may not use this file except in compliance with the License.
9
+ * You may obtain a copy of the License at
10
+ *
11
+ * http://www.apache.org/licenses/LICENSE-2.0
12
+ *
13
+ * Unless required by applicable law or agreed to in writing, software
14
+ * distributed under the License is distributed on an "AS IS" BASIS,
15
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ * See the License for the specific language governing permissions and
17
+ * limitations under the License.
18
+ */
19
+ /* eslint-disable @typescript-eslint/no-explicit-any */
20
+ import type { ShaderMap } from '../core/CoreShaderManager.js';
21
+ import type { ExtractProps } from '../core/CoreTextureManager.js';
22
+ import type { Stage } from '../core/Stage.js';
23
+ import type { CoreShader } from '../core/renderers/CoreShader.js';
24
+
25
+ /**
26
+ * Shader Controller Base Interface
27
+ *
28
+ * @remarks
29
+ * Used directly this interface is like an `any` type for Shader Controllers.
30
+ * But it is also used as a base for more specific Shader Controller interfaces.
31
+ */
32
+ export interface BaseShaderController {
33
+ type: keyof ShaderMap;
34
+ shader: CoreShader;
35
+ props: Record<string, any>;
36
+ getResolvedProps: () => Record<string, any>;
37
+ }
38
+
39
+ /**
40
+ * Shader Controller Class
41
+ *
42
+ * @remarks
43
+ * This class is used to control shader props.
44
+ */
45
+
46
+ export class ShaderController<S extends keyof ShaderMap>
47
+ implements BaseShaderController
48
+ {
49
+ private resolvedProps: ExtractProps<ShaderMap[S]>;
50
+ props: ExtractProps<ShaderMap[S]>;
51
+ constructor(
52
+ readonly type: S,
53
+ readonly shader: InstanceType<ShaderMap[S]>,
54
+ props: ExtractProps<ShaderMap[S]>,
55
+ stage: Stage,
56
+ ) {
57
+ this.resolvedProps = props;
58
+ const keys = Object.keys(props);
59
+ const l = keys.length;
60
+
61
+ const definedProps = {};
62
+ for (let i = 0; i < l; i++) {
63
+ const name = keys[i]!;
64
+ Object.defineProperty(definedProps, name, {
65
+ get: () => {
66
+ return this.resolvedProps[name as keyof ExtractProps<ShaderMap[S]>];
67
+ },
68
+ set: (value) => {
69
+ this.resolvedProps[name as keyof ExtractProps<ShaderMap[S]>] = value;
70
+ stage.requestRender();
71
+ },
72
+ });
73
+ }
74
+ this.props = definedProps as ExtractProps<ShaderMap[S]>;
75
+ }
76
+
77
+ getResolvedProps() {
78
+ return this.resolvedProps;
79
+ }
80
+ }
@@ -1,45 +1,45 @@
1
- import type { CustomDataMap } from '../core/CoreNode.js';
2
-
3
- export function santizeCustomDataMap(d: CustomDataMap): CustomDataMap {
4
- const validTypes = {
5
- boolean: true,
6
- string: true,
7
- number: true,
8
- undefined: true,
9
- };
10
-
11
- const keys = Object.keys(d);
12
- for (let i = 0; i < keys.length; i++) {
13
- const key = keys[i];
14
- if (!key) {
15
- continue;
16
- }
17
-
18
- const value = d[key];
19
- const valueType = typeof value;
20
-
21
- // Typescript doesn't understand the above const valueType ¯\_(ツ)_/¯
22
- // eslint-disable-next-line @typescript-eslint/ban-ts-comment
23
- // @ts-ignore-next-line
24
- if (valueType === 'string' && value.length > 2048) {
25
- console.warn(
26
- `Custom Data value for ${key} is too long, it will be truncated to 2048 characters`,
27
- );
28
-
29
- // same here, see above comment, this can only be a string at this point
30
- // eslint-disable-next-line @typescript-eslint/ban-ts-comment
31
- // @ts-ignore-next-line
32
- // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call
33
- d[key] = value.substring(0, 2048);
34
- }
35
-
36
- if (!validTypes[valueType as keyof typeof validTypes]) {
37
- console.warn(
38
- `Custom Data value for ${key} is not a boolean, string, or number, it will be ignored`,
39
- );
40
- delete d[key];
41
- }
42
- }
43
-
44
- return d;
45
- }
1
+ import type { CustomDataMap } from '../core/CoreNode.js';
2
+
3
+ export function santizeCustomDataMap(d: CustomDataMap): CustomDataMap {
4
+ const validTypes = {
5
+ boolean: true,
6
+ string: true,
7
+ number: true,
8
+ undefined: true,
9
+ };
10
+
11
+ const keys = Object.keys(d);
12
+ for (let i = 0; i < keys.length; i++) {
13
+ const key = keys[i];
14
+ if (!key) {
15
+ continue;
16
+ }
17
+
18
+ const value = d[key];
19
+ const valueType = typeof value;
20
+
21
+ // Typescript doesn't understand the above const valueType ¯\_(ツ)_/¯
22
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
23
+ // @ts-ignore-next-line
24
+ if (valueType === 'string' && value.length > 2048) {
25
+ console.warn(
26
+ `Custom Data value for ${key} is too long, it will be truncated to 2048 characters`,
27
+ );
28
+
29
+ // same here, see above comment, this can only be a string at this point
30
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
31
+ // @ts-ignore-next-line
32
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call
33
+ d[key] = value.substring(0, 2048);
34
+ }
35
+
36
+ if (!validTypes[valueType as keyof typeof validTypes]) {
37
+ console.warn(
38
+ `Custom Data value for ${key} is not a boolean, string, or number, it will be ignored`,
39
+ );
40
+ delete d[key];
41
+ }
42
+ }
43
+
44
+ return d;
45
+ }