@fluid-experimental/property-dds 1.1.0 → 1.2.0

package/dist/propertyTreeExtFactories.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeflatedPropertyTreeFactory = void 0;
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+const pako_1 = require("pako");
+const common_utils_1 = require("@fluidframework/common-utils");
+const propertyTreeExt_1 = require("./propertyTreeExt");
+function encodeSummary(snapshotSummary) {
+    const summaryStr = JSON.stringify(snapshotSummary);
+    const unzipped = new TextEncoder().encode(summaryStr);
+    const serializedSummary = (0, pako_1.deflate)(unzipped);
+    return serializedSummary;
+}
+function decodeSummary(serializedSummary) {
+    const unzipped = (0, pako_1.inflate)(serializedSummary);
+    const summaryStr = new TextDecoder().decode(unzipped);
+    const snapshotSummary = JSON.parse(summaryStr);
+    return snapshotSummary;
+}
+function encodeMessage(change) {
+    const changeSetStr = JSON.stringify(change.changeSet);
+    const unzipped = new TextEncoder().encode(changeSetStr);
+    const zipped = (0, pako_1.deflate)(unzipped);
+    const zippedStr = (0, common_utils_1.bufferToString)(zipped, "base64");
+    if (zippedStr.length < changeSetStr.length) {
+        // eslint-disable-next-line @typescript-eslint/dot-notation
+        change["isZipped"] = "1";
+        change.changeSet = zippedStr;
+    }
+    return change;
+}
+function decodeMessage(transferChange) {
+    // eslint-disable-next-line @typescript-eslint/dot-notation
+    if (transferChange["isZipped"]) {
+        const zipped = (0, common_utils_1.stringToBuffer)(transferChange.changeSet, "base64");
+        const unzipped = (0, pako_1.inflate)(zipped);
+        const changeSetStr = new TextDecoder().decode(unzipped);
+        transferChange.changeSet = JSON.parse(changeSetStr);
+    }
+    return transferChange;
+}
+const encDec = {
+    messageEncoder: {
+        encode: encodeMessage,
+        decode: decodeMessage,
+    },
+    summaryEncoder: {
+        encode: encodeSummary,
+        decode: decodeSummary,
+    },
+};
+class DeflatedPropertyTreeFactory {
+    get type() {
+        return DeflatedPropertyTreeFactory.Type;
+    }
+    get attributes() {
+        return DeflatedPropertyTreeFactory.Attributes;
+    }
+    async load(runtime, id, services, attributes, url) {
+        const options = {};
+        const instance = new propertyTreeExt_1.DeflatedPropertyTree(id, runtime, attributes, options, { encDec });
+        await instance.load(services);
+        return instance;
+    }
+    create(document, id, requestUrl) {
+        const options = {};
+        const cell = new propertyTreeExt_1.DeflatedPropertyTree(id, document, this.attributes, options, { encDec });
+        cell.initializeLocal();
+        return cell;
+    }
+}
+exports.DeflatedPropertyTreeFactory = DeflatedPropertyTreeFactory;
+DeflatedPropertyTreeFactory.Type = "DeflatedPropertyTree:84534a0fe613522101f6";
+DeflatedPropertyTreeFactory.Attributes = {
+    type: DeflatedPropertyTreeFactory.Type,
+    snapshotFormatVersion: "0.1",
+    packageVersion: "0.0.1",
+};
+//# sourceMappingURL=propertyTreeExtFactories.js.map

package/dist/propertyTreeExtFactories.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"propertyTreeExtFactories.js","sourceRoot":"","sources":["../src/propertyTreeExtFactories.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+BAAwC;AACxC,+DAA8E;AAS9E,uDAAyD;AAEzD,SAAS,aAAa,CAAC,eAAiC;IACpD,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IACnD,MAAM,QAAQ,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACtD,MAAM,iBAAiB,GAAW,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC;IACpD,OAAO,iBAAiB,CAAC;AAC7B,CAAC;AAED,SAAS,aAAa,CAAC,iBAAiB;IACpC,MAAM,QAAQ,GAAG,IAAA,cAAO,EAAC,iBAAiB,CAAC,CAAC;IAC5C,MAAM,UAAU,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACtD,MAAM,eAAe,GAAqB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACjE,OAAO,eAAe,CAAC;AAC3B,CAAC;AAED,SAAS,aAAa,CAAC,MAA4B;IAC/C,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACtD,MAAM,QAAQ,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IACxD,MAAM,MAAM,GAAW,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC;IACzC,MAAM,SAAS,GAAG,IAAA,6BAAc,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACnD,IAAI,SAAS,CAAC,MAAM,GAAG,YAAY,CAAC,MAAM,EAAE;QACxC,2DAA2D;QAC3D,MAAM,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC;QACzB,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;KAChC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,SAAS,aAAa,CAAC,cAAoC;IACvD,2DAA2D;IAC3D,IAAI,cAAc,CAAC,UAAU,CAAC,EAAE;QAC5B,MAAM,MAAM,GAAG,IAAA,6BAAc,EAAC,cAAc,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAClE,MAAM,QAAQ,GAAG,IAAA,cAAO,EAAC,MAAM,CAAC,CAAC;QACjC,MAAM,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACxD,cAAc,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;KACvD;IACD,OAAO,cAAc,CAAC;AAC1B,CAAC;AAED,MAAM,MAAM,GAA8B;IACtC,cAAc,EAAE;QACZ,MAAM,EAAE,aAAa;QACrB,MAAM,EAAE,aAAa;KACxB;IACD,cAAc,EAAE;QACZ,MAAM,EAAE,aAAa;QACrB,MAAM,EAAE,aAAa;KACxB;CACJ,CAAC;AAEF,MAAa,2BAA2B;IASpC,IAAW,IAAI;QACX,OAAO,2BAA2B,CAAC,IAAI,CAAC;IAC5C,CAAC;IAED,IAAW,UAAU;QACjB,OAAO,2BAA2B,CAAC,UAAU,CAAC;IAClD,CAAC;IAEM,KAAK,CAAC,IAAI,CACb,OAA+B,EAC/B,EAAU,EACV,QAA0B,EAC1B,UAA8B,EAC9B,GAAY;QAEZ,MAAM,OAAO,GAAG,EAAE,CAAC;QACnB,MAAM,QAAQ,GAAG,IAAI,sCAAoB,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,OAAoC,EACjG,EAAE,MAAM,EAAE,CAAC,CAAC;QAClB,MAAM,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9B,OAAO,QAAQ,CAAC;IACpB,CAAC;IAEM,MAAM,CAAC,QAAgC,EAAE,EAAU,EAAE,UAAmB;QAC3E,MAAM,OAAO,GAAG,EAAE,CAAC;QACnB,MAAM,IAAI,GAAG,IAAI,sCAAoB,CAAC,EAAE,EAAE,QAAQ,EAC9C,IAAI,CAAC,UAAU,EAAE,OAAoC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QACvE,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC;IAChB,CAAC;;AArCL,kEAsCC;AArC0B,gCAAI,GAAG,2CAA2C,CAAC;AAEnD,sCAAU,GAAuB;IACpD,IAAI,EAAE,2BAA2B,CAAC,IAAI;IACtC,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,OAAO;CAC1B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { deflate, inflate } from \"pako\";\nimport { bufferToString, stringToBuffer } from \"@fluidframework/common-utils\";\nimport {\n    IChannelAttributes,\n    IFluidDataStoreRuntime,\n    IChannelServices,\n    IChannelFactory,\n} from \"@fluidframework/datastore-definitions\";\nimport { IPropertyTreeMessage, ISharedPropertyTreeEncDec, ISnapshotSummary, SharedPropertyTreeOptions }\nfrom \"./propertyTree\";\nimport { DeflatedPropertyTree } from \"./propertyTreeExt\";\n\nfunction encodeSummary(snapshotSummary: ISnapshotSummary) {\n    const summaryStr = JSON.stringify(snapshotSummary);\n    const unzipped = new TextEncoder().encode(summaryStr);\n    const serializedSummary: Buffer = deflate(unzipped);\n    return serializedSummary;\n}\n\nfunction decodeSummary(serializedSummary): ISnapshotSummary {\n    const unzipped = inflate(serializedSummary);\n    const summaryStr = new TextDecoder().decode(unzipped);\n    const snapshotSummary: ISnapshotSummary = JSON.parse(summaryStr);\n    return snapshotSummary;\n}\n\nfunction encodeMessage(change: IPropertyTreeMessage) {\n    const changeSetStr = JSON.stringify(change.changeSet);\n    const unzipped = new TextEncoder().encode(changeSetStr);\n    const zipped: Buffer = deflate(unzipped);\n    const zippedStr = bufferToString(zipped, \"base64\");\n    if (zippedStr.length < changeSetStr.length) {\n        // eslint-disable-next-line @typescript-eslint/dot-notation\n        change[\"isZipped\"] = \"1\";\n        change.changeSet = zippedStr;\n    }\n    return change;\n}\n\nfunction decodeMessage(transferChange: IPropertyTreeMessage) {\n    // eslint-disable-next-line @typescript-eslint/dot-notation\n    if (transferChange[\"isZipped\"]) {\n        const zipped = stringToBuffer(transferChange.changeSet, \"base64\");\n        const unzipped = inflate(zipped);\n        const changeSetStr = new TextDecoder().decode(unzipped);\n        transferChange.changeSet = JSON.parse(changeSetStr);\n    }\n    return transferChange;\n}\n\nconst encDec: ISharedPropertyTreeEncDec = {\n    messageEncoder: {\n        encode: encodeMessage,\n        decode: decodeMessage,\n    },\n    summaryEncoder: {\n        encode: encodeSummary,\n        decode: decodeSummary,\n    },\n};\n\nexport class DeflatedPropertyTreeFactory implements IChannelFactory {\n    public static readonly Type = \"DeflatedPropertyTree:84534a0fe613522101f6\";\n\n    public static readonly Attributes: IChannelAttributes = {\n        type: DeflatedPropertyTreeFactory.Type,\n        snapshotFormatVersion: \"0.1\",\n        packageVersion: \"0.0.1\",\n    };\n\n    public get type() {\n        return DeflatedPropertyTreeFactory.Type;\n    }\n\n    public get attributes() {\n        return DeflatedPropertyTreeFactory.Attributes;\n    }\n\n    public async load(\n        runtime: IFluidDataStoreRuntime,\n        id: string,\n        services: IChannelServices,\n        attributes: IChannelAttributes,\n        url?: string,\n    ): Promise<DeflatedPropertyTree> {\n        const options = {};\n        const instance = new DeflatedPropertyTree(id, runtime, attributes, options as SharedPropertyTreeOptions\n            , { encDec });\n        await instance.load(services);\n        return instance;\n    }\n\n    public create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): DeflatedPropertyTree {\n        const options = {};\n        const cell = new DeflatedPropertyTree(id, document,\n            this.attributes, options as SharedPropertyTreeOptions, { encDec });\n        cell.initializeLocal();\n        return cell;\n    }\n}\n"]}

package/lib/index.d.ts

@@ -4,4 +4,6 @@
  */
 export * from "./propertyTree";
 export * from "./propertyTreeFactory";
+export * from "./propertyTreeExt";
+export * from "./propertyTreeExtFactories";
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC"}

package/lib/index.js

@@ -4,4 +4,6 @@
  */
 export * from "./propertyTree";
 export * from "./propertyTreeFactory";
+export * from "./propertyTreeExt";
+export * from "./propertyTreeExtFactories";
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./propertyTree\";\nexport * from \"./propertyTreeFactory\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./propertyTree\";\nexport * from \"./propertyTreeFactory\";\nexport * from \"./propertyTreeExt\";\nexport * from \"./propertyTreeExtFactories\";\n"]}

package/lib/propertyTree.d.ts

@@ -2,6 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+/// <reference types="node" />
 import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 import { IChannelAttributes, IFluidDataStoreRuntime, IChannelStorageService, IChannelFactory } from "@fluidframework/datastore-definitions";
 import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
@@ -26,11 +27,29 @@ export interface IPropertyTreeMessage {
 export interface IRemotePropertyTreeMessage extends IPropertyTreeMessage {
     sequenceNumber: number;
 }
+export interface ISnapshotSummary {
+    remoteTipView?: SerializedChangeSet;
+    remoteChanges?: IPropertyTreeMessage[];
+    unrebasedRemoteChanges?: Record<string, IRemotePropertyTreeMessage>;
+}
 export interface SharedPropertyTreeOptions {
     paths?: string[];
     clientFiltering?: boolean;
     useMH?: boolean;
 }
+export interface ISharedPropertyTreeEncDec {
+    messageEncoder: {
+        encode: (IPropertyTreeMessage: any) => IPropertyTreeMessage;
+        decode: (IPropertyTreeMessage: any) => IPropertyTreeMessage;
+    };
+    summaryEncoder: {
+        encode: (ISnapshotSummary: any) => Buffer;
+        decode: (Buffer: any) => ISnapshotSummary;
+    };
+}
+export interface IPropertyTreeConfig {
+    encDec: ISharedPropertyTreeEncDec;
+}
 /**
  * Silly DDS example that models a six sided die.
  *
@@ -57,7 +76,8 @@ export declare class SharedPropertyTree extends SharedObject {
     skipSequenceNumber: number;
     headCommitGuid: string;
     useMH: boolean;
-    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, options: SharedPropertyTreeOptions);
+    propertyTreeConfig: IPropertyTreeConfig;
+    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, options: SharedPropertyTreeOptions, propertyTreeConfig?: IPropertyTreeConfig);
     /**
      * Create a new shared cell
      *
@@ -82,6 +102,16 @@ export declare class SharedPropertyTree extends SharedObject {
     get activeCommit(): IPropertyTreeMessage;
     get root(): NodeProperty;
     commit(metadata?: Metadata, submitEmptyChange?: boolean): void;
+    /**
+     * This method encodes the given message to the transfer form
+     * @param change - The message to be encoded.
+     */
+    private encodeMessage;
+    /**
+     * This method decodes message from the transfer form.
+     * @param transferChange - The message to be decoded.
+         */
+    private decodeMessage;
     private applyChangeSet;
     stopTransmission(stop: boolean): void;
     /**
@@ -109,6 +139,38 @@ export declare class SharedPropertyTree extends SharedObject {
         prunedCount: number;
     };
     pruneHistory(): void;
+    /**
+     * This method encodes the local summary (snapshot) object into the serialized form.
+     * @param summary - The local summary (snapshot)representation.
+     * @returns The serialized summary representation.
+     */
+    private encodeSummary;
+    /**
+     * This method decodes the serialized form of the summary into the local summary (snapshot) object.
+     * @param serializedSummary - The serialized summary representation.
+     * @returns The local summary (snapshot)representation.
+     */
+    private decodeSummary;
+    /**
+     * This method writes the log message if the logging is enabled in the extended DDS.
+     * The logging is not enabled in the default Property DDS
+     * @param message - The message to be logged.
+     */
+    protected logIfEnabled(message: any): void;
+    /**
+     * This method encodes the binary representation of the
+     * blob.
+     * @param blob - The binary representation of the blob.
+     * @returns The encoded representation of the blob.
+     */
+    private encodeSummaryBlob;
+    /**
+     * This method decodes the encoded representation of the
+     * blob.
+     * @param blob - The encoded representation of the blob.
+     * @returns The binary representation of the blob.
+     */
+    private decodeSummaryBlob;
     summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
     protected loadCore(storage: IChannelStorageService): Promise<void>;
     protected onDisconnect(): void;

package/lib/propertyTree.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"propertyTree.d.ts","sourceRoot":"","sources":["../src/propertyTree.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH,OAAO,EAAE,yBAAyB,EAAe,MAAM,sCAAsC,CAAC;AAC9F,OAAO,EACN,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,eAAe,EACf,MAAM,uCAAuC,CAAC;AAG/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AASpF,OAAO,EAAiC,YAAY,EAAE,MAAM,yCAAyC,CAAC;AAMtG,oBAAY,mBAAmB,GAAG,GAAG,CAAC;AAEtC,oBAAY,QAAQ,GAAG,GAAG,CAAC;AAK3B,0BAAkB,MAAM;IAEvB,SAAS,IAAI;CACb;AAED,MAAM,WAAW,oBAAoB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,mBAAmB,CAAC;IAC/B,QAAQ,EAAE,QAAQ,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,qBAAqB,CAAC,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACtC,KAAK,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,0BAA2B,SAAQ,oBAAoB;IACvE,cAAc,EAAE,MAAM,CAAC;CACvB;AAaD,MAAM,WAAW,yBAAyB;IACzC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,KAAK,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,kBAAmB,SAAQ,YAAY;IACnD,OAAO,EAAE,mBAAmB,CAAM;IAClC,aAAa,EAAE,mBAAmB,CAAM;IACxC,YAAY,EAAE,oBAAoB,EAAE,CAAM;IAC1C,aAAa,EAAE,oBAAoB,EAAE,CAAM;IAC3C,sBAAsB,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAM;IACxE,4BAA4B,UAAS;IACrC,gBAAgB,EAAE,oBAAoB,EAAE,CAAM;IAC9C,sBAAsB,EAAE,MAAM,CAAK;IACnC,KAAK,EAAE,GAAG,CAA0C;IACpD,OAAO,EAAE,yBAAyB,CAAC;IACnC,kBAAkB,EAAE,MAAM,CAAM;IAChC,cAAc,EAAE,MAAM,CAAM;IAC5B,KAAK,EAAE,OAAO,CAAS;gBAGtB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB,EAC9B,OAAO,EAAE,yBAAyB;IAYnC;;;;;;OAMG;WACW,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;IAIvF;;;;OAIG;WACW,UAAU,IAAI,eAAe;IAI3C;;OAEG;IACH,SAAS,CAAC,SAAS;IAMnB,OAAO,CAAC,wBAAwB;IAKzB,sBAAsB;IAe7B,IAAW,SAAS,IAAI,mBAAmB,CAG1C;IAED,IAAW,YAAY,IAAI,oBAAoB,CAI9C;IACD,IAAW,IAAI,IAAI,YAAY,CAE9B;IAEM,MAAM,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,iBAAiB,CAAC,EAAE,OAAO;IAgB9D,OAAO,CAAC,cAAc;IA6BtB,gBAAgB,CAAC,IAAI,EAAE,OAAO;IAS9B;;;OAGG;IACI,0BAA0B;IAUjC;;;OAGG;IACI,yBAAyB;IAQhC;;;;;;;OAOG;IACH,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;WAepF,KAAK,CAClB,qBAAqB,EAAE,MAAM,EAC7B,aAAa,EAAE,oBAAoB,EAAE,EACrC,sBAAsB,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC;;;;;IA+E5D,YAAY;IAYZ,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;cAmCzD,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IA2HxE,SAAS,CAAC,YAAY;IAEtB,OAAO,CAAC,oBAAoB;IAY5B,OAAO,CAAC,qBAAqB;IAsC7B,kBAAkB,CAAC,IAAI,EAAE,MAAM;IAI/B,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM;IASrD,OAAO,CAAC,kBAAkB;IAwE1B,SAAS,CAAC,cAAc;CAGxB"}
+{"version":3,"file":"propertyTree.d.ts","sourceRoot":"","sources":["../src/propertyTree.ts"],"names":[],"mappings":"AAAA;;;GAGG;;AAUH,OAAO,EAAE,yBAAyB,EAAe,MAAM,sCAAsC,CAAC;AAC9F,OAAO,EACN,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,eAAe,EACf,MAAM,uCAAuC,CAAC;AAG/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AASpF,OAAO,EAAiC,YAAY,EAAE,MAAM,yCAAyC,CAAC;AAMtG,oBAAY,mBAAmB,GAAG,GAAG,CAAC;AAEtC,oBAAY,QAAQ,GAAG,GAAG,CAAC;AAK3B,0BAAkB,MAAM;IAEvB,SAAS,IAAI;CACb;AAED,MAAM,WAAW,oBAAoB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,mBAAmB,CAAC;IAC/B,QAAQ,EAAE,QAAQ,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,qBAAqB,CAAC,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACtC,KAAK,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,0BAA2B,SAAQ,oBAAoB;IACvE,cAAc,EAAE,MAAM,CAAC;CACvB;AAOD,MAAM,WAAW,gBAAgB;IAChC,aAAa,CAAC,EAAE,mBAAmB,CAAC;IACpC,aAAa,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACvC,sBAAsB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;CACpE;AAED,MAAM,WAAW,yBAAyB;IACzC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,KAAK,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,yBAAyB;IACzC,cAAc,EAAE;QAAE,MAAM,EAAE,CAAC,oBAAoB,KAAA,KAAK,oBAAoB,CAAC;QACxE,MAAM,EAAE,CAAC,oBAAoB,KAAA,KAAK,oBAAoB,CAAC;KAAE,CAAC;IAC3D,cAAc,EAAE;QAAE,MAAM,EAAE,CAAC,gBAAgB,KAAA,KAAK,MAAM,CAAC;QAAC,MAAM,EAAE,CAAC,MAAM,KAAA,KAAK,gBAAgB,CAAC;KAAE,CAAC;CAChG;AAED,MAAM,WAAW,mBAAmB;IACnC,MAAM,EAAE,yBAAyB,CAAC;CAClC;AAmBD;;;;;;;;;;;GAWG;AACH,qBAAa,kBAAmB,SAAQ,YAAY;IACnD,OAAO,EAAE,mBAAmB,CAAM;IAClC,aAAa,EAAE,mBAAmB,CAAM;IACxC,YAAY,EAAE,oBAAoB,EAAE,CAAM;IAC1C,aAAa,EAAE,oBAAoB,EAAE,CAAM;IAC3C,sBAAsB,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAM;IACxE,4BAA4B,UAAS;IACrC,gBAAgB,EAAE,oBAAoB,EAAE,CAAM;IAC9C,sBAAsB,EAAE,MAAM,CAAK;IACnC,KAAK,EAAE,GAAG,CAA0C;IACpD,OAAO,EAAE,yBAAyB,CAAC;IACnC,kBAAkB,EAAE,MAAM,CAAM;IAChC,cAAc,EAAE,MAAM,CAAM;IAC5B,KAAK,EAAE,OAAO,CAAS;IACvB,kBAAkB,EAAE,mBAAmB,CAAC;gBAGvC,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB,EAC9B,OAAO,EAAE,yBAAyB,EAClC,kBAAkB,GAAE,mBAA+C;IAapE;;;;;;OAMG;WACW,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;IAIvF;;;;OAIG;WACW,UAAU,IAAI,eAAe;IAI3C;;OAEG;IACH,SAAS,CAAC,SAAS;IAMnB,OAAO,CAAC,wBAAwB;IAKzB,sBAAsB;IAe7B,IAAW,SAAS,IAAI,mBAAmB,CAG1C;IAED,IAAW,YAAY,IAAI,oBAAoB,CAI9C;IACD,IAAW,IAAI,IAAI,YAAY,CAE9B;IAEM,MAAM,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,iBAAiB,CAAC,EAAE,OAAO;IAgB9D;;;OAGI;IACJ,OAAO,CAAC,aAAa;IAIrB;;;WAGQ;IACR,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,cAAc;IA6BtB,gBAAgB,CAAC,IAAI,EAAE,OAAO;IAS9B;;;OAGG;IACI,0BAA0B;IAUjC;;;OAGG;IACI,yBAAyB;IAQhC;;;;;;;OAOG;IACH,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;WAgBpF,KAAK,CAClB,qBAAqB,EAAE,MAAM,EAC7B,aAAa,EAAE,oBAAoB,EAAE,EACrC,sBAAsB,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC;;;;;IA+E5D,YAAY;IAanB;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAIrB;;;;OAII;IACJ,OAAO,CAAC,aAAa;IAIrB;;;;OAIG;IACH,SAAS,CAAC,YAAY,CAAC,OAAO,KAAA;IAE9B;;;;;OAKI;IACJ,OAAO,CAAC,iBAAiB;IAIzB;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAKlB,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;cAqCzD,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAwHxE,SAAS,CAAC,YAAY;IAEtB,OAAO,CAAC,oBAAoB;IAY5B,OAAO,CAAC,qBAAqB;IAsC7B,kBAAkB,CAAC,IAAI,EAAE,MAAM;IAI/B,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM;IASrD,OAAO,CAAC,kBAAkB;IAwE1B,SAAS,CAAC,cAAc;CAGxB"}

package/lib/propertyTree.js

@@ -18,6 +18,22 @@ import { PropertyFactory, BaseProperty } from "@fluid-experimental/property-prop
 import { v4 as uuidv4 } from "uuid";
 import axios from "axios";
 import { PropertyTreeFactory } from "./propertyTreeFactory";
+const defaultEncDec = {
+    messageEncoder: { encode: (msg) => msg,
+        decode: (msg) => msg },
+    summaryEncoder: {
+        encode: (summary) => {
+            const packr = new Packr();
+            const serializedSummary = packr.pack(summary);
+            return serializedSummary;
+        },
+        decode: (serializedSummary) => {
+            const packr = new Packr();
+            const snapshotSummary = packr.unpack(serializedSummary);
+            return snapshotSummary;
+        },
+    },
+};
 /**
  * Silly DDS example that models a six sided die.
  *
@@ -31,7 +47,7 @@ import { PropertyTreeFactory } from "./propertyTreeFactory";
  * in the total order)
  */
 export class SharedPropertyTree extends SharedObject {
-    constructor(id, runtime, attributes, options) {
+    constructor(id, runtime, attributes, options, propertyTreeConfig = { encDec: defaultEncDec }) {
         var _a;
         super(id, runtime, attributes, "fluid_propertyTree_");
         this.tipView = {};
@@ -51,6 +67,7 @@ export class SharedPropertyTree extends SharedObject {
         this._root._tree = this;
         // By default, we currently don't use the MH
         this.useMH = (_a = options.useMH) !== null && _a !== void 0 ? _a : false;
+        this.propertyTreeConfig = propertyTreeConfig;
     }
     /**
      * Create a new shared cell
@@ -121,6 +138,20 @@ export class SharedPropertyTree extends SharedObject {
             this.root.cleanDirty();
         }
     }
+    /**
+     * This method encodes the given message to the transfer form
+     * @param change - The message to be encoded.
+     */
+    encodeMessage(change) {
+        return this.propertyTreeConfig.encDec.messageEncoder.encode(change);
+    }
+    /**
+     * This method decodes message from the transfer form.
+     * @param transferChange - The message to be decoded.
+         */
+    decodeMessage(transferChange) {
+        return this.propertyTreeConfig.encDec.messageEncoder.decode(transferChange);
+    }
     applyChangeSet(changeSet, metadata) {
         const _changeSet = new ChangeSet(changeSet);
         _changeSet._toReversibleChangeSet(this.tipView);
@@ -139,11 +170,12 @@ export class SharedPropertyTree extends SharedObject {
         };
         this._applyLocalChangeSet(change);
         // Queue the op for transmission to the Fluid service.
+        const transferChange = this.encodeMessage(cloneDeep(change));
         if (this.transmissionsHaveBeenStopped) {
-            this.enqueuedMessages.push(cloneDeep(change));
+            this.enqueuedMessages.push(transferChange);
         }
         else {
-            this.submitLocalMessage(cloneDeep(change));
+            this.submitLocalMessage(transferChange);
         }
     }
     stopTransmission(stop) {
@@ -188,7 +220,8 @@ export class SharedPropertyTree extends SharedObject {
      */
     processCore(message, local, localOpMetadata) {
         if (message.type === MessageType.Operation && message.sequenceNumber > this.skipSequenceNumber) {
-            const content = Object.assign(Object.assign({}, message.contents), { sequenceNumber: message.sequenceNumber });
+            const change = this.decodeMessage(cloneDeep(message.contents));
+            const content = Object.assign(Object.assign({}, change), { sequenceNumber: message.sequenceNumber });
             switch (content.op) {
                 case 0 /* ChangeSet */:
                     // If the op originated locally from this client, we've already accounted for it
@@ -272,6 +305,47 @@ export class SharedPropertyTree extends SharedObject {
         this.remoteChanges = remoteChanges;
         this.unrebasedRemoteChanges = unrebasedRemoteChanges;
     }
+    /**
+     * This method encodes the local summary (snapshot) object into the serialized form.
+     * @param summary - The local summary (snapshot)representation.
+     * @returns The serialized summary representation.
+     */
+    encodeSummary(summary) {
+        return this.propertyTreeConfig.encDec.summaryEncoder.encode(summary);
+    }
+    /**
+     * This method decodes the serialized form of the summary into the local summary (snapshot) object.
+     * @param serializedSummary - The serialized summary representation.
+     * @returns The local summary (snapshot)representation.
+     */
+    decodeSummary(serializedSummary) {
+        return this.propertyTreeConfig.encDec.summaryEncoder.decode(serializedSummary);
+    }
+    /**
+     * This method writes the log message if the logging is enabled in the extended DDS.
+     * The logging is not enabled in the default Property DDS
+     * @param message - The message to be logged.
+     */
+    logIfEnabled(message) { }
+    /**
+     * This method encodes the binary representation of the
+     * blob.
+     * @param blob - The binary representation of the blob.
+     * @returns The encoded representation of the blob.
+     */
+    encodeSummaryBlob(blob) {
+        return bufferToString(blob, "base64");
+    }
+    /**
+     * This method decodes the encoded representation of the
+     * blob.
+     * @param blob - The encoded representation of the blob.
+     * @returns The binary representation of the blob.
+     */
+    decodeSummaryBlob(encoded) {
+        const buffer = bufferToString(encoded, "utf8");
+        return stringToBuffer(buffer, "base64");
+    }
     summarizeCore(serializer) {
         this.pruneHistory();
         const snapshot = {
@@ -290,12 +364,16 @@ export class SharedPropertyTree extends SharedObject {
                 unrebasedRemoteChanges: this.unrebasedRemoteChanges,
             };
             const chunkSize = 5000 * 1024; // Default limit seems to be 5MB
-            const packr = new Packr();
-            const serializedSummary = packr.pack(summary);
+            let totalBlobsSize = 0;
+            const serializedSummary = this.encodeSummary(summary);
             for (let pos = 0, i = 0; pos < serializedSummary.length; pos += chunkSize, i++) {
-                builder.addBlob(`summaryChunk_${i}`, bufferToString(serializedSummary.slice(pos, pos + chunkSize), "base64"));
+                const summaryBlob = this.encodeSummaryBlob(serializedSummary.slice(pos, pos + chunkSize));
+                // eslint-disable-next-line @typescript-eslint/dot-notation
+                totalBlobsSize += summaryBlob["length"];
+                builder.addBlob(`summaryChunk_${i}`, summaryBlob);
                 snapshot.numChunks++;
             }
+            this.logIfEnabled(`Total blobs transfer size: ${totalBlobsSize}`);
         }
         builder.addBlob("properties", serializer !== undefined
             ? serializer.stringify(snapshot, this.handle)
@@ -312,8 +390,7 @@ export class SharedPropertyTree extends SharedObject {
             if (!snapshot.useMH) {
                 // We load all chunks
                 const chunks = await Promise.all(range(snapshot.numChunks).map(async (i) => {
-                    const buffer = bufferToString(await storage.readBlob(`summaryChunk_${i}`), "utf8");
-                    return stringToBuffer(buffer, "base64");
+                    return this.decodeSummaryBlob(await storage.readBlob(`summaryChunk_${i}`));
                 }));
                 const totalLength = chunks.reduce((a, b) => a + b.byteLength, 0);
                 const serializedSummary = new Uint8Array(totalLength);
@@ -321,8 +398,7 @@ export class SharedPropertyTree extends SharedObject {
                     serializedSummary.set(new Uint8Array(chunk), offset);
                     return offset + chunk.byteLength;
                 }, 0);
-                const packr = new Packr();
-                const snapshotSummary = packr.unpack(serializedSummary);
+                const snapshotSummary = this.decodeSummary(serializedSummary);
                 if (snapshotSummary.remoteChanges === undefined ||
                     snapshotSummary.remoteTipView === undefined ||
                     snapshotSummary.unrebasedRemoteChanges === undefined) {