@8ms/helpers 1.39.0 → 1.40.0

package/dist/littleWarden/index.mjs

@@ -0,0 +1,9 @@
+//#region src/littleWarden/index.ts
+let State = /* @__PURE__ */ function(State) {
+	State["ALL_GOOD"] = "all_good";
+	State["DANGER"] = "danger";
+	State["WARNING"] = "warning";
+	return State;
+}({});
+//#endregion
+export { State };

package/dist/nextAuth/index.d.mts

@@ -0,0 +1,9 @@
+//#region src/nextAuth/index.d.ts
+declare enum State {
+  AUTHENTICATED = "authenticated",
+  PENDING = "loading",
+  // Defined by NextAuth
+  UNAUTHENTICATED = "unauthenticated"
+}
+//#endregion
+export { State };

package/dist/nextAuth/index.mjs

@@ -0,0 +1,9 @@
+//#region src/nextAuth/index.ts
+let State = /* @__PURE__ */ function(State) {
+	State["AUTHENTICATED"] = "authenticated";
+	State["PENDING"] = "loading";
+	State["UNAUTHENTICATED"] = "unauthenticated";
+	return State;
+}({});
+//#endregion
+export { State };

package/dist/webWorker/index.d.mts

@@ -0,0 +1,8 @@
+//#region src/webWorker/index.d.ts
+declare enum State {
+  ERROR = "ERROR",
+  SUCCESS = "SUCCESS",
+  PROGRESS = "PROGRESS"
+}
+//#endregion
+export { State };

package/dist/webWorker/index.mjs

@@ -0,0 +1,9 @@
+//#region src/webWorker/index.ts
+let State = /* @__PURE__ */ function(State) {
+	State["ERROR"] = "ERROR";
+	State["SUCCESS"] = "SUCCESS";
+	State["PROGRESS"] = "PROGRESS";
+	return State;
+}({});
+//#endregion
+export { State };

package/package.json

@@ -1,54 +1,72 @@
 {
-	"name":            "@8ms/helpers",
-	"license":         "UNLICENSED",
-	"version":         "1.39.0",
-	"repository":      {
+	"name": "@8ms/helpers",
+	"license": "UNLICENSED",
+	"version": "1.40.0",
+	"repository": {
 		"type": "git",
-		"url":  "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.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"
+	"types": "dist/index.d.ts",
+	"scripts": {
+		"build": "tsdown",
+		"jest": "jest --watch"
 	},
-	"dependencies":    {
-		"@date-fns/tz":  "1.2.0",
+	"packageManager": "yarn@4.12.0",
+	"engines": {
+		"node": "24"
+	},
+	"dependencies": {
+		"@date-fns/tz": "1.2.0",
 		"@date-fns/utc": "2.1.0",
-		"axios":         "1.7.8",
-		"crypto-js":     "4.2.0",
-		"date-fns":      "4.1.0",
-		"lodash":        "4.17.21",
-		"zod":           "3.23.8"
+		"crypto-js": "4.2.0",
+		"date-fns": "4.1.0",
+		"fs-extra": "^11.3.4",
+		"ky": "^2.0.0",
+		"lodash": "4.17.21",
+		"zod": "3.23.8"
 	},
 	"devDependencies": {
-		"@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/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.22.0",
-		"@prisma/client":                "5.22.0",
-		"@types/jest":                   "29.5.14",
-		"@types/lodash":                 "4.17.13",
-		"@types/node":                   "20.14.12",
-		"babel-jest":                    "29.7.0",
-		"jest":                          "29.7.0",
-		"node-fetch":                    "3.3.2",
-		"stream-chain":                  "3.3.2",
-		"stream-json":                   "1.9.1",
-		"timezone-mock":                 "1.3.6",
-		"ts-node":                       "10.9.2",
-		"tslib":                         "2.8.1",
-		"typescript":                    "5.7.2"
+		"@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.22.0",
+		"@prisma/client": "5.22.0",
+		"@types/fs-extra": "^11",
+		"@types/jest": "29.5.14",
+		"@types/lodash": "4.17.13",
+		"@types/node": "20.14.12",
+		"babel-jest": "29.7.0",
+		"jest": "29.7.0",
+		"node-fetch": "3.3.2",
+		"stream-chain": "3.3.2",
+		"stream-json": "1.9.1",
+		"timezone-mock": "1.3.6",
+		"ts-node": "10.9.2",
+		"tsdown": "^0.21.7",
+		"tslib": "2.8.1",
+		"typescript": "5.7.2"
+	},
+	"exports": {
+		"./api": "./dist/api/index.mjs",
+		"./aws/s3cache": "./dist/aws/s3cache/index.mjs",
+		"./crud": "./dist/crud/index.mjs",
+		"./date": "./dist/date/index.mjs",
+		"./environment": "./dist/environment/index.mjs",
+		"./googleAds/keywordPlanner": "./dist/googleAds/keywordPlanner/index.mjs",
+		"./littleWarden": "./dist/littleWarden/index.mjs",
+		"./nextAuth": "./dist/nextAuth/index.mjs",
+		"./webWorker": "./dist/webWorker/index.mjs",
+		"./package.json": "./package.json"
 	}
 }

package/.github/workflows/deploy_npmjs.yml

@@ -1,17 +0,0 @@
-on:
-  push:
-    branches: [ main ]
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4.2.1
-      - uses: actions/setup-node@v4.0.4
-        with:
-          node-version: 20
-      - run: yarn
-      - run: yarn build
-      - uses: JS-DevTools/npm-publish@v3.1.1
-        with:
-          token: ${{ secrets.NPM_TOKEN }}

package/api/ApiResponse.d.ts

@@ -1,50 +0,0 @@
-import { Response } from "./response";
-import { State } from "./";
-type Constructor = {
-    body?: any;
-    error?: any;
-    state?: State;
-};
-/**
- * Class version of the API to enable quicker instances.
- */
-declare class ApiResponse {
-    state: State;
-    body: any;
-    error: any;
-    constructor({ body, error, state }?: Constructor);
-    fromJson({ input }: {
-        input: Response;
-    }): this;
-    getBody(): any;
-    getBodyDefaultTo({ defaultValue, keys }: {
-        defaultValue: any;
-        keys: any | any[];
-    }): any;
-    getError(): any;
-    getJson(): Response;
-    getState(): State;
-    isError(): boolean;
-    isIdle(): boolean;
-    isPending(): boolean;
-    isSuccess(): boolean;
-    setToIdle(): this;
-    setToPending(): this;
-    setToError({ body, error }: {
-        body?: any;
-        error: any;
-    }): this;
-    setToSuccess({ body }: {
-        body: any;
-    }): this;
-    setBody({ body }: {
-        body: any;
-    }): this;
-    setError({ error }: {
-        error: any;
-    }): this;
-    setState({ state }: {
-        state: State;
-    }): this;
-}
-export default ApiResponse;

package/api/ApiResponse.js

@@ -1,94 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const defaultTo_1 = __importDefault(require("../util/defaultTo"));
-const _1 = require("./");
-/**
- * Class version of the API to enable quicker instances.
- */
-class ApiResponse {
-    constructor({ body, error, state } = {}) {
-        this.state = _1.State.IDLE;
-        this.body = null;
-        this.error = null;
-        this.body = body || null;
-        this.error = error || null;
-        this.state = state || _1.State.IDLE;
-        return this;
-    }
-    fromJson({ input }) {
-        this.body = input.body;
-        this.error = input.error;
-        this.state = input.state;
-        return this;
-    }
-    getBody() {
-        return this.body;
-    }
-    getBodyDefaultTo({ defaultValue, keys }) {
-        return (0, defaultTo_1.default)({
-            defaultValue,
-            instance: this.body,
-            keys,
-        });
-    }
-    getError() {
-        return this.error;
-    }
-    getJson() {
-        return {
-            body: this.body,
-            error: this.error,
-            state: this.state,
-        };
-    }
-    getState() {
-        return this.state;
-    }
-    isError() {
-        return this.state === _1.State.ERROR;
-    }
-    isIdle() {
-        return this.state === _1.State.IDLE;
-    }
-    isPending() {
-        return this.state === _1.State.PENDING;
-    }
-    isSuccess() {
-        return this.state === _1.State.SUCCESS;
-    }
-    setToIdle() {
-        this.state = _1.State.IDLE;
-        return this;
-    }
-    setToPending() {
-        this.state = _1.State.PENDING;
-        return this;
-    }
-    setToError({ body, error }) {
-        this.body = body || null;
-        this.error = error;
-        this.state = _1.State.ERROR;
-        return this;
-    }
-    setToSuccess({ body }) {
-        this.body = body;
-        this.state = _1.State.SUCCESS;
-        return this;
-    }
-    setBody({ body }) {
-        this.body = body;
-        return this;
-    }
-    setError({ error }) {
-        this.error = error;
-        return this;
-    }
-    setState({ state }) {
-        this.state = state;
-        return this;
-    }
-}
-exports.default = ApiResponse;

package/api/index.d.ts

@@ -1,9 +0,0 @@
-export declare enum State {
-    CANCELLED = "CANCELLED",
-    ERROR = "ERROR",
-    IDLE = "IDLE",
-    PENDING = "PENDING",
-    SUCCESS = "SUCCESS",
-    VALIDATION_ERROR = "VALIDATION_ERROR"
-}
-export declare const unexpectedError: string;

package/api/index.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.unexpectedError = exports.State = void 0;
-var State;
-(function (State) {
-    State["CANCELLED"] = "CANCELLED";
-    State["ERROR"] = "ERROR";
-    State["IDLE"] = "IDLE";
-    State["PENDING"] = "PENDING";
-    State["SUCCESS"] = "SUCCESS";
-    State["VALIDATION_ERROR"] = "VALIDATION_ERROR";
-})(State || (exports.State = State = {}));
-exports.unexpectedError = "An unexpected error occurred, please try again.";

package/api/isError.d.ts

@@ -1,6 +0,0 @@
-import { Response } from "./response";
-type IsError = {
-    response: Response;
-};
-declare const isError: (props: IsError) => boolean;
-export default isError;

package/api/isError.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const _1 = require("./");
-const isError = (props) => {
-    return _1.State.ERROR === props.response.state;
-};
-exports.default = isError;

package/api/isSuccess.d.ts

@@ -1,6 +0,0 @@
-import { Response } from './response';
-type IsSuccess = {
-    response: Response;
-};
-declare const isSuccess: (props: IsSuccess) => boolean;
-export default isSuccess;

package/api/isSuccess.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const _1 = require("./");
-const isSuccess = (props) => {
-    return _1.State.SUCCESS === props.response.state;
-};
-exports.default = isSuccess;

package/api/response.d.ts

@@ -1,8 +0,0 @@
-import { State } from "./";
-export type Response = {
-    body: any | null;
-    error: string | null;
-    state: State;
-};
-declare const response: Response;
-export default response;

package/api/response.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const _1 = require("./");
-const response = {
-    body: null,
-    error: null,
-    state: _1.State.IDLE,
-};
-exports.default = response;

package/array/contains.d.ts

@@ -1,9 +0,0 @@
-type Contains = {
-    haystack: any;
-    needle: any;
-};
-/**
- * Shorthand to check if an array or string contains a needle.
- */
-declare const contains: (props: Contains) => boolean;
-export default contains;

package/array/contains.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Shorthand to check if an array or string contains a needle.
- */
-const contains = (props) => -1 !== props.haystack.indexOf(props.needle);
-exports.default = contains;

package/array/getArray.d.ts

@@ -1,8 +0,0 @@
-type GetArray = {
-    input: any;
-};
-/**
- * Convert an array into an array or return if already an array.
- */
-declare const getArray: (props: GetArray) => any[];
-export default getArray;

package/array/getArray.js

@@ -1,11 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const isArray_1 = __importDefault(require("lodash/isArray"));
-/**
- * Convert an array into an array or return if already an array.
- */
-const getArray = (props) => (0, isArray_1.default)(props.input) ? props.input : [props.input];
-exports.default = getArray;

package/atInternet/request.d.ts

@@ -1,30 +0,0 @@
-/**
- * The request in the structure required by AT Internet.
- */
-export type Request = {
-    columns: string[];
-    evo?: {
-        [evoKey: string]: object;
-    };
-    filter?: {
-        [filterKey: string]: object;
-    };
-    "max-results": number;
-    options: {
-        "ignore_null_properties": boolean;
-    };
-    "page-num": number;
-    period: {
-        [periodKey: string]: [
-            {
-                type: string;
-                start: string;
-                end: string;
-            }
-        ];
-    };
-    sort: string[];
-    space: {
-        s: number[];
-    };
-};

package/atInternet/request.js

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

package/aws/athenaExpress/initClient.d.ts

@@ -1,12 +0,0 @@
-import { Config } from '../getConfig';
-type InitClient = {
-    config: Config;
-    database: string;
-    s3Bucket: string;
-    s3Key: string;
-};
-/**
- * Initialise the database using manually provided credentials.
- */
-declare const initClient: (props: InitClient) => void;
-export default initClient;

package/aws/athenaExpress/initClient.js

@@ -1,31 +0,0 @@
-"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.awsAthenaExpressClient = null;
-/**
- * Initialise the database using manually provided credentials.
- */
-const initClient = (props) => {
-    if (!global.awsAthenaExpressClient) {
-        const athenaExpress = require('athena-express');
-        const awsSdk = require('aws-sdk');
-        const formattedConfig = (0, getConfig_1.default)({
-            config: props.config,
-            isAthenaExpress: true
-        });
-        // Set the aws authentication
-        awsSdk.config.update(formattedConfig);
-        global.awsAthenaExpressClient = new athenaExpress.AthenaExpress({
-            aws: awsSdk,
-            s3: `s3://${props.s3Bucket}/${props.s3Key}`,
-            db: props.database,
-            formatJson: true,
-            retry: 200,
-            getStats: false,
-        });
-    }
-};
-exports.default = initClient;

package/aws/athenaExpress/query.d.ts

@@ -1,8 +0,0 @@
-type Query = {
-    query: string;
-};
-/**
- * Build the query and return the data.
- */
-declare const query: (props: Query) => Promise<any>;
-export default query;

package/aws/athenaExpress/query.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Build the query and return the data.
- */
-const query = async (props) => {
-    return await global.awsAthenaExpressClient.query(props.query)
-        .then(data => {
-        let subResponse = [];
-        if (undefined !== data['Items']) {
-            subResponse = data['Items'];
-        }
-        return subResponse;
-    });
-};
-exports.default = query;

package/aws/ec2/initClient.d.ts

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

package/aws/ec2/initClient.js

@@ -1,23 +0,0 @@
-"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.awsEc2Client = null;
-/**
- * Shorthand function to get the EC2 Client.
- * Library: @aws-sdk/client-ec2
- * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ec2/
- */
-const initClient = (props) => {
-    if (!global.awsEc2Client) {
-        const { EC2Client } = require("@aws-sdk/client-ec2");
-        const formattedConfig = (0, getConfig_1.default)({
-            config: props.config
-        });
-        global.awsEc2Client = new EC2Client(formattedConfig);
-    }
-};
-exports.initClient = initClient;

package/aws/ec2/startInstances.d.ts

@@ -1,11 +0,0 @@
-type StartInstances = {
-    additionalInfo?: string;
-    instanceIds: string[];
-    dryRun?: boolean;
-};
-/**
- * Start one or more Ec2 Instances.
- * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ec2/command/StartInstancesCommand/
- */
-export declare const startInstances: (props: StartInstances) => Promise<any>;
-export {};

package/aws/ec2/startInstances.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.startInstances = void 0;
-/**
- * Start one or more Ec2 Instances.
- * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ec2/command/StartInstancesCommand/
- */
-const startInstances = async (props) => {
-    const { StartInstancesCommand } = require("@aws-sdk/client-ec2");
-    const command = new StartInstancesCommand({
-        InstanceIds: props.instanceIds,
-        AdditionalInfo: props?.additionalInfo,
-        DryRun: props?.dryRun,
-    });
-    const response = await global.awsEc2Client.send(command);
-    return response;
-};
-exports.startInstances = startInstances;

package/aws/ec2/stopInstances.d.ts

@@ -1,12 +0,0 @@
-type StopInstances = {
-    dryRun?: boolean;
-    instanceIds: string[];
-    hibernate?: boolean;
-    force?: boolean;
-};
-/**
- * Stop one or more Ec2 Instances.
- * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ec2/command/StopInstancesCommand/
- */
-export declare const stopInstances: (props: StopInstances) => Promise<any>;
-export {};