@meridianjs/storage-s3 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,36 @@
+import * as _meridianjs_types from '@meridianjs/types';
+import { IStorageProvider, MeridianContainer } from '@meridianjs/types';
+
+interface S3StorageOptions {
+    bucket: string;
+    region: string;
+    accessKeyId?: string;
+    secretAccessKey?: string;
+    /** MinIO / localstack / custom S3-compatible endpoint */
+    endpoint?: string;
+    /** CloudFront distribution URL, e.g. "https://d1abc.cloudfront.net". Takes precedence over baseUrl. */
+    cloudfrontUrl?: string;
+    /** Any other CDN base URL. cloudfrontUrl takes precedence if both are provided. */
+    baseUrl?: string;
+}
+
+declare class S3StorageService implements IStorageProvider {
+    private readonly client;
+    private readonly options;
+    private readonly publicBaseUrl;
+    constructor(container: MeridianContainer);
+    upload(file: {
+        buffer: Buffer;
+        originalname: string;
+        mimetype: string;
+        size: number;
+    }, subDir: string): Promise<{
+        url: string;
+        key: string;
+    }>;
+    delete(urlOrKey: string): Promise<void>;
+}
+
+declare const _default: _meridianjs_types.ModuleDefinition;
+
+export { type S3StorageOptions, S3StorageService, _default as default };

package/dist/index.d.ts

@@ -0,0 +1,36 @@
+import * as _meridianjs_types from '@meridianjs/types';
+import { IStorageProvider, MeridianContainer } from '@meridianjs/types';
+
+interface S3StorageOptions {
+    bucket: string;
+    region: string;
+    accessKeyId?: string;
+    secretAccessKey?: string;
+    /** MinIO / localstack / custom S3-compatible endpoint */
+    endpoint?: string;
+    /** CloudFront distribution URL, e.g. "https://d1abc.cloudfront.net". Takes precedence over baseUrl. */
+    cloudfrontUrl?: string;
+    /** Any other CDN base URL. cloudfrontUrl takes precedence if both are provided. */
+    baseUrl?: string;
+}
+
+declare class S3StorageService implements IStorageProvider {
+    private readonly client;
+    private readonly options;
+    private readonly publicBaseUrl;
+    constructor(container: MeridianContainer);
+    upload(file: {
+        buffer: Buffer;
+        originalname: string;
+        mimetype: string;
+        size: number;
+    }, subDir: string): Promise<{
+        url: string;
+        key: string;
+    }>;
+    delete(urlOrKey: string): Promise<void>;
+}
+
+declare const _default: _meridianjs_types.ModuleDefinition;
+
+export { type S3StorageOptions, S3StorageService, _default as default };

package/dist/index.js

@@ -0,0 +1,112 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  S3StorageService: () => S3StorageService,
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var import_framework_utils = require("@meridianjs/framework-utils");
+
+// src/service.ts
+var import_node_crypto = require("crypto");
+var import_node_path = __toESM(require("path"));
+var import_client_s3 = require("@aws-sdk/client-s3");
+var S3StorageService = class {
+  client;
+  options;
+  publicBaseUrl;
+  constructor(container) {
+    const opts = container.resolve("moduleOptions");
+    if (!opts?.bucket) {
+      throw new Error(
+        "[@meridianjs/storage-s3] Missing required option: 'bucket'. Add bucket and region to your storage-s3 module config."
+      );
+    }
+    if (!opts?.region) {
+      throw new Error(
+        "[@meridianjs/storage-s3] Missing required option: 'region'. Add region to your storage-s3 module config."
+      );
+    }
+    this.options = opts;
+    const clientConfig = {
+      region: opts.region
+    };
+    if (opts.endpoint) {
+      clientConfig.endpoint = opts.endpoint;
+      clientConfig.forcePathStyle = true;
+    }
+    if (opts.accessKeyId && opts.secretAccessKey) {
+      clientConfig.credentials = {
+        accessKeyId: opts.accessKeyId,
+        secretAccessKey: opts.secretAccessKey
+      };
+    }
+    this.client = new import_client_s3.S3Client(clientConfig);
+    this.publicBaseUrl = (opts.cloudfrontUrl ?? opts.baseUrl ?? `https://${opts.bucket}.s3.${opts.region}.amazonaws.com`).replace(/\/$/, "");
+  }
+  async upload(file, subDir) {
+    const ext = import_node_path.default.extname(file.originalname);
+    const key = `${subDir}/${(0, import_node_crypto.randomUUID)()}${ext}`;
+    await this.client.send(
+      new import_client_s3.PutObjectCommand({
+        Bucket: this.options.bucket,
+        Key: key,
+        Body: file.buffer,
+        ContentType: file.mimetype
+      })
+    );
+    return { url: `${this.publicBaseUrl}/${key}`, key };
+  }
+  async delete(urlOrKey) {
+    let key;
+    if (urlOrKey.startsWith("http")) {
+      key = urlOrKey.replace(`${this.publicBaseUrl}/`, "");
+    } else {
+      key = urlOrKey;
+    }
+    await this.client.send(
+      new import_client_s3.DeleteObjectCommand({
+        Bucket: this.options.bucket,
+        Key: key
+      })
+    );
+  }
+};
+
+// src/index.ts
+var index_default = (0, import_framework_utils.Module)("storageProvider", {
+  service: S3StorageService
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  S3StorageService
+});

package/dist/index.mjs

@@ -0,0 +1,77 @@
+// src/index.ts
+import { Module } from "@meridianjs/framework-utils";
+
+// src/service.ts
+import { randomUUID } from "crypto";
+import path from "path";
+import { S3Client, PutObjectCommand, DeleteObjectCommand } from "@aws-sdk/client-s3";
+var S3StorageService = class {
+  client;
+  options;
+  publicBaseUrl;
+  constructor(container) {
+    const opts = container.resolve("moduleOptions");
+    if (!opts?.bucket) {
+      throw new Error(
+        "[@meridianjs/storage-s3] Missing required option: 'bucket'. Add bucket and region to your storage-s3 module config."
+      );
+    }
+    if (!opts?.region) {
+      throw new Error(
+        "[@meridianjs/storage-s3] Missing required option: 'region'. Add region to your storage-s3 module config."
+      );
+    }
+    this.options = opts;
+    const clientConfig = {
+      region: opts.region
+    };
+    if (opts.endpoint) {
+      clientConfig.endpoint = opts.endpoint;
+      clientConfig.forcePathStyle = true;
+    }
+    if (opts.accessKeyId && opts.secretAccessKey) {
+      clientConfig.credentials = {
+        accessKeyId: opts.accessKeyId,
+        secretAccessKey: opts.secretAccessKey
+      };
+    }
+    this.client = new S3Client(clientConfig);
+    this.publicBaseUrl = (opts.cloudfrontUrl ?? opts.baseUrl ?? `https://${opts.bucket}.s3.${opts.region}.amazonaws.com`).replace(/\/$/, "");
+  }
+  async upload(file, subDir) {
+    const ext = path.extname(file.originalname);
+    const key = `${subDir}/${randomUUID()}${ext}`;
+    await this.client.send(
+      new PutObjectCommand({
+        Bucket: this.options.bucket,
+        Key: key,
+        Body: file.buffer,
+        ContentType: file.mimetype
+      })
+    );
+    return { url: `${this.publicBaseUrl}/${key}`, key };
+  }
+  async delete(urlOrKey) {
+    let key;
+    if (urlOrKey.startsWith("http")) {
+      key = urlOrKey.replace(`${this.publicBaseUrl}/`, "");
+    } else {
+      key = urlOrKey;
+    }
+    await this.client.send(
+      new DeleteObjectCommand({
+        Bucket: this.options.bucket,
+        Key: key
+      })
+    );
+  }
+};
+
+// src/index.ts
+var index_default = Module("storageProvider", {
+  service: S3StorageService
+});
+export {
+  S3StorageService,
+  index_default as default
+};

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@meridianjs/storage-s3",
+  "version": "0.1.0",
+  "description": "S3-compatible storage module for Meridian file uploads",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean",
+    "dev": "tsup src/index.ts --format esm,cjs --dts --watch",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.0.0",
+    "@meridianjs/framework-utils": "^0.1.0",
+    "@meridianjs/types": "^0.1.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.3.5",
+    "typescript": "*"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}