@protontech/drive-sdk 0.14.10 → 0.15.1

package/src/protonDrivePhotosClient.ts

@@ -1,54 +1,54 @@
+import { getConfig } from './config';
+import { DriveCrypto } from './crypto';
+import { NullFeatureFlagProvider } from './featureFlags';
 import {
-    Logger,
-    ProtonDriveClientContructorParameters,
-    NodeOrUid,
-    MaybeMissingPhotoNode,
-    UploadMetadata,
     FileDownloader,
     FileUploader,
-    SDKEvent,
+    Logger,
+    MaybeMissingPhotoNode,
     MaybePhotoNode,
-    ThumbnailType,
-    ThumbnailResult,
-    ShareNodeSettings,
-    ShareResult,
-    UnshareNodeSettings,
-    ProtonInvitation,
-    ProtonInvitationOrUid,
-    NonProtonInvitationOrUid,
-    ProtonInvitationWithNode,
+    NodeOrUid,
     NodeResult,
     NodeResultWithError,
+    NonProtonInvitationOrUid,
     PhotoTag,
+    ProtonDriveClientContructorParameters,
+    ProtonInvitation,
+    ProtonInvitationOrUid,
+    ProtonInvitationWithNode,
+    SDKEvent,
+    ShareNodeSettings,
+    ShareResult,
+    ThumbnailResult,
+    ThumbnailType,
+    UnshareNodeSettings,
+    UploadMetadata,
 } from './interface';
-import { getConfig } from './config';
-import { DriveCrypto } from './crypto';
-import { Telemetry } from './telemetry';
-import {
-    convertInternalMissingPhotoNodeIterator,
-    convertInternalPhotoNode,
-    convertInternalPhotoNodeIterator,
-    convertInternalPhotoNodePromise,
-    getUid,
-    getUids,
-} from './transformers';
 import { DriveAPIService } from './internal/apiService';
-import { makeNodeUid } from './internal/uids';
 import { initDownloadModule } from './internal/download';
 import { DriveEventsService, DriveListener, EventSubscription } from './internal/events';
 import {
-    PHOTOS_SHARE_TARGET_TYPES,
-    initPhotosModule,
+    AlbumItem,
     initPhotoSharesModule,
-    initPhotoUploadModule,
+    initPhotosModule,
     initPhotosNodesModule,
-    AlbumItem,
+    initPhotoUploadModule,
+    PHOTOS_SHARE_TARGET_TYPES,
     TimelineItem,
 } from './internal/photos';
 import { SDKEvents } from './internal/sdkEvents';
 import { initSharesModule } from './internal/shares';
 import { initSharingModule } from './internal/sharing';
-import { NullFeatureFlagProvider } from './featureFlags';
+import { makeNodeUid } from './internal/uids';
+import { Telemetry } from './telemetry';
+import {
+    convertInternalMissingPhotoNodeIterator,
+    convertInternalPhotoNode,
+    convertInternalPhotoNodeIterator,
+    convertInternalPhotoNodePromise,
+    getUid,
+    getUids,
+} from './transformers';
 
 /**
  * ProtonDrivePhotosClient is the interface to access Photos functionality.
@@ -511,6 +511,16 @@ export class ProtonDrivePhotosClient {
         return this.upload.getFileUploader(getUid(parentFolderUid), name, metadata, signal);
     }
 
+    /**
+     * Returns an available name for a new node in the given parent folder.
+     *
+     * See `ProtonDriveClient.getAvailableName` for more information.
+     */
+    async getAvailableName(parentFolderUid: NodeOrUid, name: string): Promise<string> {
+        this.logger.info(`Getting available name in photos folder ${getUid(parentFolderUid)}`);
+        return this.nodes.management.findAvailableName(getUid(parentFolderUid), name);
+    }
+
     /**
      * Check if the photo is a duplicate.
      *

package/src/protonDrivePublicLinkClient.ts

@@ -1,42 +1,42 @@
 import { MemoryCache } from './cache';
 import { getConfig } from './config';
-import { DriveCrypto, OpenPGPCrypto, PrivateKey, SRPModule, SessionKey } from './crypto';
+import { DriveCrypto, OpenPGPCrypto, PrivateKey, SessionKey, SRPModule } from './crypto';
+import { NullFeatureFlagProvider } from './featureFlags';
 import {
-    ProtonDriveHTTPClient,
-    ProtonDriveTelemetry,
-    ProtonDriveConfig,
-    Logger,
-    NodeOrUid,
-    ProtonDriveAccount,
-    MaybeNode,
-    NodeType,
     CachedCryptoMaterial,
-    MaybeMissingNode,
+    FeatureFlagProvider,
     FileDownloader,
-    ThumbnailType,
-    ThumbnailResult,
-    UploadMetadata,
     FileUploader,
+    Logger,
+    MaybeMissingNode,
+    MaybeNode,
+    MemberRole,
+    NodeOrUid,
     NodeResult,
+    NodeType,
+    ProtonDriveAccount,
+    ProtonDriveConfig,
+    ProtonDriveHTTPClient,
+    ProtonDriveTelemetry,
     SDKEvent,
-    MemberRole,
-    FeatureFlagProvider,
+    ThumbnailResult,
+    ThumbnailType,
+    UploadMetadata,
 } from './interface';
-import { Telemetry } from './telemetry';
-import {
-    getUid,
-    convertInternalNodePromise,
-    convertInternalNodeIterator,
-    convertInternalMissingNodeIterator,
-    getUids,
-} from './transformers';
 import { initDownloadModule } from './internal/download';
 import { SDKEvents } from './internal/sdkEvents';
 import { initSharingPublicModule, UnauthDriveAPIService } from './internal/sharingPublic';
+import { NodesSecurityScanResult } from './internal/sharingPublic/nodesSecurity';
 import { SharingPublicLinkSession } from './internal/sharingPublic/session';
 import { initUploadModule } from './internal/upload';
-import { NullFeatureFlagProvider } from './featureFlags';
-import { NodesSecurityScanResult } from './internal/sharingPublic/nodesSecurity';
+import { Telemetry } from './telemetry';
+import {
+    convertInternalMissingNodeIterator,
+    convertInternalNodeIterator,
+    convertInternalNodePromise,
+    getUid,
+    getUids,
+} from './transformers';
 
 /**
  * ProtonDrivePublicLinkClient is the interface for the public link client.

package/src/transformers.ts

@@ -1,16 +1,16 @@
 import {
-    MaybeNode as PublicMaybeNode,
-    MaybeMissingNode as PublicMaybeMissingNode,
     DegradedNode as PublicDegradedNode,
-    Revision as PublicRevision,
-    Result,
-    resultOk,
-    resultError,
-    MissingNode,
-    MaybePhotoNode as PublicMaybePhotoNode,
+    DegradedPhotoNode as PublicDegradedPhotoNode,
+    MaybeMissingNode as PublicMaybeMissingNode,
     MaybeMissingPhotoNode as PublicMaybeMissingPhotoNode,
+    MaybeNode as PublicMaybeNode,
+    MaybePhotoNode as PublicMaybePhotoNode,
+    MissingNode,
     PhotoNode as PublicPhotoNode,
-    DegradedPhotoNode as PublicDegradedPhotoNode,
+    Result,
+    resultError,
+    resultOk,
+    Revision as PublicRevision,
 } from './interface';
 import { DecryptedNode as InternalNode, DecryptedRevision as InternalRevision } from './internal/nodes';
 import { DecryptedPhotoNode as InternalPartialPhotoNode } from './internal/photos';

package/dist/crypto/hmac.d.ts

@@ -1,22 +0,0 @@
-export type HmacCryptoKey = CryptoKey;
-type HmacKeyUsage = 'sign' | 'verify';
-/**
- * Import an HMAC-SHA256 key in order to use it with `signData` and `verifyData`.
- */
-export declare const importHmacKey: (key: Uint8Array<ArrayBuffer>, keyUsage?: HmacKeyUsage[]) => Promise<HmacCryptoKey>;
-/**
- * Sign data using HMAC-SHA256
- * @param key - WebCrypto secret key for signing
- * @param data - data to sign
- * @param additionalData - additional data to authenticate
- */
-export declare const computeHmacSignature: (key: HmacCryptoKey, data: Uint8Array<ArrayBuffer>) => Promise<Uint8Array<ArrayBuffer>>;
-/**
- * Verify data using HMAC-SHA256
- * @param key - WebCrypto secret key for verification
- * @param signature - signature over data
- * @param data - data to verify
- * @param additionalData - additional data to authenticate
- */
-export declare const verifyData: (key: HmacCryptoKey, signature: Uint8Array<ArrayBuffer>, data: Uint8Array<ArrayBuffer>) => Promise<boolean>;
-export {};

package/dist/crypto/hmac.js

@@ -1,44 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.verifyData = exports.computeHmacSignature = exports.importHmacKey = void 0;
-const HASH_ALGORITHM = 'SHA-256';
-const KEY_LENGTH_BYTES = 32;
-/**
- * Import an HMAC-SHA256 key in order to use it with `signData` and `verifyData`.
- */
-const importHmacKey = async (key, keyUsage = ['sign', 'verify']) => {
-    // From https://datatracker.ietf.org/doc/html/rfc2104:
-    // The key for HMAC can be of any length (keys longer than B bytes are first hashed using H).
-    // However, less than L bytes (L = 32 bytes for SHA-256) is strongly discouraged as it would
-    // decrease the security strength of the function.  Keys longer than L bytes are acceptable
-    // but the extra length would not significantly increase the function strength.
-    // (A longer key may be advisable if the randomness of the key is considered weak.)
-    if (key.length < KEY_LENGTH_BYTES) {
-        throw new Error('Unexpected HMAC key size: key is too short');
-    }
-    return crypto.subtle.importKey('raw', key, { name: 'HMAC', hash: HASH_ALGORITHM }, false, keyUsage);
-};
-exports.importHmacKey = importHmacKey;
-/**
- * Sign data using HMAC-SHA256
- * @param key - WebCrypto secret key for signing
- * @param data - data to sign
- * @param additionalData - additional data to authenticate
- */
-const computeHmacSignature = async (key, data) => {
-    const signatureBuffer = await crypto.subtle.sign({ name: 'HMAC', hash: HASH_ALGORITHM }, key, data);
-    return new Uint8Array(signatureBuffer);
-};
-exports.computeHmacSignature = computeHmacSignature;
-/**
- * Verify data using HMAC-SHA256
- * @param key - WebCrypto secret key for verification
- * @param signature - signature over data
- * @param data - data to verify
- * @param additionalData - additional data to authenticate
- */
-const verifyData = async (key, signature, data) => {
-    return crypto.subtle.verify({ name: 'HMAC', hash: HASH_ALGORITHM }, key, signature, data);
-};
-exports.verifyData = verifyData;
-//# sourceMappingURL=hmac.js.map

package/dist/crypto/hmac.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"hmac.js","sourceRoot":"","sources":["../../src/crypto/hmac.ts"],"names":[],"mappings":";;;AAAA,MAAM,cAAc,GAAG,SAAS,CAAC;AACjC,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAK5B;;GAEG;AACI,MAAM,aAAa,GAAG,KAAK,EAC9B,GAA4B,EAC5B,WAA2B,CAAC,MAAM,EAAE,QAAQ,CAAC,EACvB,EAAE;IACxB,sDAAsD;IACtD,6FAA6F;IAC7F,4FAA4F;IAC5F,2FAA2F;IAC3F,+EAA+E;IAC/E,mFAAmF;IACnF,IAAI,GAAG,CAAC,MAAM,GAAG,gBAAgB,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;AACxG,CAAC,CAAC;AAdW,QAAA,aAAa,iBAcxB;AAEF;;;;;GAKG;AACI,MAAM,oBAAoB,GAAG,KAAK,EAAE,GAAkB,EAAE,IAA6B,EAAE,EAAE;IAC5F,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IACpG,OAAO,IAAI,UAAU,CAAc,eAAe,CAAC,CAAC;AACxD,CAAC,CAAC;AAHW,QAAA,oBAAoB,wBAG/B;AAEF;;;;;;GAMG;AACI,MAAM,UAAU,GAAG,KAAK,EAAE,GAAkB,EAAE,SAAkC,EAAE,IAA6B,EAAE,EAAE;IACtH,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AAC9F,CAAC,CAAC;AAFW,QAAA,UAAU,cAErB"}

package/dist/crypto/utils.d.ts

@@ -1,2 +0,0 @@
-export declare function uint8ArrayToBase64String(array: Uint8Array): string;
-export declare function base64StringToUint8Array(string: string): Uint8Array<ArrayBuffer>;

package/dist/crypto/utils.js

@@ -1,35 +0,0 @@
-"use strict";
-// This file has copy-pasted utilities from CryptoProxy located in Proton web clients monorepo.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.uint8ArrayToBase64String = uint8ArrayToBase64String;
-exports.base64StringToUint8Array = base64StringToUint8Array;
-function uint8ArrayToBase64String(array) {
-    return encodeBase64(arrayToBinaryString(array));
-}
-function base64StringToUint8Array(string) {
-    return binaryStringToArray(decodeBase64(string) || '');
-}
-const ifDefined = (cb) => (input) => {
-    return (input !== undefined ? cb(input) : undefined);
-};
-const encodeBase64 = ifDefined((input) => btoa(input).trim());
-const decodeBase64 = ifDefined((input) => atob(input.trim()));
-const arrayToBinaryString = (bytes) => {
-    const result = [];
-    const bs = 1 << 14;
-    const j = bytes.length;
-    for (let i = 0; i < j; i += bs) {
-        // @ts-expect-error Uint8Array treated as number[]
-        // eslint-disable-next-line prefer-spread
-        result.push(String.fromCharCode.apply(String, bytes.subarray(i, i + bs < j ? i + bs : j)));
-    }
-    return result.join('');
-};
-const binaryStringToArray = (str) => {
-    const result = new Uint8Array(str.length);
-    for (let i = 0; i < str.length; i++) {
-        result[i] = str.charCodeAt(i);
-    }
-    return result;
-};
-//# sourceMappingURL=utils.js.map

package/dist/crypto/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/crypto/utils.ts"],"names":[],"mappings":";AAAA,+FAA+F;;AAE/F,4DAEC;AAED,4DAEC;AAND,SAAgB,wBAAwB,CAAC,KAAiB;IACtD,OAAO,YAAY,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC;AACpD,CAAC;AAED,SAAgB,wBAAwB,CAAC,MAAc;IACnD,OAAO,mBAAmB,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;AAC3D,CAAC;AAED,MAAM,SAAS,GACX,CAAO,EAAmB,EAAE,EAAE,CAC9B,CAA0B,KAAQ,EAAE,EAAE;IAClC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAgC,CAAC;AAC7F,CAAC,CAAC;AAEN,MAAM,YAAY,GAAG,SAAS,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;AAEtE,MAAM,YAAY,GAAG,SAAS,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;AAEtE,MAAM,mBAAmB,GAAG,CAAC,KAAiB,EAAE,EAAE;IAC9C,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,MAAM,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC;IACnB,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;IAEvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC;QAC7B,kDAAkD;QAClD,yCAAyC;QACzC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/F,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC3B,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,GAAW,EAAE,EAAE;IACxC,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAClC,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC"}

package/src/crypto/hmac.ts

@@ -1,46 +0,0 @@
-const HASH_ALGORITHM = 'SHA-256';
-const KEY_LENGTH_BYTES = 32;
-export type HmacCryptoKey = CryptoKey;
-
-type HmacKeyUsage = 'sign' | 'verify';
-
-/**
- * Import an HMAC-SHA256 key in order to use it with `signData` and `verifyData`.
- */
-export const importHmacKey = async (
-    key: Uint8Array<ArrayBuffer>,
-    keyUsage: HmacKeyUsage[] = ['sign', 'verify'],
-): Promise<HmacCryptoKey> => {
-    // From https://datatracker.ietf.org/doc/html/rfc2104:
-    // The key for HMAC can be of any length (keys longer than B bytes are first hashed using H).
-    // However, less than L bytes (L = 32 bytes for SHA-256) is strongly discouraged as it would
-    // decrease the security strength of the function.  Keys longer than L bytes are acceptable
-    // but the extra length would not significantly increase the function strength.
-    // (A longer key may be advisable if the randomness of the key is considered weak.)
-    if (key.length < KEY_LENGTH_BYTES) {
-        throw new Error('Unexpected HMAC key size: key is too short');
-    }
-    return crypto.subtle.importKey('raw', key, { name: 'HMAC', hash: HASH_ALGORITHM }, false, keyUsage);
-};
-
-/**
- * Sign data using HMAC-SHA256
- * @param key - WebCrypto secret key for signing
- * @param data - data to sign
- * @param additionalData - additional data to authenticate
- */
-export const computeHmacSignature = async (key: HmacCryptoKey, data: Uint8Array<ArrayBuffer>) => {
-    const signatureBuffer = await crypto.subtle.sign({ name: 'HMAC', hash: HASH_ALGORITHM }, key, data);
-    return new Uint8Array<ArrayBuffer>(signatureBuffer);
-};
-
-/**
- * Verify data using HMAC-SHA256
- * @param key - WebCrypto secret key for verification
- * @param signature - signature over data
- * @param data - data to verify
- * @param additionalData - additional data to authenticate
- */
-export const verifyData = async (key: HmacCryptoKey, signature: Uint8Array<ArrayBuffer>, data: Uint8Array<ArrayBuffer>) => {
-    return crypto.subtle.verify({ name: 'HMAC', hash: HASH_ALGORITHM }, key, signature, data);
-};

package/src/crypto/utils.ts

@@ -1,40 +0,0 @@
-// This file has copy-pasted utilities from CryptoProxy located in Proton web clients monorepo.
-
-export function uint8ArrayToBase64String(array: Uint8Array) {
-    return encodeBase64(arrayToBinaryString(array));
-}
-
-export function base64StringToUint8Array(string: string) {
-    return binaryStringToArray(decodeBase64(string) || '');
-}
-
-const ifDefined =
-    <T, R>(cb: (input: T) => R) =>
-    <U extends T | undefined>(input: U) => {
-        return (input !== undefined ? cb(input as T) : undefined) as U extends T ? R : undefined;
-    };
-
-const encodeBase64 = ifDefined((input: string) => btoa(input).trim());
-
-const decodeBase64 = ifDefined((input: string) => atob(input.trim()));
-
-const arrayToBinaryString = (bytes: Uint8Array) => {
-    const result = [];
-    const bs = 1 << 14;
-    const j = bytes.length;
-
-    for (let i = 0; i < j; i += bs) {
-        // @ts-expect-error Uint8Array treated as number[]
-        // eslint-disable-next-line prefer-spread
-        result.push(String.fromCharCode.apply(String, bytes.subarray(i, i + bs < j ? i + bs : j)));
-    }
-    return result.join('');
-};
-
-const binaryStringToArray = (str: string) => {
-    const result = new Uint8Array(str.length);
-    for (let i = 0; i < str.length; i++) {
-        result[i] = str.charCodeAt(i);
-    }
-    return result;
-};