@protontech/drive-sdk 0.5.1 → 0.6.1

package/dist/diagnostic/diagnostic.d.ts

@@ -1,7 +1,8 @@
 import { MaybeNode } from '../interface';
 import { ProtonDriveClient } from '../protonDriveClient';
+import { ProtonDrivePhotosClient } from '../protonDrivePhotosClient';
 import { DiagnosticHTTPClient } from './httpClient';
-import { DiagnosticOptions, DiagnosticResult } from './interface';
+import { DiagnosticOptions, DiagnosticProgressCallback, DiagnosticResult } from './interface';
 import { DiagnosticTelemetry } from './telemetry';
 /**
  * Diagnostic tool that produces full diagnostic, including logs and metrics
@@ -11,9 +12,11 @@ export declare class Diagnostic {
     private telemetry;
     private httpClient;
     private protonDriveClient;
-    constructor(telemetry: DiagnosticTelemetry, httpClient: DiagnosticHTTPClient, protonDriveClient: ProtonDriveClient);
-    verifyMyFiles(options?: DiagnosticOptions): AsyncGenerator<DiagnosticResult>;
-    verifyNodeTree(node: MaybeNode, options?: DiagnosticOptions): AsyncGenerator<DiagnosticResult>;
+    private protonDrivePhotosClient;
+    constructor(telemetry: DiagnosticTelemetry, httpClient: DiagnosticHTTPClient, protonDriveClient: ProtonDriveClient, protonDrivePhotosClient: ProtonDrivePhotosClient);
+    verifyMyFiles(options?: DiagnosticOptions, onProgress?: DiagnosticProgressCallback): AsyncGenerator<DiagnosticResult>;
+    verifyNodeTree(node: MaybeNode, options?: DiagnosticOptions, onProgress?: DiagnosticProgressCallback): AsyncGenerator<DiagnosticResult>;
+    verifyPhotosTimeline(options?: DiagnosticOptions, onProgress?: DiagnosticProgressCallback): AsyncGenerator<DiagnosticResult>;
     private yieldEvents;
     private internalGenerator;
 }

package/dist/diagnostic/diagnostic.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Diagnostic = void 0;
-const sdkDiagnostic_1 = require("./sdkDiagnostic");
+const sdkDiagnosticMain_1 = require("./sdkDiagnosticMain");
+const sdkDiagnosticPhotos_1 = require("./sdkDiagnosticPhotos");
 const zipGenerators_1 = require("./zipGenerators");
 /**
  * Diagnostic tool that produces full diagnostic, including logs and metrics
@@ -11,21 +12,28 @@ class Diagnostic {
     telemetry;
     httpClient;
     protonDriveClient;
-    constructor(telemetry, httpClient, protonDriveClient) {
+    protonDrivePhotosClient;
+    constructor(telemetry, httpClient, protonDriveClient, protonDrivePhotosClient) {
         this.telemetry = telemetry;
         this.httpClient = httpClient;
         this.protonDriveClient = protonDriveClient;
+        this.protonDrivePhotosClient = protonDrivePhotosClient;
         this.telemetry = telemetry;
         this.httpClient = httpClient;
         this.protonDriveClient = protonDriveClient;
+        this.protonDrivePhotosClient = protonDrivePhotosClient;
     }
-    async *verifyMyFiles(options) {
-        const diagnostic = new sdkDiagnostic_1.SDKDiagnostic(this.protonDriveClient);
-        yield* this.yieldEvents(diagnostic.verifyMyFiles(options));
+    async *verifyMyFiles(options, onProgress) {
+        const diagnostic = new sdkDiagnosticMain_1.SDKDiagnosticMain(this.protonDriveClient, options, onProgress);
+        yield* this.yieldEvents(diagnostic.verifyMyFiles(options?.expectedStructure));
     }
-    async *verifyNodeTree(node, options) {
-        const diagnostic = new sdkDiagnostic_1.SDKDiagnostic(this.protonDriveClient);
-        yield* this.yieldEvents(diagnostic.verifyNodeTree(node, options));
+    async *verifyNodeTree(node, options, onProgress) {
+        const diagnostic = new sdkDiagnosticMain_1.SDKDiagnosticMain(this.protonDriveClient, options, onProgress);
+        yield* this.yieldEvents(diagnostic.verifyNodeTree(node, options?.expectedStructure));
+    }
+    async *verifyPhotosTimeline(options, onProgress) {
+        const diagnostic = new sdkDiagnosticPhotos_1.SDKDiagnosticPhotos(this.protonDrivePhotosClient, options, onProgress);
+        yield* this.yieldEvents(diagnostic.verifyTimeline(options?.expectedStructure));
     }
     async *yieldEvents(generator) {
         yield* (0, zipGenerators_1.zipGenerators)(generator, this.internalGenerator(), { stopOnFirstDone: true });

package/dist/diagnostic/diagnostic.js.map

@@ -1 +1 @@
-{"version":3,"file":"diagnostic.js","sourceRoot":"","sources":["../../src/diagnostic/diagnostic.ts"],"names":[],"mappings":";;;AAIA,mDAAgD;AAEhD,mDAAgD;AAEhD;;;GAGG;AACH,MAAa,UAAU;IAEP;IACA;IACA;IAHZ,YACY,SAA8B,EAC9B,UAAgC,EAChC,iBAAoC;QAFpC,cAAS,GAAT,SAAS,CAAqB;QAC9B,eAAU,GAAV,UAAU,CAAsB;QAChC,sBAAiB,GAAjB,iBAAiB,CAAmB;QAE5C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,CAAC,aAAa,CAAC,OAA2B;QAC5C,MAAM,UAAU,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC7D,KAAK,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED,KAAK,CAAC,CAAC,cAAc,CAAC,IAAe,EAAE,OAA2B;QAC9D,MAAM,UAAU,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC7D,KAAK,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IACtE,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;AA5BD,gCA4BC"}
+{"version":3,"file":"diagnostic.js","sourceRoot":"","sources":["../../src/diagnostic/diagnostic.ts"],"names":[],"mappings":";;;AAKA,2DAAwD;AACxD,+DAA4D;AAE5D,mDAAgD;AAEhD;;;GAGG;AACH,MAAa,UAAU;IAEP;IACA;IACA;IACA;IAJZ,YACY,SAA8B,EAC9B,UAAgC,EAChC,iBAAoC,EACpC,uBAAgD;QAHhD,cAAS,GAAT,SAAS,CAAqB;QAC9B,eAAU,GAAV,UAAU,CAAsB;QAChC,sBAAiB,GAAjB,iBAAiB,CAAmB;QACpC,4BAAuB,GAAvB,uBAAuB,CAAyB;QAExD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;IAC3D,CAAC;IAED,KAAK,CAAC,CAAC,aAAa,CAChB,OAA2B,EAC3B,UAAuC;QAEvC,MAAM,UAAU,GAAG,IAAI,qCAAiB,CAAC,IAAI,CAAC,iBAAiB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QACtF,KAAK,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAClF,CAAC;IAED,KAAK,CAAC,CAAC,cAAc,CACjB,IAAe,EACf,OAA2B,EAC3B,UAAuC;QAEvC,MAAM,UAAU,GAAG,IAAI,qCAAiB,CAAC,IAAI,CAAC,iBAAiB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QACtF,KAAK,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC;IACzF,CAAC;IAED,KAAK,CAAC,CAAC,oBAAoB,CACvB,OAA2B,EAC3B,UAAuC;QAEvC,MAAM,UAAU,GAAG,IAAI,yCAAmB,CAAC,IAAI,CAAC,uBAAuB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAC9F,KAAK,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,cAAc,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC;IACnF,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;AA7CD,gCA6CC"}

package/dist/diagnostic/index.d.ts

@@ -1,6 +1,6 @@
 import { ProtonDriveClientContructorParameters } from '../interface';
 import { Diagnostic } from './interface';
-export type { Diagnostic, DiagnosticResult } from './interface';
+export type { Diagnostic, DiagnosticOptions, ExpectedTreeNode, DiagnosticProgressCallback, DiagnosticResult, } from './interface';
 /**
  * Initializes the diagnostic tool. It creates the instance of
  * ProtonDriveClient with the special probes to observe the logs,

package/dist/diagnostic/index.js

@@ -6,6 +6,7 @@ const protonDriveClient_1 = require("../protonDriveClient");
 const diagnostic_1 = require("./diagnostic");
 const httpClient_1 = require("./httpClient");
 const telemetry_1 = require("./telemetry");
+const protonDrivePhotosClient_1 = require("../protonDrivePhotosClient");
 /**
  * Initializes the diagnostic tool. It creates the instance of
  * ProtonDriveClient with the special probes to observe the logs,
@@ -28,6 +29,13 @@ function initDiagnostic(options) {
         // Special telemetry that observes the logs and metrics.
         telemetry,
     });
-    return new diagnostic_1.Diagnostic(telemetry, httpClient, protonDriveClient);
+    const protonDrivePhotosClient = new protonDrivePhotosClient_1.ProtonDrivePhotosClient({
+        ...options,
+        httpClient,
+        entitiesCache: new cache_1.NullCache(),
+        cryptoCache: new cache_1.MemoryCache(),
+        telemetry,
+    });
+    return new diagnostic_1.Diagnostic(telemetry, httpClient, protonDriveClient, protonDrivePhotosClient);
 }
 //# sourceMappingURL=index.js.map

package/dist/diagnostic/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/diagnostic/index.ts"],"names":[],"mappings":";;AAgBA,wCAqBC;AArCD,oCAAkD;AAElD,4DAAyD;AACzD,6CAA6D;AAE7D,6CAAoD;AACpD,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,OAAO,IAAI,uBAAe,CAAC,SAAS,EAAE,UAAU,EAAE,iBAAiB,CAAC,CAAC;AACzE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/diagnostic/index.ts"],"names":[],"mappings":";;AAuBA,wCA6BC;AApDD,oCAAkD;AAElD,4DAAyD;AACzD,6CAA6D;AAE7D,6CAAoD;AACpD,2CAAkD;AAClD,wEAAqE;AAUrE;;;;;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,uBAAuB,GAAG,IAAI,iDAAuB,CAAC;QACxD,GAAG,OAAO;QACV,UAAU;QACV,aAAa,EAAE,IAAI,iBAAS,EAAE;QAC9B,WAAW,EAAE,IAAI,mBAAW,EAAE;QAC9B,SAAS;KACZ,CAAC,CAAC;IAEH,OAAO,IAAI,uBAAe,CAAC,SAAS,EAAE,UAAU,EAAE,iBAAiB,EAAE,uBAAuB,CAAC,CAAC;AAClG,CAAC"}

package/dist/diagnostic/interface.d.ts

@@ -1,20 +1,33 @@
 import { Author, MaybeNode, MetricEvent, NodeType, AnonymousUser } from '../interface';
 import { LogRecord } from '../telemetry';
 export interface Diagnostic {
-    verifyMyFiles(options?: DiagnosticOptions): AsyncGenerator<DiagnosticResult>;
-    verifyNodeTree(node: MaybeNode, options?: DiagnosticOptions): AsyncGenerator<DiagnosticResult>;
+    verifyMyFiles(options?: DiagnosticOptions, onProgress?: DiagnosticProgressCallback): AsyncGenerator<DiagnosticResult>;
+    verifyNodeTree(node: MaybeNode, options?: DiagnosticOptions, onProgress?: DiagnosticProgressCallback): AsyncGenerator<DiagnosticResult>;
+    verifyPhotosTimeline(options?: DiagnosticOptions, onProgress?: DiagnosticProgressCallback): AsyncGenerator<DiagnosticResult>;
 }
 export type DiagnosticOptions = {
-    verifyContent?: boolean;
+    verifyContent?: boolean | 'peakOnly';
     verifyThumbnails?: boolean;
-    expectedStructure?: ExcpectedTreeNode;
+    expectedStructure?: ExpectedTreeNode;
 };
-export type ExcpectedTreeNode = {
+export type ExpectedTreeNode = {
     name: string;
+    expectedMediaType?: string;
     expectedSha1?: string;
     expectedSizeInBytes?: number;
-    children?: ExcpectedTreeNode[];
+    expectedAuthors?: ExpectedAuthor | {
+        key?: ExpectedAuthor;
+        name?: ExpectedAuthor;
+        content?: ExpectedAuthor;
+    };
+    children?: ExpectedTreeNode[];
 };
+export type ExpectedAuthor = string | 'anonymous';
+export type DiagnosticProgressCallback = (progress: {
+    allNodesLoaded: boolean;
+    loadedNodes: number;
+    checkedNodes: number;
+}) => void;
 export type DiagnosticResult = FatalErrorResult | SdkErrorResult | HttpErrorResult | DegradedNodeResult | UnverifiedAuthorResult | ExtendedAttributesErrorResult | ExtendedAttributesMissingFieldResult | ContentFileMissingRevisionResult | ContentIntegrityErrorResult | ContentDownloadErrorResult | ThumbnailsErrorResult | ExpectedStructureMissingNode | ExpectedStructureUnexpectedNode | ExpectedStructureIntegrityError | LogErrorResult | LogWarningResult | MetricResult;
 export type FatalErrorResult = {
     type: 'fatal_error';
@@ -79,7 +92,7 @@ export type ThumbnailsErrorResult = {
 } & NodeDetails;
 export type ExpectedStructureMissingNode = {
     type: 'expected_structure_missing_node';
-    expectedNode: ExcpectedTreeNode;
+    expectedNode: ExpectedTreeNode;
     parentNodeUid: string;
 };
 export type ExpectedStructureUnexpectedNode = {
@@ -87,7 +100,7 @@ export type ExpectedStructureUnexpectedNode = {
 } & NodeDetails;
 export type ExpectedStructureIntegrityError = {
     type: 'expected_structure_integrity_error';
-    expectedNode: ExcpectedTreeNode;
+    expectedNode: ExpectedTreeNode;
     claimedSha1?: string;
     claimedSizeInBytes?: number;
 } & NodeDetails;
@@ -106,11 +119,13 @@ export type MetricResult = {
 export type NodeDetails = {
     safeNodeDetails: {
         nodeUid: string;
-        revisionUid?: string;
+        revisionUid: string | undefined;
         nodeType: NodeType;
+        mediaType: string | undefined;
         nodeCreationTime: Date;
         keyAuthor: Author;
         nameAuthor: Author;
+        contentAuthor: Author | undefined;
         errors: {
             field: string;
             error: unknown;

package/dist/diagnostic/nodeUtils.d.ts

@@ -0,0 +1,13 @@
+import { MaybeNode, NodeType, Revision } from '../interface';
+import { NodeDetails, ExpectedTreeNode } from './interface';
+export declare function getNodeDetails(node: MaybeNode): NodeDetails;
+export declare function getNodeUids(node: MaybeNode): {
+    nodeUid: string;
+    revisionUid: string | undefined;
+};
+export declare function getNodeType(node: MaybeNode): NodeType;
+export declare function getMediaType(node: MaybeNode): string | undefined;
+export declare function getActiveRevision(node: MaybeNode): Revision | undefined;
+export declare function getNodeName(node: MaybeNode): string;
+export declare function getExpectedTreeNodeDetails(expectedNode: ExpectedTreeNode): ExpectedTreeNode;
+export declare function getTreeNodeChildByNodeName(expectedSubtree: ExpectedTreeNode | undefined, nodeName: string): ExpectedTreeNode | undefined;

package/dist/diagnostic/nodeUtils.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNodeDetails = getNodeDetails;
+exports.getNodeUids = getNodeUids;
+exports.getNodeType = getNodeType;
+exports.getMediaType = getMediaType;
+exports.getActiveRevision = getActiveRevision;
+exports.getNodeName = getNodeName;
+exports.getExpectedTreeNodeDetails = getExpectedTreeNodeDetails;
+exports.getTreeNodeChildByNodeName = getTreeNodeChildByNodeName;
+function getNodeDetails(node) {
+    const errors = [];
+    if (!node.ok) {
+        const degradedNode = node.error;
+        if (!degradedNode.name.ok) {
+            errors.push({
+                field: 'name',
+                error: degradedNode.name.error,
+            });
+        }
+        if (degradedNode.activeRevision?.ok === false) {
+            errors.push({
+                field: 'activeRevision',
+                error: degradedNode.activeRevision.error,
+            });
+        }
+        for (const error of degradedNode.errors ?? []) {
+            if (error instanceof Error) {
+                errors.push({
+                    field: 'error',
+                    error,
+                });
+            }
+        }
+    }
+    return {
+        safeNodeDetails: {
+            ...getNodeUids(node),
+            nodeType: getNodeType(node),
+            mediaType: getMediaType(node),
+            nodeCreationTime: node.ok ? node.value.creationTime : node.error.creationTime,
+            keyAuthor: node.ok ? node.value.keyAuthor : node.error.keyAuthor,
+            nameAuthor: node.ok ? node.value.nameAuthor : node.error.nameAuthor,
+            contentAuthor: getActiveRevision(node)?.contentAuthor,
+            errors,
+        },
+        sensitiveNodeDetails: node,
+    };
+}
+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 getMediaType(node) {
+    return node.ok ? node.value.mediaType : node.error.mediaType;
+}
+function getActiveRevision(node) {
+    if (node.ok) {
+        return node.value.activeRevision;
+    }
+    if (node.error.activeRevision?.ok) {
+        return node.error.activeRevision.value;
+    }
+    return undefined;
+}
+function getNodeName(node) {
+    if (node.ok) {
+        return node.value.name;
+    }
+    if (node.error.name.ok) {
+        return node.error.name.value;
+    }
+    return 'N/A';
+}
+function getExpectedTreeNodeDetails(expectedNode) {
+    return {
+        ...expectedNode,
+        children: undefined,
+    };
+}
+function getTreeNodeChildByNodeName(expectedSubtree, nodeName) {
+    return expectedSubtree?.children?.find((expectedNode) => expectedNode.name === nodeName);
+}
+//# sourceMappingURL=nodeUtils.js.map

package/dist/diagnostic/nodeUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nodeUtils.js","sourceRoot":"","sources":["../../src/diagnostic/nodeUtils.ts"],"names":[],"mappings":";;AAMA,wCA2CC;AAED,kCAMC;AAED,kCAEC;AAED,oCAEC;AAED,8CAQC;AAED,kCAQC;AAED,gEAKC;AAED,gEAKC;AA7FD,SAAgB,cAAc,CAAC,IAAe;IAC1C,MAAM,MAAM,GAGN,EAAE,CAAC;IAET,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;QACX,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC;QAChC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;YACxB,MAAM,CAAC,IAAI,CAAC;gBACR,KAAK,EAAE,MAAM;gBACb,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,KAAK;aACjC,CAAC,CAAC;QACP,CAAC;QACD,IAAI,YAAY,CAAC,cAAc,EAAE,EAAE,KAAK,KAAK,EAAE,CAAC;YAC5C,MAAM,CAAC,IAAI,CAAC;gBACR,KAAK,EAAE,gBAAgB;gBACvB,KAAK,EAAE,YAAY,CAAC,cAAc,CAAC,KAAK;aAC3C,CAAC,CAAC;QACP,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,YAAY,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC;YAC5C,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;gBACzB,MAAM,CAAC,IAAI,CAAC;oBACR,KAAK,EAAE,OAAO;oBACd,KAAK;iBACR,CAAC,CAAC;YACP,CAAC;QACL,CAAC;IACL,CAAC;IAED,OAAO;QACH,eAAe,EAAE;YACb,GAAG,WAAW,CAAC,IAAI,CAAC;YACpB,QAAQ,EAAE,WAAW,CAAC,IAAI,CAAC;YAC3B,SAAS,EAAE,YAAY,CAAC,IAAI,CAAC;YAC7B,gBAAgB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY;YAC7E,SAAS,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS;YAChE,UAAU,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU;YACnE,aAAa,EAAE,iBAAiB,CAAC,IAAI,CAAC,EAAE,aAAa;YACrD,MAAM;SACT;QACD,oBAAoB,EAAE,IAAI;KAC7B,CAAC;AACN,CAAC;AAED,SAAgB,WAAW,CAAC,IAAe;IACvC,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,SAAgB,WAAW,CAAC,IAAe;IACvC,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;AACvD,CAAC;AAED,SAAgB,YAAY,CAAC,IAAe;IACxC,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;AACjE,CAAC;AAED,SAAgB,iBAAiB,CAAC,IAAe;IAC7C,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;AAED,SAAgB,WAAW,CAAC,IAAe;IACvC,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;QACV,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IAC3B,CAAC;IACD,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;IACjC,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,SAAgB,0BAA0B,CAAC,YAA8B;IACrE,OAAO;QACH,GAAG,YAAY;QACf,QAAQ,EAAE,SAAS;KACtB,CAAC;AACN,CAAC;AAED,SAAgB,0BAA0B,CACtC,eAA6C,EAC7C,QAAgB;IAEhB,OAAO,eAAe,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;AAC7F,CAAC"}

package/dist/diagnostic/sdkDiagnosticBase.d.ts

@@ -0,0 +1,36 @@
+import { FileDownloader, MaybeNode, NodeOrUid, ThumbnailType, ThumbnailResult } from '../interface';
+import { DiagnosticOptions, DiagnosticResult, ExpectedTreeNode, DiagnosticProgressCallback } from './interface';
+interface SDKClient {
+    getFileDownloader(nodeOrUid: NodeOrUid): Promise<FileDownloader>;
+    iterateThumbnails(nodeUids: string[], thumbnailType: ThumbnailType): AsyncGenerator<ThumbnailResult>;
+}
+/**
+ * Base class for all SDK diagnostic tools that verifies the integrity of
+ * the individual nodes.
+ */
+export declare class SDKDiagnosticBase {
+    private sdkClient;
+    private options;
+    private onProgress?;
+    private progressReportInterval;
+    protected nodesQueue: {
+        node: MaybeNode;
+        expected?: ExpectedTreeNode;
+    }[];
+    protected allNodesLoaded: boolean;
+    protected loadedNodes: number;
+    protected checkedNodes: number;
+    constructor(sdkClient: SDKClient, options?: Pick<DiagnosticOptions, 'verifyContent' | 'verifyThumbnails'>, onProgress?: DiagnosticProgressCallback);
+    protected startProgress(): void;
+    protected finishProgress(): void;
+    private reportProgress;
+    protected verifyExpectedNodeChildren(parentNodeUid: string, children: MaybeNode[], expectedStructure?: ExpectedTreeNode): AsyncGenerator<DiagnosticResult>;
+    protected verifyNodesQueue(): AsyncGenerator<DiagnosticResult>;
+    private verifyNode;
+    private verifyAuthor;
+    private verifyFileExtendedAttributes;
+    private verifyContentPeak;
+    private verifyContent;
+    private verifyThumbnails;
+}
+export {};

package/dist/diagnostic/sdkDiagnosticBase.js

@@ -0,0 +1,305 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SDKDiagnosticBase = void 0;
+const interface_1 = require("../interface");
+const integrityVerificationStream_1 = require("./integrityVerificationStream");
+const nodeUtils_1 = require("./nodeUtils");
+const PROGRESS_REPORT_INTERVAL = 500;
+/**
+ * Base class for all SDK diagnostic tools that verifies the integrity of
+ * the individual nodes.
+ */
+class SDKDiagnosticBase {
+    sdkClient;
+    options;
+    onProgress;
+    progressReportInterval;
+    nodesQueue = [];
+    allNodesLoaded = false;
+    loadedNodes = 0;
+    checkedNodes = 0;
+    constructor(sdkClient, options, onProgress) {
+        this.sdkClient = sdkClient;
+        this.sdkClient = sdkClient;
+        this.options = options || { verifyContent: false, verifyThumbnails: false };
+        this.onProgress = onProgress;
+    }
+    startProgress() {
+        this.allNodesLoaded = false;
+        this.loadedNodes = 0;
+        this.checkedNodes = 0;
+        this.reportProgress();
+        this.progressReportInterval = setInterval(() => {
+            this.reportProgress();
+        }, PROGRESS_REPORT_INTERVAL);
+    }
+    finishProgress() {
+        if (this.progressReportInterval) {
+            clearInterval(this.progressReportInterval);
+            this.progressReportInterval = undefined;
+        }
+        this.reportProgress();
+    }
+    reportProgress() {
+        this.onProgress?.({
+            allNodesLoaded: this.allNodesLoaded,
+            loadedNodes: this.loadedNodes,
+            checkedNodes: this.checkedNodes,
+        });
+    }
+    async *verifyExpectedNodeChildren(parentNodeUid, children, expectedStructure) {
+        if (!expectedStructure) {
+            return;
+        }
+        const expectedNodes = expectedStructure.children ?? [];
+        const actualNodeNames = children.map((child) => (0, nodeUtils_1.getNodeName)(child));
+        for (const expectedNode of expectedNodes) {
+            if (!actualNodeNames.includes(expectedNode.name)) {
+                yield {
+                    type: 'expected_structure_missing_node',
+                    expectedNode: (0, nodeUtils_1.getExpectedTreeNodeDetails)(expectedNode),
+                    parentNodeUid,
+                };
+            }
+        }
+        for (const child of children) {
+            const childName = (0, nodeUtils_1.getNodeName)(child);
+            const isExpected = expectedNodes.some((expectedNode) => expectedNode.name === childName);
+            if (!isExpected) {
+                yield {
+                    type: 'expected_structure_unexpected_node',
+                    ...(0, nodeUtils_1.getNodeDetails)(child),
+                };
+            }
+        }
+    }
+    async *verifyNodesQueue() {
+        while (this.nodesQueue.length > 0 || !this.allNodesLoaded) {
+            const result = this.nodesQueue.shift();
+            if (result) {
+                yield* this.verifyNode(result.node, result.expected);
+                this.checkedNodes++;
+            }
+            else {
+                // Wait for 100ms before checking again.
+                await new Promise((resolve) => setTimeout(resolve, 100));
+            }
+        }
+    }
+    async *verifyNode(node, expectedStructure) {
+        if (!node.ok) {
+            yield {
+                type: 'degraded_node',
+                ...(0, nodeUtils_1.getNodeDetails)(node),
+            };
+        }
+        yield* this.verifyAuthor(node.ok ? node.value.keyAuthor : node.error.keyAuthor, 'key', node, expectedStructure);
+        yield* this.verifyAuthor(node.ok ? node.value.nameAuthor : node.error.nameAuthor, 'name', node, expectedStructure);
+        const activeRevision = (0, nodeUtils_1.getActiveRevision)(node);
+        if (activeRevision) {
+            yield* this.verifyAuthor(activeRevision.contentAuthor, 'content', node, expectedStructure);
+        }
+        yield* this.verifyFileExtendedAttributes(node, expectedStructure);
+        if (this.options.verifyContent === 'peakOnly') {
+            yield* this.verifyContentPeak(node);
+        }
+        else if (this.options.verifyContent) {
+            yield* this.verifyContent(node);
+        }
+        if (this.options.verifyThumbnails) {
+            yield* this.verifyThumbnails(node);
+        }
+        if (expectedStructure?.expectedMediaType) {
+            const mediaType = (0, nodeUtils_1.getMediaType)(node);
+            if (mediaType !== expectedStructure.expectedMediaType) {
+                yield {
+                    type: 'expected_structure_integrity_error',
+                    expectedNode: (0, nodeUtils_1.getExpectedTreeNodeDetails)(expectedStructure),
+                    ...(0, nodeUtils_1.getNodeDetails)(node),
+                };
+            }
+        }
+    }
+    async *verifyAuthor(author, authorType, node, expectedStructure) {
+        if (!author.ok) {
+            yield {
+                type: 'unverified_author',
+                authorType,
+                claimedAuthor: author.error.claimedAuthor,
+                error: author.error.error,
+                ...(0, nodeUtils_1.getNodeDetails)(node),
+            };
+        }
+        if (expectedStructure?.expectedAuthors) {
+            let expectedEmail = typeof expectedStructure.expectedAuthors === 'string'
+                ? expectedStructure.expectedAuthors
+                : expectedStructure.expectedAuthors[authorType];
+            if (expectedEmail === 'anonymous') {
+                expectedEmail = null;
+            }
+            const email = author.ok ? author.value : author.error.claimedAuthor;
+            if (expectedEmail !== undefined && email !== expectedEmail) {
+                yield {
+                    type: 'expected_structure_integrity_error',
+                    expectedNode: (0, nodeUtils_1.getExpectedTreeNodeDetails)(expectedStructure),
+                    ...(0, nodeUtils_1.getNodeDetails)(node),
+                };
+            }
+        }
+    }
+    async *verifyFileExtendedAttributes(node, expectedStructure) {
+        const activeRevision = (0, nodeUtils_1.getActiveRevision)(node);
+        const expectedAttributes = (0, nodeUtils_1.getNodeType)(node) === interface_1.NodeType.File;
+        const claimedSha1 = activeRevision?.claimedDigests?.sha1;
+        const claimedSizeInBytes = activeRevision?.claimedSize;
+        if (claimedSha1 && !/^[0-9a-f]{40}$/i.test(claimedSha1)) {
+            yield {
+                type: 'extended_attributes_error',
+                field: 'sha1',
+                value: claimedSha1,
+                ...(0, nodeUtils_1.getNodeDetails)(node),
+            };
+        }
+        if (expectedAttributes && !claimedSha1) {
+            yield {
+                type: 'extended_attributes_missing_field',
+                missingField: 'sha1',
+                ...(0, nodeUtils_1.getNodeDetails)(node),
+            };
+        }
+        if (expectedStructure) {
+            const expectedSha1 = expectedStructure.expectedSha1;
+            const expectedSizeInBytes = expectedStructure.expectedSizeInBytes;
+            const wrongSha1 = expectedSha1 !== undefined && claimedSha1 !== expectedSha1;
+            const wrongSizeInBytes = expectedSizeInBytes !== undefined && claimedSizeInBytes !== expectedSizeInBytes;
+            if (wrongSha1 || wrongSizeInBytes) {
+                yield {
+                    type: 'expected_structure_integrity_error',
+                    claimedSha1,
+                    claimedSizeInBytes,
+                    expectedNode: (0, nodeUtils_1.getExpectedTreeNodeDetails)(expectedStructure),
+                    ...(0, nodeUtils_1.getNodeDetails)(node),
+                };
+            }
+        }
+    }
+    async *verifyContentPeak(node) {
+        if ((0, nodeUtils_1.getNodeType)(node) !== interface_1.NodeType.File) {
+            return;
+        }
+        let downloader;
+        try {
+            downloader = await this.sdkClient.getFileDownloader(node);
+        }
+        catch (error) {
+            yield {
+                type: 'sdk_error',
+                call: `getFileDownloader(${node.ok ? node.value.uid : node.error.uid})`,
+                error,
+            };
+            return;
+        }
+        try {
+            const stream = downloader.getSeekableStream();
+            const peak = await stream.read(1024);
+            if (peak.value.length === 0) {
+                yield {
+                    type: 'content_download_error',
+                    error: new Error('No data read'),
+                    ...(0, nodeUtils_1.getNodeDetails)(node),
+                };
+            }
+        }
+        catch (error) {
+            yield {
+                type: 'content_download_error',
+                error,
+                ...(0, nodeUtils_1.getNodeDetails)(node),
+            };
+        }
+    }
+    async *verifyContent(node) {
+        if ((0, nodeUtils_1.getNodeType)(node) !== interface_1.NodeType.File) {
+            return;
+        }
+        const activeRevision = (0, nodeUtils_1.getActiveRevision)(node);
+        if (!activeRevision) {
+            yield {
+                type: 'content_file_missing_revision',
+                ...(0, nodeUtils_1.getNodeDetails)(node),
+            };
+            return;
+        }
+        let downloader;
+        try {
+            downloader = await this.sdkClient.getFileDownloader(node);
+        }
+        catch (error) {
+            yield {
+                type: 'sdk_error',
+                call: `getFileDownloader(${node.ok ? node.value.uid : node.error.uid})`,
+                error,
+            };
+            return;
+        }
+        const claimedSha1 = activeRevision.claimedDigests?.sha1;
+        const claimedSizeInBytes = downloader.getClaimedSizeInBytes();
+        const integrityVerificationStream = new integrityVerificationStream_1.IntegrityVerificationStream();
+        const controller = downloader.downloadToStream(integrityVerificationStream);
+        try {
+            await controller.completion();
+            const computedSha1 = integrityVerificationStream.computedSha1;
+            const computedSizeInBytes = integrityVerificationStream.computedSizeInBytes;
+            if (claimedSha1 !== computedSha1 || claimedSizeInBytes !== computedSizeInBytes) {
+                yield {
+                    type: 'content_integrity_error',
+                    claimedSha1,
+                    computedSha1,
+                    claimedSizeInBytes,
+                    computedSizeInBytes,
+                    ...(0, nodeUtils_1.getNodeDetails)(node),
+                };
+            }
+        }
+        catch (error) {
+            yield {
+                type: 'content_download_error',
+                error,
+                ...(0, nodeUtils_1.getNodeDetails)(node),
+            };
+        }
+    }
+    async *verifyThumbnails(node) {
+        if ((0, nodeUtils_1.getNodeType)(node) !== interface_1.NodeType.File) {
+            return;
+        }
+        const nodeUid = node.ok ? node.value.uid : node.error.uid;
+        try {
+            const result = await Array.fromAsync(this.sdkClient.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',
+                    error: result[0].error,
+                    ...(0, nodeUtils_1.getNodeDetails)(node),
+                };
+            }
+        }
+        catch (error) {
+            yield {
+                type: 'sdk_error',
+                call: `iterateThumbnails(${nodeUid})`,
+                error,
+            };
+        }
+    }
+}
+exports.SDKDiagnosticBase = SDKDiagnosticBase;
+//# sourceMappingURL=sdkDiagnosticBase.js.map