@flink-app/s3-plugin 0.3.5

package/.flink/generated-schemas.json

@@ -0,0 +1,311 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/Schemas",
+  "definitions": {
+    "ConnectSession": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "userId": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "id",
+        "userId"
+      ],
+      "additionalProperties": false
+    },
+    "createStripeCustomerOptions": {
+      "type": "object",
+      "properties": {
+        "userId": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "email": {
+          "type": "string"
+        },
+        "metaData": {
+          "$ref": "#/definitions/createStripeCustomerMetaData"
+        },
+        "name": {
+          "type": "string"
+        },
+        "phone": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "userId"
+      ],
+      "additionalProperties": false
+    },
+    "createStripeCustomerMetaData": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "string"
+      }
+    },
+    "stripePluginOptions": {
+      "type": "object",
+      "properties": {
+        "baseUrl": {
+          "type": "string"
+        },
+        "stripeSecreteKey": {
+          "type": "string"
+        },
+        "stripePublishableKey": {
+          "type": "string"
+        },
+        "JTW_TOKEN": {
+          "type": "string"
+        },
+        "logo": {
+          "type": "string"
+        },
+        "redirectUrl": {
+          "type": "string"
+        },
+        "stripeConnectClientID": {
+          "type": "string"
+        },
+        "phrases": {
+          "type": "object",
+          "properties": {
+            "setupDescription": {
+              "type": "string"
+            },
+            "setupButtonText": {
+              "type": "string"
+            },
+            "setupDoneMessage": {
+              "type": "string"
+            },
+            "paymentSelectCardPayButtonText": {
+              "type": "string"
+            },
+            "paymentSelectCardChangeCardButtonText": {
+              "type": "string"
+            },
+            "paymentDoneMessage": {
+              "type": "string"
+            },
+            "paymentEnterCardPayButtonText": {
+              "type": "string"
+            },
+            "connectDoneMessage": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "setupDoneMessage",
+            "connectDoneMessage"
+          ],
+          "additionalProperties": false
+        },
+        "templates": {
+          "type": "object",
+          "properties": {
+            "master": {
+              "type": "string"
+            },
+            "style": {
+              "type": "string"
+            },
+            "setupCard": {
+              "type": "string"
+            },
+            "setupDone": {
+              "type": "string"
+            },
+            "error": {
+              "type": "string"
+            },
+            "paySelectCard": {
+              "type": "string"
+            },
+            "payEnterCard": {
+              "type": "string"
+            },
+            "connectDone": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "stripeSecreteKey",
+        "stripePublishableKey",
+        "JTW_TOKEN"
+      ],
+      "additionalProperties": false
+    },
+    "connectToStripeConnectOptions": {
+      "type": "object",
+      "properties": {
+        "userId": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "userId"
+      ],
+      "additionalProperties": false
+    },
+    "hasPaymentMethodOptions": {
+      "type": "object",
+      "properties": {
+        "stripeCustomerId": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "stripeCustomerId"
+      ],
+      "additionalProperties": false
+    },
+    "setupCardOptions": {
+      "type": "object",
+      "properties": {
+        "stripeCustomerId": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "stripeCustomerId"
+      ],
+      "additionalProperties": false
+    },
+    "setupCardResponse": {
+      "type": "object",
+      "properties": {
+        "token": {
+          "type": "string"
+        },
+        "redirectUrl": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "token",
+        "redirectUrl"
+      ],
+      "additionalProperties": false
+    },
+    "setupCardTokenOptions": {
+      "type": "object",
+      "properties": {
+        "stripeCustomerId": {
+          "type": "string"
+        },
+        "client_secret": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "client_secret",
+        "stripeCustomerId"
+      ],
+      "additionalProperties": false
+    },
+    "capturePaymentOptions": {
+      "type": "object",
+      "properties": {
+        "paymentIntentId": {
+          "type": "string"
+        },
+        "amount": {
+          "type": "number"
+        }
+      },
+      "required": [
+        "paymentIntentId",
+        "amount"
+      ],
+      "additionalProperties": false
+    },
+    "confirmPaymentOptions": {
+      "type": "object",
+      "properties": {
+        "paymentIntentId": {
+          "type": "string"
+        },
+        "background": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "paymentIntentId"
+      ],
+      "additionalProperties": false
+    },
+    "confirmPaymentResponse": {
+      "type": "object",
+      "properties": {
+        "paymentIntentId": {
+          "type": "string"
+        },
+        "confirmed": {
+          "type": "boolean"
+        },
+        "captured": {
+          "type": "boolean"
+        },
+        "token": {
+          "type": "string"
+        },
+        "redirectUrl": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "paymentIntentId",
+        "confirmed",
+        "captured"
+      ],
+      "additionalProperties": false
+    },
+    "confirmPaymentTokenOptions": {
+      "type": "object",
+      "properties": {
+        "paymentIntentId": {
+          "type": "string"
+        },
+        "client_secret": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "paymentIntentId",
+        "client_secret"
+      ],
+      "additionalProperties": false
+    },
+    "createPaymentResponse": {
+      "type": "object",
+      "properties": {
+        "paymentIntentId": {
+          "type": "string"
+        },
+        "token": {
+          "type": "string"
+        },
+        "paymentUrl": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "paymentIntentId",
+        "token"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/.flink/generatedHandlers.ts

@@ -0,0 +1,7 @@
+// Generated Wed Mar 02 2022 13:43:22 GMT+0100 (Central European Standard Time)
+import { autoRegisteredHandlers, HttpMethod } from "@flink-app/flink";
+import * as HandlebarsTemplateHandler_0 from "../src/handlers/HandlebarsTemplateHandler";
+
+export const handlers = [];
+autoRegisteredHandlers.push(...handlers);
+    

package/.flink/generatedRepos.ts

@@ -0,0 +1,5 @@
+// Generated Wed Mar 02 2022 13:43:22 GMT+0100 (Central European Standard Time)
+  import { autoRegisteredRepos } from "@flink-app/flink";
+  export const repos = [];
+  autoRegisteredRepos.push(...repos);
+      

package/.flink/schemas/schemas.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/Schemas",
+  "definitions": {}
+}

package/.flink/schemas/schemas.ts

@@ -0,0 +1 @@
+// Generated Wed Mar 02 2022 13:43:22 GMT+0100 (Central European Standard Time)

package/.flink/start.ts

@@ -0,0 +1,4 @@
+// Generated Wed Mar 02 2022 13:43:22 GMT+0100 (Central European Standard Time)
+import "./generatedHandlers";
+import "./generatedRepos";
+import "../src/index";

package/dist/.flink/generatedHandlers.d.ts

@@ -0,0 +1 @@
+export declare const handlers: never[];

package/dist/.flink/generatedHandlers.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handlers = void 0;
+// Generated Wed Mar 02 2022 13:43:22 GMT+0100 (Central European Standard Time)
+var flink_1 = require("@flink-app/flink");
+exports.handlers = [];
+flink_1.autoRegisteredHandlers.push.apply(flink_1.autoRegisteredHandlers, exports.handlers);

package/dist/.flink/generatedRepos.d.ts

@@ -0,0 +1 @@
+export declare const repos: never[];

package/dist/.flink/generatedRepos.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.repos = void 0;
+// Generated Wed Mar 02 2022 13:43:22 GMT+0100 (Central European Standard Time)
+var flink_1 = require("@flink-app/flink");
+exports.repos = [];
+flink_1.autoRegisteredRepos.push.apply(flink_1.autoRegisteredRepos, exports.repos);

package/dist/.flink/schemas/schemas.js

@@ -0,0 +1,2 @@
+"use strict";
+// Generated Wed Mar 02 2022 13:43:22 GMT+0100 (Central European Standard Time)

package/dist/.flink/schemas/schemas.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$ref": "#/definitions/Schemas",
+    "definitions": {}
+}

package/dist/.flink/start.d.ts

@@ -0,0 +1,3 @@
+import "./generatedHandlers";
+import "./generatedRepos";
+import "../src/index";

package/dist/.flink/start.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// Generated Wed Mar 02 2022 13:43:22 GMT+0100 (Central European Standard Time)
+require("./generatedHandlers");
+require("./generatedRepos");
+require("../src/index");

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import { FlinkPlugin } from "@flink-app/flink";
+import { s3PluginOptions } from "./schemas/s3PluginOptions";
+export * from "./s3PluginContext";
+export declare const s3Plugin: (options: s3PluginOptions) => FlinkPlugin;

package/dist/index.js

@@ -0,0 +1,172 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.s3Plugin = void 0;
+var flink_1 = require("@flink-app/flink");
+__exportStar(require("./s3PluginContext"), exports);
+var s3Client_1 = __importDefault(require("./s3Client"));
+var express_fileupload_1 = __importDefault(require("express-fileupload"));
+var uuid = __importStar(require("uuid"));
+var mime_types_1 = __importDefault(require("mime-types"));
+var s3Plugin = function (options) {
+    var s3Client = new s3Client_1.default({
+        accessKeyId: options.accessKeyId,
+        secretAccessKey: options.secretAccessKey,
+        bucket: options.bucket,
+        s3Acl: options.s3Acl,
+        endpoint: options.endpoint,
+    });
+    return {
+        id: "s3Plugin",
+        init: function (app) { return init(app, options); },
+        ctx: {
+            s3Client: s3Client,
+        },
+    };
+};
+exports.s3Plugin = s3Plugin;
+function init(app, options) {
+    var _this = this;
+    if (options.enableUpload) {
+        var maxFileSize = options.maxFileSize || 10;
+        app.expressApp.use((0, express_fileupload_1.default)({
+            limits: { fileSize: maxFileSize * 1024 * 1024 },
+            abortOnLimit: true,
+        }));
+        var uploadUrl = options.uploadUrl || "/file-upload";
+        app.expressApp.post(uploadUrl, function (req, res) { return __awaiter(_this, void 0, void 0, function () {
+            var authenticated, file, path, s3Client, fileSplit, fileExt, filename, uploadData, ex_1;
+            var _a, _b;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (!options.uploadPermissionRequired) return [3 /*break*/, 2];
+                        return [4 /*yield*/, ((_a = app.ctx.auth) === null || _a === void 0 ? void 0 : _a.authenticateRequest(req, [options.uploadPermissionRequired]))];
+                    case 1:
+                        authenticated = (_c.sent());
+                        if (!authenticated) {
+                            res.status(500).json({
+                                status: 500,
+                                error: { id: uuid.v4(), title: "Permission denied", detail: "Permission denied to this endpoint", code: "permissionDenied" },
+                            });
+                            return [2 /*return*/];
+                        }
+                        _c.label = 2;
+                    case 2:
+                        file = (_b = req.files) === null || _b === void 0 ? void 0 : _b.file;
+                        if (!file) {
+                            res.status(500).json({ status: 500, error: { id: uuid.v4(), title: "No file", detail: "No file specified", code: "badRequest" } });
+                            return [2 /*return*/];
+                        }
+                        path = req.query.path;
+                        s3Client = app.ctx.plugins.s3Plugin.s3Client;
+                        if (s3Client == null) {
+                            res.status(500).json({
+                                status: 500,
+                                error: { id: uuid.v4(), title: "Plugin not initialized", detail: "S3 Client not initialized", code: "badRequest" },
+                            });
+                            return [2 /*return*/];
+                        }
+                        fileSplit = file.name.split(".");
+                        fileExt = fileSplit.length > 1 ? fileSplit[fileSplit.length - 1] : mime_types_1.default.extension(file.mimetype);
+                        filename = formatS3Path(path ? path : "") + uuid.v4() + "." + fileExt;
+                        _c.label = 3;
+                    case 3:
+                        _c.trys.push([3, 5, , 6]);
+                        return [4 /*yield*/, s3Client.uploadFile(filename, file.data, file.mimetype)];
+                    case 4:
+                        uploadData = _c.sent();
+                        res.json({
+                            url: uploadData.Location,
+                        });
+                        return [3 /*break*/, 6];
+                    case 5:
+                        ex_1 = _c.sent();
+                        res.status(500).json({
+                            status: 500,
+                            error: { id: uuid.v4(), title: "Internal server error", detail: "Internal server errror while communicating with S3", code: "badRequest" },
+                        });
+                        return [3 /*break*/, 6];
+                    case 6: return [2 /*return*/];
+                }
+            });
+        }); });
+        flink_1.log.info("Registered route POST " + uploadUrl);
+    }
+}
+function formatS3Path(path) {
+    path = path.trim();
+    if (path) {
+        if (path.startsWith("/")) {
+            path = path.substr(1);
+        }
+        if (!path.endsWith("/")) {
+            path = path + "/";
+        }
+    }
+    return path;
+}

package/dist/s3Client.d.ts

@@ -0,0 +1,36 @@
+/// <reference types="node" />
+import AWS from "aws-sdk";
+import S3, { ManagedUpload, ObjectIdentifierList } from "aws-sdk/clients/s3";
+import { ListObjectResponse } from "./schemas/ListObjectsResponse";
+import { s3ClientOptions } from "./schemas/s3ClientOptions";
+declare class S3Client {
+    private s3Bucket;
+    private awsAccessKeyId;
+    private awsSecretAccessKey;
+    private s3Endpoint;
+    private s3Acl;
+    s3: AWS.S3;
+    constructor(options: s3ClientOptions);
+    checkIfExists(fileName: string): Promise<boolean>;
+    uploadFile(fileName: string, data: Buffer, mime?: string): Promise<ManagedUpload.SendData>;
+    getSignedUrl(key: string, expires?: number): Promise<unknown>;
+    deleteObject(file: string, version?: string): Promise<import("aws-sdk/lib/request").PromiseResult<S3.DeleteObjectOutput, AWS.AWSError>>;
+    /**
+     * Delete files from s3 bucket
+     *
+     * @param {Array<Object>} files
+     *
+     * @returns {Promise}
+     */
+    deleteObjects(files: ObjectIdentifierList): Promise<import("aws-sdk/lib/request").PromiseResult<S3.DeleteObjectsOutput, AWS.AWSError>>;
+    getObject(key: string): Promise<{
+        data: S3.Body;
+        mimetype: string | undefined;
+    }>;
+    getObjects(): Promise<ListObjectResponse>;
+    /**
+     * This use only for unit tests
+     */
+    deleteBucket(): Promise<void>;
+}
+export default S3Client;