dexie-cloud-addon 4.0.1-beta.47 → 4.0.1-beta.48

package/dist/umd/sync/LocalSyncWorker.d.ts

@@ -0,0 +1,7 @@
+import { DexieCloudDB } from '../db/DexieCloudDB';
+import { DexieCloudOptions } from '../DexieCloudOptions';
+import { DexieCloudSchema } from 'dexie-cloud-common';
+export declare function LocalSyncWorker(db: DexieCloudDB, cloudOptions: DexieCloudOptions, cloudSchema: DexieCloudSchema): {
+    start: () => void;
+    stop: () => void;
+};

package/dist/umd/sync/SyncRequiredError.d.ts

@@ -0,0 +1,3 @@
+export declare class SyncRequiredError extends Error {
+    name: string;
+}

package/dist/umd/sync/applyServerChanges.d.ts

@@ -0,0 +1,3 @@
+import { DexieCloudDB } from '../db/DexieCloudDB';
+import { DBOperationsSet } from 'dexie-cloud-common';
+export declare function applyServerChanges(changes: DBOperationsSet<string>, db: DexieCloudDB): Promise<void>;

package/dist/umd/sync/connectWebSocket.d.ts

@@ -0,0 +1,2 @@
+import { DexieCloudDB } from '../db/DexieCloudDB';
+export declare function connectWebSocket(db: DexieCloudDB): import("rxjs").Subscription;

package/dist/umd/sync/encodeIdsForServer.d.ts

@@ -0,0 +1,4 @@
+import { DBCoreSchema } from 'dexie';
+import { DBOperationsSet } from 'dexie-cloud-common';
+import { UserLogin } from '../db/entities/UserLogin';
+export declare function encodeIdsForServer(schema: DBCoreSchema, currentUser: UserLogin, changes: DBOperationsSet): DBOperationsSet;

package/dist/umd/sync/extractRealm.d.ts

@@ -0,0 +1,2 @@
+import { EntityCommon } from "../db/entities/EntityCommon";
+export declare function extractRealm(obj: EntityCommon): string | undefined;

package/dist/umd/sync/getLatestRevisionsPerTable.d.ts

@@ -0,0 +1,6 @@
+import { DBOperationsSet } from 'dexie-cloud-common';
+export declare function getLatestRevisionsPerTable(clientChangeSet: DBOperationsSet, lastRevisions?: {
+    [table: string]: number;
+}): {
+    [table: string]: number;
+};

package/dist/umd/sync/getTablesToSyncify.d.ts

@@ -0,0 +1,3 @@
+import { DexieCloudDB } from "../db/DexieCloudDB";
+import { PersistedSyncState } from "../db/entities/PersistedSyncState";
+export declare function getTablesToSyncify(db: DexieCloudDB, syncState: PersistedSyncState | undefined): import("dexie").Table<import("../db/entities/EntityCommon").EntityCommon, any, import("../db/entities/EntityCommon").EntityCommon>[];

package/dist/umd/sync/isOnline.d.ts

@@ -0,0 +1 @@
+export declare let isOnline: boolean;

package/dist/umd/sync/isSyncNeeded.d.ts

@@ -0,0 +1,2 @@
+import { DexieCloudDB } from "../db/DexieCloudDB";
+export declare function isSyncNeeded(db: DexieCloudDB): Promise<boolean>;

package/dist/umd/sync/listClientChanges.d.ts

@@ -0,0 +1,9 @@
+import { Table } from 'dexie';
+import { DexieCloudDB } from '../db/DexieCloudDB';
+import { DBOperationsSet } from 'dexie-cloud-common';
+export declare function listClientChanges(mutationTables: Table[], db: DexieCloudDB, { since, limit }?: {
+    since?: {
+        [table: string]: number;
+    } | undefined;
+    limit?: number | undefined;
+}): Promise<DBOperationsSet>;

package/dist/umd/sync/listSyncifiedChanges.d.ts

@@ -0,0 +1,5 @@
+import { UserLogin } from '../db/entities/UserLogin';
+import { EntityCommon } from '../db/entities/EntityCommon';
+import { Table } from 'dexie';
+import { DBOperationsSet, DexieCloudSchema } from 'dexie-cloud-common';
+export declare function listSyncifiedChanges(tablesToSyncify: Table<EntityCommon>[], currentUser: UserLogin, schema: DexieCloudSchema, alreadySyncedRealms?: string[]): Promise<DBOperationsSet>;

package/dist/umd/sync/messageConsumerIsReady.d.ts

@@ -0,0 +1,2 @@
+import { BehaviorSubject } from "rxjs";
+export declare const messageConsumerIsReady: BehaviorSubject<boolean>;

package/dist/umd/sync/messagesFromServerQueue.d.ts

@@ -0,0 +1,8 @@
+import { BehaviorSubject } from 'rxjs';
+import { DexieCloudDB } from '../db/DexieCloudDB';
+import { WSConnectionMsg } from '../WSObservable';
+export type MessagesFromServerConsumer = ReturnType<typeof MessagesFromServerConsumer>;
+export declare function MessagesFromServerConsumer(db: DexieCloudDB): {
+    enqueue: (msg: WSConnectionMsg) => void;
+    readyToServe: BehaviorSubject<boolean>;
+};

package/dist/umd/sync/modifyLocalObjectsWithNewUserId.d.ts

@@ -0,0 +1,4 @@
+import { Table } from "dexie";
+import { EntityCommon } from "../db/entities/EntityCommon";
+import { UserLogin } from "../db/entities/UserLogin";
+export declare function modifyLocalObjectsWithNewUserId(syncifiedTables: Table<EntityCommon>[], currentUser: UserLogin, alreadySyncedRealms?: string[]): Promise<void>;

package/dist/umd/sync/myId.d.ts

@@ -0,0 +1 @@
+export declare const myId: string;

package/dist/umd/sync/numUnsyncedMutations.d.ts

@@ -0,0 +1,2 @@
+import { DexieCloudDB } from "../db/DexieCloudDB";
+export declare function getNumUnsyncedMutationsObservable(db: DexieCloudDB): import("rxjs").Observable<number>;

package/dist/umd/sync/old_startSyncingClientChanges.d.ts

@@ -0,0 +1,39 @@
+/** TODO:
+ * 1. Convert these unsynced changes into sync mutations by resolving values from ordinaryTables.
+ * 2. Append a convertion of mutReqs[table].muts into sync mutations.
+ * 3. Send all this using fetch
+ * 4. if successful response, delete muts from mutTables by
+ *    1. a new rw-transaction where we start by finding revs above those we generated.
+ *    2. for tables where none such found, clear the table. if some of those found, deleteRange on the table.
+ *
+ * Tankar att följa upp:
+ *  * Varje DOM environmnet får en MutationSyncer
+ *  * Håller koll på huruvida den tror att en sync redan pågår eller inte.
+ *  * Bro
+ *
+ * Leader election
+ *  * IDB persisted value: leaderId
+ *  * Varje browsing-env får en nodeId (random string).
+ *  * db.open: Kolla om det finns en leader. Om inte, sätt dig själv som leader.
+ *  * Leaders: Ha sync consumer uppe.
+ *  * Service worker: Ta ledarskap. Spara även en prop som säger att detta är service worker (för att workaround BroadCastChannel props)
+ *  * Om det finns en non-service worker ledare, försök kontakta den (via BroadCastChannel)
+ *  * Om ledaren inte svarar inom 1 sekund, ta ledarskap.
+ *  * Ledare: Lyssna på ändring av ledarskap och sluta vara ledare i så fall.
+ *  * Följare: Lyssna på ändring av ledarskap så att du alltid kontaktar rätt ledare.
+ *  * När man postar något till non-SW ledaren så ska den ACKa inom 1 sek. Annars, ta ledarskapet.
+ *
+ *
+ * Enklare:
+ *  * Vi har en som leker service worker per window. Två aktiva flikar:
+ *     * Båda vaknar upp och låser tabellen X för skrivning, om ingen annan tagit jobbet, skriver timestamp till X och
+ *       börjar sedan synka. Under tiden för sync, uppdaterar den timestamp kontinuerligt för att signallera att den
+ *       jobbar. När klar, clearar ut timestampen och avslutar jobbet.
+ *       - Om det inte fanns nåt att göra så clearas timestamp ut och man schedulerar inget mer uppvaknande.
+ *     * Den som kom sist ser att annan tagit jobbet inom rimlig timestamp och väljer då att polla igen ifall timestampet
+ *       skulle timat ut.
+ *     * Om jobbaren verkar tajma ut: gör nytt försök från början. Kan leda till att du blir ledare denna gång.
+ *     * Om jobbaren clearar ut timestampen pga avslutat jobb så kan väntaren ädnå för säkerhets-skull göra om'et från början.
+ *
+ *
+ */

package/dist/umd/sync/performGuardedJob.d.ts

@@ -0,0 +1,2 @@
+import { DexieCloudDB } from "../db/DexieCloudDB";
+export declare function performGuardedJob<T>(db: DexieCloudDB, jobName: string, job: () => Promise<T>): Promise<T>;

package/dist/umd/sync/ratelimit.d.ts

@@ -0,0 +1,3 @@
+import { DexieCloudDB } from '../db/DexieCloudDB';
+export declare function checkSyncRateLimitDelay(db: DexieCloudDB): Promise<void>;
+export declare function updateSyncRateLimitDelays(db: DexieCloudDB, res: Response): void;

package/dist/umd/sync/registerSyncEvent.d.ts

@@ -0,0 +1,3 @@
+import { DexieCloudDB } from '../db/DexieCloudDB';
+export declare function registerSyncEvent(db: DexieCloudDB, purpose: "push" | "pull"): Promise<void>;
+export declare function registerPeriodicSyncEvent(db: DexieCloudDB): Promise<void>;

package/dist/umd/sync/sync.d.ts

@@ -0,0 +1,15 @@
+import { DexieCloudDB } from '../db/DexieCloudDB';
+import { DexieCloudOptions } from '../DexieCloudOptions';
+import { DBOperationsSet, DexieCloudSchema } from 'dexie-cloud-common';
+export declare const CURRENT_SYNC_WORKER = "currentSyncWorker";
+export interface SyncOptions {
+    isInitialSync?: boolean;
+    cancelToken?: {
+        cancelled: boolean;
+    };
+    justCheckIfNeeded?: boolean;
+    retryImmediatelyOnFetchError?: boolean;
+    purpose?: 'pull' | 'push';
+}
+export declare function sync(db: DexieCloudDB, options: DexieCloudOptions, schema: DexieCloudSchema, syncOptions?: SyncOptions): Promise<boolean>;
+export declare function filterServerChangesThroughAddedClientChanges(serverChanges: DBOperationsSet<string>, addedClientChanges: DBOperationsSet): DBOperationsSet<string>;

package/dist/umd/sync/syncIfPossible.d.ts

@@ -0,0 +1,5 @@
+import { DexieCloudDB } from '../db/DexieCloudDB';
+import { SyncOptions } from './sync';
+import { DexieCloudOptions } from '../DexieCloudOptions';
+import { DexieCloudSchema } from 'dexie-cloud-common';
+export declare function syncIfPossible(db: DexieCloudDB, cloudOptions: DexieCloudOptions, cloudSchema: DexieCloudSchema, options?: SyncOptions): any;

package/dist/umd/sync/syncWithServer.d.ts

@@ -0,0 +1,6 @@
+import { DexieCloudDB } from '../db/DexieCloudDB';
+import { PersistedSyncState } from '../db/entities/PersistedSyncState';
+import { BaseRevisionMapEntry } from '../db/entities/BaseRevisionMapEntry';
+import { DBOperationsSet, DexieCloudSchema, SyncResponse } from 'dexie-cloud-common';
+import { UserLogin } from '../db/entities/UserLogin';
+export declare function syncWithServer(changes: DBOperationsSet, syncState: PersistedSyncState | undefined, baseRevs: BaseRevisionMapEntry[], db: DexieCloudDB, databaseUrl: string, schema: DexieCloudSchema | null, clientIdentity: string, currentUser: UserLogin): Promise<SyncResponse>;

package/dist/umd/sync/triggerSync.d.ts

@@ -0,0 +1,2 @@
+import { DexieCloudDB } from "../db/DexieCloudDB";
+export declare function triggerSync(db: DexieCloudDB, purpose: "push" | "pull"): void;

package/dist/umd/sync/updateBaseRevs.d.ts

@@ -0,0 +1,5 @@
+import { DexieCloudDB } from '../db/DexieCloudDB';
+import { DexieCloudSchema } from 'dexie-cloud-common';
+export declare function updateBaseRevs(db: DexieCloudDB, schema: DexieCloudSchema, latestRevisions: {
+    [table: string]: number;
+}, serverRev: any): Promise<void>;

package/dist/umd/types/DXCAlert.d.ts

@@ -0,0 +1,25 @@
+export type DXCAlert = DXCErrorAlert | DXCWarningAlert | DXCInfoAlert;
+export interface DXCErrorAlert {
+    type: 'error';
+    messageCode: 'INVALID_OTP' | 'INVALID_EMAIL' | 'LICENSE_LIMIT_REACHED' | 'GENERIC_ERROR';
+    message: string;
+    messageParams: {
+        [paramName: string]: string;
+    };
+}
+export interface DXCWarningAlert {
+    type: 'warning';
+    messageCode: 'GENERIC_WARNING' | 'LOGOUT_CONFIRMATION';
+    message: string;
+    messageParams: {
+        [paramName: string]: string;
+    };
+}
+export interface DXCInfoAlert {
+    type: 'info';
+    messageCode: 'GENERIC_INFO' | 'OTP_SENT';
+    message: string;
+    messageParams: {
+        [paramName: string]: string;
+    };
+}

package/dist/umd/types/DXCInputField.d.ts

@@ -0,0 +1,11 @@
+export type DXCInputField = DXCTextField | DXCPasswordField;
+export interface DXCTextField {
+    type: 'text' | 'email' | 'otp';
+    label?: string;
+    placeholder?: string;
+}
+export interface DXCPasswordField {
+    type: 'password';
+    label?: string;
+    placeholder?: string;
+}

package/dist/umd/types/DXCUserInteraction.d.ts

@@ -0,0 +1,93 @@
+import { DXCAlert } from './DXCAlert';
+import { DXCInputField } from './DXCInputField';
+export type DXCUserInteraction = DXCGenericUserInteraction | DXCEmailPrompt | DXCOTPPrompt | DXCMessageAlert | DXCLogoutConfirmation;
+export interface DXCGenericUserInteraction<Type extends string = "generic", TFields extends {
+    [name: string]: DXCInputField;
+} = any> {
+    type: Type;
+    title: string;
+    alerts: DXCAlert[];
+    fields: TFields;
+    submitLabel: string;
+    cancelLabel: string | null;
+    onSubmit: (params: {
+        [P in keyof TFields]: string;
+    }) => void;
+    onCancel: () => void;
+}
+/** When the system needs to prompt for an email address for login.
+ *
+*/
+export interface DXCEmailPrompt {
+    type: 'email';
+    title: string;
+    alerts: DXCAlert[];
+    fields: {
+        email: {
+            type: 'text';
+            placeholder: string;
+        };
+    };
+    submitLabel: string;
+    cancelLabel: string;
+    onSubmit: (params: {
+        email: string;
+    } | {
+        [paramName: string]: string;
+    }) => void;
+    onCancel: () => void;
+}
+/** When the system needs to prompt for an OTP code.
+ *
+*/
+export interface DXCOTPPrompt {
+    type: 'otp';
+    title: string;
+    alerts: DXCAlert[];
+    fields: {
+        otp: {
+            type: 'text';
+            label: string;
+        };
+    };
+    submitLabel: string;
+    cancelLabel: string;
+    onSubmit: (params: {
+        otp: string;
+    } | {
+        [paramName: string]: string;
+    }) => void;
+    onCancel: () => void;
+}
+/** When the system must inform about errors, warnings or information */
+export interface DXCMessageAlert {
+    type: 'message-alert';
+    title: string;
+    alerts: DXCAlert[];
+    fields: {
+        [name: string]: DXCInputField;
+    };
+    submitLabel: string;
+    cancelLabel?: null;
+    onSubmit: (params: {
+        [paramName: string]: string;
+    }) => void;
+    onCancel: () => void;
+}
+/** When the system needs confirmation to logout current user when
+ * there are unsynced changes that would be lost.
+ */
+export interface DXCLogoutConfirmation {
+    type: 'logout-confirmation';
+    title: string;
+    alerts: DXCAlert[];
+    fields: {
+        [name: string]: DXCInputField;
+    };
+    submitLabel: string;
+    cancelLabel: string;
+    onSubmit: (params: {
+        [paramName: string]: string;
+    }) => void;
+    onCancel: () => void;
+}

package/dist/umd/types/NewIdOptions.d.ts

@@ -0,0 +1,3 @@
+export interface NewIdOptions {
+    colocateWith?: string;
+}

package/dist/umd/types/SWMessageEvent.d.ts

@@ -0,0 +1,3 @@
+export interface SWMessageEvent extends MessageEvent {
+    waitUntil(promise: Promise<any>): void;
+}

package/dist/umd/types/SWSyncEvent.d.ts

@@ -0,0 +1,4 @@
+export type SyncEvent = Event & {
+    tag: string;
+    waitUntil(promise: Promise<any>): void;
+};

package/dist/umd/types/SyncState.d.ts

@@ -0,0 +1,9 @@
+export type SyncStatePhase = "initial" | "not-in-sync" | "pushing" | "pulling" | "in-sync" | 'error' | 'offline';
+export type SyncStatus = "not-started" | "connecting" | "connected" | "disconnected" | "error" | "offline";
+export interface SyncState {
+    status: SyncStatus;
+    phase: SyncStatePhase;
+    progress?: number;
+    error?: Error;
+    license?: 'ok' | 'expired' | 'deactivated';
+}

package/dist/umd/types/TXExpandos.d.ts

@@ -0,0 +1,11 @@
+import { DexieCloudSchema } from "dexie-cloud-common";
+import { UserLogin } from '../db/entities/UserLogin';
+export interface TXExpandos {
+    txid: string;
+    currentUser: UserLogin;
+    schema: DexieCloudSchema;
+    disableChangeTracking?: boolean;
+    disableAccessControl?: boolean;
+    mutationsAdded?: boolean;
+    opCount: number;
+}

package/dist/umd/updateSchemaFromOptions.d.ts

@@ -0,0 +1,3 @@
+import { DexieCloudSchema } from "dexie-cloud-common";
+import { DexieCloudOptions } from "./DexieCloudOptions";
+export declare function updateSchemaFromOptions(schema?: DexieCloudSchema | null, options?: DexieCloudOptions | null): void;

package/dist/umd/userIsActive.d.ts

@@ -0,0 +1,7 @@
+import { BehaviorSubject } from 'rxjs';
+export declare const userIsActive: BehaviorSubject<boolean>;
+export declare const userIsReallyActive: BehaviorSubject<boolean>;
+export declare const visibilityStateIsChanged: import("rxjs").Observable<{}>;
+export declare const documentBecomesHidden: import("rxjs").Observable<{}>;
+export declare const documentBecomesVisible: import("rxjs").Observable<{}>;
+export declare const userDoesSomething: import("rxjs").Observable<Event | {}>;

package/dist/umd/verifyConfig.d.ts

@@ -0,0 +1,2 @@
+import { DexieCloudOptions } from "./DexieCloudOptions";
+export declare function verifyConfig({ databaseUrl }?: DexieCloudOptions): void;

package/dist/umd/verifySchema.d.ts

@@ -0,0 +1,2 @@
+import { DexieCloudDB } from "./db/DexieCloudDB";
+export declare function verifySchema(db: DexieCloudDB): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dexie-cloud-addon",
-  "version": "4.0.1-beta.47",
+  "version": "4.0.1-beta.48",
   "description": "Dexie addon that syncs with to Dexie Cloud",
   "main": "dist/umd/dexie-cloud-addon.js",
   "type": "module",
@@ -42,7 +42,7 @@
       }
     }
   },
-  "types": "dist/types/dexie-cloud-client.d.ts",
+  "types": "dist/modern/dexie-cloud-client.d.ts",
   "engines": {
     "node": ">=14"
   },
@@ -52,37 +52,7 @@
   },
   "just-build": {
     "default": [
-      "just-build release test"
-    ],
-    "release": [
-      "# Build outputs",
-      "just-build src",
-      "just-build dexie-cloud service-worker",
-      "#dts-bundle-generator --external-inlines=dexie-cloud-common --external-imports=rxjs dexie --project src/tsconfig.json -o dist/types/dexie-cloud-addon.d.ts tools/tmp/modern/dexie-cloud-client.d.ts",
-      "# Minify modern bundle",
-      "terser --comments false --module --config-file tools/build-configs/terser-config.json --source-map url=dexie-cloud-addon.min.js.map -o dist/modern/dexie-cloud-addon.min.js -- dist/modern/dexie-cloud-addon.js",
-      "# Minify umd bundle",
-      "terser --comments false --config-file tools/build-configs/terser-config.json --source-map url=dexie-cloud-addon.min.js.map -o dist/umd/dexie-cloud-addon.min.js -- dist/umd/dexie-cloud-addon.js",
-      "# Minify modern service-worker",
-      "terser --comments false --module --config-file tools/build-configs/terser-config.json --source-map url=service-worker.min.js.map -o dist/modern/service-worker.min.js -- dist/modern/service-worker.js",
-      "# Minify umd service-worker",
-      "terser --comments false --config-file tools/build-configs/terser-config.json --source-map url=service-worker.min.js.map -o dist/umd/service-worker.min.js -- dist/umd/service-worker.js"
-    ],
-    "src": [
-      "# Build the entire typescript source into modern JS",
-      "tsc -p src -t es2016 --outDir tools/tmp/modern [--watch 'Watching for file changes.']"
-    ],
-    "dexie-cloud": [
-      "# Create a modern bundle in dist/modern",
-      "rollup -c tools/build-configs/rollup.modern.config.js",
-      "# Replace {version} and {date} in output files",
-      "node tools/replaceVersionAndDate.cjs dist/umd/dexie-cloud-addon.js dist/modern/dexie-cloud-addon.js"
-    ],
-    "service-worker": [
-      "# Create a modern bundle in dist/modern",
-      "rollup -c tools/build-configs/rollup.sw.modern.config.js",
-      "# Replace {version} and {date} in output files",
-      "node tools/replaceVersionAndDate.cjs dist/umd/service-worker.js dist/modern/service-worker.js"
+      "rollup -c tools/build-configs/rollup.config.mjs"
     ],
     "test": [
       "just-build test-unit"
@@ -95,11 +65,12 @@
   "author": "david.fahlander@gmail.com",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^18.0.0",
-    "@rollup/plugin-node-resolve": "^11.2.1",
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^11.1.5",
     "@types/node": "^18.11.18",
-    "dreambase-library": "^1.0.19",
-    "dts-bundle-generator": "^8.0.1",
+    "dreambase-library": "^1.0.21",
     "just-build": "*",
     "karma": "*",
     "karma-browserstack-launcher": "*",
@@ -107,12 +78,7 @@
     "karma-firefox-launcher": "*",
     "karma-qunit": "*",
     "preact": "*",
-    "rollup": "^2.45.2",
-    "rollup-plugin-alias": "*",
-    "rollup-plugin-commonjs": "*",
-    "rollup-plugin-dts": "^4.0.1",
-    "rollup-plugin-node-resolve": "*",
-    "rollup-plugin-sourcemaps": "*",
+    "rollup": "^4.1.4",
     "terser": "^5.20.0",
     "tslib": "*",
     "typescript": "^4.9.4"
@@ -127,9 +93,8 @@
   "scripts": {
     "test": "just-build test && pnpm run test-unit",
     "test-unit": "karma start test/unit/karma.conf.js --single-run",
-    "build": "just-build && bash ./copydts.sh",
-    "watch": "just-build --watch",
-    "clean": "rm -rf tools/tmp dist test/unit/bundle.*",
-    "copydts": "bash ./copydts.sh"
+    "build": "rollup -c tools/build-configs/rollup.config.mjs",
+    "watch": "rollup -c tools/build-configs/rollup.config.mjs --watch",
+    "clean": "rm -rf tools/tmp dist test/unit/bundle.*"
   }
 }

package/copydts.sh

@@ -1,5 +0,0 @@
-#!/bin/bash -e
-rm -rf dist/types
-mkdir dist/types
-cd tools/tmp/modern
-find . -name '*.d.ts' | cpio -pdm ../../../dist/types/