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

package/dist/types/DexieCloudAPI.d.ts

@@ -41,6 +41,9 @@ export interface DexieCloudAPI {
         userId?: string;
         grant_type?: 'demo' | 'otp';
     }): Promise<void>;
+    logout(options?: {
+        force?: boolean;
+    }): Promise<void>;
     /**
      * Connect to given URL
      */

package/dist/types/DexieCloudOptions.d.ts

@@ -11,6 +11,7 @@ export interface DexieCloudOptions {
     unsyncedTables?: string[];
     nameSuffix?: boolean;
     disableWebSocket?: boolean;
+    disableEagerSync?: boolean;
     fetchTokens?: (tokenParams: {
         public_key: string;
         hints?: {

package/dist/types/InvalidLicenseError.d.ts

@@ -0,0 +1,5 @@
+export declare class InvalidLicenseError extends Error {
+    name: string;
+    license?: 'expired' | 'deactivated';
+    constructor(license?: 'expired' | 'deactivated');
+}

package/dist/types/authentication/TokenErrorResponseError.d.ts

@@ -0,0 +1,10 @@
+import { TokenErrorResponse } from 'dexie-cloud-common';
+export declare class TokenErrorResponseError extends Error {
+    title: string;
+    messageCode: 'INVALID_OTP' | 'INVALID_EMAIL' | 'LICENSE_LIMIT_REACHED' | 'GENERIC_ERROR';
+    message: string;
+    messageParams?: {
+        [param: string]: string;
+    };
+    constructor({ title, message, messageCode, messageParams, }: TokenErrorResponse);
+}

package/dist/types/authentication/authenticate.d.ts

@@ -1,4 +1,4 @@
-import type { TokenFinalResponse } from 'dexie-cloud-common';
+import type { TokenErrorResponse, TokenFinalResponse } from 'dexie-cloud-common';
 import { BehaviorSubject } from 'rxjs';
 import { DexieCloudDB } from '../db/DexieCloudDB';
 import { UserLogin } from '../db/entities/UserLogin';
@@ -10,8 +10,8 @@ export type FetchTokenCallback = (tokenParams: {
         email?: string;
         grant_type?: string;
     };
-}) => Promise<TokenFinalResponse>;
-export declare function loadAccessToken(db: DexieCloudDB): Promise<string | undefined>;
+}) => Promise<TokenFinalResponse | TokenErrorResponse>;
+export declare function loadAccessToken(db: DexieCloudDB): Promise<UserLogin | null>;
 export declare function authenticate(url: string, context: UserLogin, fetchToken: FetchTokenCallback, userInteraction: BehaviorSubject<DXCUserInteraction | undefined>, hints?: {
     userId?: string;
     email?: string;

package/dist/types/authentication/interactWithUser.d.ts

@@ -6,6 +6,8 @@ export interface DXCUserInteractionRequest {
     type: DXCUserInteraction['type'];
     title: string;
     alerts: DXCAlert[];
+    submitLabel?: string;
+    cancelLabel?: string | null;
     fields: {
         [name: string]: DXCInputField;
     };
@@ -16,3 +18,4 @@ export declare function interactWithUser<T extends DXCUserInteractionRequest>(us
 export declare function alertUser(userInteraction: BehaviorSubject<DXCUserInteraction | undefined>, title: string, ...alerts: DXCAlert[]): Promise<{}>;
 export declare function promptForEmail(userInteraction: BehaviorSubject<DXCUserInteraction | undefined>, title: string, emailHint?: string): Promise<string>;
 export declare function promptForOTP(userInteraction: BehaviorSubject<DXCUserInteraction | undefined>, email: string, alert?: DXCAlert): Promise<string>;
+export declare function confirmLogout(userInteraction: BehaviorSubject<DXCUserInteraction | undefined>, currentUserId: string, numUnsyncedChanges: number): Promise<boolean>;

package/dist/types/authentication/logout.d.ts

@@ -0,0 +1,5 @@
+import { DexieCloudDB } from '../db/DexieCloudDB';
+export declare function logout(db: DexieCloudDB): Promise<void>;
+export declare function _logout(db: DexieCloudDB, { deleteUnsyncedData }?: {
+    deleteUnsyncedData?: boolean | undefined;
+}): Promise<number>;

package/dist/types/authentication/waitUntil.d.ts

@@ -0,0 +1,3 @@
+import { InteropObservable, Observable } from 'rxjs';
+export declare function waitUntil<T>(o: Observable<T> | InteropObservable<T>, // Works with Dexie's liveQuery observables if we'd need that
+predicate: (value: T) => boolean): Promise<T>;

package/dist/types/currentUserEmitter.d.ts

@@ -1,3 +1,3 @@
 import Dexie from "dexie";
 import { BehaviorSubject } from "rxjs";
-export declare const getCurrentUserEmitter: (x: Dexie) => BehaviorSubject<import("./db/entities/UserLogin").UserLogin>;
+export declare const getCurrentUserEmitter: (x: Dexie) => BehaviorSubject<import("./dexie-cloud-client").UserLogin>;

package/dist/types/db/entities/UserLogin.d.ts

@@ -5,6 +5,12 @@ export interface UserLogin {
     claims: {
         [claimName: string]: any;
     };
+    license?: {
+        type: 'demo' | 'eval' | 'prod' | 'client';
+        status: 'ok' | 'expired' | 'deactivated';
+        validUntil?: Date;
+        evalDaysLeft?: number;
+    };
     lastLogin: Date;
     accessToken?: string;
     accessTokenExpiration?: Date;

package/dist/types/default-ui/LoginDialog.d.ts

@@ -1,6 +1,3 @@
 import { h } from 'preact';
-import { DXCGenericUserInteraction } from '../types/DXCUserInteraction';
-import { DXCInputField } from '../types/DXCInputField';
-export declare function LoginDialog({ title, alerts, fields, onCancel, onSubmit, }: DXCGenericUserInteraction<string, {
-    [name: string]: DXCInputField;
-}>): h.JSX.Element;
+import { DXCUserInteraction } from '../types/DXCUserInteraction';
+export declare function LoginDialog({ title, type, alerts, fields, submitLabel, cancelLabel, onCancel, onSubmit, }: DXCUserInteraction): h.JSX.Element;

package/dist/types/dexie-cloud-client.d.ts

@@ -1,9 +1,11 @@
 import Dexie from 'dexie';
 import './extend-dexie-interface';
+import { UserLogin } from './db/entities/UserLogin';
 export { DexieCloudTable } from './DexieCloudTable';
 export * from './getTiedRealmId';
 export { DBRealm, DBRealmMember, DBRealmRole, DBSyncedObject, DBPermissionSet, } from 'dexie-cloud-common';
 export { Invite } from './Invite';
+export { UserLogin };
 export declare function dexieCloud(dexie: Dexie): void;
 export declare namespace dexieCloud {
     var version: string;

package/dist/types/helpers/resolveText.d.ts

@@ -1,2 +1,16 @@
 import { DXCAlert } from "../types/DXCAlert";
+/** Resolve a message template with parameters.
+ *
+ * Example:
+ *  resolveText({
+ *    message: "Hello {name}!",
+ *    messageCode: "HELLO",
+ *    messageParams: {name: "David"}
+ *  }) => "Hello David!"
+ *
+ * @param message Template message with {vars} in it.
+ * @param messageCode Unique code for the message. Can be used for translation.
+ * @param messageParams Parameters to be used in the message.
+ * @returns A final message where parameters have been replaced with values.
+ */
 export declare function resolveText({ message, messageCode, messageParams }: DXCAlert): string;

package/dist/types/isEagerSyncDisabled.d.ts

@@ -0,0 +1,2 @@
+import { DexieCloudDB } from './db/DexieCloudDB';
+export declare function isEagerSyncDisabled(db: DexieCloudDB): boolean;

package/dist/types/middlewares/createMutationTrackingMiddleware.d.ts

@@ -14,4 +14,4 @@ export interface MutationTrackingMiddlewareArgs {
  * changes to server and cleanup the tracked mutations once the server has
  * ackowledged that it got them.
  */
-export declare function createMutationTrackingMiddleware({ currentUserObservable, db }: MutationTrackingMiddlewareArgs): Middleware<DBCore>;
+export declare function createMutationTrackingMiddleware({ currentUserObservable, db, }: MutationTrackingMiddlewareArgs): Middleware<DBCore>;

package/dist/types/prodLog.d.ts

@@ -0,0 +1,9 @@
+/** A way to log to console in production without terser stripping out
+ * it from the release bundle.
+ * This should be used very rarely and only in places where it's
+ * absolutely necessary to log something in production.
+ *
+ * @param level
+ * @param args
+ */
+export declare function prodLog(level: 'log' | 'warn' | 'error' | 'debug', ...args: any[]): void;

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

@@ -1,4 +1,2 @@
-import { DexieCloudDB } from '../db/DexieCloudDB';
-export declare function performGuardedJob(db: DexieCloudDB, jobName: string, jobsTableName: string, job: () => Promise<any>, { awaitRemoteJob }?: {
-    awaitRemoteJob?: boolean;
-}): Promise<void>;
+import { DexieCloudDB } from "../db/DexieCloudDB";
+export declare function performGuardedJob<T>(db: DexieCloudDB, jobName: string, job: () => Promise<T>): Promise<T>;

package/dist/types/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/types/sync/sync.d.ts

@@ -2,7 +2,6 @@ import { DexieCloudDB } from '../db/DexieCloudDB';
 import { DexieCloudOptions } from '../DexieCloudOptions';
 import { DBOperationsSet, DexieCloudSchema } from 'dexie-cloud-common';
 export declare const CURRENT_SYNC_WORKER = "currentSyncWorker";
-export declare let numberOfSyncRequests: number;
 export interface SyncOptions {
     isInitialSync?: boolean;
     cancelToken?: {

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

@@ -9,7 +9,7 @@ export interface DXCErrorAlert {
 }
 export interface DXCWarningAlert {
     type: 'warning';
-    messageCode: 'GENERIC_WARNING';
+    messageCode: 'GENERIC_WARNING' | 'LOGOUT_CONFIRMATION';
     message: string;
     messageParams: {
         [paramName: string]: string;

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

@@ -1,6 +1,6 @@
 import { DXCAlert } from './DXCAlert';
 import { DXCInputField } from './DXCInputField';
-export type DXCUserInteraction = DXCGenericUserInteraction | DXCEmailPrompt | DXCOTPPrompt | DXCMessageAlert;
+export type DXCUserInteraction = DXCGenericUserInteraction | DXCEmailPrompt | DXCOTPPrompt | DXCMessageAlert | DXCLogoutConfirmation;
 export interface DXCGenericUserInteraction<Type extends string = "generic", TFields extends {
     [name: string]: DXCInputField;
 } = any> {
@@ -8,11 +8,16 @@ export interface DXCGenericUserInteraction<Type extends string = "generic", TFie
     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;
@@ -23,11 +28,18 @@ export interface DXCEmailPrompt {
             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;
@@ -38,16 +50,42 @@ export interface DXCOTPPrompt {
             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: {};
+    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;

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

@@ -5,4 +5,5 @@ export interface SyncState {
     phase: SyncStatePhase;
     progress?: number;
     error?: Error;
+    license?: 'ok' | 'expired' | 'deactivated';
 }