@themartiancompany/opfs 1.8.11

package/docs/interfaces/ZipOptions.md

@@ -0,0 +1,17 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / ZipOptions
+
+# Interface: ZipOptions
+
+Defined in: fs/defines.ts:279
+
+Options for `zip`.
+
+## Properties
+
+| Property | Type | Default value | Description | Defined in |
+| ------ | ------ | ------ | ------ | ------ |
+| <a id="preserveroot"></a> `preserveRoot` | `boolean` | `true` | Whether to preserve the root directory in the zip file. | fs/defines.ts:284 |

package/docs/type-aliases/FileEncoding.md

@@ -0,0 +1,15 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / FileEncoding
+
+# Type Alias: FileEncoding
+
+```ts
+type FileEncoding = "binary" | "utf8" | "blob";
+```
+
+Defined in: fs/defines.ts:105
+
+Supported file encodings for reading and writing files.

package/docs/type-aliases/FsRequestInit.md

@@ -0,0 +1,15 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / FsRequestInit
+
+# Type Alias: FsRequestInit
+
+```ts
+type FsRequestInit = Omit<FetchInit, "abortable" | "responseType">;
+```
+
+Defined in: fs/defines.ts:113
+
+fetch-t options for download and upload.

package/docs/type-aliases/ReadFileContent.md

@@ -0,0 +1,15 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / ReadFileContent
+
+# Type Alias: ReadFileContent
+
+```ts
+type ReadFileContent = ArrayBuffer | File | string;
+```
+
+Defined in: fs/defines.ts:48
+
+Represents the possible content types that can be read from a file.

package/docs/type-aliases/WriteFileContent.md

@@ -0,0 +1,15 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / WriteFileContent
+
+# Type Alias: WriteFileContent
+
+```ts
+type WriteFileContent = BufferSource | Blob | string;
+```
+
+Defined in: fs/defines.ts:32
+
+Represents the possible content types that can be written to a file.

package/docs/type-aliases/WriteSyncFileContent.md

@@ -0,0 +1,16 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / WriteSyncFileContent
+
+# Type Alias: WriteSyncFileContent
+
+```ts
+type WriteSyncFileContent = BufferSource | string;
+```
+
+Defined in: fs/defines.ts:41
+
+Represents the possible content types that can be
+written synchronously to a file.

package/docs/variables/CURRENT_DIR.md

@@ -0,0 +1,15 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / CURRENT\_DIR
+
+# Variable: CURRENT\_DIR
+
+```ts
+const CURRENT_DIR: ".";
+```
+
+Defined in: fs/constants.ts:54
+
+A constant representing the current directory path.

package/docs/variables/NOT_FOUND_ERROR.md

@@ -0,0 +1,18 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / NOT\_FOUND\_ERROR
+
+# Variable: NOT\_FOUND\_ERROR
+
+```ts
+const NOT_FOUND_ERROR: "NotFoundError";
+```
+
+Defined in: fs/constants.ts:38
+
+A constant representing the error thrown when a
+file or directory is not found.
+
+Name of DOMException.NOT_FOUND_ERR.

package/docs/variables/ROOT_DIR.md

@@ -0,0 +1,15 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / ROOT\_DIR
+
+# Variable: ROOT\_DIR
+
+```ts
+const ROOT_DIR: "/";
+```
+
+Defined in: fs/constants.ts:46
+
+A constant representing the root directory path.

package/docs/variables/TMP_DIR.md

@@ -0,0 +1,15 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / TMP\_DIR
+
+# Variable: TMP\_DIR
+
+```ts
+const TMP_DIR: "/tmp";
+```
+
+Defined in: fs/constants.ts:62
+
+A constant representing the temporary directory path.

package/package.json

@@ -0,0 +1,141 @@
+{
+  "name":
+    "@themartiancompany/opfs",
+  "description":
+    "Browser-compatible (OPFS) Node/Deno 'fs' module.",
+  "version":
+    "1.8.11",
+  "homepage":
+    "https://github.com/themartiancompany/opfs",
+  "license":
+    "GPL-3.0",
+  "bugs": {
+    "url":
+      "https://github.com/themartiancompany/opfs/issues"
+  },
+  "author": {
+    "name":
+      "Jiang Jie",
+    "email":
+      "jiang115jie@gmail.com",
+    "url":
+      "https://github.com/JiangJie"
+  },
+  "contributors": [ {
+    "name":
+      "Pellegrino Prevete",
+    "email":
+      "pellegrinoprevete@gmail.com",
+    "url":
+      "https://github.com/tallero"
+  } ],
+  "keywords": [
+    "fs",
+    "system",
+    "file",
+    "directory",
+    "opfs",
+    "origin",
+    "private",
+    "worker",
+    "sync",
+    "async",
+    "upload",
+    "download",
+    "zip",
+    "unzip"
+  ],
+  "type":
+    "module",
+  "files": [
+    "COPYING",
+    "README.md",
+    "README.cn.md",
+    "package.json",
+    "docs",
+    "src",
+    "dist"
+  ],
+  "source":
+    "src/mod.ts",
+  "man":
+    "man/opfs.1",
+  "main":
+    "dist/main.cjs",
+  "module":
+    "dist/main.mjs",
+  "types":
+    "dist/types.d.ts",
+  "sideEffects":
+    false,
+  "scripts": {
+    "clean":
+      "npx dlx rimraf .parcel-cache dist",
+    "check":
+      "npx tsc --noEmit",
+    "lint":
+      "npx eslint .",
+    "prebuild":
+      "npx rimraf dist && npm run check && npm run lint",
+    "build":
+      "npm install --save-dev && npx rollup --config rollup.config.mjs",
+    "docs":
+      "typedoc",
+    "prepublishOnly":
+      "npx rollup --config rollup.config.mjs",
+    "start":
+      "npx parcel serve tests/index.html --dist-dir dist/dev --port 8443 --https --no-cache"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/themartiancompany/opfs.git"
+  },
+  "devDependencies": {
+    "@eslint/js":
+      "^9.32.0",
+    "@parcel/packager-ts":
+      "^2.16.0",
+    "@parcel/transformer-typescript-types":
+      "^2.16.0",
+    "dlx":
+      "^0.2.1",
+    "eslint":
+      "^9.32.0",
+    "parcel":
+      "^2.16.0",
+    "rimraf":
+      "^6.1.0",
+    "rollup":
+      "^4.52.5",
+    "rollup-plugin-dts":
+      "^6.2.1",
+    "rollup-plugin-esbuild":
+      "^6.2.1",
+    "typedoc":
+      "^0.27.9",
+    "typedoc-plugin-markdown":
+      "4.4.2",
+    "typescript":
+      "^5.8.3",
+    "typescript-eslint":
+      "^8.38.0"
+  },
+  "dependencies": {
+    "@happy-ts/fetch-t":
+      "^1.3.2",
+    "@std/path":
+      "npm:@themartiancompany/std__path@^1.1.1",
+    "fflate":
+      "^0.8.2",
+    "happy-rusty":
+      "^1.5.0",
+    "tiny-future":
+      "^1.1.0",
+    "tiny-invariant":
+      "^1.3.3"
+  },
+  "@parcel/resolver-default": {
+    "packageExports":
+      true
+  }
+}

package/src/fs/assertions.ts

@@ -0,0 +1,63 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+/**    ----------------------------------------------------------------------
+ *     Copyright ©
+ *       Jiang Jie
+ *         2024, 2025
+ *       Pellegrino Prevete
+ *         2025
+ * 
+ *     All rights reserved
+ *     ----------------------------------------------------------------------
+ * 
+ *     This program is free software: you can redistribute it and/or modify
+ *     it under the terms of the GNU General Public License as published by
+ *     the Free Software Foundation, either version 3 of the License, or
+ *     (at your option) any later version.
+ * 
+ *     This program is distributed in the hope that it will be useful,
+ *     but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *     GNU General Public License for more details.
+ * 
+ *     You should have received a copy of the GNU General Public License
+ *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+import invariant from 'tiny-invariant';
+import { ROOT_DIR } from './constants.ts';
+
+/**
+ * Asserts that the provided path is an absolute path.
+ *
+ * @param path - The file path to validate.
+ * @throws Will throw an error if the path is not an absolute path.
+ */
+export function
+  assertAbsolutePath(
+    path:
+      string): void {
+    invariant(
+    typeof path === 'string',
+    () => `Path must be a string but received ${ path }`);
+    invariant(
+      path[
+        0] === ROOT_DIR,
+      () => `Path must start with / but received ${ path }`);
+}
+
+/**
+ * Asserts that the provided URL is a valid file URL.
+ *
+ * @param fileUrl - The file URL to validate.
+ * @throws Will throw an error if the URL is not a valid file URL.
+ */
+export function
+  assertFileUrl(
+    fileUrl:
+      string): void {
+    invariant(
+      typeof fileUrl === 'string',
+      () => `File url must be a string ` +
+            `but received ${ fileUrl }`);
+}

package/src/fs/constants.ts

@@ -0,0 +1,63 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+/**    ----------------------------------------------------------------------
+ *     Copyright ©
+ *       Jiang Jie
+ *         2024, 2025
+ *       Pellegrino Prevete
+ *         2025
+ * 
+ *     All rights reserved
+ *     ----------------------------------------------------------------------
+ * 
+ *     This program is free software: you can redistribute it and/or modify
+ *     it under the terms of the GNU General Public License as published by
+ *     the Free Software Foundation, either version 3 of the License, or
+ *     (at your option) any later version.
+ * 
+ *     This program is distributed in the hope that it will be useful,
+ *     but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *     GNU General Public License for more details.
+ * 
+ *     You should have received a copy of the GNU General Public License
+ *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+export { ABORT_ERROR,
+         TIMEOUT_ERROR } from '@happy-ts/fetch-t';
+
+/**
+ * A constant representing the error thrown when a
+ * file or directory is not found.
+ *
+ * Name of DOMException.NOT_FOUND_ERR.
+ */
+export
+  const
+    NOT_FOUND_ERROR =
+      'NotFoundError' as const;
+
+/**
+ * A constant representing the root directory path.
+ */
+export
+  const
+    ROOT_DIR =
+      '/' as const;
+
+/**
+ * A constant representing the current directory path.
+ */
+export
+  const
+    CURRENT_DIR =
+      '.' as const;
+
+/**
+ * A constant representing the temporary directory path.
+ */
+export
+  const
+    TMP_DIR =
+      '/tmp' as const;