@auxilium/datalynk-client 0.5.1 → 0.6.0

package/README.md

@@ -1,6 +1,6 @@
 # Datalynk Client Library
 
-[![pipeline status](https://gitlab.auxiliumgroup.com/ztimson/datalynk-client/badges/master/pipeline.svg)](https://gitlab.auxiliumgroup.com/ztimson/datalynk-client/pipelines)
+[![pipeline status](https://gitlab.auxiliumgroup.com/auxilium/datalynk/datalynk-client/badges/master/pipeline.svg)](https://gitlab.auxiliumgroup.com/ztimson/datalynk-client/pipelines)
 
 ---
 
@@ -45,6 +45,8 @@ const resp = await api.request({'$/auth/current':{}});
 
 ## Documentation
 
+The full documentation can be found [here](./docs/Home.md).
+
 <details>
   <summary>
     <h3 id="integration" style="display: inline">Integration</h3>
@@ -74,10 +76,12 @@ export class DatalynkApi extends Api {
   contacts!: Slice<Contact>;
 
   constructor() {
+    // Create API object & expose to window
     super(environment.api, {/* options */});
     window.api = this;
 
-    this.handleLogin('spoke', {/* login UI options */});
+    // Handle logging in
+    this.auth.handleLogin('spoke', {/* login UI options */});
 
     // Create store to cache slice data
     this.contacts = this.slice<Contact>(Slices.Contact);
@@ -95,7 +99,12 @@ import {environment} from '../environment/environment';
 import {Contact} from '../models/contact';
 import {Slices} from '../models/slices';
 
-export const api = new Api(environment.api, {/* options */});
+// Create API object & expose to window
+export const api = window.api = new Api(environment.api, {/* options */});
+
+// Handle logging in
+api.auth.handleLogin('spoke', {/* login UI options */});
+
 // Create store to cache slice data
 export const contacts = api.slice<Contact>(Slices.Contact);
 ```
@@ -108,7 +117,12 @@ export const contacts = api.slice<Contact>(Slices.Contact);
 <script type="module">
   import {Api} from '@auxilium/datlaynk-client/dist/index.mjs';
 
+  // Create API object & expose to window
   var api = new Api('https://spoke.auxiliumgroup.com', /* options */);
+
+  // Handle logging in
+  api.auth.handleLogin('spoke', {/* login UI options */});
+
   // Create store to cache slice data
   var contacts = api.slice(12345);
 </script>
@@ -191,7 +205,7 @@ const user = await api.auth.login('spoke', 'username', 'password', '2faCode');
 
 <details>
   <summary>
-    <h3 id="" style="display: inline">Slice Engine</h3>
+    <h3 id="slices" style="display: inline">Slice Engine</h3>
   </summary>
 
 This library comes with LINQ style query language to help make interacting with Slices easier by providing types & intelisense.
@@ -270,7 +284,7 @@ await api.slice(12345)
 
 <details>
   <summary>
-    <h3 id="" style="display: inline">Sockets</h3>
+    <h3 id="sockets" style="display: inline">Sockets</h3>
   </summary>
 
 
@@ -313,4 +327,37 @@ api.socket.sliceEvents(123, callbackFn(event)); // Listen to a specific slice
 api.socket.addListener(callbackFn(event)); // listen to all socket events
 ```
 
+</details>
+
+</details>
+
+<details>
+  <summary>
+    <h3 id="uploads" style="display: inline">Uploads</h3>
+  </summary>
+
+A file URL can be created from the file ID
+```js
+const url = api.files.get(12345);
+```
+
+Uploading files to datalynk is done by first uploading the file as form-data &
+then creating a reference to the upload ID in a slice.
+
+```js
+// Get files from file input
+const files = document.querySelector('#upload').files;
+
+// Upload file
+api.files.upload(files).then(uploaded => {
+  // Associate with record
+  const slice = 12345, row: 123;
+  api.files.associate(uploaded.map(r => r.id), slice, row, 'field');
+});
+
+// OR do it all at once
+api.files.upload(files, {slice: 12345, row: 1234, field: 'abc'});
+```
+
+
 </details>

package/dist/api.d.ts

@@ -1,29 +1,26 @@
 import { BehaviorSubject } from 'rxjs';
 import { Auth } from './auth';
 import { Files } from './files';
+import { Pdf } from './pdf';
 import { Slice, SliceMeta } from './slice';
 import { Socket } from './socket';
 import { Superuser } from './superuser';
 
-/**
- * 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 */
+    /** Bundle requests together that happen in quick succession */
     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 */
+    /** Disable sockets with false or override socket URL */
     socket?: false | string;
 };
 /**
- * Options when making requests
+ * Possible options for API calls
  */
 export interface ApiRequestOptions {
     /** Skip optimizations like bundling & caching */
@@ -33,15 +30,19 @@ export interface ApiRequestOptions {
     /** Skip wrapping IDs in an array */
     rawUpload?: boolean;
 }
-/** Request error shape */
-export interface ApiRequestError {
+/** API error response */
+export interface ApiError {
+    /** Error message */
     message: string;
+    /** Source of error */
     request: any;
+    /** Extra debugging information */
     debug?: any;
+    /** Stack trace */
     trace?: any;
 }
 /**
- * Object to handle communications between the app and Datalynk
+ * Connect to Datalynk & send requests
  */
 export declare class Api {
     readonly options: ApiOptions;
@@ -57,6 +58,8 @@ export declare class Api {
     readonly auth: Auth;
     /** File helpers */
     readonly files: Files;
+    /** PDF helpers */
+    readonly pdf: Pdf;
     /** Socket object */
     readonly socket: Socket;
     /** Superuser helpers */
@@ -68,31 +71,59 @@ export declare class Api {
     get token(): string | null;
     set token(token: string | null);
     /**
-     * Object to handle communications between the app and Datalynk
+     * Connect to Datalynk & send requests
+     *
+     * @example
+     * ```ts
+     * const api = new Api('https://spoke.auxiliumgroup.com');
+     * ```
+     *
      * @param {string} url API URL
      * @param {ApiOptions} options
      */
     constructor(url: string, options?: ApiOptions);
     private _request;
+    /**
+     * 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;
     /**
      * Send a request to Datalynk
-     * @param {object} data request
-     * @param {ApiRequestOptions} options  Options
-     * @returns {Promise<any>} Promise of response
+     *
+     * @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>;
     /**
-     * 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
+     * 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} slice Slice number the object will target
+     * @returns {Slice<T extends SliceMeta>} Object for making requests & caching rows
      */
     slice<T extends SliceMeta>(slice: number | string): 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
+     * 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
      */
     test<T = any>(data: any, options?: ApiRequestOptions): Promise<T>;
 }

package/dist/api.d.ts.map

@@ -1 +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;AAC5B,OAAO,EAAC,KAAK,EAAC,MAAM,SAAS,CAAC;AAE9B,OAAO,EAAC,KAAK,EAAE,SAAS,EAAC,MAAM,SAAS,CAAC;AACzC,OAAO,EAAC,MAAM,EAAC,MAAM,UAAU,CAAC;AAChC,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AAEtC;;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;aA+B0B,OAAO,EAAE,UAAU;IA9B5D,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,mBAAmB;IACnB,QAAQ,CAAC,KAAK,QAAmB;IACjC,oBAAoB;IACpB,QAAQ,CAAC,MAAM,EAAG,MAAM,CAAC;IACzB,wBAAwB;IACxB,QAAQ,CAAC,SAAS,YAAuB;IACzC,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;IAqBhB,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,GAAG,MAAM;IAIxD;;;;;OAKG;IACI,IAAI,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,CAAC,CAAC;CAU5E"}
+{"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;AAC5B,OAAO,EAAC,KAAK,EAAC,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAC,GAAG,EAAC,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAC,KAAK,EAAE,SAAS,EAAC,MAAM,SAAS,CAAC;AACzC,OAAO,EAAC,MAAM,EAAC,MAAM,UAAU,CAAC;AAChC,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AAEtC;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACxB,+DAA+D;IAC/D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iCAAiC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2DAA2D;IAC3D,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,wDAAwD;IACxD,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,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;aAuC0B,OAAO,EAAE,UAAU;IAtC5D,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,mBAAmB;IACnB,QAAQ,CAAC,KAAK,QAAmB;IACjC,kBAAkB;IAClB,QAAQ,CAAC,GAAG,MAAiB;IAC7B,oBAAoB;IACpB,QAAQ,CAAC,MAAM,EAAG,MAAM,CAAC;IACzB,wBAAwB;IACxB,QAAQ,CAAC,SAAS,YAAuB;IACzC,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;;;;;;;;;;OAUG;gBACS,GAAG,EAAE,MAAM,EAAkB,OAAO,GAAE,UAAe;IAyBjE,OAAO,CAAC,QAAQ;IAqBhB;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;IAsB9B;;;;;;;;;;;OAWG;IACI,OAAO,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,CAAC,CAAC;IAmC/E;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,CAAC,SAAS,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;IAIxD;;;;;;OAMG;IACI,IAAI,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,CAAC,CAAC;CAS5E"}

package/dist/auth.d.ts

@@ -2,19 +2,29 @@ import { BehaviorSubject } from 'rxjs';
 import { Api } from './api';
 import { LoginPromptOptions } from './login-prompt';
 
-/** User */
+/** User Account */
 export type User = {
+    /** User ID */
     id: Number;
+    /** Current session token */
     token: string;
+    /** Whether account is considered a guest */
     guest: boolean;
+    /** Whether account is an admin */
     sysadmin: boolean;
+    /** Account holders firstname */
     first_name: string;
+    /** Account holders lastname */
     last_name: string;
+    /** Contact email address */
     email: string;
+    /** Username for logging in */
     login: string;
     "2FA"?: string;
     "2FA_code"?: string;
+    /** Contact phone number */
     mobile_phone?: string;
+    /** Spoke user comes from */
     spoke: string;
 };
 /**
@@ -22,18 +32,23 @@ export type User = {
  */
 export declare class Auth {
     private readonly api;
+    /** Current user as an observable */
     user$: BehaviorSubject<User | null>;
+    /** Current user */
     get user(): User | null;
+    /** Set current user info */
     set user(user: User | null);
     constructor(api: Api);
     /**
      * Get current user associated with API token
+     *
      * @return {Promise<User | null>}
      */
     current(): 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
@@ -41,31 +56,37 @@ export declare class Auth {
     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
@@ -75,11 +96,13 @@ export declare class Auth {
     login(spoke: string, login: string, password: string, twoFactor?: string): Promise<any>;
     /**
      * Login as guest user
+     *
      * @return {Promise<any>}
      */
     loginGuest(): Promise<any>;
     /**
      * Create Login UI
+     *
      * @param {string} spoke Desired spoke
      * @param {LoginPromptOptions} options Aesthetic options
      * @return {Promise<void>} Login complete
@@ -87,6 +110,7 @@ export declare class Auth {
     loginPrompt(spoke: string, options?: LoginPromptOptions): Promise<void>;
     /**
      * Logout current user
+     *
      * @return {Promise<{closed: string, new: string}>}
      */
     logout(): Promise<{
@@ -95,6 +119,7 @@ export declare class Auth {
     }>;
     /**
      * Reset user account password
+     *
      * @param {string} login User login
      * @param {string} newPassword New password
      * @param {string} code Reset code sent with `resetRequest`
@@ -103,6 +128,7 @@ export declare class Auth {
     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

package/dist/auth.d.ts.map

@@ -1 +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;AAE1B,OAAO,EAAc,kBAAkB,EAAC,MAAM,gBAAgB,CAAC;AAE/D,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;IAMJ,OAAO,CAAC,QAAQ,CAAC,GAAG;IAJhC,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;IACG,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB7E;;;OAGG;IACH,eAAe;IAEf;;;OAGG;IACH,OAAO;IAEP;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC;IAOpC;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,OAAO,CAAC;IAOtC;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAOrC;;;;;;;OAOG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAkBvF;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC;IAS1B;;;;;OAKG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvE;;;OAGG;IACH,MAAM;gBAC6B,MAAM;aAAO,MAAM;;IAOtD;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM;IAWvD;;;;;OAKG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,KAAK,GAAG,OAAO;CAI3D"}
+{"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;AAE1B,OAAO,EAAc,kBAAkB,EAAC,MAAM,gBAAgB,CAAC;AAE/D,mBAAmB;AACnB,MAAM,MAAM,IAAI,GAAG;IAClB,cAAc;IACd,EAAE,EAAE,MAAM,CAAC;IACX,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,4CAA4C;IAC5C,KAAK,EAAE,OAAO,CAAC;IACf,kCAAkC;IAClC,QAAQ,EAAE,OAAO,CAAC;IAClB,gCAAgC;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2BAA2B;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;CACd,CAAA;AAED;;GAEG;AACH,qBAAa,IAAI;IASJ,OAAO,CAAC,QAAQ,CAAC,GAAG;IAPhC,oCAAoC;IACpC,KAAK,+BAA0C;IAC/C,mBAAmB;IACnB,IAAI,IAAI,IAEO,IAAI,GAAG,IAAI,CAFkB;IAC5C,4BAA4B;IAC5B,IAAI,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,EAA4B;gBAEzB,GAAG,EAAE,GAAG;IAErC;;;;OAIG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAW/B;;;;;;;OAOG;IACG,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB7E;;;;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,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAkBvF;;;;OAIG;IACH,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC;IAS1B;;;;;;OAMG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvE;;;;OAIG;IACH,MAAM;gBAC6B,MAAM;aAAO,MAAM;;IAOtD;;;;;;;OAOG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM;IAWvD;;;;;;OAMG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,KAAK,GAAG,OAAO;CAI3D"}

package/dist/files.d.ts

@@ -1,11 +1,20 @@
 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;
 }
 /**
@@ -17,19 +26,21 @@ export declare class Files {
     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} rowId Target slice record
+     * @param {number} row Target slice record
      * @param {string} field Record filed file should be added to
-     * @param {true} chain Submit request automatically if falsy, returns as a chained command otherwise
-     * @return {any} Unknown
+     * @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, rowId: number, field: string, chain: true): {
+    associate(fileIds: number | number[], slice: number, row: number, field: string, execute: true): {
         [key: string]: any;
     };
-    associate(fileIds: number | number[], slice: number, rowId: number, field: string): Promise<any>;
+    associate(fileIds: number | number[], slice: number, row: number, field: string): Promise<any>;
     /**
      * 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
@@ -37,6 +48,7 @@ export declare class Files {
     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
      */

package/dist/files.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../src/files.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,GAAG,EAAC,MAAM,OAAO,CAAC;AAE1B,MAAM,WAAW,YAAY;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,qBAAa,KAAK;IAGL,OAAO,CAAC,QAAQ,CAAC,GAAG;IAFhC,QAAQ,CAAC,GAAG,EAAG,MAAM,CAAA;gBAEQ,GAAG,EAAE,GAAG;IAIrC;;;;;;;;OAQG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,GAAG;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC;IACrH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAOhG;;;;;OAKG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,MAAM;IAI9C;;;;OAIG;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;CAyB5I"}
+{"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;IAGL,OAAO,CAAC,QAAQ,CAAC,GAAG;IAFhC,QAAQ,CAAC,GAAG,EAAG,MAAM,CAAA;gBAEQ,GAAG,EAAE,GAAG;IAIrC;;;;;;;;;OASG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,GAAG;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC;IACrH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAO9F;;;;;;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;CAyB5I"}