@loaders.gl/loader-utils 3.3.0-alpha.9 → 3.3.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 (118) hide show
  1. package/dist/es5/index.js +36 -22
  2. package/dist/es5/index.js.map +1 -1
  3. package/dist/es5/json-loader.js +1 -1
  4. package/dist/es5/json-loader.js.map +1 -1
  5. package/dist/es5/lib/binary-utils/array-buffer-utils.js +0 -30
  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} +33 -1
  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 +2 -0
  10. package/dist/es5/lib/binary-utils/get-first-characters.js.map +1 -1
  11. package/dist/es5/lib/binary-utils/{buffer-utils.js → memory-conversion-utils.js} +26 -7
  12. package/dist/es5/lib/binary-utils/memory-conversion-utils.js.map +1 -0
  13. package/dist/es5/lib/filesystems/readable-file.js +100 -0
  14. package/dist/es5/lib/filesystems/readable-file.js.map +1 -0
  15. package/dist/es5/lib/filesystems/writable-file.js +89 -0
  16. package/dist/es5/lib/filesystems/writable-file.js.map +1 -0
  17. package/dist/es5/lib/loader-utils/buffer-utils.js +19 -0
  18. package/dist/es5/lib/loader-utils/buffer-utils.js.map +1 -0
  19. package/dist/es5/lib/node/buffer.js +5 -8
  20. package/dist/es5/lib/node/buffer.js.map +1 -1
  21. package/dist/es5/lib/node/fs.js +18 -9
  22. package/dist/es5/lib/node/fs.js.map +1 -1
  23. package/dist/es5/lib/node/stream.js +20 -0
  24. package/dist/es5/lib/node/stream.js.map +1 -0
  25. package/dist/es5/lib/node/util.js +31 -7
  26. package/dist/es5/lib/node/util.js.map +1 -1
  27. package/dist/esm/index.js +11 -9
  28. package/dist/esm/index.js.map +1 -1
  29. package/dist/esm/json-loader.js +1 -1
  30. package/dist/esm/json-loader.js.map +1 -1
  31. package/dist/esm/lib/binary-utils/array-buffer-utils.js +0 -27
  32. package/dist/esm/lib/binary-utils/array-buffer-utils.js.map +1 -1
  33. package/dist/esm/lib/binary-utils/{binary-copy-utils.js → dataview-copy-utils.js} +31 -1
  34. package/dist/esm/lib/binary-utils/dataview-copy-utils.js.map +1 -0
  35. package/dist/esm/lib/binary-utils/get-first-characters.js +3 -0
  36. package/dist/esm/lib/binary-utils/get-first-characters.js.map +1 -1
  37. package/dist/esm/lib/binary-utils/memory-conversion-utils.js +38 -0
  38. package/dist/esm/lib/binary-utils/memory-conversion-utils.js.map +1 -0
  39. package/dist/esm/lib/filesystems/readable-file.js +22 -0
  40. package/dist/esm/lib/filesystems/readable-file.js.map +1 -0
  41. package/dist/esm/lib/filesystems/writable-file.js +21 -0
  42. package/dist/esm/lib/filesystems/writable-file.js.map +1 -0
  43. package/dist/esm/lib/loader-utils/buffer-utils.js +13 -0
  44. package/dist/esm/lib/loader-utils/buffer-utils.js.map +1 -0
  45. package/dist/esm/lib/node/buffer.js +5 -9
  46. package/dist/esm/lib/node/buffer.js.map +1 -1
  47. package/dist/esm/lib/node/fs.js +11 -9
  48. package/dist/esm/lib/node/fs.js.map +1 -1
  49. package/dist/esm/lib/node/stream.js +11 -0
  50. package/dist/esm/lib/node/stream.js.map +1 -0
  51. package/dist/esm/lib/node/util.js +10 -2
  52. package/dist/esm/lib/node/util.js.map +1 -1
  53. package/dist/index.d.ts +10 -7
  54. package/dist/index.d.ts.map +1 -1
  55. package/dist/index.js +25 -23
  56. package/dist/lib/binary-utils/array-buffer-utils.d.ts +4 -8
  57. package/dist/lib/binary-utils/array-buffer-utils.d.ts.map +1 -1
  58. package/dist/lib/binary-utils/array-buffer-utils.js +5 -36
  59. package/dist/lib/binary-utils/dataview-copy-utils.d.ts +43 -0
  60. package/dist/lib/binary-utils/dataview-copy-utils.d.ts.map +1 -0
  61. package/dist/lib/binary-utils/{binary-copy-utils.js → dataview-copy-utils.js} +51 -5
  62. package/dist/lib/binary-utils/get-first-characters.d.ts +15 -1
  63. package/dist/lib/binary-utils/get-first-characters.d.ts.map +1 -1
  64. package/dist/lib/binary-utils/get-first-characters.js +15 -0
  65. package/dist/lib/binary-utils/{buffer-utils.d.ts → memory-conversion-utils.d.ts} +3 -4
  66. package/dist/lib/binary-utils/memory-conversion-utils.d.ts.map +1 -0
  67. package/dist/lib/binary-utils/{buffer-utils.js → memory-conversion-utils.js} +28 -9
  68. package/dist/lib/filesystems/readable-file.d.ts +10 -0
  69. package/dist/lib/filesystems/readable-file.d.ts.map +1 -0
  70. package/dist/lib/filesystems/readable-file.js +25 -0
  71. package/dist/lib/filesystems/writable-file.d.ts +18 -0
  72. package/dist/lib/filesystems/writable-file.d.ts.map +1 -0
  73. package/dist/lib/filesystems/writable-file.js +48 -0
  74. package/dist/lib/loader-utils/buffer-utils.d.ts +10 -0
  75. package/dist/lib/loader-utils/buffer-utils.d.ts.map +1 -0
  76. package/dist/lib/loader-utils/buffer-utils.js +22 -0
  77. package/dist/lib/node/buffer.d.ts +3 -1
  78. package/dist/lib/node/buffer.d.ts.map +1 -1
  79. package/dist/lib/node/buffer.js +7 -8
  80. package/dist/lib/node/fs.d.ts +4 -2
  81. package/dist/lib/node/fs.d.ts.map +1 -1
  82. package/dist/lib/node/fs.js +10 -9
  83. package/dist/lib/node/stream.d.ts +4 -0
  84. package/dist/lib/node/stream.d.ts.map +1 -0
  85. package/dist/lib/node/stream.js +17 -0
  86. package/dist/lib/node/util.d.ts +11 -3
  87. package/dist/lib/node/util.d.ts.map +1 -1
  88. package/dist/lib/node/util.js +20 -27
  89. package/package.json +5 -4
  90. package/src/index.ts +22 -18
  91. package/src/lib/binary-utils/array-buffer-utils.ts +4 -40
  92. package/src/lib/binary-utils/{binary-copy-utils.ts → dataview-copy-utils.ts} +57 -5
  93. package/src/lib/binary-utils/get-first-characters.ts +17 -1
  94. package/src/lib/binary-utils/memory-conversion-utils.ts +53 -0
  95. package/src/lib/filesystems/readable-file.ts +30 -0
  96. package/src/lib/filesystems/writable-file.ts +44 -0
  97. package/src/lib/loader-utils/buffer-utils.ts +18 -0
  98. package/src/lib/node/buffer.ts +9 -10
  99. package/src/lib/node/fs.ts +16 -11
  100. package/src/lib/node/stream.ts +18 -0
  101. package/src/lib/node/util.ts +68 -2
  102. package/dist/es5/lib/binary-utils/binary-copy-utils.js.map +0 -1
  103. package/dist/es5/lib/binary-utils/buffer-utils.js.map +0 -1
  104. package/dist/es5/lib/binary-utils/encode-utils.js +0 -36
  105. package/dist/es5/lib/binary-utils/encode-utils.js.map +0 -1
  106. package/dist/esm/lib/binary-utils/binary-copy-utils.js.map +0 -1
  107. package/dist/esm/lib/binary-utils/buffer-utils.js +0 -18
  108. package/dist/esm/lib/binary-utils/buffer-utils.js.map +0 -1
  109. package/dist/esm/lib/binary-utils/encode-utils.js +0 -29
  110. package/dist/esm/lib/binary-utils/encode-utils.js.map +0 -1
  111. package/dist/lib/binary-utils/binary-copy-utils.d.ts +0 -24
  112. package/dist/lib/binary-utils/binary-copy-utils.d.ts.map +0 -1
  113. package/dist/lib/binary-utils/buffer-utils.d.ts.map +0 -1
  114. package/dist/lib/binary-utils/encode-utils.d.ts +0 -4
  115. package/dist/lib/binary-utils/encode-utils.d.ts.map +0 -1
  116. package/dist/lib/binary-utils/encode-utils.js +0 -35
  117. package/src/lib/binary-utils/buffer-utils.ts +0 -28
  118. package/src/lib/binary-utils/encode-utils.ts +0 -32
@@ -1,14 +1,60 @@
1
1
  "use strict";
2
+ // loaders./gl, MIT license
2
3
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.copyPaddedStringToDataView = exports.copyPaddedArrayBufferToDataView = void 0;
4
+ exports.copyPaddedStringToDataView = exports.copyPaddedArrayBufferToDataView = exports.copyBinaryToDataView = exports.copyStringToDataView = exports.padStringToByteAlignment = void 0;
4
5
  const memory_copy_utils_1 = require("./memory-copy-utils");
6
+ /**
7
+ * Helper function that pads a string with spaces to fit a certain byte alignment
8
+ * @param string
9
+ * @param byteAlignment
10
+ * @returns
11
+ *
12
+ * @todo PERFORMANCE IDEA: No need to copy string twice...
13
+ */
14
+ function padStringToByteAlignment(string, byteAlignment) {
15
+ const length = string.length;
16
+ const paddedLength = Math.ceil(length / byteAlignment) * byteAlignment; // Round up to the required alignment
17
+ const padding = paddedLength - length;
18
+ let whitespace = '';
19
+ for (let i = 0; i < padding; ++i) {
20
+ whitespace += ' ';
21
+ }
22
+ return string + whitespace;
23
+ }
24
+ exports.padStringToByteAlignment = padStringToByteAlignment;
25
+ /**
26
+ *
27
+ * @param dataView
28
+ * @param byteOffset
29
+ * @param string
30
+ * @param byteLength
31
+ * @returns
32
+ */
33
+ function copyStringToDataView(dataView, byteOffset, string, byteLength) {
34
+ if (dataView) {
35
+ for (let i = 0; i < byteLength; i++) {
36
+ dataView.setUint8(byteOffset + i, string.charCodeAt(i));
37
+ }
38
+ }
39
+ return byteOffset + byteLength;
40
+ }
41
+ exports.copyStringToDataView = copyStringToDataView;
42
+ function copyBinaryToDataView(dataView, byteOffset, binary, byteLength) {
43
+ if (dataView) {
44
+ for (let i = 0; i < byteLength; i++) {
45
+ dataView.setUint8(byteOffset + i, binary[i]);
46
+ }
47
+ }
48
+ return byteOffset + byteLength;
49
+ }
50
+ exports.copyBinaryToDataView = copyBinaryToDataView;
5
51
  /**
6
52
  * Copy sourceBuffer to dataView with some padding
7
53
  *
8
- * @param {DataView | null} dataView - destination data container. If null - only new offset is calculated
9
- * @param {number} byteOffset - destination byte offset to copy to
10
- * @param {Array | TypedArray} sourceBuffer - source data buffer
11
- * @param {number} padding - pad the resulting array to multiple of "padding" bytes. Additional bytes are filled with 0x20 (ASCII space)
54
+ * @param dataView - destination data container. If null - only new offset is calculated
55
+ * @param byteOffset - destination byte offset to copy to
56
+ * @param sourceBuffer - source data buffer
57
+ * @param padding - pad the resulting array to multiple of "padding" bytes. Additional bytes are filled with 0x20 (ASCII space)
12
58
  *
13
59
  * @return new byteOffset of resulting dataView
14
60
  */
@@ -1,3 +1,17 @@
1
- export declare function getFirstCharacters(data: any, length?: number): string;
1
+ /**
2
+ * Get the first characters from a binary file (interpret the first bytes as an ASCII string)
3
+ * @param data
4
+ * @param length
5
+ * @returns
6
+ */
7
+ export declare function getFirstCharacters(data: string | ArrayBuffer, length?: number): string;
8
+ /**
9
+ * Gets a magic string from a "file"
10
+ * Typically used to check or detect file format
11
+ * @param arrayBuffer
12
+ * @param byteOffset
13
+ * @param length
14
+ * @returns
15
+ */
2
16
  export declare function getMagicString(arrayBuffer: ArrayBuffer, byteOffset: number, length: number): string;
3
17
  //# sourceMappingURL=get-first-characters.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"get-first-characters.d.ts","sourceRoot":"","sources":["../../../src/lib/binary-utils/get-first-characters.ts"],"names":[],"mappings":"AAAA,wBAAgB,kBAAkB,CAAC,IAAI,KAAA,EAAE,MAAM,SAAI,GAAG,MAAM,CAW3D;AAED,wBAAgB,cAAc,CAC5B,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,GACb,MAAM,CAUR"}
1
+ {"version":3,"file":"get-first-characters.d.ts","sourceRoot":"","sources":["../../../src/lib/binary-utils/get-first-characters.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,EAAE,MAAM,GAAE,MAAU,GAAG,MAAM,CAWzF;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,GACb,MAAM,CAUR"}
@@ -1,6 +1,13 @@
1
1
  "use strict";
2
+ // loaders.gl, MIT license
2
3
  Object.defineProperty(exports, "__esModule", { value: true });
3
4
  exports.getMagicString = exports.getFirstCharacters = void 0;
5
+ /**
6
+ * Get the first characters from a binary file (interpret the first bytes as an ASCII string)
7
+ * @param data
8
+ * @param length
9
+ * @returns
10
+ */
4
11
  function getFirstCharacters(data, length = 5) {
5
12
  if (typeof data === 'string') {
6
13
  return data.slice(0, length);
@@ -16,6 +23,14 @@ function getFirstCharacters(data, length = 5) {
16
23
  return '';
17
24
  }
18
25
  exports.getFirstCharacters = getFirstCharacters;
26
+ /**
27
+ * Gets a magic string from a "file"
28
+ * Typically used to check or detect file format
29
+ * @param arrayBuffer
30
+ * @param byteOffset
31
+ * @param length
32
+ * @returns
33
+ */
19
34
  function getMagicString(arrayBuffer, byteOffset, length) {
20
35
  if (arrayBuffer.byteLength <= byteOffset + length) {
21
36
  return '';
@@ -9,8 +9,7 @@ export declare function isBuffer(value: any): boolean;
9
9
  */
10
10
  export declare function toBuffer(data: any): Buffer;
11
11
  /**
12
- * Converts Node.js `Buffer` to `ArrayBuffer` (without triggering bundler to include Buffer polyfill on browser)
13
- * @todo better data type
12
+ * Convert an object to an array buffer
14
13
  */
15
- export declare function bufferToArrayBuffer(buffer: any): ArrayBuffer;
16
- //# sourceMappingURL=buffer-utils.d.ts.map
14
+ export declare function toArrayBuffer(data: unknown): ArrayBuffer;
15
+ //# sourceMappingURL=memory-conversion-utils.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"memory-conversion-utils.d.ts","sourceRoot":"","sources":["../../../src/lib/binary-utils/memory-conversion-utils.ts"],"names":[],"mappings":";AAIA;;GAEG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAE5C;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,GAAG,GAAG,MAAM,CAE1C;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,OAAO,GAAG,WAAW,CA8BxD"}
@@ -1,4 +1,5 @@
1
1
  "use strict";
2
+ // loaders.gl, MIT license
2
3
  var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
4
  if (k2 === undefined) k2 = k;
4
5
  var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -23,7 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
23
24
  return result;
24
25
  };
25
26
  Object.defineProperty(exports, "__esModule", { value: true });
26
- exports.bufferToArrayBuffer = exports.toBuffer = exports.isBuffer = void 0;
27
+ exports.toArrayBuffer = exports.toBuffer = exports.isBuffer = void 0;
27
28
  const node = __importStar(require("../node/buffer"));
28
29
  /**
29
30
  * Check for Node.js `Buffer` (without triggering bundler to include Buffer polyfill on browser)
@@ -41,14 +42,32 @@ function toBuffer(data) {
41
42
  }
42
43
  exports.toBuffer = toBuffer;
43
44
  /**
44
- * Converts Node.js `Buffer` to `ArrayBuffer` (without triggering bundler to include Buffer polyfill on browser)
45
- * @todo better data type
45
+ * Convert an object to an array buffer
46
46
  */
47
- function bufferToArrayBuffer(buffer) {
48
- if (isBuffer(buffer)) {
49
- const typedArray = new Uint8Array(buffer.buffer, buffer.byteOffset, buffer.length);
50
- return typedArray.slice().buffer;
47
+ function toArrayBuffer(data) {
48
+ // Note: Should be called first, Buffers can trigger other detections below
49
+ if (isBuffer(data)) {
50
+ return node.toArrayBuffer(data);
51
+ }
52
+ if (data instanceof ArrayBuffer) {
53
+ return data;
54
+ }
55
+ // Careful - Node Buffers look like Uint8Arrays (keep after isBuffer)
56
+ if (ArrayBuffer.isView(data)) {
57
+ if (data.byteOffset === 0 && data.byteLength === data.buffer.byteLength) {
58
+ return data.buffer;
59
+ }
60
+ return data.buffer.slice(data.byteOffset, data.byteOffset + data.byteLength);
61
+ }
62
+ if (typeof data === 'string') {
63
+ const text = data;
64
+ const uint8Array = new TextEncoder().encode(text);
65
+ return uint8Array.buffer;
66
+ }
67
+ // HACK to support Blob polyfill
68
+ if (data && typeof data === 'object' && data._toArrayBuffer) {
69
+ return data._toArrayBuffer();
51
70
  }
52
- return buffer;
71
+ throw new Error('toArrayBuffer');
53
72
  }
54
- exports.bufferToArrayBuffer = bufferToArrayBuffer;
73
+ exports.toArrayBuffer = toArrayBuffer;
@@ -0,0 +1,10 @@
1
+ /// <reference types="node" />
2
+ export type ReadableFile = {
3
+ read: (position: number, length: number) => Promise<Buffer>;
4
+ close: () => Promise<void>;
5
+ /** Length of file in bytes */
6
+ size: number;
7
+ };
8
+ /** Helper function to create an envelope reader for a binary memory input */
9
+ export declare function makeReadableFile(data: Blob | ArrayBuffer): ReadableFile;
10
+ //# sourceMappingURL=readable-file.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"readable-file.d.ts","sourceRoot":"","sources":["../../../src/lib/filesystems/readable-file.ts"],"names":[],"mappings":";AAEA,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5D,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,6EAA6E;AAC7E,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,IAAI,GAAG,WAAW,GAAG,YAAY,CAmBvE"}
@@ -0,0 +1,25 @@
1
+ "use strict";
2
+ // loaders.gl, MIT license
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.makeReadableFile = void 0;
5
+ /** Helper function to create an envelope reader for a binary memory input */
6
+ function makeReadableFile(data) {
7
+ if (data instanceof ArrayBuffer) {
8
+ const arrayBuffer = data;
9
+ return {
10
+ read: async (start, length) => Buffer.from(data, start, length),
11
+ close: async () => { },
12
+ size: arrayBuffer.byteLength
13
+ };
14
+ }
15
+ const blob = data;
16
+ return {
17
+ read: async (start, length) => {
18
+ const arrayBuffer = await blob.slice(start, start + length).arrayBuffer();
19
+ return Buffer.from(arrayBuffer);
20
+ },
21
+ close: async () => { },
22
+ size: blob.size
23
+ };
24
+ }
25
+ exports.makeReadableFile = makeReadableFile;
@@ -0,0 +1,18 @@
1
+ /// <reference types="node" />
2
+ /// <reference types="node" />
3
+ import type { Writable } from 'stream';
4
+ export type WritableFile = {
5
+ write: (buf: Buffer) => Promise<void>;
6
+ close: () => Promise<void>;
7
+ };
8
+ export interface WriteStreamOptions {
9
+ flags?: string;
10
+ encoding?: 'utf8';
11
+ fd?: number;
12
+ mode?: number;
13
+ autoClose?: boolean;
14
+ start?: number;
15
+ }
16
+ /** Helper function to create an envelope reader for a binary memory input */
17
+ export declare function makeWritableFile(pathOrStream: string | Writable, options?: WriteStreamOptions): WritableFile;
18
+ //# sourceMappingURL=writable-file.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"writable-file.d.ts","sourceRoot":"","sources":["../../../src/lib/filesystems/writable-file.ts"],"names":[],"mappings":";;AAGA,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,QAAQ,CAAC;AAErC,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5B,CAAC;AAEF,MAAM,WAAW,kBAAkB;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,6EAA6E;AAC7E,wBAAgB,gBAAgB,CAC9B,YAAY,EAAE,MAAM,GAAG,QAAQ,EAC/B,OAAO,CAAC,EAAE,kBAAkB,GAC3B,YAAY,CAoBd"}
@@ -0,0 +1,48 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || function (mod) {
19
+ if (mod && mod.__esModule) return mod;
20
+ var result = {};
21
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
+ __setModuleDefault(result, mod);
23
+ return result;
24
+ };
25
+ Object.defineProperty(exports, "__esModule", { value: true });
26
+ exports.makeWritableFile = void 0;
27
+ // Forked from https://github.com/kbajalc/parquets under MIT license (Copyright (c) 2017 ironSource Ltd.)
28
+ const loader_utils_1 = require("@loaders.gl/loader-utils");
29
+ const fs = __importStar(require("../node/fs"));
30
+ /** Helper function to create an envelope reader for a binary memory input */
31
+ function makeWritableFile(pathOrStream, options) {
32
+ if (loader_utils_1.isBrowser) {
33
+ return {
34
+ write: async () => { },
35
+ close: async () => { }
36
+ };
37
+ }
38
+ const outputStream = typeof pathOrStream === 'string' ? fs.createWriteStream(pathOrStream, options) : pathOrStream;
39
+ return {
40
+ write: async (buffer) => new Promise((resolve, reject) => {
41
+ outputStream.write(buffer, (err) => (err ? reject(err) : resolve()));
42
+ }),
43
+ close: () => new Promise((resolve, reject) => {
44
+ outputStream.close((err) => (err ? reject(err) : resolve()));
45
+ })
46
+ };
47
+ }
48
+ exports.makeWritableFile = makeWritableFile;
@@ -0,0 +1,10 @@
1
+ /// <reference types="node" />
2
+ /**
3
+ * Convert Buffer to ArrayBuffer
4
+ */
5
+ export declare function toArrayBuffer(buffer: Buffer): ArrayBuffer;
6
+ /**
7
+ * Convert (copy) ArrayBuffer to Buffer
8
+ */
9
+ export declare function toBuffer(arrayBuffer: ArrayBuffer): Buffer;
10
+ //# sourceMappingURL=buffer-utils.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"buffer-utils.d.ts","sourceRoot":"","sources":["../../../src/lib/loader-utils/buffer-utils.ts"],"names":[],"mappings":";AAAA;;GAEG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,WAAW,CAOzD;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAEzD"}
@@ -0,0 +1,22 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.toBuffer = exports.toArrayBuffer = void 0;
4
+ /**
5
+ * Convert Buffer to ArrayBuffer
6
+ */
7
+ function toArrayBuffer(buffer) {
8
+ // TODO - per docs we should just be able to call buffer.buffer, but there are issues
9
+ if (Buffer.isBuffer(buffer)) {
10
+ const typedArray = new Uint8Array(buffer.buffer, buffer.byteOffset, buffer.length);
11
+ return typedArray.slice().buffer;
12
+ }
13
+ return buffer;
14
+ }
15
+ exports.toArrayBuffer = toArrayBuffer;
16
+ /**
17
+ * Convert (copy) ArrayBuffer to Buffer
18
+ */
19
+ function toBuffer(arrayBuffer) {
20
+ return Buffer.from(arrayBuffer);
21
+ }
22
+ exports.toBuffer = toBuffer;
@@ -1,10 +1,12 @@
1
1
  /// <reference types="node" />
2
2
  /**
3
3
  * Convert Buffer to ArrayBuffer
4
+ * Converts Node.js `Buffer` to `ArrayBuffer` (without triggering bundler to include Buffer polyfill on browser)
5
+ * @todo better data type
4
6
  */
5
7
  export declare function toArrayBuffer(buffer: any): any;
6
8
  /**
7
9
  * Convert (copy) ArrayBuffer to Buffer
8
10
  */
9
- export declare function toBuffer(binaryData: any): void | Buffer;
11
+ export declare function toBuffer(binaryData: ArrayBuffer | ArrayBuffer | Buffer): Buffer;
10
12
  //# sourceMappingURL=buffer.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"buffer.d.ts","sourceRoot":"","sources":["../../../src/lib/node/buffer.ts"],"names":[],"mappings":";AAKA;;GAEG;AACH,wBAAgB,aAAa,CAAC,MAAM,KAAA,OAOnC;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,UAAU,KAAA,iBAelC"}
1
+ {"version":3,"file":"buffer.d.ts","sourceRoot":"","sources":["../../../src/lib/node/buffer.ts"],"names":[],"mappings":";AAGA;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,MAAM,KAAA,OAOnC;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,UAAU,EAAE,WAAW,GAAG,WAAW,GAAG,MAAM,GAAG,MAAM,CAc/E"}
@@ -3,9 +3,10 @@
3
3
  // this file is not visible to webpack (it is excluded in the package.json "browser" field).
4
4
  Object.defineProperty(exports, "__esModule", { value: true });
5
5
  exports.toBuffer = exports.toArrayBuffer = void 0;
6
- const assert_1 = require("../env-utils/assert");
7
6
  /**
8
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
9
10
  */
10
11
  function toArrayBuffer(buffer) {
11
12
  // TODO - per docs we should just be able to call buffer.buffer, but there are issues
@@ -20,17 +21,15 @@ exports.toArrayBuffer = toArrayBuffer;
20
21
  * Convert (copy) ArrayBuffer to Buffer
21
22
  */
22
23
  function toBuffer(binaryData) {
24
+ if (Buffer.isBuffer(binaryData)) {
25
+ return binaryData;
26
+ }
23
27
  if (ArrayBuffer.isView(binaryData)) {
24
28
  binaryData = binaryData.buffer;
25
29
  }
26
30
  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;
31
+ return Buffer.from(binaryData);
33
32
  }
34
- return (0, assert_1.assert)(false);
33
+ throw new Error('toBuffer');
35
34
  }
36
35
  exports.toBuffer = toBuffer;
@@ -1,4 +1,5 @@
1
- export type { Stats } from 'fs';
1
+ import fs from 'fs';
2
+ export type { Stats, WriteStream } from 'fs';
2
3
  export declare let readdir: any;
3
4
  /** Wrapper for Node.js fs method */
4
5
  export declare let stat: any;
@@ -13,11 +14,12 @@ export declare let writeFileSync: any;
13
14
  /** Wrapper for Node.js fs method */
14
15
  export declare let open: any;
15
16
  /** Wrapper for Node.js fs method */
16
- export declare let close: any;
17
+ export declare let close: (fd: number) => Promise<void>;
17
18
  /** Wrapper for Node.js fs method */
18
19
  export declare let read: any;
19
20
  /** Wrapper for Node.js fs method */
20
21
  export declare let fstat: any;
22
+ export declare let createWriteStream: typeof fs.createWriteStream;
21
23
  export declare let isSupported: boolean;
22
24
  export declare function _readToArrayBuffer(fd: number, start: number, length: number): Promise<any>;
23
25
  //# sourceMappingURL=fs.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"fs.d.ts","sourceRoot":"","sources":["../../../src/lib/node/fs.ts"],"names":[],"mappings":"AAKA,YAAY,EAAC,KAAK,EAAC,MAAM,IAAI,CAAC;AAE9B,eAAO,IAAI,OAAO,KAAA,CAAC;AACnB,oCAAoC;AACpC,eAAO,IAAI,IAAI,KAAA,CAAC;AAEhB,oCAAoC;AACpC,eAAO,IAAI,QAAQ,KAAA,CAAC;AACpB,oCAAoC;AACpC,eAAO,IAAI,YAAY,KAAA,CAAC;AACxB,oCAAoC;AACpC,eAAO,IAAI,SAAS,KAAA,CAAC;AACrB,oCAAoC;AACpC,eAAO,IAAI,aAAa,KAAA,CAAC;AAIzB,oCAAoC;AACpC,eAAO,IAAI,IAAI,KAAA,CAAC;AAChB,oCAAoC;AACpC,eAAO,IAAI,KAAK,KAAA,CAAC;AACjB,oCAAoC;AACpC,eAAO,IAAI,IAAI,KAAA,CAAC;AAChB,oCAAoC;AACpC,eAAO,IAAI,KAAK,KAAA,CAAC;AAEjB,eAAO,IAAI,WAAW,SAAc,CAAC;AAmCrC,wBAAsB,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,gBAOjF"}
1
+ {"version":3,"file":"fs.d.ts","sourceRoot":"","sources":["../../../src/lib/node/fs.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,IAAI,CAAC;AAIpB,YAAY,EAAC,KAAK,EAAE,WAAW,EAAC,MAAM,IAAI,CAAC;AAE3C,eAAO,IAAI,OAAO,KAAA,CAAC;AACnB,oCAAoC;AACpC,eAAO,IAAI,IAAI,KAAA,CAAC;AAEhB,oCAAoC;AACpC,eAAO,IAAI,QAAQ,KAAA,CAAC;AACpB,oCAAoC;AACpC,eAAO,IAAI,YAAY,KAAA,CAAC;AACxB,oCAAoC;AACpC,eAAO,IAAI,SAAS,KAAA,CAAC;AACrB,oCAAoC;AACpC,eAAO,IAAI,aAAa,KAAA,CAAC;AAIzB,oCAAoC;AACpC,eAAO,IAAI,IAAI,KAAA,CAAC;AAChB,oCAAoC;AACpC,eAAO,IAAI,KAAK,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAChD,oCAAoC;AACpC,eAAO,IAAI,IAAI,KAAA,CAAC;AAChB,oCAAoC;AACpC,eAAO,IAAI,KAAK,KAAA,CAAC;AAEjB,eAAO,IAAI,iBAAiB,EAAE,OAAO,EAAE,CAAC,iBAAiB,CAAC;AAE1D,eAAO,IAAI,WAAW,SAAc,CAAC;AAsCrC,wBAAsB,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,gBAOjF"}
@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports._readToArrayBuffer = exports.isSupported = exports.fstat = exports.read = exports.close = exports.open = exports.writeFileSync = exports.writeFile = exports.readFileSync = exports.readFile = exports.stat = exports.readdir = void 0;
6
+ exports._readToArrayBuffer = exports.isSupported = exports.createWriteStream = exports.fstat = exports.read = exports.close = exports.open = exports.writeFileSync = exports.writeFile = exports.readFileSync = exports.readFile = exports.stat = exports.readdir = void 0;
7
7
  // fs wrapper (promisified fs + avoids bundling fs in browsers)
8
8
  const fs_1 = __importDefault(require("fs"));
9
9
  const buffer_1 = require("./buffer");
@@ -12,26 +12,27 @@ exports.isSupported = Boolean(fs_1.default);
12
12
  // paths
13
13
  try {
14
14
  /** Wrapper for Node.js fs method */
15
- exports.readdir = (0, util_1.promisify)(fs_1.default.readdir);
15
+ exports.readdir = (0, util_1.promisify2)(fs_1.default.readdir);
16
16
  /** Wrapper for Node.js fs method */
17
- exports.stat = (0, util_1.promisify)(fs_1.default.stat);
17
+ exports.stat = (0, util_1.promisify2)(fs_1.default.stat);
18
18
  /** Wrapper for Node.js fs method */
19
- exports.readFile = (0, util_1.promisify)(fs_1.default.readFile);
19
+ exports.readFile = fs_1.default.readFile;
20
20
  /** Wrapper for Node.js fs method */
21
21
  exports.readFileSync = fs_1.default.readFileSync;
22
22
  /** Wrapper for Node.js fs method */
23
- exports.writeFile = (0, util_1.promisify)(fs_1.default.writeFile);
23
+ exports.writeFile = (0, util_1.promisify3)(fs_1.default.writeFile);
24
24
  /** Wrapper for Node.js fs method */
25
25
  exports.writeFileSync = fs_1.default.writeFileSync;
26
26
  // file descriptors
27
27
  /** Wrapper for Node.js fs method */
28
- exports.open = (0, util_1.promisify)(fs_1.default.open);
28
+ exports.open = fs_1.default.open;
29
29
  /** Wrapper for Node.js fs method */
30
- exports.close = (0, util_1.promisify)(fs_1.default.close);
30
+ exports.close = (fd) => new Promise((resolve, reject) => fs_1.default.close(fd, (err) => (err ? reject(err) : resolve())));
31
31
  /** Wrapper for Node.js fs method */
32
- exports.read = (0, util_1.promisify)(fs_1.default.read);
32
+ exports.read = fs_1.default.read;
33
33
  /** Wrapper for Node.js fs method */
34
- exports.fstat = (0, util_1.promisify)(fs_1.default.fstat);
34
+ exports.fstat = fs_1.default.fstat;
35
+ exports.createWriteStream = fs_1.default.createWriteStream;
35
36
  exports.isSupported = Boolean(fs_1.default);
36
37
  }
37
38
  catch {
@@ -0,0 +1,4 @@
1
+ export type { Writable } from 'stream';
2
+ export declare let Transform: any;
3
+ export declare const isSupported: boolean;
4
+ //# sourceMappingURL=stream.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"stream.d.ts","sourceRoot":"","sources":["../../../src/lib/node/stream.ts"],"names":[],"mappings":"AAIA,YAAY,EAAC,QAAQ,EAAC,MAAM,QAAQ,CAAC;AAErC,eAAO,IAAI,SAAS,KAAA,CAAC;AAErB,eAAO,MAAM,WAAW,SAAkB,CAAC"}
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ // loaders.gl, MIT license
3
+ var __importDefault = (this && this.__importDefault) || function (mod) {
4
+ return (mod && mod.__esModule) ? mod : { "default": mod };
5
+ };
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
+ exports.isSupported = exports.Transform = void 0;
8
+ const stream_1 = __importDefault(require("stream"));
9
+ exports.isSupported = Boolean(stream_1.default);
10
+ // paths
11
+ try {
12
+ /** Wrapper for Node.js fs method */
13
+ exports.Transform = stream_1.default.Transform;
14
+ }
15
+ catch {
16
+ // ignore
17
+ }
@@ -1,5 +1,13 @@
1
- /// <reference types="node" />
2
- import * as util from 'util';
3
1
  /** Wrapper for Node.js promisify */
4
- export declare const promisify: typeof util.promisify;
2
+ type Callback<A> = (error: unknown, args: A) => void;
3
+ /**
4
+ * Typesafe promisify implementation
5
+ * @link https://dev.to/_gdelgado/implement-a-type-safe-version-of-node-s-promisify-in-7-lines-of-code-in-typescript-2j34
6
+ * @param fn
7
+ * @returns
8
+ */
9
+ export declare function promisify1<T, A>(fn: (args: T, cb: Callback<A>) => void): (args: T) => Promise<A>;
10
+ export declare function promisify2<T1, T2, A>(fn: (arg1: T1, arg2: T2, cb: Callback<A>) => void): (arg1: T1, arg2: T2) => Promise<A>;
11
+ export declare function promisify3<T1, T2, T3, A>(fn: (arg1: T1, arg2: T2, arg3: T3, cb: Callback<A>) => void): (arg1: T1, arg2: T2, arg3: T3) => Promise<A>;
12
+ export {};
5
13
  //# sourceMappingURL=util.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../src/lib/node/util.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAE7B,oCAAoC;AACpC,eAAO,MAAM,SAAS,uBAAiB,CAAC"}
1
+ {"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../src/lib/node/util.ts"],"names":[],"mappings":"AAqCA,oCAAoC;AACpC,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,KAAK,IAAI,CAAC;AAErD;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAKhG;AAED,wBAAgB,UAAU,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAClC,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,IAAI,GAChD,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,CAKpC;AAED,wBAAgB,UAAU,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EACtC,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,IAAI,GAC1D,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,CAK9C"}
@@ -1,29 +1,22 @@
1
1
  "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
- Object.defineProperty(o, "default", { enumerable: true, value: v });
15
- }) : function(o, v) {
16
- o["default"] = v;
17
- });
18
- var __importStar = (this && this.__importStar) || function (mod) {
19
- if (mod && mod.__esModule) return mod;
20
- var result = {};
21
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
- __setModuleDefault(result, mod);
23
- return result;
24
- };
2
+ // @loaders.gl, MIT license
25
3
  Object.defineProperty(exports, "__esModule", { value: true });
26
- exports.promisify = void 0;
27
- const util = __importStar(require("util"));
28
- /** Wrapper for Node.js promisify */
29
- exports.promisify = util.promisify;
4
+ exports.promisify3 = exports.promisify2 = exports.promisify1 = void 0;
5
+ /**
6
+ * Typesafe promisify implementation
7
+ * @link https://dev.to/_gdelgado/implement-a-type-safe-version-of-node-s-promisify-in-7-lines-of-code-in-typescript-2j34
8
+ * @param fn
9
+ * @returns
10
+ */
11
+ function promisify1(fn) {
12
+ return (args) => new Promise((resolve, reject) => fn(args, (error, callbackArgs) => (error ? reject(error) : resolve(callbackArgs))));
13
+ }
14
+ exports.promisify1 = promisify1;
15
+ function promisify2(fn) {
16
+ return (arg1, arg2) => new Promise((resolve, reject) => fn(arg1, arg2, (error, callbackArgs) => (error ? reject(error) : resolve(callbackArgs))));
17
+ }
18
+ exports.promisify2 = promisify2;
19
+ function promisify3(fn) {
20
+ return (arg1, arg2, arg3) => new Promise((resolve, reject) => fn(arg1, arg2, arg3, (error, callbackArgs) => (error ? reject(error) : resolve(callbackArgs))));
21
+ }
22
+ exports.promisify3 = promisify3;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@loaders.gl/loader-utils",
3
- "version": "3.3.0-alpha.9",
3
+ "version": "3.3.0",
4
4
  "description": "Framework-independent loaders for 3D graphics formats",
5
5
  "license": "MIT",
6
6
  "publishConfig": {
@@ -40,13 +40,14 @@
40
40
  "./dist/es5/lib/node/util.js": false,
41
41
  "./dist/esm/lib/node/util.js": false,
42
42
  "fs": false,
43
- "util": false
43
+ "util": false,
44
+ "stream": false
44
45
  },
45
46
  "scripts": {},
46
47
  "dependencies": {
47
48
  "@babel/runtime": "^7.3.1",
48
- "@loaders.gl/worker-utils": "3.3.0-alpha.9",
49
+ "@loaders.gl/worker-utils": "3.3.0",
49
50
  "@probe.gl/stats": "^3.5.0"
50
51
  },
51
- "gitHead": "c95a4ff72512668a93d9041ce8636bac09333fd5"
52
+ "gitHead": "566d194f175a03e042d3e588cdd514048f428cc1"
52
53
  }