@auxilium/datalynk-client 0.4.1 → 0.4.2

package/dist/api.d.ts

@@ -0,0 +1,93 @@
+import { BehaviorSubject } from 'rxjs';
+import { Auth } from './auth';
+import { Slice, SliceMeta } from './slice';
+import { Socket } from './socket';
+
+/**
+ * Function definition for API callbacks
+ */
+export type ApiCallback = (code: number, data: any) => void;
+/**
+ * Api connection options
+ */
+export type 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;
+    /** Disable sockets or override socket URL */
+    socket?: false | string;
+};
+/**
+ * Options when making requests
+ */
+export interface ApiRequestOptions {
+    /** Skip optimizations like bundling & caching */
+    force?: boolean;
+    /** Skip the token translating step */
+    raw?: boolean;
+    /** Skip wrapping IDs in an array */
+    rawUpload?: boolean;
+}
+/** Request error shape */
+export interface ApiRequestError {
+    message: string;
+    request: any;
+    debug?: any;
+    trace?: any;
+}
+/**
+ * Object to handle communications between the app and Datalynk
+ */
+export declare class Api {
+    readonly options: ApiOptions;
+    /** Current requests bundle */
+    private bundle;
+    /** Bundle lifecycle tracking */
+    private bundleOngoing;
+    /** LocalStorage key for persisting logins */
+    private localStorageKey;
+    /** Pending requests */
+    private pending;
+    /** Authentication helpers */
+    readonly auth: Auth;
+    /** Socket object */
+    readonly socket: Socket;
+    /** API endpoint */
+    readonly url: string;
+    /** API Session token */
+    token$: BehaviorSubject<string | null>;
+    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, options?: ApiOptions);
+    private _request;
+    private static translateTokens;
+    /**
+     * Send a request to Datalynk
+     * @param {object} data request
+     * @param {ApiRequestOptions} options  Options
+     * @returns {Promise<any>} Promise of response
+     */
+    request<T = any>(data: any, options?: ApiRequestOptions): Promise<T>;
+    /**
+     * Use the slice object to create the request
+     * @param {number} slice ID of the slice to use
+     * @returns {Slice<T extends SliceMeta>} Slice object to create query
+     */
+    slice<T extends SliceMeta>(slice: number): Slice<T>;
+    /**
+     * Send a request and automatically log the output
+     * @param {object | string} data request
+     * @param {ApiRequestOptions} options Options
+     * @returns {Promise<any>} Promise of response
+     */
+    test<T = any>(data: any, options?: ApiRequestOptions): 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":"AACA,OAAO,EAAC,eAAe,EAAuB,MAAM,MAAM,CAAC;AAC3D,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAC,KAAK,EAAE,SAAS,EAAC,MAAM,SAAS,CAAC;AACzC,OAAO,EAAC,MAAM,EAAC,MAAM,UAAU,CAAC;AAEhC;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,IAAI,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACxB,uEAAuE;IACvE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iCAAiC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2DAA2D;IAC3D,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACxB,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IACjC,iDAAiD;IACjD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,sCAAsC;IACtC,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,oCAAoC;IACpC,SAAS,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,0BAA0B;AAC1B,MAAM,WAAW,eAAe;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,GAAG,CAAC;IACb,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,KAAK,CAAC,EAAE,GAAG,CAAC;CACZ;AAED;;GAEG;AACH,qBAAa,GAAG;aA2B0B,OAAO,EAAE,UAAU;IA1B5D,8BAA8B;IAC9B,OAAO,CAAC,MAAM,CAAwD;IACtE,gCAAgC;IAChC,OAAO,CAAC,aAAa,CAAkB;IACvC,6CAA6C;IAC7C,OAAO,CAAC,eAAe,CAAoB;IAC3C,uBAAuB;IACvB,OAAO,CAAC,OAAO,CAA8B;IAE7C,6BAA6B;IAC7B,QAAQ,CAAC,IAAI,OAAkB;IAC/B,oBAAoB;IACpB,QAAQ,CAAC,MAAM,EAAG,MAAM,CAAC;IACzB,mBAAmB;IACnB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB,wBAAwB;IACxB,MAAM,iCAA4C;IAClD,IAAI,KAAK,IACQ,MAAM,GAAG,IAAI,CADgB;IAC9C,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAA8B;IAE5D;;;;OAIG;gBACS,GAAG,EAAE,MAAM,EAAkB,OAAO,GAAE,UAAe;IAyBjE,OAAO,CAAC,QAAQ;IAsBhB,OAAO,CAAC,MAAM,CAAC,eAAe;IAsB9B;;;;;OAKG;IACI,OAAO,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,CAAC,CAAC;IAmC/E;;;;OAIG;IACI,KAAK,CAAC,CAAC,SAAS,SAAS,EAAE,KAAK,EAAE,MAAM;IAI/C;;;;;OAKG;IACI,IAAI,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,CAAC,CAAC;CAU5E"}

package/dist/auth.d.ts

@@ -0,0 +1,55 @@
+import { BehaviorSubject } from 'rxjs';
+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;
+    user$: BehaviorSubject<User | null>;
+    get user(): User | null;
+    set user(user: User | null);
+    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(spoke: string, login: string, password: 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,eAAe,EAAC,MAAM,MAAM,CAAC;AACrC,OAAO,EAAC,GAAG,EAAC,MAAM,OAAO,CAAC;AAG1B,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;IAYJ,OAAO,CAAC,QAAQ,CAAC,GAAG;IAVhC;;;OAGG;IACH,IAAI,eAAe,YAA0B;IAE7C,KAAK,+BAA0C;IAC/C,IAAI,IAAI,IACO,IAAI,GAAG,IAAI,CADkB;IAC5C,IAAI,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,EAA4B;gBAEzB,GAAG,EAAE,GAAG;IAErC;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAW/B;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAWnE;;;OAGG;IACH,MAAM;gBAC6B,MAAM;aAAO,MAAM;;CAMtD"}