@loaders.gl/polyfills 4.0.0-beta.1 → 4.0.0-beta.2

package/dist/filesystems/node-filesystem.d.ts

@@ -0,0 +1,39 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { FileSystem, RandomAccessReadFileSystem } from '@loaders.gl/loader-utils';
+import fs from 'fs';
+type Stat = {
+    size: number;
+    isDirectory: () => boolean;
+    info?: fs.Stats;
+};
+type ReadOptions = {
+    buffer?: Buffer;
+    offset?: number;
+    length?: number;
+    position?: number;
+};
+/**
+ * FileSystem pass-through for Node.js
+ * Compatible with BrowserFileSystem.
+ * @param options
+ */
+export declare class NodeFileSystem implements FileSystem, RandomAccessReadFileSystem {
+    constructor(options: {
+        [key: string]: any;
+    });
+    readdir(dirname?: string, options?: {}): Promise<any[]>;
+    stat(path: string, options?: {}): Promise<Stat>;
+    fetch(path: string, options: {
+        [key: string]: any;
+    }): Promise<any>;
+    open(path: string, flags: string | number, mode?: any): Promise<number>;
+    close(fd: number): Promise<void>;
+    fstat(fd: number): Promise<Stat>;
+    read(fd: number, { buffer, offset, length, position }: ReadOptions): Promise<{
+        bytesRead: number;
+        buffer: Uint8Array;
+    }>;
+}
+export {};
+//# sourceMappingURL=node-filesystem.d.ts.map

package/dist/filesystems/node-filesystem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node-filesystem.d.ts","sourceRoot":"","sources":["../../src/filesystems/node-filesystem.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAC,UAAU,EAAE,0BAA0B,EAAC,MAAM,0BAA0B,CAAC;AAChF,OAAO,EAAE,MAAM,IAAI,CAAC;AAMpB,KAAK,IAAI,GAAG;IACV,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,OAAO,CAAC;IAC3B,IAAI,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC;CACjB,CAAC;AAEF,KAAK,WAAW,GAAG;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,qBAAa,cAAe,YAAW,UAAU,EAAE,0BAA0B;gBAE/D,OAAO,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC;IAInC,OAAO,CAAC,OAAO,SAAM,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAIpD,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAK/C,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC;IAQjD,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvE,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhC,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMhC,IAAI,CACR,EAAE,EAAE,MAAM,EAEV,EAAC,MAAa,EAAE,MAAU,EAAE,MAA0B,EAAE,QAAe,EAAC,EAAE,WAAW,GACpF,OAAO,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,UAAU,CAAA;KAAC,CAAC;CAoBpD"}

package/dist/index.browser.d.ts

@@ -0,0 +1,3 @@
+export declare function installFilePolyfills(): void;
+export declare const NodeFileSystem: null;
+//# sourceMappingURL=index.browser.d.ts.map

package/dist/index.browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.browser.d.ts","sourceRoot":"","sources":["../src/index.browser.ts"],"names":[],"mappings":"AAUA,wBAAgB,oBAAoB,SAAK;AAGzC,eAAO,MAAM,cAAc,MAAO,CAAC"}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export { FileReaderPolyfill } from './node/file/file-reader';
 export { FilePolyfill } from './node/file/file';
 export { installFilePolyfills } from './node/file/install-file-polyfills';
+export { NodeFileSystem } from './filesystems/node-filesystem';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAC,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAC,YAAY,EAAC,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAC,oBAAoB,EAAC,MAAM,oCAAoC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAcA,OAAO,EAAC,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAC,YAAY,EAAC,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAC,oBAAoB,EAAC,MAAM,oCAAoC,CAAC;AAqCxE,OAAO,EAAC,cAAc,EAAC,MAAM,+BAA+B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/polyfills",
-  "version": "4.0.0-beta.1",
+  "version": "4.0.0-beta.2",
   "description": "Polyfills for TextEncoder/TextDecoder",
   "license": "MIT",
   "publishConfig": {
@@ -26,70 +26,10 @@
     "README.md"
   ],
   "browser": {
-    "./src/node/fetch/utils/decode-data-uri.node.js": false,
-    "./src/node/fetch/utils/decode-data-uri.node.ts": false,
-    "./dist/es5/node/fetch/utils/decode-data-uri.node.js": false,
-    "./dist/esm/node/fetch/utils/decode-data-uri.node.js": false,
-    "./src/node/fetch/utils/stream-utils.node.js": false,
-    "./src/node/fetch/utils/stream-utils.node.ts": false,
-    "./dist/es5/node/fetch/utils/stream-utils.node.js": false,
-    "./dist/esm/node/fetch/utils/stream-utils.node.js": false,
-    "./src/node/fetch/fetch.node.js": false,
-    "./src/node/fetch/fetch.node.ts": false,
-    "./dist/es5/node/fetch/fetch.node.js": false,
-    "./dist/esm/node/fetch/fetch.node.js": false,
-    "./src/node/fetch/headers.node.js": false,
-    "./src/node/fetch/headers.node.ts": false,
-    "./dist/es5/node/fetch/headers.node.js": false,
-    "./dist/esm/node/fetch/headers.node.js": false,
-    "./src/node/fetch/response.node.js": false,
-    "./src/node/fetch/response.node.ts": false,
-    "./dist/es5/node/fetch/response.node.js": false,
-    "./dist/esm/node/fetch/response.node.js": false,
-    "./src/node/images/encode-image.node.js": false,
-    "./src/node/images/encode-image.node.ts": false,
-    "./dist/es5/node/images/encode-image.node.js": false,
-    "./dist/esm/node/images/encode-image.node.js": false,
-    "./src/node/images/parse-image.node.js": false,
-    "./src/node/images/parse-image.node.ts": false,
-    "./dist/es5/node/images/parse-image.node.js": false,
-    "./dist/esm/node/images/parse-image.node.js": false,
-    "./src/node/buffer/to-array-buffer.node.js": false,
-    "./src/node/buffer/to-array-buffer.node.ts": false,
-    "./dist/es5/node/buffer/to-array-buffer.node.js": false,
-    "./dist/esm/node/buffer/to-array-buffer.node.js": false,
-    "./src/node/buffer/btoa.node.js": false,
-    "./src/node/buffer/btoa.node.ts": false,
-    "./dist/es5/node/buffer/btoa.node.js": false,
-    "./dist/esm/node/buffer/btoa.node.js": false,
-    "./src/node/file/blob.js": false,
-    "./src/node/file/blob.ts": false,
-    "./dist/es5/node/file/blob.js": false,
-    "./dist/esm/node/file/blob.js": false,
-    "./src/node/file/file.js": false,
-    "./src/node/file/file.ts": false,
-    "./dist/es5/node/file/file.js": false,
-    "./dist/esm/node/file/file.js": false,
-    "./src/node/file/readable-stream.js": false,
-    "./src/node/file/readable-stream.ts": false,
-    "./dist/es5/node/file/readable-stream.js": false,
-    "./dist/esm/node/file/readable-stream.js": false,
-    "./src/libs/encoding-indices.js": false,
-    "./src/libs/encoding-indices.ts": false,
-    "./dist/es5/libs/encoding-indices.js": false,
-    "./dist/esm/libs/encoding-indices.js": false,
-    "fs": false,
-    "http": false,
-    "https": false,
-    "stream": false,
-    "get-pixels": false,
-    "ndarray": false,
-    "save-pixels": false,
-    "stream-to-async-iterator": false,
-    "through": false,
-    "util": false,
-    "zlib": false,
-    "web-streams-polyfill": false
+    "./src/index.ts": "./src/index.browser.ts",
+    "./dist/index.js": "./dist/index.browser.js",
+    "./dist/es5/index.js": "./dist/es5/index.browser.js",
+    "./dist/esm/index.js": "./dist/es5/index.browser.js"
   },
   "scripts": {
     "pre-build": "npm run build-bundle",
@@ -105,5 +45,5 @@
     "through": "^2.3.8",
     "web-streams-polyfill": "^3.0.0"
   },
-  "gitHead": "35c625e67132b0784e597d9ddabae8aefea29ff2"
+  "gitHead": "79c2033f755e88e11bc30a04428e3666b177b8fc"
 }

package/src/filesystems/node-filesystem.ts

@@ -0,0 +1,87 @@
+import {FileSystem, RandomAccessReadFileSystem} from '@loaders.gl/loader-utils';
+import fs from 'fs';
+import fsPromise from 'fs/promises';
+
+// import {fetchFile} from "../fetch/fetch-file"
+// import {selectLoader} from "../api/select-loader";
+
+type Stat = {
+  size: number;
+  isDirectory: () => boolean;
+  info?: fs.Stats;
+};
+
+type ReadOptions = {
+  buffer?: Buffer;
+  offset?: number;
+  length?: number;
+  position?: number;
+};
+
+/**
+ * FileSystem pass-through for Node.js
+ * Compatible with BrowserFileSystem.
+ * @param options
+ */
+export class NodeFileSystem implements FileSystem, RandomAccessReadFileSystem {
+  // implements FileSystem
+  constructor(options: {[key: string]: any}) {
+    this.fetch = options._fetch;
+  }
+
+  async readdir(dirname = '.', options?: {}): Promise<any[]> {
+    return await fsPromise.readdir(dirname, options);
+  }
+
+  async stat(path: string, options?: {}): Promise<Stat> {
+    const info = await fsPromise.stat(path, options);
+    return {size: Number(info.size), isDirectory: () => false, info};
+  }
+
+  async fetch(path: string, options: {[key: string]: any}) {
+    // Falls back to handle https:/http:/data: etc fetches
+    // eslint-disable-next-line
+    const fallbackFetch = options.fetch || this.fetch;
+    return fallbackFetch(path, options);
+  }
+
+  // implements IRandomAccessFileSystem
+  async open(path: string, flags: string | number, mode?: any): Promise<number> {
+    return (await fsPromise.open(path, flags)) as unknown as number;
+  }
+
+  async close(fd: number): Promise<void> {
+    fs.close(fd);
+  }
+
+  async fstat(fd: number): Promise<Stat> {
+    return await new Promise((resolve, reject) =>
+      fs.fstat(fd, (err, info) => (err ? reject(err) : resolve(info)))
+    );
+  }
+
+  async read(
+    fd: number,
+    // @ts-ignore Possibly null
+    {buffer = null, offset = 0, length = buffer.byteLength, position = null}: ReadOptions
+  ): Promise<{bytesRead: number; buffer: Uint8Array}> {
+    let totalBytesRead = 0;
+    // Read in loop until we get required number of bytes
+    while (totalBytesRead < length) {
+      const {bytesRead} = await new Promise<{bytesRead: number; buffer: Buffer}>(
+        // eslint-disable-next-line no-loop-func
+        (resolve, reject) =>
+          fs.read(
+            fd,
+            buffer,
+            offset + totalBytesRead,
+            length - totalBytesRead,
+            position + totalBytesRead,
+            (err, bytesRead, buffer) => (err ? reject(err) : resolve({bytesRead, buffer}))
+          )
+      );
+      totalBytesRead += bytesRead;
+    }
+    return {bytesRead: totalBytesRead, buffer};
+  }
+}

package/src/index.browser.ts

@@ -0,0 +1,14 @@
+// loaders.gl, MIT License
+
+import {allSettled} from './promise/all-settled';
+
+if (!('allSettled' in Promise)) {
+  // @ts-ignore
+  Promise.allSettled = allSettled;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-function
+export function installFilePolyfills() {}
+
+// Dummy export to avoid import errors in browser tests
+export const NodeFileSystem = null;

package/src/index.ts

@@ -1,5 +1,5 @@
 /* eslint-disable dot-notation */
-import {isBrowser, global} from './utils/globals';
+import {isBrowser} from './utils/globals';
 
 import {TextDecoder, TextEncoder} from './lib/encoding';
 import {allSettled} from './promise/all-settled';
@@ -7,10 +7,6 @@ import {allSettled} from './promise/all-settled';
 // Node specific
 import * as base64 from './node/buffer/btoa.node';
 
-import {Headers as HeadersNode} from './node/fetch/headers.node';
-import {Response as ResponseNode} from './node/fetch/response.node';
-import {fetchNode as fetchNode} from './node/fetch/fetch.node';
-
 import {encodeImageNode} from './node/images/encode-image.node';
 import {parseImageNode, NODE_FORMAT_SUPPORT} from './node/images/parse-image.node';
 
@@ -20,63 +16,83 @@ export {FileReaderPolyfill} from './node/file/file-reader';
 export {FilePolyfill} from './node/file/file';
 export {installFilePolyfills} from './node/file/install-file-polyfills';
 
+if (isBrowser) {
+  // eslint-disable-next-line no-console
+  console.error(
+    'loaders.gl: The @loaders.gl/polyfills should only be used in Node.js environments'
+  );
+}
+
 // POLYFILLS: TextEncoder, TextDecoder
 // - Recent Node versions have these classes but virtually no encodings unless special build.
 // - Browser: Edge, IE11 do not have these
 
-const installTextEncoder = !isBrowser || !('TextEncoder' in global);
-if (installTextEncoder) {
-  global['TextEncoder'] = TextEncoder;
+if (!globalThis.TextEncoder) {
+  // @ts-expect-error
+  globalThis.TextEncoder = TextEncoder;
 }
 
-const installTextDecoder = !isBrowser || !('TextDecoder' in global);
-if (installTextDecoder) {
-  global['TextDecoder'] = TextDecoder;
+if (!globalThis.TextDecoder) {
+  // @ts-expect-error
+  globalThis.TextDecoder = TextDecoder;
 }
 
 // POLYFILLS: btoa, atob
 // - Node: Yes
 // - Browser: No
 
-if (!isBrowser && !('atob' in global) && base64.atob) {
-  global['atob'] = base64.atob;
+if (!isBrowser && !('atob' in globalThis) && base64.atob) {
+  globalThis['atob'] = base64.atob;
 }
-if (!isBrowser && !('btoa' in global) && base64.btoa) {
-  global['btoa'] = base64.btoa;
-}
-
-// DEPRECATED POLYFILL:
-// - Node v18+: No, not needed
-// - Node v16 and lower: Yes
-// - Browsers (evergreen): Not needed.
-// - IE11: No. This polyfill is node only, install external polyfill
-
-if (!isBrowser && !('Headers' in global) && HeadersNode) {
-  global['Headers'] = HeadersNode;
+if (!isBrowser && !('btoa' in globalThis) && base64.btoa) {
+  globalThis['btoa'] = base64.btoa;
 }
 
-if (!isBrowser && !('Response' in global) && ResponseNode) {
-  global['Response'] = ResponseNode;
-}
+globalThis.loaders = globalThis.loaders || {};
 
-if (!isBrowser && !('fetch' in global) && fetchNode) {
-  global['fetch'] = fetchNode;
-}
+// FILESYSTEM POLYFILLS:
+export {NodeFileSystem} from './filesystems/node-filesystem';
+import {NodeFileSystem} from './filesystems/node-filesystem';
+globalThis.loaders.NodeFileSystem = NodeFileSystem;
 
 // NODE IMAGE FUNCTIONS:
 // These are not official polyfills but used by the @loaders.gl/images module if installed
 // TODO - is there an appropriate Image API we could polyfill using an adapter?
 
-if (!isBrowser && !('_encodeImageNode' in global) && encodeImageNode) {
-  global['_encodeImageNode'] = encodeImageNode;
+if (!isBrowser && !('_encodeImageNode' in globalThis) && encodeImageNode) {
+  globalThis['_encodeImageNode'] = encodeImageNode;
 }
 
-if (!isBrowser && !('_parseImageNode' in global) && parseImageNode) {
-  global['_parseImageNode'] = parseImageNode;
-  global['_imageFormatsNode'] = NODE_FORMAT_SUPPORT;
+if (!isBrowser && !('_parseImageNode' in globalThis) && parseImageNode) {
+  globalThis['_parseImageNode'] = parseImageNode;
+  globalThis['_imageFormatsNode'] = NODE_FORMAT_SUPPORT;
 }
 
 if (!('allSettled' in Promise)) {
   // @ts-ignore
   Promise.allSettled = allSettled;
 }
+
+// DEPRECATED POLYFILL:
+// - Node v18+: No, not needed
+// - Node v16 and lower: Yes
+// - Browsers (evergreen): Not needed.
+// - IE11: No. This polyfill is node only, install external polyfill
+import {Headers as HeadersNode} from './node/fetch/headers.node';
+import {Response as ResponseNode} from './node/fetch/response.node';
+import {fetchNode as fetchNode} from './node/fetch/fetch.node';
+
+if (!isBrowser && !('Headers' in globalThis) && HeadersNode) {
+  // @ts-expect-error
+  globalThis.Headers = HeadersNode;
+}
+
+if (!isBrowser && !('Response' in globalThis) && ResponseNode) {
+  // @ts-expect-error
+  globalThis.Response = ResponseNode;
+}
+
+if (!isBrowser && !('fetch' in globalThis) && fetchNode) {
+  // @ts-expect-error
+  globalThis.fetch = fetchNode;
+}