@fluidframework/azure-client 1.0.2 → 1.1.0-101037

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.0.2";
+export const pkgVersion = "1.1.0-101037";

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/**/*"],
 }