@auxilium/datalynk-client 1.0.19 → 1.1.0-rc1

package/dist/slice.d.ts

@@ -1,38 +1,21 @@
 import { BehaviorSubject } from 'rxjs';
 import { Api, ApiRequestOptions } from './api';
+import { Meta, SliceInfo } from './meta';
 import { Unsubscribe } from './socket';
-/**
- * An object to aid in constructing Datalynk requests
- */
-export declare class Slice<T = any> {
-    private slice;
-    private api;
-    static api: Api;
+export declare class ApiCall<T extends Meta = any> {
+    private readonly api;
+    readonly slice: number | string;
     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 */
-    private cache$;
-    /** Cached slice data */
-    private get cache();
-    /** Set cached data & alert subscribers */
-    private set cache(value);
     /** Get raw API request */
     get raw(): Partial<{
         [x: string]: any;
         $pop: string | undefined;
     }>;
-    /**
-     * An object to aid in constructing requests
-     *
-     * @param {number} slice Slice ID to interact with
-     * @param {Api} api Api to send the requests through
-     */
-    constructor(slice: number | string, api: Api);
+    constructor(api: Api, slice: number | string);
     /**
      * Whitelist and alias fields. Alias of `fields()`
      * @example
@@ -44,10 +27,10 @@ export declare class Slice<T = any> {
      * @return {Slice<T>}
      */
     alias: {
-        (whitelist: string[]): Slice<T>;
+        (whitelist: string[]): this;
         (alias: {
             [key: string]: string | object;
-        }): Slice<T>;
+        }): this;
     };
     /**
      * Add an 'AND' condition inside the where argument
@@ -73,7 +56,7 @@ export declare class Slice<T = any> {
      * @param {object | string} arg Count argument
      * @return {Slice<T>}
      */
-    count(arg?: object | string): Slice<T>;
+    count(arg?: object | string): this;
     /**
      * Output the formed request to the console for inspection
      * @param {boolean} enabled Enable/Disable console logging
@@ -89,7 +72,7 @@ export declare class Slice<T = any> {
      * @param {number | number[]} id ID(s) to delete
      * @return {Slice<T>}
      */
-    delete(id?: number | number[]): Slice<T>;
+    delete(id?: number | number[]): this;
     /**
      * Filter rows from slice based on an excel expression
      * @example
@@ -101,7 +84,7 @@ export declare class Slice<T = any> {
      * @param formula Excel formula to use as where clause
      * @return {Slice<T>}
      */
-    excel(formula: string): Slice<T>;
+    excel(formula: string): this;
     /**
      * Compile the request and send it
      * @param {ApiRequestOptions} options API Request options
@@ -118,15 +101,15 @@ export declare class Slice<T = any> {
      * @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(whitelist: string[]): this;
     fields(alias: {
         [key: string]: string | object;
-    }): Slice<T>;
+    }): this;
     /**
      * Unwrap response returning the first ID
      * @return {Slice<T>}
      */
-    id(): Slice<T>;
+    id(): this;
     /**
      * Set the request type to insert
      * @example
@@ -139,7 +122,7 @@ export declare class Slice<T = any> {
      * @param {T | T[]} rows Rows to be inserted into the slice
      * @return {Slice<T>}
      */
-    insert(rows: T | T[]): Slice<T>;
+    insert(rows: T | T[]): this;
     /**
      * Limit number of rows returned
      * @example
@@ -177,29 +160,29 @@ export declare class Slice<T = any> {
      * @param {boolean} ascending Sort in ascending or descending order
      * @return {Slice<T>}
      */
-    order(field: string, ascending?: boolean): Slice<T>;
+    order(field: string, ascending?: boolean): this;
     /**
      * Unwrap response, returning the field
      * @param {string} field Colon seperated path: `rows:0`
      * @return {Slice<T>}
      */
-    pop(field: string | null): Slice<T>;
+    pop(field: string | null): this;
     /**
      * Unwrap response returning the first row
      * @return {Slice<T>}
      */
-    row(): Slice<T>;
+    row(): this;
     /**
      * Unwrap response returning the rows
      * @return {Slice<T>}
      */
-    rows(): Slice<T>;
+    rows(): this;
     /**
      * Save multiple rows to the slice, automatically inserts/updates
      * @param {T} rows Rows to add to slice
      * @returns {this<T>}
      */
-    save(...rows: T[]): this;
+    save(rows: T | T[]): this;
     /**
      * Set the request type to select
      * @example
@@ -210,18 +193,7 @@ export declare class Slice<T = any> {
      * @param {number | number[]} id ID(s) to select, leaving blank will return all rows
      * @return {Slice<T>}
      */
-    select(id?: number | number[]): Slice<T>;
-    /**
-     * Synchronize cache with server
-     * @example
-     * ```ts
-     * const slice: Slice = new Slice<T>(Slices.Contact);
-     * slice.sync().subscribe((rows: T[]) => {});
-     * ```
-     * @param {boolean} on Enable/disable events
-     * @return {BehaviorSubject<T[]>} Cache which can be subscribed to
-     */
-    sync(on?: boolean): BehaviorSubject<T[]> | undefined;
+    select(id?: number | number[]): this;
     /**
      * Set the request type to update
      * @example
@@ -251,6 +223,77 @@ export declare class Slice<T = any> {
      * @param {any} value value to compare against
      * @return {Slice<T>}
      */
-    where(field: string | object, operator?: string, value?: any): Slice<T>;
+    where(field: string | object, operator?: string, value?: any): this;
+}
+/**
+ * An object to aid in constructing Datalynk requests
+ */
+export declare class Slice<T extends Meta = any> {
+    private slice;
+    private api;
+    private table?;
+    private info?;
+    private pendingInsert;
+    /** Unsubscribe from changes, undefined if not subscribed */
+    unsubscribe?: Unsubscribe | null;
+    /** Cached slice data as an observable */
+    cache$: BehaviorSubject<T[]>;
+    /** Cached slice data */
+    get cache(): T[];
+    /** Set cached data & alert subscribers */
+    private set cache(value);
+    /** Is slice offline support enabled */
+    get offlineEnabled(): boolean | undefined;
+    /**
+     * An object to aid in constructing requests
+     *
+     * @param {number} slice Slice ID to interact with
+     * @param {Api} api Api to send the requests through
+     */
+    constructor(slice: number | string, api: Api);
+    private fixIncrement;
+    private execWrapper;
+    pushChanges(): Promise<void>;
+    /**
+     * Get slice information
+     * @param reload Ignore cache & reload info
+     * @return {Promise<SliceInfo>}
+     */
+    getInfo(reload?: boolean): Promise<SliceInfo>;
+    /**
+     * Synchronize cache with server
+     * @example
+     * ```ts
+     * const slice: Slice = new Slice<T>(Slices.Contact);
+     * slice.sync().subscribe((rows: T[]) => {});
+     * ```
+     * @param {boolean} on Enable/disable events
+     * @return {BehaviorSubject<T[]>} Cache which can be subscribed to
+     */
+    sync(on?: boolean): BehaviorSubject<T[]> | undefined;
+    /**
+     * {@inheritDoc ApiCall.count}
+     */
+    count(arg?: object | string): ApiCall<T>;
+    /**
+     * {@inheritDoc ApiCall.delete}
+     */
+    delete(id: number | number[]): ApiCall<T>;
+    /**
+     * {@inheritDoc ApiCall.insert}
+     */
+    insert(rows: T | T[]): ApiCall<T>;
+    /**
+     * {@inheritDoc ApiCall.save}
+     */
+    save(rows: T | T[]): ApiCall<T>;
+    /**
+     * {@inheritDoc ApiCall.select}
+     */
+    select(id?: number | number[]): ApiCall<T>;
+    /**
+     * {@inheritDoc ApiCall.update}
+     */
+    update(rows: T | T[]): ApiCall<T>;
 }
 //# sourceMappingURL=slice.d.ts.map

package/dist/slice.d.ts.map

@@ -1 +1 @@
-{"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;;;;OAIG;IACH,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE;IAMjB;;;;;;;;;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;CAgCvE"}
+{"version":3,"file":"slice.d.ts","sourceRoot":"","sources":["../src/slice.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,eAAe,EAAiC,MAAM,MAAM,CAAC;AACrE,OAAO,EAAC,GAAG,EAAE,iBAAiB,EAAC,MAAM,OAAO,CAAC;AAC7C,OAAO,EAAC,IAAI,EAAE,SAAS,EAAC,MAAM,QAAQ,CAAC;AACvC,OAAO,EAAmB,WAAW,EAAC,MAAM,UAAU,CAAC;AAEvD,qBAAa,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,GAAG;IAmB5B,OAAO,CAAC,QAAQ,CAAC,GAAG;aAAuB,KAAK,EAAE,MAAM,GAAG,MAAM;IAlB7E,OAAO,CAAC,SAAS,CAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,CAAgB;IACjC,OAAO,CAAC,OAAO,CAAW;IAE1B,iCAAiC;IACjC,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,0BAA0B;IAC1B,IAAI,GAAG;;;OAQN;gBAE4B,GAAG,EAAE,GAAG,EAAkB,KAAK,EAAE,MAAM,GAAG,MAAM;IAE7E;;;;;;;;;OASG;IACH,KAAK;oBA0Ga,MAAM,EAAE,GAAG,IAAI;gBACnB;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;SAAE,GAAG,IAAI;MA3GnC;IAEpB;;;;;;;;;;;OAWG;IACH,GAAG,IAAI,IAAI;IAOX;;;;;;;;;;OAUG;IACH,KAAK,CAAC,GAAG,GAAE,MAAM,GAAG,MAAa,GAAG,IAAI;IAMxC;;;;OAIG;IACH,KAAK,CAAC,OAAO,UAAO,GAAG,IAAI;IAK3B;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI;IASpC;;;;;;;;;;OAUG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAK5B;;;;OAIG;IACH,IAAI,CAAC,CAAC,GAAG,GAAG,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,CAAC,CAAC;IAStD;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI;IACjC,MAAM,CAAC,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI;IAQvD;;;OAGG;IACH,EAAE,IAAI,IAAI;IAIV;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI;IAQ3B;;;;;;;;;OASG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAKxB;;;;;;;;;;;;;OAaG;IACH,EAAE;IAUF;;;;;;;;;;OAUG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,UAAO,GAAG,IAAI;IAM5C;;;;OAIG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAK/B;;;OAGG;IACH,GAAG,IAAI,IAAI;IAIX;;;OAGG;IACH,IAAI,IAAI,IAAI;IAIZ;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE;IAMlB;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI;IASpC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI;IAQ3B;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG,GAAG,IAAI;CAiCnE;AAED;;GAEG;AACH,qBAAa,KAAK,CAAC,CAAC,SAAS,IAAI,GAAG,GAAG;IA0B1B,OAAO,CAAC,KAAK;IAAmB,OAAO,CAAC,GAAG;IAzBvD,OAAO,CAAC,KAAK,CAAC,CAAmB;IACjC,OAAO,CAAC,IAAI,CAAC,CAAY;IACzB,OAAO,CAAC,aAAa,CAAK;IAE1B,4DAA4D;IAC5D,WAAW,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAEjC,yCAAyC;IACzC,MAAM,uBAAgC;IAEtC,wBAAwB;IACxB,IAAI,KAAK,IAAI,CAAC,EAAE,CAAmC;IAEnD,0CAA0C;IAC1C,OAAO,KAAK,KAAK,QAAyC;IAE1D,uCAAuC;IACvC,IAAI,cAAc,wBAAiE;IAEnF;;;;;OAKG;gBACiB,KAAK,EAAE,MAAM,GAAG,MAAM,EAAU,GAAG,EAAE,GAAG;IAwB5D,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,WAAW;IAsFb,WAAW;IAmBjB;;;;OAIG;IACG,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;IA8BnD;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,UAAO;IAsBd;;OAEG;IACH,KAAK,CAAC,GAAG,GAAE,MAAM,GAAG,MAAa;IAMjC;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE;IAM5B;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE;IAMpB;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE;IAMlB;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE;IAO7B;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE;CAKpB"}

package/dist/themes.d.ts

@@ -0,0 +1,24 @@
+export interface Theme {
+    /** Background image URL */
+    background?: string;
+    /** Background color as hex (overrides background image) */
+    backgroundColor?: string;
+    /** Primary color as hex: `#000000` */
+    color?: string;
+    /** Logo URL */
+    logo?: string;
+    /** Header string or HTML: <img alt="logo" src="...">*/
+    title?: string;
+    /** Color of headers & links */
+    textColor?: string;
+}
+/**
+ * Get the theme for a spoke
+ * @param {string} spoke Name of spoke
+ * @param {string} scope Apply sub-theme
+ * @returns {Promise<Theme>}
+ */
+export declare function getTheme(spoke: string, scope?: string): Promise<Theme & {
+    found: boolean;
+}>;
+//# sourceMappingURL=themes.d.ts.map

package/dist/themes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"themes.d.ts","sourceRoot":"","sources":["../src/themes.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,KAAK;IACrB,2BAA2B;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2DAA2D;IAC3D,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,eAAe;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uDAAuD;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,wBAAsB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,GAAG;IAAC,KAAK,EAAE,OAAO,CAAA;CAAC,CAAC,CAa/F"}

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": "1.0.19",
+	"version": "1.1.0-rc1",
 	"author": "Zak Timson <zaktimson@gmail.com>",
 	"private": false,
 	"main": "./dist/index.cjs",
@@ -21,12 +21,12 @@
 	"scripts": {
 		"build": "tsc && npx vite build",
 		"datalynk-models": "node --no-warnings ./bin/datalynk-models.mjs",
-		"docs": "typedoc --cleanOutputDir false --out ./docs --entryPoints src/**/*.ts --readme none",
+		"docs": "typedoc --cleanOutputDir false --out ./docs --entryPoints src/**/*.ts --readme README.md",
 		"watch": "vite build --watch"
 	},
 	"dependencies": {
 		"@ztimson/node-utils": "1.0.2",
-		"@ztimson/utils": "0.25.7",
+		"@ztimson/utils": "0.25.8",
 		"rxjs": "^7.8.2"
 	},
 	"devDependencies": {