@8ms/helpers 1.1.84 → 1.1.87

package/aws/sqs/addToQueue.d.ts

@@ -0,0 +1,27 @@
+export declare type AddedResponse = {
+    '$metadata': {
+        httpStatusCode: number;
+        requestId: string;
+        extendedRequestId: undefined | string;
+        cfId: undefined | string;
+        attempts: number;
+        totalRetryDelay: number;
+    };
+    MD5OfMessageBody: string;
+    MD5OfMessageAttributes: undefined | string;
+    MD5OfMessageSystemAttributes: undefined | string;
+    MessageId: string;
+    SequenceNumber: string;
+};
+declare type AddToQueue = {
+    data: any;
+    dedupeId: string;
+    groupId?: string;
+    queueId?: string;
+    queueUrl: string;
+};
+/**
+ * https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sqs-examples-send-receive-messages.html
+ */
+declare const addToQueue: ({ data, dedupeId, groupId, queueId, queueUrl }: AddToQueue) => Promise<AddedResponse>;
+export default addToQueue;

package/aws/sqs/addToQueue.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sqs-examples-send-receive-messages.html
+ */
+const addToQueue = async ({ data, dedupeId, groupId, queueId, queueUrl }) => {
+    const { SendMessageCommand } = require('@aws-sdk/client-sqs');
+    let params = {
+        MessageBody: JSON.stringify({
+            queueId,
+            data,
+        }),
+        QueueUrl: queueUrl,
+    };
+    // Required for FIFO
+    if (undefined !== dedupeId) {
+        params["MessageDeduplicationId"] = dedupeId;
+    }
+    // Required for FIFO
+    if (undefined !== groupId) {
+        params["MessageGroupId"] = dedupeId;
+    }
+    const sendData = await global.awsSqsClient.send(new SendMessageCommand(params));
+    return sendData;
+};
+exports.default = addToQueue;

package/aws/sqs/deleteFromQueue.d.ts

@@ -0,0 +1,10 @@
+import { AddedResponse } from './addToQueue';
+declare type DeleteFromQueue = {
+    queueUrl: string;
+    recipientHandle: string;
+};
+/**
+ * Delete a message from a queue.
+ */
+declare const deleteFromQueue: ({ queueUrl, recipientHandle }: DeleteFromQueue) => Promise<AddedResponse>;
+export default deleteFromQueue;

package/aws/sqs/deleteFromQueue.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Delete a message from a queue.
+ */
+const deleteFromQueue = async ({ queueUrl, recipientHandle }) => {
+    const { DeleteMessageCommand } = require('@aws-sdk/client-sqs');
+    const params = {
+        QueueUrl: queueUrl,
+        ReceiptHandle: recipientHandle,
+    };
+    const sendData = await global.awsSqsClient.send(new DeleteMessageCommand(params));
+    return sendData;
+};
+exports.default = deleteFromQueue;

package/aws/sqs/initClient.d.ts

@@ -0,0 +1,10 @@
+import { Config } from '../getConfig';
+declare type InitClient = {
+    config: Config;
+};
+/**
+ * Shorthand function to get the Lambda Client.
+ * Library: @aws-sdk/client-lambda
+ */
+declare const initClient: ({ config }: InitClient) => void;
+export default initClient;

package/aws/sqs/initClient.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 });
+const getConfig_1 = __importDefault(require("../getConfig"));
+global.awsSqsClient = null;
+/**
+ * Shorthand function to get the Lambda Client.
+ * Library: @aws-sdk/client-lambda
+ */
+const initClient = ({ config }) => {
+    if (!global.awsLambdaClient) {
+        const { SQSClient } = require('@aws-sdk/client-sqs');
+        const formattedConfig = (0, getConfig_1.default)({ config });
+        global.awsSqsClient = new SQSClient(formattedConfig);
+    }
+};
+exports.default = initClient;

package/aws/sqs/isEventSqs.d.ts

@@ -0,0 +1 @@
+export {};

package/aws/sqs/isEventSqs.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Check to see if the request is an SQS queued event,
+ */
+const isEventSqs = ({ event }) => {
+    let response = false;
+    if (undefined !== event['Records']) {
+        for (let i = 0; i < event['Records'].length; i++) {
+        }
+    }
+    return response;
+};

package/date/getTodayYmd.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Shorthand to get the current date.
+ */
+declare const getTodayYmd: () => string;
+export default getTodayYmd;

package/date/getTodayYmd.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const format_1 = __importDefault(require("./format"));
+const getToday_1 = __importDefault(require("./getToday"));
+/**
+ * Shorthand to get the current date.
+ */
+const getTodayYmd = () => {
+    const today = (0, getToday_1.default)({ setMidnight: false });
+    const todayYmd = (0, format_1.default)({
+        input: today,
+        dateFormat: 'yyyy-MM-dd',
+        setMidnight: false,
+    });
+    return todayYmd;
+};
+exports.default = getTodayYmd;

package/date/getTodayYmdhis.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Shorthand to get the current timestamp.
+ */
+declare const getTodayYmdhis: () => string;
+export default getTodayYmdhis;

package/date/getTodayYmdhis.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const format_1 = __importDefault(require("./format"));
+const getToday_1 = __importDefault(require("./getToday"));
+/**
+ * Shorthand to get the current timestamp.
+ */
+const getTodayYmdhis = () => {
+    const today = (0, getToday_1.default)({ setMidnight: false });
+    const todayYmdhis = (0, format_1.default)({
+        input: today,
+        dateFormat: 'yyyy-MM-dd HH:mm:ss',
+        setMidnight: false,
+    });
+    return todayYmdhis;
+};
+exports.default = getTodayYmdhis;

package/{deepCrawl → deepcrawl/api}/getData.d.ts

@@ -1,4 +1,4 @@
-import { Response } from '../api/response';
+import { Response } from '../../api/response';
 declare const getData: ({ url }: {
     url: string;
 }) => Promise<Response>;

package/{deepCrawl → deepcrawl/api}/getData.js

@@ -3,15 +3,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const get_1 = __importDefault(require("../axios/get"));
-const response_1 = __importDefault(require("../api/response"));
-const states_1 = __importDefault(require("../api/states"));
+const get_1 = __importDefault(require("../../axios/get"));
+const response_1 = __importDefault(require("../../api/response"));
+const states_1 = __importDefault(require("../../api/states"));
 const getData = async ({ url }) => {
     let response = { ...response_1.default };
     await (0, get_1.default)({
         config: {
             headers: {
-                'X-AUTH-TOKEN': global.deepcrawl.token,
+                'X-AUTH-TOKEN': global.deepcrawlApi.token,
             },
         },
         onError: error => {

package/{deepCrawl → deepcrawl/api}/initClient.js

@@ -3,8 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const post_1 = __importDefault(require("../axios/post"));
-global.deepcrawl = {
+const post_1 = __importDefault(require("../../axios/post"));
+global.deepcrawlApi = {
     lastUpdated: null,
     token: null,
 };
@@ -15,7 +15,7 @@ global.deepcrawl = {
  */
 const initClient = async ({ auth }) => {
     // todo: Or was more than 6 hours ago
-    if (null === global.deepcrawl.token) {
+    if (null === global.deepcrawlApi.token) {
         const apiResponse = await (0, post_1.default)({
             config: {
                 auth: {
@@ -27,7 +27,7 @@ const initClient = async ({ auth }) => {
         });
         // Ensure the value exists
         if (undefined !== apiResponse.data && undefined !== apiResponse.data.token) {
-            global.deepcrawl.token = apiResponse.data.token;
+            global.deepcrawlApi.token = apiResponse.data.token;
         }
     }
 };

package/initClients.d.ts

@@ -11,7 +11,7 @@ declare type InitClients = {
     awsS3?: boolean;
     awsSes?: boolean;
     awsSsm?: boolean;
-    deepCrawl?: {
+    deepcrawlApi?: {
         parameterName: string;
     };
     eskimi?: boolean;
@@ -33,5 +33,5 @@ declare type InitClients = {
 /**
  * Function to simplify initialising the clients.
  */
-declare const initClients: ({ athenaExpress, awsConfig, awsGlue, awsLambda, awsS3, awsSes, awsSsm, deepCrawl, googleAds, googleConfig, googleBigQuery, googleSheets, googleStorage, prisma, }: InitClients) => Promise<void>;
+declare const initClients: ({ athenaExpress, awsConfig, awsGlue, awsLambda, awsS3, awsSes, awsSsm, deepcrawlApi, googleAds, googleConfig, googleBigQuery, googleSheets, googleStorage, prisma, }: InitClients) => Promise<void>;
 export default initClients;

package/initClients.js

@@ -10,7 +10,7 @@ const initClient_4 = __importDefault(require("./aws/s3/initClient"));
 const initClient_5 = __importDefault(require("./aws/ses/initClient"));
 const getParameter_1 = __importDefault(require("./aws/ssm/getParameter"));
 const initClient_6 = __importDefault(require("./aws/ssm/initClient"));
-const initClient_7 = __importDefault(require("./deepCrawl/initClient"));
+const initClient_7 = __importDefault(require("./deepcrawl/api/initClient"));
 const initClient_8 = __importDefault(require("./google/bigQuery/initClient"));
 const initClient_9 = __importDefault(require("./google/sheets/initClient"));
 const initClient_10 = __importDefault(require("./google/storage/initClient"));
@@ -19,7 +19,7 @@ const initClient_12 = __importDefault(require("./prisma/initClient"));
 /**
  * Function to simplify initialising the clients.
  */
-const initClients = async ({ athenaExpress, awsConfig, awsGlue, awsLambda, awsS3, awsSes, awsSsm, deepCrawl, googleAds, googleConfig, googleBigQuery, googleSheets, googleStorage, prisma, }) => {
+const initClients = async ({ athenaExpress, awsConfig, awsGlue, awsLambda, awsS3, awsSes, awsSsm, deepcrawlApi, googleAds, googleConfig, googleBigQuery, googleSheets, googleStorage, prisma, }) => {
     if (athenaExpress) {
         (0, initClient_1.default)({
             config: awsConfig,
@@ -48,18 +48,29 @@ const initClients = async ({ athenaExpress, awsConfig, awsGlue, awsLambda, awsS3
             config: awsConfig,
         });
     }
-    if (awsSsm || deepCrawl || googleAds || googleConfig) {
+    if (awsSsm || deepcrawlApi || googleAds || googleConfig) {
         (0, initClient_6.default)({
             config: awsConfig,
         });
     }
-    // Deepcrawl authentication using SSM Parameter
-    if (deepCrawl) {
-        const deepcrawlParameter = await (0, getParameter_1.default)({
-            name: deepCrawl.parameterName,
+    // Deepcrawl (API) authentication using SSM Parameter
+    if (deepcrawlApi) {
+        const deepcrawlApiParameter = await (0, getParameter_1.default)({
+            name: deepcrawlApi.parameterName,
         });
-        await (0, initClient_7.default)({ auth: deepcrawlParameter });
+        await (0, initClient_7.default)({ auth: deepcrawlApiParameter });
     }
+    /**
+    // Deepcrawl (GraphQL) authentication using SSM Parameter
+    if (deepcrawlGraphql)
+    {
+        const deepcrawlGraphqlParameter = await getParameter({
+            name: deepcrawlApi.parameterName,
+        });
+        
+        await initDeepCrawlGraphql({auth: deepcrawlGraphqlParameter});
+    }
+    */
     // Google authentication using SSM
     if (googleConfig) {
         // Google Parameter

package/package.json

@@ -1,7 +1,7 @@
 {
   "name":            "@8ms/helpers",
   "license":         "UNLICENSED",
-  "version":         "1.1.84",
+  "version":         "1.1.87",
   "repository":      {
 	"type": "git",
 	"url":  "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"
@@ -15,32 +15,38 @@
   "dependencies":    {
 	"axios":       "0.27.2",
 	"crypto-js":   "4.1.1",
-	"date-fns":    "2.29.2",
+	"date-fns":    "2.29.3",
 	"date-fns-tz": "1.3.7",
 	"lodash":      "4.17.21"
   },
   "devDependencies": {
-	"@aws-sdk/client-s3":            "3.163.0",
-	"@aws-sdk/client-ses":           "3.163.0",
-	"@aws-sdk/client-ssm":           "3.163.0",
-	"@aws-sdk/s3-request-presigner": "3.163.0",
-	"@babel/preset-env":             "7.18.10",
-	"@babel/preset-flow":            "7.18.6",
-	"@babel/preset-typescript":      "7.18.6",
-	"@google-cloud/bigquery":        "6.0.2",
-	"@google-cloud/storage":         "6.4.2",
-	"@prisma/client":                "4.3.1",
-	"@types/jest":                   "29.0.0",
-	"@types/lodash":                 "4.14.184",
-	"@types/node":                   "18.7.14",
-	"babel-jest":                    "29.0.2",
-	"jest":                          "29.0.2",
-	"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"
+	"@aws-sdk/client-s3":                          "3.178.0",
+	"@aws-sdk/client-ses":                         "3.178.0",
+	"@aws-sdk/client-sqs":                         "3.178.0",
+	"@aws-sdk/client-ssm":                         "3.178.0",
+	"@aws-sdk/s3-request-presigner":               "3.178.0",
+	"@babel/preset-env":                           "7.19.1",
+	"@babel/preset-flow":                          "7.18.6",
+	"@babel/preset-typescript":                    "7.18.6",
+	"@google-cloud/bigquery":                      "6.0.3",
+	"@google-cloud/storage":                       "6.5.2",
+	"@graphql-codegen/cli":                        "2.12.1",
+	"@graphql-codegen/typescript-graphql-request": "4.5.5",
+	"@graphql-codegen/typescript-operations":      "2.5.3",
+	"@prisma/client":                              "4.3.1",
+	"@types/jest":                                 "29.0.3",
+	"@types/lodash":                               "4.14.185",
+	"@types/node":                                 "18.7.21",
+	"babel-jest":                                  "29.0.3",
+	"graphql":                                     "16.6.0",
+	"graphql-request":                             "5.0.0",
+	"jest":                                        "29.0.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.8.3"
   }
 }