@protontech/drive-sdk 0.6.1 → 0.7.0

package/src/interface/index.ts

@@ -3,6 +3,7 @@ import { OpenPGPCrypto, PrivateKey, SessionKey, SRPModule } from '../crypto';
 import { LatestEventIdProvider } from '../internal/events/interface';
 import { ProtonDriveAccount } from './account';
 import { ProtonDriveConfig } from './config';
+import { FeatureFlagProvider } from './featureFlags';
 import { ProtonDriveHTTPClient } from './httpClient';
 import { Telemetry, MetricEvent } from './telemetry';
 
@@ -12,6 +13,7 @@ export type { ProtonDriveAccount, ProtonDriveAccountAddress } from './account';
 export type { Author, UnverifiedAuthorError, AnonymousUser } from './author';
 export type { ProtonDriveConfig } from './config';
 export type { Device, DeviceOrUid } from './devices';
+export type { FeatureFlagProvider } from './featureFlags';
 export { DeviceType } from './devices';
 export type { FileDownloader, DownloadController, SeekableReadableStream } from './download';
 export type {
@@ -117,5 +119,6 @@ export interface ProtonDriveClientContructorParameters {
     srpModule: SRPModule;
     config?: ProtonDriveConfig;
     telemetry?: ProtonDriveTelemetry;
+    featureFlagProvider?: FeatureFlagProvider;
     latestEventIdProvider?: LatestEventIdProvider;
 }

package/src/internal/apiService/apiService.ts

@@ -136,7 +136,7 @@ export class DriveAPIService {
         return this.makeRequest(url, 'DELETE', undefined, signal);
     }
 
-    private async makeRequest<RequestPayload, ResponsePayload>(
+    protected async makeRequest<RequestPayload, ResponsePayload>(
         url: string,
         method = 'GET',
         data?: RequestPayload,
@@ -194,7 +194,7 @@ export class DriveAPIService {
         await this.makeStorageRequest('POST', baseUrl, token, data, onProgress, signal);
     }
 
-    private async makeStorageRequest(
+    protected async makeStorageRequest(
         method: 'GET' | 'POST',
         url: string,
         token: string,

package/src/internal/apiService/errors.ts

@@ -30,7 +30,7 @@ export function apiErrorFactory({
         Code?: number;
         Error?: string;
         Details?: object;
-        exception?: string;
+        Exception?: string;
         message?: string;
         file?: string;
         line?: number;
@@ -43,9 +43,10 @@ export function apiErrorFactory({
         typedResult.Details,
     ];
 
-    const debug = typedResult.exception
+    const debug = typedResult.Exception
         ? {
-              exception: typedResult.exception,
+              details: typedResult.Details,
+              exception: typedResult.Exception,
               message: typedResult.message,
               file: typedResult.file,
               line: typedResult.line,
@@ -82,7 +83,7 @@ export function apiErrorFactory({
         case ErrorCode.INSUFFICIENT_BOOKMARKS_QUOTA:
             return new ValidationError(message, code, details);
         default:
-            return new APICodeError(message, code, debug);
+            return new APICodeError(message, code, debug || details);
     }
 }
 

package/src/internal/download/cryptoService.ts

@@ -27,7 +27,7 @@ export class DownloadCryptoService {
         nodeKey: { key: PrivateKey; contentKeyPacketSessionKey: SessionKey },
         revision: Revision,
     ): Promise<RevisionKeys> {
-        const verificationKeys = await this.getRevisionVerificationKeys(revision);
+        const verificationKeys = await this.getRevisionVerificationKeys(revision, nodeKey.key);
         return {
             ...nodeKey,
             verificationKeys,
@@ -90,23 +90,30 @@ export class DownloadCryptoService {
         allBlockHashes: Uint8Array[],
         armoredManifestSignature?: string,
     ): Promise<void> {
-        const verificationKeys = (await this.getRevisionVerificationKeys(revision)) || nodeKey;
+        const verificationKeys = await this.getRevisionVerificationKeys(revision, nodeKey);
         const hash = mergeUint8Arrays(allBlockHashes);
 
         if (!armoredManifestSignature) {
             throw new IntegrityError(c('Error').t`Missing integrity signature`);
         }
 
-        const { verified } = await this.driveCrypto.verifyManifest(hash, armoredManifestSignature, verificationKeys);
+        const { verified, verificationErrors } = await this.driveCrypto.verifyManifest(
+            hash,
+            armoredManifestSignature,
+            verificationKeys,
+        );
+
         if (verified !== VERIFICATION_STATUS.SIGNED_AND_VALID) {
-            throw new IntegrityError(c('Error').t`Data integrity check failed`);
+            throw new IntegrityError(c('Error').t`Data integrity check failed`, {
+                verificationErrors,
+            });
         }
     }
 
-    private async getRevisionVerificationKeys(revision: Revision): Promise<PublicKey[] | undefined> {
+    private async getRevisionVerificationKeys(revision: Revision, nodeKey: PrivateKey): Promise<PublicKey[]> {
         const signatureEmail = revision.contentAuthor.ok
             ? revision.contentAuthor.value
             : revision.contentAuthor.error.claimedAuthor;
-        return signatureEmail ? await this.account.getPublicKeys(signatureEmail) : undefined;
+        return signatureEmail ? await this.account.getPublicKeys(signatureEmail) : [nodeKey];
     }
 }

package/src/internal/download/fileDownloader.ts

@@ -42,6 +42,7 @@ export class FileDownloader {
         private revision: DecryptedRevision,
         private signal?: AbortSignal,
         private onFinish?: () => void,
+        private ignoreManifestVerification = false,
     ) {
         this.telemetry = telemetry;
         this.logger = telemetry.getLoggerForRevision(revision.uid);
@@ -51,6 +52,7 @@ export class FileDownloader {
         this.revision = revision;
         this.signal = signal;
         this.onFinish = onFinish;
+        this.ignoreManifestVerification = ignoreManifestVerification;
         this.controller = new DownloadController(this.signal);
     }
 
@@ -219,7 +221,7 @@ export class FileDownloader {
                 throw new Error(`Some blocks were not downloaded`);
             }
 
-            if (ignoreIntegrityErrors) {
+            if (ignoreIntegrityErrors || this.ignoreManifestVerification) {
                 this.logger.warn('Skipping manifest check');
             } else {
                 this.logger.debug(`Verifying manifest`);
@@ -237,7 +239,7 @@ export class FileDownloader {
         } catch (error: unknown) {
             this.logger.error(`Download failed`, error);
             void this.telemetry.downloadFailed(this.revision.uid, error, fileProgress, this.getClaimedSizeInBytes());
-            await writer.abort();
+            await writer.abort?.();
             throw error;
         } finally {
             this.logger.debug(`Download cleanup`);

package/src/internal/download/index.ts

@@ -21,6 +21,7 @@ export function initDownloadModule(
     sharesService: SharesService,
     nodesService: NodesService,
     revisionsService: RevisionsService,
+    ignoreManifestVerification = false,
 ) {
     const queue = new DownloadQueue();
     const api = new DownloadAPIService(apiService);
@@ -63,6 +64,7 @@ export function initDownloadModule(
             node.activeRevision.value,
             signal,
             onFinish,
+            ignoreManifestVerification,
         );
     }
 
@@ -102,6 +104,7 @@ export function initDownloadModule(
             revision,
             signal,
             onFinish,
+            ignoreManifestVerification,
         );
     }
 

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

@@ -577,8 +577,8 @@ describe('nodeAPIService', () => {
         });
     });
 
-    describe('deleteNodes', () => {
-        it('should delete nodes', async () => {
+    describe('deleteTrashedNodes', () => {
+        it('should delete trashed nodes', async () => {
             // @ts-expect-error Mocking for testing purposes
             apiMock.post = jest.fn(async () =>
                 Promise.resolve({
@@ -600,14 +600,14 @@ describe('nodeAPIService', () => {
                 }),
             );
 
-            const result = await Array.fromAsync(api.deleteNodes(['volumeId~nodeId1', 'volumeId~nodeId2']));
+            const result = await Array.fromAsync(api.deleteTrashedNodes(['volumeId~nodeId1', 'volumeId~nodeId2']));
             expect(result).toEqual([
                 { uid: 'volumeId~nodeId1', ok: true },
                 { uid: 'volumeId~nodeId2', ok: false, error: 'INSUFFICIENT_SCOPE' },
             ]);
         });
 
-        it('should delete nodes from multiple volumes', async () => {
+        it('should delete trashed nodes from multiple volumes', async () => {
             // @ts-expect-error Mocking for testing purposes
             apiMock.post = jest.fn(async (_, { LinkIDs }) =>
                 Promise.resolve({
@@ -620,7 +620,7 @@ describe('nodeAPIService', () => {
                 }),
             );
 
-            const result = await Array.fromAsync(api.deleteNodes(['volumeId1~nodeId1', 'volumeId2~nodeId2']));
+            const result = await Array.fromAsync(api.deleteTrashedNodes(['volumeId1~nodeId1', 'volumeId2~nodeId2']));
             expect(result).toEqual([
                 { uid: 'volumeId1~nodeId1', ok: true },
                 { uid: 'volumeId2~nodeId2', ok: true },

package/src/internal/nodes/apiService.ts

@@ -1,8 +1,7 @@
 import { c } from 'ttag';
 
 import { NodeWithSameNameExistsValidationError, ProtonDriveError, ValidationError } from '../../errors';
-import { Logger, NodeResult } from '../../interface';
-import { MemberRole, RevisionState } from '../../interface/nodes';
+import { Logger, NodeResult, MemberRole, RevisionState, AnonymousUser } from '../../interface';
 import {
     DriveAPIService,
     drivePaths,
@@ -102,7 +101,6 @@ type PostRestoreRevisionResponse =
 type DeleteRevisionResponse =
     drivePaths['/drive/v2/volumes/{volumeID}/files/{linkID}/revisions/{revisionID}']['delete']['responses']['200']['content']['application/json'];
 
-
 type PostCheckAvailableHashesRequest = Extract<
     drivePaths['/drive/v2/volumes/{volumeID}/links/{linkID}/checkAvailableHashes']['post']['requestBody'],
     { content: object }
@@ -292,7 +290,7 @@ export class NodeAPIService {
         },
         newNode: {
             encryptedName: string;
-            nameSignatureEmail: string;
+            nameSignatureEmail: string | AnonymousUser;
             hash?: string;
         },
         signal?: AbortSignal,
@@ -332,9 +330,9 @@ export class NodeAPIService {
             parentUid: string;
             armoredNodePassphrase: string;
             armoredNodePassphraseSignature?: string;
-            signatureEmail?: string;
+            signatureEmail?: string | AnonymousUser;
             encryptedName: string;
-            nameSignatureEmail?: string;
+            nameSignatureEmail?: string | AnonymousUser;
             hash: string;
             contentHash?: string;
         },
@@ -369,9 +367,9 @@ export class NodeAPIService {
             parentUid: string;
             armoredNodePassphrase: string;
             armoredNodePassphraseSignature?: string;
-            signatureEmail?: string;
+            signatureEmail?: string | AnonymousUser;
             encryptedName: string;
-            nameSignatureEmail?: string;
+            nameSignatureEmail?: string | AnonymousUser;
             hash: string;
         },
         signal?: AbortSignal,
@@ -430,7 +428,7 @@ export class NodeAPIService {
         }
     }
 
-    async *deleteNodes(nodeUids: string[], signal?: AbortSignal): AsyncGenerator<NodeResult> {
+    async *deleteTrashedNodes(nodeUids: string[], signal?: AbortSignal): AsyncGenerator<NodeResult> {
         for (const { volumeId, batchNodeIds, batchNodeUids } of groupNodeUidsByVolumeAndIteratePerBatch(nodeUids)) {
             const response = await this.apiService.post<PostDeleteNodesRequest, PostDeleteNodesResponse>(
                 `drive/v2/volumes/${volumeId}/trash/delete_multiple`,
@@ -445,6 +443,21 @@ export class NodeAPIService {
         }
     }
 
+    async *deleteExistingNodes(nodeUids: string[], signal?: AbortSignal): AsyncGenerator<NodeResult> {
+        for (const { volumeId, batchNodeIds, batchNodeUids } of groupNodeUidsByVolumeAndIteratePerBatch(nodeUids)) {
+            const response = await this.apiService.post<PostDeleteNodesRequest, PostDeleteNodesResponse>(
+                `drive/v2/volumes/${volumeId}/delete_multiple`,
+                {
+                    LinkIDs: batchNodeIds,
+                },
+                signal,
+            );
+
+            // TODO: remove `as` when backend fixes OpenAPI schema.
+            yield* handleResponseErrors(batchNodeUids, volumeId, response.Responses as LinkResponse[]);
+        }
+    }
+
     async createFolder(
         parentUid: string,
         newNode: {
@@ -452,7 +465,7 @@ export class NodeAPIService {
             armoredHashKey: string;
             armoredNodePassphrase: string;
             armoredNodePassphraseSignature: string;
-            signatureEmail: string;
+            signatureEmail: string | AnonymousUser;
             encryptedName: string;
             hash: string;
             armoredExtendedAttributes?: string;

package/src/internal/nodes/cryptoReporter.ts

@@ -34,7 +34,7 @@ export class NodesCryptoReporter {
         signatureType: string,
         verified: VERIFICATION_STATUS,
         verificationErrors?: Error[],
-        claimedAuthor?: string,
+        claimedAuthor?: string | AnonymousUser,
         notAvailableVerificationKeys = false,
     ): Promise<Author> {
         const author = handleClaimedAuthor(
@@ -54,7 +54,7 @@ export class NodesCryptoReporter {
         node: { uid: string; creationTime: Date },
         field: MetricVerificationErrorField,
         verificationErrors?: Error[],
-        claimedAuthor?: string,
+        claimedAuthor?: string | AnonymousUser,
     ) {
         if (this.reportedVerificationErrors.has(node.uid)) {
             return;
@@ -128,7 +128,7 @@ function handleClaimedAuthor(
     signatureType: string,
     verified: VERIFICATION_STATUS,
     verificationErrors?: Error[],
-    claimedAuthor?: string,
+    claimedAuthor?: string | AnonymousUser,
     notAvailableVerificationKeys = false,
 ): Author {
     if (!claimedAuthor && notAvailableVerificationKeys) {