@auxilium/datalynk-client 0.9.11 → 1.0.0

package/README.md

@@ -157,7 +157,7 @@ import {Contact} from 'models/contact'; // Import model for slice we will be usi
 
 const contacts: Contact[] = await api.slice<Contact>(Slices.Contact)
                                      .select()
-                                     .exec().rows();
+                                     .rows().exec();
 ```
 
 </details>
@@ -167,6 +167,15 @@ const contacts: Contact[] = await api.slice<Contact>(Slices.Contact)
     <h3 id="authentication" style="display: inline">Authentication</h3>
   </summary>
 
+#### Guest
+
+Login as the guest account
+
+```js
+const guest = await api.auth.loginGuest();
+console.log(api.auth.isGuest()) // True
+```
+
 #### Login flow
 
 This library comes with some logic to automatically handle the login flow & should be called at the startup of your application:
@@ -212,7 +221,7 @@ const user = await api.auth.login('spoke', 'username', 'password', '2faCode');
 Multiple requests can be chained together to run them in order. The last request's response will be returned
 
 ```js
-const report = await api.chain({'$/auth/current': {}}, api.slice(12345).select());
+const report = await api.chain({'$/auth/current': {}}, api.slice(12345).select().rows());
 ```
 
 All results can be returned together by using the `chainMap`
@@ -220,7 +229,7 @@ All results can be returned together by using the `chainMap`
 ```js
 const {user, report} = await api.chainMap({
     user: {'$/auth/current': {}},
-    report: api.slice(52131).select()
+    report: api.slice(52131).select().rows()
 });
 ```
 
@@ -239,12 +248,12 @@ This library comes with LINQ style query language to help make interacting with
 // Get a single record
 const row = await api.slice<T>(12345)
                      .select(12345)
-                     .exec().row();
+                     .row().exec();
 
 // Get all slice records
 const rows = await api.slice<T>(12345)
                       .select()
-                      .exec().rows();
+                      .rows().exec();
 
 // Advanced queries
 const rows = await api.slice<T>(12345)
@@ -255,7 +264,7 @@ const rows = await api.slice<T>(12345)
                       .where({field1: 0, field2: false})
                       .order('field2', true) // ascending
                       .limit(10)
-                      .exec().rows();                      
+                      .rows().exec();                      
 ```
 
 #### Count
@@ -264,7 +273,7 @@ const rows = await api.slice<T>(12345)
 const count = await api.slice(12345)
                        .count()
                        .where({field1: 'value'})
-                       .exec().count();
+                       .count().exec();
 ```
 
 #### Insert
@@ -273,7 +282,7 @@ const count = await api.slice(12345)
 // Insert record
 const key = await api.slice<Contact>(12345)
                      .insert({first: 'Bilbo', last: 'Baggins'})
-                     .exec().key();
+                     .id().exec();
 
 // Insert multiple rows
 const keys = await api.slice<Contacts>(12345)
@@ -281,7 +290,7 @@ const keys = await api.slice<Contacts>(12345)
                         {first: 'Darth', last: 'Vader'},
                         {first: 'John', last: 'Snow'}
                       ])
-                      .exec().keys();
+                      .ids().exec();
 ```
 
 #### Update
@@ -290,13 +299,13 @@ const keys = await api.slice<Contacts>(12345)
 // Update a record
 const success = await api.slice(12345)
                          .update({id: 1, first: 'James', last: 'Kirk'})
-                         .exec().key();
+                         .id().exec();
 
 // Update multiple rows with where
 await api.slice(12345)
          .update({evil: true})
          .where({first: 'Darth'})
-         .exec().keys();
+         .ids().exec();
 ```
 
 #### Delete
@@ -305,13 +314,13 @@ await api.slice(12345)
 // Delete a record
 const success = await api.slice(12345)
                          .delete(12345)
-                         .exec().key();
+                         .id().exec();
 
 // Dlete multiple rows with where
 await api.slice(12345)
          .delete()
          .where({first: 'Darth'})
-         .exec().keys();
+         .ids().exec();
 ```
 
 </details>
@@ -363,8 +372,6 @@ api.socket.addListener(callbackFn(event)); // listen to all socket events
 
 </details>
 
-</details>
-
 <details>
   <summary>
     <h3 id="uploads" style="display: inline">Uploads</h3>

package/dist/api.d.ts

@@ -2,7 +2,7 @@ import { BehaviorSubject } from 'rxjs';
 import { Auth } from './auth';
 import { Files } from './files';
 import { Pdf } from './pdf';
-import { Slice, SliceMeta } from './slice';
+import { Slice } from './slice';
 import { Socket } from './socket';
 import { Superuser } from './superuser';
 
@@ -37,12 +37,10 @@ export type ApiOptions = {
  * Possible options for API calls
  */
 export interface ApiRequestOptions {
-    /** Skip optimizations like bundling & caching */
-    force?: boolean;
+    /** Skip bundling & caching */
+    noOptimize?: boolean;
     /** Skip the token translating step */
     raw?: boolean;
-    /** Skip wrapping IDs in an array */
-    rawUpload?: boolean;
 }
 /** API error response */
 export interface ApiError {
@@ -66,7 +64,7 @@ export declare class Api {
     private bundleOngoing;
     /** LocalStorage key for persisting logins */
     private localStorageKey;
-    /** Pending requests */
+    /** Pending requests cache */
     private pending;
     /** Authentication helpers */
     readonly auth: Auth;
@@ -78,7 +76,7 @@ export declare class Api {
     readonly socket: Socket;
     /** Superuser helpers */
     readonly superuser: Superuser;
-    /** API endpoint */
+    /** API URL endpoint */
     readonly url: string;
     /** API Session token */
     token$: BehaviorSubject<string | null>;
@@ -110,7 +108,7 @@ export declare class Api {
     /**
      * Chain multiple requests to execute together
      * @param {Slice<any>} requests List of requests to chain
-     * @return {Promise<SlicePromise[]>} API Response
+     * @return {Promise<any>} API Response
      */
     chain(...requests: (any | Slice<any>)[]): Promise<any>;
     /**
@@ -121,6 +119,14 @@ export declare class Api {
     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
      *
@@ -145,16 +151,8 @@ export declare class Api {
      * ```
      *
      * @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>;
-    /**
-     * 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
+     * @returns {Slice<T = any>} Object for making requests & caching rows
      */
-    test<T = any>(data: any, options?: ApiRequestOptions): Promise<T>;
+    slice<T = any>(slice: number | string): Slice<T>;
 }
 //# sourceMappingURL=api.d.ts.map

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;AAC9B,OAAO,EAAC,GAAG,EAAC,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAC,KAAK,EAAE,SAAS,EAAe,MAAM,SAAS,CAAC;AACvD,OAAO,EAAC,MAAM,EAAC,MAAM,UAAU,CAAC;AAChC,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AAEtC,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,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;aA6C0B,OAAO,EAAE,UAAU;IA5C5D,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,wCAAwC;IACxC,IAAI,UAAU,IAAI,UAAU,GAAG,IAAI,CAGlC;IAED;;;;;;;;;;OAUG;gBACS,GAAG,EAAE,MAAM,EAAkB,OAAO,GAAE,UAAe;IA2BjE,OAAO,CAAC,QAAQ;IAoBhB;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;IAsB9B;;;;OAIG;IACI,KAAK,CAAC,GAAG,QAAQ,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE;IAI9C;;;;OAIG;IACI,QAAQ,CAAC,OAAO,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC;IAO7C;;;;;;;;;;;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,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"}
+{"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,EAAC,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAC,MAAM,EAAC,MAAM,UAAU,CAAC;AAChC,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AAEtC,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,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,8BAA8B;IAC9B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,sCAAsC;IACtC,GAAG,CAAC,EAAE,OAAO,CAAC;CACd;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;aA6C0B,OAAO,EAAE,UAAU;IA5C5D,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,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,uBAAuB;IACvB,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,wCAAwC;IACxC,IAAI,UAAU,IAAI,UAAU,GAAG,IAAI,CAGlC;IAED;;;;;;;;;;OAUG;gBACS,GAAG,EAAE,MAAM,EAAkB,OAAO,GAAE,UAAe;IA2BjE,OAAO,CAAC,QAAQ;IAoBhB;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;IAsB9B;;;;OAIG;IACI,KAAK,CAAC,GAAG,QAAQ,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE;IAI9C;;;;OAIG;IACI,QAAQ,CAAC,OAAO,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC;IAO7C;;;;;;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,GAAG,GAAG,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;CAG5C"}