@8ms/helpers 1.1.61 → 1.1.65

package/aws/s3/isFileExists.d.ts

@@ -0,0 +1,9 @@
+declare type IsFileExists = {
+    bucket: string;
+    key: string;
+};
+/**
+ * Check to see if a file exists but don't get the contents.
+ */
+declare const isFileExists: ({ bucket, key }: IsFileExists) => Promise<boolean>;
+export default isFileExists;

package/aws/s3/isFileExists.js

@@ -0,0 +1,76 @@
+"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());
+    });
+};
+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 });
+var isResponse200_1 = __importDefault(require("../isResponse200"));
+/**
+ * Check to see if a file exists but don't get the contents.
+ */
+var isFileExists = function (_a) {
+    var bucket = _a.bucket, key = _a.key;
+    return __awaiter(void 0, void 0, void 0, function () {
+        var response, HeadObjectCommand, apiResponse, exception_1;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    response = false;
+                    _b.label = 1;
+                case 1:
+                    _b.trys.push([1, 3, , 4]);
+                    HeadObjectCommand = require('@aws-sdk/client-s3').HeadObjectCommand;
+                    return [4 /*yield*/, global.awsS3Client.send(new HeadObjectCommand({
+                            Bucket: bucket,
+                            Key: key,
+                        }))];
+                case 2:
+                    apiResponse = _b.sent();
+                    // If the status is 200 then it does exist
+                    response = (0, isResponse200_1.default)({ apiResponse: apiResponse });
+                    return [3 /*break*/, 4];
+                case 3:
+                    exception_1 = _b.sent();
+                    response = false;
+                    return [3 /*break*/, 4];
+                case 4: return [2 /*return*/, response];
+            }
+        });
+    });
+};
+exports.default = isFileExists;

package/initClients.d.ts

@@ -26,5 +26,5 @@ declare type InitClients = {
 /**
  * Function to simplify initialising the clients.
  */
-declare const initClients: ({ athenaExpress, awsConfig, awsGlue, awsS3, awsSes, awsSsm, googleAds, prisma, }: InitClients) => Promise<void>;
+declare const initClients: ({ athenaExpress, awsConfig, awsGlue, awsS3, awsSes, awsSsm, deepCrawl, googleAds, prisma, }: InitClients) => Promise<void>;
 export default initClients;

package/initClients.js

@@ -52,7 +52,7 @@ var initClient_8 = __importDefault(require("./prisma/initClient"));
  * Function to simplify initialising the clients.
  */
 var initClients = function (_a) {
-    var athenaExpress = _a.athenaExpress, awsConfig = _a.awsConfig, awsGlue = _a.awsGlue, awsS3 = _a.awsS3, awsSes = _a.awsSes, awsSsm = _a.awsSsm, googleAds = _a.googleAds, prisma = _a.prisma;
+    var athenaExpress = _a.athenaExpress, awsConfig = _a.awsConfig, awsGlue = _a.awsGlue, awsS3 = _a.awsS3, awsSes = _a.awsSes, awsSsm = _a.awsSsm, deepCrawl = _a.deepCrawl, googleAds = _a.googleAds, prisma = _a.prisma;
     return __awaiter(void 0, void 0, void 0, function () {
         var deepcrawlParameter, googleAdsParameter;
         return __generator(this, function (_b) {
@@ -78,9 +78,9 @@ var initClients = function (_a) {
                     if (true === awsSsm) {
                         (0, initClient_5.default)({ config: awsConfig });
                     }
-                    if (!(undefined !== deepcrawl)) return [3 /*break*/, 3];
+                    if (!(undefined !== deepCrawl)) return [3 /*break*/, 3];
                     return [4 /*yield*/, (0, getParameter_1.default)({
-                            name: deepcrawl.parameterName,
+                            name: deepCrawl.parameterName,
                         })];
                 case 1:
                     deepcrawlParameter = _b.sent();
@@ -101,7 +101,9 @@ var initClients = function (_a) {
                     _b.label = 6;
                 case 6:
                     if (undefined !== prisma) {
-                        (0, initClient_8.default)({ debug: true === prisma ? false : prisma.debug || false });
+                        (0, initClient_8.default)({
+                            debug: true === prisma ? false : prisma.debug || false,
+                        });
                     }
                     return [2 /*return*/];
             }

package/littleWarden/getUrlStatus.d.ts

@@ -0,0 +1,9 @@
+declare type GetUrlStatus = {
+    apiKey: string;
+    urlId: string;
+};
+/**
+ * Get the URL Status for a given URL ID from Little Warden.
+ */
+declare const getUrlStatus: ({ apiKey, urlId }: GetUrlStatus) => Promise<any>;
+export default getUrlStatus;

package/littleWarden/getUrlStatus.js

@@ -0,0 +1,67 @@
+"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());
+    });
+};
+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 });
+var get_1 = __importDefault(require("../axios/get"));
+/**
+ * Get the URL Status for a given URL ID from Little Warden.
+ */
+var getUrlStatus = function (_a) {
+    var apiKey = _a.apiKey, urlId = _a.urlId;
+    return __awaiter(void 0, void 0, void 0, function () {
+        var response;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, (0, get_1.default)({
+                        config: {
+                            headers: {
+                                'Authorization': "Token token=\"".concat(apiKey, "\""),
+                            },
+                        },
+                        url: "https://littlewarden.com/api/sites/".concat(urlId),
+                    })];
+                case 1:
+                    response = _b.sent();
+                    return [2 /*return*/, response.data.site || {}];
+            }
+        });
+    });
+};
+exports.default = getUrlStatus;

package/littleWarden/isAllGood.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Check if the field is All Good.
+ */
+declare const isAllGood: ({ field }: {
+    field: any;
+}) => boolean;
+export default isAllGood;

package/littleWarden/isAllGood.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var states_1 = __importDefault(require("./states"));
+/**
+ * Check if the field is All Good.
+ */
+var isAllGood = function (_a) {
+    var field = _a.field;
+    var response = false;
+    // Check that the status field exists
+    if (undefined !== field && undefined !== field['status']) {
+        response = states_1.default.ALL_GOOD === field['status'];
+    }
+    return response;
+};
+exports.default = isAllGood;

package/littleWarden/isDanger.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Check if the field is Danger.
+ */
+declare const isDanger: ({ field }: {
+    field: any;
+}) => boolean;
+export default isDanger;

package/littleWarden/isDanger.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var states_1 = __importDefault(require("./states"));
+/**
+ * Check if the field is Danger.
+ */
+var isDanger = function (_a) {
+    var field = _a.field;
+    var response = false;
+    // Check that the status field exists
+    if (undefined !== field && undefined !== field['status']) {
+        response = states_1.default.DANGER === field['status'];
+    }
+    return response;
+};
+exports.default = isDanger;

package/littleWarden/isWarning.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Check if the field is Warning.
+ */
+declare const isWarning: ({ field }: {
+    field: any;
+}) => boolean;
+export default isWarning;

package/littleWarden/isWarning.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var states_1 = __importDefault(require("./states"));
+/**
+ * Check if the field is Warning.
+ */
+var isWarning = function (_a) {
+    var field = _a.field;
+    var response = false;
+    // Check that the status field exists
+    if (undefined !== field && undefined !== field['status']) {
+        response = states_1.default.WARNING === field['status'];
+    }
+    return response;
+};
+exports.default = isWarning;

package/littleWarden/states.d.ts

@@ -0,0 +1,7 @@
+declare const states: {
+    ALL_GOOD: string;
+    DANGER: string;
+    WARNING: string;
+};
+export declare type State = typeof states.ALL_GOOD | typeof states.DANGER | typeof states.WARNING;
+export default states;

package/littleWarden/states.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var states = {
+    ALL_GOOD: 'all_good',
+    DANGER: 'danger',
+    WARNING: 'warning',
+};
+exports.default = states;

package/package.json

@@ -1,45 +1,45 @@
 {
-	"name": "@8ms/helpers",
-	"license": "UNLICENSED",
-	"version": "1.1.61",
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"
-	},
-	"main": "index.js",
-	"types": "index.d.ts",
-	"scripts": {
-		"build": "rimraf dist && tsc",
-		"jest": "jest --watch"
-	},
-	"dependencies": {
-		"axios": "0.27.2",
-		"crypto-js": "4.1.1",
-		"date-fns": "2.29.2",
-		"date-fns-tz": "1.3.6",
-		"lodash": "4.17.21"
-	},
-	"devDependencies": {
-		"@aws-sdk/client-s3": "3.157.0",
-		"@aws-sdk/client-ses": "3.154.0",
-		"@aws-sdk/client-ssm": "3.154.0",
-		"@aws-sdk/s3-request-presigner": "3.157.0",
-		"@babel/preset-env": "7.18.10",
-		"@babel/preset-flow": "7.18.6",
-		"@babel/preset-typescript": "7.18.6",
-		"@google-cloud/storage": "6.4.1",
-		"@prisma/client": "4.2.1",
-		"@types/jest": "28.1.8",
-		"@types/lodash": "4.14.184",
-		"@types/node": "18.7.13",
-		"babel-jest": "28.1.3",
-		"jest": "28.1.3",
-		"node-fetch": "3.2.10",
-		"numbro": "2.3.6",
-		"prisma-query-log": "3.2.0",
-		"timezone-mock": "1.3.4",
-		"ts-node": "10.9.1",
-		"tslib": "2.4.0",
-		"typescript": "4.7.4"
-	}
+  "name":            "@8ms/helpers",
+  "license":         "UNLICENSED",
+  "version":         "1.1.65",
+  "repository":      {
+	"type": "git",
+	"url":  "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"
+  },
+  "main":            "index.js",
+  "types":           "index.d.ts",
+  "scripts":         {
+	"build": "tsc",
+	"jest":  "jest --watch"
+  },
+  "dependencies":    {
+	"axios":       "0.27.2",
+	"crypto-js":   "4.1.1",
+	"date-fns":    "2.29.2",
+	"date-fns-tz": "1.3.6",
+	"lodash":      "4.17.21"
+  },
+  "devDependencies": {
+	"@aws-sdk/client-s3":            "3.161.0",
+	"@aws-sdk/client-ses":           "3.161.0",
+	"@aws-sdk/client-ssm":           "3.161.0",
+	"@aws-sdk/s3-request-presigner": "3.161.0",
+	"@babel/preset-env":             "7.18.10",
+	"@babel/preset-flow":            "7.18.6",
+	"@babel/preset-typescript":      "7.18.6",
+	"@google-cloud/storage":         "6.4.1",
+	"@prisma/client":                "4.3.0",
+	"@types/jest":                   "29.0.0",
+	"@types/lodash":                 "4.14.184",
+	"@types/node":                   "18.7.14",
+	"babel-jest":                    "29.0.1",
+	"jest":                          "29.0.1",
+	"node-fetch":                    "3.2.10",
+	"numbro":                        "2.3.6",
+	"prisma-query-log":              "3.2.0",
+	"timezone-mock":                 "1.3.4",
+	"ts-node":                       "10.9.1",
+	"tslib":                         "2.4.0",
+	"typescript":                    "4.8.2"
+  }
 }

package/aws/config.d.ts

@@ -1,5 +0,0 @@
-export declare type Config = {
-    accessKeyId: string;
-    region: string;
-    secretAccessKey: string;
-};

package/aws/config.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });