@protontech/drive-sdk 0.3.1 → 0.4.0

package/src/protonDrivePhotosClient.ts

@@ -1,19 +1,56 @@
-import { DriveAPIService } from './internal/apiService';
-import { DriveListener, ProtonDriveClientContructorParameters } from './interface';
+import {
+    Logger,
+    ProtonDriveClientContructorParameters,
+    NodeOrUid,
+    MaybeMissingNode,
+    UploadMetadata,
+    FileDownloader,
+    FileUploader,
+    SDKEvent,
+    MaybeNode,
+} from './interface';
+import { getConfig } from './config';
 import { DriveCrypto } from './crypto';
-import { initSharesModule } from './internal/shares';
+import { Telemetry } from './telemetry';
+import { convertInternalMissingNodeIterator, convertInternalNodeIterator, getUid, getUids } from './transformers';
+import { DriveAPIService } from './internal/apiService';
+import { initDownloadModule } from './internal/download';
+import { DriveEventsService, DriveListener, EventSubscription } from './internal/events';
 import { initNodesModule } from './internal/nodes';
-import { initPhotosModule } from './internal/photos';
-import { DriveEventsService } from './internal/events';
+import { initPhotoSharesModule, initPhotosModule } from './internal/photos';
 import { SDKEvents } from './internal/sdkEvents';
-import { getConfig } from './config';
-import { Telemetry } from './telemetry';
+import { initSharesModule } from './internal/shares';
+import { initSharingModule } from './internal/sharing';
+import { initUploadModule } from './internal/upload';
 
-// TODO: this is only example, on background it use drive internals, but it exposes nice interface for photos
+/**
+ * ProtonDrivePhotosClient is the interface to access Photos functionality.
+ *
+ * The client provides high-level operations for managing photos, albums, sharing,
+ * and downloading/uploading photos.
+ *
+ * @deprecated This is an experimental feature that might change without a warning.
+ */
 export class ProtonDrivePhotosClient {
+    private logger: Logger;
+    private sdkEvents: SDKEvents;
+    private events: DriveEventsService;
+    private photoShares: ReturnType<typeof initPhotoSharesModule>;
     private nodes: ReturnType<typeof initNodesModule>;
+    private sharing: ReturnType<typeof initSharingModule>;
+    private download: ReturnType<typeof initDownloadModule>;
+    private upload: ReturnType<typeof initUploadModule>;
     private photos: ReturnType<typeof initPhotosModule>;
 
+    public experimental: {
+        /**
+         * Experimental feature to return the URL of the node.
+         *
+         * See `ProtonDriveClient.experimental.getNodeUrl` for more information.
+         */
+        getNodeUrl: (nodeUid: NodeOrUid) => Promise<string>;
+    };
+
     constructor({
         httpClient,
         entitiesCache,
@@ -23,41 +60,183 @@ export class ProtonDrivePhotosClient {
         srpModule,
         config,
         telemetry,
+        latestEventIdProvider,
     }: ProtonDriveClientContructorParameters) {
         if (!telemetry) {
             telemetry = new Telemetry();
         }
+        this.logger = telemetry.getLogger('interface');
 
         const fullConfig = getConfig(config);
-        const sdkEvents = new SDKEvents(telemetry);
+        this.sdkEvents = new SDKEvents(telemetry);
         const cryptoModule = new DriveCrypto(openPGPCryptoModule, srpModule);
         const apiService = new DriveAPIService(
             telemetry,
-            sdkEvents,
+            this.sdkEvents,
             httpClient,
             fullConfig.baseUrl,
             fullConfig.language,
         );
-        const shares = initSharesModule(telemetry, apiService, entitiesCache, cryptoCache, account, cryptoModule);
-        this.nodes = initNodesModule(telemetry, apiService, entitiesCache, cryptoCache, account, cryptoModule, shares);
-        const cacheEventListeners: DriveListener[] = [this.nodes.eventHandler.updateNodesCacheOnEvent];
-        new DriveEventsService(telemetry, apiService, shares, cacheEventListeners);
-        this.photos = initPhotosModule(apiService, entitiesCache, this.nodes.access);
-    }
-
-    // Timeline or album view
-    iterateTimelinePhotos() {} // returns only UIDs and dates - used to show grid and scrolling
-    iterateAlbumPhotos() {} // same as above but for album
-    iterateThumbnails() {} // returns thumbnails for passed photos that are visible in the UI
-    getPhoto() {} // returns full photo details
-
-    // Album management
-    createAlbum(albumName: string) {
-        return this.photos.albums.createAlbum(albumName);
-    }
-    renameAlbum() {}
-    shareAlbum() {}
-    deleteAlbum() {}
-    iterateAlbums() {}
-    addPhotosToAlbum() {}
+        const coreShares = initSharesModule(telemetry, apiService, entitiesCache, cryptoCache, account, cryptoModule);
+        this.photoShares = initPhotoSharesModule(
+            telemetry,
+            apiService,
+            entitiesCache,
+            cryptoCache,
+            account,
+            cryptoModule,
+            coreShares,
+        );
+        this.nodes = initNodesModule(
+            telemetry,
+            apiService,
+            entitiesCache,
+            cryptoCache,
+            account,
+            cryptoModule,
+            this.photoShares,
+        );
+        this.photos = initPhotosModule(apiService, this.photoShares, this.nodes.access);
+        this.sharing = initSharingModule(
+            telemetry,
+            apiService,
+            entitiesCache,
+            account,
+            cryptoModule,
+            this.photoShares,
+            this.nodes.access,
+        );
+        this.download = initDownloadModule(
+            telemetry,
+            apiService,
+            cryptoModule,
+            account,
+            this.photoShares,
+            this.nodes.access,
+            this.nodes.revisions,
+        );
+        this.upload = initUploadModule(
+            telemetry,
+            apiService,
+            cryptoModule,
+            this.photoShares,
+            this.nodes.access,
+            fullConfig.clientUid,
+        );
+
+        // These are used to keep the internal cache up to date
+        const cacheEventListeners: DriveListener[] = [
+            this.nodes.eventHandler.updateNodesCacheOnEvent.bind(this.nodes.eventHandler),
+            this.sharing.eventHandler.handleDriveEvent.bind(this.sharing.eventHandler),
+        ];
+        this.events = new DriveEventsService(
+            telemetry,
+            apiService,
+            this.photoShares,
+            cacheEventListeners,
+            latestEventIdProvider,
+        );
+
+        this.experimental = {
+            getNodeUrl: async (nodeUid: NodeOrUid) => {
+                this.logger.debug(`Getting node URL for ${getUid(nodeUid)}`);
+                return this.nodes.access.getNodeUrl(getUid(nodeUid));
+            },
+        };
+    }
+
+    /**
+     * Subscribes to the general SDK events.
+     *
+     * See `ProtonDriveClient.onMessage` for more information.
+     */
+    onMessage(eventName: SDKEvent, callback: () => void): () => void {
+        this.logger.debug(`Subscribing to event ${eventName}`);
+        return this.sdkEvents.addListener(eventName, callback);
+    }
+
+    /**
+     * Subscribes to the remote data updates for all files in a tree.
+     *
+     * See `ProtonDriveClient.subscribeToTreeEvents` for more information.
+     */
+    async subscribeToTreeEvents(treeEventScopeId: string, callback: DriveListener): Promise<EventSubscription> {
+        this.logger.debug('Subscribing to node updates');
+        return this.events.subscribeToTreeEvents(treeEventScopeId, callback);
+    }
+
+    /**
+     * Subscribes to the remote general data updates.
+     *
+     * See `ProtonDriveClient.subscribeToDriveEvents` for more information.
+     */
+    async subscribeToDriveEvents(callback: DriveListener): Promise<EventSubscription> {
+        this.logger.debug('Subscribing to core updates');
+        return this.events.subscribeToCoreEvents(callback);
+    }
+
+    /**
+     * Iterates all the photos for the timeline view.
+     *
+     * The output includes only necessary information to quickly prepare
+     * the whole timeline view with the break-down per month/year and fast
+     * scrollbar.
+     *
+     * Individual photos details must be loaded separately based on what
+     * is visible in the UI.
+     *
+     * The output is sorted by the capture time, starting from the
+     * the most recent photos.
+     */
+    async *iterateTimeline(signal?: AbortSignal): AsyncGenerator<{
+        nodeUid: string;
+        captureTime: Date;
+        tags: number[];
+    }> {
+        // TODO: expose better type
+        yield* this.photos.timeline.iterateTimeline(signal);
+    }
+
+    /**
+     * Iterates the nodes by their UIDs.
+     *
+     * See `ProtonDriveClient.iterateNodes` for more information.
+     */
+    async *iterateNodes(nodeUids: NodeOrUid[], signal?: AbortSignal): AsyncGenerator<MaybeMissingNode> {
+        this.logger.info(`Iterating ${nodeUids.length} nodes`);
+        // TODO: expose photo type
+        yield* convertInternalMissingNodeIterator(this.nodes.access.iterateNodes(getUids(nodeUids), signal));
+    }
+
+    /**
+     * Iterates the albums.
+     *
+     * The output is not sorted and the order of the nodes is not guaranteed.
+     */
+    async *iterateAlbums(signal?: AbortSignal): AsyncGenerator<MaybeNode> {
+        this.logger.info('Iterating albums');
+        // TODO: expose album type
+        yield* convertInternalNodeIterator(this.photos.albums.iterateAlbums(signal));
+    }
+
+    /**
+     * Get the file downloader to download the node content.
+     *
+     * See `ProtonDriveClient.getFileDownloader` for more information.
+     */
+    async getFileDownloader(nodeUid: NodeOrUid, signal?: AbortSignal): Promise<FileDownloader> {
+        this.logger.info(`Getting file downloader for ${getUid(nodeUid)}`);
+        return this.download.getFileDownloader(getUid(nodeUid), signal);
+    }
+
+    /**
+     * Get the file uploader to upload a new file.
+     *
+     * See `ProtonDriveClient.getFileUploader` for more information.
+     */
+    async getFileUploader(name: string, metadata: UploadMetadata, signal?: AbortSignal): Promise<FileUploader> {
+        this.logger.info(`Getting file uploader`);
+        const parentFolderUid = await this.nodes.access.getVolumeRootFolder();
+        return this.upload.getFileUploader(getUid(parentFolderUid), name, metadata, signal);
+    }
 }

package/src/protonDrivePublicLinkClient.ts

@@ -7,9 +7,11 @@ import {
     Logger,
     ProtonDriveCryptoCache,
     NodeOrUid,
+    ProtonDriveAccount,
+    MaybeNode,
 } from './interface';
 import { Telemetry } from './telemetry';
-import { getUid } from './transformers';
+import { getUid, convertInternalNodePromise, convertInternalNodeIterator } from './transformers';
 import { DriveAPIService } from './internal/apiService';
 import { SDKEvents } from './internal/sdkEvents';
 import { initSharingPublicModule } from './internal/sharingPublic';
@@ -52,6 +54,7 @@ export class ProtonDrivePublicLinkClient {
     constructor({
         httpClient,
         cryptoCache,
+        account,
         openPGPCryptoModule,
         srpModule,
         config,
@@ -61,6 +64,7 @@ export class ProtonDrivePublicLinkClient {
     }: {
         httpClient: ProtonDriveHTTPClient;
         cryptoCache: ProtonDriveCryptoCache;
+        account: ProtonDriveAccount;
         openPGPCryptoModule: OpenPGPCrypto;
         srpModule: SRPModule;
         config?: ProtonDriveConfig;
@@ -84,7 +88,15 @@ export class ProtonDrivePublicLinkClient {
             fullConfig.language,
         );
         const driveCrypto = new DriveCrypto(openPGPCryptoModule, srpModule);
-        this.sharingPublic = initSharingPublicModule(telemetry, apiService, cryptoCache, driveCrypto, token, password);
+        this.sharingPublic = initSharingPublicModule(
+            telemetry,
+            apiService,
+            cryptoCache,
+            driveCrypto,
+            account,
+            token,
+            password,
+        );
 
         this.experimental = {
             getNodeUrl: async (nodeUid: NodeOrUid) => {
@@ -103,19 +115,21 @@ export class ProtonDrivePublicLinkClient {
         };
     }
 
-    // TODO: comment
-    // TODO: add public node interface
-    async getRootNode() {
+    /**
+     * @returns The root folder to the public link.
+     */
+    async getRootNode(): Promise<MaybeNode> {
         this.logger.info(`Getting root node`);
-        // TODO: conversion to public node
-        return this.sharingPublic.getRootNode();
+        return convertInternalNodePromise(this.sharingPublic.getRootNode());
     }
 
-    // TODO: comment
-    // TODO: add public node interface
-    async *iterateChildren(parentUid: NodeOrUid) {
+    /**
+     * Iterates the children of the given parent node.
+     *
+     * See `ProtonDriveClient.iterateFolderChildren` for more information.
+     */
+    async *iterateFolderChildren(parentUid: NodeOrUid, signal?: AbortSignal): AsyncGenerator<MaybeNode> {
         this.logger.info(`Iterating children of ${getUid(parentUid)}`);
-        // TODO: conversion to public node
-        yield * this.sharingPublic.iterateChildren(getUid(parentUid));
+        yield * convertInternalNodeIterator(this.sharingPublic.iterateFolderChildren(getUid(parentUid), signal));
     }
 }

package/dist/internal/photos/cache.d.ts

@@ -1,6 +0,0 @@
-import { ProtonDriveEntitiesCache } from '../../interface';
-export declare class PhotosCache {
-    private driveCache;
-    constructor(driveCache: ProtonDriveEntitiesCache);
-    setAlbum(album: any): Promise<void>;
-}

package/dist/internal/photos/cache.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PhotosCache = void 0;
-class PhotosCache {
-    driveCache;
-    constructor(driveCache) {
-        this.driveCache = driveCache;
-        this.driveCache = driveCache;
-    }
-    async setAlbum(album) {
-        await this.driveCache.setEntity(album.uid, album);
-    }
-}
-exports.PhotosCache = PhotosCache;
-//# sourceMappingURL=cache.js.map

package/dist/internal/photos/cache.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"cache.js","sourceRoot":"","sources":["../../../src/internal/photos/cache.ts"],"names":[],"mappings":";;;AAEA,MAAa,WAAW;IACA;IAApB,YAAoB,UAAoC;QAApC,eAAU,GAAV,UAAU,CAA0B;QACpD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,KAAU;QACrB,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;CACJ;AARD,kCAQC"}

package/dist/internal/photos/photosTimeline.d.ts

@@ -1,10 +0,0 @@
-import { PhotosAPIService } from './apiService';
-import { PhotosCache } from './cache';
-import { NodesService } from './interface';
-export declare class PhotosTimeline {
-    private apiService;
-    private cache;
-    private nodesService;
-    constructor(apiService: PhotosAPIService, cache: PhotosCache, nodesService: NodesService);
-    getTimelineStructure(): Promise<void>;
-}

package/dist/internal/photos/photosTimeline.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PhotosTimeline = void 0;
-class PhotosTimeline {
-    apiService;
-    cache;
-    nodesService;
-    constructor(apiService, cache, nodesService) {
-        this.apiService = apiService;
-        this.cache = cache;
-        this.nodesService = nodesService;
-        this.apiService = apiService;
-        this.cache = cache;
-        this.nodesService = nodesService;
-    }
-    async getTimelineStructure() { }
-}
-exports.PhotosTimeline = PhotosTimeline;
-//# sourceMappingURL=photosTimeline.js.map

package/dist/internal/photos/photosTimeline.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"photosTimeline.js","sourceRoot":"","sources":["../../../src/internal/photos/photosTimeline.ts"],"names":[],"mappings":";;;AAIA,MAAa,cAAc;IAEX;IACA;IACA;IAHZ,YACY,UAA4B,EAC5B,KAAkB,EAClB,YAA0B;QAF1B,eAAU,GAAV,UAAU,CAAkB;QAC5B,UAAK,GAAL,KAAK,CAAa;QAClB,iBAAY,GAAZ,YAAY,CAAc;QAElC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACrC,CAAC;IAED,KAAK,CAAC,oBAAoB,KAAI,CAAC;CAClC;AAZD,wCAYC"}

package/src/internal/photos/cache.ts

@@ -1,11 +0,0 @@
-import { ProtonDriveEntitiesCache } from '../../interface';
-
-export class PhotosCache {
-    constructor(private driveCache: ProtonDriveEntitiesCache) {
-        this.driveCache = driveCache;
-    }
-
-    async setAlbum(album: any) {
-        await this.driveCache.setEntity(album.uid, album);
-    }
-}

package/src/internal/photos/photosTimeline.ts

@@ -1,17 +0,0 @@
-import { PhotosAPIService } from './apiService';
-import { PhotosCache } from './cache';
-import { NodesService } from './interface';
-
-export class PhotosTimeline {
-    constructor(
-        private apiService: PhotosAPIService,
-        private cache: PhotosCache,
-        private nodesService: NodesService,
-    ) {
-        this.apiService = apiService;
-        this.cache = cache;
-        this.nodesService = nodesService;
-    }
-
-    async getTimelineStructure() {}
-}