@kubun/blob-node-fs 0.13.0

package/LICENSE.md

@@ -0,0 +1,57 @@
+# The Prosperity Public License 3.0.0
+
+Contributor: Paul Le Cam
+
+Source Code: https://github.com/PaulLeCam/kubun
+
+## Purpose
+
+This license allows you to use and share this software for noncommercial purposes for free and to try this software for commercial purposes for thirty days.
+
+## Agreement
+
+In order to receive this license, you have to agree to its rules.  Those rules are both obligations under that agreement and conditions to your license.  Don't do anything with this software that triggers a rule you can't or won't follow.
+
+## Notices
+
+Make sure everyone who gets a copy of any part of this software from you, with or without changes, also gets the text of this license and the contributor and source code lines above.
+
+## Commercial Trial
+
+Limit your use of this software for commercial purposes to a thirty-day trial period.  If you use this software for work, your company gets one trial period for all personnel, not one trial per person.
+
+## Contributions Back
+
+Developing feedback, changes, or additions that you contribute back to the contributor on the terms of a standardized public software license such as [the Blue Oak Model License 1.0.0](https://blueoakcouncil.org/license/1.0.0), [the Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html), [the MIT license](https://spdx.org/licenses/MIT.html), or [the two-clause BSD license](https://spdx.org/licenses/BSD-2-Clause.html) doesn't count as use for a commercial purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, doesn't count as use for a commercial purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution doesn't count as use for a commercial purpose regardless of the source of funding or obligations resulting from the funding.
+
+## Defense
+
+Don't make any legal claim against anyone accusing this software, with or without changes, alone or with other technology, of infringing any patent.
+
+## Copyright
+
+The contributor licenses you to do everything with this software that would otherwise infringe their copyright in it.
+
+## Patent
+
+The contributor licenses you to do everything with this software that would otherwise infringe any patents they can license or become able to license.
+
+## Reliability
+
+The contributor can't revoke this license.
+
+## Excuse
+
+You're excused for unknowingly breaking [Notices](#notices) if you take all practical steps to comply within thirty days of learning you broke the rule.
+
+## No Liability
+
+***As far as the law allows, this software comes as is, without any warranty or condition, and the contributor won't be liable to anyone for any damages related to this software or this license, under any kind of legal claim.***

package/lib/fs.d.ts

@@ -0,0 +1,13 @@
+import type { BlobBackend, BlobRange } from '@kubun/blob-backend';
+export declare class FSBlobBackend implements BlobBackend {
+    #private;
+    constructor(root: string);
+    createStaging(stagingID: string): Promise<WritableStream<Uint8Array>>;
+    writeChunk(stagingID: string, offset: number, bytes: Uint8Array): Promise<void>;
+    commit(stagingID: string, key: string): Promise<void>;
+    abortStaging(stagingID: string): Promise<void>;
+    createReadStream(key: string, range?: BlobRange): Promise<ReadableStream<Uint8Array>>;
+    has(key: string): Promise<boolean>;
+    delete(key: string): Promise<void>;
+    getURL(key: string): Promise<string | null>;
+}

package/lib/fs.js

@@ -0,0 +1,92 @@
+import { constants, createReadStream, createWriteStream } from 'node:fs';
+import { mkdir, open, rename, rm, stat } from 'node:fs/promises';
+import { join } from 'node:path';
+import { Readable, Writable } from 'node:stream';
+import { pathToFileURL } from 'node:url';
+// Filesystem BlobBackend. Staged uploads land under `<root>/staging`, committed
+// blobs under `<root>/content/<key>`. Commit is an atomic rename within the same
+// filesystem. Content-addressed keys are AttachmentID base36 strings (safe as
+// flat filenames).
+export class FSBlobBackend {
+    #stagingDir;
+    #contentDir;
+    #ready = null;
+    constructor(root){
+        this.#stagingDir = join(root, 'staging');
+        this.#contentDir = join(root, 'content');
+    }
+    #ensureDirs() {
+        this.#ready ??= (async ()=>{
+            await mkdir(this.#stagingDir, {
+                recursive: true
+            });
+            await mkdir(this.#contentDir, {
+                recursive: true
+            });
+        })();
+        return this.#ready;
+    }
+    #stagingPath(stagingID) {
+        return join(this.#stagingDir, stagingID);
+    }
+    #contentPath(key) {
+        return join(this.#contentDir, key);
+    }
+    async createStaging(stagingID) {
+        await this.#ensureDirs();
+        const nodeStream = createWriteStream(this.#stagingPath(stagingID));
+        return Writable.toWeb(nodeStream);
+    }
+    async writeChunk(stagingID, offset, bytes) {
+        await this.#ensureDirs();
+        // O_RDWR | O_CREAT: create-if-absent, no truncate — positioned writes into a
+        // possibly-sparse file as out-of-order ranges arrive.
+        const handle = await open(this.#stagingPath(stagingID), constants.O_RDWR | constants.O_CREAT);
+        try {
+            await handle.write(bytes, 0, bytes.length, offset);
+        } finally{
+            await handle.close();
+        }
+    }
+    async commit(stagingID, key) {
+        await this.#ensureDirs();
+        if (await this.has(key)) {
+            await rm(this.#stagingPath(stagingID), {
+                force: true
+            });
+            return;
+        }
+        await rename(this.#stagingPath(stagingID), this.#contentPath(key));
+    }
+    async abortStaging(stagingID) {
+        await rm(this.#stagingPath(stagingID), {
+            force: true
+        });
+    }
+    async createReadStream(key, range) {
+        // createReadStream's `end` is inclusive, matching BlobRange.
+        const options = range == null ? undefined : {
+            start: range.start,
+            end: range.end
+        };
+        const nodeStream = createReadStream(this.#contentPath(key), options);
+        return Readable.toWeb(nodeStream);
+    }
+    async has(key) {
+        try {
+            await stat(this.#contentPath(key));
+            return true;
+        } catch  {
+            return false;
+        }
+    }
+    async delete(key) {
+        await rm(this.#contentPath(key), {
+            force: true
+        });
+    }
+    async getURL(key) {
+        if (!await this.has(key)) return null;
+        return pathToFileURL(this.#contentPath(key)).href;
+    }
+}

package/lib/index.d.ts

@@ -0,0 +1 @@
+export { FSBlobBackend } from './fs.js';

package/lib/index.js

@@ -0,0 +1 @@
+export { FSBlobBackend } from './fs.js';

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@kubun/blob-node-fs",
+  "version": "0.13.0",
+  "keywords": [],
+  "license": "see LICENSE.md",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib/*",
+    "LICENSE.md"
+  ],
+  "dependencies": {
+    "@kubun/blob-backend": "^0.13.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "pnpm run build:clean && pnpm run build:js && pnpm run build:types",
+    "build:clean": "del lib",
+    "build:js": "swc src -d ./lib --config-file ../../node_modules/@kigu/dev/swc.json --strip-leading-paths",
+    "build:types": "tsc --emitDeclarationOnly --skipLibCheck",
+    "build:types:ci": "tsc --emitDeclarationOnly --declarationMap false",
+    "test": "pnpm run test:types && pnpm run test:unit",
+    "test:types": "tsc --noEmit -p tsconfig.test.json",
+    "test:unit": "vitest run"
+  }
+}