dexie-cloud-addon 1.0.0-beta.9 → 4.0.0-beta.12

package/dist/types/DexieCloudAPI.d.ts

@@ -0,0 +1,49 @@
+import { DexieCloudOptions } from './DexieCloudOptions';
+import { DexieCloudSchema } from 'dexie-cloud-common';
+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';
+export interface DexieCloudAPI {
+    version: string;
+    options: DexieCloudOptions | null;
+    schema: DexieCloudSchema | null;
+    serverState: DexieCloudServerState | null;
+    currentUserId: string;
+    currentUser: Rx.BehaviorSubject<UserLogin>;
+    webSocketStatus: Rx.BehaviorSubject<DXCWebSocketStatus>;
+    syncState: Rx.BehaviorSubject<SyncState>;
+    persistedSyncState: Rx.BehaviorSubject<PersistedSyncState | undefined>;
+    userInteraction: Rx.BehaviorSubject<DXCUserInteraction | undefined>;
+    invites: Rx.Observable<Invite[]>;
+    usingServiceWorker?: boolean;
+    /** Login using Dexie Cloud OTP or Demo user.
+     *
+     * @param email Email to authenticate
+     */
+    login(hint?: {
+        email?: string;
+        userId?: string;
+        grant_type?: 'demo' | 'otp';
+    }): Promise<void>;
+    /**
+     * Connect to given URL
+     */
+    configure(options: DexieCloudOptions): void;
+    /** Wait until a full sync is done.
+     *
+     */
+    sync(options?: DexieCloudSyncOptions): Promise<void>;
+    permissions<T extends {
+        owner: string;
+        realmId: string;
+        table: () => string;
+    }>(entity: T): Rx.Observable<PermissionChecker<T>>;
+    permissions<T>(obj: T, table: string): Rx.Observable<PermissionChecker<T, string>>;
+}

package/dist/types/DexieCloudOptions.d.ts

@@ -9,6 +9,7 @@ export interface DexieCloudOptions {
     customLoginGui?: boolean;
     unsyncedTables?: string[];
     periodicSync?: PeriodicSyncOptions;
+    nameSuffix?: boolean;
     fetchTokens?: (tokenParams: {
         public_key: string;
         hints?: {

package/dist/types/DexieCloudSyncOptions.d.ts

@@ -0,0 +1,4 @@
+export interface DexieCloudSyncOptions {
+    wait: boolean;
+    purpose: 'push' | 'pull';
+}

package/dist/types/DexieCloudTable.d.ts

@@ -0,0 +1,2 @@
+import { Table } from 'dexie';
+export declare type DexieCloudTable<T = any, TKey = string> = Table<T, TKey, 'realmId' | 'owner'>;

package/dist/types/Invite.d.ts

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

package/dist/types/PermissionChecker.d.ts

@@ -0,0 +1,15 @@
+import { KeyPaths } from 'dexie';
+import { DBPermissionSet } from 'dexie-cloud-common';
+declare type TableName<T> = T extends {
+    table: () => infer TABLE;
+} ? TABLE extends string ? TABLE : string : string;
+export declare class PermissionChecker<T, TableNames extends string = TableName<T>> {
+    private permissions;
+    private tableName;
+    private isOwner;
+    constructor(permissions: DBPermissionSet, tableName: TableNames, isOwner: boolean);
+    add(...tableNames: TableNames[]): boolean;
+    update(...props: KeyPaths<T>[]): boolean;
+    delete(): boolean;
+}
+export {};

package/dist/types/WSObservable.d.ts

@@ -4,15 +4,15 @@ import { DXCWebSocketStatus } from './DXCWebSocketStatus';
 export declare type WSClientToServerMsg = ReadyForChangesMessage;
 export interface ReadyForChangesMessage {
     type: 'ready';
-    rev: bigint;
+    rev: string;
 }
-export declare type WSConnectionMsg = RevisionChangedMessage | RealmAddedMessage | RealmRemovedMessage | ChangesFromServerMessage | TokenExpiredMessage;
+export declare type WSConnectionMsg = RevisionChangedMessage | RealmAddedMessage | RealmAcceptedMessage | RealmRemovedMessage | RealmsChangedMessage | ChangesFromServerMessage | TokenExpiredMessage;
 export interface ChangesFromServerMessage {
     type: 'changes';
-    baseRev: bigint;
+    baseRev: string;
     realmSetHash: string;
-    newRev: bigint;
-    changes: DBOperationsSet;
+    newRev: string;
+    changes: DBOperationsSet<string>;
 }
 export interface RevisionChangedMessage {
     type: 'rev';
@@ -22,15 +22,23 @@ export interface RealmAddedMessage {
     type: 'realm-added';
     realm: string;
 }
+export interface RealmAcceptedMessage {
+    type: 'realm-accepted';
+    realm: string;
+}
 export interface RealmRemovedMessage {
     type: 'realm-removed';
     realm: string;
 }
+export interface RealmsChangedMessage {
+    type: 'realms-changed';
+    realmsHash: string;
+}
 export interface TokenExpiredMessage {
     type: 'token-expired';
 }
 export declare class WSObservable extends Observable<WSConnectionMsg> {
-    constructor(databaseUrl: string, rev: string, clientIdentity: string, messageProducer: Observable<WSClientToServerMsg>, webSocketStatus: BehaviorSubject<DXCWebSocketStatus>, token?: string, tokenExpiration?: Date);
+    constructor(databaseUrl: string, rev: string, realmSetHash: string, clientIdentity: string, messageProducer: Observable<WSClientToServerMsg>, webSocketStatus: BehaviorSubject<DXCWebSocketStatus>, token?: string, tokenExpiration?: Date);
 }
 export declare class WSConnection extends Subscription {
     ws: WebSocket | null;
@@ -39,6 +47,7 @@ export declare class WSConnection extends Subscription {
     lastPing: Date;
     databaseUrl: string;
     rev: string;
+    realmSetHash: string;
     clientIdentity: string;
     token: string | undefined;
     tokenExpiration: Date | undefined;
@@ -49,7 +58,7 @@ export declare class WSConnection extends Subscription {
     id: number;
     private pinger;
     private messageProducerSubscription;
-    constructor(databaseUrl: string, rev: string, clientIdentity: string, token: string | undefined, tokenExpiration: Date | undefined, subscriber: Subscriber<WSConnectionMsg>, messageProducer: Observable<WSClientToServerMsg>, webSocketStatus: BehaviorSubject<DXCWebSocketStatus>);
+    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;
     reconnect(): void;

package/dist/types/associate.d.ts

@@ -0,0 +1 @@
+export declare function associate<T extends object, M>(factory: (x: T) => M): (x: T) => M;

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

@@ -1,5 +1,5 @@
-import { DexieCloudDB } from "../db/DexieCloudDB";
-import { AuthPersistedContext } from "./AuthPersistedContext";
+import { DexieCloudDB } from '../db/DexieCloudDB';
+import { AuthPersistedContext } from './AuthPersistedContext';
 /** This function changes or sets the current user as requested.
  *
  * Use cases:

package/dist/types/createSharedValueObservable.d.ts

@@ -0,0 +1,3 @@
+import { ObservableInput } from 'rxjs';
+import { ObservableWithCurrentValue } from './mapValueObservable';
+export declare function createSharedValueObservable<T>(o: ObservableInput<T>, defaultValue: T): ObservableWithCurrentValue<T>;

package/dist/types/currentUserEmitter.d.ts

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

package/dist/types/db/DexieCloudDB.d.ts

@@ -46,9 +46,9 @@ export interface DexieCloudDB extends DexieCloudDBBase {
     messageConsumer: MessagesFromServerConsumer;
 }
 export declare const DEXIE_CLOUD_SCHEMA: {
-    realms: string;
     members: string;
     roles: string;
+    realms: string;
     $jobs: string;
     $syncState: string;
     $baseRevs: string;

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

@@ -1,4 +1,5 @@
 export interface EntityCommon {
     realmId?: string;
     owner?: string;
+    $ts?: string;
 }

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

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

package/dist/types/extend-dexie-interface.d.ts

@@ -1,54 +1,16 @@
-import { Table } from 'dexie';
-import { DexieCloudOptions } from './DexieCloudOptions';
-import { DBRealm, DBRealmMember, DBRealmRole, DexieCloudSchema } from 'dexie-cloud-common';
-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 { EntityCommon } from './db/entities/EntityCommon';
-import { DXCUserInteraction } from './types/DXCUserInteraction';
-import { DXCWebSocketStatus } from './DXCWebSocketStatus';
-export interface DexieCloudSyncOptions {
-    wait: boolean;
-    purpose: "push" | "pull";
-}
-export declare type DexieCloudTable<T = any> = Table<T & EntityCommon, string>;
+import { DBRealm, DBRealmMember, DBRealmRole } from 'dexie-cloud-common';
+import { DexieCloudAPI } from './DexieCloudAPI';
+import { NewIdOptions } from './types/NewIdOptions';
 declare module 'dexie' {
     interface Dexie {
-        cloud: {
-            version: string;
-            options: DexieCloudOptions | null;
-            schema: DexieCloudSchema | null;
-            serverState: DexieCloudServerState | null;
-            currentUserId: string;
-            currentUser: Rx.BehaviorSubject<UserLogin>;
-            webSocketStatus: Rx.BehaviorSubject<DXCWebSocketStatus>;
-            syncState: Rx.BehaviorSubject<SyncState>;
-            persistedSyncState: Rx.BehaviorSubject<PersistedSyncState | undefined>;
-            userInteraction: Rx.BehaviorSubject<DXCUserInteraction | undefined>;
-            usingServiceWorker?: boolean;
-            /** Login using Dexie Cloud OTP or Demo user.
-             *
-             * @param email Email to authenticate
-             */
-            login(hint?: {
-                email?: string;
-                userId?: string;
-                grant_type?: 'demo' | 'otp';
-            }): Promise<void>;
-            /**
-             * Connect to given URL
-             */
-            configure(options: DexieCloudOptions): void;
-            /** Wait until a full sync is done.
-             *
-             */
-            sync(options?: DexieCloudSyncOptions): Promise<void>;
-        };
-        realms: Table<Partial<DBRealm>, string>;
-        members: Table<Partial<DBRealmMember>, string>;
-        roles: Table<DBRealmRole, [string, string]>;
+        cloud: DexieCloudAPI;
+        realms: Table<DBRealm, 'realmId', 'owner'>;
+        members: Table<DBRealmMember, 'id', 'realmId' | 'owner'>;
+        roles: Table<DBRealmRole, [string, string], 'owner'>;
+    }
+    interface Table {
+        newId(options: NewIdOptions): string;
+        idPrefix(): string;
     }
     interface DexieConstructor {
         Cloud: {

package/dist/types/getInternalAccessControlObservable.d.ts

@@ -0,0 +1,12 @@
+import Dexie from 'dexie';
+import { DBRealm, DBRealmMember } from 'dexie-cloud-common';
+export declare type InternalAccessControlData = {
+    readonly selfMembers: DBRealmMember[];
+    readonly realms: DBRealm[];
+    readonly userId: string;
+};
+export declare const getInternalAccessControlObservable: (x: Dexie) => import("./mapValueObservable").ObservableWithCurrentValue<{
+    selfMembers: DBRealmMember[];
+    realms: DBRealm[];
+    userId: string;
+}>;

package/dist/types/getInvitesObservable.d.ts

@@ -0,0 +1,25 @@
+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 | undefined;
+    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;
+})[]>;

package/dist/types/getPermissionsLookupObservable.d.ts

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

package/dist/types/getTiedRealmId.d.ts

@@ -0,0 +1,2 @@
+export declare function getTiedRealmId(objectId: string): string;
+export declare function getTiedObjectId(realmId: string): string | null;

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

@@ -0,0 +1 @@
+export declare function flatten<T>(a: (T | T[])[]): T[];

package/dist/types/mapValueObservable.d.ts

@@ -0,0 +1,5 @@
+import { Observable } from 'rxjs';
+export interface ObservableWithCurrentValue<T> extends Observable<T> {
+    getValue(): T;
+}
+export declare function mapValueObservable<T, R>(o: ObservableWithCurrentValue<T>, mapper: (x: T) => R): ObservableWithCurrentValue<R>;

package/dist/types/mergePermissions.d.ts

@@ -0,0 +1,2 @@
+import { DBPermissionSet } from 'dexie-cloud-common';
+export declare function mergePermissions(...permissions: DBPermissionSet[]): DBPermissionSet;

package/dist/types/middleware-helpers/idGenerationHelpers.d.ts

@@ -0,0 +1,18 @@
+import { DBCoreAddRequest, DBCoreDeleteRequest, DBCoreIndex, DBCorePutRequest } from 'dexie';
+export declare function toStringTag(o: Object): any;
+export declare function getEffectiveKeys(primaryKey: DBCoreIndex, req: (Pick<DBCoreAddRequest | DBCorePutRequest, 'type' | 'values'> & {
+    keys?: any[];
+}) | Pick<DBCoreDeleteRequest, 'keys' | 'type'>): any[];
+export declare function generateTablePrefix(tableName: string, allPrefixes: Set<string>): string;
+/**
+ *
+ * @param prefix A unique 3-letter short-name of the table.
+ * @param shardKey 3 last letters from another ID if colocation is requested. Verified on server on inserts - guarantees unique IDs across shards.
+ *  The shardKey part of the key represent the shardId where it was first created. An object with this
+ *  primary key can later on be moved to another shard without being altered. The reason for having
+ *  the origin shardKey as part of the key, is that the server will not need to check uniqueness constraint
+ *  across all shards on every insert. Updates / moves across shards are already controlled by the server
+ *  in the sense that the objects needs to be there already - we only need this part for inserts.
+ * @returns
+ */
+export declare function generateKey(prefix: string, shardKey?: string): string;

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

@@ -1,8 +1,3 @@
-import { DBCore, DBCoreAddRequest, DBCoreDeleteRequest, DBCoreIndex, DBCorePutRequest, Middleware } from 'dexie';
+import { DBCore, Middleware } from 'dexie';
 import { DexieCloudDB } from '../db/DexieCloudDB';
-export declare function toStringTag(o: Object): any;
-export declare function getEffectiveKeys(primaryKey: DBCoreIndex, req: (Pick<DBCoreAddRequest | DBCorePutRequest, 'type' | 'values'> & {
-    keys?: any[];
-}) | Pick<DBCoreDeleteRequest, 'keys' | 'type'>): any[];
-export declare function generateTablePrefix(tableName: string, allPrefixes: Set<string>): string;
 export declare function createIdGenerationMiddleware(db: DexieCloudDB): Middleware<DBCore>;

package/dist/types/permissions.d.ts

@@ -0,0 +1,9 @@
+import Dexie from 'dexie';
+import { Observable } from 'rxjs';
+import { PermissionChecker } from './PermissionChecker';
+import './extend-dexie-interface';
+export declare function permissions(dexie: Dexie, obj: {
+    owner?: string;
+    realmId?: string;
+    table?: () => string;
+}, tableName?: string): Observable<PermissionChecker<any>>;

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

@@ -0,0 +1,3 @@
+import { DexieCloudDB } from '../db/DexieCloudDB';
+import { DBOperationsSet } from 'dexie-cloud-common';
+export declare function applyServerChanges(changes: DBOperationsSet<string>, db: DexieCloudDB): Promise<void>;

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

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

@@ -1,3 +1,3 @@
 import { DexieCloudDB } from "../db/DexieCloudDB";
 import { PersistedSyncState } from "../db/entities/PersistedSyncState";
-export declare function getTablesToSyncify(db: DexieCloudDB, syncState: PersistedSyncState | undefined): import("dexie").Table<import("../db/entities/EntityCommon").EntityCommon, import("dexie").IndexableType>[];
+export declare function getTablesToSyncify(db: DexieCloudDB, syncState: PersistedSyncState | undefined): import("dexie").Table<import("../db/entities/EntityCommon").EntityCommon, import("dexie").IndexableType, void>[];

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

@@ -1,6 +1,6 @@
-import { Table } from "dexie";
-import { DexieCloudDB } from "../db/DexieCloudDB";
-import { DBOperationsSet } from "dexie-cloud-common";
+import { Table } from 'dexie';
+import { DexieCloudDB } from '../db/DexieCloudDB';
+import { DBOperationsSet } from 'dexie-cloud-common';
 export declare function listClientChanges(mutationTables: Table[], db: DexieCloudDB, { since, limit }?: {
     since?: {
         [table: string]: number;

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

@@ -1,5 +1,5 @@
-import { UserLogin } from "../db/entities/UserLogin";
-import { EntityCommon } from "../db/entities/EntityCommon";
-import { Table } from "dexie";
-import { DBOperationsSet, DexieCloudSchema } from "dexie-cloud-common";
+import { UserLogin } from '../db/entities/UserLogin';
+import { EntityCommon } from '../db/entities/EntityCommon';
+import { Table } from 'dexie';
+import { DBOperationsSet, DexieCloudSchema } from 'dexie-cloud-common';
 export declare function listSyncifiedChanges(tablesToSyncify: Table<EntityCommon>[], currentUser: UserLogin, schema: DexieCloudSchema, alreadySyncedRealms?: string[]): Promise<DBOperationsSet>;

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

@@ -13,5 +13,4 @@ export interface SyncOptions {
     purpose?: 'pull' | 'push';
 }
 export declare function sync(db: DexieCloudDB, options: DexieCloudOptions, schema: DexieCloudSchema, syncOptions?: SyncOptions): Promise<boolean>;
-export declare function applyServerChanges(changes: DBOperationsSet, db: DexieCloudDB): Promise<void>;
-export declare function filterServerChangesThroughAddedClientChanges(serverChanges: DBOperationsSet, addedClientChanges: DBOperationsSet): DBOperationsSet;
+export declare function filterServerChangesThroughAddedClientChanges(serverChanges: DBOperationsSet<string>, addedClientChanges: DBOperationsSet): DBOperationsSet<string>;

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

@@ -2,4 +2,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>;
+import { UserLogin } from '../db/entities/UserLogin';
+export declare function syncWithServer(changes: DBOperationsSet, syncState: PersistedSyncState | undefined, baseRevs: BaseRevisionMapEntry[], db: DexieCloudDB, databaseUrl: string, schema: DexieCloudSchema | null, clientIdentity: string, currentUser: UserLogin): Promise<SyncResponse>;

package/dist/types/types/NewIdOptions.d.ts

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