@protontech/drive-sdk 0.0.13 → 0.1.1

package/dist/diagnostic/index.d.ts

@@ -0,0 +1,10 @@
+import { ProtonDriveClientContructorParameters } from '../interface';
+import { Diagnostic } from './interface';
+export type { Diagnostic, DiagnosticResult } from './interface';
+/**
+ * Initializes the diagnostic tool. It creates the instance of
+ * ProtonDriveClient with the special probes to observe the logs,
+ * metrics and HTTP calls; and enforced null/empty cache to always
+ * start from scratch.
+ */
+export declare function initDiagnostic(options: Omit<ProtonDriveClientContructorParameters, 'entitiesCache' | 'cryptoCache' | 'telemetry'>): Diagnostic;

package/dist/diagnostic/index.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initDiagnostic = initDiagnostic;
+const cache_1 = require("../cache");
+const protonDriveClient_1 = require("../protonDriveClient");
+const httpClient_1 = require("./httpClient");
+const sdkDiagnostic_1 = require("./sdkDiagnostic");
+const sdkDiagnosticFull_1 = require("./sdkDiagnosticFull");
+const telemetry_1 = require("./telemetry");
+/**
+ * Initializes the diagnostic tool. It creates the instance of
+ * ProtonDriveClient with the special probes to observe the logs,
+ * metrics and HTTP calls; and enforced null/empty cache to always
+ * start from scratch.
+ */
+function initDiagnostic(options) {
+    const httpClient = new httpClient_1.DiagnosticHTTPClient(options.httpClient);
+    const telemetry = new telemetry_1.DiagnosticTelemetry();
+    const protonDriveClient = new protonDriveClient_1.ProtonDriveClient({
+        ...options,
+        httpClient,
+        // Ensure we always start with a clean state.
+        // Do not use memory cache as diagnostic should visit each node
+        // only once and we don't want to grow memory usage.
+        entitiesCache: new cache_1.NullCache(),
+        // However, we need to use memory cache for crypto cache to avoid
+        // re-fetching the same key for all the children.
+        cryptoCache: new cache_1.MemoryCache(),
+        // Special telemetry that observes the logs and metrics.
+        telemetry,
+    });
+    const diagnostic = new sdkDiagnostic_1.SDKDiagnostic(protonDriveClient);
+    return new sdkDiagnosticFull_1.FullSDKDiagnostic(diagnostic, telemetry, httpClient);
+}
+//# sourceMappingURL=index.js.map

package/dist/diagnostic/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/diagnostic/index.ts"],"names":[],"mappings":";;AAiBA,wCAsBC;AAvCD,oCAAkD;AAElD,4DAAyD;AACzD,6CAAoD;AAEpD,mDAAgD;AAChD,2DAAwD;AACxD,2CAAkD;AAIlD;;;;;GAKG;AACH,SAAgB,cAAc,CAC1B,OAAmG;IAEnG,MAAM,UAAU,GAAG,IAAI,iCAAoB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAChE,MAAM,SAAS,GAAG,IAAI,+BAAmB,EAAE,CAAC;IAE5C,MAAM,iBAAiB,GAAG,IAAI,qCAAiB,CAAC;QAC5C,GAAG,OAAO;QACV,UAAU;QACV,6CAA6C;QAC7C,+DAA+D;QAC/D,oDAAoD;QACpD,aAAa,EAAE,IAAI,iBAAS,EAAE;QAC9B,iEAAiE;QACjE,iDAAiD;QACjD,WAAW,EAAE,IAAI,mBAAW,EAAE;QAC9B,wDAAwD;QACxD,SAAS;KACZ,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,IAAI,6BAAa,CAAC,iBAAiB,CAAC,CAAC;IACxD,OAAO,IAAI,qCAAiB,CAAC,UAAU,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;AACpE,CAAC"}

package/dist/diagnostic/integrityVerificationStream.d.ts

@@ -0,0 +1,21 @@
+/**
+ * A WritableStream that computes SHA1 hash on the fly.
+ * The computed SHA1 hash is available after the stream is closed.
+ */
+export declare class IntegrityVerificationStream extends WritableStream<Uint8Array> {
+    private sha1Hash;
+    private _computedSha1;
+    private _computedSizeInBytes;
+    private _isClosed;
+    constructor();
+    /**
+     * Get the computed SHA1 hash. Only available after the stream is closed.
+     * @returns The SHA1 hash as a hex string, or null if not yet computed or stream was aborted
+     */
+    get computedSha1(): string | undefined;
+    /**
+     * Get the computed size in bytes. Only available after the stream is closed.
+     * @returns The size in bytes, or 0 if not yet computed or stream was aborted
+     */
+    get computedSizeInBytes(): number | undefined;
+}

package/dist/diagnostic/integrityVerificationStream.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IntegrityVerificationStream = void 0;
+const legacy_1 = require("@noble/hashes/legacy");
+const utils_1 = require("@noble/hashes/utils");
+/**
+ * A WritableStream that computes SHA1 hash on the fly.
+ * The computed SHA1 hash is available after the stream is closed.
+ */
+class IntegrityVerificationStream extends WritableStream {
+    sha1Hash = legacy_1.sha1.create();
+    _computedSha1 = undefined;
+    _computedSizeInBytes = 0;
+    _isClosed = false;
+    constructor() {
+        super({
+            start: () => { },
+            write: (chunk) => {
+                if (this._isClosed) {
+                    throw new Error('Cannot write to a closed stream');
+                }
+                this.sha1Hash.update(chunk);
+                this._computedSizeInBytes += chunk.length;
+            },
+            close: () => {
+                if (!this._isClosed) {
+                    this._computedSha1 = (0, utils_1.bytesToHex)(this.sha1Hash.digest());
+                    this._isClosed = true;
+                }
+            },
+            abort: () => {
+                this._isClosed = true;
+                this._computedSha1 = undefined;
+            },
+        });
+    }
+    /**
+     * Get the computed SHA1 hash. Only available after the stream is closed.
+     * @returns The SHA1 hash as a hex string, or null if not yet computed or stream was aborted
+     */
+    get computedSha1() {
+        return this._computedSha1;
+    }
+    /**
+     * Get the computed size in bytes. Only available after the stream is closed.
+     * @returns The size in bytes, or 0 if not yet computed or stream was aborted
+     */
+    get computedSizeInBytes() {
+        if (!this._isClosed) {
+            return undefined;
+        }
+        return this._computedSizeInBytes;
+    }
+}
+exports.IntegrityVerificationStream = IntegrityVerificationStream;
+//# sourceMappingURL=integrityVerificationStream.js.map

package/dist/diagnostic/integrityVerificationStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"integrityVerificationStream.js","sourceRoot":"","sources":["../../src/diagnostic/integrityVerificationStream.ts"],"names":[],"mappings":";;;AAAA,iDAA4C;AAC5C,+CAAiD;AAEjD;;;GAGG;AACH,MAAa,2BAA4B,SAAQ,cAA0B;IAC/D,QAAQ,GAAG,aAAI,CAAC,MAAM,EAAE,CAAC;IACzB,aAAa,GAAuB,SAAS,CAAC;IAC9C,oBAAoB,GAAW,CAAC,CAAC;IACjC,SAAS,GAAG,KAAK,CAAC;IAE1B;QACI,KAAK,CAAC;YACF,KAAK,EAAE,GAAG,EAAE,GAAE,CAAC;YACf,KAAK,EAAE,CAAC,KAAiB,EAAE,EAAE;gBACzB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;oBACjB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;gBACvD,CAAC;gBACD,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC5B,IAAI,CAAC,oBAAoB,IAAI,KAAK,CAAC,MAAM,CAAC;YAC9C,CAAC;YACD,KAAK,EAAE,GAAG,EAAE;gBACR,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;oBAClB,IAAI,CAAC,aAAa,GAAG,IAAA,kBAAU,EAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;oBACxD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;gBAC1B,CAAC;YACL,CAAC;YACD,KAAK,EAAE,GAAG,EAAE;gBACR,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;gBACtB,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;YACnC,CAAC;SACJ,CAAC,CAAC;IACP,CAAC;IAED;;;OAGG;IACH,IAAI,YAAY;QACZ,OAAO,IAAI,CAAC,aAAa,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,IAAI,mBAAmB;QACnB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YAClB,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACrC,CAAC;CACJ;AA/CD,kEA+CC"}

package/dist/diagnostic/interface.d.ts

@@ -0,0 +1,102 @@
+import { DegradedNode, MaybeNode, MetricEvent } from '../interface';
+import { LogRecord } from '../telemetry';
+export interface Diagnostic {
+    verifyMyFiles(options?: DiagnosticOptions): AsyncGenerator<DiagnosticResult>;
+    verifyNodeTree(node: MaybeNode, options?: DiagnosticOptions): AsyncGenerator<DiagnosticResult>;
+}
+export type DiagnosticOptions = {
+    verifyContent?: boolean;
+    verifyThumbnails?: boolean;
+};
+export type DiagnosticResult = FatalErrorResult | SdkErrorResult | HttpErrorResult | DegradedNodeResult | UnverifiedAuthorResult | ExtendedAttributesErrorResult | ExtendedAttributesMissingFieldResult | ContentFileMissingRevisionResult | ContentIntegrityErrorResult | ContentDownloadErrorResult | ThumbnailsErrorResult | LogErrorResult | LogWarningResult | MetricResult;
+export type FatalErrorResult = {
+    type: 'fatal_error';
+    message: string;
+    error?: unknown;
+};
+export type SdkErrorResult = {
+    type: 'sdk_error';
+    call: string;
+    error?: unknown;
+};
+export type HttpErrorResult = {
+    type: 'http_error';
+    request: {
+        url: string;
+        method: string;
+        json: unknown;
+    };
+    error?: unknown;
+    response?: {
+        status: number;
+        statusText: string;
+        json?: object;
+        jsonError?: unknown;
+    };
+};
+export type DegradedNodeResult = {
+    type: 'degraded_node';
+    nodeUid: string;
+    node: DegradedNode;
+};
+export type UnverifiedAuthorResult = {
+    type: 'unverified_author';
+    nodeUid: string;
+    revisionUid?: string;
+    authorType: string;
+    claimedAuthor?: string;
+    error: string;
+    node: MaybeNode;
+};
+export type ExtendedAttributesErrorResult = {
+    type: 'extended_attributes_error';
+    nodeUid: string;
+    revisionUid?: string;
+    field: 'sha1';
+    value: string;
+};
+export type ExtendedAttributesMissingFieldResult = {
+    type: 'extended_attributes_missing_field';
+    nodeUid: string;
+    revisionUid?: string;
+    missingField: 'sha1';
+};
+export type ContentFileMissingRevisionResult = {
+    type: 'content_file_missing_revision';
+    nodeUid: string;
+    revisionUid?: string;
+};
+export type ContentIntegrityErrorResult = {
+    type: 'content_integrity_error';
+    nodeUid: string;
+    revisionUid?: string;
+    claimedSha1?: string;
+    computedSha1?: string;
+    claimedSizeInBytes?: number;
+    computedSizeInBytes?: number;
+};
+export type ContentDownloadErrorResult = {
+    type: 'content_download_error';
+    nodeUid: string;
+    revisionUid?: string;
+    error: unknown;
+};
+export type ThumbnailsErrorResult = {
+    type: 'thumbnails_error';
+    nodeUid: string;
+    revisionUid?: string;
+    message?: string;
+    error?: unknown;
+};
+export type LogErrorResult = {
+    type: 'log_error';
+    log: LogRecord;
+};
+export type LogWarningResult = {
+    type: 'log_warning';
+    log: LogRecord;
+};
+export type MetricResult = {
+    type: 'metric';
+    event: MetricEvent;
+};

package/dist/diagnostic/interface.js

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

package/dist/diagnostic/interface.js.map

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

package/dist/diagnostic/sdkDiagnostic.d.ts

@@ -0,0 +1,22 @@
+import { MaybeNode } from '../interface';
+import { ProtonDriveClient } from '../protonDriveClient';
+import { Diagnostic, DiagnosticOptions, DiagnosticResult } from './interface';
+/**
+ * Diagnostic tool that uses SDK to traverse the node tree and verify
+ * the integrity of the node tree.
+ *
+ * It produces only events that can be read by direct SDK invocation.
+ * To get the full diagnostic, use {@link FullSDKDiagnostic}.
+ */
+export declare class SDKDiagnostic implements Diagnostic {
+    private protonDriveClient;
+    constructor(protonDriveClient: ProtonDriveClient);
+    verifyMyFiles(options?: DiagnosticOptions): AsyncGenerator<DiagnosticResult>;
+    verifyNodeTree(node: MaybeNode, options?: DiagnosticOptions): AsyncGenerator<DiagnosticResult>;
+    private verifyNode;
+    private verifyAuthor;
+    private verifyFileExtendedAttributes;
+    private verifyContent;
+    private verifyThumbnails;
+    private verifyNodeChildren;
+}

package/dist/diagnostic/sdkDiagnostic.js

@@ -0,0 +1,222 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SDKDiagnostic = void 0;
+const interface_1 = require("../interface");
+const integrityVerificationStream_1 = require("./integrityVerificationStream");
+/**
+ * Diagnostic tool that uses SDK to traverse the node tree and verify
+ * the integrity of the node tree.
+ *
+ * It produces only events that can be read by direct SDK invocation.
+ * To get the full diagnostic, use {@link FullSDKDiagnostic}.
+ */
+class SDKDiagnostic {
+    protonDriveClient;
+    constructor(protonDriveClient) {
+        this.protonDriveClient = protonDriveClient;
+        this.protonDriveClient = protonDriveClient;
+    }
+    async *verifyMyFiles(options) {
+        let myFilesRootFolder;
+        try {
+            myFilesRootFolder = await this.protonDriveClient.getMyFilesRootFolder();
+        }
+        catch (error) {
+            yield {
+                type: 'fatal_error',
+                message: `Error getting my files root folder`,
+                error,
+            };
+            return;
+        }
+        yield* this.verifyNodeTree(myFilesRootFolder, options);
+    }
+    async *verifyNodeTree(node, options) {
+        const isFolder = getNodeType(node) === interface_1.NodeType.Folder;
+        yield* this.verifyNode(node, options);
+        if (isFolder) {
+            yield* this.verifyNodeChildren(node, options);
+        }
+    }
+    async *verifyNode(node, options) {
+        const nodeUid = node.ok ? node.value.uid : node.error.uid;
+        if (!node.ok) {
+            yield {
+                type: 'degraded_node',
+                nodeUid,
+                node: node.error,
+            };
+        }
+        const activeRevision = getActiveRevision(node);
+        const nodeInfo = {
+            ...getNodeUids(node),
+            node,
+        };
+        yield* this.verifyAuthor(node.ok ? node.value.keyAuthor : node.error.keyAuthor, {
+            ...nodeInfo,
+            authorType: 'key',
+        });
+        yield* this.verifyAuthor(node.ok ? node.value.nameAuthor : node.error.nameAuthor, {
+            ...nodeInfo,
+            authorType: 'name',
+        });
+        if (activeRevision) {
+            yield* this.verifyAuthor(activeRevision.contentAuthor, { ...nodeInfo, authorType: 'content' });
+        }
+        yield* this.verifyFileExtendedAttributes(node);
+        if (options?.verifyContent) {
+            yield* this.verifyContent(node);
+        }
+        if (options?.verifyThumbnails) {
+            yield* this.verifyThumbnails(node);
+        }
+    }
+    async *verifyAuthor(author, info) {
+        if (!author.ok) {
+            yield {
+                type: 'unverified_author',
+                claimedAuthor: author.error.claimedAuthor,
+                error: author.error.error,
+                ...info,
+            };
+        }
+    }
+    async *verifyFileExtendedAttributes(node) {
+        const activeRevision = getActiveRevision(node);
+        const expectedAttributes = getNodeType(node) === interface_1.NodeType.File;
+        const claimedSha1 = activeRevision?.claimedDigests?.sha1;
+        if (claimedSha1 && !/^[0-9a-f]{40}$/i.test(claimedSha1)) {
+            yield {
+                type: 'extended_attributes_error',
+                ...getNodeUids(node),
+                field: 'sha1',
+                value: claimedSha1,
+            };
+        }
+        if (expectedAttributes && !claimedSha1) {
+            yield {
+                type: 'extended_attributes_missing_field',
+                ...getNodeUids(node),
+                missingField: 'sha1',
+            };
+        }
+    }
+    async *verifyContent(node) {
+        if (getNodeType(node) !== interface_1.NodeType.File) {
+            return;
+        }
+        const activeRevision = getActiveRevision(node);
+        if (!activeRevision) {
+            yield {
+                type: 'content_file_missing_revision',
+                nodeUid: node.ok ? node.value.uid : node.error.uid,
+            };
+            return;
+        }
+        let downloader;
+        try {
+            downloader = await this.protonDriveClient.getFileRevisionDownloader(activeRevision.uid);
+        }
+        catch (error) {
+            yield {
+                type: 'sdk_error',
+                call: `getFileRevisionDownloader(${activeRevision.uid})`,
+                error,
+            };
+            return;
+        }
+        const claimedSha1 = activeRevision.claimedDigests?.sha1;
+        const claimedSizeInBytes = downloader.getClaimedSizeInBytes();
+        const integrityVerificationStream = new integrityVerificationStream_1.IntegrityVerificationStream();
+        const controller = downloader.writeToStream(integrityVerificationStream);
+        try {
+            await controller.completion();
+            const computedSha1 = integrityVerificationStream.computedSha1;
+            const computedSizeInBytes = integrityVerificationStream.computedSizeInBytes;
+            if (claimedSha1 !== computedSha1 || claimedSizeInBytes !== computedSizeInBytes) {
+                yield {
+                    type: 'content_integrity_error',
+                    ...getNodeUids(node),
+                    claimedSha1,
+                    computedSha1,
+                    claimedSizeInBytes,
+                    computedSizeInBytes,
+                };
+            }
+        }
+        catch (error) {
+            yield {
+                type: 'content_download_error',
+                ...getNodeUids(node),
+                error,
+            };
+        }
+    }
+    async *verifyThumbnails(node) {
+        if (getNodeType(node) !== interface_1.NodeType.File) {
+            return;
+        }
+        const nodeUid = node.ok ? node.value.uid : node.error.uid;
+        try {
+            const result = await Array.fromAsync(this.protonDriveClient.iterateThumbnails([nodeUid], interface_1.ThumbnailType.Type1));
+            if (result.length === 0) {
+                yield {
+                    type: 'sdk_error',
+                    call: `iterateThumbnails(${nodeUid})`,
+                    error: new Error('No thumbnails found'),
+                };
+            }
+            // TODO: We should have better way to check if the thumbnail is not expected.
+            if (!result[0].ok && result[0].error !== 'Node has no thumbnail') {
+                yield {
+                    type: 'thumbnails_error',
+                    nodeUid,
+                    error: result[0].error,
+                };
+            }
+        }
+        catch (error) {
+            yield {
+                type: 'sdk_error',
+                call: `iterateThumbnails(${nodeUid})`,
+                error,
+            };
+        }
+    }
+    async *verifyNodeChildren(node, options) {
+        const nodeUid = node.ok ? node.value.uid : node.error.uid;
+        try {
+            for await (const child of this.protonDriveClient.iterateFolderChildren(node)) {
+                yield* this.verifyNodeTree(child, options);
+            }
+        }
+        catch (error) {
+            yield {
+                type: 'sdk_error',
+                call: `iterateFolderChildren(${nodeUid})`,
+                error,
+            };
+        }
+    }
+}
+exports.SDKDiagnostic = SDKDiagnostic;
+function getNodeUids(node) {
+    const activeRevision = getActiveRevision(node);
+    return {
+        nodeUid: node.ok ? node.value.uid : node.error.uid,
+        revisionUid: activeRevision?.uid,
+    };
+}
+function getNodeType(node) {
+    return node.ok ? node.value.type : node.error.type;
+}
+function getActiveRevision(node) {
+    if (node.ok) {
+        return node.value.activeRevision;
+    }
+    if (node.error.activeRevision?.ok) {
+        return node.error.activeRevision.value;
+    }
+    return undefined;
+}
+//# sourceMappingURL=sdkDiagnostic.js.map

package/dist/diagnostic/sdkDiagnostic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdkDiagnostic.js","sourceRoot":"","sources":["../../src/diagnostic/sdkDiagnostic.ts"],"names":[],"mappings":";;;AAAA,4CAAoG;AAGpG,+EAA4E;AAE5E;;;;;;GAMG;AACH,MAAa,aAAa;IACF;IAApB,YAAoB,iBAAoC;QAApC,sBAAiB,GAAjB,iBAAiB,CAAmB;QACpD,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,CAAC,aAAa,CAAC,OAA2B;QAC5C,IAAI,iBAA4B,CAAC;QAEjC,IAAI,CAAC;YACD,iBAAiB,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,EAAE,CAAC;QAC5E,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACtB,MAAM;gBACF,IAAI,EAAE,aAAa;gBACnB,OAAO,EAAE,oCAAoC;gBAC7C,KAAK;aACR,CAAC;YACF,OAAO;QACX,CAAC;QAED,KAAK,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED,KAAK,CAAC,CAAC,cAAc,CAAC,IAAe,EAAE,OAA2B;QAC9D,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,oBAAQ,CAAC,MAAM,CAAC;QAEvD,KAAK,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEtC,IAAI,QAAQ,EAAE,CAAC;YACX,KAAK,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAClD,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,CAAC,UAAU,CAAC,IAAe,EAAE,OAA2B;QAClE,MAAM,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;QAE1D,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;YACX,MAAM;gBACF,IAAI,EAAE,eAAe;gBACrB,OAAO;gBACP,IAAI,EAAE,IAAI,CAAC,KAAK;aACnB,CAAC;QACN,CAAC;QAED,MAAM,cAAc,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC/C,MAAM,QAAQ,GAAG;YACb,GAAG,WAAW,CAAC,IAAI,CAAC;YACpB,IAAI;SACP,CAAC;QAEF,KAAK,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;YAC5E,GAAG,QAAQ;YACX,UAAU,EAAE,KAAK;SACpB,CAAC,CAAC;QACH,KAAK,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE;YAC9E,GAAG,QAAQ;YACX,UAAU,EAAE,MAAM;SACrB,CAAC,CAAC;QACH,IAAI,cAAc,EAAE,CAAC;YACjB,KAAK,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,aAAa,EAAE,EAAE,GAAG,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;QACnG,CAAC;QAED,KAAK,CAAC,CAAC,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;QAE/C,IAAI,OAAO,EAAE,aAAa,EAAE,CAAC;YACzB,KAAK,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;QACD,IAAI,OAAO,EAAE,gBAAgB,EAAE,CAAC;YAC5B,KAAK,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,CAAC,YAAY,CACvB,MAAc,EACd,IAAoF;QAEpF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;YACb,MAAM;gBACF,IAAI,EAAE,mBAAmB;gBACzB,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,aAAa;gBACzC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK;gBACzB,GAAG,IAAI;aACV,CAAC;QACN,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,CAAC,4BAA4B,CAAC,IAAe;QACvD,MAAM,cAAc,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAE/C,MAAM,kBAAkB,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,oBAAQ,CAAC,IAAI,CAAC;QAE/D,MAAM,WAAW,GAAG,cAAc,EAAE,cAAc,EAAE,IAAI,CAAC;QACzD,IAAI,WAAW,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YACtD,MAAM;gBACF,IAAI,EAAE,2BAA2B;gBACjC,GAAG,WAAW,CAAC,IAAI,CAAC;gBACpB,KAAK,EAAE,MAAM;gBACb,KAAK,EAAE,WAAW;aACrB,CAAC;QACN,CAAC;QAED,IAAI,kBAAkB,IAAI,CAAC,WAAW,EAAE,CAAC;YACrC,MAAM;gBACF,IAAI,EAAE,mCAAmC;gBACzC,GAAG,WAAW,CAAC,IAAI,CAAC;gBACpB,YAAY,EAAE,MAAM;aACvB,CAAC;QACN,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,CAAC,aAAa,CAAC,IAAe;QACxC,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,oBAAQ,CAAC,IAAI,EAAE,CAAC;YACtC,OAAO;QACX,CAAC;QACD,MAAM,cAAc,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,cAAc,EAAE,CAAC;YAClB,MAAM;gBACF,IAAI,EAAE,+BAA+B;gBACrC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG;aACrD,CAAC;YACF,OAAO;QACX,CAAC;QAED,IAAI,UAA0B,CAAC;QAC/B,IAAI,CAAC;YACD,UAAU,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,yBAAyB,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QAC5F,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACtB,MAAM;gBACF,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,6BAA6B,cAAc,CAAC,GAAG,GAAG;gBACxD,KAAK;aACR,CAAC;YACF,OAAO;QACX,CAAC;QAED,MAAM,WAAW,GAAG,cAAc,CAAC,cAAc,EAAE,IAAI,CAAC;QACxD,MAAM,kBAAkB,GAAG,UAAU,CAAC,qBAAqB,EAAE,CAAC;QAE9D,MAAM,2BAA2B,GAAG,IAAI,yDAA2B,EAAE,CAAC;QACtE,MAAM,UAAU,GAAG,UAAU,CAAC,aAAa,CAAC,2BAA2B,CAAC,CAAC;QAEzE,IAAI,CAAC;YACD,MAAM,UAAU,CAAC,UAAU,EAAE,CAAC;YAE9B,MAAM,YAAY,GAAG,2BAA2B,CAAC,YAAY,CAAC;YAC9D,MAAM,mBAAmB,GAAG,2BAA2B,CAAC,mBAAmB,CAAC;YAC5E,IAAI,WAAW,KAAK,YAAY,IAAI,kBAAkB,KAAK,mBAAmB,EAAE,CAAC;gBAC7E,MAAM;oBACF,IAAI,EAAE,yBAAyB;oBAC/B,GAAG,WAAW,CAAC,IAAI,CAAC;oBACpB,WAAW;oBACX,YAAY;oBACZ,kBAAkB;oBAClB,mBAAmB;iBACtB,CAAC;YACN,CAAC;QACL,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACtB,MAAM;gBACF,IAAI,EAAE,wBAAwB;gBAC9B,GAAG,WAAW,CAAC,IAAI,CAAC;gBACpB,KAAK;aACR,CAAC;QACN,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,CAAC,gBAAgB,CAAC,IAAe;QAC3C,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,oBAAQ,CAAC,IAAI,EAAE,CAAC;YACtC,OAAO;QACX,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;QAE1D,IAAI,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,SAAS,CAChC,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC,EAAE,yBAAa,CAAC,KAAK,CAAC,CAC3E,CAAC;YAEF,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACtB,MAAM;oBACF,IAAI,EAAE,WAAW;oBACjB,IAAI,EAAE,qBAAqB,OAAO,GAAG;oBACrC,KAAK,EAAE,IAAI,KAAK,CAAC,qBAAqB,CAAC;iBAC1C,CAAC;YACN,CAAC;YACD,6EAA6E;YAC7E,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,uBAAuB,EAAE,CAAC;gBAC/D,MAAM;oBACF,IAAI,EAAE,kBAAkB;oBACxB,OAAO;oBACP,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK;iBACzB,CAAC;YACN,CAAC;QACL,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACtB,MAAM;gBACF,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,qBAAqB,OAAO,GAAG;gBACrC,KAAK;aACR,CAAC;QACN,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,CAAC,kBAAkB,CAAC,IAAe,EAAE,OAA2B;QAC1E,MAAM,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;QAC1D,IAAI,CAAC;YACD,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,IAAI,CAAC,iBAAiB,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC3E,KAAK,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YAC/C,CAAC;QACL,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACtB,MAAM;gBACF,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,yBAAyB,OAAO,GAAG;gBACzC,KAAK;aACR,CAAC;QACN,CAAC;IACL,CAAC;CACJ;AAtND,sCAsNC;AAED,SAAS,WAAW,CAAC,IAAe;IAChC,MAAM,cAAc,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC/C,OAAO;QACH,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG;QAClD,WAAW,EAAE,cAAc,EAAE,GAAG;KACnC,CAAC;AACN,CAAC;AAED,SAAS,WAAW,CAAC,IAAe;IAChC,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;AACvD,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAe;IACtC,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;QACV,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC;IACrC,CAAC;IACD,IAAI,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,EAAE,EAAE,CAAC;QAChC,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC;IAC3C,CAAC;IACD,OAAO,SAAS,CAAC;AACrB,CAAC"}

package/dist/diagnostic/sdkDiagnosticFull.d.ts

@@ -0,0 +1,18 @@
+import { MaybeNode } from '../interface';
+import { DiagnosticHTTPClient } from './httpClient';
+import { Diagnostic, DiagnosticOptions, DiagnosticResult } from './interface';
+import { DiagnosticTelemetry } from './telemetry';
+/**
+ * Diagnostic tool that produces full diagnostic, including logs and metrics
+ * by reading the events from the telemetry and HTTP client.
+ */
+export declare class FullSDKDiagnostic implements Diagnostic {
+    private diagnostic;
+    private telemetry;
+    private httpClient;
+    constructor(diagnostic: Diagnostic, telemetry: DiagnosticTelemetry, httpClient: DiagnosticHTTPClient);
+    verifyMyFiles(options?: DiagnosticOptions): AsyncGenerator<DiagnosticResult>;
+    verifyNodeTree(node: MaybeNode, options?: DiagnosticOptions): AsyncGenerator<DiagnosticResult>;
+    private yieldEvents;
+    private internalGenerator;
+}

package/dist/diagnostic/sdkDiagnosticFull.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FullSDKDiagnostic = void 0;
+const zipGenerators_1 = require("./zipGenerators");
+/**
+ * Diagnostic tool that produces full diagnostic, including logs and metrics
+ * by reading the events from the telemetry and HTTP client.
+ */
+class FullSDKDiagnostic {
+    diagnostic;
+    telemetry;
+    httpClient;
+    constructor(diagnostic, telemetry, httpClient) {
+        this.diagnostic = diagnostic;
+        this.telemetry = telemetry;
+        this.httpClient = httpClient;
+        this.diagnostic = diagnostic;
+        this.telemetry = telemetry;
+        this.httpClient = httpClient;
+    }
+    async *verifyMyFiles(options) {
+        yield* this.yieldEvents(this.diagnostic.verifyMyFiles(options));
+    }
+    async *verifyNodeTree(node, options) {
+        yield* this.yieldEvents(this.diagnostic.verifyNodeTree(node, options));
+    }
+    async *yieldEvents(generator) {
+        yield* (0, zipGenerators_1.zipGenerators)(generator, this.internalGenerator(), { stopOnFirstDone: true });
+    }
+    async *internalGenerator() {
+        yield* (0, zipGenerators_1.zipGenerators)(this.telemetry.iterateEvents(), this.httpClient.iterateEvents());
+    }
+}
+exports.FullSDKDiagnostic = FullSDKDiagnostic;
+//# sourceMappingURL=sdkDiagnosticFull.js.map

package/dist/diagnostic/sdkDiagnosticFull.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdkDiagnosticFull.js","sourceRoot":"","sources":["../../src/diagnostic/sdkDiagnosticFull.ts"],"names":[],"mappings":";;;AAIA,mDAAgD;AAEhD;;;GAGG;AACH,MAAa,iBAAiB;IAEd;IACA;IACA;IAHZ,YACY,UAAsB,EACtB,SAA8B,EAC9B,UAAgC;QAFhC,eAAU,GAAV,UAAU,CAAY;QACtB,cAAS,GAAT,SAAS,CAAqB;QAC9B,eAAU,GAAV,UAAU,CAAsB;QAExC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,CAAC,aAAa,CAAC,OAA2B;QAC5C,KAAK,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IACpE,CAAC;IAED,KAAK,CAAC,CAAC,cAAc,CAAC,IAAe,EAAE,OAA2B;QAC9D,KAAK,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAC3E,CAAC;IAEO,KAAK,CAAC,CAAC,WAAW,CAAC,SAA2C;QAClE,KAAK,CAAC,CAAC,IAAA,6BAAa,EAAC,SAAS,EAAE,IAAI,CAAC,iBAAiB,EAAE,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC,CAAC;IACzF,CAAC;IAEO,KAAK,CAAC,CAAC,iBAAiB;QAC5B,KAAK,CAAC,CAAC,IAAA,6BAAa,EAAC,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,EAAE,IAAI,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC,CAAC;IAC1F,CAAC;CACJ;AA1BD,8CA0BC"}

package/dist/diagnostic/telemetry.d.ts

@@ -0,0 +1,25 @@
+import { MetricEvent } from '../interface';
+import { LogRecord } from '../telemetry';
+import { EventsGenerator } from './eventsGenerator';
+/**
+ * Special telemetry that is compatible with the SDK.
+ *
+ * It is a probe into SDK to observe whats going on and report any suspicious
+ * behavior.
+ *
+ * It should be used only for diagnostic purposes.
+ */
+export declare class DiagnosticTelemetry extends EventsGenerator {
+    getLogger(name: string): Logger;
+    logEvent(event: MetricEvent): void;
+}
+declare class Logger {
+    private name;
+    private callback?;
+    constructor(name: string, callback?: ((log: LogRecord) => void) | undefined);
+    debug(message: string): void;
+    info(message: string): void;
+    warn(message: string): void;
+    error(message: string, error?: unknown): void;
+}
+export {};

package/dist/diagnostic/telemetry.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DiagnosticTelemetry = void 0;
+const telemetry_1 = require("../telemetry");
+const eventsGenerator_1 = require("./eventsGenerator");
+/**
+ * Special telemetry that is compatible with the SDK.
+ *
+ * It is a probe into SDK to observe whats going on and report any suspicious
+ * behavior.
+ *
+ * It should be used only for diagnostic purposes.
+ */
+class DiagnosticTelemetry extends eventsGenerator_1.EventsGenerator {
+    getLogger(name) {
+        return new Logger(name, (log) => {
+            this.enqueueEvent({
+                type: log.level === telemetry_1.LogLevel.ERROR ? 'log_error' : 'log_warning',
+                log,
+            });
+        });
+    }
+    logEvent(event) {
+        if (event.eventName === 'download' && !event.error) {
+            return;
+        }
+        if (event.eventName === 'volumeEventsSubscriptionsChanged') {
+            return;
+        }
+        this.enqueueEvent({
+            type: 'metric',
+            event,
+        });
+    }
+}
+exports.DiagnosticTelemetry = DiagnosticTelemetry;
+class Logger {
+    name;
+    callback;
+    constructor(name, callback) {
+        this.name = name;
+        this.callback = callback;
+        this.name = name;
+        this.callback = callback;
+    }
+    // Debug or info logs are excluded from the diagnostic.
+    // These logs should not include any suspicious behavior.
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    debug(message) { }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    info(message) { }
+    warn(message) {
+        this.callback?.({
+            time: new Date(),
+            level: telemetry_1.LogLevel.WARNING,
+            loggerName: this.name,
+            message,
+        });
+    }
+    error(message, error) {
+        this.callback?.({
+            time: new Date(),
+            level: telemetry_1.LogLevel.ERROR,
+            loggerName: this.name,
+            message,
+            error,
+        });
+    }
+}
+//# sourceMappingURL=telemetry.js.map

package/dist/diagnostic/telemetry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry.js","sourceRoot":"","sources":["../../src/diagnostic/telemetry.ts"],"names":[],"mappings":";;;AACA,4CAAmD;AACnD,uDAAoD;AAEpD;;;;;;;GAOG;AACH,MAAa,mBAAoB,SAAQ,iCAAe;IACpD,SAAS,CAAC,IAAY;QAClB,OAAO,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE;YAC5B,IAAI,CAAC,YAAY,CAAC;gBACd,IAAI,EAAE,GAAG,CAAC,KAAK,KAAK,oBAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa;gBAChE,GAAG;aACN,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAED,QAAQ,CAAC,KAAkB;QACvB,IAAI,KAAK,CAAC,SAAS,KAAK,UAAU,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACjD,OAAO;QACX,CAAC;QACD,IAAI,KAAK,CAAC,SAAS,KAAK,kCAAkC,EAAE,CAAC;YACzD,OAAO;QACX,CAAC;QAED,IAAI,CAAC,YAAY,CAAC;YACd,IAAI,EAAE,QAAQ;YACd,KAAK;SACR,CAAC,CAAC;IACP,CAAC;CACJ;AAvBD,kDAuBC;AAED,MAAM,MAAM;IAEI;IACA;IAFZ,YACY,IAAY,EACZ,QAAmC;QADnC,SAAI,GAAJ,IAAI,CAAQ;QACZ,aAAQ,GAAR,QAAQ,CAA2B;QAE3C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC7B,CAAC;IAED,uDAAuD;IACvD,yDAAyD;IAEzD,6DAA6D;IAC7D,KAAK,CAAC,OAAe,IAAG,CAAC;IAEzB,6DAA6D;IAC7D,IAAI,CAAC,OAAe,IAAG,CAAC;IAExB,IAAI,CAAC,OAAe;QAChB,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,IAAI,EAAE,IAAI,IAAI,EAAE;YAChB,KAAK,EAAE,oBAAQ,CAAC,OAAO;YACvB,UAAU,EAAE,IAAI,CAAC,IAAI;YACrB,OAAO;SACV,CAAC,CAAC;IACP,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,KAAe;QAClC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,IAAI,EAAE,IAAI,IAAI,EAAE;YAChB,KAAK,EAAE,oBAAQ,CAAC,KAAK;YACrB,UAAU,EAAE,IAAI,CAAC,IAAI;YACrB,OAAO;YACP,KAAK;SACR,CAAC,CAAC;IACP,CAAC;CACJ"}