supabase-dataobject-core 1.4.1 → 1.5.1

package/dist/dataObject.d.ts

@@ -1,5 +1,7 @@
 import { SupabaseClient } from '@supabase/supabase-js';
-import { DataObjectOptions, DataObjectRecord, SupabaseConfig, DataObjectEvents, DataObjectField } from './types';
+import { DataObjectOptions, DataObjectRecord, WhereClause, SupabaseConfig, DataObjectEvents, DataObjectField } from './types';
+import { DataObjectState } from './dataObjectState';
+import { MasterBinding } from './masterBinding';
 export interface DataObjectErrorHandler {
     onError?: (error: string) => void;
     onWarning?: (warning: string) => void;
@@ -7,9 +9,9 @@ export interface DataObjectErrorHandler {
 }
 export declare class DataObject {
     private supabase;
-    private options;
+    private _options;
     private errorHandler?;
-    private _isReady;
+    private _name;
     private _readyPromise;
     data: DataObjectRecord[];
     private _originalData;
@@ -18,42 +20,115 @@ export declare class DataObject {
     readonly onDataChanged: (listener: (data: DataObjectRecord[]) => void) => () => void;
     private lifeCycleEvents;
     readonly on: <K extends keyof DataObjectEvents>(event: K, listener: (...args: DataObjectEvents[K]) => void) => () => void;
+    readonly off: <K extends keyof DataObjectEvents>(event: K, listener: (...args: DataObjectEvents[K]) => void) => void;
+    readonly once: <K extends keyof DataObjectEvents>(event: K, listener: (...args: DataObjectEvents[K]) => void) => void;
     private _currentRecord;
     private _fields;
-    private masterDataObject;
-    private masterDataObjectBinding;
-    private masterDataChangeListener;
+    state: DataObjectState;
+    masterBinding: MasterBinding | undefined;
+    private _childDataObjects;
+    get name(): string;
     get recordCount(): number;
     get currentRecord(): DataObjectRecord | undefined;
+    set currentRecord(record: DataObjectRecord | undefined);
     get fields(): DataObjectField[];
     get isReady(): boolean;
     get hasChanges(): boolean;
-    constructor(supabaseConfig: SupabaseConfig, options: DataObjectOptions, errorHandler?: DataObjectErrorHandler);
+    get whereClauses(): WhereClause[];
+    get masterDataObject(): DataObject | undefined;
+    get childDataObjects(): ReadonlyArray<DataObject>;
+    get options(): DataObjectOptions;
+    constructor(supabaseConfig: SupabaseConfig, options: DataObjectOptions, name: string, errorHandler?: DataObjectErrorHandler);
     private initializeDataObject;
     waitForReady(): Promise<void>;
     private handleError;
     private handleWarning;
     private handleInfo;
+    /**
+     * Loads data from Supabase with the given parameters defined when creating data object.
+     */
     private loadData;
+    /**
+     * Fetches data created in loadData() method.
+     * @returns an array of DataObjectRecords
+     */
     getData(): DataObjectRecord[];
+    /**
+     * Refresh data to get the latest state.
+     */
     refresh(): Promise<void>;
+    /**
+     * Creates a new record in Supabase from the record informaton specified.
+     * Can only be called if a tableName is specified and canInsert is set to true.
+     * @param record - An object of fields and values for the new record.
+     * @returns true if insert is successful, false otherwise.
+     */
     insert(record: Partial<DataObjectRecord>): Promise<boolean>;
+    /**
+     * Updates a record in Supabase with the updates supplied.
+     * Can only be called if a tableName is provided and canUpdate is set to true.
+     * @param id - The id of the record to update
+     * @param updates - An object of fields and subsequent values to update
+     * @param skipRefresh - When set to true, the data object will not refresh after updating. Default is false
+     * @returns true if update was successful, false otherwise.
+     */
     update(id: any, updates: Partial<DataObjectRecord>, skipRefresh?: boolean): Promise<boolean>;
+    /**
+     * Method for deleting a record from Supabase.
+     * Can only be called if a tableName is provided and canDelete is set to true.
+     * @param id - The id of the record to delete
+     * @returns true if delete was successful, false otherwise.
+     */
     delete(id: any): Promise<boolean>;
+    /**
+     * Saves all pending changes in parallel to Supabase using the update() method, then refreshes data object.
+     * Can only be done if a tableName is specified and canUpdate is true.
+     */
     saveChanges(): Promise<void>;
+    /**
+     * Clears all pending changes and returns the data object to its original state.
+     */
     cancelChanges(): void;
-    private setupMasterDataObjectBinding;
-    private getMasterDataObjectFromManager;
-    private validateBindingFields;
-    private addMasterBindingWhereClause;
-    private removeMasterBindingWhereClause;
-    private setupMasterDataChangeListener;
-    private onMasterDataChanged;
+    /**
+     * Helper function to wrap data object records in a reactive proxy and listen for changes.
+     * @param record - DataObjectRecord to create proxy for
+     * @returns Proxy of DataObjectRecord passed through
+     */
     private createReactiveRecord;
+    /**
+     * Gets the options defined for the created data object.
+     */
     getOptions(): DataObjectOptions;
+    /**
+     * Adds a new data object to this data object's childDataObjects array.
+     * @param child - The data object to add as a child to this one.
+     */
+    registerChildDataObject(child: DataObject): void;
+    /**
+     * Removes a data object from this data object's childDataObjects array.
+     * @param child - The data object to remove.
+     */
+    unregisterChildDataObject(child: DataObject): void;
+    /**
+     * Infers data objects fields to be added to fields array.
+     * If no fields have been provided in DataObjectOptions then all fields from the provided table will be used.
+     */
+    private inferFields;
+    /**
+     * Sets defaults for DataObjectOptions based on other options defined.
+     * @param options - The DataObjectOptions for which to perform the operation on
+     * @returns DataObjectOptions with potential changes based on other option values
+     */
     private setDefaultOptions;
+    /**
+     * Helper method to dispose of a data object in order to prevent memory leaks.
+     * Disposes of all child data objects and resets state to default.
+     */
     dispose(): void;
+    /**
+     * Fetches the SupabaseClient defined for the data object.
+     */
     getSupabaseClient(): SupabaseClient;
 }
-export declare function createDataObject(supabaseConfig: SupabaseConfig, options: DataObjectOptions, errorHandler?: DataObjectErrorHandler): Promise<DataObject>;
+export declare function createDataObject(supabaseConfig: SupabaseConfig, options: DataObjectOptions, name: string, errorHandler?: DataObjectErrorHandler): Promise<DataObject>;
 //# sourceMappingURL=dataObject.d.ts.map

package/dist/dataObject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dataObject.d.ts","sourceRoot":"","sources":["../src/dataObject.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,EACH,iBAAiB,EACjB,gBAAgB,EAGhB,cAAc,EACd,gBAAgB,EAEhB,eAAe,EAElB,MAAM,SAAS,CAAC;AAIjB,MAAM,WAAW,sBAAsB;IACnC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CACnC;AAED,qBAAa,UAAU;IACnB,OAAO,CAAC,QAAQ,CAAiB;IACjC,OAAO,CAAC,OAAO,CAAoB;IACnC,OAAO,CAAC,YAAY,CAAC,CAAyB;IAC9C,OAAO,CAAC,QAAQ,CAAkB;IAClC,OAAO,CAAC,aAAa,CAAgB;IAE9B,IAAI,EAAE,gBAAgB,EAAE,CAAM;IACrC,OAAO,CAAC,aAAa,CAA0B;IAC/C,OAAO,CAAC,eAAe,CAAkD;IAEzE,OAAO,CAAC,YAAY,CAA0C;IAC9D,SAAgB,aAAa,+DAA2B;IAExD,OAAO,CAAC,eAAe,CAA6C;IACpE,SAAgB,EAAE,+GAAsD;IAExE,OAAO,CAAC,cAAc,CAA+B;IACrD,OAAO,CAAC,OAAO,CAAyB;IAGxC,OAAO,CAAC,gBAAgB,CAA2B;IACnD,OAAO,CAAC,uBAAuB,CAAwC;IACvE,OAAO,CAAC,wBAAwB,CAA6B;IAE7D,IAAW,WAAW,IAAI,MAAM,CAE/B;IAED,IAAW,aAAa,IAAI,gBAAgB,GAAG,SAAS,CAEvD;IAED,IAAW,MAAM,IAAI,eAAe,EAAE,CAErC;IAED,IAAW,OAAO,IAAI,OAAO,CAE5B;IAED,IAAW,UAAU,IAAI,OAAO,CAE/B;gBAGG,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,iBAAiB,EAC1B,YAAY,CAAC,EAAE,sBAAsB;YAQ3B,oBAAoB;IAQrB,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAI1C,OAAO,CAAC,WAAW;IAQnB,OAAO,CAAC,aAAa;IAQrB,OAAO,CAAC,UAAU;YASJ,QAAQ;IAgGf,OAAO,IAAI,gBAAgB,EAAE;IAIvB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAexB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAqC3D,MAAM,CACf,EAAE,EAAE,GAAG,EACP,OAAO,EAAE,OAAO,CAAC,gBAAgB,CAAC,EAClC,WAAW,GAAE,OAAe,GAC7B,OAAO,CAAC,OAAO,CAAC;IA4CN,MAAM,CAAC,EAAE,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAwCjC,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IA8BlC,aAAa,IAAI,IAAI;YAWd,4BAA4B;YAoC5B,8BAA8B;IAW5C,OAAO,CAAC,qBAAqB;IAiB7B,OAAO,CAAC,2BAA2B;IAgCnC,OAAO,CAAC,8BAA8B;IAWtC,OAAO,CAAC,6BAA6B;YAYvB,mBAAmB;IAajC,OAAO,CAAC,oBAAoB;IAyBrB,UAAU,IAAI,iBAAiB;IAItC,OAAO,CAAC,iBAAiB;IAUlB,OAAO,IAAI,IAAI;IAUf,iBAAiB,IAAI,cAAc;CAG7C;AAED,wBAAsB,gBAAgB,CAClC,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,iBAAiB,EAC1B,YAAY,CAAC,EAAE,sBAAsB,GACtC,OAAO,CAAC,UAAU,CAAC,CAErB"}
+{"version":3,"file":"dataObject.d.ts","sourceRoot":"","sources":["../src/dataObject.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,EACH,iBAAiB,EACjB,gBAAgB,EAEhB,WAAW,EACX,cAAc,EACd,gBAAgB,EAEhB,eAAe,EAElB,MAAM,SAAS,CAAC;AAGjB,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,MAAM,WAAW,sBAAsB;IACnC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CACnC;AAED,qBAAa,UAAU;IACnB,OAAO,CAAC,QAAQ,CAAiB;IACjC,OAAO,CAAC,QAAQ,CAAoB;IACpC,OAAO,CAAC,YAAY,CAAC,CAAyB;IAC9C,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,aAAa,CAAgB;IAE9B,IAAI,EAAE,gBAAgB,EAAE,CAAM;IACrC,OAAO,CAAC,aAAa,CAA0B;IAC/C,OAAO,CAAC,eAAe,CAAkD;IAEzE,OAAO,CAAC,YAAY,CAA0C;IAC9D,SAAgB,aAAa,+DAA2B;IAExD,OAAO,CAAC,eAAe,CAA6C;IACpE,SAAgB,EAAE,+GAAsD;IACxE,SAAgB,GAAG,yGAAuD;IAC1E,SAAgB,IAAI,yGAAwD;IAE5E,OAAO,CAAC,cAAc,CAA+B;IACrD,OAAO,CAAC,OAAO,CAAyB;IAEjC,KAAK,EAAE,eAAe,CAAC;IACvB,aAAa,EAAE,aAAa,GAAG,SAAS,CAAC;IAEhD,OAAO,CAAC,iBAAiB,CAAoB;IAE7C,IAAW,IAAI,IAAI,MAAM,CAExB;IAED,IAAW,WAAW,IAAI,MAAM,CAE/B;IAED,IAAW,aAAa,IAAI,gBAAgB,GAAG,SAAS,CAEvD;IAED,IAAW,aAAa,CAAC,MAAM,EAAE,gBAAgB,GAAG,SAAS,EAgB5D;IAED,IAAW,MAAM,IAAI,eAAe,EAAE,CAErC;IAED,IAAW,OAAO,IAAI,OAAO,CAE5B;IAED,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED,IAAW,YAAY,IAAI,WAAW,EAAE,CAEvC;IAED,IAAW,gBAAgB,IAAI,UAAU,GAAG,SAAS,CAEpD;IAED,IAAW,gBAAgB,IAAI,aAAa,CAAC,UAAU,CAAC,CAEvD;IAED,IAAW,OAAO,IAAI,iBAAiB,CAEtC;gBAGG,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,iBAAiB,EAC1B,IAAI,EAAE,MAAM,EACZ,YAAY,CAAC,EAAE,sBAAsB;YAU3B,oBAAoB;IAgBrB,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAI1C,OAAO,CAAC,WAAW;IAQnB,OAAO,CAAC,aAAa;IAQrB,OAAO,CAAC,UAAU;IAUlB;;OAEG;YACW,QAAQ;IA6GtB;;;OAGG;IACI,OAAO,IAAI,gBAAgB,EAAE;IAIpC;;OAEG;IACU,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAwBrC;;;;;OAKG;IACU,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAqCxE;;;;;;;OAOG;IACU,MAAM,CACf,EAAE,EAAE,GAAG,EACP,OAAO,EAAE,OAAO,CAAC,gBAAgB,CAAC,EAClC,WAAW,GAAE,OAAe,GAC7B,OAAO,CAAC,OAAO,CAAC;IA+CnB;;;;;OAKG;IACU,MAAM,CAAC,EAAE,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAwC9C;;;OAGG;IACU,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAgCzC;;OAEG;IACI,aAAa,IAAI,IAAI;IAe5B;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IAyB5B;;OAEG;IACI,UAAU,IAAI,iBAAiB;IAItC;;;OAGG;IACI,uBAAuB,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IAMvD;;;OAGG;IACI,yBAAyB,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IAIzD;;;OAGG;YACW,WAAW;IAWzB;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAYzB;;;OAGG;IACI,OAAO,IAAI,IAAI;IA4BtB;;OAEG;IACI,iBAAiB,IAAI,cAAc;CAG7C;AAED,wBAAsB,gBAAgB,CAClC,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,iBAAiB,EAC1B,IAAI,EAAE,MAAM,EACZ,YAAY,CAAC,EAAE,sBAAsB,GACtC,OAAO,CAAC,UAAU,CAAC,CAErB"}