@quatrain/storage-s3 0.3.0 → 1.1.7

package/lib/S3StorageAdapter.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import { AbstractStorageAdapter, FileType, FileResponseLinkType, StorageParameters, DownloadFileMetaType } from '@quatrain/storage';
 import { Readable, Stream } from 'stream';
 import { S3Client } from '@aws-sdk/client-s3';

package/package.json

@@ -1,36 +1,37 @@
 {
-   "name": "@quatrain/storage-s3",
-   "version": "0.3.0",
-   "description": "Storage adapter for S3 compatible services",
-   "main": "lib/index.js",
-   "types": "lib/index.d.ts",
-   "files": [
-      "lib/",
-      "README.md"
-   ],
-   "author": "Quatrain Développement SAS <developers@quatrain.com>",
-   "license": "MIT",
-   "devDependencies": {
-      "@tsconfig/recommended": "^1.0.1",
-      "@types/jest": "^27.0.3",
-      "jest": "^27.4.7",
-      "jest-node-exports-resolver": "^1.1.6",
-      "trace-unhandled": "^2.0.1",
-      "ts-jest": "^27.1.2",
-      "ts-node": "^10.4.0",
-      "typescript": "^5.1.5"
-   },
-   "dependencies": {
-      "@aws-sdk/client-s3": "^3.337.0",
-      "@aws-sdk/s3-request-presigner": "^3.342.0",
-      "@quatrain/storage": "^0.1.1",
-      "fs-extra": "^11.2.0"
-   },
-   "scripts": {
-      "test": "tsc && jest --verbose",
-      "build": "tsc --watch",
-      "patch": "yarn version --patch --no-git-tag-version",
-      "push": "yarn publish --access public",
-      "prepublish": "tsc"
-   }
-}
+  "name": "@quatrain/storage-s3",
+  "version": "1.1.7",
+  "description": "Storage adapter for S3 compatible services",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib/",
+    "README.md"
+  ],
+  "author": "Quatrain Développement SAS <developers@quatrain.com>",
+  "license": "MIT",
+  "devDependencies": {
+    "@tsconfig/recommended": "^1.0.1",
+    "@types/jest": "^27.0.3",
+    "@types/node": "^22.10.1",
+    "jest": "^27.4.7",
+    "jest-node-exports-resolver": "^1.1.6",
+    "trace-unhandled": "^2.0.1",
+    "ts-jest": "^27.1.2",
+    "ts-node": "^10.4.0",
+    "typescript": "^5.1.5"
+  },
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.337.0",
+    "@aws-sdk/s3-request-presigner": "^3.342.0",
+    "@quatrain/storage": "^1.1.7",
+    "fs-extra": "^11.2.0"
+  },
+  "scripts": {
+    "test": "tsc && jest --verbose",
+    "build": "tsc",
+    "wbuild": "tsc --watch",
+    "bump-to": "yarn version",
+    "publish": "yarn build && yarn npm publish --access public"
+  }
+}

package/lib/AwsStorageAdapter.d.ts

@@ -1,23 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { AbstractStorageAdapter, FileType, FileResponseLinkType, StorageParameters, DownloadFileMetaType } from '@quatrain/storage';
-import { Readable, Stream } from 'stream';
-import { S3Client } from '@aws-sdk/client-s3';
-export declare class S3StorageAdapter extends AbstractStorageAdapter {
-    protected _client: S3Client;
-    constructor(params: StorageParameters);
-    getDriver(): S3Client;
-    streamToBuffer(stream: Stream): Promise<Buffer>;
-    create(file: FileType, stream: Readable): Promise<FileType>;
-    copy(file: FileType, destFile: FileType): Promise<void>;
-    move(file: FileType, destFile: FileType): Promise<void>;
-    getUrl(file: FileType, expiresIn?: number): Promise<{
-        url: string;
-        expiresIn: number;
-    }>;
-    delete(file: FileType): Promise<boolean>;
-    getReadable(file: FileType): Promise<Readable>;
-    stream(file: FileType, res: any): Promise<any>;
-    download(file: FileType, meta: DownloadFileMetaType): Promise<string>;
-    getUploadUrl(file: FileType, expiresIn?: number): Promise<FileResponseLinkType>;
-}

package/lib/AwsStorageAdapter.js

@@ -1,168 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.S3StorageAdapter = void 0;
-const storage_1 = require("@quatrain/storage");
-const stream_1 = require("stream");
-const s3_request_presigner_1 = require("@aws-sdk/s3-request-presigner");
-const fs_1 = require("fs");
-const client_s3_1 = require("@aws-sdk/client-s3");
-class S3StorageAdapter extends storage_1.AbstractStorageAdapter {
-    constructor(params) {
-        super(params);
-        const config = {
-            forcePathStyle: true,
-            region: this._params.config.region,
-            endpoint: this._params.config.endpoint,
-            credentials: {
-                accessKeyId: this._params.config.accesskey,
-                secretAccessKey: this._params.config.secret,
-            },
-        };
-        this._client = new client_s3_1.S3Client(config);
-        storage_1.Storage.log(`AWS Storage Adapter initialized in ${this._params.config.region}`);
-    }
-    getDriver() {
-        return this._client;
-    }
-    streamToBuffer(stream) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return new Promise((resolve, reject) => {
-                const _buf = [];
-                stream.on('data', (chunk) => _buf.push(chunk));
-                stream.on('end', () => resolve(Buffer.concat(_buf)));
-                stream.on('error', (err) => reject(err));
-            });
-        });
-    }
-    create(file, stream) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const input = {
-                Bucket: file.bucket || this._params.config.bucket,
-                Key: file.ref,
-                Body: yield this.streamToBuffer(stream),
-                ContentType: file.contentType,
-            };
-            storage_1.Storage.log(`Uploading ${file.ref} to ${file.bucket}`);
-            const command = new client_s3_1.PutObjectCommand(input);
-            yield this._client.send(command);
-            return file;
-        });
-    }
-    copy(file, destFile) {
-        return __awaiter(this, void 0, void 0, function* () {
-            storage_1.Storage.log(`Copying file ${file.ref} to ${destFile.ref}`);
-            const command = new client_s3_1.CopyObjectCommand({
-                CopySource: encodeURI(`${file.bucket}/${file.ref}`),
-                Bucket: file.bucket,
-                Key: encodeURI(destFile.ref),
-            });
-            try {
-                const response = yield this._client.send(command);
-                console.log(response);
-            }
-            catch (err) {
-                console.error(err);
-            }
-        });
-    }
-    move(file, destFile) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                yield this.copy(file, destFile);
-                yield this.delete(file);
-            }
-            catch (err) {
-                console.log(err);
-            }
-        });
-    }
-    getUrl(file, expiresIn = 3600) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const command = new client_s3_1.GetObjectCommand({
-                Bucket: file.bucket,
-                Key: encodeURI(file.ref),
-            });
-            const url = yield (0, s3_request_presigner_1.getSignedUrl)(this._client, command, { expiresIn });
-            return { url, expiresIn };
-        });
-    }
-    delete(file) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            storage_1.Storage.log(`Deleting file ${file.ref}`);
-            const command = new client_s3_1.DeleteObjectCommand({
-                Bucket: file.bucket,
-                Key: file.ref,
-            });
-            yield ((_a = this._client) === null || _a === void 0 ? void 0 : _a.send(command));
-            storage_1.Storage.log('Object successfully deleted.');
-            return true;
-        });
-    }
-    getReadable(file) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function* () {
-            storage_1.Storage.log('GET Readable :', file.ref);
-            const command = new client_s3_1.GetObjectCommand({
-                Bucket: file.bucket || this._params.config.bucket,
-                Key: file.ref,
-            });
-            const item = yield ((_a = this._client) === null || _a === void 0 ? void 0 : _a.send(command));
-            const ByteArray = yield ((_b = item === null || item === void 0 ? void 0 : item.Body) === null || _b === void 0 ? void 0 : _b.transformToByteArray());
-            const buffer = Buffer.from(ByteArray, 'base64');
-            const readable = new stream_1.Readable();
-            readable.push(buffer);
-            readable.push(null);
-            return readable;
-        });
-    }
-    stream(file, res) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            const command = new client_s3_1.GetObjectCommand({
-                Bucket: file.bucket,
-                Key: file.ref,
-            });
-            const item = yield this._client.send(command);
-            const ByteArray = yield ((_a = item.Body) === null || _a === void 0 ? void 0 : _a.transformToByteArray());
-            const buffer = Buffer.from(ByteArray, 'base64');
-            const readable = new stream_1.Readable();
-            readable.push(buffer);
-            readable.push(null);
-            return readable.pipe(res);
-        });
-    }
-    download(file, meta) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const stream = yield this.getReadable(file);
-            yield new Promise((res) => stream.pipe((0, fs_1.createWriteStream)(meta.path)).on('close', res));
-            return meta.path;
-        });
-    }
-    getUploadUrl(file, expiresIn = 3600) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const input = {
-                Bucket: file.bucket || this._params.config.bucket,
-                Key: file.ref,
-            };
-            const command = new client_s3_1.PutObjectCommand(input);
-            const url = yield (0, s3_request_presigner_1.getSignedUrl)(this._client, command, { expiresIn });
-            return {
-                href: url,
-                type: 'PUT',
-                accept: file.contentType || 'application/octet-stream',
-                expiresIn,
-            };
-        });
-    }
-}
-exports.S3StorageAdapter = S3StorageAdapter;

package/lib/s3.d.ts

@@ -1,24 +0,0 @@
-import { FileType, FileResponseUrl } from '@quatrain/core';
-import { S3Client } from '@aws-sdk/client-s3';
-export declare const s3Bucket: any;
-export declare const s3Client: S3Client;
-/**
- * Move file to AWS
- * @param gcsFrom source file metadata
- * @param awsTo destination file metadata
- * @returns destination bucket name
- */
-export declare const moveFile: (gcsFrom: FileType, awsTo: FileType) => Promise<string>;
-/**
- * Returns a temporary public url matching the provided metadata
- * @param file
- * @returns
- */
-export declare const getPublicUrl: (file: FileType, expiresIn?: number) => Promise<FileResponseUrl>;
-/**
- * Delete the file matching the provided metadata
- * @param file
- * @returns
- */
-export declare const deleteFile: (file: FileType) => Promise<import("@aws-sdk/client-s3").DeleteObjectCommandOutput>;
-export declare const streamFile: (file: FileType, res: any) => Promise<any>;

package/lib/s3.js

@@ -1,93 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.streamFile = exports.deleteFile = exports.getPublicUrl = exports.moveFile = exports.s3Client = exports.s3Bucket = void 0;
-const s3_request_presigner_1 = require("@aws-sdk/s3-request-presigner");
-const client_s3_1 = require("@aws-sdk/client-s3");
-const storage_1 = require("@google-cloud/storage");
-const stream_1 = require("stream");
-const functions = require('firebase-functions');
-const { accesskey, secret, s3: { bucket, region }, } = functions.config().aws || {};
-exports.s3Bucket = bucket;
-const config = {
-    region,
-    credentials: {
-        accessKeyId: accesskey,
-        secretAccessKey: secret,
-    },
-};
-exports.s3Client = new client_s3_1.S3Client(config);
-/**
- * Move file to AWS
- * @param gcsFrom source file metadata
- * @param awsTo destination file metadata
- * @returns destination bucket name
- */
-const moveFile = (gcsFrom, awsTo) => __awaiter(void 0, void 0, void 0, function* () {
-    const storage = new storage_1.Storage();
-    const fileRef = storage.bucket(gcsFrom.bucket).file(gcsFrom.ref);
-    const fileStream = fileRef.createReadStream();
-    if (!gcsFrom.size || gcsFrom.contentType) {
-        const metadata = (yield fileRef.getMetadata())[0];
-        gcsFrom.size = metadata.size;
-        gcsFrom.contentType = metadata.contentType;
-    }
-    const input = {
-        Bucket: awsTo.bucket,
-        Key: awsTo.ref,
-        Body: fileStream,
-        ContentType: gcsFrom.contentType,
-        ContentLength: gcsFrom.size,
-    };
-    console.log(`Moving ${gcsFrom.ref} from GCP to ${awsTo.ref} at AWS`);
-    const command = new client_s3_1.PutObjectCommand(input);
-    yield exports.s3Client.send(command);
-    return awsTo.bucket;
-});
-exports.moveFile = moveFile;
-/**
- * Returns a temporary public url matching the provided metadata
- * @param file
- * @returns
- */
-const getPublicUrl = (file, expiresIn = 3600) => __awaiter(void 0, void 0, void 0, function* () {
-    const command = new client_s3_1.GetObjectCommand({ Bucket: file.bucket, Key: file.ref });
-    const url = yield (0, s3_request_presigner_1.getSignedUrl)(exports.s3Client, command, { expiresIn });
-    return { url, expiresIn };
-});
-exports.getPublicUrl = getPublicUrl;
-/**
- * Delete the file matching the provided metadata
- * @param file
- * @returns
- */
-const deleteFile = (file) => __awaiter(void 0, void 0, void 0, function* () {
-    const command = new client_s3_1.DeleteObjectCommand({
-        Bucket: file.bucket,
-        Key: file.ref,
-    });
-    const data = yield exports.s3Client.send(command);
-    console.log('Success. Object deleted.', data);
-    return data;
-});
-exports.deleteFile = deleteFile;
-const streamFile = (file, res) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a;
-    const command = new client_s3_1.GetObjectCommand({ Bucket: file.bucket, Key: file.ref });
-    const item = yield exports.s3Client.send(command);
-    const ByteArray = yield ((_a = item.Body) === null || _a === void 0 ? void 0 : _a.transformToByteArray());
-    const buffer = Buffer.from(ByteArray, 'base64');
-    const readable = new stream_1.Readable();
-    readable.push(buffer);
-    readable.push(null);
-    return readable.pipe(res);
-});
-exports.streamFile = streamFile;