@protontech/drive-sdk 0.1.0 → 0.1.1

package/src/interface/sharing.ts

@@ -3,108 +3,111 @@ import { UnverifiedAuthorError } from './author';
 import { NodeType, MemberRole, InvalidNameError } from './nodes';
 
 export type Member = {
-    uid: string,
-    invitationTime: Date,
-    addedByEmail: Result<string, UnverifiedAuthorError>,
-    inviteeEmail: string,
-    role: MemberRole,
-}
+    uid: string;
+    invitationTime: Date;
+    addedByEmail: Result<string, UnverifiedAuthorError>;
+    inviteeEmail: string;
+    role: MemberRole;
+};
 
 export type ProtonInvitation = Member;
 
 export type ProtonInvitationWithNode = ProtonInvitation & {
     node: {
-        name: Result<string, Error | InvalidNameError>,
-        type: NodeType,
-        mediaType?: string,
-    },
-}
+        uid: string;
+        name: Result<string, Error | InvalidNameError>;
+        type: NodeType;
+        mediaType?: string;
+    };
+};
 
 export type NonProtonInvitation = ProtonInvitation & {
-    state: NonProtonInvitationState,
-}
+    state: NonProtonInvitationState;
+};
 
 export enum NonProtonInvitationState {
-    Pending = "pending",
-    UserRegistered = "userRegistered",
+    Pending = 'pending',
+    UserRegistered = 'userRegistered',
 }
 
 export type PublicLink = {
-    uid: string,
-    creationTime: Date,
-    role: MemberRole,
-    url: string,
-    customPassword?: string,
-    expirationTime?: Date,
-    numberOfInitializedDownloads: number
-}
+    uid: string;
+    creationTime: Date;
+    role: MemberRole;
+    url: string;
+    customPassword?: string;
+    expirationTime?: Date;
+    numberOfInitializedDownloads: number;
+};
 
 /**
  * Bookmark representing a saved link to publicly shared node.
- * 
+ *
  * This covers both happy path and degraded path.
  */
 export type MaybeBookmark = Result<Bookmark, DegradedBookmark>;
 
 export type Bookmark = {
-    uid: string,
-    creationTime: Date,
-    url: string,
+    uid: string;
+    creationTime: Date;
+    url: string;
     node: {
-        name: string,
-        type: NodeType,
-        mediaType?: string,
-    },
-}
+        name: string;
+        type: NodeType;
+        mediaType?: string;
+    };
+};
 
 /**
  * Degraded bookmark representing a saved link to publicly shared node.
- * 
+ *
  * This is a degraded path representation of the bookmark. It is used in the
  * SDK to represent the bookmark in a way that is easy to work with. Whenever
  * any field cannot be decrypted, it is returned as `DegradedBookmark` type.
  */
 export type DegradedBookmark = Omit<Bookmark, 'url' | 'node'> & {
-    url: Result<string, Error>,
+    url: Result<string, Error>;
     node: Omit<Bookmark['node'], 'name'> & {
-        name: Result<string, Error | InvalidNameError>,
-    },
-}
+        name: Result<string, Error | InvalidNameError>;
+    };
+};
 
 export type ProtonInvitationOrUid = ProtonInvitation | string;
 export type NonProtonInvitationOrUid = NonProtonInvitation | string;
 export type BookmarkOrUid = Bookmark | string;
 
 export type ShareNodeSettings = {
-    users?: ShareMembersSettings,
-    publicLink?: SharePublicLinkSettings,
+    users?: ShareMembersSettings;
+    publicLink?: SharePublicLinkSettings;
     emailOptions?: {
-        message?: string,
-        includeNodeName?: boolean,
-    },
-}
+        message?: string;
+        includeNodeName?: boolean;
+    };
+};
 
-export type ShareMembersSettings = string[] | {
-    email: string,
-    role: MemberRole,
-}[];
+export type ShareMembersSettings =
+    | string[]
+    | {
+          email: string;
+          role: MemberRole;
+      }[];
 
 export type SharePublicLinkSettings = boolean | SharePublicLinkSettingsObject;
 
 export type SharePublicLinkSettingsObject = {
-    role: MemberRole,
-    customPassword?: string | undefined,
-    expiration?: Date | undefined,
+    role: MemberRole;
+    customPassword?: string | undefined;
+    expiration?: Date | undefined;
 };
 
 export type ShareResult = {
-    protonInvitations: ProtonInvitation[],
-    nonProtonInvitations: NonProtonInvitation[],
-    members: Member[],
-    publicLink?: PublicLink,
-}
+    protonInvitations: ProtonInvitation[];
+    nonProtonInvitations: NonProtonInvitation[];
+    members: Member[];
+    publicLink?: PublicLink;
+};
 
 export type UnshareNodeSettings = {
-    users?: string[],
-    publicLink?: 'remove',
+    users?: string[];
+    publicLink?: 'remove';
 };

package/src/interface/telemetry.ts

@@ -1,6 +1,6 @@
 export interface Telemetry<MetricEvent> {
-    getLogger: (name: string) => Logger,
-    logEvent: (event: MetricEvent) => void,
+    getLogger: (name: string) => Logger;
+    logEvent: (event: MetricEvent) => void;
 }
 
 export interface Logger {
@@ -11,98 +11,98 @@ export interface Logger {
 }
 
 export type MetricEvent =
-    MetricAPIRetrySucceededEvent |
-    MetricUploadEvent |
-    MetricDownloadEvent |
-    MetricDecryptionErrorEvent |
-    MetricVerificationErrorEvent |
-    MetricBlockVerificationErrorEvent |
-    MetricVolumeEventsSubscriptionsChangedEvent;
+    | MetricAPIRetrySucceededEvent
+    | MetricUploadEvent
+    | MetricDownloadEvent
+    | MetricDecryptionErrorEvent
+    | MetricVerificationErrorEvent
+    | MetricBlockVerificationErrorEvent
+    | MetricVolumeEventsSubscriptionsChangedEvent;
 
 export interface MetricAPIRetrySucceededEvent {
-    eventName: 'apiRetrySucceeded',
-    url: string,
-    failedAttempts: number,
-};
+    eventName: 'apiRetrySucceeded';
+    url: string;
+    failedAttempts: number;
+}
 
 export interface MetricUploadEvent {
-    eventName: 'upload',
-    volumeType?: MetricVolumeType,
-    uploadedSize: number,
-    expectedSize: number,
-    error?: MetricsUploadErrorType,
-    originalError?: unknown,
-};
+    eventName: 'upload';
+    volumeType?: MetricVolumeType;
+    uploadedSize: number;
+    expectedSize: number;
+    error?: MetricsUploadErrorType;
+    originalError?: unknown;
+}
 export type MetricsUploadErrorType =
-    'server_error' |
-    'network_error' |
-    'integrity_error' |
-    'rate_limited' |
-    '4xx' |
-    'unknown';
+    | 'server_error'
+    | 'network_error'
+    | 'integrity_error'
+    | 'rate_limited'
+    | '4xx'
+    | 'unknown';
 
 export interface MetricDownloadEvent {
-    eventName: 'download',
-    volumeType?: MetricVolumeType,
-    downloadedSize: number,
-    claimedFileSize?: number,
-    error?: MetricsDownloadErrorType,
-    originalError?: unknown,
-};
+    eventName: 'download';
+    volumeType?: MetricVolumeType;
+    downloadedSize: number;
+    claimedFileSize?: number;
+    error?: MetricsDownloadErrorType;
+    originalError?: unknown;
+}
 export type MetricsDownloadErrorType =
-    'server_error' |
-    'network_error' |
-    'decryption_error' |
-    'integrity_error' |
-    'rate_limited' |
-    '4xx' |
-    'unknown';
+    | 'server_error'
+    | 'network_error'
+    | 'decryption_error'
+    | 'integrity_error'
+    | 'rate_limited'
+    | '4xx'
+    | 'unknown';
 
 export interface MetricDecryptionErrorEvent {
-    eventName: 'decryptionError',
-    volumeType?: MetricVolumeType,
-    field: MetricsDecryptionErrorField,
-    fromBefore2024?: boolean,
-    error?: unknown,
-};
+    eventName: 'decryptionError';
+    volumeType?: MetricVolumeType;
+    field: MetricsDecryptionErrorField;
+    fromBefore2024?: boolean;
+    error?: unknown;
+}
 export type MetricsDecryptionErrorField =
-    'shareKey' |
-    'shareUrlPassword' |
-    'nodeKey' |
-    'nodeName' |
-    'nodeHashKey' |
-    'nodeExtendedAttributes' |
-    'nodeContentKey' |
-    'content';
+    | 'shareKey'
+    | 'shareUrlPassword'
+    | 'nodeKey'
+    | 'nodeName'
+    | 'nodeHashKey'
+    | 'nodeExtendedAttributes'
+    | 'nodeContentKey'
+    | 'content';
 
 export interface MetricVerificationErrorEvent {
-    eventName: 'verificationError',
-    volumeType?: MetricVolumeType,
-    field: MetricVerificationErrorField,
-    addressMatchingDefaultShare?: boolean,
-    fromBefore2024?: boolean,
-};
+    eventName: 'verificationError';
+    volumeType?: MetricVolumeType;
+    field: MetricVerificationErrorField;
+    addressMatchingDefaultShare?: boolean;
+    fromBefore2024?: boolean;
+}
 export type MetricVerificationErrorField =
-    'shareKey' |
-    'nodeKey' |
-    'nodeName' |
-    'nodeHashKey' |
-    'nodeExtendedAttributes' |
-    'nodeContentKey' |
-    'content';
+    | 'shareKey'
+    | 'nodeKey'
+    | 'nodeName'
+    | 'nodeHashKey'
+    | 'nodeExtendedAttributes'
+    | 'nodeContentKey'
+    | 'content';
 
 export interface MetricBlockVerificationErrorEvent {
-    eventName: 'blockVerificationError',
-    retryHelped: boolean,
-};
+    eventName: 'blockVerificationError';
+    retryHelped: boolean;
+}
 
 export interface MetricVolumeEventsSubscriptionsChangedEvent {
-    eventName: 'volumeEventsSubscriptionsChanged',
-    numberOfVolumeSubscriptions: number,
-};
+    eventName: 'volumeEventsSubscriptionsChanged';
+    numberOfVolumeSubscriptions: number;
+}
 
 export enum MetricVolumeType {
     OwnVolume = 'own_volume',
     Shared = 'shared',
     SharedPublic = 'shared_public',
-};
+}

package/src/interface/thumbnail.ts

@@ -1,8 +1,7 @@
-
 export type Thumbnail = {
-    type: ThumbnailType,
-    thumbnail: Uint8Array,
-}
+    type: ThumbnailType;
+    thumbnail: Uint8Array;
+};
 
 export enum ThumbnailType {
     Type1 = 1,
@@ -10,5 +9,5 @@ export enum ThumbnailType {
 }
 
 export type ThumbnailResult =
-    {nodeUid: string, ok: true, thumbnail: Uint8Array } |
-    {nodeUid: string, ok: false, error: string};
+    | { nodeUid: string; ok: true; thumbnail: Uint8Array }
+    | { nodeUid: string; ok: false; error: string };

package/src/interface/upload.ts

@@ -1,7 +1,7 @@
-import { Thumbnail } from "./thumbnail";
+import { Thumbnail } from './thumbnail';
 
 export type UploadMetadata = {
-    mediaType: string,
+    mediaType: string;
     /**
      * Expected size of the file.
      *
@@ -9,13 +9,13 @@ export type UploadMetadata = {
      * If the expected size does not match the actual size, the upload will
      * fail.
      */
-    expectedSize: number,
+    expectedSize: number;
     /**
      * Modification time of the file.
      *
      * The modification time will be encrypted and stored with the file.
      */
-    modificationTime?: Date,
+    modificationTime?: Date;
     /**
      * Additional metadata to be stored with the file.
      *
@@ -23,13 +23,13 @@ export type UploadMetadata = {
      *
      * The metadata will be encrypted and stored with the file.
      */
-    additionalMetadata?: object,
+    additionalMetadata?: object;
     /**
      * If there is an existing draft by another client, the upload will be
      * rejected. If user decides to override the existing draft and continue
      * with the upload, set this to true.
      */
-    overrideExistingDraftByOtherClient?: boolean,
+    overrideExistingDraftByOtherClient?: boolean;
 };
 
 export interface FileRevisionUploader {
@@ -41,7 +41,11 @@ export interface FileRevisionUploader {
      *
      * The function will reject if the node with the given name already exists.
      */
-    writeStream(stream: ReadableStream, thumnbails: Thumbnail[], onProgress?: (uploadedBytes: number) => void): Promise<UploadController>,
+    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
@@ -53,7 +57,11 @@ export interface FileRevisionUploader {
      *
      * The function will reject if the node with the given name already exists.
      */
-    writeFile(fileObject: File, thumnbails: Thumbnail[], onProgress?: (uploadedBytes: number) => void): Promise<UploadController>,
+    writeFile(
+        fileObject: File,
+        thumnbails: Thumbnail[],
+        onProgress?: (uploadedBytes: number) => void,
+    ): Promise<UploadController>;
 }
 
 export interface FileUploader extends FileRevisionUploader {
@@ -65,11 +73,11 @@ export interface FileUploader extends FileRevisionUploader {
      *
      * Example new name: `file (2).txt`.
      */
-    getAvailableName(): Promise<string>,
+    getAvailableName(): Promise<string>;
 }
 
 export interface UploadController {
-    pause(): void,
-    resume(): void,
-    completion(): Promise<string>,
+    pause(): void;
+    resume(): void;
+    completion(): Promise<string>;
 }