@8ms/helpers 1.37.0 → 1.38.0

package/aws/ecs/getClusters.d.ts

@@ -0,0 +1,9 @@
+type GetClusters = {
+    maxResults?: number;
+};
+/**
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ecs/command/ListClustersCommand/
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ecs/Interface/ListClustersCommandInput/
+ */
+export declare const getClusters: (props: GetClusters) => Promise<string[]>;
+export {};

package/aws/ecs/getClusters.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getClusters = void 0;
+const isResponse200_1 = __importDefault(require("../isResponse200"));
+/**
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ecs/command/ListClustersCommand/
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ecs/Interface/ListClustersCommandInput/
+ */
+const getClusters = async (props) => {
+    let response = [];
+    let apiResponse = null;
+    const { ListClustersCommand } = require("@aws-sdk/client-ecs");
+    while (null === apiResponse || apiResponse?.nextToken) {
+        const listClustersCommand = new ListClustersCommand({
+            maxResults: props?.maxResults,
+            nextToken: apiResponse?.nextToken,
+        });
+        apiResponse = await global.awsEcsClient.send(listClustersCommand);
+        // console.log("listClustersResponse", apiResponse);
+        if ((0, isResponse200_1.default)({ apiResponse })) {
+            response = [
+                ...response,
+                ...apiResponse.clusterArns,
+            ];
+        }
+    }
+    return response;
+};
+exports.getClusters = getClusters;

package/aws/ecs/getTaskDefinitions.d.ts

@@ -0,0 +1,13 @@
+import { SortOrder, TaskDefinitionStatus } from "@aws-sdk/client-ecs";
+type GetTaskDefinitions = {
+    familyPrefix?: string;
+    maxResults?: number;
+    sort?: SortOrder;
+    status?: TaskDefinitionStatus;
+};
+/**
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ecs/command/ListTaskDefinitionsCommand/
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ecs/Interface/ListTaskDefinitionsCommandInput/
+ */
+export declare const getTaskDefinitions: (props: GetTaskDefinitions) => Promise<string[]>;
+export {};

package/aws/ecs/getTaskDefinitions.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTaskDefinitions = void 0;
+const isResponse200_1 = __importDefault(require("../isResponse200"));
+/**
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ecs/command/ListTaskDefinitionsCommand/
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ecs/Interface/ListTaskDefinitionsCommandInput/
+ */
+const getTaskDefinitions = async (props) => {
+    let response = [];
+    let apiResponse = null;
+    const { ListTaskDefinitionsCommand } = require("@aws-sdk/client-ecs");
+    while (null === apiResponse || apiResponse?.nextToken) {
+        const listTaskDefinitionsCommand = new ListTaskDefinitionsCommand({
+            maxResults: props?.maxResults,
+            familyPrefix: props?.familyPrefix,
+            sort: props?.sort,
+            status: props?.status,
+            nextToken: apiResponse?.nextToken,
+        });
+        apiResponse = await global.awsEcsClient.send(listTaskDefinitionsCommand);
+        // console.log("listTaskDefinitionsResponse", apiResponse);
+        if ((0, isResponse200_1.default)({ apiResponse })) {
+            response = [
+                ...response,
+                ...apiResponse.taskDefinitionArns,
+            ];
+        }
+    }
+    return response;
+};
+exports.getTaskDefinitions = getTaskDefinitions;

package/aws/ecs/getTasks.d.ts

@@ -0,0 +1,16 @@
+import { DesiredStatus } from "@aws-sdk/client-ecs";
+type GetTasks = {
+    cluster?: string;
+    containerInstance?: string;
+    desiredStatus?: DesiredStatus;
+    family?: string;
+    maxResults?: number;
+    serviceName?: string;
+    startedBy?: string;
+};
+/**
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ecs/command/ListTasksCommand/
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ecs/Interface/ListTasksCommandInput/
+ */
+export declare const getTasks: (props: GetTasks) => Promise<string[]>;
+export {};

package/aws/ecs/getTasks.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTasks = void 0;
+const isResponse200_1 = __importDefault(require("../isResponse200"));
+/**
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ecs/command/ListTasksCommand/
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ecs/Interface/ListTasksCommandInput/
+ */
+const getTasks = async (props) => {
+    let response = [];
+    let apiResponse = null;
+    const { ListTasksCommand } = require("@aws-sdk/client-ecs");
+    while (null === apiResponse || apiResponse?.nextToken) {
+        const listTasksCommand = new ListTasksCommand({
+            cluster: props?.cluster,
+            containerInstance: props?.containerInstance,
+            desiredStatus: props?.desiredStatus,
+            family: props?.family,
+            maxResults: props?.maxResults,
+            nextToken: apiResponse?.nextToken,
+            serviceName: props?.serviceName,
+            startedBy: props?.startedBy,
+        });
+        apiResponse = await global.awsEcsClient.send(listTasksCommand);
+        // console.log("listClustersResponse", apiResponse);
+        if ((0, isResponse200_1.default)({ apiResponse })) {
+            response = [
+                ...response,
+                ...apiResponse.taskArns,
+            ];
+        }
+    }
+    return response;
+};
+exports.getTasks = getTasks;

package/aws/ecs/initClient.d.ts

@@ -0,0 +1,11 @@
+import { Config } from "../getConfig";
+type InitClient = {
+    config: Config;
+};
+/**
+ * Shorthand function to get the ECS Client.
+ * Library: @aws-sdk/client-ecs
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ecs/
+ */
+export declare const initClient: (props: InitClient) => void;
+export {};

package/aws/ecs/initClient.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initClient = void 0;
+const getConfig_1 = __importDefault(require("../getConfig"));
+global.awsEcsClient = null;
+/**
+ * Shorthand function to get the ECS Client.
+ * Library: @aws-sdk/client-ecs
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ecs/
+ */
+const initClient = (props) => {
+    if (!global.awsEcsClient) {
+        const { ECSClient } = require("@aws-sdk/client-ecs");
+        const formattedConfig = (0, getConfig_1.default)({
+            config: props.config
+        });
+        global.awsEcsClient = new ECSClient(formattedConfig);
+    }
+};
+exports.initClient = initClient;

package/aws/ecs/runTask.d.ts

@@ -0,0 +1,16 @@
+import { LaunchType, NetworkConfiguration, TaskOverride } from "@aws-sdk/client-ecs";
+type RunTask = {
+    cluster?: string;
+    count?: number;
+    launchType?: LaunchType;
+    networkConfiguration?: NetworkConfiguration;
+    overrides?: TaskOverride;
+    taskDefinition?: string;
+};
+/**
+ * Initialise and run a task
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ecs/command/RunTaskCommand/
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ecs/Interface/RunTaskCommandInput/
+ */
+export declare const runTask: (props: RunTask) => Promise<boolean>;
+export {};

package/aws/ecs/runTask.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runTask = void 0;
+const isResponse200_1 = __importDefault(require("../isResponse200"));
+/**
+ * Initialise and run a task
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ecs/command/RunTaskCommand/
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ecs/Interface/RunTaskCommandInput/
+ */
+const runTask = async (props) => {
+    let response = false;
+    const { RunTaskCommand } = require("@aws-sdk/client-ecs");
+    const runtTaskCommand = new RunTaskCommand({
+        cluster: props?.cluster,
+        launchType: props?.launchType,
+        networkConfiguration: props?.networkConfiguration,
+        overrides: props?.overrides,
+        taskDefinition: props?.taskDefinition,
+    });
+    const apiResponse = await global.awsEcsClient.send(runtTaskCommand);
+    // console.log("runTaskCommandResponse", apiResponse);
+    if ((0, isResponse200_1.default)({ apiResponse })) {
+        response = apiResponse;
+    }
+    return response;
+};
+exports.runTask = runTask;

package/date/getYesterday.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-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 __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };

package/initClients.d.ts

@@ -7,6 +7,7 @@ type InitClients = {
     };
     awsConfig?: AwsConfig;
     awsEc2?: boolean;
+    awsEcs?: boolean;
     awsGlue?: boolean;
     awsLambda?: boolean;
     awsS3?: boolean;

package/initClients.js

@@ -5,24 +5,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const initClient_1 = __importDefault(require("./aws/athenaExpress/initClient"));
 const initClient_2 = require("./aws/ec2/initClient");
-const initClient_3 = __importDefault(require("./aws/glue/initClient"));
-const initClient_4 = __importDefault(require("./aws/lambda/initClient"));
-const initClient_5 = __importDefault(require("./aws/s3/initClient"));
-const initClient_6 = __importDefault(require("./aws/ses/initClient"));
+const initClient_3 = require("./aws/ecs/initClient");
+const initClient_4 = __importDefault(require("./aws/glue/initClient"));
+const initClient_5 = __importDefault(require("./aws/lambda/initClient"));
+const initClient_6 = __importDefault(require("./aws/s3/initClient"));
+const initClient_7 = __importDefault(require("./aws/ses/initClient"));
 const getParameter_1 = __importDefault(require("./aws/ssm/getParameter"));
-const initClient_7 = __importDefault(require("./aws/ssm/initClient"));
-const initClient_8 = __importDefault(require("./lumar/api/initClient"));
-const initClient_9 = __importDefault(require("./lumar/graphql/initClient"));
-const initClient_10 = __importDefault(require("./google/bigQuery/initClient"));
-const initClient_11 = __importDefault(require("./google/sheets/initClient"));
-const initClient_12 = __importDefault(require("./google/storage/initClient"));
-const initClient_13 = __importDefault(require("./googleAds/initClient"));
-const initClient_14 = __importDefault(require("./prisma/initClient"));
+const initClient_8 = __importDefault(require("./aws/ssm/initClient"));
+const initClient_9 = __importDefault(require("./lumar/api/initClient"));
+const initClient_10 = __importDefault(require("./lumar/graphql/initClient"));
+const initClient_11 = __importDefault(require("./google/bigQuery/initClient"));
+const initClient_12 = __importDefault(require("./google/sheets/initClient"));
+const initClient_13 = __importDefault(require("./google/storage/initClient"));
+const initClient_14 = __importDefault(require("./googleAds/initClient"));
+const initClient_15 = __importDefault(require("./prisma/initClient"));
 /**
  * Function to simplify initialising the clients.
  */
 const initClients = async (props) => {
-    if (props.athenaExpress) {
+    if (props?.athenaExpress) {
         (0, initClient_1.default)({
             config: props.awsConfig,
             database: props.athenaExpress.database,
@@ -30,95 +31,100 @@ const initClients = async (props) => {
             s3Key: props.athenaExpress.s3Key,
         });
     }
-    if (props.awsEc2) {
+    if (props?.awsEc2) {
         (0, initClient_2.initClient)({
             config: props.awsConfig,
         });
     }
-    if (props.awsGlue) {
-        (0, initClient_3.default)({
+    if (props?.awsEcs) {
+        (0, initClient_3.initClient)({
             config: props.awsConfig,
         });
     }
-    if (props.awsLambda) {
+    if (props?.awsGlue) {
         (0, initClient_4.default)({
             config: props.awsConfig,
         });
     }
-    if (props.awsS3) {
+    if (props?.awsLambda) {
         (0, initClient_5.default)({
             config: props.awsConfig,
         });
     }
-    if (props.awsSes) {
+    if (props?.awsS3) {
         (0, initClient_6.default)({
             config: props.awsConfig,
         });
     }
-    if (props.awsSsm || props.lumarApi || props.lumarGraphql || props.googleAds || props.googleConfig) {
+    if (props?.awsSes) {
         (0, initClient_7.default)({
             config: props.awsConfig,
         });
     }
+    if (props?.awsSsm || props?.lumarApi || props?.lumarGraphql || props?.googleAds || props?.googleConfig) {
+        (0, initClient_8.default)({
+            config: props.awsConfig,
+        });
+    }
     // Lumar (API) authentication using SSM Parameter
-    if (props.lumarApi) {
+    if (props?.lumarApi) {
         const lumarApiParameter = await (0, getParameter_1.default)({
             name: props.lumarApi.parameterName,
         });
-        await (0, initClient_8.default)({
+        await (0, initClient_9.default)({
             auth: lumarApiParameter
         });
     }
     // Lumar (GraphQL) authentication using SSM Parameter
-    if (props.lumarGraphql) {
+    if (props?.lumarGraphql) {
         const lumarGraphqlParameter = await (0, getParameter_1.default)({
             name: props.lumarGraphql.parameterName,
         });
-        await (0, initClient_9.default)({
+        await (0, initClient_10.default)({
             auth: lumarGraphqlParameter
         });
     }
     // Google authentication using SSM
-    if (props.googleConfig) {
+    if (props?.googleConfig) {
         // Google Parameter
         const googleParameter = await (0, getParameter_1.default)({
             name: props.googleConfig.parameterName,
         });
         // BigQuery
-        if (props.googleBigQuery && props.googleConfig.projectId) {
-            (0, initClient_10.default)({
+        if (props?.googleBigQuery && props?.googleConfig?.projectId) {
+            (0, initClient_11.default)({
                 parameter: googleParameter,
                 projectId: props.googleConfig.projectId,
             });
         }
         // Google Sheets
-        if (props.googleSheets) {
-            (0, initClient_11.default)({
+        if (props?.googleSheets) {
+            (0, initClient_12.default)({
                 parameter: googleParameter,
             });
         }
         // Google Storage
-        if (props.googleStorage && props.googleConfig.projectId) {
-            (0, initClient_12.default)({
+        if (props?.googleStorage && props?.googleConfig?.projectId) {
+            (0, initClient_13.default)({
                 parameter: googleParameter,
                 projectId: props.googleConfig.projectId,
             });
         }
     }
     // Google Ads authentication using SSM Parameter
-    if (props.googleAds) {
+    if (props?.googleAds) {
         const googleAdsParameter = await (0, getParameter_1.default)({
             name: props.googleAds.parameterName,
         });
-        await (0, initClient_13.default)({
+        await (0, initClient_14.default)({
             parameter: googleAdsParameter,
         });
     }
     // Initialise Prisma
-    if (prisma) {
-        (0, initClient_14.default)({
-            debug: prisma ? false : prisma?.debug ?? false,
-            planetScale: prisma ? false : prisma?.planetScale ?? false,
+    if (props?.prisma) {
+        (0, initClient_15.default)({
+            debug: props?.prisma?.debug ?? false,
+            planetScale: props?.prisma?.planetScale ?? false,
         });
     }
 };

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name":            "@8ms/helpers",
 	"license":         "UNLICENSED",
-	"version":         "1.37.0",
+	"version":         "1.38.0",
 	"repository":      {
 		"type": "git",
 		"url":  "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"
@@ -15,28 +15,29 @@
 	"dependencies":    {
 		"@date-fns/tz":  "1.2.0",
 		"@date-fns/utc": "2.1.0",
-		"axios":         "1.7.7",
+		"axios":         "1.7.8",
 		"crypto-js":     "4.2.0",
 		"date-fns":      "4.1.0",
 		"lodash":        "4.17.21",
 		"zod":           "3.23.8"
 	},
 	"devDependencies": {
-		"@aws-sdk/client-ec2":           "3.683.0",
-		"@aws-sdk/client-s3":            "3.682.0",
-		"@aws-sdk/client-ses":           "3.682.0",
-		"@aws-sdk/client-sqs":           "3.682.0",
-		"@aws-sdk/client-ssm":           "3.682.0",
-		"@aws-sdk/lib-storage":          "3.685.0",
-		"@aws-sdk/s3-request-presigner": "3.685.0",
+		"@aws-sdk/client-ec2":           "3.701.0",
+		"@aws-sdk/client-ecs":           "3.699.0",
+		"@aws-sdk/client-s3":            "3.701.0",
+		"@aws-sdk/client-ses":           "3.699.0",
+		"@aws-sdk/client-sqs":           "3.699.0",
+		"@aws-sdk/client-ssm":           "3.699.0",
+		"@aws-sdk/lib-storage":          "3.701.0",
+		"@aws-sdk/s3-request-presigner": "3.701.0",
 		"@babel/preset-env":             "7.26.0",
 		"@babel/preset-flow":            "7.25.9",
 		"@babel/preset-typescript":      "7.26.0",
 		"@google-cloud/bigquery":        "7.9.1",
 		"@google-cloud/storage":         "7.14.0",
 		"@planetscale/database":         "1.19.0",
-		"@prisma/adapter-planetscale":   "5.21.1",
-		"@prisma/client":                "5.21.1",
+		"@prisma/adapter-planetscale":   "5.22.0",
+		"@prisma/client":                "5.22.0",
 		"@types/jest":                   "29.5.14",
 		"@types/lodash":                 "4.17.13",
 		"@types/node":                   "20.14.12",
@@ -44,10 +45,10 @@
 		"jest":                          "29.7.0",
 		"node-fetch":                    "3.3.2",
 		"stream-chain":                  "3.3.2",
-		"stream-json":                   "1.9.0",
+		"stream-json":                   "1.9.1",
 		"timezone-mock":                 "1.3.6",
 		"ts-node":                       "10.9.2",
-		"tslib":                         "2.7.0",
-		"typescript":                    "5.6.3"
+		"tslib":                         "2.8.1",
+		"typescript":                    "5.7.2"
 	}
 }

package/stream/sort.d.ts

@@ -4,6 +4,7 @@ declare const Transform: any;
  * https://www.npmjs.com/package/fast-stream-sort
  */
 declare class SortStreamer extends Transform {
+    static [x: string]: any;
     constructor(options: any, comp: any);
     _transform(data: any, _: any, callback: any): void;
     _flush(): void;