@fluidframework/test-utils 1.4.0-115997 → 2.0.0-dev-rc.1.0.0.224419

package/api-report/test-utils.api.md

@@ -0,0 +1,395 @@
+## API Report File for "@fluidframework/test-utils"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ConfigTypes } from '@fluidframework/core-interfaces';
+import { ContainerRuntime } from '@fluidframework/container-runtime';
+import { ContainerRuntimeFactoryWithDefaultDataStore } from '@fluidframework/aqueduct';
+import { FluidDataStoreRuntime } from '@fluidframework/datastore';
+import { FluidObject } from '@fluidframework/core-interfaces';
+import { IChannelFactory } from '@fluidframework/datastore-definitions';
+import { ICodeDetailsLoader } from '@fluidframework/container-definitions';
+import { IConfigProviderBase } from '@fluidframework/core-interfaces';
+import { IContainer } from '@fluidframework/container-definitions';
+import { IContainerContext } from '@fluidframework/container-definitions';
+import { IContainerRuntime } from '@fluidframework/container-runtime-definitions';
+import { IContainerRuntimeOptions } from '@fluidframework/container-runtime';
+import { IDataStore } from '@fluidframework/runtime-definitions';
+import { IDocumentService } from '@fluidframework/driver-definitions';
+import { IDocumentServiceFactory } from '@fluidframework/driver-definitions';
+import { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import { IFluidCodeDetails } from '@fluidframework/container-definitions';
+import { IFluidDataStoreChannel } from '@fluidframework/runtime-definitions';
+import { IFluidDataStoreContext } from '@fluidframework/runtime-definitions';
+import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions';
+import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
+import { IFluidHandle } from '@fluidframework/core-interfaces';
+import { IFluidLoadable } from '@fluidframework/core-interfaces';
+import { IFluidModule } from '@fluidframework/container-definitions';
+import { IFluidModuleWithDetails } from '@fluidframework/container-definitions';
+import { IHostLoader } from '@fluidframework/container-definitions';
+import { ILoaderOptions } from '@fluidframework/container-definitions';
+import { ILoaderProps } from '@fluidframework/container-loader';
+import { IOnDemandSummarizeOptions } from '@fluidframework/container-runtime';
+import { IProvideFluidCodeDetailsComparer } from '@fluidframework/container-definitions';
+import { IProvideFluidDataStoreFactory } from '@fluidframework/runtime-definitions';
+import { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions';
+import { IProvideRuntimeFactory } from '@fluidframework/container-definitions';
+import { IRequest } from '@fluidframework/core-interfaces';
+import { IRequestHeader } from '@fluidframework/core-interfaces';
+import { IResolvedUrl } from '@fluidframework/driver-definitions';
+import { IResponse } from '@fluidframework/core-interfaces';
+import { IRuntime } from '@fluidframework/container-definitions';
+import { ISharedMap } from '@fluidframework/map';
+import { ISummarizer } from '@fluidframework/container-runtime';
+import { ISummaryContext } from '@fluidframework/driver-definitions';
+import { ISummaryTree } from '@fluidframework/protocol-definitions';
+import { ITelemetryBaseEvent } from '@fluidframework/core-interfaces';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITelemetryGenericEvent } from '@fluidframework/core-interfaces';
+import { ITestDriver } from '@fluidframework/test-driver-definitions';
+import { IUrlResolver } from '@fluidframework/driver-definitions';
+import { Loader } from '@fluidframework/container-loader';
+import { NamedFluidDataStoreRegistryEntries } from '@fluidframework/runtime-definitions';
+import { RuntimeRequestHandler } from '@fluidframework/request-handler';
+
+// @internal (undocumented)
+export type ChannelFactoryRegistry = Iterable<[string | undefined, IChannelFactory]>;
+
+// @alpha
+export function createAndAttachContainer(source: IFluidCodeDetails, loader: IHostLoader, attachRequest: IRequest): Promise<IContainer>;
+
+// @internal
+export const createContainerRuntimeFactoryWithDefaultDataStore: (Base: typeof ContainerRuntimeFactoryWithDefaultDataStore | undefined, ctorArgs: {
+    defaultFactory: IFluidDataStoreFactory;
+    registryEntries: NamedFluidDataStoreRegistryEntries;
+    dependencyContainer?: any;
+    requestHandlers?: RuntimeRequestHandler[] | undefined;
+    runtimeOptions?: IContainerRuntimeOptions | undefined;
+    provideEntryPoint?: ((runtime: IContainerRuntime) => Promise<FluidObject>) | undefined;
+}) => ContainerRuntimeFactoryWithDefaultDataStore;
+
+// @internal (undocumented)
+export const createDocumentId: () => string;
+
+// @internal
+export function createLoader(packageEntries: Iterable<[IFluidCodeDetails, fluidEntryPoint]>, documentServiceFactory: IDocumentServiceFactory, urlResolver: IUrlResolver, logger?: ITelemetryBaseLogger, options?: ILoaderOptions): IHostLoader;
+
+// @internal
+export function createSummarizer(provider: ITestObjectProvider, container: IContainer, config?: ITestContainerConfig, summaryVersion?: string, logger?: ITelemetryBaseLogger): Promise<{
+    container: IContainer;
+    summarizer: ISummarizer;
+}>;
+
+// @internal
+export function createSummarizerFromFactory(provider: ITestObjectProvider, container: IContainer, dataStoreFactory: IFluidDataStoreFactory, summaryVersion?: string, containerRuntimeFactoryType?: typeof ContainerRuntimeFactoryWithDefaultDataStore, registryEntries?: NamedFluidDataStoreRegistryEntries, logger?: ITelemetryBaseLogger, configProvider?: IConfigProviderBase): Promise<{
+    container: IContainer;
+    summarizer: ISummarizer;
+}>;
+
+// @internal
+export const createTestContainerRuntimeFactory: (containerRuntimeCtor: typeof ContainerRuntime) => {
+    new (type: string, dataStoreFactory: IFluidDataStoreFactory, runtimeOptions?: IContainerRuntimeOptions, requestHandlers?: RuntimeRequestHandler[]): {
+        type: string;
+        dataStoreFactory: IFluidDataStoreFactory;
+        runtimeOptions: IContainerRuntimeOptions;
+        requestHandlers: RuntimeRequestHandler[];
+        instantiateFirstTime(runtime: ContainerRuntime): Promise<void>;
+        instantiateFromExisting(runtime: ContainerRuntime): Promise<void>;
+        preInitialize(context: IContainerContext, existing: boolean): Promise<IRuntime & IContainerRuntime>;
+        readonly IRuntimeFactory: any;
+        instantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;
+        hasInitialized(_runtime: IContainerRuntime): Promise<void>;
+    };
+};
+
+// @internal (undocumented)
+export enum DataObjectFactoryType {
+    // (undocumented)
+    Primed = 0,
+    // (undocumented)
+    Test = 1
+}
+
+// @internal (undocumented)
+export const defaultTimeoutDurationMs = 250;
+
+// @internal
+export class EventAndErrorTrackingLogger implements ITelemetryBaseLogger {
+    constructor(baseLogger: ITelemetryBaseLogger);
+    // (undocumented)
+    registerExpectedEvent(...orderedExpectedEvents: ITelemetryGenericEvent[]): void;
+    // (undocumented)
+    reportAndClearTrackedEvents(): {
+        expectedNotFound: ({
+            index: number;
+            event: ITelemetryGenericEvent | undefined;
+        } | undefined)[];
+        unexpectedErrors: ITelemetryBaseEvent[];
+    };
+    // (undocumented)
+    send(event: ITelemetryBaseEvent): void;
+}
+
+// @internal (undocumented)
+export type fluidEntryPoint = SupportedExportInterfaces | IFluidModule;
+
+// @internal
+export function getContainerEntryPointBackCompat<T>(container: IContainer): Promise<T>;
+
+// @internal
+export function getDataStoreEntryPointBackCompat<T>(dataStore: IDataStore): Promise<T>;
+
+// @internal (undocumented)
+export function getUnexpectedLogErrorException(logger: EventAndErrorTrackingLogger | undefined, prefix?: string): Error | undefined;
+
+// @internal
+export interface IDocumentIdStrategy {
+    get(): string;
+    reset(): void;
+    update(resolvedUrl?: IResolvedUrl): void;
+}
+
+// @alpha (undocumented)
+export interface IOpProcessingController {
+    // (undocumented)
+    pauseProcessing(...containers: IContainer[]): Promise<void>;
+    // (undocumented)
+    processIncoming(...containers: IContainer[]): Promise<void>;
+    // (undocumented)
+    processOutgoing(...containers: IContainer[]): Promise<void>;
+    // (undocumented)
+    resumeProcessing(...containers: IContainer[]): void;
+}
+
+// @alpha (undocumented)
+export interface IProvideTestFluidObject {
+    // (undocumented)
+    readonly ITestFluidObject: ITestFluidObject;
+}
+
+// @internal (undocumented)
+export interface ITestContainerConfig {
+    enableAttribution?: boolean;
+    fluidDataObjectType?: DataObjectFactoryType;
+    loaderProps?: Partial<ILoaderProps>;
+    registry?: ChannelFactoryRegistry;
+    runtimeOptions?: IContainerRuntimeOptions;
+}
+
+// @alpha (undocumented)
+export interface ITestFluidObject extends IProvideTestFluidObject, IFluidLoadable {
+    // (undocumented)
+    readonly channel: IFluidDataStoreChannel;
+    // (undocumented)
+    readonly context: IFluidDataStoreContext;
+    // (undocumented)
+    getSharedObject<T = any>(id: string): Promise<T>;
+    // (undocumented)
+    root: ISharedMap;
+    // (undocumented)
+    readonly runtime: IFluidDataStoreRuntime;
+}
+
+// @internal (undocumented)
+export interface ITestObjectProvider {
+    createContainer(entryPoint: fluidEntryPoint, loaderProps?: Partial<ILoaderProps>): Promise<IContainer>;
+    createFluidEntryPoint: (testContainerConfig?: ITestContainerConfig) => fluidEntryPoint;
+    createLoader(packageEntries: Iterable<[IFluidCodeDetails, fluidEntryPoint]>, loaderProps?: Partial<ILoaderProps>): IHostLoader;
+    defaultCodeDetails: IFluidCodeDetails;
+    documentId: string;
+    documentServiceFactory: IDocumentServiceFactory;
+    driver: ITestDriver;
+    ensureSynchronized(timeoutDuration?: number): Promise<void>;
+    loadContainer(entryPoint: fluidEntryPoint, loaderProps?: Partial<ILoaderProps>, requestHeader?: IRequestHeader): Promise<IContainer>;
+    loadTestContainer(testContainerConfig?: ITestContainerConfig, requestHeader?: IRequestHeader): Promise<IContainer>;
+    logger: EventAndErrorTrackingLogger | undefined;
+    makeTestContainer(testContainerConfig?: ITestContainerConfig): Promise<IContainer>;
+    makeTestLoader(testContainerConfig?: ITestContainerConfig): IHostLoader;
+    opProcessingController: IOpProcessingController;
+    reset(): void;
+    resetLoaderContainerTracker(syncSummarizerClients?: boolean): any;
+    type: "TestObjectProvider" | "TestObjectProviderWithVersionedLoad";
+    updateDocumentId(url: IResolvedUrl | undefined): void;
+    urlResolver: IUrlResolver;
+}
+
+// @alpha (undocumented)
+export class LoaderContainerTracker implements IOpProcessingController {
+    constructor(syncSummarizerClients?: boolean);
+    add<LoaderType extends IHostLoader>(loader: LoaderType): void;
+    ensureSynchronized(...containers: IContainer[]): Promise<void>;
+    pauseProcessing(...containers: IContainer[]): Promise<void>;
+    processIncoming(...containers: IContainer[]): Promise<void>;
+    processOutgoing(...containers: IContainer[]): Promise<void>;
+    reset(): void;
+    resumeProcessing(...containers: IContainer[]): IContainer[];
+}
+
+// @internal
+export class LocalCodeLoader implements ICodeDetailsLoader {
+    constructor(packageEntries: Iterable<[IFluidCodeDetails, fluidEntryPoint]>, runtimeOptions?: IContainerRuntimeOptions);
+    load(source: IFluidCodeDetails): Promise<IFluidModuleWithDetails>;
+}
+
+// @internal (undocumented)
+export const mockConfigProvider: (settings?: Record<string, ConfigTypes>) => IConfigProviderBase;
+
+// @internal
+export const retryWithEventualValue: <T>(callback: () => Promise<T>, check: (value: T) => boolean, defaultValue: T, maxTries?: number, backOffMs?: number) => Promise<T>;
+
+// @internal
+export function summarizeNow(summarizer: ISummarizer, inputs?: string | IOnDemandSummarizeOptions): Promise<SummaryInfo>;
+
+// @internal
+export interface SummaryInfo {
+    summaryRefSeq: number;
+    summaryTree: ISummaryTree;
+    summaryVersion: string;
+}
+
+// @internal (undocumented)
+export type SupportedExportInterfaces = Partial<IProvideRuntimeFactory & IProvideFluidDataStoreFactory & IProvideFluidDataStoreRegistry & IProvideFluidCodeDetailsComparer>;
+
+// @internal
+export const TestContainerRuntimeFactory: {
+    new (type: string, dataStoreFactory: IFluidDataStoreFactory, runtimeOptions?: IContainerRuntimeOptions, requestHandlers?: RuntimeRequestHandler[]): {
+        type: string;
+        dataStoreFactory: IFluidDataStoreFactory;
+        runtimeOptions: IContainerRuntimeOptions;
+        requestHandlers: RuntimeRequestHandler[];
+        instantiateFirstTime(runtime: ContainerRuntime): Promise<void>;
+        instantiateFromExisting(runtime: ContainerRuntime): Promise<void>;
+        preInitialize(context: IContainerContext, existing: boolean): Promise<IRuntime & IContainerRuntime>;
+        readonly IRuntimeFactory: any;
+        instantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;
+        hasInitialized(_runtime: IContainerRuntime): Promise<void>;
+    };
+};
+
+// @internal
+export class TestFluidObject implements ITestFluidObject {
+    constructor(runtime: IFluidDataStoreRuntime, channel: IFluidDataStoreChannel, context: IFluidDataStoreContext, factoryEntriesMap: Map<string, IChannelFactory>);
+    // (undocumented)
+    readonly channel: IFluidDataStoreChannel;
+    // (undocumented)
+    readonly context: IFluidDataStoreContext;
+    getSharedObject<T = any>(id: string): Promise<T>;
+    // (undocumented)
+    get handle(): IFluidHandle<this>;
+    // (undocumented)
+    get IFluidLoadable(): this;
+    // (undocumented)
+    initialize(existing: boolean): Promise<void>;
+    // (undocumented)
+    get ITestFluidObject(): this;
+    // (undocumented)
+    request(request: IRequest): Promise<IResponse>;
+    // (undocumented)
+    root: ISharedMap;
+    // (undocumented)
+    readonly runtime: IFluidDataStoreRuntime;
+}
+
+// @internal
+export class TestFluidObjectFactory implements IFluidDataStoreFactory {
+    constructor(factoryEntries: ChannelFactoryRegistry, type?: string);
+    // (undocumented)
+    get IFluidDataStoreFactory(): this;
+    // (undocumented)
+    instantiateDataStore(context: IFluidDataStoreContext, existing: boolean): Promise<FluidDataStoreRuntime>;
+    // (undocumented)
+    readonly type: string;
+}
+
+// @internal
+export class TestObjectProvider implements ITestObjectProvider {
+    constructor(LoaderConstructor: typeof Loader,
+    driver: ITestDriver,
+    createFluidEntryPoint: (testContainerConfig?: ITestContainerConfig) => fluidEntryPoint);
+    createContainer(entryPoint: fluidEntryPoint, loaderProps?: Partial<ILoaderProps>): Promise<IContainer>;
+    readonly createFluidEntryPoint: (testContainerConfig?: ITestContainerConfig) => fluidEntryPoint;
+    createLoader(packageEntries: Iterable<[IFluidCodeDetails, fluidEntryPoint]>, loaderProps?: Partial<ILoaderProps>): Loader;
+    get defaultCodeDetails(): IFluidCodeDetails;
+    get documentId(): string;
+    get documentServiceFactory(): IDocumentServiceFactory;
+    readonly driver: ITestDriver;
+    ensureSynchronized(): Promise<void>;
+    loadContainer(entryPoint: fluidEntryPoint, loaderProps?: Partial<ILoaderProps>, requestHeader?: IRequestHeader): Promise<IContainer>;
+    loadTestContainer(testContainerConfig?: ITestContainerConfig, requestHeader?: IRequestHeader): Promise<IContainer>;
+    get logger(): EventAndErrorTrackingLogger;
+    makeTestContainer(testContainerConfig?: ITestContainerConfig): Promise<IContainer>;
+    makeTestLoader(testContainerConfig?: ITestContainerConfig): Loader;
+    get opProcessingController(): IOpProcessingController;
+    reset(): void;
+    resetLoaderContainerTracker(syncSummarizerClients?: boolean): void;
+    readonly type = "TestObjectProvider";
+    updateDocumentId(resolvedUrl: IResolvedUrl | undefined): void;
+    get urlResolver(): IUrlResolver;
+}
+
+// @internal
+export class TestObjectProviderWithVersionedLoad implements ITestObjectProvider {
+    constructor(LoaderConstructorForCreating: typeof Loader, LoaderConstructorForLoading: typeof Loader, driverForCreating: ITestDriver, driverForLoading: ITestDriver, createFluidEntryPointForCreating: (testContainerConfig?: ITestContainerConfig) => fluidEntryPoint, createFluidEntryPointForLoading: (testContainerConfig?: ITestContainerConfig) => fluidEntryPoint);
+    createContainer(entryPoint: fluidEntryPoint, loaderProps?: Partial<ILoaderProps>): Promise<IContainer>;
+    get createFluidEntryPoint(): (testContainerConfig?: ITestContainerConfig) => fluidEntryPoint;
+    createLoader(packageEntries: Iterable<[IFluidCodeDetails, fluidEntryPoint]>, loaderProps?: Partial<ILoaderProps>): Loader;
+    get defaultCodeDetails(): IFluidCodeDetails;
+    get documentId(): string;
+    get documentServiceFactory(): IDocumentServiceFactory;
+    get driver(): ITestDriver;
+    ensureSynchronized(): Promise<void>;
+    loadContainer(entryPoint: fluidEntryPoint, loaderProps?: Partial<ILoaderProps>, requestHeader?: IRequestHeader): Promise<IContainer>;
+    loadTestContainer(testContainerConfig?: ITestContainerConfig, requestHeader?: IRequestHeader): Promise<IContainer>;
+    get logger(): EventAndErrorTrackingLogger;
+    makeTestContainer(testContainerConfig?: ITestContainerConfig): Promise<IContainer>;
+    makeTestLoader(testContainerConfig?: ITestContainerConfig): Loader;
+    get opProcessingController(): IOpProcessingController;
+    reset(): void;
+    resetLoaderContainerTracker(syncSummarizerClients?: boolean): void;
+    readonly type = "TestObjectProviderWithVersionedLoad";
+    updateDocumentId(resolvedUrl: IResolvedUrl | undefined): void;
+    get urlResolver(): IUrlResolver;
+}
+
+// @internal
+export function timeoutAwait<T = void>(promise: PromiseLike<T>, timeoutOptions?: TimeoutWithError | TimeoutWithValue<T>): Promise<T>;
+
+// @internal
+export function timeoutPromise<T = void>(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void, timeoutOptions?: TimeoutWithError | TimeoutWithValue<T>): Promise<T>;
+
+// @internal (undocumented)
+export interface TimeoutWithError {
+    durationMs?: number;
+    // (undocumented)
+    errorMsg?: string;
+    // (undocumented)
+    reject?: true;
+}
+
+// @internal (undocumented)
+export interface TimeoutWithValue<T = void> {
+    durationMs?: number;
+    // (undocumented)
+    reject: false;
+    // (undocumented)
+    value: T;
+}
+
+// @internal
+export function waitForContainerConnection(container: IContainer, failOnContainerClose?: boolean, timeoutOptions?: TimeoutWithError): Promise<void>;
+
+// @internal
+export function wrapDocumentService(innerDocService: IDocumentService, uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext): IDocumentService;
+
+// @internal
+export function wrapDocumentServiceFactory(innerDocServiceFactory: IDocumentServiceFactory, uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext): IDocumentServiceFactory;
+
+// @internal
+export function wrapDocumentStorageService(innerDocStorageService: IDocumentStorageService, uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext): IDocumentStorageService;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/dist/DriverWrappers.d.ts

@@ -0,0 +1,32 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IDocumentService, IDocumentServiceFactory, IDocumentStorageService, ISummaryContext } from "@fluidframework/driver-definitions";
+import { ISummaryTree } from "@fluidframework/protocol-definitions";
+/**
+ * Wraps the given IDocumentStorageService to override the `uploadSummaryWithContext` method. It calls the
+ * `uploadSummaryCb` whenever a summary is uploaded by the client. The summary context can be updated in the
+ * callback before it is uploaded to the server.
+ * @internal
+ */
+export declare function wrapDocumentStorageService(innerDocStorageService: IDocumentStorageService, uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext): IDocumentStorageService;
+/**
+ * Wraps the given IDocumentService to override the `connectToStorage` method. The intent is to plumb the
+ * `uploadSummaryCb` to the IDocumentStorageService so that it is called whenever a summary is uploaded by
+ * the client.
+ * The document storage service that is created in `connectToStorage` is wrapped by calling `wrapDocumentStorageService`
+ * to pass in the `uploadSummaryCb`.
+ * @internal
+ */
+export declare function wrapDocumentService(innerDocService: IDocumentService, uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext): IDocumentService;
+/**
+ * Wraps the given IDocumentServiceFactory to override the `createDocumentService` method. The intent is to plumb
+ * the `uploadSummaryCb` all the way to the IDocumentStorageService so that it is called whenever a summary is
+ * uploaded by the client.
+ * The document service that is created in `createDocumentService` is wrapped by calling `wrapDocumentService` to
+ * pass in the `uploadSummaryCb`.
+ * @internal
+ */
+export declare function wrapDocumentServiceFactory(innerDocServiceFactory: IDocumentServiceFactory, uploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext): IDocumentServiceFactory;
+//# sourceMappingURL=DriverWrappers.d.ts.map

package/dist/DriverWrappers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DriverWrappers.d.ts","sourceRoot":"","sources":["../src/DriverWrappers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACN,gBAAgB,EAChB,uBAAuB,EACvB,uBAAuB,EAEvB,eAAe,EACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAEpE;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACzC,sBAAsB,EAAE,uBAAuB,EAC/C,eAAe,EAAE,CAAC,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,KAAK,eAAe,2BAWzF;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAClC,eAAe,EAAE,gBAAgB,EACjC,eAAe,EAAE,CAAC,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,KAAK,eAAe,oBAQzF;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACzC,sBAAsB,EAAE,uBAAuB,EAC/C,eAAe,EAAE,CAAC,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,KAAK,eAAe,2BAgBzF"}

package/dist/DriverWrappers.js

@@ -0,0 +1,57 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wrapDocumentServiceFactory = exports.wrapDocumentService = exports.wrapDocumentStorageService = void 0;
+/**
+ * Wraps the given IDocumentStorageService to override the `uploadSummaryWithContext` method. It calls the
+ * `uploadSummaryCb` whenever a summary is uploaded by the client. The summary context can be updated in the
+ * callback before it is uploaded to the server.
+ * @internal
+ */
+function wrapDocumentStorageService(innerDocStorageService, uploadSummaryCb) {
+    const outerDocStorageService = Object.create(innerDocStorageService);
+    outerDocStorageService.uploadSummaryWithContext = async (summary, context) => {
+        const newContext = uploadSummaryCb(summary, context);
+        return innerDocStorageService.uploadSummaryWithContext(summary, newContext);
+    };
+    return outerDocStorageService;
+}
+exports.wrapDocumentStorageService = wrapDocumentStorageService;
+/**
+ * Wraps the given IDocumentService to override the `connectToStorage` method. The intent is to plumb the
+ * `uploadSummaryCb` to the IDocumentStorageService so that it is called whenever a summary is uploaded by
+ * the client.
+ * The document storage service that is created in `connectToStorage` is wrapped by calling `wrapDocumentStorageService`
+ * to pass in the `uploadSummaryCb`.
+ * @internal
+ */
+function wrapDocumentService(innerDocService, uploadSummaryCb) {
+    const outerDocService = Object.create(innerDocService);
+    outerDocService.connectToStorage = async () => {
+        const storageService = await innerDocService.connectToStorage();
+        return wrapDocumentStorageService(storageService, uploadSummaryCb);
+    };
+    return outerDocService;
+}
+exports.wrapDocumentService = wrapDocumentService;
+/**
+ * Wraps the given IDocumentServiceFactory to override the `createDocumentService` method. The intent is to plumb
+ * the `uploadSummaryCb` all the way to the IDocumentStorageService so that it is called whenever a summary is
+ * uploaded by the client.
+ * The document service that is created in `createDocumentService` is wrapped by calling `wrapDocumentService` to
+ * pass in the `uploadSummaryCb`.
+ * @internal
+ */
+function wrapDocumentServiceFactory(innerDocServiceFactory, uploadSummaryCb) {
+    const outerDocServiceFactory = Object.create(innerDocServiceFactory);
+    outerDocServiceFactory.createDocumentService = async (resolvedUrl, logger, clientIsSummarizer) => {
+        const documentService = await innerDocServiceFactory.createDocumentService(resolvedUrl, logger, clientIsSummarizer);
+        return wrapDocumentService(documentService, uploadSummaryCb);
+    };
+    return outerDocServiceFactory;
+}
+exports.wrapDocumentServiceFactory = wrapDocumentServiceFactory;
+//# sourceMappingURL=DriverWrappers.js.map

package/dist/DriverWrappers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DriverWrappers.js","sourceRoot":"","sources":["../src/DriverWrappers.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAYH;;;;;GAKG;AACH,SAAgB,0BAA0B,CACzC,sBAA+C,EAC/C,eAAyF;IAEzF,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAA4B,CAAC;IAChG,sBAAsB,CAAC,wBAAwB,GAAG,KAAK,EACtD,OAAqB,EACrB,OAAwB,EACN,EAAE;QACpB,MAAM,UAAU,GAAG,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACrD,OAAO,sBAAsB,CAAC,wBAAwB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC7E,CAAC,CAAC;IACF,OAAO,sBAAsB,CAAC;AAC/B,CAAC;AAbD,gEAaC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CAClC,eAAiC,EACjC,eAAyF;IAEzF,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,eAAe,CAAqB,CAAC;IAC3E,eAAe,CAAC,gBAAgB,GAAG,KAAK,IAAsC,EAAE;QAC/E,MAAM,cAAc,GAAG,MAAM,eAAe,CAAC,gBAAgB,EAAE,CAAC;QAChE,OAAO,0BAA0B,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;IACpE,CAAC,CAAC;IACF,OAAO,eAAe,CAAC;AACxB,CAAC;AAVD,kDAUC;AAED;;;;;;;GAOG;AACH,SAAgB,0BAA0B,CACzC,sBAA+C,EAC/C,eAAyF;IAEzF,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAA4B,CAAC;IAChG,sBAAsB,CAAC,qBAAqB,GAAG,KAAK,EACnD,WAAyB,EACzB,MAA6B,EAC7B,kBAA4B,EACA,EAAE;QAC9B,MAAM,eAAe,GAAG,MAAM,sBAAsB,CAAC,qBAAqB,CACzE,WAAW,EACX,MAAM,EACN,kBAAkB,CAClB,CAAC;QACF,OAAO,mBAAmB,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;IAC9D,CAAC,CAAC;IACF,OAAO,sBAAsB,CAAC;AAC/B,CAAC;AAlBD,gEAkBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryBaseLogger } from \"@fluidframework/core-interfaces\";\nimport {\n\tIDocumentService,\n\tIDocumentServiceFactory,\n\tIDocumentStorageService,\n\tIResolvedUrl,\n\tISummaryContext,\n} from \"@fluidframework/driver-definitions\";\nimport { ISummaryTree } from \"@fluidframework/protocol-definitions\";\n\n/**\n * Wraps the given IDocumentStorageService to override the `uploadSummaryWithContext` method. It calls the\n * `uploadSummaryCb` whenever a summary is uploaded by the client. The summary context can be updated in the\n * callback before it is uploaded to the server.\n * @internal\n */\nexport function wrapDocumentStorageService(\n\tinnerDocStorageService: IDocumentStorageService,\n\tuploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext,\n) {\n\tconst outerDocStorageService = Object.create(innerDocStorageService) as IDocumentStorageService;\n\touterDocStorageService.uploadSummaryWithContext = async (\n\t\tsummary: ISummaryTree,\n\t\tcontext: ISummaryContext,\n\t): Promise<string> => {\n\t\tconst newContext = uploadSummaryCb(summary, context);\n\t\treturn innerDocStorageService.uploadSummaryWithContext(summary, newContext);\n\t};\n\treturn outerDocStorageService;\n}\n\n/**\n * Wraps the given IDocumentService to override the `connectToStorage` method. The intent is to plumb the\n * `uploadSummaryCb` to the IDocumentStorageService so that it is called whenever a summary is uploaded by\n * the client.\n * The document storage service that is created in `connectToStorage` is wrapped by calling `wrapDocumentStorageService`\n * to pass in the `uploadSummaryCb`.\n * @internal\n */\nexport function wrapDocumentService(\n\tinnerDocService: IDocumentService,\n\tuploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext,\n) {\n\tconst outerDocService = Object.create(innerDocService) as IDocumentService;\n\touterDocService.connectToStorage = async (): Promise<IDocumentStorageService> => {\n\t\tconst storageService = await innerDocService.connectToStorage();\n\t\treturn wrapDocumentStorageService(storageService, uploadSummaryCb);\n\t};\n\treturn outerDocService;\n}\n\n/**\n * Wraps the given IDocumentServiceFactory to override the `createDocumentService` method. The intent is to plumb\n * the `uploadSummaryCb` all the way to the IDocumentStorageService so that it is called whenever a summary is\n * uploaded by the client.\n * The document service that is created in `createDocumentService` is wrapped by calling `wrapDocumentService` to\n * pass in the `uploadSummaryCb`.\n * @internal\n */\nexport function wrapDocumentServiceFactory(\n\tinnerDocServiceFactory: IDocumentServiceFactory,\n\tuploadSummaryCb: (summaryTree: ISummaryTree, context: ISummaryContext) => ISummaryContext,\n) {\n\tconst outerDocServiceFactory = Object.create(innerDocServiceFactory) as IDocumentServiceFactory;\n\touterDocServiceFactory.createDocumentService = async (\n\t\tresolvedUrl: IResolvedUrl,\n\t\tlogger?: ITelemetryBaseLogger,\n\t\tclientIsSummarizer?: boolean,\n\t): Promise<IDocumentService> => {\n\t\tconst documentService = await innerDocServiceFactory.createDocumentService(\n\t\t\tresolvedUrl,\n\t\t\tlogger,\n\t\t\tclientIsSummarizer,\n\t\t);\n\t\treturn wrapDocumentService(documentService, uploadSummaryCb);\n\t};\n\treturn outerDocServiceFactory;\n}\n"]}

package/dist/TestConfigs.d.ts

@@ -0,0 +1,10 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ConfigTypes, IConfigProviderBase } from "@fluidframework/core-interfaces";
+/**
+ * @internal
+ */
+export declare const mockConfigProvider: (settings?: Record<string, ConfigTypes>) => IConfigProviderBase;
+//# sourceMappingURL=TestConfigs.d.ts.map

package/dist/TestConfigs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestConfigs.d.ts","sourceRoot":"","sources":["../src/TestConfigs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAEnF;;GAEG;AACH,eAAO,MAAM,kBAAkB,cACpB,OAAO,MAAM,EAAE,WAAW,CAAC,KACnC,mBAIF,CAAC"}

package/dist/TestConfigs.js

@@ -0,0 +1,17 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mockConfigProvider = void 0;
+/**
+ * @internal
+ */
+const mockConfigProvider = (settings = {}) => {
+    return {
+        getRawConfig: (name) => settings[name],
+    };
+};
+exports.mockConfigProvider = mockConfigProvider;
+//# sourceMappingURL=TestConfigs.js.map

package/dist/TestConfigs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestConfigs.js","sourceRoot":"","sources":["../src/TestConfigs.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;GAEG;AACI,MAAM,kBAAkB,GAAG,CACjC,WAAwC,EAAE,EACpB,EAAE;IACxB,OAAO;QACN,YAAY,EAAE,CAAC,IAAY,EAAe,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;KAC3D,CAAC;AACH,CAAC,CAAC;AANW,QAAA,kBAAkB,sBAM7B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ConfigTypes, IConfigProviderBase } from \"@fluidframework/core-interfaces\";\n\n/**\n * @internal\n */\nexport const mockConfigProvider = (\n\tsettings: Record<string, ConfigTypes> = {},\n): IConfigProviderBase => {\n\treturn {\n\t\tgetRawConfig: (name: string): ConfigTypes => settings[name],\n\t};\n};\n"]}

package/dist/TestSummaryUtils.d.ts

@@ -0,0 +1,61 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ContainerRuntimeFactoryWithDefaultDataStore } from "@fluidframework/aqueduct";
+import { IContainer } from "@fluidframework/container-definitions";
+import { IOnDemandSummarizeOptions, ISummarizer } from "@fluidframework/container-runtime";
+import { ITelemetryBaseLogger, IConfigProviderBase } from "@fluidframework/core-interfaces";
+import { IFluidDataStoreFactory, NamedFluidDataStoreRegistryEntries } from "@fluidframework/runtime-definitions";
+import { ISummaryTree } from "@fluidframework/protocol-definitions";
+import { ITestContainerConfig, ITestObjectProvider } from "./testObjectProvider";
+/**
+ * Creates a summarizer client from the given container and data store factory, and returns the summarizer client's
+ * IContainer and ISummarizer.
+ * The ISummarizer can be used to generate on-demand summaries. The IContainer can be used to fetch data stores, etc.
+ * @internal
+ */
+export declare function createSummarizerFromFactory(provider: ITestObjectProvider, container: IContainer, dataStoreFactory: IFluidDataStoreFactory, summaryVersion?: string, containerRuntimeFactoryType?: typeof ContainerRuntimeFactoryWithDefaultDataStore, registryEntries?: NamedFluidDataStoreRegistryEntries, logger?: ITelemetryBaseLogger, configProvider?: IConfigProviderBase): Promise<{
+    container: IContainer;
+    summarizer: ISummarizer;
+}>;
+/**
+ * Creates a summarizer client from the given container and returns the summarizer client's IContainer and ISummarizer.
+ * The ISummarizer can be used to generate on-demand summaries. The IContainer can be used to fetch data stores, etc.
+ *
+ * Can pass in a test config provider to enable/disable features.
+ * @internal
+ */
+export declare function createSummarizer(provider: ITestObjectProvider, container: IContainer, config?: ITestContainerConfig, summaryVersion?: string, logger?: ITelemetryBaseLogger): Promise<{
+    container: IContainer;
+    summarizer: ISummarizer;
+}>;
+/**
+ * Summarizes on demand and returns the summary tree, the version number and the reference sequence number of the
+ * submitted summary.
+ *
+ * @param summarizer - The ISummarizer to use to summarize on demand
+ * @param inputs - Either the reason string or the full IOnDemandSummarizeOptions.
+ * Defaults to the reason "end-to-end test".
+ * @internal
+ */
+export declare function summarizeNow(summarizer: ISummarizer, inputs?: string | IOnDemandSummarizeOptions): Promise<SummaryInfo>;
+/**
+ * Summary information containing the summary tree, summary version, and summary sequence number.
+ * @internal
+ */
+export interface SummaryInfo {
+    /**
+     * The summary tree generated
+     */
+    summaryTree: ISummaryTree;
+    /**
+     * Handle of the completed summary
+     */
+    summaryVersion: string;
+    /**
+     * Reference sequence number of the current summary generation
+     */
+    summaryRefSeq: number;
+}
+//# sourceMappingURL=TestSummaryUtils.d.ts.map

package/dist/TestSummaryUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestSummaryUtils.d.ts","sourceRoot":"","sources":["../src/TestSummaryUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,2CAA2C,EAAE,MAAM,0BAA0B,CAAC;AAEvF,OAAO,EAAE,UAAU,EAA6B,MAAM,uCAAuC,CAAC;AAC9F,OAAO,EACN,yBAAyB,EACzB,WAAW,EAEX,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACN,oBAAoB,EAGpB,mBAAmB,EACnB,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EACN,sBAAsB,EACtB,kCAAkC,EAClC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAsDjF;;;;;GAKG;AACH,wBAAsB,2BAA2B,CAChD,QAAQ,EAAE,mBAAmB,EAC7B,SAAS,EAAE,UAAU,EACrB,gBAAgB,EAAE,sBAAsB,EACxC,cAAc,CAAC,EAAE,MAAM,EACvB,2BAA2B,qDAA8C,EACzE,eAAe,CAAC,EAAE,kCAAkC,EACpD,MAAM,CAAC,EAAE,oBAAoB,EAC7B,cAAc,GAAE,mBAA0C,GACxD,OAAO,CAAC;IAAE,SAAS,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,WAAW,CAAA;CAAE,CAAC,CAiB7D;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CACrC,QAAQ,EAAE,mBAAmB,EAC7B,SAAS,EAAE,UAAU,EACrB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,cAAc,CAAC,EAAE,MAAM,EACvB,MAAM,CAAC,EAAE,oBAAoB,GAC3B,OAAO,CAAC;IAAE,SAAS,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,WAAW,CAAA;CAAE,CAAC,CAe7D;AAED;;;;;;;;GAQG;AACH,wBAAsB,YAAY,CACjC,UAAU,EAAE,WAAW,EACvB,MAAM,GAAE,MAAM,GAAG,yBAA6C,GAC5D,OAAO,CAAC,WAAW,CAAC,CAmCtB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,WAAW,EAAE,YAAY,CAAC;IAC1B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACtB"}