document-drive 1.0.0-alpha.93 → 1.0.0-alpha.95

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "document-drive",
-    "version": "1.0.0-alpha.93",
+    "version": "1.0.0-alpha.95",
     "license": "AGPL-3.0-only",
     "type": "module",
     "module": "./src/index.ts",

package/src/read-mode/index.ts

@@ -1,4 +1,3 @@
-import { ListenerFilter } from 'document-model-libs/document-drive';
 import { Document } from 'document-model/document';
 import { DocumentDriveServerConstructor, RemoteDriveOptions } from '../server';
 import { logger } from '../utils/logger';
@@ -8,6 +7,7 @@ import {
     IReadModeDriveServer,
     IReadModeDriveService,
     ReadDrive,
+    ReadDriveOptions,
     ReadDrivesListener,
     ReadModeDriveServerMixin
 } from './types';
@@ -72,8 +72,8 @@ export function ReadModeServer<TBase extends DocumentDriveServerConstructor>(
             return this.#readModeStorage.getReadDriveContext(id);
         }
 
-        async addReadDrive(url: string, filter?: ListenerFilter) {
-            await this.#readModeStorage.addReadDrive(url, filter);
+        async addReadDrive(url: string, options?: ReadDriveOptions) {
+            await this.#readModeStorage.addReadDrive(url, options);
             this.#notifyListeners(await this.#buildDrives(), 'add');
         }
 
@@ -108,13 +108,14 @@ export function ReadModeServer<TBase extends DocumentDriveServerConstructor>(
                 return result;
             }
 
+            const { url, ...readOptions } = result;
             try {
-                const newDrive = await this.addRemoteDrive(result.url, options);
+                const newDrive = await this.addRemoteDrive(url, options);
                 return newDrive;
             } catch (error) {
                 // if an error is thrown, then add the read drive again
                 logger.error(error);
-                await this.addReadDrive(result.url, result.filter);
+                await this.addReadDrive(result.url, readOptions);
                 throw error;
             }
         }

package/src/read-mode/service.ts

@@ -1,7 +1,4 @@
-import type {
-    DocumentDriveDocument,
-    ListenerFilter
-} from 'document-model-libs/document-drive';
+import type { DocumentDriveDocument } from 'document-model-libs/document-drive';
 import * as DocumentDrive from 'document-model-libs/document-drive';
 import { Document, DocumentModel } from 'document-model/document';
 import { GraphQLError } from 'graphql';
@@ -20,7 +17,8 @@ import {
     InferDocumentState,
     IReadModeDriveService,
     ReadDrive,
-    ReadDriveContext
+    ReadDriveContext,
+    ReadDriveOptions
 } from './types';
 
 export class ReadModeService implements IReadModeDriveService {
@@ -148,8 +146,9 @@ export class ReadModeService implements IReadModeDriveService {
         return document;
     }
 
-    async addReadDrive(url: string, filter?: ListenerFilter): Promise<void> {
-        const { id } = await requestPublicDrive(url);
+    async addReadDrive(url: string, options?: ReadDriveOptions): Promise<void> {
+        const { id } =
+            options?.expectedDriveInfo ?? (await requestPublicDrive(url));
 
         const result = await this.#fetchDrive(id, url);
         if (result instanceof Error) {
@@ -160,13 +159,8 @@ export class ReadModeService implements IReadModeDriveService {
         this.#drives.set(id, {
             drive: result as unknown as ReadDrive,
             context: {
-                url,
-                filter: filter ?? {
-                    documentId: ['*'],
-                    documentType: ['*'],
-                    branch: ['*'],
-                    scope: ['*']
-                }
+                ...options,
+                url
             }
         });
     }

package/src/read-mode/types.ts

@@ -5,6 +5,7 @@ import {
 import { Action, Document, DocumentModel } from 'document-model/document';
 import { DocumentDriveServerMixin, RemoteDriveOptions } from '../server';
 import { DocumentModelNotFoundError } from '../server/error';
+import { DriveInfo } from '../utils/graphql';
 import {
     ReadDocumentNotFoundError,
     ReadDriveNotFoundError,
@@ -47,10 +48,14 @@ export interface IReadModeDriveServer extends IReadModeDriveService {
     ): Promise<ReadDrivesListenerUnsubscribe>; // TODO: make DriveEvents extensible and reuse event emitter
 }
 
+export type ReadDriveOptions = {
+    expectedDriveInfo?: DriveInfo;
+    filter?: ListenerFilter;
+};
+
 export type ReadDriveContext = {
     url: string;
-    filter: ListenerFilter;
-};
+} & ReadDriveOptions;
 
 export type ReadDrive = DocumentDriveDocument & {
     readContext: ReadDriveContext;
@@ -62,7 +67,7 @@ export type IsDocument<D extends Document> =
         : false;
 
 export interface IReadModeDriveService {
-    addReadDrive(url: string, filter?: ListenerFilter): Promise<void>;
+    addReadDrive(url: string, options?: ReadDriveOptions): Promise<void>;
 
     getReadDrives(): Promise<string[]>;
 

package/src/storage/browser.ts

@@ -6,6 +6,7 @@ import {
     Operation,
     OperationScope
 } from 'document-model/document';
+import LocalForage from 'localforage';
 import { DriveNotFoundError } from '../server/error';
 import { SynchronizationUnitQuery } from '../server/types';
 import { mergeOperations } from '../utils';
@@ -20,8 +21,8 @@ export class BrowserStorage implements IDriveStorage {
     static DRIVES_KEY = 'DRIVES';
 
     constructor(namespace?: string) {
-        this.db = import('localforage').then(localForage =>
-            localForage.default.createInstance({
+        this.db = LocalForage.ready().then(() =>
+            LocalForage.createInstance({
                 name: namespace
                     ? `${namespace}:${BrowserStorage.DBName}`
                     : BrowserStorage.DBName
@@ -37,11 +38,12 @@ export class BrowserStorage implements IDriveStorage {
         const document = await (
             await this.db
         ).getItem<Document>(this.buildKey(drive, id));
-        return document !== undefined;
+        return !document;
     }
 
     async getDocuments(drive: string) {
-        const keys = await (await this.db).keys();
+        const db = await this.db;
+        const keys = await db.keys();
         const driveKey = `${drive}${BrowserStorage.SEP}`;
         return keys
             .filter(key => key.startsWith(driveKey))
@@ -96,7 +98,7 @@ export class BrowserStorage implements IDriveStorage {
 
     async getDrives() {
         const db = await this.db;
-        const keys = (await db.keys()) ?? [];
+        const keys = await db.keys();
         return keys
             .filter(key => key.startsWith(BrowserStorage.DRIVES_KEY))
             .map(key =>
@@ -107,9 +109,8 @@ export class BrowserStorage implements IDriveStorage {
     }
 
     async getDrive(id: string) {
-        const drive = await (
-            await this.db
-        ).getItem<DocumentDriveStorage>(
+        const db = await this.db;
+        const drive = await db.getItem<DocumentDriveStorage>(
             this.buildKey(BrowserStorage.DRIVES_KEY, id)
         );
         if (!drive) {

package/src/utils/default-drives-manager.ts

@@ -203,7 +203,9 @@ export class DefaultDrivesManager implements IDefaultDrivesManager {
             let remoteDriveInfo = { ...remoteDrive };
 
             try {
-                const driveInfo = await requestPublicDrive(remoteDrive.url);
+                const driveInfo =
+                    remoteDrive.metadata ??
+                    (await requestPublicDrive(remoteDrive.url));
 
                 remoteDriveInfo = { ...remoteDrive, metadata: driveInfo };
 
@@ -212,15 +214,17 @@ export class DefaultDrivesManager implements IDefaultDrivesManager {
                 const driveIsAdded = drives.includes(driveInfo.id);
                 const readDriveIsAdded = readDrives?.includes(driveInfo.id);
 
+                const hasAccessLevel =
+                    remoteDrive.options.accessLevel !== undefined;
                 const readMode =
                     readServer && remoteDrive.options.accessLevel === 'READ';
                 const isAdded = readMode ? readDriveIsAdded : driveIsAdded;
 
                 // if the read mode has changed then existing drives
                 // in the previous mode should be deleted
-                const driveToDelete = readMode
-                    ? driveIsAdded
-                    : readDriveIsAdded;
+                const driveToDelete =
+                    hasAccessLevel &&
+                    (readMode ? driveIsAdded : readDriveIsAdded);
                 if (driveToDelete) {
                     try {
                         await (readMode
@@ -257,10 +261,17 @@ export class DefaultDrivesManager implements IDefaultDrivesManager {
                     remoteDriveInfo
                 );
 
-                await this.server.addRemoteDrive(remoteDrive.url, {
-                    ...remoteDrive.options,
-                    expectedDriveInfo: driveInfo
-                });
+                // if no access level is defined and read mode
+                // is supported then uses read mode
+                (!hasAccessLevel && readServer) || readMode
+                    ? await readServer.addReadDrive(remoteDrive.url, {
+                          ...remoteDrive.options,
+                          expectedDriveInfo: driveInfo
+                      })
+                    : await this.server.addRemoteDrive(remoteDrive.url, {
+                          ...remoteDrive.options,
+                          expectedDriveInfo: driveInfo
+                      });
 
                 remoteDriveInfo.status = 'SUCCESS';