@fluidframework/driver-definitions 2.0.2 → 2.1.0-276326

package/src/protocol/protocol.ts

@@ -4,6 +4,7 @@
  */
 
 /**
+ * @legacy
  * @alpha
  */
 export enum MessageType {
@@ -93,6 +94,7 @@ export enum SignalType {
 
 /**
  * Messages to track latency trace.
+ * @legacy
  * @alpha
  */
 export interface ITrace {
@@ -113,6 +115,7 @@ export interface ITrace {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export interface INack {
@@ -134,6 +137,7 @@ export interface INack {
 
 /**
  * Document-specific message.
+ * @legacy
  * @alpha
  */
 export interface IDocumentMessage {
@@ -189,6 +193,7 @@ export interface IDocumentSystemMessage extends IDocumentMessage {
 
 /**
  * Branch origin information.
+ * @legacy
  * @alpha
  */
 export interface IBranchOrigin {
@@ -210,6 +215,7 @@ export interface IBranchOrigin {
 
 /**
  * Sequenced message for a distributed document.
+ * @legacy
  * @alpha
  */
 export interface ISequencedDocumentMessage {
@@ -332,6 +338,7 @@ export interface ISequencedDocumentAugmentedMessage extends ISequencedDocumentMe
 
 /**
  * Common interface between incoming and outgoing signals.
+ * @legacy
  * @alpha
  */
 export interface ISignalMessageBase {
@@ -364,6 +371,7 @@ export interface ISignalMessageBase {
 
 /**
  * Interface for signals sent by the server to clients.
+ * @legacy
  * @alpha
  */
 export interface ISignalMessage extends ISignalMessageBase {
@@ -382,6 +390,7 @@ export interface ISignalMessage extends ISignalMessageBase {
 export type ISentSignalMessage = ISignalMessageBase;
 
 /**
+ * @legacy
  * @alpha
  */
 export interface IUploadedSummaryDetails {
@@ -392,6 +401,7 @@ export interface IUploadedSummaryDetails {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export interface ISummaryContent {
@@ -438,6 +448,7 @@ export interface IServerError {
 
 /**
  * Data about the original proposed summary message.
+ * @legacy
  * @alpha
  */
 export interface ISummaryProposal {
@@ -449,6 +460,7 @@ export interface ISummaryProposal {
 
 /**
  * Contents of summary ack expected from the server.
+ * @legacy
  * @alpha
  */
 export interface ISummaryAck {
@@ -465,6 +477,7 @@ export interface ISummaryAck {
 
 /**
  * Contents of summary nack expected from the server.
+ * @legacy
  * @alpha
  */
 export interface ISummaryNack {
@@ -495,6 +508,7 @@ export interface ISummaryNack {
 
 /**
  * Interface for nack content.
+ * @legacy
  * @alpha
  */
 export interface INackContent {
@@ -525,6 +539,7 @@ export interface INackContent {
 
 /**
  * Type of the nack.
+ * @legacy
  * @alpha
  */
 export enum NackErrorType {

package/src/protocol/scopes.ts

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

package/src/protocol/sockets.ts

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

package/src/protocol/storage.ts

@@ -6,6 +6,7 @@
 import type { IsoDate } from "./date.js";
 
 /**
+ * @legacy
  * @alpha
  */
 export interface IDocumentAttributes {
@@ -21,6 +22,7 @@ export interface IDocumentAttributes {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export enum FileMode {
@@ -32,6 +34,7 @@ export enum FileMode {
 
 /**
  * Raw blob stored within the tree.
+ * @legacy
  * @alpha
  */
 export interface IBlob {
@@ -48,6 +51,7 @@ export interface IBlob {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export interface IAttachment {
@@ -55,6 +59,7 @@ export interface IAttachment {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export interface ICreateBlobResponse {
@@ -63,6 +68,7 @@ export interface ICreateBlobResponse {
 
 /**
  * A tree entry wraps a path with a type of node.
+ * @legacy
  * @alpha
  */
 export type ITreeEntry = {
@@ -93,6 +99,7 @@ export type ITreeEntry = {
 
 /**
  * Type of entries that can be stored in a tree.
+ * @legacy
  * @alpha
  */
 export enum TreeEntry {
@@ -102,6 +109,7 @@ export enum TreeEntry {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export interface ITree {
@@ -128,6 +136,7 @@ export interface ITree {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export interface ISnapshotTree {
@@ -159,6 +168,7 @@ export interface ISnapshotTreeEx extends ISnapshotTree {
 
 /**
  * Represents a version of the snapshot of a data store.
+ * @legacy
  * @alpha
  */
 export interface IVersion {

package/src/protocol/summary.ts

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

package/src/protocol/tokens.ts

@@ -9,6 +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
  */
 export interface ITokenClaims {

package/src/storage.ts

@@ -73,12 +73,14 @@ export interface IDeltaStorageService {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export type IStreamResult<T> = { done: true } | { done: false; value: T };
 
 /**
  * Read interface for the Queue
+ * @legacy
  * @alpha
  */
 export interface IStream<T> {
@@ -87,6 +89,7 @@ export interface IStream<T> {
 
 /**
  * Interface to provide access to stored deltas for a shared object
+ * @legacy
  * @alpha
  */
 export interface IDocumentDeltaStorageService {
@@ -114,6 +117,7 @@ export interface IDocumentDeltaStorageService {
 // internal assumptions of the Runtime's GC feature will be violated
 // DO NOT INCREASE THIS TYPE'S VALUE
 /**
+ * @legacy
  * @alpha
  */
 export type FiveDaysMs = 432_000_000; /* 5 days in milliseconds */
@@ -121,6 +125,7 @@ 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
  */
 export interface IDocumentStorageServicePolicies {
@@ -142,6 +147,7 @@ export interface IDocumentStorageServicePolicies {
 
 /**
  * Interface to provide access to snapshots saved for a shared object
+ * @legacy
  * @alpha
  */
 export interface IDocumentStorageService extends Partial<IDisposable> {
@@ -215,6 +221,7 @@ export interface IDocumentStorageService extends Partial<IDisposable> {
 
 /**
  * Events emitted by {@link IDocumentService}.
+ * @legacy
  * @alpha
  */
 export interface IDocumentServiceEvents extends IEvent {
@@ -226,6 +233,7 @@ export interface IDocumentServiceEvents extends IEvent {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export interface IDocumentDeltaConnectionEvents extends IErrorEvent {
@@ -240,6 +248,7 @@ export interface IDocumentDeltaConnectionEvents extends IErrorEvent {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export interface IDocumentDeltaConnection
@@ -322,6 +331,7 @@ export interface IDocumentDeltaConnection
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export enum LoaderCachingPolicy {
@@ -337,6 +347,7 @@ export enum LoaderCachingPolicy {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export interface IDocumentServicePolicies {
@@ -359,6 +370,7 @@ export interface IDocumentServicePolicies {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export interface IDocumentService extends IEventProvider<IDocumentServiceEvents> {
@@ -400,6 +412,7 @@ export interface IDocumentService extends IEventProvider<IDocumentServiceEvents>
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export interface IDocumentServiceFactory {
@@ -442,6 +455,7 @@ export interface IDocumentServiceFactory {
 /**
  * Context for uploading a summary to storage.
  * Indicates the previously acked summary.
+ * @legacy
  * @alpha
  */
 export interface ISummaryContext {
@@ -459,6 +473,7 @@ export interface ISummaryContext {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export enum FetchSource {
@@ -469,6 +484,7 @@ export enum FetchSource {
 /**
  * A "Full" container Snapshot, including ISnapshotTree, blobs and outstanding ops (and other metadata)
  *
+ * @legacy
  * @alpha
  */
 export interface ISnapshot {
@@ -492,6 +508,7 @@ export interface ISnapshot {
 /**
  * Snapshot fetch options which are used to communicate different things to the driver
  * when fetching the snapshot.
+ * @legacy
  * @alpha
  */
 export interface ISnapshotFetchOptions {

package/src/urlResolver.ts

@@ -6,6 +6,7 @@
 import type { IRequest } from "@fluidframework/core-interfaces";
 
 /**
+ * @legacy
  * @alpha
  */
 export interface IResolvedUrl {
@@ -21,6 +22,7 @@ export interface IResolvedUrl {
 
 /**
  * Container package info handed off to resolver.
+ * @legacy
  * @alpha
  */
 export interface IContainerPackageInfo {
@@ -31,6 +33,7 @@ export interface IContainerPackageInfo {
 }
 
 /**
+ * @legacy
  * @alpha
  */
 export interface IUrlResolver {
@@ -56,6 +59,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
  */
 export interface DriverPreCheckInfo {
@@ -73,6 +77,7 @@ export interface DriverPreCheckInfo {
 
 /**
  * Additional key in the loader request header
+ * @legacy
  * @alpha
  */
 export enum DriverHeader {