@ricsam/quickjs-fs 0.0.1 → 0.2.0

package/README.md

@@ -1,45 +1,72 @@
 # @ricsam/quickjs-fs
 
-## ⚠️ IMPORTANT NOTICE ⚠️
-
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
-
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
-
-## Purpose
-
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@ricsam/quickjs-fs`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**
+File System Access API (OPFS-compatible).
+
+```typescript
+import { setupFs, createNodeDirectoryHandle } from "@ricsam/quickjs-fs";
+
+const handle = setupFs(context, {
+  getDirectory: async (path) => {
+    // Validate path access
+    if (!path.startsWith("/allowed")) {
+      throw new Error("Access denied");
+    }
+    return createNodeDirectoryHandle(`./sandbox${path}`);
+  },
+});
+```
+
+**Injected Globals:**
+- `fs.getDirectory(path)` - Entry point for file system access
+- `FileSystemDirectoryHandle`, `FileSystemFileHandle`
+- `FileSystemWritableFileStream`
+
+**Usage in QuickJS:**
+
+```javascript
+// Get directory handle
+const root = await fs.getDirectory("/data");
+
+// Read a file
+const fileHandle = await root.getFileHandle("config.json");
+const file = await fileHandle.getFile();
+const text = await file.text();
+const config = JSON.parse(text);
+
+// Write a file
+const outputHandle = await root.getFileHandle("output.txt", { create: true });
+const writable = await outputHandle.createWritable();
+await writable.write("Hello, World!");
+await writable.close();
+
+// Directory operations
+const subDir = await root.getDirectoryHandle("subdir", { create: true });
+await root.removeEntry("old-file.txt");
+await root.removeEntry("old-dir", { recursive: true });
+
+// Iterate directory
+for await (const [name, handle] of root.entries()) {
+  console.log(name, handle.kind); // "file" or "directory"
+}
+```
+
+#### Host Adapters
+
+**Node.js/Bun adapter:**
+
+```typescript
+import { createNodeDirectoryHandle } from "@ricsam/quickjs-fs";
+
+const dirHandle = createNodeDirectoryHandle("/path/to/directory");
+```
+
+**In-memory adapter (for testing):**
+
+```typescript
+import { createMemoryDirectoryHandle } from "@ricsam/quickjs-fs";
+
+const memFs = createMemoryDirectoryHandle({
+  "config.json": JSON.stringify({ debug: true }),
+  "data/users.json": JSON.stringify([]),
+});
+```

package/dist/cjs/index.cjs

@@ -0,0 +1,43 @@
+// @bun @bun-cjs
+(function(exports, require, module, __filename, __dirname) {var __defProp = Object.defineProperty;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __moduleCache = /* @__PURE__ */ new WeakMap;
+var __toCommonJS = (from) => {
+  var entry = __moduleCache.get(from), desc;
+  if (entry)
+    return entry;
+  entry = __defProp({}, "__esModule", { value: true });
+  if (from && typeof from === "object" || typeof from === "function")
+    __getOwnPropNames(from).map((key) => !__hasOwnProp.call(entry, key) && __defProp(entry, key, {
+      get: () => from[key],
+      enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+    }));
+  __moduleCache.set(from, entry);
+  return entry;
+};
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, {
+      get: all[name],
+      enumerable: true,
+      configurable: true,
+      set: (newValue) => all[name] = () => newValue
+    });
+};
+
+// packages/fs/src/index.ts
+var exports_src = {};
+__export(exports_src, {
+  setupFs: () => import_setup.setupFs,
+  createNodeDirectoryHandle: () => import_node_adapter.createNodeDirectoryHandle,
+  createMemoryDirectoryHandle: () => import_memory_adapter.createMemoryDirectoryHandle
+});
+module.exports = __toCommonJS(exports_src);
+var import_setup = require("./setup.ts");
+var import_node_adapter = require("./node-adapter.ts");
+var import_memory_adapter = require("./memory-adapter.ts");
+})
+
+//# debugId=A9E29D78C7B0FEDC64756E2164756E21

package/dist/cjs/index.cjs.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "sources": ["../../src/index.ts"],
+  "sourcesContent": [
+    "export { setupFs } from \"./setup.ts\";\nexport { createNodeDirectoryHandle } from \"./node-adapter.ts\";\nexport { createMemoryDirectoryHandle } from \"./memory-adapter.ts\";\n\nexport type {\n  SetupFsOptions,\n  FsHandle,\n  HostDirectoryHandle,\n  HostFileHandle,\n  HostWritableFileStream,\n  WriteParams,\n} from \"./types.ts\";\n"
+  ],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAwB,IAAxB;AAC0C,IAA1C;AAC4C,IAA5C;",
+  "debugId": "A9E29D78C7B0FEDC64756E2164756E21",
+  "names": []
+}

package/dist/cjs/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "@ricsam/quickjs-fs",
+  "version": "0.2.0",
+  "type": "commonjs"
+}

package/dist/mjs/index.mjs

@@ -0,0 +1,12 @@
+// @bun
+// packages/fs/src/index.ts
+import { setupFs } from "./setup.ts";
+import { createNodeDirectoryHandle } from "./node-adapter.ts";
+import { createMemoryDirectoryHandle } from "./memory-adapter.ts";
+export {
+  setupFs,
+  createNodeDirectoryHandle,
+  createMemoryDirectoryHandle
+};
+
+//# debugId=DF39C017335E76D064756E2164756E21

package/dist/mjs/index.mjs.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "sources": ["../../src/index.ts"],
+  "sourcesContent": [
+    "export { setupFs } from \"./setup.ts\";\nexport { createNodeDirectoryHandle } from \"./node-adapter.ts\";\nexport { createMemoryDirectoryHandle } from \"./memory-adapter.ts\";\n\nexport type {\n  SetupFsOptions,\n  FsHandle,\n  HostDirectoryHandle,\n  HostFileHandle,\n  HostWritableFileStream,\n  WriteParams,\n} from \"./types.ts\";\n"
+  ],
+  "mappings": ";;AAAA;AACA;AACA;",
+  "debugId": "DF39C017335E76D064756E2164756E21",
+  "names": []
+}

package/dist/mjs/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "@ricsam/quickjs-fs",
+  "version": "0.2.0",
+  "type": "module"
+}

package/dist/types/handles/directory-handle.d.ts

@@ -0,0 +1,12 @@
+import type { StateMap } from "@ricsam/quickjs-core";
+import type { QuickJSContext, QuickJSHandle } from "quickjs-emscripten";
+import type { HostDirectoryHandle } from "../types.ts";
+export declare const pendingHostHandles: Map<number, {
+    handle: HostDirectoryHandle;
+    name: string;
+}>;
+export declare function registerHostDirectoryHandle(handle: HostDirectoryHandle): number;
+/**
+ * Create the FileSystemDirectoryHandle class for QuickJS
+ */
+export declare function createFileSystemDirectoryHandleClass(context: QuickJSContext, stateMap: StateMap): QuickJSHandle;

package/dist/types/handles/file-handle.d.ts

@@ -0,0 +1,14 @@
+import type { QuickJSContext, QuickJSHandle } from "quickjs-emscripten";
+import type { StateMap } from "@ricsam/quickjs-core";
+import type { HostFileHandle, HostWritableFileStream } from "../types.ts";
+export declare const pendingFileHandles: Map<number, {
+    handle: HostFileHandle;
+    name: string;
+}>;
+export declare const pendingWritableStreams: Map<number, HostWritableFileStream>;
+export declare function registerHostFileHandle(handle: HostFileHandle): number;
+export declare function registerHostWritableStream(stream: HostWritableFileStream): number;
+/**
+ * Create the FileSystemFileHandle class for QuickJS
+ */
+export declare function createFileSystemFileHandleClass(context: QuickJSContext, stateMap: StateMap): QuickJSHandle;

package/dist/types/handles/writable-stream.d.ts

@@ -0,0 +1,6 @@
+import type { QuickJSContext, QuickJSHandle } from "quickjs-emscripten";
+import type { StateMap } from "@ricsam/quickjs-core";
+/**
+ * Create the FileSystemWritableFileStream class for QuickJS
+ */
+export declare function createFileSystemWritableFileStreamClass(context: QuickJSContext, stateMap: StateMap): QuickJSHandle;

package/dist/types/index.d.ts

@@ -0,0 +1,4 @@
+export { setupFs } from "./setup.ts";
+export { createNodeDirectoryHandle } from "./node-adapter.ts";
+export { createMemoryDirectoryHandle } from "./memory-adapter.ts";
+export type { SetupFsOptions, FsHandle, HostDirectoryHandle, HostFileHandle, HostWritableFileStream, WriteParams, } from "./types.ts";

package/dist/types/memory-adapter.d.ts

@@ -0,0 +1,18 @@
+import type { HostDirectoryHandle } from "./types.ts";
+/**
+ * Create an in-memory directory handle
+ * Useful for testing or fully sandboxed environments
+ *
+ * @example
+ * import { createMemoryDirectoryHandle } from "@ricsam/quickjs-fs";
+ *
+ * const memFs = createMemoryDirectoryHandle({
+ *   "config.json": JSON.stringify({ debug: true }),
+ *   "data/users.json": JSON.stringify([]),
+ * });
+ *
+ * const handle = setupFs(context, {
+ *   getDirectory: async (path) => memFs
+ * });
+ */
+export declare function createMemoryDirectoryHandle(initialFiles?: Record<string, string | Uint8Array>): HostDirectoryHandle;

package/dist/types/node-adapter.d.ts

@@ -0,0 +1,23 @@
+import type { HostDirectoryHandle } from "./types.ts";
+/**
+ * Create a directory handle backed by Node.js/Bun fs
+ * Useful for server-side implementations
+ *
+ * @param rootPath - Absolute path to the directory on disk
+ * @returns A HostDirectoryHandle implementation
+ *
+ * @example
+ * import { createNodeDirectoryHandle } from "@ricsam/quickjs-fs";
+ *
+ * const handle = setupFs(context, {
+ *   getDirectory: async (path) => {
+ *     // Only allow access to /sandbox
+ *     if (!path.startsWith("/sandbox")) {
+ *       throw new Error("Access denied");
+ *     }
+ *     const realPath = path.replace("/sandbox", "/var/app/sandbox");
+ *     return createNodeDirectoryHandle(realPath);
+ *   }
+ * });
+ */
+export declare function createNodeDirectoryHandle(rootPath: string): HostDirectoryHandle;

package/dist/types/setup.d.ts

@@ -0,0 +1,56 @@
+import type { QuickJSContext } from "quickjs-emscripten";
+import type { SetupFsOptions, FsHandle } from "./types.ts";
+/**
+ * Setup File System API in a QuickJS context
+ *
+ * Injects the following globals:
+ * - fs.getDirectory(path) - Server-compatible entry point
+ * - FileSystemFileHandle
+ * - FileSystemDirectoryHandle
+ * - FileSystemWritableFileStream
+ *
+ * **Private globals (internal use):**
+ * - `__FileSystemFileHandle__` - For creating file handle instances from wrapper code
+ * - `__FileSystemDirectoryHandle__` - For creating directory handle instances
+ * - `__FileSystemWritableFileStream__` - For creating writable stream instances
+ *
+ * These private globals follow the `__Name__` convention and are required for the
+ * wrapper pattern: public methods call internal methods that return IDs, then use
+ * evalCode with private constructors to create properly-typed class instances.
+ * See PATTERNS.md sections 2 and 5 for details.
+ *
+ * **Wrapper pattern example:**
+ * ```typescript
+ * // Public method (added via evalCode)
+ * FileSystemFileHandle.prototype.createWritable = async function(options) {
+ *   const result = await this._createWritableInternal(options);
+ *   return new __FileSystemWritableFileStream__(result.__writableStreamId);
+ * };
+ * ```
+ *
+ * @example
+ * import { setupFs, createNodeDirectoryHandle } from "@ricsam/quickjs-fs";
+ *
+ * const handle = setupFs(context, {
+ *   getDirectory: async (path) => {
+ *     // Validate and resolve path
+ *     const resolvedPath = resolveSandboxPath(path);
+ *     return createNodeDirectoryHandle(resolvedPath);
+ *   }
+ * });
+ *
+ * context.evalCode(`
+ *   const root = await fs.getDirectory("/data");
+ *   const configHandle = await root.getFileHandle("config.json");
+ *   const file = await configHandle.getFile();
+ *   const text = await file.text();
+ *   console.log(JSON.parse(text));
+ *
+ *   // Write a new file
+ *   const outputHandle = await root.getFileHandle("output.txt", { create: true });
+ *   const writable = await outputHandle.createWritable();
+ *   await writable.write("Hello, World!");
+ *   await writable.close();
+ * `);
+ */
+export declare function setupFs(context: QuickJSContext, options: SetupFsOptions): FsHandle;

package/dist/types/types.d.ts

@@ -0,0 +1,85 @@
+import type { StateMap, CoreHandle } from "@ricsam/quickjs-core";
+export type { StateMap, CoreHandle };
+/**
+ * Host-side directory handle interface
+ * Implement this to provide file system access to QuickJS
+ */
+export interface HostDirectoryHandle {
+    readonly kind: "directory";
+    readonly name: string;
+    getFileHandle(name: string, options?: {
+        create?: boolean;
+    }): Promise<HostFileHandle>;
+    getDirectoryHandle(name: string, options?: {
+        create?: boolean;
+    }): Promise<HostDirectoryHandle>;
+    removeEntry(name: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
+    resolve(possibleDescendant: HostFileHandle | HostDirectoryHandle): Promise<string[] | null>;
+    entries(): AsyncIterable<[string, HostFileHandle | HostDirectoryHandle]>;
+    keys(): AsyncIterable<string>;
+    values(): AsyncIterable<HostFileHandle | HostDirectoryHandle>;
+}
+/**
+ * Host-side file handle interface
+ */
+export interface HostFileHandle {
+    readonly kind: "file";
+    readonly name: string;
+    getFile(): Promise<File>;
+    createWritable(options?: {
+        keepExistingData?: boolean;
+    }): Promise<HostWritableFileStream>;
+}
+/**
+ * Host-side writable file stream interface
+ */
+export interface HostWritableFileStream {
+    write(data: string | ArrayBuffer | Uint8Array | Blob | WriteParams): Promise<void>;
+    seek(position: number): Promise<void>;
+    truncate(size: number): Promise<void>;
+    close(): Promise<void>;
+    abort(reason?: unknown): Promise<void>;
+}
+export interface WriteParams {
+    type: "write" | "seek" | "truncate";
+    data?: string | ArrayBuffer | Uint8Array | Blob;
+    position?: number;
+    size?: number;
+}
+export interface SetupFsOptions {
+    /**
+     * Handler to resolve paths to directory handles
+     * This is the server-side entry point for file system access
+     *
+     * @param path - The path requested by QuickJS code
+     * @returns A directory handle rooted at this path
+     * @throws If the path is not allowed or doesn't exist
+     */
+    getDirectory: (path: string) => Promise<HostDirectoryHandle>;
+    /** Existing state map */
+    stateMap?: StateMap;
+    /** Existing core handle */
+    coreHandle?: CoreHandle;
+}
+export interface FsHandle {
+    /** State map containing internal states */
+    readonly stateMap: StateMap;
+    /** Dispose all handles */
+    dispose(): void;
+}
+export interface FileSystemFileHandleState {
+    kind: "file";
+    name: string;
+    hostHandle: HostFileHandle;
+}
+export interface FileSystemDirectoryHandleState {
+    kind: "directory";
+    name: string;
+    hostHandle: HostDirectoryHandle;
+}
+export interface FileSystemWritableFileStreamState {
+    hostStream: HostWritableFileStream;
+    closed: boolean;
+}

package/package.json

@@ -1,10 +1,55 @@
 {
   "name": "@ricsam/quickjs-fs",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @ricsam/quickjs-fs",
+  "version": "0.2.0",
+  "main": "./dist/cjs/index.cjs",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "require": "./dist/cjs/index.cjs",
+      "import": "./dist/mjs/index.mjs"
+    }
+  },
+  "scripts": {
+    "build": "bun build ./src/index.ts --outdir ./dist --target bun",
+    "test": "bun test",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@ricsam/quickjs-core": "^0.2.0",
+    "quickjs-emscripten": "^0.31.0"
+  },
+  "peerDependencies": {
+    "quickjs-emscripten": "^0.31.0"
+  },
+  "author": "Richard Samuelsson",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ricsam/richie-qjs.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ricsam/richie-qjs/issues"
+  },
+  "homepage": "https://github.com/ricsam/richie-qjs#readme",
   "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
+    "quickjs",
+    "sandbox",
+    "javascript",
+    "runtime",
+    "fetch",
+    "filesystem",
+    "streams",
+    "wasm",
+    "emscripten"
+  ],
+  "description": "File system API implementation for QuickJS runtime",
+  "module": "./dist/mjs/index.mjs",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "README.md"
   ]
-}
+}