@fluidframework/driver-utils 2.0.0-internal.3.2.2 → 2.0.0-internal.3.3.1

package/lib/treeUtils.d.ts

@@ -5,39 +5,58 @@
 import { SummaryType, ISnapshotTree, ISummaryTree } from "@fluidframework/protocol-definitions";
 /**
  * Summary tree assembler props
+ *
+ * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
  */
 export interface ISummaryTreeAssemblerProps {
     /**
      * Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced.
+     *
+     * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
      */
     unreferenced?: true;
 }
 /**
  * Summary tree assembler (without stats collection).
+ *
+ * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
  */
 export declare class SummaryTreeAssembler {
     private readonly props?;
     private attachmentCounter;
     private readonly summaryTree;
+    /**
+     * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+     */
     constructor(props?: ISummaryTreeAssemblerProps | undefined);
     /**
      * Get final summary
+     *
+     * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
      */
     get summary(): ISummaryTree;
     /**
      * Add blob to summary
+     *
+     * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
      */
     addBlob(key: string, content: string | Uint8Array): void;
     /**
      * Add handle to summary
+     *
+     * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
      */
     addHandle(key: string, handleType: SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment, handle: string): void;
     /**
      * Add tree to summary
+     *
+     * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
      */
     addTree(key: string, summary: ISummaryTree): void;
     /**
      * Add attachment to summary
+     *
+     * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
      */
     addAttachment(id: string): void;
 }
@@ -46,6 +65,8 @@ export declare class SummaryTreeAssembler {
  * @param snapshot - Source snapshot tree
  * @param blobs - Blobs cache
  * @returns Converted snapshot in ISummaryTree format
+ *
+ * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
  */
 export declare function convertSnapshotAndBlobsToSummaryTree(snapshot: ISnapshotTree, blobs: Map<string, ArrayBuffer>): ISummaryTree;
 //# sourceMappingURL=treeUtils.d.ts.map

package/lib/treeUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"treeUtils.d.ts","sourceRoot":"","sources":["../src/treeUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACN,WAAW,EACX,aAAa,EACb,YAAY,EAEZ,MAAM,sCAAsC,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAC1C;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC;CACpB;AAED;;GAEG;AACH,qBAAa,oBAAoB;IAIpB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;IAHnC,OAAO,CAAC,iBAAiB,CAAa;IACtC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAyC;gBAExC,KAAK,CAAC,wCAA4B;IAE/D;;OAEG;IACH,IAAW,OAAO,IAAI,YAAY,CAMjC;IAED;;OAEG;IACI,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI;IAO/D;;OAEG;IACI,SAAS,CACf,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,UAAU,EACxE,MAAM,EAAE,MAAM,GACZ,IAAI;IAQP;;OAEG;IACI,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG,IAAI;IAIxD;;OAEG;IACI,aAAa,CAAC,EAAE,EAAE,MAAM;CAG/B;AAED;;;;;GAKG;AACH,wBAAgB,oCAAoC,CACnD,QAAQ,EAAE,aAAa,EACvB,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,GAC7B,YAAY,CAcd"}
+{"version":3,"file":"treeUtils.d.ts","sourceRoot":"","sources":["../src/treeUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACN,WAAW,EACX,aAAa,EACb,YAAY,EAEZ,MAAM,sCAAsC,CAAC;AAE9C;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IAC1C;;;;OAIG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC;CACpB;AAED;;;;GAIG;AACH,qBAAa,oBAAoB;IAOpB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;IANnC,OAAO,CAAC,iBAAiB,CAAa;IACtC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAyC;IAErE;;OAEG;gBAC0B,KAAK,CAAC,wCAA4B;IAE/D;;;;OAIG;IACH,IAAW,OAAO,IAAI,YAAY,CAMjC;IAED;;;;OAIG;IACI,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI;IAO/D;;;;OAIG;IACI,SAAS,CACf,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,UAAU,EACxE,MAAM,EAAE,MAAM,GACZ,IAAI;IAQP;;;;OAIG;IACI,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG,IAAI;IAIxD;;;;OAIG;IACI,aAAa,CAAC,EAAE,EAAE,MAAM;CAG/B;AAED;;;;;;;GAOG;AACH,wBAAgB,oCAAoC,CACnD,QAAQ,EAAE,aAAa,EACvB,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,GAC7B,YAAY,CAcd"}

package/lib/treeUtils.js

@@ -6,8 +6,13 @@ import { assert, IsoBuffer } from "@fluidframework/common-utils";
 import { SummaryType, } from "@fluidframework/protocol-definitions";
 /**
  * Summary tree assembler (without stats collection).
+ *
+ * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
  */
 export class SummaryTreeAssembler {
+    /**
+     * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+     */
     constructor(props) {
         this.props = props;
         this.attachmentCounter = 0;
@@ -15,6 +20,8 @@ export class SummaryTreeAssembler {
     }
     /**
      * Get final summary
+     *
+     * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
      */
     get summary() {
         var _a;
@@ -26,6 +33,8 @@ export class SummaryTreeAssembler {
     }
     /**
      * Add blob to summary
+     *
+     * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
      */
     addBlob(key, content) {
         this.summaryTree[key] = {
@@ -35,6 +44,8 @@ export class SummaryTreeAssembler {
     }
     /**
      * Add handle to summary
+     *
+     * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
      */
     addHandle(key, handleType, handle) {
         this.summaryTree[key] = {
@@ -45,12 +56,16 @@ export class SummaryTreeAssembler {
     }
     /**
      * Add tree to summary
+     *
+     * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
      */
     addTree(key, summary) {
         this.summaryTree[key] = summary;
     }
     /**
      * Add attachment to summary
+     *
+     * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
      */
     addAttachment(id) {
         this.summaryTree[this.attachmentCounter++] = { id, type: SummaryType.Attachment };
@@ -61,6 +76,8 @@ export class SummaryTreeAssembler {
  * @param snapshot - Source snapshot tree
  * @param blobs - Blobs cache
  * @returns Converted snapshot in ISummaryTree format
+ *
+ * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
  */
 export function convertSnapshotAndBlobsToSummaryTree(snapshot, blobs) {
     const assembler = new SummaryTreeAssembler({

package/lib/treeUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"treeUtils.js","sourceRoot":"","sources":["../src/treeUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EACN,WAAW,GAIX,MAAM,sCAAsC,CAAC;AAY9C;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAIhC,YAA6B,KAAkC;QAAlC,UAAK,GAAL,KAAK,CAA6B;QAHvD,sBAAiB,GAAW,CAAC,CAAC;QACrB,gBAAW,GAAsC,EAAE,CAAC;IAEH,CAAC;IAEnE;;OAEG;IACH,IAAW,OAAO;;QACjB,OAAO;YACN,IAAI,EAAE,WAAW,CAAC,IAAI;YACtB,IAAI,oBAAO,IAAI,CAAC,WAAW,CAAE;YAC7B,YAAY,EAAE,MAAA,IAAI,CAAC,KAAK,0CAAE,YAAY;SACtC,CAAC;IACH,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,GAAW,EAAE,OAA4B;QACvD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG;YACvB,IAAI,EAAE,WAAW,CAAC,IAAI;YACtB,OAAO;SACP,CAAC;IACH,CAAC;IAED;;OAEG;IACI,SAAS,CACf,GAAW,EACX,UAAwE,EACxE,MAAc;QAEd,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG;YACvB,IAAI,EAAE,WAAW,CAAC,MAAM;YACxB,UAAU;YACV,MAAM;SACN,CAAC;IACH,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,GAAW,EAAE,OAAqB;QAChD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,EAAU;QAC9B,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,WAAW,CAAC,UAAU,EAAE,CAAC;IACnF,CAAC;CACD;AAED;;;;;GAKG;AACH,MAAM,UAAU,oCAAoC,CACnD,QAAuB,EACvB,KAA+B;IAE/B,MAAM,SAAS,GAAG,IAAI,oBAAoB,CAAC;QAC1C,YAAY,EAAE,QAAQ,CAAC,YAAY;KACnC,CAAC,CAAC;IACH,KAAK,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;QACxD,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC3B,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC1E,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;KAChE;IACD,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;QACzD,MAAM,OAAO,GAAG,oCAAoC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAClE,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;KAChC;IACD,OAAO,SAAS,CAAC,OAAO,CAAC;AAC1B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, IsoBuffer } from \"@fluidframework/common-utils\";\nimport {\n\tSummaryType,\n\tISnapshotTree,\n\tISummaryTree,\n\tSummaryObject,\n} from \"@fluidframework/protocol-definitions\";\n\n/**\n * Summary tree assembler props\n */\nexport interface ISummaryTreeAssemblerProps {\n\t/**\n\t * Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced.\n\t */\n\tunreferenced?: true;\n}\n\n/**\n * Summary tree assembler (without stats collection).\n */\nexport class SummaryTreeAssembler {\n\tprivate attachmentCounter: number = 0;\n\tprivate readonly summaryTree: { [path: string]: SummaryObject } = {};\n\n\tconstructor(private readonly props?: ISummaryTreeAssemblerProps) {}\n\n\t/**\n\t * Get final summary\n\t */\n\tpublic get summary(): ISummaryTree {\n\t\treturn {\n\t\t\ttype: SummaryType.Tree,\n\t\t\ttree: { ...this.summaryTree },\n\t\t\tunreferenced: this.props?.unreferenced,\n\t\t};\n\t}\n\n\t/**\n\t * Add blob to summary\n\t */\n\tpublic addBlob(key: string, content: string | Uint8Array): void {\n\t\tthis.summaryTree[key] = {\n\t\t\ttype: SummaryType.Blob,\n\t\t\tcontent,\n\t\t};\n\t}\n\n\t/**\n\t * Add handle to summary\n\t */\n\tpublic addHandle(\n\t\tkey: string,\n\t\thandleType: SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment,\n\t\thandle: string,\n\t): void {\n\t\tthis.summaryTree[key] = {\n\t\t\ttype: SummaryType.Handle,\n\t\t\thandleType,\n\t\t\thandle,\n\t\t};\n\t}\n\n\t/**\n\t * Add tree to summary\n\t */\n\tpublic addTree(key: string, summary: ISummaryTree): void {\n\t\tthis.summaryTree[key] = summary;\n\t}\n\n\t/**\n\t * Add attachment to summary\n\t */\n\tpublic addAttachment(id: string) {\n\t\tthis.summaryTree[this.attachmentCounter++] = { id, type: SummaryType.Attachment };\n\t}\n}\n\n/**\n * Helper function that converts ISnapshotTree and blobs to ISummaryTree\n * @param snapshot - Source snapshot tree\n * @param blobs - Blobs cache\n * @returns Converted snapshot in ISummaryTree format\n */\nexport function convertSnapshotAndBlobsToSummaryTree(\n\tsnapshot: ISnapshotTree,\n\tblobs: Map<string, ArrayBuffer>,\n): ISummaryTree {\n\tconst assembler = new SummaryTreeAssembler({\n\t\tunreferenced: snapshot.unreferenced,\n\t});\n\tfor (const [path, id] of Object.entries(snapshot.blobs)) {\n\t\tconst blob = blobs.get(id);\n\t\tassert(blob !== undefined, 0x2dd /* \"Cannot find blob for a given id\" */);\n\t\tassembler.addBlob(path, IsoBuffer.from(blob).toString(\"utf-8\"));\n\t}\n\tfor (const [key, tree] of Object.entries(snapshot.trees)) {\n\t\tconst subtree = convertSnapshotAndBlobsToSummaryTree(tree, blobs);\n\t\tassembler.addTree(key, subtree);\n\t}\n\treturn assembler.summary;\n}\n"]}
+{"version":3,"file":"treeUtils.js","sourceRoot":"","sources":["../src/treeUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EACN,WAAW,GAIX,MAAM,sCAAsC,CAAC;AAgB9C;;;;GAIG;AACH,MAAM,OAAO,oBAAoB;IAIhC;;OAEG;IACH,YAA6B,KAAkC;QAAlC,UAAK,GAAL,KAAK,CAA6B;QANvD,sBAAiB,GAAW,CAAC,CAAC;QACrB,gBAAW,GAAsC,EAAE,CAAC;IAKH,CAAC;IAEnE;;;;OAIG;IACH,IAAW,OAAO;;QACjB,OAAO;YACN,IAAI,EAAE,WAAW,CAAC,IAAI;YACtB,IAAI,oBAAO,IAAI,CAAC,WAAW,CAAE;YAC7B,YAAY,EAAE,MAAA,IAAI,CAAC,KAAK,0CAAE,YAAY;SACtC,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,GAAW,EAAE,OAA4B;QACvD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG;YACvB,IAAI,EAAE,WAAW,CAAC,IAAI;YACtB,OAAO;SACP,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,SAAS,CACf,GAAW,EACX,UAAwE,EACxE,MAAc;QAEd,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG;YACvB,IAAI,EAAE,WAAW,CAAC,MAAM;YACxB,UAAU;YACV,MAAM;SACN,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,GAAW,EAAE,OAAqB;QAChD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,EAAU;QAC9B,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,WAAW,CAAC,UAAU,EAAE,CAAC;IACnF,CAAC;CACD;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,oCAAoC,CACnD,QAAuB,EACvB,KAA+B;IAE/B,MAAM,SAAS,GAAG,IAAI,oBAAoB,CAAC;QAC1C,YAAY,EAAE,QAAQ,CAAC,YAAY;KACnC,CAAC,CAAC;IACH,KAAK,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;QACxD,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC3B,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC1E,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;KAChE;IACD,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;QACzD,MAAM,OAAO,GAAG,oCAAoC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAClE,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;KAChC;IACD,OAAO,SAAS,CAAC,OAAO,CAAC;AAC1B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, IsoBuffer } from \"@fluidframework/common-utils\";\nimport {\n\tSummaryType,\n\tISnapshotTree,\n\tISummaryTree,\n\tSummaryObject,\n} from \"@fluidframework/protocol-definitions\";\n\n/**\n * Summary tree assembler props\n *\n * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.\n */\nexport interface ISummaryTreeAssemblerProps {\n\t/**\n\t * Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced.\n\t *\n\t * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.\n\t */\n\tunreferenced?: true;\n}\n\n/**\n * Summary tree assembler (without stats collection).\n *\n * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.\n */\nexport class SummaryTreeAssembler {\n\tprivate attachmentCounter: number = 0;\n\tprivate readonly summaryTree: { [path: string]: SummaryObject } = {};\n\n\t/**\n\t * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.\n\t */\n\tconstructor(private readonly props?: ISummaryTreeAssemblerProps) {}\n\n\t/**\n\t * Get final summary\n\t *\n\t * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.\n\t */\n\tpublic get summary(): ISummaryTree {\n\t\treturn {\n\t\t\ttype: SummaryType.Tree,\n\t\t\ttree: { ...this.summaryTree },\n\t\t\tunreferenced: this.props?.unreferenced,\n\t\t};\n\t}\n\n\t/**\n\t * Add blob to summary\n\t *\n\t * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.\n\t */\n\tpublic addBlob(key: string, content: string | Uint8Array): void {\n\t\tthis.summaryTree[key] = {\n\t\t\ttype: SummaryType.Blob,\n\t\t\tcontent,\n\t\t};\n\t}\n\n\t/**\n\t * Add handle to summary\n\t *\n\t * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.\n\t */\n\tpublic addHandle(\n\t\tkey: string,\n\t\thandleType: SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment,\n\t\thandle: string,\n\t): void {\n\t\tthis.summaryTree[key] = {\n\t\t\ttype: SummaryType.Handle,\n\t\t\thandleType,\n\t\t\thandle,\n\t\t};\n\t}\n\n\t/**\n\t * Add tree to summary\n\t *\n\t * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.\n\t */\n\tpublic addTree(key: string, summary: ISummaryTree): void {\n\t\tthis.summaryTree[key] = summary;\n\t}\n\n\t/**\n\t * Add attachment to summary\n\t *\n\t * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.\n\t */\n\tpublic addAttachment(id: string) {\n\t\tthis.summaryTree[this.attachmentCounter++] = { id, type: SummaryType.Attachment };\n\t}\n}\n\n/**\n * Helper function that converts ISnapshotTree and blobs to ISummaryTree\n * @param snapshot - Source snapshot tree\n * @param blobs - Blobs cache\n * @returns Converted snapshot in ISummaryTree format\n *\n * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.\n */\nexport function convertSnapshotAndBlobsToSummaryTree(\n\tsnapshot: ISnapshotTree,\n\tblobs: Map<string, ArrayBuffer>,\n): ISummaryTree {\n\tconst assembler = new SummaryTreeAssembler({\n\t\tunreferenced: snapshot.unreferenced,\n\t});\n\tfor (const [path, id] of Object.entries(snapshot.blobs)) {\n\t\tconst blob = blobs.get(id);\n\t\tassert(blob !== undefined, 0x2dd /* \"Cannot find blob for a given id\" */);\n\t\tassembler.addBlob(path, IsoBuffer.from(blob).toString(\"utf-8\"));\n\t}\n\tfor (const [key, tree] of Object.entries(snapshot.trees)) {\n\t\tconst subtree = convertSnapshotAndBlobsToSummaryTree(tree, blobs);\n\t\tassembler.addTree(key, subtree);\n\t}\n\treturn assembler.summary;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/driver-utils",
-  "version": "2.0.0-internal.3.2.2",
+  "version": "2.0.0-internal.3.3.1",
   "description": "Collection of utility functions for Fluid drivers",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -37,24 +37,24 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^1.1.1",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.3.2.2 <2.0.0-internal.4.0.0",
-    "@fluidframework/driver-definitions": ">=2.0.0-internal.3.2.2 <2.0.0-internal.4.0.0",
-    "@fluidframework/gitresources": "^0.1038.2000",
-    "@fluidframework/protocol-base": "^0.1038.2000",
+    "@fluidframework/core-interfaces": ">=2.0.0-internal.3.3.1 <2.0.0-internal.4.0.0",
+    "@fluidframework/driver-definitions": ">=2.0.0-internal.3.3.1 <2.0.0-internal.4.0.0",
+    "@fluidframework/gitresources": "^0.1038.3000",
+    "@fluidframework/protocol-base": "^0.1038.3000",
     "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/telemetry-utils": ">=2.0.0-internal.3.2.2 <2.0.0-internal.4.0.0",
+    "@fluidframework/telemetry-utils": ">=2.0.0-internal.3.3.1 <2.0.0-internal.4.0.0",
     "axios": "^0.26.0",
     "url": "^0.11.0",
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "^0.10.0",
+    "@fluid-tools/build-cli": "^0.12.0",
     "@fluidframework/build-common": "^1.1.0",
-    "@fluidframework/build-tools": "^0.10.0",
-    "@fluidframework/driver-utils-previous": "npm:@fluidframework/driver-utils@2.0.0-internal.3.1.0",
+    "@fluidframework/build-tools": "^0.12.0",
+    "@fluidframework/driver-utils-previous": "npm:@fluidframework/driver-utils@2.0.0-internal.3.2.0",
     "@fluidframework/eslint-config-fluid": "^2.0.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.3.2.2 <2.0.0-internal.4.0.0",
-    "@fluidframework/runtime-utils": ">=2.0.0-internal.3.2.2 <2.0.0-internal.4.0.0",
+    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.3.3.1 <2.0.0-internal.4.0.0",
+    "@fluidframework/runtime-utils": ">=2.0.0-internal.3.3.1 <2.0.0-internal.4.0.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^9.1.1",
@@ -72,10 +72,6 @@
     "typescript": "~4.5.5"
   },
   "typeValidation": {
-    "version": "2.0.0-internal.3.2.0",
-    "previousVersionStyle": "~previousMinor",
-    "baselineRange": ">=2.0.0-internal.3.1.0 <2.0.0-internal.3.2.0",
-    "baselineVersion": "2.0.0-internal.3.1.0",
     "broken": {}
   },
   "scripts": {
@@ -102,7 +98,7 @@
     "test:mocha": "mocha --ignore 'dist/test/types/*' --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
     "tsc": "tsc",
-    "typetests:gen": "flub generate typetests --generate --dir .",
+    "typetests:gen": "fluid-type-test-generator",
     "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
   }
 }

package/src/blobCacheStorageService.ts

@@ -11,8 +11,13 @@ import { DocumentStorageServiceProxy } from "./documentStorageServiceProxy";
 
 /**
  * IDocumentStorageService adapter with pre-cached blobs.
+ *
+ * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
  */
 export class BlobCacheStorageService extends DocumentStorageServiceProxy {
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	constructor(
 		internalStorageService: IDocumentStorageService,
 		private readonly blobs: Map<string, ArrayBufferLike>,
@@ -20,10 +25,16 @@ export class BlobCacheStorageService extends DocumentStorageServiceProxy {
 		super(internalStorageService);
 	}
 
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	public get policies(): IDocumentStorageServicePolicies | undefined {
 		return this.internalStorageService.policies;
 	}
 
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	public async readBlob(id: string): Promise<ArrayBufferLike> {
 		const blob = this.blobs.get(id);
 		if (blob !== undefined) {

package/src/emptyDocumentDeltaStorageService.ts

@@ -9,8 +9,13 @@ import { Queue } from "./parallelRequests";
 
 /**
  * Implementation of IDocumentDeltaStorageService that will always return an empty message queue when fetching messages
+ *
+ * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
  */
 export class EmptyDocumentDeltaStorageService implements IDocumentDeltaStorageService {
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	public fetchMessages(
 		from: number,
 		_to: number | undefined,

package/src/index.ts

@@ -55,8 +55,10 @@ export { readAndParse } from "./readAndParse";
 export { IProgress, runWithRetry } from "./runWithRetry";
 export {
 	combineAppAndProtocolSummary,
+	CombinedAppAndProtocolSummary,
 	getDocAttributesFromProtocolSummary,
 	getQuorumValuesFromProtocolSummary,
+	isCombinedAppAndProtocolSummary,
 } from "./summaryForCreateNew";
 export { convertSummaryTreeToSnapshotITree } from "./treeConversions";
 export {

package/src/mapWithExpiration.ts

@@ -8,11 +8,16 @@ import { assert } from "@fluidframework/common-utils";
 /**
  * An extension of Map that expires (deletes) entries after a period of inactivity.
  * The policy is based on the last time a key was written to.
+ *
+ * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
  */
 export class MapWithExpiration<TKey = any, TValue = any> extends Map<TKey, TValue> {
 	/** Timestamps (as epoch ms numbers) of when each key was last refreshed */
 	private readonly lastRefreshedTimes = new Map<TKey, number>();
 
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	constructor(private readonly expiryMs: number) {
 		super();
 	}
@@ -47,37 +52,58 @@ export class MapWithExpiration<TKey = any, TValue = any> extends Map<TKey, TValu
 		this.forEach(() => {});
 	}
 
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	get size(): number {
 		this.clearExpiredEntries();
 		return super.size;
 	}
 
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	has(key: TKey): boolean {
 		this.checkExpiry(key, true /* cleanUp */);
 		return super.has(key);
 	}
 
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	get(key: TKey): TValue | undefined {
 		this.checkExpiry(key, true /* cleanUp */);
 		return super.get(key);
 	}
 
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	set(key: TKey, value: TValue): this {
 		// Sliding window expiration policy (on write)
 		this.refresh(key);
 		return super.set(key, value);
 	}
 
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	delete(key: TKey): boolean {
 		this.lastRefreshedTimes.delete(key);
 		return super.delete(key);
 	}
 
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	clear(): void {
 		this.lastRefreshedTimes.clear();
 		super.clear();
 	}
 
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	forEach(
 		callbackfn: (value: TValue, key: TKey, map: Map<TKey, TValue>) => void,
 		thisArg?: any,
@@ -100,23 +126,38 @@ export class MapWithExpiration<TKey = any, TValue = any> extends Map<TKey, TValu
 		});
 	}
 
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	entries(): IterableIterator<[TKey, TValue]> {
 		this.clearExpiredEntries();
 		return super.entries();
 	}
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	keys(): IterableIterator<TKey> {
 		this.clearExpiredEntries();
 		return super.keys();
 	}
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	values(): IterableIterator<TValue> {
 		this.clearExpiredEntries();
 		return super.values();
 	}
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	[Symbol.iterator](): IterableIterator<[TKey, TValue]> {
 		this.clearExpiredEntries();
 		return super[Symbol.iterator]();
 	}
 
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	valueOf() {
 		this.clearExpiredEntries();
 		return super.valueOf();

package/src/multiDocumentServiceFactory.ts

@@ -13,7 +13,13 @@ import { ISummaryTree } from "@fluidframework/protocol-definitions";
 import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
 import { ensureFluidResolvedUrl } from "./fluidResolvedUrl";
 
+/**
+ * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+ */
 export class MultiDocumentServiceFactory implements IDocumentServiceFactory {
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	public static create(
 		documentServiceFactory: IDocumentServiceFactory | IDocumentServiceFactory[],
 	) {
@@ -37,13 +43,22 @@ export class MultiDocumentServiceFactory implements IDocumentServiceFactory {
 
 	private readonly protocolToDocumentFactoryMap: Map<string, IDocumentServiceFactory>;
 
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	constructor(documentServiceFactories: IDocumentServiceFactory[]) {
 		this.protocolToDocumentFactoryMap = new Map();
 		documentServiceFactories.forEach((factory: IDocumentServiceFactory) => {
 			this.protocolToDocumentFactoryMap.set(factory.protocolName, factory);
 		});
 	}
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	public readonly protocolName = "none:";
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	async createDocumentService(
 		resolvedUrl: IResolvedUrl,
 		logger?: ITelemetryBaseLogger,
@@ -64,6 +79,9 @@ export class MultiDocumentServiceFactory implements IDocumentServiceFactory {
 		return factory.createDocumentService(resolvedUrl, logger, clientIsSummarizer);
 	}
 
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	public async createContainer(
 		createNewSummary: ISummaryTree,
 		createNewResolvedUrl: IResolvedUrl,

package/src/multiUrlResolver.ts

@@ -10,6 +10,8 @@ import { IResolvedUrl, IUrlResolver } from "@fluidframework/driver-definitions";
  * Resolver that takes a list of url resolvers and then try each of them to resolve the url.
  * @param resolversList - List of url resolvers to be used to resolve the request.
  * @param request - Request to be resolved.
+ *
+ * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
  */
 export async function configurableUrlResolver(
 	resolversList: IUrlResolver[],
@@ -25,7 +27,13 @@ export async function configurableUrlResolver(
 	return undefined;
 }
 
+/**
+ * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+ */
 export class MultiUrlResolver implements IUrlResolver {
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	public static create(urlResolver: IUrlResolver | IUrlResolver[]) {
 		if (Array.isArray(urlResolver)) {
 			if (urlResolver.length === 1) {
@@ -38,10 +46,16 @@ export class MultiUrlResolver implements IUrlResolver {
 
 	private constructor(private readonly urlResolvers: IUrlResolver[]) {}
 
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	async resolve(request: IRequest): Promise<IResolvedUrl | undefined> {
 		return configurableUrlResolver(this.urlResolvers, request);
 	}
 
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Not recommended for general purpose use.
+	 */
 	public async getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string> {
 		throw new Error("Not implmented");
 	}

package/src/networkUtils.ts

@@ -38,6 +38,8 @@ export function logNetworkFailure(
  * or machine connected to router that is not connected to internet)
  * But there should be no false negatives.
  * The only exception - Opera returns false when user enters "Work Offline" mode, regardless of actual connectivity.
+ *
+ * @deprecated - 2.0.0-internal.3.2.0 Not recommended for general purpose use.
  */
 // eslint-disable-next-line @typescript-eslint/promise-function-async
 export function waitForConnectedState(minDelay: number): Promise<void> {

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/driver-utils";
-export const pkgVersion = "2.0.0-internal.3.2.2";
+export const pkgVersion = "2.0.0-internal.3.3.1";

package/src/parallelRequests.ts

@@ -8,7 +8,7 @@ import { PerformanceEvent } from "@fluidframework/telemetry-utils";
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { IDeltasFetchResult, IStream, IStreamResult } from "@fluidframework/driver-definitions";
 import { getRetryDelayFromError, canRetryOnError, createGenericNetworkError } from "./network";
-import { waitForConnectedState, logNetworkFailure } from "./networkUtils";
+import { logNetworkFailure } from "./networkUtils";
 // For now, this package is versioned and released in unison with the specific drivers
 import { pkgVersion as driverVersion } from "./packageVersion";
 
@@ -379,6 +379,19 @@ export class Queue<T> implements IStream<T> {
 	}
 }
 
+const waitForOnline = async (): Promise<void> => {
+	// Only wait if we have a strong signal that we're offline - otherwise assume we're online.
+	if (globalThis.navigator?.onLine === false && globalThis.addEventListener !== undefined) {
+		return new Promise<void>((resolve) => {
+			const resolveAndRemoveListener = () => {
+				resolve();
+				globalThis.removeEventListener("online", resolveAndRemoveListener);
+			};
+			globalThis.addEventListener("online", resolveAndRemoveListener);
+		});
+	}
+};
+
 /**
  * Retrieve single batch of ops
  * @param request - request index
@@ -403,7 +416,6 @@ async function getSingleOpBatch(
 	let lastSuccessTime: number | undefined;
 
 	let retry: number = 0;
-	const deltas: ISequencedDocumentMessage[] = [];
 	const nothing = { partial: false, cancel: true, payload: [] };
 
 	while (signal?.aborted !== true) {
@@ -412,23 +424,22 @@ async function getSingleOpBatch(
 		const startTime = performance.now();
 
 		try {
-			// Issue async request for deltas - limit the number fetched to MaxBatchDeltas
-			const deltasP = get({ ...props, retry } /* telemetry props */);
-
-			const { messages, partialResult } = await deltasP;
-			deltas.push(...messages);
-
-			const deltasRetrievedLast = messages.length;
+			// Issue async request for deltas
+			const { messages, partialResult } = await get(
+				{ ...props, retry } /* telemetry props */,
+			);
 
-			if (deltasRetrievedLast !== 0 || !strongTo) {
-				return { payload: deltas, cancel: false, partial: partialResult };
+			// If we got messages back, return them.  Return regardless of whether we got messages back if we didn't
+			// specify a "to", since we don't have an expectation of how many to receive.
+			if (messages.length !== 0 || !strongTo) {
+				return { payload: messages, cancel: false, partial: partialResult };
 			}
 
-			// Storage does not have ops we need.
-			// Attempt to fetch more deltas. If we didn't receive any in the previous call we up our retry
-			// count since something prevented us from seeing those deltas
+			// Otherwise, the storage gave us back an empty set of ops but we were expecting a non-empty set.
 
 			if (lastSuccessTime === undefined) {
+				// Take timestamp of the first time server responded successfully, even though it wasn't with the ops we asked for.
+				// If we keep getting empty responses we'll eventually fail out below.
 				lastSuccessTime = performance.now();
 			} else if (performance.now() - lastSuccessTime > 30000) {
 				// If we are connected and receiving proper responses from server, but can't get any ops back,
@@ -449,8 +460,6 @@ async function getSingleOpBatch(
 		} catch (error) {
 			const canRetry = canRetryOnError(error);
 
-			lastSuccessTime = undefined;
-
 			const retryAfter = getRetryDelayFromError(error);
 
 			// This will log to error table only if the error is non-retryable
@@ -472,12 +481,22 @@ async function getSingleOpBatch(
 				throw error;
 			}
 
-			if (retryAfter !== undefined && retryAfter >= 0) {
+			if (retryAfter !== undefined) {
+				// If the error told us to wait, then we will wait for that specific amount rather than the default.
 				delay = retryAfter;
 			}
 		}
 
-		await waitForConnectedState(delay);
+		// If we get here something has gone wrong - either got an unexpected empty set of messages back or a real error.
+		// Either way we will wait a little bit before retrying.
+		await new Promise<void>((resolve) => {
+			setTimeout(resolve, delay);
+		});
+
+		// If we believe we're offline, we assume there's no point in trying until we at least think we're online.
+		// NOTE: This isn't strictly true for drivers that don't require network (e.g. local driver).  Really this logic
+		// should probably live in the driver.
+		await waitForOnline();
 	}
 
 	return nothing;