0.9.1 - improve 'syncUpAndUpdateCollection()' type signature

Author: TeamworkGuy2

CHANGELOG.md

@@ -4,7 +4,13 @@ This project does its best to adhere to [Semantic Versioning](http://semver.org/
 
 
 --------
-### [0.9.0](N/A) - 2020-09-05
+### [0.9.1](N/A) - 2020-12-11
+#### Changed
+* Improve `syncUpAndUpdateCollection()` type signature to support either null `primaryKey` or null `primaryKeys` but not both
+
+
+--------
+### [0.9.0](https://github.com/TeamworkGuy2/lokijs-collections-syncing/commit/6ab12c05a18606eaa5c6ba1ce4fd1f89dcd73b63) - 2020-09-05
 #### Changed
 * Update to TypeScript 4.0
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "lokijs-collections-syncing",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "description": "lokijs-collections syncing to and from a remote data source",
   "author": "TeamworkGuy2",
   "homepage": "https://github.com/TeamworkGuy2/lokijs-collections-syncing",

sync/SyncDataCollection.js

@@ -177,19 +177,6 @@ var SyncDataCollection = /** @class */ (function () {
         }
         return this.syncUpAndUpdateCollection(localColl, primaryKey, primaryKeys, convertAndSendItemsToServer);
     };
-    /** A wrapper around a 'syncAction' function that syncs data to a destination.
-     * This function loads the items from storage for 'syncAction' and is called back if the data transfer is successful or not.
-     * If the transfer is successful, the items in storage are updated to reflect that a sync has occurred.
-     * @template E the local collection data model. This type should contain deleted, synched, and last modified properties corresponding to the prop names passed to the constructor
-     * @template F the local collection data model with optional properties. This type should contain deleted, synched, and last modified properties corresponding to the prop names passed to the constructor
-     * @template R the 'syncAction' response type
-     * @template S the remote data model. This type should contain deleted, synched, and last modified properties corresponding to the prop names passed to the constructor
-     * @param dfd deferred object to reject or resolve once 'syncAction' has completed or failed
-     * @param table the data source where data can be updated or retrieved
-     * @param primaryKey the table data model's primary key, this or 'primaryKeys' must not be null, 'primaryKey' takes recedence
-     * @param primaryKeys the table data model's primary keys, this or 'primaryKey' must not be null
-     * @param syncAction the action which performs the data sync
-     */
     SyncDataCollection.prototype.syncUpAndUpdateCollection = function (table, primaryKey, primaryKeys, syncAction) {
         var self = this;
         var dfd = Defer.newDefer();

sync/SyncDataCollection.ts

@@ -46,8 +46,12 @@ class SyncDataCollection {
      * @param [notifyActionEnd] optional event listener type function which is called whenever a sync action finishes, see {@link SyncAction}. Note: this method is only called if the action is successful, see 'notifyActionFailure'
      * @param [notifyActionFailure] optional event listener type function which is called whenever a sync action fails, see {@link SyncAction}
      */
-    constructor(getLastSyncDownTimestamp: (table: DataCollection<any, any>) => number, updateLastSyncDownTimestamp: (table: DataCollection<any, any>) => void,
-        isDeletedPropName: string, isSynchedPropName: string, lastModifiedPropName: string,
+    constructor(
+        getLastSyncDownTimestamp: (table: DataCollection<any, any>) => number,
+        updateLastSyncDownTimestamp: (table: DataCollection<any, any>) => void,
+        isDeletedPropName: string,
+        isSynchedPropName: string,
+        lastModifiedPropName: string,
         notifyActionStart?: (action: SyncDataCollection.SyncAction, table: DataCollection<any, any>) => any,
         notifyActionEnd?: (action: SyncDataCollection.SyncAction, table: DataCollection<any, any>, startTimerKey: any) => void,
         notifyActionFailure?: (action: SyncDataCollection.SyncAction, table: DataCollection<any, any>, startTimerKey: any, err: any) => void
@@ -95,8 +99,10 @@ class SyncDataCollection {
      * @template R1 the sync down function error type
      * @template R2 the process results callback error type
      */
-    public syncDownCollection<E extends F, F, P, S, R1, R2>(params: P, table: DataCollection<E, F>, syncDownFunc: (params: P) => PsPromise<S, R1>,
-            processResultsCallback: (results: S) => void | PsPromise<void, R2>): PsPromise<void, SyncError> {
+    public syncDownCollection<E extends F, F, P, S, R1, R2>(params: P, table: DataCollection<E, F>,
+        syncDownFunc: (params: P) => PsPromise<S, R1>,
+        processResultsCallback: (results: S) => void | PsPromise<void, R2>
+    ): PsPromise<void, SyncError> {
         var self = this;
         var dfd = Defer.newDefer<void, SyncError>();
 
@@ -235,6 +241,8 @@ class SyncDataCollection {
      * @param primaryKeys the table data model's primary keys, this or 'primaryKey' must not be null
      * @param syncAction the action which performs the data sync
      */
+    public syncUpAndUpdateCollection<E extends F, F, R, S>(table: DataCollection<E, F>, primaryKey: (keyof E) | null, primaryKeys: (keyof E)[], syncAction: (items: E[]) => PsPromise<R, S>): PsPromise<R | null, S>;
+    public syncUpAndUpdateCollection<E extends F, F, R, S>(table: DataCollection<E, F>, primaryKey: (keyof E), primaryKeys: (keyof E)[] | null, syncAction: (items: E[]) => PsPromise<R, S>): PsPromise<R | null, S>;
     public syncUpAndUpdateCollection<E extends F, F, R, S>(table: DataCollection<E, F>, primaryKey: (keyof E) | null, primaryKeys: (keyof E)[], syncAction: (items: E[]) => PsPromise<R, S>): PsPromise<R | null, S> {
         var self = this;
         var dfd = Defer.newDefer<R | null, S>();
@@ -467,7 +475,6 @@ module SyncDataCollection {
 
 
 
-
     /** A utility function for picking a 'SyncDownOp' based on a set of flags describing the desired syncing behavior
      * @param clearData true if all existing local data should be deleted before syncing down new data, false to keep local data (with some cavets)
      * @param removeDeletedData true to remove local data marked deleted (based 'isDeletedPropName' values of true) before syncing down new data, false to keep deleted data

sync/SyncSettingsBuilder.js

@@ -96,21 +96,21 @@ var SyncSettingsBuilder = /** @class */ (function () {
         inst.copyObjectFunc = settings.copyObjectFunc;
         return inst;
     };
-    SyncSettingsBuilder.fromDataCollectionAndSyncFuncs = function (table, syncDownFunc, syncUpFunc) {
-        var tableModel = table.getDataModel();
-        var tableFuncs = table.getDataModelFuncs();
+    SyncSettingsBuilder.fromDataCollectionAndSyncFuncs = function (localCollection, syncDownFunc, syncUpFunc) {
+        var collModel = localCollection.getDataModel();
+        var collFuncs = localCollection.getDataModelFuncs();
         var inst = new SyncSettingsBuilder();
         // sync settings
-        inst.localCollection = table;
-        inst.primaryKeys = tableModel.primaryKeys;
-        inst.hasPrimaryKeyCheckers = tableModel.primaryKeys.map(function (k) { return function (itm) { return !!itm[k]; }; });
-        inst.copyObjectFunc = tableFuncs.copyFunc;
+        inst.localCollection = localCollection;
+        inst.primaryKeys = collModel.primaryKeys;
+        inst.hasPrimaryKeyCheckers = collModel.primaryKeys.map(function (k) { return function (itm) { return !!itm[k]; }; });
+        inst.copyObjectFunc = collFuncs.copyFunc;
         // sync down
         inst.syncDownFunc = syncDownFunc;
-        inst.toLocalObject = tableFuncs.toLocalObject;
+        inst.toLocalObject = collFuncs.toLocalObject;
         // sync up
         inst.syncUpFunc = syncUpFunc;
-        inst.toSvcObject = tableFuncs.toSvcObject;
+        inst.toSvcObject = collFuncs.toSvcObject;
         return {
             addFilterFuncs: function (findFilterFunc) {
                 inst.findFilterFunc = findFilterFunc;

sync/SyncSettingsBuilder.ts

@@ -43,10 +43,13 @@ class SyncSettingsBuilder<E extends F, F, P, S, U, R> implements SettingsBuilder
     }
 
 
-    public addSettings(localCollection: DataCollection<E, F>, primaryKeys: (keyof E & string)[], hasPrimaryKeyCheckers: ((obj: E) => boolean) | ((obj: E) => boolean)[],
-            findFilterFunc: (item: any) => any,
-            copyObjectFunc: (item: E) => E) {
-
+    public addSettings(
+        localCollection: DataCollection<E, F>,
+        primaryKeys: (keyof E & string)[],
+        hasPrimaryKeyCheckers: ((obj: E) => boolean) | ((obj: E) => boolean)[],
+        findFilterFunc: (item: any) => any,
+        copyObjectFunc: (item: E) => E
+    ) {
         this.localCollection = localCollection;
         this.primaryKeys = primaryKeys;
         this.hasPrimaryKeyCheckers = Arrays.asArray(hasPrimaryKeyCheckers);
@@ -101,11 +104,15 @@ class SyncSettingsBuilder<E extends F, F, P, S, U, R> implements SettingsBuilder
     }
 
 
-    public static fromSettingsConvert<E extends F, F, R>(localCollection: DataCollection<E, F>, primaryKeys: (keyof E & string)[], hasPrimaryKeyCheckers: ((obj: E) => boolean) | ((obj: E) => boolean)[],
-            findFilterFunc: (item: any) => any,
-            copyObjectFunc: (item: E) => E,
-            convertUrlToSyncDownFunc: (url: string) => (params: any) => PsPromise<any[], R>,
-            convertUrlToSyncUpFunc: (url: string) => (params: any, items: any[]) => PsPromise<any, R>): SyncDownBuilderWithUrl<E, F> & SyncUpBuilderWithUrl<E, F> {
+    public static fromSettingsConvert<E extends F, F, R>(
+        localCollection: DataCollection<E, F>,
+        primaryKeys: (keyof E & string)[],
+        hasPrimaryKeyCheckers: ((obj: E) => boolean) | ((obj: E) => boolean)[],
+        findFilterFunc: (item: any) => any,
+        copyObjectFunc: (item: E) => E,
+        convertUrlToSyncDownFunc: (url: string) => (params: any) => PsPromise<any[], R>,
+        convertUrlToSyncUpFunc: (url: string) => (params: any, items: any[]) => PsPromise<any, R>
+    ): SyncDownBuilderWithUrl<E, F> & SyncUpBuilderWithUrl<E, F> {
 
         var inst = new SyncSettingsBuilder<E, F, any, any, any, R>();
         inst.localCollection = localCollection;
@@ -119,9 +126,13 @@ class SyncSettingsBuilder<E extends F, F, P, S, U, R> implements SettingsBuilder
     }
 
 
-    public static fromSettings<E extends F, F, R>(localCollection: DataCollection<E, F>, primaryKeys: (keyof E & string)[], hasPrimaryKeyCheckers: ((obj: E) => boolean) | ((obj: E) => boolean)[],
-            findFilterFunc: (item: any) => any,
-            copyObjectFunc: (item: E) => E): SyncDownBuilder<E, F> & SyncUpBuilder<E, F> {
+    public static fromSettings<E extends F, F, R>(
+        localCollection: DataCollection<E, F>,
+        primaryKeys: (keyof E & string)[],
+        hasPrimaryKeyCheckers: ((obj: E) => boolean) | ((obj: E) => boolean)[],
+        findFilterFunc: (item: any) => any,
+        copyObjectFunc: (item: E) => E
+    ): SyncDownBuilder<E, F> & SyncUpBuilder<E, F> {
 
         var inst = new SyncSettingsBuilder<E, F, any, any, any, R>();
         inst.localCollection = localCollection;
@@ -144,24 +155,26 @@ class SyncSettingsBuilder<E extends F, F, P, S, U, R> implements SettingsBuilder
     }
 
 
-    public static fromDataCollectionAndSyncFuncs<E extends F, F, P, S, U, R>(table: DataCollection<E, F>,
-            syncDownFunc: (params: P) => PsPromise<S[], R>,
-            syncUpFunc: (params: P, items: S[]) => PsPromise<U, R>): { addFilterFuncs: (findFilterFunc: (item: S) => F) => BuilderEnd<E, F, P, S, U, R> } {
+    public static fromDataCollectionAndSyncFuncs<E extends F, F, P, S, U, R>(
+        localCollection: DataCollection<E, F>,
+        syncDownFunc: (params: P) => PsPromise<S[], R>,
+        syncUpFunc: (params: P, items: S[]) => PsPromise<U, R>
+    ): { addFilterFuncs: (findFilterFunc: (item: S) => F) => BuilderEnd<E, F, P, S, U, R> } {
 
-        var tableModel = table.getDataModel();
-        var tableFuncs = <DtoAllFuncs<E, S>>table.getDataModelFuncs();
+        var collModel = localCollection.getDataModel();
+        var collFuncs = <DtoAllFuncs<E, S>>localCollection.getDataModelFuncs();
         var inst = new SyncSettingsBuilder<E, F, P, S, U, R>();
         // sync settings
-        inst.localCollection = table;
-        inst.primaryKeys = tableModel.primaryKeys;
-        inst.hasPrimaryKeyCheckers = tableModel.primaryKeys.map(k => (itm: E) => !!itm[k]);
-        inst.copyObjectFunc = tableFuncs.copyFunc;
+        inst.localCollection = localCollection;
+        inst.primaryKeys = collModel.primaryKeys;
+        inst.hasPrimaryKeyCheckers = collModel.primaryKeys.map(k => (itm: E) => !!itm[k]);
+        inst.copyObjectFunc = collFuncs.copyFunc;
         // sync down
         inst.syncDownFunc = syncDownFunc;
-        inst.toLocalObject = tableFuncs.toLocalObject;
+        inst.toLocalObject = collFuncs.toLocalObject;
         // sync up
         inst.syncUpFunc = syncUpFunc;
-        inst.toSvcObject = tableFuncs.toSvcObject;
+        inst.toSvcObject = collFuncs.toSvcObject;
 
         return {
             addFilterFuncs: function (findFilterFunc: (item: S) => F) {
@@ -188,12 +201,15 @@ module SyncSettingsBuilder {
         convertUrlToSyncUpFunc: ((url: string) => (params: any, items: any[]) => PsPromise<any, R>) | undefined;
 
 
-        constructor(localCollection: DataCollection<E, F>, primaryKeys: (keyof E & string)[], hasPrimaryKeyCheckers: ((obj: E) => boolean) | ((obj: E) => boolean)[],
-                findFilterFunc: (item: S) => F,
-                copyObj: (item: E) => E,
-                convertUrlToSyncDownFunc?: (url: string) => (params: any) => PsPromise<any[], R>,
-                convertUrlToSyncUpFunc?: (url: string) => (params: any, items: any[]) => PsPromise<any, R>) {
-
+        constructor(
+            localCollection: DataCollection<E, F>,
+            primaryKeys: (keyof E & string)[],
+            hasPrimaryKeyCheckers: ((obj: E) => boolean) | ((obj: E) => boolean)[],
+            findFilterFunc: (item: S) => F,
+            copyObj: (item: E) => E,
+            convertUrlToSyncDownFunc?: (url: string) => (params: any) => PsPromise<any[], R>,
+            convertUrlToSyncUpFunc?: (url: string) => (params: any, items: any[]) => PsPromise<any, R>
+        ) {
             this.localCollection = localCollection;
             this.primaryKeys = primaryKeys;
             this.hasPrimaryKeyCheckers = Arrays.asArray(hasPrimaryKeyCheckers);