dexie-cloud-addon 4.0.0-beta.18 → 4.0.0-beta.21

package/dist/types/DexieCloudAPI.d.ts

@@ -4,17 +4,17 @@ import { UserLogin } from './db/entities/UserLogin';
 import * as Rx from 'rxjs';
 import { PersistedSyncState } from './db/entities/PersistedSyncState';
 import { SyncState } from './types/SyncState';
-import { DexieCloudServerState } from './DexieCloudServerState';
 import { DXCUserInteraction } from './types/DXCUserInteraction';
 import { DXCWebSocketStatus } from './DXCWebSocketStatus';
 import { PermissionChecker } from './PermissionChecker';
 import { DexieCloudSyncOptions } from "./DexieCloudSyncOptions";
 import { Invite } from './Invite';
+/** The API of db.cloud, where `db` is an instance of Dexie with dexie-cloud-addon active.
+ */
 export interface DexieCloudAPI {
     version: string;
     options: DexieCloudOptions | null;
     schema: DexieCloudSchema | null;
-    serverState: DexieCloudServerState | null;
     currentUserId: string;
     currentUser: Rx.BehaviorSubject<UserLogin>;
     webSocketStatus: Rx.BehaviorSubject<DXCWebSocketStatus>;
@@ -26,9 +26,12 @@ export interface DexieCloudAPI {
         [roleName: string]: DBRealmRole;
     }>;
     usingServiceWorker?: boolean;
+    isServiceWorkerDB?: boolean;
     /** Login using Dexie Cloud OTP or Demo user.
      *
      * @param email Email to authenticate
+     * @param userId Optional userId to authenticate
+     * @param grant_type requested grant type
      */
     login(hint?: {
         email?: string;
@@ -39,14 +42,25 @@ export interface DexieCloudAPI {
      * Connect to given URL
      */
     configure(options: DexieCloudOptions): void;
-    /** Wait until a full sync is done.
+    /** Trigger a sync
      *
      */
     sync(options?: DexieCloudSyncOptions): Promise<void>;
+    /** Method that returns an observable of the available permissions of given
+     * entity.
+     *
+     * @param entity Entity to check permission for
+     */
     permissions<T extends {
         owner: string;
         realmId: string;
         table: () => string;
     }>(entity: T): Rx.Observable<PermissionChecker<T>>;
+    /** Method that returns an observable of the available permissions of given
+     * object and table name.
+     *
+     * @param obj Object retrieved from a dexie query
+     * @param table Table name that the object was retrieved from
+     */
     permissions<T>(obj: T, table: string): Rx.Observable<PermissionChecker<T, string>>;
 }

package/dist/types/DexieCloudEntity.d.ts

@@ -0,0 +1,8 @@
+import Dexie, { Entity, IndexableType, OwnClonableProperties, TableProp } from 'dexie';
+export declare class DexieCloudEntity<DexieSubClass extends Dexie = Dexie> extends Entity<DexieSubClass> {
+    realmId: string;
+    owner: string;
+    can(...args: [verb: 'add', table: TableProp<DexieSubClass> | string] | [verb: 'update', ...fields: (keyof OwnClonableProperties<this>)[]] | [verb: 'delete']): boolean;
+    $id(): IndexableType;
+    isRealm(): boolean;
+}

package/dist/types/DexieCloudOptions.d.ts

@@ -6,10 +6,11 @@ export interface DexieCloudOptions {
     databaseUrl: string;
     requireAuth?: boolean;
     tryUseServiceWorker?: boolean;
+    periodicSync?: PeriodicSyncOptions;
     customLoginGui?: boolean;
     unsyncedTables?: string[];
-    periodicSync?: PeriodicSyncOptions;
     nameSuffix?: boolean;
+    disableWebSocket?: boolean;
     fetchTokens?: (tokenParams: {
         public_key: string;
         hints?: {

package/dist/types/Invite.d.ts

@@ -3,4 +3,6 @@ export interface Invite extends DBRealmMember {
     realm?: DBRealm & {
         permissions: DBPermissionSet;
     };
+    accept(): Promise<void>;
+    reject(): Promise<void>;
 }

package/dist/types/WebSocketStatus.d.ts

@@ -0,0 +1 @@
+export declare type WebSocketStatus = "not-started" | "connecting" | "connected" | "error" | "asleep";

package/dist/types/createMyMembersObservable.d.ts

@@ -0,0 +1,14 @@
+import Dexie from 'dexie';
+import { DBPermissionSet, DBRealm, DBRealmMember } from 'dexie-cloud-common';
+import { Observable } from 'rxjs';
+import { UserLogin } from './db/entities/UserLogin';
+export declare function createMyMembersObservable(db: Dexie, currentUserObservable: Observable<UserLogin>): Observable<{
+    invites: Array<DBRealmMember & {
+        realm: DBRealm;
+    }>;
+    permissions: {
+        [realmId: string]: DBRealm & {
+            permissions: DBPermissionSet;
+        };
+    };
+}>;

package/dist/types/currentUserObservable.d.ts

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

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

@@ -1,4 +1,3 @@
-import { DXCUserInteraction } from "../../types/DXCUserInteraction";
 export interface UserLogin {
     userId?: string;
     name?: string;
@@ -14,5 +13,4 @@ export interface UserLogin {
     nonExportablePrivateKey?: CryptoKey;
     publicKey?: CryptoKey;
     isLoggedIn?: boolean;
-    interaction?: DXCUserInteraction;
 }

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

@@ -1,4 +1,5 @@
 import { ComponentChildren, h } from 'preact';
-export declare function Dialog({ children }: {
+export declare function Dialog({ children, className }: {
     children?: ComponentChildren;
+    className?: string;
 }): h.JSX.Element;

package/dist/types/getInvitesObservable.d.ts

@@ -1,25 +1,3 @@
 import { Dexie } from 'dexie';
 import { Invite } from './Invite';
-export declare const getInvitesObservable: (x: Dexie) => import("./mapValueObservable").ObservableWithCurrentValue<(Invite | {
-    realm: import("dexie-cloud-common").DBRealm & {
-        permissions: import("dexie-cloud-common").DBPermissionSet;
-    };
-    id: string;
-    userId?: string | undefined;
-    email?: string | undefined;
-    name?: string | undefined;
-    invite?: boolean | undefined;
-    invitedDate?: Date | undefined;
-    invitedBy?: {
-        name: string;
-        email: string;
-        userId: string;
-    } | undefined;
-    accepted?: Date | undefined;
-    rejected?: Date | undefined;
-    roles?: string[] | undefined;
-    permissions?: import("dexie-cloud-common").DBPermissionSet | undefined;
-    realmId: string;
-    owner: string;
-    $ts?: number | undefined;
-})[]>;
+export declare const getInvitesObservable: (x: Dexie) => import("./mapValueObservable").ObservableWithCurrentValue<Invite[]>;

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

@@ -0,0 +1,8 @@
+import { Observable } from "rxjs";
+import { SWBroadcastChannel } from "./SWBroadcastChannel";
+export declare class BroadcastedAndLocalEvent<T> extends Observable<T> {
+    name: string;
+    bc: BroadcastChannel | SWBroadcastChannel;
+    constructor(name: string);
+    next(message: T): void;
+}

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

@@ -0,0 +1 @@
+export declare function getVisibilityStateObservable(): import("rxjs").Observable<VisibilityState>;

package/dist/types/permissionsLookup.d.ts

@@ -0,0 +1,9 @@
+import Dexie from 'dexie';
+import { DBPermissionSet, DBRealm } from 'dexie-cloud-common';
+import { Observable } from 'rxjs';
+export declare type PermissionsLookupObservable = Observable<{
+    [realmId: string]: DBRealm & {
+        permissions: DBPermissionSet;
+    };
+}>;
+export declare const getPermissionsLookupObservable: (x: Dexie) => PermissionsLookupObservable;

package/dist/types/permissionsLookupObservable.d.ts

@@ -0,0 +1,14 @@
+import Dexie from 'dexie';
+import { DBPermissionSet, DBRealm, DBRealmMember } from 'dexie-cloud-common';
+import { Observable } from 'rxjs';
+import { UserLogin } from './db/entities/UserLogin';
+export declare function createMyMembersObservable(db: Dexie, currentUserObservable: Observable<UserLogin>): Observable<{
+    invites: Array<DBRealmMember & {
+        realm: DBRealm;
+    }>;
+    permissions: {
+        [realmId: string]: DBRealm & {
+            permissions: DBPermissionSet;
+        };
+    };
+}>;

package/dist/types/sync/globalizePrivateIds.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 encodePrimaryKeys(schema: DBCoreSchema, currentUser: UserLogin, changes: DBOperationsSet): DBOperationsSet;

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/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/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/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;
+}