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

package/.eslintrc.cjs

@@ -0,0 +1,14 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+	extends: [
+		require.resolve("@fluidframework/eslint-config-fluid/minimal-deprecated"),
+		"prettier",
+	],
+	parserOptions: {
+		project: ["./tsconfig.json", "./src/test/tsconfig.json"],
+	},
+};

package/.mocharc.cjs

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+"use strict";
+
+const getFluidTestMochaConfig = require("@fluid-internal/mocha-test-setup/mocharc-common");
+
+const packageDir = __dirname;
+const config = getFluidTestMochaConfig(packageDir);
+module.exports = config;

package/CHANGELOG.md

@@ -0,0 +1,93 @@
+# @fluidframework/dds-interceptions
+
+## 2.0.0-rc.2.0.0
+
+### Minor Changes
+
+-   @fluidframework/dds-interceptions is now considered experimental ([#19679](https://github.com/microsoft/FluidFramework/issues/19679)) [181d802c9b](https://github.com/microsoft/FluidFramework/commits/181d802c9bb990ec3464d0c9d78126b05fa06cd3)
+
+    The DDS interception pattern was intended to support attribution scenarios but is now in process of being replaced by a different attributor approach. It is not recommended for use.
+
+## 2.0.0-rc.1.0.0
+
+Dependency updates only.
+
+## 2.0.0-internal.8.0.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.0.0
+
+### Major Changes
+
+-   Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
+
+## 2.0.0-internal.6.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.0.0
+
+### Major Changes
+
+-   Upgraded typescript transpilation target to ES2020 [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
+
+    Upgraded typescript transpilation target to ES2020. This is done in order to decrease the bundle sizes of Fluid Framework packages. This has provided size improvements across the board for ex. Loader, Driver, Runtime etc. Reduced bundle sizes helps to load lesser code in apps and hence also helps to improve the perf.If any app wants to target any older versions of browsers with which this target version is not compatible, then they can use packages like babel to transpile to a older target.
+
+## 2.0.0-internal.5.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.0.0
+
+Dependency updates only.
+
+## 2.0.0-internal.4.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.4.1.0
+
+Dependency updates only.

package/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,95 @@
+# @fluid-experimental/dds-interceptions
+
+This package provides factory methods to create a wrapper around some of the basic Distributed Data Structures (DDS) that support an interception callback. Apps can provide a callback when creating these wrappers and this callback will be called when the DDS is modified. This allows apps to support features such as basic user attribution on a SharedString.
+
+<!-- AUTO-GENERATED-CONTENT:START (README_DEPENDENCY_GUIDELINES_SECTION:includeHeading=TRUE) -->
+
+<!-- prettier-ignore-start -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+
+## Using Fluid Framework libraries
+
+When taking a dependency on a Fluid Framework library, we recommend using a `^` (caret) version range, such as `^1.3.4`.
+While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
+library consumers should always prefer `^`.
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+## Shared String With Interception
+
+It provides `createSharedStringWithInterception` that accepts a SharedString, the data store context and a callback, and returns a SharedString object:
+
+```typescript
+function createSharedStringWithInterception(
+	sharedString: SharedString,
+	context: IFluidDataStoreContext,
+	propertyInterceptionCallback: (props?: MergeTree.PropertySet) => MergeTree.PropertySet,
+): SharedString;
+```
+
+When a function is called that modifies the SharedString (for example, insertText), it calls propertyInterceptionCallback with the provided properties. The callback function can then provide the new set of properties that it wants to set. The operation in the called function and any operations in the callback are batched, i.e., they are guaranteed to be in order and will be applied together.
+
+For example, to support a feature like simple user attribution, the app can append the user information to the properties in the callback. The user information can than be retrieved by getting the properties at any position.
+
+## Shared Map With Interception
+
+It provides `createSharedMapWithInterception` that accepts a SharedMap, the data store context and a callback, and returns a SharedMap object:
+
+```typescript
+function createSharedMapWithInterception(
+	sharedMap: SharedMap,
+	context: IFluidDataStoreContext,
+	setInterceptionCallback: (sharedMap: ISharedMap, key: string, value: any) => void,
+): SharedMap;
+```
+
+When set is called on the SharedMap, it calls setInterceptionCallback with the underlying SharedMap, the key and value that the set was called with. The callback function can then perform operations on either the underlying SharedMap or any other DDS. The original set operation and any operations in the callback are batched, i.e., they are guaranteed to be in order and will be applied together.
+
+Example: To support a feature like simple user attribution, in the callback, the app can set the user information in the underlying SharedMap against a key derived from the original key - say against "key.attribute". Or, it could use a separate SharedMap to store the user information against the same key.
+
+## Shared Directory / Sub Directory With Interception
+
+It provides `createdDirectoryWithInterception` that accepts an IDirectory object, the data store context and a callback, and returns an IDirectory object:
+
+```typescript
+function createDirectoryWithInterception<T extends IDirectory>(
+	baseDirectory: T,
+	context: IFluidDataStoreContext,
+	setInterceptionCallback: (
+		baseDirectory: IDirectory,
+		subDirectory: IDirectory,
+		key: string,
+		value: any,
+	) => void,
+): T;
+```
+
+It can be used to wrap a SharedDirectory or one of it's subdirectories to get an interception callback when set is called on the object. The callback function is passed the following:
+
+-   baseDirectory: This is the outermost directory in this directory structure that was wrapped. For example, when a SharedDirectory (say 'root') is wrapped, then a set on it or any of its sub directories will be passed 'root' as the baseDirectory.
+-   subDirectory: This is the directory that the set is called on and which calls the callback.
+-   key: They key that set was called with.
+-   value: They value that set was called with.
+
+The original set operation and any operations in the callback function are batched, i.e., they are guaranteed to in order and will be applied together.
+
+Example: To support a feature like simple user attribution, in the callback, the app can set the user information in a sub directory of the original object against the same key.
+
+<!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) -->
+
+<!-- prettier-ignore-start -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+
+## Trademark
+
+This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
+
+Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
+
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->

package/api-extractor-cjs.json

@@ -0,0 +1,8 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-base.cjs.primary.json",
+	// CJS is actually secondary; so, no report.
+	"apiReport": {
+		"enabled": false
+	}
+}

package/api-extractor-lint.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-lint.json"
+}

package/api-extractor.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-base.esm.primary.json"
+}

package/api-report/dds-interceptions.api.md

@@ -0,0 +1,24 @@
+## API Report File for "@fluid-experimental/dds-interceptions"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { IDirectory } from '@fluidframework/map';
+import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
+import { ISharedMap } from '@fluidframework/map';
+import * as MergeTree from '@fluidframework/merge-tree';
+import { SharedString } from '@fluidframework/sequence';
+
+// @internal
+export function createDirectoryWithInterception<T extends IDirectory>(baseDirectory: T, context: IFluidDataStoreContext, setInterceptionCallback: (baseDirectory: IDirectory, subDirectory: IDirectory, key: string, value: any) => void): T;
+
+// @internal
+export function createSharedMapWithInterception(sharedMap: ISharedMap, context: IFluidDataStoreContext, setInterceptionCallback: (sharedMap: ISharedMap, key: string, value: any) => void): ISharedMap;
+
+// @internal
+export function createSharedStringWithInterception(sharedString: SharedString, context: IFluidDataStoreContext, propertyInterceptionCallback: (props?: MergeTree.PropertySet) => MergeTree.PropertySet): SharedString;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/dist/dds-interceptions-alpha.d.ts

@@ -0,0 +1,13 @@
+import { IDirectory } from '@fluidframework/map';
+import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
+import { ISharedMap } from '@fluidframework/map';
+import * as MergeTree from '@fluidframework/merge-tree';
+import { SharedString } from '@fluidframework/sequence';
+
+/* Excluded from this release type: createDirectoryWithInterception */
+
+/* Excluded from this release type: createSharedMapWithInterception */
+
+/* Excluded from this release type: createSharedStringWithInterception */
+
+export { }

package/dist/dds-interceptions-beta.d.ts

@@ -0,0 +1,19 @@
+import { IDirectory } from '@fluidframework/map';
+import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
+import { ISharedMap } from '@fluidframework/map';
+import * as MergeTree from '@fluidframework/merge-tree';
+import { SharedString } from '@fluidframework/sequence';
+
+/* Excluded from this release type: createDirectoryWithInterception */
+
+/* Excluded from this release type: createSharedMapWithInterception */
+
+/* Excluded from this release type: createSharedStringWithInterception */
+
+/* Excluded from this release type: IDirectory */
+
+/* Excluded from this release type: IFluidDataStoreContext */
+
+/* Excluded from this release type: SharedString */
+
+export { }

package/dist/dds-interceptions-public.d.ts

@@ -0,0 +1,19 @@
+import { IDirectory } from '@fluidframework/map';
+import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
+import { ISharedMap } from '@fluidframework/map';
+import * as MergeTree from '@fluidframework/merge-tree';
+import { SharedString } from '@fluidframework/sequence';
+
+/* Excluded from this release type: createDirectoryWithInterception */
+
+/* Excluded from this release type: createSharedMapWithInterception */
+
+/* Excluded from this release type: createSharedStringWithInterception */
+
+/* Excluded from this release type: IDirectory */
+
+/* Excluded from this release type: IFluidDataStoreContext */
+
+/* Excluded from this release type: SharedString */
+
+export { }

package/dist/dds-interceptions-untrimmed.d.ts

@@ -0,0 +1,67 @@
+import { IDirectory } from '@fluidframework/map';
+import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
+import { ISharedMap } from '@fluidframework/map';
+import * as MergeTree from '@fluidframework/merge-tree';
+import { SharedString } from '@fluidframework/sequence';
+
+/**
+ * - 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 declare function createDirectoryWithInterception<T extends IDirectory>(baseDirectory: T, context: IFluidDataStoreContext, setInterceptionCallback: (baseDirectory: IDirectory, subDirectory: IDirectory, key: string, value: any) => void): T;
+
+/**
+ * - 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 declare function createSharedMapWithInterception(sharedMap: ISharedMap, context: IFluidDataStoreContext, setInterceptionCallback: (sharedMap: ISharedMap, key: string, value: any) => void): ISharedMap;
+
+/**
+ * - Create a new object from the passed SharedString.
+ *
+ * - Modify the methods that insert / remove / annotate the properties of the SharedString to call
+ * the propertyInterceptionCallback to get new properties.
+ *
+ * - Use these new properties to call the underlying SharedString.
+ *
+ * - The propertyInterceptionCallback and the call to the underlying SharedString are wrapped around an
+ * orderSequentially call to batch any operations that might happen in the callback.
+ *
+ * @param sharedString - The underlying SharedString
+ * @param context - The IFluidDataStoreContext that will be used to call orderSequentially
+ * @param propertyInterceptionCallback - The interception callback to be called
+ *
+ * @returns A new SharedString that intercepts the methods modifying the SharedString properties.
+ * @internal
+ */
+export declare function createSharedStringWithInterception(sharedString: SharedString, context: IFluidDataStoreContext, propertyInterceptionCallback: (props?: MergeTree.PropertySet) => MergeTree.PropertySet): SharedString;
+
+export { }

package/dist/index.d.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";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,+BAA+B,EAAE,+BAA+B,EAAE,MAAM,gBAAgB,CAAC;AAClG,OAAO,EAAE,kCAAkC,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/index.js

@@ -0,0 +1,13 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSharedStringWithInterception = exports.createSharedMapWithInterception = exports.createDirectoryWithInterception = void 0;
+var index_js_1 = require("./map/index.js");
+Object.defineProperty(exports, "createDirectoryWithInterception", { enumerable: true, get: function () { return index_js_1.createDirectoryWithInterception; } });
+Object.defineProperty(exports, "createSharedMapWithInterception", { enumerable: true, get: function () { return index_js_1.createSharedMapWithInterception; } });
+var index_js_2 = require("./sequence/index.js");
+Object.defineProperty(exports, "createSharedStringWithInterception", { enumerable: true, get: function () { return index_js_2.createSharedStringWithInterception; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2CAAkG;AAAzF,2HAAA,+BAA+B,OAAA;AAAE,2HAAA,+BAA+B,OAAA;AACzE,gDAAyE;AAAhE,8HAAA,kCAAkC,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { createDirectoryWithInterception, createSharedMapWithInterception } from \"./map/index.js\";\nexport { createSharedStringWithInterception } from \"./sequence/index.js\";\n"]}

package/dist/map/index.d.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";
+//# sourceMappingURL=index.d.ts.map

package/dist/map/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/map/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,+BAA+B,EAAE,MAAM,sCAAsC,CAAC;AACvF,OAAO,EAAE,+BAA+B,EAAE,MAAM,gCAAgC,CAAC"}

package/dist/map/index.js

@@ -0,0 +1,12 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSharedMapWithInterception = exports.createDirectoryWithInterception = void 0;
+var sharedDirectoryWithInterception_js_1 = require("./sharedDirectoryWithInterception.js");
+Object.defineProperty(exports, "createDirectoryWithInterception", { enumerable: true, get: function () { return sharedDirectoryWithInterception_js_1.createDirectoryWithInterception; } });
+var sharedMapWithInterception_js_1 = require("./sharedMapWithInterception.js");
+Object.defineProperty(exports, "createSharedMapWithInterception", { enumerable: true, get: function () { return sharedMapWithInterception_js_1.createSharedMapWithInterception; } });
+//# sourceMappingURL=index.js.map

package/dist/map/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/map/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2FAAuF;AAA9E,qJAAA,+BAA+B,OAAA;AACxC,+EAAiF;AAAxE,+IAAA,+BAA+B,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { createDirectoryWithInterception } from \"./sharedDirectoryWithInterception.js\";\nexport { createSharedMapWithInterception } from \"./sharedMapWithInterception.js\";\n"]}

package/dist/map/sharedDirectoryWithInterception.d.ts

@@ -0,0 +1,29 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IDirectory } from "@fluidframework/map";
+import { IFluidDataStoreContext } from "@fluidframework/runtime-definitions";
+/**
+ * - 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 declare function createDirectoryWithInterception<T extends IDirectory>(baseDirectory: T, context: IFluidDataStoreContext, setInterceptionCallback: (baseDirectory: IDirectory, subDirectory: IDirectory, key: string, value: any) => void): T;
+//# sourceMappingURL=sharedDirectoryWithInterception.d.ts.map

package/dist/map/sharedDirectoryWithInterception.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedDirectoryWithInterception.d.ts","sourceRoot":"","sources":["../../src/map/sharedDirectoryWithInterception.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AA+H7E;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,+BAA+B,CAAC,CAAC,SAAS,UAAU,EACnE,aAAa,EAAE,CAAC,EAChB,OAAO,EAAE,sBAAsB,EAC/B,uBAAuB,EAAE,CACxB,aAAa,EAAE,UAAU,EACzB,YAAY,EAAE,UAAU,EACxB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,GAAG,KACN,IAAI,GACP,CAAC,CAOH"}

package/dist/map/sharedDirectoryWithInterception.js

@@ -0,0 +1,117 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDirectoryWithInterception = void 0;
+const core_utils_1 = require("@fluidframework/core-utils");
+/**
+ * - 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(baseDirectory, subDirectory, context, setInterceptionCallback) {
+    const subDirectoryWithInterception = Object.create(subDirectory);
+    // executingCallback keeps track of whether set is called recursively from the setInterceptionCallback.
+    let executingCallback = false;
+    subDirectoryWithInterception.set = (key, value) => {
+        let directory;
+        // Set should not be called on the wrapped object from the interception callback as this will lead to
+        // infinite recursion.
+        (0, core_utils_1.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) => {
+        const subSubDirectory = subDirectory.createSubDirectory(subdirName);
+        return createSubDirectoryWithInterception(baseDirectory, subSubDirectory, context, setInterceptionCallback);
+    };
+    subDirectoryWithInterception.getSubDirectory = (subdirName) => {
+        const subSubDirectory = subDirectory.getSubDirectory(subdirName);
+        return subSubDirectory === undefined
+            ? subSubDirectory
+            : createSubDirectoryWithInterception(baseDirectory, subSubDirectory, context, setInterceptionCallback);
+    };
+    subDirectoryWithInterception.subdirectories = () => {
+        const localDirectoriesIterator = subDirectory.subdirectories();
+        const iterator = {
+            next() {
+                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) => {
+        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
+ */
+function createDirectoryWithInterception(baseDirectory, context, setInterceptionCallback) {
+    return createSubDirectoryWithInterception(baseDirectory, baseDirectory, context, setInterceptionCallback);
+}
+exports.createDirectoryWithInterception = createDirectoryWithInterception;
+//# sourceMappingURL=sharedDirectoryWithInterception.js.map

package/dist/map/sharedDirectoryWithInterception.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedDirectoryWithInterception.js","sourceRoot":"","sources":["../../src/map/sharedDirectoryWithInterception.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAoD;AAIpD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAS,kCAAkC,CAC1C,aAAgB,EAChB,YAAe,EACf,OAA+B,EAC/B,uBAKS;IAET,MAAM,4BAA4B,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAEjE,uGAAuG;IACvG,IAAI,iBAAiB,GAAY,KAAK,CAAC;IAEvC,4BAA4B,CAAC,GAAG,GAAG,CAAC,GAAW,EAAE,KAAU,EAAE,EAAE;QAC9D,IAAI,SAAS,CAAC;QACd,qGAAqG;QACrG,sBAAsB;QACtB,IAAA,mBAAM,EACL,iBAAiB,KAAK,KAAK,EAC3B,KAAK,CAAC,6DAA6D,CACnE,CAAC;QAEF,OAAO,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,EAAE;YAC/C,SAAS,GAAG,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACzC,iBAAiB,GAAG,IAAI,CAAC;YACzB,IAAI;gBACH,uBAAuB,CAAC,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;aACjE;oBAAS;gBACT,iBAAiB,GAAG,KAAK,CAAC;aAC1B;QACF,CAAC,CAAC,CAAC;QACH,+DAA+D;QAC/D,OAAO,SAAS,CAAC;IAClB,CAAC,CAAC;IAEF,4BAA4B,CAAC,kBAAkB,GAAG,CAAC,UAAkB,EAAc,EAAE;QACpF,MAAM,eAAe,GAAG,YAAY,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QACpE,OAAO,kCAAkC,CACxC,aAAa,EACb,eAAe,EACf,OAAO,EACP,uBAAuB,CACvB,CAAC;IACH,CAAC,CAAC;IAEF,4BAA4B,CAAC,eAAe,GAAG,CAAC,UAAkB,EAA0B,EAAE;QAC7F,MAAM,eAAe,GAAG,YAAY,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QACjE,OAAO,eAAe,KAAK,SAAS;YACnC,CAAC,CAAC,eAAe;YACjB,CAAC,CAAC,kCAAkC,CAClC,aAAa,EACb,eAAe,EACf,OAAO,EACP,uBAAuB,CACtB,CAAC;IACN,CAAC,CAAC;IAEF,4BAA4B,CAAC,cAAc,GAAG,GAA2C,EAAE;QAC1F,MAAM,wBAAwB,GAAG,YAAY,CAAC,cAAc,EAAE,CAAC;QAC/D,MAAM,QAAQ,GAAG;YAChB,IAAI;gBACH,MAAM,OAAO,GAAG,wBAAwB,CAAC,IAAI,EAAE,CAAC;gBAChD,yEAAyE;gBACzE,IAAI,OAAO,CAAC,IAAI,EAAE;oBACjB,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;iBACxC;qBAAM;oBACN,4DAA4D;oBAC5D,MAAM,MAAM,GAAG,kCAAkC,CAChD,aAAa,EACb,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAChB,OAAO,EACP,uBAAuB,CACvB,CAAC;oBACF,OAAO,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;iBAC1D;YACF,CAAC;YACD,CAAC,MAAM,CAAC,QAAQ,CAAC;gBAChB,OAAO,IAAI,CAAC;YACb,CAAC;SACD,CAAC;QACF,OAAO,QAAQ,CAAC;IACjB,CAAC,CAAC;IAEF,4BAA4B,CAAC,mBAAmB,GAAG,CAClD,YAAoB,EACK,EAAE;QAC3B,MAAM,eAAe,GAAG,YAAY,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACvE,OAAO,eAAe,KAAK,SAAS;YACnC,CAAC,CAAC,eAAe;YACjB,CAAC,CAAC,kCAAkC,CAClC,aAAa,EACb,eAAe,EACf,OAAO,EACP,uBAAuB,CACtB,CAAC;IACN,CAAC,CAAC;IAEF,+DAA+D;IAC/D,OAAO,4BAA4B,CAAC;AACrC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,+BAA+B,CAC9C,aAAgB,EAChB,OAA+B,EAC/B,uBAKS;IAET,OAAO,kCAAkC,CACxC,aAAa,EACb,aAAa,EACb,OAAO,EACP,uBAAuB,CACvB,CAAC;AACH,CAAC;AAhBD,0EAgBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils\";\nimport { IDirectory } from \"@fluidframework/map\";\nimport { IFluidDataStoreContext } from \"@fluidframework/runtime-definitions\";\n\n/**\n * - Create a new object from the passed subDirectory.\n *\n * - Modify the set method to call the setInterceptionCallback before calling set on the underlying object.\n *\n * - The setInterceptionCallback and the call to the underlying object are wrapped around an orderSequentially\n * call to batch any operations that might happen in the callback.\n *\n * - Modify the sub directory methods to create / return a wrapper object that in turn intercepts the set method and\n * calls the setInterceptionCallback.\n *\n * - When a sub directory is created from this directory, this base directory object is passed to it which is passed\n * into the interception callback.\n *\n * @param baseDirectory - The base directory in the directory structure that is passed to the interception callback\n * @param subDirectory - The underlying object that is to be intercepted\n * @param context - The IFluidDataStoreContext that will be used to call orderSequentially\n * @param setInterceptionCallback - The interception callback to be called\n *\n * @returns A new sub directory that intercepts the set method and calls the setInterceptionCallback.\n */\nfunction createSubDirectoryWithInterception<T extends IDirectory>(\n\tbaseDirectory: T,\n\tsubDirectory: T,\n\tcontext: IFluidDataStoreContext,\n\tsetInterceptionCallback: (\n\t\tbaseDirectory: IDirectory,\n\t\tsubDirectory: IDirectory,\n\t\tkey: string,\n\t\tvalue: any,\n\t) => void,\n): T {\n\tconst subDirectoryWithInterception = Object.create(subDirectory);\n\n\t// executingCallback keeps track of whether set is called recursively from the setInterceptionCallback.\n\tlet executingCallback: boolean = false;\n\n\tsubDirectoryWithInterception.set = (key: string, value: any) => {\n\t\tlet directory;\n\t\t// Set should not be called on the wrapped object from the interception callback as this will lead to\n\t\t// infinite recursion.\n\t\tassert(\n\t\t\texecutingCallback === false,\n\t\t\t0x0bf /* \"set called recursively from the interception callback\" */,\n\t\t);\n\n\t\tcontext.containerRuntime.orderSequentially(() => {\n\t\t\tdirectory = subDirectory.set(key, value);\n\t\t\texecutingCallback = true;\n\t\t\ttry {\n\t\t\t\tsetInterceptionCallback(baseDirectory, subDirectory, key, value);\n\t\t\t} finally {\n\t\t\t\texecutingCallback = false;\n\t\t\t}\n\t\t});\n\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-return\n\t\treturn directory;\n\t};\n\n\tsubDirectoryWithInterception.createSubDirectory = (subdirName: string): IDirectory => {\n\t\tconst subSubDirectory = subDirectory.createSubDirectory(subdirName);\n\t\treturn createSubDirectoryWithInterception(\n\t\t\tbaseDirectory,\n\t\t\tsubSubDirectory,\n\t\t\tcontext,\n\t\t\tsetInterceptionCallback,\n\t\t);\n\t};\n\n\tsubDirectoryWithInterception.getSubDirectory = (subdirName: string): IDirectory | undefined => {\n\t\tconst subSubDirectory = subDirectory.getSubDirectory(subdirName);\n\t\treturn subSubDirectory === undefined\n\t\t\t? subSubDirectory\n\t\t\t: createSubDirectoryWithInterception(\n\t\t\t\t\tbaseDirectory,\n\t\t\t\t\tsubSubDirectory,\n\t\t\t\t\tcontext,\n\t\t\t\t\tsetInterceptionCallback,\n\t\t\t  );\n\t};\n\n\tsubDirectoryWithInterception.subdirectories = (): IterableIterator<[string, IDirectory]> => {\n\t\tconst localDirectoriesIterator = subDirectory.subdirectories();\n\t\tconst iterator = {\n\t\t\tnext(): IteratorResult<[string, IDirectory]> {\n\t\t\t\tconst nextVal = localDirectoriesIterator.next();\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/strict-boolean-expressions\n\t\t\t\tif (nextVal.done) {\n\t\t\t\t\treturn { value: undefined, done: true };\n\t\t\t\t} else {\n\t\t\t\t\t// Wrap the stored subdirectory in the interception wrapper.\n\t\t\t\t\tconst subDir = createSubDirectoryWithInterception(\n\t\t\t\t\t\tbaseDirectory,\n\t\t\t\t\t\tnextVal.value[1],\n\t\t\t\t\t\tcontext,\n\t\t\t\t\t\tsetInterceptionCallback,\n\t\t\t\t\t);\n\t\t\t\t\treturn { value: [nextVal.value[0], subDir], done: false };\n\t\t\t\t}\n\t\t\t},\n\t\t\t[Symbol.iterator]() {\n\t\t\t\treturn this;\n\t\t\t},\n\t\t};\n\t\treturn iterator;\n\t};\n\n\tsubDirectoryWithInterception.getWorkingDirectory = (\n\t\trelativePath: string,\n\t): IDirectory | undefined => {\n\t\tconst subSubDirectory = subDirectory.getWorkingDirectory(relativePath);\n\t\treturn subSubDirectory === undefined\n\t\t\t? subSubDirectory\n\t\t\t: createSubDirectoryWithInterception(\n\t\t\t\t\tbaseDirectory,\n\t\t\t\t\tsubSubDirectory,\n\t\t\t\t\tcontext,\n\t\t\t\t\tsetInterceptionCallback,\n\t\t\t  );\n\t};\n\n\t// eslint-disable-next-line @typescript-eslint/no-unsafe-return\n\treturn subDirectoryWithInterception;\n}\n\n/**\n * - Create a new object from the passed IDirectory object.\n *\n * - Modify the set method to call the setInterceptionCallback before calling set on the underlying object.\n *\n * - The setInterceptionCallback and the call to the underlying object are wrapped around an orderSequentially\n * call to batch any operations that might happen in the callback.\n *\n * - Modify the sub directory methods to create / return a wrapper object that in turn intercepts the set method and\n * calls the setInterceptionCallback.\n *\n * - When a sub directory is created from this directory, this directory object is passed to it which is passed into\n * the interception callback.\n *\n * @param baseDirectory - The underlying object that is to be intercepted\n * @param context - The IFluidDataStoreContext that will be used to call orderSequentially\n * @param setInterceptionCallback - The interception callback to be called\n *\n * @returns A new IDirectory object that intercepts the set method and calls the setInterceptionCallback.\n * @internal\n */\nexport function createDirectoryWithInterception<T extends IDirectory>(\n\tbaseDirectory: T,\n\tcontext: IFluidDataStoreContext,\n\tsetInterceptionCallback: (\n\t\tbaseDirectory: IDirectory,\n\t\tsubDirectory: IDirectory,\n\t\tkey: string,\n\t\tvalue: any,\n\t) => void,\n): T {\n\treturn createSubDirectoryWithInterception(\n\t\tbaseDirectory,\n\t\tbaseDirectory,\n\t\tcontext,\n\t\tsetInterceptionCallback,\n\t);\n}\n"]}