@protontech/drive-sdk 0.3.2 → 0.4.0

package/dist/protonDrivePhotosClient.d.ts

@@ -1,16 +1,90 @@
-import { ProtonDriveClientContructorParameters } from './interface';
+import { ProtonDriveClientContructorParameters, NodeOrUid, MaybeMissingNode, UploadMetadata, FileDownloader, FileUploader, SDKEvent, MaybeNode } from './interface';
+import { DriveListener, EventSubscription } from './internal/events';
+/**
+ * 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 declare class ProtonDrivePhotosClient {
+    private logger;
+    private sdkEvents;
+    private events;
+    private photoShares;
     private nodes;
+    private sharing;
+    private download;
+    private upload;
     private photos;
-    constructor({ httpClient, entitiesCache, cryptoCache, account, openPGPCryptoModule, srpModule, config, telemetry, }: ProtonDriveClientContructorParameters);
-    iterateTimelinePhotos(): void;
-    iterateAlbumPhotos(): void;
-    iterateThumbnails(): void;
-    getPhoto(): void;
-    createAlbum(albumName: string): Promise<void>;
-    renameAlbum(): void;
-    shareAlbum(): void;
-    deleteAlbum(): void;
-    iterateAlbums(): void;
-    addPhotosToAlbum(): void;
+    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, cryptoCache, account, openPGPCryptoModule, srpModule, config, telemetry, latestEventIdProvider, }: ProtonDriveClientContructorParameters);
+    /**
+     * Subscribes to the general SDK events.
+     *
+     * See `ProtonDriveClient.onMessage` for more information.
+     */
+    onMessage(eventName: SDKEvent, callback: () => void): () => void;
+    /**
+     * Subscribes to the remote data updates for all files in a tree.
+     *
+     * See `ProtonDriveClient.subscribeToTreeEvents` for more information.
+     */
+    subscribeToTreeEvents(treeEventScopeId: string, callback: DriveListener): Promise<EventSubscription>;
+    /**
+     * Subscribes to the remote general data updates.
+     *
+     * See `ProtonDriveClient.subscribeToDriveEvents` for more information.
+     */
+    subscribeToDriveEvents(callback: DriveListener): Promise<EventSubscription>;
+    /**
+     * 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.
+     */
+    iterateTimeline(signal?: AbortSignal): AsyncGenerator<{
+        nodeUid: string;
+        captureTime: Date;
+        tags: number[];
+    }>;
+    /**
+     * Iterates the nodes by their UIDs.
+     *
+     * See `ProtonDriveClient.iterateNodes` for more information.
+     */
+    iterateNodes(nodeUids: NodeOrUid[], signal?: AbortSignal): AsyncGenerator<MaybeMissingNode>;
+    /**
+     * Iterates the albums.
+     *
+     * The output is not sorted and the order of the nodes is not guaranteed.
+     */
+    iterateAlbums(signal?: AbortSignal): AsyncGenerator<MaybeNode>;
+    /**
+     * Get the file downloader to download the node content.
+     *
+     * See `ProtonDriveClient.getFileDownloader` for more information.
+     */
+    getFileDownloader(nodeUid: NodeOrUid, signal?: AbortSignal): Promise<FileDownloader>;
+    /**
+     * Get the file uploader to upload a new file.
+     *
+     * See `ProtonDriveClient.getFileUploader` for more information.
+     */
+    getFileUploader(name: string, metadata: UploadMetadata, signal?: AbortSignal): Promise<FileUploader>;
 }

package/dist/protonDrivePhotosClient.js

@@ -1,47 +1,150 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProtonDrivePhotosClient = void 0;
-const apiService_1 = require("./internal/apiService");
+const config_1 = require("./config");
 const crypto_1 = require("./crypto");
-const shares_1 = require("./internal/shares");
+const telemetry_1 = require("./telemetry");
+const transformers_1 = require("./transformers");
+const apiService_1 = require("./internal/apiService");
+const download_1 = require("./internal/download");
+const events_1 = require("./internal/events");
 const nodes_1 = require("./internal/nodes");
 const photos_1 = require("./internal/photos");
-const events_1 = require("./internal/events");
 const sdkEvents_1 = require("./internal/sdkEvents");
-const config_1 = require("./config");
-const telemetry_1 = require("./telemetry");
-// TODO: this is only example, on background it use drive internals, but it exposes nice interface for photos
+const shares_1 = require("./internal/shares");
+const sharing_1 = require("./internal/sharing");
+const upload_1 = require("./internal/upload");
+/**
+ * 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.
+ */
 class ProtonDrivePhotosClient {
+    logger;
+    sdkEvents;
+    events;
+    photoShares;
     nodes;
+    sharing;
+    download;
+    upload;
     photos;
-    constructor({ httpClient, entitiesCache, cryptoCache, account, openPGPCryptoModule, srpModule, config, telemetry, }) {
+    experimental;
+    constructor({ httpClient, entitiesCache, cryptoCache, account, openPGPCryptoModule, srpModule, config, telemetry, latestEventIdProvider, }) {
         if (!telemetry) {
             telemetry = new telemetry_1.Telemetry();
         }
+        this.logger = telemetry.getLogger('interface');
         const fullConfig = (0, config_1.getConfig)(config);
-        const sdkEvents = new sdkEvents_1.SDKEvents(telemetry);
+        this.sdkEvents = new sdkEvents_1.SDKEvents(telemetry);
         const cryptoModule = new crypto_1.DriveCrypto(openPGPCryptoModule, srpModule);
-        const apiService = new apiService_1.DriveAPIService(telemetry, sdkEvents, httpClient, fullConfig.baseUrl, fullConfig.language);
-        const shares = (0, shares_1.initSharesModule)(telemetry, apiService, entitiesCache, cryptoCache, account, cryptoModule);
-        this.nodes = (0, nodes_1.initNodesModule)(telemetry, apiService, entitiesCache, cryptoCache, account, cryptoModule, shares);
-        const cacheEventListeners = [this.nodes.eventHandler.updateNodesCacheOnEvent];
-        new events_1.DriveEventsService(telemetry, apiService, shares, cacheEventListeners);
-        this.photos = (0, photos_1.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) {
-        return this.photos.albums.createAlbum(albumName);
-    }
-    renameAlbum() { }
-    shareAlbum() { }
-    deleteAlbum() { }
-    iterateAlbums() { }
-    addPhotosToAlbum() { }
+        const apiService = new apiService_1.DriveAPIService(telemetry, this.sdkEvents, httpClient, fullConfig.baseUrl, fullConfig.language);
+        const coreShares = (0, shares_1.initSharesModule)(telemetry, apiService, entitiesCache, cryptoCache, account, cryptoModule);
+        this.photoShares = (0, photos_1.initPhotoSharesModule)(telemetry, apiService, entitiesCache, cryptoCache, account, cryptoModule, coreShares);
+        this.nodes = (0, nodes_1.initNodesModule)(telemetry, apiService, entitiesCache, cryptoCache, account, cryptoModule, this.photoShares);
+        this.photos = (0, photos_1.initPhotosModule)(apiService, this.photoShares, this.nodes.access);
+        this.sharing = (0, sharing_1.initSharingModule)(telemetry, apiService, entitiesCache, account, cryptoModule, this.photoShares, this.nodes.access);
+        this.download = (0, download_1.initDownloadModule)(telemetry, apiService, cryptoModule, account, this.photoShares, this.nodes.access, this.nodes.revisions);
+        this.upload = (0, upload_1.initUploadModule)(telemetry, apiService, cryptoModule, this.photoShares, this.nodes.access, fullConfig.clientUid);
+        // These are used to keep the internal cache up to date
+        const cacheEventListeners = [
+            this.nodes.eventHandler.updateNodesCacheOnEvent.bind(this.nodes.eventHandler),
+            this.sharing.eventHandler.handleDriveEvent.bind(this.sharing.eventHandler),
+        ];
+        this.events = new events_1.DriveEventsService(telemetry, apiService, this.photoShares, cacheEventListeners, latestEventIdProvider);
+        this.experimental = {
+            getNodeUrl: async (nodeUid) => {
+                this.logger.debug(`Getting node URL for ${(0, transformers_1.getUid)(nodeUid)}`);
+                return this.nodes.access.getNodeUrl((0, transformers_1.getUid)(nodeUid));
+            },
+        };
+    }
+    /**
+     * Subscribes to the general SDK events.
+     *
+     * See `ProtonDriveClient.onMessage` for more information.
+     */
+    onMessage(eventName, callback) {
+        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, callback) {
+        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) {
+        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) {
+        // 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, signal) {
+        this.logger.info(`Iterating ${nodeUids.length} nodes`);
+        // TODO: expose photo type
+        yield* (0, transformers_1.convertInternalMissingNodeIterator)(this.nodes.access.iterateNodes((0, transformers_1.getUids)(nodeUids), signal));
+    }
+    /**
+     * Iterates the albums.
+     *
+     * The output is not sorted and the order of the nodes is not guaranteed.
+     */
+    async *iterateAlbums(signal) {
+        this.logger.info('Iterating albums');
+        // TODO: expose album type
+        yield* (0, transformers_1.convertInternalNodeIterator)(this.photos.albums.iterateAlbums(signal));
+    }
+    /**
+     * Get the file downloader to download the node content.
+     *
+     * See `ProtonDriveClient.getFileDownloader` for more information.
+     */
+    async getFileDownloader(nodeUid, signal) {
+        this.logger.info(`Getting file downloader for ${(0, transformers_1.getUid)(nodeUid)}`);
+        return this.download.getFileDownloader((0, transformers_1.getUid)(nodeUid), signal);
+    }
+    /**
+     * Get the file uploader to upload a new file.
+     *
+     * See `ProtonDriveClient.getFileUploader` for more information.
+     */
+    async getFileUploader(name, metadata, signal) {
+        this.logger.info(`Getting file uploader`);
+        const parentFolderUid = await this.nodes.access.getVolumeRootFolder();
+        return this.upload.getFileUploader((0, transformers_1.getUid)(parentFolderUid), name, metadata, signal);
+    }
 }
 exports.ProtonDrivePhotosClient = ProtonDrivePhotosClient;
 //# sourceMappingURL=protonDrivePhotosClient.js.map

package/dist/protonDrivePhotosClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"protonDrivePhotosClient.js","sourceRoot":"","sources":["../src/protonDrivePhotosClient.ts"],"names":[],"mappings":";;;AAAA,sDAAwD;AAExD,qCAAuC;AACvC,8CAAqD;AACrD,4CAAmD;AACnD,8CAAqD;AACrD,8CAAuD;AACvD,oDAAiD;AACjD,qCAAqC;AACrC,2CAAwC;AAExC,6GAA6G;AAC7G,MAAa,uBAAuB;IACxB,KAAK,CAAqC;IAC1C,MAAM,CAAsC;IAEpD,YAAY,EACR,UAAU,EACV,aAAa,EACb,WAAW,EACX,OAAO,EACP,mBAAmB,EACnB,SAAS,EACT,MAAM,EACN,SAAS,GAC2B;QACpC,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,SAAS,GAAG,IAAI,qBAAS,EAAE,CAAC;QAChC,CAAC;QAED,MAAM,UAAU,GAAG,IAAA,kBAAS,EAAC,MAAM,CAAC,CAAC;QACrC,MAAM,SAAS,GAAG,IAAI,qBAAS,CAAC,SAAS,CAAC,CAAC;QAC3C,MAAM,YAAY,GAAG,IAAI,oBAAW,CAAC,mBAAmB,EAAE,SAAS,CAAC,CAAC;QACrE,MAAM,UAAU,GAAG,IAAI,4BAAe,CAClC,SAAS,EACT,SAAS,EACT,UAAU,EACV,UAAU,CAAC,OAAO,EAClB,UAAU,CAAC,QAAQ,CACtB,CAAC;QACF,MAAM,MAAM,GAAG,IAAA,yBAAgB,EAAC,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;QAC1G,IAAI,CAAC,KAAK,GAAG,IAAA,uBAAe,EAAC,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;QAC/G,MAAM,mBAAmB,GAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,uBAAuB,CAAC,CAAC;QAC/F,IAAI,2BAAkB,CAAC,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,mBAAmB,CAAC,CAAC;QAC3E,IAAI,CAAC,MAAM,GAAG,IAAA,yBAAgB,EAAC,UAAU,EAAE,aAAa,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACjF,CAAC;IAED,yBAAyB;IACzB,qBAAqB,KAAI,CAAC,CAAC,gEAAgE;IAC3F,kBAAkB,KAAI,CAAC,CAAC,8BAA8B;IACtD,iBAAiB,KAAI,CAAC,CAAC,kEAAkE;IACzF,QAAQ,KAAI,CAAC,CAAC,6BAA6B;IAE3C,mBAAmB;IACnB,WAAW,CAAC,SAAiB;QACzB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IACrD,CAAC;IACD,WAAW,KAAI,CAAC;IAChB,UAAU,KAAI,CAAC;IACf,WAAW,KAAI,CAAC;IAChB,aAAa,KAAI,CAAC;IAClB,gBAAgB,KAAI,CAAC;CACxB;AAlDD,0DAkDC"}
+{"version":3,"file":"protonDrivePhotosClient.js","sourceRoot":"","sources":["../src/protonDrivePhotosClient.ts"],"names":[],"mappings":";;;AAWA,qCAAqC;AACrC,qCAAuC;AACvC,2CAAwC;AACxC,iDAAkH;AAClH,sDAAwD;AACxD,kDAAyD;AACzD,8CAAyF;AACzF,4CAAmD;AACnD,8CAA4E;AAC5E,oDAAiD;AACjD,8CAAqD;AACrD,gDAAuD;AACvD,8CAAqD;AAErD;;;;;;;GAOG;AACH,MAAa,uBAAuB;IACxB,MAAM,CAAS;IACf,SAAS,CAAY;IACrB,MAAM,CAAqB;IAC3B,WAAW,CAA2C;IACtD,KAAK,CAAqC;IAC1C,OAAO,CAAuC;IAC9C,QAAQ,CAAwC;IAChD,MAAM,CAAsC;IAC5C,MAAM,CAAsC;IAE7C,YAAY,CAOjB;IAEF,YAAY,EACR,UAAU,EACV,aAAa,EACb,WAAW,EACX,OAAO,EACP,mBAAmB,EACnB,SAAS,EACT,MAAM,EACN,SAAS,EACT,qBAAqB,GACe;QACpC,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,SAAS,GAAG,IAAI,qBAAS,EAAE,CAAC;QAChC,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QAE/C,MAAM,UAAU,GAAG,IAAA,kBAAS,EAAC,MAAM,CAAC,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,IAAI,qBAAS,CAAC,SAAS,CAAC,CAAC;QAC1C,MAAM,YAAY,GAAG,IAAI,oBAAW,CAAC,mBAAmB,EAAE,SAAS,CAAC,CAAC;QACrE,MAAM,UAAU,GAAG,IAAI,4BAAe,CAClC,SAAS,EACT,IAAI,CAAC,SAAS,EACd,UAAU,EACV,UAAU,CAAC,OAAO,EAClB,UAAU,CAAC,QAAQ,CACtB,CAAC;QACF,MAAM,UAAU,GAAG,IAAA,yBAAgB,EAAC,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;QAC9G,IAAI,CAAC,WAAW,GAAG,IAAA,8BAAqB,EACpC,SAAS,EACT,UAAU,EACV,aAAa,EACb,WAAW,EACX,OAAO,EACP,YAAY,EACZ,UAAU,CACb,CAAC;QACF,IAAI,CAAC,KAAK,GAAG,IAAA,uBAAe,EACxB,SAAS,EACT,UAAU,EACV,aAAa,EACb,WAAW,EACX,OAAO,EACP,YAAY,EACZ,IAAI,CAAC,WAAW,CACnB,CAAC;QACF,IAAI,CAAC,MAAM,GAAG,IAAA,yBAAgB,EAAC,UAAU,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAChF,IAAI,CAAC,OAAO,GAAG,IAAA,2BAAiB,EAC5B,SAAS,EACT,UAAU,EACV,aAAa,EACb,OAAO,EACP,YAAY,EACZ,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,KAAK,CAAC,MAAM,CACpB,CAAC;QACF,IAAI,CAAC,QAAQ,GAAG,IAAA,6BAAkB,EAC9B,SAAS,EACT,UAAU,EACV,YAAY,EACZ,OAAO,EACP,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,KAAK,CAAC,MAAM,EACjB,IAAI,CAAC,KAAK,CAAC,SAAS,CACvB,CAAC;QACF,IAAI,CAAC,MAAM,GAAG,IAAA,yBAAgB,EAC1B,SAAS,EACT,UAAU,EACV,YAAY,EACZ,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,KAAK,CAAC,MAAM,EACjB,UAAU,CAAC,SAAS,CACvB,CAAC;QAEF,uDAAuD;QACvD,MAAM,mBAAmB,GAAoB;YACzC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;YAC7E,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;SAC7E,CAAC;QACF,IAAI,CAAC,MAAM,GAAG,IAAI,2BAAkB,CAChC,SAAS,EACT,UAAU,EACV,IAAI,CAAC,WAAW,EAChB,mBAAmB,EACnB,qBAAqB,CACxB,CAAC;QAEF,IAAI,CAAC,YAAY,GAAG;YAChB,UAAU,EAAE,KAAK,EAAE,OAAkB,EAAE,EAAE;gBACrC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,wBAAwB,IAAA,qBAAM,EAAC,OAAO,CAAC,EAAE,CAAC,CAAC;gBAC7D,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,IAAA,qBAAM,EAAC,OAAO,CAAC,CAAC,CAAC;YACzD,CAAC;SACJ,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,SAAmB,EAAE,QAAoB;QAC/C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,wBAAwB,SAAS,EAAE,CAAC,CAAC;QACvD,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,qBAAqB,CAAC,gBAAwB,EAAE,QAAuB;QACzE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjD,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IACzE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,sBAAsB,CAAC,QAAuB;QAChD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjD,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,CAAC,eAAe,CAAC,MAAoB;QAKvC,2BAA2B;QAC3B,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,CAAC,YAAY,CAAC,QAAqB,EAAE,MAAoB;QAC3D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,QAAQ,CAAC,MAAM,QAAQ,CAAC,CAAC;QACvD,0BAA0B;QAC1B,KAAK,CAAC,CAAC,IAAA,iDAAkC,EAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,IAAA,sBAAO,EAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IACzG,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,CAAC,aAAa,CAAC,MAAoB;QACrC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACrC,0BAA0B;QAC1B,KAAK,CAAC,CAAC,IAAA,0CAA2B,EAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,iBAAiB,CAAC,OAAkB,EAAE,MAAoB;QAC5D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,+BAA+B,IAAA,qBAAM,EAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACnE,OAAO,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAA,qBAAM,EAAC,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,eAAe,CAAC,IAAY,EAAE,QAAwB,EAAE,MAAoB;QAC9E,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;QAC1C,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,mBAAmB,EAAE,CAAC;QACtE,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,IAAA,qBAAM,EAAC,eAAe,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IACxF,CAAC;CACJ;AAhND,0DAgNC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@protontech/drive-sdk",
-    "version": "0.3.2",
+    "version": "0.4.0",
     "description": "Proton Drive SDK",
     "license": "GPL-3.0",
     "main": "dist/index.js",

package/src/internal/apiService/errorCodes.ts

@@ -18,6 +18,7 @@ export const enum ErrorCode {
     OK = 1000,
     OK_MANY = 1001,
     OK_ASYNC = 1002,
+    INVALID_REQUIREMENTS = 2000,
     INVALID_VALUE = 2001,
     NOT_ENOUGH_PERMISSIONS = 2011,
     NOT_ENOUGH_PERMISSIONS_TO_GRANT_PERMISSIONS = 2026,

package/src/internal/apiService/errors.ts

@@ -57,6 +57,8 @@ export function apiErrorFactory({
         // Here we convert only general enough codes. Specific cases that are
         // not clear from the code itself must be handled by each module
         // separately.
+        case ErrorCode.INVALID_REQUIREMENTS:
+            return new InvalidRequirementsAPIError(message, code, details);
         case ErrorCode.INVALID_VALUE:
         case ErrorCode.NOT_ENOUGH_PERMISSIONS:
         case ErrorCode.NOT_ENOUGH_PERMISSIONS_TO_GRANT_PERMISSIONS:
@@ -108,3 +110,7 @@ export class APICodeError extends ServerError {
 export class NotFoundAPIError extends ValidationError {
     name = 'NotFoundAPIError';
 }
+
+export class InvalidRequirementsAPIError extends ValidationError {
+    name = 'InvalidRequirementsAPIError';
+}

package/src/internal/devices/interface.ts

@@ -13,7 +13,7 @@ export type DeviceMetadata = {
 };
 
 export interface SharesService {
-    getMyFilesIDs(): Promise<{ volumeId: string }>;
+    getOwnVolumeIDs(): Promise<{ volumeId: string }>;
     getMyFilesShareMemberEmailKey(): Promise<{
         addressId: string;
         email: string;

package/src/internal/devices/manager.test.ts

@@ -30,7 +30,7 @@ describe('DevicesManager', () => {
         };
         // @ts-expect-error No need to implement all methods for mocking
         sharesService = {
-            getMyFilesIDs: jest.fn(),
+            getOwnVolumeIDs: jest.fn(),
         };
         // @ts-expect-error No need to implement all methods for mocking
         nodesService = {};
@@ -74,13 +74,13 @@ describe('DevicesManager', () => {
             shareId: 'shareid',
         } as DeviceMetadata;
 
-        sharesService.getMyFilesIDs.mockResolvedValue({ volumeId });
+        sharesService.getOwnVolumeIDs.mockResolvedValue({ volumeId });
         cryptoService.createDevice.mockResolvedValue({ address, shareKey, node });
         apiService.createDevice.mockResolvedValue(createdDevice);
 
         const result = await manager.createDevice(name, deviceType);
 
-        expect(sharesService.getMyFilesIDs).toHaveBeenCalled();
+        expect(sharesService.getOwnVolumeIDs).toHaveBeenCalled();
         expect(cryptoService.createDevice).toHaveBeenCalledWith(name);
         expect(apiService.createDevice).toHaveBeenCalledWith(
             { volumeId, type: deviceType },

package/src/internal/devices/manager.ts

@@ -47,7 +47,7 @@ export class DevicesManager {
     }
 
     async createDevice(name: string, deviceType: DeviceType): Promise<Device> {
-        const { volumeId } = await this.sharesService.getMyFilesIDs();
+        const { volumeId } = await this.sharesService.getOwnVolumeIDs();
         const { address, shareKey, node } = await this.cryptoService.createDevice(name);
 
         const device = await this.apiService.createDevice(

package/src/internal/events/apiService.ts

@@ -57,7 +57,7 @@ export class EventsAPIService {
         return {
             latestEventId: result.EventID,
             more: result.More === 1,
-            refresh: result.Refresh === 1,
+            refresh,
             events,
         };
     }

package/src/internal/events/coreEventManager.test.ts

@@ -46,29 +46,6 @@ describe('CoreEventManager', () => {
         const eventId = 'event1';
         const latestEventId = 'event2';
 
-        it('should yield ShareWithMeUpdated event when refresh is true', async () => {
-            const mockEvents: DriveEventsListWithStatus = {
-                latestEventId,
-                more: false,
-                refresh: true,
-                events: [],
-            };
-            mockApiService.getCoreEvents.mockResolvedValue(mockEvents);
-
-            const events = [];
-            for await (const event of coreEventManager.getEvents(eventId)) {
-                events.push(event);
-            }
-
-            expect(events).toHaveLength(1);
-            expect(events[0]).toEqual({
-                type: DriveEventType.SharedWithMeUpdated,
-                treeEventScopeId: 'core',
-                eventId: latestEventId,
-            });
-            expect(mockApiService.getCoreEvents).toHaveBeenCalledWith(eventId);
-        });
-
         it('should yield all events when there are actual events', async () => {
             const mockEvent1: DriveEvent = {
                 type: DriveEventType.SharedWithMeUpdated,
@@ -88,14 +65,31 @@ describe('CoreEventManager', () => {
             };
             mockApiService.getCoreEvents.mockResolvedValue(mockEvents);
 
-            const events = [];
-            for await (const event of coreEventManager.getEvents(eventId)) {
-                events.push(event);
-            }
+            const events = await Array.fromAsync(coreEventManager.getEvents(eventId));
 
             expect(events).toHaveLength(2);
             expect(events[0]).toEqual(mockEvent1);
             expect(events[1]).toEqual(mockEvent2);
         });
+
+        it('should yield FastForward event there are no events but lastEventId changed', async () => {
+            const mockEvents: DriveEventsListWithStatus = {
+                latestEventId,
+                more: false,
+                refresh: false,
+                events: [],
+            };
+            mockApiService.getCoreEvents.mockResolvedValue(mockEvents);
+
+            const events = await Array.fromAsync(coreEventManager.getEvents(eventId));
+
+            expect(events).toHaveLength(1);
+            expect(events[0]).toEqual({
+                type: DriveEventType.FastForward,
+                treeEventScopeId: 'core',
+                eventId: latestEventId,
+            });
+            expect(mockApiService.getCoreEvents).toHaveBeenCalledWith(eventId);
+        });
     });
 });

package/src/internal/events/coreEventManager.ts

@@ -32,7 +32,7 @@ export class CoreEventManager implements EventManagerInterface<DriveEvent> {
         const events = await this.apiService.getCoreEvents(eventId);
         if (events.events.length === 0 && events.latestEventId !== eventId) {
             yield {
-                type: DriveEventType.SharedWithMeUpdated,
+                type: DriveEventType.FastForward,
                 treeEventScopeId: 'core',
                 eventId: events.latestEventId,
             };

package/src/internal/events/index.ts

@@ -1,11 +1,10 @@
 import { Logger, ProtonDriveTelemetry } from '../../interface';
 import { DriveAPIService } from '../apiService';
-import { DriveEvent, DriveListener, EventSubscription, LatestEventIdProvider } from './interface';
+import { DriveEvent, DriveListener, EventSubscription, LatestEventIdProvider, SharesService } from './interface';
 import { EventsAPIService } from './apiService';
 import { CoreEventManager } from './coreEventManager';
 import { VolumeEventManager } from './volumeEventManager';
 import { EventManager } from './eventManager';
-import { SharesManager } from '../shares/manager';
 
 export type { DriveEvent, DriveListener, EventSubscription } from './interface';
 export { DriveEventType } from './interface';
@@ -28,7 +27,7 @@ export class DriveEventsService {
     constructor(
         private telemetry: ProtonDriveTelemetry,
         apiService: DriveAPIService,
-        private shareManagement: SharesManager,
+        private sharesService: SharesService,
         private cacheEventListeners: DriveListener[] = [],
         private latestEventIdProvider?: LatestEventIdProvider,
     ) {
@@ -104,7 +103,7 @@ export class DriveEventsService {
         this.logger.debug(`Creating volume event manager for volume ${volumeId}`);
         const volumeEventManager = new VolumeEventManager(this.logger, this.apiService, volumeId);
 
-        const isOwnVolume = await this.shareManagement.isOwnVolume(volumeId);
+        const isOwnVolume = await this.sharesService.isOwnVolume(volumeId);
         const pollingInterval = this.getDefaultVolumePollingInterval(isOwnVolume);
         const latestEventId = this.latestEventIdProvider.getLatestEventId(volumeId);
         const eventManager = new EventManager<DriveEvent>(volumeEventManager, pollingInterval, latestEventId);

package/src/internal/events/interface.ts

@@ -112,3 +112,7 @@ export interface EventManagerInterface<T> {
     getEvents(eventId: string): AsyncIterable<T>;
     getLogger(): Logger;
 }
+
+export interface SharesService {
+    isOwnVolume(volumeId: string): Promise<boolean>;
+}

package/src/internal/nodes/apiService.test.ts

@@ -1,7 +1,8 @@
 import { MemberRole, NodeType } from '../../interface';
 import { getMockLogger } from '../../tests/logger';
-import { DriveAPIService, ErrorCode } from '../apiService';
+import { DriveAPIService, ErrorCode, InvalidRequirementsAPIError } from '../apiService';
 import { NodeAPIService } from './apiService';
+import { NodeOutOfSyncError } from './errors';
 
 function generateAPIFileNode(linkOverrides = {}, overrides = {}) {
     const node = generateAPINode();
@@ -542,4 +543,37 @@ describe('nodeAPIService', () => {
             }
         });
     });
+
+    describe('renameNode', () => {
+        it('should rename node', async () => {
+            await api.renameNode(
+                'volumeId~nodeId1',
+                { hash: 'originalHash' },
+                { encryptedName: 'encryptedName1', nameSignatureEmail: 'nameSignatureEmail1', hash: 'newHash' },
+            );
+
+            expect(apiMock.put).toHaveBeenCalledWith(
+                'drive/v2/volumes/volumeId/links/nodeId1/rename',
+                {
+                    Name: 'encryptedName1',
+                    NameSignatureEmail: 'nameSignatureEmail1',
+                    Hash: 'newHash',
+                    OriginalHash: 'originalHash',
+                },
+                undefined,
+            );
+        });
+
+        it('should throw error if node is out of sync', async () => {
+            apiMock.put = jest.fn().mockRejectedValue(new InvalidRequirementsAPIError('Node is out of sync'));
+
+            await expect(
+                api.renameNode(
+                    'volumeId~nodeId1',
+                    { hash: 'originalHash' },
+                    { encryptedName: 'encryptedName1', nameSignatureEmail: 'nameSignatureEmail1', hash: 'newHash' },
+                ),
+            ).rejects.toThrow(new NodeOutOfSyncError('Node is out of sync'));
+        });
+    });
 });