@protontech/drive-sdk 0.0.13 → 0.1.0

package/dist/internal/events/interface.d.ts

@@ -1,3 +1,4 @@
+import { Logger } from "../../interface";
 /**
  * Callback that accepts list of Drive events and flag whether no
  * event should be processed, but rather full cache refresh should be
@@ -5,14 +6,23 @@
  *
  * @param fullRefreshVolumeId - ID of the volume that should be fully refreshed.
  */
-export type DriveListener = (events: DriveEvent[], fullRefreshVolumeId?: string) => Promise<void>;
+export type DriveListener = (event: DriveEvent) => Promise<void>;
+export interface Event {
+    eventId: string;
+}
+export interface EventSubscription {
+    dispose(): void;
+}
+export interface LatestEventIdProvider {
+    getLatestEventId(treeEventScopeId: string): string | null;
+}
 /**
  * Generic internal event interface representing a list of events
  * with metadata about the last event ID, whether there are more
  * events to fetch, or whether the listener should refresh its state.
  */
-export type Events<T> = {
-    lastEventId: string;
+export type EventsListWithStatus<T> = {
+    latestEventId: string;
     more: boolean;
     refresh: boolean;
     events: T[];
@@ -20,28 +30,63 @@ export type Events<T> = {
 /**
  * Internal event interface representing a list of specific Drive events.
  */
-export type DriveEvents = Events<DriveEvent>;
-export type DriveEvent = {
-    type: DriveEventType.NodeCreated | DriveEventType.NodeUpdated | DriveEventType.NodeUpdatedMetadata;
+export type DriveEventsListWithStatus = EventsListWithStatus<DriveEvent>;
+type NodeCruEventType = DriveEventType.NodeCreated | DriveEventType.NodeUpdated;
+export type NodeEventType = NodeCruEventType | DriveEventType.NodeDeleted;
+export type NodeEvent = {
+    type: NodeCruEventType;
     nodeUid: string;
     parentNodeUid?: string;
     isTrashed: boolean;
     isShared: boolean;
-    isOwnVolume: boolean;
+    treeEventScopeId: string;
+    eventId: string;
 } | {
     type: DriveEventType.NodeDeleted;
     nodeUid: string;
     parentNodeUid?: string;
-    isTrashed?: boolean;
-    isShared?: boolean;
-    isOwnVolume: boolean;
-} | {
-    type: DriveEventType.ShareWithMeUpdated;
+    treeEventScopeId: string;
+    eventId: string;
+};
+export type FastForwardEvent = {
+    type: DriveEventType.FastForward;
+    treeEventScopeId: string;
+    eventId: string;
+};
+export type TreeRefreshEvent = {
+    type: DriveEventType.TreeRefresh;
+    treeEventScopeId: string;
+    eventId: string;
 };
+export type TreeRemovalEvent = {
+    type: DriveEventType.TreeRemove;
+    treeEventScopeId: string;
+    eventId: 'none';
+};
+export type SharedWithMeUpdated = {
+    type: DriveEventType.SharedWithMeUpdated;
+    eventId: string;
+    treeEventScopeId: 'core';
+};
+export type DriveEvent = NodeEvent | FastForwardEvent | TreeRefreshEvent | TreeRemovalEvent | FastForwardEvent | SharedWithMeUpdated;
 export declare enum DriveEventType {
     NodeCreated = "node_created",
     NodeUpdated = "node_updated",
-    NodeUpdatedMetadata = "node_updated_metadata",
     NodeDeleted = "node_deleted",
-    ShareWithMeUpdated = "share_with_me_updated"
+    SharedWithMeUpdated = "shared_with_me_updated",
+    TreeRefresh = "tree_refresh",
+    TreeRemove = "tree_remove",
+    FastForward = "fast_forward"
+}
+/**
+ * This can happen if all shared nodes in that volume where unshared or if the
+ * volume was deleted.
+ */
+export declare class UnsubscribeFromEventsSourceError extends Error {
+}
+export interface EventManagerInterface<T> {
+    getLatestEventId(): Promise<string>;
+    getEvents(eventId: string): AsyncIterable<T>;
+    getLogger(): Logger;
 }
+export {};

package/dist/internal/events/interface.js

@@ -1,12 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DriveEventType = void 0;
+exports.UnsubscribeFromEventsSourceError = exports.DriveEventType = void 0;
 var DriveEventType;
 (function (DriveEventType) {
     DriveEventType["NodeCreated"] = "node_created";
     DriveEventType["NodeUpdated"] = "node_updated";
-    DriveEventType["NodeUpdatedMetadata"] = "node_updated_metadata";
     DriveEventType["NodeDeleted"] = "node_deleted";
-    DriveEventType["ShareWithMeUpdated"] = "share_with_me_updated";
+    DriveEventType["SharedWithMeUpdated"] = "shared_with_me_updated";
+    DriveEventType["TreeRefresh"] = "tree_refresh";
+    DriveEventType["TreeRemove"] = "tree_remove";
+    DriveEventType["FastForward"] = "fast_forward";
 })(DriveEventType || (exports.DriveEventType = DriveEventType = {}));
+/**
+ * This can happen if all shared nodes in that volume where unshared or if the
+ * volume was deleted.
+ */
+class UnsubscribeFromEventsSourceError extends Error {
+}
+exports.UnsubscribeFromEventsSourceError = UnsubscribeFromEventsSourceError;
+;
 //# sourceMappingURL=interface.js.map

package/dist/internal/events/interface.js.map

@@ -1 +1 @@
-{"version":3,"file":"interface.js","sourceRoot":"","sources":["../../../src/internal/events/interface.ts"],"names":[],"mappings":";;;AA4CA,IAAY,cAMX;AAND,WAAY,cAAc;IACtB,8CAA4B,CAAA;IAC5B,8CAA4B,CAAA;IAC5B,+DAA6C,CAAA;IAC7C,8CAA4B,CAAA;IAC5B,8DAA4C,CAAA;AAChD,CAAC,EANW,cAAc,8BAAd,cAAc,QAMzB"}
+{"version":3,"file":"interface.js","sourceRoot":"","sources":["../../../src/internal/events/interface.ts"],"names":[],"mappings":";;;AAqFA,IAAY,cAQX;AARD,WAAY,cAAc;IACtB,8CAA4B,CAAA;IAC5B,8CAA4B,CAAA;IAC5B,8CAA4B,CAAA;IAC5B,gEAA8C,CAAA;IAC9C,8CAA4B,CAAA;IAC5B,4CAA0B,CAAA;IAC1B,8CAA4B,CAAA;AAChC,CAAC,EARW,cAAc,8BAAd,cAAc,QAQzB;AAED;;;GAGG;AACH,MAAa,gCAAiC,SAAQ,KAAK;CAAG;AAA9D,4EAA8D;AAAA,CAAC"}

package/dist/internal/events/volumeEventManager.d.ts

@@ -1,27 +1,17 @@
 import { Logger } from "../../interface";
 import { EventsAPIService } from "./apiService";
-import { EventsCache } from "./cache";
-import { DriveListener } from "./interface";
+import { DriveEvent, EventManagerInterface } from "./interface";
 /**
  * Combines API and event manager to provide a service for listening to
  * volume events. Volume events are all about nodes updates. Whenever
  * there is update to the node metadata or content, the event is emitted.
  */
-export declare class VolumeEventManager {
+export declare class VolumeEventManager implements EventManagerInterface<DriveEvent> {
+    private logger;
     private apiService;
-    private cache;
     private volumeId;
-    private manager;
-    constructor(logger: Logger, apiService: EventsAPIService, cache: EventsCache, volumeId: string, isOwnVolume: boolean);
-    private getLastEventId;
-    /**
-     * There is a limit how many volume subscribtions can be active at
-     * the same time. The manager of all volume managers should set the
-     * intervals for each volume accordingly depending on the volume
-     * type or the total number of subscriptions.
-     */
-    setPollingInterval(pollingIntervalInSeconds: number): void;
-    startSubscription(): Promise<void>;
-    stopSubscription(): Promise<void>;
-    addListener(callback: DriveListener): void;
+    constructor(logger: Logger, apiService: EventsAPIService, volumeId: string);
+    getLogger(): Logger;
+    getEvents(eventId: string): AsyncIterable<DriveEvent>;
+    getLatestEventId(): Promise<string>;
 }

package/dist/internal/events/volumeEventManager.js

@@ -2,67 +2,80 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VolumeEventManager = void 0;
 const telemetry_1 = require("../../telemetry");
-const eventManager_1 = require("./eventManager");
+const interface_1 = require("./interface");
+const apiService_1 = require("../apiService");
 /**
  * Combines API and event manager to provide a service for listening to
  * volume events. Volume events are all about nodes updates. Whenever
  * there is update to the node metadata or content, the event is emitted.
  */
 class VolumeEventManager {
+    logger;
     apiService;
-    cache;
     volumeId;
-    manager;
-    constructor(logger, apiService, cache, volumeId, isOwnVolume) {
+    constructor(logger, apiService, volumeId) {
+        this.logger = logger;
         this.apiService = apiService;
-        this.cache = cache;
         this.volumeId = volumeId;
         this.apiService = apiService;
         this.volumeId = volumeId;
-        this.manager = new eventManager_1.EventManager(new telemetry_1.LoggerWithPrefix(logger, `volume ${volumeId}`), () => this.getLastEventId(), (eventId) => this.apiService.getVolumeEvents(volumeId, eventId, isOwnVolume), (lastEventId) => this.cache.setLastEventId(volumeId, {
-            lastEventId,
-            pollingIntervalInSeconds: this.manager.pollingIntervalInSeconds,
-            isOwnVolume
-        }));
-        this.cache.getPollingIntervalInSeconds(volumeId)
-            .then((pollingIntervalInSeconds) => {
-            if (pollingIntervalInSeconds) {
-                this.manager.pollingIntervalInSeconds = pollingIntervalInSeconds;
-            }
-        })
-            .catch(() => { });
-    }
-    async getLastEventId() {
-        const lastEventId = await this.cache.getLastEventId(this.volumeId);
-        if (lastEventId) {
-            return lastEventId;
-        }
-        return this.apiService.getVolumeLatestEventId(this.volumeId);
+        this.logger = new telemetry_1.LoggerWithPrefix(logger, `volume ${volumeId}`);
     }
-    /**
-     * There is a limit how many volume subscribtions can be active at
-     * the same time. The manager of all volume managers should set the
-     * intervals for each volume accordingly depending on the volume
-     * type or the total number of subscriptions.
-     */
-    setPollingInterval(pollingIntervalInSeconds) {
-        this.manager.pollingIntervalInSeconds = pollingIntervalInSeconds;
+    getLogger() {
+        return this.logger;
     }
-    async startSubscription() {
-        await this.manager.start();
-    }
-    async stopSubscription() {
-        await this.manager.stop();
-    }
-    addListener(callback) {
-        this.manager.addListener(async (events, fullRefresh) => {
-            if (fullRefresh) {
-                await callback([], this.volumeId);
+    async *getEvents(eventId) {
+        try {
+            let events;
+            let more = true;
+            while (more) {
+                events = await this.apiService.getVolumeEvents(this.volumeId, eventId);
+                more = events.more;
+                if (events.refresh) {
+                    yield {
+                        type: interface_1.DriveEventType.TreeRefresh,
+                        treeEventScopeId: this.volumeId,
+                        eventId: events.latestEventId,
+                    };
+                    break;
+                }
+                // Update to the latest eventId to avoid inactive volumes from getting out of sync
+                if (events.events.length === 0 && events.latestEventId !== eventId) {
+                    yield {
+                        type: interface_1.DriveEventType.FastForward,
+                        treeEventScopeId: this.volumeId,
+                        eventId: events.latestEventId,
+                    };
+                    break;
+                }
+                yield* events.events;
+                eventId = events.latestEventId;
             }
-            else {
-                await callback(events);
+        }
+        catch (error) {
+            if (error instanceof apiService_1.NotFoundAPIError) {
+                this.logger.info(`Volume events no longer accessible`);
+                yield {
+                    type: interface_1.DriveEventType.TreeRemove,
+                    treeEventScopeId: this.volumeId,
+                    // After a TreeRemoval event, polling should stop.
+                    eventId: 'none',
+                };
             }
-        });
+            throw error;
+        }
+    }
+    async getLatestEventId() {
+        try {
+            return await this.apiService.getVolumeLatestEventId(this.volumeId);
+        }
+        catch (error) {
+            if (error instanceof apiService_1.NotFoundAPIError) {
+                this.logger.info(`Volume events no longer accessible`);
+                throw new interface_1.UnsubscribeFromEventsSourceError(error.message);
+            }
+            throw error;
+        }
     }
 }
 exports.VolumeEventManager = VolumeEventManager;

package/dist/internal/events/volumeEventManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"volumeEventManager.js","sourceRoot":"","sources":["../../../src/internal/events/volumeEventManager.ts"],"names":[],"mappings":";;;AACA,+CAAmD;AAInD,iDAA8C;AAE9C;;;;GAIG;AACH,MAAa,kBAAkB;IAGS;IAAsC;IAA4B;IAF9F,OAAO,CAA2B;IAE1C,YAAY,MAAc,EAAU,UAA4B,EAAU,KAAkB,EAAU,QAAgB,EAAE,WAAoB;QAAxG,eAAU,GAAV,UAAU,CAAkB;QAAU,UAAK,GAAL,KAAK,CAAa;QAAU,aAAQ,GAAR,QAAQ,CAAQ;QAClH,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,IAAI,CAAC,OAAO,GAAG,IAAI,2BAAY,CAC3B,IAAI,4BAAgB,CAAC,MAAM,EAAE,UAAU,QAAQ,EAAE,CAAC,EAClD,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,EAC3B,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,QAAQ,EAAE,OAAO,EAAE,WAAW,CAAC,EAC5E,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,EAAE;YACjD,WAAW;YACX,wBAAwB,EAAE,IAAI,CAAC,OAAO,CAAC,wBAAwB;YAC/D,WAAW;SACd,CAAC,CACL,CAAC;QACF,IAAI,CAAC,KAAK,CAAC,2BAA2B,CAAC,QAAQ,CAAC;aAC3C,IAAI,CAAC,CAAC,wBAAwB,EAAE,EAAE;YAC/B,IAAI,wBAAwB,EAAE,CAAC;gBAC3B,IAAI,CAAC,OAAO,CAAC,wBAAwB,GAAG,wBAAwB,CAAC;YACrE,CAAC;QACL,CAAC,CAAC;aACD,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IACzB,CAAC;IAEO,KAAK,CAAC,cAAc;QACxB,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnE,IAAI,WAAW,EAAE,CAAC;YACd,OAAO,WAAW,CAAC;QACvB,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjE,CAAC;IAED;;;;;OAKG;IACH,kBAAkB,CAAC,wBAAgC;QAC/C,IAAI,CAAC,OAAO,CAAC,wBAAwB,GAAG,wBAAwB,CAAC;IACrE,CAAC;IAED,KAAK,CAAC,iBAAiB;QACnB,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,gBAAgB;QAClB,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;IAC9B,CAAC;IAED,WAAW,CAAC,QAAuB;QAC/B,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE;YACnD,IAAI,WAAW,EAAE,CAAC;gBACd,MAAM,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACtC,CAAC;iBAAM,CAAC;gBACJ,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC3B,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AA7DD,gDA6DC"}
+{"version":3,"file":"volumeEventManager.js","sourceRoot":"","sources":["../../../src/internal/events/volumeEventManager.ts"],"names":[],"mappings":";;;AACA,+CAAmD;AAEnD,2CAA6I;AAC7I,8CAAiD;AAEjD;;;;GAIG;AACH,MAAa,kBAAkB;IAEP;IAAwB;IAAsC;IAAlF,YAAoB,MAAc,EAAU,UAA4B,EAAU,QAAgB;QAA9E,WAAM,GAAN,MAAM,CAAQ;QAAU,eAAU,GAAV,UAAU,CAAkB;QAAU,aAAQ,GAAR,QAAQ,CAAQ;QAC9F,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,IAAI,4BAAgB,CAAC,MAAM,EAAE,UAAU,QAAQ,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,CAAE,SAAS,CAAC,OAAe;QAC7B,IAAI,CAAC;YACD,IAAI,MAAiC,CAAC;YACtC,IAAI,IAAI,GAAG,IAAI,CAAC;YAChB,OAAO,IAAI,EAAE,CAAC;gBACV,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBACvE,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;gBACnB,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;oBACjB,MAAM;wBACF,IAAI,EAAE,0BAAc,CAAC,WAAW;wBAChC,gBAAgB,EAAE,IAAI,CAAC,QAAQ;wBAC/B,OAAO,EAAE,MAAM,CAAC,aAAa;qBAChC,CAAC;oBACF,MAAM;gBACV,CAAC;gBACD,kFAAkF;gBAClF,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,aAAa,KAAK,OAAO,EAAE,CAAC;oBACjE,MAAM;wBACF,IAAI,EAAE,0BAAc,CAAC,WAAW;wBAChC,gBAAgB,EAAE,IAAI,CAAC,QAAQ;wBAC/B,OAAO,EAAE,MAAM,CAAC,aAAa;qBAChC,CAAC;oBACF,MAAM;gBACV,CAAC;gBACD,KAAK,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;gBACrB,OAAO,GAAG,MAAM,CAAC,aAAa,CAAC;YACnC,CAAC;QACL,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACtB,IAAI,KAAK,YAAY,6BAAgB,EAAE,CAAC;gBACpC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;gBACvD,MAAM;oBACF,IAAI,EAAE,0BAAc,CAAC,UAAU;oBAC/B,gBAAgB,EAAE,IAAI,CAAC,QAAQ;oBAC/B,kDAAkD;oBAClD,OAAO,EAAE,MAAM;iBAClB,CAAC;YACN,CAAC;YACD,MAAM,KAAK,CAAC;QAChB,CAAC;IACL,CAAC;IAED,KAAK,CAAC,gBAAgB;QAClB,IAAI,CAAC;YACD,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvE,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACtB,IAAI,KAAK,YAAY,6BAAgB,EAAE,CAAC;gBACpC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;gBACvD,MAAM,IAAI,4CAAgC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC9D,CAAC;YACD,MAAM,KAAK,CAAC;QAChB,CAAC;IACL,CAAC;CACJ;AAhED,gDAgEC"}

package/dist/internal/events/volumeEventManager.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/internal/events/volumeEventManager.test.js

@@ -0,0 +1,203 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const logger_1 = require("../../tests/logger");
+const apiService_1 = require("../apiService");
+const volumeEventManager_1 = require("./volumeEventManager");
+const interface_1 = require("./interface");
+jest.mock("./apiService");
+describe("VolumeEventManager", () => {
+    let manager;
+    let mockEventsAPIService;
+    const mockLogger = (0, logger_1.getMockLogger)();
+    const volumeId = "volumeId123";
+    beforeEach(() => {
+        jest.clearAllMocks();
+        mockEventsAPIService = {
+            getVolumeLatestEventId: jest.fn(),
+            getVolumeEvents: jest.fn(),
+            getCoreLatestEventId: jest.fn(),
+            getCoreEvents: jest.fn(),
+        };
+        manager = new volumeEventManager_1.VolumeEventManager(mockLogger, mockEventsAPIService, volumeId);
+    });
+    describe("getLatestEventId", () => {
+        it("should return the latest event ID from API", async () => {
+            const expectedEventId = "eventId123";
+            mockEventsAPIService.getVolumeLatestEventId.mockResolvedValue(expectedEventId);
+            const result = await manager.getLatestEventId();
+            expect(result).toBe(expectedEventId);
+            expect(mockEventsAPIService.getVolumeLatestEventId).toHaveBeenCalledWith(volumeId);
+        });
+        it("should throw UnsubscribeFromEventsSourceError when API returns NotFoundAPIError", async () => {
+            const notFoundError = new apiService_1.NotFoundAPIError("Event not found", 2501);
+            mockEventsAPIService.getVolumeLatestEventId.mockRejectedValue(notFoundError);
+            await expect(manager.getLatestEventId()).rejects.toThrow("Event not found");
+        });
+        it("should rethrow other errors", async () => {
+            const networkError = new Error("Network error");
+            mockEventsAPIService.getVolumeLatestEventId.mockRejectedValue(networkError);
+            await expect(manager.getLatestEventId()).rejects.toThrow("Network error");
+        });
+    });
+    describe("getEvents", () => {
+        it("should yield events from API response", async () => {
+            const mockEventsResponse = {
+                latestEventId: "eventId456",
+                more: false,
+                refresh: false,
+                events: [
+                    {
+                        type: interface_1.DriveEventType.NodeCreated,
+                        nodeUid: "node1",
+                        parentNodeUid: "parent1",
+                        isTrashed: false,
+                        isShared: false,
+                        treeEventScopeId: volumeId,
+                        eventId: "eventId456",
+                    }
+                ],
+            };
+            mockEventsAPIService.getVolumeEvents.mockResolvedValue(mockEventsResponse);
+            const events = [];
+            for await (const event of manager.getEvents("startEventId")) {
+                events.push(event);
+            }
+            expect(events).toEqual(mockEventsResponse.events);
+            expect(mockEventsAPIService.getVolumeEvents).toHaveBeenCalledWith(volumeId, "startEventId");
+        });
+        it("should continue fetching when more events are available", async () => {
+            const firstResponse = {
+                latestEventId: "eventId2",
+                more: true,
+                refresh: false,
+                events: [
+                    {
+                        type: interface_1.DriveEventType.NodeCreated,
+                        nodeUid: "node1",
+                        parentNodeUid: "parent1",
+                        isTrashed: false,
+                        isShared: false,
+                        treeEventScopeId: volumeId,
+                        eventId: "eventId2",
+                    }
+                ],
+            };
+            const secondResponse = {
+                latestEventId: "eventId3",
+                more: false,
+                refresh: false,
+                events: [
+                    {
+                        type: interface_1.DriveEventType.NodeUpdated,
+                        nodeUid: "node2",
+                        parentNodeUid: "parent1",
+                        isTrashed: false,
+                        isShared: false,
+                        treeEventScopeId: volumeId,
+                        eventId: "eventId3",
+                    }
+                ],
+            };
+            mockEventsAPIService.getVolumeEvents
+                .mockResolvedValueOnce(firstResponse)
+                .mockResolvedValueOnce(secondResponse);
+            const events = [];
+            for await (const event of manager.getEvents("startEventId")) {
+                events.push(event);
+            }
+            expect(events).toHaveLength(2);
+            expect(events[0]).toEqual(firstResponse.events[0]);
+            expect(events[1]).toEqual(secondResponse.events[0]);
+            expect(mockEventsAPIService.getVolumeEvents).toHaveBeenCalledTimes(2);
+            expect(mockEventsAPIService.getVolumeEvents).toHaveBeenNthCalledWith(1, volumeId, "startEventId");
+            expect(mockEventsAPIService.getVolumeEvents).toHaveBeenNthCalledWith(2, volumeId, "eventId2");
+        });
+        it("should yield TreeRefresh event when refresh is true", async () => {
+            const mockEventsResponse = {
+                latestEventId: "eventId789",
+                more: false,
+                refresh: true,
+                events: [],
+            };
+            mockEventsAPIService.getVolumeEvents.mockResolvedValue(mockEventsResponse);
+            const events = [];
+            for await (const event of manager.getEvents("startEventId")) {
+                events.push(event);
+            }
+            expect(events).toHaveLength(1);
+            expect(events[0]).toEqual({
+                type: interface_1.DriveEventType.TreeRefresh,
+                treeEventScopeId: volumeId,
+                eventId: "eventId789",
+            });
+        });
+        it("should yield FastForward event when no events but eventId changed", async () => {
+            const mockEventsResponse = {
+                latestEventId: "newEventId",
+                more: false,
+                refresh: false,
+                events: [],
+            };
+            mockEventsAPIService.getVolumeEvents.mockResolvedValue(mockEventsResponse);
+            const events = [];
+            for await (const event of manager.getEvents("oldEventId")) {
+                events.push(event);
+            }
+            expect(events).toHaveLength(1);
+            expect(events[0]).toEqual({
+                type: interface_1.DriveEventType.FastForward,
+                treeEventScopeId: volumeId,
+                eventId: "newEventId",
+            });
+        });
+        it("should yield TreeRemove event when API returns NotFoundAPIError", async () => {
+            const notFoundError = new apiService_1.NotFoundAPIError("Volume not found", 2501);
+            mockEventsAPIService.getVolumeEvents.mockRejectedValue(notFoundError);
+            const events = [];
+            try {
+                for await (const event of manager.getEvents("startEventId")) {
+                    events.push(event);
+                }
+            }
+            catch (error) {
+                // The error should be re-thrown, but first it should yield a TreeRemove event
+                expect(error).toBe(notFoundError);
+            }
+            expect(events).toHaveLength(1);
+            expect(events[0]).toEqual({
+                type: interface_1.DriveEventType.TreeRemove,
+                treeEventScopeId: volumeId,
+                eventId: 'none',
+            });
+        });
+        it("should rethrow non-NotFoundAPIError errors", async () => {
+            const networkError = new Error("Network error");
+            mockEventsAPIService.getVolumeEvents.mockRejectedValue(networkError);
+            const eventGenerator = manager.getEvents("startEventId");
+            const eventIterator = eventGenerator[Symbol.asyncIterator]();
+            await expect(eventIterator.next()).rejects.toThrow("Network error");
+        });
+        it("should not yield events when events array is empty and eventId unchanged", async () => {
+            const mockEventsResponse = {
+                latestEventId: "sameEventId",
+                more: false,
+                refresh: false,
+                events: [],
+            };
+            mockEventsAPIService.getVolumeEvents.mockResolvedValue(mockEventsResponse);
+            const events = [];
+            for await (const event of manager.getEvents("sameEventId")) {
+                events.push(event);
+            }
+            expect(events).toHaveLength(0);
+        });
+    });
+    describe("getLogger", () => {
+        it("should return logger with prefix", () => {
+            const logger = manager.getLogger();
+            expect(logger).toBeDefined();
+            // The logger should be wrapped with LoggerWithPrefix, but we can't easily test the prefix
+        });
+    });
+});
+//# sourceMappingURL=volumeEventManager.test.js.map

package/dist/internal/events/volumeEventManager.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"volumeEventManager.test.js","sourceRoot":"","sources":["../../../src/internal/events/volumeEventManager.test.ts"],"names":[],"mappings":";;AAAA,+CAAmD;AACnD,8CAAiD;AAEjD,6DAA0D;AAC1D,2CAAwE;AAExE,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;AAE1B,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAChC,IAAI,OAA2B,CAAC;IAChC,IAAI,oBAAmD,CAAC;IACxD,MAAM,UAAU,GAAG,IAAA,sBAAa,GAAE,CAAC;IACnC,MAAM,QAAQ,GAAG,aAAa,CAAC;IAE/B,UAAU,CAAC,GAAG,EAAE;QACZ,IAAI,CAAC,aAAa,EAAE,CAAC;QAErB,oBAAoB,GAAG;YACnB,sBAAsB,EAAE,IAAI,CAAC,EAAE,EAAE;YACjC,eAAe,EAAE,IAAI,CAAC,EAAE,EAAE;YAC1B,oBAAoB,EAAE,IAAI,CAAC,EAAE,EAAE;YAC/B,aAAa,EAAE,IAAI,CAAC,EAAE,EAAE;SACpB,CAAC;QAET,OAAO,GAAG,IAAI,uCAAkB,CAC5B,UAAU,EACV,oBAAoB,EACpB,QAAQ,CACX,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;YACxD,MAAM,eAAe,GAAG,YAAY,CAAC;YACrC,oBAAoB,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;YAE/E,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAEhD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YACrC,MAAM,CAAC,oBAAoB,CAAC,sBAAsB,CAAC,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QACvF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iFAAiF,EAAE,KAAK,IAAI,EAAE;YAC7F,MAAM,aAAa,GAAG,IAAI,6BAAgB,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;YACpE,oBAAoB,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;YAE7E,MAAM,MAAM,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QAChF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;YACzC,MAAM,YAAY,GAAG,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;YAChD,oBAAoB,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAE5E,MAAM,MAAM,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QAC9E,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;QACvB,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;YACnD,MAAM,kBAAkB,GAA8B;gBAClD,aAAa,EAAE,YAAY;gBAC3B,IAAI,EAAE,KAAK;gBACX,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE;oBACJ;wBACI,IAAI,EAAE,0BAAc,CAAC,WAAW;wBAChC,OAAO,EAAE,OAAO;wBAChB,aAAa,EAAE,SAAS;wBACxB,SAAS,EAAE,KAAK;wBAChB,QAAQ,EAAE,KAAK;wBACf,gBAAgB,EAAE,QAAQ;wBAC1B,OAAO,EAAE,YAAY;qBACxB;iBACJ;aACJ,CAAC;YAEF,oBAAoB,CAAC,eAAe,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;YAE3E,MAAM,MAAM,GAAG,EAAE,CAAC;YAClB,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC;gBAC1D,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvB,CAAC;YAED,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAClD,MAAM,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC,oBAAoB,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QAChG,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;YACrE,MAAM,aAAa,GAA8B;gBAC7C,aAAa,EAAE,UAAU;gBACzB,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE;oBACJ;wBACI,IAAI,EAAE,0BAAc,CAAC,WAAW;wBAChC,OAAO,EAAE,OAAO;wBAChB,aAAa,EAAE,SAAS;wBACxB,SAAS,EAAE,KAAK;wBAChB,QAAQ,EAAE,KAAK;wBACf,gBAAgB,EAAE,QAAQ;wBAC1B,OAAO,EAAE,UAAU;qBACtB;iBACJ;aACJ,CAAC;YAEF,MAAM,cAAc,GAA8B;gBAC9C,aAAa,EAAE,UAAU;gBACzB,IAAI,EAAE,KAAK;gBACX,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE;oBACJ;wBACI,IAAI,EAAE,0BAAc,CAAC,WAAW;wBAChC,OAAO,EAAE,OAAO;wBAChB,aAAa,EAAE,SAAS;wBACxB,SAAS,EAAE,KAAK;wBAChB,QAAQ,EAAE,KAAK;wBACf,gBAAgB,EAAE,QAAQ;wBAC1B,OAAO,EAAE,UAAU;qBACtB;iBACJ;aACJ,CAAC;YAEF,oBAAoB,CAAC,eAAe;iBAC/B,qBAAqB,CAAC,aAAa,CAAC;iBACpC,qBAAqB,CAAC,cAAc,CAAC,CAAC;YAE3C,MAAM,MAAM,GAAG,EAAE,CAAC;YAClB,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC;gBAC1D,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvB,CAAC;YAED,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YACnD,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YACpD,MAAM,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YACtE,MAAM,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC;YAClG,MAAM,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;QAClG,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;YACjE,MAAM,kBAAkB,GAA8B;gBAClD,aAAa,EAAE,YAAY;gBAC3B,IAAI,EAAE,KAAK;gBACX,OAAO,EAAE,IAAI;gBACb,MAAM,EAAE,EAAE;aACb,CAAC;YAEF,oBAAoB,CAAC,eAAe,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;YAE3E,MAAM,MAAM,GAAG,EAAE,CAAC;YAClB,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC;gBAC1D,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvB,CAAC;YAED,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;gBACtB,IAAI,EAAE,0BAAc,CAAC,WAAW;gBAChC,gBAAgB,EAAE,QAAQ;gBAC1B,OAAO,EAAE,YAAY;aACxB,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mEAAmE,EAAE,KAAK,IAAI,EAAE;YAC/E,MAAM,kBAAkB,GAA8B;gBAClD,aAAa,EAAE,YAAY;gBAC3B,IAAI,EAAE,KAAK;gBACX,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,EAAE;aACb,CAAC;YAEF,oBAAoB,CAAC,eAAe,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;YAE3E,MAAM,MAAM,GAAG,EAAE,CAAC;YAClB,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,CAAC;gBACxD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvB,CAAC;YAED,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;gBACtB,IAAI,EAAE,0BAAc,CAAC,WAAW;gBAChC,gBAAgB,EAAE,QAAQ;gBAC1B,OAAO,EAAE,YAAY;aACxB,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;YAC7E,MAAM,aAAa,GAAG,IAAI,6BAAgB,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC;YACrE,oBAAoB,CAAC,eAAe,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;YAEtE,MAAM,MAAM,GAAG,EAAE,CAAC;YAClB,IAAI,CAAC;gBACD,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC;oBAC1D,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC;YACL,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,8EAA8E;gBAC9E,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACtC,CAAC;YAED,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;gBACtB,IAAI,EAAE,0BAAc,CAAC,UAAU;gBAC/B,gBAAgB,EAAE,QAAQ;gBAC1B,OAAO,EAAE,MAAM;aAClB,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;YACxD,MAAM,YAAY,GAAG,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;YAChD,oBAAoB,CAAC,eAAe,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAErE,MAAM,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;YACzD,MAAM,aAAa,GAAG,cAAc,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;YAC7D,MAAM,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QACxE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;YACtF,MAAM,kBAAkB,GAA8B;gBAClD,aAAa,EAAE,aAAa;gBAC5B,IAAI,EAAE,KAAK;gBACX,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,EAAE;aACb,CAAC;YAEF,oBAAoB,CAAC,eAAe,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;YAE3E,MAAM,MAAM,GAAG,EAAE,CAAC;YAClB,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC;gBACzD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvB,CAAC;YAED,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;QACvB,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;YACxC,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;YACnC,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;YAC7B,0FAA0F;QAC9F,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

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

@@ -1,8 +1,10 @@
+import { EntityResult } from "../../cache";
 import { ProtonDriveEntitiesCache, Logger } from "../../interface";
 import { DecryptedNode } from "./interface";
 export declare enum CACHE_TAG_KEYS {
     ParentUid = "nodeParentUid",
-    Trashed = "nodeTrashed"
+    Trashed = "nodeTrashed",
+    Roots = "nodeRoot"
 }
 type DecryptedNodeResult = ({
     uid: string;
@@ -33,6 +35,12 @@ export declare class NodesCache {
      * which nodes were up-to-date anymore.
      */
     setNodesStaleFromVolume(volumeId: string): Promise<void>;
+    /**
+     * Remove all entries associated with a volume.
+     *
+     * This is needed when a user looses access to a volume.
+     */
+    removeVolume(volumeId: string): Promise<void>;
     /**
      * Remove corrupted node never throws, but it logs so we can know
      * about issues and fix them. It is crucial to remove corrupted
@@ -44,6 +52,7 @@ export declare class NodesCache {
     private getRecursiveChildrenCacheUids;
     iterateNodes(nodeUids: string[]): AsyncGenerator<DecryptedNodeResult>;
     iterateChildren(parentNodeUid: string): AsyncGenerator<DecryptedNodeResult>;
+    iterateRootNodeUids(volumeId: string): AsyncGenerator<EntityResult<string>>;
     iterateTrashedNodes(): AsyncGenerator<DecryptedNodeResult>;
     /**
      * Converts result from the cache with cache UID and data to result of node

package/dist/internal/nodes/cache.js

@@ -7,6 +7,7 @@ var CACHE_TAG_KEYS;
 (function (CACHE_TAG_KEYS) {
     CACHE_TAG_KEYS["ParentUid"] = "nodeParentUid";
     CACHE_TAG_KEYS["Trashed"] = "nodeTrashed";
+    CACHE_TAG_KEYS["Roots"] = "nodeRoot";
 })(CACHE_TAG_KEYS || (exports.CACHE_TAG_KEYS = CACHE_TAG_KEYS = {}));
 /**
  * Provides caching for nodes metadata.
@@ -33,6 +34,9 @@ class NodesCache {
         if (node.parentUid) {
             tags.push(`${CACHE_TAG_KEYS.ParentUid}:${node.parentUid}`);
         }
+        else {
+            tags.push(`${CACHE_TAG_KEYS.Roots}:${volumeId}`);
+        }
         if (node.trashTime) {
             tags.push(`${CACHE_TAG_KEYS.Trashed}`);
         }
@@ -67,6 +71,16 @@ class NodesCache {
             await this.driveCache.removeEntities([result.key]);
         }
     }
+    /**
+     * Remove all entries associated with a volume.
+     *
+     * This is needed when a user looses access to a volume.
+     */
+    async removeVolume(volumeId) {
+        for await (const result of this.iterateRootNodeUids(volumeId)) {
+            await this.removeNodes([result.key]);
+        }
+    }
     /**
      * Remove corrupted node never throws, but it logs so we can know
      * about issues and fix them. It is crucial to remove corrupted
@@ -133,6 +147,9 @@ class NodesCache {
             }
         }
     }
+    async *iterateRootNodeUids(volumeId) {
+        yield* this.driveCache.iterateEntitiesByTag(`${CACHE_TAG_KEYS.Roots}:${volumeId}`);
+    }
     async *iterateTrashedNodes() {
         for await (const result of this.driveCache.iterateEntitiesByTag(CACHE_TAG_KEYS.Trashed)) {
             const node = await this.convertCacheResult(result);