@fluidframework/driver-definitions 2.53.0 → 2.60.0

package/src/protocol/protocol.ts

@@ -6,8 +6,7 @@
 import type { TypedMessage } from "@fluidframework/core-interfaces/internal";
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export enum MessageType {
 	/**
@@ -96,8 +95,7 @@ export enum SignalType {
 
 /**
  * Messages to track latency trace.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ITrace {
 	/**
@@ -117,8 +115,7 @@ export interface ITrace {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface INack {
 	/**
@@ -139,8 +136,7 @@ export interface INack {
 
 /**
  * Document-specific message.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IDocumentMessage {
 	/**
@@ -195,8 +191,7 @@ export interface IDocumentSystemMessage extends IDocumentMessage {
 
 /**
  * Branch origin information.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IBranchOrigin {
 	/**
@@ -217,8 +212,7 @@ export interface IBranchOrigin {
 
 /**
  * Sequenced message for a distributed document.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISequencedDocumentMessage {
 	/**
@@ -340,8 +334,7 @@ export interface ISequencedDocumentAugmentedMessage extends ISequencedDocumentMe
 
 /**
  * Common interface between incoming and outgoing signals.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISignalMessageBase<TMessage extends TypedMessage = TypedMessage> {
 	/**
@@ -373,8 +366,7 @@ export interface ISignalMessageBase<TMessage extends TypedMessage = TypedMessage
 
 /**
  * Interface for signals sent by the server to clients.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISignalMessage<TMessage extends TypedMessage = TypedMessage>
 	extends ISignalMessageBase<TMessage> {
@@ -394,8 +386,7 @@ export type ISentSignalMessage<TMessage extends TypedMessage = TypedMessage> =
 	ISignalMessageBase<TMessage>;
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IUploadedSummaryDetails {
 	/**
@@ -405,8 +396,7 @@ export interface IUploadedSummaryDetails {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISummaryContent {
 	/**
@@ -452,8 +442,7 @@ export interface IServerError {
 
 /**
  * Data about the original proposed summary message.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISummaryProposal {
 	/**
@@ -464,8 +453,7 @@ export interface ISummaryProposal {
 
 /**
  * Contents of summary ack expected from the server.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISummaryAck {
 	/**
@@ -481,8 +469,7 @@ export interface ISummaryAck {
 
 /**
  * Contents of summary nack expected from the server.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISummaryNack {
 	/**
@@ -512,8 +499,7 @@ export interface ISummaryNack {
 
 /**
  * Interface for nack content.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface INackContent {
 	/**
@@ -543,8 +529,7 @@ export interface INackContent {
 
 /**
  * Type of the nack.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export enum NackErrorType {
 	/**

package/src/protocol/scopes.ts

@@ -5,8 +5,7 @@
 
 /**
  * Defines scope access for a Container/Document.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export enum ScopeType {
 	/**

package/src/protocol/sockets.ts

@@ -10,8 +10,7 @@ import type { ITokenClaims } from "./tokens.js";
 
 /**
  * Message sent to connect to the given document.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IConnect {
 	/**
@@ -80,8 +79,7 @@ export interface IConnect {
 
 /**
  * Message sent to indicate a client has connected to the server.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IConnected {
 	/**

package/src/protocol/storage.ts

@@ -6,8 +6,7 @@
 import type { IsoDate } from "./date.js";
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IDocumentAttributes {
 	/**
@@ -22,8 +21,7 @@ export interface IDocumentAttributes {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export enum FileMode {
 	File = "100644",
@@ -34,8 +32,7 @@ export enum FileMode {
 
 /**
  * Raw blob stored within the tree.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IBlob {
 	/**
@@ -46,21 +43,19 @@ export interface IBlob {
 	/**
 	 * The encoding of the contents string
 	 */
-	// eslint-disable-next-line unicorn/text-encoding-identifier-case
+	// eslint-disable-next-line unicorn/text-encoding-identifier-case -- Cannot change "utf-8" to "utf8" as this encoding value is stored in summaries and would be a breaking change which needs to be done first before changing to utf8
 	encoding: "utf-8" | "base64";
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IAttachment {
 	id: string;
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ICreateBlobResponse {
 	id: string;
@@ -68,8 +63,7 @@ export interface ICreateBlobResponse {
 
 /**
  * A tree entry wraps a path with a type of node.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type ITreeEntry = {
 	/**
@@ -99,8 +93,7 @@ export type ITreeEntry = {
 
 /**
  * Type of entries that can be stored in a tree.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export enum TreeEntry {
 	Blob = "Blob",
@@ -109,8 +102,7 @@ export enum TreeEntry {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ITree {
 	entries: ITreeEntry[];
@@ -136,8 +128,7 @@ export interface ITree {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISnapshotTree {
 	id?: string;
@@ -168,8 +159,7 @@ export interface ISnapshotTreeEx extends ISnapshotTree {
 
 /**
  * Represents a version of the snapshot of a data store.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IVersion {
 	/**

package/src/protocol/summary.ts

@@ -14,8 +14,7 @@ export type SummaryObject = ISummaryTree | ISummaryBlob | ISummaryHandle | ISumm
 
 /**
  * The root of the summary tree.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type SummaryTree = ISummaryTree | ISummaryHandle;
 

package/src/protocol/tokens.ts

@@ -9,8 +9,7 @@ import type { IUser } from "./users.js";
  * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} Claims
  *
  * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4}
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ITokenClaims {
 	/**

package/src/storage.ts

@@ -73,15 +73,13 @@ export interface IDeltaStorageService {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type IStreamResult<T> = { done: true } | { done: false; value: T };
 
 /**
  * Read interface for the Queue
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IStream<T> {
 	read(): Promise<IStreamResult<T>>;
@@ -89,8 +87,7 @@ export interface IStream<T> {
 
 /**
  * Interface to provide access to stored deltas for a shared object
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IDocumentDeltaStorageService {
 	/**
@@ -117,16 +114,14 @@ export interface IDocumentDeltaStorageService {
 // internal assumptions of the Runtime's GC feature will be violated
 // DO NOT INCREASE THIS TYPE'S VALUE
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type FiveDaysMs = 432_000_000; /* 5 days in milliseconds */
 
 /**
  * Policies describing attributes or characteristics of the driver's storage service,
  * to direct how other components interact with the driver
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IDocumentStorageServicePolicies {
 	/**
@@ -147,8 +142,7 @@ export interface IDocumentStorageServicePolicies {
 
 /**
  * Interface to provide access to snapshots saved for a shared object
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IDocumentStorageService extends Partial<IDisposable> {
 	/**
@@ -221,8 +215,7 @@ export interface IDocumentStorageService extends Partial<IDisposable> {
 
 /**
  * Events emitted by {@link IDocumentService}.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IDocumentServiceEvents extends IEvent {
 	/**
@@ -233,8 +226,7 @@ export interface IDocumentServiceEvents extends IEvent {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IDocumentDeltaConnectionEvents extends IErrorEvent {
 	(event: "nack", listener: (documentId: string, message: INack[]) => void);
@@ -256,8 +248,7 @@ export interface IDocumentDeltaConnectionEvents extends IErrorEvent {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IDocumentDeltaConnection
 	extends IDisposable,
@@ -339,8 +330,7 @@ export interface IDocumentDeltaConnection
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export enum LoaderCachingPolicy {
 	/**
@@ -355,8 +345,7 @@ export enum LoaderCachingPolicy {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IDocumentServicePolicies {
 	/**
@@ -378,8 +367,7 @@ export interface IDocumentServicePolicies {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IDocumentService extends IEventProvider<IDocumentServiceEvents> {
 	resolvedUrl: IResolvedUrl;
@@ -420,8 +408,7 @@ export interface IDocumentService extends IEventProvider<IDocumentServiceEvents>
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IDocumentServiceFactory {
 	/**
@@ -463,8 +450,7 @@ export interface IDocumentServiceFactory {
 /**
  * Context for uploading a summary to storage.
  * Indicates the previously acked summary.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISummaryContext {
 	/**
@@ -481,8 +467,7 @@ export interface ISummaryContext {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export enum FetchSource {
 	default = "default",
@@ -492,8 +477,7 @@ export enum FetchSource {
 /**
  * A "Full" container Snapshot, including ISnapshotTree, blobs and outstanding ops (and other metadata)
  *
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISnapshot {
 	snapshotTree: ISnapshotTree;
@@ -516,8 +500,7 @@ export interface ISnapshot {
 /**
  * Snapshot fetch options which are used to communicate different things to the driver
  * when fetching the snapshot.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISnapshotFetchOptions {
 	/**

package/src/urlResolver.ts

@@ -6,8 +6,7 @@
 import type { IRequest } from "@fluidframework/core-interfaces";
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IResolvedUrl {
 	type: "fluid";
@@ -22,8 +21,7 @@ export interface IResolvedUrl {
 
 /**
  * Container package info handed off to resolver.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IContainerPackageInfo {
 	/**
@@ -33,8 +31,7 @@ export interface IContainerPackageInfo {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IUrlResolver {
 	// Like DNS should be able to cache resolution requests. Then possibly just have a token provider go and do stuff?
@@ -59,8 +56,7 @@ export interface IUrlResolver {
 /**
  * Information that can be returned by a lightweight, seperately exported driver function. Used to preanalyze a URL
  * for driver compatibility and preload information.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface DriverPreCheckInfo {
 	/**
@@ -77,8 +73,7 @@ export interface DriverPreCheckInfo {
 
 /**
  * Additional key in the loader request header
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export enum DriverHeader {
 	// Key to indicate whether the request for summarizer