@protontech/drive-sdk 0.1.1 → 0.2.0

package/src/internal/events/index.ts

@@ -21,7 +21,7 @@ const CORE_POLLING_INTERVAL = 30;
  */
 export class DriveEventsService {
     private apiService: EventsAPIService;
-    private coreEvents?: EventManager<DriveEvent>;
+    private coreEventManager?: EventManager<DriveEvent>;
     private volumeEventManagers: { [volumeId: string]: EventManager<DriveEvent> };
     private logger: Logger;
 
@@ -38,20 +38,16 @@ export class DriveEventsService {
         this.volumeEventManagers = {};
     }
 
-    /**
-     * Subscribe to drive events. The treeEventScopeId can be obtained from a node.
-     */
-    async subscribeToTreeEvents(treeEventScopeId: string, callback: DriveListener): Promise<EventSubscription> {
-        const volumeId = treeEventScopeId;
-        this.logger.debug(`Creating volume event manager for volume ${volumeId}`);
-        let manager = this.volumeEventManagers[volumeId];
-        let started = true;
+    // FIXME: Allow to pass own core events manager from the public interface.
+    async subscribeToCoreEvents(callback: DriveListener): Promise<EventSubscription> {
+        let manager = this.coreEventManager;
+        const started = !!manager;
+
         if (manager === undefined) {
-            manager = await this.createVolumeEventManager(volumeId);
-            this.volumeEventManagers[volumeId] = manager;
-            started = false;
-            this.sendNumberOfVolumeSubscriptionsToTelemetry();
+            manager = await this.createCoreEventManager();
+            this.coreEventManager = manager;
         }
+
         const eventSubscription = manager.addListener(callback);
         if (!started) {
             await manager.start();
@@ -59,53 +55,75 @@ export class DriveEventsService {
         return eventSubscription;
     }
 
-    // FIXME: Allow to pass own core events manager from the public interface.
-    async subscribeToCoreEvents(callback: DriveListener): Promise<EventSubscription> {
-        if (this.latestEventIdProvider === null || this.latestEventIdProvider === undefined) {
+    private async createCoreEventManager() {
+        if (!this.latestEventIdProvider) {
             throw new Error(
                 'Cannot subscribe to events without passing a latestEventIdProvider in ProtonDriveClient initialization',
             );
         }
-        if (this.coreEvents === undefined) {
-            const coreEventManager = new CoreEventManager(this.logger, this.apiService);
-            const latestEventId = this.latestEventIdProvider.getLatestEventId('core') ?? null;
-            this.coreEvents = new EventManager(coreEventManager, CORE_POLLING_INTERVAL, latestEventId);
-            for (const listener of this.cacheEventListeners) {
-                this.coreEvents.addListener(listener);
-            }
+
+        const coreEventManager = new CoreEventManager(this.logger, this.apiService);
+        const latestEventId = this.latestEventIdProvider.getLatestEventId('core') ?? null;
+        const eventManager = new EventManager(coreEventManager, CORE_POLLING_INTERVAL, latestEventId);
+
+        for (const listener of this.cacheEventListeners) {
+            eventManager.addListener(listener);
         }
-        const eventSubscription = this.coreEvents.addListener(callback);
-        await this.coreEvents.start();
-        return eventSubscription;
+
+        return eventManager;
     }
 
-    private sendNumberOfVolumeSubscriptionsToTelemetry() {
-        this.telemetry.logEvent({
-            eventName: 'volumeEventsSubscriptionsChanged',
-            numberOfVolumeSubscriptions: Object.keys(this.volumeEventManagers).length,
-        });
+    /**
+     * Subscribe to drive events. The treeEventScopeId can be obtained from a node.
+     */
+    async subscribeToTreeEvents(treeEventScopeId: string, callback: DriveListener): Promise<EventSubscription> {
+        const volumeId = treeEventScopeId;
+        let manager = this.volumeEventManagers[volumeId];
+        const started = !!manager;
+
+        if (manager === undefined) {
+            manager = await this.createVolumeEventManager(volumeId);
+            this.volumeEventManagers[volumeId] = manager;
+        }
+
+        const eventSubscription = manager.addListener(callback);
+        if (!started) {
+            await manager.start();
+            this.sendNumberOfVolumeSubscriptionsToTelemetry();
+        }
+        return eventSubscription;
     }
 
     private async createVolumeEventManager(volumeId: string): Promise<EventManager<DriveEvent>> {
-        if (this.latestEventIdProvider === null || this.latestEventIdProvider === undefined) {
+        if (!this.latestEventIdProvider) {
             throw new Error(
                 'Cannot subscribe to events without passing a latestEventIdProvider in ProtonDriveClient initialization',
             );
         }
+
+        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 pollingInterval = this.getDefaultVolumePollingInterval(isOwnVolume);
-        const volumeEventManager = new VolumeEventManager(this.logger, this.apiService, volumeId);
         const latestEventId = this.latestEventIdProvider.getLatestEventId(volumeId);
         const eventManager = new EventManager<DriveEvent>(volumeEventManager, pollingInterval, latestEventId);
+
         for (const listener of this.cacheEventListeners) {
             eventManager.addListener(listener);
         }
-        await eventManager.start();
-        this.volumeEventManagers[volumeId] = eventManager;
+
         return eventManager;
     }
 
     private getDefaultVolumePollingInterval(isOwnVolume: boolean): number {
         return isOwnVolume ? OWN_VOLUME_POLLING_INTERVAL : OTHER_VOLUME_POLLING_INTERVAL;
     }
+
+    private sendNumberOfVolumeSubscriptionsToTelemetry() {
+        this.telemetry.recordMetric({
+            eventName: 'volumeEventsSubscriptionsChanged',
+            numberOfVolumeSubscriptions: Object.keys(this.volumeEventManagers).length,
+        });
+    }
 }

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

@@ -76,7 +76,7 @@ function generateAPINode() {
     };
 }
 
-function generateFileNode(overrides = {}) {
+function generateFileNode(overrides = {}, encryptedCryptoOverrides = {}) {
     const node = generateNode();
     return {
         ...node,
@@ -98,12 +98,13 @@ function generateFileNode(overrides = {}) {
                 armoredExtendedAttributes: '{file}',
                 thumbnails: [],
             },
+            ...encryptedCryptoOverrides,
         },
         ...overrides,
     };
 }
 
-function generateFolderNode(overrides = {}) {
+function generateFolderNode(overrides = {}, encryptedCryptoOverrides = {}) {
     const node = generateNode();
     return {
         ...node,
@@ -114,6 +115,7 @@ function generateFolderNode(overrides = {}) {
                 armoredHashKey: 'nodeHashKey',
                 armoredExtendedAttributes: '{folder}',
             },
+            ...encryptedCryptoOverrides,
         },
         ...overrides,
     };
@@ -140,7 +142,8 @@ function generateNode() {
 
         shareId: undefined,
         isShared: false,
-        directMemberRole: MemberRole.Admin,
+        directRole: MemberRole.Admin,
+        membership: undefined,
 
         encryptedCrypto: {
             armoredKey: 'nodeKey',
@@ -148,6 +151,7 @@ function generateNode() {
             armoredNodePassphraseSignature: 'nodePassSig',
             nameSignatureEmail: 'nameSigEmail',
             signatureEmail: 'sigEmail',
+            membership: undefined,
         },
     };
 }
@@ -211,14 +215,34 @@ describe('nodeAPIService', () => {
                         },
                         Membership: {
                             Permissions: 22,
+                            InviteTime: 1234567890,
+                            InviterEmail: 'inviterEmail',
+                            MemberSharePassphraseKeyPacket: 'memberSharePassphraseKeyPacket',
+                            InviterSharePassphraseKeyPacketSignature: 'inviterSharePassphraseKeyPacketSignature',
+                            InviteeSharePassphraseSessionKeySignature: 'inviteeSharePassphraseSessionKeySignature',
+                        },
+                    },
+                ),
+                generateFolderNode(
+                    {
+                        isShared: true,
+                        shareId: 'shareId',
+                        directRole: MemberRole.Admin,
+                        membership: {
+                            role: MemberRole.Admin,
+                            inviteTime: new Date(1234567890000),
+                        },
+                    },
+                    {
+                        membership: {
+                            inviterEmail: 'inviterEmail',
+                            base64MemberSharePassphraseKeyPacket: 'memberSharePassphraseKeyPacket',
+                            armoredInviterSharePassphraseKeyPacketSignature: 'inviterSharePassphraseKeyPacketSignature',
+                            armoredInviteeSharePassphraseSessionKeySignature:
+                                'inviteeSharePassphraseSessionKeySignature',
                         },
                     },
                 ),
-                generateFolderNode({
-                    isShared: true,
-                    shareId: 'shareId',
-                    directMemberRole: MemberRole.Admin,
-                }),
             );
         });
 
@@ -232,14 +256,34 @@ describe('nodeAPIService', () => {
                         },
                         Membership: {
                             Permissions: 42,
+                            InviteTime: 1234567890,
+                            InviterEmail: 'inviterEmail',
+                            MemberSharePassphraseKeyPacket: 'memberSharePassphraseKeyPacket',
+                            InviterSharePassphraseKeyPacketSignature: 'inviterSharePassphraseKeyPacketSignature',
+                            InviteeSharePassphraseSessionKeySignature: 'inviteeSharePassphraseSessionKeySignature',
+                        },
+                    },
+                ),
+                generateFolderNode(
+                    {
+                        isShared: true,
+                        shareId: 'shareId',
+                        directRole: MemberRole.Viewer,
+                        membership: {
+                            role: MemberRole.Viewer,
+                            inviteTime: new Date(1234567890000),
+                        },
+                    },
+                    {
+                        membership: {
+                            inviterEmail: 'inviterEmail',
+                            base64MemberSharePassphraseKeyPacket: 'memberSharePassphraseKeyPacket',
+                            armoredInviterSharePassphraseKeyPacketSignature: 'inviterSharePassphraseKeyPacketSignature',
+                            armoredInviteeSharePassphraseSessionKeySignature:
+                                'inviteeSharePassphraseSessionKeySignature',
                         },
                     },
                 ),
-                generateFolderNode({
-                    isShared: true,
-                    shareId: 'shareId',
-                    directMemberRole: MemberRole.Viewer,
-                }),
                 'myVolumeId',
             );
         });
@@ -308,12 +352,12 @@ describe('nodeAPIService', () => {
                 generateFolderNode({
                     uid: 'volumeId1~nodeId1',
                     parentUid: 'volumeId1~parentNodeId1',
-                    directMemberRole: MemberRole.Admin,
+                    directRole: MemberRole.Admin,
                 }),
                 generateFolderNode({
                     uid: 'volumeId2~nodeId2',
                     parentUid: 'volumeId2~parentNodeId2',
-                    directMemberRole: MemberRole.Inherited,
+                    directRole: MemberRole.Inherited,
                 }),
             ]);
         });

package/src/internal/nodes/apiService.ts

@@ -8,7 +8,7 @@ import {
     drivePaths,
     isCodeOk,
     nodeTypeNumberToNodeType,
-    permissionsToDirectMemberRole,
+    permissionsToMemberRole,
 } from '../apiService';
 import { asyncIteratorRace } from '../asyncIteratorRace';
 import { batch } from '../batch';
@@ -471,6 +471,8 @@ function linkToEncryptedNode(
     link: PostLoadLinksMetadataResponse['Links'][0],
     isAdmin: boolean,
 ): EncryptedNode {
+    const membershipRole = permissionsToMemberRole(logger, link.Membership?.Permissions);
+
     const baseNodeMetadata = {
         // Internal metadata
         hash: link.Link.NameHash || undefined,
@@ -486,16 +488,31 @@ function linkToEncryptedNode(
         // Sharing node metadata
         shareId: link.Sharing?.ShareID || undefined,
         isShared: !!link.Sharing,
-        directMemberRole: isAdmin
-            ? MemberRole.Admin
-            : permissionsToDirectMemberRole(logger, link.Membership?.Permissions),
+        directRole: isAdmin ? MemberRole.Admin : membershipRole,
+        membership: link.Membership
+            ? {
+                  role: membershipRole,
+                  inviteTime: new Date(link.Membership.InviteTime * 1000),
+              }
+            : undefined,
     };
+
     const baseCryptoNodeMetadata = {
         signatureEmail: link.Link.SignatureEmail || undefined,
         nameSignatureEmail: link.Link.NameSignatureEmail || undefined,
         armoredKey: link.Link.NodeKey,
         armoredNodePassphrase: link.Link.NodePassphrase,
         armoredNodePassphraseSignature: link.Link.NodePassphraseSignature,
+        membership: link.Membership
+            ? {
+                  inviterEmail: link.Membership.InviterEmail,
+                  base64MemberSharePassphraseKeyPacket: link.Membership.MemberSharePassphraseKeyPacket,
+                  armoredInviterSharePassphraseKeyPacketSignature:
+                      link.Membership.InviterSharePassphraseKeyPacketSignature,
+                  armoredInviteeSharePassphraseSessionKeySignature:
+                      link.Membership.InviteeSharePassphraseSessionKeySignature,
+              }
+            : undefined,
     };
 
     if (link.Link.Type === 1 && link.Folder) {

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

@@ -12,7 +12,12 @@ function generateNode(
     return {
         uid: `${params.volumeId || 'volumeId'}~:${uid}`,
         parentUid: `${params.volumeId || 'volumeId'}~:${parentUid}`,
-        directMemberRole: MemberRole.Admin,
+        directRole: MemberRole.Admin,
+        membership: {
+            role: MemberRole.Admin,
+            inviteTime: new Date(),
+            sharedBy: resultOk('test@example.com'),
+        },
         type: NodeType.File,
         mediaType: 'text',
         isShared: false,

package/src/internal/nodes/cache.ts

@@ -252,8 +252,9 @@ function deserialiseNode(nodeData: string): DecryptedNode {
         typeof node !== 'object' ||
         !node.uid ||
         typeof node.uid !== 'string' ||
-        !node.directMemberRole ||
-        typeof node.directMemberRole !== 'string' ||
+        !node.directRole ||
+        typeof node.directRole !== 'string' ||
+        (typeof node.membership !== 'object' && node.membership !== undefined) ||
         !node.type ||
         typeof node.type !== 'string' ||
         (typeof node.mediaType !== 'string' && node.mediaType !== undefined) ||
@@ -271,6 +272,12 @@ function deserialiseNode(nodeData: string): DecryptedNode {
         creationTime: new Date(node.creationTime),
         trashTime: node.trashTime ? new Date(node.trashTime) : undefined,
         activeRevision: node.activeRevision ? deserialiseRevision(node.activeRevision) : undefined,
+        membership: node.membership
+            ? {
+                  ...node.membership,
+                  inviteTime: new Date(node.membership.inviteTime),
+              }
+            : undefined,
         folder: node.folder
             ? {
                   ...node.folder,