Tag AzureClient and OdspClient as alpha

azure/packages/azure-client/api-report/azure-client.api.md

@@ -25,7 +25,7 @@ export class AzureAudience extends ServiceAudience<AzureMember> implements IAzur
     protected createServiceMember(audienceMember: IClient): AzureMember;
 }
 
-// @internal
+// @alpha
 export class AzureClient {
     constructor(properties: AzureClientProps);
     copyContainer<TContainerSchema extends ContainerSchema>(id: string, containerSchema: TContainerSchema, version?: AzureContainerVersion): Promise<{
@@ -43,7 +43,7 @@ export class AzureClient {
     getContainerVersions(id: string, options?: AzureGetVersionsOptions): Promise<AzureContainerVersion[]>;
 }
 
-// @internal
+// @alpha
 export interface AzureClientProps {
     readonly configProvider?: IConfigProviderBase;
     readonly connection: AzureRemoteConnectionConfig | AzureLocalConnectionConfig;
@@ -52,22 +52,22 @@ export interface AzureClientProps {
     readonly summaryCompression?: boolean | ICompressionStorageConfig;
 }
 
-// @internal
+// @alpha
 export interface AzureConnectionConfig {
     endpoint: string;
     tokenProvider: ITokenProvider;
     type: AzureConnectionConfigType;
 }
 
-// @internal
+// @alpha
 export type AzureConnectionConfigType = "local" | "remote";
 
-// @internal
+// @alpha
 export interface AzureContainerServices {
     audience: IAzureAudience;
 }
 
-// @internal
+// @alpha
 export interface AzureContainerVersion {
     date?: string;
     id: string;
@@ -82,23 +82,23 @@ export class AzureFunctionTokenProvider implements ITokenProvider {
     fetchStorageToken(tenantId: string, documentId: string): Promise<ITokenResponse>;
 }
 
-// @internal
+// @alpha
 export interface AzureGetVersionsOptions {
     maxCount: number;
 }
 
-// @internal
+// @alpha
 export interface AzureLocalConnectionConfig extends AzureConnectionConfig {
     type: "local";
 }
 
-// @internal
+// @alpha
 export interface AzureMember<T = any> extends IMember {
     additionalDetails?: T;
     userName: string;
 }
 
-// @internal
+// @alpha
 export interface AzureRemoteConnectionConfig extends AzureConnectionConfig {
     tenantId: string;
     type: "remote";
@@ -110,7 +110,7 @@ export interface AzureUser<T = any> extends IUser {
     name: string;
 }
 
-// @internal
+// @alpha
 export type IAzureAudience = IServiceAudience<AzureMember>;
 
 export { ITelemetryBaseEvent }

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.
- * @internal
+ * @alpha
  */
 export class AzureClient {
 	private readonly documentServiceFactory: IDocumentServiceFactory;

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
- * @internal
+ * @alpha
  */
 export interface AzureClientProps {
 	/**
@@ -35,7 +35,7 @@ export interface AzureClientProps {
 
 /**
  * Container version metadata.
- * @internal
+ * @alpha
  */
 export interface AzureContainerVersion {
 	/**
@@ -52,7 +52,7 @@ export interface AzureContainerVersion {
 
 /**
  * Options for "Get Container Versions" API.
- * @internal
+ * @alpha
  */
 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
- * @internal
+ * @alpha
  */
 export type AzureConnectionConfigType = "local" | "remote";
 
 /**
  * Parameters for establishing a connection with the Azure Fluid Relay.
- * @internal
+ * @alpha
  */
 export interface AzureConnectionConfig {
 	/**
@@ -92,7 +92,7 @@ export interface AzureConnectionConfig {
 
 /**
  * Parameters for establishing a remote connection with the Azure Fluid Relay.
- * @internal
+ * @alpha
  */
 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.
- * @internal
+ * @alpha
  */
 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.
- * @internal
+ * @alpha
  */
 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.
- * @internal
+ * @alpha
  */
 // 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
- * @internal
+ * @alpha
  */
 export type IAzureAudience = IServiceAudience<AzureMember>;

packages/drivers/odsp-driver-definitions/api-report/odsp-driver-definitions.api.md

@@ -309,7 +309,7 @@ export interface TokenFetchOptions {
 // @internal
 export const tokenFromResponse: (tokenResponse: string | TokenResponse | null | undefined) => string | null;
 
-// @internal
+// @alpha
 export interface TokenResponse {
     fromCache?: boolean;
     token: string;

packages/drivers/odsp-driver-definitions/src/tokenFetch.ts

@@ -5,7 +5,7 @@
 
 /**
  * Represents token response
- * @internal
+ * @alpha
  */
 export interface TokenResponse {
 	/** Token value */

packages/drivers/routerlicious-driver/api-report/routerlicious-driver.api.md

@@ -44,14 +44,14 @@ export interface IRouterliciousDriverPolicies {
     maxConcurrentStorageRequests: number;
 }
 
-// @internal
+// @alpha
 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>;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface ITokenResponse {
     fromCache?: boolean;
     jwt: string;

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

@@ -18,7 +18,7 @@ export interface ITokenService {
 }
 
 /**
- * @internal
+ * @alpha
  */
 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.
- * @internal
+ * @alpha
  */
 export interface ITokenProvider {
 	/**

packages/framework/fluid-static/api-report/fluid-static.api.md

@@ -20,7 +20,7 @@ import { IFluidLoadable } from '@fluidframework/core-interfaces';
 import { IRuntimeFactory } from '@fluidframework/container-definitions';
 import { TypedEventEmitter } from '@fluid-internal/client-utils';
 
-// @internal
+// @alpha
 export interface ContainerSchema {
     dynamicObjectTypes?: LoadableObjectClass<any>[];
     initialObjects: LoadableObjectClassRecord;
@@ -43,7 +43,7 @@ export function createServiceAudience<M extends IMember = IMember>(props: {
     createServiceMember: (audienceMember: IClient) => M;
 }): IServiceAudience<M>;
 
-// @internal
+// @alpha
 export type DataObjectClass<T extends IFluidLoadable> = {
     readonly factory: IFluidDataStoreFactory;
 } & LoadableObjectCtor<T>;
@@ -77,7 +77,7 @@ export interface IConnection {
     mode: "write" | "read";
 }
 
-// @internal
+// @alpha
 export interface IFluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema> extends IEventProvider<IFluidContainerEvents> {
     attach(): Promise<string>;
     readonly attachState: AttachState;
@@ -91,7 +91,7 @@ export interface IFluidContainer<TContainerSchema extends ContainerSchema = Cont
     readonly isDirty: boolean;
 }
 
-// @internal
+// @alpha
 export interface IFluidContainerEvents extends IEvent {
     (event: "connected", listener: () => void): void;
     (event: "disconnected", listener: () => void): void;
@@ -106,7 +106,7 @@ export interface IMember {
     userId: string;
 }
 
-// @internal
+// @alpha
 export type InitialObjects<T extends ContainerSchema> = {
     [K in keyof T["initialObjects"]]: T["initialObjects"][K] extends LoadableObjectClass<infer TChannel> ? TChannel : never;
 };
@@ -139,16 +139,16 @@ export interface IServiceAudienceEvents<M extends IMember> extends IEvent {
     (event: "memberRemoved", listener: MemberChangedListener<M>): void;
 }
 
-// @internal
+// @alpha
 export type LoadableObjectClass<T extends IFluidLoadable> = DataObjectClass<T> | SharedObjectClass<T>;
 
-// @internal
+// @alpha
 export type LoadableObjectClassRecord = Record<string, LoadableObjectClass<any>>;
 
-// @internal
+// @alpha
 export type LoadableObjectCtor<T extends IFluidLoadable> = new (...args: any[]) => T;
 
-// @internal
+// @alpha
 export type LoadableObjectRecord = Record<string, IFluidLoadable>;
 
 // @internal
@@ -172,7 +172,7 @@ export abstract class ServiceAudience<M extends IMember = IMember> extends Typed
     protected shouldIncludeAsMember(member: IClient): boolean;
 }
 
-// @internal
+// @alpha
 export type SharedObjectClass<T extends IFluidLoadable> = {
     readonly getFactory: () => IChannelFactory;
 } & LoadableObjectCtor<T>;

packages/framework/fluid-static/src/fluidContainer.ts

@@ -14,7 +14,7 @@ import type { ContainerSchema, IRootDataObject, LoadableObjectClass } from "./ty
 
 /**
  * Extract the type of 'initialObjects' from the given {@link ContainerSchema} type.
- * @internal
+ * @alpha
  */
 export type InitialObjects<T extends ContainerSchema> = {
 	// Construct a LoadableObjectRecord type by enumerating the keys of
@@ -31,7 +31,7 @@ export type InitialObjects<T extends ContainerSchema> = {
 
 /**
  * Events emitted from {@link IFluidContainer}.
- * @internal
+ * @alpha
  */
 export interface IFluidContainerEvents extends IEvent {
 	/**
@@ -96,7 +96,7 @@ export interface IFluidContainerEvents extends IEvent {
  * @typeparam TContainerSchema - Used to determine the type of 'initialObjects'.
  *
  * @remarks Note: external implementations of this interface are not supported.
- * @internal
+ * @alpha
  */
 export interface IFluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema>
 	extends IEventProvider<IFluidContainerEvents> {