@fluidframework/driver-utils 2.0.0-internal.3.0.1 → 2.0.0-internal.3.1.0

package/src/treeConversions.ts

@@ -3,84 +3,62 @@
  * Licensed under the MIT License.
  */
 
-import {
-    Uint8ArrayToString,
-    unreachableCase,
-} from "@fluidframework/common-utils";
-import {
-    AttachmentTreeEntry,
-    BlobTreeEntry,
-    TreeTreeEntry,
-} from "@fluidframework/protocol-base";
-import {
-    ISummaryTree,
-    ITree,
-    ITreeEntry,
-    SummaryType,
-} from "@fluidframework/protocol-definitions";
+import { Uint8ArrayToString, unreachableCase } from "@fluidframework/common-utils";
+import { AttachmentTreeEntry, BlobTreeEntry, TreeTreeEntry } from "@fluidframework/protocol-base";
+import { ISummaryTree, ITree, ITreeEntry, SummaryType } from "@fluidframework/protocol-definitions";
 
 /**
  * Converts ISummaryTree to ITree format.
  * @param summaryTree - summary tree in ISummaryTree format
  */
-export function convertSummaryTreeToSnapshotITree(
-    summaryTree: ISummaryTree,
-): ITree {
-    const entries: ITreeEntry[] = [];
-    const protocolSummary = summaryTree.tree[".protocol"] as ISummaryTree;
-    const appSummary = summaryTree.tree[".app"] as ISummaryTree;
-    // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
-    const adaptSumaryTree = protocolSummary && appSummary;
-    // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
-    const allSummaryEntries = adaptSumaryTree
-        ? [
-              ...Object.entries(protocolSummary.tree),
-              ...Object.entries(appSummary.tree),
-          ]
-        : Object.entries(summaryTree.tree);
+export function convertSummaryTreeToSnapshotITree(summaryTree: ISummaryTree): ITree {
+	const entries: ITreeEntry[] = [];
+	const protocolSummary = summaryTree.tree[".protocol"] as ISummaryTree;
+	const appSummary = summaryTree.tree[".app"] as ISummaryTree;
+	// eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
+	const adaptSumaryTree = protocolSummary && appSummary;
+	// eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
+	const allSummaryEntries = adaptSumaryTree
+		? [...Object.entries(protocolSummary.tree), ...Object.entries(appSummary.tree)]
+		: Object.entries(summaryTree.tree);
 
-    for (const [key, value] of allSummaryEntries) {
-        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
-        const k = adaptSumaryTree && ["attributes"].includes(key) ? `.${key}` : key;
-        switch (value.type) {
-            case SummaryType.Blob: {
-                let parsedContent: string;
-                let encoding: "utf-8" | "base64" = "utf-8";
-                if (typeof value.content === "string") {
-                    parsedContent = value.content;
-                } else {
-                    parsedContent = Uint8ArrayToString(value.content, "base64");
-                    encoding = "base64";
-                }
-                entries.push(new BlobTreeEntry(k, parsedContent, encoding));
-                break;
-            }
+	for (const [key, value] of allSummaryEntries) {
+		// eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
+		const k = adaptSumaryTree && ["attributes"].includes(key) ? `.${key}` : key;
+		switch (value.type) {
+			case SummaryType.Blob: {
+				let parsedContent: string;
+				let encoding: "utf-8" | "base64" = "utf-8";
+				if (typeof value.content === "string") {
+					parsedContent = value.content;
+				} else {
+					parsedContent = Uint8ArrayToString(value.content, "base64");
+					encoding = "base64";
+				}
+				entries.push(new BlobTreeEntry(k, parsedContent, encoding));
+				break;
+			}
 
-            case SummaryType.Tree: {
-                entries.push(
-                    new TreeTreeEntry(
-                        k,
-                        convertSummaryTreeToSnapshotITree(value),
-                    ),
-                );
-                break;
-            }
+			case SummaryType.Tree: {
+				entries.push(new TreeTreeEntry(k, convertSummaryTreeToSnapshotITree(value)));
+				break;
+			}
 
-            case SummaryType.Attachment: {
-                entries.push(new AttachmentTreeEntry(k, value.id));
-                break;
-            }
+			case SummaryType.Attachment: {
+				entries.push(new AttachmentTreeEntry(k, value.id));
+				break;
+			}
 
-            case SummaryType.Handle: {
-                throw new Error("Should not have Handle type in summary tree");
-            }
+			case SummaryType.Handle: {
+				throw new Error("Should not have Handle type in summary tree");
+			}
 
-            default:
-                unreachableCase(value, "Unexpected summary tree type");
-        }
-    }
-    return {
-        entries,
-        unreferenced: summaryTree.unreferenced,
-    };
+			default:
+				unreachableCase(value, "Unexpected summary tree type");
+		}
+	}
+	return {
+		entries,
+		unreferenced: summaryTree.unreferenced,
+	};
 }

package/src/treeUtils.ts

@@ -3,86 +3,82 @@
  * Licensed under the MIT License.
  */
 
+import { assert, IsoBuffer } from "@fluidframework/common-utils";
 import {
-    assert,
-    IsoBuffer,
-} from "@fluidframework/common-utils";
-import {
-    SummaryType,
-    ISnapshotTree,
-    ISummaryTree,
-    SummaryObject,
+	SummaryType,
+	ISnapshotTree,
+	ISummaryTree,
+	SummaryObject,
 } from "@fluidframework/protocol-definitions";
 
 /**
  * Summary tree assembler props
  */
 export interface ISummaryTreeAssemblerProps {
-    /**
+	/**
 	 * Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced.
 	 */
-    unreferenced?: true;
+	unreferenced?: true;
 }
 
 /**
  * Summary tree assembler (without stats collection).
  */
 export class SummaryTreeAssembler {
-    private attachmentCounter: number = 0;
-    private readonly summaryTree: { [path: string]: SummaryObject; } = {};
+	private attachmentCounter: number = 0;
+	private readonly summaryTree: { [path: string]: SummaryObject } = {};
 
-    constructor(
-        private readonly props?: ISummaryTreeAssemblerProps,
-    ) { }
+	constructor(private readonly props?: ISummaryTreeAssemblerProps) {}
 
-    /**
-    * Get final summary
-    */
-    public get summary(): ISummaryTree {
-        return {
-            type: SummaryType.Tree,
-            tree: { ...this.summaryTree },
-            unreferenced: this.props?.unreferenced,
-        };
-    }
+	/**
+	 * Get final summary
+	 */
+	public get summary(): ISummaryTree {
+		return {
+			type: SummaryType.Tree,
+			tree: { ...this.summaryTree },
+			unreferenced: this.props?.unreferenced,
+		};
+	}
 
-    /**
-    * Add blob to summary
-    */
-    public addBlob(key: string, content: string | Uint8Array): void {
-        this.summaryTree[key] = {
-            type: SummaryType.Blob,
-            content,
-        };
-    }
+	/**
+	 * Add blob to summary
+	 */
+	public addBlob(key: string, content: string | Uint8Array): void {
+		this.summaryTree[key] = {
+			type: SummaryType.Blob,
+			content,
+		};
+	}
 
-    /**
-    * Add handle to summary
-    */
-    public addHandle(
-        key: string,
-        handleType: SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment,
-        handle: string): void {
-        this.summaryTree[key] = {
-            type: SummaryType.Handle,
-            handleType,
-            handle,
-        };
-    }
+	/**
+	 * Add handle to summary
+	 */
+	public addHandle(
+		key: string,
+		handleType: SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment,
+		handle: string,
+	): void {
+		this.summaryTree[key] = {
+			type: SummaryType.Handle,
+			handleType,
+			handle,
+		};
+	}
 
-    /**
-    * Add tree to summary
-    */
-    public addTree(key: string, summary: ISummaryTree): void {
-        this.summaryTree[key] = summary;
-    }
+	/**
+	 * Add tree to summary
+	 */
+	public addTree(key: string, summary: ISummaryTree): void {
+		this.summaryTree[key] = summary;
+	}
 
-    /**
-    * Add attachment to summary
-    */
-    public addAttachment(id: string) {
-        this.summaryTree[this.attachmentCounter++] = { id, type: SummaryType.Attachment };
-    }
+	/**
+	 * Add attachment to summary
+	 */
+	public addAttachment(id: string) {
+		this.summaryTree[this.attachmentCounter++] = { id, type: SummaryType.Attachment };
+	}
 }
 
 /**
@@ -92,20 +88,20 @@ export class SummaryTreeAssembler {
  * @returns Converted snapshot in ISummaryTree format
  */
 export function convertSnapshotAndBlobsToSummaryTree(
-    snapshot: ISnapshotTree,
-    blobs: Map<string, ArrayBuffer>,
+	snapshot: ISnapshotTree,
+	blobs: Map<string, ArrayBuffer>,
 ): ISummaryTree {
-    const assembler = new SummaryTreeAssembler({
-        unreferenced: snapshot.unreferenced,
-    });
-    for (const [path, id] of Object.entries(snapshot.blobs)) {
-        const blob = blobs.get(id);
-        assert(blob !== undefined, 0x2dd /* "Cannot find blob for a given id" */);
-        assembler.addBlob(path, IsoBuffer.from(blob).toString("utf-8"));
-    }
-    for (const [key, tree] of Object.entries(snapshot.trees)) {
-        const subtree = convertSnapshotAndBlobsToSummaryTree(tree, blobs);
-        assembler.addTree(key, subtree);
-    }
-    return assembler.summary;
+	const assembler = new SummaryTreeAssembler({
+		unreferenced: snapshot.unreferenced,
+	});
+	for (const [path, id] of Object.entries(snapshot.blobs)) {
+		const blob = blobs.get(id);
+		assert(blob !== undefined, 0x2dd /* "Cannot find blob for a given id" */);
+		assembler.addBlob(path, IsoBuffer.from(blob).toString("utf-8"));
+	}
+	for (const [key, tree] of Object.entries(snapshot.trees)) {
+		const subtree = convertSnapshotAndBlobsToSummaryTree(tree, blobs);
+		assembler.addTree(key, subtree);
+	}
+	return assembler.summary;
 }

package/tsconfig.esnext.json

@@ -1,7 +1,7 @@
 {
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-        "outDir": "./lib",
-        "module": "esnext"
-    },
-}
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"outDir": "./lib",
+		"module": "esnext",
+	},
+}

package/tsconfig.json

@@ -1,14 +1,10 @@
 {
-    "extends": "@fluidframework/build-common/ts-common-config.json",
-    "compilerOptions": {
-        "composite": true,
-        "rootDir": "./src",
-        "outDir": "./dist"
-    },
-    "include": [
-        "src/**/*"
-    ],
-    "exclude": [
-        "src/test/**/*",
-    ]
+	"extends": "@fluidframework/build-common/ts-common-config.json",
+	"compilerOptions": {
+		"composite": true,
+		"rootDir": "./src",
+		"outDir": "./dist",
+	},
+	"include": ["src/**/*"],
+	"exclude": ["src/test/**/*"],
 }