@cequrebackends/plugin-s3 0.12.2

package/README.md

@@ -0,0 +1,23 @@
+# @cequrebackends/plugin-s3
+
+Amazon S3 and S3-compatible cloud storage plugin for Cequre backends.
+
+## Installation
+
+```bash
+bun add @cequrebackends/plugin-s3 @aws-sdk/client-s3
+```
+
+## Usage
+
+```typescript
+import { CequreRuntime } from "@cequrebackends/cequre-ts";
+import { s3Storage } from "@cequrebackends/plugin-s3";
+
+const runtime = new CequreRuntime(schema, {
+  adapter,
+  plugins: [
+    s3Storage({ bucket: "my-bucket", region: "us-east-1" })
+  ]
+});
+```

package/dist/index.d.ts

@@ -0,0 +1,50 @@
+import { type StorageProvider, type UploadedFile } from "@cequrebackends/cequre-ts";
+export interface S3Config {
+    /** S3 bucket name */
+    bucket: string;
+    /** AWS region (e.g., "us-east-1") */
+    region: string;
+    /** S3 endpoint URL (for S3-compatible services like MinIO, DigitalOcean Spaces) */
+    endpoint?: string;
+    /** Public URL prefix for serving uploaded files (e.g., "https://cdn.example.com") */
+    publicUrl?: string;
+    /** AWS access key ID */
+    accessKeyId: string;
+    /** AWS secret access key */
+    secretAccessKey: string;
+    /** Force path-style URLs (required for MinIO and some S3-compatible services) */
+    forcePathStyle?: boolean;
+}
+export declare class CequreFileS3 implements StorageProvider {
+    private readonly s3Cfg;
+    private readonly s3;
+    private readonly awsClient;
+    private readonly baseUrl;
+    constructor(config: S3Config);
+    saveFile(file: File, options?: {
+        filename?: string;
+    }): Promise<UploadedFile>;
+    initMultipartUpload(options: {
+        filename: string;
+        mimetype: string;
+        size: number;
+    }): Promise<{
+        uploadId: string;
+        filename: string;
+        parts?: {
+            partNumber: number;
+            url: string;
+        }[];
+    }>;
+    completeMultipartUpload(uploadId: string, filename: string, parts: {
+        partNumber: number;
+        etag?: string;
+    }[]): Promise<UploadedFile>;
+    deleteFile(filename: string): Promise<void>;
+    getFileUrl(filename: string): Promise<string | undefined>;
+}
+/**
+ * Creates an S3 storage provider for Cequre uploads.
+ */
+export declare function s3Storage(config: S3Config): StorageProvider;
+//# 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":"AAAA,OAAO,EAAE,KAAK,eAAe,EAAE,KAAK,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAGpF,MAAM,WAAW,QAAQ;IACvB,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,qCAAqC;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,mFAAmF;IACnF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qFAAqF;IACrF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wBAAwB;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,4BAA4B;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,iFAAiF;IACjF,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAyBD,qBAAa,YAAa,YAAW,eAAe;IAClD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAW;IACjC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAc;IACjC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;IACtC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;gBAErB,MAAM,EAAE,QAAQ;IAwCtB,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC;IAqB5E,mBAAmB,CAAC,OAAO,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE;YAAE,UAAU,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;KAAE,CAAC;IAuClL,uBAAuB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC;IA0ClI,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ3C,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;CAahE;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,QAAQ,GAAG,eAAe,CAE3D"}

package/dist/index.js

@@ -0,0 +1,159 @@
+// @bun
+// src/index.ts
+import { ulid } from "@cequrebackends/cequre-ts";
+import { AwsClient } from "aws4fetch";
+
+class CequreFileS3 {
+  s3Cfg;
+  s3;
+  awsClient;
+  baseUrl;
+  constructor(config) {
+    this.s3Cfg = config;
+    const BunS3Client = globalThis.Bun?.S3Client;
+    if (!BunS3Client) {
+      throw new Error("Bun.S3Client is not available. Ensure you are running on Bun >= 1.1.44.");
+    }
+    this.s3 = new BunS3Client({
+      bucket: this.s3Cfg.bucket,
+      region: this.s3Cfg.region,
+      endpoint: this.s3Cfg.endpoint,
+      accessKeyId: this.s3Cfg.accessKeyId,
+      secretAccessKey: this.s3Cfg.secretAccessKey,
+      forcePathStyle: this.s3Cfg.forcePathStyle
+    });
+    this.awsClient = new AwsClient({
+      accessKeyId: this.s3Cfg.accessKeyId,
+      secretAccessKey: this.s3Cfg.secretAccessKey,
+      region: this.s3Cfg.region,
+      service: "s3"
+    });
+    let baseUrl;
+    if (this.s3Cfg.endpoint) {
+      const ep = new URL(this.s3Cfg.endpoint);
+      if (this.s3Cfg.forcePathStyle) {
+        baseUrl = `${ep.origin}/${this.s3Cfg.bucket}`;
+      } else {
+        baseUrl = `${ep.protocol}//${this.s3Cfg.bucket}.${ep.host}`;
+      }
+    } else {
+      baseUrl = `https://${this.s3Cfg.bucket}.s3.${this.s3Cfg.region}.amazonaws.com`;
+    }
+    this.baseUrl = baseUrl;
+  }
+  async saveFile(file, options) {
+    const ext = file.name ? file.name.substring(file.name.lastIndexOf(".")) : "";
+    const filename = options?.filename ?? `${ulid()}${ext}`;
+    try {
+      await this.s3.write(filename, file);
+      const publicUrl = this.s3Cfg.publicUrl ? `${this.s3Cfg.publicUrl.replace(/\/$/, "")}/${filename}` : `/${filename}`;
+      return {
+        filename,
+        originalName: file.name || "upload",
+        mimetype: file.type || "application/octet-stream",
+        size: file.size,
+        url: publicUrl
+      };
+    } catch (err) {
+      throw new Error(`S3 upload failed: ${err instanceof Error ? err.message : String(err)}`);
+    }
+  }
+  async initMultipartUpload(options) {
+    const ext = options.filename.includes(".") ? options.filename.substring(options.filename.lastIndexOf(".")) : "";
+    const filename = `${ulid()}${ext}`;
+    const createUrl = `${this.baseUrl}/${filename}?uploads`;
+    const createReq = await this.awsClient.fetch(createUrl, {
+      method: "POST",
+      headers: {
+        "Content-Type": options.mimetype
+      }
+    });
+    const createText = await createReq.text();
+    if (!createReq.ok) {
+      throw new Error(`Failed to create multipart upload: ${createText}`);
+    }
+    const uploadIdMatch = createText.match(/<UploadId>([\s\S]*?)<\/UploadId>/);
+    if (!uploadIdMatch || !uploadIdMatch[1])
+      throw new Error("Missing UploadId in S3 response");
+    const uploadId = uploadIdMatch[1].trim();
+    const chunkSize = 5 * 1024 * 1024;
+    const totalParts = Math.ceil(options.size / chunkSize);
+    const parts = [];
+    for (let i = 1;i <= totalParts; i++) {
+      const partUrl = `${this.baseUrl}/${filename}?partNumber=${i}&uploadId=${encodeURIComponent(uploadId)}`;
+      const signedUrlReq = await this.awsClient.sign(partUrl, { method: "PUT", aws: { signQuery: true } });
+      parts.push({
+        partNumber: i,
+        url: signedUrlReq.url
+      });
+    }
+    console.log(">>> INIT SUCCESS. UPLOAD_ID:", uploadId);
+    return { uploadId, filename, parts };
+  }
+  async completeMultipartUpload(uploadId, filename, parts) {
+    console.log(">>> COMPLETE STARTED. UPLOAD_ID:", uploadId);
+    const completeUrl = `${this.baseUrl}/${filename}?uploadId=${encodeURIComponent(uploadId)}`;
+    let xml = `<CompleteMultipartUpload>
+`;
+    for (const part of parts.sort((a, b) => a.partNumber - b.partNumber)) {
+      if (!part.etag)
+        throw new Error(`Missing ETag for part ${part.partNumber}`);
+      xml += `  <Part>
+`;
+      xml += `    <PartNumber>${part.partNumber}</PartNumber>
+`;
+      xml += `    <ETag>${part.etag}</ETag>
+`;
+      xml += `  </Part>
+`;
+    }
+    xml += `</CompleteMultipartUpload>`;
+    const completeReq = await this.awsClient.fetch(completeUrl, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/xml"
+      },
+      body: xml
+    });
+    const completeText = await completeReq.text();
+    if (!completeReq.ok) {
+      throw new Error(`Failed to complete multipart upload: ${completeText}`);
+    }
+    const headReq = await this.awsClient.fetch(`${this.baseUrl}/${filename}`, { method: "HEAD" });
+    const size = parseInt(headReq.headers.get("Content-Length") || "0", 10);
+    const mimetype = headReq.headers.get("Content-Type") || "application/octet-stream";
+    const publicUrl = this.s3Cfg.publicUrl ? `${this.s3Cfg.publicUrl.replace(/\/$/, "")}/${filename}` : `/${filename}`;
+    return {
+      filename,
+      originalName: filename,
+      mimetype,
+      size,
+      url: publicUrl
+    };
+  }
+  async deleteFile(filename) {
+    try {
+      await this.s3.delete(filename);
+    } catch (err) {
+      throw new Error(`S3 delete failed: ${err instanceof Error ? err.message : String(err)}`);
+    }
+  }
+  async getFileUrl(filename) {
+    try {
+      return this.s3.file(filename).presign({ expiresIn: 3600 });
+    } catch (err) {
+      console.error("Failed to presign S3 URL", err);
+      if (this.s3Cfg.publicUrl) {
+        return `${this.s3Cfg.publicUrl.replace(/\/$/, "")}/${filename}`;
+      }
+      return `${this.baseUrl}/${filename}`;
+    }
+  }
+}
+function s3Storage(config) {
+  return new CequreFileS3(config);
+}
+export {
+  s3Storage,
+  CequreFileS3
+};

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@cequrebackends/plugin-s3",
+  "version": "0.12.2",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rm -rf dist && bun build ./src/index.ts --outdir ./dist --target bun --packages external && tsc --emitDeclarationOnly"
+  },
+  "dependencies": {
+    "aws4fetch": "^1.0.20"
+  },
+  "devDependencies": {
+    "typescript": "^6.0.3",
+    "@cequrebackends/cequre-ts": "0.12.2"
+  },
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cequrebackends/cequre.git"
+  },
+  "peerDependencies": {
+    "@cequrebackends/cequre-ts": "0.12.2"
+  }
+}