Merge branch 'main' into beta-tag-loader-class-common

microsoft · Dec 2, 2023 · 17a124c · 17a124c
2 parents 5f558d1 + 751fc73
commit 17a124c
Show file tree

Hide file tree

Showing 12 changed files with 92 additions and 92 deletions.
diff --git a/common/lib/protocol-definitions/api-report/protocol-definitions.api.md b/common/lib/protocol-definitions/api-report/protocol-definitions.api.md
@@ -4,7 +4,7 @@
 
 ```ts
 
-// @internal
+// @alpha
 export type ConnectionMode = "write" | "read";
 
 // @internal (undocumented)
@@ -25,7 +25,7 @@ export interface IActorClient {
     sub: string;
 }
 
-// @internal
+// @alpha
 export type IApprovedProposal = {
     approvalSequenceNumber: number;
 } & ISequencedProposal;
@@ -42,19 +42,19 @@ export interface IBlob {
     encoding: "utf-8" | "base64";
 }
 
-// @internal
+// @alpha
 export interface IBranchOrigin {
     id: string;
     minimumSequenceNumber: number;
     sequenceNumber: number;
 }
 
-// @internal
+// @alpha
 export interface ICapabilities {
     interactive: boolean;
 }
 
-// @internal
+// @alpha
 export interface IClient {
     details: IClientDetails;
     mode: ConnectionMode;
@@ -65,15 +65,15 @@ export interface IClient {
     user: IUser;
 }
 
-// @internal
+// @alpha
 export interface IClientConfiguration {
     blockSize: number;
     maxMessageSize: number;
     noopCountFrequency?: number;
     noopTimeFrequency?: number;
 }
 
-// @internal
+// @alpha
 export interface IClientDetails {
     capabilities: ICapabilities;
     // (undocumented)
@@ -89,7 +89,7 @@ export interface IClientJoin {
     detail: IClient;
 }
 
-// @internal
+// @alpha
 export type ICommittedProposal = {
     commitSequenceNumber: number;
 } & IApprovedProposal;
@@ -130,19 +130,19 @@ export interface IConnected {
     version: string;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface ICreateBlobResponse {
     // (undocumented)
     id: string;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IDocumentAttributes {
     minimumSequenceNumber: number;
     sequenceNumber: number;
 }
 
-// @internal
+// @alpha
 export interface IDocumentMessage {
     clientSequenceNumber: number;
     compression?: string;
@@ -160,14 +160,14 @@ export interface IDocumentSystemMessage extends IDocumentMessage {
     data: string;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface INack {
     content: INackContent;
     operation: IDocumentMessage | undefined;
     sequenceNumber: number;
 }
 
-// @internal
+// @alpha
 export interface INackContent {
     code: number;
     message: string;
@@ -181,7 +181,7 @@ export interface IProcessMessageResult {
     immediateNoOp?: boolean;
 }
 
-// @internal
+// @alpha
 export interface IProposal {
     key: string;
     value: unknown;
@@ -211,7 +211,7 @@ export interface IQuorum extends Omit<IQuorumClients, "on" | "once" | "off">, Om
     once: IQuorum["on"];
 }
 
-// @internal
+// @alpha
 export interface IQuorumClients {
     // (undocumented)
     getMember(clientId: string): ISequencedClient | undefined;
@@ -277,7 +277,7 @@ export interface ISentSignalMessage extends ISignalMessageBase {
     targetClientId?: string;
 }
 
-// @internal
+// @alpha
 export interface ISequencedClient {
     client: IClient;
     sequenceNumber: number;
@@ -289,7 +289,7 @@ export interface ISequencedDocumentAugmentedMessage extends ISequencedDocumentMe
     additionalContent: string;
 }
 
-// @internal
+// @alpha
 export interface ISequencedDocumentMessage {
     clientId: string | null;
     clientSequenceNumber: number;
@@ -322,7 +322,7 @@ export interface ISequencedDocumentSystemMessage extends ISequencedDocumentMessa
     data: string;
 }
 
-// @internal
+// @alpha
 export type ISequencedProposal = {
     sequenceNumber: number;
 } & IProposal;
@@ -332,28 +332,28 @@ export interface IServerError {
     errorMessage: string;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface ISignalClient {
     client: IClient;
     clientConnectionNumber?: number;
     clientId: string;
     referenceSequenceNumber?: number;
 }
 
-// @internal
+// @alpha
 export interface ISignalMessage extends ISignalMessageBase {
     clientId: string | null;
 }
 
-// @internal
+// @alpha
 export interface ISignalMessageBase {
     clientConnectionNumber?: number;
     content: unknown;
     referenceSequenceNumber?: number;
     type?: string;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface ISnapshotTree {
     // (undocumented)
     blobs: {
@@ -378,7 +378,7 @@ export interface ISnapshotTreeEx extends ISnapshotTree {
     };
 }
 
-// @internal
+// @alpha
 export type IsoDate = string;
 
 // @internal
@@ -387,23 +387,23 @@ export interface ISummaryAck {
     summaryProposal: ISummaryProposal;
 }
 
-// @internal
+// @alpha
 export interface ISummaryAttachment {
     // (undocumented)
     id: string;
     // (undocumented)
     type: SummaryType.Attachment;
 }
 
-// @internal
+// @alpha
 export interface ISummaryBlob {
     // (undocumented)
     content: string | Uint8Array;
     // (undocumented)
     type: SummaryType.Blob;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface ISummaryContent {
     details?: IUploadedSummaryDetails;
     handle: string;
@@ -412,7 +412,7 @@ export interface ISummaryContent {
     parents: string[];
 }
 
-// @internal
+// @alpha
 export interface ISummaryHandle {
     handle: string;
     handleType: SummaryTypeNoHandle;
@@ -443,7 +443,7 @@ export interface ISummaryTokenClaims {
     sub: string;
 }
 
-// @internal
+// @alpha
 export interface ISummaryTree {
     // (undocumented)
     tree: {
@@ -454,7 +454,7 @@ export interface ISummaryTree {
     unreferenced?: true;
 }
 
-// @internal
+// @alpha
 export interface ITokenClaims {
     documentId: string;
     exp: number;
@@ -477,7 +477,7 @@ export interface ITokenService {
     extractClaims(token: string): ITokenClaims;
 }
 
-// @internal
+// @alpha
 export interface ITrace {
     action: string;
     service: string;
@@ -507,24 +507,24 @@ export type ITreeEntry = {
     value: IAttachment;
 });
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export interface IUploadedSummaryDetails {
     includesProtocolTree?: boolean;
 }
 
-// @internal
+// @alpha
 export interface IUser {
     id: string;
 }
 
-// @internal
+// @alpha
 export interface IVersion {
     date?: IsoDate;
     id: string;
     treeId: string;
 }
 
-// @internal (undocumented)
+// @alpha (undocumented)
 export enum MessageType {
     Accept = "accept",
     ClientJoin = "join",
@@ -541,7 +541,7 @@ export enum MessageType {
     SummaryNack = "summaryNack"
 }
 
-// @internal
+// @alpha
 export enum NackErrorType {
     BadRequestError = "BadRequestError",
     InvalidScopeError = "InvalidScopeError",
@@ -562,32 +562,32 @@ export enum SignalType {
     ClientLeave = "leave"
 }
 
-// @internal
+// @alpha
 export type SummaryObject = ISummaryTree | ISummaryBlob | ISummaryHandle | ISummaryAttachment;
 
 // @internal
 export type SummaryTree = ISummaryTree | ISummaryHandle;
 
-// @internal
+// @alpha
 export namespace SummaryType {
-    // (undocumented)
+    // @internal (undocumented)
     export type Attachment = 4;
-    // (undocumented)
+    // @internal (undocumented)
     export type Blob = 2;
-    // (undocumented)
+    // @internal (undocumented)
     export type Handle = 3;
-    // (undocumented)
+    // @internal (undocumented)
     export type Tree = 1;
     const Tree: Tree;
     const Blob: Blob;
     const Handle: Handle;
     const Attachment: Attachment;
 }
 
-// @internal
+// @alpha
 export type SummaryType = SummaryType.Attachment | SummaryType.Blob | SummaryType.Handle | SummaryType.Tree;
 
-// @internal
+// @alpha
 export type SummaryTypeNoHandle = SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment;
 
 // @internal

diff --git a/common/lib/protocol-definitions/src/clients.ts b/common/lib/protocol-definitions/src/clients.ts
@@ -12,14 +12,14 @@ import { IUser } from "./users";
  *
  * Note: a user's connection mode is dependent on their permissions.
  * E.g. a user with read-only permissions will not be allowed a "write" connection mode.
- * @internal
+ * @alpha
  */
 export type ConnectionMode = "write" | "read";
 
 /**
  * Capabilities of a Client.
  * In particular, whether or not the client is {@link ICapabilities.interactive}.
- * @internal
+ * @alpha
  */
 export interface ICapabilities {
 	/**
@@ -36,7 +36,7 @@ export interface ICapabilities {
 
 /**
  * {@link IClient} connection / environment metadata.
- * @internal
+ * @alpha
  */
 export interface IClientDetails {
 	/**
@@ -63,7 +63,7 @@ export interface IClientDetails {
 
 /**
  * Represents a client connected to a Fluid service, including associated user details, permissions, and connection mode.
- * @internal
+ * @alpha
  */
 export interface IClient {
 	/**
@@ -96,7 +96,7 @@ export interface IClient {
 
 /**
  * A {@link IClient} that has been acknowledged by the sequencer.
- * @internal
+ * @alpha
  */
 export interface ISequencedClient {
 	/**
@@ -111,7 +111,7 @@ export interface ISequencedClient {
 }
 
 /**
- * @internal
+ * @alpha
  */
 export interface ISignalClient {
 	/**

diff --git a/common/lib/protocol-definitions/src/config.ts b/common/lib/protocol-definitions/src/config.ts
@@ -5,7 +5,7 @@
 
 /**
  * Key value store of service configuration properties provided to the client as part of connection.
- * @internal
+ * @alpha
  */
 export interface IClientConfiguration {
 	/**