dexie-cloud-addon 4.2.4 → 4.2.5

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

@@ -1,25 +0,0 @@
-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

@@ -1,11 +0,0 @@
-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

@@ -1,93 +0,0 @@
-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

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

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

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

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

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

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

@@ -1,9 +0,0 @@
-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

@@ -1,11 +0,0 @@
-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

@@ -1,3 +0,0 @@
-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

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

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

package/dist/umd/verifySchema.d.ts

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

package/dist/umd/yjs/YDexieCloudSyncState.d.ts

@@ -1,3 +0,0 @@
-import type { YSyncState } from 'y-dexie';
-export interface YDexieCloudSyncState extends YSyncState {
-}

package/dist/umd/yjs/YTable.d.ts

@@ -1,3 +0,0 @@
-import { EntityTable } from "dexie";
-import type { YUpdateRow } from "y-dexie";
-export type YTable = EntityTable<YUpdateRow, "i">;

package/dist/umd/yjs/applyYMessages.d.ts

@@ -1,9 +0,0 @@
-import { DexieCloudDB } from '../db/DexieCloudDB';
-import { YServerMessage } from 'dexie-cloud-common';
-export declare function applyYServerMessages(yMessages: YServerMessage[], db: DexieCloudDB): Promise<{
-    receivedUntils: {
-        [yTable: string]: number;
-    };
-    resyncNeeded: boolean;
-    yServerRevision?: string;
-}>;

package/dist/umd/yjs/awareness.d.ts

@@ -1,3 +0,0 @@
-import type { Awareness } from 'y-protocols/awareness';
-export declare const awarenessWeakMap: WeakMap<any, Awareness>;
-export declare const getDocAwareness: (doc: any) => Awareness | undefined;

package/dist/umd/yjs/createYClientUpdateObservable.d.ts

@@ -1,4 +0,0 @@
-import { Observable } from 'rxjs';
-import { YClientMessage } from 'dexie-cloud-common';
-import { DexieCloudDB } from '../db/DexieCloudDB';
-export declare function createYClientUpdateObservable(db: DexieCloudDB): Observable<YClientMessage>;

package/dist/umd/yjs/createYHandler.d.ts

@@ -1,2 +0,0 @@
-import type { DexieCloudDB } from '../db/DexieCloudDB';
-export declare function createYHandler(db: DexieCloudDB): (provider: import("y-dexie").DexieYProvider) => void;

package/dist/umd/yjs/downloadYDocsFromServer.d.ts

@@ -1,3 +0,0 @@
-import { DexieCloudDB } from '../db/DexieCloudDB';
-import { PersistedSyncState } from '../db/entities/PersistedSyncState';
-export declare function downloadYDocsFromServer(db: DexieCloudDB, databaseUrl: string, { yDownloadedRealms, realms }: PersistedSyncState): Promise<void>;

package/dist/umd/yjs/getUpdatesTable.d.ts

@@ -1,3 +0,0 @@
-import { DexieCloudDB } from "../db/DexieCloudDB";
-import { YTable } from "./YTable";
-export declare function getUpdatesTable(db: DexieCloudDB, table: string, ydocProp: string): YTable | undefined;

package/dist/umd/yjs/listUpdatesSince.d.ts

@@ -1,3 +0,0 @@
-import type { Table } from 'dexie';
-import type { YUpdateRow } from 'y-dexie';
-export declare function listUpdatesSince(yTable: Table, sinceIncluding: number): Promise<YUpdateRow[]>;

package/dist/umd/yjs/listYClientMessagesAndStateVector.d.ts

@@ -1,26 +0,0 @@
-import type { Table } from 'dexie';
-import type { YClientMessage } from 'dexie-cloud-common';
-import { DexieCloudDB } from '../db/DexieCloudDB';
-import { EntityCommon } from '../db/entities/EntityCommon';
-/** Queries the local database for YMessages to send to server.
- *
- * There are 2 messages that this function can provide:
- *   YUpdateFromClientRequest ( for local updates )
- *   YStateVector ( for state vector of foreign updates so that server can reduce the number of udpates to send back )
- *
- * Notice that we do not do a step 1 sync phase here to get a state vector from the server. Reason we can avoid
- * the 2-step sync is that we are client-server and not client-client here and we keep track of the client changes
- * sent to server by letting server acknowledge them. There is always a chance that some client update has already
- * been sent and that the client failed to receive the ack. However, if this happens it does not matter - the change
- * would be sent again and Yjs handles duplicate changes anyway. And it's rare so we earn the cost of roundtrips by
- * avoiding the step1 sync and instead keep track of this in the `unsentFrom` property of the SyncState.
- *
- * @param db
- * @returns
- */
-export declare function listYClientMessagesAndStateVector(db: DexieCloudDB, tablesToSync: Table<EntityCommon>[]): Promise<{
-    yMessages: YClientMessage[];
-    lastUpdateIds: {
-        [yTable: string]: number;
-    };
-}>;

package/dist/umd/yjs/reopenDocSignal.d.ts

@@ -1,10 +0,0 @@
-import { Subject } from "rxjs";
-import type * as Y from "yjs";
-/** A property (package-private) on Y.Doc that is used
- * to signal that the server wants us to send a 'doc-open' message
- * to the server for this document.
- *
- * @param doc
- * @returns
- */
-export declare function getOpenDocSignal(doc: Y.Doc): Subject<void>;

package/dist/umd/yjs/updateYSyncStates.d.ts

@@ -1,6 +0,0 @@
-import { DexieCloudDB } from '../db/DexieCloudDB';
-export declare function updateYSyncStates(lastUpdateIdsBeforeSync: {
-    [yTable: string]: number;
-}, receivedUntilsAfterSync: {
-    [yTable: string]: number;
-}, db: DexieCloudDB): Promise<void>;