Tag AzureClient public (#18678)

Tags the AzureClient class and all it's transitive dependencies as public. --------- Co-authored-by: Tony Murphy <anthonm@microsoft.com> Co-authored-by: Joshua Smithrud <54606601+Josmithr@users.noreply.github.com>
microsoft · Dec 14, 2023 · 04a597c · 04a597c
1 parent 7a248ae
commit 04a597c
Show file tree

Hide file tree

Showing 15 changed files with 80 additions and 76 deletions.
diff --git a/azure/packages/azure-client/api-report/azure-client.api.md b/azure/packages/azure-client/api-report/azure-client.api.md
@@ -18,7 +18,7 @@ import { ITokenResponse } from '@fluidframework/routerlicious-driver';
 import { IUser } from '@fluidframework/protocol-definitions';
 import { ScopeType } from '@fluidframework/protocol-definitions';
 
-// @alpha
+// @public
 export class AzureClient {
     constructor(properties: AzureClientProps);
     copyContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, version?: AzureContainerVersion): Promise<{
@@ -36,7 +36,7 @@ export class AzureClient {
     getContainerVersions(id: string, options?: AzureGetVersionsOptions): Promise<AzureContainerVersion[]>;
 }
 
-// @alpha
+// @public
 export interface AzureClientProps {
     readonly configProvider?: IConfigProviderBase;
     readonly connection: AzureRemoteConnectionConfig | AzureLocalConnectionConfig;
@@ -45,22 +45,22 @@ export interface AzureClientProps {
     readonly summaryCompression?: boolean | ICompressionStorageConfig;
 }
 
-// @alpha
+// @public
 export interface AzureConnectionConfig {
     endpoint: string;
     tokenProvider: ITokenProvider;
     type: AzureConnectionConfigType;
 }
 
-// @alpha
+// @public
 export type AzureConnectionConfigType = "local" | "remote";
 
-// @alpha
+// @public
 export interface AzureContainerServices {
     audience: IAzureAudience;
 }
 
-// @alpha
+// @public
 export interface AzureContainerVersion {
     date?: string;
     id: string;
@@ -75,23 +75,23 @@ export class AzureFunctionTokenProvider implements ITokenProvider {
     fetchStorageToken(tenantId: string, documentId: string): Promise<ITokenResponse>;
 }
 
-// @alpha
+// @public
 export interface AzureGetVersionsOptions {
     maxCount: number;
 }
 
-// @alpha
+// @public
 export interface AzureLocalConnectionConfig extends AzureConnectionConfig {
     type: "local";
 }
 
-// @alpha
+// @public
 export interface AzureMember<T = any> extends IMember {
     additionalDetails?: T;
     userName: string;
 }
 
-// @alpha
+// @public
 export interface AzureRemoteConnectionConfig extends AzureConnectionConfig {
     tenantId: string;
     type: "remote";
@@ -103,7 +103,7 @@ export interface AzureUser<T = any> extends IUser {
     name: string;
 }
 
-// @alpha
+// @public
 export type IAzureAudience = IServiceAudience<AzureMember>;
 
 export { ITelemetryBaseEvent }

diff --git a/azure/packages/azure-client/src/AzureClient.ts b/azure/packages/azure-client/src/AzureClient.ts
@@ -52,7 +52,7 @@ const MAX_VERSION_COUNT = 5;
 /**
  * AzureClient provides the ability to have a Fluid object backed by the Azure Fluid Relay or,
  * when running with local tenantId, have it be backed by a local Azure Fluid Relay instance.
- * @alpha
+ * @public
  */
 export class AzureClient {
 	private readonly documentServiceFactory: IDocumentServiceFactory;

diff --git a/azure/packages/azure-client/src/interfaces.ts b/azure/packages/azure-client/src/interfaces.ts
@@ -13,7 +13,7 @@ import { type ICompressionStorageConfig } from "@fluidframework/driver-utils";
 
 /**
  * Props for initializing a new AzureClient instance
- * @alpha
+ * @public
  */
 export interface AzureClientProps {
 	/**
@@ -35,7 +35,7 @@ export interface AzureClientProps {
 
 /**
  * Container version metadata.
- * @alpha
+ * @public
  */
 export interface AzureContainerVersion {
 	/**
@@ -52,7 +52,7 @@ export interface AzureContainerVersion {
 
 /**
  * Options for "Get Container Versions" API.
- * @alpha
+ * @public
  */
 export interface AzureGetVersionsOptions {
 	/**
@@ -67,13 +67,13 @@ export interface AzureGetVersionsOptions {
  * - "local" for local connections to a Fluid relay instance running on the localhost
  *
  * - "remote" for client connections to the Azure Fluid Relay service
- * @alpha
+ * @public
  */
 export type AzureConnectionConfigType = "local" | "remote";
 
 /**
  * Parameters for establishing a connection with the Azure Fluid Relay.
- * @alpha
+ * @public
  */
 export interface AzureConnectionConfig {
 	/**
@@ -92,7 +92,7 @@ export interface AzureConnectionConfig {
 
 /**
  * Parameters for establishing a remote connection with the Azure Fluid Relay.
- * @alpha
+ * @public
  */
 export interface AzureRemoteConnectionConfig extends AzureConnectionConfig {
 	/**
@@ -107,7 +107,7 @@ export interface AzureRemoteConnectionConfig extends AzureConnectionConfig {
 
 /**
  * Parameters for establishing a local connection with a local instance of the Azure Fluid Relay.
- * @alpha
+ * @public
  */
 export interface AzureLocalConnectionConfig extends AzureConnectionConfig {
 	/**
@@ -126,7 +126,7 @@ export interface AzureLocalConnectionConfig extends AzureConnectionConfig {
  *
  * Any functionality regarding how the data is handled within the FluidContainer itself, i.e. which data objects
  * or DDSes to use, will not be included here but rather on the FluidContainer class itself.
- * @alpha
+ * @public
  */
 export interface AzureContainerServices {
 	/**
@@ -167,7 +167,7 @@ export interface AzureUser<T = any> extends IUser {
  * @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.
- * @alpha
+ * @public
  */
 // TODO: this should be updated to use something other than `any` (unknown)
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -185,6 +185,6 @@ export interface AzureMember<T = any> extends IMember {
 
 /**
  * Audience object for Azure Fluid Relay containers
- * @alpha
+ * @public
  */
 export type IAzureAudience = IServiceAudience<AzureMember>;
diff --git a/packages/common/container-definitions/api-report/container-definitions.api.md b/packages/common/container-definitions/api-report/container-definitions.api.md
@@ -41,15 +41,15 @@ export enum AttachState {
     Detached = "Detached"
 }
 
-// @alpha
+// @public
 export namespace ConnectionState {
     export type CatchingUp = 1;
     export type Connected = 2;
     export type Disconnected = 0;
     export type EstablishingConnection = 3;
 }
 
-// @alpha
+// @public
 export type ConnectionState = ConnectionState.Disconnected | ConnectionState.EstablishingConnection | ConnectionState.CatchingUp | ConnectionState.Connected;
 
 // @internal @deprecated
@@ -228,7 +228,7 @@ export interface IContainerLoadMode {
     pauseAfterLoad?: boolean;
 }
 
-// @alpha
+// @public
 export type ICriticalContainerError = IErrorBase;
 
 // @public @sealed

diff --git a/packages/common/container-definitions/src/error.ts b/packages/common/container-definitions/src/error.ts
@@ -89,6 +89,6 @@ export interface ContainerWarning extends IErrorBase {
  * - {@link @fluidframework/odsp-driver-definitions#OdspErrorType}
  *
  * - {@link @fluidframework/routerlicious-driver#RouterliciousErrorType}
- * @alpha
+ * @public
  */
 export type ICriticalContainerError = IErrorBase;
diff --git a/packages/common/container-definitions/src/loader.ts b/packages/common/container-definitions/src/loader.ts
@@ -250,41 +250,41 @@ export interface IContainerEvents extends IEvent {
 /**
  * Namespace for the different connection states a container can be in.
  * PLEASE NOTE: The sequence of the numerical values does no correspond to the typical connection state progression.
- * @alpha
+ * @public
  */
 // eslint-disable-next-line @typescript-eslint/no-namespace
 export namespace ConnectionState {
 	/**
 	 * The container is not connected to the delta server.
 	 * Note - When in this state the container may be about to reconnect,
 	 * or may remain disconnected until explicitly told to connect.
-	 * @alpha
+	 * @public
 	 */
 	export type Disconnected = 0;
 
 	/**
 	 * The container is disconnected but actively trying to establish a new connection.
 	 * PLEASE NOTE that this numerical value falls out of the order you may expect for this state.
-	 * @alpha
+	 * @public
 	 */
 	export type EstablishingConnection = 3;
 
 	/**
 	 * The container has an inbound connection only, and is catching up to the latest known state from the service.
-	 * @alpha
+	 * @public
 	 */
 	export type CatchingUp = 1;
 
 	/**
 	 * The container is fully connected and syncing.
-	 * @alpha
+	 * @public
 	 */
 	export type Connected = 2;
 }
 
 /**
  * Type defining the different states of connectivity a Container can be in.
- * @alpha
+ * @public
  */
 export type ConnectionState =
 	| ConnectionState.Disconnected

diff --git a/packages/common/core-interfaces/api-report/core-interfaces.api.md b/packages/common/core-interfaces/api-report/core-interfaces.api.md
@@ -4,7 +4,7 @@
 
 ```ts
 
-// @alpha
+// @public
 export type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined;
 
 // @public
@@ -33,7 +33,7 @@ export type FluidObjectKeys<T> = keyof FluidObject<T>;
 // @public
 export type FluidObjectProviderKeys<T, TProp extends keyof T = keyof T> = string extends TProp ? never : number extends TProp ? never : TProp extends keyof Required<T>[TProp] ? Required<T>[TProp] extends Required<Required<T>[TProp]>[TProp] ? TProp : never : never;
 
-// @alpha
+// @public
 export interface IConfigProviderBase {
     getRawConfig(name: string): ConfigTypes;
 }

diff --git a/packages/common/core-interfaces/src/config.ts b/packages/common/core-interfaces/src/config.ts
@@ -5,13 +5,13 @@
 
 /**
  * Types supported by {@link IConfigProviderBase}.
- * @alpha
+ * @public
  */
 export type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined;
 
 /**
  * Base interface for providing configurations to enable/disable/control features.
- * @alpha
+ * @public
  */
 export interface IConfigProviderBase {
 	/**

diff --git a/packages/drivers/routerlicious-driver/api-report/routerlicious-driver.api.md b/packages/drivers/routerlicious-driver/api-report/routerlicious-driver.api.md
@@ -44,14 +44,14 @@ export interface IRouterliciousDriverPolicies {
     maxConcurrentStorageRequests: number;
 }
 
-// @alpha
+// @public
 export interface ITokenProvider {
     documentPostCreateCallback?(documentId: string, creationToken: string): Promise<void>;
     fetchOrdererToken(tenantId: string, documentId?: string, refresh?: boolean): Promise<ITokenResponse>;
     fetchStorageToken(tenantId: string, documentId: string, refresh?: boolean): Promise<ITokenResponse>;
 }
 
-// @alpha (undocumented)
+// @public (undocumented)
 export interface ITokenResponse {
     fromCache?: boolean;
     jwt: string;

diff --git a/packages/drivers/routerlicious-driver/src/tokens.ts b/packages/drivers/routerlicious-driver/src/tokens.ts
@@ -18,7 +18,7 @@ export interface ITokenService {
 }
 
 /**
- * @alpha
+ * @public
  */
 export interface ITokenResponse {
 	/**
@@ -37,7 +37,7 @@ export interface ITokenResponse {
 /**
  * Abstracts the token fetching mechanism for a hosting application.
  * The hosting application is responsible for providing an implementation.
- * @alpha
+ * @public
  */
 export interface ITokenProvider {
 	/**