@magda/utils 2.3.2 → 3.0.0-alpha.0

package/dist/index-web.d.ts

@@ -1,200 +1,17 @@
-/// <reference types="node" />
-import { Arguments } from 'yargs';
-
-/**
- * Checks to see whether the passed argv has a jwtSecret object. If not,
- * tries to add one by looking at the JWT_SECRET env var and failing that,
- * the jwtSecret value in package.json config.
- *
- * If it can't find one and required is true (or unprovided), this will
- * throw an Error.
- */
-export declare function addJwtSecretFromEnvVar<T>(argv: {
-    [key in keyof Arguments<T>]: Arguments<T>[key];
-}, required?: boolean): {
-    [key in keyof Arguments<T>]: Arguments<T>[key];
-};
-
-declare class ApiError {
-    'message': string;
-}
-
-export declare function arrayToMaybe<T>(rows: T[]): Maybe<T>;
-
-export declare class AsyncPage<T> {
-    readonly requestNextPage: CreateAsyncPage<T>;
-    readonly data: T;
-    readonly hasData: boolean;
-    static create<T>(next: (data: T) => Promise<T>): AsyncPage<T>;
-    static single<T>(value: T): AsyncPage<T>;
-    static singlePromise<T>(valuePromise: Promise<T>): AsyncPage<T>;
-    static none<T>(): AsyncPage<T>;
-    constructor(data: T, hasData: boolean, requestNextPage: CreateAsyncPage<T>);
-    map<TResult>(selector: (data: T) => TResult): AsyncPage<TResult>;
-    forEach(callback: (data: T) => void): Promise<void>;
-    take(n: number): AsyncPage<T>;
-}
-
-export declare function asyncPageToArray<T>(page: AsyncPage<T[]>): Promise<T[]>;
-
-export declare class BadRequestError extends ServiceError {
-    constructor(statusCode: number, errorResponse: ApiError, e: any);
-}
-
-export declare function buildJwt(jwtSecret: string, userId: string, session?: any): any;
-
-export declare const coerceJson: (param: string) => (json?: string | object | any[]) => any;
-
-declare interface CreateAsyncPage<T> {
-    (): Promise<AsyncPage<T>>;
-}
-
-export declare function createNoCacheFetchOptions(fetchOptions?: RequestInit): {
-    body?: BodyInit;
-    cache?: RequestCache;
-    credentials?: RequestCredentials;
-    headers?: HeadersInit;
-    integrity?: string;
-    keepalive?: boolean;
-    method?: string;
-    mode?: RequestMode;
-    redirect?: RequestRedirect;
-    referrer?: string;
-    referrerPolicy?: ReferrerPolicy;
-    signal?: AbortSignal;
-    window?: any;
-};
-
-/**
- * Creates a {@link ServiceError} from the result of a failed call to an API generated
- * by swagger-codegen.  The result typically includes `response` (with a status code) and
- * a `body` (the JSON the server returned with the error), but may be other things if,
- * e.g., an exception occurred while attempting to invoke the service.
- *
- * @export
- * @param {*} e The result of the failed call.
- * @returns {Error} An Error created from the failed result.
- */
-export declare function createServiceError(e: any): Error;
-
-export declare function encodeURIComponentWithApost(string: string): string;
-
-declare interface Eq<T> {
-    equals(t: T): boolean;
-}
-
-export declare function fetchRequest<T = any, CT = string>(method: string, url: string, body?: any, contentType?: CT | RequestContentType | undefined | null, returnHeaders?: false, extraRequestOptions?: RequestInit): Promise<T>;
-
-export declare function fetchRequest<T = any, CT = string>(method: string, url: string, body?: any, contentType?: CT | RequestContentType | undefined | null, returnHeaders?: true, extraRequestOptions?: RequestInit): Promise<[T, Headers]>;
-
-export declare function forEachAsync<T>(page: AsyncPage<T[]>, maxConcurrency: number, callbackFn: (data: T) => Promise<void>): Promise<void>;
-
-export declare function formatServiceError(baseMessage: string, e: any, retriesLeft: number): string;
-
-declare interface Functor<T> {
-    fmap<U>(f: (t: T) => U): Functor<U>;
-    lift<U>(f: (t: T) => U): Functor<U>;
-    map<U>(f: (t: T) => U): Functor<U>;
-}
-
-export declare function getDefaultRequestInitOptions(): RequestInit;
-
-export declare function getRequest<T = any, CT = string>(url: string, noCache?: boolean, extraFetchOptions?: RequestInit): Promise<T>;
-
-export declare function getRequestNoCache<T = any, CT = string>(url: string, extraFetchOptions?: RequestInit): Promise<T>;
-
-export declare const isUuid: (id: any) => boolean;
-
-declare class Maybe<T> implements Monad<T>, Functor<T>, Eq<Maybe<T>> {
-    private type;
-    private value;
-    constructor(type: MaybeType, value?: T);
-    static sequence<T>(t: {
-        [k: string]: Maybe<T>;
-    }): Maybe<{
-        [k: string]: T;
-    }>;
-    static all: (t: {
-        [k: string]: Maybe<any>;
-    }) => Maybe<{
-        [k: string]: any;
-    }>;
-    static maybe<T>(t: T): Maybe<T>;
-    static just<T>(t: T): Maybe<T>;
-    static nothing<T>(): Maybe<T>;
-    unit<U>(u: U): Maybe<U>;
-    bind<U>(f: (t: T) => Maybe<U>): Maybe<U>;
-    of: <U>(u: U) => Maybe<U>;
-    chain: <U>(f: (t: T) => Maybe<U>) => Maybe<U>;
-    fmap<U>(f: (t: T) => U): Maybe<U>;
-    lift: <U>(f: (t: T) => U) => Maybe<U>;
-    map: <U>(f: (t: T) => U) => Maybe<U>;
-    caseOf<U>(patterns: MaybePatterns<T, U>): U;
-    defaulting(defaultValue: T): Maybe<T>;
-    equals(other: Maybe<T>): any;
-    valueOr<U extends T>(defaultValue: U): T | U;
-    valueOrCompute<U extends T>(defaultValueFunction: () => U): T | U;
-    valueOrThrow(error?: Error): T;
-    do(patterns?: OptionalMaybePatterns<T, void>): Maybe<T>;
-}
-
-declare interface MaybePatterns<T, U> {
-    just: (t: T) => U;
-    nothing: () => U;
-}
-
-declare enum MaybeType {
-    Nothing = 0,
-    Just = 1,
-}
-
-declare interface Monad<T> {
-    unit<U>(t: U): Monad<U>;
-    bind<U>(f: (t: T) => Monad<U>): Monad<U>;
-    of<U>(t: U): Monad<U>;
-    chain<U>(f: (t: T) => Monad<U>): Monad<U>;
-}
-
-declare interface OptionalMaybePatterns<T, U> {
-    just?: (t: T) => U;
-    nothing?: () => U;
-}
-
-declare type RequestContentType = RequestContentTypeJson | RequestContentTypePlainText | RequestContentTypeForm | RequestContentTypeBinary | RequestContentTypeMultipartForm;
-
-declare type RequestContentTypeBinary = "application/octet-stream";
-
-declare type RequestContentTypeForm = "application/x-www-form-urlencoded";
-
-declare type RequestContentTypeJson = "application/json";
-
-declare type RequestContentTypeMultipartForm = "multipart/form-data";
-
-declare type RequestContentTypePlainText = "text/plain";
-
-export declare function retry<T>(op: () => Promise<T>, delaySeconds: number, retries: number, onRetry: (e: any, retries: number) => any, shouldRetry?: (e: any) => boolean): Promise<T>;
-
-export declare function retryBackoff<T>(op: () => Promise<T>, delaySeconds: number, retries: number, onRetry: (e: any, retries: number) => any, easing?: (delaySeconds: number) => number): Promise<T>;
-
-export declare function runLater<TResult>(milliseconds: number, functionToRunLater: () => Promise<TResult> | TResult): Promise<TResult>;
-
-declare class ServerError extends Error {
-    statusCode: number;
-    constructor(message?: string, statusCode?: number);
-    toData(): {
-        isError: boolean;
-        errorCode: number;
-        errorMessage: string;
-    };
-}
-
-export declare class ServiceError extends Error {
-    e: any;
-    constructor(message: string, e: any);
-}
-
-export declare function setDefaultRequestInitOptions(options: RequestInit): void;
-
-export declare function unionToThrowable<T>(input: T | Error | ServerError): T;
-
-export { }
+export { default as arrayToMaybe } from "@magda/typescript-common/dist/util/arrayToMaybe.js";
+export { default as isUuid } from "@magda/typescript-common/dist/util/isUuid.js";
+export { default as unionToThrowable } from "@magda/typescript-common/dist/util/unionToThrowable.js";
+export { default as AsyncPage, forEachAsync, asyncPageToArray } from "@magda/typescript-common/dist/AsyncPage.js";
+export { default as coerceJson } from "@magda/typescript-common/dist/coerceJson.js";
+export { default as retry } from "@magda/typescript-common/dist/retry.js";
+export { default as retryBackoff } from "@magda/typescript-common/dist/retryBackoff.js";
+export { default as runLater } from "@magda/typescript-common/dist/runLater.js";
+export { default as addJwtSecretFromEnvVar } from "@magda/typescript-common/dist/session/addJwtSecretFromEnvVar.js";
+export { encodeURIComponentWithApost } from "@magda/typescript-common/dist/test/util.js";
+export { default as formatServiceError } from "@magda/typescript-common/dist/formatServiceError.js";
+export { default as createServiceError, ServiceError, BadRequestError } from "@magda/typescript-common/dist/createServiceError.js";
+export { default as fetchRequest } from "@magda/typescript-common/dist/fetchRequest.js";
+export { getDefaultRequestInitOptions, setDefaultRequestInitOptions } from "@magda/typescript-common/dist/fetchRequest.js";
+export { default as getRequest } from "@magda/typescript-common/dist/getRequest.js";
+export { default as getRequestNoCache } from "@magda/typescript-common/dist/getRequestNoCache.js";
+export { default as createNoCacheFetchOptions } from "@magda/typescript-common/dist/createNoCacheFetchOptions.js";