@loaders.gl/loader-utils 3.4.0-alpha.1 → 3.4.0-alpha.3

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 (200) hide show
  1. package/dist/es5/index.js +43 -22
  2. package/dist/es5/index.js.map +1 -1
  3. package/dist/es5/json-loader.js +7 -11
  4. package/dist/es5/json-loader.js.map +1 -1
  5. package/dist/es5/lib/binary-utils/array-buffer-utils.js +1 -38
  6. package/dist/es5/lib/binary-utils/array-buffer-utils.js.map +1 -1
  7. package/dist/es5/lib/binary-utils/{binary-copy-utils.js → dataview-copy-utils.js} +30 -3
  8. package/dist/es5/lib/binary-utils/dataview-copy-utils.js.map +1 -0
  9. package/dist/es5/lib/binary-utils/get-first-characters.js.map +1 -1
  10. package/dist/es5/lib/binary-utils/{buffer-utils.js → memory-conversion-utils.js} +23 -9
  11. package/dist/es5/lib/binary-utils/memory-conversion-utils.js.map +1 -0
  12. package/dist/es5/lib/binary-utils/memory-copy-utils.js +0 -3
  13. package/dist/es5/lib/binary-utils/memory-copy-utils.js.map +1 -1
  14. package/dist/es5/lib/env-utils/assert.js.map +1 -1
  15. package/dist/es5/lib/env-utils/globals.js +1 -5
  16. package/dist/es5/lib/env-utils/globals.js.map +1 -1
  17. package/dist/es5/lib/filesystems/node-filesystem.js +86 -100
  18. package/dist/es5/lib/filesystems/node-filesystem.js.map +1 -1
  19. package/dist/es5/lib/filesystems/readable-file.js +91 -0
  20. package/dist/es5/lib/filesystems/readable-file.js.map +1 -0
  21. package/dist/es5/lib/filesystems/writable-file.js +82 -0
  22. package/dist/es5/lib/filesystems/writable-file.js.map +1 -0
  23. package/dist/es5/lib/iterators/async-iteration.js +134 -140
  24. package/dist/es5/lib/iterators/async-iteration.js.map +1 -1
  25. package/dist/es5/lib/iterators/text-iterators.js +207 -221
  26. package/dist/es5/lib/iterators/text-iterators.js.map +1 -1
  27. package/dist/es5/lib/node/buffer.browser.js +14 -0
  28. package/dist/es5/lib/node/buffer.browser.js.map +1 -0
  29. package/dist/es5/lib/node/buffer.js +5 -10
  30. package/dist/es5/lib/node/buffer.js.map +1 -1
  31. package/dist/es5/lib/node/fs.js +38 -40
  32. package/dist/es5/lib/node/fs.js.map +1 -1
  33. package/dist/es5/lib/node/promisify.js +36 -0
  34. package/dist/es5/lib/node/promisify.js.map +1 -0
  35. package/dist/es5/lib/node/stream.js +16 -0
  36. package/dist/es5/lib/node/stream.js.map +1 -0
  37. package/dist/es5/lib/option-utils/merge-loader-options.js +28 -0
  38. package/dist/es5/lib/option-utils/merge-loader-options.js.map +1 -0
  39. package/dist/es5/lib/parser-utils/parse-json.js.map +1 -1
  40. package/dist/es5/lib/path-utils/file-aliases.js +0 -5
  41. package/dist/es5/lib/path-utils/file-aliases.js.map +1 -1
  42. package/dist/es5/lib/path-utils/get-cwd.js +15 -0
  43. package/dist/es5/lib/path-utils/get-cwd.js.map +1 -0
  44. package/dist/es5/lib/path-utils/path.js +105 -5
  45. package/dist/es5/lib/path-utils/path.js.map +1 -1
  46. package/dist/es5/lib/request-utils/request-scheduler.js +6 -29
  47. package/dist/es5/lib/request-utils/request-scheduler.js.map +1 -1
  48. package/dist/es5/lib/worker-loader-utils/create-loader-worker.js +69 -79
  49. package/dist/es5/lib/worker-loader-utils/create-loader-worker.js.map +1 -1
  50. package/dist/es5/lib/worker-loader-utils/encode-with-worker.js +0 -1
  51. package/dist/es5/lib/worker-loader-utils/encode-with-worker.js.map +1 -1
  52. package/dist/es5/lib/worker-loader-utils/parse-with-worker.js +70 -77
  53. package/dist/es5/lib/worker-loader-utils/parse-with-worker.js.map +1 -1
  54. package/dist/es5/types.js.map +1 -1
  55. package/dist/es5/workers/json-worker.js.map +1 -1
  56. package/dist/esm/index.js +9 -21
  57. package/dist/esm/index.js.map +1 -1
  58. package/dist/esm/json-loader.js +1 -4
  59. package/dist/esm/json-loader.js.map +1 -1
  60. package/dist/esm/lib/binary-utils/array-buffer-utils.js +0 -35
  61. package/dist/esm/lib/binary-utils/array-buffer-utils.js.map +1 -1
  62. package/dist/esm/lib/binary-utils/{binary-copy-utils.js → dataview-copy-utils.js} +27 -4
  63. package/dist/esm/lib/binary-utils/dataview-copy-utils.js.map +1 -0
  64. package/dist/esm/lib/binary-utils/get-first-characters.js.map +1 -1
  65. package/dist/esm/lib/binary-utils/memory-conversion-utils.js +31 -0
  66. package/dist/esm/lib/binary-utils/memory-conversion-utils.js.map +1 -0
  67. package/dist/esm/lib/binary-utils/memory-copy-utils.js +0 -4
  68. package/dist/esm/lib/binary-utils/memory-copy-utils.js.map +1 -1
  69. package/dist/esm/lib/env-utils/assert.js +0 -1
  70. package/dist/esm/lib/env-utils/assert.js.map +1 -1
  71. package/dist/esm/lib/env-utils/globals.js +1 -7
  72. package/dist/esm/lib/env-utils/globals.js.map +1 -1
  73. package/dist/esm/lib/filesystems/node-filesystem.js +0 -1
  74. package/dist/esm/lib/filesystems/node-filesystem.js.map +1 -1
  75. package/dist/esm/lib/filesystems/readable-file.js +20 -0
  76. package/dist/esm/lib/filesystems/readable-file.js.map +1 -0
  77. package/dist/esm/lib/filesystems/writable-file.js +20 -0
  78. package/dist/esm/lib/filesystems/writable-file.js.map +1 -0
  79. package/dist/esm/lib/iterators/async-iteration.js +0 -2
  80. package/dist/esm/lib/iterators/async-iteration.js.map +1 -1
  81. package/dist/esm/lib/iterators/text-iterators.js +13 -12
  82. package/dist/esm/lib/iterators/text-iterators.js.map +1 -1
  83. package/dist/esm/lib/node/buffer.browser.js +7 -0
  84. package/dist/esm/lib/node/buffer.browser.js.map +1 -0
  85. package/dist/esm/lib/node/buffer.js +5 -12
  86. package/dist/esm/lib/node/buffer.js.map +1 -1
  87. package/dist/esm/lib/node/fs.js +12 -17
  88. package/dist/esm/lib/node/fs.js.map +1 -1
  89. package/dist/esm/lib/node/promisify.js +10 -0
  90. package/dist/esm/lib/node/promisify.js.map +1 -0
  91. package/dist/esm/lib/node/stream.js +7 -0
  92. package/dist/esm/lib/node/stream.js.map +1 -0
  93. package/dist/esm/lib/option-utils/merge-loader-options.js +15 -0
  94. package/dist/esm/lib/option-utils/merge-loader-options.js.map +1 -0
  95. package/dist/esm/lib/parser-utils/parse-json.js +0 -1
  96. package/dist/esm/lib/parser-utils/parse-json.js.map +1 -1
  97. package/dist/esm/lib/path-utils/file-aliases.js +0 -6
  98. package/dist/esm/lib/path-utils/file-aliases.js.map +1 -1
  99. package/dist/esm/lib/path-utils/get-cwd.js +9 -0
  100. package/dist/esm/lib/path-utils/get-cwd.js.map +1 -0
  101. package/dist/esm/lib/path-utils/path.js +104 -6
  102. package/dist/esm/lib/path-utils/path.js.map +1 -1
  103. package/dist/esm/lib/request-utils/request-scheduler.js +0 -16
  104. package/dist/esm/lib/request-utils/request-scheduler.js.map +1 -1
  105. package/dist/esm/lib/worker-loader-utils/create-loader-worker.js +0 -10
  106. package/dist/esm/lib/worker-loader-utils/create-loader-worker.js.map +1 -1
  107. package/dist/esm/lib/worker-loader-utils/encode-with-worker.js +0 -2
  108. package/dist/esm/lib/worker-loader-utils/encode-with-worker.js.map +1 -1
  109. package/dist/esm/lib/worker-loader-utils/parse-with-worker.js +1 -8
  110. package/dist/esm/lib/worker-loader-utils/parse-with-worker.js.map +1 -1
  111. package/dist/esm/types.js.map +1 -1
  112. package/dist/index.d.ts +11 -7
  113. package/dist/index.d.ts.map +1 -1
  114. package/dist/index.js +28 -23
  115. package/dist/lib/binary-utils/array-buffer-utils.d.ts +4 -8
  116. package/dist/lib/binary-utils/array-buffer-utils.d.ts.map +1 -1
  117. package/dist/lib/binary-utils/array-buffer-utils.js +5 -36
  118. package/dist/lib/binary-utils/dataview-copy-utils.d.ts +43 -0
  119. package/dist/lib/binary-utils/dataview-copy-utils.d.ts.map +1 -0
  120. package/dist/lib/binary-utils/{binary-copy-utils.js → dataview-copy-utils.js} +51 -5
  121. package/dist/lib/binary-utils/get-first-characters.d.ts +15 -1
  122. package/dist/lib/binary-utils/get-first-characters.d.ts.map +1 -1
  123. package/dist/lib/binary-utils/get-first-characters.js +15 -0
  124. package/dist/lib/binary-utils/{buffer-utils.d.ts → memory-conversion-utils.d.ts} +3 -4
  125. package/dist/lib/binary-utils/memory-conversion-utils.d.ts.map +1 -0
  126. package/dist/lib/binary-utils/{buffer-utils.js → memory-conversion-utils.js} +28 -9
  127. package/dist/lib/filesystems/readable-file.d.ts +10 -0
  128. package/dist/lib/filesystems/readable-file.d.ts.map +1 -0
  129. package/dist/lib/filesystems/readable-file.js +25 -0
  130. package/dist/lib/filesystems/writable-file.d.ts +18 -0
  131. package/dist/lib/filesystems/writable-file.d.ts.map +1 -0
  132. package/dist/lib/{node/util.js → filesystems/writable-file.js} +23 -4
  133. package/dist/lib/node/buffer.browser.d.ts +12 -0
  134. package/dist/lib/node/buffer.browser.d.ts.map +1 -0
  135. package/dist/lib/node/buffer.browser.js +22 -0
  136. package/dist/lib/node/buffer.d.ts +3 -1
  137. package/dist/lib/node/buffer.d.ts.map +1 -1
  138. package/dist/lib/node/buffer.js +10 -10
  139. package/dist/lib/node/fs.d.ts +4 -2
  140. package/dist/lib/node/fs.d.ts.map +1 -1
  141. package/dist/lib/node/fs.js +11 -10
  142. package/dist/lib/node/promisify.d.ts +13 -0
  143. package/dist/lib/node/promisify.d.ts.map +1 -0
  144. package/dist/lib/node/promisify.js +22 -0
  145. package/dist/lib/node/stream.d.ts +4 -0
  146. package/dist/lib/node/stream.d.ts.map +1 -0
  147. package/dist/lib/node/stream.js +17 -0
  148. package/dist/lib/option-utils/merge-loader-options.d.ts +9 -0
  149. package/dist/lib/option-utils/merge-loader-options.d.ts.map +1 -0
  150. package/dist/lib/option-utils/merge-loader-options.js +24 -0
  151. package/dist/lib/path-utils/get-cwd.d.ts +2 -0
  152. package/dist/lib/path-utils/get-cwd.d.ts.map +1 -0
  153. package/dist/lib/path-utils/get-cwd.js +12 -0
  154. package/dist/lib/path-utils/path.d.ts +8 -0
  155. package/dist/lib/path-utils/path.d.ts.map +1 -1
  156. package/dist/lib/path-utils/path.js +141 -3
  157. package/dist/lib/worker-loader-utils/create-loader-worker.js +1 -1
  158. package/dist/types.d.ts +26 -26
  159. package/dist/types.d.ts.map +1 -1
  160. package/package.json +10 -17
  161. package/src/index.ts +24 -18
  162. package/src/lib/binary-utils/array-buffer-utils.ts +4 -40
  163. package/src/lib/binary-utils/{binary-copy-utils.ts → dataview-copy-utils.ts} +57 -5
  164. package/src/lib/binary-utils/get-first-characters.ts +17 -1
  165. package/src/lib/binary-utils/memory-conversion-utils.ts +53 -0
  166. package/src/lib/filesystems/readable-file.ts +30 -0
  167. package/src/lib/filesystems/writable-file.ts +44 -0
  168. package/src/lib/node/buffer.browser.ts +20 -0
  169. package/src/lib/node/buffer.ts +12 -11
  170. package/src/lib/node/fs.ts +16 -11
  171. package/src/lib/node/promisify.ts +70 -0
  172. package/src/lib/node/stream.ts +18 -0
  173. package/src/lib/option-utils/merge-loader-options.ts +25 -0
  174. package/src/lib/path-utils/get-cwd.ts +9 -0
  175. package/src/lib/path-utils/path.ts +138 -4
  176. package/src/types.ts +26 -26
  177. package/dist/es5/lib/binary-utils/binary-copy-utils.js.map +0 -1
  178. package/dist/es5/lib/binary-utils/buffer-utils.js.map +0 -1
  179. package/dist/es5/lib/binary-utils/encode-utils.js +0 -36
  180. package/dist/es5/lib/binary-utils/encode-utils.js.map +0 -1
  181. package/dist/es5/lib/node/util.js +0 -13
  182. package/dist/es5/lib/node/util.js.map +0 -1
  183. package/dist/esm/lib/binary-utils/binary-copy-utils.js.map +0 -1
  184. package/dist/esm/lib/binary-utils/buffer-utils.js +0 -18
  185. package/dist/esm/lib/binary-utils/buffer-utils.js.map +0 -1
  186. package/dist/esm/lib/binary-utils/encode-utils.js +0 -29
  187. package/dist/esm/lib/binary-utils/encode-utils.js.map +0 -1
  188. package/dist/esm/lib/node/util.js +0 -4
  189. package/dist/esm/lib/node/util.js.map +0 -1
  190. package/dist/lib/binary-utils/binary-copy-utils.d.ts +0 -24
  191. package/dist/lib/binary-utils/binary-copy-utils.d.ts.map +0 -1
  192. package/dist/lib/binary-utils/buffer-utils.d.ts.map +0 -1
  193. package/dist/lib/binary-utils/encode-utils.d.ts +0 -4
  194. package/dist/lib/binary-utils/encode-utils.d.ts.map +0 -1
  195. package/dist/lib/binary-utils/encode-utils.js +0 -35
  196. package/dist/lib/node/util.d.ts +0 -5
  197. package/dist/lib/node/util.d.ts.map +0 -1
  198. package/src/lib/binary-utils/buffer-utils.ts +0 -28
  199. package/src/lib/binary-utils/encode-utils.ts +0 -32
  200. package/src/lib/node/util.ts +0 -4
@@ -0,0 +1,30 @@
1
+ // loaders.gl, MIT license
2
+
3
+ export type ReadableFile = {
4
+ read: (position: number, length: number) => Promise<Buffer>;
5
+ close: () => Promise<void>;
6
+ /** Length of file in bytes */
7
+ size: number;
8
+ };
9
+
10
+ /** Helper function to create an envelope reader for a binary memory input */
11
+ export function makeReadableFile(data: Blob | ArrayBuffer): ReadableFile {
12
+ if (data instanceof ArrayBuffer) {
13
+ const arrayBuffer: ArrayBuffer = data;
14
+ return {
15
+ read: async (start: number, length: number) => Buffer.from(data, start, length),
16
+ close: async () => {},
17
+ size: arrayBuffer.byteLength
18
+ };
19
+ }
20
+
21
+ const blob: Blob = data;
22
+ return {
23
+ read: async (start: number, length: number) => {
24
+ const arrayBuffer = await blob.slice(start, start + length).arrayBuffer();
25
+ return Buffer.from(arrayBuffer);
26
+ },
27
+ close: async () => {},
28
+ size: blob.size
29
+ };
30
+ }
@@ -0,0 +1,44 @@
1
+ // Forked from https://github.com/kbajalc/parquets under MIT license (Copyright (c) 2017 ironSource Ltd.)
2
+ import {isBrowser} from '../env-utils/globals';
3
+ import * as fs from '../node/fs';
4
+ import type {Writable} from 'stream';
5
+
6
+ export type WritableFile = {
7
+ write: (buf: Buffer) => Promise<void>;
8
+ close: () => Promise<void>;
9
+ };
10
+
11
+ export interface WriteStreamOptions {
12
+ flags?: string;
13
+ encoding?: 'utf8';
14
+ fd?: number;
15
+ mode?: number;
16
+ autoClose?: boolean;
17
+ start?: number;
18
+ }
19
+
20
+ /** Helper function to create an envelope reader for a binary memory input */
21
+ export function makeWritableFile(
22
+ pathOrStream: string | Writable,
23
+ options?: WriteStreamOptions
24
+ ): WritableFile {
25
+ if (isBrowser) {
26
+ return {
27
+ write: async () => {},
28
+ close: async () => {}
29
+ };
30
+ }
31
+
32
+ const outputStream: Writable =
33
+ typeof pathOrStream === 'string' ? fs.createWriteStream(pathOrStream, options) : pathOrStream;
34
+ return {
35
+ write: async (buffer: Buffer) =>
36
+ new Promise((resolve, reject) => {
37
+ outputStream.write(buffer, (err) => (err ? reject(err) : resolve()));
38
+ }),
39
+ close: () =>
40
+ new Promise((resolve, reject) => {
41
+ (outputStream as any).close((err) => (err ? reject(err) : resolve()));
42
+ })
43
+ };
44
+ }
@@ -0,0 +1,20 @@
1
+ // loaders.gl, MIT license
2
+
3
+ // Isolates Buffer references to ensure they are only bundled under Node.js (avoids big webpack polyfill)
4
+ // this file is selected by the package.json "browser" field).
5
+
6
+ /**
7
+ * Convert Buffer to ArrayBuffer
8
+ * Converts Node.js `Buffer` to `ArrayBuffer` (without triggering bundler to include Buffer polyfill on browser)
9
+ * @todo better data type
10
+ */
11
+ export function toArrayBuffer(buffer) {
12
+ return buffer;
13
+ }
14
+
15
+ /**
16
+ * Convert (copy) ArrayBuffer to Buffer
17
+ */
18
+ export function toBuffer(binaryData: ArrayBuffer | ArrayBuffer | Buffer): Buffer {
19
+ throw new Error('Buffer not supported in browser');
20
+ }
@@ -1,10 +1,12 @@
1
- // Isolates Buffer references to ensure they are only bundled under Node.js (avoids big webpack polyfill)
2
- // this file is not visible to webpack (it is excluded in the package.json "browser" field).
1
+ // loaders.gl, MIT license
3
2
 
4
- import {assert} from '../env-utils/assert';
3
+ // Isolates Buffer references to ensure they are only bundled under Node.js (avoids big webpack polyfill)
4
+ // this file is selected by the package.json "browser" field).
5
5
 
6
6
  /**
7
7
  * Convert Buffer to ArrayBuffer
8
+ * Converts Node.js `Buffer` to `ArrayBuffer` (without triggering bundler to include Buffer polyfill on browser)
9
+ * @todo better data type
8
10
  */
9
11
  export function toArrayBuffer(buffer) {
10
12
  // TODO - per docs we should just be able to call buffer.buffer, but there are issues
@@ -18,19 +20,18 @@ export function toArrayBuffer(buffer) {
18
20
  /**
19
21
  * Convert (copy) ArrayBuffer to Buffer
20
22
  */
21
- export function toBuffer(binaryData) {
23
+ export function toBuffer(binaryData: ArrayBuffer | ArrayBuffer | Buffer): Buffer {
24
+ if (Buffer.isBuffer(binaryData)) {
25
+ return binaryData;
26
+ }
27
+
22
28
  if (ArrayBuffer.isView(binaryData)) {
23
29
  binaryData = binaryData.buffer;
24
30
  }
25
31
 
26
32
  if (typeof Buffer !== 'undefined' && binaryData instanceof ArrayBuffer) {
27
- const buffer = new Buffer(binaryData.byteLength);
28
- const view = new Uint8Array(binaryData);
29
- for (let i = 0; i < buffer.length; ++i) {
30
- buffer[i] = view[i];
31
- }
32
- return buffer;
33
+ return Buffer.from(binaryData);
33
34
  }
34
35
 
35
- return assert(false);
36
+ throw new Error('toBuffer');
36
37
  }
@@ -1,9 +1,9 @@
1
1
  // fs wrapper (promisified fs + avoids bundling fs in browsers)
2
2
  import fs from 'fs';
3
3
  import {toArrayBuffer} from './buffer';
4
- import {promisify} from './util';
4
+ import {promisify2, promisify3} from './promisify';
5
5
 
6
- export type {Stats} from 'fs';
6
+ export type {Stats, WriteStream} from 'fs';
7
7
 
8
8
  export let readdir;
9
9
  /** Wrapper for Node.js fs method */
@@ -23,41 +23,46 @@ export let writeFileSync;
23
23
  /** Wrapper for Node.js fs method */
24
24
  export let open;
25
25
  /** Wrapper for Node.js fs method */
26
- export let close;
26
+ export let close: (fd: number) => Promise<void>;
27
27
  /** Wrapper for Node.js fs method */
28
28
  export let read;
29
29
  /** Wrapper for Node.js fs method */
30
30
  export let fstat;
31
31
 
32
+ export let createWriteStream: typeof fs.createWriteStream;
33
+
32
34
  export let isSupported = Boolean(fs);
33
35
 
34
36
  // paths
35
37
 
36
38
  try {
37
39
  /** Wrapper for Node.js fs method */
38
- readdir = promisify(fs.readdir);
40
+ readdir = promisify2(fs.readdir);
39
41
  /** Wrapper for Node.js fs method */
40
- stat = promisify(fs.stat);
42
+ stat = promisify2(fs.stat);
41
43
 
42
44
  /** Wrapper for Node.js fs method */
43
- readFile = promisify(fs.readFile);
45
+ readFile = fs.readFile;
44
46
  /** Wrapper for Node.js fs method */
45
47
  readFileSync = fs.readFileSync;
46
48
  /** Wrapper for Node.js fs method */
47
- writeFile = promisify(fs.writeFile);
49
+ writeFile = promisify3(fs.writeFile);
48
50
  /** Wrapper for Node.js fs method */
49
51
  writeFileSync = fs.writeFileSync;
50
52
 
51
53
  // file descriptors
52
54
 
53
55
  /** Wrapper for Node.js fs method */
54
- open = promisify(fs.open);
56
+ open = fs.open;
55
57
  /** Wrapper for Node.js fs method */
56
- close = promisify(fs.close);
58
+ close = (fd: number) =>
59
+ new Promise((resolve, reject) => fs.close(fd, (err) => (err ? reject(err) : resolve())));
57
60
  /** Wrapper for Node.js fs method */
58
- read = promisify(fs.read);
61
+ read = fs.read;
59
62
  /** Wrapper for Node.js fs method */
60
- fstat = promisify(fs.fstat);
63
+ fstat = fs.fstat;
64
+
65
+ createWriteStream = fs.createWriteStream;
61
66
 
62
67
  isSupported = Boolean(fs);
63
68
  } catch {
@@ -0,0 +1,70 @@
1
+ // @loaders.gl, MIT license
2
+
3
+ // type Parameter1<T extends (arg1: any, ...args: unknown[]) => unknown> = T extends (
4
+ // arg1: infer P,
5
+ // ...args: unknown[]
6
+ // ) => unknown
7
+ // ? P
8
+ // : never;
9
+
10
+ // type Parameter2<T extends (arg1: unknown, arg2: any, ...args: unknown[]) => unknown> = T extends (
11
+ // arg1: unknown,
12
+ // arg2: infer P,
13
+ // ...args: unknown[]
14
+ // ) => unknown
15
+ // ? P
16
+ // : never;
17
+
18
+ // type CallbackParameter2<
19
+ // T extends (arg: unknown, cb: (error: any, value: any) => void) => unknown
20
+ // > = T extends (arg: unknown, cb: (error: any, value: infer P) => void) => unknown ? P : never;
21
+
22
+ // type CallbackParameter3<
23
+ // T extends (arg: unknown, arg2: unknown, cb: (error: any, value: any) => void) => unknown
24
+ // > = T extends (arg: unknown, arg2: unknown, cb: (error: any, value: infer P) => void) => unknown
25
+ // ? P
26
+ // : never;
27
+
28
+ // /** Extract the parameters of a function type in a tuple */
29
+ // export type Promisified<F extends (arg1, cb: (error: unknown, value: any) => void) => any> = (
30
+ // arg1: Parameter1<F>
31
+ // ) => Promise<CallbackParameter2<F>>;
32
+ // /** Extract the parameters of a function type in a tuple */
33
+ // export type Promisified2<F extends (arg1, arg2, cb: (error: unknown, value: any) => void) => any> = (
34
+ // arg1: Parameter1<F>,
35
+ // arg2: Parameter2<F>
36
+ // ) => Promise<CallbackParameter3<F>>;
37
+
38
+ /** Wrapper for Node.js promisify */
39
+ type Callback<A> = (error: unknown, args: A) => void;
40
+
41
+ /**
42
+ * Typesafe promisify implementation
43
+ * @link https://dev.to/_gdelgado/implement-a-type-safe-version-of-node-s-promisify-in-7-lines-of-code-in-typescript-2j34
44
+ * @param fn
45
+ * @returns
46
+ */
47
+ export function promisify1<T, A>(fn: (args: T, cb: Callback<A>) => void): (args: T) => Promise<A> {
48
+ return (args: T) =>
49
+ new Promise((resolve, reject) =>
50
+ fn(args, (error, callbackArgs) => (error ? reject(error) : resolve(callbackArgs)))
51
+ );
52
+ }
53
+
54
+ export function promisify2<T1, T2, A>(
55
+ fn: (arg1: T1, arg2: T2, cb: Callback<A>) => void
56
+ ): (arg1: T1, arg2: T2) => Promise<A> {
57
+ return (arg1: T1, arg2: T2) =>
58
+ new Promise((resolve, reject) =>
59
+ fn(arg1, arg2, (error, callbackArgs) => (error ? reject(error) : resolve(callbackArgs)))
60
+ );
61
+ }
62
+
63
+ export function promisify3<T1, T2, T3, A>(
64
+ fn: (arg1: T1, arg2: T2, arg3: T3, cb: Callback<A>) => void
65
+ ): (arg1: T1, arg2: T2, arg3: T3) => Promise<A> {
66
+ return (arg1: T1, arg2: T2, arg3: T3) =>
67
+ new Promise((resolve, reject) =>
68
+ fn(arg1, arg2, arg3, (error, callbackArgs) => (error ? reject(error) : resolve(callbackArgs)))
69
+ );
70
+ }
@@ -0,0 +1,18 @@
1
+ // loaders.gl, MIT license
2
+
3
+ import stream from 'stream';
4
+
5
+ export type {Writable} from 'stream';
6
+
7
+ export let Transform;
8
+
9
+ export const isSupported = Boolean(stream);
10
+
11
+ // paths
12
+
13
+ try {
14
+ /** Wrapper for Node.js fs method */
15
+ Transform = stream.Transform;
16
+ } catch {
17
+ // ignore
18
+ }
@@ -0,0 +1,25 @@
1
+ // loaders.gl, MIT license
2
+
3
+ import {LoaderOptions} from '../../types';
4
+
5
+ /**
6
+ *
7
+ * @param baseOptions Can be undefined, in which case a fresh options object will be minted
8
+ * @param newOptions
9
+ * @returns
10
+ */
11
+ export function mergeLoaderOptions<Options extends LoaderOptions>(
12
+ baseOptions: Options | undefined,
13
+ newOptions: Options
14
+ ): Options {
15
+ const options = {...baseOptions};
16
+ for (const [key, newValue] of Object.entries(newOptions)) {
17
+ if (newValue && typeof newValue === 'object') {
18
+ options[key] = options[key] || {};
19
+ Object.assign(options[key] as object, newOptions[key]);
20
+ } else {
21
+ options[key] = newOptions[key];
22
+ }
23
+ }
24
+ return options as Options;
25
+ }
@@ -0,0 +1,9 @@
1
+ // loaders.gl MIT license
2
+
3
+ export function getCWD() {
4
+ if (typeof process !== 'undefined' && typeof process.cwd !== 'undefined') {
5
+ return process.cwd();
6
+ }
7
+ const pathname = window.location?.pathname;
8
+ return pathname?.slice(0, pathname.lastIndexOf('/') + 1) || '';
9
+ }
@@ -1,12 +1,14 @@
1
1
  // Beginning of a minimal implementation of the Node.js path API, that doesn't pull in big polyfills.
2
2
 
3
+ import {getCWD} from './get-cwd';
4
+
3
5
  /**
4
6
  * Replacement for Node.js path.filename
5
7
  * @param url
6
8
  */
7
9
  export function filename(url: string): string {
8
- const slashIndex = url && url.lastIndexOf('/');
9
- return slashIndex >= 0 ? url.substr((slashIndex as number) + 1) : '';
10
+ const slashIndex = url ? url.lastIndexOf('/') : -1;
11
+ return slashIndex >= 0 ? url.substr(slashIndex + 1) : '';
10
12
  }
11
13
 
12
14
  /**
@@ -14,8 +16,8 @@ export function filename(url: string): string {
14
16
  * @param url
15
17
  */
16
18
  export function dirname(url: string): string {
17
- const slashIndex = url && url.lastIndexOf('/');
18
- return slashIndex >= 0 ? url.substr(0, slashIndex as number) : '';
19
+ const slashIndex = url ? url.lastIndexOf('/') : -1;
20
+ return slashIndex >= 0 ? url.substr(0, slashIndex) : '';
19
21
  }
20
22
 
21
23
  /**
@@ -35,3 +37,135 @@ export function join(...parts: string[]): string {
35
37
  });
36
38
  return parts.join(separator);
37
39
  }
40
+
41
+ /* eslint-disable no-continue */
42
+
43
+ /**
44
+ * https://nodejs.org/api/path.html#path_path_resolve_paths
45
+ * @param paths A sequence of paths or path segments.
46
+ * @return resolved path
47
+ * Forked from BTOdell/path-resolve under MIT license
48
+ * @see https://github.com/BTOdell/path-resolve/blob/master/LICENSE
49
+ */
50
+ export function resolve(...components: string[]): string {
51
+ const paths: string[] = [];
52
+ for (let _i = 0; _i < components.length; _i++) {
53
+ paths[_i] = components[_i];
54
+ }
55
+ let resolvedPath = '';
56
+ let resolvedAbsolute = false;
57
+ let cwd: string | undefined;
58
+ for (let i = paths.length - 1; i >= -1 && !resolvedAbsolute; i--) {
59
+ let path: string | undefined;
60
+ if (i >= 0) {
61
+ path = paths[i];
62
+ } else {
63
+ if (cwd === undefined) {
64
+ cwd = getCWD();
65
+ }
66
+ path = cwd;
67
+ }
68
+ // Skip empty entries
69
+ if (path.length === 0) {
70
+ continue;
71
+ }
72
+ resolvedPath = `${path}/${resolvedPath}`;
73
+ resolvedAbsolute = path.charCodeAt(0) === SLASH;
74
+ }
75
+ // At this point the path should be resolved to a full absolute path, but
76
+ // handle relative paths to be safe (might happen when process.cwd() fails)
77
+ // Normalize the path (removes leading slash)
78
+ resolvedPath = normalizeStringPosix(resolvedPath, !resolvedAbsolute);
79
+ if (resolvedAbsolute) {
80
+ return `/${resolvedPath}`;
81
+ } else if (resolvedPath.length > 0) {
82
+ return resolvedPath;
83
+ }
84
+ return '.';
85
+ }
86
+
87
+ const SLASH = 47;
88
+ const DOT = 46;
89
+
90
+ /**
91
+ * Resolves . and .. elements in a path with directory names
92
+ * Forked from BTOdell/path-resolve under MIT license
93
+ * @see https://github.com/BTOdell/path-resolve/blob/master/LICENSE
94
+ */
95
+ /* eslint-disable max-depth */
96
+ // eslint-disable-next-line complexity, max-statements
97
+ function normalizeStringPosix(path: string, allowAboveRoot: boolean): string {
98
+ let res = '';
99
+ let lastSlash = -1;
100
+ let dots = 0;
101
+ let code: number | undefined;
102
+ let isAboveRoot = false;
103
+
104
+ for (let i = 0; i <= path.length; ++i) {
105
+ if (i < path.length) {
106
+ code = path.charCodeAt(i);
107
+ } else if (code === SLASH) {
108
+ break;
109
+ } else {
110
+ code = SLASH;
111
+ }
112
+ if (code === SLASH) {
113
+ if (lastSlash === i - 1 || dots === 1) {
114
+ // NOOP
115
+ } else if (lastSlash !== i - 1 && dots === 2) {
116
+ if (
117
+ res.length < 2 ||
118
+ !isAboveRoot ||
119
+ res.charCodeAt(res.length - 1) !== DOT ||
120
+ res.charCodeAt(res.length - 2) !== DOT
121
+ ) {
122
+ if (res.length > 2) {
123
+ const start = res.length - 1;
124
+ let j = start;
125
+ for (; j >= 0; --j) {
126
+ if (res.charCodeAt(j) === SLASH) {
127
+ break;
128
+ }
129
+ }
130
+ if (j !== start) {
131
+ res = j === -1 ? '' : res.slice(0, j);
132
+ lastSlash = i;
133
+ dots = 0;
134
+ isAboveRoot = false;
135
+ continue;
136
+ }
137
+ } else if (res.length === 2 || res.length === 1) {
138
+ res = '';
139
+ lastSlash = i;
140
+ dots = 0;
141
+ isAboveRoot = false;
142
+ continue;
143
+ }
144
+ }
145
+ if (allowAboveRoot) {
146
+ if (res.length > 0) {
147
+ res += '/..';
148
+ } else {
149
+ res = '..';
150
+ }
151
+ isAboveRoot = true;
152
+ }
153
+ } else {
154
+ const slice = path.slice(lastSlash + 1, i);
155
+ if (res.length > 0) {
156
+ res += `/${slice}`;
157
+ } else {
158
+ res = slice;
159
+ }
160
+ isAboveRoot = false;
161
+ }
162
+ lastSlash = i;
163
+ dots = 0;
164
+ } else if (code === DOT && dots !== -1) {
165
+ ++dots;
166
+ } else {
167
+ dots = -1;
168
+ }
169
+ }
170
+ return res;
171
+ }
package/src/types.ts CHANGED
@@ -57,7 +57,7 @@ export type LoaderOptions = {
57
57
  // workers
58
58
 
59
59
  /** CDN load workers from */
60
- CDN?: string;
60
+ CDN?: string | null;
61
61
  /** Set to `false` to disable workers */
62
62
  worker?: boolean;
63
63
  /** Number of concurrent workers (per loader) on desktop browser */
@@ -76,40 +76,40 @@ export type LoaderOptions = {
76
76
  /** @deprecated `options.throw removed`, Use `options.nothrow` instead */
77
77
  throws?: boolean;
78
78
  /** @deprecated `options.dataType` no longer used */
79
- dataType?: any;
79
+ dataType?: never;
80
80
  /** @deprecated `options.uri` no longer used */
81
- uri?: any;
81
+ uri?: never;
82
82
  /** @deprecated `options.method` removed. Use `options.fetch.method` */
83
- method?: any;
83
+ method?: never;
84
84
  /** @deprecated `options.headers` removed. Use `options.fetch.headers` */
85
- headers?: any;
85
+ headers?: never;
86
86
  /** @deprecated `options.body` removed. Use `options.fetch.body` */
87
- body?: any;
87
+ body?: never;
88
88
  /** @deprecated `options.mode` removed. Use `options.fetch.mode` */
89
- mode?: any;
89
+ mode?: never;
90
90
  /** @deprecated `options.credentials` removed. Use `options.fetch.credentials` */
91
- credentials?: any;
91
+ credentials?: never;
92
92
  /** @deprecated `options.cache` removed. Use `options.fetch.cache` */
93
- cache?: any;
93
+ cache?: never;
94
94
  /** @deprecated `options.redirect` removed. Use `options.fetch.redirect` */
95
- redirect?: any;
95
+ redirect?: never;
96
96
  /** @deprecated `options.referrer` removed. Use `options.fetch.referrer` */
97
- referrer?: any;
97
+ referrer?: never;
98
98
  /** @deprecated `options.referrerPolicy` removed. Use `options.fetch.referrerPolicy` */
99
- referrerPolicy?: any;
99
+ referrerPolicy?: never;
100
100
  /** @deprecated `options.integrity` removed. Use `options.fetch.integrity` */
101
- integrity?: any;
101
+ integrity?: never;
102
102
  /** @deprecated `options.keepalive` removed. Use `options.fetch.keepalive` */
103
- keepalive?: any;
103
+ keepalive?: never;
104
104
  /** @deprecated `options.signal` removed. Use `options.fetch.signal` */
105
- signal?: any;
105
+ signal?: never;
106
106
 
107
107
  // Accept other keys (loader options objects, e.g. `options.csv`, `options.json` ...)
108
- [loaderId: string]: any;
108
+ [loaderId: string]: unknown;
109
109
  };
110
110
 
111
111
  type PreloadOptions = {
112
- [key: string]: any;
112
+ [key: string]: unknown;
113
113
  };
114
114
 
115
115
  /**
@@ -122,7 +122,7 @@ export type Loader = {
122
122
  module: string;
123
123
  version: string;
124
124
  worker?: string | boolean;
125
- options: object;
125
+ options: LoaderOptions;
126
126
  deprecatedOptions?: object;
127
127
  // end Worker
128
128
 
@@ -133,11 +133,11 @@ export type Loader = {
133
133
  binary?: boolean;
134
134
  text?: boolean;
135
135
 
136
- tests?: (((ArrayBuffer) => boolean) | ArrayBuffer | string)[];
136
+ tests?: (((ArrayBuffer: ArrayBuffer) => boolean) | ArrayBuffer | string)[];
137
137
 
138
138
  // TODO - deprecated
139
139
  supported?: boolean;
140
- testText?: (string) => boolean;
140
+ testText?: (string: string) => boolean;
141
141
  };
142
142
 
143
143
  /**
@@ -146,7 +146,7 @@ export type Loader = {
146
146
  */
147
147
  export type LoaderWithParser = Loader & {
148
148
  // TODO - deprecated
149
- testText?: (string) => boolean;
149
+ testText?: (string: string) => boolean;
150
150
 
151
151
  parse: Parse;
152
152
  preload?: Preload;
@@ -196,23 +196,23 @@ export type LoaderContext = {
196
196
  loaders?: Loader[] | null;
197
197
  url?: string;
198
198
 
199
- fetch: typeof fetch;
199
+ fetch: typeof fetch | FetchLike;
200
200
  response?: Response;
201
201
  parse: (
202
202
  arrayBuffer: ArrayBuffer,
203
- loaders?,
203
+ loaders?: Loader | Loader[] | LoaderOptions,
204
204
  options?: LoaderOptions,
205
205
  context?: LoaderContext
206
206
  ) => Promise<any>;
207
207
  parseSync?: (
208
208
  arrayBuffer: ArrayBuffer,
209
- loaders?,
209
+ loaders?: Loader | Loader[] | LoaderOptions,
210
210
  options?: LoaderOptions,
211
211
  context?: LoaderContext
212
212
  ) => any;
213
213
  parseInBatches?: (
214
214
  iterator: AsyncIterable<ArrayBuffer> | Iterable<ArrayBuffer>,
215
- loaders?,
215
+ loaders?: Loader | Loader[] | LoaderOptions,
216
216
  options?: LoaderOptions,
217
217
  context?: LoaderContext
218
218
  ) => AsyncIterable<any> | Promise<AsyncIterable<any>>;
@@ -306,7 +306,7 @@ export interface IFileSystem {
306
306
 
307
307
  type ReadOptions = {buffer?: ArrayBuffer; offset?: number; length?: number; position?: number};
308
308
  export interface IRandomAccessReadFileSystem extends IFileSystem {
309
- open(path: string, flags, mode?): Promise<any>;
309
+ open(path: string, flags: string | number, mode?: any): Promise<any>;
310
310
  close(fd: any): Promise<void>;
311
311
  fstat(fd: any): Promise<object>;
312
312
  read(fd: any, options?: ReadOptions): Promise<{bytesRead: number; buffer: Buffer}>;
@@ -1 +0,0 @@
1
- {"version":3,"file":"binary-copy-utils.js","names":["copyPaddedArrayBufferToDataView","dataView","byteOffset","sourceBuffer","padding","paddedLength","padToNBytes","byteLength","padLength","targetArray","Uint8Array","buffer","sourceArray","set","i","setUint8","copyPaddedStringToDataView","string","textEncoder","TextEncoder","stringBuffer","encode"],"sources":["../../../../src/lib/binary-utils/binary-copy-utils.ts"],"sourcesContent":["import {TypedArray} from '../../types';\nimport {padToNBytes} from './memory-copy-utils';\n\n/**\n * Copy sourceBuffer to dataView with some padding\n *\n * @param {DataView | null} dataView - destination data container. If null - only new offset is calculated\n * @param {number} byteOffset - destination byte offset to copy to\n * @param {Array | TypedArray} sourceBuffer - source data buffer\n * @param {number} padding - pad the resulting array to multiple of \"padding\" bytes. Additional bytes are filled with 0x20 (ASCII space)\n *\n * @return new byteOffset of resulting dataView\n */\nexport function copyPaddedArrayBufferToDataView(\n dataView: DataView | null,\n byteOffset: number,\n sourceBuffer: TypedArray,\n padding: number\n) {\n const paddedLength = padToNBytes(sourceBuffer.byteLength, padding);\n const padLength = paddedLength - sourceBuffer.byteLength;\n\n if (dataView) {\n // Copy array\n const targetArray = new Uint8Array(\n dataView.buffer,\n dataView.byteOffset + byteOffset,\n sourceBuffer.byteLength\n );\n const sourceArray = new Uint8Array(sourceBuffer);\n targetArray.set(sourceArray);\n\n // Add PADDING\n for (let i = 0; i < padLength; ++i) {\n // json chunk is padded with spaces (ASCII 0x20)\n dataView.setUint8(byteOffset + sourceBuffer.byteLength + i, 0x20);\n }\n }\n byteOffset += paddedLength;\n return byteOffset;\n}\n\n/**\n * Copy string to dataView with some padding\n *\n * @param {DataView | null} dataView - destination data container. If null - only new offset is calculated\n * @param {number} byteOffset - destination byte offset to copy to\n * @param {string} string - source string\n * @param {number} padding - pad the resulting array to multiple of \"padding\" bytes. Additional bytes are filled with 0x20 (ASCII space)\n *\n * @return new byteOffset of resulting dataView\n */\nexport function copyPaddedStringToDataView(\n dataView: DataView | null,\n byteOffset: number,\n string: string,\n padding: number\n): number {\n const textEncoder = new TextEncoder();\n // PERFORMANCE IDEA: We encode twice, once to get size and once to store\n // PERFORMANCE IDEA: Use TextEncoder.encodeInto() to avoid temporary copy\n const stringBuffer = textEncoder.encode(string);\n\n byteOffset = copyPaddedArrayBufferToDataView(dataView, byteOffset, stringBuffer, padding);\n\n return byteOffset;\n}\n"],"mappings":";;;;;;;AACA;AAYO,SAASA,+BAA+B,CAC7CC,QAAyB,EACzBC,UAAkB,EAClBC,YAAwB,EACxBC,OAAe,EACf;EACA,IAAMC,YAAY,GAAG,IAAAC,4BAAW,EAACH,YAAY,CAACI,UAAU,EAAEH,OAAO,CAAC;EAClE,IAAMI,SAAS,GAAGH,YAAY,GAAGF,YAAY,CAACI,UAAU;EAExD,IAAIN,QAAQ,EAAE;IAEZ,IAAMQ,WAAW,GAAG,IAAIC,UAAU,CAChCT,QAAQ,CAACU,MAAM,EACfV,QAAQ,CAACC,UAAU,GAAGA,UAAU,EAChCC,YAAY,CAACI,UAAU,CACxB;IACD,IAAMK,WAAW,GAAG,IAAIF,UAAU,CAACP,YAAY,CAAC;IAChDM,WAAW,CAACI,GAAG,CAACD,WAAW,CAAC;;IAG5B,KAAK,IAAIE,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGN,SAAS,EAAE,EAAEM,CAAC,EAAE;MAElCb,QAAQ,CAACc,QAAQ,CAACb,UAAU,GAAGC,YAAY,CAACI,UAAU,GAAGO,CAAC,EAAE,IAAI,CAAC;IACnE;EACF;EACAZ,UAAU,IAAIG,YAAY;EAC1B,OAAOH,UAAU;AACnB;;AAYO,SAASc,0BAA0B,CACxCf,QAAyB,EACzBC,UAAkB,EAClBe,MAAc,EACdb,OAAe,EACP;EACR,IAAMc,WAAW,GAAG,IAAIC,WAAW,EAAE;EAGrC,IAAMC,YAAY,GAAGF,WAAW,CAACG,MAAM,CAACJ,MAAM,CAAC;EAE/Cf,UAAU,GAAGF,+BAA+B,CAACC,QAAQ,EAAEC,UAAU,EAAEkB,YAAY,EAAEhB,OAAO,CAAC;EAEzF,OAAOF,UAAU;AACnB"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"buffer-utils.js","names":["isBuffer","value","toBuffer","data","node","bufferToArrayBuffer","buffer","typedArray","Uint8Array","byteOffset","length","slice"],"sources":["../../../../src/lib/binary-utils/buffer-utils.ts"],"sourcesContent":["import * as node from '../node/buffer';\n\n/**\n * Check for Node.js `Buffer` (without triggering bundler to include Buffer polyfill on browser)\n */\nexport function isBuffer(value: any): boolean {\n return value && typeof value === 'object' && value.isBuffer;\n}\n\n/**\n * Converts to Node.js `Buffer` (without triggering bundler to include Buffer polyfill on browser)\n * @todo better data type\n */\nexport function toBuffer(data: any): Buffer {\n return node.toBuffer ? node.toBuffer(data) : data;\n}\n\n/**\n * Converts Node.js `Buffer` to `ArrayBuffer` (without triggering bundler to include Buffer polyfill on browser)\n * @todo better data type\n */\nexport function bufferToArrayBuffer(buffer: any): ArrayBuffer {\n if (isBuffer(buffer)) {\n const typedArray = new Uint8Array(buffer.buffer, buffer.byteOffset, buffer.length);\n return typedArray.slice().buffer;\n }\n return buffer;\n}\n"],"mappings":";;;;;;;;;;;AAAA;AAAuC;AAAA;AAKhC,SAASA,QAAQ,CAACC,KAAU,EAAW;EAC5C,OAAOA,KAAK,IAAI,sBAAOA,KAAK,MAAK,QAAQ,IAAIA,KAAK,CAACD,QAAQ;AAC7D;;AAMO,SAASE,QAAQ,CAACC,IAAS,EAAU;EAC1C,OAAOC,IAAI,CAACF,QAAQ,GAAGE,IAAI,CAACF,QAAQ,CAACC,IAAI,CAAC,GAAGA,IAAI;AACnD;;AAMO,SAASE,mBAAmB,CAACC,MAAW,EAAe;EAC5D,IAAIN,QAAQ,CAACM,MAAM,CAAC,EAAE;IACpB,IAAMC,UAAU,GAAG,IAAIC,UAAU,CAACF,MAAM,CAACA,MAAM,EAAEA,MAAM,CAACG,UAAU,EAAEH,MAAM,CAACI,MAAM,CAAC;IAClF,OAAOH,UAAU,CAACI,KAAK,EAAE,CAACL,MAAM;EAClC;EACA,OAAOA,MAAM;AACf"}