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

package/src/AzureClient.ts

@@ -10,32 +10,36 @@ import {
 	LoaderHeader,
 } from "@fluidframework/container-definitions/internal";
 import { Loader, loadContainerPaused } from "@fluidframework/container-loader/internal";
-import { type FluidObject, type IConfigProviderBase } from "@fluidframework/core-interfaces";
+import type { FluidObject, IConfigProviderBase } from "@fluidframework/core-interfaces";
 import { assert } from "@fluidframework/core-utils/internal";
-import {
-	type IDocumentServiceFactory,
-	type IUrlResolver,
+import type { IClient } from "@fluidframework/driver-definitions";
+import type {
+	IDocumentServiceFactory,
+	IUrlResolver,
 } from "@fluidframework/driver-definitions/internal";
 import { applyStorageCompression } from "@fluidframework/driver-utils/internal";
-import { type ContainerSchema, type IFluidContainer } from "@fluidframework/fluid-static";
+import type {
+	ContainerSchema,
+	IFluidContainer,
+	CompatibilityMode,
+} from "@fluidframework/fluid-static";
 import {
 	type IRootDataObject,
 	createDOProviderContainerRuntimeFactory,
 	createFluidContainer,
 	createServiceAudience,
 } from "@fluidframework/fluid-static/internal";
-import { type IClient } from "@fluidframework/protocol-definitions";
 import { RouterliciousDocumentServiceFactory } from "@fluidframework/routerlicious-driver/internal";
 import { wrapConfigProviderWithDefaults } from "@fluidframework/telemetry-utils/internal";
 
 import { createAzureAudienceMember } from "./AzureAudience.js";
 import { AzureUrlResolver, createAzureCreateNewRequest } from "./AzureUrlResolver.js";
-import {
-	type AzureClientProps,
-	type AzureConnectionConfig,
-	type AzureContainerServices,
-	type AzureContainerVersion,
-	type AzureGetVersionsOptions,
+import type {
+	AzureClientProps,
+	AzureConnectionConfig,
+	AzureContainerServices,
+	AzureContainerVersion,
+	AzureGetVersionsOptions,
 } from "./interfaces.js";
 import { isAzureRemoteConnectionConfig } from "./utils.js";
 
@@ -122,15 +126,17 @@ export 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.
 	 */
 	public async createContainer<const TContainerSchema extends ContainerSchema>(
 		containerSchema: TContainerSchema,
+		compatibilityMode: CompatibilityMode,
 	): Promise<{
 		container: IFluidContainer<TContainerSchema>;
 		services: AzureContainerServices;
 	}> {
-		const loader = this.createLoader(containerSchema);
+		const loader = this.createLoader(containerSchema, compatibilityMode);
 
 		const container = await loader.createDetachedContainer({
 			package: "no-dynamic-package",
@@ -151,18 +157,23 @@ export 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.
 	 */
 	public async getContainer<TContainerSchema extends ContainerSchema>(
 		id: string,
 		containerSchema: TContainerSchema,
+		compatibilityMode: CompatibilityMode,
 	): Promise<{
 		container: IFluidContainer<TContainerSchema>;
 		services: AzureContainerServices;
 	}> {
-		const loader = this.createLoader(containerSchema);
+		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(
+			"storage",
+			encodeURIComponent(this.properties.connection.endpoint),
+		);
 		url.searchParams.append(
 			"tenantId",
 			encodeURIComponent(getTenantId(this.properties.connection)),
@@ -185,18 +196,23 @@ export 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.
 	 */
 	public async viewContainerVersion<TContainerSchema extends ContainerSchema>(
 		id: string,
 		containerSchema: TContainerSchema,
 		version: AzureContainerVersion,
+		compatibilityMode: CompatibilityMode,
 	): Promise<{
 		container: IFluidContainer<TContainerSchema>;
 	}> {
-		const loader = this.createLoader(containerSchema);
+		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(
+			"storage",
+			encodeURIComponent(this.properties.connection.endpoint),
+		);
 		url.searchParams.append(
 			"tenantId",
 			encodeURIComponent(getTenantId(this.properties.connection)),
@@ -226,7 +242,10 @@ export class AzureClient {
 		options?: AzureGetVersionsOptions,
 	): Promise<AzureContainerVersion[]> {
 		const url = new URL(this.properties.connection.endpoint);
-		url.searchParams.append("storage", encodeURIComponent(this.properties.connection.endpoint));
+		url.searchParams.append(
+			"storage",
+			encodeURIComponent(this.properties.connection.endpoint),
+		);
 		url.searchParams.append(
 			"tenantId",
 			encodeURIComponent(getTenantId(this.properties.connection)),
@@ -259,8 +278,11 @@ export class AzureClient {
 		};
 	}
 
-	private createLoader(schema: ContainerSchema): Loader {
-		const runtimeFactory = createDOProviderContainerRuntimeFactory({ schema });
+	private createLoader(schema: ContainerSchema, compatibilityMode: CompatibilityMode): Loader {
+		const runtimeFactory = createDOProviderContainerRuntimeFactory({
+			schema,
+			compatibilityMode,
+		});
 		const load = async (): Promise<IFluidModuleWithDetails> => {
 			return {
 				module: { fluidExport: runtimeFactory },

package/src/AzureFunctionTokenProvider.ts

@@ -3,10 +3,10 @@
  * Licensed under the MIT License.
  */
 
-import { type ITokenProvider, type ITokenResponse } from "@fluidframework/routerlicious-driver";
+import type { ITokenProvider, ITokenResponse } from "@fluidframework/routerlicious-driver";
 import axios from "axios";
 
-import { type AzureMember } from "./interfaces.js";
+import type { AzureMember } from "./interfaces.js";
 
 /**
  * Token Provider implementation for connecting to an Azure Function endpoint for
@@ -28,13 +28,19 @@ export class AzureFunctionTokenProvider implements ITokenProvider {
 		private readonly user?: Pick<AzureMember, "id" | "name" | "additionalDetails">,
 	) {}
 
-	public async fetchOrdererToken(tenantId: string, documentId?: string): Promise<ITokenResponse> {
+	public async fetchOrdererToken(
+		tenantId: string,
+		documentId?: string,
+	): Promise<ITokenResponse> {
 		return {
 			jwt: await this.getToken(tenantId, documentId),
 		};
 	}
 
-	public async fetchStorageToken(tenantId: string, documentId: string): Promise<ITokenResponse> {
+	public async fetchStorageToken(
+		tenantId: string,
+		documentId: string,
+	): Promise<ITokenResponse> {
 		return {
 			jwt: await this.getToken(tenantId, documentId),
 		};

package/src/AzureUrlResolver.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { type IRequest } from "@fluidframework/core-interfaces";
+import type { IRequest } from "@fluidframework/core-interfaces";
 import {
 	DriverHeader,
 	type IResolvedUrl,
@@ -56,7 +56,10 @@ export class AzureUrlResolver implements IUrlResolver {
 		};
 	}
 
-	public async getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string> {
+	public async getAbsoluteUrl(
+		resolvedUrl: IResolvedUrl,
+		relativeUrl: string,
+	): Promise<string> {
 		if (resolvedUrl.type !== "fluid") {
 			throw new Error("Invalid Resolved Url");
 		}
@@ -84,7 +87,8 @@ function decodeAzureUrl(urlString: string): {
 	const storageUrlDecoded = decodeURIComponent(storageUrl);
 	const tenantIdDecoded = decodeURIComponent(tenantId);
 	const containerId = searchParameters.get("containerId");
-	const containerIdDecoded = containerId === null ? undefined : decodeURIComponent(containerId);
+	const containerIdDecoded =
+		containerId === null ? undefined : decodeURIComponent(containerId);
 	return {
 		ordererUrl,
 		storageUrl: storageUrlDecoded,
@@ -100,7 +104,10 @@ function decodeAzureUrl(urlString: string): {
  * @param endpointUrl - URI to the Azure Fluid Relay service discovery endpoint.
  * @param tenantId - Unique tenant identifier.
  */
-export const createAzureCreateNewRequest = (endpointUrl: string, tenantId: string): IRequest => {
+export const createAzureCreateNewRequest = (
+	endpointUrl: string,
+	tenantId: string,
+): IRequest => {
 	const url = new URL(endpointUrl);
 	url.searchParams.append("storage", encodeURIComponent(endpointUrl));
 	url.searchParams.append("tenantId", encodeURIComponent(tenantId));

package/src/index.ts

@@ -26,8 +26,14 @@ export type {
 } from "./interfaces.js";
 
 export type { ITokenProvider, ITokenResponse } from "@fluidframework/routerlicious-driver";
-export type { ITokenClaims, IUser } from "@fluidframework/protocol-definitions";
-export { ScopeType } from "@fluidframework/protocol-definitions";
+export type { IUser } from "@fluidframework/driver-definitions";
+export { type ITokenClaims, ScopeType } from "@fluidframework/driver-definitions/internal";
 
 // Re-export so developers can build loggers without pulling in core-interfaces
-export type { ITelemetryBaseEvent, ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
+export type {
+	ITelemetryBaseEvent,
+	ITelemetryBaseLogger,
+} from "@fluidframework/core-interfaces";
+
+// Re-export so developers have access to parameter types for createContainer/getContainer without pulling in fluid-static
+export type { CompatibilityMode } from "@fluidframework/fluid-static";

package/src/interfaces.ts

@@ -3,14 +3,14 @@
  * Licensed under the MIT License.
  */
 
-import {
-	type IConfigProviderBase,
-	type ITelemetryBaseLogger,
+import type {
+	IConfigProviderBase,
+	ITelemetryBaseLogger,
 } from "@fluidframework/core-interfaces";
-import { type ICompressionStorageConfig } from "@fluidframework/driver-utils";
-import { type IMember, type IServiceAudience } from "@fluidframework/fluid-static";
-import { type IUser } from "@fluidframework/protocol-definitions";
-import { type ITokenProvider } from "@fluidframework/routerlicious-driver";
+import type { IUser } from "@fluidframework/driver-definitions";
+import type { ICompressionStorageConfig } from "@fluidframework/driver-utils";
+import type { IMember, IServiceAudience } from "@fluidframework/fluid-static";
+import type { ITokenProvider } from "@fluidframework/routerlicious-driver";
 
 /**
  * Props for initializing a new AzureClient instance
@@ -150,12 +150,13 @@ export interface AzureContainerServices {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export interface AzureUser<T = any> extends IUser {
 	/**
-	 * The user's name
+	 * {@inheritDoc AzureMember.name}
+	 *
 	 */
 	name: string;
 
 	/**
-	 * Custom, app-specific user information
+	 * {@inheritDoc AzureMember.additionalDetails}
 	 */
 	additionalDetails?: T;
 }
@@ -174,12 +175,12 @@ export interface AzureUser<T = any> extends IUser {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export interface AzureMember<T = any> extends IMember {
 	/**
-	 * {@inheritDoc AzureUser.name}
+	 * The user's name
 	 */
 	name: string;
 
 	/**
-	 * {@inheritDoc AzureUser.additionalDetails}
+	 * Custom, app-specific user information
 	 */
 	additionalDetails?: T;
 }

package/tsconfig.json

@@ -5,5 +5,6 @@
 	"compilerOptions": {
 		"rootDir": "./src",
 		"outDir": "./lib",
+		"exactOptionalPropertyTypes": false,
 	},
 }

package/tsdoc.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+	"extends": ["../../../common/build/build-common/tsdoc-base.json"]
+}