@etohq/file-s3 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("@etohq/types").ModuleProviderExports;
+export default _default;
+//# 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":";AAKA,wBAEE"}

package/dist/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@etohq/framework/utils");
+const s3_file_1 = require("./services/s3-file");
+const services = [s3_file_1.S3FileService];
+exports.default = (0, utils_1.ModuleProvider)(utils_1.Modules.FILE, {
+    services,
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAAA,kDAAgE;AAChE,gDAAkD;AAElD,MAAM,QAAQ,GAAG,CAAC,uBAAa,CAAC,CAAA;AAEhC,kBAAe,IAAA,sBAAc,EAAC,eAAO,CAAC,IAAI,EAAE;IAC1C,QAAQ;CACT,CAAC,CAAA"}

package/dist/services/s3-file.d.ts

@@ -0,0 +1,32 @@
+import { S3Client } from "@aws-sdk/client-s3";
+import { FileTypes, Logger, S3FileServiceOptions } from "@etohq/framework/types";
+import { AbstractFileProviderService } from "@etohq/framework/utils";
+type InjectedDependencies = {
+    logger: Logger;
+};
+interface S3FileServiceConfig {
+    fileUrl: string;
+    accessKeyId?: string;
+    secretAccessKey?: string;
+    authenticationMethod?: "access-key" | "s3-iam-role";
+    region: string;
+    bucket: string;
+    prefix?: string;
+    endpoint?: string;
+    cacheControl?: string;
+    downloadFileDuration?: number;
+    additionalClientConfig?: Record<string, any>;
+}
+export declare class S3FileService extends AbstractFileProviderService {
+    static identifier: string;
+    protected config_: S3FileServiceConfig;
+    protected logger_: Logger;
+    protected client_: S3Client;
+    constructor({ logger }: InjectedDependencies, options: S3FileServiceOptions);
+    protected getClient(): S3Client;
+    upload(file: FileTypes.ProviderUploadFileDTO): Promise<FileTypes.ProviderFileResultDTO>;
+    delete(file: FileTypes.ProviderDeleteFileDTO): Promise<void>;
+    getPresignedDownloadUrl(fileData: FileTypes.ProviderGetFileDTO): Promise<string>;
+}
+export {};
+//# sourceMappingURL=s3-file.d.ts.map

package/dist/services/s3-file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3-file.d.ts","sourceRoot":"","sources":["../../src/services/s3-file.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,QAAQ,EAET,MAAM,oBAAoB,CAAA;AAE3B,OAAO,EACL,SAAS,EACT,MAAM,EACN,oBAAoB,EACrB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EACL,2BAA2B,EAE5B,MAAM,wBAAwB,CAAA;AAI/B,KAAK,oBAAoB,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,UAAU,mBAAmB;IAC3B,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,oBAAoB,CAAC,EAAE,YAAY,GAAG,aAAa,CAAA;IACnD,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAC7B,sBAAsB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC7C;AAED,qBAAa,aAAc,SAAQ,2BAA2B;IAC5D,MAAM,CAAC,UAAU,SAAO;IACxB,SAAS,CAAC,OAAO,EAAE,mBAAmB,CAAA;IACtC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAA;IACzB,SAAS,CAAC,OAAO,EAAE,QAAQ,CAAA;gBAEf,EAAE,MAAM,EAAE,EAAE,oBAAoB,EAAE,OAAO,EAAE,oBAAoB;IAgC3E,SAAS,CAAC,SAAS;IAoBb,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,GACpC,OAAO,CAAC,SAAS,CAAC,qBAAqB,CAAC;IAoDrC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAc5D,uBAAuB,CAC3B,QAAQ,EAAE,SAAS,CAAC,kBAAkB,GACrC,OAAO,CAAC,MAAM,CAAC;CAWnB"}

package/dist/services/s3-file.js

@@ -0,0 +1,118 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.S3FileService = void 0;
+const client_s3_1 = require("@aws-sdk/client-s3");
+const s3_request_presigner_1 = require("@aws-sdk/s3-request-presigner");
+const utils_1 = require("@etohq/framework/utils");
+const path_1 = __importDefault(require("path"));
+const ulid_1 = require("ulid");
+class S3FileService extends utils_1.AbstractFileProviderService {
+    constructor({ logger }, options) {
+        super();
+        const authenticationMethod = options.authentication_method ?? "access-key";
+        if (authenticationMethod === "access-key" &&
+            (!options.access_key_id || !options.secret_access_key)) {
+            throw new utils_1.EtoError(utils_1.EtoError.Types.INVALID_DATA, `Access key ID and secret access key are required when using access key authentication`);
+        }
+        this.config_ = {
+            fileUrl: options.file_url,
+            accessKeyId: options.access_key_id,
+            secretAccessKey: options.secret_access_key,
+            authenticationMethod: authenticationMethod,
+            region: options.region,
+            bucket: options.bucket,
+            prefix: options.prefix ?? "",
+            endpoint: options.endpoint,
+            cacheControl: options.cache_control ?? "public, max-age=31536000",
+            downloadFileDuration: options.download_file_duration ?? 60 * 60,
+            additionalClientConfig: options.additional_client_config ?? {},
+        };
+        this.logger_ = logger;
+        this.client_ = this.getClient();
+    }
+    getClient() {
+        // If none is provided, the SDK will use the default credentials provider chain, see https://docs.aws.amazon.com/cli/v1/userguide/cli-configure-envvars.html
+        const credentials = this.config_.authenticationMethod === "access-key"
+            ? {
+                accessKeyId: this.config_.accessKeyId,
+                secretAccessKey: this.config_.secretAccessKey,
+            }
+            : undefined;
+        const config = {
+            credentials,
+            region: this.config_.region,
+            endpoint: this.config_.endpoint,
+            ...this.config_.additionalClientConfig,
+        };
+        return new client_s3_1.S3Client(config);
+    }
+    async upload(file) {
+        if (!file) {
+            throw new utils_1.EtoError(utils_1.EtoError.Types.INVALID_DATA, `No file provided`);
+        }
+        if (!file.filename) {
+            throw new utils_1.EtoError(utils_1.EtoError.Types.INVALID_DATA, `No filename provided`);
+        }
+        const parsedFilename = path_1.default.parse(file.filename);
+        // TODO: Allow passing a full path for storage per request, not as a global config.
+        const fileKey = `${this.config_.prefix}${parsedFilename.name}-${(0, ulid_1.ulid)()}${parsedFilename.ext}`;
+        const content = Buffer.from(file.content, "binary");
+        const command = new client_s3_1.PutObjectCommand({
+            // We probably also want to support a separate bucket altogether for private files
+            // protected private_bucket_: string
+            // protected private_access_key_id_: string
+            // protected private_secret_access_key_: string
+            ACL: file.access === "public" ? "public-read" : "private",
+            Bucket: this.config_.bucket,
+            Body: content,
+            Key: fileKey,
+            ContentType: file.mimeType,
+            CacheControl: this.config_.cacheControl,
+            // Note: We could potentially set the content disposition when uploading,
+            // but storing the original filename as metadata should suffice.
+            Metadata: {
+                "x-amz-meta-original-filename": file.filename,
+            },
+        });
+        try {
+            await this.client_.send(command);
+        }
+        catch (e) {
+            this.logger_.error(e);
+            throw e;
+        }
+        return {
+            url: `${this.config_.fileUrl}/${fileKey}`,
+            key: fileKey,
+        };
+    }
+    async delete(file) {
+        const command = new client_s3_1.DeleteObjectCommand({
+            Bucket: this.config_.bucket,
+            Key: file.fileKey,
+        });
+        try {
+            await this.client_.send(command);
+        }
+        catch (e) {
+            // TODO: Rethrow depending on the error (eg. a file not found error is fine, but a failed request should be rethrown)
+            this.logger_.error(e);
+        }
+    }
+    async getPresignedDownloadUrl(fileData) {
+        // TODO: Allow passing content disposition when getting a presigned URL
+        const command = new client_s3_1.GetObjectCommand({
+            Bucket: this.config_.bucket,
+            Key: `${fileData.fileKey}`,
+        });
+        return await (0, s3_request_presigner_1.getSignedUrl)(this.client_, command, {
+            expiresIn: this.config_.downloadFileDuration,
+        });
+    }
+}
+exports.S3FileService = S3FileService;
+S3FileService.identifier = "s3";
+//# sourceMappingURL=s3-file.js.map

package/dist/services/s3-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3-file.js","sourceRoot":"","sources":["../../src/services/s3-file.ts"],"names":[],"mappings":";;;;;;AAAA,kDAM2B;AAC3B,wEAA4D;AAM5D,kDAG+B;AAC/B,gDAAuB;AACvB,+BAA2B;AAoB3B,MAAa,aAAc,SAAQ,mCAA2B;IAM5D,YAAY,EAAE,MAAM,EAAwB,EAAE,OAA6B;QACzE,KAAK,EAAE,CAAA;QAEP,MAAM,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,IAAI,YAAY,CAAA;QAE1E,IACE,oBAAoB,KAAK,YAAY;YACrC,CAAC,CAAC,OAAO,CAAC,aAAa,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,EACtD,CAAC;YACD,MAAM,IAAI,gBAAQ,CAChB,gBAAQ,CAAC,KAAK,CAAC,YAAY,EAC3B,uFAAuF,CACxF,CAAA;QACH,CAAC;QAED,IAAI,CAAC,OAAO,GAAG;YACb,OAAO,EAAE,OAAO,CAAC,QAAQ;YACzB,WAAW,EAAE,OAAO,CAAC,aAAa;YAClC,eAAe,EAAE,OAAO,CAAC,iBAAiB;YAC1C,oBAAoB,EAAE,oBAAoB;YAC1C,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;YAC5B,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,YAAY,EAAE,OAAO,CAAC,aAAa,IAAI,0BAA0B;YACjE,oBAAoB,EAAE,OAAO,CAAC,sBAAsB,IAAI,EAAE,GAAG,EAAE;YAC/D,sBAAsB,EAAE,OAAO,CAAC,wBAAwB,IAAI,EAAE;SAC/D,CAAA;QACD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;IACjC,CAAC;IAES,SAAS;QACjB,4JAA4J;QAC5J,MAAM,WAAW,GACf,IAAI,CAAC,OAAO,CAAC,oBAAoB,KAAK,YAAY;YAChD,CAAC,CAAC;gBACE,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,WAAY;gBACtC,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,eAAgB;aAC/C;YACH,CAAC,CAAC,SAAS,CAAA;QAEf,MAAM,MAAM,GAAuB;YACjC,WAAW;YACX,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;YAC3B,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;YAC/B,GAAG,IAAI,CAAC,OAAO,CAAC,sBAAsB;SACvC,CAAA;QAED,OAAO,IAAI,oBAAQ,CAAC,MAAM,CAAC,CAAA;IAC7B,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAAqC;QAErC,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,gBAAQ,CAAC,gBAAQ,CAAC,KAAK,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAA;QACrE,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,MAAM,IAAI,gBAAQ,CAChB,gBAAQ,CAAC,KAAK,CAAC,YAAY,EAC3B,sBAAsB,CACvB,CAAA;QACH,CAAC;QAED,MAAM,cAAc,GAAG,cAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAEhD,mFAAmF;QACnF,MAAM,OAAO,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,cAAc,CAAC,IAAI,IAAI,IAAA,WAAI,GAAE,GACpE,cAAc,CAAC,GACjB,EAAE,CAAA;QAEF,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;QACnD,MAAM,OAAO,GAAG,IAAI,4BAAgB,CAAC;YACnC,kFAAkF;YAClF,oCAAoC;YACpC,2CAA2C;YAC3C,+CAA+C;YAE/C,GAAG,EAAE,IAAI,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS;YACzD,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;YAC3B,IAAI,EAAE,OAAO;YACb,GAAG,EAAE,OAAO;YACZ,WAAW,EAAE,IAAI,CAAC,QAAQ;YAC1B,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY;YACvC,yEAAyE;YACzE,gEAAgE;YAChE,QAAQ,EAAE;gBACR,8BAA8B,EAAE,IAAI,CAAC,QAAQ;aAC9C;SACF,CAAC,CAAA;QAEF,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAClC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YACrB,MAAM,CAAC,CAAA;QACT,CAAC;QAED,OAAO;YACL,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,OAAO,EAAE;YACzC,GAAG,EAAE,OAAO;SACb,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,IAAqC;QAChD,MAAM,OAAO,GAAG,IAAI,+BAAmB,CAAC;YACtC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;YAC3B,GAAG,EAAE,IAAI,CAAC,OAAO;SAClB,CAAC,CAAA;QAEF,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAClC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,qHAAqH;YACrH,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QACvB,CAAC;IACH,CAAC;IAED,KAAK,CAAC,uBAAuB,CAC3B,QAAsC;QAEtC,uEAAuE;QACvE,MAAM,OAAO,GAAG,IAAI,4BAAgB,CAAC;YACnC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;YAC3B,GAAG,EAAE,GAAG,QAAQ,CAAC,OAAO,EAAE;SAC3B,CAAC,CAAA;QAEF,OAAO,MAAM,IAAA,mCAAY,EAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE;YAC/C,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,oBAAoB;SAC7C,CAAC,CAAA;IACJ,CAAC;;AA1IH,sCA2IC;AA1IQ,wBAAU,GAAG,IAAI,CAAA"}

package/dist/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../src/index.ts","../src/services/s3-file.ts"],"version":"5.6.2"}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@etohq/file-s3",
+  "version": "1.0.0",
+  "description": "S3 protocol file storage for Eto. Supports any S3-compatible storage provider",
+  "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/etohq/eto",
+    "directory": "packages/file-local"
+  },
+  "files": [
+    "dist",
+    "!dist/**/__tests__",
+    "!dist/**/__mocks__",
+    "!dist/**/__fixtures__"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "author": "Eto",
+  "license": "MIT",
+  "scripts": {
+    "test": "jest --passWithNoTests src",
+    "test:integration": "jest --forceExit -- integration-tests/__tests__/*.spec.ts",
+    "build": "rimraf dist && tsc --build ./tsconfig.json",
+    "watch": "tsc --watch"
+  },
+  "devDependencies": {
+    "@etohq/framework": "^1.0.0",
+    "@swc/core": "^1.7.28",
+    "@swc/jest": "^0.2.36",
+    "axios": "^0.21.4",
+    "jest": "^29.7.0",
+    "rimraf": "^5.0.2",
+    "typescript": "^5.6.2"
+  },
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.556.0",
+    "@aws-sdk/s3-request-presigner": "^3.556.0",
+    "awilix": "^8.0.1",
+    "ulid": "^2.3.0"
+  },
+  "peerDependencies": {
+    "@etohq/framework": "^1.0.0"
+  },
+  "keywords": [
+    "eto-plugin",
+    "eto-plugin-s3"
+  ]
+}