@protontech/drive-sdk 0.0.11 → 0.0.12

package/dist/errors.js

@@ -0,0 +1,163 @@
+"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;
+    constructor(message, code) {
+        super(message);
+        this.code = code;
+    }
+}
+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';
+    availableName;
+    constructor(message, code, availableName) {
+        super(message, code);
+        this.availableName = availableName;
+    }
+}
+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,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"}

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/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,16 @@
+import { Thumbnail } from "./thumbnail";
+export type UploadMetadata = {
+    mediaType: string;
+    expectedSize: number;
+    modificationTime?: Date;
+    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 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":""}

package/dist/internal/apiService/errorCodes.d.ts

@@ -0,0 +1,30 @@
+export declare const enum HTTPErrorCode {
+    OK = 200,
+    NOT_FOUND = 404,
+    TOO_MANY_REQUESTS = 429,
+    INTERNAL_SERVER_ERROR = 500
+}
+export declare function isCodeOk(code: number): boolean;
+export declare function isCodeOkAsync(code: number): boolean;
+export declare const enum ErrorCode {
+    OK = 1000,
+    OK_MANY = 1001,
+    OK_ASYNC = 1002,
+    NOT_ENOUGH_PERMISSIONS = 2011,
+    NOT_ENOUGH_PERMISSIONS_TO_GRANT_PERMISSIONS = 2026,
+    ALREADY_EXISTS = 2500,
+    NOT_EXISTS = 2501,
+    INSUFFICIENT_QUOTA = 200001,
+    INSUFFICIENT_SPACE = 200002,
+    MAX_FILE_SIZE_FOR_FREE_USER = 200003,
+    MAX_PUBLIC_EDIT_MODE_FOR_FREE_USER = 200004,
+    INSUFFICIENT_VOLUME_QUOTA = 200100,
+    INSUFFICIENT_DEVICE_QUOTA = 200101,
+    ALREADY_MEMBER_OF_SHARE_IN_VOLUME_WITH_ANOTHER_ADDRESS = 200201,
+    TOO_MANY_CHILDREN = 200300,
+    NESTING_TOO_DEEP = 200301,
+    INSUFFICIENT_INVITATION_QUOTA = 200600,
+    INSUFFICIENT_SHARE_QUOTA = 200601,
+    INSUFFICIENT_SHARE_JOINED_QUOTA = 200602,
+    INSUFFICIENT_BOOKMARKS_QUOTA = 200800
+}

package/dist/internal/apiService/errorCodes.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCodeOk = isCodeOk;
+exports.isCodeOkAsync = isCodeOkAsync;
+function isCodeOk(code) {
+    return code === 1000 /* ErrorCode.OK */ || code === 1001 /* ErrorCode.OK_MANY */ || code === 1002 /* ErrorCode.OK_ASYNC */;
+}
+function isCodeOkAsync(code) {
+    return code === 1002 /* ErrorCode.OK_ASYNC */;
+}
+//# sourceMappingURL=errorCodes.js.map

package/dist/internal/apiService/errorCodes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errorCodes.js","sourceRoot":"","sources":["../../../src/internal/apiService/errorCodes.ts"],"names":[],"mappings":";;AAOA,4BAEC;AAED,sCAEC;AAND,SAAgB,QAAQ,CAAC,IAAY;IACjC,OAAO,IAAI,4BAAiB,IAAI,IAAI,iCAAsB,IAAI,IAAI,kCAAuB,CAAC;AAC9F,CAAC;AAED,SAAgB,aAAa,CAAC,IAAY;IACtC,OAAO,IAAI,kCAAuB,CAAC;AACvC,CAAC"}

package/dist/internal/apiService/observerStream.d.ts

@@ -0,0 +1,3 @@
+export declare class ObserverStream extends TransformStream<Uint8Array, Uint8Array> {
+    constructor(fn?: (chunk: Uint8Array) => void);
+}

package/dist/internal/apiService/observerStream.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ObserverStream = void 0;
+class ObserverStream extends TransformStream {
+    constructor(fn) {
+        super({
+            transform(chunk, controller) {
+                fn?.(chunk);
+                controller.enqueue(chunk);
+            },
+        });
+    }
+}
+exports.ObserverStream = ObserverStream;
+//# sourceMappingURL=observerStream.js.map

package/dist/internal/apiService/observerStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"observerStream.js","sourceRoot":"","sources":["../../../src/internal/apiService/observerStream.ts"],"names":[],"mappings":";;;AAAA,MAAa,cAAe,SAAQ,eAAuC;IACvE,YAAY,EAAgC;QACxC,KAAK,CAAC;YACF,SAAS,CAAC,KAAK,EAAE,UAAU;gBACvB,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;gBACZ,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC9B,CAAC;SACJ,CAAC,CAAC;IACP,CAAC;CACJ;AATD,wCASC"}

package/dist/internal/batchLoading.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Helper class for batch loading items.
+ *
+ * The class is responsible for fetching items in batches. Any call to
+ * `load` will add the item to the batch (without fetching anything),
+ * and if the batch reaches the limit, it will fetch the items and yield
+ * them transparently to the caller.
+ *
+ * Example:
+ *
+ * ```typescript
+ * const batchLoading = new BatchLoading<string, DecryptedNode>({ loadItems: loadNodesCallback });
+ * for (const nodeUid of nodeUids) {
+ *   for await (const node of batchLoading.load(nodeUid)) {
+ *     console.log(node);
+ *   }
+ * }
+ * for await (const node of batchLoading.loadRest()) {
+ *  console.log(node);
+ * }
+ * ```
+ */
+export declare class BatchLoading<ID, ITEM> {
+    private batchSize;
+    private iterateItems;
+    private itemsToFetch;
+    constructor(options: {
+        loadItems?: (ids: ID[]) => Promise<ITEM[]>;
+        iterateItems?: (ids: ID[]) => AsyncGenerator<ITEM>;
+        batchSize?: number;
+    });
+    load(nodeUid: ID): AsyncGenerator<Awaited<ITEM>, void, any>;
+    loadRest(): AsyncGenerator<Awaited<ITEM>, void, any>;
+}

package/dist/internal/batchLoading.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BatchLoading = void 0;
+const DEFAULT_BATCH_LOADING = 10;
+/**
+ * Helper class for batch loading items.
+ *
+ * The class is responsible for fetching items in batches. Any call to
+ * `load` will add the item to the batch (without fetching anything),
+ * and if the batch reaches the limit, it will fetch the items and yield
+ * them transparently to the caller.
+ *
+ * Example:
+ *
+ * ```typescript
+ * const batchLoading = new BatchLoading<string, DecryptedNode>({ loadItems: loadNodesCallback });
+ * for (const nodeUid of nodeUids) {
+ *   for await (const node of batchLoading.load(nodeUid)) {
+ *     console.log(node);
+ *   }
+ * }
+ * for await (const node of batchLoading.loadRest()) {
+ *  console.log(node);
+ * }
+ * ```
+ */
+class BatchLoading {
+    batchSize = DEFAULT_BATCH_LOADING;
+    iterateItems;
+    itemsToFetch;
+    constructor(options) {
+        this.itemsToFetch = [];
+        if (options.loadItems) {
+            const loadItems = options.loadItems;
+            this.iterateItems = async function* (ids) {
+                for (const item of await loadItems(ids)) {
+                    yield item;
+                }
+            };
+        }
+        else if (options.iterateItems) {
+            this.iterateItems = options.iterateItems;
+        }
+        else {
+            // This is developer error.
+            throw new Error('Either loadItems or iterateItems must be provided');
+        }
+        if (options.batchSize) {
+            this.batchSize = options.batchSize;
+        }
+    }
+    async *load(nodeUid) {
+        this.itemsToFetch.push(nodeUid);
+        if (this.itemsToFetch.length >= this.batchSize) {
+            yield* this.iterateItems(this.itemsToFetch);
+            this.itemsToFetch = [];
+        }
+    }
+    async *loadRest() {
+        if (this.itemsToFetch.length === 0) {
+            return;
+        }
+        yield* this.iterateItems(this.itemsToFetch);
+        this.itemsToFetch = [];
+    }
+}
+exports.BatchLoading = BatchLoading;
+//# sourceMappingURL=batchLoading.js.map

package/dist/internal/batchLoading.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"batchLoading.js","sourceRoot":"","sources":["../../src/internal/batchLoading.ts"],"names":[],"mappings":";;;AAAA,MAAM,qBAAqB,GAAG,EAAE,CAAC;AAEjC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,YAAY;IACb,SAAS,GAAG,qBAAqB,CAAC;IAClC,YAAY,CAAsC;IAElD,YAAY,CAAO;IAE3B,YAAY,OAIX;QACG,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;QAEvB,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACpB,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;YACpC,IAAI,CAAC,YAAY,GAAG,KAAK,SAAS,CAAC,EAAE,GAAS;gBAC1C,KAAK,MAAM,IAAI,IAAI,MAAM,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;oBACtC,MAAM,IAAI,CAAC;gBACf,CAAC;YACL,CAAC,CAAA;QACL,CAAC;aAAM,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;YAC9B,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC7C,CAAC;aAAM,CAAC;YACJ,2BAA2B;YAC3B,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACzE,CAAC;QAED,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACpB,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACvC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,CAAC,IAAI,CAAC,OAAW;QACnB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEhC,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YAC7C,KAAK,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC5C,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;QAC3B,CAAC;IACL,CAAC;IAED,KAAK,CAAC,CAAC,QAAQ;QACX,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACjC,OAAO;QACX,CAAC;QAED,KAAK,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC5C,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;IAC3B,CAAC;CACJ;AAjDD,oCAiDC"}

package/dist/internal/batchLoading.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/internal/batchLoading.test.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const batchLoading_1 = require("./batchLoading");
+describe("BatchLoading", () => {
+    let batchLoading;
+    beforeEach(() => {
+        jest.clearAllMocks();
+    });
+    it("should load in batches with loadItems", async () => {
+        const loadItems = jest.fn((items) => Promise.resolve(items.map((item) => `loaded:${item}`)));
+        batchLoading = new batchLoading_1.BatchLoading({ loadItems, batchSize: 2 });
+        const result = [];
+        for (const item of ["a", "b", "c", "d", "e"]) {
+            for await (const loadedItem of batchLoading.load(item)) {
+                result.push(loadedItem);
+            }
+        }
+        for await (const loadedItem of batchLoading.loadRest()) {
+            result.push(loadedItem);
+        }
+        expect(result).toEqual(["loaded:a", "loaded:b", "loaded:c", "loaded:d", "loaded:e"]);
+        expect(loadItems).toHaveBeenCalledTimes(3);
+        expect(loadItems).toHaveBeenNthCalledWith(1, ["a", "b"]);
+        expect(loadItems).toHaveBeenNthCalledWith(2, ["c", "d"]);
+        expect(loadItems).toHaveBeenNthCalledWith(3, ["e"]);
+    });
+    it("should load in batches with iterateItems", async () => {
+        const iterateItems = jest.fn(async function* (items) {
+            for (const item of items) {
+                yield `loaded:${item}`;
+            }
+        });
+        batchLoading = new batchLoading_1.BatchLoading({ iterateItems, batchSize: 2 });
+        const result = [];
+        for (const item of ["a", "b", "c", "d", "e"]) {
+            for await (const loadedItem of batchLoading.load(item)) {
+                result.push(loadedItem);
+            }
+        }
+        for await (const loadedItem of batchLoading.loadRest()) {
+            result.push(loadedItem);
+        }
+        expect(result).toEqual(["loaded:a", "loaded:b", "loaded:c", "loaded:d", "loaded:e"]);
+        expect(iterateItems).toHaveBeenCalledTimes(3);
+        expect(iterateItems).toHaveBeenNthCalledWith(1, ["a", "b"]);
+        expect(iterateItems).toHaveBeenNthCalledWith(2, ["c", "d"]);
+        expect(iterateItems).toHaveBeenNthCalledWith(3, ["e"]);
+    });
+});
+//# sourceMappingURL=batchLoading.test.js.map

package/dist/internal/batchLoading.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"batchLoading.test.js","sourceRoot":"","sources":["../../src/internal/batchLoading.test.ts"],"names":[],"mappings":";;AAAA,iDAA8C;AAE9C,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC1B,IAAI,YAA0C,CAAC;IAE/C,UAAU,CAAC,GAAG,EAAE;QACZ,IAAI,CAAC,aAAa,EAAE,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;QACnD,MAAM,SAAS,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,KAAe,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAEvG,YAAY,GAAG,IAAI,2BAAY,CAAiB,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC;QAE7E,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;YAC3C,IAAI,KAAK,EAAE,MAAM,UAAU,IAAI,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrD,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC5B,CAAC;QACL,CAAC;QACD,IAAI,KAAK,EAAE,MAAM,UAAU,IAAI,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC;YACrD,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5B,CAAC;QAGD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;QACrF,MAAM,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC3C,MAAM,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QACzD,MAAM,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QACzD,MAAM,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;QACtD,MAAM,YAAY,GAAG,IAAI,CAAC,EAAE,CAAC,KAAK,SAAS,CAAC,EAAE,KAAe;YACzD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACvB,MAAM,UAAU,IAAI,EAAE,CAAC;YAC3B,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,YAAY,GAAG,IAAI,2BAAY,CAAiB,EAAE,YAAY,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC;QAEhF,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;YAC3C,IAAI,KAAK,EAAE,MAAM,UAAU,IAAI,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrD,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC5B,CAAC;QACL,CAAC;QACD,IAAI,KAAK,EAAE,MAAM,UAAU,IAAI,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC;YACrD,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5B,CAAC;QAED,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;QACrF,MAAM,CAAC,YAAY,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC9C,MAAM,CAAC,YAAY,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QAC5D,MAAM,CAAC,YAAY,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QAC5D,MAAM,CAAC,YAAY,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/internal/download/controller.d.ts

@@ -0,0 +1,8 @@
+export declare class DownloadController {
+    private paused;
+    promise?: Promise<void>;
+    waitWhilePaused(): Promise<void>;
+    pause(): void;
+    resume(): void;
+    completion(): Promise<void>;
+}