@fluidframework/map 0.54.0 → 0.55.0

package/src/directory.ts

@@ -4,12 +4,9 @@
  */
 
 import { assert,TypedEventEmitter } from "@fluidframework/common-utils";
-import { IFluidSerializer } from "@fluidframework/core-interfaces";
 import { readAndParse } from "@fluidframework/driver-utils";
-import { addBlobToTree } from "@fluidframework/protocol-base";
 import {
     ISequencedDocumentMessage,
-    ITree,
     MessageType,
 } from "@fluidframework/protocol-definitions";
 import {
@@ -19,7 +16,9 @@ import {
     IChannelServices,
     IChannelFactory,
 } from "@fluidframework/datastore-definitions";
-import { SharedObject, ValueType } from "@fluidframework/shared-object-base";
+import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
+import { IFluidSerializer, SharedObject, ValueType } from "@fluidframework/shared-object-base";
+import { SummaryTreeBuilder } from "@fluidframework/runtime-utils";
 import * as path from "path-browserify";
 import {
     IDirectory,
@@ -204,10 +203,10 @@ export interface IDirectoryNewStorageFormat {
     content: IDirectoryDataObject;
 }
 
-function serializeDirectory(root: SubDirectory, serializer: IFluidSerializer): ITree {
+function serializeDirectory(root: SubDirectory, serializer: IFluidSerializer): ISummaryTreeWithStats {
     const MinValueSizeSeparateSnapshotBlob = 8 * 1024;
 
-    const tree: ITree = { entries: [] };
+    const builder = new SummaryTreeBuilder();
     let counter = 0;
     const blobs: string[] = [];
 
@@ -241,7 +240,7 @@ function serializeDirectory(root: SubDirectory, serializer: IFluidSerializer): I
                 const blobName = `blob${counter}`;
                 counter++;
                 blobs.push(blobName);
-                addBlobToTree(tree, blobName, extraContent);
+                builder.addBlob(blobName, JSON.stringify(extraContent));
             } else {
                 currentSubDirObject.storage[key] = result;
             }
@@ -261,9 +260,9 @@ function serializeDirectory(root: SubDirectory, serializer: IFluidSerializer): I
         blobs,
         content,
     };
-    addBlobToTree(tree, snapshotFileName, newFormat);
+    builder.addBlob(snapshotFileName, JSON.stringify(newFormat));
 
-    return tree;
+    return builder.getSummaryTree();
 }
 
 /**
@@ -419,6 +418,7 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
 
     /**
      * {@inheritDoc IDirectory.wait}
+     * @deprecated 0.55 - This method will be removed in an upcoming release.  See BREAKING.md for migration options.
      */
     public async wait<T = any>(key: string): Promise<T> {
         return this.root.wait<T>(key);
@@ -560,10 +560,10 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
     }
 
     /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.snapshotCore}
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
      * @internal
      */
-    protected snapshotCore(serializer: IFluidSerializer): ITree {
+    protected summarizeCore(serializer: IFluidSerializer, fullTree: boolean): ISummaryTreeWithStats {
         return serializeDirectory(this.root, serializer);
     }
 
@@ -901,6 +901,7 @@ class SubDirectory extends TypedEventEmitter<IDirectoryEvents> implements IDirec
 
     /**
      * {@inheritDoc IDirectory.wait}
+     * @deprecated 0.55 - This method will be removed in an upcoming release.  See BREAKING.md for migration options.
      */
     public async wait<T = any>(key: string): Promise<T> {
         // Return immediately if the value already exists

package/src/interfaces.ts

@@ -44,6 +44,7 @@ export interface IDirectory extends Map<string, any>, IEventProvider<IDirectoryE
      * A form of get except it will only resolve the promise once the key exists in the directory.
      * @param key - Key to retrieve from
      * @returns The stored value once available
+     * @deprecated 0.55 - This method will be removed in an upcoming release.  See BREAKING.md for migration options.
      */
     wait<T = any>(key: string): Promise<T>;
 
@@ -268,6 +269,7 @@ export interface ISharedMap extends ISharedObject<ISharedMapEvents>, Map<string,
      * A form of get except it will only resolve the promise once the key exists in the map.
      * @param key - Key to retrieve from
      * @returns The stored value once available
+     * @deprecated 0.55 - This method will be removed in an upcoming release.  See BREAKING.md for migration options.
      */
     wait<T = any>(key: string): Promise<T>;
 

package/src/localValues.ts

@@ -3,12 +3,10 @@
  * Licensed under the MIT License.
  */
 
+import { IFluidHandle } from "@fluidframework/core-interfaces";
 import {
-    IFluidHandle,
     IFluidSerializer,
     ISerializedHandle,
-} from "@fluidframework/core-interfaces";
-import {
     parseHandles,
     serializeHandles,
     SharedObject,

package/src/map.ts

@@ -3,13 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { IFluidSerializer } from "@fluidframework/core-interfaces";
-import { addBlobToTree } from "@fluidframework/protocol-base";
-import {
-    ISequencedDocumentMessage,
-    ITree,
-    MessageType,
-} from "@fluidframework/protocol-definitions";
+import { ISequencedDocumentMessage, MessageType } from "@fluidframework/protocol-definitions";
 import {
     IChannelAttributes,
     IFluidDataStoreRuntime,
@@ -17,10 +11,13 @@ import {
     IChannelServices,
     IChannelFactory,
 } from "@fluidframework/datastore-definitions";
+import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
 import { readAndParse } from "@fluidframework/driver-utils";
 import {
+    IFluidSerializer,
     SharedObject,
 } from "@fluidframework/shared-object-base";
+import { SummaryTreeBuilder } from "@fluidframework/runtime-utils";
 import {
     ISharedMap,
     ISharedMapEvents,
@@ -213,6 +210,7 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
 
     /**
      * {@inheritDoc ISharedMap.wait}
+     * @deprecated 0.55 - This method will be removed in an upcoming release.  See BREAKING.md for migration options.
      */
     public async wait<T = any>(key: string): Promise<T> {
         return this.kernel.wait<T>(key);
@@ -252,18 +250,16 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
     }
 
     /**
-     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.snapshotCore}
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
      * @internal
      */
-    protected snapshotCore(serializer: IFluidSerializer): ITree {
+    protected summarizeCore(serializer: IFluidSerializer, fullTree: boolean): ISummaryTreeWithStats {
         let currentSize = 0;
         let counter = 0;
         let headerBlob: IMapDataObjectSerializable = {};
         const blobs: string[] = [];
 
-        const tree: ITree = {
-            entries: [],
-        };
+        const builder = new SummaryTreeBuilder();
 
         const data = this.kernel.getSerializedStorage(serializer);
 
@@ -296,7 +292,7 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
                         value: JSON.parse(value.value),
                     },
                 };
-                addBlobToTree(tree, blobName, content);
+                builder.addBlob(blobName, JSON.stringify(content));
             } else {
                 currentSize += value.type.length + 21; // Approximation cost of property header
                 if (value.value) {
@@ -307,7 +303,7 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
                     const blobName = `blob${counter}`;
                     counter++;
                     blobs.push(blobName);
-                    addBlobToTree(tree, blobName, headerBlob);
+                    builder.addBlob(blobName, JSON.stringify(headerBlob));
                     headerBlob = {};
                     currentSize = 0;
                 }
@@ -322,9 +318,9 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
             blobs,
             content: headerBlob,
         };
-        addBlobToTree(tree, snapshotFileName, header);
+        builder.addBlob(snapshotFileName, JSON.stringify(header));
 
-        return tree;
+        return builder.getSummaryTree();
     }
 
     /**

package/src/mapKernel.ts

@@ -3,8 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import { IFluidHandle, IFluidSerializer } from "@fluidframework/core-interfaces";
-import { ValueType } from "@fluidframework/shared-object-base";
+import { IFluidHandle } from "@fluidframework/core-interfaces";
+import { IFluidSerializer, ValueType } from "@fluidframework/shared-object-base";
 import { assert, TypedEventEmitter } from "@fluidframework/common-utils";
 import {
     ISerializableValue,
@@ -262,6 +262,7 @@ export class MapKernel {
 
     /**
      * {@inheritDoc ISharedMap.wait}
+     * @deprecated 0.55 - This method will be removed in an upcoming release.  See BREAKING.md for migration options.
      */
     public async wait<T = any>(key: string): Promise<T> {
         // Return immediately if the value already exists

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/map";
-export const pkgVersion = "0.54.0";
+export const pkgVersion = "0.55.0";