@loaders.gl/polyfills 4.2.0-alpha.4 → 4.2.0-alpha.6

package/dist/index.cjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["index.browser.js"],
+  "sourcesContent": ["// loaders.gl\n// SPDX-License-Identifier: MIT\nexport function installFilePolyfills() { }\n// Dummy export to avoid import errors in browser tests\nexport const NodeFileSystem = null;\nexport function fetchNode(path, options) {\n    throw new Error('fetchNode not available in browser');\n}\n// Ensure process and process.env are defined, as Node code tends to crash on these\n// @ts-ignore\nglobalThis.process = globalThis.process || {};\n// @ts-ignore\nglobalThis.process.env = globalThis.process.env || {};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAEO,SAAS,uBAAuB;AAAE;AAElC,IAAM,iBAAiB;AACvB,SAAS,UAAU,MAAM,SAAS;AACrC,QAAM,IAAI,MAAM,oCAAoC;AACxD;AAGA,WAAW,UAAU,WAAW,WAAW,CAAC;AAE5C,WAAW,QAAQ,MAAM,WAAW,QAAQ,OAAO,CAAC;",
+  "names": []
+}

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export declare const nodeVersion: number;
-export { Blob_ as Blob } from './file/install-blob-polyfills';
-export { File_ as File } from './file/install-file-polyfills';
-export { makeNodeStream } from './streams/make-node-stream';
-export { installFilePolyfills } from './file/install-file-polyfills';
+export { Blob_ as Blob } from "./file/install-blob-polyfills.js";
+export { File_ as File } from "./file/install-file-polyfills.js";
+export { makeNodeStream } from "./streams/make-node-stream.js";
+export { installFilePolyfills } from "./file/install-file-polyfills.js";
 //# 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":"AAoBA,eAAO,MAAM,WAAW,QAAwC,CAAC;AAMjE,OAAO,EAAC,KAAK,IAAI,IAAI,EAAC,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAC,KAAK,IAAI,IAAI,EAAC,MAAM,+BAA+B,CAAC;AAY5D,OAAO,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAC;AA8D1D,OAAO,EAAC,oBAAoB,EAAC,MAAM,+BAA+B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAqBA,eAAO,MAAM,WAAW,QAAwC,CAAC;AAMjE,OAAO,EAAC,KAAK,IAAI,IAAI,EAAC,yCAAsC;AAC5D,OAAO,EAAC,KAAK,IAAI,IAAI,EAAC,yCAAsC;AAY5D,OAAO,EAAC,cAAc,EAAC,sCAAmC;AA8D1D,OAAO,EAAC,oBAAoB,EAAC,yCAAsC"}

package/dist/index.js

@@ -1,62 +1,93 @@
+/* eslint-disable dot-notation */
 import { isBrowser } from "./utils/is-browser.js";
 import { TextDecoder, TextEncoder } from "./text-encoder/text-encoder.js";
+// Node specific
 import { atob, btoa } from "./buffer/btoa.node.js";
 import { encodeImageNode } from "./images/encode-image-node.js";
 import { parseImageNode, NODE_FORMAT_SUPPORT } from "./images/parse-image-node.js";
+// FILESYSTEM POLYFILLS
 import { NodeFile } from "./filesystems/node-file.js";
 import { NodeFileSystem } from "./filesystems/node-filesystem.js";
 import { fetchNode } from "./filesystems/fetch-node.js";
 import { NodeHash } from "./crypto/node-hash.js";
+// NODE VERSION
+// @ts-expect-error
 import { versions } from 'node:process';
 export const nodeVersion = parseInt(versions.node.split('.')[0]);
+// STREAM POLYFILLS
 import { makeNodeStream } from "./streams/make-node-stream.js";
+// BLOB AND FILE POLYFILLS
 export { Blob_ as Blob } from "./file/install-blob-polyfills.js";
 export { File_ as File } from "./file/install-file-polyfills.js";
 if (isBrowser) {
-  console.error('loaders.gl: The @loaders.gl/polyfills should only be used in Node.js environments');
+    // eslint-disable-next-line no-console
+    console.error('loaders.gl: The @loaders.gl/polyfills should only be used in Node.js environments');
 }
 globalThis.loaders = globalThis.loaders || {};
+// STREAM POLYFILLS
 export { makeNodeStream } from "./streams/make-node-stream.js";
 globalThis.loaders.makeNodeStream = makeNodeStream;
+// FILESYSTEM POLYFILLS
 globalThis.loaders.NodeFile = NodeFile;
 globalThis.loaders.NodeFileSystem = NodeFileSystem;
 globalThis.loaders.fetchNode = fetchNode;
+// CRYPTO POLYFILLS
 globalThis.loaders.NodeHash = NodeHash;
+// POLYFILLS: TextEncoder, TextDecoder
+// - Recent Node versions have these classes but virtually no encodings unless special build.
+// - Browser: Edge, IE11 do not have these
 if (!globalThis.TextEncoder) {
-  globalThis.TextEncoder = TextEncoder;
+    // @ts-expect-error
+    globalThis.TextEncoder = TextEncoder;
 }
 if (!globalThis.TextDecoder) {
-  globalThis.TextDecoder = TextDecoder;
+    // @ts-expect-error
+    globalThis.TextDecoder = TextDecoder;
 }
+// POLYFILLS: btoa, atob
+// - Node: Yes
+// - Browser: No
 if (!('atob' in globalThis) && atob) {
-  globalThis['atob'] = atob;
+    globalThis['atob'] = atob;
 }
 if (!('btoa' in globalThis) && btoa) {
-  globalThis['btoa'] = btoa;
+    globalThis['btoa'] = btoa;
 }
+// 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?
 globalThis.loaders.encodeImageNode = encodeImageNode;
 globalThis.loaders.parseImageNode = parseImageNode;
 globalThis.loaders.imageFormatsNode = NODE_FORMAT_SUPPORT;
+// Deprecated, remove after republish
 globalThis._parseImageNode = parseImageNode;
 globalThis._imageFormatsNode = NODE_FORMAT_SUPPORT;
+// LOAD LIBRARY
 import { readFileAsArrayBuffer, readFileAsText, requireFromFile, requireFromString } from "./load-library/require-utils.node.js";
 globalThis.loaders.readFileAsArrayBuffer = readFileAsArrayBuffer;
 globalThis.loaders.readFileAsText = readFileAsText;
 globalThis.loaders.requireFromFile = requireFromFile;
 globalThis.loaders.requireFromString = requireFromString;
 export { installFilePolyfills } from "./file/install-file-polyfills.js";
+// 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 "./fetch/headers-polyfill.js";
 import { Response as ResponseNode } from "./fetch/response-polyfill.js";
 import { fetchNode as fetchNodePolyfill } from "./fetch/fetch-polyfill.js";
 if (nodeVersion < 18) {
-  if (!('Headers' in globalThis) && HeadersNode) {
-    globalThis.Headers = HeadersNode;
-  }
-  if (!('Response' in globalThis) && ResponseNode) {
-    globalThis.Response = ResponseNode;
-  }
-  if (!('fetch' in globalThis) && fetchNodePolyfill) {
-    globalThis.fetch = fetchNodePolyfill;
-  }
+    if (!('Headers' in globalThis) && HeadersNode) {
+        // @ts-ignore
+        globalThis.Headers = HeadersNode;
+    }
+    if (!('Response' in globalThis) && ResponseNode) {
+        // @ts-ignore
+        globalThis.Response = ResponseNode;
+    }
+    if (!('fetch' in globalThis) && fetchNodePolyfill) {
+        // @ts-ignore
+        globalThis.fetch = fetchNodePolyfill;
+    }
 }
-//# sourceMappingURL=index.js.map