@auxilium/datalynk-client 1.2.4 → 1.2.5

package/dist/api.d.ts

@@ -0,0 +1,206 @@
+import { Database } from '@ztimson/utils';
+import { BehaviorSubject } from 'rxjs';
+import { Auth } from './auth';
+import { PWA } from './pwa';
+import { Files } from './files';
+import { Meta } from './meta';
+import { Pdf } from './pdf';
+import { ApiCall, Slice } from './slice';
+import { Socket } from './socket';
+import { Superuser } from './superuser';
+import { WebRtc } from './webrtc';
+export type JwtPayload = {
+    aud: string;
+    email: string;
+    exp: number;
+    iat: number;
+    iss: string;
+    jti: string;
+    payload: any;
+    realm: string;
+    timezone: string;
+    uid: number;
+};
+/**
+ * Api connection options
+ */
+export type ApiOptions = {
+    /** Bundle requests together that happen in quick succession */
+    bundleTime?: number;
+    /** Use legacy dates by default */
+    legacyDates?: boolean;
+    /** PWA manifest overrides */
+    manifest?: any;
+    /** Name of application */
+    name?: string;
+    /** List of slices to use offline */
+    offline?: number[];
+    /** Website hostname */
+    origin?: string;
+    /** Save session token to localStorage to persist logins */
+    saveSession?: boolean;
+    /** Service worker URL */
+    serviceWorker?: string;
+    /** Disable sockets with false or override socket URL */
+    socket?: false | string;
+    /** WebRTC TURN server URL */
+    webrtc?: {
+        /** Additional ICE servers */
+        ice?: RTCIceServer[];
+        /** Auxilium WebRTC STUN/TURN server URL override */
+        url: string;
+        /** TURN server username */
+        username?: string;
+        /** TURN server password */
+        password?: string;
+    };
+};
+/**
+ * Possible options for API calls
+ */
+export interface ApiRequestOptions {
+    /** Skip bundling & caching */
+    noOptimize?: boolean;
+    /** Skip the token translating step */
+    raw?: boolean;
+    /** Set request token */
+    token?: string;
+}
+/** API error response */
+export interface ApiError {
+    /** Error message */
+    message: string;
+    /** Source of error */
+    request: any;
+    /** Extra debugging information */
+    debug?: any;
+    /** Stack trace */
+    trace?: any;
+}
+/**
+ * Connect to Datalynk & send requests
+ */
+export declare class Api {
+    readonly origin: string;
+    /** Client library version */
+    static version: string;
+    /** Current requests bundle */
+    private bundle;
+    /** Bundle lifecycle tracking */
+    private bundleOngoing;
+    /** LocalStorage key for persisting logins */
+    private localStorageKey;
+    /** Pending requests cache */
+    private pending;
+    /** Helpers */
+    /** Authentication */
+    readonly auth: Auth;
+    /** File */
+    readonly files: Files;
+    /** PDF */
+    readonly pdf: Pdf;
+    /** PWA setup & prompt */
+    readonly pwa: PWA;
+    /** Socket */
+    readonly socket: Socket;
+    /** Superuser */
+    readonly superuser: Superuser;
+    /** WebRTC */
+    readonly webrtc: WebRtc;
+    /** Offline database */
+    database?: Database;
+    /** Options */
+    options: ApiOptions;
+    /** Created slices */
+    sliceCache: Map<number, Slice<any>>;
+    /** API URL */
+    url: string;
+    /** Client library version */
+    version: string;
+    /** Get session info from JWT payload */
+    get jwtPayload(): JwtPayload | null;
+    /** Is token expired */
+    get expired(): boolean;
+    /** Logged in spoke */
+    get spoke(): string;
+    /** API Session token */
+    token$: BehaviorSubject<string | null>;
+    get token(): string | null;
+    set token(token: string | null);
+    /**
+     * Connect to Datalynk & send requests
+     *
+     * @example
+     * ```ts
+     * const api = new Api('https://spoke.auxiliumgroup.com');
+     * ```
+     *
+     * @param {string} origin API URL
+     * @param {ApiOptions} options
+     */
+    constructor(origin: string, options?: ApiOptions);
+    private _request;
+    /**
+     * Get list of slices
+     * @return {Promise<number[]>}
+     */
+    getSlices(): Promise<number[]>;
+    /**
+     * Parses API request/response object for special Datalynk tokens & converts them to native JS objects
+     *
+     * @param obj An API request or response
+     * @return {Object} Api request or response with translated tokens
+     * @private
+     */
+    private static translateTokens;
+    /**
+     * Chain multiple requests to execute together
+     * @param {Slice<any>} requests List of requests to chain
+     * @return {Promise<any>} API Response
+     */
+    chain(...requests: (any | ApiCall<any>)[]): Promise<any>;
+    /**
+     * Organize multiple requests into a single mapped request
+     * @param {{[p: string]: any}} request Map of requests
+     * @return {Promise<any>} Map of API Responses
+     */
+    chainMap(request: {
+        [key: string]: any;
+    }): Promise<any>;
+    /**
+     * Exact same as `request` method, but logs the response in the console automatically
+     *
+     * @param {object | string} data Datalynk request as object or string
+     * @param {ApiRequestOptions} options
+     * @returns {Promise<any>} Datalynk response
+     */
+    debug<T = any>(data: any, options?: ApiRequestOptions): Promise<T>;
+    /**
+     * Send a request to Datalynk
+     *
+     * @example
+     * ```ts
+     * const response = await api.request('$/auth/current');
+     * ```
+     *
+     * @param {object} data Request using Datalynk API syntax. Strings will be converted: '$/auth/current' -> {'$/auth/current': {}}
+     * @param {ApiRequestOptions} options
+     * @returns {Promise<any>} Datalynk response or error
+     */
+    request<T = any>(data: any, options?: ApiRequestOptions): Promise<T>;
+    /**
+     * Create a slice object using the API
+     *
+     * @example
+     * ```ts
+     * const contactsSlice = api.slice<Contacts>(12345);
+     * const allContacts = await contactsSlice.select().exec().rows();
+     * const unsubscribe = contactsSlice.sync().subscribe(rows => console.log(rows));
+     * ```
+     *
+     * @param {number} id Slice ID the object will target
+     * @returns {Slice<T = any>} Object for making requests & caching rows
+     */
+    slice<T extends Meta = any>(id: number | string): Slice<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,EAAoD,QAAQ,EAAC,MAAM,gBAAgB,CAAC;AAC3F,OAAO,EAAC,eAAe,EAAuB,MAAM,MAAM,CAAC;AAC3D,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAC,GAAG,EAAC,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAC,KAAK,EAAC,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAC,GAAG,EAAC,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAC,OAAO,EAAE,KAAK,EAAC,MAAM,SAAS,CAAC;AACvC,OAAO,EAAC,MAAM,EAAC,MAAM,UAAU,CAAC;AAChC,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AAEtC,OAAO,EAAC,MAAM,EAAC,MAAM,UAAU,CAAC;AAEhC,MAAM,MAAM,UAAU,GAAG;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,GAAG,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;CACZ,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACxB,+DAA+D;IAC/D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kCAAkC;IAClC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,0BAA0B;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,uBAAuB;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2DAA2D;IAC3D,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,yBAAyB;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wDAAwD;IACxD,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IACxB,6BAA6B;IAC7B,MAAM,CAAC,EAAE;QACR,6BAA6B;QAC7B,GAAG,CAAC,EAAE,YAAY,EAAE,CAAC;QACrB,oDAAoD;QACpD,GAAG,EAAE,MAAM,CAAC;QACZ,2BAA2B;QAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,2BAA2B;QAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;KAClB,CAAA;CACD,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IACjC,8BAA8B;IAC9B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,sCAAsC;IACtC,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,wBAAwB;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAyB;AACzB,MAAM,WAAW,QAAQ;IACxB,oBAAoB;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,sBAAsB;IACtB,OAAO,EAAE,GAAG,CAAC;IACb,kCAAkC;IAClC,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,kBAAkB;IAClB,KAAK,CAAC,EAAE,GAAG,CAAC;CACZ;AAED;;GAEG;AACH,qBAAa,GAAG;aAwEa,MAAM,EAAE,MAAM;IAvE1C,6BAA6B;IAC7B,MAAM,CAAC,OAAO,EAAE,MAAM,CAAW;IAEjC,8BAA8B;IAC9B,OAAO,CAAC,MAAM,CAAwD;IACtE,gCAAgC;IAChC,OAAO,CAAC,aAAa,CAAkB;IACvC,6CAA6C;IAC7C,OAAO,CAAC,eAAe,CAAoB;IAC3C,6BAA6B;IAC7B,OAAO,CAAC,OAAO,CAA8B;IAE7C,cAAc;IACd,qBAAqB;IACrB,QAAQ,CAAC,IAAI,EAAG,IAAI,CAAC;IACrB,WAAW;IACX,QAAQ,CAAC,KAAK,EAAG,KAAK,CAAC;IACvB,UAAU;IACV,QAAQ,CAAC,GAAG,EAAG,GAAG,CAAC;IACnB,yBAAyB;IACzB,QAAQ,CAAC,GAAG,EAAG,GAAG,CAAC;IACnB,aAAa;IACb,QAAQ,CAAC,MAAM,EAAG,MAAM,CAAC;IACzB,gBAAgB;IAChB,QAAQ,CAAC,SAAS,EAAG,SAAS,CAAC;IAC/B,aAAa;IACb,QAAQ,CAAC,MAAM,EAAG,MAAM,CAAC;IAEzB,uBAAuB;IACvB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,cAAc;IACd,OAAO,EAAG,UAAU,CAAC;IACrB,qBAAqB;IACrB,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAa;IAChD,cAAc;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAW;IAE1B,wCAAwC;IACxC,IAAI,UAAU,IAAI,UAAU,GAAG,IAAI,CAGlC;IAED,uBAAuB;IACvB,IAAI,OAAO,YAEV;IAED,sBAAsB;IACtB,IAAI,KAAK,WAER;IAED,wBAAwB;IACxB,MAAM,iCAAsD;IAC5D,IAAI,KAAK,IACQ,MAAM,GAAG,IAAI,CADgB;IAC9C,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAA8B;IAE5D;;;;;;;;;;OAUG;gBACyB,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,UAAe;IAmDpE,OAAO,CAAC,QAAQ;IAqBhB;;;OAGG;IACH,SAAS,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAQ9B;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;IA0B9B;;;;OAIG;IACI,KAAK,CAAC,GAAG,QAAQ,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE;IAehD;;;;OAIG;IACI,QAAQ,CAAC,OAAO,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC;IAiB7C;;;;;;OAMG;IACI,KAAK,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,CAAC,CAAC;IAU7E;;;;;;;;;;;OAWG;IACI,OAAO,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,CAAC,CAAC;IAqC/E;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,CAAC,SAAS,IAAI,GAAG,GAAG,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC;CAIjE"}

package/dist/auth.d.ts

@@ -0,0 +1,174 @@
+import { Api } from './api';
+import { BehaviorSubject } from 'rxjs';
+import { LoginPrompt, LoginPromptOptions } from './login-prompt';
+/** User Account */
+export type User = {
+    /** Whether user is active */
+    active: number;
+    /** User's authentication reference */
+    auth_ref: number;
+    /** Contact email address */
+    email: string;
+    /** User ID */
+    id: number;
+    /** 2-Factor authentication type (optional) */
+    "2FA"?: string;
+    /** 2-Factor authentication code (optional) */
+    "2FA_code"?: string;
+    /** Current user ID if available (optional) */
+    CurrentUserID?: number | null;
+    /** Reference to the user that created this user */
+    creatorRef: number;
+    /** Date when the user was created (ISO 8601) */
+    created: string;
+    /** Communication ID (optional) */
+    communicationid?: number | null;
+    /** Account holder's first name */
+    first_name: string;
+    /** Last time this user was reported (optional) */
+    lastreported?: string | null;
+    /** Account holder's last name */
+    last_name: string;
+    /** Link to user's landing page (optional) */
+    landingpage?: string;
+    /** Username for logging in */
+    login: string;
+    /** Mobile info or alternate format (optional) */
+    mobile?: string;
+    /** Name of user's mobile app (optional) */
+    mobileappname?: string | null;
+    /** Color theme of user's mobile app (optional) */
+    mobileappcolor?: string | null;
+    /** Contact mobile phone number (optional) */
+    mobile_phone?: string;
+    /** Date when the user was last modified (ISO 8601) */
+    modified: string;
+    /** Reference to the user that last modified this user (optional) */
+    modifierRef?: number | null;
+    /** Phone number (optional) */
+    Phone?: string;
+    /** Type of phone (optional) */
+    phonetype?: string | null;
+    /** Spoke user comes from */
+    spoke: string;
+    /** Whether account is considered a guest */
+    guest: boolean;
+    /** Whether account is an admin */
+    sysadmin: boolean;
+    /** Current session token */
+    token: string;
+};
+/**
+ * Authentication requests
+ */
+export declare class Auth {
+    private readonly api;
+    private onlinePrompt?;
+    /** Current user as an observable */
+    user$: BehaviorSubject<User | null | undefined>;
+    /** Current user */
+    get user(): User | null | undefined;
+    /** Set current user info */
+    set user(user: User | null | undefined);
+    get spoke(): string | null;
+    constructor(api: Api);
+    /**
+     * Get current user associated with API token
+     *
+     * @return {Promise<User | null>}
+     */
+    current(token?: string | null): Promise<null | User>;
+    /**
+     * Automatically handle sessions by checking localStorage & URL parameters for a token & prompting
+     * user with a login screen if required
+     *
+     * @param {string} spoke Desired spoke
+     * @param {LoginPromptOptions} options Aesthetic options
+     * @return {Promise<void>} Login complete
+     */
+    handleLogin(spoke: string, options?: LoginPromptOptions): Promise<void>;
+    /**
+     * Check whether user has a token
+     *
+     * @return {boolean} True if session token authenticated
+     */
+    isAuthenticated(): boolean;
+    /**
+     * Check if the current user is a guest
+     *
+     * @return {boolean} True if guest
+     */
+    isGuest(): boolean;
+    /**
+     * Check if user is a system administrator
+     *
+     * @return {Promise<boolean>} True if system administrator
+     */
+    isSysAdmin(): Promise<boolean>;
+    /**
+     * Check if user is a table administrator
+     *
+     * @return {Promise<boolean>} True if table administrator
+     */
+    isTableAdmin(): Promise<boolean>;
+    /**
+     * Check if user is a user administrator
+     *
+     * @return {Promise<boolean>} True if user administrator
+     */
+    isUserAdmin(): Promise<boolean>;
+    /**
+     * 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
+     * @param {twoFactor?: string, expire?: string} opts 2FA code & expire date (YYYY-MM-DD)
+     * @returns {Promise<User>} User account
+     */
+    login(spoke: string, login: string, password: string, opts?: {
+        twoFactor?: string;
+        expire?: null | string;
+    }): Promise<User>;
+    /**
+     * Login as guest user
+     *
+     * @return {Promise<User>} Guest account
+     */
+    loginGuest(): Promise<User>;
+    /**
+     * Create Login UI
+     *
+     * @param {string} spoke Desired spoke
+     * @param {LoginPromptOptions} options Aesthetic options
+     * @return {LoginPrompt} Login prompt
+     */
+    loginPrompt(spoke: string, options?: LoginPromptOptions): LoginPrompt;
+    /**
+     * Logout current user
+     *
+     * @return {Promise<{closed: string, new: string}>}
+     */
+    logout(reload?: boolean): Promise<{
+        closed: string;
+        new: string;
+    }>;
+    /**
+     * Reset user account password
+     *
+     * @param {string} login User login
+     * @param {string} newPassword New password
+     * @param {string} code Reset code sent with `resetRequest`
+     * @return {Promise<any>} New session
+     */
+    reset(login: string, newPassword: string, code?: string): Promise<any>;
+    /**
+     * Request reset code for user
+     *
+     * @param {string} login User to reset
+     * @param {"email" | "sms" | "voice"} mode Method of sending reset code
+     * @return {Promise<any>} Unknown
+     */
+    resetRequest(login: string, mode: 'email' | 'sms' | 'voice'): Promise<any>;
+}
+//# 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;AAC1B,OAAO,EAAC,eAAe,EAAS,MAAM,MAAM,CAAC;AAE7C,OAAO,EAAC,WAAW,EAAE,kBAAkB,EAAC,MAAM,gBAAgB,CAAC;AAE/D,mBAAmB;AACnB,MAAM,MAAM,IAAI,GAAG;IAClB,6BAA6B;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,cAAc;IACd,EAAE,EAAE,MAAM,CAAC;IACX,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8CAA8C;IAC9C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,8CAA8C;IAC9C,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAC;IACnB,gDAAgD;IAChD,OAAO,EAAE,MAAM,CAAC;IAChB,kCAAkC;IAClC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,kCAAkC;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,kDAAkD;IAClD,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,iCAAiC;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,kDAAkD;IAClD,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,6CAA6C;IAC7C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,sDAAsD;IACtD,QAAQ,EAAE,MAAM,CAAC;IACjB,oEAAoE;IACpE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,8BAA8B;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,4CAA4C;IAC5C,KAAK,EAAE,OAAO,CAAC;IACf,kCAAkC;IAClC,QAAQ,EAAE,OAAO,CAAC;IAClB,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;CACd,CAAA;AAED;;GAEG;AACH,qBAAa,IAAI;IAcJ,OAAO,CAAC,QAAQ,CAAC,GAAG;IAbhC,OAAO,CAAC,YAAY,CAAC,CAAM;IAE3B,oCAAoC;IACpC,KAAK,2CAA2D;IAEhE,mBAAmB;IACnB,IAAI,IAAI,IAGO,IAAI,GAAG,IAAI,GAAG,SAAS,CAHM;IAE5C,4BAA4B;IAC5B,IAAI,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,EAA4B;IAElE,IAAI,KAAK,kBAAiD;gBAE7B,GAAG,EAAE,GAAG;IAWrC;;;;OAIG;IACG,OAAO,CAAC,KAAK,GAAE,MAAM,GAAG,IAA0B,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAa/E;;;;;;;OAOG;IACG,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAmB7E;;;;OAIG;IACH,eAAe;IAEf;;;;OAIG;IACH,OAAO;IAEP;;;;OAIG;IACG,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC;IAOpC;;;;OAIG;IACG,YAAY,IAAI,OAAO,CAAC,OAAO,CAAC;IAOtC;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAOrC;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;QAC5D,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,MAAM,CAAC,EAAE,IAAI,GAAG,MAAM,CAAA;KACtB,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBjB;;;;OAIG;IACH,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAS3B;;;;;;OAMG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,WAAW;IAIrE;;;;OAIG;IACH,MAAM,CAAC,MAAM,UAAO;gBAEe,MAAM;aAAO,MAAM;;IAOtD;;;;;;;OAOG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM;IAavD;;;;;;OAMG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,KAAK,GAAG,OAAO;CAI3D"}

package/dist/files.d.ts

@@ -0,0 +1,65 @@
+import { Api } from './api';
+/**
+ * Metadata for an uploaded file in Datalynk
+ */
+export interface UploadedFile {
+    /** File ID used to reference file in Datalynk */
+    id: number;
+    /** Filename */
+    name: string;
+    /** Size of file on disk */
+    size: number;
+    /** Filename extension */
+    extension: string;
+    /** Mimetype */
+    mime: string;
+    /** URL to open file */
+    url?: string;
+}
+/**
+ * Handle uploading & fetching files from Datalynk
+ */
+export declare class Files {
+    private readonly api;
+    constructor(api: Api);
+    /**
+     * Associate an existing file with an existing row
+     *
+     * @param {number | number[]} fileIds Existing files to associate
+     * @param {number} slice Target slice
+     * @param {number} row Target slice record
+     * @param {string} field Record filed file should be added to
+     * @param {boolean} execute Will run request by default, passing false will return the API request instead
+     * @return {any} The API response by default, or the raw API request if execute is false
+     */
+    associate(fileIds: number | number[], slice: number, row: number, field: string, execute?: true): Promise<any>;
+    associate(fileIds: number | number[], slice: number, row: number, field: string, execute: false): {
+        '!/tools/file/update': {
+            slice: number;
+            row: number;
+            field: string;
+            ids: number[];
+        };
+    };
+    /**
+     * Get an authenticated URL to fetch files from
+     *
+     * @param {number} id File ID
+     * @param {boolean} ignoreToken Ignore authentication
+     * @return {string} URL file can be viewed at
+     */
+    get(id: number, ignoreToken?: boolean): string;
+    /**
+     * Upload file(s) to the API & optionally associate them with a row
+     *
+     * @param {FileList | File | File[]} files Files to be uploaded
+     * @param {{slice: number, row: any, field: string, pk?: string}} associate Row to associate with
+     */
+    upload(files: FileList | File | File[], associate?: {
+        slice: number;
+        row: number | any;
+        field: string;
+        pk?: string;
+    }): Promise<UploadedFile[]>;
+}
+//# sourceMappingURL=files.d.ts.map

package/dist/files.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../src/files.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,GAAG,EAAC,MAAM,OAAO,CAAC;AAE1B;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B,iDAAiD;IACjD,EAAE,EAAE,MAAM,CAAC;IACX,eAAe;IACf,IAAI,EAAE,MAAM,CAAC;IACb,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,yBAAyB;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe;IACf,IAAI,EAAE,MAAM,CAAC;IACb,uBAAuB;IACvB,GAAG,CAAC,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,qBAAa,KAAK;IACL,OAAO,CAAC,QAAQ,CAAC,GAAG;gBAAH,GAAG,EAAE,GAAG;IAErC;;;;;;;;;OASG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC;IAC9G,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,GAAG;QAAC,qBAAqB,EAAE;YAAC,KAAK,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,EAAE,CAAA;SAAC,CAAA;KAAC;IAOrL;;;;;;OAMG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,MAAM;IAI9C;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,QAAQ,GAAG,IAAI,GAAG,IAAI,EAAE,EAAE,SAAS,CAAC,EAAE;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,EAAE,CAAC,EAAE,MAAM,CAAA;KAAC,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;CAuB5I"}

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+export * from './api';
+export * from './auth';
+export * from './files';
+export * from './login-prompt';
+export * from './meta';
+export * from './pdf';
+export * from './pwa';
+export * from './serializer';
+export * from './slice';
+export * from './socket';
+export * from './superuser';
+export * from './themes';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,QAAQ,CAAC;AACvB,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC;AACtB,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC"}