Issue 1048 addons for Dexie 3.0

addons/Dexie.Observable/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dexie-observable",
-  "version": "1.0.0-beta.8",
+  "version": "3.0.0-beta.9",
   "description": "Addon to Dexie that makes it possible to observe database changes no matter if they occur on other db instance or other window.",
   "main": "dist/dexie-observable.js",
   "module": "dist/dexie-observable.es.js",
@@ -76,10 +76,10 @@
   },
   "homepage": "http://dexie.org",
   "peerDependencies": {
-    "dexie": "^2.0.4"
+    "dexie": "^3.0.2"
   },
   "devDependencies": {
-    "dexie": "^2.0.4",
+    "dexie": "^3.0.2",
     "eslint": "^5.16.0",
     "just-build": "^0.9.19",
     "karma": "^4.1.0",

addons/Dexie.Observable/src/Dexie.Observable.d.ts

@@ -2,9 +2,53 @@
 // Project: https://github.com/dfahlander/Dexie.js/tree/master/addons/Dexie.Observable
 // Definitions by: David Fahlander <http://github.com/dfahlander>
 
-import Dexie from 'dexie';
+import Dexie, { DexieEventSet } from 'dexie';
 import { IDatabaseChange } from '../api';
 
+export interface SyncNodeConstructor {
+    new() : SyncNode;
+}
+
+//
+// Interfaces of Dexie.Observable
+//            
+
+
+/**
+ * A SyncNode represents a local database instance that subscribes
+ * to changes made on the database.
+ * SyncNodes are stored in the _syncNodes table.
+ * 
+ * Dexie.Syncable extends this interface and allows 'remote' nodes to be stored
+ * as well.
+ */
+export interface SyncNode {
+    id?: number,
+    myRevision: number,
+    type: 'local' | 'remote',
+    lastHeartBeat: number,
+    deleteTimeStamp: number, // In case lastHeartBeat is too old, a value of now + HIBERNATE_GRACE_PERIOD will be set here. If reached before node wakes up, node will be deleted.
+    isMaster: number // 1 if true. Not using Boolean because it's not possible to index Booleans.
+}
+
+export interface ObservableEventSet extends DexieEventSet {
+    (eventName: 'latestRevisionIncremented', subscriber: (dbName: string, latestRevision: number) => void): void;
+    (eventName: 'suicideNurseCall', subscriber: (dbName: string, nodeID: number) => void): void;
+    (eventName: 'intercomm', subscriber: (dbName: string) => void): void;
+    (eventName: 'beforeunload', subscriber: () => void): void;
+}
+
+// Object received by on('message') after sendMessage() or broadcastMessage()
+interface MessageEvent {
+    id: number;
+    type: string;
+    message: any;
+    destinationNode: number;
+    wantReply?: boolean;
+    resolve(result: any): void;
+    reject(error: any): void;
+}
+
 //
 // Extend Dexie interface
 //
@@ -14,7 +58,8 @@ declare module 'dexie' {
         // Placeholder where to access the SyncNode class constructor.
         // (makes it valid to do new db.observable.SyncNode())
         observable: {
-            SyncNode: Dexie.Observable.SyncNodeConstructor;
+            version: string;
+            SyncNode: SyncNodeConstructor;
             sendMessage(
                 type: string, // Don't use 'response' as it is used internally by the framework
                 message: any, // anything that can be saved by IndexedDB
@@ -31,34 +76,32 @@ declare module 'dexie' {
             ): void;
         }
 
-        readonly _localSyncNode: Dexie.Observable.SyncNode;
+        readonly _localSyncNode: SyncNode;
 
         _changes: Dexie.Table<IDatabaseChange & {rev: number}, number>;
-        _syncNodes: Dexie.Table<Dexie.Observable.SyncNode, number>;
+        _syncNodes: Dexie.Table<SyncNode, number>;
         _intercomm: Dexie.Table<any, number>;
     }
 
-    module Dexie {
-        // Extended events db.on('changes', subscriber), ...
-        interface DbEvents {
-            (eventName: 'changes', subscriber: (changes: IDatabaseChange[], partial: boolean)=>void): void;
-            (eventName: 'cleanup', subscriber: ()=>any): void;
-            (eventName: 'message', subscriber: (msg: Dexie.Observable.MessageEvent)=>any): void;
-        }
+    // Extended events db.on('changes', subscriber), ...
+    interface DbEvents {
+        (eventName: 'changes', subscriber: (changes: IDatabaseChange[], partial: boolean)=>void): void;
+        (eventName: 'cleanup', subscriber: ()=>any): void;
+        (eventName: 'message', subscriber: (msg: MessageEvent)=>any): void;
+    }
 
-        // Extended IndexSpec with uuid boolean for primary key.
-        interface IndexSpec {
-            uuid: boolean;
-        }
+    // Extended IndexSpec with uuid boolean for primary key.
+    interface IndexSpec {
+        uuid: boolean;
+    }
 
-        var Observable: {
+    interface DexieConstructor {
+        Observable: {
             (db: Dexie) : void;
 
-            //
-            //
-            //
+            version: string;
             createUUID: () => string;
-            on: Observable.ObservableEventSet;
+            on: ObservableEventSet;
             localStorageImpl: {
                 setItem(key: string, value: string): void,
                 getItem(key: string): string,
@@ -67,53 +110,6 @@ declare module 'dexie' {
             _onStorage: (event: StorageEvent) => void;
         }
 
-        //
-        // Define Dexie.Observable
-        //
-        module Observable {
-            //
-            // Interfaces of Dexie.Observable
-            //            
-
-            interface SyncNodeConstructor {
-                new() : SyncNode;
-            }
-
-            /**
-             * A SyncNode represents a local database instance that subscribes
-             * to changes made on the database.
-             * SyncNodes are stored in the _syncNodes table.
-             * 
-             * Dexie.Syncable extends this interface and allows 'remote' nodes to be stored
-             * as well.
-             */
-            interface SyncNode {
-                id?: number,
-                myRevision: number,
-                type: 'local' | 'remote',
-                lastHeartBeat: number,
-                deleteTimeStamp: number, // In case lastHeartBeat is too old, a value of now + HIBERNATE_GRACE_PERIOD will be set here. If reached before node wakes up, node will be deleted.
-                isMaster: number // 1 if true. Not using Boolean because it's not possible to index Booleans.
-            }
-
-            interface ObservableEventSet extends Dexie.DexieEventSet {
-                (eventName: 'latestRevisionIncremented', subscriber: (dbName: string, latestRevision: number) => void): void;
-                (eventName: 'suicideNurseCall', subscriber: (dbName: string, nodeID: number) => void): void;
-                (eventName: 'intercomm', subscriber: (dbName: string) => void): void;
-                (eventName: 'beforeunload', subscriber: () => void): void;
-            }
-
-            // Object received by on('message') after sendMessage() or broadcastMessage()
-            interface MessageEvent {
-                id: number;
-                type: string;
-                message: any;
-                destinationNode: number;
-                wantReply?: boolean;
-                resolve(result: any): void;
-                reject(error: any): void;
-            }
-        }
     }
 }
 

addons/Dexie.Observable/src/Dexie.Observable.js

@@ -55,11 +55,17 @@ var override = Dexie.override;
 var Promise = Dexie.Promise;
 var browserIsShuttingDown = false;
 
-export default function Observable(db) {
-    /// <summary>
-    ///   Extension to Dexie providing Syncronization capabilities to Dexie.
-    /// </summary>
-    /// <param name="db" type="Dexie"></param>
+/** Dexie addon for change tracking and real-time observation.
+ * 
+ * @param {Dexie} db 
+ */
+function Observable(db) {
+    if (!/^3\./.test(Dexie.version))
+        throw new Error(`Missing dexie version 3.x`);
+    if (db.observable) {
+        if (db.observable.version !== "{version}") throw new Error(`Mixed versions of dexie-observable`);
+        return; // Addon already active.
+    }
 
     var NODE_TIMEOUT = 20000, // 20 seconds before local db instances are timed out. This is so that old changes can be deleted when not needed and to garbage collect old _syncNodes objects.
         HIBERNATE_GRACE_PERIOD = 20000, // 20 seconds
@@ -99,7 +105,7 @@ export default function Observable(db) {
         }
     });
 
-    db.observable = {};
+    db.observable = {version: "{version}"};
     db.observable.SyncNode = SyncNode;
 
     const wakeupObservers = initWakeupObservers(db, Observable, localStorage);
@@ -488,6 +494,7 @@ export default function Observable(db) {
 // Static properties and methods
 // 
 
+Observable.version = "{version}";
 Observable.latestRevision = {}; // Latest revision PER DATABASE. Example: Observable.latestRevision.FriendsDB = 37;
 Observable.on = Dexie.Events(null, "latestRevisionIncremented", "suicideNurseCall", "intercomm", "beforeunload"); // fire(dbname, value);
 Observable.createUUID = createUUID;
@@ -511,6 +518,15 @@ if (global.addEventListener) {
     global.addEventListener("storage", Observable._onStorage);
     global.addEventListener("beforeunload", Observable._onBeforeUnload);
 }
-// Register addon:
-Dexie.Observable = Observable;
-Dexie.addons.push(Observable);
+
+if (Dexie.Observable) {
+    if (Dexie.Observable.version !== "{version}") {
+        throw new Error (`Mixed versions of dexie-observable`);
+    }
+} else {
+    // Register addon:
+    Dexie.Observable = Observable;
+    Dexie.addons.push(Observable);
+}
+
+export default Dexie.Observable;

addons/Dexie.Observable/tools/build-configs/rollup.config.js

@@ -9,18 +9,14 @@ export default {
   output: [{
     file: 'dist/dexie-observable.js',
     format: 'umd',
-    banner: readFileSync(path.resolve(__dirname, 'banner.txt'))+""
-        .replace(/{version}/g, version)
-        .replace(/{date}/g, new Date().toDateString()),
+    banner: readFileSync(path.resolve(__dirname, 'banner.txt')),
     globals: {dexie: "Dexie"},
     name: 'Dexie.Observable',
     sourcemap: true
   },{
     file: 'dist/dexie-observable.es.js',
     format: 'es',
-    banner: readFileSync(path.resolve(__dirname, 'banner.txt'))+""
-        .replace(/{version}/g, version)
-        .replace(/{date}/g, new Date().toDateString()),
+    banner: readFileSync(path.resolve(__dirname, 'banner.txt')),
     globals: {dexie: "Dexie"},
     name: 'Dexie.Observable',
     sourcemap: true