@8ms/helpers 2.3.4 → 2.3.6

package/tsdown.config.ts

@@ -0,0 +1,10 @@
+import {defineConfig} from "tsdown";
+
+export default defineConfig({
+	entry  : ["src/**/index.ts"],
+	outDir : "dist",
+	format : ["esm"],
+	dts    : true,
+	clean  : true,
+	exports: true,  // auto-generates the exports map in package.json
+});

package/.github/generate-exports.js

@@ -1,69 +0,0 @@
-
-import fs from 'fs';
-import path from 'path';
-import {fileURLToPath} from 'url';
-
-const __dirname   = path.dirname(fileURLToPath(import.meta.url));
-const projectRoot = path.join(__dirname, '..');
-const srcRoot     = path.join(projectRoot, 'src');
-const packageJson = JSON.parse(fs.readFileSync(path.join(projectRoot, 'package.json'), 'utf8'));
-
-const excludeDirs = new Set(['node_modules', 'scripts', 'jest', 'src', '.git', '.github', '.idea']);
-
-const exports = {
-	'.': {
-		types:   './index.d.ts',
-		import:  './index.js',
-		require: './index.js',
-		default: './index.js'
-	}
-};
-
-const importExportRegex = /((?:import|export)\s+(?:type\s+)?(?:[\s\S]*?from\s+)?['"])(\.{1,2}\/[^'"]+?)(['"])/g;
-
-function scan(baseDir, relativePath = '')
-{
-	for(const entry of fs.readdirSync(baseDir, {withFileTypes: true}))
-	{
-		const fullPath       = path.join(baseDir, entry.name);
-		const newRelativePath = relativePath ? `${relativePath}/${entry.name}` : entry.name;
-
-		if(entry.isDirectory())
-		{
-			if(excludeDirs.has(entry.name) || entry.name.startsWith('.')) continue;
-
-			if(fs.existsSync(path.join(fullPath, 'index.js')))
-			{
-				const jsPath = `./${newRelativePath}/index.js`;
-				const config = {types: `./${newRelativePath}/index.d.ts`, import: jsPath, require: jsPath, default: jsPath};
-
-				exports[`./${newRelativePath}`]            = config;
-				exports[`./${newRelativePath}/index.js`]  = config;
-				exports[`./${newRelativePath}/index.d.ts`] = {types: config.types, default: config.types};
-			}
-
-			scan(fullPath, newRelativePath);
-		}
-		else if(entry.isFile() && !entry.name.endsWith('.d.ts') && (entry.name.endsWith('.ts') || entry.name.endsWith('.tsx')))
-		{
-			const original = fs.readFileSync(fullPath, 'utf8');
-			const updated  = original.replace(importExportRegex, (match, prefix, specifier, suffix) =>
-				path.extname(specifier) ? match : `${prefix}${specifier}.js${suffix}`
-			);
-
-			if(updated !== original)
-			{
-				fs.writeFileSync(fullPath, updated, 'utf8');
-				console.log(`Fixed extensions in: ${path.relative(projectRoot, fullPath)}`);
-			}
-		}
-	}
-}
-
-scan(projectRoot);
-scan(srcRoot);
-
-packageJson.exports = exports;
-fs.writeFileSync(path.join(projectRoot, 'package.json'), JSON.stringify(packageJson, null, '\t') + '\n', 'utf8');
-
-console.log(`Generated exports for ${Object.keys(exports).length} entries`);

package/_class/BaseClass.d.ts

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

package/_class/BaseClass.js

@@ -1,44 +0,0 @@
-import isArray from "lodash/isArray";
-import set from "lodash/set";
-import { defaultTo } from "../util";
-export class BaseClass {
-    /**
-     * Shortcut to set a value to an array and return the instance.
-     */
-    _setArray = (fields, input) => {
-        if (isArray(input)) {
-            set(this, fields, input);
-        }
-        else {
-            set(this, fields, [input]);
-        }
-        return this;
-    };
-    /**
-     * Shortcut to set a value and return the instance.
-     */
-    _setValue = (fields, input) => {
-        set(this, fields, input);
-        return this;
-    };
-    /**
-     * Shortcut to add a value to an existing array.
-     */
-    _push = (fields, input) => {
-        let temp = this._get(fields, []);
-        if (isArray(input)) {
-            temp = temp.concat(input);
-        }
-        else {
-            temp = temp.push(input);
-        }
-        set(this, fields, temp);
-        return this;
-    };
-    /**
-     * Shortcut to get a value, but default if the fields don't exist.
-     */
-    _get = (fields, defaultValue = null) => {
-        return defaultTo(this, fields, defaultValue);
-    };
-}

package/_class/BaseNamespace.d.ts

@@ -1,9 +0,0 @@
-export declare class BaseNamespace {
-    client: any;
-    key: string;
-    config: any;
-    constructor(key: string, config: any);
-    ensureInit: () => Promise<void>;
-    reset: () => void;
-    getClient: () => Promise<any>;
-}

package/_class/BaseNamespace.js

@@ -1,24 +0,0 @@
-import { isServer } from "../environment";
-export class BaseNamespace {
-    client = null;
-    key;
-    config = null;
-    constructor(key, config) {
-        if (!isServer) {
-            throw new Error("Server-side only class accessed from client");
-        }
-        this.key = key;
-        this.config = config;
-    }
-    // To be superseded by child
-    ensureInit = async () => {
-    };
-    // Reset the client
-    reset = () => {
-        this.client = null;
-    };
-    // Return the raw client if needed
-    getClient = async () => {
-        return this.client();
-    };
-}

package/_class/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./BaseClass";
-export * from "./BaseNamespace";

package/_class/index.js

@@ -1,2 +0,0 @@
-export * from "./BaseClass";
-export * from "./BaseNamespace";

package/adverity/adverity.d.ts

@@ -1,112 +0,0 @@
-import { z } from "zod/v4";
-export declare const stackSchema: z.ZodObject<{
-    id: z.ZodString;
-    uuid: z.ZodString;
-    name: z.ZodString;
-    slug: z.ZodString;
-    url: z.ZodString;
-    change_url: z.ZodString;
-    extracts_url: z.ZodString;
-    issues_url: z.ZodString;
-    overview_url: z.ZodString;
-    permissions: z.ZodObject<{
-        isCreator: z.ZodBoolean;
-        isDatastreamManager: z.ZodBoolean;
-        isViewer: z.ZodBoolean;
-    }, z.core.$strip>;
-}, z.core.$strip>;
-export type StackSchemaType = z.infer<typeof stackSchema>;
-export declare const datastreamSchema: z.ZodObject<{
-    id: z.ZodNumber;
-    stack: z.ZodObject<{
-        id: z.ZodString;
-        uuid: z.ZodString;
-        name: z.ZodString;
-        slug: z.ZodString;
-        url: z.ZodString;
-        change_url: z.ZodString;
-        extracts_url: z.ZodString;
-        issues_url: z.ZodString;
-        overview_url: z.ZodString;
-        permissions: z.ZodObject<{
-            isCreator: z.ZodBoolean;
-            isDatastreamManager: z.ZodBoolean;
-            isViewer: z.ZodBoolean;
-        }, z.core.$strip>;
-    }, z.core.$strip>;
-    stack_id: z.ZodNumber;
-    name: z.ZodString;
-    slug: z.ZodString;
-    app_label: z.ZodString;
-    absolute_url: z.ZodString;
-    change_url: z.ZodString;
-    extracts_url: z.ZodString;
-    fetch_url: z.ZodString;
-    overview_url: z.ZodString;
-    schema_mapping_url: z.ZodString;
-    enabled: z.ZodBigInt;
-    next_run: z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"Not Scheduled">]>;
-    url: z.ZodString;
-    datastream_type_id: z.ZodNumber;
-    logo_url: z.ZodString;
-    extracts_stream_url: z.ZodString;
-    supports_extended_intervals: z.ZodNumber;
-    updated: z.ZodString;
-    created: z.ZodString;
-    creator: z.ZodString;
-    can_be_fetched: z.ZodNumber;
-}, z.core.$strip>;
-export type DatastreamSchemaType = z.infer<typeof datastreamSchema>;
-export declare const jobSchema: z.ZodObject<{
-    id: z.ZodNumber;
-    url: z.ZodString;
-    job_start: z.ZodNullable<z.ZodString>;
-    job_end: z.ZodNullable<z.ZodString>;
-    progress: z.ZodNumber;
-    state: z.ZodNumber;
-    state_label: z.ZodString;
-    state_color: z.ZodString;
-    datastream: z.ZodObject<{
-        id: z.ZodNumber;
-        stack: z.ZodObject<{
-            id: z.ZodString;
-            uuid: z.ZodString;
-            name: z.ZodString;
-            slug: z.ZodString;
-            url: z.ZodString;
-            change_url: z.ZodString;
-            extracts_url: z.ZodString;
-            issues_url: z.ZodString;
-            overview_url: z.ZodString;
-            permissions: z.ZodObject<{
-                isCreator: z.ZodBoolean;
-                isDatastreamManager: z.ZodBoolean;
-                isViewer: z.ZodBoolean;
-            }, z.core.$strip>;
-        }, z.core.$strip>;
-        stack_id: z.ZodNumber;
-        name: z.ZodString;
-        slug: z.ZodString;
-        app_label: z.ZodString;
-        absolute_url: z.ZodString;
-        change_url: z.ZodString;
-        extracts_url: z.ZodString;
-        fetch_url: z.ZodString;
-        overview_url: z.ZodString;
-        schema_mapping_url: z.ZodString;
-        enabled: z.ZodBigInt;
-        next_run: z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"Not Scheduled">]>;
-        url: z.ZodString;
-        datastream_type_id: z.ZodNumber;
-        logo_url: z.ZodString;
-        extracts_stream_url: z.ZodString;
-        supports_extended_intervals: z.ZodNumber;
-        updated: z.ZodString;
-        created: z.ZodString;
-        creator: z.ZodString;
-        can_be_fetched: z.ZodNumber;
-    }, z.core.$strip>;
-    issues: z.ZodArray<z.ZodAny>;
-    type: z.ZodUnion<readonly [z.ZodString, z.ZodString, z.ZodString]>;
-}, z.core.$strip>;
-export type JobSchemaType = z.infer<typeof jobSchema>;

package/adverity/adverity.js

@@ -1,58 +0,0 @@
-import { z } from "zod/v4";
-export const stackSchema = z.object({
-    id: z.string(),
-    uuid: z.string(),
-    name: z.string(),
-    slug: z.string(),
-    url: z.string(),
-    change_url: z.string(),
-    extracts_url: z.string(),
-    issues_url: z.string(),
-    overview_url: z.string(),
-    permissions: z.object({
-        isCreator: z.boolean(),
-        isDatastreamManager: z.boolean(),
-        isViewer: z.boolean(),
-    })
-});
-export const datastreamSchema = z.object({
-    id: z.number(),
-    stack: stackSchema,
-    stack_id: z.number(),
-    name: z.string(),
-    slug: z.string(),
-    app_label: z.string(),
-    absolute_url: z.string(),
-    change_url: z.string(),
-    extracts_url: z.string(),
-    fetch_url: z.string(),
-    overview_url: z.string(),
-    schema_mapping_url: z.string(),
-    enabled: z.bigint(),
-    next_run: z.union([z.string(), z.literal("Not Scheduled")]),
-    url: z.string(),
-    datastream_type_id: z.number(),
-    logo_url: z.string(),
-    extracts_stream_url: z.string(),
-    supports_extended_intervals: z.number(),
-    updated: z.string(),
-    created: z.string(),
-    creator: z.string(),
-    can_be_fetched: z.number(),
-});
-export const jobSchema = z.object({
-    id: z.number(),
-    url: z.string(),
-    job_start: z.string()
-        .nullable(),
-    job_end: z.string()
-        .nullable(),
-    progress: z.number(),
-    state: z.number(),
-    state_label: z.string(),
-    state_color: z.string(),
-    datastream: datastreamSchema,
-    issues: z.any()
-        .array(),
-    type: z.union([z.string("Fetch"), z.string("Enrich"), z.string("Transfer")]),
-});

package/adverity/index.d.ts

@@ -1 +0,0 @@
-export * from "./adverity";

package/adverity/index.js

@@ -1 +0,0 @@
-export * from "./adverity";

package/adverity/server/getJobs.js

@@ -1,26 +0,0 @@
-import { getLuxonDate, getToday, getYesterday, getYmdString } from "../../date";
-import { get } from "../../axios";
-/**
- * Fetch all the jobs that ran yesterday by default.
- * A job can either by in Fetch, Enrich or Transfer states, but all have different job ids. This makes it difficult to track and we would be reliant on the start/end time which could varu.
- * As a result, we only store the Transfer jobs as this is when it gets moved into Bigquery. If it's not in Bigquery we cant use it anyway.
- */
-export const getJobs = async (apiKey, start, end, url) => {
-    const startYmd = getYmdString(start ? getLuxonDate(start) : getYesterday());
-    const endYmd = getYmdString(end ? getLuxonDate(end) : getToday());
-    const finalUrl = "undefined" !== typeof url ? url : `https://8ms.datatap.adverity.com/api/jobs/?start=${startYmd}&end=${endYmd}&page_size=300`;
-    let response = [];
-    const apiResponse = await get(finalUrl, {
-        headers: {
-            Authorization: `Bearer ${apiKey}`,
-        }
-    });
-    if (apiResponse.isSuccess()) {
-        const apiResponseBody = apiResponse.getBody();
-        // Move to the next page
-        if (apiResponseBody.next) {
-            response = [...apiResponse.getBody(), await getJobs(apiKey, start, end, apiResponseBody.next)];
-        }
-    }
-    return response;
-};

package/adverity/server/index.d.ts

@@ -1 +0,0 @@
-export * from "./getJobs";

package/adverity/server/index.js

@@ -1 +0,0 @@
-export * from "./getJobs";

package/api/ApiResponseClass.d.ts

@@ -1,35 +0,0 @@
-import { ApiState, ApiResponse } from "./api";
-import { z } from "zod/v4";
-type ConstructorProps = {
-    body?: any;
-    error?: any;
-    state?: ApiState;
-};
-/**
- * Class version of the API to enable quicker instances.
- */
-export declare class ApiResponseClass<T = any, E = any> {
-    state: ApiState;
-    body: T | null;
-    error: E | null;
-    constructor({ body, error, state }?: ConstructorProps);
-    fromJson: (input: ApiResponse) => this;
-    getBody: () => any;
-    getBodyDefaultTo: (keys: any | any[], defaultValue: any) => any;
-    getError: () => any;
-    getJson: () => ApiResponse<T, E>;
-    getApiState: () => ApiState;
-    isError: () => boolean;
-    isIdle: () => boolean;
-    isPending: () => boolean;
-    isSuccess: () => boolean;
-    setToIdle: () => this;
-    setToPending: () => this;
-    setToError: (error: any, body?: any) => this;
-    setToSuccess: (body: any) => this;
-    setBody: (body: any) => this;
-    setError: (error: any) => this;
-    setApiState: (state: ApiState) => this;
-    validateZod: <T_1>(schema: z.ZodSchema<T_1>) => ApiResponseClass<T_1, E>;
-}
-export {};

package/api/ApiResponseClass.js

@@ -1,93 +0,0 @@
-import { defaultTo } from "../util";
-import { apiState } from "./api";
-/**
- * Class version of the API to enable quicker instances.
- */
-export class ApiResponseClass {
-    state = apiState.IDLE;
-    body = null;
-    error = null;
-    constructor({ body, error, state } = {}) {
-        this.body = body || null;
-        this.error = error || null;
-        this.state = state || apiState.IDLE;
-        return this;
-    }
-    fromJson = (input) => {
-        this.body = input.body;
-        this.error = input.error;
-        this.state = input.state;
-        return this;
-    };
-    getBody = () => {
-        return this.body;
-    };
-    getBodyDefaultTo = (keys, defaultValue) => {
-        return defaultTo(this.body, keys, defaultValue);
-    };
-    getError = () => {
-        return this.error;
-    };
-    getJson = () => {
-        return {
-            body: this.body,
-            error: this.error,
-            state: this.state,
-        };
-    };
-    getApiState = () => {
-        return this.state;
-    };
-    isError = () => {
-        return this.state === apiState.ERROR;
-    };
-    isIdle = () => {
-        return this.state === apiState.IDLE;
-    };
-    isPending = () => {
-        return this.state === apiState.PENDING;
-    };
-    isSuccess = () => {
-        return this.state === apiState.SUCCESS;
-    };
-    setToIdle = () => {
-        this.state = apiState.IDLE;
-        return this;
-    };
-    setToPending = () => {
-        this.state = apiState.PENDING;
-        return this;
-    };
-    setToError = (error, body) => {
-        this.body = body || null;
-        this.error = error;
-        this.state = apiState.ERROR;
-        return this;
-    };
-    setToSuccess = (body) => {
-        this.body = body;
-        this.state = apiState.SUCCESS;
-        return this;
-    };
-    setBody = (body) => {
-        this.body = body;
-        return this;
-    };
-    setError = (error) => {
-        this.error = error;
-        return this;
-    };
-    setApiState = (state) => {
-        this.state = state;
-        return this;
-    };
-    validateZod = (schema) => {
-        try {
-            const validatedBody = schema.parse(this.body);
-            return new ApiResponseClass({ body: validatedBody, state: this.state });
-        }
-        catch (error) {
-            return new ApiResponseClass({ error, state: apiState.ERROR });
-        }
-    };
-}

package/api/api.d.ts

@@ -1,17 +0,0 @@
-export { ApiResponseClass } from "./ApiResponseClass";
-export declare const apiState: {
-    readonly CANCELLED: "CANCELLED";
-    readonly ERROR: "ERROR";
-    readonly IDLE: "IDLE";
-    readonly PENDING: "PENDING";
-    readonly SUCCESS: "SUCCESS";
-    readonly VALIDATION_ERROR: "VALIDATION_ERROR";
-};
-export type ApiState = typeof apiState[keyof typeof apiState];
-export type ApiResponse<T = any, E = any> = {
-    body: T | null;
-    error: E | null;
-    state: ApiState;
-};
-export declare const defaultResponse: ApiResponse;
-export declare const unexpectedError: string;

package/api/api.js

@@ -1,15 +0,0 @@
-export { ApiResponseClass } from "./ApiResponseClass";
-export const apiState = {
-    CANCELLED: "CANCELLED",
-    ERROR: "ERROR",
-    IDLE: "IDLE",
-    PENDING: "PENDING",
-    SUCCESS: "SUCCESS",
-    VALIDATION_ERROR: "VALIDATION_ERROR",
-};
-export const defaultResponse = {
-    body: null,
-    error: null,
-    state: apiState.IDLE,
-};
-export const unexpectedError = "An unexpected error occurred, please try again.";

package/api/functions.d.ts

@@ -1,7 +0,0 @@
-import { ApiResponse } from "./api";
-export declare const isCancelled: (apiResponse: ApiResponse) => boolean;
-export declare const isError: (apiResponse: ApiResponse) => boolean;
-export declare const isIdle: (apiResponse: ApiResponse) => boolean;
-export declare const isPending: (apiResponse: ApiResponse) => boolean;
-export declare const isSuccess: (apiResponse: ApiResponse) => boolean;
-export declare const isValidationError: (apiResponse: ApiResponse) => boolean;

package/api/functions.js

@@ -1,19 +0,0 @@
-import { apiState } from "./api";
-export const isCancelled = (apiResponse) => {
-    return apiState.CANCELLED === apiResponse.state;
-};
-export const isError = (apiResponse) => {
-    return apiState.ERROR === apiResponse.state;
-};
-export const isIdle = (apiResponse) => {
-    return apiState.IDLE === apiResponse.state;
-};
-export const isPending = (apiResponse) => {
-    return apiState.PENDING === apiResponse.state;
-};
-export const isSuccess = (apiResponse) => {
-    return apiState.SUCCESS === apiResponse.state;
-};
-export const isValidationError = (apiResponse) => {
-    return apiState.VALIDATION_ERROR === apiResponse.state;
-};

package/api/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./api";
-export * from "./ApiResponseClass";
-export * from "./functions";

package/api/index.js

@@ -1,3 +0,0 @@
-export * from "./api";
-export * from "./ApiResponseClass";
-export * from "./functions";

package/array/array.d.ts

@@ -1,8 +0,0 @@
-/**
- * Shorthand to check if an array or string contains a needle.
- */
-export declare const contains: <T>(haystack: T[], needle: T) => boolean;
-/**
- * Convert an array into an array or return if already an array.
- */
-export declare const getArray: <T>(input: T) => T[];

package/array/array.js

@@ -1,9 +0,0 @@
-import isArray from "lodash/isArray";
-/**
- * Shorthand to check if an array or string contains a needle.
- */
-export const contains = (haystack, needle) => -1 !== haystack.indexOf(needle);
-/**
- * Convert an array into an array or return if already an array.
- */
-export const getArray = (input) => isArray(input) ? input : [input];

package/array/index.d.ts

@@ -1 +0,0 @@
-export * from "./array";

package/array/index.js

@@ -1 +0,0 @@
-export * from "./array";

package/atInternet/atInternet.d.ts

@@ -1,16 +0,0 @@
-import { z } from "zod/v4";
-/**
- * The request in the structure required by AT Internet.
- */
-export declare const requestSchema: z.ZodObject<{
-    columns: z.ZodArray<z.ZodString>;
-    evo: z.ZodObject<{}, z.core.$strip>;
-    filter: z.ZodObject<{}, z.core.$strip>;
-    "max-results": z.ZodNumber;
-    options: z.ZodObject<{
-        ignore_null_properties: z.ZodBoolean;
-    }, z.core.$strip>;
-    "page-num": z.ZodNumber;
-    period: z.ZodObject<{}, z.core.$strip>;
-}, z.core.$strip>;
-export type RequestSchemaType = z.infer<typeof requestSchema>;

package/atInternet/atInternet.js

@@ -1,15 +0,0 @@
-import { z } from "zod/v4";
-/**
- * The request in the structure required by AT Internet.
- */
-export const requestSchema = z.object({
-    columns: z.array(z.string()),
-    evo: z.object({}),
-    filter: z.object({}),
-    "max-results": z.number(),
-    options: z.object({
-        "ignore_null_properties": z.boolean(),
-    }),
-    "page-num": z.number(),
-    period: z.object({}),
-});

package/atInternet/index.d.ts

@@ -1 +0,0 @@
-export * from "./atInternet";

package/atInternet/index.js

@@ -1 +0,0 @@
-export * from "./atInternet";