@magnet-cms/adapter-storage-r2 1.0.0

package/dist/index.cjs

@@ -0,0 +1,253 @@
+'use strict';
+
+var crypto = require('crypto');
+var clientS3 = require('@aws-sdk/client-s3');
+var s3RequestPresigner = require('@aws-sdk/s3-request-presigner');
+var common = require('@magnet-cms/common');
+
+// src/r2-storage.adapter.ts
+async function streamToBuffer(stream) {
+  const chunks = [];
+  for await (const chunk of stream) {
+    chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
+  }
+  return Buffer.concat(chunks);
+}
+function generateFilename(originalFilename) {
+  const ext = originalFilename.split(".").pop() || "";
+  const uuid = crypto.randomUUID();
+  return ext ? `${uuid}.${ext}` : uuid;
+}
+var R2StorageAdapter = class _R2StorageAdapter extends common.StorageAdapter {
+  client;
+  config;
+  bucket;
+  constructor(config) {
+    super();
+    this.config = config;
+    this.bucket = config.bucket;
+    const endpoint = config.endpoint || `https://${config.accountId}.r2.cloudflarestorage.com`;
+    this.client = new clientS3.S3Client({
+      region: config.region || "auto",
+      credentials: {
+        accessKeyId: config.accessKeyId,
+        secretAccessKey: config.secretAccessKey
+      },
+      endpoint,
+      forcePathStyle: config.forcePathStyle ?? true
+    });
+  }
+  getKey(path) {
+    return path;
+  }
+  getPublicUrl(key) {
+    if (this.config.publicUrl) {
+      return `${this.config.publicUrl.replace(/\/$/, "")}/${key}`;
+    }
+    throw new Error(
+      "R2 storage requires publicUrl in config for public file URLs"
+    );
+  }
+  async initialize() {
+    await this.client.send(
+      new clientS3.ListObjectsV2Command({
+        Bucket: this.bucket,
+        MaxKeys: 1
+      })
+    );
+  }
+  async upload(file, originalFilename, options) {
+    const buffer = Buffer.isBuffer(file) ? file : await streamToBuffer(file);
+    const filename = options?.filename || generateFilename(originalFilename);
+    const folder = options?.folder || "";
+    const key = folder ? `${folder}/${filename}` : filename;
+    await this.client.send(
+      new clientS3.PutObjectCommand({
+        Bucket: this.bucket,
+        Key: key,
+        Body: buffer,
+        ContentType: options?.mimeType || "application/octet-stream"
+      })
+    );
+    const url = this.getPublicUrl(key);
+    return {
+      id: crypto.randomUUID(),
+      filename,
+      originalFilename,
+      mimeType: options?.mimeType || "application/octet-stream",
+      size: buffer.length,
+      path: key,
+      url,
+      folder: folder || void 0,
+      tags: options?.tags,
+      alt: options?.alt,
+      customFields: options?.customFields,
+      createdAt: /* @__PURE__ */ new Date(),
+      updatedAt: /* @__PURE__ */ new Date()
+    };
+  }
+  async uploadChunked(stream, originalFilename, _totalSize, options) {
+    const buffer = await streamToBuffer(stream);
+    return this.upload(buffer, originalFilename, options);
+  }
+  async delete(path) {
+    const key = this.getKey(path);
+    try {
+      await this.client.send(
+        new clientS3.DeleteObjectsCommand({
+          Bucket: this.bucket,
+          Delete: { Objects: [{ Key: key }] }
+        })
+      );
+      return true;
+    } catch {
+      return false;
+    }
+  }
+  async deleteMany(paths) {
+    const keys = paths.map((p) => ({ Key: this.getKey(p) }));
+    try {
+      await this.client.send(
+        new clientS3.DeleteObjectsCommand({
+          Bucket: this.bucket,
+          Delete: { Objects: keys }
+        })
+      );
+      return { deleted: paths.length, failed: [] };
+    } catch {
+      return { deleted: 0, failed: paths };
+    }
+  }
+  getUrl(path, _transform) {
+    return this.getPublicUrl(this.getKey(path));
+  }
+  async getStream(path) {
+    const key = this.getKey(path);
+    const response = await this.client.send(
+      new clientS3.GetObjectCommand({ Bucket: this.bucket, Key: key })
+    );
+    if (!response.Body) {
+      throw new Error(`Failed to get object: ${path}`);
+    }
+    return response.Body;
+  }
+  async getBuffer(path) {
+    const stream = await this.getStream(path);
+    return streamToBuffer(stream);
+  }
+  async exists(path) {
+    const key = this.getKey(path);
+    try {
+      await this.client.send(
+        new clientS3.HeadObjectCommand({ Bucket: this.bucket, Key: key })
+      );
+      return true;
+    } catch {
+      return false;
+    }
+  }
+  async transform(path, _options) {
+    return this.getBuffer(path);
+  }
+  async move(path, newPath) {
+    const srcKey = this.getKey(path);
+    const destKey = this.getKey(newPath);
+    await this.client.send(
+      new clientS3.CopyObjectCommand({
+        Bucket: this.bucket,
+        CopySource: `${this.bucket}/${srcKey}`,
+        Key: destKey
+      })
+    );
+    await this.delete(path);
+    const filename = newPath.split("/").pop() || newPath;
+    return {
+      id: crypto.randomUUID(),
+      filename,
+      originalFilename: filename,
+      mimeType: "application/octet-stream",
+      size: 0,
+      path: destKey,
+      url: this.getPublicUrl(destKey),
+      createdAt: /* @__PURE__ */ new Date(),
+      updatedAt: /* @__PURE__ */ new Date()
+    };
+  }
+  async copy(path, newPath) {
+    const srcKey = this.getKey(path);
+    const destKey = this.getKey(newPath);
+    await this.client.send(
+      new clientS3.CopyObjectCommand({
+        Bucket: this.bucket,
+        CopySource: `${this.bucket}/${srcKey}`,
+        Key: destKey
+      })
+    );
+    const filename = newPath.split("/").pop() || newPath;
+    return {
+      id: crypto.randomUUID(),
+      filename,
+      originalFilename: filename,
+      mimeType: "application/octet-stream",
+      size: 0,
+      path: destKey,
+      url: this.getPublicUrl(destKey),
+      createdAt: /* @__PURE__ */ new Date(),
+      updatedAt: /* @__PURE__ */ new Date()
+    };
+  }
+  async signedUrl(path, expiresIn = 3600) {
+    const key = this.getKey(path);
+    return s3RequestPresigner.getSignedUrl(
+      this.client,
+      new clientS3.GetObjectCommand({ Bucket: this.bucket, Key: key }),
+      { expiresIn }
+    );
+  }
+  /** Environment variables used by this adapter */
+  static envVars = [
+    { name: "R2_BUCKET", required: true, description: "R2 bucket name" },
+    {
+      name: "R2_ACCOUNT_ID",
+      required: true,
+      description: "Cloudflare account ID"
+    },
+    {
+      name: "R2_ACCESS_KEY_ID",
+      required: true,
+      description: "R2 access key ID"
+    },
+    {
+      name: "R2_SECRET_ACCESS_KEY",
+      required: true,
+      description: "R2 secret access key"
+    },
+    {
+      name: "R2_PUBLIC_URL",
+      required: false,
+      description: "Public URL for R2 bucket"
+    }
+  ];
+  /**
+   * Create a configured storage provider for MagnetModule.forRoot().
+   * Auto-resolves config values from environment variables if not provided.
+   */
+  static forRoot(config) {
+    const resolvedConfig = {
+      bucket: config?.bucket ?? process.env.R2_BUCKET ?? "",
+      region: config?.region ?? "auto",
+      accountId: config?.accountId ?? process.env.R2_ACCOUNT_ID ?? "",
+      accessKeyId: config?.accessKeyId ?? process.env.R2_ACCESS_KEY_ID ?? "",
+      secretAccessKey: config?.secretAccessKey ?? process.env.R2_SECRET_ACCESS_KEY ?? "",
+      publicUrl: config?.publicUrl ?? process.env.R2_PUBLIC_URL
+    };
+    return {
+      type: "storage",
+      adapter: new _R2StorageAdapter(resolvedConfig),
+      config: resolvedConfig,
+      envVars: _R2StorageAdapter.envVars
+    };
+  }
+};
+
+exports.R2StorageAdapter = R2StorageAdapter;

package/dist/index.d.cts

@@ -0,0 +1,54 @@
+import { Readable } from 'node:stream';
+import { StorageAdapter, R2StorageConfig, UploadOptions, UploadResult, TransformOptions, EnvVarRequirement, StorageMagnetProvider } from '@magnet-cms/common';
+
+/**
+ * R2 Storage adapter for Magnet CMS.
+ * Uses Cloudflare R2 (S3-compatible) for file storage.
+ *
+ * @example
+ * ```typescript
+ * import { R2StorageAdapter } from '@magnet-cms/adapter-storage-r2'
+ *
+ * const storage = new R2StorageAdapter({
+ *   bucket: 'my-bucket',
+ *   region: 'auto',
+ *   accountId: process.env.CLOUDFLARE_ACCOUNT_ID,
+ *   accessKeyId: process.env.R2_ACCESS_KEY_ID,
+ *   secretAccessKey: process.env.R2_SECRET_ACCESS_KEY,
+ *   publicUrl: 'https://pub-xxx.r2.dev',
+ * })
+ * ```
+ */
+declare class R2StorageAdapter extends StorageAdapter {
+    private readonly client;
+    private readonly config;
+    private readonly bucket;
+    constructor(config: R2StorageConfig);
+    private getKey;
+    private getPublicUrl;
+    initialize(): Promise<void>;
+    upload(file: Buffer | Readable, originalFilename: string, options?: UploadOptions): Promise<UploadResult>;
+    uploadChunked(stream: Readable, originalFilename: string, _totalSize: number, options?: UploadOptions): Promise<UploadResult>;
+    delete(path: string): Promise<boolean>;
+    deleteMany(paths: string[]): Promise<{
+        deleted: number;
+        failed: string[];
+    }>;
+    getUrl(path: string, _transform?: TransformOptions): string;
+    getStream(path: string): Promise<Readable>;
+    getBuffer(path: string): Promise<Buffer>;
+    exists(path: string): Promise<boolean>;
+    transform(path: string, _options: TransformOptions): Promise<Buffer>;
+    move(path: string, newPath: string): Promise<UploadResult>;
+    copy(path: string, newPath: string): Promise<UploadResult>;
+    signedUrl(path: string, expiresIn?: number): Promise<string>;
+    /** Environment variables used by this adapter */
+    static readonly envVars: EnvVarRequirement[];
+    /**
+     * Create a configured storage provider for MagnetModule.forRoot().
+     * Auto-resolves config values from environment variables if not provided.
+     */
+    static forRoot(config?: Partial<R2StorageConfig>): StorageMagnetProvider;
+}
+
+export { R2StorageAdapter };

package/dist/index.d.ts

@@ -0,0 +1,54 @@
+import { Readable } from 'node:stream';
+import { StorageAdapter, R2StorageConfig, UploadOptions, UploadResult, TransformOptions, EnvVarRequirement, StorageMagnetProvider } from '@magnet-cms/common';
+
+/**
+ * R2 Storage adapter for Magnet CMS.
+ * Uses Cloudflare R2 (S3-compatible) for file storage.
+ *
+ * @example
+ * ```typescript
+ * import { R2StorageAdapter } from '@magnet-cms/adapter-storage-r2'
+ *
+ * const storage = new R2StorageAdapter({
+ *   bucket: 'my-bucket',
+ *   region: 'auto',
+ *   accountId: process.env.CLOUDFLARE_ACCOUNT_ID,
+ *   accessKeyId: process.env.R2_ACCESS_KEY_ID,
+ *   secretAccessKey: process.env.R2_SECRET_ACCESS_KEY,
+ *   publicUrl: 'https://pub-xxx.r2.dev',
+ * })
+ * ```
+ */
+declare class R2StorageAdapter extends StorageAdapter {
+    private readonly client;
+    private readonly config;
+    private readonly bucket;
+    constructor(config: R2StorageConfig);
+    private getKey;
+    private getPublicUrl;
+    initialize(): Promise<void>;
+    upload(file: Buffer | Readable, originalFilename: string, options?: UploadOptions): Promise<UploadResult>;
+    uploadChunked(stream: Readable, originalFilename: string, _totalSize: number, options?: UploadOptions): Promise<UploadResult>;
+    delete(path: string): Promise<boolean>;
+    deleteMany(paths: string[]): Promise<{
+        deleted: number;
+        failed: string[];
+    }>;
+    getUrl(path: string, _transform?: TransformOptions): string;
+    getStream(path: string): Promise<Readable>;
+    getBuffer(path: string): Promise<Buffer>;
+    exists(path: string): Promise<boolean>;
+    transform(path: string, _options: TransformOptions): Promise<Buffer>;
+    move(path: string, newPath: string): Promise<UploadResult>;
+    copy(path: string, newPath: string): Promise<UploadResult>;
+    signedUrl(path: string, expiresIn?: number): Promise<string>;
+    /** Environment variables used by this adapter */
+    static readonly envVars: EnvVarRequirement[];
+    /**
+     * Create a configured storage provider for MagnetModule.forRoot().
+     * Auto-resolves config values from environment variables if not provided.
+     */
+    static forRoot(config?: Partial<R2StorageConfig>): StorageMagnetProvider;
+}
+
+export { R2StorageAdapter };

package/dist/index.js

@@ -0,0 +1,251 @@
+import { randomUUID } from 'node:crypto';
+import { S3Client, ListObjectsV2Command, PutObjectCommand, DeleteObjectsCommand, GetObjectCommand, HeadObjectCommand, CopyObjectCommand } from '@aws-sdk/client-s3';
+import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
+import { StorageAdapter } from '@magnet-cms/common';
+
+// src/r2-storage.adapter.ts
+async function streamToBuffer(stream) {
+  const chunks = [];
+  for await (const chunk of stream) {
+    chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
+  }
+  return Buffer.concat(chunks);
+}
+function generateFilename(originalFilename) {
+  const ext = originalFilename.split(".").pop() || "";
+  const uuid = randomUUID();
+  return ext ? `${uuid}.${ext}` : uuid;
+}
+var R2StorageAdapter = class _R2StorageAdapter extends StorageAdapter {
+  client;
+  config;
+  bucket;
+  constructor(config) {
+    super();
+    this.config = config;
+    this.bucket = config.bucket;
+    const endpoint = config.endpoint || `https://${config.accountId}.r2.cloudflarestorage.com`;
+    this.client = new S3Client({
+      region: config.region || "auto",
+      credentials: {
+        accessKeyId: config.accessKeyId,
+        secretAccessKey: config.secretAccessKey
+      },
+      endpoint,
+      forcePathStyle: config.forcePathStyle ?? true
+    });
+  }
+  getKey(path) {
+    return path;
+  }
+  getPublicUrl(key) {
+    if (this.config.publicUrl) {
+      return `${this.config.publicUrl.replace(/\/$/, "")}/${key}`;
+    }
+    throw new Error(
+      "R2 storage requires publicUrl in config for public file URLs"
+    );
+  }
+  async initialize() {
+    await this.client.send(
+      new ListObjectsV2Command({
+        Bucket: this.bucket,
+        MaxKeys: 1
+      })
+    );
+  }
+  async upload(file, originalFilename, options) {
+    const buffer = Buffer.isBuffer(file) ? file : await streamToBuffer(file);
+    const filename = options?.filename || generateFilename(originalFilename);
+    const folder = options?.folder || "";
+    const key = folder ? `${folder}/${filename}` : filename;
+    await this.client.send(
+      new PutObjectCommand({
+        Bucket: this.bucket,
+        Key: key,
+        Body: buffer,
+        ContentType: options?.mimeType || "application/octet-stream"
+      })
+    );
+    const url = this.getPublicUrl(key);
+    return {
+      id: randomUUID(),
+      filename,
+      originalFilename,
+      mimeType: options?.mimeType || "application/octet-stream",
+      size: buffer.length,
+      path: key,
+      url,
+      folder: folder || void 0,
+      tags: options?.tags,
+      alt: options?.alt,
+      customFields: options?.customFields,
+      createdAt: /* @__PURE__ */ new Date(),
+      updatedAt: /* @__PURE__ */ new Date()
+    };
+  }
+  async uploadChunked(stream, originalFilename, _totalSize, options) {
+    const buffer = await streamToBuffer(stream);
+    return this.upload(buffer, originalFilename, options);
+  }
+  async delete(path) {
+    const key = this.getKey(path);
+    try {
+      await this.client.send(
+        new DeleteObjectsCommand({
+          Bucket: this.bucket,
+          Delete: { Objects: [{ Key: key }] }
+        })
+      );
+      return true;
+    } catch {
+      return false;
+    }
+  }
+  async deleteMany(paths) {
+    const keys = paths.map((p) => ({ Key: this.getKey(p) }));
+    try {
+      await this.client.send(
+        new DeleteObjectsCommand({
+          Bucket: this.bucket,
+          Delete: { Objects: keys }
+        })
+      );
+      return { deleted: paths.length, failed: [] };
+    } catch {
+      return { deleted: 0, failed: paths };
+    }
+  }
+  getUrl(path, _transform) {
+    return this.getPublicUrl(this.getKey(path));
+  }
+  async getStream(path) {
+    const key = this.getKey(path);
+    const response = await this.client.send(
+      new GetObjectCommand({ Bucket: this.bucket, Key: key })
+    );
+    if (!response.Body) {
+      throw new Error(`Failed to get object: ${path}`);
+    }
+    return response.Body;
+  }
+  async getBuffer(path) {
+    const stream = await this.getStream(path);
+    return streamToBuffer(stream);
+  }
+  async exists(path) {
+    const key = this.getKey(path);
+    try {
+      await this.client.send(
+        new HeadObjectCommand({ Bucket: this.bucket, Key: key })
+      );
+      return true;
+    } catch {
+      return false;
+    }
+  }
+  async transform(path, _options) {
+    return this.getBuffer(path);
+  }
+  async move(path, newPath) {
+    const srcKey = this.getKey(path);
+    const destKey = this.getKey(newPath);
+    await this.client.send(
+      new CopyObjectCommand({
+        Bucket: this.bucket,
+        CopySource: `${this.bucket}/${srcKey}`,
+        Key: destKey
+      })
+    );
+    await this.delete(path);
+    const filename = newPath.split("/").pop() || newPath;
+    return {
+      id: randomUUID(),
+      filename,
+      originalFilename: filename,
+      mimeType: "application/octet-stream",
+      size: 0,
+      path: destKey,
+      url: this.getPublicUrl(destKey),
+      createdAt: /* @__PURE__ */ new Date(),
+      updatedAt: /* @__PURE__ */ new Date()
+    };
+  }
+  async copy(path, newPath) {
+    const srcKey = this.getKey(path);
+    const destKey = this.getKey(newPath);
+    await this.client.send(
+      new CopyObjectCommand({
+        Bucket: this.bucket,
+        CopySource: `${this.bucket}/${srcKey}`,
+        Key: destKey
+      })
+    );
+    const filename = newPath.split("/").pop() || newPath;
+    return {
+      id: randomUUID(),
+      filename,
+      originalFilename: filename,
+      mimeType: "application/octet-stream",
+      size: 0,
+      path: destKey,
+      url: this.getPublicUrl(destKey),
+      createdAt: /* @__PURE__ */ new Date(),
+      updatedAt: /* @__PURE__ */ new Date()
+    };
+  }
+  async signedUrl(path, expiresIn = 3600) {
+    const key = this.getKey(path);
+    return getSignedUrl(
+      this.client,
+      new GetObjectCommand({ Bucket: this.bucket, Key: key }),
+      { expiresIn }
+    );
+  }
+  /** Environment variables used by this adapter */
+  static envVars = [
+    { name: "R2_BUCKET", required: true, description: "R2 bucket name" },
+    {
+      name: "R2_ACCOUNT_ID",
+      required: true,
+      description: "Cloudflare account ID"
+    },
+    {
+      name: "R2_ACCESS_KEY_ID",
+      required: true,
+      description: "R2 access key ID"
+    },
+    {
+      name: "R2_SECRET_ACCESS_KEY",
+      required: true,
+      description: "R2 secret access key"
+    },
+    {
+      name: "R2_PUBLIC_URL",
+      required: false,
+      description: "Public URL for R2 bucket"
+    }
+  ];
+  /**
+   * Create a configured storage provider for MagnetModule.forRoot().
+   * Auto-resolves config values from environment variables if not provided.
+   */
+  static forRoot(config) {
+    const resolvedConfig = {
+      bucket: config?.bucket ?? process.env.R2_BUCKET ?? "",
+      region: config?.region ?? "auto",
+      accountId: config?.accountId ?? process.env.R2_ACCOUNT_ID ?? "",
+      accessKeyId: config?.accessKeyId ?? process.env.R2_ACCESS_KEY_ID ?? "",
+      secretAccessKey: config?.secretAccessKey ?? process.env.R2_SECRET_ACCESS_KEY ?? "",
+      publicUrl: config?.publicUrl ?? process.env.R2_PUBLIC_URL
+    };
+    return {
+      type: "storage",
+      adapter: new _R2StorageAdapter(resolvedConfig),
+      config: resolvedConfig,
+      envVars: _R2StorageAdapter.envVars
+    };
+  }
+};
+
+export { R2StorageAdapter };

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@magnet-cms/adapter-storage-r2",
+  "version": "1.0.0",
+  "description": "Cloudflare R2 storage adapter for Magnet CMS",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "exports": {
+    "import": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "require": {
+      "types": "./dist/index.d.cts",
+      "default": "./dist/index.cjs"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build:dev": "tsup --watch",
+    "build": "tsup"
+  },
+  "devDependencies": {
+    "@magnet-cms/common": "workspace:*",
+    "@repo/biome": "workspace:*",
+    "@repo/tsup": "workspace:*",
+    "@repo/typescript-config": "workspace:*",
+    "@aws-sdk/client-s3": "^3.700.0",
+    "@aws-sdk/s3-request-presigner": "^3.700.0"
+  },
+  "peerDependencies": {
+    "@magnet-cms/common": "^0.1.0",
+    "@aws-sdk/client-s3": "^3.0.0",
+    "@aws-sdk/s3-request-presigner": "^3.0.0"
+  }
+}