@protontech/drive-sdk 0.0.12 → 0.0.13

package/dist/errors.d.ts

@@ -41,7 +41,11 @@ export declare class ValidationError extends ProtonDriveError {
      * Use only for debugging purposes.
      */
     readonly code?: number;
-    constructor(message: string, code?: number);
+    /**
+     * Additional details about the error provided by the server.
+     */
+    readonly details?: object;
+    constructor(message: string, code?: number, details?: object);
 }
 /**
  * Error thrown when the node already exists.
@@ -53,8 +57,8 @@ export declare class ValidationError extends ProtonDriveError {
  */
 export declare class NodeAlreadyExistsValidationError extends ValidationError {
     name: string;
-    readonly availableName: string;
-    constructor(message: string, code: number, availableName: string);
+    readonly existingNodeUid?: string;
+    constructor(message: string, code: number, existingNodeUid?: string);
 }
 /**
  * Error thrown when the API call fails.

package/dist/errors.js

@@ -49,9 +49,14 @@ class ValidationError extends ProtonDriveError {
      * Use only for debugging purposes.
      */
     code;
-    constructor(message, 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;
@@ -65,10 +70,10 @@ exports.ValidationError = ValidationError;
  */
 class NodeAlreadyExistsValidationError extends ValidationError {
     name = 'NodeAlreadyExistsValidationError';
-    availableName;
-    constructor(message, code, availableName) {
+    existingNodeUid;
+    constructor(message, code, existingNodeUid) {
         super(message, code);
-        this.availableName = availableName;
+        this.existingNodeUid = existingNodeUid;
     }
 }
 exports.NodeAlreadyExistsValidationError = NodeAlreadyExistsValidationError;

package/dist/errors.js.map

@@ -1 +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,YAAY,OAAe,EAAE,IAAa;QACtC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACrB,CAAC;CACJ;AAdD,0CAcC;AAED;;;;;;;GAOG;AACH,MAAa,gCAAiC,SAAQ,eAAe;IACjE,IAAI,GAAG,kCAAkC,CAAC;IAE1B,aAAa,CAAS;IAEtC,YAAY,OAAe,EAAE,IAAY,EAAE,aAAqB;QAC5D,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACrB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACvC,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"}
+{"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/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/upload.d.ts

@@ -1,13 +1,61 @@
 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 Fileuploader {
-    writeStream(stream: ReadableStream, thumnbails: Thumbnail[], onProgress?: (uploadedBytes: number) => void): UploadController;
-    writeFile(fileObject: File, thumnbails: Thumbnail[], onProgress?: (uploadedBytes: number) => void): UploadController;
+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;