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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-definitions",
-  "version": "2.0.0-dev.3.1.0.125672",
+  "version": "2.0.0-dev.4.1.0.148229",
   "description": "Fluid container definitions",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -14,6 +14,31 @@
   "main": "dist/index.js",
   "module": "lib/index.js",
   "types": "dist/index.d.ts",
+  "dependencies": {
+    "@fluidframework/common-definitions": "^0.20.1",
+    "@fluidframework/core-interfaces": "2.0.0-dev.4.1.0.148229",
+    "@fluidframework/driver-definitions": "2.0.0-dev.4.1.0.148229",
+    "@fluidframework/protocol-definitions": "^1.1.0",
+    "events": "^3.1.0"
+  },
+  "devDependencies": {
+    "@fluid-tools/build-cli": "^0.13.1",
+    "@fluidframework/build-common": "^1.1.0",
+    "@fluidframework/build-tools": "^0.13.1",
+    "@fluidframework/container-definitions-previous": "npm:@fluidframework/container-definitions@2.0.0-internal.4.0.0",
+    "@fluidframework/eslint-config-fluid": "^2.0.0",
+    "@microsoft/api-extractor": "^7.34.4",
+    "@types/events": "^3.0.0",
+    "concurrently": "^7.6.0",
+    "copyfiles": "^2.4.1",
+    "eslint": "~8.6.0",
+    "prettier": "~2.6.2",
+    "rimraf": "^4.4.0",
+    "typescript": "~4.5.5"
+  },
+  "typeValidation": {
+    "broken": {}
+  },
   "scripts": {
     "build": "concurrently npm:build:compile npm:lint && npm run build:docs",
     "build:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
@@ -37,37 +62,7 @@
     "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
     "tsc": "tsc",
     "tsc:watch": "tsc --watch",
-    "typetests:gen": "flub generate typetests --generate --dir .",
+    "typetests:gen": "fluid-type-test-generator",
     "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
-  },
-  "dependencies": {
-    "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/core-interfaces": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
-    "@fluidframework/driver-definitions": ">=2.0.0-dev.3.1.0.125672 <2.0.0-dev.4.0.0",
-    "@fluidframework/protocol-definitions": "^1.1.0",
-    "events": "^3.1.0"
-  },
-  "devDependencies": {
-    "@fluid-tools/build-cli": "^0.8.0",
-    "@fluidframework/build-common": "^1.1.0",
-    "@fluidframework/build-tools": "^0.8.0",
-    "@fluidframework/container-definitions-previous": "npm:@fluidframework/container-definitions@2.0.0-internal.3.0.0",
-    "@fluidframework/eslint-config-fluid": "^2.0.0",
-    "@microsoft/api-extractor": "^7.22.2",
-    "@rushstack/eslint-config": "^2.5.1",
-    "@types/events": "^3.0.0",
-    "concurrently": "^6.2.0",
-    "copyfiles": "^2.4.1",
-    "eslint": "~8.6.0",
-    "prettier": "~2.6.2",
-    "rimraf": "^2.6.2",
-    "typescript": "~4.5.5"
-  },
-  "typeValidation": {
-    "version": "2.0.0-internal.3.1.0",
-    "previousVersionStyle": "~previousMinor",
-    "baselineRange": ">=2.0.0-internal.3.0.0 <2.0.0-internal.3.1.0",
-    "baselineVersion": "2.0.0-internal.3.0.0",
-    "broken": {}
   }
-}
+}

package/src/deltas.ts

@@ -26,26 +26,6 @@ import {
 export interface IConnectionDetails {
 	clientId: string;
 	claims: ITokenClaims;
-
-	/**
-	 * @deprecated No replacement API recommended.
-	 */
-	existing: boolean;
-
-	/**
-	 * @deprecated No replacement API recommended.
-	 */
-	mode: ConnectionMode;
-
-	/**
-	 * @deprecated No replacement API recommended.
-	 */
-	version: string;
-
-	/**
-	 * @deprecated No replacement API recommended.
-	 */
-	initialClients: ISignalClient[];
 	serviceConfiguration: IClientConfiguration;
 
 	/**
@@ -61,6 +41,15 @@ export interface IConnectionDetails {
 	checkpointSequenceNumber: number | undefined;
 }
 
+/**
+ * Internal version of IConnectionDetails with props are only exposed internally
+ */
+export interface IConnectionDetailsInternal extends IConnectionDetails {
+	mode: ConnectionMode;
+	version: string;
+	initialClients: ISignalClient[];
+}
+
 /**
  * Interface used to define a strategy for handling incoming delta messages
  */

package/src/error.ts

@@ -84,6 +84,19 @@ export interface ContainerWarning extends IErrorBase {
 
 /**
  * Represents errors raised on container.
+ *
+ * @see
+ *
+ * The following are commonly thrown error types, but `errorType` could be any string.
+ *
+ * - {@link @fluidframework/container-definitions#ContainerErrorType}
+ *
+ * - {@link @fluidframework/driver-definitions#DriverErrorType}
+ *
+ * - {@link @fluidframework/odsp-driver-definitions#OdspErrorType}
+ *
+ * - {@link @fluidframework/routerlicious-driver#RouterliciousErrorType}
+ *
  */
 export type ICriticalContainerError = IErrorBase;
 

package/src/index.ts

@@ -17,6 +17,7 @@ export {
 } from "./browserPackage";
 export {
 	IConnectionDetails,
+	IConnectionDetailsInternal,
 	IDeltaHandlerStrategy,
 	IDeltaManager,
 	IDeltaManagerEvents,
@@ -72,4 +73,3 @@ export {
 	IRuntime,
 	IRuntimeFactory,
 } from "./runtime";
-export { IFluidTokenProvider, IProvideFluidTokenProvider } from "./tokenProvider";

package/src/loader.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { IRequest, IResponse, IFluidRouter } from "@fluidframework/core-interfaces";
+import { IRequest, IResponse, IFluidRouter, FluidObject } from "@fluidframework/core-interfaces";
 import {
 	IClientDetails,
 	IDocumentMessage,
@@ -87,8 +87,13 @@ export interface IFluidCodeResolver {
 
 /**
  * Code AllowListing Interface
+ *
+ * @deprecated 2.0.0-internal.3.2.0 Fluid does not prescribe a particular code validation approach. Will be removed in an upcoming release.
  */
 export interface ICodeAllowList {
+	/**
+	 * @deprecated 2.0.0-internal.3.2.0 Fluid does not prescribe a particular code validation approach. Will be removed in an upcoming release.
+	 */
 	testSource(source: IResolvedFluidCodeDetails): Promise<boolean>;
 }
 
@@ -155,7 +160,19 @@ export interface IContainerEvents extends IEvent {
 	(event: "disconnected", listener: () => void);
 
 	/**
-	 * Emitted when a {@link AttachState.Detached | detached} container is
+	 * Emitted when a {@link AttachState.Detached | detached} container begins the process of
+	 * {@link AttachState.Attaching | attached} to the Fluid service.
+	 *
+	 * @see
+	 *
+	 * - {@link IContainer.attachState}
+	 *
+	 * - {@link IContainer.attach}
+	 */
+	(event: "attaching", listener: () => void);
+
+	/**
+	 * Emitted when the {@link AttachState.Attaching | attaching} process is complete and the container is
 	 * {@link AttachState.Attached | attached} to the Fluid service.
 	 *
 	 * @see
@@ -351,6 +368,8 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
 	/**
 	 * Closes the container and returns serialized local state intended to be
 	 * given to a newly loaded container.
+	 * @experimental
+	 * {@link https://github.com/microsoft/FluidFramework/packages/tree/main/loader/container-loader/closeAndGetPendingLocalState.md}
 	 */
 	closeAndGetPendingLocalState(): string;
 
@@ -454,6 +473,19 @@ export interface IContainer extends IEventProvider<IContainerEvents>, IFluidRout
 	 * @alpha
 	 */
 	forceReadonly?(readonly: boolean);
+
+	/**
+	 * Exposes the entryPoint for the container.
+	 * Use this as the primary way of getting access to the user-defined logic within the container.
+	 * If the method is undefined or the returned promise returns undefined (meaning that exposing the entryPoint
+	 * hasn't been implemented in a particular scenario) fall back to the current approach of requesting the default
+	 * object of the container through the request pattern.
+	 *
+	 * @remarks The plan is that eventually IContainer will no longer implement IFluidRouter (and thus won't have a
+	 * request() method), this method will no longer be optional, and it will become the only way to access
+	 * the entryPoint for the container.
+	 */
+	getEntryPoint?(): Promise<FluidObject | undefined>;
 }
 
 /**
@@ -522,6 +554,7 @@ export type ILoaderOptions = {
  */
 export enum LoaderHeader {
 	/**
+	 * @deprecated In next release, all caching functionality will be removed, and this is not useful anymore
 	 * Override the Loader's default caching behavior for this container.
 	 */
 	cache = "fluid-cache",
@@ -589,6 +622,9 @@ export interface IContainerLoadMode {
  * Set of Request Headers that the Loader understands and may inspect or modify
  */
 export interface ILoaderHeader {
+	/**
+	 * @deprecated In next release, all caching functionality will be removed, and this is not useful anymore
+	 */
 	[LoaderHeader.cache]: boolean;
 	[LoaderHeader.clientDetails]: IClientDetails;
 	[LoaderHeader.loadMode]: IContainerLoadMode;

package/src/runtime.ts

@@ -89,14 +89,34 @@ export interface IRuntime extends IDisposable {
 
 	/**
 	 * 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>;
 }
 
 /**
@@ -106,6 +126,7 @@ export interface IBatchMessage {
 	contents?: string;
 	metadata: Record<string, unknown> | undefined;
 	compression?: string;
+	referenceSequenceNumber?: number;
 }
 
 /**
@@ -128,8 +149,11 @@ export interface IContainerContext extends IDisposable {
 	/** @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 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;
@@ -171,12 +195,22 @@ export interface IContainerContext extends IDisposable {
 	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";

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;IAC1C,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;CAClD;AAED,MAAM,WAAW,mBAAoB,SAAQ,0BAA0B;IACtE,YAAY,EAAE;QAAE,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACzC"}

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\treadonly IFluidTokenProvider: IFluidTokenProvider;\n}\n\nexport interface IFluidTokenProvider extends IProvideFluidTokenProvider {\n\tintelligence: { [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;IAC1C,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;CAClD;AAED,MAAM,WAAW,mBAAoB,SAAQ,0BAA0B;IACtE,YAAY,EAAE;QAAE,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACzC"}

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\treadonly IFluidTokenProvider: IFluidTokenProvider;\n}\n\nexport interface IFluidTokenProvider extends IProvideFluidTokenProvider {\n\tintelligence: { [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 };
-}