@8ms/helpers 1.1.67 → 1.1.73

package/aws/s3/moveFile.d.ts

@@ -1,9 +0,0 @@
-import { File } from './copyFile';
-/**
- * It's not possible to just move or rename a file, you must copy then delete the old file.
- */
-declare const moveFile: ({ from, to }: {
-    from: File;
-    to: File;
-}) => Promise<void>;
-export default moveFile;

package/aws/s3/readBuffer.d.ts

@@ -1,13 +0,0 @@
-import { Modified } from './readFile';
-export declare type ReadBufferResponse = Modified & {
-    buffer: any;
-};
-declare type ReadBuffer = {
-    bucket: string;
-    key: string;
-};
-/**
- * Similar function to reading the S3 file, but instead of a text file return a buffer.
- */
-declare const readBuffer: ({ bucket, key }: ReadBuffer) => Promise<ReadBufferResponse>;
-export default readBuffer;

package/aws/s3/readFile.d.ts

@@ -1,30 +0,0 @@
-export declare type Modified = {
-    now: number;
-    modified: {
-        unix: null | number;
-        vsNow: {
-            months: number;
-            days: number;
-            hours: number;
-            minutes: number;
-        };
-        vsMidnight: {
-            hours: number;
-            minutes: number;
-        };
-    };
-};
-export declare type ReadFileResponse = Modified & {
-    body: any;
-};
-export declare const readFileDefault: ReadFileResponse;
-declare type ReadFile = {
-    bucket: string;
-    key: string;
-    isJson?: boolean;
-};
-/**
- * Read a file from S3 and return either null, the content or JSON decoded.
- */
-declare const readFile: ({ bucket, key, isJson }: ReadFile) => Promise<ReadFileResponse>;
-export default readFile;

package/aws/s3/writeFile.d.ts

@@ -1,10 +0,0 @@
-declare type WriteFile = {
-    bucket: string;
-    data: any;
-    key: string;
-};
-/**
- * Write a file to S3.
- */
-declare const writeFile: ({ bucket, data, key, ...options }: WriteFile) => Promise<any>;
-export default writeFile;

package/aws/s3/writePresignedPost.d.ts

@@ -1,15 +0,0 @@
-import { Response } from '../../api/response';
-import { Config } from '../config';
-declare type WritePresignedPost = {
-    bucket: string;
-    config: Config;
-    fields: any;
-    file: any;
-    key: string;
-    url: string;
-};
-/**
- * Get a presigned post URL so we can upload directly to S3 via frontend.
- */
-declare const writePresignedPost: ({ bucket, config, fields, file, key, url }: WritePresignedPost) => Promise<Response>;
-export default writePresignedPost;

package/aws/s3cache/cache.d.ts

@@ -1,7 +0,0 @@
-import durationComparisons from '../../date/durationComparisons';
-import durations from '../../date/durations';
-export declare type Cache = {
-    duration: number;
-    from: typeof durationComparisons.VS_MIDNIGHT | typeof durationComparisons.VS_NOW;
-    timeframe: typeof durations.FOREVER | typeof durations.MONTHS | typeof durations.DAYS | typeof durations.HOURS | typeof durations.MINUTES;
-};

package/aws/s3cache/getCache.d.ts

@@ -1,12 +0,0 @@
-import { Cache } from './cache';
-import { GetKey } from './getKey';
-declare type GetCache = GetKey & {
-    bucket: string;
-    cache: Cache;
-    isJson?: boolean;
-};
-/**
- * Get the stored cache if it exists.
- */
-declare const getCache: ({ bucket, cache, fileName, folder, isJson }: GetCache) => Promise<any>;
-export default getCache;

package/aws/s3cache/getKey.d.ts

@@ -1,10 +0,0 @@
-export declare type GetKey = {
-    fileName: any;
-    folder: string;
-};
-/**
- * Take an input and return the key.
- * Always in the "_cache" folder with the "environment" followed by the optional folder then the key.
- */
-declare const getKey: ({ fileName, folder }: GetKey) => string;
-export default getKey;

package/aws/s3cache/saveCache.d.ts

@@ -1,10 +0,0 @@
-declare type SaveCache = {
-    bucket: string;
-    data: any;
-    key: string;
-};
-/**
- * Save the cache.
- */
-declare const saveCache: ({ bucket, data, key }: SaveCache) => Promise<void>;
-export default saveCache;

package/aws/s3cache/updateCache.d.ts

@@ -1,10 +0,0 @@
-import { GetKey } from './getKey';
-declare type UpdateCache = GetKey & {
-    bucket: any;
-    data: any;
-};
-/**
- * Delete other caches if present, then save the new file.
- */
-declare const updateCache: ({ bucket, data, fileName, folder }: UpdateCache) => Promise<void>;
-export default updateCache;

package/aws/ses/SimpleEmail.d.ts

@@ -1,54 +0,0 @@
-import { Response } from '../../api/response';
-import BaseClass from '../../class/BaseClass';
-import { Config } from '../config';
-/**
- * Class to build and send an AWS SES email.
- */
-declare class SimpleEmail extends BaseClass {
-    from?: string;
-    to: string[];
-    cc: string[];
-    bcc: string[];
-    html?: string;
-    subject?: string;
-    constructor({ bcc, cc, from, html, subject, to }: {
-        bcc?: string[];
-        cc?: string[];
-        from?: string;
-        html?: string;
-        subject?: string;
-        to?: string | string[];
-    });
-    setFrom({ from }: {
-        from: string;
-    }): this;
-    setHtml({ html }: {
-        html: string;
-    }): this;
-    setSubject({ subject }: {
-        subject: string;
-    }): this;
-    pushBcc({ recipient }: {
-        recipient: string | string[];
-    }): this;
-    pushCc({ recipient }: {
-        recipient: string | string[];
-    }): this;
-    pushTo({ recipient }: {
-        recipient: string | string[];
-    }): this;
-    setBcc({ recipient }: {
-        recipient: string | string[];
-    }): this;
-    setCc({ recipient }: {
-        recipient: string | string[];
-    }): this;
-    setTo({ recipient }: {
-        recipient: string | string[];
-    }): this;
-    send({ config }: {
-        config?: Config;
-    }): Promise<Response>;
-    private _filterRecipients;
-}
-export default SimpleEmail;

package/aws/ses/initClient.d.ts

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

package/aws/ssm/getParameter.d.ts

@@ -1,10 +0,0 @@
-declare type GetParameter = {
-    name: string;
-    withDecryption?: boolean;
-    isJson?: boolean;
-};
-/**
- * Get a parameter and decryption if necessary (secure string)
- */
-declare const getParameter: ({ name, withDecryption, isJson }: GetParameter) => Promise<any>;
-export default getParameter;

package/aws/ssm/initClient.d.ts

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

package/axios/get.d.ts

@@ -1,8 +0,0 @@
-export declare type Get = {
-    config?: object;
-    onError?: Function;
-    onSuccess?: Function;
-    url: string;
-};
-declare const get: ({ config, onError, onSuccess, url }: Get) => Promise<any>;
-export default get;

package/axios/post.d.ts

@@ -1,12 +0,0 @@
-export declare type Post = {
-    config?: object;
-    data?: object;
-    onError?: Function;
-    onSuccess?: Function;
-    url: string;
-};
-/**
- * Make a POST request.
- */
-declare const post: ({ config, data, onError, onSuccess, url }: Post) => Promise<any>;
-export default post;

package/boolean/getBoolean.d.ts

@@ -1,7 +0,0 @@
-/**
- * Convert an input from a variety of forms into boolean.
- */
-declare const getBoolean: ({ input }: {
-    input: any;
-}) => boolean;
-export default getBoolean;

package/class/BaseClass.d.ts

@@ -1,31 +0,0 @@
-declare class BaseClass {
-    /**
-     * Shortcut to set a value to an array and return the instance.
-     */
-    protected _setArray({ input, fields }: {
-        input: any | any[];
-        fields: any | any[];
-    }): this;
-    /**
-     * Shortcut to set a value and return the instance.
-     */
-    protected _setValue({ input, fields }: {
-        input: any;
-        fields: any | any[];
-    }): this;
-    /**
-     * Shortcut to add a value to an existing array.
-     */
-    protected _push({ input, fields }: {
-        input: any | any[];
-        fields: any | any[];
-    }): this;
-    /**
-     * Shortcut to get a value, but default if the fields don't exist.
-     */
-    protected _get({ defaultValue, fields }: {
-        defaultValue: any;
-        fields: any | any[];
-    }): any;
-}
-export default BaseClass;

package/crud/actions.d.ts

@@ -1,8 +0,0 @@
-export declare const actions: {
-    CREATE: string;
-    READ: string;
-    UPDATE: string;
-    DELETE: string;
-};
-export declare type Action = typeof actions.CREATE | typeof actions.READ | typeof actions.UPDATE | typeof actions.DELETE;
-export default actions;

package/crypto/getDecrypt.d.ts

@@ -1,10 +0,0 @@
-/**
- * Decrypt an encoding string using a salt
- * Library: crypto-js
- */
-declare const getDecrypt: ({ appSalt, input, salt }: {
-    appSalt: string;
-    input: string;
-    salt: string;
-}) => string;
-export default getDecrypt;

package/crypto/getEncrypt.d.ts

@@ -1,10 +0,0 @@
-/**
- * Encrypt an encoding string using a salt
- * Library: crypto-js
- */
-declare const getEncrypt: ({ appSalt, input, salt }: {
-    appSalt: string;
-    input: string;
-    salt: string;
-}) => string;
-export default getEncrypt;

package/crypto/getRandom.d.ts

@@ -1,8 +0,0 @@
-/**
- * Create a random string and return a number of characters from it.
- * Library: crypto-js
- */
-declare const getRandom: ({ length }: {
-    length: number;
-}) => string;
-export default getRandom;

package/crypto/getSha256.d.ts

@@ -1,8 +0,0 @@
-/**
- * Encrypt a string using sha256
- * Library: crypto-js
- */
-declare const getSha256: ({ input }: {
-    input: any;
-}) => string;
-export default getSha256;

package/date/date.d.ts

@@ -1,4 +0,0 @@
-/**
- * A date can be either a number (YYYYMMDD), string (YYYY-MM-DD) or Date instance.
- */
-export declare type DateType = number | string | Date;

package/date/duration.d.ts

@@ -1,5 +0,0 @@
-export declare type Duration = {
-    hours: number;
-    minutes: number;
-    seconds: number;
-};

package/date/durationComparisons.d.ts

@@ -1,5 +0,0 @@
-declare const durationComparisons: {
-    VS_NOW: string;
-    VS_MIDNIGHT: string;
-};
-export default durationComparisons;

package/date/durations.d.ts

@@ -1,8 +0,0 @@
-declare const durations: {
-    FOREVER: string;
-    MONTHS: string;
-    DAYS: string;
-    HOURS: string;
-    MINUTES: string;
-};
-export default durations;

package/date/financialYear.d.ts

@@ -1,4 +0,0 @@
-export declare type FinancialYear = {
-    end: Date;
-    start: Date;
-};

package/date/financialYearWeek.d.ts

@@ -1,6 +0,0 @@
-export declare type FinancialYearWeekType = {
-    end: Date;
-    financialWeek: number;
-    financialYear: number;
-    start: Date;
-};

package/date/format.d.ts

@@ -1,13 +0,0 @@
-import { DateType } from './date';
-import { GetMidnight } from './getMidnight';
-import { GetTimeZoned } from './getTimeZoned';
-declare type Format = GetTimeZoned & GetMidnight & {
-    dateFormat?: string;
-    input: DateType;
-};
-/**
- * Convert a (number | string | Date) into a "yyyy-MM-dd" string or a specified format.
- * As the user would be providing the input we don't want to change the timezone typically.
- */
-declare const format: ({ input, dateFormat, setMidnight, setTimeZone }: Format) => string;
-export default format;

package/date/getDate.d.ts

@@ -1,12 +0,0 @@
-import { DateType } from './date';
-import { GetMidnight } from './getMidnight';
-import { GetTimeZoned } from './getTimeZoned';
-declare type GetDate = GetTimeZoned & GetMidnight & {
-    input: DateType;
-};
-/**
- * Convert a (number | string | Date) into a Date object.
- * As the user would be providing the input we don't want to change the timezone typically.
- */
-declare const getDate: ({ input, setMidnight, setTimeZone }: GetDate) => Date;
-export default getDate;

package/date/getDatesBetween.d.ts

@@ -1,10 +0,0 @@
-import { DateType } from './date';
-/**
- * Similar to date-fns' eachDayOfInterval, however the timezone messes this function up.
- * https://date-fns.org/v2.28.0/docs/eachDayOfInterval
- */
-declare const getDatesBetween: ({ end, start }: {
-    end: DateType;
-    start: DateType;
-}) => Date[];
-export default getDatesBetween;

package/date/getDurationHours.d.ts

@@ -1,8 +0,0 @@
-/**
- * Convert a number 1000 seconds into HH:MM:SS
- * https://stackoverflow.com/a/1322771
- */
-declare const getDurationHours: ({ seconds }: {
-    seconds: number;
-}) => string;
-export default getDurationHours;

package/date/getDurationMinutes.d.ts

@@ -1,8 +0,0 @@
-/**
- * Convert a number 1000 seconds into MM:SS
- * https://stackoverflow.com/a/1322771
- */
-declare const getDurationMinutes: ({ seconds }: {
-    seconds: number;
-}) => string;
-export default getDurationMinutes;

package/date/getFinancialYear.d.ts

@@ -1,9 +0,0 @@
-import { FinancialYear } from './financialYear';
-declare type GetFinancialYearType = {
-    year?: number;
-};
-/**
- * Get the current financial year.
- */
-declare const getFinancialYear: ({ year }?: GetFinancialYearType) => FinancialYear;
-export default getFinancialYear;

package/date/getFinancialYearToDate.d.ts

@@ -1,7 +0,0 @@
-import { FinancialYear } from './financialYear';
-/**
- * Return the current financial year up to today.
- * Timezone should always be London based
- */
-declare const getFinancialYearToDate: () => FinancialYear;
-export default getFinancialYearToDate;

package/date/getFinancialYearToYesterday.d.ts

@@ -1,7 +0,0 @@
-import { FinancialYear } from './financialYear';
-/**
- * Return the current financial year up to yesterday.
- * Timezone should always be London based
- */
-declare const getFinancialYearToYesterday: () => FinancialYear;
-export default getFinancialYearToYesterday;

package/date/getFinancialYearWeeks.d.ts

@@ -1,9 +0,0 @@
-import { FinancialYearWeekType } from './financialYearWeek';
-declare type GetFinancialYearWeeks = {
-    year?: number;
-};
-/**
- * Get the current financial year.
- */
-declare const getFinancialYearWeeks: ({ year }?: GetFinancialYearWeeks) => FinancialYearWeekType[];
-export default getFinancialYearWeeks;

package/date/getLastWeek.d.ts

@@ -1,10 +0,0 @@
-import { GetMidnight } from './getMidnight';
-import { GetTimeZoned } from './getTimeZoned';
-import { Timeframe } from './timeframe';
-declare type GetLastWeek = GetTimeZoned & GetMidnight;
-/**
- * Return an object of start/end predefined date of Last Week.
- * Creating a date from scratch (no user input), thus needs to be London time.
- */
-declare const getLastWeek: ({ setMidnight, setTimeZone }?: GetLastWeek) => Timeframe;
-export default getLastWeek;

package/date/getMax.d.ts

@@ -1,12 +0,0 @@
-import { DateType } from './date';
-import { GetMidnight } from './getMidnight';
-import { GetTimeZoned } from './getTimeZoned';
-declare type GetMax = GetTimeZoned & GetMidnight & {
-    input: DateType;
-    max: DateType;
-};
-/**
- * If a given date is beyond the maximum, return the maximum.
- */
-declare const getMax: ({ input, max, setMidnight }: GetMax) => Date;
-export default getMax;

package/date/getMidnight.d.ts

@@ -1,10 +0,0 @@
-export declare type GetMidnight = {
-    setMidnight?: boolean;
-};
-/**
- * Set a date's time to 0 hours, 0 minutes, 0 seconds, 0 milliseconds
- */
-declare const getMidnight: ({ input, setMidnight }: GetMidnight & {
-    input: Date;
-}) => Date;
-export default getMidnight;

package/date/getMin.d.ts

@@ -1,12 +0,0 @@
-import { DateType } from './date';
-import { GetMidnight } from './getMidnight';
-import { GetTimeZoned } from './getTimeZoned';
-declare type GetMin = GetTimeZoned & GetMidnight & {
-    input: DateType;
-    min: DateType;
-};
-/**
- * If a given date is before the minimum, return the minimum.
- */
-declare const getMin: ({ input, min, setMidnight }: GetMin) => Date;
-export default getMin;

package/date/getMonday.d.ts

@@ -1,14 +0,0 @@
-import { DateType } from './date';
-import { GetMidnight } from './getMidnight';
-import { GetTimeZoned } from './getTimeZoned';
-declare type GetMonday = GetTimeZoned & GetMidnight & {
-    input?: DateType;
-    weeksAgo: number;
-};
-/**
- * Retrieve the closest last Monday relative to the input or today.
- * 0 weeksAgo - Tuesday (10th), return Monday (8th)
- * 1 weeksAgo - Tuesday (10th), return Monday (1st)
- */
-declare const getMonday: ({ weeksAgo, input, setMidnight, setTimeZone }: GetMonday) => Date;
-export default getMonday;

package/date/getNumber.d.ts

@@ -1,11 +0,0 @@
-import { DateType } from './date';
-import { GetMidnight } from './getMidnight';
-import { GetTimeZoned } from './getTimeZoned';
-declare type GetNumber = GetTimeZoned & GetMidnight & {
-    input: DateType;
-};
-/**
- * Convert a (number | string | Date) into a YYYYMMDD number.
- */
-declare const getNumber: ({ input, setMidnight, setTimeZone }: GetNumber) => number;
-export default getNumber;

package/date/getPredefinedTimeframe.d.ts

@@ -1,9 +0,0 @@
-import { PredefinedTimeframes } from './predefinedTimeframes';
-import { Timeframe } from './timeframe';
-/**
- * Check to see the date matches a predefined time frame
- */
-declare const getPredefinedTimeframe: ({ timeframe }: {
-    timeframe: Timeframe;
-}) => PredefinedTimeframes;
-export default getPredefinedTimeframe;

package/date/getSunday.d.ts

@@ -1,14 +0,0 @@
-import { DateType } from './date';
-import { GetMidnight } from './getMidnight';
-import { GetTimeZoned } from './getTimeZoned';
-declare type GetSunday = GetTimeZoned & GetMidnight & {
-    input?: DateType;
-    weeksAgo: number;
-};
-/**
- * Retrieve the closest last Sunday relative to the input or today.
- * 0 weeksAgo - Tuesday (17th), return Sunday (14th)
- * 1 weeksAgo - Tuesday (17th), return Monday (7th)
- */
-declare const getSunday: ({ weeksAgo, input, setMidnight, setTimeZone }: GetSunday) => Date;
-export default getSunday;

package/date/getThisWeek.d.ts

@@ -1,10 +0,0 @@
-import { GetMidnight } from './getMidnight';
-import { GetTimeZoned } from './getTimeZoned';
-import { Timeframe } from './timeframe';
-declare type GetThisWeek = GetTimeZoned & GetMidnight;
-/**
- * Return an object of start/end predefined date of This Week.
- * Creating a date from scratch (no user input), thus needs to be London time.
- */
-declare const getThisWeek: ({ setMidnight, setTimeZone }?: GetThisWeek) => Timeframe;
-export default getThisWeek;

package/date/getTimeZoned.d.ts

@@ -1,13 +0,0 @@
-export declare type GetTimeZoned = {
-    setTimeZone?: string | false;
-};
-export declare const timeZoneLondon = "Europe/London";
-/**
- * Convert an input into a given timezone.
- * We can't use getDate here as it becomes a circular issue.
- * Returns a new Date instance.
- */
-declare const getTimeZoned: ({ input, setTimeZone }: GetTimeZoned & {
-    input: Date;
-}) => Date;
-export default getTimeZoned;

package/date/getToday.d.ts

@@ -1,9 +0,0 @@
-import { GetMidnight } from './getMidnight';
-import { GetTimeZoned } from './getTimeZoned';
-declare type GetToday = GetTimeZoned & GetMidnight;
-/**
- * Shortcut to get today's date.
- * Creating a date from scratch (no user input), thus needs to be London time.
- */
-declare const getToday: ({ setMidnight, setTimeZone }?: GetToday) => Date;
-export default getToday;

package/date/getTwoWeeksAgo.d.ts

@@ -1,10 +0,0 @@
-import { GetMidnight } from './getMidnight';
-import { GetTimeZoned } from './getTimeZoned';
-import { Timeframe } from './timeframe';
-declare type GetTwoWeeksAgo = GetTimeZoned & GetMidnight;
-/**
- * Return an object of start/end predefined date of Two Weeks Ago.
- * Creating a date from scratch (no user input), thus needs to be London time.
- */
-declare const getTwoWeeksAgo: ({ setMidnight, setTimeZone }?: GetTwoWeeksAgo) => Timeframe;
-export default getTwoWeeksAgo;