@fluidframework/driver-utils 2.0.0-dev.6.4.0.192049 → 2.0.0-dev.7.2.0.204906

package/lib/summaryForCreateNew.js

@@ -8,13 +8,13 @@ import { SummaryType, } from "@fluidframework/protocol-definitions";
  * this is used internally for create new, and single commit summary
  * @internal
  */
-export function isCombinedAppAndProtocolSummary(summary) {
+export function isCombinedAppAndProtocolSummary(summary, ...optionalRootTrees) {
     if (summary?.tree === undefined ||
         summary.tree?.[".app"]?.type !== SummaryType.Tree ||
         summary.tree?.[".protocol"]?.type !== SummaryType.Tree) {
         return false;
     }
-    const treeKeys = Object.keys(summary.tree);
+    const treeKeys = Object.keys(summary.tree).filter((t) => !optionalRootTrees.includes(t));
     if (treeKeys.length !== 2) {
         return false;
     }
@@ -23,6 +23,7 @@ export function isCombinedAppAndProtocolSummary(summary) {
 /**
  * Extract the attributes from the protocol summary.
  * @param protocolSummary - protocol summary from which the values are to be extracted.
+ * @public
  */
 export function getDocAttributesFromProtocolSummary(protocolSummary) {
     const attributesBlob = protocolSummary.tree.attributes;
@@ -31,6 +32,7 @@ export function getDocAttributesFromProtocolSummary(protocolSummary) {
 /**
  * Extract quorum values from the protocol summary.
  * @param protocolSummary - protocol summary from which the values are to be extracted.
+ * @public
  */
 export function getQuorumValuesFromProtocolSummary(protocolSummary) {
     const quorumValuesBlob = protocolSummary.tree.quorumValues;

package/lib/summaryForCreateNew.js.map

@@ -1 +1 @@
-{"version":3,"file":"summaryForCreateNew.js","sourceRoot":"","sources":["../src/summaryForCreateNew.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEN,WAAW,GAIX,MAAM,sCAAsC,CAAC;AAc9C;;;;GAIG;AACH,MAAM,UAAU,+BAA+B,CAC9C,OAAiC;IAEjC,IACC,OAAO,EAAE,IAAI,KAAK,SAAS;QAC3B,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,KAAK,WAAW,CAAC,IAAI;QACjD,OAAO,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,EAAE,IAAI,KAAK,WAAW,CAAC,IAAI,EACrD;QACD,OAAO,KAAK,CAAC;KACb;IACD,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3C,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;QAC1B,OAAO,KAAK,CAAC;KACb;IACD,OAAO,IAAI,CAAC;AACb,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mCAAmC,CAClD,eAA6B;IAE7B,MAAM,cAAc,GAAG,eAAe,CAAC,IAAI,CAAC,UAA0B,CAAC;IACvE,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,OAAiB,CAAwB,CAAC;AAC5E,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kCAAkC,CACjD,eAA6B;IAE7B,MAAM,gBAAgB,GAAG,eAAe,CAAC,IAAI,CAAC,YAA4B,CAAC;IAC3E,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,OAAiB,CAG/D,CAAC;IACJ,OAAO,YAAY,CAAC;AACrB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tISummaryTree,\n\tSummaryType,\n\tISummaryBlob,\n\tICommittedProposal,\n\tIDocumentAttributes,\n} from \"@fluidframework/protocol-definitions\";\n\n/**\n * Defines the current layout of an .app + .protocol summary tree\n * this is used internally for create new, and single commit summary\n * @internal\n */\nexport interface CombinedAppAndProtocolSummary extends ISummaryTree {\n\ttree: {\n\t\t[\".app\"]: ISummaryTree;\n\t\t[\".protocol\"]: ISummaryTree;\n\t};\n}\n\n/**\n * Validates the current layout of an .app + .protocol summary tree\n * this is used internally for create new, and single commit summary\n * @internal\n */\nexport function isCombinedAppAndProtocolSummary(\n\tsummary: ISummaryTree | undefined,\n): summary is CombinedAppAndProtocolSummary {\n\tif (\n\t\tsummary?.tree === undefined ||\n\t\tsummary.tree?.[\".app\"]?.type !== SummaryType.Tree ||\n\t\tsummary.tree?.[\".protocol\"]?.type !== SummaryType.Tree\n\t) {\n\t\treturn false;\n\t}\n\tconst treeKeys = Object.keys(summary.tree);\n\tif (treeKeys.length !== 2) {\n\t\treturn false;\n\t}\n\treturn true;\n}\n\n/**\n * Extract the attributes from the protocol summary.\n * @param protocolSummary - protocol summary from which the values are to be extracted.\n */\nexport function getDocAttributesFromProtocolSummary(\n\tprotocolSummary: ISummaryTree,\n): IDocumentAttributes {\n\tconst attributesBlob = protocolSummary.tree.attributes as ISummaryBlob;\n\treturn JSON.parse(attributesBlob.content as string) as IDocumentAttributes;\n}\n\n/**\n * Extract quorum values from the protocol summary.\n * @param protocolSummary - protocol summary from which the values are to be extracted.\n */\nexport function getQuorumValuesFromProtocolSummary(\n\tprotocolSummary: ISummaryTree,\n): [string, ICommittedProposal][] {\n\tconst quorumValuesBlob = protocolSummary.tree.quorumValues as ISummaryBlob;\n\tconst quorumValues = JSON.parse(quorumValuesBlob.content as string) as [\n\t\tstring,\n\t\tICommittedProposal,\n\t][];\n\treturn quorumValues;\n}\n"]}
+{"version":3,"file":"summaryForCreateNew.js","sourceRoot":"","sources":["../src/summaryForCreateNew.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEN,WAAW,GAIX,MAAM,sCAAsC,CAAC;AAc9C;;;;GAIG;AACH,MAAM,UAAU,+BAA+B,CAC9C,OAAiC,EACjC,GAAG,iBAA2B;IAE9B,IACC,OAAO,EAAE,IAAI,KAAK,SAAS;QAC3B,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,KAAK,WAAW,CAAC,IAAI;QACjD,OAAO,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,EAAE,IAAI,KAAK,WAAW,CAAC,IAAI,EACrD;QACD,OAAO,KAAK,CAAC;KACb;IACD,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACzF,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;QAC1B,OAAO,KAAK,CAAC;KACb;IACD,OAAO,IAAI,CAAC;AACb,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mCAAmC,CAClD,eAA6B;IAE7B,MAAM,cAAc,GAAG,eAAe,CAAC,IAAI,CAAC,UAA0B,CAAC;IACvE,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,OAAiB,CAAwB,CAAC;AAC5E,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kCAAkC,CACjD,eAA6B;IAE7B,MAAM,gBAAgB,GAAG,eAAe,CAAC,IAAI,CAAC,YAA4B,CAAC;IAC3E,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,OAAiB,CAG/D,CAAC;IACJ,OAAO,YAAY,CAAC;AACrB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tISummaryTree,\n\tSummaryType,\n\tISummaryBlob,\n\tICommittedProposal,\n\tIDocumentAttributes,\n} from \"@fluidframework/protocol-definitions\";\n\n/**\n * Defines the current layout of an .app + .protocol summary tree\n * this is used internally for create new, and single commit summary\n * @internal\n */\nexport interface CombinedAppAndProtocolSummary extends ISummaryTree {\n\ttree: {\n\t\t[\".app\"]: ISummaryTree;\n\t\t[\".protocol\"]: ISummaryTree;\n\t};\n}\n\n/**\n * Validates the current layout of an .app + .protocol summary tree\n * this is used internally for create new, and single commit summary\n * @internal\n */\nexport function isCombinedAppAndProtocolSummary(\n\tsummary: ISummaryTree | undefined,\n\t...optionalRootTrees: string[]\n): summary is CombinedAppAndProtocolSummary {\n\tif (\n\t\tsummary?.tree === undefined ||\n\t\tsummary.tree?.[\".app\"]?.type !== SummaryType.Tree ||\n\t\tsummary.tree?.[\".protocol\"]?.type !== SummaryType.Tree\n\t) {\n\t\treturn false;\n\t}\n\tconst treeKeys = Object.keys(summary.tree).filter((t) => !optionalRootTrees.includes(t));\n\tif (treeKeys.length !== 2) {\n\t\treturn false;\n\t}\n\treturn true;\n}\n\n/**\n * Extract the attributes from the protocol summary.\n * @param protocolSummary - protocol summary from which the values are to be extracted.\n * @public\n */\nexport function getDocAttributesFromProtocolSummary(\n\tprotocolSummary: ISummaryTree,\n): IDocumentAttributes {\n\tconst attributesBlob = protocolSummary.tree.attributes as ISummaryBlob;\n\treturn JSON.parse(attributesBlob.content as string) as IDocumentAttributes;\n}\n\n/**\n * Extract quorum values from the protocol summary.\n * @param protocolSummary - protocol summary from which the values are to be extracted.\n * @public\n */\nexport function getQuorumValuesFromProtocolSummary(\n\tprotocolSummary: ISummaryTree,\n): [string, ICommittedProposal][] {\n\tconst quorumValuesBlob = protocolSummary.tree.quorumValues as ISummaryBlob;\n\tconst quorumValues = JSON.parse(quorumValuesBlob.content as string) as [\n\t\tstring,\n\t\tICommittedProposal,\n\t][];\n\treturn quorumValues;\n}\n"]}

package/lib/treeConversions.d.ts

@@ -6,6 +6,7 @@ import { ISummaryTree, ITree } from "@fluidframework/protocol-definitions";
 /**
  * Converts ISummaryTree to ITree format.
  * @param summaryTree - summary tree in ISummaryTree format
+ * @public
  */
 export declare function convertSummaryTreeToSnapshotITree(summaryTree: ISummaryTree): ITree;
 //# sourceMappingURL=treeConversions.d.ts.map

package/lib/treeConversions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"treeConversions.d.ts","sourceRoot":"","sources":["../src/treeConversions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,YAAY,EAAE,KAAK,EAA2B,MAAM,sCAAsC,CAAC;AAIpG;;;GAGG;AACH,wBAAgB,iCAAiC,CAAC,WAAW,EAAE,YAAY,GAAG,KAAK,CAgDlF"}
+{"version":3,"file":"treeConversions.d.ts","sourceRoot":"","sources":["../src/treeConversions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,YAAY,EAAE,KAAK,EAA2B,MAAM,sCAAsC,CAAC;AAIpG;;;;GAIG;AACH,wBAAgB,iCAAiC,CAAC,WAAW,EAAE,YAAY,GAAG,KAAK,CAgDlF"}

package/lib/treeConversions.js

@@ -10,6 +10,7 @@ import { isCombinedAppAndProtocolSummary } from "./summaryForCreateNew";
 /**
  * Converts ISummaryTree to ITree format.
  * @param summaryTree - summary tree in ISummaryTree format
+ * @public
  */
 export function convertSummaryTreeToSnapshotITree(summaryTree) {
     const entries = [];

package/lib/treeConversions.js.map

@@ -1 +1 @@
-{"version":3,"file":"treeConversions.js","sourceRoot":"","sources":["../src/treeConversions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAmC,WAAW,EAAE,MAAM,sCAAsC,CAAC;AACpG,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAC3E,OAAO,EAAE,+BAA+B,EAAE,MAAM,uBAAuB,CAAC;AAExE;;;GAGG;AACH,MAAM,UAAU,iCAAiC,CAAC,WAAyB;IAC1E,MAAM,OAAO,GAAiB,EAAE,CAAC;IACjC,MAAM,gBAAgB,GAAG,+BAA+B,CAAC,WAAW,CAAC,CAAC;IACtE,MAAM,iBAAiB,GAAG,gBAAgB;QACzC,CAAC,CAAC;YACA,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC;YACrD,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC;SAC/C;QACH,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAEpC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,iBAAiB,EAAE;QAC7C,MAAM,CAAC,GAAG,gBAAgB,IAAI,GAAG,KAAK,YAAY,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC;QACzE,QAAQ,KAAK,CAAC,IAAI,EAAE;YACnB,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC;gBACtB,IAAI,aAAqB,CAAC;gBAC1B,IAAI,QAAQ,GAAuB,OAAO,CAAC;gBAC3C,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,EAAE;oBACtC,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC;iBAC9B;qBAAM;oBACN,aAAa,GAAG,kBAAkB,CAAC,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;oBAC5D,QAAQ,GAAG,QAAQ,CAAC;iBACpB;gBACD,OAAO,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC;gBAC5D,MAAM;aACN;YAED,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC;gBACtB,OAAO,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,CAAC,EAAE,iCAAiC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC7E,MAAM;aACN;YAED,KAAK,WAAW,CAAC,UAAU,CAAC,CAAC;gBAC5B,OAAO,CAAC,IAAI,CAAC,IAAI,mBAAmB,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;gBACnD,MAAM;aACN;YAED,KAAK,WAAW,CAAC,MAAM,CAAC,CAAC;gBACxB,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;aAC/D;YAED;gBACC,eAAe,CAAC,KAAK,EAAE,8BAA8B,CAAC,CAAC;SACxD;KACD;IACD,OAAO;QACN,OAAO;QACP,YAAY,EAAE,WAAW,CAAC,YAAY;KACtC,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { Uint8ArrayToString } from \"@fluid-internal/client-utils\";\nimport { unreachableCase } from \"@fluidframework/core-utils\";\nimport { ISummaryTree, ITree, ITreeEntry, SummaryType } from \"@fluidframework/protocol-definitions\";\nimport { AttachmentTreeEntry, BlobTreeEntry, TreeTreeEntry } from \"./blob\";\nimport { isCombinedAppAndProtocolSummary } from \"./summaryForCreateNew\";\n\n/**\n * Converts ISummaryTree to ITree format.\n * @param summaryTree - summary tree in ISummaryTree format\n */\nexport function convertSummaryTreeToSnapshotITree(summaryTree: ISummaryTree): ITree {\n\tconst entries: ITreeEntry[] = [];\n\tconst adaptSummaryTree = isCombinedAppAndProtocolSummary(summaryTree);\n\tconst allSummaryEntries = adaptSummaryTree\n\t\t? [\n\t\t\t\t...Object.entries(summaryTree.tree[\".protocol\"].tree),\n\t\t\t\t...Object.entries(summaryTree.tree[\".app\"].tree),\n\t\t  ]\n\t\t: Object.entries(summaryTree.tree);\n\n\tfor (const [key, value] of allSummaryEntries) {\n\t\tconst k = adaptSummaryTree && key === \"attributes\" ? \".attributes\" : key;\n\t\tswitch (value.type) {\n\t\t\tcase SummaryType.Blob: {\n\t\t\t\tlet parsedContent: string;\n\t\t\t\tlet encoding: \"utf-8\" | \"base64\" = \"utf-8\";\n\t\t\t\tif (typeof value.content === \"string\") {\n\t\t\t\t\tparsedContent = value.content;\n\t\t\t\t} else {\n\t\t\t\t\tparsedContent = Uint8ArrayToString(value.content, \"base64\");\n\t\t\t\t\tencoding = \"base64\";\n\t\t\t\t}\n\t\t\t\tentries.push(new BlobTreeEntry(k, parsedContent, encoding));\n\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\tcase SummaryType.Tree: {\n\t\t\t\tentries.push(new TreeTreeEntry(k, convertSummaryTreeToSnapshotITree(value)));\n\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\tcase SummaryType.Attachment: {\n\t\t\t\tentries.push(new AttachmentTreeEntry(k, value.id));\n\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\tcase SummaryType.Handle: {\n\t\t\t\tthrow new Error(\"Should not have Handle type in summary tree\");\n\t\t\t}\n\n\t\t\tdefault:\n\t\t\t\tunreachableCase(value, \"Unexpected summary tree type\");\n\t\t}\n\t}\n\treturn {\n\t\tentries,\n\t\tunreferenced: summaryTree.unreferenced,\n\t};\n}\n"]}
+{"version":3,"file":"treeConversions.js","sourceRoot":"","sources":["../src/treeConversions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAmC,WAAW,EAAE,MAAM,sCAAsC,CAAC;AACpG,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAC3E,OAAO,EAAE,+BAA+B,EAAE,MAAM,uBAAuB,CAAC;AAExE;;;;GAIG;AACH,MAAM,UAAU,iCAAiC,CAAC,WAAyB;IAC1E,MAAM,OAAO,GAAiB,EAAE,CAAC;IACjC,MAAM,gBAAgB,GAAG,+BAA+B,CAAC,WAAW,CAAC,CAAC;IACtE,MAAM,iBAAiB,GAAG,gBAAgB;QACzC,CAAC,CAAC;YACA,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC;YACrD,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC;SAC/C;QACH,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAEpC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,iBAAiB,EAAE;QAC7C,MAAM,CAAC,GAAG,gBAAgB,IAAI,GAAG,KAAK,YAAY,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC;QACzE,QAAQ,KAAK,CAAC,IAAI,EAAE;YACnB,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC;gBACtB,IAAI,aAAqB,CAAC;gBAC1B,IAAI,QAAQ,GAAuB,OAAO,CAAC;gBAC3C,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,EAAE;oBACtC,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC;iBAC9B;qBAAM;oBACN,aAAa,GAAG,kBAAkB,CAAC,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;oBAC5D,QAAQ,GAAG,QAAQ,CAAC;iBACpB;gBACD,OAAO,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC;gBAC5D,MAAM;aACN;YAED,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC;gBACtB,OAAO,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,CAAC,EAAE,iCAAiC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC7E,MAAM;aACN;YAED,KAAK,WAAW,CAAC,UAAU,CAAC,CAAC;gBAC5B,OAAO,CAAC,IAAI,CAAC,IAAI,mBAAmB,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;gBACnD,MAAM;aACN;YAED,KAAK,WAAW,CAAC,MAAM,CAAC,CAAC;gBACxB,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;aAC/D;YAED;gBACC,eAAe,CAAC,KAAK,EAAE,8BAA8B,CAAC,CAAC;SACxD;KACD;IACD,OAAO;QACN,OAAO;QACP,YAAY,EAAE,WAAW,CAAC,YAAY;KACtC,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { Uint8ArrayToString } from \"@fluid-internal/client-utils\";\nimport { unreachableCase } from \"@fluidframework/core-utils\";\nimport { ISummaryTree, ITree, ITreeEntry, SummaryType } from \"@fluidframework/protocol-definitions\";\nimport { AttachmentTreeEntry, BlobTreeEntry, TreeTreeEntry } from \"./blob\";\nimport { isCombinedAppAndProtocolSummary } from \"./summaryForCreateNew\";\n\n/**\n * Converts ISummaryTree to ITree format.\n * @param summaryTree - summary tree in ISummaryTree format\n * @public\n */\nexport function convertSummaryTreeToSnapshotITree(summaryTree: ISummaryTree): ITree {\n\tconst entries: ITreeEntry[] = [];\n\tconst adaptSummaryTree = isCombinedAppAndProtocolSummary(summaryTree);\n\tconst allSummaryEntries = adaptSummaryTree\n\t\t? [\n\t\t\t\t...Object.entries(summaryTree.tree[\".protocol\"].tree),\n\t\t\t\t...Object.entries(summaryTree.tree[\".app\"].tree),\n\t\t  ]\n\t\t: Object.entries(summaryTree.tree);\n\n\tfor (const [key, value] of allSummaryEntries) {\n\t\tconst k = adaptSummaryTree && key === \"attributes\" ? \".attributes\" : key;\n\t\tswitch (value.type) {\n\t\t\tcase SummaryType.Blob: {\n\t\t\t\tlet parsedContent: string;\n\t\t\t\tlet encoding: \"utf-8\" | \"base64\" = \"utf-8\";\n\t\t\t\tif (typeof value.content === \"string\") {\n\t\t\t\t\tparsedContent = value.content;\n\t\t\t\t} else {\n\t\t\t\t\tparsedContent = Uint8ArrayToString(value.content, \"base64\");\n\t\t\t\t\tencoding = \"base64\";\n\t\t\t\t}\n\t\t\t\tentries.push(new BlobTreeEntry(k, parsedContent, encoding));\n\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\tcase SummaryType.Tree: {\n\t\t\t\tentries.push(new TreeTreeEntry(k, convertSummaryTreeToSnapshotITree(value)));\n\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\tcase SummaryType.Attachment: {\n\t\t\t\tentries.push(new AttachmentTreeEntry(k, value.id));\n\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\tcase SummaryType.Handle: {\n\t\t\t\tthrow new Error(\"Should not have Handle type in summary tree\");\n\t\t\t}\n\n\t\t\tdefault:\n\t\t\t\tunreachableCase(value, \"Unexpected summary tree type\");\n\t\t}\n\t}\n\treturn {\n\t\tentries,\n\t\tunreferenced: summaryTree.unreferenced,\n\t};\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/driver-utils",
-  "version": "2.0.0-dev.6.4.0.192049",
+  "version": "2.0.0-dev.7.2.0.204906",
   "description": "Collection of utility functions for Fluid drivers",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -35,42 +35,41 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.0.0-dev.6.4.0.192049",
-    "@fluidframework/core-interfaces": "2.0.0-dev.6.4.0.192049",
-    "@fluidframework/core-utils": "2.0.0-dev.6.4.0.192049",
-    "@fluidframework/driver-definitions": "2.0.0-dev.6.4.0.192049",
-    "@fluidframework/gitresources": "^1.0.1",
-    "@fluidframework/protocol-base": "^1.0.1",
-    "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/telemetry-utils": "2.0.0-dev.6.4.0.192049",
+    "@fluid-internal/client-utils": "2.0.0-dev.7.2.0.204906",
+    "@fluidframework/core-interfaces": "2.0.0-dev.7.2.0.204906",
+    "@fluidframework/core-utils": "2.0.0-dev.7.2.0.204906",
+    "@fluidframework/driver-definitions": "2.0.0-dev.7.2.0.204906",
+    "@fluidframework/gitresources": "^2.0.1",
+    "@fluidframework/protocol-base": "^2.0.1",
+    "@fluidframework/protocol-definitions": "^3.0.0",
+    "@fluidframework/telemetry-utils": "2.0.0-dev.7.2.0.204906",
     "axios": "^0.26.0",
     "lz4js": "^0.2.0",
     "url": "^0.11.0",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "^0.22.0",
-    "@fluidframework/build-common": "^2.0.0",
-    "@fluidframework/build-tools": "^0.22.0",
-    "@fluidframework/driver-utils-previous": "npm:@fluidframework/driver-utils@2.0.0-internal.6.3.0",
-    "@fluidframework/eslint-config-fluid": "^2.1.0",
-    "@fluidframework/mocha-test-setup": "2.0.0-dev.6.4.0.192049",
-    "@microsoft/api-extractor": "^7.34.4",
+    "@fluid-tools/build-cli": "0.26.0-203096",
+    "@fluidframework/build-common": "^2.0.2",
+    "@fluidframework/build-tools": "0.26.0-203096",
+    "@fluidframework/driver-utils-previous": "npm:@fluidframework/driver-utils@2.0.0-internal.7.1.0",
+    "@fluidframework/eslint-config-fluid": "^3.0.0",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.2.0.204906",
+    "@microsoft/api-extractor": "^7.37.0",
     "@types/mocha": "^9.1.1",
     "@types/node": "^16.18.38",
     "@types/sinon": "^7.0.13",
     "c8": "^7.7.1",
-    "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
-    "eslint": "~8.6.0",
+    "eslint": "~8.50.0",
     "mocha": "^10.2.0",
     "mocha-json-output-reporter": "^2.0.1",
     "mocha-multi-reporters": "^1.5.1",
     "moment": "^2.21.0",
-    "prettier": "~2.6.2",
+    "prettier": "~3.0.3",
     "rimraf": "^4.4.0",
     "sinon": "^7.4.2",
-    "typescript": "~4.5.5"
+    "typescript": "~5.1.6"
   },
   "typeValidation": {
     "broken": {}
@@ -79,11 +78,11 @@
     "build": "fluid-build . --task build",
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",
-    "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
+    "build:docs": "api-extractor run --local",
     "build:esnext": "tsc --project ./tsconfig.esnext.json",
     "build:genver": "gen-version",
     "build:test": "tsc --project ./src/test/tsconfig.json",
-    "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
+    "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob 'dist' 'lib' '*.tsbuildinfo' '*.build.log' '_api-extractor-temp' 'nyc'",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",

package/src/adapters/compression/compressionTypes.ts

@@ -3,11 +3,17 @@
  * Licensed under the MIT License.
  */
 
+/**
+ * @public
+ */
 export enum SummaryCompressionAlgorithm {
 	None = 0,
 	LZ4 = 1,
 }
 
+/**
+ * @public
+ */
 export interface ICompressionStorageConfig {
 	algorithm: SummaryCompressionAlgorithm;
 	minSizeToCompress: number;

package/src/adapters/compression/documentServiceCompressionAdapter.ts

@@ -9,7 +9,10 @@ import { DocumentStorageServiceCompressionAdapter as DocumentStorageServiceSumma
 import { ICompressionStorageConfig } from "./compressionTypes";
 
 export class DocumentServiceCompressionAdapter extends DocumentServiceProxy {
-	constructor(service: IDocumentService, private readonly _config: ICompressionStorageConfig) {
+	constructor(
+		service: IDocumentService,
+		private readonly _config: ICompressionStorageConfig,
+	) {
 		super(service);
 	}
 

package/src/adapters/compression/documentServiceFactoryCompressionAdapter.ts

@@ -30,15 +30,7 @@ export class DocumentServiceFactoryCompressionAdapter extends DocumentServiceFac
 		clientIsSummarizer?: boolean,
 	): Promise<IDocumentService> {
 		if (createNewSummary !== undefined) {
-			// TODO : this is a hack to make sure that the initial summary is not compressed
-			// We must prevent the initial summary from being compressed because
-			// of the hack at packages/drivers/routerlicious-driver/src/createNewUtils.ts
-			// where the binary blob is converted to a string using UTF-8 encoding
-			// which is producing incorrect results for compressed data.
-			const configForInitial = {
-				...this._config,
-				minSizeToCompress: Number.POSITIVE_INFINITY,
-			};
+			const configForInitial = this._config;
 			const newAppSumary =
 				DocumentStorageServiceSummaryBlobCompressionAdapter.compressSummary(
 					createNewSummary.tree[".app"] as ISummaryTree,

package/src/adapters/compression/summaryblob/documentStorageServiceSummaryBlobCompressionAdapter.ts

@@ -19,6 +19,9 @@ import { compress, decompress } from "lz4js";
 import { DocumentStorageServiceProxy } from "../../../documentStorageServiceProxy";
 import { ICompressionStorageConfig, SummaryCompressionAlgorithm } from "../";
 
+/**
+ * @public
+ */
 export const blobHeadersBlobName = ".metadata.blobHeaders";
 const metadataBlobName = ".metadata";
 
@@ -32,6 +35,7 @@ const metadataBlobName = ".metadata";
  * In case, the markup blob is present, it is expected that the first byte of the markup blob
  * will contain the info about the compression. If the first byte is not present, it is assumed
  * that the compression is not enabled and no first prefix byte is present in the blobs.
+ * @public
  */
 export class DocumentStorageServiceCompressionAdapter extends DocumentStorageServiceProxy {
 	private _isCompressionEnabled: boolean = false;

package/src/adapters/predefinedAdapters.ts

@@ -17,6 +17,7 @@ import {
  * @param documentServiceFactory - The document service factory to apply compression to.
  * @param config - The compression configuration.
  * @returns The document service factory possibly with compression applied.
+ * @public
  */
 export function applyStorageCompression(
 	documentServiceFactory: IDocumentServiceFactory,

package/src/blob.ts

@@ -13,6 +13,7 @@ import {
 
 /**
  * Basic implementation of a blob ITreeEntry
+ * @public
  */
 export class BlobTreeEntry {
 	public readonly mode = FileMode.File;
@@ -36,6 +37,7 @@ export class BlobTreeEntry {
 
 /**
  * Basic implementation of a tree ITreeEntry
+ * @public
  */
 export class TreeTreeEntry {
 	public readonly mode = FileMode.Directory;
@@ -46,11 +48,15 @@ export class TreeTreeEntry {
 	 * @param path - path of entry
 	 * @param value - subtree
 	 */
-	constructor(public readonly path: string, public readonly value: ITree) {}
+	constructor(
+		public readonly path: string,
+		public readonly value: ITree,
+	) {}
 }
 
 /**
  * Basic implementation of an attachment ITreeEntry
+ * @public
  */
 export class AttachmentTreeEntry {
 	public readonly mode = FileMode.File;
@@ -62,7 +68,10 @@ export class AttachmentTreeEntry {
 	 * @param path - path of entry
 	 * @param id - id of external blob attachment
 	 */
-	constructor(public readonly path: string, public readonly id: string) {
+	constructor(
+		public readonly path: string,
+		public readonly id: string,
+	) {
 		this.value = { id };
 	}
 }

package/src/buildSnapshotTree.ts

@@ -86,6 +86,7 @@ function flatten(tree: ITreeEntry[], blobMap: Map<string, ArrayBufferLike>): git
  * @param blobMap - a map of blob's sha1 to content that gets filled with content from entries
  * NOTE: blobMap's validity is contingent on the returned promise's resolution
  * @returns the hierarchical tree
+ * @public
  */
 export function buildSnapshotTree(
 	entries: ITreeEntry[],

package/src/documentStorageServiceProxy.ts

@@ -17,6 +17,9 @@ import {
 	IVersion,
 } from "@fluidframework/protocol-definitions";
 
+/**
+ * @public
+ */
 export class DocumentStorageServiceProxy implements IDocumentStorageService {
 	private _policies: IDocumentStorageServicePolicies | undefined;
 

package/src/error.ts

@@ -7,7 +7,10 @@
 import { DriverErrorType, IDriverErrorBase } from "@fluidframework/driver-definitions";
 import { IFluidErrorBase, LoggingError } from "@fluidframework/telemetry-utils";
 
-/** Error indicating an API is being used improperly resulting in an invalid operation. */
+/**
+ * Error indicating an API is being used improperly resulting in an invalid operation.
+ * @public
+ */
 export class UsageError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {
 	// eslint-disable-next-line import/no-deprecated
 	readonly errorType = DriverErrorType.usageError;

package/src/index.ts

@@ -51,5 +51,6 @@ export { convertSummaryTreeToSnapshotITree } from "./treeConversions";
 export {
 	applyStorageCompression,
 	ICompressionStorageConfig,
+	SummaryCompressionAlgorithm,
 	blobHeadersBlobName,
 } from "./adapters";

package/src/insecureUrlResolver.ts

@@ -22,6 +22,7 @@ import Axios from "axios";
  * The tenantId/documentId pair defines the 'full' document ID the service makes use of. The path is then an optional
  * part of the URL that the document interprets and maps to a data store. It's exactly similar to how a web service
  * works or a router inside of a single page app framework.
+ * @public
  */
 export class InsecureUrlResolver implements IUrlResolver {
 	private readonly cache = new Map<string, Promise<IResolvedUrl>>();
@@ -48,7 +49,7 @@ export class InsecureUrlResolver implements IUrlResolver {
 		// service using our bearer token.
 		if (this.isForNodeTest) {
 			const [, documentId, tmpRelativePath] = parsedUrl.pathname.substr(1).split("/");
-			const relativePath = tmpRelativePath === undefined ? "" : tmpRelativePath;
+			const relativePath = tmpRelativePath ?? "";
 			return this.resolveHelper(documentId, relativePath, parsedUrl.search);
 		} else if (parsedUrl.host === window.location.host) {
 			const fullPath = parsedUrl.pathname.substr(1);

package/src/messageRecognition.ts

@@ -12,18 +12,25 @@ import {
  * Tells if message was sent by container runtime
  * @privateRemarks ADO #1385: To be moved to container-definitions
  * @returns whether the message is a runtime message
+ * @public
  */
 export function isRuntimeMessage(message: { type: string }): boolean {
 	return message.type === MessageType.Operation;
 }
 
-// ADO #1385: staging code changes across layers.
-// Eventually to be replaced by MessageType.accept
+/**
+ * @privateRemarks ADO #1385: staging code changes across layers.
+ * Eventually to be replaced by MessageType.accept
+ * @public
+ */
 export enum MessageType2 {
 	Accept = "accept",
 }
 
-// ADO #1385: To be moved to packages/protocol-base/src/protocol.ts
+/**
+ * @privateRemarks ADO #1385: To be moved to packages/protocol-base/src/protocol.ts
+ * @public
+ */
 export function canBeCoalescedByService(
 	message: ISequencedDocumentMessage | IDocumentMessage,
 ): boolean {

package/src/network.ts

@@ -16,15 +16,21 @@ import {
 import { ITelemetryProperties } from "@fluidframework/core-interfaces";
 import { IFluidErrorBase, LoggingError } from "@fluidframework/telemetry-utils";
 
+/**
+ * @public
+ */
 export enum OnlineStatus {
 	Offline,
 	Online,
 	Unknown,
 }
 
-// It tells if we have local connection only - we might not have connection to web.
-// No solution for node.js (other than resolve dns names / ping specific sites)
-// Can also use window.addEventListener("online" / "offline")
+/**
+ * It tells if we have local connection only - we might not have connection to web.
+ * No solution for node.js (other than resolve dns names / ping specific sites)
+ * Can also use window.addEventListener("online" / "offline")
+ * @public
+ */
 export function isOnline(): OnlineStatus {
 	if (
 		typeof navigator === "object" &&
@@ -36,25 +42,34 @@ export function isOnline(): OnlineStatus {
 	return OnlineStatus.Unknown;
 }
 
-/** Telemetry props with driver-specific required properties */
+/**
+ * Telemetry props with driver-specific required properties
+ * @public
+ */
 export type DriverErrorTelemetryProps = ITelemetryProperties & {
 	driverVersion: string | undefined;
 };
 
 /**
  * Generic network error class.
+ * @public
  */
 export class GenericNetworkError extends LoggingError implements IDriverErrorBase, IFluidErrorBase {
 	// eslint-disable-next-line import/no-deprecated
 	readonly errorType = DriverErrorType.genericNetworkError;
 
-	constructor(message: string, readonly canRetry: boolean, props: DriverErrorTelemetryProps) {
+	constructor(
+		message: string,
+		readonly canRetry: boolean,
+		props: DriverErrorTelemetryProps,
+	) {
 		super(message, props);
 	}
 }
 
 /**
  * FluidInvalidSchema error class.
+ * @public
  */
 export class FluidInvalidSchemaError
 	extends LoggingError
@@ -69,6 +84,9 @@ export class FluidInvalidSchemaError
 	}
 }
 
+/**
+ * @public
+ */
 export class DeltaStreamConnectionForbiddenError
 	extends LoggingError
 	implements IDriverErrorBase, IFluidErrorBase
@@ -85,6 +103,9 @@ export class DeltaStreamConnectionForbiddenError
 	}
 }
 
+/**
+ * @public
+ */
 export class AuthorizationError
 	extends LoggingError
 	implements IAuthorizationError, IFluidErrorBase
@@ -104,6 +125,9 @@ export class AuthorizationError
 	}
 }
 
+/**
+ * @public
+ */
 export class LocationRedirectionError
 	extends LoggingError
 	implements ILocationRedirectionError, IFluidErrorBase
@@ -122,6 +146,9 @@ export class LocationRedirectionError
 	}
 }
 
+/**
+ * @public
+ */
 export class NetworkErrorBasic<T extends string> extends LoggingError implements IFluidErrorBase {
 	constructor(
 		message: string,
@@ -133,20 +160,35 @@ export class NetworkErrorBasic<T extends string> extends LoggingError implements
 	}
 }
 
+/**
+ * @public
+ */
 export class NonRetryableError<T extends string> extends NetworkErrorBasic<T> {
-	constructor(message: string, readonly errorType: T, props: DriverErrorTelemetryProps) {
+	constructor(
+		message: string,
+		readonly errorType: T,
+		props: DriverErrorTelemetryProps,
+	) {
 		super(message, errorType, false, props);
 	}
 }
 
+/**
+ * @public
+ */
 export class RetryableError<T extends string> extends NetworkErrorBasic<T> {
-	constructor(message: string, readonly errorType: T, props: DriverErrorTelemetryProps) {
+	constructor(
+		message: string,
+		readonly errorType: T,
+		props: DriverErrorTelemetryProps,
+	) {
 		super(message, errorType, true, props);
 	}
 }
 
 /**
  * Throttling error class - used to communicate all throttling errors
+ * @public
  */
 export class ThrottlingError extends LoggingError implements IThrottlingWarning, IFluidErrorBase {
 	// eslint-disable-next-line import/no-deprecated
@@ -162,9 +204,15 @@ export class ThrottlingError extends LoggingError implements IThrottlingWarning,
 	}
 }
 
+/**
+ * @public
+ */
 export const createWriteError = (message: string, props: DriverErrorTelemetryProps) =>
 	new NonRetryableError(message, DriverErrorTypes.writeError, props);
 
+/**
+ * @public
+ */
 export function createGenericNetworkError(
 	message: string,
 	retryInfo: { canRetry: boolean; retryAfterMs?: number },
@@ -180,13 +228,20 @@ export function createGenericNetworkError(
  * Check if a connection error can be retried.  Unless explicitly allowed, retry is disallowed.
  * I.e. asserts or unexpected exceptions in our code result in container failure.
  * @param error - The error to inspect for ability to retry
+ * @public
  */
 export const canRetryOnError = (error: any): boolean => error?.canRetry === true;
 
-/** Check retryAfterSeconds property on error */
+/**
+ * Check retryAfterSeconds property on error
+ * @public
+ * */
 export const getRetryDelaySecondsFromError = (error: any): number | undefined =>
 	error?.retryAfterSeconds as number | undefined;
 
-/** Check retryAfterSeconds property on error and convert to ms */
+/**
+ * Check retryAfterSeconds property on error and convert to ms
+ * @public
+ * */
 export const getRetryDelayFromError = (error: any): number | undefined =>
 	error?.retryAfterSeconds !== undefined ? error.retryAfterSeconds * 1000 : undefined;

package/src/networkUtils.ts

@@ -7,6 +7,9 @@ import { ITelemetryErrorEvent } from "@fluidframework/core-interfaces";
 import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 import { isOnline, OnlineStatus, canRetryOnError } from "./network";
 
+/**
+ * @public
+ */
 export function logNetworkFailure(
 	logger: ITelemetryLoggerExt,
 	event: ITelemetryErrorEvent,

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/driver-utils";
-export const pkgVersion = "2.0.0-dev.6.4.0.192049";
+export const pkgVersion = "2.0.0-dev.7.2.0.204906";

package/src/parallelRequests.ts

@@ -29,11 +29,12 @@ type WorkingState = "working" | "done" | "canceled";
  * @param logger - logger to use
  * @param requestCallback - callback to request batches
  * @returns Queue that can be used to retrieve data
+ * @public
  */
 export class ParallelRequests<T> {
 	private latestRequested: number;
 	private nextToDeliver: number;
-	private readonly results: Map<number, T[]> = new Map();
+	private readonly results = new Map<number, T[]>();
 	private workingState: WorkingState = "working";
 	private requestsInFlight = 0;
 	private readonly endEvent = new Deferred<void>();
@@ -338,6 +339,7 @@ export class ParallelRequests<T> {
 /**
  * Helper queue class to allow async push / pull
  * It's essentially a pipe allowing multiple writers, and single reader
+ * @public
  */
 export class Queue<T> implements IStream<T> {
 	private readonly queue: Promise<IStreamResult<T>>[] = [];
@@ -531,6 +533,7 @@ async function getSingleOpBatch(
  * @param signal - Cancelation signal
  * @param scenarioName - Reason for fetching ops
  * @returns Messages fetched
+ * @public
  */
 export function requestOps(
 	get: (
@@ -651,12 +654,18 @@ export function requestOps(
 	return queue;
 }
 
+/**
+ * @public
+ */
 export const emptyMessageStream: IStream<ISequencedDocumentMessage[]> = {
 	read: async () => {
 		return { done: true };
 	},
 };
 
+/**
+ * @public
+ */
 export function streamFromMessages(
 	messagesArg: Promise<ISequencedDocumentMessage[]>,
 ): IStream<ISequencedDocumentMessage[]> {
@@ -673,6 +682,9 @@ export function streamFromMessages(
 	};
 }
 
+/**
+ * @public
+ */
 export function streamObserver<T>(
 	stream: IStream<T>,
 	handler: (value: IStreamResult<T>) => void,

package/src/prefetchDocumentStorageService.ts

@@ -7,6 +7,9 @@ import { ISnapshotTree, IVersion } from "@fluidframework/protocol-definitions";
 import { DocumentStorageServiceProxy } from "./documentStorageServiceProxy";
 import { canRetryOnError } from "./network";
 
+/**
+ * @public
+ */
 export class PrefetchDocumentStorageService extends DocumentStorageServiceProxy {
 	// BlobId -> blob prefetchCache cache
 	private readonly prefetchCache = new Map<string, Promise<ArrayBufferLike>>();