@fluidframework/container-loader 2.0.0-dev.4.3.0.157531 → 2.0.0-dev.4.3.0.158678

package/lib/index.d.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 export { ConnectionState } from "./connectionState";
-export { IContainerConfig, IContainerLoadOptions, IPendingContainerState, waitContainerToCatchUp, } from "./container";
+export { IContainerConfig, IContainerExperimental, IContainerLoadOptions, IPendingContainerState, waitContainerToCatchUp, } from "./container";
 export { ISerializableBlobContents } from "./containerStorageAdapter";
 export { ICodeDetailsLoader, IDetachedBlobStorage, IFluidModuleWithDetails, ILoaderOptions, ILoaderProps, ILoaderServices, Loader, requestResolvedObjectFromContainer, } from "./loader";
 export { IProtocolHandler, ProtocolHandlerBuilder } from "./protocol";

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EACN,gBAAgB,EAChB,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,GACtB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,EACN,kBAAkB,EAClB,oBAAoB,EACpB,uBAAuB,EACvB,cAAc,EACd,YAAY,EACZ,eAAe,EACf,MAAM,EACN,kCAAkC,GAClC,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EACN,gBAAgB,EAChB,sBAAsB,EACtB,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,GACtB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,EACN,kBAAkB,EAClB,oBAAoB,EACpB,uBAAuB,EACvB,cAAc,EACd,YAAY,EACZ,eAAe,EACf,MAAM,EACN,kCAAkC,GAClC,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC"}

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAIN,sBAAsB,GACtB,MAAM,aAAa,CAAC;AAErB,OAAO,EAON,MAAM,EACN,kCAAkC,GAClC,MAAM,UAAU,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { ConnectionState } from \"./connectionState\";\nexport {\n\tIContainerConfig,\n\tIContainerLoadOptions,\n\tIPendingContainerState,\n\twaitContainerToCatchUp,\n} from \"./container\";\nexport { ISerializableBlobContents } from \"./containerStorageAdapter\";\nexport {\n\tICodeDetailsLoader,\n\tIDetachedBlobStorage,\n\tIFluidModuleWithDetails,\n\tILoaderOptions,\n\tILoaderProps,\n\tILoaderServices,\n\tLoader,\n\trequestResolvedObjectFromContainer,\n} from \"./loader\";\nexport { IProtocolHandler, ProtocolHandlerBuilder } from \"./protocol\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAKN,sBAAsB,GACtB,MAAM,aAAa,CAAC;AAErB,OAAO,EAON,MAAM,EACN,kCAAkC,GAClC,MAAM,UAAU,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { ConnectionState } from \"./connectionState\";\nexport {\n\tIContainerConfig,\n\tIContainerExperimental,\n\tIContainerLoadOptions,\n\tIPendingContainerState,\n\twaitContainerToCatchUp,\n} from \"./container\";\nexport { ISerializableBlobContents } from \"./containerStorageAdapter\";\nexport {\n\tICodeDetailsLoader,\n\tIDetachedBlobStorage,\n\tIFluidModuleWithDetails,\n\tILoaderOptions,\n\tILoaderProps,\n\tILoaderServices,\n\tLoader,\n\trequestResolvedObjectFromContainer,\n} from \"./loader\";\nexport { IProtocolHandler, ProtocolHandlerBuilder } from \"./protocol\";\n"]}

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/container-loader";
-export declare const pkgVersion = "2.0.0-dev.4.3.0.157531";
+export declare const pkgVersion = "2.0.0-dev.4.3.0.158678";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/container-loader";
-export const pkgVersion = "2.0.0-dev.4.3.0.157531";
+export const pkgVersion = "2.0.0-dev.4.3.0.158678";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,kCAAkC,CAAC;AAC1D,MAAM,CAAC,MAAM,UAAU,GAAG,wBAAwB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/container-loader\";\nexport const pkgVersion = \"2.0.0-dev.4.3.0.157531\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,kCAAkC,CAAC;AAC1D,MAAM,CAAC,MAAM,UAAU,GAAG,wBAAwB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/container-loader\";\nexport const pkgVersion = \"2.0.0-dev.4.3.0.158678\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-loader",
-  "version": "2.0.0-dev.4.3.0.157531",
+  "version": "2.0.0-dev.4.3.0.158678",
   "description": "Fluid container loader",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -37,14 +37,14 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^1.1.1",
-    "@fluidframework/container-definitions": "2.0.0-dev.4.3.0.157531",
-    "@fluidframework/container-utils": "2.0.0-dev.4.3.0.157531",
-    "@fluidframework/core-interfaces": "2.0.0-dev.4.3.0.157531",
-    "@fluidframework/driver-definitions": "2.0.0-dev.4.3.0.157531",
-    "@fluidframework/driver-utils": "2.0.0-dev.4.3.0.157531",
+    "@fluidframework/container-definitions": "2.0.0-dev.4.3.0.158678",
+    "@fluidframework/container-utils": "2.0.0-dev.4.3.0.158678",
+    "@fluidframework/core-interfaces": "2.0.0-dev.4.3.0.158678",
+    "@fluidframework/driver-definitions": "2.0.0-dev.4.3.0.158678",
+    "@fluidframework/driver-utils": "2.0.0-dev.4.3.0.158678",
     "@fluidframework/protocol-base": "^0.1039.1000",
     "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/telemetry-utils": "2.0.0-dev.4.3.0.157531",
+    "@fluidframework/telemetry-utils": "2.0.0-dev.4.3.0.158678",
     "abort-controller": "^3.0.0",
     "double-ended-queue": "^2.1.0-0",
     "events": "^3.1.0",
@@ -53,13 +53,13 @@
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@fluid-internal/test-loader-utils": "2.0.0-dev.4.3.0.157531",
+    "@fluid-internal/test-loader-utils": "2.0.0-dev.4.3.0.158678",
     "@fluid-tools/build-cli": "^0.17.0",
     "@fluidframework/build-common": "^1.1.0",
     "@fluidframework/build-tools": "^0.17.0",
     "@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@2.0.0-internal.4.1.0",
     "@fluidframework/eslint-config-fluid": "^2.0.0",
-    "@fluidframework/mocha-test-setup": "2.0.0-dev.4.3.0.157531",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.4.3.0.158678",
     "@microsoft/api-extractor": "^7.34.4",
     "@types/double-ended-queue": "^2.1.0",
     "@types/events": "^3.0.0",

package/src/container.ts

@@ -305,7 +305,7 @@ const summarizerClientType = "summarizer";
  */
 export class Container
 	extends EventEmitterWithErrorHandling<IContainerEvents>
-	implements IContainer
+	implements IContainer, IContainerExperimental
 {
 	public static version = "^0.1.0";
 
@@ -1000,6 +1000,12 @@ export class Container
 		// runtime matches pending ops to successful ones by clientId and client seq num, so we need to close the
 		// container at the same time we get pending state, otherwise this container could reconnect and resubmit with
 		// a new clientId and a future container using stale pending state without the new clientId would resubmit them
+		const pendingState = this.getPendingLocalState();
+		this.close();
+		return pendingState;
+	}
+
+	public getPendingLocalState(): string {
 		if (!this.offlineLoadEnabled) {
 			throw new UsageError("Can't get pending local state unless offline load is enabled");
 		}
@@ -1011,7 +1017,6 @@ export class Container
 			this.resolvedUrl !== undefined && this.resolvedUrl.type === "fluid",
 			0x0d2 /* "resolved url should be valid Fluid url" */,
 		);
-		assert(!!this._protocolHandler, 0x2e3 /* "Must have a valid protocol handler instance" */);
 		assert(!!this.baseSnapshot, 0x5d4 /* no base snapshot */);
 		assert(!!this.baseSnapshotBlobs, 0x5d5 /* no snapshot blobs */);
 		const pendingState: IPendingContainerState = {
@@ -1024,10 +1029,7 @@ export class Container
 			clientId: this.clientId,
 		};
 
-		this.mc.logger.sendTelemetryEvent({ eventName: "CloseAndGetPendingLocalState" });
-
-		// Only close here as method name suggests
-		this.close();
+		this.mc.logger.sendTelemetryEvent({ eventName: "GetPendingLocalState" });
 
 		return JSON.stringify(pendingState);
 	}
@@ -2228,3 +2230,19 @@ export class Container
 		}
 	}
 }
+
+/**
+ * IContainer interface that includes experimental features still under development.
+ * @internal
+ */
+export interface IContainerExperimental extends IContainer {
+	/**
+	 * Get pending state from container. WARNING: misuse of this API can result in duplicate op
+	 * submission and potential document corruption. The blob returned MUST be deleted if and when this
+	 * container emits a "connected" event.
+	 * @returns serialized blob that can be passed to Loader.resolve()
+	 * @experimental misuse of this API can result in duplicate op submission and potential document corruption
+	 * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/loader/container-loader/closeAndGetPendingLocalState.md}
+	 */
+	getPendingLocalState(): string;
+}

package/src/index.ts

@@ -6,6 +6,7 @@
 export { ConnectionState } from "./connectionState";
 export {
 	IContainerConfig,
+	IContainerExperimental,
 	IContainerLoadOptions,
 	IPendingContainerState,
 	waitContainerToCatchUp,

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/container-loader";
-export const pkgVersion = "2.0.0-dev.4.3.0.157531";
+export const pkgVersion = "2.0.0-dev.4.3.0.158678";