@remix-run/file-storage 0.13.0 → 0.13.2

package/dist/lib/backends/fs.js

@@ -1,7 +1,7 @@
 import * as fs from 'node:fs';
 import * as fsp from 'node:fs/promises';
 import * as path from 'node:path';
-import { openFile, writeFile } from '@remix-run/fs';
+import { openLazyFile, writeFile } from '@remix-run/fs';
 /**
  * Creates a `FileStorage` that is backed by a filesystem directory using node:fs.
  *
@@ -52,7 +52,7 @@ export function createFsFileStorage(directory) {
         };
         await fsp.writeFile(metaPath, JSON.stringify(meta));
         let metaData = await readMetadata(metaPath);
-        return openFile(filePath, {
+        return openLazyFile(filePath, {
             lastModified: metaData.lastModified,
             name: metaData.name,
             type: metaData.type,
@@ -63,7 +63,7 @@ export function createFsFileStorage(directory) {
             let { filePath, metaPath } = await getPaths(key);
             try {
                 let meta = await readMetadata(metaPath);
-                return openFile(filePath, {
+                return openLazyFile(filePath, {
                     lastModified: meta.lastModified,
                     name: meta.name,
                     type: meta.type,

package/dist/lib/file-storage.d.ts

@@ -4,12 +4,14 @@
 export interface FileStorage {
     /**
      * Get a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) at the given key.
+     *
      * @param key The key to look up
      * @returns The file with the given key, or `null` if no such key exists
      */
     get(key: string): File | null | Promise<File | null>;
     /**
      * Check if a file with the given key exists.
+     *
      * @param key The key to look up
      * @returns `true` if a file with the given key exists, `false` otherwise
      */
@@ -75,28 +77,32 @@ export interface FileStorage {
      */
     list<T extends ListOptions>(options?: T): ListResult<T> | Promise<ListResult<T>>;
     /**
-     * Put a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) in storage and return
-     * a new file backed by this storage.
+     * Put a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) in storage and return a
+     * new file backed by this storage.
+     *
      * @param key The key to store the file under
      * @param file The file to store
-     * @returns A new File object backed by this storage
+     * @returns A new `File` object backed by this storage
      */
     put(key: string, file: File): File | Promise<File>;
     /**
      * Remove the file with the given key from storage.
+     *
      * @param key The key to remove
-     * @returns A promise that resolves when the file has been removed
      */
     remove(key: string): void | Promise<void>;
     /**
      * Put a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) in storage at the given
      * key.
+     *
      * @param key The key to store the file under
      * @param file The file to store
-     * @returns A promise that resolves when the file has been stored
      */
     set(key: string, file: File): void | Promise<void>;
 }
+/**
+ * A reference to a file in storage by its key.
+ */
 export interface FileKey {
     /**
      * The key of the file in storage.
@@ -124,6 +130,9 @@ export interface FileMetadata extends FileKey {
      */
     type: string;
 }
+/**
+ * Options for listing files in storage.
+ */
 export interface ListOptions {
     /**
      * An opaque string that allows you to paginate over the keys in storage.
@@ -142,6 +151,9 @@ export interface ListOptions {
      */
     prefix?: string;
 }
+/**
+ * The result of listing files in storage.
+ */
 export interface ListResult<T extends ListOptions> {
     /**
      * An opaque string that allows you to paginate over the keys in storage. Pass this back in the

package/dist/lib/file-storage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"file-storage.d.ts","sourceRoot":"","sources":["../../src/lib/file-storage.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,CAAA;IACpD;;;;OAIG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;IACH,IAAI,CAAC,CAAC,SAAS,WAAW,EAAE,OAAO,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;IAChF;;;;;;OAMG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAClD;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzC;;;;;;OAMG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACnD;AAED,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,OAAO;IAC3C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,WAAW;IAC/C;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,KAAK,EAAE,CAAC,CAAC,SAAS;QAAE,eAAe,EAAE,IAAI,CAAA;KAAE,GAAG,YAAY,GAAG,OAAO,CAAC,EAAE,CAAA;CACxE"}
+{"version":3,"file":"file-storage.d.ts","sourceRoot":"","sources":["../../src/lib/file-storage.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,CAAA;IACpD;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;IACH,IAAI,CAAC,CAAC,SAAS,WAAW,EAAE,OAAO,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;IAChF;;;;;;;OAOG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAClD;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzC;;;;;;OAMG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,OAAO;IAC3C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,WAAW;IAC/C;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,KAAK,EAAE,CAAC,CAAC,SAAS;QAAE,eAAe,EAAE,IAAI,CAAA;KAAE,GAAG,YAAY,GAAG,OAAO,CAAC,EAAE,CAAA;CACxE"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remix-run/file-storage",
-  "version": "0.13.0",
+  "version": "0.13.2",
   "description": "Key/value storage for JavaScript File objects",
   "author": "Michael Jackson <mjijackson@gmail.com>",
   "repository": {
@@ -33,14 +33,14 @@
     },
     "./package.json": "./package.json"
   },
-  "peerDependencies": {
-    "@remix-run/fs": "^0.1.0",
-    "@remix-run/lazy-file": "^4.0.0"
+  "dependencies": {
+    "@remix-run/fs": "^0.4.1",
+    "@remix-run/lazy-file": "^5.0.1"
   },
   "devDependencies": {
     "@types/node": "^24.6.0",
-    "typescript": "^5.9.3",
-    "@remix-run/form-data-parser": "^0.14.0"
+    "@typescript/native-preview": "7.0.0-dev.20251125.1",
+    "@remix-run/form-data-parser": "0.14.0"
   },
   "keywords": [
     "file",
@@ -49,9 +49,9 @@
     "fs"
   ],
   "scripts": {
-    "build": "tsc -p tsconfig.build.json",
+    "build": "tsgo -p tsconfig.build.json",
     "clean": "git clean -fdX",
-    "test": "node --disable-warning=ExperimentalWarning --test './src/**/*.test.ts'",
-    "typecheck": "tsc --noEmit"
+    "test": "node --disable-warning=ExperimentalWarning --test",
+    "typecheck": "tsgo --noEmit"
   }
 }

package/src/lib/backends/fs.ts

@@ -1,7 +1,7 @@
 import * as fs from 'node:fs'
 import * as fsp from 'node:fs/promises'
 import * as path from 'node:path'
-import { openFile, writeFile } from '@remix-run/fs'
+import { openLazyFile, writeFile } from '@remix-run/fs'
 
 import type { FileStorage, FileMetadata, ListOptions, ListResult } from '../file-storage.ts'
 
@@ -69,7 +69,7 @@ export function createFsFileStorage(directory: string): FileStorage {
 
     let metaData = await readMetadata(metaPath)
 
-    return openFile(filePath, {
+    return openLazyFile(filePath, {
       lastModified: metaData.lastModified,
       name: metaData.name,
       type: metaData.type,
@@ -83,7 +83,7 @@ export function createFsFileStorage(directory: string): FileStorage {
       try {
         let meta = await readMetadata(metaPath)
 
-        return openFile(filePath, {
+        return openLazyFile(filePath, {
           lastModified: meta.lastModified,
           name: meta.name,
           type: meta.type,

package/src/lib/file-storage.ts

@@ -4,12 +4,14 @@
 export interface FileStorage {
   /**
    * Get a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) at the given key.
+   *
    * @param key The key to look up
    * @returns The file with the given key, or `null` if no such key exists
    */
   get(key: string): File | null | Promise<File | null>
   /**
    * Check if a file with the given key exists.
+   *
    * @param key The key to look up
    * @returns `true` if a file with the given key exists, `false` otherwise
    */
@@ -75,29 +77,33 @@ export interface FileStorage {
    */
   list<T extends ListOptions>(options?: T): ListResult<T> | Promise<ListResult<T>>
   /**
-   * Put a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) in storage and return
-   * a new file backed by this storage.
+   * Put a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) in storage and return a
+   * new file backed by this storage.
+   *
    * @param key The key to store the file under
    * @param file The file to store
-   * @returns A new File object backed by this storage
+   * @returns A new `File` object backed by this storage
    */
   put(key: string, file: File): File | Promise<File>
   /**
    * Remove the file with the given key from storage.
+   *
    * @param key The key to remove
-   * @returns A promise that resolves when the file has been removed
    */
   remove(key: string): void | Promise<void>
   /**
    * Put a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) in storage at the given
    * key.
+   *
    * @param key The key to store the file under
    * @param file The file to store
-   * @returns A promise that resolves when the file has been stored
    */
   set(key: string, file: File): void | Promise<void>
 }
 
+/**
+ * A reference to a file in storage by its key.
+ */
 export interface FileKey {
   /**
    * The key of the file in storage.
@@ -127,6 +133,9 @@ export interface FileMetadata extends FileKey {
   type: string
 }
 
+/**
+ * Options for listing files in storage.
+ */
 export interface ListOptions {
   /**
    * An opaque string that allows you to paginate over the keys in storage.
@@ -146,6 +155,9 @@ export interface ListOptions {
   prefix?: string
 }
 
+/**
+ * The result of listing files in storage.
+ */
 export interface ListResult<T extends ListOptions> {
   /**
    * An opaque string that allows you to paginate over the keys in storage. Pass this back in the