@fluid-experimental/property-dds 1.2.6 → 2.0.0-dev.1.3.0.96595

package/dist/propertyTreeExt.d.ts

@@ -12,4 +12,8 @@ export declare class DeflatedPropertyTree extends SharedPropertyTree {
     static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string): DeflatedPropertyTree;
     static getFactory(): IChannelFactory;
 }
+export declare class LZ4PropertyTree extends SharedPropertyTree {
+    static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string): LZ4PropertyTree;
+    static getFactory(): IChannelFactory;
+}
 //# sourceMappingURL=propertyTreeExt.d.ts.map

package/dist/propertyTreeExt.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"propertyTreeExt.d.ts","sourceRoot":"","sources":["../src/propertyTreeExt.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAChG,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAGpD;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,kBAAkB;WAC1C,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;WAIzE,UAAU,IAAI,eAAe;CAG9C"}
+{"version":3,"file":"propertyTreeExt.d.ts","sourceRoot":"","sources":["../src/propertyTreeExt.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAChG,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAGpD;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,kBAAkB;WAC1C,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;WAIzE,UAAU,IAAI,eAAe;CAG9C;AAED,qBAAa,eAAgB,SAAQ,kBAAkB;WACrC,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;WAIzE,UAAU,IAAI,eAAe;CAG9C"}

package/dist/propertyTreeExt.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DeflatedPropertyTree = void 0;
+exports.LZ4PropertyTree = exports.DeflatedPropertyTree = void 0;
 const propertyTree_1 = require("./propertyTree");
 const propertyTreeExtFactories_1 = require("./propertyTreeExtFactories");
 /**
@@ -20,4 +20,13 @@ class DeflatedPropertyTree extends propertyTree_1.SharedPropertyTree {
     }
 }
 exports.DeflatedPropertyTree = DeflatedPropertyTree;
+class LZ4PropertyTree extends propertyTree_1.SharedPropertyTree {
+    static create(runtime, id, queryString) {
+        return runtime.createChannel(id, propertyTreeExtFactories_1.LZ4PropertyTreeFactory.Type);
+    }
+    static getFactory() {
+        return new propertyTreeExtFactories_1.LZ4PropertyTreeFactory();
+    }
+}
+exports.LZ4PropertyTree = LZ4PropertyTree;
 //# sourceMappingURL=propertyTreeExt.js.map

package/dist/propertyTreeExt.js.map

@@ -1 +1 @@
-{"version":3,"file":"propertyTreeExt.js","sourceRoot":"","sources":["../src/propertyTreeExt.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,iDAAoD;AACpD,yEAAyE;AAEzE;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,iCAAkB;IACjD,MAAM,CAAC,MAAM,CAAC,OAA+B,EAAE,EAAW,EAAE,WAAoB;QACnF,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,sDAA2B,CAAC,IAAI,CAAyB,CAAC;IAC/F,CAAC;IAEM,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,sDAA2B,EAAE,CAAC;IAC7C,CAAC;CACJ;AARD,oDAQC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IChannelFactory, IFluidDataStoreRuntime } from \"@fluidframework/datastore-definitions\";\nimport { SharedPropertyTree } from \"./propertyTree\";\nimport { DeflatedPropertyTreeFactory } from \"./propertyTreeExtFactories\";\n\n/**\n * This class is the extension of SharedPropertyTree which compresses\n * the deltas and summaries communicated to the server by Deflate.\n */\nexport class DeflatedPropertyTree extends SharedPropertyTree {\n    public static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string) {\n        return runtime.createChannel(id, DeflatedPropertyTreeFactory.Type) as DeflatedPropertyTree;\n    }\n\n    public static getFactory(): IChannelFactory {\n        return new DeflatedPropertyTreeFactory();\n    }\n}\n"]}
+{"version":3,"file":"propertyTreeExt.js","sourceRoot":"","sources":["../src/propertyTreeExt.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,iDAAoD;AACpD,yEAAiG;AAEjG;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,iCAAkB;IACjD,MAAM,CAAC,MAAM,CAAC,OAA+B,EAAE,EAAW,EAAE,WAAoB;QACnF,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,sDAA2B,CAAC,IAAI,CAAyB,CAAC;IAC/F,CAAC;IAEM,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,sDAA2B,EAAE,CAAC;IAC7C,CAAC;CACJ;AARD,oDAQC;AAED,MAAa,eAAgB,SAAQ,iCAAkB;IAC5C,MAAM,CAAC,MAAM,CAAC,OAA+B,EAAE,EAAW,EAAE,WAAoB;QACnF,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,iDAAsB,CAAC,IAAI,CAAoB,CAAC;IACrF,CAAC;IAEM,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,iDAAsB,EAAE,CAAC;IACxC,CAAC;CACJ;AARD,0CAQC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IChannelFactory, IFluidDataStoreRuntime } from \"@fluidframework/datastore-definitions\";\nimport { SharedPropertyTree } from \"./propertyTree\";\nimport { DeflatedPropertyTreeFactory, LZ4PropertyTreeFactory } from \"./propertyTreeExtFactories\";\n\n/**\n * This class is the extension of SharedPropertyTree which compresses\n * the deltas and summaries communicated to the server by Deflate.\n */\nexport class DeflatedPropertyTree extends SharedPropertyTree {\n    public static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string) {\n        return runtime.createChannel(id, DeflatedPropertyTreeFactory.Type) as DeflatedPropertyTree;\n    }\n\n    public static getFactory(): IChannelFactory {\n        return new DeflatedPropertyTreeFactory();\n    }\n}\n\nexport class LZ4PropertyTree extends SharedPropertyTree {\n    public static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string) {\n        return runtime.createChannel(id, LZ4PropertyTreeFactory.Type) as LZ4PropertyTree;\n    }\n\n    public static getFactory(): IChannelFactory {\n        return new LZ4PropertyTreeFactory();\n    }\n}\n"]}

package/dist/propertyTreeExtFactories.d.ts

@@ -1,11 +1,37 @@
 import { IChannelAttributes, IFluidDataStoreRuntime, IChannelServices, IChannelFactory } from "@fluidframework/datastore-definitions";
-import { DeflatedPropertyTree } from "./propertyTreeExt";
-export declare class DeflatedPropertyTreeFactory implements IChannelFactory {
+import { IPropertyTreeConfig, ISharedPropertyTreeEncDec, SharedPropertyTree, SharedPropertyTreeOptions } from "./propertyTree";
+import { DeflatedPropertyTree, LZ4PropertyTree } from "./propertyTreeExt";
+export declare abstract class CompressedPropertyTreeFactory implements IChannelFactory {
+    abstract get attributes(): any;
+    abstract get type(): any;
+    abstract getEncodeFce(): any;
+    abstract getDecodeFce(): any;
+    private createCompressionMethods;
+    getEncDec(): ISharedPropertyTreeEncDec;
+    abstract newPropertyTree(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, options: SharedPropertyTreeOptions, propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree;
+    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes, url?: string): Promise<SharedPropertyTree>;
+    create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): SharedPropertyTree;
+}
+export declare class DeflatedPropertyTreeFactory extends CompressedPropertyTreeFactory {
     static readonly Type = "DeflatedPropertyTree:84534a0fe613522101f6";
     static readonly Attributes: IChannelAttributes;
-    get type(): string;
-    get attributes(): IChannelAttributes;
     load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes, url?: string): Promise<DeflatedPropertyTree>;
     create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): DeflatedPropertyTree;
+    get type(): string;
+    get attributes(): IChannelAttributes;
+    getEncodeFce(): any;
+    getDecodeFce(): any;
+    newPropertyTree(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, options: SharedPropertyTreeOptions, propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree;
+}
+export declare class LZ4PropertyTreeFactory extends CompressedPropertyTreeFactory {
+    static readonly Type = "LZ4PropertyTree:84534a0fe613522101f6";
+    static readonly Attributes: IChannelAttributes;
+    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes, url?: string): Promise<LZ4PropertyTree>;
+    create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): LZ4PropertyTree;
+    get type(): string;
+    get attributes(): IChannelAttributes;
+    getEncodeFce(): any;
+    getDecodeFce(): any;
+    newPropertyTree(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, options: SharedPropertyTreeOptions, propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree;
 }
 //# sourceMappingURL=propertyTreeExtFactories.d.ts.map

package/dist/propertyTreeExtFactories.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"propertyTreeExtFactories.d.ts","sourceRoot":"","sources":["../src/propertyTreeExtFactories.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,gBAAgB,EAChB,eAAe,EAClB,MAAM,uCAAuC,CAAC;AAG/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAmDzD,qBAAa,2BAA4B,YAAW,eAAe;IAC/D,gBAAuB,IAAI,+CAA+C;IAE1E,gBAAuB,UAAU,EAAE,kBAAkB,CAInD;IAEF,IAAW,IAAI,WAEd;IAED,IAAW,UAAU,uBAEpB;IAEY,IAAI,CACb,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,EAC9B,GAAG,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,oBAAoB,CAAC;IAQzB,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,oBAAoB;CAOzG"}
+{"version":3,"file":"propertyTreeExtFactories.d.ts","sourceRoot":"","sources":["../src/propertyTreeExtFactories.ts"],"names":[],"mappings":"AAQA,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,gBAAgB,EAChB,eAAe,EAClB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACH,mBAAmB,EAAwB,yBAAyB,EAClD,kBAAkB,EAAE,yBAAyB,EAClE,MACQ,gBAAgB,CAAC;AAC1B,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE1E,8BAAsB,6BAA8B,YAAW,eAAe;IAC1E,aAAoB,UAAU,QAAG;IACjC,aAAoB,IAAI,QAAG;aACX,YAAY;aACZ,YAAY;IAC5B,OAAO,CAAC,wBAAwB;IA0CzB,SAAS,IAAI,yBAAyB;aAG7B,eAAe,CAC3B,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB,EAC9B,OAAO,EAAE,yBAAyB,EAClC,kBAAkB,EAAE,mBAAmB,GAAG,kBAAkB;IAEnD,IAAI,CACb,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,EAC9B,GAAG,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,kBAAkB,CAAC;IASvB,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB;CAQvG;AAED,qBAAa,2BAA4B,SAAQ,6BAA6B;IAC1E,gBAAuB,IAAI,+CAA+C;IAE1E,gBAAuB,UAAU,EAAE,kBAAkB,CAInD;IAEW,IAAI,CACb,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,EAC9B,GAAG,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,oBAAoB,CAAC;IAIzB,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,oBAAoB;IAItG,IAAW,IAAI,WAEd;IAED,IAAW,UAAU,uBAEpB;IAEM,YAAY;IACZ,YAAY;IACZ,eAAe,CAClB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB,EAC9B,OAAO,EAAE,yBAAyB,EAClC,kBAAkB,EAAE,mBAAmB,GAAG,kBAAkB;CAGnE;AAED,qBAAa,sBAAuB,SAAQ,6BAA6B;IACrE,gBAAuB,IAAI,0CAA0C;IAErE,gBAAuB,UAAU,EAAE,kBAAkB,CAInD;IAEW,IAAI,CACb,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,EAC9B,GAAG,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,eAAe,CAAC;IAIpB,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,eAAe;IAIjG,IAAW,IAAI,WAEd;IAED,IAAW,UAAU,uBAEpB;IAEM,YAAY;IACZ,YAAY;IACZ,eAAe,CAClB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB,EAC9B,OAAO,EAAE,yBAAyB,EAClC,kBAAkB,EAAE,mBAAmB,GAAG,kBAAkB;CAGnE"}

package/dist/propertyTreeExtFactories.js

@@ -1,77 +1,94 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DeflatedPropertyTreeFactory = void 0;
+exports.LZ4PropertyTreeFactory = exports.DeflatedPropertyTreeFactory = exports.CompressedPropertyTreeFactory = void 0;
 /*!
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+/* eslint-disable @typescript-eslint/no-unsafe-return */
 const pako_1 = require("pako");
+const lz4js_1 = require("lz4js");
 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;
+class CompressedPropertyTreeFactory {
+    createCompressionMethods(encodeFn, decodeFn) {
+        return {
+            messageEncoder: {
+                encode: (change) => {
+                    const changeSetStr = JSON.stringify(change.changeSet);
+                    const unzipped = new TextEncoder().encode(changeSetStr);
+                    const zipped = encodeFn(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;
+                },
+                decode: (transferChange) => {
+                    // eslint-disable-next-line @typescript-eslint/dot-notation
+                    if (transferChange["isZipped"]) {
+                        const zipped = new Uint8Array((0, common_utils_1.stringToBuffer)(transferChange.changeSet, "base64"));
+                        const unzipped = decodeFn(zipped);
+                        const changeSetStr = new TextDecoder().decode(unzipped);
+                        transferChange.changeSet = JSON.parse(changeSetStr);
+                    }
+                    return transferChange;
+                },
+            },
+            summaryEncoder: {
+                encode: (snapshotSummary) => {
+                    const summaryStr = JSON.stringify(snapshotSummary);
+                    const unzipped = new TextEncoder().encode(summaryStr);
+                    const serializedSummary = encodeFn(unzipped);
+                    return serializedSummary;
+                },
+                decode: (serializedSummary) => {
+                    const unzipped = decodeFn(serializedSummary);
+                    const summaryStr = new TextDecoder().decode(unzipped);
+                    const snapshotSummary = JSON.parse(summaryStr);
+                    return snapshotSummary;
+                },
+            },
+        };
     }
-    get attributes() {
-        return DeflatedPropertyTreeFactory.Attributes;
+    getEncDec() {
+        return this.createCompressionMethods(this.getEncodeFce(), this.getDecodeFce());
     }
     async load(runtime, id, services, attributes, url) {
         const options = {};
-        const instance = new propertyTreeExt_1.DeflatedPropertyTree(id, runtime, attributes, options, { encDec });
+        const instance = this.newPropertyTree(id, runtime, attributes, options, { encDec: this.getEncDec() });
         await instance.load(services);
         return instance;
     }
     create(document, id, requestUrl) {
         const options = {};
-        const cell = new propertyTreeExt_1.DeflatedPropertyTree(id, document, this.attributes, options, { encDec });
+        const cell = this.newPropertyTree(id, document, this.attributes, options, { encDec: this.getEncDec() });
         cell.initializeLocal();
         return cell;
     }
 }
+exports.CompressedPropertyTreeFactory = CompressedPropertyTreeFactory;
+class DeflatedPropertyTreeFactory extends CompressedPropertyTreeFactory {
+    async load(runtime, id, services, attributes, url) {
+        return await super.load(runtime, id, services, attributes, url);
+    }
+    create(document, id, requestUrl) {
+        return super.create(document, id, requestUrl);
+    }
+    get type() {
+        return DeflatedPropertyTreeFactory.Type;
+    }
+    get attributes() {
+        return DeflatedPropertyTreeFactory.Attributes;
+    }
+    getEncodeFce() { return pako_1.deflate; }
+    getDecodeFce() { return pako_1.inflate; }
+    newPropertyTree(id, runtime, attributes, options, propertyTreeConfig) {
+        return new propertyTreeExt_1.DeflatedPropertyTree(id, runtime, attributes, options, propertyTreeConfig);
+    }
+}
 exports.DeflatedPropertyTreeFactory = DeflatedPropertyTreeFactory;
 DeflatedPropertyTreeFactory.Type = "DeflatedPropertyTree:84534a0fe613522101f6";
 DeflatedPropertyTreeFactory.Attributes = {
@@ -79,4 +96,30 @@ DeflatedPropertyTreeFactory.Attributes = {
     snapshotFormatVersion: "0.1",
     packageVersion: "0.0.1",
 };
+class LZ4PropertyTreeFactory extends CompressedPropertyTreeFactory {
+    async load(runtime, id, services, attributes, url) {
+        return await super.load(runtime, id, services, attributes, url);
+    }
+    create(document, id, requestUrl) {
+        return super.create(document, id, requestUrl);
+    }
+    get type() {
+        return LZ4PropertyTreeFactory.Type;
+    }
+    get attributes() {
+        return LZ4PropertyTreeFactory.Attributes;
+    }
+    getEncodeFce() { return lz4js_1.compress; }
+    getDecodeFce() { return lz4js_1.decompress; }
+    newPropertyTree(id, runtime, attributes, options, propertyTreeConfig) {
+        return new propertyTreeExt_1.LZ4PropertyTree(id, runtime, attributes, options, propertyTreeConfig);
+    }
+}
+exports.LZ4PropertyTreeFactory = LZ4PropertyTreeFactory;
+LZ4PropertyTreeFactory.Type = "LZ4PropertyTree:84534a0fe613522101f6";
+LZ4PropertyTreeFactory.Attributes = {
+    type: LZ4PropertyTreeFactory.Type,
+    snapshotFormatVersion: "0.1",
+    packageVersion: "0.0.1",
+};
 //# sourceMappingURL=propertyTreeExtFactories.js.map

package/dist/propertyTreeExtFactories.js.map

@@ -1 +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"]}
+{"version":3,"file":"propertyTreeExtFactories.js","sourceRoot":"","sources":["../src/propertyTreeExtFactories.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,wDAAwD;AACxD,+BAAwC;AACxC,iCAA6C;AAC7C,+DAA8E;AAY9E,uDAA0E;AAE1E,MAAsB,6BAA6B;IAKvC,wBAAwB,CAAC,QAAQ,EAAE,QAAQ;QAC/C,OAAO;YACH,cAAc,EAAE;gBACZ,MAAM,EAAE,CAAC,MAA4B,EAAE,EAAE;oBACrC,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;oBACtD,MAAM,QAAQ,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;oBACxD,MAAM,MAAM,GAAW,QAAQ,CAAC,QAAQ,CAAC,CAAC;oBAC1C,MAAM,SAAS,GAAG,IAAA,6BAAc,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;oBACnD,IAAI,SAAS,CAAC,MAAM,GAAG,YAAY,CAAC,MAAM,EAAE;wBACxC,2DAA2D;wBAC3D,MAAM,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC;wBACzB,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;qBAChC;oBACD,OAAO,MAAM,CAAC;gBAClB,CAAC;gBACD,MAAM,EAAE,CAAC,cAAoC,EAAE,EAAE;oBAC7C,2DAA2D;oBAC3D,IAAI,cAAc,CAAC,UAAU,CAAC,EAAE;wBAC5B,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,IAAA,6BAAc,EAAC,cAAc,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;wBAClF,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;wBAClC,MAAM,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;wBACxD,cAAc,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;qBACvD;oBACD,OAAO,cAAc,CAAC;gBAC1B,CAAC;aACJ;YACD,cAAc,EAAE;gBACZ,MAAM,EAAE,CAAC,eAAiC,EAAU,EAAE;oBAClD,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;oBACnD,MAAM,QAAQ,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;oBACtD,MAAM,iBAAiB,GAAW,QAAQ,CAAC,QAAQ,CAAC,CAAC;oBACrD,OAAO,iBAAiB,CAAC;gBAC7B,CAAC;gBACD,MAAM,EAAE,CAAC,iBAAiB,EAAoB,EAAE;oBAC5C,MAAM,QAAQ,GAAG,QAAQ,CAAC,iBAAiB,CAAC,CAAC;oBAC7C,MAAM,UAAU,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;oBACtD,MAAM,eAAe,GAAqB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;oBACjE,OAAO,eAAe,CAAC;gBAC3B,CAAC;aACJ;SACJ,CAAC;IACN,CAAC;IACM,SAAS;QACZ,OAAO,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;IACnF,CAAC;IAQM,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,CAAC,eAAe,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EACzD,OAAoC,EAClC,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QACpC,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,CAAC,eAAe,CAAC,EAAE,EAAE,QAAQ,EAC1C,IAAI,CAAC,UAAU,EAAE,OAAoC,EACrD,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QAClC,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAhFD,sEAgFC;AAED,MAAa,2BAA4B,SAAQ,6BAA6B;IASnE,KAAK,CAAC,IAAI,CACb,OAA+B,EAC/B,EAAU,EACV,QAA0B,EAC1B,UAA8B,EAC9B,GAAY;QAEZ,OAAO,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,CAAyB,CAAC;IAC5F,CAAC;IAEM,MAAM,CAAC,QAAgC,EAAE,EAAU,EAAE,UAAmB;QAC3E,OAAO,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;IAClD,CAAC;IAED,IAAW,IAAI;QACX,OAAO,2BAA2B,CAAC,IAAI,CAAC;IAC5C,CAAC;IAED,IAAW,UAAU;QACjB,OAAO,2BAA2B,CAAC,UAAU,CAAC;IAClD,CAAC;IAEM,YAAY,KAAK,OAAO,cAAO,CAAC,CAAC,CAAC;IAClC,YAAY,KAAK,OAAO,cAAO,CAAC,CAAC,CAAC;IAClC,eAAe,CAClB,EAAU,EACV,OAA+B,EAC/B,UAA8B,EAC9B,OAAkC,EAClC,kBAAuC;QACvC,OAAO,IAAI,sCAAoB,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAC;IAC1F,CAAC;;AAxCL,kEAyCC;AAxC0B,gCAAI,GAAG,2CAA2C,CAAC;AAEnD,sCAAU,GAAuB;IACpD,IAAI,EAAE,2BAA2B,CAAC,IAAI;IACtC,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,OAAO;CAC1B,CAAC;AAoCN,MAAa,sBAAuB,SAAQ,6BAA6B;IAS9D,KAAK,CAAC,IAAI,CACb,OAA+B,EAC/B,EAAU,EACV,QAA0B,EAC1B,UAA8B,EAC9B,GAAY;QAEZ,OAAO,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,CAAoB,CAAC;IACvF,CAAC;IAEM,MAAM,CAAC,QAAgC,EAAE,EAAU,EAAE,UAAmB;QAC3E,OAAO,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;IAClD,CAAC;IAED,IAAW,IAAI;QACX,OAAO,sBAAsB,CAAC,IAAI,CAAC;IACvC,CAAC;IAED,IAAW,UAAU;QACjB,OAAO,sBAAsB,CAAC,UAAU,CAAC;IAC7C,CAAC;IAEM,YAAY,KAAK,OAAO,gBAAQ,CAAC,CAAC,CAAC;IACnC,YAAY,KAAK,OAAO,kBAAU,CAAC,CAAC,CAAC;IACrC,eAAe,CAClB,EAAU,EACV,OAA+B,EAC/B,UAA8B,EAC9B,OAAkC,EAClC,kBAAuC;QACvC,OAAO,IAAI,iCAAe,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAC;IACrF,CAAC;;AAxCL,wDAyCC;AAxC0B,2BAAI,GAAG,sCAAsC,CAAC;AAE9C,iCAAU,GAAuB;IACpD,IAAI,EAAE,sBAAsB,CAAC,IAAI;IACjC,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 */\n/* eslint-disable @typescript-eslint/no-unsafe-return */\nimport { deflate, inflate } from \"pako\";\nimport { compress, decompress } from \"lz4js\";\nimport { bufferToString, stringToBuffer } from \"@fluidframework/common-utils\";\nimport {\n    IChannelAttributes,\n    IFluidDataStoreRuntime,\n    IChannelServices,\n    IChannelFactory,\n} from \"@fluidframework/datastore-definitions\";\nimport {\n    IPropertyTreeConfig, IPropertyTreeMessage, ISharedPropertyTreeEncDec,\n    ISnapshotSummary, SharedPropertyTree, SharedPropertyTreeOptions,\n}\n    from \"./propertyTree\";\nimport { DeflatedPropertyTree, LZ4PropertyTree } from \"./propertyTreeExt\";\n\nexport abstract class CompressedPropertyTreeFactory implements IChannelFactory {\n    public abstract get attributes();\n    public abstract get type();\n    public abstract getEncodeFce();\n    public abstract getDecodeFce();\n    private createCompressionMethods(encodeFn, decodeFn): ISharedPropertyTreeEncDec {\n        return {\n            messageEncoder: {\n                encode: (change: IPropertyTreeMessage) => {\n                    const changeSetStr = JSON.stringify(change.changeSet);\n                    const unzipped = new TextEncoder().encode(changeSetStr);\n                    const zipped: Buffer = encodeFn(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                decode: (transferChange: IPropertyTreeMessage) => {\n                    // eslint-disable-next-line @typescript-eslint/dot-notation\n                    if (transferChange[\"isZipped\"]) {\n                        const zipped = new Uint8Array(stringToBuffer(transferChange.changeSet, \"base64\"));\n                        const unzipped = decodeFn(zipped);\n                        const changeSetStr = new TextDecoder().decode(unzipped);\n                        transferChange.changeSet = JSON.parse(changeSetStr);\n                    }\n                    return transferChange;\n                },\n            },\n            summaryEncoder: {\n                encode: (snapshotSummary: ISnapshotSummary): Buffer => {\n                    const summaryStr = JSON.stringify(snapshotSummary);\n                    const unzipped = new TextEncoder().encode(summaryStr);\n                    const serializedSummary: Buffer = encodeFn(unzipped);\n                    return serializedSummary;\n                },\n                decode: (serializedSummary): ISnapshotSummary => {\n                    const unzipped = decodeFn(serializedSummary);\n                    const summaryStr = new TextDecoder().decode(unzipped);\n                    const snapshotSummary: ISnapshotSummary = JSON.parse(summaryStr);\n                    return snapshotSummary;\n                },\n            },\n        };\n    }\n    public getEncDec(): ISharedPropertyTreeEncDec {\n        return this.createCompressionMethods(this.getEncodeFce(), this.getDecodeFce());\n    }\n    public abstract newPropertyTree(\n        id: string,\n        runtime: IFluidDataStoreRuntime,\n        attributes: IChannelAttributes,\n        options: SharedPropertyTreeOptions,\n        propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree;\n\n    public async load(\n        runtime: IFluidDataStoreRuntime,\n        id: string,\n        services: IChannelServices,\n        attributes: IChannelAttributes,\n        url?: string,\n    ): Promise<SharedPropertyTree> {\n        const options = {};\n        const instance = this.newPropertyTree(id, runtime, attributes,\n            options as SharedPropertyTreeOptions\n            , { encDec: this.getEncDec() });\n        await instance.load(services);\n        return instance;\n    }\n\n    public create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): SharedPropertyTree {\n        const options = {};\n        const cell = this.newPropertyTree(id, document,\n            this.attributes, options as SharedPropertyTreeOptions,\n            { encDec: this.getEncDec() });\n        cell.initializeLocal();\n        return cell;\n    }\n}\n\nexport class DeflatedPropertyTreeFactory extends CompressedPropertyTreeFactory {\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 async load(\n        runtime: IFluidDataStoreRuntime,\n        id: string,\n        services: IChannelServices,\n        attributes: IChannelAttributes,\n        url?: string,\n    ): Promise<DeflatedPropertyTree> {\n        return await super.load(runtime, id, services, attributes, url) as DeflatedPropertyTree;\n    }\n\n    public create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): DeflatedPropertyTree {\n        return super.create(document, id, requestUrl);\n    }\n\n    public get type() {\n        return DeflatedPropertyTreeFactory.Type;\n    }\n\n    public get attributes() {\n        return DeflatedPropertyTreeFactory.Attributes;\n    }\n\n    public getEncodeFce() { return deflate; }\n    public getDecodeFce() { return inflate; }\n    public newPropertyTree(\n        id: string,\n        runtime: IFluidDataStoreRuntime,\n        attributes: IChannelAttributes,\n        options: SharedPropertyTreeOptions,\n        propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree {\n        return new DeflatedPropertyTree(id, runtime, attributes, options, propertyTreeConfig);\n    }\n}\n\nexport class LZ4PropertyTreeFactory extends CompressedPropertyTreeFactory {\n    public static readonly Type = \"LZ4PropertyTree:84534a0fe613522101f6\";\n\n    public static readonly Attributes: IChannelAttributes = {\n        type: LZ4PropertyTreeFactory.Type,\n        snapshotFormatVersion: \"0.1\",\n        packageVersion: \"0.0.1\",\n    };\n\n    public async load(\n        runtime: IFluidDataStoreRuntime,\n        id: string,\n        services: IChannelServices,\n        attributes: IChannelAttributes,\n        url?: string,\n    ): Promise<LZ4PropertyTree> {\n        return await super.load(runtime, id, services, attributes, url) as LZ4PropertyTree;\n    }\n\n    public create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): LZ4PropertyTree {\n        return super.create(document, id, requestUrl);\n    }\n\n    public get type() {\n        return LZ4PropertyTreeFactory.Type;\n    }\n\n    public get attributes() {\n        return LZ4PropertyTreeFactory.Attributes;\n    }\n\n    public getEncodeFce() { return compress; }\n    public getDecodeFce() { return decompress; }\n    public newPropertyTree(\n        id: string,\n        runtime: IFluidDataStoreRuntime,\n        attributes: IChannelAttributes,\n        options: SharedPropertyTreeOptions,\n        propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree {\n        return new LZ4PropertyTree(id, runtime, attributes, options, propertyTreeConfig);\n    }\n}\n"]}

package/lib/propertyTreeExt.d.ts

@@ -12,4 +12,8 @@ export declare class DeflatedPropertyTree extends SharedPropertyTree {
     static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string): DeflatedPropertyTree;
     static getFactory(): IChannelFactory;
 }
+export declare class LZ4PropertyTree extends SharedPropertyTree {
+    static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string): LZ4PropertyTree;
+    static getFactory(): IChannelFactory;
+}
 //# sourceMappingURL=propertyTreeExt.d.ts.map

package/lib/propertyTreeExt.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"propertyTreeExt.d.ts","sourceRoot":"","sources":["../src/propertyTreeExt.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAChG,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAGpD;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,kBAAkB;WAC1C,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;WAIzE,UAAU,IAAI,eAAe;CAG9C"}
+{"version":3,"file":"propertyTreeExt.d.ts","sourceRoot":"","sources":["../src/propertyTreeExt.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAChG,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAGpD;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,kBAAkB;WAC1C,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;WAIzE,UAAU,IAAI,eAAe;CAG9C;AAED,qBAAa,eAAgB,SAAQ,kBAAkB;WACrC,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;WAIzE,UAAU,IAAI,eAAe;CAG9C"}

package/lib/propertyTreeExt.js

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 import { SharedPropertyTree } from "./propertyTree";
-import { DeflatedPropertyTreeFactory } from "./propertyTreeExtFactories";
+import { DeflatedPropertyTreeFactory, LZ4PropertyTreeFactory } from "./propertyTreeExtFactories";
 /**
  * This class is the extension of SharedPropertyTree which compresses
  * the deltas and summaries communicated to the server by Deflate.
@@ -16,4 +16,12 @@ export class DeflatedPropertyTree extends SharedPropertyTree {
         return new DeflatedPropertyTreeFactory();
     }
 }
+export class LZ4PropertyTree extends SharedPropertyTree {
+    static create(runtime, id, queryString) {
+        return runtime.createChannel(id, LZ4PropertyTreeFactory.Type);
+    }
+    static getFactory() {
+        return new LZ4PropertyTreeFactory();
+    }
+}
 //# sourceMappingURL=propertyTreeExt.js.map

package/lib/propertyTreeExt.js.map

@@ -1 +1 @@
-{"version":3,"file":"propertyTreeExt.js","sourceRoot":"","sources":["../src/propertyTreeExt.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,2BAA2B,EAAE,MAAM,4BAA4B,CAAC;AAEzE;;;GAGG;AACH,MAAM,OAAO,oBAAqB,SAAQ,kBAAkB;IACjD,MAAM,CAAC,MAAM,CAAC,OAA+B,EAAE,EAAW,EAAE,WAAoB;QACnF,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,2BAA2B,CAAC,IAAI,CAAyB,CAAC;IAC/F,CAAC;IAEM,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,2BAA2B,EAAE,CAAC;IAC7C,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IChannelFactory, IFluidDataStoreRuntime } from \"@fluidframework/datastore-definitions\";\nimport { SharedPropertyTree } from \"./propertyTree\";\nimport { DeflatedPropertyTreeFactory } from \"./propertyTreeExtFactories\";\n\n/**\n * This class is the extension of SharedPropertyTree which compresses\n * the deltas and summaries communicated to the server by Deflate.\n */\nexport class DeflatedPropertyTree extends SharedPropertyTree {\n    public static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string) {\n        return runtime.createChannel(id, DeflatedPropertyTreeFactory.Type) as DeflatedPropertyTree;\n    }\n\n    public static getFactory(): IChannelFactory {\n        return new DeflatedPropertyTreeFactory();\n    }\n}\n"]}
+{"version":3,"file":"propertyTreeExt.js","sourceRoot":"","sources":["../src/propertyTreeExt.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,2BAA2B,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAEjG;;;GAGG;AACH,MAAM,OAAO,oBAAqB,SAAQ,kBAAkB;IACjD,MAAM,CAAC,MAAM,CAAC,OAA+B,EAAE,EAAW,EAAE,WAAoB;QACnF,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,2BAA2B,CAAC,IAAI,CAAyB,CAAC;IAC/F,CAAC;IAEM,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,2BAA2B,EAAE,CAAC;IAC7C,CAAC;CACJ;AAED,MAAM,OAAO,eAAgB,SAAQ,kBAAkB;IAC5C,MAAM,CAAC,MAAM,CAAC,OAA+B,EAAE,EAAW,EAAE,WAAoB;QACnF,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,sBAAsB,CAAC,IAAI,CAAoB,CAAC;IACrF,CAAC;IAEM,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,sBAAsB,EAAE,CAAC;IACxC,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IChannelFactory, IFluidDataStoreRuntime } from \"@fluidframework/datastore-definitions\";\nimport { SharedPropertyTree } from \"./propertyTree\";\nimport { DeflatedPropertyTreeFactory, LZ4PropertyTreeFactory } from \"./propertyTreeExtFactories\";\n\n/**\n * This class is the extension of SharedPropertyTree which compresses\n * the deltas and summaries communicated to the server by Deflate.\n */\nexport class DeflatedPropertyTree extends SharedPropertyTree {\n    public static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string) {\n        return runtime.createChannel(id, DeflatedPropertyTreeFactory.Type) as DeflatedPropertyTree;\n    }\n\n    public static getFactory(): IChannelFactory {\n        return new DeflatedPropertyTreeFactory();\n    }\n}\n\nexport class LZ4PropertyTree extends SharedPropertyTree {\n    public static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string) {\n        return runtime.createChannel(id, LZ4PropertyTreeFactory.Type) as LZ4PropertyTree;\n    }\n\n    public static getFactory(): IChannelFactory {\n        return new LZ4PropertyTreeFactory();\n    }\n}\n"]}

package/lib/propertyTreeExtFactories.d.ts

@@ -1,11 +1,37 @@
 import { IChannelAttributes, IFluidDataStoreRuntime, IChannelServices, IChannelFactory } from "@fluidframework/datastore-definitions";
-import { DeflatedPropertyTree } from "./propertyTreeExt";
-export declare class DeflatedPropertyTreeFactory implements IChannelFactory {
+import { IPropertyTreeConfig, ISharedPropertyTreeEncDec, SharedPropertyTree, SharedPropertyTreeOptions } from "./propertyTree";
+import { DeflatedPropertyTree, LZ4PropertyTree } from "./propertyTreeExt";
+export declare abstract class CompressedPropertyTreeFactory implements IChannelFactory {
+    abstract get attributes(): any;
+    abstract get type(): any;
+    abstract getEncodeFce(): any;
+    abstract getDecodeFce(): any;
+    private createCompressionMethods;
+    getEncDec(): ISharedPropertyTreeEncDec;
+    abstract newPropertyTree(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, options: SharedPropertyTreeOptions, propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree;
+    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes, url?: string): Promise<SharedPropertyTree>;
+    create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): SharedPropertyTree;
+}
+export declare class DeflatedPropertyTreeFactory extends CompressedPropertyTreeFactory {
     static readonly Type = "DeflatedPropertyTree:84534a0fe613522101f6";
     static readonly Attributes: IChannelAttributes;
-    get type(): string;
-    get attributes(): IChannelAttributes;
     load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes, url?: string): Promise<DeflatedPropertyTree>;
     create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): DeflatedPropertyTree;
+    get type(): string;
+    get attributes(): IChannelAttributes;
+    getEncodeFce(): any;
+    getDecodeFce(): any;
+    newPropertyTree(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, options: SharedPropertyTreeOptions, propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree;
+}
+export declare class LZ4PropertyTreeFactory extends CompressedPropertyTreeFactory {
+    static readonly Type = "LZ4PropertyTree:84534a0fe613522101f6";
+    static readonly Attributes: IChannelAttributes;
+    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes, url?: string): Promise<LZ4PropertyTree>;
+    create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): LZ4PropertyTree;
+    get type(): string;
+    get attributes(): IChannelAttributes;
+    getEncodeFce(): any;
+    getDecodeFce(): any;
+    newPropertyTree(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, options: SharedPropertyTreeOptions, propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree;
 }
 //# sourceMappingURL=propertyTreeExtFactories.d.ts.map

package/lib/propertyTreeExtFactories.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"propertyTreeExtFactories.d.ts","sourceRoot":"","sources":["../src/propertyTreeExtFactories.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,gBAAgB,EAChB,eAAe,EAClB,MAAM,uCAAuC,CAAC;AAG/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAmDzD,qBAAa,2BAA4B,YAAW,eAAe;IAC/D,gBAAuB,IAAI,+CAA+C;IAE1E,gBAAuB,UAAU,EAAE,kBAAkB,CAInD;IAEF,IAAW,IAAI,WAEd;IAED,IAAW,UAAU,uBAEpB;IAEY,IAAI,CACb,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,EAC9B,GAAG,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,oBAAoB,CAAC;IAQzB,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,oBAAoB;CAOzG"}
+{"version":3,"file":"propertyTreeExtFactories.d.ts","sourceRoot":"","sources":["../src/propertyTreeExtFactories.ts"],"names":[],"mappings":"AAQA,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,gBAAgB,EAChB,eAAe,EAClB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACH,mBAAmB,EAAwB,yBAAyB,EAClD,kBAAkB,EAAE,yBAAyB,EAClE,MACQ,gBAAgB,CAAC;AAC1B,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE1E,8BAAsB,6BAA8B,YAAW,eAAe;IAC1E,aAAoB,UAAU,QAAG;IACjC,aAAoB,IAAI,QAAG;aACX,YAAY;aACZ,YAAY;IAC5B,OAAO,CAAC,wBAAwB;IA0CzB,SAAS,IAAI,yBAAyB;aAG7B,eAAe,CAC3B,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB,EAC9B,OAAO,EAAE,yBAAyB,EAClC,kBAAkB,EAAE,mBAAmB,GAAG,kBAAkB;IAEnD,IAAI,CACb,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,EAC9B,GAAG,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,kBAAkB,CAAC;IASvB,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB;CAQvG;AAED,qBAAa,2BAA4B,SAAQ,6BAA6B;IAC1E,gBAAuB,IAAI,+CAA+C;IAE1E,gBAAuB,UAAU,EAAE,kBAAkB,CAInD;IAEW,IAAI,CACb,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,EAC9B,GAAG,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,oBAAoB,CAAC;IAIzB,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,oBAAoB;IAItG,IAAW,IAAI,WAEd;IAED,IAAW,UAAU,uBAEpB;IAEM,YAAY;IACZ,YAAY;IACZ,eAAe,CAClB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB,EAC9B,OAAO,EAAE,yBAAyB,EAClC,kBAAkB,EAAE,mBAAmB,GAAG,kBAAkB;CAGnE;AAED,qBAAa,sBAAuB,SAAQ,6BAA6B;IACrE,gBAAuB,IAAI,0CAA0C;IAErE,gBAAuB,UAAU,EAAE,kBAAkB,CAInD;IAEW,IAAI,CACb,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,EAC9B,GAAG,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,eAAe,CAAC;IAIpB,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,eAAe;IAIjG,IAAW,IAAI,WAEd;IAED,IAAW,UAAU,uBAEpB;IAEM,YAAY;IACZ,YAAY;IACZ,eAAe,CAClB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB,EAC9B,OAAO,EAAE,yBAAyB,EAClC,kBAAkB,EAAE,mBAAmB,GAAG,kBAAkB;CAGnE"}

package/lib/propertyTreeExtFactories.js

@@ -2,77 +2,118 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+/* eslint-disable @typescript-eslint/no-unsafe-return */
 import { deflate, inflate } from "pako";
+import { compress, decompress } from "lz4js";
 import { bufferToString, stringToBuffer } from "@fluidframework/common-utils";
-import { DeflatedPropertyTree } from "./propertyTreeExt";
-function encodeSummary(snapshotSummary) {
-    const summaryStr = JSON.stringify(snapshotSummary);
-    const unzipped = new TextEncoder().encode(summaryStr);
-    const serializedSummary = deflate(unzipped);
-    return serializedSummary;
-}
-function decodeSummary(serializedSummary) {
-    const unzipped = 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 = deflate(unzipped);
-    const zippedStr = 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 = stringToBuffer(transferChange.changeSet, "base64");
-        const unzipped = 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,
-    },
-};
-export class DeflatedPropertyTreeFactory {
-    get type() {
-        return DeflatedPropertyTreeFactory.Type;
+import { DeflatedPropertyTree, LZ4PropertyTree } from "./propertyTreeExt";
+export class CompressedPropertyTreeFactory {
+    createCompressionMethods(encodeFn, decodeFn) {
+        return {
+            messageEncoder: {
+                encode: (change) => {
+                    const changeSetStr = JSON.stringify(change.changeSet);
+                    const unzipped = new TextEncoder().encode(changeSetStr);
+                    const zipped = encodeFn(unzipped);
+                    const zippedStr = bufferToString(zipped, "base64");
+                    if (zippedStr.length < changeSetStr.length) {
+                        // eslint-disable-next-line @typescript-eslint/dot-notation
+                        change["isZipped"] = "1";
+                        change.changeSet = zippedStr;
+                    }
+                    return change;
+                },
+                decode: (transferChange) => {
+                    // eslint-disable-next-line @typescript-eslint/dot-notation
+                    if (transferChange["isZipped"]) {
+                        const zipped = new Uint8Array(stringToBuffer(transferChange.changeSet, "base64"));
+                        const unzipped = decodeFn(zipped);
+                        const changeSetStr = new TextDecoder().decode(unzipped);
+                        transferChange.changeSet = JSON.parse(changeSetStr);
+                    }
+                    return transferChange;
+                },
+            },
+            summaryEncoder: {
+                encode: (snapshotSummary) => {
+                    const summaryStr = JSON.stringify(snapshotSummary);
+                    const unzipped = new TextEncoder().encode(summaryStr);
+                    const serializedSummary = encodeFn(unzipped);
+                    return serializedSummary;
+                },
+                decode: (serializedSummary) => {
+                    const unzipped = decodeFn(serializedSummary);
+                    const summaryStr = new TextDecoder().decode(unzipped);
+                    const snapshotSummary = JSON.parse(summaryStr);
+                    return snapshotSummary;
+                },
+            },
+        };
     }
-    get attributes() {
-        return DeflatedPropertyTreeFactory.Attributes;
+    getEncDec() {
+        return this.createCompressionMethods(this.getEncodeFce(), this.getDecodeFce());
     }
     async load(runtime, id, services, attributes, url) {
         const options = {};
-        const instance = new DeflatedPropertyTree(id, runtime, attributes, options, { encDec });
+        const instance = this.newPropertyTree(id, runtime, attributes, options, { encDec: this.getEncDec() });
         await instance.load(services);
         return instance;
     }
     create(document, id, requestUrl) {
         const options = {};
-        const cell = new DeflatedPropertyTree(id, document, this.attributes, options, { encDec });
+        const cell = this.newPropertyTree(id, document, this.attributes, options, { encDec: this.getEncDec() });
         cell.initializeLocal();
         return cell;
     }
 }
+export class DeflatedPropertyTreeFactory extends CompressedPropertyTreeFactory {
+    async load(runtime, id, services, attributes, url) {
+        return await super.load(runtime, id, services, attributes, url);
+    }
+    create(document, id, requestUrl) {
+        return super.create(document, id, requestUrl);
+    }
+    get type() {
+        return DeflatedPropertyTreeFactory.Type;
+    }
+    get attributes() {
+        return DeflatedPropertyTreeFactory.Attributes;
+    }
+    getEncodeFce() { return deflate; }
+    getDecodeFce() { return inflate; }
+    newPropertyTree(id, runtime, attributes, options, propertyTreeConfig) {
+        return new DeflatedPropertyTree(id, runtime, attributes, options, propertyTreeConfig);
+    }
+}
 DeflatedPropertyTreeFactory.Type = "DeflatedPropertyTree:84534a0fe613522101f6";
 DeflatedPropertyTreeFactory.Attributes = {
     type: DeflatedPropertyTreeFactory.Type,
     snapshotFormatVersion: "0.1",
     packageVersion: "0.0.1",
 };
+export class LZ4PropertyTreeFactory extends CompressedPropertyTreeFactory {
+    async load(runtime, id, services, attributes, url) {
+        return await super.load(runtime, id, services, attributes, url);
+    }
+    create(document, id, requestUrl) {
+        return super.create(document, id, requestUrl);
+    }
+    get type() {
+        return LZ4PropertyTreeFactory.Type;
+    }
+    get attributes() {
+        return LZ4PropertyTreeFactory.Attributes;
+    }
+    getEncodeFce() { return compress; }
+    getDecodeFce() { return decompress; }
+    newPropertyTree(id, runtime, attributes, options, propertyTreeConfig) {
+        return new LZ4PropertyTree(id, runtime, attributes, options, propertyTreeConfig);
+    }
+}
+LZ4PropertyTreeFactory.Type = "LZ4PropertyTree:84534a0fe613522101f6";
+LZ4PropertyTreeFactory.Attributes = {
+    type: LZ4PropertyTreeFactory.Type,
+    snapshotFormatVersion: "0.1",
+    packageVersion: "0.0.1",
+};
 //# sourceMappingURL=propertyTreeExtFactories.js.map

package/lib/propertyTreeExtFactories.js.map

@@ -1 +1 @@
-{"version":3,"file":"propertyTreeExtFactories.js","sourceRoot":"","sources":["../src/propertyTreeExtFactories.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAS9E,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;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,OAAO,CAAC,QAAQ,CAAC,CAAC;IACpD,OAAO,iBAAiB,CAAC;AAC7B,CAAC;AAED,SAAS,aAAa,CAAC,iBAAiB;IACpC,MAAM,QAAQ,GAAG,OAAO,CAAC,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,OAAO,CAAC,QAAQ,CAAC,CAAC;IACzC,MAAM,SAAS,GAAG,cAAc,CAAC,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,cAAc,CAAC,cAAc,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAClE,MAAM,QAAQ,GAAG,OAAO,CAAC,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,MAAM,OAAO,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,oBAAoB,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,oBAAoB,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;;AApCsB,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"]}
+{"version":3,"file":"propertyTreeExtFactories.js","sourceRoot":"","sources":["../src/propertyTreeExtFactories.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wDAAwD;AACxD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAY9E,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE1E,MAAM,OAAgB,6BAA6B;IAKvC,wBAAwB,CAAC,QAAQ,EAAE,QAAQ;QAC/C,OAAO;YACH,cAAc,EAAE;gBACZ,MAAM,EAAE,CAAC,MAA4B,EAAE,EAAE;oBACrC,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;oBACtD,MAAM,QAAQ,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;oBACxD,MAAM,MAAM,GAAW,QAAQ,CAAC,QAAQ,CAAC,CAAC;oBAC1C,MAAM,SAAS,GAAG,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;oBACnD,IAAI,SAAS,CAAC,MAAM,GAAG,YAAY,CAAC,MAAM,EAAE;wBACxC,2DAA2D;wBAC3D,MAAM,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC;wBACzB,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;qBAChC;oBACD,OAAO,MAAM,CAAC;gBAClB,CAAC;gBACD,MAAM,EAAE,CAAC,cAAoC,EAAE,EAAE;oBAC7C,2DAA2D;oBAC3D,IAAI,cAAc,CAAC,UAAU,CAAC,EAAE;wBAC5B,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,cAAc,CAAC,cAAc,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;wBAClF,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;wBAClC,MAAM,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;wBACxD,cAAc,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;qBACvD;oBACD,OAAO,cAAc,CAAC;gBAC1B,CAAC;aACJ;YACD,cAAc,EAAE;gBACZ,MAAM,EAAE,CAAC,eAAiC,EAAU,EAAE;oBAClD,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;oBACnD,MAAM,QAAQ,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;oBACtD,MAAM,iBAAiB,GAAW,QAAQ,CAAC,QAAQ,CAAC,CAAC;oBACrD,OAAO,iBAAiB,CAAC;gBAC7B,CAAC;gBACD,MAAM,EAAE,CAAC,iBAAiB,EAAoB,EAAE;oBAC5C,MAAM,QAAQ,GAAG,QAAQ,CAAC,iBAAiB,CAAC,CAAC;oBAC7C,MAAM,UAAU,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;oBACtD,MAAM,eAAe,GAAqB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;oBACjE,OAAO,eAAe,CAAC;gBAC3B,CAAC;aACJ;SACJ,CAAC;IACN,CAAC;IACM,SAAS;QACZ,OAAO,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;IACnF,CAAC;IAQM,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,CAAC,eAAe,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EACzD,OAAoC,EAClC,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QACpC,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,CAAC,eAAe,CAAC,EAAE,EAAE,QAAQ,EAC1C,IAAI,CAAC,UAAU,EAAE,OAAoC,EACrD,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QAClC,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAED,MAAM,OAAO,2BAA4B,SAAQ,6BAA6B;IASnE,KAAK,CAAC,IAAI,CACb,OAA+B,EAC/B,EAAU,EACV,QAA0B,EAC1B,UAA8B,EAC9B,GAAY;QAEZ,OAAO,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,CAAyB,CAAC;IAC5F,CAAC;IAEM,MAAM,CAAC,QAAgC,EAAE,EAAU,EAAE,UAAmB;QAC3E,OAAO,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;IAClD,CAAC;IAED,IAAW,IAAI;QACX,OAAO,2BAA2B,CAAC,IAAI,CAAC;IAC5C,CAAC;IAED,IAAW,UAAU;QACjB,OAAO,2BAA2B,CAAC,UAAU,CAAC;IAClD,CAAC;IAEM,YAAY,KAAK,OAAO,OAAO,CAAC,CAAC,CAAC;IAClC,YAAY,KAAK,OAAO,OAAO,CAAC,CAAC,CAAC;IAClC,eAAe,CAClB,EAAU,EACV,OAA+B,EAC/B,UAA8B,EAC9B,OAAkC,EAClC,kBAAuC;QACvC,OAAO,IAAI,oBAAoB,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAC;IAC1F,CAAC;;AAvCsB,gCAAI,GAAG,2CAA2C,CAAC;AAEnD,sCAAU,GAAuB;IACpD,IAAI,EAAE,2BAA2B,CAAC,IAAI;IACtC,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,OAAO;CAC1B,CAAC;AAoCN,MAAM,OAAO,sBAAuB,SAAQ,6BAA6B;IAS9D,KAAK,CAAC,IAAI,CACb,OAA+B,EAC/B,EAAU,EACV,QAA0B,EAC1B,UAA8B,EAC9B,GAAY;QAEZ,OAAO,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,CAAoB,CAAC;IACvF,CAAC;IAEM,MAAM,CAAC,QAAgC,EAAE,EAAU,EAAE,UAAmB;QAC3E,OAAO,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;IAClD,CAAC;IAED,IAAW,IAAI;QACX,OAAO,sBAAsB,CAAC,IAAI,CAAC;IACvC,CAAC;IAED,IAAW,UAAU;QACjB,OAAO,sBAAsB,CAAC,UAAU,CAAC;IAC7C,CAAC;IAEM,YAAY,KAAK,OAAO,QAAQ,CAAC,CAAC,CAAC;IACnC,YAAY,KAAK,OAAO,UAAU,CAAC,CAAC,CAAC;IACrC,eAAe,CAClB,EAAU,EACV,OAA+B,EAC/B,UAA8B,EAC9B,OAAkC,EAClC,kBAAuC;QACvC,OAAO,IAAI,eAAe,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAC;IACrF,CAAC;;AAvCsB,2BAAI,GAAG,sCAAsC,CAAC;AAE9C,iCAAU,GAAuB;IACpD,IAAI,EAAE,sBAAsB,CAAC,IAAI;IACjC,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 */\n/* eslint-disable @typescript-eslint/no-unsafe-return */\nimport { deflate, inflate } from \"pako\";\nimport { compress, decompress } from \"lz4js\";\nimport { bufferToString, stringToBuffer } from \"@fluidframework/common-utils\";\nimport {\n    IChannelAttributes,\n    IFluidDataStoreRuntime,\n    IChannelServices,\n    IChannelFactory,\n} from \"@fluidframework/datastore-definitions\";\nimport {\n    IPropertyTreeConfig, IPropertyTreeMessage, ISharedPropertyTreeEncDec,\n    ISnapshotSummary, SharedPropertyTree, SharedPropertyTreeOptions,\n}\n    from \"./propertyTree\";\nimport { DeflatedPropertyTree, LZ4PropertyTree } from \"./propertyTreeExt\";\n\nexport abstract class CompressedPropertyTreeFactory implements IChannelFactory {\n    public abstract get attributes();\n    public abstract get type();\n    public abstract getEncodeFce();\n    public abstract getDecodeFce();\n    private createCompressionMethods(encodeFn, decodeFn): ISharedPropertyTreeEncDec {\n        return {\n            messageEncoder: {\n                encode: (change: IPropertyTreeMessage) => {\n                    const changeSetStr = JSON.stringify(change.changeSet);\n                    const unzipped = new TextEncoder().encode(changeSetStr);\n                    const zipped: Buffer = encodeFn(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                decode: (transferChange: IPropertyTreeMessage) => {\n                    // eslint-disable-next-line @typescript-eslint/dot-notation\n                    if (transferChange[\"isZipped\"]) {\n                        const zipped = new Uint8Array(stringToBuffer(transferChange.changeSet, \"base64\"));\n                        const unzipped = decodeFn(zipped);\n                        const changeSetStr = new TextDecoder().decode(unzipped);\n                        transferChange.changeSet = JSON.parse(changeSetStr);\n                    }\n                    return transferChange;\n                },\n            },\n            summaryEncoder: {\n                encode: (snapshotSummary: ISnapshotSummary): Buffer => {\n                    const summaryStr = JSON.stringify(snapshotSummary);\n                    const unzipped = new TextEncoder().encode(summaryStr);\n                    const serializedSummary: Buffer = encodeFn(unzipped);\n                    return serializedSummary;\n                },\n                decode: (serializedSummary): ISnapshotSummary => {\n                    const unzipped = decodeFn(serializedSummary);\n                    const summaryStr = new TextDecoder().decode(unzipped);\n                    const snapshotSummary: ISnapshotSummary = JSON.parse(summaryStr);\n                    return snapshotSummary;\n                },\n            },\n        };\n    }\n    public getEncDec(): ISharedPropertyTreeEncDec {\n        return this.createCompressionMethods(this.getEncodeFce(), this.getDecodeFce());\n    }\n    public abstract newPropertyTree(\n        id: string,\n        runtime: IFluidDataStoreRuntime,\n        attributes: IChannelAttributes,\n        options: SharedPropertyTreeOptions,\n        propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree;\n\n    public async load(\n        runtime: IFluidDataStoreRuntime,\n        id: string,\n        services: IChannelServices,\n        attributes: IChannelAttributes,\n        url?: string,\n    ): Promise<SharedPropertyTree> {\n        const options = {};\n        const instance = this.newPropertyTree(id, runtime, attributes,\n            options as SharedPropertyTreeOptions\n            , { encDec: this.getEncDec() });\n        await instance.load(services);\n        return instance;\n    }\n\n    public create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): SharedPropertyTree {\n        const options = {};\n        const cell = this.newPropertyTree(id, document,\n            this.attributes, options as SharedPropertyTreeOptions,\n            { encDec: this.getEncDec() });\n        cell.initializeLocal();\n        return cell;\n    }\n}\n\nexport class DeflatedPropertyTreeFactory extends CompressedPropertyTreeFactory {\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 async load(\n        runtime: IFluidDataStoreRuntime,\n        id: string,\n        services: IChannelServices,\n        attributes: IChannelAttributes,\n        url?: string,\n    ): Promise<DeflatedPropertyTree> {\n        return await super.load(runtime, id, services, attributes, url) as DeflatedPropertyTree;\n    }\n\n    public create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): DeflatedPropertyTree {\n        return super.create(document, id, requestUrl);\n    }\n\n    public get type() {\n        return DeflatedPropertyTreeFactory.Type;\n    }\n\n    public get attributes() {\n        return DeflatedPropertyTreeFactory.Attributes;\n    }\n\n    public getEncodeFce() { return deflate; }\n    public getDecodeFce() { return inflate; }\n    public newPropertyTree(\n        id: string,\n        runtime: IFluidDataStoreRuntime,\n        attributes: IChannelAttributes,\n        options: SharedPropertyTreeOptions,\n        propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree {\n        return new DeflatedPropertyTree(id, runtime, attributes, options, propertyTreeConfig);\n    }\n}\n\nexport class LZ4PropertyTreeFactory extends CompressedPropertyTreeFactory {\n    public static readonly Type = \"LZ4PropertyTree:84534a0fe613522101f6\";\n\n    public static readonly Attributes: IChannelAttributes = {\n        type: LZ4PropertyTreeFactory.Type,\n        snapshotFormatVersion: \"0.1\",\n        packageVersion: \"0.0.1\",\n    };\n\n    public async load(\n        runtime: IFluidDataStoreRuntime,\n        id: string,\n        services: IChannelServices,\n        attributes: IChannelAttributes,\n        url?: string,\n    ): Promise<LZ4PropertyTree> {\n        return await super.load(runtime, id, services, attributes, url) as LZ4PropertyTree;\n    }\n\n    public create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): LZ4PropertyTree {\n        return super.create(document, id, requestUrl);\n    }\n\n    public get type() {\n        return LZ4PropertyTreeFactory.Type;\n    }\n\n    public get attributes() {\n        return LZ4PropertyTreeFactory.Attributes;\n    }\n\n    public getEncodeFce() { return compress; }\n    public getDecodeFce() { return decompress; }\n    public newPropertyTree(\n        id: string,\n        runtime: IFluidDataStoreRuntime,\n        attributes: IChannelAttributes,\n        options: SharedPropertyTreeOptions,\n        propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree {\n        return new LZ4PropertyTree(id, runtime, attributes, options, propertyTreeConfig);\n    }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-experimental/property-dds",
-  "version": "1.2.6",
+  "version": "2.0.0-dev.1.3.0.96595",
   "description": "definition of the property distributed data store",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -35,40 +35,41 @@
     "tsc": "tsc"
   },
   "dependencies": {
-    "@fluid-experimental/property-changeset": "^1.2.6",
-    "@fluid-experimental/property-properties": "^1.2.6",
-    "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/container-definitions": "^1.2.6",
-    "@fluidframework/core-interfaces": "^1.2.6",
-    "@fluidframework/datastore-definitions": "^1.2.6",
-    "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/runtime-definitions": "^1.2.6",
-    "@fluidframework/runtime-utils": "^1.2.6",
-    "@fluidframework/shared-object-base": "^1.2.6",
+    "@fluid-experimental/property-changeset": "2.0.0-dev.1.3.0.96595",
+    "@fluid-experimental/property-properties": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/common-utils": "^1.0.0",
+    "@fluidframework/container-definitions": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/core-interfaces": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/datastore-definitions": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/protocol-definitions": "^1.0.0",
+    "@fluidframework/runtime-definitions": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/runtime-utils": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/shared-object-base": "2.0.0-dev.1.3.0.96595",
     "axios": "^0.26.0",
     "fastest-json-copy": "^1.0.1",
     "lodash": "^4.17.21",
+    "lz4js": "^0.2.0",
     "msgpackr": "^1.4.7",
     "pako": "^2.0.4",
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluid-experimental/property-common": "^1.2.6",
-    "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/driver-definitions": "^1.2.6",
-    "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/local-driver": "^1.2.6",
-    "@fluidframework/mocha-test-setup": "^1.2.6",
-    "@fluidframework/sequence": "^1.2.6",
-    "@fluidframework/server-local-server": "^0.1036.5000",
-    "@fluidframework/test-runtime-utils": "^1.2.6",
-    "@fluidframework/test-utils": "^1.2.6",
+    "@fluid-experimental/property-common": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/build-common": "^1.0.0",
+    "@fluidframework/driver-definitions": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/eslint-config-fluid": "^1.0.0",
+    "@fluidframework/local-driver": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/sequence": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/server-local-server": "^0.1037.2001",
+    "@fluidframework/test-runtime-utils": "2.0.0-dev.1.3.0.96595",
+    "@fluidframework/test-utils": "2.0.0-dev.1.3.0.96595",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^9.1.1",
     "chai": "^4.2.0",
     "concurrently": "^6.2.0",
-    "copyfiles": "^2.1.0",
+    "copyfiles": "^2.4.1",
     "cross-env": "^7.0.2",
     "easy-table": "^1.1.1",
     "env-cmd": "^10.1.0",

package/src/propertyTreeExt.ts

@@ -5,7 +5,7 @@
 
 import { IChannelFactory, IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
 import { SharedPropertyTree } from "./propertyTree";
-import { DeflatedPropertyTreeFactory } from "./propertyTreeExtFactories";
+import { DeflatedPropertyTreeFactory, LZ4PropertyTreeFactory } from "./propertyTreeExtFactories";
 
 /**
  * This class is the extension of SharedPropertyTree which compresses
@@ -20,3 +20,13 @@ export class DeflatedPropertyTree extends SharedPropertyTree {
         return new DeflatedPropertyTreeFactory();
     }
 }
+
+export class LZ4PropertyTree extends SharedPropertyTree {
+    public static create(runtime: IFluidDataStoreRuntime, id?: string, queryString?: string) {
+        return runtime.createChannel(id, LZ4PropertyTreeFactory.Type) as LZ4PropertyTree;
+    }
+
+    public static getFactory(): IChannelFactory {
+        return new LZ4PropertyTreeFactory();
+    }
+}

package/src/propertyTreeExtFactories.ts

@@ -2,7 +2,9 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+/* eslint-disable @typescript-eslint/no-unsafe-return */
 import { deflate, inflate } from "pako";
+import { compress, decompress } from "lz4js";
 import { bufferToString, stringToBuffer } from "@fluidframework/common-utils";
 import {
     IChannelAttributes,
@@ -10,60 +12,96 @@ import {
     IChannelServices,
     IChannelFactory,
 } from "@fluidframework/datastore-definitions";
-import { IPropertyTreeMessage, ISharedPropertyTreeEncDec, ISnapshotSummary, SharedPropertyTreeOptions }
-from "./propertyTree";
-import { DeflatedPropertyTree } from "./propertyTreeExt";
-
-function encodeSummary(snapshotSummary: ISnapshotSummary) {
-    const summaryStr = JSON.stringify(snapshotSummary);
-    const unzipped = new TextEncoder().encode(summaryStr);
-    const serializedSummary: Buffer = deflate(unzipped);
-    return serializedSummary;
+import {
+    IPropertyTreeConfig, IPropertyTreeMessage, ISharedPropertyTreeEncDec,
+    ISnapshotSummary, SharedPropertyTree, SharedPropertyTreeOptions,
 }
+    from "./propertyTree";
+import { DeflatedPropertyTree, LZ4PropertyTree } from "./propertyTreeExt";
 
-function decodeSummary(serializedSummary): ISnapshotSummary {
-    const unzipped = inflate(serializedSummary);
-    const summaryStr = new TextDecoder().decode(unzipped);
-    const snapshotSummary: ISnapshotSummary = JSON.parse(summaryStr);
-    return snapshotSummary;
-}
+export abstract class CompressedPropertyTreeFactory implements IChannelFactory {
+    public abstract get attributes();
+    public abstract get type();
+    public abstract getEncodeFce();
+    public abstract getDecodeFce();
+    private createCompressionMethods(encodeFn, decodeFn): ISharedPropertyTreeEncDec {
+        return {
+            messageEncoder: {
+                encode: (change: IPropertyTreeMessage) => {
+                    const changeSetStr = JSON.stringify(change.changeSet);
+                    const unzipped = new TextEncoder().encode(changeSetStr);
+                    const zipped: Buffer = encodeFn(unzipped);
+                    const zippedStr = bufferToString(zipped, "base64");
+                    if (zippedStr.length < changeSetStr.length) {
+                        // eslint-disable-next-line @typescript-eslint/dot-notation
+                        change["isZipped"] = "1";
+                        change.changeSet = zippedStr;
+                    }
+                    return change;
+                },
+                decode: (transferChange: IPropertyTreeMessage) => {
+                    // eslint-disable-next-line @typescript-eslint/dot-notation
+                    if (transferChange["isZipped"]) {
+                        const zipped = new Uint8Array(stringToBuffer(transferChange.changeSet, "base64"));
+                        const unzipped = decodeFn(zipped);
+                        const changeSetStr = new TextDecoder().decode(unzipped);
+                        transferChange.changeSet = JSON.parse(changeSetStr);
+                    }
+                    return transferChange;
+                },
+            },
+            summaryEncoder: {
+                encode: (snapshotSummary: ISnapshotSummary): Buffer => {
+                    const summaryStr = JSON.stringify(snapshotSummary);
+                    const unzipped = new TextEncoder().encode(summaryStr);
+                    const serializedSummary: Buffer = encodeFn(unzipped);
+                    return serializedSummary;
+                },
+                decode: (serializedSummary): ISnapshotSummary => {
+                    const unzipped = decodeFn(serializedSummary);
+                    const summaryStr = new TextDecoder().decode(unzipped);
+                    const snapshotSummary: ISnapshotSummary = JSON.parse(summaryStr);
+                    return snapshotSummary;
+                },
+            },
+        };
+    }
+    public getEncDec(): ISharedPropertyTreeEncDec {
+        return this.createCompressionMethods(this.getEncodeFce(), this.getDecodeFce());
+    }
+    public abstract newPropertyTree(
+        id: string,
+        runtime: IFluidDataStoreRuntime,
+        attributes: IChannelAttributes,
+        options: SharedPropertyTreeOptions,
+        propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree;
 
-function encodeMessage(change: IPropertyTreeMessage) {
-    const changeSetStr = JSON.stringify(change.changeSet);
-    const unzipped = new TextEncoder().encode(changeSetStr);
-    const zipped: Buffer = deflate(unzipped);
-    const zippedStr = bufferToString(zipped, "base64");
-    if (zippedStr.length < changeSetStr.length) {
-        // eslint-disable-next-line @typescript-eslint/dot-notation
-        change["isZipped"] = "1";
-        change.changeSet = zippedStr;
+    public async load(
+        runtime: IFluidDataStoreRuntime,
+        id: string,
+        services: IChannelServices,
+        attributes: IChannelAttributes,
+        url?: string,
+    ): Promise<SharedPropertyTree> {
+        const options = {};
+        const instance = this.newPropertyTree(id, runtime, attributes,
+            options as SharedPropertyTreeOptions
+            , { encDec: this.getEncDec() });
+        await instance.load(services);
+        return instance;
     }
-    return change;
-}
 
-function decodeMessage(transferChange: IPropertyTreeMessage) {
-    // eslint-disable-next-line @typescript-eslint/dot-notation
-    if (transferChange["isZipped"]) {
-        const zipped = stringToBuffer(transferChange.changeSet, "base64");
-        const unzipped = inflate(zipped);
-        const changeSetStr = new TextDecoder().decode(unzipped);
-        transferChange.changeSet = JSON.parse(changeSetStr);
+    public create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): SharedPropertyTree {
+        const options = {};
+        const cell = this.newPropertyTree(id, document,
+            this.attributes, options as SharedPropertyTreeOptions,
+            { encDec: this.getEncDec() });
+        cell.initializeLocal();
+        return cell;
     }
-    return transferChange;
 }
 
-const encDec: ISharedPropertyTreeEncDec = {
-    messageEncoder: {
-        encode: encodeMessage,
-        decode: decodeMessage,
-    },
-    summaryEncoder: {
-        encode: encodeSummary,
-        decode: decodeSummary,
-    },
-};
-
-export class DeflatedPropertyTreeFactory implements IChannelFactory {
+export class DeflatedPropertyTreeFactory extends CompressedPropertyTreeFactory {
     public static readonly Type = "DeflatedPropertyTree:84534a0fe613522101f6";
 
     public static readonly Attributes: IChannelAttributes = {
@@ -72,6 +110,20 @@ export class DeflatedPropertyTreeFactory implements IChannelFactory {
         packageVersion: "0.0.1",
     };
 
+    public async load(
+        runtime: IFluidDataStoreRuntime,
+        id: string,
+        services: IChannelServices,
+        attributes: IChannelAttributes,
+        url?: string,
+    ): Promise<DeflatedPropertyTree> {
+        return await super.load(runtime, id, services, attributes, url) as DeflatedPropertyTree;
+    }
+
+    public create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): DeflatedPropertyTree {
+        return super.create(document, id, requestUrl);
+    }
+
     public get type() {
         return DeflatedPropertyTreeFactory.Type;
     }
@@ -80,25 +132,57 @@ export class DeflatedPropertyTreeFactory implements IChannelFactory {
         return DeflatedPropertyTreeFactory.Attributes;
     }
 
+    public getEncodeFce() { return deflate; }
+    public getDecodeFce() { return inflate; }
+    public newPropertyTree(
+        id: string,
+        runtime: IFluidDataStoreRuntime,
+        attributes: IChannelAttributes,
+        options: SharedPropertyTreeOptions,
+        propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree {
+        return new DeflatedPropertyTree(id, runtime, attributes, options, propertyTreeConfig);
+    }
+}
+
+export class LZ4PropertyTreeFactory extends CompressedPropertyTreeFactory {
+    public static readonly Type = "LZ4PropertyTree:84534a0fe613522101f6";
+
+    public static readonly Attributes: IChannelAttributes = {
+        type: LZ4PropertyTreeFactory.Type,
+        snapshotFormatVersion: "0.1",
+        packageVersion: "0.0.1",
+    };
+
     public async load(
         runtime: IFluidDataStoreRuntime,
         id: string,
         services: IChannelServices,
         attributes: IChannelAttributes,
         url?: string,
-    ): Promise<DeflatedPropertyTree> {
-        const options = {};
-        const instance = new DeflatedPropertyTree(id, runtime, attributes, options as SharedPropertyTreeOptions
-            , { encDec });
-        await instance.load(services);
-        return instance;
+    ): Promise<LZ4PropertyTree> {
+        return await super.load(runtime, id, services, attributes, url) as LZ4PropertyTree;
     }
 
-    public create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): DeflatedPropertyTree {
-        const options = {};
-        const cell = new DeflatedPropertyTree(id, document,
-            this.attributes, options as SharedPropertyTreeOptions, { encDec });
-        cell.initializeLocal();
-        return cell;
+    public create(document: IFluidDataStoreRuntime, id: string, requestUrl?: string): LZ4PropertyTree {
+        return super.create(document, id, requestUrl);
+    }
+
+    public get type() {
+        return LZ4PropertyTreeFactory.Type;
+    }
+
+    public get attributes() {
+        return LZ4PropertyTreeFactory.Attributes;
+    }
+
+    public getEncodeFce() { return compress; }
+    public getDecodeFce() { return decompress; }
+    public newPropertyTree(
+        id: string,
+        runtime: IFluidDataStoreRuntime,
+        attributes: IChannelAttributes,
+        options: SharedPropertyTreeOptions,
+        propertyTreeConfig: IPropertyTreeConfig): SharedPropertyTree {
+        return new LZ4PropertyTree(id, runtime, attributes, options, propertyTreeConfig);
     }
 }