@fluid-experimental/attributor 2.0.0-rc.2.0.2 → 2.0.0-rc.3.0.1

package/dist/attributor-alpha.d.ts

@@ -1,27 +0,0 @@
-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

@@ -1,31 +0,0 @@
-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

@@ -1,31 +0,0 @@
-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

@@ -1,127 +0,0 @@
-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]>;
-}
-
-/**
- * Creates an `IRuntimeAttributor` for usage with {@link mixinAttributor}.
- *
- * @remarks The attributor will only be populated with data once it's passed via scope to a container runtime load flow.
- *
- * @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.
- *
- * @remarks Attributors are only populated after the container runtime into which they are being injected 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 { }

package/lib/attributor-alpha.d.ts

@@ -1,27 +0,0 @@
-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/lib/attributor-beta.d.ts

@@ -1,31 +0,0 @@
-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/lib/attributor-public.d.ts

@@ -1,31 +0,0 @@
-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/lib/attributor-untrimmed.d.ts

@@ -1,127 +0,0 @@
-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]>;
-}
-
-/**
- * Creates an `IRuntimeAttributor` for usage with {@link mixinAttributor}.
- *
- * @remarks The attributor will only be populated with data once it's passed via scope to a container runtime load flow.
- *
- * @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.
- *
- * @remarks Attributors are only populated after the container runtime into which they are being injected 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 { }

package/lib/test/attribution/dirname.cjs

@@ -1,16 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports._dirname = void 0;
-// Problem:
-//   - `__dirname` is not defined in ESM
-//   - `import.meta.url` is not defined in CJS
-// Solution:
-//   - Export '__dirname' from a .cjs file in the same directory.
-//
-// Note that *.cjs files are always CommonJS, but can be imported from ESM.
-exports._dirname = __dirname;
-//# sourceMappingURL=dirname.cjs.map

package/lib/test/attribution/dirname.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"dirname.cjs","sourceRoot":"","sources":["../../../src/test/attribution/dirname.cts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,WAAW;AACX,wCAAwC;AACxC,8CAA8C;AAC9C,YAAY;AACZ,iEAAiE;AACjE,EAAE;AACF,2EAA2E;AAC9D,QAAA,QAAQ,GAAG,SAAS,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// Problem:\n//   - `__dirname` is not defined in ESM\n//   - `import.meta.url` is not defined in CJS\n// Solution:\n//   - Export '__dirname' from a .cjs file in the same directory.\n//\n// Note that *.cjs files are always CommonJS, but can be imported from ESM.\nexport const _dirname = __dirname;\n"]}