@auxilium/datalynk-client 0.9.12 → 1.0.0

package/dist/slice.d.ts

@@ -1,104 +1,19 @@
 import { BehaviorSubject } from 'rxjs';
-import { Api, ApiError, ApiRequestOptions } from './api';
+import { Api, ApiRequestOptions } from './api';
 import { Unsubscribe } from './socket';
 
-export interface SliceMeta {
-    id?: number;
-    created?: Date;
-    creatorRef?: number;
-    modified?: Date;
-    modifiedRef?: number;
-}
-/**
- * An object to provide helpers for Datalynk results
- */
-export declare class SlicePromise<T extends SliceMeta> {
-    readonly slice: Slice<T>;
-    readonly promise: Promise<SliceResponse<T>>;
-    /**
-     * An object to provide helpers for Datalynk results
-     *
-     * @param slice
-     * @param {SliceResponse<T>} promise Datalynk promise to handle
-     */
-    constructor(slice: Slice<T>, promise: Promise<SliceResponse<T>>);
-    /**
-     * Catch promise errors
-     */
-    catch(callback: (error: ApiError | any) => any): Promise<any>;
-    /**
-     * Count rows or fetch count alias result
-     */
-    count(): Promise<number>;
-    /**
-     * Log the raw result to the console for inspection
-     */
-    debug(): SlicePromise<T>;
-    /**
-     * Fields that failed
-     */
-    failed(): Promise<number[]>;
-    /**
-     * Catch promise errors
-     */
-    finally(callback: () => any): Promise<SliceResponse<T>>;
-    /**
-     * Fields that were ignored (Perms or readonly)
-     */
-    ignored(): Promise<object[]>;
-    /**
-     * ID of first affected row
-     */
-    key(): Promise<number>;
-    /**
-     * IDs of all affected rows
-     */
-    keys(): Promise<number[]>;
-    /**
-     * Fields that were affected successfully
-     */
-    granted(): Promise<object[]>;
-    /**
-     * First row of data
-     */
-    row(): Promise<T>;
-    /**
-     * All rows of data
-     */
-    rows(): Promise<T[]>;
-    /**
-     * Handle as normal request
-     */
-    then(success: (response: SliceResponse<T>) => any, error?: (error: ApiError | any) => any): Promise<SliceResponse<T>>;
-    /**
-     * Get the raw promise
-     */
-    toPromise(): Promise<SliceResponse<T>>;
-    /**
-     * Get the transaction ID
-     */
-    transaction(): Promise<number>;
-}
-/**
- * Model for datalynk responses
- */
-export interface SliceResponse<T extends SliceMeta> {
-    failed: number[];
-    granted: object[];
-    'ignored-fields': object[];
-    keys: number[];
-    rows: T[];
-    tx: number;
-}
 /**
  * An object to aid in constructing Datalynk requests
  */
-export declare class Slice<T extends SliceMeta> {
+export declare class Slice<T = any> {
     private slice;
     private api;
     static api: Api;
     private operation;
+    private popField?;
     private request;
+    /** Log response automatically */
+    debugging?: boolean;
     /** Unsubscribe from changes, undefined if not subscribed */
     unsubscribe?: Unsubscribe | null;
     /** Cached slice data as an observable */
@@ -108,9 +23,10 @@ export declare class Slice<T extends SliceMeta> {
     /** Set cached data & alert subscribers */
     private set cache(value);
     /** Get raw API request */
-    get raw(): {
+    get raw(): Partial<{
         [x: string]: any;
-    };
+        $pop: string | undefined;
+    }>;
     /**
      * An object to aid in constructing requests
      *
@@ -119,17 +35,21 @@ export declare class Slice<T extends SliceMeta> {
      */
     constructor(slice: number | string, api: Api);
     /**
-     * Whitelist and alias fields. Alias for the fields functions
+     * Whitelist and alias fields. Alias of `fields()`
      * @example
      * ```ts
      * const id: {id: number, field2: any}[] = await new Slice<T>(12345)
      * 		.select().alias({id: 'id', field1: 'field2'}).exec().keys();
      * ```
      * @param {object} aliasKeyVals List of properties to whitelist and what to rename them to
+     * @return {Slice<T>}
      */
-    alias(aliasKeyVals: {
-        [key: string]: string | object;
-    }): Slice<T>;
+    alias: {
+        (whitelist: string[]): Slice<T>;
+        (alias: {
+            [key: string]: string | object;
+        }): Slice<T>;
+    };
     /**
      * Add an 'AND' condition inside the where argument
      * @example
@@ -140,6 +60,7 @@ export declare class Slice<T extends SliceMeta> {
      *                 .where({field2: 2, field3: 3})
      *                 .exec().rows();
      * ```
+     * @return {Slice<T>}
      */
     and(): this;
     /**
@@ -151,12 +72,15 @@ export declare class Slice<T extends SliceMeta> {
      * 					.exec().count();
      * ```
      * @param {object | string} arg Count argument
+     * @return {Slice<T>}
      */
-    count(arg?: object | string): this;
+    count(arg?: object | string): Slice<T>;
     /**
      * Output the formed request to the console for inspection
+     * @param {boolean} enabled Enable/Disable console logging
+     * @return {Slice<T>}
      */
-    debug(): this;
+    debug(enabled?: boolean): this;
     /**
      * Set the request type to delete
      * @example
@@ -164,6 +88,7 @@ export declare class Slice<T extends SliceMeta> {
      * await new Slice(12345).delete(id).exec();
      * ```
      * @param {number | number[]} id ID(s) to delete
+     * @return {Slice<T>}
      */
     delete(id?: number | number[]): Slice<T>;
     /**
@@ -175,14 +100,15 @@ export declare class Slice<T extends SliceMeta> {
      *                 .exec().rows();
      * ```
      * @param formula Excel formula to use as where clause
+     * @return {Slice<T>}
      */
     excel(formula: string): Slice<T>;
     /**
      * Compile the request and send it
      * @param {ApiRequestOptions} options API Request options
-     * @return {SlicePromise<T>}
+     * @return {Promise<T = any>} API response
      */
-    exec(options?: ApiRequestOptions): SlicePromise<T>;
+    exec<T = any>(options?: ApiRequestOptions): Promise<T>;
     /**
      * Whitelist fields by passing an array of keys or alias fields by using a map
      * @example
@@ -191,11 +117,17 @@ export declare class Slice<T extends SliceMeta> {
      * 		.select().fields(['id', 'field1']).exec().keys();
      * ```
      * @param {object} whitelist Either a list of keys to whitelist or a map of keys to rename
+     * @return {Slice<T>}
      */
     fields(whitelist: string[]): Slice<T>;
     fields(alias: {
         [key: string]: string | object;
     }): Slice<T>;
+    /**
+     * Unwrap response returning the first ID
+     * @return {Slice<T>}
+     */
+    id(): Slice<T>;
     /**
      * Set the request type to insert
      * @example
@@ -206,6 +138,7 @@ export declare class Slice<T extends SliceMeta> {
      * ]).exec().keys();
      * ```
      * @param {T | T[]} rows Rows to be inserted into the slice
+     * @return {Slice<T>}
      */
     insert(rows: T | T[]): Slice<T>;
     /**
@@ -216,8 +149,9 @@ export declare class Slice<T extends SliceMeta> {
      *                 .exec().rows();
      * ```
      * @param {number} num Number of rows to return
+     * @return {Slice<T>}
      */
-    limit(num: number): void;
+    limit(num: number): this;
     /**
      * Add an 'OR' condition inside the where argument
      * @example
@@ -230,6 +164,7 @@ export declare class Slice<T extends SliceMeta> {
      *                 .where(['$gt', ['$field', field4], 4)
      *                 .exec().rows();
      * ```
+     * @return {Slice<T>}
      */
     or(): this;
     /**
@@ -241,8 +176,25 @@ export declare class Slice<T extends SliceMeta> {
      * ```
      * @param {string} field property name
      * @param {boolean} ascending Sort in ascending or descending order
+     * @return {Slice<T>}
      */
     order(field: string, ascending?: boolean): Slice<T>;
+    /**
+     * Unwrap response, returning the field
+     * @param {string} field Colon seperated path: `rows:0`
+     * @return {Slice<T>}
+     */
+    pop(field: string | null): Slice<T>;
+    /**
+     * Unwrap response returning the first row
+     * @return {Slice<T>}
+     */
+    row(): Slice<T>;
+    /**
+     * Unwrap response returning the rows
+     * @return {Slice<T>}
+     */
+    rows(): Slice<T>;
     /**
      * Set the request type to select
      * @example
@@ -251,6 +203,7 @@ export declare class Slice<T extends SliceMeta> {
      * const row: T = new Slice<T>(12345).select(id).exec().row();
      * ```
      * @param {number | number[]} id ID(s) to select, leaving blank will return all rows
+     * @return {Slice<T>}
      */
     select(id?: number | number[]): Slice<T>;
     /**
@@ -274,6 +227,7 @@ export declare class Slice<T extends SliceMeta> {
      * ]).exec().keys();
      * ```
      * @param {T | T[]} rows Rows to be updated, each row must have an ID
+     * @return {Slice<T>}
      */
     update(rows: T | T[]): this;
     /**
@@ -290,6 +244,7 @@ export declare class Slice<T extends SliceMeta> {
      * @param {string | object} field property to compare or a map of equality comparisons
      * @param {string} operator Operation to compare with. Accepts JS operators (>=, ==, !=, ...) as well as datalynk styax ($gte, $eq, $is, $not, ...)
      * @param {any} value value to compare against
+     * @return {Slice<T>}
      */
     where(field: string | object, operator?: string, value?: any): Slice<T>;
 }

package/dist/slice.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"slice.d.ts","sourceRoot":"","sources":["../src/slice.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,EAAC,MAAM,MAAM,CAAC;AACrC,OAAO,EAAC,GAAG,EAAE,QAAQ,EAAE,iBAAiB,EAAC,MAAM,OAAO,CAAC;AACvD,OAAO,EAAmB,WAAW,EAAC,MAAM,UAAU,CAAC;AAEvD,MAAM,WAAW,SAAS;IACzB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,qBAAa,YAAY,CAAC,CAAC,SAAS,SAAS;aAQhB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;aAAkB,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAN/F;;;;;OAKG;gBACyB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAkB,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAE/F;;OAEG;IACH,KAAK,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,QAAQ,GAAG,GAAG,KAAK,GAAG;IAI9C;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC;IAM9B;;OAEG;IACH,KAAK,IAAI,YAAY,CAAC,CAAC,CAAC;IAKxB;;OAEG;IACG,MAAM;IAKZ;;OAEG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG;IAI3B;;OAEG;IACG,OAAO;IAKb;;OAEG;IACG,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC;IAI5B;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAK/B;;OAEG;IACG,OAAO;IAKb;;OAEG;IACG,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC;IAIvB;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC;IAK1B;;OAEG;IACH,IAAI,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,GAAG,GAAG,KAAK,GAAG,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAIrH;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAItC;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC;CAIpC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,SAAS;IACjD,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,EAAE,EAAE,MAAM,CAAC;CACX;AAED;;GAEG;AACH,qBAAa,KAAK,CAAC,CAAC,SAAS,SAAS;IA2BzB,OAAO,CAAC,KAAK;IAAmB,OAAO,CAAC,GAAG;IA1BvD,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC;IAEhB,OAAO,CAAC,SAAS,CAAU;IAC3B,OAAO,CAAC,OAAO,CAAW;IAE1B,4DAA4D;IAC5D,WAAW,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAEjC,yCAAyC;IACzC,OAAO,CAAC,MAAM,CAAgC;IAC9C,wBAAwB;IACxB,OAAO,KAAK,KAAK,GAA0C;IAC3D,0CAA0C;IAC1C,OAAO,KAAK,KAAK,QAAyC;IAE1D,0BAA0B;IAC1B,IAAI,GAAG;;MAEN;IAED;;;;;OAKG;gBACiB,KAAK,EAAE,MAAM,GAAG,MAAM,EAAU,GAAG,EAAE,GAAG;IAE5D;;;;;;;;OAQG;IACH,KAAK,CAAC,YAAY,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IAIjE;;;;;;;;;;OAUG;IACH,GAAG;IAOH;;;;;;;;;OASG;IACH,KAAK,CAAC,GAAG,GAAE,MAAM,GAAG,MAAa;IAMjC;;OAEG;IACH,KAAK;IAKL;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IASxC;;;;;;;;;OASG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC;IAKhC;;;;OAIG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,YAAY,CAAC,CAAC,CAAC;IAMlD;;;;;;;;OAQG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IACrC,MAAM,CAAC,KAAK,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;KAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IAQzD;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IAQ/B;;;;;;;;OAQG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM;IAIjB;;;;;;;;;;;;OAYG;IACH,EAAE;IAUF;;;;;;;;;OASG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,UAAO,GAAG,KAAK,CAAC,CAAC,CAAC;IAMhD;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IASxC;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,UAAO;IAoBd;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE;IAQpB;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC;CA+BvE"}
+{"version":3,"file":"slice.d.ts","sourceRoot":"","sources":["../src/slice.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,eAAe,EAAC,MAAM,MAAM,CAAC;AACrC,OAAO,EAAC,GAAG,EAAE,iBAAiB,EAAC,MAAM,OAAO,CAAC;AAC7C,OAAO,EAAmB,WAAW,EAAC,MAAM,UAAU,CAAC;AAEvD;;GAEG;AACH,qBAAa,KAAK,CAAC,CAAC,GAAG,GAAG;IAoCb,OAAO,CAAC,KAAK;IAAmB,OAAO,CAAC,GAAG;IAnCvD,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC;IAEhB,OAAO,CAAC,SAAS,CAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,CAAgB;IACjC,OAAO,CAAC,OAAO,CAAW;IAE1B,iCAAiC;IACjC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,4DAA4D;IAC5D,WAAW,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAEjC,yCAAyC;IACzC,OAAO,CAAC,MAAM,CAAgC;IAC9C,wBAAwB;IACxB,OAAO,KAAK,KAAK,GAA0C;IAC3D,0CAA0C;IAC1C,OAAO,KAAK,KAAK,QAAyC;IAE1D,0BAA0B;IAC1B,IAAI,GAAG;;;OAQN;IAED;;;;;OAKG;gBACiB,KAAK,EAAE,MAAM,GAAG,MAAM,EAAU,GAAG,EAAE,GAAG;IAE5D;;;;;;;;;OASG;IACH,KAAK;oBAyGa,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;gBACvB;YAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;SAAC,GAAG,KAAK,CAAC,CAAC,CAAC;MA1GrC;IAEpB;;;;;;;;;;;OAWG;IACH,GAAG;IAOH;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,GAAE,MAAM,GAAG,MAAa,GAAG,KAAK,CAAC,CAAC,CAAC;IAM5C;;;;OAIG;IACH,KAAK,CAAC,OAAO,UAAO;IAKpB;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IASxC;;;;;;;;;;OAUG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC;IAKhC;;;;OAIG;IACH,IAAI,CAAC,CAAC,GAAG,GAAG,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,CAAC,CAAC;IAQtD;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IACrC,MAAM,CAAC,KAAK,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;KAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IAQzD;;;OAGG;IACH,EAAE,IAAI,KAAK,CAAC,CAAC,CAAC;IAId;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IAQ/B;;;;;;;;;OASG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM;IAKjB;;;;;;;;;;;;;OAaG;IACH,EAAE;IAUF;;;;;;;;;;OAUG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,UAAO,GAAG,KAAK,CAAC,CAAC,CAAC;IAMhD;;;;OAIG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC;IAKnC;;;OAGG;IACH,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC;IAIf;;;OAGG;IACH,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC;IAIhB;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IASxC;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,UAAO;IAoBd;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE;IAQpB;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC;CA+BvE"}

package/package.json

@@ -2,7 +2,7 @@
 	"name": "@auxilium/datalynk-client",
 	"description": "Datalynk client library",
 	"repository": "https://gitlab.auxiliumgroup.com/auxilium/datalynk/datalynk-client",
-	"version": "0.9.12",
+	"version": "1.0.0",
 	"author": "Zak Timson <zaktimson@gmail.com>",
 	"private": false,
 	"main": "./dist/index.cjs",