@finsemble/finsemble-ui 1.0.0-beta-3 → 1.0.0-beta-6

package/clients/StoreModel.d.ts

@@ -1,318 +0,0 @@
-import { StandardError, StandardErrorCallback, StandardPromise } from "../types";
-import { IRouterClient } from "./routerClient";
-export declare type ListenerFunction<T = any> = (err: StandardError, response: {
-    field: string;
-    value: T;
-}) => void;
-export declare type DispatchListenerFunction = (any: any) => void;
-export declare type FieldOnlyParam = {
-    field: string;
-};
-export declare type ListenerParam = {
-    field: string;
-    listener: ListenerFunction;
-};
-export declare type RemoveListenersType = ListenerParam | ListenerParam[];
-export declare type Mappings = Record<string, any>;
-export declare type RemoveStoreCallback = (params: {
-    store: string;
-    global?: boolean;
-}, cb?: StandardErrorCallback<boolean>) => StandardPromise<boolean>;
-export declare class StoreModel {
-    /**
-     * @ignore
-     */
-    routerClient: IRouterClient;
-    /**
-     * @ignore
-     */
-    removeStoreCallback: RemoveStoreCallback;
-    /**
-     * @ignore
-     */
-    isGlobal: boolean;
-    /**
-     * @ignore
-     */
-    values: Record<string, any>;
-    /**
-     * @ignore
-     */
-    listeners: Record<string, ListenerFunction[]>;
-    /**
-     * @ignore
-     * @deprecated
-     */
-    registeredDispatchListeners: DispatchListenerFunction[];
-    /**
-     * @ignore
-     */
-    mapping: Mappings;
-    /**
-     * Prevents multiple listener requests on the same field from being sent to the DistributedStoreService
-     * @ignore
-     */
-    subs: Record<string, boolean>;
-    /**
-     * @ignore
-     */
-    name: string;
-    /**
-     * @ignore
-     */
-    constructor(params: {
-        global?: boolean;
-        name: string;
-        values?: Record<string, any>;
-    }, routerClient: IRouterClient, removeStoreCallback: RemoveStoreCallback);
-    /** This is the Flux dispatcher. It can be used dispatch actions across stores. These action are not caught inside of the global store service. For more information, you can read the [Flux documentation](https://facebook.github.io/flux/docs/overview.html).
-     *
-     * Example:
-     * ```
-     * store.Dispatcher.register(function(action){
-     * 	if(action.actionType === "ACTION1") {
-     * 		// Do something with the action here.
-     * 	}
-     * })
-     * ```
-     * @ignore
-     */
-    Dispatcher: {
-        register: (fn: (update: any) => void) => void;
-        dispatch: (data: any) => void;
-    };
-    /**
-     * @param {*} err
-     * @param {*} message
-     * @ignore
-     */
-    handleDispatchedMessages(err: StandardError, message?: {
-        data: any;
-    }): void;
-    /**
-     * Set a value in the store. Two events will be triggered with topics of: store and field.
-     *
-     * ```javascript
-     * store.setValue({ field:'field1', value:"new value" });
-     * ```
-     * @param {String} params.field The name of the field where data will be stored
-     * @param {String} params.value Value to be stored
-     * @param {function} cb callback
-     */
-    setValue(params: {
-        field: string;
-        value: any;
-    }, cb?: StandardErrorCallback<void>): void;
-    /**
-     * Handles changes to the store. Will publish from the field that was changed and back.
-     * @private Do not call this function directly. It will be converted to private member in a future release
-     * @ignore
-     */
-    publishObjectUpdates(startField: string, mappings: Mappings): void;
-    /**
-     * Send items that are no longer mapped or had their map change. If a value is remapped we'll send out the new value.
-     * @private Do not call this function directly. It will be converted to private member in a future release
-     * @ignore
-     */
-    sendRemovals(removals: string[]): void;
-    /**
-     * This will set multiple values in the store.
-     *
-     * ```javascript
-     * store.setValues([{ field:'field1', value:"new value" }]);
-     * ```
-     * @param {function} cb callback
-     * @param {Array<{ field : string, value : any}>} fields An array where each element is like the object below.
-     */
-    setValues(fields: {
-        field: string;
-        value: any;
-    }[], cb?: StandardErrorCallback<void>): void;
-    /**
-     * Get a value from the store. If global is not set, we'll check local first then we'll check global. Returns the value of the field. If no callback is given and the value is local, this will run synchronously.
-     *
-     * Be very careful not to `await` this function as it is not promisified. Use `await getGlobalValue` instead.
-     *
-     * ```javascript
-     * store.getValue({ field: 'field1' }, function(err,value){});
-     * store.getValue('field1', function(err,value){});
-     * ```
-     * @param {object|string} params The field where the value is stored.
-     * @param {String} params.field The field where the value is stored.
-     * @param {StandardCallback} cb Will return the value if found.
-     * @returns any Don't use the return statement. Always use the cb.
-     */
-    getValue<T = any>(params: {
-        field: string;
-    } | string, cb?: StandardErrorCallback<T>): T | any;
-    /**
-     * Get the entire store.
-     *
-     * @param { Function} cb Will return the value if found
-     * @returns object | void - The store in key/value form if it's a local store - otherwise void
-     * @ignore
-     */
-    getAll(cb: StandardErrorCallback<Record<string, any>>): any;
-    /**
-     * Get multiple values from the store. Returns an object of with the fields as keys.If no callback is given and the value is local, this will run synchronously. Returns an object of with the fields as keys.If no callback is given and the value is local, this will run synchronous
-     *
-     * ```javascript
-     * store.getValues([{ field:'field1' }, { field:'field2' }], function(err,values){});
-     * store.getValues(['field1', 'field2'], function(err,values){});
-     * ```
-     * @param {Array.<object>|Array.<String>} fields An Array of field objects. If there are no fields provided, or value is null, all values in the store are returned.
-     * @param {string} fields.field The field where the value is stored.
-     * @param {Function} [cb] Will return the value if found.
-     * @returns {Object} - returns an object of with the fields as keys.If no callback is given and the value is local, this will run synchronous
-     */
-    getValues(fields: {
-        field: string;
-    }[] | string[], cb?: StandardErrorCallback<any>): any;
-    /**
-     * Get a single value from a *global* store. This function is promisifed.
-     *
-     * @param {string} field The field to fetch
-     * @param {(err, data) => void} [cb] Optional callback to receive value. `err` will be string if an error occurred. `data` will contain the returned value or be undefined.
-     * @return {Promise<{err, data}} `err` will be string if an error occurred. `data` will contain the returned value or be undefined.
-     */
-    getGlobalValue<T = any>(field: string, cb?: StandardErrorCallback<T>): StandardPromise<T>;
-    /**
-     * Get values from the global store.
-     * @private Do not call this function directly. It will be converted to private member in a future release
-     * @ignore
-     */
-    getGlobalValues(params: {
-        field: string;
-    }[] | string[] | null, cb?: StandardErrorCallback<Record<string, any>>): void;
-    /**
-     * Remove a value from the store.
-     *
-     * ```javascript
-     * store.removeValue({ field: 'field1' }, function(err,bool){});
-     * ```
-     * @param {Object | String} params - Either an object (`{ field: string }`) or string
-     * @param {String} param.field The name of the field
-     * @param {Function} cb returns an error if there is one
-     */
-    removeValue(params: string | {
-        field: string;
-    }, cb?: StandardErrorCallback<void>): void;
-    /**
-     * Removes multiple values from the store.
-     *
-     * ```javascript
-     * store.removeValues([{ field: 'field1' }], function(err,bool){});
-     * ```
-     * @param {Object[] | String[]} params - An Array of field objects
-     * @param {String} params.field - The name of the field
-     * @param {Function} cb -  returns an error if there is one.
-     */
-    removeValues(params: string[] | {
-        field: string;
-    }[], cb: any): any;
-    /**
-     * Destroys the store.
-     * @param {Function} cb Function to be invoked after the store is destroyed.
-     */
-    destroy(cb?: StandardErrorCallback<boolean>): void;
-    /**
-     * Adds a subscription for the desired dynamic store changes
-     * @ignore
-     */
-    changeSub(change: string): void;
-    /**
-     * Add a listener to the store at either the store or field level. If no field is given, the store level is used. You can also listen to nested object (e.g., field1.nestedField).
-     *
-     * ```javascript
-     * var myFunction = function(err,data) {
-     * }
-     * store.addListener({ field:'field1' }, myFunction, cb);
-     * ```
-     * @param {String} params.field The piece of data that you want to listen on. If this is empty it listens to all changes of the store.
-     * @param {Function} fn the function to call when the data changes
-     * @param {Function} cb callback to be invoked
-     */
-    addListener(params: {
-        field?: string;
-    }, fn: ListenerFunction, cb?: () => void): void;
-    /**
-     * Add an array of listeners as  objects or strings. If using strings, you must provide a function callback.
-     *
-     * ```javascript
-     * var myFunction = function(err,data){
-     * }
-     * store.addListeners([{
-     * 	field: 'field1',
-     * 	listener: myFunction
-     * },
-     * {
-     * 	field:'field2',
-     * 	listener: myFunction
-     * }],
-     * null, cb);
-     * store.addListeners([{ field: 'field1' },{ field: 'field2', listener: myFunction }], myFunction, cb);
-     * store.addListeners(['field1','field2'], myFunction, cb);
-     * ```
-     * @param {String} params.field The piece of data that you want listen on. If this is empty it listen to all changes of the store.
-     * @param {String} params.listener The function to call when the piece of data is modified. If this is empty, fn is used.
-     * @param {function} fn The function to call when the piece of data is modified.
-     * @param {function} cb callback to be invoked when the listeners are added.
-     */
-    addListeners(params: {
-        field: string;
-        listener: ListenerFunction;
-    } | {
-        field: string;
-        listener: ListenerFunction;
-    }[] | string[], fn: ListenerFunction, cb?: () => void): void;
-    /**
-     * Remove a listener from store. If no field is given, we look for a store listener
-     * @param {String} params.field - The data field with the listener that you want to remove.
-     * @param {function} fn The handler passed into `addListener` or `addListeners`.
-     * @param {function} cb returns true if it was successful in removing the listener.
-     *
-     * ```javascript
-     * var myFunction = function(err,data){}
-     * store.removeListener({ field: 'field1' }, MyFunction, function(bool){});
-     * ```
-     */
-    removeListener(params: {
-        field?: string;
-    }, fn: ListenerFunction, cb?: StandardErrorCallback<boolean>): void;
-    /**
-     * Remove an array of listeners from the store
-     * @param {String} params.field The data field with the listener that you want to remove.
-     * @param {String} params.listener The handler passed into `addListener` or `addListeners`.
-     * @param {function} fn The handler passed into `addListener` or `addListeners`.
-     * @param {function} cb returns true if it was successful in removing the listener.
-     *
-     * ```javascript
-     * var myFunction = function(err,data){}
-     * store.removeListeners({ field: 'field1' }, MyFunction, function(bool){});
-     * store.removeListeners([{ field: 'field1', listener: MyFunction}], function(bool){});
-     * store.removeListeners(['field1'], MyFunction, function(bool){});
-     * ```
-     */
-    removeListeners(params: RemoveListenersType, fn?: ListenerFunction<any>, cb?: StandardErrorCallback<boolean>): void;
-    /**
-     * Handles all changes coming in from the service.
-     * @private Do not call this function directly. It will be converted to private member in a future release
-     * @ignore
-     */
-    handleChanges: (err: StandardError, response: {
-        data: {
-            store: string;
-            storeData: any;
-            field: string;
-            value: any;
-        };
-    }) => void;
-    /**
-     * Trigger any function that is listening for changes
-     * @private Do not call this function directly. It will be converted to private member in a future release
-     * @ignore
-     */
-    triggerListeners(listenerKey: string, data: any): void;
-}
-export default StoreModel;
-//# sourceMappingURL=StoreModel.d.ts.map

package/clients/StoreModel.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"StoreModel.d.ts","sourceRoot":"","sources":["../../../src/clients/StoreModel.ts"],"names":[],"mappings":"AAGA,OAAO,EAAoB,aAAa,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AACnG,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE/C,oBAAY,gBAAgB,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,aAAa,EAAE,QAAQ,EAAE;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,KAAK,IAAI,CAAC;AAE5G,oBAAY,wBAAwB,GAAG,CAAC,GAAG,KAAA,KAAK,IAAI,CAAC;AAErD,oBAAY,cAAc,GAAG;IAC5B,KAAK,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,oBAAY,aAAa,GAAG;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,gBAAgB,CAAC;CAC3B,CAAC;AACF,oBAAY,mBAAmB,GAAG,aAAa,GAAG,aAAa,EAAE,CAAC;AAElE,oBAAY,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE3C,oBAAY,mBAAmB,GAAG,CACjC,MAAM,EAAE;IACP,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB,EACD,EAAE,CAAC,EAAE,qBAAqB,CAAC,OAAO,CAAC,KAC/B,eAAe,CAAC,OAAO,CAAC,CAAC;AAC9B,qBAAa,UAAU;IACtB;;OAEG;IACH,YAAY,EAAE,aAAa,CAAC;IAE5B;;OAEG;IACH,mBAAmB,EAAE,mBAAmB,CAAC;IAEzC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAS;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAM;IAEjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAM;IAEnD;;;OAGG;IACH,2BAA2B,EAAE,wBAAwB,EAAE,CAAM;IAE7D;;OAEG;IACH,OAAO,EAAE,QAAQ,CAAM;IAEvB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAM;IAEnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;gBAEF,MAAM,EAAE;QACP,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAC7B,EACD,YAAY,EAAE,aAAa,EAC3B,mBAAmB,EAAE,mBAAmB;IAmBzC;;;;;;;;;;;OAWG;IACH,UAAU;gCACe,GAAG,KAAK,IAAI;yBAGnB,GAAG;MAOnB;IAEF;;;;OAIG;IACH,wBAAwB,CAAC,GAAG,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE;QAAE,IAAI,EAAE,GAAG,CAAA;KAAE;IAQpE;;;;;;;;;OASG;IACH,QAAQ,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,GAAG,CAAA;KAAE,EAAE,EAAE,CAAC,EAAE,qBAAqB,CAAC,IAAI,CAAC,GAAG,IAAI;IAiCvF;;;;OAIG;IACH,oBAAoB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ;IAQ3D;;;;OAIG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE;IAM/B;;;;;;;;OAQG;IACH,SAAS,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,GAAG,CAAA;KAAE,EAAE,EAAE,EAAE,CAAC,EAAE,qBAAqB,CAAC,IAAI,CAAC,GAAG,IAAI;IAqB1F;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM,EAAE,EAAE,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,GAAG;IAwB7F;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,EAAE,qBAAqB,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,GAAG;IAS3D;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,GAAG,MAAM,EAAE,EAAE,EAAE,CAAC,EAAE,qBAAqB,CAAC,GAAG,CAAC,GAAG,GAAG;IA2CvF;;;;;;OAMG;IACG,cAAc,CAAC,CAAC,GAAG,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC;IAS/F;;;;OAIG;IACH,eAAe,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,EAAE,qBAAqB,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAa9G;;;;;;;;;OASG;IACH,WAAW,CACV,MAAM,EACH,MAAM,GACN;QACA,KAAK,EAAE,MAAM,CAAC;KACb,EACJ,EAAE,CAAC,EAAE,qBAAqB,CAAC,IAAI,CAAC;IAUjC;;;;;;;;;OASG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,EAAE,EAAE,KAAA;IAQvD;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,EAAE,qBAAqB,CAAC,OAAO,CAAC;IAe3C;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM;IASxB;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,MAAM,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,EAAE,EAAE,gBAAgB,EAAE,EAAE,CAAC,EAAE,MAAM,IAAI;IAgB7E;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,YAAY,CACX,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,gBAAgB,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,gBAAgB,CAAA;KAAE,EAAE,GAAG,MAAM,EAAE,EAClH,EAAE,EAAE,gBAAgB,EACpB,EAAE,CAAC,EAAE,MAAM,IAAI,GACb,IAAI;IA2BP;;;;;;;;;;OAUG;IACH,cAAc,CAAC,MAAM,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,EAAE,EAAE,gBAAgB,EAAE,EAAE,CAAC,EAAE,qBAAqB,CAAC,OAAO,CAAC,GAAG,IAAI;IAkB3G;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,MAAM,EAAE,mBAAmB,EAAE,EAAE,CAAC,EAAE,gBAAgB,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,EAAE,qBAAqB,CAAC,OAAO,CAAC,GAAG,IAAI;IAwBnH;;;;OAIG;IACH,aAAa,QACP,aAAa,YACR;QACT,IAAI,EAAE;YACL,KAAK,EAAE,MAAM,CAAC;YACd,SAAS,EAAE,GAAG,CAAC;YACf,KAAK,EAAE,MAAM,CAAC;YACd,KAAK,EAAE,GAAG,CAAC;SACX,CAAC;KACF,UAaA;IAEF;;;;OAIG;IACH,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG;CAU/C;AAED,eAAe,UAAU,CAAC"}