@protontech/drive-sdk 0.0.11 → 0.0.13

package/dist/errors.js

@@ -0,0 +1,168 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IntegrityError = exports.DecryptionError = exports.ConnectionError = exports.RateLimitedError = exports.ServerError = exports.NodeAlreadyExistsValidationError = exports.ValidationError = exports.AbortError = exports.ProtonDriveError = void 0;
+const ttag_1 = require("ttag");
+/**
+ * Base class for all SDK errors.
+ *
+ * This class can be used for catching all SDK errors. The error should have
+ * translated message in the `message` property that should be shown to the
+ * user without any modification.
+ *
+ * No retries should be done as that is already handled by the SDK.
+ *
+ * When SDK throws an error and it is not `ProtonDriveError`, it is unhandled error
+ * by the SDK and usually indicates bug in the SDK. Please, report it.
+ */
+class ProtonDriveError extends Error {
+    name = 'ProtonDriveError';
+}
+exports.ProtonDriveError = ProtonDriveError;
+/**
+ * Error thrown when the operation is aborted.
+ *
+ * This error is thrown when the operation is aborted by the user.
+ * For example, by calling `abort()` on the `AbortSignal`.
+ */
+class AbortError extends ProtonDriveError {
+    name = 'AbortError';
+    constructor(message) {
+        super(message || (0, ttag_1.c)('Error').t `Operation aborted`);
+    }
+}
+exports.AbortError = AbortError;
+/**
+ * Error thrown when the validation fails.
+ *
+ * This error is thrown when the validation of the input fails.
+ * Validation can be done on the client side or on the server side.
+ *
+ * For example, on the client, it can be thrown when the node name doesn't
+ * follow the required format, etc., while on the server side, it can be thrown
+ * when there is not enough permissions, etc.
+ */
+class ValidationError extends ProtonDriveError {
+    name = 'ValidationError';
+    /**
+     * Internal API code.
+     *
+     * Use only for debugging purposes.
+     */
+    code;
+    /**
+     * Additional details about the error provided by the server.
+     */
+    details;
+    constructor(message, code, details) {
+        super(message);
+        this.code = code;
+        this.details = details;
+    }
+}
+exports.ValidationError = ValidationError;
+/**
+ * Error thrown when the node already exists.
+ *
+ * This error is thrown when the node with the same name already exists in the
+ * parent folder. The client should ask the user to replace the existing node
+ * or choose another name. The available name is provided in the `availableName`
+ * property (that will contain original name with the index that can be used).
+ */
+class NodeAlreadyExistsValidationError extends ValidationError {
+    name = 'NodeAlreadyExistsValidationError';
+    existingNodeUid;
+    constructor(message, code, existingNodeUid) {
+        super(message, code);
+        this.existingNodeUid = existingNodeUid;
+    }
+}
+exports.NodeAlreadyExistsValidationError = NodeAlreadyExistsValidationError;
+/**
+ * Error thrown when the API call fails.
+ *
+ * This error covers both HTTP errors and API errors. SDK automatically
+ * retries the request before the error is thrown. The sepcific algorithm
+ * used for retries depends on the type of the error.
+ *
+ * Client should not retry the request when this error is thrown.
+ */
+class ServerError extends ProtonDriveError {
+    name = 'ServerError';
+    /**
+     * HTTP status code of the response.
+     *
+     * Use only for debugging purposes.
+     */
+    statusCode;
+    /**
+     * Internal API code.
+     *
+     * Use only for debugging purposes.
+     */
+    code;
+}
+exports.ServerError = ServerError;
+/**
+ * Error thrown when the client makes too many requests to the API.
+ *
+ * SDK is configured to stay below the rate limits, but it can still happen if
+ * client is running multiple SDKs in parallel, or if the rate limits are
+ * changed on the server side.
+ *
+ * SDK automatically retries the request before the error is thrown after
+ * waiting for the required time specified by the server.
+ *
+ * Client should slow down calling SDK when this error is thrown.
+ *
+ * You can be also notified about the rate limits by the `requestsThrottled`
+ * event. See `onMessage` method on the SDK class for more details.
+ */
+class RateLimitedError extends ServerError {
+    name = 'RateLimitedError';
+    code = 429;
+}
+exports.RateLimitedError = RateLimitedError;
+/**
+ * Error thrown when the client is not connected to the internet.
+ *
+ * Client should check the internet connection when this error is thrown.
+ *
+ * You can also be notified about the connection status by the `offline` event
+ * See `onMessage` method on the SDK class for more details.
+ */
+class ConnectionError extends ProtonDriveError {
+    name = 'ConnectionError';
+}
+exports.ConnectionError = ConnectionError;
+/**
+ * Error thrown when the decryption fails.
+ *
+ * Client should report this error to the user and report bug report.
+ *
+ * In most cases, there is no decryption error. Every decryption error should
+ * be not exposed but set as empty value on the node, for example. But in the
+ * case of the file content, if block cannot be decrypted, decryption error
+ * is thrown.
+ */
+class DecryptionError extends ProtonDriveError {
+    name = 'DecryptionError';
+}
+exports.DecryptionError = DecryptionError;
+/**
+ * Error thrown when the data integrity check fails.
+ *
+ * Client should report this error to the user and report bug report.
+ *
+ * For example, it can happen when hashes don't match, etc. In some cases,
+ * SDK allows to run command without verification checks for debug purposes.
+ */
+class IntegrityError extends ProtonDriveError {
+    name = 'IntegrityError';
+    debug;
+    constructor(message, debug) {
+        super(message);
+        this.debug = debug;
+    }
+}
+exports.IntegrityError = IntegrityError;
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AAAA,+BAAyB;AAEzB;;;;;;;;;;;GAWG;AACH,MAAa,gBAAiB,SAAQ,KAAK;IACvC,IAAI,GAAG,kBAAkB,CAAC;CAC7B;AAFD,4CAEC;AAED;;;;;GAKG;AACH,MAAa,UAAW,SAAQ,gBAAgB;IAC5C,IAAI,GAAG,YAAY,CAAC;IAEpB,YAAY,OAAgB;QACxB,KAAK,CAAC,OAAO,IAAI,IAAA,QAAC,EAAC,OAAO,CAAC,CAAC,CAAC,CAAA,mBAAmB,CAAC,CAAC;IACtD,CAAC;CACJ;AAND,gCAMC;AAED;;;;;;;;;GASG;AACH,MAAa,eAAgB,SAAQ,gBAAgB;IACjD,IAAI,GAAG,iBAAiB,CAAC;IAEzB;;;;OAIG;IACa,IAAI,CAAU;IAE9B;;OAEG;IACa,OAAO,CAAU;IAEjC,YAAY,OAAe,EAAE,IAAa,EAAE,OAAgB;QACxD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;CACJ;AApBD,0CAoBC;AAED;;;;;;;GAOG;AACH,MAAa,gCAAiC,SAAQ,eAAe;IACjE,IAAI,GAAG,kCAAkC,CAAC;IAE1B,eAAe,CAAU;IAEzC,YAAY,OAAe,EAAE,IAAY,EAAE,eAAwB;QAC/D,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACrB,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IAC3C,CAAC;CACJ;AATD,4EASC;AAED;;;;;;;;GAQG;AACH,MAAa,WAAY,SAAQ,gBAAgB;IAC7C,IAAI,GAAG,aAAa,CAAC;IAErB;;;;OAIG;IACa,UAAU,CAAU;IACpC;;;;OAIG;IACa,IAAI,CAAU;CACjC;AAfD,kCAeC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAa,gBAAiB,SAAQ,WAAW;IAC7C,IAAI,GAAG,kBAAkB,CAAC;IAE1B,IAAI,GAAG,GAAG,CAAC;CACd;AAJD,4CAIC;AAED;;;;;;;GAOG;AACH,MAAa,eAAgB,SAAQ,gBAAgB;IACjD,IAAI,GAAG,iBAAiB,CAAC;CAC5B;AAFD,0CAEC;AAED;;;;;;;;;GASG;AACH,MAAa,eAAgB,SAAQ,gBAAgB;IACjD,IAAI,GAAG,iBAAiB,CAAC;CAC5B;AAFD,0CAEC;AAED;;;;;;;GAOG;AACH,MAAa,cAAe,SAAQ,gBAAgB;IAChD,IAAI,GAAG,gBAAgB,CAAC;IAER,KAAK,CAAU;IAE/B,YAAY,OAAe,EAAE,KAAc;QACvC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACvB,CAAC;CACJ;AATD,wCASC"}

package/dist/interface/account.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=account.js.map

package/dist/interface/account.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"account.js","sourceRoot":"","sources":["../../src/interface/account.ts"],"names":[],"mappings":""}

package/dist/interface/author.d.ts

@@ -0,0 +1,26 @@
+import { Result } from './result';
+/**
+ * Author with verification status.
+ *
+ * It can be either a string (email) or an anonymous user.
+ *
+ * If author cannot be verified, the result is failure with an error.
+ * The client can still get claimed author from the error object, but
+ * it must be used with caution.
+ */
+export type Author = Result<string | AnonymousUser, UnverifiedAuthorError>;
+/**
+ * Anonymous user. Used when user shares folder publicly and anonymous
+ * users can access the folder and upload new files without being logged in.
+ */
+export type AnonymousUser = null;
+/**
+ * Unverified author.
+ *
+ * If author cannot be verified, the result is this object containing
+ * the claimed author and the verification error.
+ */
+export type UnverifiedAuthorError = {
+    claimedAuthor?: string;
+    error: string;
+};

package/dist/interface/author.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=author.js.map

package/dist/interface/author.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"author.js","sourceRoot":"","sources":["../../src/interface/author.ts"],"names":[],"mappings":""}

package/dist/interface/download.d.ts

@@ -0,0 +1,29 @@
+export interface FileDownloader {
+    /**
+     * Get the claimed size of the file in bytes.
+     *
+     * This provides total clear-text size of the file. This is encrypted
+     * information that is not known to the Proton Drive and thus it is
+     * explicitely stated as claimed only and must be treated that way.
+     * It can be wrong or missing completely.
+     */
+    getClaimedSizeInBytes(): number | undefined;
+    /**
+     * Download, decrypt and verify the content from the server and write
+     * to the provided stream.
+     *
+     * @param onProgress - Callback that is called with the number of downloaded bytes
+     */
+    writeToStream(streamFactory: WritableStream, onProgress: (downloadedBytes: number) => void): DownloadController;
+    /**
+     * Same as `writeToStream` but without verification checks.
+     *
+     * Use this only for debugging purposes.
+     */
+    unsafeWriteToStream(streamFactory: WritableStream, onProgress: (downloadedBytes: number) => void): DownloadController;
+}
+export interface DownloadController {
+    pause(): void;
+    resume(): void;
+    completion(): Promise<void>;
+}

package/dist/interface/download.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=download.js.map

package/dist/interface/download.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"download.js","sourceRoot":"","sources":["../../src/interface/download.ts"],"names":[],"mappings":""}

package/dist/interface/httpClient.d.ts

@@ -0,0 +1,38 @@
+export interface ProtonDriveHTTPClient {
+    fetchJson(options: ProtonDriveHTTPClientJsonOptions): Promise<Response>;
+    fetchBlob(options: ProtonDriveHTTPClientBlobOptions): Promise<Response>;
+}
+export type ProtonDriveHTTPClientJsonOptions = ProtonDriveHTTPClientBaseOptions & {
+    json?: object;
+};
+export type ProtonDriveHTTPClientBlobOptions = ProtonDriveHTTPClientBaseOptions & {
+    body?: XMLHttpRequestBodyInit;
+    onProgress?: (progress: number) => void;
+};
+type ProtonDriveHTTPClientBaseOptions = {
+    url: string;
+    method: string;
+    headers: Headers;
+    /**
+     * The timeout in milliseconds.
+     *
+     * When timeout is reached, the request will be aborted with TimeoutError.
+     */
+    timeoutMs: number;
+    signal?: AbortSignal;
+};
+export type ProtonDriveConfig = {
+    /**
+     * The base URL for the Proton Drive (without schema).
+     *
+     * If not provided, defaults to 'drive-api.proton.me'.
+     */
+    baseUrl?: string;
+    /**
+     * The language to use for error messages.
+     *
+     * If not provided, defaults to 'en'.
+     */
+    language?: string;
+};
+export {};

package/dist/interface/httpClient.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=httpClient.js.map

package/dist/interface/httpClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpClient.js","sourceRoot":"","sources":["../../src/interface/httpClient.ts"],"names":[],"mappings":""}

package/dist/interface/index.d.ts

@@ -19,7 +19,7 @@ export type { ProtonInvitation, ProtonInvitationWithNode, NonProtonInvitation, M
 export { NonProtonInvitationState } from './sharing';
 export type { Telemetry, Logger, MetricAPIRetrySucceededEvent, MetricUploadEvent, MetricsUploadErrorType, MetricDownloadEvent, MetricsDownloadErrorType, MetricDecryptionErrorEvent, MetricsDecryptionErrorField, MetricVerificationErrorEvent, MetricVerificationErrorField, MetricBlockVerificationErrorEvent, MetricVolumeEventsSubscriptionsChangedEvent, MetricEvent } from './telemetry';
 export { MetricVolumeType } from './telemetry';
-export type { Fileuploader, UploadController, UploadMetadata } from './upload';
+export type { FileUploader, FileRevisionUploader, UploadController, UploadMetadata } from './upload';
 export type { Thumbnail, ThumbnailResult } from './thumbnail';
 export { ThumbnailType } from './thumbnail';
 export type ProtonDriveTelemetry = Telemetry<MetricEvent>;

package/dist/interface/nodes.d.ts

@@ -127,7 +127,18 @@ export type InvalidNameError = {
 };
 export declare enum NodeType {
     File = "file",
-    Folder = "folder"
+    Folder = "folder",
+    /**
+     * Album is a special type available only in Photos section.
+     *
+     * The SDK does not support any album-specific actions, but it can load
+     * the node and do general operations on it, such as sharing. However,
+     * you should not rely that anything can work. It is not guaranteed that
+     * and in the future specific Photos SDK will support albums.
+     *
+     * @deprecated This type is not part of the public API.
+     */
+    Album = "album"
 }
 export declare enum MemberRole {
     Viewer = "viewer",

package/dist/interface/nodes.js

@@ -5,6 +5,17 @@ var NodeType;
 (function (NodeType) {
     NodeType["File"] = "file";
     NodeType["Folder"] = "folder";
+    /**
+     * Album is a special type available only in Photos section.
+     *
+     * The SDK does not support any album-specific actions, but it can load
+     * the node and do general operations on it, such as sharing. However,
+     * you should not rely that anything can work. It is not guaranteed that
+     * and in the future specific Photos SDK will support albums.
+     *
+     * @deprecated This type is not part of the public API.
+     */
+    NodeType["Album"] = "album";
 })(NodeType || (exports.NodeType = NodeType = {}));
 var MemberRole;
 (function (MemberRole) {

package/dist/interface/nodes.js.map

@@ -1 +1 @@
-{"version":3,"file":"nodes.js","sourceRoot":"","sources":["../../src/interface/nodes.ts"],"names":[],"mappings":";;;AAsIA,IAAY,QAGX;AAHD,WAAY,QAAQ;IAChB,yBAAa,CAAA;IACb,6BAAiB,CAAA;AACrB,CAAC,EAHW,QAAQ,wBAAR,QAAQ,QAGnB;AAED,IAAY,UAKX;AALD,WAAY,UAAU;IAClB,+BAAiB,CAAA;IACjB,+BAAiB,CAAA;IACjB,6BAAe,CAAA;IACf,qCAAuB,CAAA;AAC3B,CAAC,EALW,UAAU,0BAAV,UAAU,QAKrB;AAsBD,IAAY,aAGX;AAHD,WAAY,aAAa;IACrB,kCAAiB,CAAA;IACjB,0CAAyB,CAAA;AAC7B,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB"}
+{"version":3,"file":"nodes.js","sourceRoot":"","sources":["../../src/interface/nodes.ts"],"names":[],"mappings":";;;AAsIA,IAAY,QAcX;AAdD,WAAY,QAAQ;IAChB,yBAAa,CAAA;IACb,6BAAiB,CAAA;IACjB;;;;;;;;;OASG;IACH,2BAAe,CAAA;AACnB,CAAC,EAdW,QAAQ,wBAAR,QAAQ,QAcnB;AAED,IAAY,UAKX;AALD,WAAY,UAAU;IAClB,+BAAiB,CAAA;IACjB,+BAAiB,CAAA;IACjB,6BAAe,CAAA;IACf,qCAAuB,CAAA;AAC3B,CAAC,EALW,UAAU,0BAAV,UAAU,QAKrB;AAsBD,IAAY,aAGX;AAHD,WAAY,aAAa;IACrB,kCAAiB,CAAA;IACjB,0CAAyB,CAAA;AAC7B,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB"}

package/dist/interface/result.d.ts

@@ -0,0 +1,9 @@
+export type Result<T, E> = {
+    ok: true;
+    value: T;
+} | {
+    ok: false;
+    error: E;
+};
+export declare function resultOk<T, E>(value: T): Result<T, E>;
+export declare function resultError<T, E>(error: E): Result<T, E>;

package/dist/interface/result.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resultOk = resultOk;
+exports.resultError = resultError;
+function resultOk(value) {
+    return { ok: true, value };
+}
+function resultError(error) {
+    return { ok: false, error };
+}
+//# sourceMappingURL=result.js.map

package/dist/interface/result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"result.js","sourceRoot":"","sources":["../../src/interface/result.ts"],"names":[],"mappings":";;AAIA,4BAEC;AAED,kCAEC;AAND,SAAgB,QAAQ,CAAO,KAAQ;IACnC,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AAC/B,CAAC;AAED,SAAgB,WAAW,CAAO,KAAQ;IACtC,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AAChC,CAAC"}

package/dist/interface/thumbnail.d.ts

@@ -0,0 +1,17 @@
+export type Thumbnail = {
+    type: ThumbnailType;
+    thumbnail: Uint8Array;
+};
+export declare enum ThumbnailType {
+    Type1 = 1,
+    Type2 = 2
+}
+export type ThumbnailResult = {
+    nodeUid: string;
+    ok: true;
+    thumbnail: Uint8Array;
+} | {
+    nodeUid: string;
+    ok: false;
+    error: string;
+};

package/dist/interface/thumbnail.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ThumbnailType = void 0;
+var ThumbnailType;
+(function (ThumbnailType) {
+    ThumbnailType[ThumbnailType["Type1"] = 1] = "Type1";
+    ThumbnailType[ThumbnailType["Type2"] = 2] = "Type2";
+})(ThumbnailType || (exports.ThumbnailType = ThumbnailType = {}));
+//# sourceMappingURL=thumbnail.js.map

package/dist/interface/thumbnail.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"thumbnail.js","sourceRoot":"","sources":["../../src/interface/thumbnail.ts"],"names":[],"mappings":";;;AAMA,IAAY,aAGX;AAHD,WAAY,aAAa;IACrB,mDAAS,CAAA;IACT,mDAAS,CAAA;AACb,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB"}

package/dist/interface/upload.d.ts

@@ -0,0 +1,64 @@
+import { Thumbnail } from "./thumbnail";
+export type UploadMetadata = {
+    mediaType: string;
+    /**
+     * Expected size of the file.
+     *
+     * The file size is used to verify the integrity of the file during upload.
+     * If the expected size does not match the actual size, the upload will
+     * fail.
+     */
+    expectedSize: number;
+    /**
+     * Modification time of the file.
+     *
+     * The modification time will be encrypted and stored with the file.
+     */
+    modificationTime?: Date;
+    /**
+     * Additional metadata to be stored with the file.
+     *
+     * These metadata must be object that can be serialized to JSON.
+     *
+     * The metadata will be encrypted and stored with the file.
+     */
+    additionalMetadata?: object;
+};
+export interface FileRevisionUploader {
+    /**
+     * Uploads a file from a stream.
+     *
+     * The function will resolve to a controller that can be used to pause,
+     * resume and complete the upload.
+     *
+     * The function will reject if the node with the given name already exists.
+     */
+    writeStream(stream: ReadableStream, thumnbails: Thumbnail[], onProgress?: (uploadedBytes: number) => void): Promise<UploadController>;
+    /**
+     * Uploads a file from a file object. It is convenient to use this method
+     * when the file is already in memory. The file object is used to get the
+     * metadata, such as the media type, size or modification time.
+     *
+     * The function will resolve to a controller that can be used to pause,
+     * resume and complete the upload.
+     *
+     * The function will reject if the node with the given name already exists.
+     */
+    writeFile(fileObject: File, thumnbails: Thumbnail[], onProgress?: (uploadedBytes: number) => void): Promise<UploadController>;
+}
+export interface FileUploader extends FileRevisionUploader {
+    /**
+     * Returns the available name for the file.
+     *
+     * The function will return a name that includes the original name with the
+     * available index. The name is guaranteed to be unique in the parent folder.
+     *
+     * Example new name: `file (2).txt`.
+     */
+    getAvailableName(): Promise<string>;
+}
+export interface UploadController {
+    pause(): void;
+    resume(): void;
+    completion(): Promise<string>;
+}

package/dist/interface/upload.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=upload.js.map

package/dist/interface/upload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upload.js","sourceRoot":"","sources":["../../src/interface/upload.ts"],"names":[],"mappings":""}