@fluidframework/container-definitions 2.0.0-dev.2.3.0.115467 → 2.0.0-dev.4.1.0.148229

package/src/runtime.ts

@@ -4,23 +4,19 @@
  */
 
 import { ITelemetryBaseLogger, IDisposable } from "@fluidframework/common-definitions";
-import {
-    FluidObject,
-    IRequest,
-    IResponse,
-} from "@fluidframework/core-interfaces";
+import { FluidObject, IRequest, IResponse } from "@fluidframework/core-interfaces";
 import { IDocumentStorageService } from "@fluidframework/driver-definitions";
 import {
-    IClientConfiguration,
-    IClientDetails,
-    ISequencedDocumentMessage,
-    ISnapshotTree,
-    MessageType,
-    ISummaryTree,
-    IVersion,
-    IDocumentMessage,
-    IQuorumClients,
-    ISummaryContent,
+	IClientConfiguration,
+	IClientDetails,
+	ISequencedDocumentMessage,
+	ISnapshotTree,
+	MessageType,
+	ISummaryTree,
+	IVersion,
+	IDocumentMessage,
+	IQuorumClients,
+	ISummaryContent,
 } from "@fluidframework/protocol-definitions";
 import { IAudience } from "./audience";
 import { IDeltaManager } from "./deltas";
@@ -33,22 +29,22 @@ import { IFluidCodeDetails } from "./fluidPackage";
  * service.  The transition from detached to attached state is a one-way transition.
  */
 export enum AttachState {
-    /**
-     * In detached state, the data is only present on the local client's machine.  It has not yet been uploaded
-     * to the service.
-     */
-    Detached = "Detached",
-
-    /**
-     * In attaching state, the data has started the upload to the service, but has not yet completed.
-     */
-    Attaching = "Attaching",
-
-    /**
-     * In attached state, the data has completed upload to the service.  It can be accessed by other clients after
-     * reaching attached state.
-     */
-    Attached = "Attached",
+	/**
+	 * In detached state, the data is only present on the local client's machine.  It has not yet been uploaded
+	 * to the service.
+	 */
+	Detached = "Detached",
+
+	/**
+	 * In attaching state, the data has started the upload to the service, but has not yet completed.
+	 */
+	Attaching = "Attaching",
+
+	/**
+	 * In attached state, the data has completed upload to the service.  It can be accessed by other clients after
+	 * reaching attached state.
+	 */
+	Attached = "Attached",
 }
 
 /**
@@ -56,61 +52,81 @@ export enum AttachState {
  * Primarily held by the ContainerContext to be able to interact with the running instance of the Container.
  */
 export interface IRuntime extends IDisposable {
-
-    /**
-     * Executes a request against the runtime
-     */
-    request(request: IRequest): Promise<IResponse>;
-
-    /**
-     * Notifies the runtime of a change in the connection state
-     */
-    setConnectionState(connected: boolean, clientId?: string);
-
-    /**
-     * Processes the given op (message)
-     */
-    process(message: ISequencedDocumentMessage, local: boolean);
-
-    /**
-     * Processes the given signal
-     */
-    processSignal(message: any, local: boolean);
-
-    /**
-     * Create a summary. Used when attaching or serializing a detached container.
-     *
-     * @param blobRedirectTable - A table passed during the attach process. While detached, blob upload is supported
-     * using IDs generated locally. After attach, these IDs cannot be used, so this table maps the old local IDs to the
-     * new storage IDs so requests can be redirected.
-     */
-    createSummary(blobRedirectTable?: Map<string, string>): ISummaryTree;
-
-    /**
-     * Propagate the container state when container is attaching or attached.
-     * @param attachState - State of the container.
-     */
-    setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;
-
-    /**
-     * Get pending local state in a serializable format to be given back to a newly loaded container
-     */
-    getPendingLocalState(): unknown;
-
-    /**
-     * Notify runtime that container is moving to "Attaching" state
-     * @param snapshot - snapshot created at attach time
-     */
-    notifyAttaching(snapshot: ISnapshotTreeWithBlobContents): void;
+	/**
+	 * Executes a request against the runtime
+	 */
+	request(request: IRequest): Promise<IResponse>;
+
+	/**
+	 * Notifies the runtime of a change in the connection state
+	 */
+	setConnectionState(connected: boolean, clientId?: string);
+
+	/**
+	 * Processes the given op (message)
+	 */
+	process(message: ISequencedDocumentMessage, local: boolean);
+
+	/**
+	 * Processes the given signal
+	 */
+	processSignal(message: any, local: boolean);
+
+	/**
+	 * Create a summary. Used when attaching or serializing a detached container.
+	 *
+	 * @param blobRedirectTable - A table passed during the attach process. While detached, blob upload is supported
+	 * using IDs generated locally. After attach, these IDs cannot be used, so this table maps the old local IDs to the
+	 * new storage IDs so requests can be redirected.
+	 */
+	createSummary(blobRedirectTable?: Map<string, string>): ISummaryTree;
+
+	/**
+	 * Propagate the container state when container is attaching or attached.
+	 * @param attachState - State of the container.
+	 */
+	setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;
+
+	/**
+	 * Get pending local state in a serializable format to be given back to a newly loaded container
+	 * @experimental
+	 * {@link https://github.com/microsoft/FluidFramework/packages/tree/main/loader/container-loader/closeAndGetPendingLocalState.md}
+	 */
+	getPendingLocalState(): unknown;
+
+	/**
+	 * Notify runtime that container is moving to "Attaching" state
+	 * @param snapshot - snapshot created at attach time
+	 * @deprecated - not necessary after op replay moved to Container
+	 */
+	notifyAttaching(snapshot: ISnapshotTreeWithBlobContents): void;
+
+	/**
+	 * Notify runtime that we have processed a saved message, so that it can do async work (applying
+	 * stashed ops) after having processed it.
+	 */
+	notifyOpReplay?(message: ISequencedDocumentMessage): Promise<void>;
+
+	/**
+	 * Exposes the entryPoint for the container runtime.
+	 * Use this as the primary way of getting access to the user-defined logic within the container runtime.
+	 *
+	 * @see {@link IContainer.getEntryPoint}
+	 *
+	 * @remarks The plan is that eventually IRuntime will no longer have a request() method, this method will no
+	 * longer be optional, and it will become the only way to access the entryPoint for the runtime.
+	 */
+	getEntryPoint?(): Promise<FluidObject | undefined>;
 }
 
 /**
  * Payload type for IContainerContext.submitBatchFn()
  */
 export interface IBatchMessage {
-    contents?: string;
-    metadata: Record<string, unknown> | undefined;
-    compression?: string;
+	contents?: string;
+	metadata: Record<string, unknown> | undefined;
+	compression?: string;
+	referenceSequenceNumber?: number;
 }
 
 /**
@@ -122,71 +138,85 @@ export interface IBatchMessage {
  * and the Container has created a new ContainerContext.
  */
 export interface IContainerContext extends IDisposable {
-    /** @deprecated Please pass in existing directly in instantiateRuntime */
-    readonly existing: boolean | undefined;
-    readonly options: ILoaderOptions;
-    readonly clientId: string | undefined;
-    readonly clientDetails: IClientDetails;
-    readonly storage: IDocumentStorageService;
-    readonly connected: boolean;
-    readonly baseSnapshot: ISnapshotTree | undefined;
-    /** @deprecated Please use submitBatchFn & submitSummaryFn */
-    readonly submitFn: (type: MessageType, contents: any, batch: boolean, appData?: any) => number;
-    /** @returns clientSequenceNumber of last message in a batch */
-    readonly submitBatchFn: (batch: IBatchMessage[]) => number;
-    readonly submitSummaryFn: (summaryOp: ISummaryContent) => number;
-    readonly submitSignalFn: (contents: any) => void;
-    readonly closeFn: (error?: ICriticalContainerError) => void;
-    readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
-    readonly quorum: IQuorumClients;
-    /**
-     * @deprecated This method is provided as a migration tool for customers currently reading the code details
-     * from within the Container by directly accessing the Quorum proposals.  The code details should not be accessed
-     * from within the Container as this requires coupling between the container contents and the code loader.
-     * Direct access to Quorum proposals will be removed in an upcoming release, and in a further future release this
-     * migration tool will be removed.
-     */
-    getSpecifiedCodeDetails?(): IFluidCodeDetails | undefined;
-    readonly audience: IAudience | undefined;
-    readonly loader: ILoader;
-    // The logger implementation, which would support tagged events, should be provided by the loader.
-    readonly taggedLogger: ITelemetryBaseLogger;
-    readonly serviceConfiguration: IClientConfiguration | undefined;
-    pendingLocalState?: unknown;
-
-    /**
-     * Ambient services provided with the context
-     */
-    readonly scope: FluidObject;
-
-    /**
-     * Get an absolute url for a provided container-relative request.
-     * @param relativeUrl - A relative request within the container
-     *
-     * TODO: Optional for backwards compatibility. Make non-optional in version 0.19
-     */
-    getAbsoluteUrl?(relativeUrl: string): Promise<string | undefined>;
-
-    /**
-     * Indicates the attachment state of the container to a host service.
-     */
-    readonly attachState: AttachState;
-
-    getLoadedFromVersion(): IVersion | undefined;
-
-    updateDirtyContainerState(dirty: boolean): void;
-    /**
-     * WARNING: this id is meant for telemetry usages ONLY, not recommended for other consumption
-     * This id is not supposed to be exposed anywhere else. It is dependant on usage or drivers
-     * and scenarios which can change in the future.
-     */
-    readonly id: string;
+	/** @deprecated Please pass in existing directly in instantiateRuntime */
+	readonly existing: boolean | undefined;
+	readonly options: ILoaderOptions;
+	readonly clientId: string | undefined;
+	readonly clientDetails: IClientDetails;
+	readonly storage: IDocumentStorageService;
+	readonly connected: boolean;
+	readonly baseSnapshot: ISnapshotTree | undefined;
+	/** @deprecated Please use submitBatchFn & submitSummaryFn */
+	readonly submitFn: (type: MessageType, contents: any, batch: boolean, appData?: any) => number;
+	/** @returns clientSequenceNumber of last message in a batch */
+	readonly submitBatchFn: (batch: IBatchMessage[], referenceSequenceNumber?: number) => number;
+	readonly submitSummaryFn: (
+		summaryOp: ISummaryContent,
+		referenceSequenceNumber?: number,
+	) => number;
+	readonly submitSignalFn: (contents: any) => void;
+	readonly disposeFn?: (error?: ICriticalContainerError) => void;
+	readonly closeFn: (error?: ICriticalContainerError) => void;
+	readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
+	readonly quorum: IQuorumClients;
+	/**
+	 * @deprecated This method is provided as a migration tool for customers currently reading the code details
+	 * from within the Container by directly accessing the Quorum proposals.  The code details should not be accessed
+	 * from within the Container as this requires coupling between the container contents and the code loader.
+	 * Direct access to Quorum proposals will be removed in an upcoming release, and in a further future release this
+	 * migration tool will be removed.
+	 */
+	getSpecifiedCodeDetails?(): IFluidCodeDetails | undefined;
+	readonly audience: IAudience | undefined;
+	readonly loader: ILoader;
+	// The logger implementation, which would support tagged events, should be provided by the loader.
+	readonly taggedLogger: ITelemetryBaseLogger;
+	readonly serviceConfiguration: IClientConfiguration | undefined;
+	pendingLocalState?: unknown;
+
+	/**
+	 * Ambient services provided with the context
+	 */
+	readonly scope: FluidObject;
+
+	/**
+	 * Get an absolute url for a provided container-relative request.
+	 * @param relativeUrl - A relative request within the container
+	 *
+	 * TODO: Optional for backwards compatibility. Make non-optional in version 0.19
+	 */
+	getAbsoluteUrl?(relativeUrl: string): Promise<string | undefined>;
+
+	/**
+	 * Indicates the attachment state of the container to a host service.
+	 */
+	readonly attachState: AttachState;
+
+	getLoadedFromVersion(): IVersion | undefined;
+
+	updateDirtyContainerState(dirty: boolean): void;
+
+	readonly supportedFeatures?: ReadonlyMap<string, unknown>;
+
+	/**
+	 * WARNING: this id is meant for telemetry usages ONLY, not recommended for other consumption
+	 * This id is not supposed to be exposed anywhere else. It is dependant on usage or drivers
+	 * and scenarios which can change in the future.
+	 */
+	readonly id: string;
+
+	/**
+	 * Proxy for {@link IRuntime.getEntryPoint}, the entryPoint defined in the container's runtime.
+	 *
+	 * @see {@link IContainer.getEntryPoint}
+	 */
+	getEntryPoint?(): Promise<FluidObject | undefined>;
 }
 
 export const IRuntimeFactory: keyof IProvideRuntimeFactory = "IRuntimeFactory";
 
 export interface IProvideRuntimeFactory {
-    readonly IRuntimeFactory: IRuntimeFactory;
+	readonly IRuntimeFactory: IRuntimeFactory;
 }
 
 /**
@@ -196,12 +226,12 @@ export interface IProvideRuntimeFactory {
  * to start up the running instance of the Container.
  */
 export interface IRuntimeFactory extends IProvideRuntimeFactory {
-    /**
-     * Instantiates a new IRuntime for the given IContainerContext to proxy to
-     * This is the main entry point to the Container's business logic
-     *
-     * @param context - container context to be supplied to the runtime
-     * @param existing - whether to instantiate for the first time or from an existing context
-     */
-    instantiateRuntime(context: IContainerContext, existing?: boolean): Promise<IRuntime>;
+	/**
+	 * Instantiates a new IRuntime for the given IContainerContext to proxy to
+	 * This is the main entry point to the Container's business logic
+	 *
+	 * @param context - container context to be supplied to the runtime
+	 * @param existing - whether to instantiate for the first time or from an existing context
+	 */
+	instantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;
 }

package/tsconfig.esnext.json

@@ -1,7 +1,7 @@
 {
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-        "outDir": "./lib",
-        "module": "esnext"
-    },
-}
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"outDir": "./lib",
+		"module": "esnext",
+	},
+}

package/tsconfig.json

@@ -1,17 +1,10 @@
 {
-    "extends": "@fluidframework/build-common/ts-common-config.json",
-    "exclude": [
-        "src/test/**/*"
-    ],
-    "compilerOptions": {
-        "rootDir": "./src",
-        "outDir": "./dist",
-        "composite": true,
-        "types": [
-            "node"
-        ]
-    },
-    "include": [
-        "src/**/*"
-    ]
+	"extends": "@fluidframework/build-common/ts-common-config.json",
+	"exclude": ["src/test/**/*"],
+	"compilerOptions": {
+		"rootDir": "./src",
+		"outDir": "./dist",
+		"composite": true,
+	},
+	"include": ["src/**/*"],
 }

package/dist/tokenProvider.d.ts

@@ -1,14 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-export declare const IFluidTokenProvider: keyof IProvideFluidTokenProvider;
-export interface IProvideFluidTokenProvider {
-    readonly IFluidTokenProvider: IFluidTokenProvider;
-}
-export interface IFluidTokenProvider extends IProvideFluidTokenProvider {
-    intelligence: {
-        [service: string]: any;
-    };
-}
-//# sourceMappingURL=tokenProvider.d.ts.map

package/dist/tokenProvider.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"tokenProvider.d.ts","sourceRoot":"","sources":["../src/tokenProvider.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,eAAO,MAAM,mBAAmB,EAAE,MAAM,0BAAkD,CAAC;AAE3F,MAAM,WAAW,0BAA0B;IACvC,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;CACrD;AAED,MAAM,WAAW,mBAAoB,SAAQ,0BAA0B;IACnE,YAAY,EAAE;QAAE,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;CAC7C"}

package/dist/tokenProvider.js

@@ -1,9 +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.IFluidTokenProvider = void 0;
-exports.IFluidTokenProvider = "IFluidTokenProvider";
-//# sourceMappingURL=tokenProvider.js.map

package/dist/tokenProvider.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"tokenProvider.js","sourceRoot":"","sources":["../src/tokenProvider.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEU,QAAA,mBAAmB,GAAqC,qBAAqB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport const IFluidTokenProvider: keyof IProvideFluidTokenProvider = \"IFluidTokenProvider\";\n\nexport interface IProvideFluidTokenProvider {\n    readonly IFluidTokenProvider: IFluidTokenProvider;\n}\n\nexport interface IFluidTokenProvider extends IProvideFluidTokenProvider {\n    intelligence: { [service: string]: any; };\n}\n"]}

package/lib/tokenProvider.d.ts

@@ -1,14 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-export declare const IFluidTokenProvider: keyof IProvideFluidTokenProvider;
-export interface IProvideFluidTokenProvider {
-    readonly IFluidTokenProvider: IFluidTokenProvider;
-}
-export interface IFluidTokenProvider extends IProvideFluidTokenProvider {
-    intelligence: {
-        [service: string]: any;
-    };
-}
-//# sourceMappingURL=tokenProvider.d.ts.map

package/lib/tokenProvider.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"tokenProvider.d.ts","sourceRoot":"","sources":["../src/tokenProvider.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,eAAO,MAAM,mBAAmB,EAAE,MAAM,0BAAkD,CAAC;AAE3F,MAAM,WAAW,0BAA0B;IACvC,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;CACrD;AAED,MAAM,WAAW,mBAAoB,SAAQ,0BAA0B;IACnE,YAAY,EAAE;QAAE,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;CAC7C"}

package/lib/tokenProvider.js

@@ -1,6 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-export const IFluidTokenProvider = "IFluidTokenProvider";
-//# sourceMappingURL=tokenProvider.js.map

package/lib/tokenProvider.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"tokenProvider.js","sourceRoot":"","sources":["../src/tokenProvider.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,CAAC,MAAM,mBAAmB,GAAqC,qBAAqB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport const IFluidTokenProvider: keyof IProvideFluidTokenProvider = \"IFluidTokenProvider\";\n\nexport interface IProvideFluidTokenProvider {\n    readonly IFluidTokenProvider: IFluidTokenProvider;\n}\n\nexport interface IFluidTokenProvider extends IProvideFluidTokenProvider {\n    intelligence: { [service: string]: any; };\n}\n"]}

package/src/tokenProvider.ts

@@ -1,14 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-export const IFluidTokenProvider: keyof IProvideFluidTokenProvider = "IFluidTokenProvider";
-
-export interface IProvideFluidTokenProvider {
-    readonly IFluidTokenProvider: IFluidTokenProvider;
-}
-
-export interface IFluidTokenProvider extends IProvideFluidTokenProvider {
-    intelligence: { [service: string]: any; };
-}