@protontech/drive-sdk 0.7.0 → 0.7.2

package/dist/interface/index.d.ts

@@ -20,6 +20,7 @@ export { DriveEventType, SDKEvent } from './events';
 export type { ProtonDriveHTTPClient, ProtonDriveHTTPClientJsonRequest, ProtonDriveHTTPClientBlobRequest, } from './httpClient';
 export type { MaybeNode, NodeEntity, DegradedNode, MaybeMissingNode, MissingNode, InvalidNameError, Revision, NodeOrUid, RevisionOrUid, NodeResult, NodeResultWithNewUid, Membership, } from './nodes';
 export { NodeType, MemberRole, RevisionState } from './nodes';
+export type { MaybePhotoNode, MaybeMissingPhotoNode, PhotoNode, DegradedPhotoNode, PhotoAttributes } from './photos';
 export type { ProtonInvitation, ProtonInvitationWithNode, NonProtonInvitation, Member, PublicLink, MaybeBookmark, Bookmark, DegradedBookmark, ProtonInvitationOrUid, NonProtonInvitationOrUid, BookmarkOrUid, ShareNodeSettings, UnshareNodeSettings, ShareMembersSettings, SharePublicLinkSettings, SharePublicLinkSettingsObject, ShareResult, } from './sharing';
 export { NonProtonInvitationState } from './sharing';
 export type { Telemetry, Logger, MetricAPIRetrySucceededEvent, MetricUploadEvent, MetricsUploadErrorType, MetricDownloadEvent, MetricsDownloadErrorType, MetricDecryptionErrorEvent, MetricsDecryptionErrorField, MetricVerificationErrorEvent, MetricVerificationErrorField, MetricBlockVerificationErrorEvent, MetricVolumeEventsSubscriptionsChangedEvent, MetricEvent, } from './telemetry';

package/dist/interface/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/interface/index.ts"],"names":[],"mappings":";;;AAUA,mCAAiD;AAAxC,kGAAA,QAAQ,OAAA;AAAE,qGAAA,WAAW,OAAA;AAM9B,qCAAuC;AAA9B,qGAAA,UAAU,OAAA;AAYnB,mCAAoD;AAA3C,wGAAA,cAAc,OAAA;AAAE,kGAAA,QAAQ,OAAA;AAoBjC,iCAA8D;AAArD,iGAAA,QAAQ,OAAA;AAAE,mGAAA,UAAU,OAAA;AAAE,sGAAA,aAAa,OAAA;AAoB5C,qCAAqD;AAA5C,mHAAA,wBAAwB,OAAA;AAiBjC,yCAA+C;AAAtC,6GAAA,gBAAgB,OAAA;AAGzB,yCAA4C;AAAnC,0GAAA,aAAa,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/interface/index.ts"],"names":[],"mappings":";;;AAUA,mCAAiD;AAAxC,kGAAA,QAAQ,OAAA;AAAE,qGAAA,WAAW,OAAA;AAM9B,qCAAuC;AAA9B,qGAAA,UAAU,OAAA;AAYnB,mCAAoD;AAA3C,wGAAA,cAAc,OAAA;AAAE,kGAAA,QAAQ,OAAA;AAoBjC,iCAA8D;AAArD,iGAAA,QAAQ,OAAA;AAAE,mGAAA,UAAU,OAAA;AAAE,sGAAA,aAAa,OAAA;AAqB5C,qCAAqD;AAA5C,mHAAA,wBAAwB,OAAA;AAiBjC,yCAA+C;AAAtC,6GAAA,gBAAgB,OAAA;AAGzB,yCAA4C;AAAnC,0GAAA,aAAa,OAAA"}

package/dist/interface/nodes.d.ts

@@ -88,6 +88,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.
@@ -152,16 +156,13 @@ export declare 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"
+    Album = "album",
+    /**
+     * Photo is returned only by `ProtonDrivePhotosClient`.
+     */
+    Photo = "photo"
 }
 export type Membership = {
     role: MemberRole;
@@ -197,6 +198,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;
@@ -224,5 +228,5 @@ export type NodeResultWithNewUid = {
 } | {
     uid: string;
     ok: false;
-    error: string;
+    error: Error;
 };

package/dist/interface/nodes.js

@@ -6,16 +6,13 @@ var 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.
+     * Album is returned only by `ProtonDrivePhotosClient`.
      */
     NodeType["Album"] = "album";
+    /**
+     * Photo is returned only by `ProtonDrivePhotosClient`.
+     */
+    NodeType["Photo"] = "photo";
 })(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":";;;AA6JA,IAAY,QAcX;AAdD,WAAY,QAAQ;IAChB,yBAAa,CAAA;IACb,6BAAiB,CAAA;IACjB;;;;;;;;;OASG;IACH,2BAAe,CAAA;AACnB,CAAC,EAdW,QAAQ,wBAAR,QAAQ,QAcnB;AAmBD,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":";;;AAiKA,IAAY,QAWX;AAXD,WAAY,QAAQ;IAChB,yBAAa,CAAA;IACb,6BAAiB,CAAA;IACjB;;OAEG;IACH,2BAAe,CAAA;IACf;;OAEG;IACH,2BAAe,CAAA;AACnB,CAAC,EAXW,QAAQ,wBAAR,QAAQ,QAWnB;AAmBD,IAAY,UAKX;AALD,WAAY,UAAU;IAClB,+BAAiB,CAAA;IACjB,+BAAiB,CAAA;IACjB,6BAAe,CAAA;IACf,qCAAuB,CAAA;AAC3B,CAAC,EALW,UAAU,0BAAV,UAAU,QAKrB;AAyBD,IAAY,aAGX;AAHD,WAAY,aAAa;IACrB,kCAAiB,CAAA;IACjB,0CAAyB,CAAA;AAC7B,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB"}

package/dist/interface/photos.d.ts

@@ -0,0 +1,62 @@
+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[];
+};

package/dist/interface/photos.js

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

package/dist/interface/photos.js.map

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