@aligent/microservice-util-lib 0.1.1

package/dist/s3/s3.js

@@ -0,0 +1,196 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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 (g && (g = 0, op[0] && (_ = 0)), _) 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 __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
+var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var g = generator.apply(thisArg, _arguments || []), i, q = [];
+    return i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i;
+    function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }
+    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
+    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
+    function fulfill(value) { resume("next", value); }
+    function reject(value) { resume("throw", value); }
+    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var aws_sdk_1 = require("aws-sdk");
+var object_hash_1 = __importDefault(require("object-hash"));
+var chunkBy_1 = __importDefault(require("../chunkBy/chunkBy"));
+/** A data access object for an S3 bucket */
+var S3Dao = /** @class */ (function () {
+    /**
+     * @param bucket the location of the bucket that objects should be stored in
+     */
+    function S3Dao(bucket) {
+        this.bucket = bucket;
+        this.s3 = new aws_sdk_1.S3();
+    }
+    /**
+     * Store data in an S3 bucket
+     * @param data the data to store
+     * @param name the name to call the object in S3 @default the hash of the data
+     * @returns an object which can be used to fetch the data
+     */
+    S3Dao.prototype.storeData = function (data, name) {
+        return __awaiter(this, void 0, void 0, function () {
+            var getObject;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (typeof data === 'undefined') {
+                            throw new Error('data is undefined');
+                        }
+                        getObject = {
+                            Bucket: this.bucket,
+                            Key: name || (0, object_hash_1.default)(data)
+                        };
+                        return [4 /*yield*/, this.s3.putObject(__assign(__assign({}, getObject), { Body: JSON.stringify(data) })).promise()];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/, getObject];
+                }
+            });
+        });
+    };
+    /**
+     * Store an array of object as individual chunks in S3
+     * @param data the data to store
+     * @param chunkSize the number of entries that should be in each chunk
+     * @returns an array of objects which can be used to fetch the chunks
+     */
+    S3Dao.prototype.storeChunked = function (data, chunkSize) {
+        return __awaiter(this, void 0, void 0, function () {
+            var chunks;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        chunks = (0, chunkBy_1.default)(data, chunkSize);
+                        return [4 /*yield*/, Promise.all(chunks.map(function (chunk) { return _this.storeData(chunk); }))];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * Fetch an object from the S3 bucket
+     * @param objectDetails the object which describes the location of the object
+     * @returns the body of the object
+     */
+    S3Dao.prototype.fetchData = function (objectDetails) {
+        return __awaiter(this, void 0, void 0, function () {
+            var data;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.s3.getObject(objectDetails).promise()];
+                    case 1:
+                        data = _a.sent();
+                        return [2 /*return*/, JSON.parse(data.Body.toString())];
+                }
+            });
+        });
+    };
+    /**
+     * Generator to fetch chunked data, chunk by chunk
+     * @param chunks the list of object chunks
+     */
+    S3Dao.prototype.fetchChunks = function (chunks) {
+        return __asyncGenerator(this, arguments, function fetchChunks_1() {
+            var i, chunk, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        i = 0;
+                        _a.label = 1;
+                    case 1:
+                        if (!(i < chunks.length)) return [3 /*break*/, 8];
+                        return [4 /*yield*/, __await(this.fetchData(chunks[i]))];
+                    case 2:
+                        chunk = _a.sent();
+                        response = {
+                            chunk: chunk,
+                            s3Object: chunks[i]
+                        };
+                        if (!(i === chunks.length - 1)) return [3 /*break*/, 4];
+                        return [4 /*yield*/, __await(response)];
+                    case 3: return [2 /*return*/, _a.sent()];
+                    case 4: return [4 /*yield*/, __await(response)];
+                    case 5: return [4 /*yield*/, _a.sent()];
+                    case 6:
+                        _a.sent();
+                        _a.label = 7;
+                    case 7:
+                        i++;
+                        return [3 /*break*/, 1];
+                    case 8: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Delete an object from the S3 bucket
+     * @param objectDetails the object to delete
+     */
+    S3Dao.prototype.deleteData = function (objectDetails) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.s3.deleteObject(objectDetails).promise()];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    return S3Dao;
+}());
+exports.default = S3Dao;
+//# sourceMappingURL=s3.js.map

package/dist/s3/s3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3.js","sourceRoot":"","sources":["../../src/s3/s3.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAA6B;AAC7B,4DAA+B;AAE/B,+DAAyC;AAEzC,4CAA4C;AAC5C;IAIE;;OAEG;IACH,eAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,GAAG,IAAI,YAAE,EAAE,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACU,yBAAS,GAAtB,UACE,IAAO,EACP,IAAa;;;;;;wBAEb,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;4BAC/B,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;yBACtC;wBACK,SAAS,GAAwB;4BACrC,MAAM,EAAE,IAAI,CAAC,MAAM;4BACnB,GAAG,EAAE,IAAI,IAAI,IAAA,qBAAI,EAAC,IAAW,CAAC;yBAC/B,CAAC;wBAEF,qBAAM,IAAI,CAAC,EAAE,CAAC,SAAS,uBAClB,SAAS,KACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAC1B,CAAC,OAAO,EAAE,EAAA;;wBAHZ,SAGY,CAAC;wBAEb,sBAAO,SAAS,EAAC;;;;KAClB;IAED;;;;;OAKG;IACU,4BAAY,GAAzB,UAA2C,IAAO,EAAE,SAAiB;;;;;;;wBAC7D,MAAM,GAAG,IAAA,iBAAO,EAAC,IAAI,EAAE,SAAS,CAAC,CAAC;wBACjC,qBAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,UAAA,KAAK,IAAI,OAAA,KAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAArB,CAAqB,CAAC,CAAC,EAAA;4BAApE,sBAAO,SAA6D,EAAC;;;;KACtE;IAED;;;;OAIG;IACU,yBAAS,GAAtB,UAA0B,aAAkC;;;;;4BAC7C,qBAAM,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,OAAO,EAAE,EAAA;;wBAAvD,IAAI,GAAG,SAAgD;wBAC7D,sBAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAC;;;;KACzC;IAED;;;OAGG;IACW,2BAAW,GAAzB,UAA6B,MAA6B;;;;;;wBAC/C,CAAC,GAAG,CAAC;;;6BAAE,CAAA,CAAC,GAAG,MAAM,CAAC,MAAM,CAAA;wBACd,6BAAM,IAAI,CAAC,SAAS,CAAI,MAAM,CAAC,CAAC,CAAC,CAAC,GAAA;;wBAA7C,KAAK,GAAM,SAAkC;wBAE7C,QAAQ,GAAG;4BACf,KAAK,OAAA;4BACL,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;yBACpB,CAAC;6BAEE,CAAA,CAAC,KAAK,MAAM,CAAC,MAAM,GAAG,CAAC,CAAA,EAAvB,wBAAuB;qDAClB,QAAQ;4BAAf,iCAAgB;yDAEZ,QAAQ;4BAAd,gCAAc;;wBAAd,SAAc,CAAC;;;wBAXkB,CAAC,EAAE,CAAA;;;;;;KAavC;IAED;;;OAGG;IACU,0BAAU,GAAvB,UAAwB,aAAkC;;;;4BACjD,qBAAM,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,OAAO,EAAE,EAAA;4BAA1D,sBAAO,SAAmD,EAAC;;;;KAC5D;IACH,YAAC;AAAD,CAAC,AAtFD,IAsFC;AAED,kBAAe,KAAK,CAAC"}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@aligent/microservice-util-lib",
+  "version": "0.1.1",
+  "description": "A set of utility functions for Aligent Microservices",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc",
+    "lint": "eslint src/*.ts src/**/*.ts",
+    "lint:fix": "eslint --fix src/*.ts src/**/*.ts",
+    "test": "npm run lint && npm run test:types && npm run test:jest",
+    "test:jest": "jest src/",
+    "test:types": "tsc --noEmit",
+    "docs": "typedoc --readme none --githubPages false --plugin typedoc-plugin-markdown --entryDocument modules.md --namedAnchors true --out docs src/index.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@bitbucket.org/aligent/microservices-utilities.git"
+  },
+  "author": "Aligent",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/jest": "^29.2.4",
+    "@types/lodash": "^4.14.191",
+    "@types/node": "^18.11.17",
+    "@types/object-hash": "^3.0.2",
+    "@typescript-eslint/eslint-plugin": "^5.46.1",
+    "@typescript-eslint/parser": "^5.46.1",
+    "eslint": "^8.30.0",
+    "jest": "^29.3.1",
+    "ts-jest": "^29.0.3",
+    "typedoc": "^0.23.23",
+    "typedoc-plugin-markdown": "^3.14.0",
+    "typescript": "^4.9.4"
+  },
+  "dependencies": {
+    "aws-sdk": "^2.1281.0",
+    "axios": "^1.2.1",
+    "lodash": "^4.17.21",
+    "object-hash": "^3.0.0"
+  },
+  "files": [
+    "dist"
+  ]
+}