@auxilium/datalynk-client 0.2.0 → 0.2.1

package/dist/api.d.ts

@@ -0,0 +1,89 @@
+import { Auth } from './auth';
+import { Slice } from './slice';
+
+/**
+ * Function definition for API callbacks
+ */
+export type ApiCallback = (code: number, data: any) => void;
+/**
+ * Api connection options
+ */
+export interface ApiOptions {
+    /** Bundle requests that happen within X ms to save network overhead */
+    bundleTime?: number;
+    /** Name of client for logging */
+    origin?: string;
+    /** Save session token to localStorage to persist logins */
+    saveSession?: boolean;
+}
+/**
+ * Options when making requests
+ */
+export interface RequestOptions {
+    /** Skip optimizations like bundling & caching */
+    force?: boolean;
+    /** Skip the token translating step */
+    raw?: boolean;
+    /** Skip wrapping IDs in an array */
+    rawUpload?: boolean;
+    /** Override target spoke */
+    spoke?: string;
+}
+/**
+ * Object to handle communications between the app and Datalynk
+ */
+export declare class Api {
+    readonly url: string;
+    spoke: string;
+    readonly options: ApiOptions;
+    /** Current requests bundle */
+    private bundle;
+    /** Bundle lifecycle tracking */
+    private bundleOngoing;
+    /** API dispatch endpoint */
+    private endpoint;
+    /** Client created callbacks to HTTP status codes */
+    private eventCallbacks;
+    /** Pending requests */
+    private pending;
+    readonly auth: Auth;
+    /** Session token - Syncs to localStorage */
+    private _token;
+    get token(): string | null;
+    set token(token: string | null);
+    /**
+     * Object to handle communications between the app and Datalynk
+     * @param {string} url API URL
+     * @param {ApiOptions} options
+     */
+    constructor(url: string, spoke: string, options?: ApiOptions);
+    private _request;
+    private static translateTokens;
+    /**
+     * Add an error code listener
+     * @param {number} code the error code to listen to
+     * @param {ApiCallback} fn the callback function
+     */
+    addListener(code: number, fn: ApiCallback): void;
+    /**
+     * Send a request to Datalynk
+     * @param {object} data request
+     * @param {RequestOptions} options  Options
+     * @returns {Promise<any>} Promise of response
+     */
+    request<T = any>(data: any, options?: RequestOptions): Promise<T>;
+    /**
+     * Use the slice object to create the request
+     * @param {number} slice ID of the slice to use
+     * @returns {Slice<T>} Slice object to create query
+     */
+    slice<T>(slice: number): Slice<T>;
+    /**
+     * Send a request and automatically log the output
+     * @param {object | string} data request
+     * @param {RequestOptions} options Options
+     * @returns {Promise<any>} Promise of response
+     */
+    test<T = any>(data: any, options?: RequestOptions): Promise<T>;
+}
+//# sourceMappingURL=api.d.ts.map

package/dist/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAC,KAAK,EAAC,MAAM,SAAS,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,IAAI,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,uEAAuE;IACvE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iCAAiC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2DAA2D;IAC3D,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,iDAAiD;IACjD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,sCAAsC;IACtC,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,oCAAoC;IACpC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,4BAA4B;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,qBAAa,GAAG;aAkCc,GAAG,EAAE,MAAM;IAAS,KAAK,EAAE,MAAM;aAAkB,OAAO,EAAE,UAAU;IAjClG,8BAA8B;IAC9B,OAAO,CAAC,MAAM,CAAwD;IACtE,gCAAgC;IAChC,OAAO,CAAC,aAAa,CAAkB;IACvC,4BAA4B;IAC5B,OAAO,CAAC,QAAQ,CAAS;IACzB,oDAAoD;IACpD,OAAO,CAAC,cAAc,CAAwC;IAC9D,uBAAuB;IACvB,OAAO,CAAC,OAAO,CAA8B;IAG7C,QAAQ,CAAC,IAAI,OAAkB;IAE/B,4CAA4C;IAC5C,OAAO,CAAC,MAAM,CAAuB;IACrC,IAAI,KAAK,IAIQ,MAAM,GAAG,IAAI,CAD7B;IACD,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAM7B;IAED;;;;OAIG;gBACyB,GAAG,EAAE,MAAM,EAAS,KAAK,EAAE,MAAM,EAAkB,OAAO,GAAE,UAAe;IAUvG,OAAO,CAAC,QAAQ;IAsBhB,OAAO,CAAC,MAAM,CAAC,eAAe;IAsB9B;;;;OAIG;IACI,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,WAAW;IAKhD;;;;;OAKG;IACI,OAAO,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,CAAC,CAAC;IAmC5E;;;;OAIG;IACI,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM;IAI7B;;;;;OAKG;IACI,IAAI,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,CAAC,CAAC;CAU1E"}

package/dist/auth.d.ts

@@ -0,0 +1,51 @@
+import { Api } from './api';
+
+/** User */
+export type User = {
+    id: Number;
+    token: string;
+    guest: boolean;
+    sysadmin: boolean;
+    first_name: string;
+    last_name: string;
+    email: string;
+    login: string;
+    "2FA"?: string;
+    "2FA_code"?: string;
+    mobile_phone?: string;
+    spoke: string;
+};
+/**
+ * Authentication requests
+ */
+export declare class Auth {
+    private readonly api;
+    /**
+     * Check whether user has a token
+     * @return {boolean}
+     */
+    get isAuthenticated(): boolean;
+    constructor(api: Api);
+    /**
+     * Get current user associated with API token
+     * @return {Promise<User | null>}
+     */
+    current(): Promise<null | User>;
+    /**
+     * Perform login and save the session token
+     * @param {string} login Login username or email
+     * @param {string} password Password for account
+     * @param {string} spoke Override login spoke
+     * @returns {Promise<any>} Session information returned from login request
+     */
+    login(login: string, password: string, spoke?: string): Promise<any>;
+    /**
+     * Logout current user
+     * @return {Promise<{closed: string, new: string}>}
+     */
+    logout(): Promise<{
+        closed: string;
+        new: string;
+    }>;
+}
+//# sourceMappingURL=auth.d.ts.map

package/dist/auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,GAAG,EAAC,MAAM,OAAO,CAAC;AAE1B,WAAW;AACX,MAAM,MAAM,IAAI,GAAG;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,OAAO,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;CACd,CAAA;AAED;;GAEG;AACH,qBAAa,IAAI;IAQJ,OAAO,CAAC,QAAQ,CAAC,GAAG;IANhC;;;OAGG;IACH,IAAI,eAAe,YAA+B;gBAErB,GAAG,EAAE,GAAG;IAErC;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAK/B;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAOpE;;;OAGG;IACH,MAAM;gBAC4B,MAAM;aAAO,MAAM;;CAMrD"}