@loaders.gl/loader-utils 4.3.4 → 4.4.0-alpha.10

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 (189) hide show
  1. package/README.md +8 -0
  2. package/dist/format-types.d.ts +24 -0
  3. package/dist/format-types.d.ts.map +1 -0
  4. package/dist/format-types.js +5 -0
  5. package/dist/format-types.js.map +1 -0
  6. package/dist/index.cjs +201 -307
  7. package/dist/index.cjs.map +4 -4
  8. package/dist/index.d.ts +16 -17
  9. package/dist/index.d.ts.map +1 -1
  10. package/dist/index.js +6 -9
  11. package/dist/index.js.map +1 -0
  12. package/dist/json-loader.js +2 -1
  13. package/dist/json-loader.js.map +1 -0
  14. package/dist/lib/binary-utils/array-buffer-utils.d.ts +2 -2
  15. package/dist/lib/binary-utils/array-buffer-utils.d.ts.map +1 -1
  16. package/dist/lib/binary-utils/array-buffer-utils.js +1 -0
  17. package/dist/lib/binary-utils/array-buffer-utils.js.map +1 -0
  18. package/dist/lib/binary-utils/dataview-copy-utils.js +1 -0
  19. package/dist/lib/binary-utils/dataview-copy-utils.js.map +1 -0
  20. package/dist/lib/binary-utils/get-first-characters.d.ts +1 -1
  21. package/dist/lib/binary-utils/get-first-characters.d.ts.map +1 -1
  22. package/dist/lib/binary-utils/get-first-characters.js +1 -0
  23. package/dist/lib/binary-utils/get-first-characters.js.map +1 -0
  24. package/dist/lib/binary-utils/memory-conversion-utils.d.ts +10 -4
  25. package/dist/lib/binary-utils/memory-conversion-utils.d.ts.map +1 -1
  26. package/dist/lib/binary-utils/memory-conversion-utils.js +40 -4
  27. package/dist/lib/binary-utils/memory-conversion-utils.js.map +1 -0
  28. package/dist/lib/binary-utils/memory-copy-utils.js +1 -0
  29. package/dist/lib/binary-utils/memory-copy-utils.js.map +1 -0
  30. package/dist/lib/env-utils/assert.js +1 -0
  31. package/dist/lib/env-utils/assert.js.map +1 -0
  32. package/dist/lib/env-utils/globals.js +1 -0
  33. package/dist/lib/env-utils/globals.js.map +1 -0
  34. package/dist/lib/file-provider/data-view-file.d.ts.map +1 -1
  35. package/dist/lib/file-provider/data-view-file.js +3 -1
  36. package/dist/lib/file-provider/data-view-file.js.map +1 -0
  37. package/dist/lib/file-provider/file-handle-file.js +1 -0
  38. package/dist/lib/file-provider/file-handle-file.js.map +1 -0
  39. package/dist/lib/file-provider/file-provider-interface.js +1 -0
  40. package/dist/lib/file-provider/file-provider-interface.js.map +1 -0
  41. package/dist/lib/file-provider/file-provider.js +1 -0
  42. package/dist/lib/file-provider/file-provider.js.map +1 -0
  43. package/dist/lib/files/blob-file.js +1 -0
  44. package/dist/lib/files/blob-file.js.map +1 -0
  45. package/dist/lib/files/file.js +1 -0
  46. package/dist/lib/files/file.js.map +1 -0
  47. package/dist/lib/files/http-file.js +1 -0
  48. package/dist/lib/files/http-file.js.map +1 -0
  49. package/dist/lib/files/node-file-facade.js +1 -0
  50. package/dist/lib/files/node-file-facade.js.map +1 -0
  51. package/dist/lib/files/sources.js +1 -0
  52. package/dist/lib/files/sources.js.map +1 -0
  53. package/dist/lib/filesystems/filesystem.js +1 -0
  54. package/dist/lib/filesystems/filesystem.js.map +1 -0
  55. package/dist/lib/filesystems/node-filesystem-facade.js +1 -0
  56. package/dist/lib/filesystems/node-filesystem-facade.js.map +1 -0
  57. package/dist/lib/iterators/async-iteration.d.ts +14 -14
  58. package/dist/lib/iterators/async-iteration.d.ts.map +1 -1
  59. package/dist/lib/iterators/async-iteration.js +68 -16
  60. package/dist/lib/iterators/async-iteration.js.map +1 -0
  61. package/dist/lib/iterators/text-iterators.js +2 -1
  62. package/dist/lib/iterators/text-iterators.js.map +1 -0
  63. package/dist/lib/javascript-utils/is-type.d.ts +59 -0
  64. package/dist/lib/javascript-utils/is-type.d.ts.map +1 -0
  65. package/dist/lib/javascript-utils/is-type.js +68 -0
  66. package/dist/lib/javascript-utils/is-type.js.map +1 -0
  67. package/dist/lib/log-utils/log.js +2 -1
  68. package/dist/lib/log-utils/log.js.map +1 -0
  69. package/dist/lib/module-utils/js-module-utils.js +1 -0
  70. package/dist/lib/module-utils/js-module-utils.js.map +1 -0
  71. package/dist/lib/node/buffer.browser.js +1 -0
  72. package/dist/lib/node/buffer.browser.js.map +1 -0
  73. package/dist/lib/node/buffer.js +1 -0
  74. package/dist/lib/node/buffer.js.map +1 -0
  75. package/dist/lib/node/fs.browser.js +1 -0
  76. package/dist/lib/node/fs.browser.js.map +1 -0
  77. package/dist/lib/node/promisify.js +1 -0
  78. package/dist/lib/node/promisify.js.map +1 -0
  79. package/dist/lib/node/stream.browser.js +1 -0
  80. package/dist/lib/node/stream.browser.js.map +1 -0
  81. package/dist/lib/node/stream.js +1 -0
  82. package/dist/lib/node/stream.js.map +1 -0
  83. package/dist/lib/option-utils/merge-options.d.ts +12 -0
  84. package/dist/lib/option-utils/merge-options.d.ts.map +1 -0
  85. package/dist/lib/option-utils/{merge-loader-options.js → merge-options.js} +5 -1
  86. package/dist/lib/option-utils/merge-options.js.map +1 -0
  87. package/dist/lib/parser-utils/parse-json.js +1 -0
  88. package/dist/lib/parser-utils/parse-json.js.map +1 -0
  89. package/dist/lib/path-utils/file-aliases.js +1 -0
  90. package/dist/lib/path-utils/file-aliases.js.map +1 -0
  91. package/dist/lib/path-utils/get-cwd.js +1 -0
  92. package/dist/lib/path-utils/get-cwd.js.map +1 -0
  93. package/dist/lib/path-utils/path.js +2 -1
  94. package/dist/lib/path-utils/path.js.map +1 -0
  95. package/dist/lib/request-utils/request-scheduler.d.ts +4 -0
  96. package/dist/lib/request-utils/request-scheduler.d.ts.map +1 -1
  97. package/dist/lib/request-utils/request-scheduler.js +15 -0
  98. package/dist/lib/request-utils/request-scheduler.js.map +1 -0
  99. package/dist/lib/sources/data-source.d.ts +26 -14
  100. package/dist/lib/sources/data-source.d.ts.map +1 -1
  101. package/dist/lib/sources/data-source.js +32 -9
  102. package/dist/lib/sources/data-source.js.map +1 -0
  103. package/dist/lib/sources/image-source.d.ts +1 -4
  104. package/dist/lib/sources/image-source.d.ts.map +1 -1
  105. package/dist/lib/sources/image-source.js +3 -2
  106. package/dist/lib/sources/image-source.js.map +1 -0
  107. package/dist/lib/sources/image-tile-source.d.ts +2 -1
  108. package/dist/lib/sources/image-tile-source.d.ts.map +1 -1
  109. package/dist/lib/sources/image-tile-source.js +1 -0
  110. package/dist/lib/sources/image-tile-source.js.map +1 -0
  111. package/dist/lib/sources/tile-source-adapter.d.ts +3 -3
  112. package/dist/lib/sources/tile-source-adapter.d.ts.map +1 -1
  113. package/dist/lib/sources/tile-source-adapter.js +1 -1
  114. package/dist/lib/sources/tile-source-adapter.js.map +1 -0
  115. package/dist/lib/sources/tile-source.d.ts +3 -5
  116. package/dist/lib/sources/tile-source.d.ts.map +1 -1
  117. package/dist/lib/sources/tile-source.js +1 -0
  118. package/dist/lib/sources/tile-source.js.map +1 -0
  119. package/dist/lib/sources/utils/image-type.js +1 -0
  120. package/dist/lib/sources/utils/image-type.js.map +1 -0
  121. package/dist/lib/sources/utils/utils.js +2 -1
  122. package/dist/lib/sources/utils/utils.js.map +1 -0
  123. package/dist/lib/sources/vector-source.d.ts +2 -4
  124. package/dist/lib/sources/vector-source.d.ts.map +1 -1
  125. package/dist/lib/sources/vector-source.js +2 -2
  126. package/dist/lib/sources/vector-source.js.map +1 -0
  127. package/dist/lib/sources/vector-tile-source.d.ts +2 -2
  128. package/dist/lib/sources/vector-tile-source.d.ts.map +1 -1
  129. package/dist/lib/sources/vector-tile-source.js +1 -0
  130. package/dist/lib/sources/vector-tile-source.js.map +1 -0
  131. package/dist/lib/worker-loader-utils/create-loader-worker.js +5 -1
  132. package/dist/lib/worker-loader-utils/create-loader-worker.js.map +1 -0
  133. package/dist/lib/worker-loader-utils/encode-with-worker.d.ts +1 -1
  134. package/dist/lib/worker-loader-utils/encode-with-worker.d.ts.map +1 -1
  135. package/dist/lib/worker-loader-utils/encode-with-worker.js +5 -2
  136. package/dist/lib/worker-loader-utils/encode-with-worker.js.map +1 -0
  137. package/dist/lib/worker-loader-utils/parse-with-worker.d.ts +1 -1
  138. package/dist/lib/worker-loader-utils/parse-with-worker.d.ts.map +1 -1
  139. package/dist/lib/worker-loader-utils/parse-with-worker.js +6 -3
  140. package/dist/lib/worker-loader-utils/parse-with-worker.js.map +1 -0
  141. package/dist/loader-types.d.ts +99 -74
  142. package/dist/loader-types.d.ts.map +1 -1
  143. package/dist/loader-types.js +1 -0
  144. package/dist/loader-types.js.map +1 -0
  145. package/dist/source-types.d.ts +20 -8
  146. package/dist/source-types.d.ts.map +1 -1
  147. package/dist/source-types.js +2 -0
  148. package/dist/source-types.js.map +1 -0
  149. package/dist/types.d.ts +9 -4
  150. package/dist/types.d.ts.map +1 -1
  151. package/dist/types.js +1 -0
  152. package/dist/types.js.map +1 -0
  153. package/dist/workers/json-worker.js +1 -0
  154. package/dist/workers/json-worker.js.map +1 -0
  155. package/dist/writer-types.d.ts +22 -15
  156. package/dist/writer-types.d.ts.map +1 -1
  157. package/dist/writer-types.js +1 -0
  158. package/dist/writer-types.js.map +1 -0
  159. package/package.json +4 -7
  160. package/src/format-types.ts +27 -0
  161. package/src/index.ts +51 -17
  162. package/src/lib/binary-utils/array-buffer-utils.ts +3 -3
  163. package/src/lib/binary-utils/get-first-characters.ts +1 -1
  164. package/src/lib/binary-utils/memory-conversion-utils.ts +58 -8
  165. package/src/lib/file-provider/data-view-file.ts +6 -1
  166. package/src/lib/iterators/async-iteration.ts +94 -19
  167. package/src/lib/iterators/text-iterators.ts +1 -1
  168. package/src/lib/javascript-utils/is-type.ts +130 -0
  169. package/src/lib/node/buffer.ts +1 -1
  170. package/src/lib/option-utils/{merge-loader-options.ts → merge-options.ts} +10 -6
  171. package/src/lib/path-utils/path.ts +1 -1
  172. package/src/lib/request-utils/request-scheduler.ts +15 -0
  173. package/src/lib/sources/data-source.ts +53 -19
  174. package/src/lib/sources/image-source.ts +2 -7
  175. package/src/lib/sources/image-tile-source.ts +2 -4
  176. package/src/lib/sources/tile-source-adapter.ts +4 -4
  177. package/src/lib/sources/tile-source.ts +3 -9
  178. package/src/lib/sources/utils/utils.ts +1 -1
  179. package/src/lib/sources/vector-source.ts +2 -6
  180. package/src/lib/sources/vector-tile-source.ts +2 -5
  181. package/src/lib/worker-loader-utils/create-loader-worker.ts +4 -1
  182. package/src/lib/worker-loader-utils/encode-with-worker.ts +5 -2
  183. package/src/lib/worker-loader-utils/parse-with-worker.ts +5 -3
  184. package/src/loader-types.ts +126 -98
  185. package/src/source-types.ts +35 -10
  186. package/src/types.ts +17 -9
  187. package/src/writer-types.ts +25 -20
  188. package/dist/lib/option-utils/merge-loader-options.d.ts +0 -9
  189. package/dist/lib/option-utils/merge-loader-options.d.ts.map +0 -1
package/README.md CHANGED
@@ -3,3 +3,11 @@
3
3
  This module contains shared utilities for loaders.gl, a collection of framework-independent 3D and geospatial loaders (parsers).
4
4
 
5
5
  For documentation please visit the [website](https://loaders.gl).
6
+
7
+ ## Binary iterator utilities
8
+
9
+ `@loaders.gl/loader-utils` includes helpers such as `concatenateArrayBuffersAsync` that operate
10
+ over `ArrayBuffer`, `ArrayBufferView`, and `ArrayBufferLike` inputs (including `SharedArrayBuffer`).
11
+ These utilities make it easy to normalize streamed binary data before handing it off to loaders.
12
+ Chunks backed by `SharedArrayBuffer` or typed array views are copied into standalone `ArrayBuffer`
13
+ instances so byte offsets and underlying storage quirks never corrupt concatenated output.
@@ -0,0 +1,24 @@
1
+ /**
2
+ * An object that describes a format
3
+ */
4
+ export type Format = {
5
+ /** Human readable name */
6
+ name: string;
7
+ /** Unique lower-case id string for this format. Used for e.g. LoaderOptions */
8
+ id: string;
9
+ /** loaders.gl module that contains the implementation of this format */
10
+ module: string;
11
+ /** Which category does this loader belong to */
12
+ category?: string;
13
+ /** File extensions that are potential matches with this loader. */
14
+ extensions: string[];
15
+ /** MIMETypes that indicate a match with this loader. @note Some MIMETypes are generic and supported by many loaders */
16
+ mimeTypes: string[];
17
+ /** Is this a binary format */
18
+ binary?: boolean;
19
+ /** Is this a text format */
20
+ text?: boolean;
21
+ /** Test some initial bytes of content to see if this loader might be a match */
22
+ tests?: (((ArrayBuffer: ArrayBuffer) => boolean) | ArrayBuffer | string)[];
23
+ };
24
+ //# sourceMappingURL=format-types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"format-types.d.ts","sourceRoot":"","sources":["../src/format-types.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,+EAA+E;IAC/E,EAAE,EAAE,MAAM,CAAC;IACX,wEAAwE;IACxE,MAAM,EAAE,MAAM,CAAC;IACf,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mEAAmE;IACnE,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,uHAAuH;IACvH,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,8BAA8B;IAC9B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,4BAA4B;IAC5B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,gFAAgF;IAChF,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,WAAW,KAAK,OAAO,CAAC,GAAG,WAAW,GAAG,MAAM,CAAC,EAAE,CAAC;CAC5E,CAAC"}
@@ -0,0 +1,5 @@
1
+ // loaders.gl
2
+ // SPDX-License-Identifier: MIT
3
+ // Copyright (c) vis.gl contributors
4
+ export {};
5
+ //# sourceMappingURL=format-types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"format-types.js","sourceRoot":"","sources":["../src/format-types.ts"],"names":[],"mappings":"AAAA,aAAa;AACb,+BAA+B;AAC/B,oCAAoC"}