dexie-cloud-addon 1.0.0-alpha.6 → 1.0.0-beta.11

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

@@ -0,0 +1,3 @@
+import { DexieCloudDB } from '../db/DexieCloudDB';
+import { ChangesFromServerMessage } from '../WSObservable';
+export declare function syncServerToClientOnly(db: DexieCloudDB, { baseRev, newRev, changes, realmSetHash }: ChangesFromServerMessage): import("rxjs").Observable<void>;

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

@@ -0,0 +1,5 @@
+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';
+export declare function syncWithServer(changes: DBOperationsSet, syncState: PersistedSyncState | undefined, baseRevs: BaseRevisionMapEntry[], db: DexieCloudDB, databaseUrl: string, schema: DexieCloudSchema | null, clientIdentity: string): Promise<SyncResponse>;

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

@@ -0,0 +1,25 @@
+export declare 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';
+    message: string;
+    messageParams: {
+        [paramName: string]: string;
+    };
+}
+export interface DXCInfoAlert {
+    type: 'info';
+    messageCode: 'GENERIC_INFO' | 'OTP_SENT';
+    message: string;
+    messageParams: {
+        [paramName: string]: string;
+    };
+}

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

@@ -0,0 +1,11 @@
+export declare 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/types/types/DXCUserInteraction.d.ts

@@ -0,0 +1,55 @@
+import { DXCAlert } from './DXCAlert';
+import { DXCInputField } from './DXCInputField';
+export declare type DXCUserInteraction = DXCGenericUserInteraction | DXCEmailPrompt | DXCOTPPrompt | DXCMessageAlert;
+export interface DXCGenericUserInteraction<Type extends string = "generic", TFields extends {
+    [name: string]: DXCInputField;
+} = any> {
+    type: Type;
+    title: string;
+    alerts: DXCAlert[];
+    fields: TFields;
+    onSubmit: (params: {
+        [P in keyof TFields]: string;
+    }) => void;
+    onCancel: () => void;
+}
+export interface DXCEmailPrompt {
+    type: 'email';
+    title: string;
+    alerts: DXCAlert[];
+    fields: {
+        email: {
+            type: 'text';
+            placeholder: string;
+        };
+    };
+    onSubmit: (params: {
+        email: string;
+    }) => void;
+    onCancel: () => void;
+}
+export interface DXCOTPPrompt {
+    type: 'otp';
+    title: string;
+    alerts: DXCAlert[];
+    fields: {
+        otp: {
+            type: 'text';
+            label: string;
+        };
+    };
+    onSubmit: (params: {
+        otp: string;
+    }) => void;
+    onCancel: () => void;
+}
+export interface DXCMessageAlert {
+    type: 'message-alert';
+    title: string;
+    alerts: DXCAlert[];
+    fields: {};
+    onSubmit: (params: {
+        [paramName: string]: string;
+    }) => void;
+    onCancel: () => void;
+}

package/dist/types/types/LoginState.d.ts

@@ -0,0 +1,41 @@
+export declare type LoginState = LoginStateSilent | LoginStateInteraction | LoginStateError;
+export interface LoginStateSilent {
+    type: 'silent';
+}
+export declare type LoginStateInteraction = (Alert | EmailRequested | OTPRequested) & {
+    type: 'interaction';
+    alerts?: {
+        type: 'error' | 'warning' | 'info';
+        message: string;
+    }[];
+    isWorking?: boolean;
+    onSubmit: (params: LoginPromptReply) => void;
+    onCancel: () => void;
+};
+export declare type LoginPromptReply = {
+    email?: string;
+    otp?: string;
+    name?: string;
+};
+export interface LoginStateError {
+    type: 'error';
+    message: string;
+}
+interface Alert {
+    interactionType: 'alert';
+    alerts: {
+        type: 'error' | 'warning' | 'info';
+        message: string;
+    }[];
+    submitText: 'OK';
+}
+interface EmailRequested {
+    interactionType: 'emailRequested';
+    submitText: 'Send OTP';
+}
+interface OTPRequested {
+    interactionType: 'otpRequested';
+    isWorking: boolean;
+    submitText: 'Login';
+}
+export {};

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

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

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

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

package/dist/types/types/SyncConnectionStatus.d.ts

@@ -0,0 +1 @@
+export declare type SyncConnectionStatus = "not-started" | "connecting" | "connected" | "disconnected" | "error" | "offline";

package/dist/types/types/SyncFlowStatus.d.ts

@@ -0,0 +1,6 @@
+export declare type SyncPhase = "initial" | "not-in-sync" | "pushing" | "pulling" | "in-sync" | 'error' | 'offline';
+export interface SyncFlowStatus {
+    phase: SyncPhase;
+    progress?: number;
+    error?: Error;
+}

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

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

package/dist/types/types/SyncStatus.d.ts

@@ -0,0 +1,6 @@
+export declare type SyncPhase = "initial" | "not-in-sync" | "pushing" | "pulling" | "in-sync" | 'error' | 'offline';
+export interface SyncStatus {
+    phase: SyncPhase;
+    progress?: number;
+    error?: Error;
+}

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

@@ -0,0 +1,10 @@
+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;
+}

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

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

package/dist/types/verifySchema.d.ts

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