@themartiancompany/opfs 1.8.11 → 2.0.1

package/README.md

@@ -19,7 +19,7 @@
 [comment]: <> (License along with this program.)
 [comment]: <> (If not, see <https://www.gnu.org/licenses/>.)
 
-# Origin Private File System module (`@themartiancompany/opfs`)
+# OPFS Module (`@themartiancompany/opfs`)
 
 [![NPM version](
   https://img.shields.io/npm/v/@themartiancompany/opfs.svg)](
@@ -29,63 +29,17 @@
   https://img.shields.io/badge/lang-cn-red.svg)](
   README.cn.md)
 
-Browser-compatible `fs` module leveraging the
-[Origin Private File System](
-  https://developer.mozilla.org/en-US/docs/Web/API/File_System_API/Origin_private_file_system)
-(OPFS) specification  which references the
-[Deno Runtime File System](
-  https://deno.land/api#File_System) and
-[Deno `@std/fs`](
-  https://jsr.io/@std/fs)
-APIs.
+Browser-compatible `fs` module obtained combining the
+[Happy OPFS](
+  https://github.com/themartiancompany/happy-opfs)
+and the
+[OPFS Tools](
+  https://github.com/hughfenghen/opfs-tools).
 
 OPFS stands for *origin private file system* 
 and it is a file system API for manipulating local
 files in a browser environment.
 
-There are significant differences between the
-standard OPFS API and familiar file system APIs
-based on path operations, such as those of
-Node.js and Deno.
-The purpose of this module is to implement an API
-similar to those in the browser, allowing for
-convenient file operations.
-
-The return values of asynchronous APIs are of the
-[Result](
-  https://github.com/JiangJie/happy-rusty)
-type, similar to Rust's `Result` enum type,
-providing a more user-friendly error handling approach.
-
-As to why the library targets Deno, that's because:
-
-- early versions of the Node.js fs API were based
-  on callback syntax, although newer versions support
-  Promise syntax;
-  on the other hand, the Deno fs API was designed from
-  the beginning with Promise syntax. Therefore, Deno has
-  less historical baggage, making it a more suitable choice
-  for implementing a native-compatible API;
-- Deno natively supports TypeScript, while Node.js
-  currently does not without the use of additional tools.
-
-Originally based on the 
-[Happy OPFS](
-  https://github.com/JiangJie/happy-opfs)
-module by Jian Jie and renamed
-because I've noticed there was no
-`fs.createReadStream` implementation,
-while the other available
-[OPFS Tools](
-  https://github.com/hughfenghen/opfs-tools)
-module had but didn't call it verbatim
-so I've thought it may have
-been appropriate to make everybody including
-the module potentially less happy and check
-whether if a third module including the function
-and simply called `opfs` can show how much the
-`namespace/package` model works on the field.
-
 ## Installation
 
 To install a locally built version of the
@@ -136,44 +90,16 @@ npm \
     "@themartiancompany/opfs"
 ```
 
-## Synchronous support
-
-> [!NOTE]
-The asynchronous interface is to be preferred
-because the main thread does not provide a synchronous interface,
-so in order to force the implementation of synchronous syntax,
-the I/O operation needs to be moved a
-[`Worker`](
-  https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API),
-and the main thread needs to be blocked until the
-`Worker` completes its I/O operation, which obviously
-causes performance loss.
-
-Also since the `Worker` needs to be started first
-the synchronous interface can only be used after start completion,
-such that any reading and writing before that will fail.
-
-**Please note** that in order to share data
-between the main thread and the `Worker`,
-`SharedArrayBuffer` needs to be used and so
-two additional `HTTP Response Headers` are required for this:
-`'Cross-Origin-Opener-Policy': 'same-origin'`
-and
-`'Cross-Origin-Embedder-Policy': 'require-corp'`,
-otherwise a `ReferenceError: SharedArrayBuffer is not defined`
-error will be thrown.
-
-The headers are automatically set up respectively by
-Parcel and Serve in the Typescript and
-Javascript examples below.
-
-## Examples
+### Documentation
 
-To visually inspect file system status in-browser
-it is available the
-[OPFS Explorer](
-  https://chromewebstore.google.com/detail/acndjpgkpaclldomagafnognkcgjignd)
-extension.
+For API documentation
+refer to the
+[Happy OPFS](
+  https://github.com/themartiancompany/happy-opfs/blob/main/docs/README.md),
+[OPFS Tools](
+  https://github.com/hughfenghen/opfs-tools/blob/main/docs/api.md) and
+[File System API](
+  https://nodejs.org/api/fs.html).
 
 ### Javascript
 
@@ -198,44 +124,8 @@ libraries.
 Refer to the Ahsi repository for more information
 about installing and running it.
 
-### Typescript
-
-Typescript asynchronous
-([tests/async.ts](
-  tests/async.ts))
-and synchronous examples 
-([tests/sync.ts](
-  tests/sync.ts))
-are made available in the `tests` directory.
-
-To build them and make them available in an
-HTTP server run
-
-```bash
-npm \
-  run \
-    start
-```
-
-then open
-[https://localhost:8443/](
-  https://localhost:8443/)
-in your browser and open the developer
-tools to observe the console output.
-
-## Documentation
-
-Module API is in the
-[docs](
-  docs/README.md)
-directory.
-
 ## License
 
-This software repository by Jian Jie
-and Pellegrino Prevete is released
+This software repository is released
 under the terms of the GNU Affero
 General Public License version 3.
-Portions of the works authored by
-Jian are released under GNU General
-Public License version 3.

package/{src/fs/constants.ts → opfs}

@@ -1,4 +1,6 @@
-// SPDX-License-Identifier: GPL-3.0-or-later
+#!/usr/bin/env node
+
+// SPDX-License-Identifier: AGPL-3.0-or-later
 
 /**    ----------------------------------------------------------------------
  *     Copyright ©
@@ -24,40 +26,49 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-export { ABORT_ERROR,
-         TIMEOUT_ERROR } from '@happy-ts/fetch-t';
+const
+  _opfs =
+    require(
+      "happy-opfs");
+const
+  _opfs_tools =
+    require(
+      "opfs-tools");
+_file =
+  _opfs_tools.file;
 
-/**
- * A constant representing the error thrown when a
- * file or directory is not found.
- *
- * Name of DOMException.NOT_FOUND_ERR.
- */
-export
+function
+  _read_stream_create(
+    _input_file,
+    _options) {
   const
-    NOT_FOUND_ERROR =
-      'NotFoundError' as const;
+    _file_obj =
+      _file(
+        _input_file);
+    const
+      _writer =
+        _file_obj.createReader();
+  return _writer;
+}
 
-/**
- * A constant representing the root directory path.
- */
-export
+function
+  _read_stream_create(
+    _input_file,
+    _options) {
   const
-    ROOT_DIR =
-      '/' as const;
+    _file_obj =
+      _file(
+        _input_file);
+    const
+      _writer =
+        _file_obj.createWriter();
+  return _writer;
+}
 
-/**
- * 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;
+module.exports =
+  _opfs;
+module.exports.createReadStream =
+  _read_stream_create;
+module.exports.createWriteStream =
+  _write_stream_create;

package/package.json

@@ -4,31 +4,23 @@
   "description":
     "Browser-compatible (OPFS) Node/Deno 'fs' module.",
   "version":
-    "1.8.11",
+    "2.0.1",
   "homepage":
     "https://github.com/themartiancompany/opfs",
   "license":
-    "GPL-3.0",
+    "AGPL-3.0",
   "bugs": {
     "url":
       "https://github.com/themartiancompany/opfs/issues"
   },
-  "author": {
-    "name":
-      "Jiang Jie",
-    "email":
-      "jiang115jie@gmail.com",
-    "url":
-      "https://github.com/JiangJie"
+  "author":
+    { "name":
+        "Pellegrino Prevete",
+      "email":
+        "pellegrinoprevete@gmail.com",
+      "url":
+        "https://github.com/tallero"
   },
-  "contributors": [ {
-    "name":
-      "Pellegrino Prevete",
-    "email":
-      "pellegrinoprevete@gmail.com",
-    "url":
-      "https://github.com/tallero"
-  } ],
   "keywords": [
     "fs",
     "system",
@@ -50,41 +42,28 @@
   "files": [
     "COPYING",
     "README.md",
-    "README.cn.md",
-    "package.json",
-    "docs",
-    "src",
-    "dist"
+    "opfs",
+    "package.json"
   ],
   "source":
     "src/mod.ts",
   "man":
     "man/opfs.1",
   "main":
-    "dist/main.cjs",
+    "opfs",
   "module":
-    "dist/main.mjs",
-  "types":
-    "dist/types.d.ts",
+    "opfs",
   "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",
+      "npm run lint",
     "build":
-      "npm install --save-dev && npx rollup --config rollup.config.mjs",
+      "npm install --save-dev",
     "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"
+      "typedoc"
   },
   "repository": {
     "type": "git",
@@ -93,49 +72,13 @@
   "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"
+      "^9.32.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
+    "happy-opfs":
+      "npm:@themartiancompany/happy-opfs@^1.8.12",
+    "opfs-tools":
+      "0.7.4"
   }
 }