@fluidframework/azure-client 1.2.0-106934 → 1.2.0

package/src/AzureUrlResolver.ts

@@ -4,10 +4,10 @@
  */
 import { IRequest } from "@fluidframework/core-interfaces";
 import {
-    DriverHeader,
-    IFluidResolvedUrl,
-    IResolvedUrl,
-    IUrlResolver,
+	DriverHeader,
+	IFluidResolvedUrl,
+	IResolvedUrl,
+	IUrlResolver,
 } from "@fluidframework/driver-definitions";
 
 /**
@@ -18,89 +18,96 @@ import {
  * providers that fulfill the {@link @fluidframework/routerlicious-driver#ITokenProvider} interface.
  */
 export class AzureUrlResolver implements IUrlResolver {
-    constructor() {}
+	public constructor() {}
 
-    public async resolve(request: IRequest): Promise<IFluidResolvedUrl> {
-        const { ordererUrl, storageUrl, tenantId, containerId } = decodeAzureUrl(request.url);
-        // determine whether the request is for creating of a new container.
-        // such request has the `createNew` header set to true and doesn't have a container ID.
-        if (request.headers && request.headers[DriverHeader.createNew] === true) {
-            return {
-                endpoints: {
-                    deltaStorageUrl: `${ordererUrl}/deltas/${tenantId}/new`,
-                    ordererUrl,
-                    storageUrl: `${storageUrl}/repos/${tenantId}`,
-                },
-                // id is a mandatory attribute, but it's ignored by the driver for new container requests.
-                id: "",
-                // tokens attribute is redundant as all tokens are generated via ITokenProvider
-                tokens: {},
-                type: "fluid",
-                url: `${ordererUrl}/${tenantId}/new`,
-            };
-        }
-        if (containerId === undefined) {
-            throw new Error("Azure URL did not contain containerId");
-        }
-        const documentUrl = `${ordererUrl}/${tenantId}/${containerId}`;
-        return {
-            endpoints: {
-                deltaStorageUrl: `${ordererUrl}/deltas/${tenantId}/${containerId}`,
-                ordererUrl,
-                storageUrl: `${storageUrl}/repos/${tenantId}`,
-            },
-            id: containerId,
-            tokens: {},
-            type: "fluid",
-            url: documentUrl,
-        };
-    }
+	public async resolve(request: IRequest): Promise<IFluidResolvedUrl> {
+		const { ordererUrl, storageUrl, tenantId, containerId } = decodeAzureUrl(request.url);
+		// determine whether the request is for creating of a new container.
+		// such request has the `createNew` header set to true and doesn't have a container ID.
+		if (request.headers && request.headers[DriverHeader.createNew] === true) {
+			return {
+				endpoints: {
+					deltaStorageUrl: `${ordererUrl}/deltas/${tenantId}/new`,
+					ordererUrl,
+					storageUrl: `${storageUrl}/repos/${tenantId}`,
+				},
+				// id is a mandatory attribute, but it's ignored by the driver for new container requests.
+				id: "",
+				// tokens attribute is redundant as all tokens are generated via ITokenProvider
+				tokens: {},
+				type: "fluid",
+				url: `${ordererUrl}/${tenantId}/new`,
+			};
+		}
+		if (containerId === undefined) {
+			throw new Error("Azure URL did not contain containerId");
+		}
+		const documentUrl = `${ordererUrl}/${tenantId}/${containerId}`;
+		return {
+			endpoints: {
+				deltaStorageUrl: `${ordererUrl}/deltas/${tenantId}/${containerId}`,
+				ordererUrl,
+				storageUrl: `${storageUrl}/repos/${tenantId}`,
+			},
+			id: containerId,
+			tokens: {},
+			type: "fluid",
+			url: documentUrl,
+		};
+	}
 
-    public async getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string> {
-        if (resolvedUrl.type !== "fluid") {
-            throw new Error("Invalid Resolved Url");
-        }
-        return `${resolvedUrl.url}/${relativeUrl}`;
-    }
+	public async getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string> {
+		if (resolvedUrl.type !== "fluid") {
+			throw new Error("Invalid Resolved Url");
+		}
+		return `${resolvedUrl.url}/${relativeUrl}`;
+	}
 }
 
 function decodeAzureUrl(urlString: string): {
-    ordererUrl: string;
-    storageUrl: string;
-    tenantId: string;
-    containerId?: string;
+	ordererUrl: string;
+	storageUrl: string;
+	tenantId: string;
+	containerId?: string;
 } {
-    const url = new URL(urlString);
-    const ordererUrl = url.origin;
-    const searchParams = url.searchParams;
-    const storageUrl = searchParams.get("storage");
-    if (storageUrl === null) {
-        throw new Error("Azure URL did not contain a storage URL");
-    }
-    const tenantId = searchParams.get("tenantId");
-    if (tenantId === null) {
-        throw new Error("Azure URL did not contain a tenant ID");
-    }
-    const storageUrlDecoded = decodeURIComponent(storageUrl);
-    const tenantIdDecoded = decodeURIComponent(tenantId);
-    const containerId = searchParams.get("containerId");
-    const containerIdDecoded = containerId !== null ? decodeURIComponent(containerId) : undefined;
-    return {
-        ordererUrl,
-        storageUrl: storageUrlDecoded,
-        tenantId: tenantIdDecoded,
-        containerId: containerIdDecoded,
-    };
+	const url = new URL(urlString);
+	const ordererUrl = url.origin;
+	const searchParams = url.searchParams;
+	const storageUrl = searchParams.get("storage");
+	if (storageUrl === null) {
+		throw new Error("Azure URL did not contain a storage URL");
+	}
+	const tenantId = searchParams.get("tenantId");
+	if (tenantId === null) {
+		throw new Error("Azure URL did not contain a tenant ID");
+	}
+	const storageUrlDecoded = decodeURIComponent(storageUrl);
+	const tenantIdDecoded = decodeURIComponent(tenantId);
+	const containerId = searchParams.get("containerId");
+	const containerIdDecoded = containerId !== null ? decodeURIComponent(containerId) : undefined;
+	return {
+		ordererUrl,
+		storageUrl: storageUrlDecoded,
+		tenantId: tenantIdDecoded,
+		containerId: containerIdDecoded,
+	};
 }
 
+/**
+ * Creates a request object that can be passed to {@link @fluidframework/fluid-static#IFluidContainer.attach} to
+ * request creation of a new Fluid Container on the Azure service.
+ *
+ * @param endpointUrl - URI to the Azure Fluid Relay service discovery endpoint.
+ * @param tenantId - Unique tenant identifier.
+ */
 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));
-    return {
-        url: url.href,
-        headers: {
-            [DriverHeader.createNew]: true,
-        },
-    };
+	const url = new URL(endpointUrl);
+	url.searchParams.append("storage", encodeURIComponent(endpointUrl));
+	url.searchParams.append("tenantId", encodeURIComponent(tenantId));
+	return {
+		url: url.href,
+		headers: {
+			[DriverHeader.createNew]: true,
+		},
+	};
 };

package/src/index.ts

@@ -13,19 +13,19 @@ export { AzureAudience } from "./AzureAudience";
 export { AzureClient } from "./AzureClient";
 export { AzureFunctionTokenProvider } from "./AzureFunctionTokenProvider";
 export {
-    AzureClientProps,
-    AzureConnectionConfig,
-    AzureConnectionConfigType,
-    AzureContainerServices,
-    AzureContainerVersion,
-    AzureGetVersionsOptions,
-    AzureLocalConnectionConfig,
-    AzureMember,
-    AzureRemoteConnectionConfig,
-    AzureUser,
-    IAzureAudience,
-    ITelemetryBaseEvent,
-    ITelemetryBaseLogger,
+	AzureClientProps,
+	AzureConnectionConfig,
+	AzureConnectionConfigType,
+	AzureContainerServices,
+	AzureContainerVersion,
+	AzureGetVersionsOptions,
+	AzureLocalConnectionConfig,
+	AzureMember,
+	AzureRemoteConnectionConfig,
+	AzureUser,
+	IAzureAudience,
+	ITelemetryBaseEvent,
+	ITelemetryBaseLogger,
 } from "./interfaces";
 
 export { ITokenProvider, ITokenResponse } from "@fluidframework/routerlicious-driver";

package/src/interfaces.ts

@@ -14,40 +14,40 @@ export { ITelemetryBaseEvent, ITelemetryBaseLogger } from "@fluidframework/commo
  * Props for initializing a new AzureClient instance
  */
 export interface AzureClientProps {
-    /**
-     * Configuration for establishing a connection with the Azure Fluid Relay.
-     */
-    readonly connection: AzureRemoteConnectionConfig | AzureLocalConnectionConfig;
-    /**
-     * Optional. A logger instance to receive diagnostic messages.
-     */
-    readonly logger?: ITelemetryBaseLogger;
+	/**
+	 * Configuration for establishing a connection with the Azure Fluid Relay.
+	 */
+	readonly connection: AzureRemoteConnectionConfig | AzureLocalConnectionConfig;
+	/**
+	 * Optional. A logger instance to receive diagnostic messages.
+	 */
+	readonly logger?: ITelemetryBaseLogger;
 }
 
 /**
  * Container version metadata.
  */
 export interface AzureContainerVersion {
-    /**
-     * Version ID
-     */
-    id: string;
+	/**
+	 * Version ID
+	 */
+	id: string;
 
-    /**
-     * Time when version was generated.
-     * ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
-     */
-    date?: string;
+	/**
+	 * Time when version was generated.
+	 * ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
+	 */
+	date?: string;
 }
 
 /**
  * Options for "Get Container Versions" API.
  */
 export interface AzureGetVersionsOptions {
-    /**
-     * Max number of versions
-     */
-    maxCount: number;
+	/**
+	 * Max number of versions
+	 */
+	maxCount: number;
 }
 
 /**
@@ -61,42 +61,42 @@ export type AzureConnectionConfigType = "local" | "remote";
  * Parameters for establishing a connection with the Azure Fluid Relay.
  */
 export interface AzureConnectionConfig {
-    /**
-     * The type of connection. Whether we're connecting to a remote Fluid relay server or a local instance.
-     */
-    type: AzureConnectionConfigType;
-    /**
-     * URI to the Azure Fluid Relay service discovery endpoint.
-     */
-    endpoint: string;
-    /**
-     * Instance that provides Azure Fluid Relay endpoint tokens.
-     */
-    tokenProvider: ITokenProvider;
+	/**
+	 * The type of connection. Whether we're connecting to a remote Fluid relay server or a local instance.
+	 */
+	type: AzureConnectionConfigType;
+	/**
+	 * URI to the Azure Fluid Relay service discovery endpoint.
+	 */
+	endpoint: string;
+	/**
+	 * Instance that provides Azure Fluid Relay endpoint tokens.
+	 */
+	tokenProvider: ITokenProvider;
 }
 
 /**
  * Parameters for establishing a remote connection with the Azure Fluid Relay.
  */
 export interface AzureRemoteConnectionConfig extends AzureConnectionConfig {
-    /**
-     * The type of connection. Set to a remote connection.
-     */
-    type: "remote";
-    /**
-     * Unique tenant identifier.
-     */
-    tenantId: string;
+	/**
+	 * The type of connection. Set to a remote connection.
+	 */
+	type: "remote";
+	/**
+	 * Unique tenant identifier.
+	 */
+	tenantId: string;
 }
 
 /**
  * Parameters for establishing a local connection with a local instance of the Azure Fluid Relay.
  */
 export interface AzureLocalConnectionConfig extends AzureConnectionConfig {
-    /**
-     * The type of connection. Set to a remote connection.
-     */
-    type: "local";
+	/**
+	 * The type of connection. Set to a remote connection.
+	 */
+	type: "local";
 }
 
 /**
@@ -107,11 +107,11 @@ export interface AzureLocalConnectionConfig extends AzureConnectionConfig {
  * will not be included here but rather on the FluidContainer class itself.
  */
 export interface AzureContainerServices {
-    /**
-     * Provides an object that can be used to get the users that are present in this Fluid session and
-     * listeners for when the roster has any changes from users joining/leaving the session
-     */
-    audience: IAzureAudience;
+	/**
+	 * Provides an object that can be used to get the users that are present in this Fluid session and
+	 * listeners for when the roster has any changes from users joining/leaving the session
+	 */
+	audience: IAzureAudience;
 }
 
 /**
@@ -125,15 +125,15 @@ export interface AzureContainerServices {
 // TODO: this should be updated to use something other than `any` (unknown)
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export interface AzureUser<T = any> extends IUser {
-    /**
-     * The user's name
-     */
-    name: string;
+	/**
+	 * The user's name
+	 */
+	name: string;
 
-    /**
-     * Custom, app-specific user information
-     */
-    additionalDetails?: T;
+	/**
+	 * Custom, app-specific user information
+	 */
+	additionalDetails?: T;
 }
 
 /**
@@ -148,15 +148,15 @@ export interface AzureUser<T = any> extends IUser {
 // TODO: this should be updated to use something other than `any` (unknown)
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export interface AzureMember<T = any> extends IMember {
-    /**
-     * {@inheritDoc AzureUser.name}
-     */
-    userName: string;
+	/**
+	 * {@inheritDoc AzureUser.name}
+	 */
+	userName: string;
 
-    /**
-     * {@inheritDoc AzureUser.additionalDetails}
-     */
-    additionalDetails?: T;
+	/**
+	 * {@inheritDoc AzureUser.additionalDetails}
+	 */
+	additionalDetails?: T;
 }
 
 /**

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/azure-client";
-export const pkgVersion = "1.2.0-106934";
+export const pkgVersion = "1.2.0";

package/src/utils.ts

@@ -3,25 +3,25 @@
  * Licensed under the MIT License.
  */
 import {
-    AzureConnectionConfig,
-    AzureLocalConnectionConfig,
-    AzureRemoteConnectionConfig,
+	AzureConnectionConfig,
+	AzureLocalConnectionConfig,
+	AzureRemoteConnectionConfig,
 } from "./interfaces";
 
 /**
  * Type guard for validating a given AzureConnectionConfig is a remote connection type (AzureRemoteConnectionConfig)
  */
 export function isAzureRemoteConnectionConfig(
-    connectionConfig: AzureConnectionConfig,
+	connectionConfig: AzureConnectionConfig,
 ): connectionConfig is AzureRemoteConnectionConfig {
-    return connectionConfig.type === "remote";
+	return connectionConfig.type === "remote";
 }
 
 /**
  * Type guard for validating a given AzureConnectionConfig is a local connection type (AzureLocalConnectionConfig)
  */
 export function isAzureLocalConnectionConfig(
-    connectionConfig: AzureConnectionConfig,
+	connectionConfig: AzureConnectionConfig,
 ): connectionConfig is AzureLocalConnectionConfig {
-    return connectionConfig.type === "local";
+	return connectionConfig.type === "local";
 }

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,11 +1,11 @@
 {
-  "extends": "@fluidframework/build-common/ts-common-config.json",
-  "compilerOptions": {
-    "rootDir": "./src",
-    "outDir": "./dist",
-    "composite": true,
-    "types": ["node"],
-  },
-  "include": ["src/**/*"],
-  "exclude": ["src/test/**/*"],
+	"extends": "@fluidframework/build-common/ts-common-config.json",
+	"compilerOptions": {
+		"rootDir": "./src",
+		"outDir": "./dist",
+		"composite": true,
+		"types": ["node"],
+	},
+	"include": ["src/**/*"],
+	"exclude": ["src/test/**/*"],
 }