dwh-fetch 1.3.3

package/dist/lib/dwh-fetch.d.ts

@@ -0,0 +1,149 @@
+/// <reference types="node" />
+import superagent from 'superagent';
+import { Logger } from 'tslog';
+export declare const VALUE_ERROR_MASK = 4294967232;
+export declare const WEB_BUS_PIN_ERR = 2147483648;
+export declare function isErrorValue(val: any): boolean;
+export declare function isValidValue(val: any): boolean;
+export interface FileInfo {
+    directory: string;
+    name: string;
+    filePath: string;
+    size: number;
+    lastModified: Date;
+    isDirectory: boolean;
+    isReadOnly: boolean;
+}
+export declare type DownloadFileOptions = {
+    /**
+     * if set to true, the parameter RAW=1 will be added to the downloaded path
+     * For a digiweb that means all interpretations on this file will be disabled
+     * with this you can get a .req files source code instead of the executed result
+     *
+     * Defaults to true
+     */
+    raw: boolean;
+};
+/**
+ * Parses 'Dec 18  2020' or 'Apr 13 14:25' to valid JavaScript date objects.
+ * @param dateTime Date time string returned from '##GETDIRLINE()'.
+ * @returns Date object or throws error.
+ */
+export declare function parseTimeString(timeString: string): Date;
+export declare function parseFileInfoOrThrow(directory: string, line: string): FileInfo;
+export declare function parseFileInfo(directory: string, line: string): FileInfo | undefined;
+export declare class DwhLine {
+    value: string;
+    success: boolean;
+    expression: string;
+    constructor(value: string, success?: boolean, expression?: string);
+    static fromString(line: string, expression?: string): DwhLine;
+    toInt(): number;
+}
+export declare class DwhResponse {
+    accessRights: number;
+    lines: DwhLine[];
+    constructor(accessRights?: number, lines?: DwhLine[]);
+}
+export interface DwhFetchOptions {
+    authFallbackHandler?: (dwh: DwhFetch) => Promise<void>;
+    log?: Logger;
+    /**
+     * Timeout in milliseconds. If no timeout is set superagent will wait for response forever:
+     * https://github.com/visionmedia/superagent/issues/17#issuecomment-207742985
+     */
+    timeoutResponse?: number;
+    /**
+     * Timeout for max running response e.G when download takes to long it will abort after deadline time.
+     */
+    timeoutDeadline?: number;
+    /**
+     * Passing RSA keys via constructor options.
+     */
+    rsaKeys?: string;
+    /**
+     * these headers will be passed to every request
+     */
+    headers?: {
+        [P: string]: string;
+    };
+}
+export declare class DwhFetch {
+    private options?;
+    static readonly DEFAULT_TIMEOUT_RESPONSE = 7000;
+    static readonly DEFAULT_TIMEOUT_DEADLINE: number;
+    private headers;
+    url: string;
+    authorityToken: number;
+    currentlyHandlingAuthFailure: boolean;
+    rsaKeys: string;
+    constructor(url?: string, options?: DwhFetchOptions | undefined);
+    private removeDwhFile;
+    createPostBody(expressions: string[]): string;
+    isMultiLineRequest(expression: string): boolean;
+    toIntOrThrow(str: string): number;
+    parseBody(expressions: string[], body: string): DwhResponse;
+    dwhUrl(): string;
+    fetchOrThrow(expressions: string[]): Promise<DwhResponse>;
+    responseToText(response: superagent.Response): string;
+    fetch(expressions: string[]): Promise<DwhResponse>;
+    sendPostBodyOrThrow(postBody: string): Promise<string>;
+    isAuthFailure(result: DwhResponse): boolean;
+    fetchRsa(): Promise<string | undefined>;
+    initRsa(): Promise<void>;
+    fetchString(expression: string): Promise<string | undefined>;
+    fetchStringOrThrow(expression: string): Promise<string>;
+    wrapDefault<T>(call: () => Promise<T>, defaultValueOnFailure: T): Promise<T>;
+    fetchNumber(expression: string): Promise<number | undefined>;
+    throwFailure(lineWithError: DwhLine): void;
+    fetchNumberOrThrow(expression: string): Promise<number>;
+    login(user: string, password: string): Promise<boolean>;
+    setAuthorityToken(token: number): void;
+    logout(): Promise<boolean>;
+    private isErrorInMultiLineResult;
+    private getErrorCodeOfGResult;
+    private decodeBackdoorKey;
+    executePostAndReturnFirstLine(requestBody: string): Promise<string>;
+    useBackdoor(): Promise<boolean>;
+    getCurrentRights(): Promise<number>;
+    hasError(result: DwhResponse): boolean;
+    throwOnError(result: DwhResponse): void;
+    fetchDirectoryLines(pathWithPattern: string, options?: {
+        startLines?: number;
+    }): Promise<string[]>;
+    files(pathWithPattern: string, options?: {
+        startLines?: number;
+    }): Promise<FileInfo[]>;
+    uploadFile(path: string, content: Buffer | Blob): Promise<boolean>;
+    downloadFile(path: string, options?: DownloadFileOptions): superagent.Request;
+    private createFileUrl;
+    downloadFileAsString(path: string, options?: DownloadFileOptions): Promise<string>;
+    mkdir(path: string): Promise<boolean>;
+    /**
+     * Removes an EMPTY directory from digiweb.
+     * @param path empty directory to remove
+     * @returns 0 when success.
+     */
+    removeDir(path: string): Promise<boolean>;
+    /**
+     * Removes directory recursive. Aborts when error occur
+     * trying to delete file or directory inside path.
+     * @param path directory to remove
+     * @returns 0 when success.
+     */
+    removeDirRecursively(path: string): Promise<boolean>;
+    deleteFile(file: string): Promise<boolean>;
+    getFileInfo(file: string): Promise<FileInfo | undefined>;
+    exists(digiwebFilename: string): Promise<boolean>;
+    isFile(digiwebFilename: string): Promise<boolean>;
+    isDirectory(digiwebFilename: string): Promise<boolean>;
+    restart(): Promise<void>;
+    /**
+     * Creates timeout for superagent.
+     * @returns timeout in ms.
+     */
+    getTimeout(): {
+        deadline: number;
+        response: number;
+    };
+}