@fluidframework/azure-client 1.1.0-74609 → 1.1.1

package/src/AzureUrlResolver.ts

@@ -2,7 +2,6 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-
 import { IRequest } from "@fluidframework/core-interfaces";
 import {
     DriverHeader,
@@ -11,23 +10,21 @@ import {
     IUrlResolver,
 } from "@fluidframework/driver-definitions";
 
-// Implementation of a URL resolver to resolve documents stored using the Azure Fluid Relay
-// based off of the orderer and storage URLs provide. The token provider here can be a
-// InsecureTokenProvider for basic scenarios or more robust, secure providers that fulfill the
-// ITokenProvider interface
+/**
+ * Implementation of {@link @fluidframework/driver-definitions#IUrlResolver} to resolve documents stored using the
+ * Azure Fluid Relay based off of the orderer and storage URLs provide.
+ *
+ * @remarks The token provider here can be an `InsecureTokenProvider` for basic scenarios or more robust, secure
+ * providers that fulfill the {@link @fluidframework/routerlicious-driver#ITokenProvider} interface.
+ */
 export class AzureUrlResolver implements IUrlResolver {
-    constructor() { }
+    constructor() {}
 
     public async resolve(request: IRequest): Promise<IFluidResolvedUrl> {
-        const { ordererUrl, storageUrl, tenantId, containerId } = decodeAzureUrl(
-            request.url,
-        );
+        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
-        ) {
+        if (request.headers && request.headers[DriverHeader.createNew] === true) {
             return {
                 endpoints: {
                     deltaStorageUrl: `${ordererUrl}/deltas/${tenantId}/new`,
@@ -46,7 +43,7 @@ export class AzureUrlResolver implements IUrlResolver {
             throw new Error("Azure URL did not contain containerId");
         }
         const documentUrl = `${ordererUrl}/${tenantId}/${containerId}`;
-        return Promise.resolve({
+        return {
             endpoints: {
                 deltaStorageUrl: `${ordererUrl}/deltas/${tenantId}/${containerId}`,
                 ordererUrl,
@@ -56,15 +53,12 @@ export class AzureUrlResolver implements IUrlResolver {
             tokens: {},
             type: "fluid",
             url: documentUrl,
-        });
+        };
     }
 
-    public async getAbsoluteUrl(
-        resolvedUrl: IResolvedUrl,
-        relativeUrl: string,
-    ): Promise<string> {
+    public async getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string): Promise<string> {
         if (resolvedUrl.type !== "fluid") {
-            throw Error("Invalid Resolved Url");
+            throw new Error("Invalid Resolved Url");
         }
         return `${resolvedUrl.url}/${relativeUrl}`;
     }
@@ -99,10 +93,7 @@ function decodeAzureUrl(urlString: string): {
     };
 }
 
-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

@@ -9,10 +9,24 @@
  * @packageDocumentation
  */
 
-export * from "./AzureAudience";
-export * from "./AzureClient";
-export * from "./AzureFunctionTokenProvider";
-export * from "./interfaces";
+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,
+} from "./interfaces";
 
 export { ITokenProvider, ITokenResponse } from "@fluidframework/routerlicious-driver";
-export { ScopeType, ITokenClaims, IUser } from "@fluidframework/protocol-definitions";
+export { ITokenClaims, IUser, ScopeType } from "@fluidframework/protocol-definitions";

package/src/interfaces.ts

@@ -2,19 +2,13 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-
 import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
-import {
-    IMember,
-    IServiceAudience,
-} from "@fluidframework/fluid-static";
+import { IMember, IServiceAudience } from "@fluidframework/fluid-static";
+import { IUser } from "@fluidframework/protocol-definitions";
 import { ITokenProvider } from "@fluidframework/routerlicious-driver";
 
 // Re-export so developers can build loggers without pulling in common-definitions
-export {
-    ITelemetryBaseEvent,
-    ITelemetryBaseLogger,
-} from "@fluidframework/common-definitions";
+export { ITelemetryBaseEvent, ITelemetryBaseLogger } from "@fluidframework/common-definitions";
 
 /**
  * Props for initializing a new AzureClient instance
@@ -23,7 +17,7 @@ export interface AzureClientProps {
     /**
      * Configuration for establishing a connection with the Azure Fluid Relay.
      */
-    readonly connection: AzureConnectionConfig;
+    readonly connection: AzureRemoteConnectionConfig | AzureLocalConnectionConfig;
     /**
      * Optional. A logger instance to receive diagnostic messages.
      */
@@ -121,11 +115,47 @@ export interface AzureContainerServices {
 }
 
 /**
- * Since Azure provides user names for all of its members, we extend the IMember interface to include
- * this service-specific value. It will be returned for all audience members connected to Azure.
+ * Since Azure provides user names for all of its members, we extend the
+ * {@link @fluidframework/protocol-definitions#IUser} interface to include this service-specific value. *
+ *
+ * @typeParam T - See {@link AzureUser.additionalDetails}.
+ * Note: must be JSON-serializable.
+ * Passing a non-serializable object (e.g. a `class`) will result in undefined behavior.
+ */
+// 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;
+
+    /**
+     * Custom, app-specific user information
+     */
+    additionalDetails?: T;
+}
+
+/**
+ * Since Azure provides user names for all of its members, we extend the
+ * {@link @fluidframework/protocol-definitions#IMember} interface to include this service-specific value.
+ * It will be returned for all audience members connected to Azure.
+ *
+ * @typeParam T - See {@link AzureMember.additionalDetails}.
+ * Note: must be JSON-serializable.
+ * Passing a non-serializable object (e.g. a `class`) will result in undefined behavior.
  */
+// 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.additionalDetails}
+     */
     additionalDetails?: T;
 }
 

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/azure-client";
-export const pkgVersion = "1.1.0-74609";
+export const pkgVersion = "1.1.1";

package/src/utils.ts

@@ -2,13 +2,18 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { AzureRemoteConnectionConfig, AzureLocalConnectionConfig, AzureConnectionConfig } from "./interfaces";
+import {
+    AzureConnectionConfig,
+    AzureLocalConnectionConfig,
+    AzureRemoteConnectionConfig,
+} from "./interfaces";
 
 /**
  * Type guard for validating a given AzureConnectionConfig is a remote connection type (AzureRemoteConnectionConfig)
  */
 export function isAzureRemoteConnectionConfig(
-    connectionConfig: AzureConnectionConfig): connectionConfig is AzureRemoteConnectionConfig {
+    connectionConfig: AzureConnectionConfig,
+): connectionConfig is AzureRemoteConnectionConfig {
     return connectionConfig.type === "remote";
 }
 
@@ -16,6 +21,7 @@ export function isAzureRemoteConnectionConfig(
  * Type guard for validating a given AzureConnectionConfig is a local connection type (AzureLocalConnectionConfig)
  */
 export function isAzureLocalConnectionConfig(
-    connectionConfig: AzureConnectionConfig): connectionConfig is AzureLocalConnectionConfig {
+    connectionConfig: AzureConnectionConfig,
+): connectionConfig is AzureLocalConnectionConfig {
     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,17 +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/**/*"],
 }