@ipld/car 5.3.3 → 5.4.0

package/README.md

@@ -377,7 +377,7 @@ amount of memory that the runtime can handle.
 <a name="CarReader__readRaw"></a>
 ### `async CarReader.readRaw(fd, blockIndex)`
 
-* `fd` `(fs.promises.FileHandle|number)`: A file descriptor from the
+* `fd` `(FileHandle|number)`: A file descriptor from the
   Node.js `fs` module. Either an integer, from `fs.open()` or a `FileHandle`
   from `fs.promises.open()`.
 * `blockIndex` `(BlockIndex)`: An index pointing to the location of the
@@ -780,7 +780,7 @@ upon successful modification.
 <a name="CarWriter__updateRootsInFile"></a>
 ### `async CarWriter.updateRootsInFile(fd, roots)`
 
-* `fd` `(fs.promises.FileHandle|number)`: A file descriptor from the
+* `fd` `(FileHandle|number)`: A file descriptor from the
   Node.js `fs` module. Either an integer, from `fs.open()` or a `FileHandle`
   from `fs.promises.open()`.
 * `roots` `(CID[])`: A new list of roots to replace the existing list in

package/dist/src/promise-fs-opts.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @description This function is needed not to initialize the `fs.read` on load time. To run in cf workers without polyfill.
+ * @param {number} fd
+ * @param {Uint8Array} buffer
+ * @param {number} offset
+ * @param {number} length
+ * @param {number} position
+ * @returns {Promise<{ bytesRead: number, buffer: Uint8Array }>}
+ */
+export function fsread(fd: number, buffer: Uint8Array, offset: number, length: number, position: number): Promise<{
+    bytesRead: number;
+    buffer: Uint8Array;
+}>;
+/**
+ * @description This function is needed not to initialize the `fs.write` on load time. To run in cf workers without polyfill.
+ * @param {number} fd
+ * @param {Uint8Array} buffer
+ * @param {number} offset
+ * @param {number} length
+ * @param {number} position
+ * @returns {Promise<{ bytesRead: number, buffer: Uint8Array }>}
+ */
+export function fswrite(fd: number, buffer: Uint8Array, offset: number, length: number, position: number): Promise<{
+    bytesRead: number;
+    buffer: Uint8Array;
+}>;
+export const hasFS: boolean;
+//# sourceMappingURL=promise-fs-opts.d.ts.map

package/dist/src/promise-fs-opts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promise-fs-opts.d.ts","sourceRoot":"","sources":["../../src/promise-fs-opts.js"],"names":[],"mappings":"AAWA;;;;;;;;GAQG;AACH,2BAPW,MAAM,UACN,UAAU,UACV,MAAM,UACN,MAAM,YACN,MAAM,GACJ,QAAQ;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,UAAU,CAAA;CAAE,CAAC,CAO9D;AAMD;;;;;;;;GAQG;AACH,4BAPW,MAAM,UACN,UAAU,UACV,MAAM,UACN,MAAM,YACN,MAAM,GACJ,QAAQ;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,UAAU,CAAA;CAAE,CAAC,CAO9D;AA1CD,4BAAyB"}

package/dist/src/reader.d.ts

@@ -1,4 +1,9 @@
-/// <reference types="node" />
+/**
+ * @typedef {import('./api').Block} Block
+ * @typedef {import('./api').BlockIndex} BlockIndex
+ * @typedef {import('./api').CarReader} CarReaderIface
+ * @typedef {import('fs').promises.FileHandle} FileHandle
+ */
 /**
  * @class
  * @implements {CarReaderIface}
@@ -16,7 +21,7 @@ export class CarReader extends BrowserCarReader implements CarReaderIface {
      * @async
      * @static
      * @memberof CarReader
-     * @param {fs.promises.FileHandle | number} fd - A file descriptor from the
+     * @param {FileHandle | number} fd - A file descriptor from the
      * Node.js `fs` module. Either an integer, from `fs.open()` or a `FileHandle`
      * from `fs.promises.open()`.
      * @param {BlockIndex} blockIndex - An index pointing to the location of the
@@ -24,12 +29,12 @@ export class CarReader extends BrowserCarReader implements CarReaderIface {
      * `{cid:CID, blockLength:number, blockOffset:number}`.
      * @returns {Promise<Block>} A `{ cid:CID, bytes:Uint8Array }` pair.
      */
-    static readRaw(fd: fs.promises.FileHandle | number, blockIndex: BlockIndex): Promise<Block>;
+    static readRaw(fd: FileHandle | number, blockIndex: BlockIndex): Promise<Block>;
 }
-export const __browser: false;
+export const __browser: boolean;
 export type Block = import('./api').Block;
 export type BlockIndex = import('./api').BlockIndex;
 export type CarReaderIface = import('./api').CarReader;
+export type FileHandle = import('fs').promises.FileHandle;
 import { CarReader as BrowserCarReader } from './reader-browser.js';
-import fs from 'fs';
 //# sourceMappingURL=reader.d.ts.map

package/dist/src/reader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reader.d.ts","sourceRoot":"","sources":["../../src/reader.js"],"names":[],"mappings":";AAYA;;;GAGG;AACH;IACE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,mBARW,GAAG,QAAQ,CAAC,UAAU,GAAG,MAAM,cAG/B,UAAU,GAGR,QAAQ,KAAK,CAAC,CAiB1B;CACF;AAED,8BAA8B;oBAlDjB,OAAO,OAAO,EAAE,KAAK;yBACrB,OAAO,OAAO,EAAE,UAAU;6BAC1B,OAAO,OAAO,EAAE,SAAS;8CALQ,qBAAqB;eAFpD,IAAI"}
+{"version":3,"file":"reader.d.ts","sourceRoot":"","sources":["../../src/reader.js"],"names":[],"mappings":"AAGA;;;;;GAKG;AAEH;;;GAGG;AACH;IACE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,mBARW,UAAU,GAAG,MAAM,cAGnB,UAAU,GAGR,QAAQ,KAAK,CAAC,CAiB1B;CACF;AAED,gCAA+B;oBAjDlB,OAAO,OAAO,EAAE,KAAK;yBACrB,OAAO,OAAO,EAAE,UAAU;6BAC1B,OAAO,OAAO,EAAE,SAAS;yBACzB,OAAO,IAAI,EAAE,QAAQ,CAAC,UAAU;8CANC,qBAAqB"}

package/dist/src/writer.d.ts

@@ -1,7 +1,7 @@
-/// <reference types="node" />
 /**
  * @typedef {import('multiformats/cid').CID} CID
  * @typedef {import('./api').BlockWriter} BlockWriter
+ * @typedef {import('fs').promises.FileHandle} FileHandle
  */
 /**
  * @class
@@ -26,7 +26,7 @@ export class CarWriter extends BrowserCarWriter implements BlockWriter {
      * @async
      * @static
      * @memberof CarWriter
-     * @param {fs.promises.FileHandle | number} fd - A file descriptor from the
+     * @param {FileHandle | number} fd - A file descriptor from the
      * Node.js `fs` module. Either an integer, from `fs.open()` or a `FileHandle`
      * from `fs.promises.open()`.
      * @param {CID[]} roots - A new list of roots to replace the existing list in
@@ -35,11 +35,11 @@ export class CarWriter extends BrowserCarWriter implements BlockWriter {
      * as the existing roots.
      * @returns {Promise<void>}
      */
-    static updateRootsInFile(fd: fs.promises.FileHandle | number, roots: CID[]): Promise<void>;
+    static updateRootsInFile(fd: FileHandle | number, roots: CID[]): Promise<void>;
 }
-export const __browser: false;
+export const __browser: boolean;
 export type CID = import('multiformats/cid').CID;
 export type BlockWriter = import('./api').BlockWriter;
+export type FileHandle = import('fs').promises.FileHandle;
 import { CarWriter as BrowserCarWriter } from './writer-browser.js';
-import fs from 'fs';
 //# sourceMappingURL=writer.d.ts.map

package/dist/src/writer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"writer.d.ts","sourceRoot":"","sources":["../../src/writer.js"],"names":[],"mappings":";AASA;;;GAGG;AAEH;;;GAGG;AACH;IACE;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,6BATW,GAAG,QAAQ,CAAC,UAAU,GAAG,MAAM,SAG/B,GAAG,EAAE,GAIH,QAAQ,IAAI,CAAC,CAoCzB;CACF;AAED,8BAA8B;kBAzEjB,OAAO,kBAAkB,EAAE,GAAG;0BAC9B,OAAO,OAAO,EAAE,WAAW;8CAPM,qBAAqB;eAJpD,IAAI"}
+{"version":3,"file":"writer.d.ts","sourceRoot":"","sources":["../../src/writer.js"],"names":[],"mappings":"AAKA;;;;GAIG;AAEH;;;GAGG;AACH;IACE;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,6BATW,UAAU,GAAG,MAAM,SAGnB,GAAG,EAAE,GAIH,QAAQ,IAAI,CAAC,CAoCzB;CACF;AAED,gCAA+B;kBA1ElB,OAAO,kBAAkB,EAAE,GAAG;0BAC9B,OAAO,OAAO,EAAE,WAAW;yBAC3B,OAAO,IAAI,EAAE,QAAQ,CAAC,UAAU;8CALC,qBAAqB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ipld/car",
-  "version": "5.3.3",
+  "version": "5.4.0",
   "description": "Content Addressable aRchive format reader and writer",
   "author": "Rod <rod@vagg.org> (http://r.va.gg/)",
   "license": "Apache-2.0 OR MIT",

package/src/promise-fs-opts.js

@@ -0,0 +1,46 @@
+import fs from 'fs'
+import { promisify } from 'util'
+
+const hasFS = Boolean(fs)
+
+export { hasFS }
+
+/**
+ * @type {any}
+ */
+let _fsReadFn
+/**
+ * @description This function is needed not to initialize the `fs.read` on load time. To run in cf workers without polyfill.
+ * @param {number} fd
+ * @param {Uint8Array} buffer
+ * @param {number} offset
+ * @param {number} length
+ * @param {number} position
+ * @returns {Promise<{ bytesRead: number, buffer: Uint8Array }>}
+ */
+export function fsread (fd, buffer, offset, length, position) {
+  if (!_fsReadFn) {
+    _fsReadFn = promisify(fs.read)
+  }
+  return _fsReadFn(fd, buffer, offset, length, position)
+}
+
+/**
+ * @type {any}
+ */
+let _fsWriteFn
+/**
+ * @description This function is needed not to initialize the `fs.write` on load time. To run in cf workers without polyfill.
+ * @param {number} fd
+ * @param {Uint8Array} buffer
+ * @param {number} offset
+ * @param {number} length
+ * @param {number} position
+ * @returns {Promise<{ bytesRead: number, buffer: Uint8Array }>}
+ */
+export function fswrite (fd, buffer, offset, length, position) {
+  if (!_fsWriteFn) {
+    _fsWriteFn = promisify(fs.write)
+  }
+  return _fsWriteFn(fd, buffer, offset, length, position)
+}

package/src/reader.js

@@ -1,15 +1,13 @@
-import fs from 'fs'
-import { promisify } from 'util'
+import { fsread, hasFS } from './promise-fs-opts.js'
 import { CarReader as BrowserCarReader } from './reader-browser.js'
 
 /**
  * @typedef {import('./api').Block} Block
  * @typedef {import('./api').BlockIndex} BlockIndex
  * @typedef {import('./api').CarReader} CarReaderIface
+ * @typedef {import('fs').promises.FileHandle} FileHandle
  */
 
-const fsread = promisify(fs.read)
-
 /**
  * @class
  * @implements {CarReaderIface}
@@ -27,7 +25,7 @@ export class CarReader extends BrowserCarReader {
    * @async
    * @static
    * @memberof CarReader
-   * @param {fs.promises.FileHandle | number} fd - A file descriptor from the
+   * @param {FileHandle | number} fd - A file descriptor from the
    * Node.js `fs` module. Either an integer, from `fs.open()` or a `FileHandle`
    * from `fs.promises.open()`.
    * @param {BlockIndex} blockIndex - An index pointing to the location of the
@@ -53,4 +51,4 @@ export class CarReader extends BrowserCarReader {
   }
 }
 
-export const __browser = false
+export const __browser = !hasFS

package/src/writer.js

@@ -1,15 +1,12 @@
-import fs from 'fs'
-import { promisify } from 'util'
 import { readHeader, chunkReader } from './decoder.js'
 import { createHeader } from './encoder.js'
+import { fsread, fswrite, hasFS } from './promise-fs-opts.js'
 import { CarWriter as BrowserCarWriter } from './writer-browser.js'
 
-const fsread = promisify(fs.read)
-const fswrite = promisify(fs.write)
-
 /**
  * @typedef {import('multiformats/cid').CID} CID
  * @typedef {import('./api').BlockWriter} BlockWriter
+ * @typedef {import('fs').promises.FileHandle} FileHandle
  */
 
 /**
@@ -35,7 +32,7 @@ export class CarWriter extends BrowserCarWriter {
    * @async
    * @static
    * @memberof CarWriter
-   * @param {fs.promises.FileHandle | number} fd - A file descriptor from the
+   * @param {FileHandle | number} fd - A file descriptor from the
    * Node.js `fs` module. Either an integer, from `fs.open()` or a `FileHandle`
    * from `fs.promises.open()`.
    * @param {CID[]} roots - A new list of roots to replace the existing list in
@@ -81,4 +78,4 @@ export class CarWriter extends BrowserCarWriter {
   }
 }
 
-export const __browser = false
+export const __browser = !hasFS