@airnauts/comments-storage-fs 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Airnauts
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,24 @@
+# @airnauts/comments-storage-fs
+
+Filesystem attachment-storage adapter for the
+[Airnauts commenting tool](https://github.com/Airnauts/commenting-tool) server.
+
+## Install
+
+```bash
+pnpm add @airnauts/comments-storage-fs
+```
+
+## Usage
+
+```ts
+import { FileSystemStorage } from '@airnauts/comments-storage-fs'
+
+const storage = new FileSystemStorage({ rootDir: './uploads' })
+```
+
+Pass `storage` to `createCommentsServer` from `@airnauts/comments-server`.
+
+## License
+
+MIT © Airnauts

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import type { PutBlob, PutResult, StorageAdapter } from '@airnauts/comments-server';
+export type FileSystemStorageOptions = {
+    rootDir: string;
+    /**
+     * Public URL base. When set, `put` returns `${baseUrl}/${key}` (a browser-served
+     * path) instead of a `file://` URL. A trailing slash is trimmed.
+     */
+    baseUrl?: string;
+};
+export declare class FileSystemStorage implements StorageAdapter {
+    private readonly opts;
+    constructor(opts: FileSystemStorageOptions);
+    put(blob: PutBlob): Promise<PutResult>;
+}
+/** Construct a filesystem `StorageAdapter` (uniform `xxxStorage(config)` shape). */
+export declare function fileSystemStorage(opts: FileSystemStorageOptions): StorageAdapter;
+export declare const packageName = "@airnauts/comments-storage-fs";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAEnF,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,MAAM,CAAA;IACf;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAwCD,qBAAa,iBAAkB,YAAW,cAAc;IAC1C,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,wBAAwB;IAErD,GAAG,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;CAc7C;AAED,oFAAoF;AACpF,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,wBAAwB,GAAG,cAAc,CAEhF;AAED,eAAO,MAAM,WAAW,kCAAkC,CAAA"}

package/dist/index.js

@@ -0,0 +1,68 @@
+// src/index.ts
+import { randomBytes } from "crypto";
+import { mkdir, writeFile } from "fs/promises";
+import { join, posix } from "path";
+import { pathToFileURL } from "url";
+function sanitizeName(name) {
+  const cleaned = name.replace(/[^A-Za-z0-9._-]/g, "_").slice(0, 200);
+  return cleaned.length > 0 ? cleaned : "file";
+}
+function uniqueKey(name) {
+  const ts = Date.now().toString(36);
+  const rand = randomBytes(6).toString("hex");
+  const safe = sanitizeName(name);
+  return posix.join(ts, `${rand}-${safe}`);
+}
+async function readAllBytes(data) {
+  if (data instanceof Uint8Array) return data;
+  const reader = data.getReader();
+  const chunks = [];
+  let total = 0;
+  try {
+    for (; ; ) {
+      const { value, done } = await reader.read();
+      if (done) break;
+      if (value) {
+        chunks.push(value);
+        total += value.byteLength;
+      }
+    }
+  } finally {
+    reader.releaseLock();
+  }
+  const out = new Uint8Array(total);
+  let offset = 0;
+  for (const c of chunks) {
+    out.set(c, offset);
+    offset += c.byteLength;
+  }
+  return out;
+}
+var FileSystemStorage = class {
+  constructor(opts) {
+    this.opts = opts;
+  }
+  opts;
+  async put(blob) {
+    const key = uniqueKey(blob.name);
+    const abs = join(this.opts.rootDir, key);
+    await mkdir(join(abs, ".."), { recursive: true });
+    const bytes = await readAllBytes(blob.data);
+    await writeFile(abs, bytes);
+    return {
+      key,
+      url: this.opts.baseUrl ? `${this.opts.baseUrl.replace(/\/$/, "")}/${key}` : pathToFileURL(abs).href,
+      size: bytes.byteLength
+    };
+  }
+};
+function fileSystemStorage(opts) {
+  return new FileSystemStorage(opts);
+}
+var packageName = "@airnauts/comments-storage-fs";
+export {
+  FileSystemStorage,
+  fileSystemStorage,
+  packageName
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { randomBytes } from 'node:crypto'\nimport { mkdir, writeFile } from 'node:fs/promises'\nimport { join, posix } from 'node:path'\nimport { pathToFileURL } from 'node:url'\nimport type { PutBlob, PutResult, StorageAdapter } from '@airnauts/comments-server'\n\nexport type FileSystemStorageOptions = {\n  rootDir: string\n  /**\n   * Public URL base. When set, `put` returns `${baseUrl}/${key}` (a browser-served\n   * path) instead of a `file://` URL. A trailing slash is trimmed.\n   */\n  baseUrl?: string\n}\n\nfunction sanitizeName(name: string): string {\n  const cleaned = name.replace(/[^A-Za-z0-9._-]/g, '_').slice(0, 200)\n  return cleaned.length > 0 ? cleaned : 'file'\n}\n\nfunction uniqueKey(name: string): string {\n  const ts = Date.now().toString(36)\n  const rand = randomBytes(6).toString('hex')\n  const safe = sanitizeName(name)\n  return posix.join(ts, `${rand}-${safe}`)\n}\n\nasync function readAllBytes(data: Uint8Array | ReadableStream<Uint8Array>): Promise<Uint8Array> {\n  if (data instanceof Uint8Array) return data\n  const reader = data.getReader()\n  const chunks: Uint8Array[] = []\n  let total = 0\n  try {\n    for (;;) {\n      const { value, done } = await reader.read()\n      if (done) break\n      if (value) {\n        chunks.push(value)\n        total += value.byteLength\n      }\n    }\n  } finally {\n    reader.releaseLock()\n  }\n  const out = new Uint8Array(total)\n  let offset = 0\n  for (const c of chunks) {\n    out.set(c, offset)\n    offset += c.byteLength\n  }\n  return out\n}\n\nexport class FileSystemStorage implements StorageAdapter {\n  constructor(private readonly opts: FileSystemStorageOptions) {}\n\n  async put(blob: PutBlob): Promise<PutResult> {\n    const key = uniqueKey(blob.name)\n    const abs = join(this.opts.rootDir, key)\n    await mkdir(join(abs, '..'), { recursive: true })\n    const bytes = await readAllBytes(blob.data)\n    await writeFile(abs, bytes)\n    return {\n      key,\n      url: this.opts.baseUrl\n        ? `${this.opts.baseUrl.replace(/\\/$/, '')}/${key}`\n        : pathToFileURL(abs).href,\n      size: bytes.byteLength,\n    }\n  }\n}\n\n/** Construct a filesystem `StorageAdapter` (uniform `xxxStorage(config)` shape). */\nexport function fileSystemStorage(opts: FileSystemStorageOptions): StorageAdapter {\n  return new FileSystemStorage(opts)\n}\n\nexport const packageName = '@airnauts/comments-storage-fs'\n"],"mappings":";AAAA,SAAS,mBAAmB;AAC5B,SAAS,OAAO,iBAAiB;AACjC,SAAS,MAAM,aAAa;AAC5B,SAAS,qBAAqB;AAY9B,SAAS,aAAa,MAAsB;AAC1C,QAAM,UAAU,KAAK,QAAQ,oBAAoB,GAAG,EAAE,MAAM,GAAG,GAAG;AAClE,SAAO,QAAQ,SAAS,IAAI,UAAU;AACxC;AAEA,SAAS,UAAU,MAAsB;AACvC,QAAM,KAAK,KAAK,IAAI,EAAE,SAAS,EAAE;AACjC,QAAM,OAAO,YAAY,CAAC,EAAE,SAAS,KAAK;AAC1C,QAAM,OAAO,aAAa,IAAI;AAC9B,SAAO,MAAM,KAAK,IAAI,GAAG,IAAI,IAAI,IAAI,EAAE;AACzC;AAEA,eAAe,aAAa,MAAoE;AAC9F,MAAI,gBAAgB,WAAY,QAAO;AACvC,QAAM,SAAS,KAAK,UAAU;AAC9B,QAAM,SAAuB,CAAC;AAC9B,MAAI,QAAQ;AACZ,MAAI;AACF,eAAS;AACP,YAAM,EAAE,OAAO,KAAK,IAAI,MAAM,OAAO,KAAK;AAC1C,UAAI,KAAM;AACV,UAAI,OAAO;AACT,eAAO,KAAK,KAAK;AACjB,iBAAS,MAAM;AAAA,MACjB;AAAA,IACF;AAAA,EACF,UAAE;AACA,WAAO,YAAY;AAAA,EACrB;AACA,QAAM,MAAM,IAAI,WAAW,KAAK;AAChC,MAAI,SAAS;AACb,aAAW,KAAK,QAAQ;AACtB,QAAI,IAAI,GAAG,MAAM;AACjB,cAAU,EAAE;AAAA,EACd;AACA,SAAO;AACT;AAEO,IAAM,oBAAN,MAAkD;AAAA,EACvD,YAA6B,MAAgC;AAAhC;AAAA,EAAiC;AAAA,EAAjC;AAAA,EAE7B,MAAM,IAAI,MAAmC;AAC3C,UAAM,MAAM,UAAU,KAAK,IAAI;AAC/B,UAAM,MAAM,KAAK,KAAK,KAAK,SAAS,GAAG;AACvC,UAAM,MAAM,KAAK,KAAK,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;AAChD,UAAM,QAAQ,MAAM,aAAa,KAAK,IAAI;AAC1C,UAAM,UAAU,KAAK,KAAK;AAC1B,WAAO;AAAA,MACL;AAAA,MACA,KAAK,KAAK,KAAK,UACX,GAAG,KAAK,KAAK,QAAQ,QAAQ,OAAO,EAAE,CAAC,IAAI,GAAG,KAC9C,cAAc,GAAG,EAAE;AAAA,MACvB,MAAM,MAAM;AAAA,IACd;AAAA,EACF;AACF;AAGO,SAAS,kBAAkB,MAAgD;AAChF,SAAO,IAAI,kBAAkB,IAAI;AACnC;AAEO,IAAM,cAAc;","names":[]}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@airnauts/comments-storage-fs",
+  "version": "0.1.0",
+  "description": "Filesystem attachment-storage adapter for the Airnauts commenting tool server.",
+  "keywords": [
+    "comments",
+    "commenting",
+    "annotations",
+    "feedback",
+    "airnauts",
+    "storage",
+    "filesystem"
+  ],
+  "license": "MIT",
+  "author": "Airnauts",
+  "homepage": "https://github.com/Airnauts/commenting-tool#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Airnauts/commenting-tool.git",
+    "directory": "packages/storage-fs"
+  },
+  "bugs": {
+    "url": "https://github.com/Airnauts/commenting-tool/issues"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!dist/.tsbuildinfo",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@airnauts/comments-core": "^0.1.0",
+    "@airnauts/comments-server": "^0.1.0"
+  },
+  "devDependencies": {
+    "@airnauts/comments-test-support": "0.0.0"
+  },
+  "scripts": {
+    "build": "tsup && tsc --build --force",
+    "typecheck": "tsc --build",
+    "test": "vitest run"
+  }
+}