@fluid-experimental/attributor 2.0.0-dev-rc.1.0.0.224419

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/CHANGELOG.md

@@ -0,0 +1,122 @@
+# @fluid-experimental/attributor
+
+## 2.0.0-internal.8.0.0
+
+### Major Changes
+
+-   container-runtime: Removed `ContainerRuntime.load(...)` [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
+
+    The static method `ContainerRuntime.load(...)` has been removed. Please migrate all usage of this method to
+    `ContainerRuntime.loadRuntime(...)`.
+
+## 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
+
+-   Dependencies on @fluidframework/protocol-definitions package updated to 3.0.0 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    This included the following changes from the protocol-definitions release:
+
+    -   Updating signal interfaces for some planned improvements. The intention is split the interface between signals
+        submitted by clients to the server and the resulting signals sent from the server to clients.
+        -   A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has
+            been added, which will be the typing for signals sent from the client to the server. Both extend a new
+            ISignalMessageBase interface that contains common members.
+    -   The @fluidframework/common-definitions package dependency has been updated to version 1.0.0.
+
+-   Server upgrade: dependencies on Fluid server packages updated to 2.0.1 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    Dependencies on the following Fluid server package have been updated to version 2.0.1:
+
+    -   @fluidframework/gitresources: 2.0.1
+    -   @fluidframework/server-kafka-orderer: 2.0.1
+    -   @fluidframework/server-lambdas: 2.0.1
+    -   @fluidframework/server-lambdas-driver: 2.0.1
+    -   @fluidframework/server-local-server: 2.0.1
+    -   @fluidframework/server-memory-orderer: 2.0.1
+    -   @fluidframework/protocol-base: 2.0.1
+    -   @fluidframework/server-routerlicious: 2.0.1
+    -   @fluidframework/server-routerlicious-base: 2.0.1
+    -   @fluidframework/server-services: 2.0.1
+    -   @fluidframework/server-services-client: 2.0.1
+    -   @fluidframework/server-services-core: 2.0.1
+    -   @fluidframework/server-services-ordering-kafkanode: 2.0.1
+    -   @fluidframework/server-services-ordering-rdkafka: 2.0.1
+    -   @fluidframework/server-services-ordering-zookeeper: 2.0.1
+    -   @fluidframework/server-services-shared: 2.0.1
+    -   @fluidframework/server-services-telemetry: 2.0.1
+    -   @fluidframework/server-services-utils: 2.0.1
+    -   @fluidframework/server-test-utils: 2.0.1
+    -   tinylicious: 2.0.1
+
+-   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,144 @@
+# @fluid-experimental/attributor
+
+This package contains definitions and implementations for framework-provided attribution functionality.
+
+<!-- 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 `^`.
+
+Note that when depending on a library version of the form `2.0.0-internal.x.y.z`, called the Fluid internal version scheme,
+you must use a `>= <` dependency range (such as `>=2.0.0-internal.x.y.z <2.0.0-internal.w.0.0` where `w` is `x+1`).
+Standard `^` and `~` ranges will not work as expected.
+See the [@fluid-tools/version-tools](https://github.com/microsoft/FluidFramework/blob/main/build-tools/packages/version-tools/README.md)
+package for more information including tools to convert between version schemes.
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+## 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.
+
+<!-- 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-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.json"
+}

package/api-report/attributor.api.md

@@ -0,0 +1,71 @@
+## API Report File for "@fluid-experimental/attributor"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { AttributionInfo } from '@fluidframework/runtime-definitions';
+import { AttributionKey } from '@fluidframework/runtime-definitions';
+import { ContainerRuntime } from '@fluidframework/container-runtime';
+import { IAudience } from '@fluidframework/container-definitions';
+import { IDeltaManager } from '@fluidframework/container-definitions';
+import { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+
+// @internal
+export class Attributor implements IAttributor {
+    constructor(initialEntries?: Iterable<[number, AttributionInfo]>);
+    // (undocumented)
+    entries(): IterableIterator<[number, AttributionInfo]>;
+    getAttributionInfo(key: number): AttributionInfo;
+    // (undocumented)
+    protected readonly keyToInfo: Map<number, AttributionInfo>;
+    // (undocumented)
+    tryGetAttributionInfo(key: number): AttributionInfo | undefined;
+}
+
+// @internal (undocumented)
+export function createRuntimeAttributor(): IRuntimeAttributor;
+
+// @internal (undocumented)
+export const enableOnNewFileKey = "Fluid.Attribution.EnableOnNewFile";
+
+// @internal
+export interface IAttributor {
+    // (undocumented)
+    entries(): IterableIterator<[number, AttributionInfo]>;
+    getAttributionInfo(key: number): AttributionInfo;
+    // (undocumented)
+    tryGetAttributionInfo(key: number): AttributionInfo | undefined;
+}
+
+// @internal (undocumented)
+export interface IProvideRuntimeAttributor {
+    // (undocumented)
+    readonly IRuntimeAttributor: IRuntimeAttributor;
+}
+
+// @internal (undocumented)
+export const IRuntimeAttributor: keyof IProvideRuntimeAttributor;
+
+// @internal @sealed
+export interface IRuntimeAttributor extends IProvideRuntimeAttributor {
+    // (undocumented)
+    get(key: AttributionKey): AttributionInfo;
+    // (undocumented)
+    has(key: AttributionKey): boolean;
+    // (undocumented)
+    readonly isEnabled: boolean;
+}
+
+// @internal
+export const mixinAttributor: (Base?: typeof ContainerRuntime) => typeof ContainerRuntime;
+
+// @internal
+export class OpStreamAttributor extends Attributor implements IAttributor {
+    constructor(deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>, audience: IAudience, initialEntries?: Iterable<[number, AttributionInfo]>);
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/dist/attributor-alpha.d.ts

@@ -0,0 +1,27 @@
+import { AttributionInfo } from '@fluidframework/runtime-definitions';
+import { AttributionKey } from '@fluidframework/runtime-definitions';
+import { ContainerRuntime } from '@fluidframework/container-runtime';
+import { IAudience } from '@fluidframework/container-definitions';
+import { IDeltaManager } from '@fluidframework/container-definitions';
+import { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+
+/* Excluded from this release type: AttributionInfo */
+
+/* Excluded from this release type: Attributor */
+
+/* Excluded from this release type: createRuntimeAttributor */
+
+/* Excluded from this release type: enableOnNewFileKey */
+
+/* Excluded from this release type: IAttributor */
+
+/* Excluded from this release type: IProvideRuntimeAttributor */
+
+/* Excluded from this release type: IRuntimeAttributor */
+
+/* Excluded from this release type: mixinAttributor */
+
+/* Excluded from this release type: OpStreamAttributor */
+
+export { }

package/dist/attributor-beta.d.ts

@@ -0,0 +1,31 @@
+import { AttributionInfo } from '@fluidframework/runtime-definitions';
+import { AttributionKey } from '@fluidframework/runtime-definitions';
+import { ContainerRuntime } from '@fluidframework/container-runtime';
+import { IAudience } from '@fluidframework/container-definitions';
+import { IDeltaManager } from '@fluidframework/container-definitions';
+import { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+
+/* Excluded from this release type: AttributionInfo */
+
+/* Excluded from this release type: AttributionKey */
+
+/* Excluded from this release type: Attributor */
+
+/* Excluded from this release type: ContainerRuntime */
+
+/* Excluded from this release type: createRuntimeAttributor */
+
+/* Excluded from this release type: enableOnNewFileKey */
+
+/* Excluded from this release type: IAttributor */
+
+/* Excluded from this release type: IProvideRuntimeAttributor */
+
+/* Excluded from this release type: IRuntimeAttributor */
+
+/* Excluded from this release type: mixinAttributor */
+
+/* Excluded from this release type: OpStreamAttributor */
+
+export { }

package/dist/attributor-public.d.ts

@@ -0,0 +1,31 @@
+import { AttributionInfo } from '@fluidframework/runtime-definitions';
+import { AttributionKey } from '@fluidframework/runtime-definitions';
+import { ContainerRuntime } from '@fluidframework/container-runtime';
+import { IAudience } from '@fluidframework/container-definitions';
+import { IDeltaManager } from '@fluidframework/container-definitions';
+import { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+
+/* Excluded from this release type: AttributionInfo */
+
+/* Excluded from this release type: AttributionKey */
+
+/* Excluded from this release type: Attributor */
+
+/* Excluded from this release type: ContainerRuntime */
+
+/* Excluded from this release type: createRuntimeAttributor */
+
+/* Excluded from this release type: enableOnNewFileKey */
+
+/* Excluded from this release type: IAttributor */
+
+/* Excluded from this release type: IProvideRuntimeAttributor */
+
+/* Excluded from this release type: IRuntimeAttributor */
+
+/* Excluded from this release type: mixinAttributor */
+
+/* Excluded from this release type: OpStreamAttributor */
+
+export { }

package/dist/attributor-untrimmed.d.ts

@@ -0,0 +1,124 @@
+import { AttributionInfo } from '@fluidframework/runtime-definitions';
+import { AttributionKey } from '@fluidframework/runtime-definitions';
+import { ContainerRuntime } from '@fluidframework/container-runtime';
+import { IAudience } from '@fluidframework/container-definitions';
+import { IDeltaManager } from '@fluidframework/container-definitions';
+import { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+
+/**
+ * {@inheritdoc IAttributor}
+ * @internal
+ */
+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]>;
+}
+
+/**
+ * @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}.
+ * @internal
+ */
+export declare function createRuntimeAttributor(): IRuntimeAttributor;
+
+/**
+ * @internal
+ */
+export declare const enableOnNewFileKey = "Fluid.Attribution.EnableOnNewFile";
+
+/**
+ * Provides lookup between attribution keys and their associated attribution information.
+ * @internal
+ */
+export declare 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]>;
+}
+
+/**
+ * @internal
+ */
+export declare interface IProvideRuntimeAttributor {
+    readonly IRuntimeAttributor: IRuntimeAttributor;
+}
+
+/**
+ * @internal
+ */
+export declare const IRuntimeAttributor: keyof IProvideRuntimeAttributor;
+
+/**
+ * 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
+ * @internal
+ */
+export declare 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;
+}
+
+/**
+ * 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
+ * @internal
+ */
+export declare const mixinAttributor: (Base?: typeof ContainerRuntime) => typeof ContainerRuntime;
+
+/**
+ * Attributor which listens to an op stream and records entries for each op.
+ * Sequence numbers are used as attribution keys.
+ * @internal
+ */
+export declare class OpStreamAttributor extends Attributor implements IAttributor {
+    constructor(deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>, audience: IAudience, initialEntries?: Iterable<[number, AttributionInfo]>);
+}
+
+export { }