@loaders.gl/loader-utils 3.0.10 → 3.0.14

package/src/lib/filesystems/node-filesystem.ts

@@ -0,0 +1,79 @@
+import * as fs from '../node/fs';
+import {IFileSystem, IRandomAccessReadFileSystem} from '@loaders.gl/loader-utils';
+// 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 default class NodeFileSystem implements IFileSystem, IRandomAccessReadFileSystem {
+  // implements IFileSystem
+  constructor(options: {[key: string]: any}) {
+    this.fetch = options._fetch;
+  }
+
+  async readdir(dirname = '.', options?: {}): Promise<any[]> {
+    return await fs.readdir(dirname, options);
+  }
+
+  async stat(path: string, options?: {}): Promise<Stat> {
+    const info = await fs.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 fs.open(path, flags);
+  }
+
+  async close(fd: number): Promise<void> {
+    return await fs.close(fd);
+  }
+
+  async fstat(fd: number): Promise<Stat> {
+    const info = await fs.fstat(fd);
+    return info;
+  }
+
+  async read(
+    fd: number,
+    // @ts-ignore Possibly null
+    {buffer = null, offset = 0, length = buffer.byteLength, position = null}: ReadOptions
+  ): Promise<{bytesRead: number; buffer: Buffer}> {
+    let totalBytesRead = 0;
+    // Read in loop until we get required number of bytes
+    while (totalBytesRead < length) {
+      const {bytesRead} = await fs.read(
+        fd,
+        buffer,
+        offset + totalBytesRead,
+        length - totalBytesRead,
+        position + totalBytesRead
+      );
+      totalBytesRead += bytesRead;
+    }
+    return {bytesRead: totalBytesRead, buffer};
+  }
+}

package/src/lib/node/fs.ts

@@ -1,22 +1,38 @@
 // fs wrapper (promisified fs + avoids bundling fs in browsers)
 import fs from 'fs';
-import {toArrayBuffer} from './buffer-utils.node';
-import {promisify} from 'util';
+import {toArrayBuffer} from './buffer';
+import {promisify} from './util';
 
-const error = (fsFunction) => () => {
-  throw new Error(`${fsFunction} not available in browser`);
-};
+export type {Stats} from 'fs';
 
-export const isSupported = Boolean(fs);
+// paths
+
+/** Wrapper for Node.js fs method */
+export const readdir = promisify(fs.readdir);
+/** Wrapper for Node.js fs method */
+export const stat = promisify(fs.stat);
+
+/** Wrapper for Node.js fs method */
+export const readFile = promisify(fs.readFile);
+/** Wrapper for Node.js fs method */
+export const readFileSync = fs.readFileSync;
+/** Wrapper for Node.js fs method */
+export const writeFile = promisify(fs.writeFile);
+/** Wrapper for Node.js fs method */
+export const writeFileSync = fs.writeFileSync;
 
-export const open = fs?.open ? promisify(fs.open) : error('fs.open');
-export const close = fs?.close ? promisify(fs.close) : error('fs.close');
-export const read = fs?.read ? promisify(fs.read) : error('fs.read');
+// file descriptors
 
-export const readFile = fs?.readFile ? promisify(fs.readFile) : error('fs.readFile');
-export const readFileSync = fs?.readFileSync ? fs.readFileSync : error('fs.readFileSync');
-export const writeFile = fs?.writeFile ? promisify(fs.writeFile) : error('fs.writeFile');
-export const writeFileSync = fs?.writeFileSync ? fs.writeFileSync : error('fs.writeFileSync');
+/** Wrapper for Node.js fs method */
+export const open = promisify(fs.open);
+/** Wrapper for Node.js fs method */
+export const close = promisify(fs.close);
+/** Wrapper for Node.js fs method */
+export const read = promisify(fs.read);
+/** Wrapper for Node.js fs method */
+export const fstat = promisify(fs.fstat);
+
+export const isSupported = Boolean(fs);
 
 export async function _readToArrayBuffer(fd: number, start: number, length: number) {
   const buffer = Buffer.alloc(length);

package/src/lib/node/util.ts

@@ -0,0 +1,4 @@
+import * as util from 'util';
+
+/** Wrapper for Node.js promisify */
+export const promisify = util.promisify;

package/dist/es5/lib/node/buffer-utils.node.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/lib/node/buffer-utils.node.ts"],"names":["toArrayBuffer","buffer","Buffer","isBuffer","typedArray","Uint8Array","toBuffer","binaryData","ArrayBuffer","isView","byteLength","view","i","length"],"mappings":";;;;;;;;AAGA;;AAKO,SAASA,aAAT,CAAuBC,MAAvB,EAA+B;AAEpC,MAAIC,MAAM,CAACC,QAAP,CAAgBF,MAAhB,CAAJ,EAA6B;AAC3B,QAAMG,UAAU,GAAG,IAAIC,UAAJ,CAAeJ,MAAf,CAAnB;AACA,WAAOG,UAAU,CAACH,MAAlB;AACD;;AACD,SAAOA,MAAP;AACD;;AAKM,SAASK,QAAT,CAAkBC,UAAlB,EAA8B;AACnC,MAAIC,WAAW,CAACC,MAAZ,CAAmBF,UAAnB,CAAJ,EAAoC;AAClCA,IAAAA,UAAU,GAAGA,UAAU,CAACN,MAAxB;AACD;;AAED,MAAI,OAAOC,MAAP,KAAkB,WAAlB,IAAiCK,UAAU,YAAYC,WAA3D,EAAwE;AACtE,QAAMP,MAAM,GAAG,IAAIC,MAAJ,CAAWK,UAAU,CAACG,UAAtB,CAAf;AACA,QAAMC,IAAI,GAAG,IAAIN,UAAJ,CAAeE,UAAf,CAAb;;AACA,SAAK,IAAIK,CAAC,GAAG,CAAb,EAAgBA,CAAC,GAAGX,MAAM,CAACY,MAA3B,EAAmC,EAAED,CAArC,EAAwC;AACtCX,MAAAA,MAAM,CAACW,CAAD,CAAN,GAAYD,IAAI,CAACC,CAAD,CAAhB;AACD;;AACD,WAAOX,MAAP;AACD;;AAED,SAAO,oBAAO,KAAP,CAAP;AACD","sourcesContent":["// Isolates Buffer references to ensure they are only bundled under Node.js (avoids big webpack polyfill)\n// this file is not visible to webpack (it is excluded in the package.json \"browser\" field).\n\nimport {assert} from '../env-utils/assert';\n\n/**\n * Convert Buffer to ArrayBuffer\n */\nexport function toArrayBuffer(buffer) {\n  // TODO - per docs we should just be able to call buffer.buffer, but there are issues\n  if (Buffer.isBuffer(buffer)) {\n    const typedArray = new Uint8Array(buffer);\n    return typedArray.buffer;\n  }\n  return buffer;\n}\n\n/**\n * Convert (copy) ArrayBuffer to Buffer\n */\nexport function toBuffer(binaryData) {\n  if (ArrayBuffer.isView(binaryData)) {\n    binaryData = binaryData.buffer;\n  }\n\n  if (typeof Buffer !== 'undefined' && binaryData instanceof ArrayBuffer) {\n    const buffer = new Buffer(binaryData.byteLength);\n    const view = new Uint8Array(binaryData);\n    for (let i = 0; i < buffer.length; ++i) {\n      buffer[i] = view[i];\n    }\n    return buffer;\n  }\n\n  return assert(false);\n}\n"],"file":"buffer-utils.node.js"}

package/dist/esm/lib/node/buffer-utils.node.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/lib/node/buffer-utils.node.ts"],"names":["assert","toArrayBuffer","buffer","Buffer","isBuffer","typedArray","Uint8Array","toBuffer","binaryData","ArrayBuffer","isView","byteLength","view","i","length"],"mappings":"AAGA,SAAQA,MAAR,QAAqB,qBAArB;AAKA,OAAO,SAASC,aAAT,CAAuBC,MAAvB,EAA+B;AAEpC,MAAIC,MAAM,CAACC,QAAP,CAAgBF,MAAhB,CAAJ,EAA6B;AAC3B,UAAMG,UAAU,GAAG,IAAIC,UAAJ,CAAeJ,MAAf,CAAnB;AACA,WAAOG,UAAU,CAACH,MAAlB;AACD;;AACD,SAAOA,MAAP;AACD;AAKD,OAAO,SAASK,QAAT,CAAkBC,UAAlB,EAA8B;AACnC,MAAIC,WAAW,CAACC,MAAZ,CAAmBF,UAAnB,CAAJ,EAAoC;AAClCA,IAAAA,UAAU,GAAGA,UAAU,CAACN,MAAxB;AACD;;AAED,MAAI,OAAOC,MAAP,KAAkB,WAAlB,IAAiCK,UAAU,YAAYC,WAA3D,EAAwE;AACtE,UAAMP,MAAM,GAAG,IAAIC,MAAJ,CAAWK,UAAU,CAACG,UAAtB,CAAf;AACA,UAAMC,IAAI,GAAG,IAAIN,UAAJ,CAAeE,UAAf,CAAb;;AACA,SAAK,IAAIK,CAAC,GAAG,CAAb,EAAgBA,CAAC,GAAGX,MAAM,CAACY,MAA3B,EAAmC,EAAED,CAArC,EAAwC;AACtCX,MAAAA,MAAM,CAACW,CAAD,CAAN,GAAYD,IAAI,CAACC,CAAD,CAAhB;AACD;;AACD,WAAOX,MAAP;AACD;;AAED,SAAOF,MAAM,CAAC,KAAD,CAAb;AACD","sourcesContent":["// Isolates Buffer references to ensure they are only bundled under Node.js (avoids big webpack polyfill)\n// this file is not visible to webpack (it is excluded in the package.json \"browser\" field).\n\nimport {assert} from '../env-utils/assert';\n\n/**\n * Convert Buffer to ArrayBuffer\n */\nexport function toArrayBuffer(buffer) {\n  // TODO - per docs we should just be able to call buffer.buffer, but there are issues\n  if (Buffer.isBuffer(buffer)) {\n    const typedArray = new Uint8Array(buffer);\n    return typedArray.buffer;\n  }\n  return buffer;\n}\n\n/**\n * Convert (copy) ArrayBuffer to Buffer\n */\nexport function toBuffer(binaryData) {\n  if (ArrayBuffer.isView(binaryData)) {\n    binaryData = binaryData.buffer;\n  }\n\n  if (typeof Buffer !== 'undefined' && binaryData instanceof ArrayBuffer) {\n    const buffer = new Buffer(binaryData.byteLength);\n    const view = new Uint8Array(binaryData);\n    for (let i = 0; i < buffer.length; ++i) {\n      buffer[i] = view[i];\n    }\n    return buffer;\n  }\n\n  return assert(false);\n}\n"],"file":"buffer-utils.node.js"}