@protontech/drive-sdk 0.12.1 → 0.13.1

package/src/internal/apiService/driveTypes.ts

@@ -1392,7 +1392,7 @@ export interface paths {
         put?: never;
         /**
          * Request block upload
-         * @description Request upload information for a set of blocks.
+         * @description Request upload URLs for a set of blocks/thumbnails of a given draft revision.
          */
         post: operations["post_drive-blocks"];
         delete?: never;
@@ -1410,10 +1410,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /**
-         * Upload small file
-         * @description This does not support anonymous uploads (yet)
-         */
+        /** Upload small file */
         post: operations["post_drive-v2-volumes-{volumeID}-files-small"];
         delete?: never;
         options?: never;
@@ -1430,10 +1427,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /**
-         * Upload small revision
-         * @description This does not support anonymous uploads (yet)
-         */
+        /** Upload small revision */
         post: operations["post_drive-v2-volumes-{volumeID}-files-{linkID}-revisions-small"];
         delete?: never;
         options?: never;
@@ -2148,7 +2142,10 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** List URLs on share */
+        /**
+         * List URLs on share
+         * @description There can only be one or zero share URLs on a given share.
+         */
         get: operations["get_drive-shares-{shareID}-urls"];
         put?: never;
         /** Share by URL */
@@ -2465,6 +2462,46 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/drive/unauth/v2/volumes/{volumeID}/files/small": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Upload small file
+         * @description See /drive/v2/volumes/{volumeID}/files/small for full documentation
+         */
+        post: operations["post_drive-unauth-v2-volumes-{volumeID}-files-small"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/drive/unauth/v2/volumes/{volumeID}/files/{linkID}/revisions/small": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Upload small revision
+         * @description See /drive/v2/volumes/{volumeID}/files/{linkID}/revisions/small for full documentation
+         */
+        post: operations["post_drive-unauth-v2-volumes-{volumeID}-files-{linkID}-revisions-small"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/drive/unauth/v2/volumes/{volumeID}/links/{linkID}/revisions/{revisionID}/verification": {
         parameters: {
             query?: never;
@@ -2607,6 +2644,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/drive/shares/{shareID}/editors-can-share": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Update editorsCanShare property of a share
+         * @description Only allowed to volume owners and members with Admin rights on the Parent
+         */
+        put: operations["put_drive-shares-{shareID}-editors-can-share"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/drive/shares/{shareID}/owner": {
         parameters: {
             query?: never;
@@ -2639,6 +2696,7 @@ export interface paths {
         put?: never;
         /**
          * Update properties of a share
+         * @deprecated
          * @description Update the values on one or more properties of the Share. For now, only allowed changing editorsCanShare attribute
          */
         post: operations["post_drive-shares-{shareID}-property"];
@@ -4540,6 +4598,15 @@ export interface components {
          * @enum {integer}
          */
         LinkState2: 0 | 1 | 2;
+        OwnedByDto: {
+            /**
+             * Format: email
+             * @description OwnerUser email for regular and photo volumes, null otherwise
+             */
+            Email?: string | null;
+            /** @description OwnerOrganization name for org. volumes, null otherwise */
+            Organization?: string | null;
+        };
         LinkDto: {
             LinkID: components["schemas"]["Id"];
             Type: components["schemas"]["NodeType2"];
@@ -4557,6 +4624,7 @@ export interface components {
             SignatureEmail?: string | null;
             /** Format: email */
             NameSignatureEmail?: string | null;
+            OwnedBy: components["schemas"]["OwnedByDto"];
             /** @default null */
             DirectPermissions: number | null;
         };
@@ -5236,6 +5304,8 @@ export interface components {
             State: components["schemas"]["HealthCheckState"];
         };
         AbuseReportDto: {
+            /** @description Passphrase for reported Link's Node key, unencrypted, as a string, escaped for JSON. */
+            ResourcePassphrase: string;
             /**
              * @description Reported ShareURL, complete including fragment
              * @example https://drive.proton.me/urls/1F9BKXYDMA#yF7d7bn01GMM
@@ -5243,8 +5313,6 @@ export interface components {
             ShareURL: string;
             /** @enum {string} */
             AbuseCategory: "spam" | "copyright" | "child-abuse" | "stolen-data" | "malware" | "other";
-            /** @description Passphrase for reported Link's Node key, unencrypted, as a string, escaped for JSON. */
-            ResourcePassphrase: string;
             /**
              * @description Full password, including custom part, as string, escaped for JSON
              * @default
@@ -5984,11 +6052,10 @@ export interface components {
             ShareURLs: components["schemas"]["ShareURLResponseDto"][];
             /**
              * @deprecated
-             * @description If the Recursive query parameter is set, also returns the related links and ancestors up to the share as a dictionary by LinkID.
+             * @description Unused and deprecated. Always empty.
+             * @default []
              */
-            Links: {
-                [key: string]: components["schemas"]["ExtendedLinkTransformer"];
-            };
+            Links: Record<string, never>;
             /**
              * ProtonResponseCode
              * @example 1000
@@ -6344,6 +6411,10 @@ export interface components {
              */
             Code: 1000;
         };
+        UpdateShareEditorsCanShareRequestDto: {
+            /** @description Indicates if editor members of this share could reshare it or not */
+            Value: boolean;
+        };
         TransferInput: {
             /** @description The ID of the new address */
             AddressID: string;
@@ -7275,23 +7346,6 @@ export interface operations {
                     };
                 };
             };
-            /** @description Failed dependency */
-            424: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": {
-                        /**
-                         * @description Potential codes:
-                         *      - 2032
-                         *
-                         * @enum {integer}
-                         */
-                        Code: 2032;
-                    };
-                };
-            };
         };
     };
     "post_drive-photos-volumes": {
@@ -7333,23 +7387,6 @@ export interface operations {
                     };
                 };
             };
-            /** @description Failed dependency */
-            424: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": {
-                        /**
-                         * @description Potential codes:
-                         *      - 2032
-                         *
-                         * @enum {integer}
-                         */
-                        Code: 2032;
-                    };
-                };
-            };
         };
     };
     "put_drive-photos-volumes-{volumeID}-albums-{linkID}": {
@@ -7393,26 +7430,6 @@ export interface operations {
                     };
                 };
             };
-            /** @description Failed dependency */
-            424: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": {
-                        /**
-                         * @description Potential codes:
-                         *      - 2501: File or folder not found
-                         *      - 2001: Invalid PGP message
-                         *      - 200501: Operation failed: Please retry
-                         *      - 2032
-                         *
-                         * @enum {integer}
-                         */
-                        Code: 2032;
-                    };
-                };
-            };
         };
     };
     "delete_drive-photos-volumes-{volumeID}-albums-{linkID}": {
@@ -10832,23 +10849,6 @@ export interface operations {
                     };
                 };
             };
-            /** @description Failed dependency */
-            424: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": {
-                        /**
-                         * @description Potential codes:
-                         *      - 2032
-                         *
-                         * @enum {integer}
-                         */
-                        Code: 2032;
-                    };
-                };
-            };
         };
     };
     "post_drive-urls-{token}-auth": {
@@ -11570,20 +11570,7 @@ export interface operations {
     };
     "get_drive-shares-{shareID}-urls": {
         parameters: {
-            query?: {
-                /**
-                 * @deprecated
-                 * @description By default, only shareURL pointing to the share are returned. With Recursive=1, list all shareURLs in the subtree reachable from the Share. 1 (true) or 0 (false).
-                 */
-                Recursive?: 0 | 1;
-                /**
-                 * @deprecated
-                 * @description Fetch Thumbnail URLs
-                 */
-                Thumbnails?: 0 | 1;
-                PageSize?: components["schemas"]["OffsetPagination"]["PageSize"] & unknown;
-                Page?: components["schemas"]["OffsetPagination"]["Page"] & unknown;
-            };
+            query?: never;
             header?: never;
             path: {
                 shareID: string;
@@ -12120,6 +12107,53 @@ export interface operations {
             };
         };
     };
+    "post_drive-unauth-v2-volumes-{volumeID}-files-small": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                volumeID: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Success */
+            200: {
+                headers: {
+                    "x-pm-code": 1000;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SmallUploadResponseDto"];
+                };
+            };
+        };
+    };
+    "post_drive-unauth-v2-volumes-{volumeID}-files-{linkID}-revisions-small": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                volumeID: string;
+                linkID: components["schemas"]["Id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Success */
+            200: {
+                headers: {
+                    "x-pm-code": 1000;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SmallUploadResponseDto"];
+                };
+            };
+        };
+    };
     "get_drive-unauth-v2-volumes-{volumeID}-links-{linkID}-revisions-{revisionID}-verification": {
         parameters: {
             query?: never;
@@ -12345,6 +12379,33 @@ export interface operations {
             };
         };
     };
+    "put_drive-shares-{shareID}-editors-can-share": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                shareID: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["UpdateShareEditorsCanShareRequestDto"];
+            };
+        };
+        responses: {
+            /** @description Success */
+            200: {
+                headers: {
+                    "x-pm-code": 1000;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SuccessfulResponse"];
+                };
+            };
+        };
+    };
     "post_drive-shares-{shareID}-owner": {
         parameters: {
             query?: never;

package/src/internal/download/telemetry.test.ts

@@ -38,6 +38,7 @@ describe('DownloadTelemetry', () => {
             eventName: 'download',
             volumeType: 'own_volume',
             downloadedSize: 0,
+            approximateDownloadedSize: 0,
             error: 'unknown',
             originalError: error,
         });
@@ -51,7 +52,9 @@ describe('DownloadTelemetry', () => {
             eventName: 'download',
             volumeType: 'own_volume',
             downloadedSize: 123,
+            approximateDownloadedSize: 4095,
             claimedFileSize: 456,
+            approximateClaimedFileSize: 4095,
             error: 'unknown',
             originalError: error,
         });
@@ -64,7 +67,9 @@ describe('DownloadTelemetry', () => {
             eventName: 'download',
             volumeType: 'own_volume',
             downloadedSize: 500,
+            approximateDownloadedSize: 4095,
             claimedFileSize: 500,
+            approximateClaimedFileSize: 4095,
         });
     });
 

package/src/internal/download/telemetry.ts

@@ -1,6 +1,6 @@
 import { RateLimitedError, ValidationError, DecryptionError, IntegrityError } from '../../errors';
 import { ProtonDriveTelemetry, MetricsDownloadErrorType, Logger } from '../../interface';
-import { LoggerWithPrefix } from '../../telemetry';
+import { LoggerWithPrefix, reduceSizePrecision } from '../../telemetry';
 import { APIHTTPError } from '../apiService';
 import { splitNodeRevisionUid, splitNodeUid } from '../uids';
 import { SharesService } from './interface';
@@ -83,6 +83,10 @@ export class DownloadTelemetry {
         this.telemetry.recordMetric({
             eventName: 'download',
             volumeType,
+            approximateDownloadedSize: reduceSizePrecision(options.downloadedSize),
+            approximateClaimedFileSize: options.claimedFileSize
+                ? reduceSizePrecision(options.claimedFileSize)
+                : undefined,
             ...options,
         });
     }

package/src/internal/events/index.ts

@@ -62,7 +62,7 @@ export class DriveEventsService {
         }
 
         const coreEventManager = new CoreEventManager(this.logger, this.apiService);
-        const latestEventId = this.latestEventIdProvider.getLatestEventId('core') ?? null;
+        const latestEventId = await this.latestEventIdProvider.getLatestEventId('core');
         const eventManager = new EventManager(coreEventManager, CORE_POLLING_INTERVAL, latestEventId);
 
         for (const listener of this.cacheEventListeners) {
@@ -105,7 +105,7 @@ export class DriveEventsService {
 
         const isOwnVolume = await this.sharesService.isOwnVolume(volumeId);
         const pollingInterval = this.getDefaultVolumePollingInterval(isOwnVolume);
-        const latestEventId = this.latestEventIdProvider.getLatestEventId(volumeId);
+        const latestEventId = await this.latestEventIdProvider.getLatestEventId(volumeId);
         const eventManager = new EventManager<DriveEvent>(volumeEventManager, pollingInterval, latestEventId);
 
         for (const listener of this.cacheEventListeners) {

package/src/internal/events/interface.ts

@@ -18,7 +18,7 @@ export interface EventSubscription {
 }
 
 export interface LatestEventIdProvider {
-    getLatestEventId(treeEventScopeId: string): string | null;
+    getLatestEventId(treeEventScopeId: string): Promise<string | null>;
 }
 
 /**

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

@@ -74,6 +74,11 @@ function generateAPINode() {
             NodeKey: 'nodeKey',
             NodePassphrase: 'nodePass',
             NodePassphraseSignature: 'nodePassSig',
+
+            OwnedBy: {
+                Email: 'ownerByEmail',
+                Organization: null,
+            },
         },
         SharingSummary: null,
     };
@@ -149,6 +154,10 @@ function generateNode() {
         isSharedPublicly: false,
         directRole: MemberRole.Admin,
         membership: undefined,
+        ownedBy: {
+            email: 'ownerByEmail',
+            organization: undefined,
+        },
 
         encryptedCrypto: {
             armoredKey: 'nodeKey',

package/src/internal/nodes/apiService.ts

@@ -780,6 +780,10 @@ export function linkToEncryptedNodeBaseMetadata(
                   inviteTime: new Date(link.Membership.InviteTime * 1000),
               }
             : undefined,
+        ownedBy: {
+            email: link.Link.OwnedBy?.Email || undefined,
+            organization: link.Link.OwnedBy?.Organization || undefined,
+        },
     };
 
     const baseCryptoNodeMetadata = {

package/src/internal/nodes/cryptoService.ts

@@ -1,6 +1,13 @@
 import { c } from 'ttag';
 
-import { DriveCrypto, PrivateKey, PublicKey, SessionKey, VERIFICATION_STATUS } from '../../crypto';
+import {
+    base64StringToUint8Array,
+    DriveCrypto,
+    PrivateKey,
+    PublicKey,
+    SessionKey,
+    VERIFICATION_STATUS,
+} from '../../crypto';
 import {
     resultOk,
     resultError,
@@ -201,7 +208,9 @@ export class NodesCryptoService {
         let activeRevision: Result<DecryptedUnparsedRevision, Error> | undefined;
         let contentKeyPacketSessionKey;
         let contentKeyPacketAuthor;
+        let contentKeyPacket: Uint8Array<ArrayBuffer> | undefined;
         if ('file' in node.encryptedCrypto) {
+            contentKeyPacket = base64StringToUint8Array(node.encryptedCrypto.file.base64ContentKeyPacket);
             const [activeRevisionPromise, contentKeyPacketSessionKeyPromise] = [
                 this.decryptRevision(node.uid, node.encryptedCrypto.activeRevision, key),
                 this.decryptContentKeyPacket(node, node.encryptedCrypto, key, keyVerificationKeys),
@@ -284,6 +293,7 @@ export class NodesCryptoService {
                 passphrase,
                 key,
                 passphraseSessionKey,
+                contentKeyPacket,
                 contentKeyPacketSessionKey,
                 hashKey,
             },

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

@@ -51,19 +51,15 @@ describe('extended attrbiutes', () => {
     });
 
     describe('should generate file attributes without additional metadata', () => {
-        const testCases: [object, string | undefined][] = [
-            [{}, undefined],
+        const testCases: [any, string | undefined][] = [
             [
-                { modificationTime: new Date(1234567890000) },
-                '{"Common":{"ModificationTime":"2009-02-13T23:31:30.000Z"}}',
+                { size: 0, blockSizes: [], digests: { sha1: 'abcdef' } },
+                '{"Common":{"Size":0,"BlockSizes":[],"Digests":{"SHA1":"abcdef"}}}',
+            ],
+            [
+                { size: 1234, blockSizes: [1200, 34], digests: { sha1: 'gedcba' } },
+                '{"Common":{"Size":1234,"BlockSizes":[1200,34],"Digests":{"SHA1":"gedcba"}}}',
             ],
-            [{ size: undefined }, undefined],
-            [{ size: 0 }, '{"Common":{"Size":0}}'],
-            [{ size: 1234 }, '{"Common":{"Size":1234}}'],
-            [{ blockSizes: [] }, undefined],
-            [{ blockSizes: [4, 4, 4, 2] }, '{"Common":{"BlockSizes":[4,4,4,2]}}'],
-            [{ digests: {} }, undefined],
-            [{ digests: { sha1: 'abcdef' } }, '{"Common":{"Digests":{"SHA1":"abcdef"}}}'],
             [
                 {
                     modificationTime: new Date(1234567890000),
@@ -75,7 +71,7 @@ describe('extended attrbiutes', () => {
             ],
         ];
         testCases.forEach(([input, expectedAttributes]) => {
-            it(`should generate ${input}`, () => {
+            it(`should generate ${JSON.stringify(input)}`, () => {
                 const output = generateFileExtendedAttributes(input);
                 expect(output).toBe(expectedAttributes);
             });
@@ -83,24 +79,28 @@ describe('extended attrbiutes', () => {
     });
 
     describe('should generate file attributes with additional metadata', () => {
-        const testCases: [object, string | undefined][] = [
-            [{}, '{"Media":{"Width":100,"Height":100}}'],
-            [{ size: undefined }, '{"Media":{"Width":100,"Height":100}}'],
-            [{ size: 123 }, '{"Common":{"Size":123},"Media":{"Width":100,"Height":100}}'],
-        ];
-        testCases.forEach(([input, expectedAttributes]) => {
-            it(`should generate ${input}`, () => {
-                const output = generateFileExtendedAttributes(input, { Media: { Width: 100, Height: 100 } });
-                expect(output).toBe(expectedAttributes);
-            });
+        const input = {
+            size: 1234,
+            blockSizes: [1200, 34],
+            digests: { sha1: 'abcdef' },
+        };
+
+        it(`should generate ${JSON.stringify(input)}`, () => {
+            const output = generateFileExtendedAttributes(input, { Media: { Width: 100, Height: 100 } });
+            expect(output).toBe(
+                '{"Common":{"Size":1234,"BlockSizes":[1200,34],"Digests":{"SHA1":"abcdef"}},"Media":{"Width":100,"Height":100}}',
+            );
         });
     });
 
     describe('should throw an error if additional metadata contains common attributes', () => {
         it('should throw an error', () => {
-            expect(() => generateFileExtendedAttributes({ size: 123 }, { Common: { Hello: 'World' } })).toThrow(
-                'Common attributes are not allowed in additional metadata',
-            );
+            expect(() =>
+                generateFileExtendedAttributes(
+                    { size: 123, blockSizes: [], digests: { sha1: 'abcdef' } },
+                    { Common: { Hello: 'World' } },
+                ),
+            ).toThrow('Common attributes are not allowed in additional metadata');
         });
     });
 

package/src/internal/nodes/extendedAttributes.ts

@@ -86,14 +86,14 @@ export function parseFolderExtendedAttributes(logger: Logger, extendedAttributes
 export function generateFileExtendedAttributes(
     common: {
         modificationTime?: Date;
-        size?: number;
-        blockSizes?: number[];
-        digests?: {
-            sha1?: string;
+        size: number;
+        blockSizes: number[];
+        digests: {
+            sha1: string;
         };
     },
     additionalMetadata?: object,
-): string | undefined {
+): string {
     if (additionalMetadata && 'Common' in additionalMetadata) {
         throw new Error('Common attributes are not allowed in additional metadata');
     }
@@ -102,20 +102,11 @@ export function generateFileExtendedAttributes(
     if (common.modificationTime) {
         commonAttributes.ModificationTime = dateToIsoString(common.modificationTime);
     }
-    if (common.size !== undefined) {
-        commonAttributes.Size = common.size;
-    }
-    if (common.blockSizes?.length) {
-        commonAttributes.BlockSizes = common.blockSizes;
-    }
-    if (common.digests?.sha1) {
-        commonAttributes.Digests = {
-            SHA1: common.digests.sha1,
-        };
-    }
-    if (!Object.keys(commonAttributes).length && !additionalMetadata) {
-        return undefined;
-    }
+    commonAttributes.Size = common.size;
+    commonAttributes.BlockSizes = common.blockSizes;
+    commonAttributes.Digests = {
+        SHA1: common.digests.sha1,
+    };
     return JSON.stringify({
         ...(Object.keys(commonAttributes).length ? { Common: commonAttributes } : {}),
         ...(additionalMetadata ? { ...additionalMetadata } : {}),

package/src/internal/nodes/interface.ts

@@ -47,6 +47,10 @@ interface BaseNode {
         inviteTime: Date;
         // TODO: acceptedBy: Author;
     };
+    ownedBy: {
+        email?: string;
+        organization?: string;
+    };
 }
 
 /**
@@ -156,6 +160,7 @@ export interface DecryptedNodeKeys {
     passphrase: string;
     key: PrivateKey;
     passphraseSessionKey: SessionKey;
+    contentKeyPacket?: Uint8Array<ArrayBuffer>;
     contentKeyPacketSessionKey?: SessionKey;
     hashKey?: Uint8Array<ArrayBuffer>;
 }