@fluidframework/azure-client 2.0.0-rc.4.0.6 → 2.0.0-rc.5.0.0

package/.eslintrc.cjs

@@ -38,5 +38,13 @@ module.exports = {
 				"unicorn/prevent-abbreviations": "off",
 			},
 		},
+		{
+			// Overrides for tests
+			files: ["src/test/*.spec.ts"],
+			rules: {
+				// Mocha tests should prefer regular functions, see https://mochajs.org/#arrow-functions
+				"prefer-arrow-callback": "off",
+			},
+		},
 	],
 };

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @fluidframework/azure-client
 
+## 2.0.0-rc.5.0.0
+
+### Minor Changes
+
+-   Update to TypeScript 5.4 ([#21214](https://github.com/microsoft/FluidFramework/pull/21214)) [0e6256c722](https://github.com/microsoft/FluidFramework/commit/0e6256c722d8bf024f4325bf02547daeeb18bfa6)
+
+    Update package implementations to use TypeScript 5.4.5.
+
+-   azure-client, tinylicious-client: compatibilityMode parameter added to createContainer and getContainer on AzureClient and TinyliciousClient ([#20997](https://github.com/microsoft/FluidFramework/pull/20997)) [2730787209](https://github.com/microsoft/FluidFramework/commit/2730787209a60155752d51da3c78cf97e1b5f3f9)
+
+    To support migration from 1.x to 2.0, a compatibility mode parameter has been added to these methods on AzureClient and TinyliciousClient. When set to "1", this allows interop between the 2.0 clients and 1.x clients. When set to "2", interop with 1.x clients is disallowed but new 2.0 features may be used.
+
 ## 2.0.0-rc.4.0.0
 
 ### Minor Changes

package/api-extractor/api-extractor-lint-beta.cjs.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
+	"mainEntryPointFilePath": "<projectFolder>/dist/beta.d.ts"
+}

package/api-extractor/api-extractor-lint-beta.esm.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
+	"mainEntryPointFilePath": "<projectFolder>/lib/beta.d.ts"
+}

package/api-extractor/api-extractor-lint-bundle.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.json",
+	"mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts"
+}

package/api-extractor/api-extractor-lint-legacy.cjs.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
+	"mainEntryPointFilePath": "<projectFolder>/dist/legacy.d.ts"
+}

package/api-extractor/api-extractor-lint-legacy.esm.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
+	"mainEntryPointFilePath": "<projectFolder>/lib/legacy.d.ts"
+}

package/api-extractor/api-extractor-lint-public.cjs.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
+	"mainEntryPointFilePath": "<projectFolder>/dist/public.d.ts"
+}

package/api-extractor/api-extractor-lint-public.esm.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
+	"mainEntryPointFilePath": "<projectFolder>/lib/public.d.ts"
+}

package/api-extractor.json

@@ -1,4 +1,4 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-base.esm.primary.json"
+	"extends": "../../../common/build/build-common/api-extractor-base.esm.current.json"
 }

package/api-report/{azure-client.api.md → azure-client.alpha.api.md}

@@ -1,36 +1,37 @@
-## API Report File for "@fluidframework/azure-client"
+## Alpha API Report File for "@fluidframework/azure-client"
 
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
 ```ts
 
-import { ContainerSchema } from '@fluidframework/fluid-static';
-import { ICompressionStorageConfig } from '@fluidframework/driver-utils';
-import { IConfigProviderBase } from '@fluidframework/core-interfaces';
-import { IFluidContainer } from '@fluidframework/fluid-static';
-import { IMember } from '@fluidframework/fluid-static';
-import { IServiceAudience } from '@fluidframework/fluid-static';
+import { CompatibilityMode } from '@fluidframework/fluid-static';
+import type { ContainerSchema } from '@fluidframework/fluid-static';
+import type { ICompressionStorageConfig } from '@fluidframework/driver-utils';
+import type { IConfigProviderBase } from '@fluidframework/core-interfaces';
+import type { IFluidContainer } from '@fluidframework/fluid-static';
+import type { IMember } from '@fluidframework/fluid-static';
+import type { IServiceAudience } from '@fluidframework/fluid-static';
 import { ITelemetryBaseEvent } from '@fluidframework/core-interfaces';
 import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
-import { ITokenClaims } from '@fluidframework/protocol-definitions';
+import { ITokenClaims } from '@fluidframework/driver-definitions/internal';
 import { ITokenProvider } from '@fluidframework/routerlicious-driver';
 import { ITokenResponse } from '@fluidframework/routerlicious-driver';
-import { IUser } from '@fluidframework/protocol-definitions';
-import { ScopeType } from '@fluidframework/protocol-definitions';
+import { IUser } from '@fluidframework/driver-definitions';
+import { ScopeType } from '@fluidframework/driver-definitions/internal';
 
 // @public
 export class AzureClient {
     constructor(properties: AzureClientProps);
-    createContainer<const TContainerSchema extends ContainerSchema>(containerSchema: TContainerSchema): Promise<{
+    createContainer<const TContainerSchema extends ContainerSchema>(containerSchema: TContainerSchema, compatibilityMode: CompatibilityMode): Promise<{
         container: IFluidContainer<TContainerSchema>;
         services: AzureContainerServices;
     }>;
-    getContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema): Promise<{
+    getContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, compatibilityMode: CompatibilityMode): Promise<{
         container: IFluidContainer<TContainerSchema>;
         services: AzureContainerServices;
     }>;
     getContainerVersions(id: string, options?: AzureGetVersionsOptions): Promise<AzureContainerVersion[]>;
-    viewContainerVersion<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, version: AzureContainerVersion): Promise<{
+    viewContainerVersion<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, version: AzureContainerVersion, compatibilityMode: CompatibilityMode): Promise<{
         container: IFluidContainer<TContainerSchema>;
     }>;
 }
@@ -65,15 +66,6 @@ export interface AzureContainerVersion {
     id: string;
 }
 
-// @internal @deprecated
-export class AzureFunctionTokenProvider implements ITokenProvider {
-    constructor(azFunctionUrl: string, user?: Pick<AzureMember<any>, "name" | "id" | "additionalDetails"> | undefined);
-    // (undocumented)
-    fetchOrdererToken(tenantId: string, documentId?: string): Promise<ITokenResponse>;
-    // (undocumented)
-    fetchStorageToken(tenantId: string, documentId: string): Promise<ITokenResponse>;
-}
-
 // @public
 export interface AzureGetVersionsOptions {
     maxCount: number;
@@ -96,11 +88,7 @@ export interface AzureRemoteConnectionConfig extends AzureConnectionConfig {
     type: "remote";
 }
 
-// @internal
-export interface AzureUser<T = any> extends IUser {
-    additionalDetails?: T;
-    name: string;
-}
+export { CompatibilityMode }
 
 // @public
 export type IAzureAudience = IServiceAudience<AzureMember>;

package/api-report/azure-client.beta.api.md

@@ -0,0 +1,110 @@
+## Beta API Report File for "@fluidframework/azure-client"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { CompatibilityMode } from '@fluidframework/fluid-static';
+import type { ContainerSchema } from '@fluidframework/fluid-static';
+import type { ICompressionStorageConfig } from '@fluidframework/driver-utils';
+import type { IConfigProviderBase } from '@fluidframework/core-interfaces';
+import type { IFluidContainer } from '@fluidframework/fluid-static';
+import type { IMember } from '@fluidframework/fluid-static';
+import type { IServiceAudience } from '@fluidframework/fluid-static';
+import { ITelemetryBaseEvent } from '@fluidframework/core-interfaces';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITokenClaims } from '@fluidframework/driver-definitions/internal';
+import { ITokenProvider } from '@fluidframework/routerlicious-driver';
+import { ITokenResponse } from '@fluidframework/routerlicious-driver';
+import { IUser } from '@fluidframework/driver-definitions';
+import { ScopeType } from '@fluidframework/driver-definitions/internal';
+
+// @public
+export class AzureClient {
+    constructor(properties: AzureClientProps);
+    createContainer<const TContainerSchema extends ContainerSchema>(containerSchema: TContainerSchema, compatibilityMode: CompatibilityMode): Promise<{
+        container: IFluidContainer<TContainerSchema>;
+        services: AzureContainerServices;
+    }>;
+    getContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, compatibilityMode: CompatibilityMode): Promise<{
+        container: IFluidContainer<TContainerSchema>;
+        services: AzureContainerServices;
+    }>;
+    getContainerVersions(id: string, options?: AzureGetVersionsOptions): Promise<AzureContainerVersion[]>;
+    viewContainerVersion<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, version: AzureContainerVersion, compatibilityMode: CompatibilityMode): Promise<{
+        container: IFluidContainer<TContainerSchema>;
+    }>;
+}
+
+// @public
+export interface AzureClientProps {
+    readonly configProvider?: IConfigProviderBase;
+    readonly connection: AzureRemoteConnectionConfig | AzureLocalConnectionConfig;
+    readonly logger?: ITelemetryBaseLogger;
+    // (undocumented)
+    readonly summaryCompression?: boolean | ICompressionStorageConfig;
+}
+
+// @public
+export interface AzureConnectionConfig {
+    endpoint: string;
+    tokenProvider: ITokenProvider;
+    type: AzureConnectionConfigType;
+}
+
+// @public
+export type AzureConnectionConfigType = "local" | "remote";
+
+// @public
+export interface AzureContainerServices {
+    audience: IAzureAudience;
+}
+
+// @public
+export interface AzureContainerVersion {
+    date?: string;
+    id: string;
+}
+
+// @public
+export interface AzureGetVersionsOptions {
+    maxCount: number;
+}
+
+// @public
+export interface AzureLocalConnectionConfig extends AzureConnectionConfig {
+    type: "local";
+}
+
+// @public
+export interface AzureMember<T = any> extends IMember {
+    additionalDetails?: T;
+    name: string;
+}
+
+// @public
+export interface AzureRemoteConnectionConfig extends AzureConnectionConfig {
+    tenantId: string;
+    type: "remote";
+}
+
+export { CompatibilityMode }
+
+// @public
+export type IAzureAudience = IServiceAudience<AzureMember>;
+
+export { ITelemetryBaseEvent }
+
+export { ITelemetryBaseLogger }
+
+export { ITokenClaims }
+
+export { ITokenProvider }
+
+export { ITokenResponse }
+
+export { IUser }
+
+export { ScopeType }
+
+```

package/api-report/azure-client.public.api.md

@@ -0,0 +1,110 @@
+## Public API Report File for "@fluidframework/azure-client"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { CompatibilityMode } from '@fluidframework/fluid-static';
+import type { ContainerSchema } from '@fluidframework/fluid-static';
+import type { ICompressionStorageConfig } from '@fluidframework/driver-utils';
+import type { IConfigProviderBase } from '@fluidframework/core-interfaces';
+import type { IFluidContainer } from '@fluidframework/fluid-static';
+import type { IMember } from '@fluidframework/fluid-static';
+import type { IServiceAudience } from '@fluidframework/fluid-static';
+import { ITelemetryBaseEvent } from '@fluidframework/core-interfaces';
+import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import { ITokenClaims } from '@fluidframework/driver-definitions/internal';
+import { ITokenProvider } from '@fluidframework/routerlicious-driver';
+import { ITokenResponse } from '@fluidframework/routerlicious-driver';
+import { IUser } from '@fluidframework/driver-definitions';
+import { ScopeType } from '@fluidframework/driver-definitions/internal';
+
+// @public
+export class AzureClient {
+    constructor(properties: AzureClientProps);
+    createContainer<const TContainerSchema extends ContainerSchema>(containerSchema: TContainerSchema, compatibilityMode: CompatibilityMode): Promise<{
+        container: IFluidContainer<TContainerSchema>;
+        services: AzureContainerServices;
+    }>;
+    getContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, compatibilityMode: CompatibilityMode): Promise<{
+        container: IFluidContainer<TContainerSchema>;
+        services: AzureContainerServices;
+    }>;
+    getContainerVersions(id: string, options?: AzureGetVersionsOptions): Promise<AzureContainerVersion[]>;
+    viewContainerVersion<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, version: AzureContainerVersion, compatibilityMode: CompatibilityMode): Promise<{
+        container: IFluidContainer<TContainerSchema>;
+    }>;
+}
+
+// @public
+export interface AzureClientProps {
+    readonly configProvider?: IConfigProviderBase;
+    readonly connection: AzureRemoteConnectionConfig | AzureLocalConnectionConfig;
+    readonly logger?: ITelemetryBaseLogger;
+    // (undocumented)
+    readonly summaryCompression?: boolean | ICompressionStorageConfig;
+}
+
+// @public
+export interface AzureConnectionConfig {
+    endpoint: string;
+    tokenProvider: ITokenProvider;
+    type: AzureConnectionConfigType;
+}
+
+// @public
+export type AzureConnectionConfigType = "local" | "remote";
+
+// @public
+export interface AzureContainerServices {
+    audience: IAzureAudience;
+}
+
+// @public
+export interface AzureContainerVersion {
+    date?: string;
+    id: string;
+}
+
+// @public
+export interface AzureGetVersionsOptions {
+    maxCount: number;
+}
+
+// @public
+export interface AzureLocalConnectionConfig extends AzureConnectionConfig {
+    type: "local";
+}
+
+// @public
+export interface AzureMember<T = any> extends IMember {
+    additionalDetails?: T;
+    name: string;
+}
+
+// @public
+export interface AzureRemoteConnectionConfig extends AzureConnectionConfig {
+    tenantId: string;
+    type: "remote";
+}
+
+export { CompatibilityMode }
+
+// @public
+export type IAzureAudience = IServiceAudience<AzureMember>;
+
+export { ITelemetryBaseEvent }
+
+export { ITelemetryBaseLogger }
+
+export { ITokenClaims }
+
+export { ITokenProvider }
+
+export { ITokenResponse }
+
+export { IUser }
+
+export { ScopeType }
+
+```

package/biome.jsonc

@@ -0,0 +1,4 @@
+{
+	"$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+	"extends": ["../../../biome.jsonc"]
+}

package/dist/AzureAudience.d.ts

@@ -2,8 +2,8 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { type IClient } from "@fluidframework/protocol-definitions";
-import { type AzureMember } from "./interfaces.js";
+import type { IClient } from "@fluidframework/driver-definitions";
+import type { AzureMember } from "./interfaces.js";
 /**
  * Creates Azure-specific audience member.
  *

package/dist/AzureAudience.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AzureAudience.d.ts","sourceRoot":"","sources":["../src/AzureAudience.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,OAAO,EAAc,MAAM,sCAAsC,CAAC;AAEhF,OAAO,EAAE,KAAK,WAAW,EAAkB,MAAM,iBAAiB,CAAC;AAEnE;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,cAAc,EAAE,OAAO,GAAG,WAAW,CAU9E"}
+{"version":3,"file":"AzureAudience.d.ts","sourceRoot":"","sources":["../src/AzureAudience.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAS,MAAM,oCAAoC,CAAC;AAEzE,OAAO,KAAK,EAAE,WAAW,EAAa,MAAM,iBAAiB,CAAC;AAE9D;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,cAAc,EAAE,OAAO,GAAG,WAAW,CAU9E"}

package/dist/AzureAudience.js.map

@@ -1 +1 @@
-{"version":3,"file":"AzureAudience.js","sourceRoot":"","sources":["../src/AzureAudience.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAMH;;;;;GAKG;AACH,SAAgB,yBAAyB,CAAC,cAAuB;IAChE,MAAM,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC;IACjC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAExB,OAAO;QACN,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,WAAW,EAAE,EAAE;QACf,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;KACzC,CAAC;AACH,CAAC;AAVD,8DAUC;AAED;;GAEG;AACH,SAAS,iBAAiB,CAAC,IAAW;IACrC,MAAM,cAAc,GAAG,IAA0B,CAAC;IAClD,MAAM,WAAW,GAAG,4CAA4C,CAAC;IACjE,IAAI,cAAc,CAAC,EAAE,KAAK,SAAS,EAAE;QACpC,MAAM,IAAI,SAAS,CAAC,GAAG,WAAW,kCAAkC,CAAC,CAAC;KACtE;IACD,IAAI,cAAc,CAAC,IAAI,KAAK,SAAS,EAAE;QACtC,MAAM,IAAI,SAAS,CAAC,GAAG,WAAW,oCAAoC,CAAC,CAAC;KACxE;AACF,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { type IClient, type IUser } from \"@fluidframework/protocol-definitions\";\n\nimport { type AzureMember, type AzureUser } from \"./interfaces.js\";\n\n/**\n * Creates Azure-specific audience member.\n *\n * @remarks\n * The provided `audienceMember`'s {@link @fluidframework/protocol-definitions#IClient.user} must be an {@link AzureUser}.\n */\nexport function createAzureAudienceMember(audienceMember: IClient): AzureMember {\n\tconst user = audienceMember.user;\n\tassertIsAzureUser(user);\n\n\treturn {\n\t\tid: user.id,\n\t\tname: user.name,\n\t\tconnections: [],\n\t\tadditionalDetails: user.additionalDetails,\n\t};\n}\n\n/**\n * Asserts that the provided {@link @fluidframework/protocol-definitions#IUser} is an {@link AzureUser}.\n */\nfunction assertIsAzureUser(user: IUser): asserts user is AzureUser<unknown> {\n\tconst maybeAzureUser = user as Partial<AzureUser>;\n\tconst baseMessage = 'Provided user data was not an \"AzureUser\".';\n\tif (maybeAzureUser.id === undefined) {\n\t\tthrow new TypeError(`${baseMessage} Missing required \"id\" property.`);\n\t}\n\tif (maybeAzureUser.name === undefined) {\n\t\tthrow new TypeError(`${baseMessage} Missing required \"name\" property.`);\n\t}\n}\n"]}
+{"version":3,"file":"AzureAudience.js","sourceRoot":"","sources":["../src/AzureAudience.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAMH;;;;;GAKG;AACH,SAAgB,yBAAyB,CAAC,cAAuB;IAChE,MAAM,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC;IACjC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAExB,OAAO;QACN,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,WAAW,EAAE,EAAE;QACf,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;KACzC,CAAC;AACH,CAAC;AAVD,8DAUC;AAED;;GAEG;AACH,SAAS,iBAAiB,CAAC,IAAW;IACrC,MAAM,cAAc,GAAG,IAA0B,CAAC;IAClD,MAAM,WAAW,GAAG,4CAA4C,CAAC;IACjE,IAAI,cAAc,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;QACrC,MAAM,IAAI,SAAS,CAAC,GAAG,WAAW,kCAAkC,CAAC,CAAC;IACvE,CAAC;IACD,IAAI,cAAc,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QACvC,MAAM,IAAI,SAAS,CAAC,GAAG,WAAW,oCAAoC,CAAC,CAAC;IACzE,CAAC;AACF,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IClient, IUser } from \"@fluidframework/driver-definitions\";\n\nimport type { AzureMember, AzureUser } from \"./interfaces.js\";\n\n/**\n * Creates Azure-specific audience member.\n *\n * @remarks\n * The provided `audienceMember`'s {@link @fluidframework/protocol-definitions#IClient.user} must be an {@link AzureUser}.\n */\nexport function createAzureAudienceMember(audienceMember: IClient): AzureMember {\n\tconst user = audienceMember.user;\n\tassertIsAzureUser(user);\n\n\treturn {\n\t\tid: user.id,\n\t\tname: user.name,\n\t\tconnections: [],\n\t\tadditionalDetails: user.additionalDetails,\n\t};\n}\n\n/**\n * Asserts that the provided {@link @fluidframework/protocol-definitions#IUser} is an {@link AzureUser}.\n */\nfunction assertIsAzureUser(user: IUser): asserts user is AzureUser<unknown> {\n\tconst maybeAzureUser = user as Partial<AzureUser>;\n\tconst baseMessage = 'Provided user data was not an \"AzureUser\".';\n\tif (maybeAzureUser.id === undefined) {\n\t\tthrow new TypeError(`${baseMessage} Missing required \"id\" property.`);\n\t}\n\tif (maybeAzureUser.name === undefined) {\n\t\tthrow new TypeError(`${baseMessage} Missing required \"name\" property.`);\n\t}\n}\n"]}

package/dist/AzureClient.d.ts

@@ -2,8 +2,8 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { type ContainerSchema, type IFluidContainer } from "@fluidframework/fluid-static";
-import { type AzureClientProps, type AzureContainerServices, type AzureContainerVersion, type AzureGetVersionsOptions } from "./interfaces.js";
+import type { ContainerSchema, IFluidContainer, CompatibilityMode } from "@fluidframework/fluid-static";
+import type { AzureClientProps, AzureContainerServices, AzureContainerVersion, AzureGetVersionsOptions } from "./interfaces.js";
 /**
  * AzureClient provides the ability to have a Fluid object backed by the Azure Fluid Relay or,
  * when running with local tenantId, have it be backed by a local Azure Fluid Relay instance.
@@ -24,9 +24,10 @@ export declare class AzureClient {
      * @typeparam TContainerSchema - Used to infer the the type of 'initialObjects' in the returned container.
      * (normally not explicitly specified.)
      * @param containerSchema - Container schema for the new container.
+     * @param compatibilityMode - Compatibility mode the container should run in.
      * @returns New detached container instance along with associated services.
      */
-    createContainer<const TContainerSchema extends ContainerSchema>(containerSchema: TContainerSchema): Promise<{
+    createContainer<const TContainerSchema extends ContainerSchema>(containerSchema: TContainerSchema, compatibilityMode: CompatibilityMode): Promise<{
         container: IFluidContainer<TContainerSchema>;
         services: AzureContainerServices;
     }>;
@@ -36,9 +37,10 @@ export declare class AzureClient {
      * (normally not explicitly specified.)
      * @param id - Unique ID of the container in Azure Fluid Relay.
      * @param containerSchema - Container schema used to access data objects in the container.
+     * @param compatibilityMode - Compatibility mode the container should run in.
      * @returns Existing container instance along with associated services.
      */
-    getContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema): Promise<{
+    getContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, compatibilityMode: CompatibilityMode): Promise<{
         container: IFluidContainer<TContainerSchema>;
         services: AzureContainerServices;
     }>;
@@ -49,9 +51,10 @@ export declare class AzureClient {
      * @param id - Unique ID of the source container in Azure Fluid Relay.
      * @param containerSchema - Container schema used to access data objects in the container.
      * @param version - Unique version of the source container in Azure Fluid Relay.
+     * @param compatibilityMode - Compatibility mode the container should run in.
      * @returns Loaded container instance at the specified version.
      */
-    viewContainerVersion<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, version: AzureContainerVersion): Promise<{
+    viewContainerVersion<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, version: AzureContainerVersion, compatibilityMode: CompatibilityMode): Promise<{
         container: IFluidContainer<TContainerSchema>;
     }>;
     /**

package/dist/AzureClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AzureClient.d.ts","sourceRoot":"","sources":["../src/AzureClient.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAgBH,OAAO,EAAE,KAAK,eAAe,EAAE,KAAK,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAa1F,OAAO,EACN,KAAK,gBAAgB,EAErB,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,MAAM,iBAAiB,CAAC;AA+CzB;;;;GAIG;AACH,qBAAa,WAAW;IASJ,OAAO,CAAC,QAAQ,CAAC,UAAU;IAR9C,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAA0B;IACjE,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAe;IAC3C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAkC;IAEjE;;;OAGG;gBACiC,UAAU,EAAE,gBAAgB;IAoBhE;;;;;;OAMG;IACU,eAAe,CAAC,KAAK,CAAC,gBAAgB,SAAS,eAAe,EAC1E,eAAe,EAAE,gBAAgB,GAC/B,OAAO,CAAC;QACV,SAAS,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;QAC7C,QAAQ,EAAE,sBAAsB,CAAC;KACjC,CAAC;IAgBF;;;;;;;OAOG;IACU,YAAY,CAAC,gBAAgB,SAAS,eAAe,EACjE,EAAE,EAAE,MAAM,EACV,eAAe,EAAE,gBAAgB,GAC/B,OAAO,CAAC;QACV,SAAS,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;QAC7C,QAAQ,EAAE,sBAAsB,CAAC;KACjC,CAAC;IAmBF;;;;;;;;OAQG;IACU,oBAAoB,CAAC,gBAAgB,SAAS,eAAe,EACzE,EAAE,EAAE,MAAM,EACV,eAAe,EAAE,gBAAgB,EACjC,OAAO,EAAE,qBAAqB,GAC5B,OAAO,CAAC;QACV,SAAS,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;KAC7C,CAAC;IAqBF;;;;;;OAMG;IACU,oBAAoB,CAChC,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,uBAAuB,GAC/B,OAAO,CAAC,qBAAqB,EAAE,CAAC;IA0BnC,OAAO,CAAC,oBAAoB;IAS5B,OAAO,CAAC,YAAY;YA8BN,oBAAoB;YAiCpB,sBAAsB;CASpC"}
+{"version":3,"file":"AzureClient.d.ts","sourceRoot":"","sources":["../src/AzureClient.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAiBH,OAAO,KAAK,EACX,eAAe,EACf,eAAe,EACf,iBAAiB,EACjB,MAAM,8BAA8B,CAAC;AAYtC,OAAO,KAAK,EACX,gBAAgB,EAEhB,sBAAsB,EACtB,qBAAqB,EACrB,uBAAuB,EACvB,MAAM,iBAAiB,CAAC;AA+CzB;;;;GAIG;AACH,qBAAa,WAAW;IASJ,OAAO,CAAC,QAAQ,CAAC,UAAU;IAR9C,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAA0B;IACjE,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAe;IAC3C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAkC;IAEjE;;;OAGG;gBACiC,UAAU,EAAE,gBAAgB;IAoBhE;;;;;;;OAOG;IACU,eAAe,CAAC,KAAK,CAAC,gBAAgB,SAAS,eAAe,EAC1E,eAAe,EAAE,gBAAgB,EACjC,iBAAiB,EAAE,iBAAiB,GAClC,OAAO,CAAC;QACV,SAAS,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;QAC7C,QAAQ,EAAE,sBAAsB,CAAC;KACjC,CAAC;IAgBF;;;;;;;;OAQG;IACU,YAAY,CAAC,gBAAgB,SAAS,eAAe,EACjE,EAAE,EAAE,MAAM,EACV,eAAe,EAAE,gBAAgB,EACjC,iBAAiB,EAAE,iBAAiB,GAClC,OAAO,CAAC;QACV,SAAS,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;QAC7C,QAAQ,EAAE,sBAAsB,CAAC;KACjC,CAAC;IAsBF;;;;;;;;;OASG;IACU,oBAAoB,CAAC,gBAAgB,SAAS,eAAe,EACzE,EAAE,EAAE,MAAM,EACV,eAAe,EAAE,gBAAgB,EACjC,OAAO,EAAE,qBAAqB,EAC9B,iBAAiB,EAAE,iBAAiB,GAClC,OAAO,CAAC;QACV,SAAS,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;KAC7C,CAAC;IAwBF;;;;;;OAMG;IACU,oBAAoB,CAChC,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,uBAAuB,GAC/B,OAAO,CAAC,qBAAqB,EAAE,CAAC;IA6BnC,OAAO,CAAC,oBAAoB;IAS5B,OAAO,CAAC,YAAY;YAiCN,oBAAoB;YAiCpB,sBAAsB;CASpC"}

package/dist/AzureClient.js

@@ -39,8 +39,8 @@ const azureClientFeatureGates = {
  */
 const azureClientV1CompatFeatureGates = {
     // Disable Garbage Collection
-    "Fluid.GarbageCollection.RunSweep": false,
-    "Fluid.GarbageCollection.DisableAutoRecovery": true,
+    "Fluid.GarbageCollection.RunSweep": false, // To prevent the GC op
+    "Fluid.GarbageCollection.DisableAutoRecovery": true, // To prevent the GC op
     "Fluid.GarbageCollection.ThrowOnTombstoneLoadOverride": false, // For a consistent story of "GC is disabled"
 };
 /**
@@ -85,10 +85,11 @@ class AzureClient {
      * @typeparam TContainerSchema - Used to infer the the type of 'initialObjects' in the returned container.
      * (normally not explicitly specified.)
      * @param containerSchema - Container schema for the new container.
+     * @param compatibilityMode - Compatibility mode the container should run in.
      * @returns New detached container instance along with associated services.
      */
-    async createContainer(containerSchema) {
-        const loader = this.createLoader(containerSchema);
+    async createContainer(containerSchema, compatibilityMode) {
+        const loader = this.createLoader(containerSchema, compatibilityMode);
         const container = await loader.createDetachedContainer({
             package: "no-dynamic-package",
             config: {},
@@ -103,10 +104,11 @@ class AzureClient {
      * (normally not explicitly specified.)
      * @param id - Unique ID of the container in Azure Fluid Relay.
      * @param containerSchema - Container schema used to access data objects in the container.
+     * @param compatibilityMode - Compatibility mode the container should run in.
      * @returns Existing container instance along with associated services.
      */
-    async getContainer(id, containerSchema) {
-        const loader = this.createLoader(containerSchema);
+    async getContainer(id, containerSchema, compatibilityMode) {
+        const loader = this.createLoader(containerSchema, compatibilityMode);
         const url = new URL(this.properties.connection.endpoint);
         url.searchParams.append("storage", encodeURIComponent(this.properties.connection.endpoint));
         url.searchParams.append("tenantId", encodeURIComponent(getTenantId(this.properties.connection)));
@@ -127,10 +129,11 @@ class AzureClient {
      * @param id - Unique ID of the source container in Azure Fluid Relay.
      * @param containerSchema - Container schema used to access data objects in the container.
      * @param version - Unique version of the source container in Azure Fluid Relay.
+     * @param compatibilityMode - Compatibility mode the container should run in.
      * @returns Loaded container instance at the specified version.
      */
-    async viewContainerVersion(id, containerSchema, version) {
-        const loader = this.createLoader(containerSchema);
+    async viewContainerVersion(id, containerSchema, version, compatibilityMode) {
+        const loader = this.createLoader(containerSchema, compatibilityMode);
         const url = new URL(this.properties.connection.endpoint);
         url.searchParams.append("storage", encodeURIComponent(this.properties.connection.endpoint));
         url.searchParams.append("tenantId", encodeURIComponent(getTenantId(this.properties.connection)));
@@ -179,8 +182,11 @@ class AzureClient {
             }),
         };
     }
-    createLoader(schema) {
-        const runtimeFactory = (0, internal_5.createDOProviderContainerRuntimeFactory)({ schema });
+    createLoader(schema, compatibilityMode) {
+        const runtimeFactory = (0, internal_5.createDOProviderContainerRuntimeFactory)({
+            schema,
+            compatibilityMode,
+        });
         const load = async () => {
             return {
                 module: { fluidExport: runtimeFactory },