@magda/utils 2.3.3 → 3.0.0-alpha.0

package/dist/index.d.ts

@@ -1,9 +1,7 @@
 /// <reference types="node" />
+
 import { Arguments } from 'yargs';
-import { CoreOptions } from 'request';
-import { Request as Request_2 } from 'request';
-import { RequestAPI } from 'request';
-import { RequiredUriUrl } from 'request';
+import requestOriginal from 'request';
 
 /**
  * Checks to see whether the passed argv has a jwtSecret object. If not,
@@ -45,7 +43,7 @@ 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 function buildJwt(jwtSecret: string, userId: string, session?: any): string;
 
 export declare const coerceJson: (param: string) => (json?: string | object | any[]) => any;
 
@@ -66,7 +64,7 @@ export declare function createNoCacheFetchOptions(fetchOptions?: RequestInit): {
     referrer?: string;
     referrerPolicy?: ReferrerPolicy;
     signal?: AbortSignal;
-    window?: any;
+    window?: null;
 };
 
 /**
@@ -113,7 +111,7 @@ export declare const isUuid: (id: any) => boolean;
 
 declare class Maybe<T> implements Monad<T>, Functor<T>, Eq<Maybe<T>> {
     private type;
-    private value;
+    private value?;
     constructor(type: MaybeType, value?: T);
     static sequence<T>(t: {
         [k: string]: Maybe<T>;
@@ -125,9 +123,11 @@ declare class Maybe<T> implements Monad<T>, Functor<T>, Eq<Maybe<T>> {
     }) => Maybe<{
         [k: string]: any;
     }>;
-    static maybe<T>(t: T): Maybe<T>;
+    static maybe<T>(t?: T | null): Maybe<T>;
     static just<T>(t: T): Maybe<T>;
     static nothing<T>(): Maybe<T>;
+    static isJust<T>(t: Maybe<T>): boolean;
+    static isNothing<T>(t: Maybe<T>): boolean;
     unit<U>(u: U): Maybe<U>;
     bind<U>(f: (t: T) => Maybe<U>): Maybe<U>;
     of: <U>(u: U) => Maybe<U>;
@@ -141,7 +141,7 @@ declare class Maybe<T> implements Monad<T>, Functor<T>, Eq<Maybe<T>> {
     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>;
+    do(patterns?: Partial<MaybePatterns<T, void>>): Maybe<T>;
 }
 
 declare interface MaybePatterns<T, U> {
@@ -151,7 +151,7 @@ declare interface MaybePatterns<T, U> {
 
 declare enum MaybeType {
     Nothing = 0,
-    Just = 1,
+    Just = 1
 }
 
 declare interface Monad<T> {
@@ -161,12 +161,7 @@ declare interface Monad<T> {
     chain<U>(f: (t: T) => Monad<U>): Monad<U>;
 }
 
-declare interface OptionalMaybePatterns<T, U> {
-    just?: (t: T) => U;
-    nothing?: () => U;
-}
-
-export declare const request: RequestAPI<Request_2, CoreOptions, RequiredUriUrl>;
+export declare const request: requestOriginal.RequestAPI<requestOriginal.Request, requestOriginal.CoreOptions, requestOriginal.RequiredUriUrl>;
 
 declare type RequestContentType = RequestContentTypeJson | RequestContentTypePlainText | RequestContentTypeForm | RequestContentTypeBinary | RequestContentTypeMultipartForm;
 
@@ -180,7 +175,7 @@ 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 retry<T = any>(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>;