@fluid-experimental/attributor 2.0.0-internal.3.3.0

package/.eslintrc.js

@@ -0,0 +1,20 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+	extends: [require.resolve("@fluidframework/eslint-config-fluid/minimal"), "prettier"],
+	parserOptions: {
+		project: ["./tsconfig.json", "./src/test/tsconfig.json"],
+	},
+	overrides: [
+		{
+			// Rules only for test files
+			files: ["*.spec.ts", "src/test/**"],
+			rules: {
+				"import/no-nodejs-modules": ["error", { allow: ["assert", "fs", "path"] }],
+			},
+		},
+	],
+};

package/.mocharc.js

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

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,106 @@
+# @fluid-experimental/attributor
+
+This package contains definitions and implementations for framework-provided attribution functionality.
+
+## Status
+
+All attribution APIs (both in this package and elsewhere in `@fluidframework` packages) are marked as [alpha](https://api-extractor.com/pages/tsdoc/tag_alpha/) to enable fast iteration (as third-party use is not officially supported, breaking API changes can be made in minor versions).
+
+Despite this, the APIs are generally ready for early adoption--feel free to play around with them in local setups and provide feedback on their shape, usability, or other factors!
+
+## Quickstart
+
+To turn on op-stream based attribution in your container, use `mixinAttributor` to create a `ContainerRuntime` class which supports querying for attribution information.
+When you instantiate your container runtime, pass a scope which implements `IProvideRuntimeAttributor`.
+
+```typescript
+import { ContainerRuntime } from "@fluidframework/container-runtime";
+import { mixinAttributor, createRuntimeAttributor } from "@fluid-experimental/attributor";
+
+const ContainerRuntimeWithAttribution = mixinAttributor(ContainerRuntime);
+
+// ...then, in your ContainerRuntime factory use this class:
+class ContainerRuntimeFactory implements IRuntimeFactory {
+	public async instantiateRuntime(
+		context: IContainerContext,
+		existing?: boolean,
+	): Promise<IRuntime> {
+		const attributor = createRuntimeAttributor();
+		// ...make this attributor accessible to your application however you deem fit; e.g. by registering it on a DependencyContainer.
+		// To inject loading and storing of attribution data on your runtime, provide a scope implementing IProvideRuntimeAttributor:
+		const scope: FluidObject<IProvideRuntimeAttributor> = { IRuntimeAttributor: attributor };
+		const runtime = await ContainerRuntimeWithAttribution.load(
+			context,
+			dataStoreRegistry,
+			undefined,
+			undefined,
+			scope,
+		);
+		// do whatever setup is necessary with the runtime here
+		return runtime;
+	}
+}
+```
+
+This will cause your container runtime to load attribution data available on existing containers.
+To additionally start storing attribution data on new documents, enable the config flag `"Fluid.Attribution.EnableOnNewFile"`.
+Be sure to also [enable any necessary options at the DDS level](#dds-support).
+For a more comprehensive list of backwards-compatability concerns which shed more light on these flags, see [integration](#integration).
+
+Applications can recover this information using APIs on the DDSes they use. For example, the following code snippet illustrates how that works for `SharedString`:
+
+```typescript
+function getAttributionInfo(
+	attributor: IRuntimeAttributor,
+	sharedString: SharedString,
+	pos: number,
+): AttributionInfo | undefined {
+	const { segment, offset } = sharedString.getContainingSegment(pos);
+	if (!segment || !offset) {
+		throw new UsageError("Invalid pos");
+	}
+	const attributionKey: AttributionKey = segment.attribution.getAtOffset(offset);
+	// BEWARE: DDSes may track attribution key with type "detached" and "local", which aren't yet
+	// supported out-of-the-box in IRuntimeAttributor. The application can recover AttributionInfo
+	// from these keys if it wants using user information about the creator of the document and the
+	// current active user, respectively.
+	if (attributor.has(attributionKey)) {
+		return attributor.get(attributionKey);
+	}
+}
+
+// Get the user who inserted the text at position 0 in `sharedString` and the timestamp for when they did so.
+const { user, timestamp } = getAttributionInfo(attributor, sharedString, 0);
+```
+
+## Overview
+
+Attribution is inherently a content-based operation--it answers questions about who created or changed a piece of content as well as when they did it.
+Since applications typically want attribution at a relatively fine-grained level, DDSes are the initial entrypoint for attributing content.
+A DDS may define its attribution API as it sees fit, but should somehow expose a way to retrieve attribution keys from its content.
+These attribution keys can be exchanged for user and timestamp information using the container runtime.
+
+### DDS Support
+
+The following DDSes currently support attribution:
+
+-   [SharedString](../../dds/sequence/README.md#attribution)
+
+### Op Stream Attribution
+
+Framework-provided attribution tracks user and timestamp information for each op submitted.
+Any more complex scenarios where attribution doesn't align with the direct submitter (such as attributing copy-pasted content to the original creators) will need to be handled by Fluid consumers using extensibility points.
+The extensibility APIs are a work in progress; check back later for more details.
+
+### Integration
+
+Backwards-compatability for using this mixin with existing documents is a work in progress.
+When an existing document is loaded that was created using a ContainerRuntimeFactory without a mixed in attributor,
+that document will continue to operate as if no attribution has been mixed in.
+Additionally, if a document that contains attribution is loaded using a container runtime without a mixed-in attributor,
+any attribution information stored in that document may be lost.
+
+The current design of the mixin's behavior is therefore motivated by the ability to roll out the feature in Fluid's collaborative environment.
+The behavior of `"Fluid.Attribution.WriteOnNewFile"` supports the standard strategy of rolling out code that reads a new format and waiting for it to saturate before beginning to write that new format.
+"reading the new format" corresponds to using a container runtime initialized with `mixinAttributor`, and "writing the new format" to enabling `"Fluid.Attribution.WriteOnNewFile"` in configuration.
+During the "waiting to saturate" period, developers are free to experiment with turning the feature flag on locally and testing various compatability scenarios.

package/api-extractor.json

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

package/dist/attributor.d.ts

@@ -0,0 +1,56 @@
+import { IDocumentMessage, ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
+import { AttributionInfo } from "@fluidframework/runtime-definitions";
+import { IAudience, IDeltaManager } from "@fluidframework/container-definitions";
+/**
+ * Provides lookup between attribution keys and their associated attribution information.
+ * @alpha
+ */
+export interface IAttributor {
+    /**
+     * Retrieves attribution information associated with a particular key.
+     * @param key - Attribution key to look up.
+     * @throws If no attribution information is recorded for that key.
+     */
+    getAttributionInfo(key: number): AttributionInfo;
+    /**
+     * @param key - Attribution key to look up.
+     * @returns the attribution information associated with the provided key, or undefined if no information exists.
+     */
+    tryGetAttributionInfo(key: number): AttributionInfo | undefined;
+    /**
+     * @returns an iterable of (attribution key, attribution info) pairs for each stored key.
+     */
+    entries(): IterableIterator<[number, AttributionInfo]>;
+}
+/**
+ * {@inheritdoc IAttributor}
+ * @alpha
+ */
+export declare class Attributor implements IAttributor {
+    protected readonly keyToInfo: Map<number, AttributionInfo>;
+    /**
+     * @param initialEntries - Any entries which should be populated on instantiation.
+     */
+    constructor(initialEntries?: Iterable<[number, AttributionInfo]>);
+    /**
+     * {@inheritdoc IAttributor.getAttributionInfo}
+     */
+    getAttributionInfo(key: number): AttributionInfo;
+    /**
+     * {@inheritdoc IAttributor.tryGetAttributionInfo}
+     */
+    tryGetAttributionInfo(key: number): AttributionInfo | undefined;
+    /**
+     * {@inheritdoc IAttributor.entries}
+     */
+    entries(): IterableIterator<[number, AttributionInfo]>;
+}
+/**
+ * Attributor which listens to an op stream and records entries for each op.
+ * Sequence numbers are used as attribution keys.
+ * @alpha
+ */
+export declare class OpStreamAttributor extends Attributor implements IAttributor {
+    constructor(deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>, audience: IAudience, initialEntries?: Iterable<[number, AttributionInfo]>);
+}
+//# sourceMappingURL=attributor.d.ts.map

package/dist/attributor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"attributor.d.ts","sourceRoot":"","sources":["../src/attributor.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACnG,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AAEtE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AAEjF;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B;;;;OAIG;IACH,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAC;IAEjD;;;OAGG;IACH,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS,CAAC;IAEhE;;OAEG;IACH,OAAO,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC;CAIvD;AAED;;;GAGG;AACH,qBAAa,UAAW,YAAW,WAAW;IAC7C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAE3D;;OAEG;gBACS,cAAc,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAIhE;;OAEG;IACI,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe;IAQvD;;OAEG;IACI,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAItE;;OAEG;IACI,OAAO,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAG7D;AAED;;;;GAIG;AACH,qBAAa,kBAAmB,SAAQ,UAAW,YAAW,WAAW;gBAEvE,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,EACxE,QAAQ,EAAE,SAAS,EACnB,cAAc,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAkBrD"}

package/dist/attributor.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpStreamAttributor = exports.Attributor = void 0;
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+const common_utils_1 = require("@fluidframework/common-utils");
+const container_utils_1 = require("@fluidframework/container-utils");
+/**
+ * {@inheritdoc IAttributor}
+ * @alpha
+ */
+class Attributor {
+    /**
+     * @param initialEntries - Any entries which should be populated on instantiation.
+     */
+    constructor(initialEntries) {
+        this.keyToInfo = new Map(initialEntries !== null && initialEntries !== void 0 ? initialEntries : []);
+    }
+    /**
+     * {@inheritdoc IAttributor.getAttributionInfo}
+     */
+    getAttributionInfo(key) {
+        const result = this.tryGetAttributionInfo(key);
+        if (!result) {
+            throw new container_utils_1.UsageError(`Requested attribution information for unstored key: ${key}.`);
+        }
+        return result;
+    }
+    /**
+     * {@inheritdoc IAttributor.tryGetAttributionInfo}
+     */
+    tryGetAttributionInfo(key) {
+        return this.keyToInfo.get(key);
+    }
+    /**
+     * {@inheritdoc IAttributor.entries}
+     */
+    entries() {
+        return this.keyToInfo.entries();
+    }
+}
+exports.Attributor = Attributor;
+/**
+ * Attributor which listens to an op stream and records entries for each op.
+ * Sequence numbers are used as attribution keys.
+ * @alpha
+ */
+class OpStreamAttributor extends Attributor {
+    constructor(deltaManager, audience, initialEntries) {
+        super(initialEntries);
+        deltaManager.on("op", (message) => {
+            const client = audience.getMember(message.clientId);
+            if (message.type === "op") {
+                // TODO: This case may be legitimate, and if so we need to figure out how to handle it.
+                (0, common_utils_1.assert)(client !== undefined, 0x4af /* Received message from user not in the audience */);
+                this.keyToInfo.set(message.sequenceNumber, {
+                    user: client.user,
+                    timestamp: message.timestamp,
+                });
+            }
+        });
+    }
+}
+exports.OpStreamAttributor = OpStreamAttributor;
+//# sourceMappingURL=attributor.js.map

package/dist/attributor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attributor.js","sourceRoot":"","sources":["../src/attributor.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+DAAsD;AAGtD,qEAA6D;AA8B7D;;;GAGG;AACH,MAAa,UAAU;IAGtB;;OAEG;IACH,YAAY,cAAoD;QAC/D,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,CAAC,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,EAAE,CAAC,CAAC;IAChD,CAAC;IAED;;OAEG;IACI,kBAAkB,CAAC,GAAW;QACpC,MAAM,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,EAAE;YACZ,MAAM,IAAI,4BAAU,CAAC,uDAAuD,GAAG,GAAG,CAAC,CAAC;SACpF;QACD,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;OAEG;IACI,qBAAqB,CAAC,GAAW;QACvC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,OAAO;QACb,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;IACjC,CAAC;CACD;AAlCD,gCAkCC;AAED;;;;GAIG;AACH,MAAa,kBAAmB,SAAQ,UAAU;IACjD,YACC,YAAwE,EACxE,QAAmB,EACnB,cAAoD;QAEpD,KAAK,CAAC,cAAc,CAAC,CAAC;QACtB,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,OAAkC,EAAE,EAAE;YAC5D,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACpD,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,EAAE;gBAC1B,uFAAuF;gBACvF,IAAA,qBAAM,EACL,MAAM,KAAK,SAAS,EACpB,KAAK,CAAC,oDAAoD,CAC1D,CAAC;gBACF,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,cAAc,EAAE;oBAC1C,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,SAAS,EAAE,OAAO,CAAC,SAAS;iBAC5B,CAAC,CAAC;aACH;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;CACD;AAtBD,gDAsBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { assert } from \"@fluidframework/common-utils\";\nimport { IDocumentMessage, ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { AttributionInfo } from \"@fluidframework/runtime-definitions\";\nimport { UsageError } from \"@fluidframework/container-utils\";\nimport { IAudience, IDeltaManager } from \"@fluidframework/container-definitions\";\n\n/**\n * Provides lookup between attribution keys and their associated attribution information.\n * @alpha\n */\nexport interface IAttributor {\n\t/**\n\t * Retrieves attribution information associated with a particular key.\n\t * @param key - Attribution key to look up.\n\t * @throws If no attribution information is recorded for that key.\n\t */\n\tgetAttributionInfo(key: number): AttributionInfo;\n\n\t/**\n\t * @param key - Attribution key to look up.\n\t * @returns the attribution information associated with the provided key, or undefined if no information exists.\n\t */\n\ttryGetAttributionInfo(key: number): AttributionInfo | undefined;\n\n\t/**\n\t * @returns an iterable of (attribution key, attribution info) pairs for each stored key.\n\t */\n\tentries(): IterableIterator<[number, AttributionInfo]>;\n\n\t// TODO:\n\t// - GC\n}\n\n/**\n * {@inheritdoc IAttributor}\n * @alpha\n */\nexport class Attributor implements IAttributor {\n\tprotected readonly keyToInfo: Map<number, AttributionInfo>;\n\n\t/**\n\t * @param initialEntries - Any entries which should be populated on instantiation.\n\t */\n\tconstructor(initialEntries?: Iterable<[number, AttributionInfo]>) {\n\t\tthis.keyToInfo = new Map(initialEntries ?? []);\n\t}\n\n\t/**\n\t * {@inheritdoc IAttributor.getAttributionInfo}\n\t */\n\tpublic getAttributionInfo(key: number): AttributionInfo {\n\t\tconst result = this.tryGetAttributionInfo(key);\n\t\tif (!result) {\n\t\t\tthrow new UsageError(`Requested attribution information for unstored key: ${key}.`);\n\t\t}\n\t\treturn result;\n\t}\n\n\t/**\n\t * {@inheritdoc IAttributor.tryGetAttributionInfo}\n\t */\n\tpublic tryGetAttributionInfo(key: number): AttributionInfo | undefined {\n\t\treturn this.keyToInfo.get(key);\n\t}\n\n\t/**\n\t * {@inheritdoc IAttributor.entries}\n\t */\n\tpublic entries(): IterableIterator<[number, AttributionInfo]> {\n\t\treturn this.keyToInfo.entries();\n\t}\n}\n\n/**\n * Attributor which listens to an op stream and records entries for each op.\n * Sequence numbers are used as attribution keys.\n * @alpha\n */\nexport class OpStreamAttributor extends Attributor implements IAttributor {\n\tconstructor(\n\t\tdeltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,\n\t\taudience: IAudience,\n\t\tinitialEntries?: Iterable<[number, AttributionInfo]>,\n\t) {\n\t\tsuper(initialEntries);\n\t\tdeltaManager.on(\"op\", (message: ISequencedDocumentMessage) => {\n\t\t\tconst client = audience.getMember(message.clientId);\n\t\t\tif (message.type === \"op\") {\n\t\t\t\t// TODO: This case may be legitimate, and if so we need to figure out how to handle it.\n\t\t\t\tassert(\n\t\t\t\t\tclient !== undefined,\n\t\t\t\t\t0x4af /* Received message from user not in the audience */,\n\t\t\t\t);\n\t\t\t\tthis.keyToInfo.set(message.sequenceNumber, {\n\t\t\t\t\tuser: client.user,\n\t\t\t\t\ttimestamp: message.timestamp,\n\t\t\t\t});\n\t\t\t}\n\t\t});\n\t}\n}\n"]}

package/dist/encoders.d.ts

@@ -0,0 +1,28 @@
+import { AttributionInfo } from "@fluidframework/runtime-definitions";
+import { IAttributor } from "./attributor";
+import { InternedStringId } from "./stringInterner";
+export interface Encoder<TDecoded, TEncoded> {
+    encode(decoded: TDecoded): TEncoded;
+    decode(encoded: TEncoded): TDecoded;
+}
+export declare type TimestampEncoder = Encoder<number[], number[]>;
+export declare const deltaEncoder: TimestampEncoder;
+export declare type IAttributorSerializer = Encoder<IAttributor, SerializedAttributor>;
+export interface SerializedAttributor {
+    interner: readonly string[];
+    seqs: number[];
+    timestamps: number[];
+    attributionRefs: InternedStringId[];
+}
+export declare class AttributorSerializer implements IAttributorSerializer {
+    private readonly makeAttributor;
+    private readonly timestampEncoder;
+    constructor(makeAttributor: (entries: Iterable<[number, AttributionInfo]>) => IAttributor, timestampEncoder: TimestampEncoder);
+    encode(attributor: IAttributor): SerializedAttributor;
+    decode(encoded: SerializedAttributor): IAttributor;
+}
+/**
+ * @returns an encoder which composes `a` and `b`.
+ */
+export declare const chain: <T1, T2, T3>(a: Encoder<T1, T2>, b: Encoder<T2, T3>) => Encoder<T1, T3>;
+//# sourceMappingURL=encoders.d.ts.map

package/dist/encoders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encoders.d.ts","sourceRoot":"","sources":["../src/encoders.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAyB,MAAM,kBAAkB,CAAC;AAE3E,MAAM,WAAW,OAAO,CAAC,QAAQ,EAAE,QAAQ;IAC1C,MAAM,CAAC,OAAO,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAEpC,MAAM,CAAC,OAAO,EAAE,QAAQ,GAAG,QAAQ,CAAC;CACpC;AAID,oBAAY,gBAAgB,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;AAE3D,eAAO,MAAM,YAAY,EAAE,gBAuB1B,CAAC;AAEF,oBAAY,qBAAqB,GAAG,OAAO,CAAC,WAAW,EAAE,oBAAoB,CAAC,CAAC;AAE/E,MAAM,WAAW,oBAAoB;IACpC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAA+D;IAC1F,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,eAAe,EAAE,gBAAgB,EAAE,CAAC;CACpC;AAED,qBAAa,oBAAqB,YAAW,qBAAqB;IAEhE,OAAO,CAAC,QAAQ,CAAC,cAAc;IAG/B,OAAO,CAAC,QAAQ,CAAC,gBAAgB;gBAHhB,cAAc,EAAE,CAChC,OAAO,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,KACxC,WAAW,EACC,gBAAgB,EAAE,gBAAgB;IAG7C,MAAM,CAAC,UAAU,EAAE,WAAW,GAAG,oBAAoB;IAsBrD,MAAM,CAAC,OAAO,EAAE,oBAAoB,GAAG,WAAW;CAkBzD;AAED;;GAEG;AACH,eAAO,MAAM,KAAK,yEAGhB,CAAC"}

package/dist/encoders.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.chain = exports.AttributorSerializer = exports.deltaEncoder = void 0;
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+const common_utils_1 = require("@fluidframework/common-utils");
+const stringInterner_1 = require("./stringInterner");
+exports.deltaEncoder = {
+    encode: (timestamps) => {
+        const deltaTimestamps = new Array(timestamps.length);
+        let prev = 0;
+        for (let i = 0; i < timestamps.length; i++) {
+            deltaTimestamps[i] = timestamps[i] - prev;
+            prev = timestamps[i];
+        }
+        return deltaTimestamps;
+    },
+    decode: (encoded) => {
+        (0, common_utils_1.assert)(Array.isArray(encoded), 0x4b0 /* Encoded timestamps should be an array of nummbers */);
+        const timestamps = new Array(encoded.length);
+        let cumulativeSum = 0;
+        for (let i = 0; i < encoded.length; i++) {
+            cumulativeSum += encoded[i];
+            timestamps[i] = cumulativeSum;
+        }
+        return timestamps;
+    },
+};
+class AttributorSerializer {
+    constructor(makeAttributor, timestampEncoder) {
+        this.makeAttributor = makeAttributor;
+        this.timestampEncoder = timestampEncoder;
+    }
+    encode(attributor) {
+        const interner = new stringInterner_1.MutableStringInterner();
+        const seqs = [];
+        const timestamps = [];
+        const attributionRefs = [];
+        for (const [seq, { user, timestamp }] of attributor.entries()) {
+            seqs.push(seq);
+            timestamps.push(timestamp);
+            const ref = interner.getOrCreateInternedId(JSON.stringify(user));
+            attributionRefs.push(ref);
+        }
+        const serialized = {
+            interner: interner.getSerializable(),
+            seqs,
+            timestamps: this.timestampEncoder.encode(timestamps),
+            attributionRefs,
+        };
+        return serialized;
+    }
+    decode(encoded) {
+        const interner = new stringInterner_1.MutableStringInterner(encoded.interner);
+        const { seqs, timestamps: encodedTimestamps, attributionRefs } = encoded;
+        const timestamps = this.timestampEncoder.decode(encodedTimestamps);
+        (0, common_utils_1.assert)(seqs.length === timestamps.length && timestamps.length === attributionRefs.length, 0x4b1 /* serialized attribution columns should have the same length */);
+        const entries = new Array(seqs.length);
+        for (let i = 0; i < seqs.length; i++) {
+            const key = seqs[i];
+            const timestamp = timestamps[i];
+            const ref = attributionRefs[i];
+            const user = JSON.parse(interner.getString(ref));
+            entries[i] = [key, { user, timestamp }];
+        }
+        return this.makeAttributor(entries);
+    }
+}
+exports.AttributorSerializer = AttributorSerializer;
+/**
+ * @returns an encoder which composes `a` and `b`.
+ */
+const chain = (a, b) => ({
+    encode: (content) => b.encode(a.encode(content)),
+    decode: (content) => a.decode(b.decode(content)),
+});
+exports.chain = chain;
+//# sourceMappingURL=encoders.js.map

package/dist/encoders.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"encoders.js","sourceRoot":"","sources":["../src/encoders.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+DAAsD;AAKtD,qDAA2E;AAY9D,QAAA,YAAY,GAAqB;IAC7C,MAAM,EAAE,CAAC,UAAoB,EAAE,EAAE;QAChC,MAAM,eAAe,GAAa,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC/D,IAAI,IAAI,GAAG,CAAC,CAAC;QACb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC3C,eAAe,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;YAC1C,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;SACrB;QACD,OAAO,eAAe,CAAC;IACxB,CAAC;IACD,MAAM,EAAE,CAAC,OAAiB,EAAE,EAAE;QAC7B,IAAA,qBAAM,EACL,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EACtB,KAAK,CAAC,uDAAuD,CAC7D,CAAC;QACF,MAAM,UAAU,GAAa,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACvD,IAAI,aAAa,GAAG,CAAC,CAAC;QACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACxC,aAAa,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;YAC5B,UAAU,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC;SAC9B;QACD,OAAO,UAAU,CAAC;IACnB,CAAC;CACD,CAAC;AAWF,MAAa,oBAAoB;IAChC,YACkB,cAED,EACC,gBAAkC;QAHlC,mBAAc,GAAd,cAAc,CAEf;QACC,qBAAgB,GAAhB,gBAAgB,CAAkB;IACjD,CAAC;IAEG,MAAM,CAAC,UAAuB;QACpC,MAAM,QAAQ,GAAG,IAAI,sCAAqB,EAAE,CAAC;QAC7C,MAAM,IAAI,GAAa,EAAE,CAAC;QAC1B,MAAM,UAAU,GAAa,EAAE,CAAC;QAChC,MAAM,eAAe,GAAuB,EAAE,CAAC;QAC/C,KAAK,MAAM,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE,EAAE;YAC9D,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACf,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC3B,MAAM,GAAG,GAAG,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;YACjE,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAC1B;QAED,MAAM,UAAU,GAAyB;YACxC,QAAQ,EAAE,QAAQ,CAAC,eAAe,EAAE;YACpC,IAAI;YACJ,UAAU,EAAE,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC;YACpD,eAAe;SACf,CAAC;QAEF,OAAO,UAAU,CAAC;IACnB,CAAC;IAEM,MAAM,CAAC,OAA6B;QAC1C,MAAM,QAAQ,GAAG,IAAI,sCAAqB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC7D,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,iBAAiB,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;QACzE,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;QACnE,IAAA,qBAAM,EACL,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,KAAK,eAAe,CAAC,MAAM,EACjF,KAAK,CAAC,gEAAgE,CACtE,CAAC;QACF,MAAM,OAAO,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACrC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACpB,MAAM,SAAS,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;YAChC,MAAM,GAAG,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC;YAC/B,MAAM,IAAI,GAAU,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;YACxD,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;SACxC;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;CACD;AAhDD,oDAgDC;AAED;;GAEG;AACI,MAAM,KAAK,GAAG,CAAa,CAAkB,EAAE,CAAkB,EAAmB,EAAE,CAAC,CAAC;IAC9F,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAChD,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;CAChD,CAAC,CAAC;AAHU,QAAA,KAAK,SAGf","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { assert } from \"@fluidframework/common-utils\";\nimport { Jsonable } from \"@fluidframework/datastore-definitions\";\nimport { IUser } from \"@fluidframework/protocol-definitions\";\nimport { AttributionInfo } from \"@fluidframework/runtime-definitions\";\nimport { IAttributor } from \"./attributor\";\nimport { InternedStringId, MutableStringInterner } from \"./stringInterner\";\n\nexport interface Encoder<TDecoded, TEncoded> {\n\tencode(decoded: TDecoded): TEncoded;\n\n\tdecode(encoded: TEncoded): TDecoded;\n}\n\n// Note: the encoded format doesn't matter as long as it's serializable;\n// these types could be weakened.\nexport type TimestampEncoder = Encoder<number[], number[]>;\n\nexport const deltaEncoder: TimestampEncoder = {\n\tencode: (timestamps: number[]) => {\n\t\tconst deltaTimestamps: number[] = new Array(timestamps.length);\n\t\tlet prev = 0;\n\t\tfor (let i = 0; i < timestamps.length; i++) {\n\t\t\tdeltaTimestamps[i] = timestamps[i] - prev;\n\t\t\tprev = timestamps[i];\n\t\t}\n\t\treturn deltaTimestamps;\n\t},\n\tdecode: (encoded: Jsonable) => {\n\t\tassert(\n\t\t\tArray.isArray(encoded),\n\t\t\t0x4b0 /* Encoded timestamps should be an array of nummbers */,\n\t\t);\n\t\tconst timestamps: number[] = new Array(encoded.length);\n\t\tlet cumulativeSum = 0;\n\t\tfor (let i = 0; i < encoded.length; i++) {\n\t\t\tcumulativeSum += encoded[i];\n\t\t\ttimestamps[i] = cumulativeSum;\n\t\t}\n\t\treturn timestamps;\n\t},\n};\n\nexport type IAttributorSerializer = Encoder<IAttributor, SerializedAttributor>;\n\nexport interface SerializedAttributor {\n\tinterner: readonly string[] /* result of calling getSerializable() on a StringInterner */;\n\tseqs: number[];\n\ttimestamps: number[];\n\tattributionRefs: InternedStringId[];\n}\n\nexport class AttributorSerializer implements IAttributorSerializer {\n\tconstructor(\n\t\tprivate readonly makeAttributor: (\n\t\t\tentries: Iterable<[number, AttributionInfo]>,\n\t\t) => IAttributor,\n\t\tprivate readonly timestampEncoder: TimestampEncoder,\n\t) {}\n\n\tpublic encode(attributor: IAttributor): SerializedAttributor {\n\t\tconst interner = new MutableStringInterner();\n\t\tconst seqs: number[] = [];\n\t\tconst timestamps: number[] = [];\n\t\tconst attributionRefs: InternedStringId[] = [];\n\t\tfor (const [seq, { user, timestamp }] of attributor.entries()) {\n\t\t\tseqs.push(seq);\n\t\t\ttimestamps.push(timestamp);\n\t\t\tconst ref = interner.getOrCreateInternedId(JSON.stringify(user));\n\t\t\tattributionRefs.push(ref);\n\t\t}\n\n\t\tconst serialized: SerializedAttributor = {\n\t\t\tinterner: interner.getSerializable(),\n\t\t\tseqs,\n\t\t\ttimestamps: this.timestampEncoder.encode(timestamps),\n\t\t\tattributionRefs,\n\t\t};\n\n\t\treturn serialized;\n\t}\n\n\tpublic decode(encoded: SerializedAttributor): IAttributor {\n\t\tconst interner = new MutableStringInterner(encoded.interner);\n\t\tconst { seqs, timestamps: encodedTimestamps, attributionRefs } = encoded;\n\t\tconst timestamps = this.timestampEncoder.decode(encodedTimestamps);\n\t\tassert(\n\t\t\tseqs.length === timestamps.length && timestamps.length === attributionRefs.length,\n\t\t\t0x4b1 /* serialized attribution columns should have the same length */,\n\t\t);\n\t\tconst entries = new Array(seqs.length);\n\t\tfor (let i = 0; i < seqs.length; i++) {\n\t\t\tconst key = seqs[i];\n\t\t\tconst timestamp = timestamps[i];\n\t\t\tconst ref = attributionRefs[i];\n\t\t\tconst user: IUser = JSON.parse(interner.getString(ref));\n\t\t\tentries[i] = [key, { user, timestamp }];\n\t\t}\n\t\treturn this.makeAttributor(entries);\n\t}\n}\n\n/**\n * @returns an encoder which composes `a` and `b`.\n */\nexport const chain = <T1, T2, T3>(a: Encoder<T1, T2>, b: Encoder<T2, T3>): Encoder<T1, T3> => ({\n\tencode: (content) => b.encode(a.encode(content)),\n\tdecode: (content) => a.decode(b.decode(content)),\n});\n"]}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { Attributor, OpStreamAttributor, IAttributor } from "./attributor";
+export { createRuntimeAttributor, enableOnNewFileKey, IProvideRuntimeAttributor, IRuntimeAttributor, mixinAttributor, } from "./mixinAttributor";
+//# 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;AACH,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3E,OAAO,EACN,uBAAuB,EACvB,kBAAkB,EAClB,yBAAyB,EACzB,kBAAkB,EAClB,eAAe,GACf,MAAM,mBAAmB,CAAC"}

package/dist/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mixinAttributor = exports.IRuntimeAttributor = exports.enableOnNewFileKey = exports.createRuntimeAttributor = exports.OpStreamAttributor = exports.Attributor = void 0;
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+var attributor_1 = require("./attributor");
+Object.defineProperty(exports, "Attributor", { enumerable: true, get: function () { return attributor_1.Attributor; } });
+Object.defineProperty(exports, "OpStreamAttributor", { enumerable: true, get: function () { return attributor_1.OpStreamAttributor; } });
+var mixinAttributor_1 = require("./mixinAttributor");
+Object.defineProperty(exports, "createRuntimeAttributor", { enumerable: true, get: function () { return mixinAttributor_1.createRuntimeAttributor; } });
+Object.defineProperty(exports, "enableOnNewFileKey", { enumerable: true, get: function () { return mixinAttributor_1.enableOnNewFileKey; } });
+Object.defineProperty(exports, "IRuntimeAttributor", { enumerable: true, get: function () { return mixinAttributor_1.IRuntimeAttributor; } });
+Object.defineProperty(exports, "mixinAttributor", { enumerable: true, get: function () { return mixinAttributor_1.mixinAttributor; } });
+//# 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;AACH,2CAA2E;AAAlE,wGAAA,UAAU,OAAA;AAAE,gHAAA,kBAAkB,OAAA;AACvC,qDAM2B;AAL1B,0HAAA,uBAAuB,OAAA;AACvB,qHAAA,kBAAkB,OAAA;AAElB,qHAAA,kBAAkB,OAAA;AAClB,kHAAA,eAAe,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nexport { Attributor, OpStreamAttributor, IAttributor } from \"./attributor\";\nexport {\n\tcreateRuntimeAttributor,\n\tenableOnNewFileKey,\n\tIProvideRuntimeAttributor,\n\tIRuntimeAttributor,\n\tmixinAttributor,\n} from \"./mixinAttributor\";\n"]}

package/dist/lz4Encoder.d.ts

@@ -0,0 +1,7 @@
+import { Jsonable } from "@fluidframework/datastore-definitions";
+import { Encoder } from "./encoders";
+/**
+ * @alpha
+ */
+export declare function makeLZ4Encoder<T>(): Encoder<Jsonable<T>, string>;
+//# sourceMappingURL=lz4Encoder.d.ts.map

package/dist/lz4Encoder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lz4Encoder.d.ts","sourceRoot":"","sources":["../src/lz4Encoder.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;GAEG;AACH,wBAAgB,cAAc,CAAC,CAAC,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAchE"}

package/dist/lz4Encoder.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeLZ4Encoder = void 0;
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+const lz4js_1 = require("lz4js");
+const common_utils_1 = require("@fluidframework/common-utils");
+/**
+ * @alpha
+ */
+function makeLZ4Encoder() {
+    return {
+        encode: (decoded) => {
+            const uncompressed = new TextEncoder().encode(JSON.stringify(decoded));
+            const compressed = (0, lz4js_1.compress)(uncompressed);
+            return (0, common_utils_1.bufferToString)(compressed, "base64");
+        },
+        decode: (serializedSummary) => {
+            const compressed = new Uint8Array((0, common_utils_1.stringToBuffer)(serializedSummary, "base64"));
+            const uncompressed = (0, lz4js_1.decompress)(compressed);
+            const decoded = JSON.parse(new TextDecoder().decode(uncompressed));
+            return decoded;
+        },
+    };
+}
+exports.makeLZ4Encoder = makeLZ4Encoder;
+//# sourceMappingURL=lz4Encoder.js.map

package/dist/lz4Encoder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lz4Encoder.js","sourceRoot":"","sources":["../src/lz4Encoder.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,iCAA6C;AAC7C,+DAA8E;AAI9E;;GAEG;AACH,SAAgB,cAAc;IAC7B,OAAO;QACN,MAAM,EAAE,CAAC,OAAoB,EAAE,EAAE;YAChC,MAAM,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;YACvE,MAAM,UAAU,GAAG,IAAA,gBAAQ,EAAC,YAAY,CAAC,CAAC;YAC1C,OAAO,IAAA,6BAAc,EAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC7C,CAAC;QACD,MAAM,EAAE,CAAC,iBAAyB,EAAe,EAAE;YAClD,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,IAAA,6BAAc,EAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC/E,MAAM,YAAY,GAAG,IAAA,kBAAU,EAAC,UAAU,CAAC,CAAC;YAC5C,MAAM,OAAO,GAAgB,IAAI,CAAC,KAAK,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;YAChF,OAAO,OAAO,CAAC;QAChB,CAAC;KACD,CAAC;AACH,CAAC;AAdD,wCAcC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { compress, decompress } from \"lz4js\";\nimport { bufferToString, stringToBuffer } from \"@fluidframework/common-utils\";\nimport { Jsonable } from \"@fluidframework/datastore-definitions\";\nimport { Encoder } from \"./encoders\";\n\n/**\n * @alpha\n */\nexport function makeLZ4Encoder<T>(): Encoder<Jsonable<T>, string> {\n\treturn {\n\t\tencode: (decoded: Jsonable<T>) => {\n\t\t\tconst uncompressed = new TextEncoder().encode(JSON.stringify(decoded));\n\t\t\tconst compressed = compress(uncompressed);\n\t\t\treturn bufferToString(compressed, \"base64\");\n\t\t},\n\t\tdecode: (serializedSummary: string): Jsonable<T> => {\n\t\t\tconst compressed = new Uint8Array(stringToBuffer(serializedSummary, \"base64\"));\n\t\t\tconst uncompressed = decompress(compressed);\n\t\t\tconst decoded: Jsonable<T> = JSON.parse(new TextDecoder().decode(uncompressed));\n\t\t\treturn decoded;\n\t\t},\n\t};\n}\n"]}

package/dist/mixinAttributor.d.ts

@@ -0,0 +1,60 @@
+import { ContainerRuntime } from "@fluidframework/container-runtime";
+import { AttributionInfo, AttributionKey } from "@fluidframework/runtime-definitions";
+/**
+ * @alpha
+ * Feature Gate Key -
+ * Whether or not a container runtime instantiated using `mixinAttributor`'s load should generate an attributor on
+ * new files. See package README for more notes on integration.
+ */
+export declare const enableOnNewFileKey = "Fluid.Attribution.EnableOnNewFile";
+/**
+ * @alpha
+ */
+export declare const IRuntimeAttributor: keyof IProvideRuntimeAttributor;
+/**
+ * @alpha
+ */
+export interface IProvideRuntimeAttributor {
+    readonly IRuntimeAttributor: IRuntimeAttributor;
+}
+/**
+ * Provides access to attribution information stored on the container runtime.
+ *
+ * Attributors are only populated after the container runtime they are injected into has initialized.
+ * @sealed
+ * @alpha
+ */
+export interface IRuntimeAttributor extends IProvideRuntimeAttributor {
+    /**
+     * @throws - If no AttributionInfo exists for this key.
+     */
+    get(key: AttributionKey): AttributionInfo;
+    /**
+     * @returns - Whether any AttributionInfo exists for the provided key.
+     */
+    has(key: AttributionKey): boolean;
+    /**
+     * @returns - Whether the runtime is currently tracking attribution information for the loaded container.
+     * See {@link mixinAttributor} for more details on when this happens.
+     */
+    readonly isEnabled: boolean;
+}
+/**
+ * @returns an IRuntimeAttributor for usage with `mixinAttributor`. The attributor will only be populated with data
+ * once it's passed via scope to a container runtime load flow. See {@link mixinAttributor}.
+ * @alpha
+ */
+export declare function createRuntimeAttributor(): IRuntimeAttributor;
+/**
+ * Mixes in logic to load and store runtime-based attribution functionality.
+ *
+ * The `scope` passed to `load` should implement `IProvideRuntimeAttributor`.
+ *
+ * Existing documents without stored attributors will not start storing attribution information: if an
+ * IRuntimeAttributor is passed via scope to load a document that never previously had attribution information,
+ * that attributor's `has` method will always return `false`.
+ * @param Base - base class, inherits from FluidAttributorRuntime
+ * @alpha
+ */
+export declare const mixinAttributor: (Base?: typeof ContainerRuntime) => typeof ContainerRuntime;
+//# sourceMappingURL=mixinAttributor.d.ts.map

package/dist/mixinAttributor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mixinAttributor.d.ts","sourceRoot":"","sources":["../src/mixinAttributor.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AAErE,OAAO,EACN,eAAe,EACf,cAAc,EAId,MAAM,qCAAqC,CAAC;AAe7C;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,sCAAsC,CAAC;AAEtE;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,MAAM,yBAAgD,CAAC;AAExF;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACzC,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;CAChD;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAmB,SAAQ,yBAAyB;IACpE;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,cAAc,GAAG,eAAe,CAAC;IAE1C;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC;IAElC;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;CAC5B;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,IAAI,kBAAkB,CAE5D;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,UAAU,uBAAuB,4BA+ErB,CAAC"}