@zucker-framework/storage 1.0.0

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@zucker-framework/storage",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "scripts/r2-storage-canary.mjs",
+    "LICENSE",
+    "NOTICE",
+    "THIRD_PARTY_NOTICES"
+  ],
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.1124.0",
+    "@aws-sdk/s3-request-presigner": "^3.1124.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.19.43"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^12.0.0",
+    "@nestjs/core": "^12.0.0",
+    "webdav": "^5.0.0"
+  },
+  "license": "Apache-2.0",
+  "author": "Lind",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Lind-pro/zucker-framework.git",
+    "directory": "packages/storage"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --external @nestjs/common --external @nestjs/core --external webdav",
+    "canary:r2": "node scripts/r2-storage-canary.mjs",
+    "clean": "rm -rf dist",
+    "lint": "eslint src/",
+    "verify:package": "node scripts/verify-package.mjs"
+  }
+}

package/scripts/r2-storage-canary.mjs

@@ -0,0 +1,84 @@
+import { createHash, randomUUID } from 'node:crypto';
+import { S3Storage } from '../dist/index.mjs';
+
+const required = ['R2_ENDPOINT', 'R2_ACCESS_KEY_ID', 'R2_SECRET_ACCESS_KEY', 'R2_BUCKET'];
+
+if (process.env.R2_CANARY !== '1') {
+  throw new Error('Set R2_CANARY=1 to run the disposable R2 storage canary');
+}
+for (const key of required) {
+  if (!process.env[key]) throw new Error(`Missing required canary setting: ${key}`);
+}
+
+const storage = new S3Storage({
+  accessKeyId: process.env.R2_ACCESS_KEY_ID,
+  secretAccessKey: process.env.R2_SECRET_ACCESS_KEY,
+  endpoint: process.env.R2_ENDPOINT,
+  bucket: process.env.R2_BUCKET,
+  region: 'auto',
+  forcePathStyle: false,
+  objectAclMode: 'none',
+  uploadUrlMode: 'public-only',
+});
+const prefix = `_canary/storage/${randomUUID()}`;
+const sourceKey = `${prefix}/source.txt`;
+const copyKey = `${prefix}/copy.txt`;
+const payload = Buffer.from(`zucker-storage-r2-canary:${randomUUID()}`);
+const expectedHash = sha256(payload);
+let verified = false;
+
+try {
+  const uploaded = await storage.upload(payload, sourceKey, {
+    contentType: 'text/plain',
+    acl: 'private',
+    metadata: { sha256: expectedHash },
+  });
+  assert(uploaded.key === sourceKey && uploaded.url === '', 'private upload contract');
+  assert(await storage.exists(sourceKey), 'uploaded object existence');
+
+  const info = await storage.getFileInfo(sourceKey);
+  assert(info?.size === payload.length, 'head object size');
+
+  const downloaded = await read(await storage.download(sourceKey));
+  assert(downloaded.length === payload.length, 'download size');
+  assert(sha256(downloaded) === expectedHash, 'download hash');
+
+  const listed = await storage.list(prefix);
+  assert(
+    listed.some((file) => file.key === sourceKey),
+    'list prefix',
+  );
+
+  await storage.copy(sourceKey, copyKey);
+  const copied = await read(await storage.download(copyKey));
+  assert(sha256(copied) === expectedHash, 'copy hash');
+
+  const signedUrl = await storage.getDownloadUrl(sourceKey, 300);
+  const response = await fetch(signedUrl);
+  assert(response.ok, 'signed URL response');
+  assert(sha256(Buffer.from(await response.arrayBuffer())) === expectedHash, 'signed URL hash');
+  verified = true;
+} finally {
+  await Promise.allSettled([storage.delete(copyKey), storage.delete(sourceKey)]);
+  if (verified) {
+    assert(!(await storage.exists(sourceKey)), 'source delete');
+    assert(!(await storage.exists(copyKey)), 'copy delete');
+  }
+  storage.onModuleDestroy();
+}
+
+process.stdout.write('R2 canary passed: upload/head/download/list/copy/signed-url/delete\n');
+
+function assert(condition, stage) {
+  if (!condition) throw new Error(`R2 canary failed at ${stage}`);
+}
+
+async function read(result) {
+  const chunks = [];
+  for await (const chunk of result.stream) chunks.push(Buffer.from(chunk));
+  return Buffer.concat(chunks);
+}
+
+function sha256(value) {
+  return createHash('sha256').update(value).digest('hex');
+}