0.8.0 - Update interfaces, remove unnecessary generics.

Author: TeamworkGuy2

CHANGELOG.md

@@ -4,7 +4,21 @@ This project does its best to adhere to [Semantic Versioning](http://semver.org/
 
 
 --------
-### [0.7.10](N/A) - 2019-11-08
+### [0.8.0](N/A) - 2019-11-09
+#### Changed
+* Renamed interfaces:
+  * `SyncSettingsWithUp` -> `SyncSettingsUp`
+  * `SyncSettingsWithDown` -> `SyncSettingsDown`
+  * `SyncSettingsWithUpDown` -> `SyncSettingsUpDown`
+
+#### Removed
+* Remove unused `updateLastSyncDate` field from `SyncDownSettingsImpl`
+* Remove unnecessary `F` generic type from `SyncUpSettings`, `SyncDownSettings`, `SyncUpSettingsImpl`, and `SyncDownSettingsImpl`
+* Remove unused `P` and `R` generic parameters from `SyncDataCollection.createAddUpdateOrRemoveItemsFunc()`
+
+
+--------
+### [0.7.10](https://github.com/TeamworkGuy2/lokijs-collections-syncing/commit/744380abc048fbe6f9acde6bd3ab419d51fc2e8e) - 2019-11-08
 #### Changed
 * Update to TypeScript 3.7
 

package.json

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

sync/SyncDataCollection.ts

@@ -71,7 +71,7 @@ class SyncDataCollection {
      * @param syncDownOp the type of sync to perform
      * @return a map of 'syncSettingsAry' collection names to the promises that will complete when they finish syncing
      */
-    public syncDownCollections<P, R>(params: P, syncSettingsAry: SyncSettingsWithDown<any, any, P, any, R>[], syncDownOp: SyncDataCollection.SyncDownOp): StringMap<PsPromise<void, SyncError>> {
+    public syncDownCollections<P, R>(params: P, syncSettingsAry: SyncSettingsDown<any, any, P, any, R>[], syncDownOp: SyncDataCollection.SyncDownOp): StringMap<PsPromise<void, SyncError>> {
         var promises: StringMap<PsPromise<void, SyncError>> = {};
 
         // sync each of the tables based on the settings in the passed in array
@@ -175,7 +175,7 @@ class SyncDataCollection {
      * only contains one record and send that one record as an object, rather than sending an
      * array of objects to the service call, false or undefined sends an array of any data in the collection
      */
-    public syncUpCollection<E extends F, F, P, S, U, R>(params: P, syncSetting: SyncSettingsWithUp<E, F, P, S, U, R>): PsPromise<U | null, SyncError> {
+    public syncUpCollection<E extends F, F, P, S, U, R>(params: P, syncSetting: SyncSettingsUp<E, F, P, S, U, R>): PsPromise<U | null, SyncError> {
         var self = this;
         var primaryKeys = syncSetting.primaryKeys;
         var primaryKey = (primaryKeys.length === 1 ? primaryKeys[0] : null);
@@ -321,7 +321,7 @@ class SyncDataCollection {
      * @param isDeletedPropName the name of the property which indicates if an item should be deleted, if value of this property is truthy the item is deleted when the syncing, nullable
      * @param syncDownOp the type of merge/update/add operation to perform with the new items
      */
-    public static createAddUpdateOrRemoveItemsFunc<E extends F, F, P, S, R>(syncSettings: SyncSettingsWithDown<E, F, P, S, R>, isDeletedPropName: keyof S, syncDownOp: SyncDataCollection.SyncDownOp) {
+    public static createAddUpdateOrRemoveItemsFunc<E extends F, F, S>(syncSettings: SyncSettingsDown<E, F, any, S, any>, isDeletedPropName: keyof S, syncDownOp: SyncDataCollection.SyncDownOp) {
         return function addUpdateOrRemoveItemsFunc(items: S[]) {
             var table = syncSettings.localCollection;
             var findFilterFunc = syncSettings.findFilterFunc;

sync/SyncSettingsBuilder.ts

@@ -84,7 +84,7 @@ class SyncSettingsBuilder<E extends F, F, P, S, U, R> implements SettingsBuilder
     }
 
 
-    public build(): SyncSettingsWithUpDown<E, F, P, S, U, R> {
+    public build(): SyncSettingsUpDown<E, F, P, S, U, R> {
         return this;
     }
 
@@ -215,7 +215,7 @@ module SyncSettingsBuilder {
 
     /** Settings for syncing up (uploading) server data from a local data collection
      */
-    export class SyncUpSettingsImpl<E extends F, F, P, S, U, R> implements SyncUpSettings<E, F, P, S, U, R> {
+    export class SyncUpSettingsImpl<E, P, S, U, R> implements SyncUpSettings<E, P, S, U, R> {
         syncUpFunc: (params: P, items: S[]) => PsPromise<U, R>;
         toSvcObject: (item: E) => S;
 
@@ -226,7 +226,7 @@ module SyncSettingsBuilder {
         }
 
 
-        public static copy<E1 extends F1, F1, P1, S1, U1, R1>(src: SyncUpSettings<E1, F1, P1, S1, U1, R1>) {
+        public static copy<E1, P1, S1, U1, R1>(src: SyncUpSettings<E1, P1, S1, U1, R1>) {
             return new SyncUpSettingsImpl(src.syncUpFunc, src.toSvcObject);
         }
 
@@ -237,10 +237,9 @@ module SyncSettingsBuilder {
 
     /** Settings for syncing down (downloading) server data to a local data collection
      */
-    export class SyncDownSettingsImpl<E extends F, F, P, S, R> implements SyncDownSettings<E, F, P, S, R> {
+    export class SyncDownSettingsImpl<E, P, S, R> implements SyncDownSettings<E, P, S, R> {
         syncDownFunc: (params: P) => PsPromise<S[], R>;
         toLocalObject: (item: any) => E;
-        updateLastSyncDate!: (table: DataCollection<E, F>) => void;
 
 
         constructor(syncDownFunc: (params: P) => PsPromise<S[], R>, toLocalObj: (item: any) => E) {
@@ -249,7 +248,7 @@ module SyncSettingsBuilder {
         }
 
 
-        public static copy<E1 extends F1, F1, P1, S1, R1>(src: SyncDownSettings<E1, F1, P1, S1, R1>) {
+        public static copy<E1, P1, S1, R1>(src: SyncDownSettings<E1, P1, S1, R1>) {
             return new SyncDownSettingsImpl(src.syncDownFunc, src.toLocalObject);
         }
 
@@ -288,7 +287,7 @@ interface SyncUpBuilderWithUrl<E extends F, F> extends SyncUpBuilder<E, F> {
 
 interface SyncUpAlreadyDownBuilder<E extends F, F, P, S, U, R> {
     addSyncDownFunc(syncDownFunc: (params: P) => PsPromise<S[], R>, toLocalObject: (item: S) => E): BuilderEnd<E, F, P, S, U, R>;
-    build(): SyncSettingsWithUp<E, F, P, S, U, R>;
+    build(): SyncSettingsUp<E, F, P, S, U, R>;
 }
 
 interface SyncUpAlreadyDownBuilderWithUrl<E extends F, F, P, S, U, R> extends SyncUpAlreadyDownBuilder<E, F, P, S, U, R> {
@@ -297,15 +296,15 @@ interface SyncUpAlreadyDownBuilderWithUrl<E extends F, F, P, S, U, R> extends Sy
 
 interface SyncDownAlreadyUpBuilder<E extends F, F, P, S, R> {
     addSyncUpFunc<U>(syncUpFunc: (params: P, items: S[]) => PsPromise<U, R>, toSvcObject: (item: E) => S): BuilderEnd<E, F, P, S, U, R>;
-    build(): SyncSettingsWithDown<E, F, P, S, R>;
+    build(): SyncSettingsDown<E, F, P, S, R>;
 }
 
 interface SyncDownAlreadyUpBuilderWithUrl<E extends F, F, P, S, R> extends SyncDownAlreadyUpBuilder<E, F, P, S, R> {
     addSyncUpUrl<U>(syncUpUrl: string, toSvcObject: (item: E) => S): BuilderEnd<E, F, P, S, U, R>;
 }
 
 interface BuilderEnd<E extends F, F, P, S, U, R> extends SettingsBuilder<E, F>, SyncDownBuilder<E, F>, SyncUpBuilder<E, F> {
-    build(): SyncSettingsWithUpDown<E, F, P, S, U, R>;
+    build(): SyncSettingsUpDown<E, F, P, S, U, R>;
 }
 
 

sync/syncing-types.d.ts

@@ -17,6 +17,11 @@ declare interface SyncError {
 
 
 /** Settings for syncing server data to and from a local data collection
+ * @template E the client data collection type
+ * @template F the client data collection type with optional properties
+ * @template P the parameters to pass with the items
+ * @template S the server data collection type
+ * @template R the server error
  */
 declare interface SyncSettings<E extends F, F, S, R> {
     localCollection: DataCollection<E, F>;
@@ -30,39 +35,37 @@ declare interface SyncSettings<E extends F, F, S, R> {
 
 
 /** Settings for syncing up (uploading) server data from a local data collection
- * @template E the client data collection type
- * @template F the client data collection type with optional properties
+ * @template E the client data type
  * @template P the parameters to pass with the items
  * @template S the server data collection type
  * @template U the server response
  * @template R the server error
  */
-declare interface SyncUpSettings<E extends F, F, P, S, U, R> {
+declare interface SyncUpSettings<E, P, S, U, R> {
     syncUpFunc: (params: P, items: S[]) => PsPromise<U, R>;
     toSvcObject: (item: E) => S;
 }
 
 
 /** Settings for syncing down (downloading) server data to a local data collection
  * @template E the client data collection type
- * @template F the client data collection type with optional properties
  * @template P the parameters to pass with the items
  * @template S the server data collection type
  * @template R the server error
  */
-declare interface SyncDownSettings<E extends F, F, P, S, R> {
+declare interface SyncDownSettings<E, P, S, R> {
     syncDownFunc: (params: P) => PsPromise<S[], R>;
     toLocalObject: (item: S) => E;
 }
 
 
-declare interface SyncSettingsWithUp<E extends F, F, P, S, U, R> extends SyncSettings<E, F, S, R>, SyncUpSettings<E, F, P, S, U, R> {
+declare interface SyncSettingsUp<E extends F, F, P, S, U, R> extends SyncSettings<E, F, S, R>, SyncUpSettings<E, P, S, U, R> {
 }
 
 
-declare interface SyncSettingsWithDown<E extends F, F, P, S, R> extends SyncSettings<E, F, S, R>, SyncDownSettings<E, F, P, S, R> {
+declare interface SyncSettingsDown<E extends F, F, P, S, R> extends SyncSettings<E, F, S, R>, SyncDownSettings<E, P, S, R> {
 }
 
 
-declare interface SyncSettingsWithUpDown<E extends F, F, P, S, U, R> extends SyncSettings<E, F, S, R>, SyncUpSettings<E, F, P, S, U, R>, SyncDownSettings<E, F, P, S, R> {
+declare interface SyncSettingsUpDown<E extends F, F, P, S, U, R> extends SyncSettings<E, F, S, R>, SyncUpSettings<E, P, S, U, R>, SyncDownSettings<E, P, S, R> {
 }