@fluid-experimental/dds-interceptions 2.0.0-dev-rc.2.0.0.245554

package/lib/test/sharedStringWithInterception.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedStringWithInterception.spec.js","sourceRoot":"","sources":["../../src/test/sharedStringWithInterception.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAE1C,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE7E,OAAO,EAAE,kCAAkC,EAAE,MAAM,sBAAsB,CAAC;AAE1E,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAChD;;;;OAIG;IACH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACxC,MAAM,cAAc,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;QAC/C,MAAM,UAAU,GAAG,QAAQ,CAAC;QAC5B,IAAI,YAA0B,CAAC;QAC/B,IAAI,gBAAwC,CAAC;QAE7C,SAAS,iBAAiB,CAAC,QAAoB;YAC9C,QAAQ,EAAE,CAAC;QACZ,CAAC;QAED,6EAA6E;QAC7E,SAAS,sBAAsB,CAAC,KAAmB;YAClD,MAAM,QAAQ,GAAG,EAAE,GAAG,KAAK,EAAE,GAAG,cAAc,EAAE,CAAC;YACjD,OAAO,QAAQ,CAAC;QACjB,CAAC;QAED,oGAAoG;QACpG,sBAAsB;QACtB,SAAS,YAAY,CACpB,EAAgB,EAChB,IAAY,EACZ,KAAkB,EAClB,QAAgB;YAEhB,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,mDAAmD,CAAC,CAAC;YACtF,MAAM,CAAC,SAAS,CACf,EAAE,GAAG,EAAE,CAAC,uBAAuB,CAAC,QAAQ,CAAC,EAAE,EAC3C,EAAE,GAAG,KAAK,EAAE,EACZ,+DAA+D,CAC/D,CAAC;QACH,CAAC;QAED,UAAU,CAAC,GAAG,EAAE;YACf,MAAM,gBAAgB,GAAG,IAAI,yBAAyB,EAAE,CAAC;YACzD,YAAY,GAAG,IAAI,YAAY,CAC9B,gBAAgB,EAChB,UAAU,EACV,mBAAmB,CAAC,UAAU,CAC9B,CAAC;YAEF,yEAAyE;YACzE,gBAAgB,GAAG;gBAClB,gBAAgB,EAAE,EAAE,iBAAiB,EAAE;aACb,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;YAChF,MAAM,4BAA4B,GAAG,kCAAkC,CACtE,YAAY,EACZ,gBAAgB,EAChB,sBAAsB,CACtB,CAAC;YAEF,kCAAkC;YAClC,IAAI,IAAI,GAAW,KAAK,CAAC;YACzB,IAAI,SAAS,GAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;YAC/C,4BAA4B,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;YAC5D,YAAY,CACX,4BAA4B,EAC5B,IAAI,EACJ,EAAE,GAAG,SAAS,EAAE,GAAG,cAAc,EAAE,EACnC,CAAC,CACD,CAAC;YAEF,qCAAqC;YACrC,IAAI,GAAG,KAAK,CAAC;YACb,SAAS,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;YAClC,4BAA4B,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;YACjE,YAAY,CACX,4BAA4B,EAC5B,OAAO,EACP,EAAE,GAAG,SAAS,EAAE,GAAG,cAAc,EAAE,EACnC,CAAC,CACD,CAAC;YAEF,8BAA8B;YAC9B,MAAM,UAAU,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;YACtC,4BAA4B,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC;YAC7D,YAAY,CACX,4BAA4B,EAC5B,OAAO,EACP,EAAE,GAAG,SAAS,EAAE,GAAG,UAAU,EAAE,GAAG,cAAc,EAAE,EAClD,CAAC,CACD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qFAAqF,EAAE,KAAK,IAAI,EAAE;YACpG,MAAM,4BAA4B,GAAG,kCAAkC,CACtE,YAAY,EACZ,gBAAgB,EAChB,sBAAsB,CACtB,CAAC;YAEF,+DAA+D;YAC/D,IAAI,IAAI,GAAW,KAAK,CAAC;YACzB,IAAI,SAAS,GAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;YAC/C,4BAA4B,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;YAC5D,mEAAmE;YACnE,YAAY,CAAC,YAAY,EAAE,IAAI,EAAE,EAAE,GAAG,SAAS,EAAE,GAAG,cAAc,EAAE,EAAE,CAAC,CAAC,CAAC;YAEzE,gEAAgE;YAChE,IAAI,GAAG,KAAK,CAAC;YACb,SAAS,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;YAClC,4BAA4B,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;YACjE,mEAAmE;YACnE,YAAY,CAAC,YAAY,EAAE,OAAO,EAAE,EAAE,GAAG,SAAS,EAAE,GAAG,cAAc,EAAE,EAAE,CAAC,CAAC,CAAC;YAE5E,8BAA8B;YAC9B,MAAM,UAAU,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;YACtC,4BAA4B,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC;YAC7D,mEAAmE;YACnE,YAAY,CACX,YAAY,EACZ,OAAO,EACP,EAAE,GAAG,SAAS,EAAE,GAAG,UAAU,EAAE,GAAG,cAAc,EAAE,EAClD,CAAC,CACD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qFAAqF,EAAE,KAAK,IAAI,EAAE;YACpG,MAAM,4BAA4B,GAAG,kCAAkC,CACtE,YAAY,EACZ,gBAAgB,EAChB,sBAAsB,CACtB,CAAC;YAEF,gDAAgD;YAChD,IAAI,IAAI,GAAW,KAAK,CAAC;YACzB,IAAI,SAAS,GAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;YAC/C,YAAY,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;YAC5C,uGAAuG;YACvG,YAAY,CAAC,4BAA4B,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;YAE/D,iDAAiD;YACjD,IAAI,GAAG,KAAK,CAAC;YACb,SAAS,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;YAClC,YAAY,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;YACjD,uGAAuG;YACvG,YAAY,CAAC,4BAA4B,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;YAElE,+DAA+D;YAC/D,MAAM,UAAU,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;YACtC,YAAY,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC;YAC7C,uGAAuG;YACvG,YAAY,CAAC,4BAA4B,EAAE,OAAO,EAAE,EAAE,GAAG,SAAS,EAAE,GAAG,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC;QACzF,CAAC,CAAC,CAAC;QAEH;;;;WAIG;QACH,EAAE,CAAC,0FAA0F,EAAE,KAAK,IAAI,EAAE;YACzG,wCAAwC;YACxC,IAAI,4BAA0C,CAAC;YAE/C,MAAM,kBAAkB,GAAG,EAAE,eAAe,EAAE,MAAM,EAAE,CAAC;YACvD,IAAI,UAAU,GAAY,IAAI,CAAC;YAC/B,+FAA+F;YAC/F,iCAAiC;YACjC,2FAA2F;YAC3F,SAAS,uBAAuB,CAAC,UAAwB;gBACxD,MAAM,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,YAAY,CAAC;gBACpE,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,kBAAkB,CAAC,CAAC;gBAC3C,OAAO,EAAE,GAAG,UAAU,EAAE,GAAG,cAAc,EAAE,CAAC;YAC7C,CAAC;YAED,4GAA4G;YAC5G,iCAAiC;YACjC,4BAA4B,GAAG,kCAAkC,CAChE,YAAY,EACZ,gBAAgB,EAChB,uBAAuB,CACvB,CAAC;YAEF,IAAI,IAAI,GAAW,KAAK,CAAC;YACzB,MAAM,KAAK,GAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;YAC7C,kGAAkG;YAClG,2BAA2B;YAC3B,YAAY,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YAExC,IAAI,QAAQ,GAAY,KAAK,CAAC;YAC9B,IAAI;gBACH,IAAI,GAAG,KAAK,CAAC;gBACb,uBAAuB;gBACvB,4BAA4B,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;aACrD;YAAC,OAAO,KAAU,EAAE;gBACpB,MAAM,CAAC,WAAW,CACjB,KAAK,CAAC,OAAO,EACb,OAAO,EACP,yFAAyF,CACzF,CAAC;gBACF,QAAQ,GAAG,IAAI,CAAC;aAChB;YACD,MAAM,CAAC,KAAK,CACX,QAAQ,EACR,IAAI,EACJ,yEAAyE,CACzE,CAAC;YAEF,0CAA0C;YAC1C,0GAA0G;YAC1G,UAAU,GAAG,KAAK,CAAC;YACnB,IAAI,GAAG,MAAM,CAAC;YACd,4BAA4B,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YAC5D,YAAY,CACX,4BAA4B,EAC5B,QAAQ,EACR,EAAE,GAAG,KAAK,EAAE,GAAG,cAAc,EAAE,EAC/B,CAAC,CACD,CAAC;YAEF,kGAAkG;YAClG,YAAY,CACX,4BAA4B,EAC5B,QAAQ,EACR,EAAE,GAAG,KAAK,EAAE,GAAG,kBAAkB,EAAE,EACnC,CAAC,CACD,CAAC;QACH,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { strict as assert } from \"assert\";\nimport { PropertySet } from \"@fluidframework/merge-tree\";\nimport { MockFluidDataStoreRuntime } from \"@fluidframework/test-runtime-utils\";\nimport { SharedString, SharedStringFactory } from \"@fluidframework/sequence\";\nimport { IFluidDataStoreContext } from \"@fluidframework/runtime-definitions\";\nimport { createSharedStringWithInterception } from \"../sequence/index.js\";\n\ndescribe(\"Shared String with Interception\", () => {\n\t/**\n\t * The following tests test simple user attribution in SharedString with interception.\n\t * In the callback function of the SharedString with interception, it adds the user\n\t * information to the passed properties and returns it.\n\t */\n\tdescribe(\"Simple User Attribution\", () => {\n\t\tconst userAttributes = { userId: \"Fake User\" };\n\t\tconst documentId = \"fakeId\";\n\t\tlet sharedString: SharedString;\n\t\tlet dataStoreContext: IFluidDataStoreContext;\n\n\t\tfunction orderSequentially(callback: () => void): void {\n\t\t\tcallback();\n\t\t}\n\n\t\t// Interception function that adds userProps to the passed props and returns.\n\t\tfunction propertyInterceptionCb(props?: PropertySet): PropertySet {\n\t\t\tconst newProps = { ...props, ...userAttributes };\n\t\t\treturn newProps;\n\t\t}\n\n\t\t// Function that verifies that the given shared string has correct value and the right properties at\n\t\t// the given position.\n\t\tfunction verifyString(\n\t\t\tss: SharedString,\n\t\t\ttext: string,\n\t\t\tprops: PropertySet,\n\t\t\tposition: number,\n\t\t) {\n\t\t\tassert.equal(ss.getText(), text, \"The retrieved text should match the inserted text\");\n\t\t\tassert.deepEqual(\n\t\t\t\t{ ...ss.getPropertiesAtPosition(position) },\n\t\t\t\t{ ...props },\n\t\t\t\t\"The properties set via the interception callback should exist\",\n\t\t\t);\n\t\t}\n\n\t\tbeforeEach(() => {\n\t\t\tconst dataStoreRuntime = new MockFluidDataStoreRuntime();\n\t\t\tsharedString = new SharedString(\n\t\t\t\tdataStoreRuntime,\n\t\t\t\tdocumentId,\n\t\t\t\tSharedStringFactory.Attributes,\n\t\t\t);\n\n\t\t\t// eslint-disable-next-line @typescript-eslint/consistent-type-assertions\n\t\t\tdataStoreContext = {\n\t\t\t\tcontainerRuntime: { orderSequentially },\n\t\t\t} as IFluidDataStoreContext;\n\t\t});\n\n\t\tit(\"should be able to intercept SharedString methods by the wrapper\", async () => {\n\t\t\tconst sharedStringWithInterception = createSharedStringWithInterception(\n\t\t\t\tsharedString,\n\t\t\t\tdataStoreContext,\n\t\t\t\tpropertyInterceptionCb,\n\t\t\t);\n\n\t\t\t// Insert text into shared string.\n\t\t\tlet text: string = \"123\";\n\t\t\tlet syleProps: PropertySet = { style: \"bold\" };\n\t\t\tsharedStringWithInterception.insertText(0, text, syleProps);\n\t\t\tverifyString(\n\t\t\t\tsharedStringWithInterception,\n\t\t\t\ttext,\n\t\t\t\t{ ...syleProps, ...userAttributes },\n\t\t\t\t2,\n\t\t\t);\n\n\t\t\t// Replace text in the shared string.\n\t\t\ttext = \"aaa\";\n\t\t\tsyleProps = { style: \"italics \" };\n\t\t\tsharedStringWithInterception.replaceText(2, 3, \"aaa\", syleProps);\n\t\t\tverifyString(\n\t\t\t\tsharedStringWithInterception,\n\t\t\t\t\"12aaa\",\n\t\t\t\t{ ...syleProps, ...userAttributes },\n\t\t\t\t2,\n\t\t\t);\n\n\t\t\t// Annotate the shared string.\n\t\t\tconst colorProps = { color: \"green\" };\n\t\t\tsharedStringWithInterception.annotateRange(0, 5, colorProps);\n\t\t\tverifyString(\n\t\t\t\tsharedStringWithInterception,\n\t\t\t\t\"12aaa\",\n\t\t\t\t{ ...syleProps, ...colorProps, ...userAttributes },\n\t\t\t\t2,\n\t\t\t);\n\t\t});\n\n\t\tit(\"should be able to see changes made by the wrapper from the underlying shared string\", async () => {\n\t\t\tconst sharedStringWithInterception = createSharedStringWithInterception(\n\t\t\t\tsharedString,\n\t\t\t\tdataStoreContext,\n\t\t\t\tpropertyInterceptionCb,\n\t\t\t);\n\n\t\t\t// Insert text via the shared string with interception wrapper.\n\t\t\tlet text: string = \"123\";\n\t\t\tlet syleProps: PropertySet = { style: \"bold\" };\n\t\t\tsharedStringWithInterception.insertText(0, text, syleProps);\n\t\t\t// Verify the text and properties via the underlying shared string.\n\t\t\tverifyString(sharedString, text, { ...syleProps, ...userAttributes }, 2);\n\n\t\t\t// Replace text via the shared string with interception wrapper.\n\t\t\ttext = \"aaa\";\n\t\t\tsyleProps = { style: \"italics \" };\n\t\t\tsharedStringWithInterception.replaceText(2, 3, \"aaa\", syleProps);\n\t\t\t// Verify the text and properties via the underlying shared string.\n\t\t\tverifyString(sharedString, \"12aaa\", { ...syleProps, ...userAttributes }, 2);\n\n\t\t\t// Annotate the shared string.\n\t\t\tconst colorProps = { color: \"green\" };\n\t\t\tsharedStringWithInterception.annotateRange(0, 5, colorProps);\n\t\t\t// Verify the text and properties via the underlying shared string.\n\t\t\tverifyString(\n\t\t\t\tsharedString,\n\t\t\t\t\"12aaa\",\n\t\t\t\t{ ...syleProps, ...colorProps, ...userAttributes },\n\t\t\t\t2,\n\t\t\t);\n\t\t});\n\n\t\tit(\"should be able to see changes made by the underlying shared string from the wrapper\", async () => {\n\t\t\tconst sharedStringWithInterception = createSharedStringWithInterception(\n\t\t\t\tsharedString,\n\t\t\t\tdataStoreContext,\n\t\t\t\tpropertyInterceptionCb,\n\t\t\t);\n\n\t\t\t// Insert text via the underlying shared string.\n\t\t\tlet text: string = \"123\";\n\t\t\tlet syleProps: PropertySet = { style: \"bold\" };\n\t\t\tsharedString.insertText(0, text, syleProps);\n\t\t\t// Verify the text and properties via the interception wrapper. It should not have the user attributes.\n\t\t\tverifyString(sharedStringWithInterception, text, syleProps, 2);\n\n\t\t\t// Replace text via the underlying shared string.\n\t\t\ttext = \"aaa\";\n\t\t\tsyleProps = { style: \"italics \" };\n\t\t\tsharedString.replaceText(2, 3, \"aaa\", syleProps);\n\t\t\t// Verify the text and properties via the interception wrapper. It should not have the user attributes.\n\t\t\tverifyString(sharedStringWithInterception, \"12aaa\", syleProps, 2);\n\n\t\t\t// Annotate the shared string via the underlying shared string.\n\t\t\tconst colorProps = { color: \"green\" };\n\t\t\tsharedString.annotateRange(0, 5, colorProps);\n\t\t\t// Verify the text and properties via the interception wrapper. It should not have the user attributes.\n\t\t\tverifyString(sharedStringWithInterception, \"12aaa\", { ...syleProps, ...colorProps }, 2);\n\t\t});\n\n\t\t/**\n\t\t * This test calls a method on the wrapper from the interception callback which will cause an infinite\n\t\t * recursion. Verify that the wrapper detects this and asserts.\n\t\t * Also, verify that the object is not unusable after the assert.\n\t\t */\n\t\tit(\"should assert if a wrapper method is called from the callback causing infinite recursion\", async () => {\n\t\t\t// eslint-disable-next-line prefer-const\n\t\t\tlet sharedStringWithInterception: SharedString;\n\n\t\t\tconst propsInRecursiveCb = { fromRecursiveCb: \"true\" };\n\t\t\tlet useWrapper: boolean = true;\n\t\t\t// If useWrapper above is true, this interception callback calls a method on the wrapped object\n\t\t\t// causing an infinite recursion.\n\t\t\t// If useWrapper is false, it uses the passed shared string which does not cause recursion.\n\t\t\tfunction recursiveInterceptionCb(properties?: PropertySet) {\n\t\t\t\tconst ss = useWrapper ? sharedStringWithInterception : sharedString;\n\t\t\t\tss.annotateRange(0, 1, propsInRecursiveCb);\n\t\t\t\treturn { ...properties, ...userAttributes };\n\t\t\t}\n\n\t\t\t// Create the interception wrapper with the above callback. The set method should throw an assertion as this\n\t\t\t// will cause infinite recursion.\n\t\t\tsharedStringWithInterception = createSharedStringWithInterception(\n\t\t\t\tsharedString,\n\t\t\t\tdataStoreContext,\n\t\t\t\trecursiveInterceptionCb,\n\t\t\t);\n\n\t\t\tlet text: string = \"123\";\n\t\t\tconst props: PropertySet = { style: \"bold\" };\n\t\t\t// First, insert text via the unwrapped shared string so that we have something to annotate in the\n\t\t\t// recursiveInterceptionCb.\n\t\t\tsharedString.insertText(0, text, props);\n\n\t\t\tlet asserted: boolean = false;\n\t\t\ttry {\n\t\t\t\ttext = \"abc\";\n\t\t\t\t// Try to replace text.\n\t\t\t\tsharedStringWithInterception.replaceText(1, 2, text);\n\t\t\t} catch (error: any) {\n\t\t\t\tassert.strictEqual(\n\t\t\t\t\terror.message,\n\t\t\t\t\t\"0x0c8\",\n\t\t\t\t\t\"We should have caught an assert in replaceText because it detects an infinite recursion\",\n\t\t\t\t);\n\t\t\t\tasserted = true;\n\t\t\t}\n\t\t\tassert.equal(\n\t\t\t\tasserted,\n\t\t\t\ttrue,\n\t\t\t\t\"replaceText should have asserted because it detects inifinite recursion\",\n\t\t\t);\n\n\t\t\t// Verify that the object is still usable:\n\t\t\t// Set useWrapper to false and call replacetext on the wrapper again. Verify that we do not get an assert.\n\t\t\tuseWrapper = false;\n\t\t\ttext = \"test\";\n\t\t\tsharedStringWithInterception.replaceText(2, 3, text, props);\n\t\t\tverifyString(\n\t\t\t\tsharedStringWithInterception,\n\t\t\t\t\"12test\",\n\t\t\t\t{ ...props, ...userAttributes },\n\t\t\t\t2,\n\t\t\t);\n\n\t\t\t// Verify that the annotate on position 0 in the recursiveInterceptionCb annotated the attributes.\n\t\t\tverifyString(\n\t\t\t\tsharedStringWithInterception,\n\t\t\t\t\"12test\",\n\t\t\t\t{ ...props, ...propsInRecursiveCb },\n\t\t\t\t0,\n\t\t\t);\n\t\t});\n\t});\n});\n"]}

package/package.json

@@ -0,0 +1,151 @@
+{
+  "name": "@fluid-experimental/dds-interceptions",
+  "version": "2.0.0-dev-rc.2.0.0.245554",
+  "description": "Distributed Data Structures that support an interception callback",
+  "homepage": "https://fluidframework.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/FluidFramework.git",
+    "directory": "packages/framework/dds-interceptions"
+  },
+  "license": "MIT",
+  "author": "Microsoft and contributors",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/index.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./public": {
+      "import": {
+        "types": "./lib/dds-interceptions-public.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/dds-interceptions-public.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./internal": {
+      "import": {
+        "types": "./lib/index.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "c8": {
+    "all": true,
+    "cache-dir": "nyc/.cache",
+    "exclude": [
+      "src/test/**/*.*ts",
+      "dist/test/**/*.*js"
+    ],
+    "exclude-after-remap": false,
+    "include": [
+      "src/**/*.*ts",
+      "dist/**/*.*js"
+    ],
+    "report-dir": "nyc/report",
+    "reporter": [
+      "cobertura",
+      "html",
+      "text"
+    ],
+    "temp-directory": "nyc/.nyc_output"
+  },
+  "dependencies": {
+    "@fluidframework/core-utils": "2.0.0-dev-rc.2.0.0.245554",
+    "@fluidframework/map": "2.0.0-dev-rc.2.0.0.245554",
+    "@fluidframework/merge-tree": "2.0.0-dev-rc.2.0.0.245554",
+    "@fluidframework/runtime-definitions": "2.0.0-dev-rc.2.0.0.245554",
+    "@fluidframework/sequence": "2.0.0-dev-rc.2.0.0.245554"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.13.3",
+    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.2.0.0.245554",
+    "@fluid-tools/build-cli": "^0.34.0",
+    "@fluidframework/build-common": "^2.0.3",
+    "@fluidframework/build-tools": "^0.34.0",
+    "@fluidframework/eslint-config-fluid": "^5.1.0",
+    "@fluidframework/test-runtime-utils": "2.0.0-dev-rc.2.0.0.245554",
+    "@microsoft/api-extractor": "^7.42.3",
+    "@types/diff": "^3.5.1",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^18.19.0",
+    "c8": "^8.0.1",
+    "copyfiles": "^2.4.1",
+    "cross-env": "^7.0.3",
+    "diff": "^3.5.0",
+    "eslint": "~8.55.0",
+    "mocha": "^10.2.0",
+    "mocha-json-output-reporter": "^2.0.1",
+    "mocha-multi-reporters": "^1.5.1",
+    "moment": "^2.21.0",
+    "prettier": "~3.0.3",
+    "rimraf": "^4.4.0",
+    "typescript": "~5.1.6"
+  },
+  "fluidBuild": {
+    "tasks": {
+      "build:docs": {
+        "dependsOn": [
+          "...",
+          "api-extractor:commonjs",
+          "api-extractor:esnext"
+        ],
+        "script": false
+      }
+    }
+  },
+  "typeValidation": {
+    "disabled": true,
+    "broken": {}
+  },
+  "scripts": {
+    "api": "fluid-build . --task api",
+    "api-extractor:commonjs": "api-extractor run --config ./api-extractor-cjs.json",
+    "api-extractor:esnext": "api-extractor run --local",
+    "build": "fluid-build . --task build",
+    "build:commonjs": "fluid-build . --task commonjs",
+    "build:compile": "fluid-build . --task compile",
+    "build:compile:min": "npm run build:compile",
+    "build:docs": "fluid-build . --task api",
+    "build:esnext": "tsc --project ./tsconfig.json",
+    "build:test": "npm run build:test:cjs && npm run build:test:esm",
+    "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
+    "build:test:esm": "tsc --project ./src/test/tsconfig.json",
+    "check:are-the-types-wrong": "attw --pack . --entrypoints .",
+    "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
+    "ci:build:docs": "api-extractor run",
+    "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
+    "eslint": "eslint --format stylish src",
+    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+    "format": "npm run prettier:fix",
+    "lint": "npm run prettier && npm run check:release-tags && npm run eslint",
+    "lint:fix": "npm run prettier:fix && npm run eslint:fix",
+    "prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
+    "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",
+    "test": "npm run test:mocha",
+    "test:coverage": "c8 npm test",
+    "test:mocha": "npm run test:mocha:esm && echo skipping cjs to avoid overhead - npm run test:mocha:cjs",
+    "test:mocha:cjs": "mocha --recursive \"dist/test/**/*.spec.*js\" --exit -r node_modules/@fluid-internal/mocha-test-setup",
+    "test:mocha:esm": "mocha --recursive \"lib/test/**/*.spec.*js\" --exit -r node_modules/@fluid-internal/mocha-test-setup",
+    "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
+    "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
+    "typetests:gen": "fluid-type-test-generator",
+    "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
+  }
+}

package/prettier.config.cjs

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+	...require("@fluidframework/build-common/prettier.config.cjs"),
+};

package/src/index.ts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export { createDirectoryWithInterception, createSharedMapWithInterception } from "./map/index.js";
+export { createSharedStringWithInterception } from "./sequence/index.js";

package/src/map/index.ts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export { createDirectoryWithInterception } from "./sharedDirectoryWithInterception.js";
+export { createSharedMapWithInterception } from "./sharedMapWithInterception.js";

package/src/map/sharedDirectoryWithInterception.ts

@@ -0,0 +1,172 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { assert } from "@fluidframework/core-utils";
+import { IDirectory } from "@fluidframework/map";
+import { IFluidDataStoreContext } from "@fluidframework/runtime-definitions";
+
+/**
+ * - Create a new object from the passed subDirectory.
+ *
+ * - Modify the set method to call the setInterceptionCallback before calling set on the underlying object.
+ *
+ * - The setInterceptionCallback and the call to the underlying object are wrapped around an orderSequentially
+ * call to batch any operations that might happen in the callback.
+ *
+ * - Modify the sub directory methods to create / return a wrapper object that in turn intercepts the set method and
+ * calls the setInterceptionCallback.
+ *
+ * - When a sub directory is created from this directory, this base directory object is passed to it which is passed
+ * into the interception callback.
+ *
+ * @param baseDirectory - The base directory in the directory structure that is passed to the interception callback
+ * @param subDirectory - The underlying object that is to be intercepted
+ * @param context - The IFluidDataStoreContext that will be used to call orderSequentially
+ * @param setInterceptionCallback - The interception callback to be called
+ *
+ * @returns A new sub directory that intercepts the set method and calls the setInterceptionCallback.
+ */
+function createSubDirectoryWithInterception<T extends IDirectory>(
+	baseDirectory: T,
+	subDirectory: T,
+	context: IFluidDataStoreContext,
+	setInterceptionCallback: (
+		baseDirectory: IDirectory,
+		subDirectory: IDirectory,
+		key: string,
+		value: any,
+	) => void,
+): T {
+	const subDirectoryWithInterception = Object.create(subDirectory);
+
+	// executingCallback keeps track of whether set is called recursively from the setInterceptionCallback.
+	let executingCallback: boolean = false;
+
+	subDirectoryWithInterception.set = (key: string, value: any) => {
+		let directory;
+		// Set should not be called on the wrapped object from the interception callback as this will lead to
+		// infinite recursion.
+		assert(
+			executingCallback === false,
+			0x0bf /* "set called recursively from the interception callback" */,
+		);
+
+		context.containerRuntime.orderSequentially(() => {
+			directory = subDirectory.set(key, value);
+			executingCallback = true;
+			try {
+				setInterceptionCallback(baseDirectory, subDirectory, key, value);
+			} finally {
+				executingCallback = false;
+			}
+		});
+		// eslint-disable-next-line @typescript-eslint/no-unsafe-return
+		return directory;
+	};
+
+	subDirectoryWithInterception.createSubDirectory = (subdirName: string): IDirectory => {
+		const subSubDirectory = subDirectory.createSubDirectory(subdirName);
+		return createSubDirectoryWithInterception(
+			baseDirectory,
+			subSubDirectory,
+			context,
+			setInterceptionCallback,
+		);
+	};
+
+	subDirectoryWithInterception.getSubDirectory = (subdirName: string): IDirectory | undefined => {
+		const subSubDirectory = subDirectory.getSubDirectory(subdirName);
+		return subSubDirectory === undefined
+			? subSubDirectory
+			: createSubDirectoryWithInterception(
+					baseDirectory,
+					subSubDirectory,
+					context,
+					setInterceptionCallback,
+			  );
+	};
+
+	subDirectoryWithInterception.subdirectories = (): IterableIterator<[string, IDirectory]> => {
+		const localDirectoriesIterator = subDirectory.subdirectories();
+		const iterator = {
+			next(): IteratorResult<[string, IDirectory]> {
+				const nextVal = localDirectoriesIterator.next();
+				// eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
+				if (nextVal.done) {
+					return { value: undefined, done: true };
+				} else {
+					// Wrap the stored subdirectory in the interception wrapper.
+					const subDir = createSubDirectoryWithInterception(
+						baseDirectory,
+						nextVal.value[1],
+						context,
+						setInterceptionCallback,
+					);
+					return { value: [nextVal.value[0], subDir], done: false };
+				}
+			},
+			[Symbol.iterator]() {
+				return this;
+			},
+		};
+		return iterator;
+	};
+
+	subDirectoryWithInterception.getWorkingDirectory = (
+		relativePath: string,
+	): IDirectory | undefined => {
+		const subSubDirectory = subDirectory.getWorkingDirectory(relativePath);
+		return subSubDirectory === undefined
+			? subSubDirectory
+			: createSubDirectoryWithInterception(
+					baseDirectory,
+					subSubDirectory,
+					context,
+					setInterceptionCallback,
+			  );
+	};
+
+	// eslint-disable-next-line @typescript-eslint/no-unsafe-return
+	return subDirectoryWithInterception;
+}
+
+/**
+ * - Create a new object from the passed IDirectory object.
+ *
+ * - Modify the set method to call the setInterceptionCallback before calling set on the underlying object.
+ *
+ * - The setInterceptionCallback and the call to the underlying object are wrapped around an orderSequentially
+ * call to batch any operations that might happen in the callback.
+ *
+ * - Modify the sub directory methods to create / return a wrapper object that in turn intercepts the set method and
+ * calls the setInterceptionCallback.
+ *
+ * - When a sub directory is created from this directory, this directory object is passed to it which is passed into
+ * the interception callback.
+ *
+ * @param baseDirectory - The underlying object that is to be intercepted
+ * @param context - The IFluidDataStoreContext that will be used to call orderSequentially
+ * @param setInterceptionCallback - The interception callback to be called
+ *
+ * @returns A new IDirectory object that intercepts the set method and calls the setInterceptionCallback.
+ * @internal
+ */
+export function createDirectoryWithInterception<T extends IDirectory>(
+	baseDirectory: T,
+	context: IFluidDataStoreContext,
+	setInterceptionCallback: (
+		baseDirectory: IDirectory,
+		subDirectory: IDirectory,
+		key: string,
+		value: any,
+	) => void,
+): T {
+	return createSubDirectoryWithInterception(
+		baseDirectory,
+		baseDirectory,
+		context,
+		setInterceptionCallback,
+	);
+}

package/src/map/sharedMapWithInterception.ts

@@ -0,0 +1,58 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { assert } from "@fluidframework/core-utils";
+import { ISharedMap } from "@fluidframework/map";
+import { IFluidDataStoreContext } from "@fluidframework/runtime-definitions";
+
+/**
+ * - Create a new object from the passed SharedMap.
+ *
+ * - Modify the set method to call the setInterceptionCallback before calling set on the underlying SharedMap.
+ *
+ * - The setInterceptionCallback and the call to the underlying SharedMap are wrapped around an
+ * orderSequentially call to batch any operations that might happen in the callback.
+ *
+ * @param sharedMap - The underlying SharedMap
+ * @param context - The IFluidDataStoreContext that will be used to call orderSequentially
+ * @param setInterceptionCallback - The interception callback to be called
+ *
+ * @returns A new SharedMap that intercepts the set method and calls the setInterceptionCallback.
+ * @internal
+ */
+export function createSharedMapWithInterception(
+	sharedMap: ISharedMap,
+	context: IFluidDataStoreContext,
+	setInterceptionCallback: (sharedMap: ISharedMap, key: string, value: any) => void,
+): ISharedMap {
+	const sharedMapWithInterception = Object.create(sharedMap);
+
+	// executingCallback keeps track of whether set is called recursively from the setInterceptionCallback.
+	let executingCallback: boolean = false;
+
+	sharedMapWithInterception.set = (key: string, value: any) => {
+		let map;
+		// Set should not be called on the wrapped object from the interception callback as this will lead to
+		// infinite recursion.
+		assert(
+			executingCallback === false,
+			0x0c0 /* "set called recursively from the interception callback" */,
+		);
+
+		context.containerRuntime.orderSequentially(() => {
+			map = sharedMap.set(key, value);
+			executingCallback = true;
+			try {
+				setInterceptionCallback(sharedMap, key, value);
+			} finally {
+				executingCallback = false;
+			}
+		});
+		// eslint-disable-next-line @typescript-eslint/no-unsafe-return
+		return map;
+	};
+
+	return sharedMapWithInterception as ISharedMap;
+}

package/src/sequence/index.ts

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export { createSharedStringWithInterception } from "./sharedStringWithInterception.js";