docs: Improve @fluidframework/test-client-utils API docs

api-report/test-runtime-utils.api.md

@@ -67,7 +67,9 @@ export interface IMockContainerRuntimePendingMessage {
 
 // @public
 export class InsecureTokenProvider implements ITokenProvider {
-    constructor(tenantKey: string, user: IUser);
+    constructor(
+    tenantKey: string,
+    user: IUser);
     // (undocumented)
     fetchOrdererToken(tenantId: string, documentId?: string): Promise<ITokenResponse>;
     // (undocumented)

common/lib/protocol-definitions/api-report/protocol-definitions.api.md

@@ -590,7 +590,6 @@ export interface IUploadedSummaryDetails {
 
 // @public
 export interface IUser {
-    // (undocumented)
     id: string;
 }
 

common/lib/protocol-definitions/src/users.ts

@@ -7,5 +7,8 @@
  * Base user definition. It is valid to extend this interface when adding new details to the user object.
  */
 export interface IUser {
+    /**
+     * Unique identifier of the user session. This ID is established on each connection with the service.
+     */
     id: string;
 }

docs/rollup-api-data.js

@@ -20,6 +20,7 @@ const websitePackages = [
     "@fluidframework/map",
     "@fluidframework/sequence",
     "@fluidframework/fluid-static",
+    "@fluidframework/routerlicious-driver",
     "@fluidframework/test-client-utils",
     "@fluidframework/tinylicious-client",
 ];

packages/drivers/routerlicious-driver/src/tokens.ts

@@ -21,8 +21,7 @@ export interface ITokenResponse {
 }
 
 /**
- * The ITokenProvider abstracts the token fetching mechanism for a host. Host will be responsible for
- * implementing the interfaces.
+ * Abstracts the token fetching mechanism for a hosting application. The hosting application will be responsible for providing an implementation.
  */
 export interface ITokenProvider {
     /**

packages/framework/test-client-utils/src/generateTestUser.ts

@@ -7,7 +7,9 @@ import generateName from "sillyname";
 import { v4 as uuid } from "uuid";
 
 /**
- * Create a new user object with a unique id (uuid) and random name (FIRST LAST)
+ * Create a new user object with a unique id
+ * ({@link https://en.wikipedia.org/wiki/Universally_unique_identifier | uuid}) and random name (FIRST LAST)
+ *
  * @returns a user object with a name and id property
  */
 export const generateTestUser = (): IUser & { name: string; } => {

packages/runtime/test-runtime-utils/src/insecureTokenProvider.ts

@@ -8,17 +8,28 @@ import { ITokenProvider, ITokenResponse } from "@fluidframework/routerlicious-dr
 import { generateToken } from "./generateToken";
 
 /**
- * As the name implies this is not secure and should not be used in production. It simply makes the example easier
- * to get up and running.
+ * {@link @fluidframework/routerlicious-driver#ITokenProvider} intended for **test use only**.
+ * As the name implies this is not secure and should not be used in production.
+ * It simply makes examples where authentication is not relevant easier to bootstrap.
  */
 export class InsecureTokenProvider implements ITokenProvider {
     constructor(
+        /**
+         * TODO
+         */
         private readonly tenantKey: string,
+
+        /**
+         * User with whom generated tokens will be associated.
+         */
         private readonly user: IUser,
     ) {
 
     }
 
+    /**
+     * {@inheritDoc @fluidframework/routerlicious-driver#ITokenProvider.fetchOrdererToken}
+     */
     public async fetchOrdererToken(tenantId: string, documentId?: string): Promise<ITokenResponse> {
         return {
             fromCache: true,
@@ -36,6 +47,9 @@ export class InsecureTokenProvider implements ITokenProvider {
         };
     }
 
+    /**
+     * {@inheritDoc @fluidframework/routerlicious-driver#ITokenProvider.fetchStorageToken}
+     */
     public async fetchStorageToken(tenantId: string, documentId: string): Promise<ITokenResponse> {
         return {
             fromCache: true,