dexie-cloud-addon 4.0.0-beta.13 → 4.0.0-beta.16

package/dist/types/DexieCloudAPI.d.ts

@@ -1,5 +1,5 @@
 import { DexieCloudOptions } from './DexieCloudOptions';
-import { DexieCloudSchema } from 'dexie-cloud-common';
+import { DBRealmRole, DexieCloudSchema } from 'dexie-cloud-common';
 import { UserLogin } from './db/entities/UserLogin';
 import * as Rx from 'rxjs';
 import { PersistedSyncState } from './db/entities/PersistedSyncState';
@@ -22,6 +22,9 @@ export interface DexieCloudAPI {
     persistedSyncState: Rx.BehaviorSubject<PersistedSyncState | undefined>;
     userInteraction: Rx.BehaviorSubject<DXCUserInteraction | undefined>;
     invites: Rx.Observable<Invite[]>;
+    roles: Rx.Observable<{
+        [roleName: string]: DBRealmRole;
+    }>;
     usingServiceWorker?: boolean;
     /** Login using Dexie Cloud OTP or Demo user.
      *

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/Invite.d.ts

@@ -1,4 +1,4 @@
-import { DBPermissionSet, DBRealm, DBRealmMember } from "dexie-cloud-common";
+import { DBPermissionSet, DBRealm, DBRealmMember } from 'dexie-cloud-common';
 export interface Invite extends DBRealmMember {
     realm?: DBRealm & {
         permissions: DBPermissionSet;

package/dist/types/WSObservable.d.ts

@@ -61,6 +61,7 @@ export declare class WSConnection extends Subscription {
     constructor(databaseUrl: string, rev: string, realmSetHash: string, clientIdentity: string, token: string | undefined, tokenExpiration: Date | undefined, subscriber: Subscriber<WSConnectionMsg>, messageProducer: Observable<WSClientToServerMsg>, webSocketStatus: BehaviorSubject<DXCWebSocketStatus>);
     private teardown;
     private disconnect;
+    reconnecting: boolean;
     reconnect(): void;
     connect(): 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/dexie-cloud-client.d.ts

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

package/dist/types/getGlobalRolesObservable.d.ts

@@ -0,0 +1,5 @@
+import Dexie from 'dexie';
+import { DBRealmRole } from 'dexie-cloud-common';
+export declare const getGlobalRolesObservable: (x: Dexie) => import("./mapValueObservable").ObservableWithCurrentValue<{
+    [roleName: string]: DBRealmRole;
+}>;

package/dist/types/getInvitesObservable.d.ts

@@ -4,7 +4,7 @@ export declare const getInvitesObservable: (x: Dexie) => import("./mapValueObser
     realm: import("dexie-cloud-common").DBRealm & {
         permissions: import("dexie-cloud-common").DBPermissionSet;
     };
-    id?: string | undefined;
+    id: string;
     userId?: string | undefined;
     email?: string | undefined;
     name?: string | undefined;

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