@protontech/drive-sdk 0.6.2 → 0.7.1

package/dist/transformers.js.map

@@ -1 +1 @@
-{"version":3,"file":"transformers.js","sourceRoot":"","sources":["../src/transformers.ts"],"names":[],"mappings":";;AAsCA,wBAaC;AAED,0BAEC;AAED,kEAMC;AAED,gFAUC;AAED,gEAGC;AAED,kDAuCC;AAED,0EAMC;AAjID,2CAUqB;AA4BrB,SAAgB,MAAM,CAAC,OAAgB;IACnC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,OAAO,CAAC;IACnB,CAAC;IACD,oEAAoE;IACpE,IAAI,KAAK,IAAI,OAAO,EAAE,CAAC;QACnB,OAAO,OAAO,CAAC,GAAG,CAAC;IACvB,CAAC;IACD,2DAA2D;IAC3D,IAAI,OAAO,CAAC,EAAE,EAAE,CAAC;QACb,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC;IAC7B,CAAC;IACD,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC;AAC7B,CAAC;AAED,SAAgB,OAAO,CAAC,QAAmB;IACvC,OAAO,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AAChC,CAAC;AAEM,KAAK,SAAS,CAAC,CAAC,2BAA2B,CAC9C,YAAiD;IAEjD,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;QACpC,MAAM,mBAAmB,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;AACL,CAAC;AAEM,KAAK,SAAS,CAAC,CAAC,kCAAkC,CACrD,YAA+D;IAE/D,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;QACpC,IAAI,YAAY,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,IAAA,uBAAW,EAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;aAAM,CAAC;YACJ,MAAM,mBAAmB,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;IACL,CAAC;AACL,CAAC;AAEM,KAAK,UAAU,0BAA0B,CAAC,WAAyC;IACtF,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC;IAC/B,OAAO,mBAAmB,CAAC,IAAI,CAAC,CAAC;AACrC,CAAC;AAED,SAAgB,mBAAmB,CAAC,IAAyB;IACzD,MAAM,gBAAgB,GAAG;QACrB,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;QACvC,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;QACvC,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,iBAAiB,EAAE,IAAI,CAAC,OAAO;QAC/B,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;KAC1C,CAAC;IAEF,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;IACvB,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAE3C,IAAI,IAAI,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,cAAc,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC;QAC5E,OAAO,IAAA,uBAAW,EAAC;YACf,GAAG,gBAAgB;YACnB,IAAI;YACJ,cAAc,EAAE,cAAc,EAAE,EAAE;gBAC9B,CAAC,CAAC,IAAA,oBAAQ,EAAC,uBAAuB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;gBACzD,CAAC,CAAC,cAAc;YACpB,MAAM,EAAE,IAAI,CAAC,MAAM;SACA,CAAC,CAAC;IAC7B,CAAC;IAED,OAAO,IAAA,oBAAQ,EAAC;QACZ,GAAG,gBAAgB;QACnB,IAAI,EAAE,IAAI,CAAC,KAAK;QAChB,cAAc,EAAE,cAAc,EAAE,EAAE,CAAC,CAAC,CAAC,uBAAuB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS;KAC7E,CAAC,CAAC;AAC3B,CAAC;AAEM,KAAK,SAAS,CAAC,CAAC,+BAA+B,CAClD,gBAAkD;IAElD,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,gBAAgB,EAAE,CAAC;QAC5C,MAAM,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IAC5C,CAAC;AACL,CAAC;AAED,SAAS,uBAAuB,CAAC,QAA0B;IACvD,OAAO;QACH,GAAG,EAAE,QAAQ,CAAC,GAAG;QACjB,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,YAAY,EAAE,QAAQ,CAAC,YAAY;QACnC,aAAa,EAAE,QAAQ,CAAC,aAAa;QACrC,WAAW,EAAE,QAAQ,CAAC,WAAW;QACjC,WAAW,EAAE,QAAQ,CAAC,WAAW;QACjC,uBAAuB,EAAE,QAAQ,CAAC,uBAAuB;QACzD,cAAc,EAAE,QAAQ,CAAC,cAAc;QACvC,yBAAyB,EAAE,QAAQ,CAAC,yBAAyB;KAChE,CAAC;AACN,CAAC"}
+{"version":3,"file":"transformers.js","sourceRoot":"","sources":["../src/transformers.ts"],"names":[],"mappings":";;AA2CA,wBAaC;AAED,0BAEC;AAED,kEAMC;AAED,gFAUC;AAED,gEAGC;AAED,kDAwCC;AAED,4EAMC;AAED,0FAUC;AAED,0EAKC;AAED,4DAYC;AAED,0EAMC;AAhLD,2CAaqB;AA8BrB,SAAgB,MAAM,CAAC,OAAgB;IACnC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,OAAO,CAAC;IACnB,CAAC;IACD,oEAAoE;IACpE,IAAI,KAAK,IAAI,OAAO,EAAE,CAAC;QACnB,OAAO,OAAO,CAAC,GAAG,CAAC;IACvB,CAAC;IACD,2DAA2D;IAC3D,IAAI,OAAO,CAAC,EAAE,EAAE,CAAC;QACb,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC;IAC7B,CAAC;IACD,OAAO,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC;AAC7B,CAAC;AAED,SAAgB,OAAO,CAAC,QAAmB;IACvC,OAAO,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AAChC,CAAC;AAEM,KAAK,SAAS,CAAC,CAAC,2BAA2B,CAC9C,YAAiD;IAEjD,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;QACpC,MAAM,mBAAmB,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;AACL,CAAC;AAEM,KAAK,SAAS,CAAC,CAAC,kCAAkC,CACrD,YAA+D;IAE/D,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;QACpC,IAAI,YAAY,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,IAAA,uBAAW,EAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;aAAM,CAAC;YACJ,MAAM,mBAAmB,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;IACL,CAAC;AACL,CAAC;AAEM,KAAK,UAAU,0BAA0B,CAAC,WAAyC;IACtF,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC;IAC/B,OAAO,mBAAmB,CAAC,IAAI,CAAC,CAAC;AACrC,CAAC;AAED,SAAgB,mBAAmB,CAAC,IAAyB;IACzD,MAAM,gBAAgB,GAAG;QACrB,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;QACvC,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;QACvC,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;QACvC,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,iBAAiB,EAAE,IAAI,CAAC,OAAO;QAC/B,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;KAC1C,CAAC;IAEF,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;IACvB,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAE3C,IAAI,IAAI,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,cAAc,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC;QAC5E,OAAO,IAAA,uBAAW,EAAC;YACf,GAAG,gBAAgB;YACnB,IAAI;YACJ,cAAc,EAAE,cAAc,EAAE,EAAE;gBAC9B,CAAC,CAAC,IAAA,oBAAQ,EAAC,uBAAuB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;gBACzD,CAAC,CAAC,cAAc;YACpB,MAAM,EAAE,IAAI,CAAC,MAAM;SACA,CAAC,CAAC;IAC7B,CAAC;IAED,OAAO,IAAA,oBAAQ,EAAC;QACZ,GAAG,gBAAgB;QACnB,IAAI,EAAE,IAAI,CAAC,KAAK;QAChB,cAAc,EAAE,cAAc,EAAE,EAAE,CAAC,CAAC,CAAC,uBAAuB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS;KACjG,CAAC,CAAC;AACP,CAAC;AAEM,KAAK,SAAS,CAAC,CAAC,gCAAgC,CACnD,iBAA2D;IAE3D,IAAI,KAAK,EAAE,MAAM,SAAS,IAAI,iBAAiB,EAAE,CAAC;QAC9C,MAAM,wBAAwB,CAAC,SAAS,CAAC,CAAC;IAC9C,CAAC;AACL,CAAC;AAEM,KAAK,SAAS,CAAC,CAAC,uCAAuC,CAC1D,iBAAyE;IAEzE,IAAI,KAAK,EAAE,MAAM,SAAS,IAAI,iBAAiB,EAAE,CAAC;QAC9C,IAAI,YAAY,IAAI,SAAS,EAAE,CAAC;YAC5B,MAAM,IAAA,uBAAW,EAAC,SAAS,CAAC,CAAC;QACjC,CAAC;aAAM,CAAC;YACJ,MAAM,wBAAwB,CAAC,SAAS,CAAC,CAAC;QAC9C,CAAC;IACL,CAAC;AACL,CAAC;AAEM,KAAK,UAAU,+BAA+B,CACjD,gBAAmD;IAEnD,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC;IACzC,OAAO,wBAAwB,CAAC,SAAS,CAAC,CAAC;AAC/C,CAAC;AAED,SAAgB,wBAAwB,CAAC,SAAmC;IACxE,MAAM,IAAI,GAAG,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAC5C,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;QACV,OAAO,IAAA,oBAAQ,EAAC;YACZ,GAAG,IAAI,CAAC,KAAK;YACb,KAAK,EAAE,SAAS,CAAC,KAAK;SACN,CAAC,CAAC;IAC1B,CAAC;IACD,OAAO,IAAA,uBAAW,EAAC;QACf,GAAG,IAAI,CAAC,KAAK;QACb,KAAK,EAAE,SAAS,CAAC,KAAK;KACE,CAAC,CAAC;AAClC,CAAC;AAEM,KAAK,SAAS,CAAC,CAAC,+BAA+B,CAClD,gBAAkD;IAElD,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,gBAAgB,EAAE,CAAC;QAC5C,MAAM,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IAC5C,CAAC;AACL,CAAC;AAED,SAAS,uBAAuB,CAAC,QAA0B;IACvD,OAAO;QACH,GAAG,EAAE,QAAQ,CAAC,GAAG;QACjB,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,YAAY,EAAE,QAAQ,CAAC,YAAY;QACnC,aAAa,EAAE,QAAQ,CAAC,aAAa;QACrC,WAAW,EAAE,QAAQ,CAAC,WAAW;QACjC,WAAW,EAAE,QAAQ,CAAC,WAAW;QACjC,uBAAuB,EAAE,QAAQ,CAAC,uBAAuB;QACzD,cAAc,EAAE,QAAQ,CAAC,cAAc;QACvC,yBAAyB,EAAE,QAAQ,CAAC,yBAAyB;KAChE,CAAC;AACN,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@protontech/drive-sdk",
-    "version": "0.6.2",
+    "version": "0.7.1",
     "description": "Proton Drive SDK",
     "license": "GPL-3.0",
     "main": "dist/index.js",

package/src/interface/index.ts

@@ -47,6 +47,7 @@ export type {
     Membership,
 } from './nodes';
 export { NodeType, MemberRole, RevisionState } from './nodes';
+export type { MaybePhotoNode, MaybeMissingPhotoNode, PhotoNode, DegradedPhotoNode, PhotoAttributes } from './photos';
 export type {
     ProtonInvitation,
     ProtonInvitationWithNode,

package/src/interface/nodes.ts

@@ -92,6 +92,10 @@ export type NodeEntity = {
      * Created on server date.
      */
     creationTime: Date;
+    /**
+     * Modified on server (renamed, moved, etc.).
+     */
+    modificationTime: Date;
     trashTime?: Date;
     /**
      * Total size of all revisions, encrypted size on the server.
@@ -159,16 +163,13 @@ export enum NodeType {
     File = 'file',
     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 is returned only by `ProtonDrivePhotosClient`.
      */
     Album = 'album',
+    /**
+     * Photo is returned only by `ProtonDrivePhotosClient`.
+     */
+    Photo = 'photo',
 }
 
 export type Membership = {
@@ -208,6 +209,9 @@ export type Revision = {
      * Raw size of the revision, as stored in extended attributes.
      */
     claimedSize?: number;
+    /**
+     * Modification time on the file system.
+     */
     claimedModificationTime?: Date;
     claimedDigests?: {
         sha1?: string;
@@ -223,7 +227,6 @@ export enum RevisionState {
 export type NodeOrUid = MaybeNode | NodeEntity | DegradedNode | string;
 export type RevisionOrUid = Revision | string;
 
+// TODO: Remove string from the result and use Error instead to be compatible with the NodeResultWithNewUid.
 export type NodeResult = { uid: string; ok: true } | { uid: string; ok: false; error: string };
-export type NodeResultWithNewUid =
-    | { uid: string; newUid: string; ok: true }
-    | { uid: string; ok: false; error: string };
+export type NodeResultWithNewUid = { uid: string; newUid: string; ok: true } | { uid: string; ok: false; error: Error };

package/src/interface/photos.ts

@@ -0,0 +1,67 @@
+import { Result } from "./result";
+import { DegradedNode, NodeEntity, NodeType, MissingNode } from "./nodes";
+
+/**
+ * Node representing a photo or album for Photos SDK.
+ *
+ * See `MaybeNode` for more information.
+ */
+export type MaybePhotoNode = Result<PhotoNode, DegradedPhotoNode>;
+
+/**
+ * Node representing a photo or album, or missing node for Photos SDK.
+ *
+ * See `MaybeMissingNode` for more information.
+ */
+export type MaybeMissingPhotoNode = Result<PhotoNode, DegradedPhotoNode | MissingNode>;
+
+/**
+ * Node representing a photo or album for Photos SDK.
+ *
+ * See `NodeEntity` for more information.
+ */
+export type PhotoNode = NodeEntity & {
+    type: NodeType.Photo;
+    photo?: PhotoAttributes;
+};
+
+/**
+ * Degraded node representing a photo or album for Photos SDK.
+ *
+ * See `DegradedNode` for more information.
+ */
+export type DegradedPhotoNode = DegradedNode & {
+    photo?: PhotoAttributes;
+};
+
+/**
+ * Attributes of a photo.
+ *
+ * Only nodes of type `NodeType.Photo` have property of this type.
+ */
+export type PhotoAttributes = {
+    /**
+     * Date used for sorting in the photo timeline.
+     */
+    captureTime: Date;
+    /**
+     * Photo can consist of multiple photos or vidoes (e.g., live photo).
+     * Only the main photos are iterated and each main photo will have
+     * set the list of related photo UIDs that client can use to load
+     * the related photos. All the related photos will have set the
+     * main photo UID.
+     */
+    mainPhotoNodeUid?: string;
+    relatedPhotoNodeUids: string[];
+    /**
+     * List of albums in which the photo is included.
+     */
+    albums: {
+        nodeUid: string;
+        additionTime: Date;
+    }[];
+    /**
+     * List of tags assigned to the photo.
+     */
+    tags: number[]; // TODO: enum
+}

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,