@fluidframework/driver-definitions - npm Package Compare versions

Comparing version 2.53.1 to 2.60.0

api-report/driver-definitions.legacy.beta.api.md

+## Beta API Report File for "@fluidframework/driver-definitions"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public
+export type ConnectionMode = "write" | "read";
+
+// @beta @legacy (undocumented)
+export type DriverError = IThrottlingWarning | IGenericNetworkError | IAuthorizationError | ILocationRedirectionError | IDriverBasicError;
+
+// @beta @legacy
+export const DriverErrorTypes: {
+    readonly genericNetworkError: "genericNetworkError";
+    readonly authorizationError: "authorizationError";
+    readonly fileNotFoundOrAccessDeniedError: "fileNotFoundOrAccessDeniedError";
+    readonly offlineError: "offlineError";
+    readonly unsupportedClientProtocolVersion: "unsupportedClientProtocolVersion";
+    readonly writeError: "writeError";
+    readonly fetchFailure: "fetchFailure";
+    readonly fetchTokenError: "fetchTokenError";
+    readonly incorrectServerResponse: "incorrectServerResponse";
+    readonly fileOverwrittenInStorage: "fileOverwrittenInStorage";
+    readonly deltaStreamConnectionForbidden: "deltaStreamConnectionForbidden";
+    readonly locationRedirection: "locationRedirection";
+    readonly fluidInvalidSchema: "fluidInvalidSchema";
+    readonly fileIsLocked: "fileIsLocked";
+    readonly outOfStorageError: "outOfStorageError";
+    readonly genericError: "genericError";
+    readonly throttlingError: "throttlingError";
+    readonly usageError: "usageError";
+};
+
+// @beta @legacy
+export type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErrorTypes];
+
+// @beta @legacy
+export enum DriverHeader {
+    // (undocumented)
+    createNew = "createNew",
+    // (undocumented)
+    summarizingClient = "fluid-client-summarizer"
+}
+
+// @beta @legacy
+export interface DriverPreCheckInfo {
+    codeDetailsHint?: string;
+    criticalBootDomains?: string[];
+}
+
+// @beta @legacy (undocumented)
+export enum FetchSource {
+    // (undocumented)
+    default = "default",
+    // (undocumented)
+    noCache = "noCache"
+}
+
+// @beta @legacy (undocumented)
+export enum FileMode {
+    // (undocumented)
+    Directory = "040000",
+    // (undocumented)
+    Executable = "100755",
+    // (undocumented)
+    File = "100644",
+    // (undocumented)
+    Symlink = "120000"
+}
+
+// @beta @legacy (undocumented)
+export type FiveDaysMs = 432_000_000;
+
+// @beta @legacy
+export interface IAnyDriverError extends Omit<IDriverErrorBase, "errorType"> {
+    // (undocumented)
+    readonly errorType: string;
+    scenarioName?: string;
+}
+
+// @beta @legacy
+export type IApprovedProposal = {
+    approvalSequenceNumber: number;
+} & ISequencedProposal;
+
+// @beta @legacy (undocumented)
+export interface IAttachment {
+    // (undocumented)
+    id: string;
+}
+
+// @beta @legacy (undocumented)
+export interface IAuthorizationError extends IDriverErrorBase {
+    // (undocumented)
+    readonly claims?: string;
+    // (undocumented)
+    readonly errorType: typeof DriverErrorTypes.authorizationError;
+    // (undocumented)
+    readonly tenantId?: string;
+}
+
+// @beta @legacy
+export interface IBlob {
+    contents: string;
+    encoding: "utf-8" | "base64";
+}
+
+// @beta @legacy
+export interface IBranchOrigin {
+    id: string;
+    minimumSequenceNumber: number;
+    sequenceNumber: number;
+}
+
+// @public
+export interface ICapabilities {
+    interactive: boolean;
+}
+
+// @public
+export interface IClient {
+    details: IClientDetails;
+    mode: ConnectionMode;
+    // (undocumented)
+    permission: string[];
+    scopes: string[];
+    timestamp?: number;
+    user: IUser;
+}
+
+// @beta @legacy
+export interface IClientConfiguration {
+    blockSize: number;
+    maxMessageSize: number;
+    noopCountFrequency?: number;
+    noopTimeFrequency?: number;
+}
+
+// @public
+export interface IClientDetails {
+    capabilities: ICapabilities;
+    // (undocumented)
+    device?: string;
+    // (undocumented)
+    environment?: string;
+    type?: string;
+}
+
+// @beta @legacy
+export type ICommittedProposal = {
+    commitSequenceNumber: number;
+} & IApprovedProposal;
+
+// @beta @legacy
+export interface IConnect {
+    client: IClient;
+    driverVersion?: string;
+    epoch?: string;
+    id: string;
+    mode: ConnectionMode;
+    nonce?: string;
+    relayUserAgent?: string;
+    supportedFeatures?: Record<string, unknown>;
+    tenantId: string;
+    token: string | null;
+    versions: string[];
+}
+
+// @beta @legacy
+export interface IConnected {
+    checkpointSequenceNumber?: number;
+    claims: ITokenClaims;
+    clientId: string;
+    epoch?: string;
+    existing: boolean;
+    initialClients: ISignalClient[];
+    initialMessages: ISequencedDocumentMessage[];
+    initialSignals: ISignalMessage[];
+    maxMessageSize: number;
+    mode: ConnectionMode;
+    nonce?: string;
+    relayServiceAgent?: string;
+    serviceConfiguration: IClientConfiguration;
+    supportedFeatures?: Record<string, unknown>;
+    supportedVersions: string[];
+    timestamp?: number;
+    version: string;
+}
+
+// @beta @legacy
+export interface IContainerPackageInfo {
+    name: string;
+}
+
+// @beta @legacy (undocumented)
+export interface ICreateBlobResponse {
+    // (undocumented)
+    id: string;
+}
+
+// @beta @legacy (undocumented)
+export interface IDocumentAttributes {
+    minimumSequenceNumber: number;
+    sequenceNumber: number;
+}
+
+// @beta @legacy (undocumented)
+export interface IDocumentDeltaConnection extends IDisposable, IEventProvider<IDocumentDeltaConnectionEvents> {
+    checkpointSequenceNumber?: number;
+    claims: ITokenClaims;
+    clientId: string;
+    existing: boolean;
+    initialClients: ISignalClient[];
+    initialMessages: ISequencedDocumentMessage[];
+    initialSignals: ISignalMessage[];
+    mode: ConnectionMode;
+    relayServiceAgent?: string;
+    serviceConfiguration: IClientConfiguration;
+    submit(messages: IDocumentMessage[]): void;
+    submitSignal: (content: string, targetClientId?: string) => void;
+    version: string;
+}
+
+// @beta @legacy (undocumented)
+export interface IDocumentDeltaConnectionEvents extends IErrorEvent {
+    // (undocumented)
+    (event: "nack", listener: (documentId: string, message: INack[]) => void): any;
+    // (undocumented)
+    (event: "disconnect", listener: (reason: IAnyDriverError) => void): any;
+    // (undocumented)
+    (event: "op", listener: (documentId: string, messages: ISequencedDocumentMessage[]) => void): any;
+    // (undocumented)
+    (event: "signal", listener: (message: ISignalMessage | ISignalMessage[]) => void): any;
+    // (undocumented)
+    (event: "pong", listener: (latency: number) => void): any;
+    // (undocumented)
+    (event: "error", listener: (error: any) => void): any;
+}
+
+// @beta @legacy
+export interface IDocumentDeltaStorageService {
+    fetchMessages(from: number, to: number | undefined, abortSignal?: AbortSignal, cachedOnly?: boolean, fetchReason?: string): IStream<ISequencedDocumentMessage[]>;
+}
+
+// @beta @legacy
+export interface IDocumentMessage {
+    clientSequenceNumber: number;
+    compression?: string;
+    contents: unknown;
+    metadata?: unknown;
+    referenceSequenceNumber: number;
+    serverMetadata?: unknown;
+    traces?: ITrace[];
+    type: string;
+}
+
+// @beta @legacy (undocumented)
+export interface IDocumentService extends IEventProvider<IDocumentServiceEvents> {
+    connectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;
+    connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;
+    connectToStorage(): Promise<IDocumentStorageService>;
+    dispose(error?: any): void;
+    policies?: IDocumentServicePolicies;
+    // (undocumented)
+    resolvedUrl: IResolvedUrl;
+}
+
+// @beta @legacy
+export interface IDocumentServiceEvents extends IEvent {
+    (event: "metadataUpdate", listener: (metadata: Record<string, string>) => void): any;
+}
+
+// @beta @legacy (undocumented)
+export interface IDocumentServiceFactory {
+    createContainer(createNewSummary: ISummaryTree | undefined, createNewResolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
+}
+
+// @beta @legacy (undocumented)
+export interface IDocumentServicePolicies {
+    readonly storageOnly?: boolean;
+    readonly summarizeProtocolTree?: boolean;
+    readonly supportGetSnapshotApi?: boolean;
+}
+
+// @beta @legacy
+export interface IDocumentStorageService extends Partial<IDisposable> {
+    createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
+    downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
+    getSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;
+    getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;
+    getVersions(versionId: string | null, count: number, scenarioName?: string, fetchSource?: FetchSource): Promise<IVersion[]>;
+    readonly policies?: IDocumentStorageServicePolicies | undefined;
+    readBlob(id: string): Promise<ArrayBufferLike>;
+    uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
+}
+
+// @beta @legacy
+export interface IDocumentStorageServicePolicies {
+    readonly caching?: LoaderCachingPolicy;
+    readonly maximumCacheDurationMs?: FiveDaysMs;
+}
+
+// @beta @legacy
+export interface IDriverBasicError extends IDriverErrorBase {
+    // (undocumented)
+    readonly errorType: typeof DriverErrorTypes.genericError | typeof DriverErrorTypes.fileNotFoundOrAccessDeniedError | typeof DriverErrorTypes.offlineError | typeof DriverErrorTypes.unsupportedClientProtocolVersion | typeof DriverErrorTypes.writeError | typeof DriverErrorTypes.fetchFailure | typeof DriverErrorTypes.fetchTokenError | typeof DriverErrorTypes.incorrectServerResponse | typeof DriverErrorTypes.fileOverwrittenInStorage | typeof DriverErrorTypes.fluidInvalidSchema | typeof DriverErrorTypes.usageError | typeof DriverErrorTypes.fileIsLocked | typeof DriverErrorTypes.outOfStorageError;
+    // (undocumented)
+    readonly statusCode?: number;
+}
+
+// @beta @legacy
+export interface IDriverErrorBase {
+    canRetry: boolean;
+    endpointReached?: boolean;
+    readonly errorType: DriverErrorTypes;
+    readonly message: string;
+    online?: string;
+}
+
+// @beta @legacy (undocumented)
+export interface IGenericNetworkError extends IDriverErrorBase {
+    // (undocumented)
+    readonly errorType: typeof DriverErrorTypes.genericNetworkError;
+    // (undocumented)
+    readonly statusCode?: number;
+}
+
+// @beta @legacy (undocumented)
+export interface ILocationRedirectionError extends IDriverErrorBase {
+    // (undocumented)
+    readonly errorType: typeof DriverErrorTypes.locationRedirection;
+    // (undocumented)
+    readonly redirectUrl: IResolvedUrl;
+}
+
+// @beta @legacy (undocumented)
+export interface INack {
+    content: INackContent;
+    operation: IDocumentMessage | undefined;
+    sequenceNumber: number;
+}
+
+// @beta @legacy
+export interface INackContent {
+    code: number;
+    message: string;
+    retryAfter?: number;
+    type: NackErrorType;
+}
+
+// @beta @legacy (undocumented)
+export interface IProcessMessageResult {
+    // (undocumented)
+    immediateNoOp?: boolean;
+}
+
+// @beta @legacy
+export interface IProposal {
+    key: string;
+    value: unknown;
+}
+
+// @beta @legacy
+export interface IQuorum extends Omit<IQuorumClients, "on" | "once" | "off">, Omit<IQuorumProposals, "on" | "once" | "off"> {
+    // (undocumented)
+    off: IQuorum["on"];
+    // (undocumented)
+    on: IQuorumClients["on"] & IQuorumProposals["on"];
+    // (undocumented)
+    once: IQuorum["on"];
+}
+
+// @public
+export interface IQuorumClients {
+    // (undocumented)
+    getMember(clientId: string): ISequencedClient | undefined;
+    // (undocumented)
+    getMembers(): Map<string, ISequencedClient>;
+    // (undocumented)
+    off: IQuorumClients["on"];
+    // (undocumented)
+    on(event: "addMember", listener: (clientId: string, details: ISequencedClient) => void): any;
+    // (undocumented)
+    on(event: "removeMember", listener: (clientId: string) => void): any;
+    // (undocumented)
+    on(event: "error", listener: (message: any) => void): any;
+    // (undocumented)
+    once: IQuorumClients["on"];
+}
+
+// @beta @legacy
+export interface IQuorumProposals {
+    // (undocumented)
+    get(key: string): unknown;
+    // (undocumented)
+    has(key: string): boolean;
+    // (undocumented)
+    off: IQuorumProposals["on"];
+    // (undocumented)
+    on(event: "addProposal", listener: (proposal: ISequencedProposal) => void): any;
+    // (undocumented)
+    on(event: "approveProposal", listener: (sequenceNumber: number, key: string, value: unknown, approvalSequenceNumber: number) => void): any;
+    // (undocumented)
+    on(event: "error", listener: (message: any) => void): void;
+    // (undocumented)
+    once: IQuorumProposals["on"];
+    // (undocumented)
+    propose(key: string, value: unknown): Promise<void>;
+}
+
+// @beta @legacy (undocumented)
+export interface IResolvedUrl {
+    // (undocumented)
+    endpoints: {
+        [name: string]: string;
+    };
+    id: string;
+    // (undocumented)
+    tokens: {
+        [name: string]: string;
+    };
+    // (undocumented)
+    type: "fluid";
+    // (undocumented)
+    url: string;
+}
+
+// @public
+export interface ISequencedClient {
+    client: IClient;
+    sequenceNumber: number;
+}
+
+// @beta @legacy
+export interface ISequencedDocumentMessage {
+    clientId: string | null;
+    clientSequenceNumber: number;
+    // @deprecated
+    compression?: string;
+    contents: unknown;
+    data?: string;
+    // @deprecated
+    expHash1?: string;
+    metadata?: unknown;
+    minimumSequenceNumber: number;
+    origin?: IBranchOrigin;
+    referenceSequenceNumber: number;
+    sequenceNumber: number;
+    serverMetadata?: unknown;
+    timestamp: number;
+    traces?: ITrace[];
+    type: string;
+}
+
+// @beta @legacy
+export type ISequencedProposal = {
+    sequenceNumber: number;
+} & IProposal;
+
+// @beta @legacy (undocumented)
+export interface ISignalClient {
+    client: IClient;
+    clientConnectionNumber?: number;
+    clientId: string;
+    referenceSequenceNumber?: number;
+}
+
+// @beta @legacy
+export interface ISignalMessage<TMessage extends TypedMessage = TypedMessage> extends ISignalMessageBase<TMessage> {
+    clientId: string | null;
+}
+
+// @beta @legacy
+export interface ISignalMessageBase<TMessage extends TypedMessage = TypedMessage> {
+    clientConnectionNumber?: number;
+    content: TMessage["content"];
+    referenceSequenceNumber?: number;
+    targetClientId?: string;
+    type?: TMessage["type"];
+}
+
+// @beta @legacy
+export interface ISnapshot {
+    // (undocumented)
+    blobContents: Map<string, ArrayBuffer>;
+    latestSequenceNumber: number | undefined;
+    // (undocumented)
+    ops: ISequencedDocumentMessage[];
+    sequenceNumber: number | undefined;
+    // (undocumented)
+    snapshotFormatV: 1;
+    // (undocumented)
+    snapshotTree: ISnapshotTree;
+}
+
+// @beta @legacy
+export interface ISnapshotFetchOptions {
+    cacheSnapshot?: boolean;
+    fetchSource?: FetchSource;
+    loadingGroupIds?: string[];
+    scenarioName?: string;
+    versionId?: string;
+}
+
+// @beta @legacy (undocumented)
+export interface ISnapshotTree {
+    // (undocumented)
+    blobs: {
+        [path: string]: string;
+    };
+    groupId?: string;
+    // (undocumented)
+    id?: string;
+    // (undocumented)
+    trees: {
+        [path: string]: ISnapshotTree;
+    };
+    unreferenced?: true;
+}
+
+// @beta @legacy
+export type IsoDate = string;
+
+// @beta @legacy
+export interface IStream<T> {
+    // (undocumented)
+    read(): Promise<IStreamResult<T>>;
+}
+
+// @beta @legacy (undocumented)
+export type IStreamResult<T> = {
+    done: true;
+} | {
+    done: false;
+    value: T;
+};
+
+// @beta @legacy
+export interface ISummaryAck {
+    handle: string;
+    summaryProposal: ISummaryProposal;
+}
+
+// @public
+export interface ISummaryAttachment {
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    type: SummaryType.Attachment;
+}
+
+// @public
+export interface ISummaryBlob {
+    // (undocumented)
+    content: string | Uint8Array;
+    // (undocumented)
+    type: SummaryType.Blob;
+}
+
+// @beta @legacy (undocumented)
+export interface ISummaryContent {
+    details?: IUploadedSummaryDetails;
+    handle: string;
+    head: string;
+    message: string;
+    parents: string[];
+}
+
+// @beta @legacy
+export interface ISummaryContext {
+    readonly ackHandle: string | undefined;
+    readonly proposalHandle: string | undefined;
+    // (undocumented)
+    readonly referenceSequenceNumber: number;
+}
+
+// @public
+export interface ISummaryHandle {
+    handle: string;
+    handleType: SummaryTypeNoHandle;
+    // (undocumented)
+    type: SummaryType.Handle;
+}
+
+// @beta @legacy
+export interface ISummaryNack {
+    code?: number;
+    message?: string;
+    retryAfter?: number;
+    summaryProposal: ISummaryProposal;
+}
+
+// @beta @legacy
+export interface ISummaryProposal {
+    summarySequenceNumber: number;
+}
+
+// @public
+export interface ISummaryTree {
+    groupId?: string;
+    tree: {
+        [path: string]: SummaryObject;
+    };
+    // (undocumented)
+    type: SummaryType.Tree;
+    unreferenced?: true;
+}
+
+// @beta @legacy (undocumented)
+export interface IThrottlingWarning extends IDriverErrorBase {
+    // (undocumented)
+    readonly errorType: typeof DriverErrorTypes.throttlingError;
+    // (undocumented)
+    readonly retryAfterSeconds: number;
+}
+
+// @beta @legacy
+export interface ITokenClaims {
+    documentId: string;
+    exp: number;
+    iat: number;
+    jti?: string;
+    scopes: string[];
+    tenantId: string;
+    user: IUser;
+    ver: string;
+}
+
+// @beta @legacy
+export interface ITrace {
+    action: string;
+    service: string;
+    timestamp: number;
+}
+
+// @beta @legacy (undocumented)
+export interface ITree {
+    // (undocumented)
+    entries: ITreeEntry[];
+    groupId?: string;
+    id?: string;
+    unreferenced?: true;
+}
+
+// @beta @legacy
+export type ITreeEntry = {
+    path: string;
+    mode: FileMode;
+} & ({
+    type: TreeEntry.Blob;
+    value: IBlob;
+} | {
+    type: TreeEntry.Tree;
+    value: ITree;
+} | {
+    type: TreeEntry.Attachment;
+    value: IAttachment;
+});
+
+// @beta @legacy (undocumented)
+export interface IUploadedSummaryDetails {
+    includesProtocolTree?: boolean;
+}
+
+// @beta @legacy (undocumented)
+export interface IUrlResolver {
+    getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string, packageInfoSource?: IContainerPackageInfo): Promise<string>;
+    // (undocumented)
+    resolve(request: IRequest): Promise<IResolvedUrl | undefined>;
+}
+
+// @public
+export interface IUser {
+    id: string;
+}
+
+// @beta @legacy
+export interface IVersion {
+    date?: IsoDate;
+    id: string;
+    treeId: string;
+}
+
+// @beta @legacy (undocumented)
+export enum LoaderCachingPolicy {
+    NoCaching = 0,
+    Prefetch = 1
+}
+
+// @beta @legacy (undocumented)
+export enum MessageType {
+    Accept = "accept",
+    ClientJoin = "join",
+    ClientLeave = "leave",
+    Control = "control",
+    NoClient = "noClient",
+    NoOp = "noop",
+    Operation = "op",
+    Propose = "propose",
+    Reject = "reject",
+    RoundTrip = "tripComplete",
+    Summarize = "summarize",
+    SummaryAck = "summaryAck",
+    SummaryNack = "summaryNack"
+}
+
+// @beta @legacy
+export enum NackErrorType {
+    BadRequestError = "BadRequestError",
+    InvalidScopeError = "InvalidScopeError",
+    LimitExceededError = "LimitExceededError",
+    ThrottlingError = "ThrottlingError"
+}
+
+// @beta @legacy
+export enum ScopeType {
+    DocRead = "doc:read",
+    DocWrite = "doc:write",
+    SummaryWrite = "summary:write"
+}
+
+// @public
+export type SummaryObject = ISummaryTree | ISummaryBlob | ISummaryHandle | ISummaryAttachment;
+
+// @beta @legacy
+export type SummaryTree = ISummaryTree | ISummaryHandle;
+
+// @public
+export namespace SummaryType {
+    const Tree: Tree;
+    const Blob: Blob;
+    const Handle: Handle;
+    const Attachment: Attachment;
+}
+
+// @public
+export type SummaryType = SummaryType.Attachment | SummaryType.Blob | SummaryType.Handle | SummaryType.Tree;
+
+// @public
+export type SummaryTypeNoHandle = SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment;
+
+// @beta @legacy
+export enum TreeEntry {
+    // (undocumented)
+    Attachment = "Attachment",
+    // (undocumented)
+    Blob = "Blob",
+    // (undocumented)
+    Tree = "Tree"
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

CHANGELOG.md

 # @fluidframework/driver-definitions
 
+## 2.60.0
+
+Dependency updates only.
+
 ## 2.53.0
@@ -4,0 +8,0 @@

dist/driverError.d.ts

@@ -8,4 +8,3 @@ /*!
  * Different error types the Driver may report out to the Host.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -87,4 +86,3 @@ export declare const DriverErrorTypes: {
  * {@inheritDoc (DriverErrorTypes:variable)}
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -102,4 +100,3 @@ export type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErrorTypes];
  * but we can't reference a specific driver's error type enum in this code.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -116,4 +113,3 @@ export interface IAnyDriverError extends Omit<IDriverErrorBase, "errorType"> {
  * Base interface for all errors and warnings
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -146,4 +142,3 @@ export interface IDriverErrorBase {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -155,4 +150,3 @@ export interface IThrottlingWarning extends IDriverErrorBase {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -164,4 +158,3 @@ export interface IGenericNetworkError extends IDriverErrorBase {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -174,4 +167,3 @@ export interface IAuthorizationError extends IDriverErrorBase {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -185,4 +177,3 @@ export interface ILocationRedirectionError extends IDriverErrorBase {
  * allows compiler to differentiate interfaces based on error type
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -194,6 +185,5 @@ export interface IDriverBasicError extends IDriverErrorBase {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type DriverError = IThrottlingWarning | IGenericNetworkError | IAuthorizationError | ILocationRedirectionError | IDriverBasicError;
 //# sourceMappingURL=driverError.d.ts.map

dist/driverError.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"driverError.d.ts","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAMrD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB;IAI5B;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;IAQH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;;OAIG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;CAEM,CAAC;AACX;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAExF;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC;IAC3E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,gBAAgB,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC3D,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,eAAe,CAAC;IAC5D,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC7D,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,mBAAmB,CAAC;IAChE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC5D,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,kBAAkB,CAAC;IAC/D,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IAClE,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,mBAAmB,CAAC;IAChE,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;CACnC;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IAC1D,QAAQ,CAAC,SAAS,EACf,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,+BAA+B,GACvD,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,gCAAgC,GACxD,OAAO,gBAAgB,CAAC,UAAU,GAClC,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,eAAe,GACvC,OAAO,gBAAgB,CAAC,uBAAuB,GAC/C,OAAO,gBAAgB,CAAC,wBAAwB,GAChD,OAAO,gBAAgB,CAAC,kBAAkB,GAC1C,OAAO,gBAAgB,CAAC,UAAU,GAClC,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,iBAAiB,CAAC;IAC7C,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GACpB,kBAAkB,GAClB,oBAAoB,GACpB,mBAAmB,GACnB,yBAAyB,GACzB,iBAAiB,CAAC"}
+{"version":3,"file":"driverError.d.ts","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAMrD;;;GAGG;AACH,eAAO,MAAM,gBAAgB;IAI5B;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;IAQH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;;OAIG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;CAEM,CAAC;AACX;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAExF;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC;IAC3E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,gBAAgB,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC3D,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,eAAe,CAAC;IAC5D,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC7D,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,mBAAmB,CAAC;IAChE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC5D,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,kBAAkB,CAAC;IAC/D,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IAClE,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,mBAAmB,CAAC;IAChE,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IAC1D,QAAQ,CAAC,SAAS,EACf,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,+BAA+B,GACvD,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,gCAAgC,GACxD,OAAO,gBAAgB,CAAC,UAAU,GAClC,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,eAAe,GACvC,OAAO,gBAAgB,CAAC,uBAAuB,GAC/C,OAAO,gBAAgB,CAAC,wBAAwB,GAChD,OAAO,gBAAgB,CAAC,kBAAkB,GAC1C,OAAO,gBAAgB,CAAC,UAAU,GAClC,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,iBAAiB,CAAC;IAC7C,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GACpB,kBAAkB,GAClB,oBAAoB,GACpB,mBAAmB,GACnB,yBAAyB,GACzB,iBAAiB,CAAC"}

dist/driverError.js

@@ -13,4 +13,3 @@ "use strict";
  * Different error types the Driver may report out to the Host.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -17,0 +16,0 @@ exports.DriverErrorTypes = {

dist/driverError.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"driverError.js","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,uEAA2E;AAI3E,8GAA8G;AAC9G,MAAM,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,GAAG,8BAA8B,EAAE,GACpF,0BAAe,CAAC;AAEjB;;;;GAIG;AACU,QAAA,gBAAgB,GAAG;IAC/B,2BAA2B;IAC3B,GAAG,8BAA8B;IAEjC;;;OAGG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;OAEG;IACH,kBAAkB,EAAE,oBAAoB;IAExC;;OAEG;IACH,+BAA+B,EAAE,iCAAiC;IAElE;;OAEG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,gCAAgC,EAAE,kCAAkC;IAEpE;;;OAGG;IACH,UAAU,EAAE,YAAY;IAExB;;;;;OAKG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,eAAe,EAAE,iBAAiB;IAElC;;OAEG;IACH,uBAAuB,EAAE,yBAAyB;IAElD;;;;;OAKG;IACH,wBAAwB,EAAE,0BAA0B;IAEpD;;OAEG;IACH,8BAA8B,EAAE,gCAAgC;IAEhE;;;OAGG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;;;OAIG;IACH,kBAAkB,EAAE,oBAAoB;IAExC;;OAEG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,iBAAiB,EAAE,mBAAmB;CAC7B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { FluidErrorTypes } from \"@fluidframework/core-interfaces/internal\";\n\nimport type { IResolvedUrl } from \"./urlResolver.js\";\n\n// Omit `dataCorruptionError` and `dataProcessingError` from the list of values inherited from FluidErrorTypes\nconst { dataCorruptionError, dataProcessingError, ...FluidErrorTypesExceptDataTypes } =\n\tFluidErrorTypes;\n\n/**\n * Different error types the Driver may report out to the Host.\n * @legacy\n * @alpha\n */\nexport const DriverErrorTypes = {\n\t// Inherit base error types\n\t...FluidErrorTypesExceptDataTypes,\n\n\t/**\n\t * Some non-categorized (below) networking error\n\t * Include errors like  fatal server error (usually 500).\n\t */\n\tgenericNetworkError: \"genericNetworkError\",\n\n\t/**\n\t * Access denied - user does not have enough privileges to open a file, or continue to operate on a file\n\t */\n\tauthorizationError: \"authorizationError\",\n\n\t/**\n\t * File not found, or file deleted during session\n\t */\n\tfileNotFoundOrAccessDeniedError: \"fileNotFoundOrAccessDeniedError\",\n\n\t/**\n\t * We can not reach server due to computer being offline.\n\t */\n\tofflineError: \"offlineError\",\n\n\t/*\n\t * Unsupported client protocol\n\t */\n\tunsupportedClientProtocolVersion: \"unsupportedClientProtocolVersion\",\n\n\t/**\n\t * User does not have write permissions to a file, but is changing content of a file.\n\t * That might be indication of some data store error - data stores should not generate ops in readonly mode.\n\t */\n\twriteError: \"writeError\",\n\n\t/**\n\t * A generic fetch failure that indicates we were not able to get a response from the server.\n\t * This may be due to the client being offline (though, if we are able to detect offline state it will be\n\t * logged as an offlineError instead).  Other possibilities could be DNS errors, malformed fetch request,\n\t * CSP violation, etc.\n\t */\n\tfetchFailure: \"fetchFailure\",\n\n\t/**\n\t * This error occurs when token provider fails to fetch orderer token\n\t */\n\tfetchTokenError: \"fetchTokenError\",\n\n\t/**\n\t * Unexpected response from server. Either JSON is malformed, or some required properties are missing\n\t */\n\tincorrectServerResponse: \"incorrectServerResponse\",\n\n\t/**\n\t * This error occurs when the file is modified externally (not through Fluid protocol) in storage.\n\t * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,\n\t * and storage / driver / loader detects such mismatch.\n\t * When it's hit, client needs to forget all the knowledge about this file and start over.\n\t */\n\tfileOverwrittenInStorage: \"fileOverwrittenInStorage\",\n\n\t/**\n\t * The document is read-only and delta stream connection is forbidden.\n\t */\n\tdeltaStreamConnectionForbidden: \"deltaStreamConnectionForbidden\",\n\n\t/**\n\t * The location of file/container can change on server. So if the file location moves and we try to access the old\n\t * location, then this error is thrown to let the client know about the new location info.\n\t */\n\tlocationRedirection: \"locationRedirection\",\n\n\t/**\n\t * When a file is not a Fluid file, but has Fluid extension such as \".note\",\n\t * server won't be able to open it and will return this error. The innerMostErrorCode will be\n\t * \"fluidInvalidSchema\"\n\t */\n\tfluidInvalidSchema: \"fluidInvalidSchema\",\n\n\t/**\n\t * File is locked for read/write by storage, e.g. whole collection is locked and access denied.\n\t */\n\tfileIsLocked: \"fileIsLocked\",\n\n\t/**\n\t * Storage is out of space\n\t */\n\toutOfStorageError: \"outOfStorageError\",\n} as const;\n/**\n * {@inheritDoc (DriverErrorTypes:variable)}\n * @legacy\n * @alpha\n */\nexport type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErrorTypes];\n\n/**\n * Interface describing errors and warnings raised by any driver code.\n *\n * @remarks\n * Not expected to be implemented by a class or an object literal, but rather used in place of\n * any or unknown in various function signatures that pass errors around.\n *\n * \"Any\" in the interface name is a nod to the fact that errorType has lost its type constraint.\n * It will be either {@link @fluidframework/driver-definitions#(DriverErrorTypes:variable)} or the specific driver's specialized error type enum,\n * but we can't reference a specific driver's error type enum in this code.\n * @legacy\n * @alpha\n */\nexport interface IAnyDriverError extends Omit<IDriverErrorBase, \"errorType\"> {\n\treadonly errorType: string;\n\t/**\n\t * This property is used predominantly for socket io errors. It captures the underlying socket event name which resulted in the error.\n\t * i.e. connect_error, connect_document_error etc.\n\t */\n\tscenarioName?: string;\n}\n\n/**\n * Base interface for all errors and warnings\n * @legacy\n * @alpha\n */\nexport interface IDriverErrorBase {\n\t/**\n\t * Classification of what type of error this is, used programmatically by consumers to interpret the error.\n\t *\n\t * @privateRemarks TODO: use {@link DriverErrorTypes} instead (breaking change).\n\t */\n\treadonly errorType: DriverErrorTypes;\n\n\t/**\n\t * Free-form error message\n\t */\n\treadonly message: string;\n\n\t/**\n\t * True indicates the caller may retry the failed action. False indicates it's a fatal error\n\t */\n\tcanRetry: boolean;\n\n\t/**\n\t * Best guess as to network conditions (online/offline) when the error arose.\n\t * See OnlineStatus enum in driver-utils package for expected values.\n\t */\n\tonline?: string;\n\n\t/**\n\t * Whether service was reachable and we got some response from service.\n\t */\n\tendpointReached?: boolean;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IThrottlingWarning extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.throttlingError;\n\treadonly retryAfterSeconds: number;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IGenericNetworkError extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.genericNetworkError;\n\treadonly statusCode?: number;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IAuthorizationError extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.authorizationError;\n\treadonly claims?: string;\n\treadonly tenantId?: string;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface ILocationRedirectionError extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.locationRedirection;\n\treadonly redirectUrl: IResolvedUrl;\n}\n\n/**\n * Having this uber interface without types that have their own interfaces\n * allows compiler to differentiate interfaces based on error type\n * @legacy\n * @alpha\n */\nexport interface IDriverBasicError extends IDriverErrorBase {\n\treadonly errorType:\n\t\t| typeof DriverErrorTypes.genericError\n\t\t| typeof DriverErrorTypes.fileNotFoundOrAccessDeniedError\n\t\t| typeof DriverErrorTypes.offlineError\n\t\t| typeof DriverErrorTypes.unsupportedClientProtocolVersion\n\t\t| typeof DriverErrorTypes.writeError\n\t\t| typeof DriverErrorTypes.fetchFailure\n\t\t| typeof DriverErrorTypes.fetchTokenError\n\t\t| typeof DriverErrorTypes.incorrectServerResponse\n\t\t| typeof DriverErrorTypes.fileOverwrittenInStorage\n\t\t| typeof DriverErrorTypes.fluidInvalidSchema\n\t\t| typeof DriverErrorTypes.usageError\n\t\t| typeof DriverErrorTypes.fileIsLocked\n\t\t| typeof DriverErrorTypes.outOfStorageError;\n\treadonly statusCode?: number;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport type DriverError =\n\t| IThrottlingWarning\n\t| IGenericNetworkError\n\t| IAuthorizationError\n\t| ILocationRedirectionError\n\t| IDriverBasicError;\n"]}
+{"version":3,"file":"driverError.js","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,uEAA2E;AAI3E,8GAA8G;AAC9G,MAAM,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,GAAG,8BAA8B,EAAE,GACpF,0BAAe,CAAC;AAEjB;;;GAGG;AACU,QAAA,gBAAgB,GAAG;IAC/B,2BAA2B;IAC3B,GAAG,8BAA8B;IAEjC;;;OAGG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;OAEG;IACH,kBAAkB,EAAE,oBAAoB;IAExC;;OAEG;IACH,+BAA+B,EAAE,iCAAiC;IAElE;;OAEG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,gCAAgC,EAAE,kCAAkC;IAEpE;;;OAGG;IACH,UAAU,EAAE,YAAY;IAExB;;;;;OAKG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,eAAe,EAAE,iBAAiB;IAElC;;OAEG;IACH,uBAAuB,EAAE,yBAAyB;IAElD;;;;;OAKG;IACH,wBAAwB,EAAE,0BAA0B;IAEpD;;OAEG;IACH,8BAA8B,EAAE,gCAAgC;IAEhE;;;OAGG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;;;OAIG;IACH,kBAAkB,EAAE,oBAAoB;IAExC;;OAEG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,iBAAiB,EAAE,mBAAmB;CAC7B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { FluidErrorTypes } from \"@fluidframework/core-interfaces/internal\";\n\nimport type { IResolvedUrl } from \"./urlResolver.js\";\n\n// Omit `dataCorruptionError` and `dataProcessingError` from the list of values inherited from FluidErrorTypes\nconst { dataCorruptionError, dataProcessingError, ...FluidErrorTypesExceptDataTypes } =\n\tFluidErrorTypes;\n\n/**\n * Different error types the Driver may report out to the Host.\n * @legacy @beta\n */\nexport const DriverErrorTypes = {\n\t// Inherit base error types\n\t...FluidErrorTypesExceptDataTypes,\n\n\t/**\n\t * Some non-categorized (below) networking error\n\t * Include errors like  fatal server error (usually 500).\n\t */\n\tgenericNetworkError: \"genericNetworkError\",\n\n\t/**\n\t * Access denied - user does not have enough privileges to open a file, or continue to operate on a file\n\t */\n\tauthorizationError: \"authorizationError\",\n\n\t/**\n\t * File not found, or file deleted during session\n\t */\n\tfileNotFoundOrAccessDeniedError: \"fileNotFoundOrAccessDeniedError\",\n\n\t/**\n\t * We can not reach server due to computer being offline.\n\t */\n\tofflineError: \"offlineError\",\n\n\t/*\n\t * Unsupported client protocol\n\t */\n\tunsupportedClientProtocolVersion: \"unsupportedClientProtocolVersion\",\n\n\t/**\n\t * User does not have write permissions to a file, but is changing content of a file.\n\t * That might be indication of some data store error - data stores should not generate ops in readonly mode.\n\t */\n\twriteError: \"writeError\",\n\n\t/**\n\t * A generic fetch failure that indicates we were not able to get a response from the server.\n\t * This may be due to the client being offline (though, if we are able to detect offline state it will be\n\t * logged as an offlineError instead).  Other possibilities could be DNS errors, malformed fetch request,\n\t * CSP violation, etc.\n\t */\n\tfetchFailure: \"fetchFailure\",\n\n\t/**\n\t * This error occurs when token provider fails to fetch orderer token\n\t */\n\tfetchTokenError: \"fetchTokenError\",\n\n\t/**\n\t * Unexpected response from server. Either JSON is malformed, or some required properties are missing\n\t */\n\tincorrectServerResponse: \"incorrectServerResponse\",\n\n\t/**\n\t * This error occurs when the file is modified externally (not through Fluid protocol) in storage.\n\t * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,\n\t * and storage / driver / loader detects such mismatch.\n\t * When it's hit, client needs to forget all the knowledge about this file and start over.\n\t */\n\tfileOverwrittenInStorage: \"fileOverwrittenInStorage\",\n\n\t/**\n\t * The document is read-only and delta stream connection is forbidden.\n\t */\n\tdeltaStreamConnectionForbidden: \"deltaStreamConnectionForbidden\",\n\n\t/**\n\t * The location of file/container can change on server. So if the file location moves and we try to access the old\n\t * location, then this error is thrown to let the client know about the new location info.\n\t */\n\tlocationRedirection: \"locationRedirection\",\n\n\t/**\n\t * When a file is not a Fluid file, but has Fluid extension such as \".note\",\n\t * server won't be able to open it and will return this error. The innerMostErrorCode will be\n\t * \"fluidInvalidSchema\"\n\t */\n\tfluidInvalidSchema: \"fluidInvalidSchema\",\n\n\t/**\n\t * File is locked for read/write by storage, e.g. whole collection is locked and access denied.\n\t */\n\tfileIsLocked: \"fileIsLocked\",\n\n\t/**\n\t * Storage is out of space\n\t */\n\toutOfStorageError: \"outOfStorageError\",\n} as const;\n/**\n * {@inheritDoc (DriverErrorTypes:variable)}\n * @legacy @beta\n */\nexport type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErrorTypes];\n\n/**\n * Interface describing errors and warnings raised by any driver code.\n *\n * @remarks\n * Not expected to be implemented by a class or an object literal, but rather used in place of\n * any or unknown in various function signatures that pass errors around.\n *\n * \"Any\" in the interface name is a nod to the fact that errorType has lost its type constraint.\n * It will be either {@link @fluidframework/driver-definitions#(DriverErrorTypes:variable)} or the specific driver's specialized error type enum,\n * but we can't reference a specific driver's error type enum in this code.\n * @legacy @beta\n */\nexport interface IAnyDriverError extends Omit<IDriverErrorBase, \"errorType\"> {\n\treadonly errorType: string;\n\t/**\n\t * This property is used predominantly for socket io errors. It captures the underlying socket event name which resulted in the error.\n\t * i.e. connect_error, connect_document_error etc.\n\t */\n\tscenarioName?: string;\n}\n\n/**\n * Base interface for all errors and warnings\n * @legacy @beta\n */\nexport interface IDriverErrorBase {\n\t/**\n\t * Classification of what type of error this is, used programmatically by consumers to interpret the error.\n\t *\n\t * @privateRemarks TODO: use {@link DriverErrorTypes} instead (breaking change).\n\t */\n\treadonly errorType: DriverErrorTypes;\n\n\t/**\n\t * Free-form error message\n\t */\n\treadonly message: string;\n\n\t/**\n\t * True indicates the caller may retry the failed action. False indicates it's a fatal error\n\t */\n\tcanRetry: boolean;\n\n\t/**\n\t * Best guess as to network conditions (online/offline) when the error arose.\n\t * See OnlineStatus enum in driver-utils package for expected values.\n\t */\n\tonline?: string;\n\n\t/**\n\t * Whether service was reachable and we got some response from service.\n\t */\n\tendpointReached?: boolean;\n}\n\n/**\n * @legacy @beta\n */\nexport interface IThrottlingWarning extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.throttlingError;\n\treadonly retryAfterSeconds: number;\n}\n\n/**\n * @legacy @beta\n */\nexport interface IGenericNetworkError extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.genericNetworkError;\n\treadonly statusCode?: number;\n}\n\n/**\n * @legacy @beta\n */\nexport interface IAuthorizationError extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.authorizationError;\n\treadonly claims?: string;\n\treadonly tenantId?: string;\n}\n\n/**\n * @legacy @beta\n */\nexport interface ILocationRedirectionError extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.locationRedirection;\n\treadonly redirectUrl: IResolvedUrl;\n}\n\n/**\n * Having this uber interface without types that have their own interfaces\n * allows compiler to differentiate interfaces based on error type\n * @legacy @beta\n */\nexport interface IDriverBasicError extends IDriverErrorBase {\n\treadonly errorType:\n\t\t| typeof DriverErrorTypes.genericError\n\t\t| typeof DriverErrorTypes.fileNotFoundOrAccessDeniedError\n\t\t| typeof DriverErrorTypes.offlineError\n\t\t| typeof DriverErrorTypes.unsupportedClientProtocolVersion\n\t\t| typeof DriverErrorTypes.writeError\n\t\t| typeof DriverErrorTypes.fetchFailure\n\t\t| typeof DriverErrorTypes.fetchTokenError\n\t\t| typeof DriverErrorTypes.incorrectServerResponse\n\t\t| typeof DriverErrorTypes.fileOverwrittenInStorage\n\t\t| typeof DriverErrorTypes.fluidInvalidSchema\n\t\t| typeof DriverErrorTypes.usageError\n\t\t| typeof DriverErrorTypes.fileIsLocked\n\t\t| typeof DriverErrorTypes.outOfStorageError;\n\treadonly statusCode?: number;\n}\n\n/**\n * @legacy @beta\n */\nexport type DriverError =\n\t| IThrottlingWarning\n\t| IGenericNetworkError\n\t| IAuthorizationError\n\t| ILocationRedirectionError\n\t| IDriverBasicError;\n"]}

dist/git/resources.d.ts

@@ -119,4 +119,3 @@ /*!
  * Required params to create ref
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -129,4 +128,3 @@ export interface ICreateRefParams {
  * Required params to patch ref
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -133,0 +131,0 @@ export interface IPatchRefParams {

dist/git/resources.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"resources.d.ts","sourceRoot":"","sources":["../../src/git/resources.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB,MAAM,EAAE,OAAO,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,UAAU,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,WAAW,EAAE,CAAC;CACvB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,cAAc;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE;QACP,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,OAAO,CAAC;QAChB,SAAS,EAAE,UAAU,CAAC;QACtB,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,WAAW,CAAC;KAClB,CAAC;IACF,OAAO,EAAE,WAAW,EAAE,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAEjC,OAAO,EAAE,MAAM,CAAC;IAIhB,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;KACZ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,OAAO,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IACjC,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,gBAAgB,EAAE,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,UAAU,EAAE,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;KACZ,CAAC;CACF"}
+{"version":3,"file":"resources.d.ts","sourceRoot":"","sources":["../../src/git/resources.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB,MAAM,EAAE,OAAO,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,UAAU,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,WAAW,EAAE,CAAC;CACvB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,cAAc;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE;QACP,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,OAAO,CAAC;QAChB,SAAS,EAAE,UAAU,CAAC;QACtB,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,WAAW,CAAC;KAClB,CAAC;IACF,OAAO,EAAE,WAAW,EAAE,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAEjC,OAAO,EAAE,MAAM,CAAC;IAIhB,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;KACZ,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,OAAO,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IACjC,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,gBAAgB,EAAE,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,UAAU,EAAE,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;KACZ,CAAC;CACF"}

dist/git/resources.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"resources.js","sourceRoot":"","sources":["../../src/git/resources.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// The types defined in this directory provide strong typing for the deserialized\n// REST payloads when communicating with the Git service.\n//\n// These should not be changed unless Git itself is changed, and should be aligned\n// with the service side definitions contained here:\n//\n// server/routerlicious/packages/gitresources/src/resources.ts\n\n/**\n * Details about the author of the commit\n * @internal\n */\nexport interface IAuthor {\n\tname: string;\n\temail: string;\n\t// ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ\n\tdate: string;\n}\n\n/**\n * Details about the committer of the commit\n * @internal\n */\nexport interface ICommitter {\n\tname: string;\n\temail: string;\n\t// ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ\n\tdate: string;\n}\n\n/**\n * Details of the commit\n * @internal\n */\nexport interface ICommitHash {\n\tsha: string;\n\turl: string;\n}\n\n/**\n * Required params to create commit\n * @internal\n */\nexport interface ICreateCommitParams {\n\tmessage: string;\n\ttree: string;\n\tparents: string[];\n\t// GitHub has signature verification on the author\n\tauthor: IAuthor;\n}\n\n/**\n * Commit content\n * @internal\n */\nexport interface ICommit {\n\tsha: string;\n\turl: string;\n\tauthor: IAuthor;\n\tcommitter: ICommitter;\n\tmessage: string;\n\ttree: ICommitHash;\n\tparents: ICommitHash[];\n}\n\n/**\n * Details of a commit\n *\n * GitHub differentiates the commit resource returned from its git and repos routes. The repos\n * route returns more site specific information (like links to the developer's account) while the git\n * route is what is actually stored in the Git repo\n *\n * https://developer.github.com/v3/git/commits/\n * https://developer.github.com/v3/repos/commits/\n * @internal\n */\nexport interface ICommitDetails {\n\turl: string;\n\tsha: string;\n\tcommit: {\n\t\turl: string;\n\t\tauthor: IAuthor;\n\t\tcommitter: ICommitter;\n\t\tmessage: string;\n\t\ttree: ICommitHash;\n\t};\n\tparents: ICommitHash[];\n}\n\n/**\n * Blob content\n * @internal\n */\nexport interface IBlob {\n\tcontent: string;\n\tencoding: string;\n\turl: string;\n\tsha: string;\n\tsize: number;\n}\n\n/**\n * Required params to create blob\n * @internal\n */\nexport interface ICreateBlobParams {\n\t// The encoded content\n\tcontent: string;\n\n\t// The encoding of the content.\n\t// eslint-disable-next-line unicorn/text-encoding-identifier-case\n\tencoding: \"utf-8\" | \"base64\";\n}\n\n/**\n * Response to create blob request\n * @internal\n */\nexport interface ICreateBlobResponse {\n\tsha: string;\n\turl: string;\n}\n\n/**\n * Ref content\n * @internal\n */\nexport interface IRef {\n\tref: string;\n\turl: string;\n\tobject: {\n\t\ttype: string;\n\t\tsha: string;\n\t\turl: string;\n\t};\n}\n\n/**\n * Required params to create ref\n * @legacy\n * @alpha\n */\nexport interface ICreateRefParams {\n\tref: string;\n\tsha: string;\n}\n\n/**\n * Required params to patch ref\n * @legacy\n * @alpha\n */\nexport interface IPatchRefParams {\n\tsha: string;\n\tforce: boolean;\n}\n\n/**\n * Required params to create repo\n * @param name - name of the repository\n * @internal\n */\nexport interface ICreateRepoParams {\n\tname: string;\n}\n\n/**\n * Required details to create tree entry\n * @internal\n */\nexport interface ICreateTreeEntry {\n\tpath: string;\n\tmode: string;\n\ttype: string;\n\tsha: string;\n}\n\n/**\n * Required params to create tree\n * @internal\n */\nexport interface ICreateTreeParams {\n\tbase_tree?: string;\n\ttree: ICreateTreeEntry[];\n}\n\n/**\n * Tree Entry Content\n * @internal\n */\nexport interface ITreeEntry {\n\tpath: string;\n\tmode: string;\n\ttype: string;\n\tsize: number;\n\tsha: string;\n\turl: string;\n}\n\n/**\n * Tree content\n * @internal\n */\nexport interface ITree {\n\tsha: string;\n\turl: string;\n\ttree: ITreeEntry[];\n}\n\n/**\n * Tagger content\n * @internal\n */\nexport interface ITagger {\n\tname: string;\n\temail: string;\n\t// ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ\n\tdate: string;\n}\n\n/**\n * Required params to create tag\n * @internal\n */\nexport interface ICreateTagParams {\n\ttag: string;\n\tmessage: string;\n\tobject: string;\n\ttype: string;\n\ttagger: ITagger;\n}\n\n/**\n * Tag content\n * @internal\n */\nexport interface ITag {\n\ttag: string;\n\tsha: string;\n\turl: string;\n\tmessage: string;\n\ttagger: ITagger;\n\tobject: {\n\t\ttype: string;\n\t\tsha: string;\n\t\turl: string;\n\t};\n}\n"]}
+{"version":3,"file":"resources.js","sourceRoot":"","sources":["../../src/git/resources.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// The types defined in this directory provide strong typing for the deserialized\n// REST payloads when communicating with the Git service.\n//\n// These should not be changed unless Git itself is changed, and should be aligned\n// with the service side definitions contained here:\n//\n// server/routerlicious/packages/gitresources/src/resources.ts\n\n/**\n * Details about the author of the commit\n * @internal\n */\nexport interface IAuthor {\n\tname: string;\n\temail: string;\n\t// ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ\n\tdate: string;\n}\n\n/**\n * Details about the committer of the commit\n * @internal\n */\nexport interface ICommitter {\n\tname: string;\n\temail: string;\n\t// ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ\n\tdate: string;\n}\n\n/**\n * Details of the commit\n * @internal\n */\nexport interface ICommitHash {\n\tsha: string;\n\turl: string;\n}\n\n/**\n * Required params to create commit\n * @internal\n */\nexport interface ICreateCommitParams {\n\tmessage: string;\n\ttree: string;\n\tparents: string[];\n\t// GitHub has signature verification on the author\n\tauthor: IAuthor;\n}\n\n/**\n * Commit content\n * @internal\n */\nexport interface ICommit {\n\tsha: string;\n\turl: string;\n\tauthor: IAuthor;\n\tcommitter: ICommitter;\n\tmessage: string;\n\ttree: ICommitHash;\n\tparents: ICommitHash[];\n}\n\n/**\n * Details of a commit\n *\n * GitHub differentiates the commit resource returned from its git and repos routes. The repos\n * route returns more site specific information (like links to the developer's account) while the git\n * route is what is actually stored in the Git repo\n *\n * https://developer.github.com/v3/git/commits/\n * https://developer.github.com/v3/repos/commits/\n * @internal\n */\nexport interface ICommitDetails {\n\turl: string;\n\tsha: string;\n\tcommit: {\n\t\turl: string;\n\t\tauthor: IAuthor;\n\t\tcommitter: ICommitter;\n\t\tmessage: string;\n\t\ttree: ICommitHash;\n\t};\n\tparents: ICommitHash[];\n}\n\n/**\n * Blob content\n * @internal\n */\nexport interface IBlob {\n\tcontent: string;\n\tencoding: string;\n\turl: string;\n\tsha: string;\n\tsize: number;\n}\n\n/**\n * Required params to create blob\n * @internal\n */\nexport interface ICreateBlobParams {\n\t// The encoded content\n\tcontent: string;\n\n\t// The encoding of the content.\n\t// eslint-disable-next-line unicorn/text-encoding-identifier-case\n\tencoding: \"utf-8\" | \"base64\";\n}\n\n/**\n * Response to create blob request\n * @internal\n */\nexport interface ICreateBlobResponse {\n\tsha: string;\n\turl: string;\n}\n\n/**\n * Ref content\n * @internal\n */\nexport interface IRef {\n\tref: string;\n\turl: string;\n\tobject: {\n\t\ttype: string;\n\t\tsha: string;\n\t\turl: string;\n\t};\n}\n\n/**\n * Required params to create ref\n * @legacy @beta\n */\nexport interface ICreateRefParams {\n\tref: string;\n\tsha: string;\n}\n\n/**\n * Required params to patch ref\n * @legacy @beta\n */\nexport interface IPatchRefParams {\n\tsha: string;\n\tforce: boolean;\n}\n\n/**\n * Required params to create repo\n * @param name - name of the repository\n * @internal\n */\nexport interface ICreateRepoParams {\n\tname: string;\n}\n\n/**\n * Required details to create tree entry\n * @internal\n */\nexport interface ICreateTreeEntry {\n\tpath: string;\n\tmode: string;\n\ttype: string;\n\tsha: string;\n}\n\n/**\n * Required params to create tree\n * @internal\n */\nexport interface ICreateTreeParams {\n\tbase_tree?: string;\n\ttree: ICreateTreeEntry[];\n}\n\n/**\n * Tree Entry Content\n * @internal\n */\nexport interface ITreeEntry {\n\tpath: string;\n\tmode: string;\n\ttype: string;\n\tsize: number;\n\tsha: string;\n\turl: string;\n}\n\n/**\n * Tree content\n * @internal\n */\nexport interface ITree {\n\tsha: string;\n\turl: string;\n\ttree: ITreeEntry[];\n}\n\n/**\n * Tagger content\n * @internal\n */\nexport interface ITagger {\n\tname: string;\n\temail: string;\n\t// ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ\n\tdate: string;\n}\n\n/**\n * Required params to create tag\n * @internal\n */\nexport interface ICreateTagParams {\n\ttag: string;\n\tmessage: string;\n\tobject: string;\n\ttype: string;\n\ttagger: ITagger;\n}\n\n/**\n * Tag content\n * @internal\n */\nexport interface ITag {\n\ttag: string;\n\tsha: string;\n\turl: string;\n\tmessage: string;\n\ttagger: ITagger;\n\tobject: {\n\t\ttype: string;\n\t\tsha: string;\n\t\turl: string;\n\t};\n}\n"]}

dist/protocol/clients.d.ts

@@ -99,4 +99,3 @@ /*!
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -103,0 +102,0 @@ export interface ISignalClient {

dist/protocol/clients.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"clients.d.ts","sourceRoot":"","sources":["../../src/protocol/clients.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,MAAM,CAAC;AAE9C;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC7B;;;;;;;;OAQG;IACH,WAAW,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,YAAY,EAAE,aAAa,CAAC;IAE5B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,cAAc,CAAC;IAExB,UAAU,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IAEZ;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CAChB"}
+{"version":3,"file":"clients.d.ts","sourceRoot":"","sources":["../../src/protocol/clients.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,MAAM,CAAC;AAE9C;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC7B;;;;;;;;OAQG;IACH,WAAW,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,YAAY,EAAE,aAAa,CAAC;IAE5B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,cAAc,CAAC;IAExB,UAAU,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IAEZ;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CAChB"}

dist/protocol/clients.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"clients.js","sourceRoot":"","sources":["../../src/protocol/clients.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IUser } from \"./users.js\";\n\n/**\n * A client's connection mode - either view-only (\"read\") or allowing edits (\"write\").\n *\n * @remarks\n *\n * Note: a user's connection mode is dependent on their permissions.\n * E.g. a user with read-only permissions will not be allowed a \"write\" connection mode.\n * @public\n */\nexport type ConnectionMode = \"write\" | \"read\";\n\n/**\n * Capabilities of a Client.\n * In particular, whether or not the client is {@link ICapabilities.interactive}.\n * @public\n */\nexport interface ICapabilities {\n\t/**\n\t * Indicates if the client represents a potentially interactive session with a user (if 'true') or if it's\n\t * a \"system entity\" (if 'false').\n\t *\n\t * @remarks\n\t *\n\t * The only \"system entity\" scenario at the moment is the\n\t * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer client}.\n\t */\n\tinteractive: boolean;\n}\n\n/**\n * {@link IClient} connection / environment metadata.\n * @public\n */\nexport interface IClientDetails {\n\t/**\n\t * {@inheritDoc ICapabilities}\n\t */\n\tcapabilities: ICapabilities;\n\n\t/**\n\t * The kind of client being described.\n\t *\n\t * `undefined` indicates that the kind could not be determined.\n\t */\n\ttype?: string;\n\n\t/**\n\t * @remarks\n\t *\n\t * If the environment needs to specify multiple properties which gives info about the environment, then\n\t * it should be in particular format like: \"prop1:val1;prop2:val2;prop3:val3\"\n\t */\n\tenvironment?: string;\n\tdevice?: string;\n}\n\n/**\n * Represents a client connected to a Fluid service, including associated user details, permissions, and connection mode.\n * @public\n */\nexport interface IClient {\n\t/**\n\t * {@inheritDoc ConnectionMode}\n\t */\n\tmode: ConnectionMode;\n\n\t/**\n\t * {@inheritDoc IClientDetails}\n\t */\n\tdetails: IClientDetails;\n\n\tpermission: string[];\n\n\t/**\n\t * The user information associated with this client connection.\n\t */\n\tuser: IUser;\n\n\t/**\n\t * Enumerates actions allowed for the client connection.\n\t */\n\tscopes: string[];\n\n\t/**\n\t * The time the client connected to the service.\n\t */\n\ttimestamp?: number;\n}\n\n/**\n * A {@link IClient} that has been acknowledged by the sequencer.\n * @public\n */\nexport interface ISequencedClient {\n\t/**\n\t * The underlying client details.\n\t */\n\tclient: IClient;\n\n\t/**\n\t * The sequence number of the \"join\" message sent when the client joined the session.\n\t */\n\tsequenceNumber: number;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface ISignalClient {\n\t/**\n\t * The {@link ISignalClient.client}'s unique ID.\n\t */\n\tclientId: string;\n\n\t/**\n\t * The underlying client details.\n\t */\n\tclient: IClient;\n\n\t/**\n\t * Counts the number of signals sent by the client.\n\t */\n\tclientConnectionNumber?: number;\n\n\t/**\n\t * Sequence number that indicates when the signal was created in relation to the delta stream.\n\t */\n\treferenceSequenceNumber?: number;\n}\n\n/**\n * Contents sent with a `ClientJoin` message.\n * @internal\n */\nexport interface IClientJoin {\n\t/**\n\t * The ID of the joining client.\n\t */\n\tclientId: string;\n\n\t/**\n\t * The underlying client details.\n\t */\n\tdetail: IClient;\n}\n"]}
+{"version":3,"file":"clients.js","sourceRoot":"","sources":["../../src/protocol/clients.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IUser } from \"./users.js\";\n\n/**\n * A client's connection mode - either view-only (\"read\") or allowing edits (\"write\").\n *\n * @remarks\n *\n * Note: a user's connection mode is dependent on their permissions.\n * E.g. a user with read-only permissions will not be allowed a \"write\" connection mode.\n * @public\n */\nexport type ConnectionMode = \"write\" | \"read\";\n\n/**\n * Capabilities of a Client.\n * In particular, whether or not the client is {@link ICapabilities.interactive}.\n * @public\n */\nexport interface ICapabilities {\n\t/**\n\t * Indicates if the client represents a potentially interactive session with a user (if 'true') or if it's\n\t * a \"system entity\" (if 'false').\n\t *\n\t * @remarks\n\t *\n\t * The only \"system entity\" scenario at the moment is the\n\t * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer client}.\n\t */\n\tinteractive: boolean;\n}\n\n/**\n * {@link IClient} connection / environment metadata.\n * @public\n */\nexport interface IClientDetails {\n\t/**\n\t * {@inheritDoc ICapabilities}\n\t */\n\tcapabilities: ICapabilities;\n\n\t/**\n\t * The kind of client being described.\n\t *\n\t * `undefined` indicates that the kind could not be determined.\n\t */\n\ttype?: string;\n\n\t/**\n\t * @remarks\n\t *\n\t * If the environment needs to specify multiple properties which gives info about the environment, then\n\t * it should be in particular format like: \"prop1:val1;prop2:val2;prop3:val3\"\n\t */\n\tenvironment?: string;\n\tdevice?: string;\n}\n\n/**\n * Represents a client connected to a Fluid service, including associated user details, permissions, and connection mode.\n * @public\n */\nexport interface IClient {\n\t/**\n\t * {@inheritDoc ConnectionMode}\n\t */\n\tmode: ConnectionMode;\n\n\t/**\n\t * {@inheritDoc IClientDetails}\n\t */\n\tdetails: IClientDetails;\n\n\tpermission: string[];\n\n\t/**\n\t * The user information associated with this client connection.\n\t */\n\tuser: IUser;\n\n\t/**\n\t * Enumerates actions allowed for the client connection.\n\t */\n\tscopes: string[];\n\n\t/**\n\t * The time the client connected to the service.\n\t */\n\ttimestamp?: number;\n}\n\n/**\n * A {@link IClient} that has been acknowledged by the sequencer.\n * @public\n */\nexport interface ISequencedClient {\n\t/**\n\t * The underlying client details.\n\t */\n\tclient: IClient;\n\n\t/**\n\t * The sequence number of the \"join\" message sent when the client joined the session.\n\t */\n\tsequenceNumber: number;\n}\n\n/**\n * @legacy @beta\n */\nexport interface ISignalClient {\n\t/**\n\t * The {@link ISignalClient.client}'s unique ID.\n\t */\n\tclientId: string;\n\n\t/**\n\t * The underlying client details.\n\t */\n\tclient: IClient;\n\n\t/**\n\t * Counts the number of signals sent by the client.\n\t */\n\tclientConnectionNumber?: number;\n\n\t/**\n\t * Sequence number that indicates when the signal was created in relation to the delta stream.\n\t */\n\treferenceSequenceNumber?: number;\n}\n\n/**\n * Contents sent with a `ClientJoin` message.\n * @internal\n */\nexport interface IClientJoin {\n\t/**\n\t * The ID of the joining client.\n\t */\n\tclientId: string;\n\n\t/**\n\t * The underlying client details.\n\t */\n\tdetail: IClient;\n}\n"]}

dist/protocol/config.d.ts

@@ -7,4 +7,3 @@ /*!
  * Key value store of service configuration properties provided to the client as part of connection.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -11,0 +10,0 @@ export interface IClientConfiguration {

dist/protocol/config.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/protocol/config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC5B"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/protocol/config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC5B"}

dist/protocol/config.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/protocol/config.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Key value store of service configuration properties provided to the client as part of connection.\n * @legacy\n * @alpha\n */\nexport interface IClientConfiguration {\n\t/**\n\t * Max message size the server will accept before requiring chunking.\n\t */\n\tmaxMessageSize: number;\n\n\t/**\n\t * Server-defined ideal block size for storing snapshots.\n\t */\n\tblockSize: number;\n\n\t/**\n\t * noopTimeFrequency & noopCountFrequency control how often a client with \"write\" connection needs to send\n\t * noop messages in case no other ops are being sent. Any op (including noops) result in client\n\t * communicating its reference sequence number to the relay service, which can recalculate MSN based on new info.\n\t * Clients send noops when either noopTimeFrequency ms elapsed from receiving the last op or when receiving\n\t * noopCountFrequency ops and only if the client did not have a chance to communicate its reference sequence\n\t * number via regular ops.\n\t * 'Infinity' will disable this feature and if no value is provided, the client choses some reasonable value.\n\t */\n\tnoopTimeFrequency?: number;\n\n\t/**\n\t * Set min op frequency with which noops would be sent in case of an active connection which is not sending any op.\n\t * See {@link IClientConfiguration.noopTimeFrequency} for more details.\n\t * 'Infinity' will disable this feature and if no value is provided, the client choses some reasonable value.\n\t */\n\tnoopCountFrequency?: number;\n}\n"]}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/protocol/config.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Key value store of service configuration properties provided to the client as part of connection.\n * @legacy @beta\n */\nexport interface IClientConfiguration {\n\t/**\n\t * Max message size the server will accept before requiring chunking.\n\t */\n\tmaxMessageSize: number;\n\n\t/**\n\t * Server-defined ideal block size for storing snapshots.\n\t */\n\tblockSize: number;\n\n\t/**\n\t * noopTimeFrequency & noopCountFrequency control how often a client with \"write\" connection needs to send\n\t * noop messages in case no other ops are being sent. Any op (including noops) result in client\n\t * communicating its reference sequence number to the relay service, which can recalculate MSN based on new info.\n\t * Clients send noops when either noopTimeFrequency ms elapsed from receiving the last op or when receiving\n\t * noopCountFrequency ops and only if the client did not have a chance to communicate its reference sequence\n\t * number via regular ops.\n\t * 'Infinity' will disable this feature and if no value is provided, the client choses some reasonable value.\n\t */\n\tnoopTimeFrequency?: number;\n\n\t/**\n\t * Set min op frequency with which noops would be sent in case of an active connection which is not sending any op.\n\t * See {@link IClientConfiguration.noopTimeFrequency} for more details.\n\t * 'Infinity' will disable this feature and if no value is provided, the client choses some reasonable value.\n\t */\n\tnoopCountFrequency?: number;\n}\n"]}

dist/protocol/consensus.d.ts

@@ -13,4 +13,3 @@ /*!
  * the proposal.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -29,4 +28,3 @@ export interface IProposal {
  * Similar to {@link IProposal} except it also includes the sequence number when it was made.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -38,4 +36,3 @@ export type ISequencedProposal = {
  * Adds the sequence number at which the message was approved to an {@link ISequencedProposal}.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -47,4 +44,3 @@ export type IApprovedProposal = {
  * Adds the sequence number at which the message was committed to an {@link IApprovedProposal}.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -69,4 +65,3 @@ export type ICommittedProposal = {
  * Interface for tracking proposals in the Quorum.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -85,4 +80,3 @@ export interface IQuorumProposals {
  * Interface combining tracking of clients as well as proposals in the Quorum.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -105,4 +99,3 @@ export interface IQuorum extends Omit<IQuorumClients, "on" | "once" | "off">, Omit<IQuorumProposals, "on" | "once" | "off"> {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -109,0 +102,0 @@ export interface IProcessMessageResult {

dist/protocol/consensus.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"consensus.d.ts","sourceRoot":"","sources":["../../src/protocol/consensus.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAErD;;;;;;;;;GASG;AACH,MAAM,WAAW,SAAS;IACzB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAAE,cAAc,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAAC;AAExE;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAAE,sBAAsB,EAAE,MAAM,CAAA;CAAE,GAAG,kBAAkB,CAAC;AAExF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAAE,oBAAoB,EAAE,MAAM,CAAA;CAAE,GAAG,iBAAiB,CAAC;AAEtF;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC5C,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAAC;IAC1D,EAAE,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,KAAK,IAAI,OAAE;IACxF,EAAE,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;IAEhE,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,OAAE;IACrD,IAAI,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;IAC3B,GAAG,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAE1B,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAE1B,EAAE,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,IAAI,OAAE;IAC3E,EAAE,CACD,KAAK,EAAE,iBAAiB,EACxB,QAAQ,EAAE,CACT,cAAc,EAAE,MAAM,EACtB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,sBAAsB,EAAE,MAAM,KAC1B,IAAI,OACR;IAEF,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAC3D,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC7B,GAAG,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,OAChB,SAAQ,IAAI,CAAC,cAAc,EAAE,IAAI,GAAG,MAAM,GAAG,KAAK,CAAC,EAClD,IAAI,CAAC,gBAAgB,EAAE,IAAI,GAAG,MAAM,GAAG,KAAK,CAAC;IAC9C,EAAE,EAAE,cAAc,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAClD,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACpB,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,cAAc,EAAE,MAAM,CAAC;IACvB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,OAAO,EAAE,CAAC,MAAM,EAAE,gBAAgB,CAAC,EAAE,CAAC;IACtC,SAAS,EAAE,CAAC,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IACpD,MAAM,EAAE,CAAC,MAAM,EAAE,kBAAkB,CAAC,EAAE,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACrC,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB"}
+{"version":3,"file":"consensus.d.ts","sourceRoot":"","sources":["../../src/protocol/consensus.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAErD;;;;;;;;GAQG;AACH,MAAM,WAAW,SAAS;IACzB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAAE,cAAc,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAAC;AAExE;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAAE,sBAAsB,EAAE,MAAM,CAAA;CAAE,GAAG,kBAAkB,CAAC;AAExF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAAE,oBAAoB,EAAE,MAAM,CAAA;CAAE,GAAG,iBAAiB,CAAC;AAEtF;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC5C,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAAC;IAC1D,EAAE,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,KAAK,IAAI,OAAE;IACxF,EAAE,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;IAEhE,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,OAAE;IACrD,IAAI,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;IAC3B,GAAG,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAE1B,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAE1B,EAAE,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,IAAI,OAAE;IAC3E,EAAE,CACD,KAAK,EAAE,iBAAiB,EACxB,QAAQ,EAAE,CACT,cAAc,EAAE,MAAM,EACtB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,sBAAsB,EAAE,MAAM,KAC1B,IAAI,OACR;IAEF,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAC3D,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC7B,GAAG,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,OAChB,SAAQ,IAAI,CAAC,cAAc,EAAE,IAAI,GAAG,MAAM,GAAG,KAAK,CAAC,EAClD,IAAI,CAAC,gBAAgB,EAAE,IAAI,GAAG,MAAM,GAAG,KAAK,CAAC;IAC9C,EAAE,EAAE,cAAc,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAClD,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACpB,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,cAAc,EAAE,MAAM,CAAC;IACvB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,OAAO,EAAE,CAAC,MAAM,EAAE,gBAAgB,CAAC,EAAE,CAAC;IACtC,SAAS,EAAE,CAAC,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IACpD,MAAM,EAAE,CAAC,MAAM,EAAE,kBAAkB,CAAC,EAAE,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB"}

dist/protocol/consensus.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"consensus.js","sourceRoot":"","sources":["../../src/protocol/consensus.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ISequencedClient } from \"./clients.js\";\n\n/**\n * Proposal to set the given key/value pair.\n *\n * @remarks\n * Consensus on the proposal is achieved if the MSN is \\>= the sequence number\n * at which the proposal is made and no client within the collaboration window rejects\n * the proposal.\n * @legacy\n * @alpha\n */\nexport interface IProposal {\n\t/**\n\t * The key for the proposal.\n\t */\n\tkey: string;\n\n\t/**\n\t * The value of the proposal.\n\t */\n\tvalue: unknown;\n}\n\n/**\n * Similar to {@link IProposal} except it also includes the sequence number when it was made.\n * @legacy\n * @alpha\n */\nexport type ISequencedProposal = { sequenceNumber: number } & IProposal;\n\n/**\n * Adds the sequence number at which the message was approved to an {@link ISequencedProposal}.\n * @legacy\n * @alpha\n */\nexport type IApprovedProposal = { approvalSequenceNumber: number } & ISequencedProposal;\n\n/**\n * Adds the sequence number at which the message was committed to an {@link IApprovedProposal}.\n * @legacy\n * @alpha\n */\nexport type ICommittedProposal = { commitSequenceNumber: number } & IApprovedProposal;\n\n/**\n * Interface for tracking clients in the Quorum.\n * @public\n */\nexport interface IQuorumClients {\n\tgetMembers(): Map<string, ISequencedClient>;\n\tgetMember(clientId: string): ISequencedClient | undefined;\n\ton(event: \"addMember\", listener: (clientId: string, details: ISequencedClient) => void);\n\ton(event: \"removeMember\", listener: (clientId: string) => void);\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\ton(event: \"error\", listener: (message: any) => void);\n\tonce: IQuorumClients[\"on\"];\n\toff: IQuorumClients[\"on\"];\n}\n\n/**\n * Interface for tracking proposals in the Quorum.\n * @legacy\n * @alpha\n */\nexport interface IQuorumProposals {\n\tpropose(key: string, value: unknown): Promise<void>;\n\n\thas(key: string): boolean;\n\n\tget(key: string): unknown;\n\n\ton(event: \"addProposal\", listener: (proposal: ISequencedProposal) => void);\n\ton(\n\t\tevent: \"approveProposal\",\n\t\tlistener: (\n\t\t\tsequenceNumber: number,\n\t\t\tkey: string,\n\t\t\tvalue: unknown,\n\t\t\tapprovalSequenceNumber: number,\n\t\t) => void,\n\t);\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\ton(event: \"error\", listener: (message: any) => void): void;\n\tonce: IQuorumProposals[\"on\"];\n\toff: IQuorumProposals[\"on\"];\n}\n\n/**\n * Interface combining tracking of clients as well as proposals in the Quorum.\n * @legacy\n * @alpha\n */\nexport interface IQuorum\n\textends Omit<IQuorumClients, \"on\" | \"once\" | \"off\">,\n\t\tOmit<IQuorumProposals, \"on\" | \"once\" | \"off\"> {\n\ton: IQuorumClients[\"on\"] & IQuorumProposals[\"on\"];\n\tonce: IQuorum[\"on\"];\n\toff: IQuorum[\"on\"];\n}\n\n/**\n * @internal\n */\nexport interface IProtocolState {\n\tsequenceNumber: number;\n\tminimumSequenceNumber: number;\n\tmembers: [string, ISequencedClient][];\n\tproposals: [number, ISequencedProposal, string[]][];\n\tvalues: [string, ICommittedProposal][];\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IProcessMessageResult {\n\timmediateNoOp?: boolean;\n}\n"]}
+{"version":3,"file":"consensus.js","sourceRoot":"","sources":["../../src/protocol/consensus.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ISequencedClient } from \"./clients.js\";\n\n/**\n * Proposal to set the given key/value pair.\n *\n * @remarks\n * Consensus on the proposal is achieved if the MSN is \\>= the sequence number\n * at which the proposal is made and no client within the collaboration window rejects\n * the proposal.\n * @legacy @beta\n */\nexport interface IProposal {\n\t/**\n\t * The key for the proposal.\n\t */\n\tkey: string;\n\n\t/**\n\t * The value of the proposal.\n\t */\n\tvalue: unknown;\n}\n\n/**\n * Similar to {@link IProposal} except it also includes the sequence number when it was made.\n * @legacy @beta\n */\nexport type ISequencedProposal = { sequenceNumber: number } & IProposal;\n\n/**\n * Adds the sequence number at which the message was approved to an {@link ISequencedProposal}.\n * @legacy @beta\n */\nexport type IApprovedProposal = { approvalSequenceNumber: number } & ISequencedProposal;\n\n/**\n * Adds the sequence number at which the message was committed to an {@link IApprovedProposal}.\n * @legacy @beta\n */\nexport type ICommittedProposal = { commitSequenceNumber: number } & IApprovedProposal;\n\n/**\n * Interface for tracking clients in the Quorum.\n * @public\n */\nexport interface IQuorumClients {\n\tgetMembers(): Map<string, ISequencedClient>;\n\tgetMember(clientId: string): ISequencedClient | undefined;\n\ton(event: \"addMember\", listener: (clientId: string, details: ISequencedClient) => void);\n\ton(event: \"removeMember\", listener: (clientId: string) => void);\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\ton(event: \"error\", listener: (message: any) => void);\n\tonce: IQuorumClients[\"on\"];\n\toff: IQuorumClients[\"on\"];\n}\n\n/**\n * Interface for tracking proposals in the Quorum.\n * @legacy @beta\n */\nexport interface IQuorumProposals {\n\tpropose(key: string, value: unknown): Promise<void>;\n\n\thas(key: string): boolean;\n\n\tget(key: string): unknown;\n\n\ton(event: \"addProposal\", listener: (proposal: ISequencedProposal) => void);\n\ton(\n\t\tevent: \"approveProposal\",\n\t\tlistener: (\n\t\t\tsequenceNumber: number,\n\t\t\tkey: string,\n\t\t\tvalue: unknown,\n\t\t\tapprovalSequenceNumber: number,\n\t\t) => void,\n\t);\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\ton(event: \"error\", listener: (message: any) => void): void;\n\tonce: IQuorumProposals[\"on\"];\n\toff: IQuorumProposals[\"on\"];\n}\n\n/**\n * Interface combining tracking of clients as well as proposals in the Quorum.\n * @legacy @beta\n */\nexport interface IQuorum\n\textends Omit<IQuorumClients, \"on\" | \"once\" | \"off\">,\n\t\tOmit<IQuorumProposals, \"on\" | \"once\" | \"off\"> {\n\ton: IQuorumClients[\"on\"] & IQuorumProposals[\"on\"];\n\tonce: IQuorum[\"on\"];\n\toff: IQuorum[\"on\"];\n}\n\n/**\n * @internal\n */\nexport interface IProtocolState {\n\tsequenceNumber: number;\n\tminimumSequenceNumber: number;\n\tmembers: [string, ISequencedClient][];\n\tproposals: [number, ISequencedProposal, string[]][];\n\tvalues: [string, ICommittedProposal][];\n}\n\n/**\n * @legacy @beta\n */\nexport interface IProcessMessageResult {\n\timmediateNoOp?: boolean;\n}\n"]}

dist/protocol/date.d.ts

@@ -7,6 +7,5 @@ /*!
  * {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601 format} date: `YYYY-MM-DDTHH:MM:SSZ`.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type IsoDate = string;
 //# sourceMappingURL=date.d.ts.map

dist/protocol/date.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"date.d.ts","sourceRoot":"","sources":["../../src/protocol/date.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC"}
+{"version":3,"file":"date.d.ts","sourceRoot":"","sources":["../../src/protocol/date.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC"}

dist/protocol/date.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"date.js","sourceRoot":"","sources":["../../src/protocol/date.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601 format} date: `YYYY-MM-DDTHH:MM:SSZ`.\n * @legacy\n * @alpha\n */\nexport type IsoDate = string;\n"]}
+{"version":3,"file":"date.js","sourceRoot":"","sources":["../../src/protocol/date.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601 format} date: `YYYY-MM-DDTHH:MM:SSZ`.\n * @legacy @beta\n */\nexport type IsoDate = string;\n"]}

dist/protocol/protocol.d.ts

@@ -7,4 +7,3 @@ /*!
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -83,4 +82,3 @@ export declare enum MessageType {
  * Messages to track latency trace.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -102,4 +100,3 @@ export interface ITrace {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -122,4 +119,3 @@ export interface INack {
  * Document-specific message.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -170,4 +166,3 @@ export interface IDocumentMessage {
  * Branch origin information.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -190,4 +185,3 @@ export interface IBranchOrigin {
  * Sequenced message for a distributed document.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -291,4 +285,3 @@ export interface ISequencedDocumentMessage {
  * Common interface between incoming and outgoing signals.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -320,4 +313,3 @@ export interface ISignalMessageBase<TMessage extends TypedMessage = TypedMessage> {
  * Interface for signals sent by the server to clients.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -337,4 +329,3 @@ export interface ISignalMessage<TMessage extends TypedMessage = TypedMessage> extends ISignalMessageBase<TMessage> {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -348,4 +339,3 @@ export interface IUploadedSummaryDetails {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -387,4 +377,3 @@ export interface ISummaryContent {
  * Data about the original proposed summary message.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -399,4 +388,3 @@ export interface ISummaryProposal {
  * Contents of summary ack expected from the server.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -415,4 +403,3 @@ export interface ISummaryAck {
  * Contents of summary nack expected from the server.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -443,4 +430,3 @@ export interface ISummaryNack {
  * Interface for nack content.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -471,4 +457,3 @@ export interface INackContent {
  * Type of the nack.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -475,0 +460,0 @@ export declare enum NackErrorType {

dist/protocol/protocol.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../../src/protocol/protocol.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0CAA0C,CAAC;AAE7E;;;GAGG;AACH,oBAAY,WAAW;IACtB;;;;;OAKG;IACH,IAAI,SAAS;IAEb;;OAEG;IACH,UAAU,SAAS;IAEnB;;OAEG;IACH,WAAW,UAAU;IAErB;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,UAAU,eAAe;IAEzB;;OAEG;IACH,WAAW,gBAAgB;IAE3B;;OAEG;IACH,SAAS,OAAO;IAEhB;;OAEG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,SAAS,iBAAiB;IAE1B;;OAEG;IACH,OAAO,YAAY;CACnB;AAED;;GAEG;AACH,oBAAY,UAAU;IACrB;;OAEG;IACH,UAAU,SAAS;IAEnB;;OAEG;IACH,WAAW,UAAU;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,MAAM;IACtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACrB;;OAEG;IACH,SAAS,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAExC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC/D,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACzC;;;OAGG;IAEH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;;OAIG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,qCAAqC,GAAG,IAAI,CACvD,yBAAyB,EACzB,UAAU,GAAG,aAAa,CAC1B,GAAG;IACH;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,+BAAgC,SAAQ,yBAAyB;IACjF,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,kCAAmC,SAAQ,yBAAyB;IACpF,iBAAiB,EAAE,MAAM,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY;IAC/E;;OAEG;IACH,OAAO,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,CAC3E,SAAQ,kBAAkB,CAAC,QAAQ,CAAC;IACpC;;;OAGG;IAEH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,IAC1E,kBAAkB,CAAC,QAAQ,CAAC,CAAC;AAE9B;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACvC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,uBAAuB,CAAC;CAIlC;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,eAAe,EAAE,gBAAgB,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,eAAe,EAAE,gBAAgB,CAAC;IAElC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC5B;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,oBAAY,aAAa;IACxB;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,iBAAiB,sBAAsB;IAEvC;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,kBAAkB,uBAAuB;CACzC"}
+{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../../src/protocol/protocol.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0CAA0C,CAAC;AAE7E;;GAEG;AACH,oBAAY,WAAW;IACtB;;;;;OAKG;IACH,IAAI,SAAS;IAEb;;OAEG;IACH,UAAU,SAAS;IAEnB;;OAEG;IACH,WAAW,UAAU;IAErB;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,UAAU,eAAe;IAEzB;;OAEG;IACH,WAAW,gBAAgB;IAE3B;;OAEG;IACH,SAAS,OAAO;IAEhB;;OAEG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,SAAS,iBAAiB;IAE1B;;OAEG;IACH,OAAO,YAAY;CACnB;AAED;;GAEG;AACH,oBAAY,UAAU;IACrB;;OAEG;IACH,UAAU,SAAS;IAEnB;;OAEG;IACH,WAAW,UAAU;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM;IACtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACrB;;OAEG;IACH,SAAS,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAExC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC/D,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACzC;;;OAGG;IAEH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;;OAIG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,qCAAqC,GAAG,IAAI,CACvD,yBAAyB,EACzB,UAAU,GAAG,aAAa,CAC1B,GAAG;IACH;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,+BAAgC,SAAQ,yBAAyB;IACjF,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,kCAAmC,SAAQ,yBAAyB;IACpF,iBAAiB,EAAE,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY;IAC/E;;OAEG;IACH,OAAO,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,CAC3E,SAAQ,kBAAkB,CAAC,QAAQ,CAAC;IACpC;;;OAGG;IAEH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,IAC1E,kBAAkB,CAAC,QAAQ,CAAC,CAAC;AAE9B;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,uBAAuB,CAAC;CAIlC;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,eAAe,EAAE,gBAAgB,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,eAAe,EAAE,gBAAgB,CAAC;IAElC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC5B;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,oBAAY,aAAa;IACxB;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,iBAAiB,sBAAsB;IAEvC;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,kBAAkB,uBAAuB;CACzC"}

dist/protocol/protocol.js

@@ -9,4 +9,3 @@ "use strict";
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -87,4 +86,3 @@ var MessageType;
  * Type of the nack.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -91,0 +89,0 @@ var NackErrorType;

dist/protocol/protocol.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../../src/protocol/protocol.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;;GAGG;AACH,IAAY,WAoEX;AApED,WAAY,WAAW;IACtB;;;;;OAKG;IACH,4BAAa,CAAA;IAEb;;OAEG;IACH,kCAAmB,CAAA;IAEnB;;OAEG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,kCAAmB,CAAA;IAEnB;;OAEG;IACH,gCAAiB,CAAA;IAEjB;;OAEG;IACH,gCAAiB,CAAA;IAEjB;;OAEG;IACH,sCAAuB,CAAA;IAEvB;;OAEG;IACH,wCAAyB,CAAA;IAEzB;;OAEG;IACH,0CAA2B,CAAA;IAE3B;;OAEG;IACH,+BAAgB,CAAA;IAEhB;;OAEG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,yCAA0B,CAAA;IAE1B;;OAEG;IACH,kCAAmB,CAAA;AACpB,CAAC,EApEW,WAAW,2BAAX,WAAW,QAoEtB;AAED;;GAEG;AACH,IAAY,UAUX;AAVD,WAAY,UAAU;IACrB;;OAEG;IACH,iCAAmB,CAAA;IAEnB;;OAEG;IACH,mCAAqB,CAAA;AACtB,CAAC,EAVW,UAAU,0BAAV,UAAU,QAUrB;AAicD;;;;GAIG;AACH,IAAY,aAoBX;AApBD,WAAY,aAAa;IACxB;;OAEG;IACH,oDAAmC,CAAA;IAEnC;;OAEG;IACH,wDAAuC,CAAA;IAEvC;;OAEG;IACH,oDAAmC,CAAA;IAEnC;;OAEG;IACH,0DAAyC,CAAA;AAC1C,CAAC,EApBW,aAAa,6BAAb,aAAa,QAoBxB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { TypedMessage } from \"@fluidframework/core-interfaces/internal\";\n\n/**\n * @legacy\n * @alpha\n */\nexport enum MessageType {\n\t/**\n\t * Empty operation message. Used to send an updated reference sequence number.\n\t * Relay service is free to coalesce these messages or fully drop them, if\n\t * another message was used to update MSN to a number equal or higher than referenced\n\t * sequence number in Noop.\n\t */\n\tNoOp = \"noop\",\n\n\t/**\n\t * System message sent to indicate a new client has joined the collaboration.\n\t */\n\tClientJoin = \"join\",\n\n\t/**\n\t * System message sent to indicate a client has left the collaboration.\n\t */\n\tClientLeave = \"leave\",\n\n\t/**\n\t * Proposes a new consensus value.\n\t */\n\tPropose = \"propose\",\n\n\t/**\n\t * Message used to reject a pending proposal.\n\t */\n\tReject = \"reject\",\n\n\t/**\n\t * Message sent by client accepting proposal\n\t */\n\tAccept = \"accept\",\n\n\t/**\n\t * Summary operation (message).\n\t */\n\tSummarize = \"summarize\",\n\n\t/**\n\t * Summary operation (message) written.\n\t */\n\tSummaryAck = \"summaryAck\",\n\n\t/**\n\t * Summary operation (message) write failure.\n\t */\n\tSummaryNack = \"summaryNack\",\n\n\t/**\n\t * Operation (message) produced by container runtime.\n\t */\n\tOperation = \"op\",\n\n\t/**\n\t * Message to indicate that no active clients are present.\n\t */\n\tNoClient = \"noClient\",\n\n\t/**\n\t * Message to indicate successful round trip.\n\t */\n\tRoundTrip = \"tripComplete\",\n\n\t/**\n\t * Service specific control messages that are never sequenced.\n\t */\n\tControl = \"control\",\n}\n\n/**\n * @internal\n */\nexport enum SignalType {\n\t/**\n\t * System signal sent to indicate a new client has joined the collaboration.\n\t */\n\tClientJoin = \"join\",\n\n\t/**\n\t * System signal sent to indicate a client has left the collaboration.\n\t */\n\tClientLeave = \"leave\",\n}\n\n/**\n * Messages to track latency trace.\n * @legacy\n * @alpha\n */\nexport interface ITrace {\n\t/**\n\t * Service generating the trace.\n\t */\n\tservice: string;\n\n\t/**\n\t * Denotes receiving/sending.\n\t */\n\taction: string;\n\n\t/**\n\t * Floating point time in milliseconds with up to nanosecond precision.\n\t */\n\ttimestamp: number;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface INack {\n\t/**\n\t * The operation that was just nacked.\n\t */\n\toperation: IDocumentMessage | undefined;\n\n\t/**\n\t * The sequence number the client needs to catch up to before retrying.\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * Detail info about the nack.\n\t */\n\tcontent: INackContent;\n}\n\n/**\n * Document-specific message.\n * @legacy\n * @alpha\n */\nexport interface IDocumentMessage {\n\t/**\n\t * The document's client sequence number.\n\t */\n\tclientSequenceNumber: number;\n\n\t/**\n\t * The reference sequence number the message was sent relative to.\n\t */\n\treferenceSequenceNumber: number;\n\n\t/**\n\t * The type of document message being sent.\n\t */\n\ttype: string;\n\n\t/**\n\t * The contents of the message.\n\t */\n\tcontents: unknown;\n\n\t/**\n\t * App provided metadata about the operation.\n\t */\n\tmetadata?: unknown;\n\n\t/**\n\t * Server provided metadata about the operation.\n\t */\n\tserverMetadata?: unknown;\n\n\t/**\n\t * Traces related to the packet.\n\t */\n\ttraces?: ITrace[];\n\n\t/**\n\t * The compression algorithm that was used to compress contents of this message.\n\t * @experimental Not ready for use\n\t */\n\tcompression?: string;\n}\n\n/**\n * Document Message with optional system level data field.\n * @internal\n */\nexport interface IDocumentSystemMessage extends IDocumentMessage {\n\tdata: string;\n}\n\n/**\n * Branch origin information.\n * @legacy\n * @alpha\n */\nexport interface IBranchOrigin {\n\t/**\n\t * Origin branch of the message.\n\t */\n\tid: string;\n\n\t/**\n\t * Sequence number for the message in branch ID.\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * Minimum sequence number for the message in branch ID.\n\t */\n\tminimumSequenceNumber: number;\n}\n\n/**\n * Sequenced message for a distributed document.\n * @legacy\n * @alpha\n */\nexport interface ISequencedDocumentMessage {\n\t/**\n\t * The client ID that submitted the message.\n\t * For server generated messages the clientId will be null;\n\t */\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tclientId: string | null;\n\n\t/**\n\t * The sequenced identifier.\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * The minimum sequence number for all connected clients.\n\t */\n\tminimumSequenceNumber: number;\n\n\t/**\n\t * The document's client sequence number.\n\t */\n\tclientSequenceNumber: number;\n\n\t/**\n\t * The reference sequence number the message was sent relative to.\n\t */\n\treferenceSequenceNumber: number;\n\n\t/**\n\t * The type of operation.\n\t */\n\ttype: string;\n\n\t/**\n\t * The contents of the message.\n\t */\n\tcontents: unknown;\n\n\t/**\n\t * App provided metadata about the operation.\n\t */\n\tmetadata?: unknown;\n\n\t/**\n\t * Server provided metadata about the operation.\n\t */\n\tserverMetadata?: unknown;\n\n\t/**\n\t * Origin branch information for the message.\n\t *\n\t * @remarks Can be marked undefined if the current message is also the origin.\n\t */\n\torigin?: IBranchOrigin;\n\n\t/**\n\t * Traces related to the packet.\n\t */\n\ttraces?: ITrace[];\n\n\t/**\n\t * Timestamp when the server ticketed the message.\n\t */\n\ttimestamp: number;\n\n\t/**\n\t * Data provided by service. Only present in service generated messages.\n\t */\n\tdata?: string;\n\n\t/**\n\t * Experimental field for storing the rolling hash at sequence number.\n\t *\n\t * @deprecated Use ISequencedDocumentMessageExperimental instead.\n\t */\n\texpHash1?: string;\n\n\t/**\n\t * The compression algorithm that was used to compress contents of this message.\n\t *\n\t * @deprecated Use ISequencedDocumentMessageExperimental instead.\n\t */\n\tcompression?: string;\n}\n\n/**\n * {@link ISequencedDocumentAugmentedMessage} with experimental properties.\n * @internal\n */\nexport type ISequencedDocumentMessageExperimental = Omit<\n\tISequencedDocumentMessage,\n\t\"expHash1\" | \"compression\"\n> & {\n\t/**\n\t * Stores the rolling hash at sequence number.\n\t */\n\texpHash1?: string;\n\n\t/**\n\t * The compression algorithm that was used to compress contents of this message.\n\t */\n\tcompression?: string;\n};\n\n/**\n * @internal\n */\nexport interface ISequencedDocumentSystemMessage extends ISequencedDocumentMessage {\n\tdata: string;\n}\n\n/**\n * @internal\n */\nexport interface ISequencedDocumentAugmentedMessage extends ISequencedDocumentMessage {\n\tadditionalContent: string;\n}\n\n/**\n * Common interface between incoming and outgoing signals.\n * @legacy\n * @alpha\n */\nexport interface ISignalMessageBase<TMessage extends TypedMessage = TypedMessage> {\n\t/**\n\t * Signal content\n\t */\n\tcontent: TMessage[\"content\"];\n\n\t/**\n\t * Signal type\n\t */\n\ttype?: TMessage[\"type\"];\n\n\t/**\n\t * Counts the number of signals sent by the sending client.\n\t */\n\tclientConnectionNumber?: number;\n\n\t/**\n\t * Sequence number that indicates when the signal was created in relation to the delta stream\n\t */\n\treferenceSequenceNumber?: number;\n\n\t/**\n\t * Client ID of the singular client the signal is being (or has been) sent to.\n\t * May only be specified when IConnect.supportedFeatures['submit_signals_v2'] is true, will throw otherwise.\n\t */\n\ttargetClientId?: string;\n}\n\n/**\n * Interface for signals sent by the server to clients.\n * @legacy\n * @alpha\n */\nexport interface ISignalMessage<TMessage extends TypedMessage = TypedMessage>\n\textends ISignalMessageBase<TMessage> {\n\t/**\n\t * The client ID that submitted the message.\n\t * For server generated messages the clientId will be null.\n\t */\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tclientId: string | null;\n}\n\n/**\n * Interface for signals sent by clients to the server.\n * @internal\n */\nexport type ISentSignalMessage<TMessage extends TypedMessage = TypedMessage> =\n\tISignalMessageBase<TMessage>;\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IUploadedSummaryDetails {\n\t/**\n\t * Indicates whether the uploaded summary contains \".protocol\" tree.\n\t */\n\tincludesProtocolTree?: boolean;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface ISummaryContent {\n\t/**\n\t * Handle reference to the summary data.\n\t */\n\thandle: string;\n\n\t/**\n\t * Message included as part of the summary.\n\t */\n\tmessage: string;\n\n\t/**\n\t * Handles to parent summaries of the proposed new summary.\n\t */\n\tparents: string[];\n\n\t/**\n\t * Handle to the current latest summary stored by the service\n\t */\n\thead: string;\n\n\t/**\n\t * Details of the uploaded summary.\n\t */\n\tdetails?: IUploadedSummaryDetails;\n\n\t// TODO - need an epoch/reload bit to indicate to clients that the summary has changed and requires a reload\n\t// This could be encoded in the summary itself as well but then would require the client to download it to check\n}\n\n/**\n * General errors returned from the server.\n * May want to add error code or something similar in the future.\n * @internal\n */\nexport interface IServerError {\n\t/**\n\t * Message describing the server error.\n\t */\n\terrorMessage: string;\n}\n\n/**\n * Data about the original proposed summary message.\n * @legacy\n * @alpha\n */\nexport interface ISummaryProposal {\n\t/**\n\t * Actual sequence number of the summary message proposal.\n\t */\n\tsummarySequenceNumber: number;\n}\n\n/**\n * Contents of summary ack expected from the server.\n * @legacy\n * @alpha\n */\nexport interface ISummaryAck {\n\t/**\n\t * Handle of the complete summary.\n\t */\n\thandle: string;\n\n\t/**\n\t * Information about the proposed summary message.\n\t */\n\tsummaryProposal: ISummaryProposal;\n}\n\n/**\n * Contents of summary nack expected from the server.\n * @legacy\n * @alpha\n */\nexport interface ISummaryNack {\n\t/**\n\t * Information about the proposed summary message.\n\t */\n\tsummaryProposal: ISummaryProposal;\n\n\t/**\n\t * An error code number that represents the error. It will be a valid HTTP error code.\n\t * 403 errors are non retriable.\n\t * 400 errors are always immediately retriable.\n\t * 429 errors are retriable or non retriable (depends on type field).\n\t */\n\tcode?: number;\n\n\t/**\n\t * A message about the error for debugging/logging/telemetry purposes\n\t */\n\tmessage?: string;\n\n\t/**\n\t * Optional Retry-After time in seconds.\n\t * If specified, the client should wait this many seconds before retrying.8\n\t */\n\tretryAfter?: number;\n}\n\n/**\n * Interface for nack content.\n * @legacy\n * @alpha\n */\nexport interface INackContent {\n\t/**\n\t * An error code number that represents the error. It will be a valid HTTP error code.\n\t * 403 errors are non retriable and client should acquire a new identity before reconnection.\n\t * 400 errors are always immediately retriable\n\t * 429 errors are retriable or non retriable (depends on type field).\n\t */\n\tcode: number;\n\n\t/**\n\t * Type of the Nack.\n\t */\n\ttype: NackErrorType;\n\n\t/**\n\t * A message about the nack for debugging/logging/telemetry purposes\n\t */\n\tmessage: string;\n\n\t/**\n\t * Optional Retry-After time in seconds\n\t * If specified, the client should wait this many seconds before retrying\n\t */\n\tretryAfter?: number;\n}\n\n/**\n * Type of the nack.\n * @legacy\n * @alpha\n */\nexport enum NackErrorType {\n\t/**\n\t * Retriable after {@link ISummaryNack.retryAfter} seconds.\n\t */\n\tThrottlingError = \"ThrottlingError\",\n\n\t/**\n\t * Client's token is not valid for the intended message.\n\t */\n\tInvalidScopeError = \"InvalidScopeError\",\n\n\t/**\n\t * Clients message is invalid and should retry immediately with a valid message.\n\t */\n\tBadRequestError = \"BadRequestError\",\n\n\t/**\n\t * Service is having issues. Client should not retry.\n\t */\n\tLimitExceededError = \"LimitExceededError\",\n}\n"]}
+{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../../src/protocol/protocol.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;GAEG;AACH,IAAY,WAoEX;AApED,WAAY,WAAW;IACtB;;;;;OAKG;IACH,4BAAa,CAAA;IAEb;;OAEG;IACH,kCAAmB,CAAA;IAEnB;;OAEG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,kCAAmB,CAAA;IAEnB;;OAEG;IACH,gCAAiB,CAAA;IAEjB;;OAEG;IACH,gCAAiB,CAAA;IAEjB;;OAEG;IACH,sCAAuB,CAAA;IAEvB;;OAEG;IACH,wCAAyB,CAAA;IAEzB;;OAEG;IACH,0CAA2B,CAAA;IAE3B;;OAEG;IACH,+BAAgB,CAAA;IAEhB;;OAEG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,yCAA0B,CAAA;IAE1B;;OAEG;IACH,kCAAmB,CAAA;AACpB,CAAC,EApEW,WAAW,2BAAX,WAAW,QAoEtB;AAED;;GAEG;AACH,IAAY,UAUX;AAVD,WAAY,UAAU;IACrB;;OAEG;IACH,iCAAmB,CAAA;IAEnB;;OAEG;IACH,mCAAqB,CAAA;AACtB,CAAC,EAVW,UAAU,0BAAV,UAAU,QAUrB;AAobD;;;GAGG;AACH,IAAY,aAoBX;AApBD,WAAY,aAAa;IACxB;;OAEG;IACH,oDAAmC,CAAA;IAEnC;;OAEG;IACH,wDAAuC,CAAA;IAEvC;;OAEG;IACH,oDAAmC,CAAA;IAEnC;;OAEG;IACH,0DAAyC,CAAA;AAC1C,CAAC,EApBW,aAAa,6BAAb,aAAa,QAoBxB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { TypedMessage } from \"@fluidframework/core-interfaces/internal\";\n\n/**\n * @legacy @beta\n */\nexport enum MessageType {\n\t/**\n\t * Empty operation message. Used to send an updated reference sequence number.\n\t * Relay service is free to coalesce these messages or fully drop them, if\n\t * another message was used to update MSN to a number equal or higher than referenced\n\t * sequence number in Noop.\n\t */\n\tNoOp = \"noop\",\n\n\t/**\n\t * System message sent to indicate a new client has joined the collaboration.\n\t */\n\tClientJoin = \"join\",\n\n\t/**\n\t * System message sent to indicate a client has left the collaboration.\n\t */\n\tClientLeave = \"leave\",\n\n\t/**\n\t * Proposes a new consensus value.\n\t */\n\tPropose = \"propose\",\n\n\t/**\n\t * Message used to reject a pending proposal.\n\t */\n\tReject = \"reject\",\n\n\t/**\n\t * Message sent by client accepting proposal\n\t */\n\tAccept = \"accept\",\n\n\t/**\n\t * Summary operation (message).\n\t */\n\tSummarize = \"summarize\",\n\n\t/**\n\t * Summary operation (message) written.\n\t */\n\tSummaryAck = \"summaryAck\",\n\n\t/**\n\t * Summary operation (message) write failure.\n\t */\n\tSummaryNack = \"summaryNack\",\n\n\t/**\n\t * Operation (message) produced by container runtime.\n\t */\n\tOperation = \"op\",\n\n\t/**\n\t * Message to indicate that no active clients are present.\n\t */\n\tNoClient = \"noClient\",\n\n\t/**\n\t * Message to indicate successful round trip.\n\t */\n\tRoundTrip = \"tripComplete\",\n\n\t/**\n\t * Service specific control messages that are never sequenced.\n\t */\n\tControl = \"control\",\n}\n\n/**\n * @internal\n */\nexport enum SignalType {\n\t/**\n\t * System signal sent to indicate a new client has joined the collaboration.\n\t */\n\tClientJoin = \"join\",\n\n\t/**\n\t * System signal sent to indicate a client has left the collaboration.\n\t */\n\tClientLeave = \"leave\",\n}\n\n/**\n * Messages to track latency trace.\n * @legacy @beta\n */\nexport interface ITrace {\n\t/**\n\t * Service generating the trace.\n\t */\n\tservice: string;\n\n\t/**\n\t * Denotes receiving/sending.\n\t */\n\taction: string;\n\n\t/**\n\t * Floating point time in milliseconds with up to nanosecond precision.\n\t */\n\ttimestamp: number;\n}\n\n/**\n * @legacy @beta\n */\nexport interface INack {\n\t/**\n\t * The operation that was just nacked.\n\t */\n\toperation: IDocumentMessage | undefined;\n\n\t/**\n\t * The sequence number the client needs to catch up to before retrying.\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * Detail info about the nack.\n\t */\n\tcontent: INackContent;\n}\n\n/**\n * Document-specific message.\n * @legacy @beta\n */\nexport interface IDocumentMessage {\n\t/**\n\t * The document's client sequence number.\n\t */\n\tclientSequenceNumber: number;\n\n\t/**\n\t * The reference sequence number the message was sent relative to.\n\t */\n\treferenceSequenceNumber: number;\n\n\t/**\n\t * The type of document message being sent.\n\t */\n\ttype: string;\n\n\t/**\n\t * The contents of the message.\n\t */\n\tcontents: unknown;\n\n\t/**\n\t * App provided metadata about the operation.\n\t */\n\tmetadata?: unknown;\n\n\t/**\n\t * Server provided metadata about the operation.\n\t */\n\tserverMetadata?: unknown;\n\n\t/**\n\t * Traces related to the packet.\n\t */\n\ttraces?: ITrace[];\n\n\t/**\n\t * The compression algorithm that was used to compress contents of this message.\n\t * @experimental Not ready for use\n\t */\n\tcompression?: string;\n}\n\n/**\n * Document Message with optional system level data field.\n * @internal\n */\nexport interface IDocumentSystemMessage extends IDocumentMessage {\n\tdata: string;\n}\n\n/**\n * Branch origin information.\n * @legacy @beta\n */\nexport interface IBranchOrigin {\n\t/**\n\t * Origin branch of the message.\n\t */\n\tid: string;\n\n\t/**\n\t * Sequence number for the message in branch ID.\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * Minimum sequence number for the message in branch ID.\n\t */\n\tminimumSequenceNumber: number;\n}\n\n/**\n * Sequenced message for a distributed document.\n * @legacy @beta\n */\nexport interface ISequencedDocumentMessage {\n\t/**\n\t * The client ID that submitted the message.\n\t * For server generated messages the clientId will be null;\n\t */\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tclientId: string | null;\n\n\t/**\n\t * The sequenced identifier.\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * The minimum sequence number for all connected clients.\n\t */\n\tminimumSequenceNumber: number;\n\n\t/**\n\t * The document's client sequence number.\n\t */\n\tclientSequenceNumber: number;\n\n\t/**\n\t * The reference sequence number the message was sent relative to.\n\t */\n\treferenceSequenceNumber: number;\n\n\t/**\n\t * The type of operation.\n\t */\n\ttype: string;\n\n\t/**\n\t * The contents of the message.\n\t */\n\tcontents: unknown;\n\n\t/**\n\t * App provided metadata about the operation.\n\t */\n\tmetadata?: unknown;\n\n\t/**\n\t * Server provided metadata about the operation.\n\t */\n\tserverMetadata?: unknown;\n\n\t/**\n\t * Origin branch information for the message.\n\t *\n\t * @remarks Can be marked undefined if the current message is also the origin.\n\t */\n\torigin?: IBranchOrigin;\n\n\t/**\n\t * Traces related to the packet.\n\t */\n\ttraces?: ITrace[];\n\n\t/**\n\t * Timestamp when the server ticketed the message.\n\t */\n\ttimestamp: number;\n\n\t/**\n\t * Data provided by service. Only present in service generated messages.\n\t */\n\tdata?: string;\n\n\t/**\n\t * Experimental field for storing the rolling hash at sequence number.\n\t *\n\t * @deprecated Use ISequencedDocumentMessageExperimental instead.\n\t */\n\texpHash1?: string;\n\n\t/**\n\t * The compression algorithm that was used to compress contents of this message.\n\t *\n\t * @deprecated Use ISequencedDocumentMessageExperimental instead.\n\t */\n\tcompression?: string;\n}\n\n/**\n * {@link ISequencedDocumentAugmentedMessage} with experimental properties.\n * @internal\n */\nexport type ISequencedDocumentMessageExperimental = Omit<\n\tISequencedDocumentMessage,\n\t\"expHash1\" | \"compression\"\n> & {\n\t/**\n\t * Stores the rolling hash at sequence number.\n\t */\n\texpHash1?: string;\n\n\t/**\n\t * The compression algorithm that was used to compress contents of this message.\n\t */\n\tcompression?: string;\n};\n\n/**\n * @internal\n */\nexport interface ISequencedDocumentSystemMessage extends ISequencedDocumentMessage {\n\tdata: string;\n}\n\n/**\n * @internal\n */\nexport interface ISequencedDocumentAugmentedMessage extends ISequencedDocumentMessage {\n\tadditionalContent: string;\n}\n\n/**\n * Common interface between incoming and outgoing signals.\n * @legacy @beta\n */\nexport interface ISignalMessageBase<TMessage extends TypedMessage = TypedMessage> {\n\t/**\n\t * Signal content\n\t */\n\tcontent: TMessage[\"content\"];\n\n\t/**\n\t * Signal type\n\t */\n\ttype?: TMessage[\"type\"];\n\n\t/**\n\t * Counts the number of signals sent by the sending client.\n\t */\n\tclientConnectionNumber?: number;\n\n\t/**\n\t * Sequence number that indicates when the signal was created in relation to the delta stream\n\t */\n\treferenceSequenceNumber?: number;\n\n\t/**\n\t * Client ID of the singular client the signal is being (or has been) sent to.\n\t * May only be specified when IConnect.supportedFeatures['submit_signals_v2'] is true, will throw otherwise.\n\t */\n\ttargetClientId?: string;\n}\n\n/**\n * Interface for signals sent by the server to clients.\n * @legacy @beta\n */\nexport interface ISignalMessage<TMessage extends TypedMessage = TypedMessage>\n\textends ISignalMessageBase<TMessage> {\n\t/**\n\t * The client ID that submitted the message.\n\t * For server generated messages the clientId will be null.\n\t */\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tclientId: string | null;\n}\n\n/**\n * Interface for signals sent by clients to the server.\n * @internal\n */\nexport type ISentSignalMessage<TMessage extends TypedMessage = TypedMessage> =\n\tISignalMessageBase<TMessage>;\n\n/**\n * @legacy @beta\n */\nexport interface IUploadedSummaryDetails {\n\t/**\n\t * Indicates whether the uploaded summary contains \".protocol\" tree.\n\t */\n\tincludesProtocolTree?: boolean;\n}\n\n/**\n * @legacy @beta\n */\nexport interface ISummaryContent {\n\t/**\n\t * Handle reference to the summary data.\n\t */\n\thandle: string;\n\n\t/**\n\t * Message included as part of the summary.\n\t */\n\tmessage: string;\n\n\t/**\n\t * Handles to parent summaries of the proposed new summary.\n\t */\n\tparents: string[];\n\n\t/**\n\t * Handle to the current latest summary stored by the service\n\t */\n\thead: string;\n\n\t/**\n\t * Details of the uploaded summary.\n\t */\n\tdetails?: IUploadedSummaryDetails;\n\n\t// TODO - need an epoch/reload bit to indicate to clients that the summary has changed and requires a reload\n\t// This could be encoded in the summary itself as well but then would require the client to download it to check\n}\n\n/**\n * General errors returned from the server.\n * May want to add error code or something similar in the future.\n * @internal\n */\nexport interface IServerError {\n\t/**\n\t * Message describing the server error.\n\t */\n\terrorMessage: string;\n}\n\n/**\n * Data about the original proposed summary message.\n * @legacy @beta\n */\nexport interface ISummaryProposal {\n\t/**\n\t * Actual sequence number of the summary message proposal.\n\t */\n\tsummarySequenceNumber: number;\n}\n\n/**\n * Contents of summary ack expected from the server.\n * @legacy @beta\n */\nexport interface ISummaryAck {\n\t/**\n\t * Handle of the complete summary.\n\t */\n\thandle: string;\n\n\t/**\n\t * Information about the proposed summary message.\n\t */\n\tsummaryProposal: ISummaryProposal;\n}\n\n/**\n * Contents of summary nack expected from the server.\n * @legacy @beta\n */\nexport interface ISummaryNack {\n\t/**\n\t * Information about the proposed summary message.\n\t */\n\tsummaryProposal: ISummaryProposal;\n\n\t/**\n\t * An error code number that represents the error. It will be a valid HTTP error code.\n\t * 403 errors are non retriable.\n\t * 400 errors are always immediately retriable.\n\t * 429 errors are retriable or non retriable (depends on type field).\n\t */\n\tcode?: number;\n\n\t/**\n\t * A message about the error for debugging/logging/telemetry purposes\n\t */\n\tmessage?: string;\n\n\t/**\n\t * Optional Retry-After time in seconds.\n\t * If specified, the client should wait this many seconds before retrying.8\n\t */\n\tretryAfter?: number;\n}\n\n/**\n * Interface for nack content.\n * @legacy @beta\n */\nexport interface INackContent {\n\t/**\n\t * An error code number that represents the error. It will be a valid HTTP error code.\n\t * 403 errors are non retriable and client should acquire a new identity before reconnection.\n\t * 400 errors are always immediately retriable\n\t * 429 errors are retriable or non retriable (depends on type field).\n\t */\n\tcode: number;\n\n\t/**\n\t * Type of the Nack.\n\t */\n\ttype: NackErrorType;\n\n\t/**\n\t * A message about the nack for debugging/logging/telemetry purposes\n\t */\n\tmessage: string;\n\n\t/**\n\t * Optional Retry-After time in seconds\n\t * If specified, the client should wait this many seconds before retrying\n\t */\n\tretryAfter?: number;\n}\n\n/**\n * Type of the nack.\n * @legacy @beta\n */\nexport enum NackErrorType {\n\t/**\n\t * Retriable after {@link ISummaryNack.retryAfter} seconds.\n\t */\n\tThrottlingError = \"ThrottlingError\",\n\n\t/**\n\t * Client's token is not valid for the intended message.\n\t */\n\tInvalidScopeError = \"InvalidScopeError\",\n\n\t/**\n\t * Clients message is invalid and should retry immediately with a valid message.\n\t */\n\tBadRequestError = \"BadRequestError\",\n\n\t/**\n\t * Service is having issues. Client should not retry.\n\t */\n\tLimitExceededError = \"LimitExceededError\",\n}\n"]}

dist/protocol/scopes.d.ts

@@ -7,4 +7,3 @@ /*!
  * Defines scope access for a Container/Document.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -11,0 +10,0 @@ export declare enum ScopeType {

dist/protocol/scopes.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"scopes.d.ts","sourceRoot":"","sources":["../../src/protocol/scopes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AACH,oBAAY,SAAS;IACpB;;OAEG;IACH,OAAO,aAAa;IAEpB;;OAEG;IACH,QAAQ,cAAc;IAEtB;;OAEG;IACH,YAAY,kBAAkB;CAC9B"}
+{"version":3,"file":"scopes.d.ts","sourceRoot":"","sources":["../../src/protocol/scopes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AACH,oBAAY,SAAS;IACpB;;OAEG;IACH,OAAO,aAAa;IAEpB;;OAEG;IACH,QAAQ,cAAc;IAEtB;;OAEG;IACH,YAAY,kBAAkB;CAC9B"}

dist/protocol/scopes.js

@@ -10,4 +10,3 @@ "use strict";
  * Defines scope access for a Container/Document.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -14,0 +13,0 @@ var ScopeType;

dist/protocol/scopes.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"scopes.js","sourceRoot":"","sources":["../../src/protocol/scopes.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;;;GAIG;AACH,IAAY,SAeX;AAfD,WAAY,SAAS;IACpB;;OAEG;IACH,iCAAoB,CAAA;IAEpB;;OAEG;IACH,mCAAsB,CAAA;IAEtB;;OAEG;IACH,2CAA8B,CAAA;AAC/B,CAAC,EAfW,SAAS,yBAAT,SAAS,QAepB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Defines scope access for a Container/Document.\n * @legacy\n * @alpha\n */\nexport enum ScopeType {\n\t/**\n\t * Read access is supported on the Container/Document\n\t */\n\tDocRead = \"doc:read\",\n\n\t/**\n\t * Write access is supported on the Container/Document\n\t */\n\tDocWrite = \"doc:write\",\n\n\t/**\n\t * User can generate new summaries operations\n\t */\n\tSummaryWrite = \"summary:write\",\n}\n"]}
+{"version":3,"file":"scopes.js","sourceRoot":"","sources":["../../src/protocol/scopes.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;;GAGG;AACH,IAAY,SAeX;AAfD,WAAY,SAAS;IACpB;;OAEG;IACH,iCAAoB,CAAA;IAEpB;;OAEG;IACH,mCAAsB,CAAA;IAEtB;;OAEG;IACH,2CAA8B,CAAA;AAC/B,CAAC,EAfW,SAAS,yBAAT,SAAS,QAepB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Defines scope access for a Container/Document.\n * @legacy @beta\n */\nexport enum ScopeType {\n\t/**\n\t * Read access is supported on the Container/Document\n\t */\n\tDocRead = \"doc:read\",\n\n\t/**\n\t * Write access is supported on the Container/Document\n\t */\n\tDocWrite = \"doc:write\",\n\n\t/**\n\t * User can generate new summaries operations\n\t */\n\tSummaryWrite = \"summary:write\",\n}\n"]}

dist/protocol/sockets.d.ts

@@ -11,4 +11,3 @@ /*!
  * Message sent to connect to the given document.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -69,4 +68,3 @@ export interface IConnect {
  * Message sent to indicate a client has connected to the server.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -73,0 +71,0 @@ export interface IConnected {

dist/protocol/sockets.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"sockets.d.ts","sourceRoot":"","sources":["../../src/protocol/sockets.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,KAAK,EAAE,yBAAyB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEhD;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACxB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IAGH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;IAEnB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE5C;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IAC1B;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,eAAe,EAAE,yBAAyB,EAAE,CAAC;IAE7C;;OAEG;IACH,cAAc,EAAE,cAAc,EAAE,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,aAAa,EAAE,CAAC;IAEhC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACH,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE5C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC3B"}
+{"version":3,"file":"sockets.d.ts","sourceRoot":"","sources":["../../src/protocol/sockets.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,KAAK,EAAE,yBAAyB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEhD;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACxB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IAGH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;IAEnB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE5C;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IAC1B;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,eAAe,EAAE,yBAAyB,EAAE,CAAC;IAE7C;;OAEG;IACH,cAAc,EAAE,cAAc,EAAE,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,aAAa,EAAE,CAAC;IAEhC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACH,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE5C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC3B"}

dist/protocol/sockets.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"sockets.js","sourceRoot":"","sources":["../../src/protocol/sockets.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ConnectionMode, IClient, ISignalClient } from \"./clients.js\";\nimport type { IClientConfiguration } from \"./config.js\";\nimport type { ISequencedDocumentMessage, ISignalMessage } from \"./protocol.js\";\nimport type { ITokenClaims } from \"./tokens.js\";\n\n/**\n * Message sent to connect to the given document.\n * @legacy\n * @alpha\n */\nexport interface IConnect {\n\t/**\n\t * The tenant ID for the document.\n\t */\n\ttenantId: string;\n\n\t/**\n\t * The document that is being connected to\n\t */\n\tid: string;\n\n\t/**\n\t * Authorization token\n\t */\n\t// TODO: Update this to use undefined instead of null.\n\t// eslint-disable-next-line @rushstack/no-new-null\n\ttoken: string | null;\n\n\t/**\n\t * Type of the client trying to connect\n\t */\n\tclient: IClient;\n\n\t/**\n\t * Semver list of protocol versions supported by the client ordered in priority of use\n\t */\n\tversions: string[];\n\n\t/**\n\t * Version of the driver which is connecting. It can be used at server to record in telemetry or\n\t * to block/allow specific driver version for specific features.\n\t */\n\tdriverVersion?: string;\n\n\t/**\n\t * Connection mode of client.\n\t */\n\tmode: ConnectionMode;\n\n\t/**\n\t * An optional nonce used during connection to identify connection attempts\n\t */\n\tnonce?: string;\n\n\t/**\n\t * Represents the version of document at client. It should match the version on server\n\t * for connection to be successful.\n\t */\n\tepoch?: string;\n\n\t/**\n\t * A list of optional features that client supports.\n\t * Features supported might be service specific.\n\t * If we have standardized features across all services, they need to be exposed in more structured way.\n\t */\n\tsupportedFeatures?: Record<string, unknown>;\n\n\t/**\n\t * Properties that client can send to server to tell info about client environment. These are a bunch of properties\n\t * separated by \";\" which server can log to better understand client environment etc.\n\t * Format: \"prop1:val1;prop2:val2;prop3:val3\"\n\t */\n\trelayUserAgent?: string;\n}\n\n/**\n * Message sent to indicate a client has connected to the server.\n * @legacy\n * @alpha\n */\nexport interface IConnected {\n\t/**\n\t * Claims for the client\n\t */\n\tclaims: ITokenClaims;\n\n\t/**\n\t * The client who is sending the message\n\t */\n\tclientId: string;\n\n\t/**\n\t * Whether or not this is an existing document\n\t */\n\texisting: boolean;\n\n\t/**\n\t * Maximum size of a message before chunking is required\n\t */\n\tmaxMessageSize: number;\n\n\t/**\n\t * Messages sent during the connection\n\t */\n\tinitialMessages: ISequencedDocumentMessage[];\n\n\t/**\n\t * Signals sent during the connection\n\t */\n\tinitialSignals: ISignalMessage[];\n\n\t/**\n\t * Prior clients already connected.\n\t */\n\tinitialClients: ISignalClient[];\n\n\t/**\n\t * Protocol version selected by the server to communicate with the client\n\t */\n\tversion: string;\n\n\t/**\n\t * List of protocol versions supported by the server\n\t */\n\tsupportedVersions: string[];\n\n\t/**\n\t * Configuration details provided by the service\n\t */\n\tserviceConfiguration: IClientConfiguration;\n\n\t/**\n\t * Connection mode of client.\n\t */\n\tmode: ConnectionMode;\n\n\t/**\n\t * An optional nonce used during connection to identify connection attempts\n\t */\n\tnonce?: string;\n\n\t/**\n\t * Last known sequence number to ordering service at the time of connection\n\t * It may lap actual last sequence number (quite a bit, if container  is very active).\n\t * But it's best information for client to figure out how far it is behind, at least\n\t * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n\t * that is likely to be more up-to-date.\n\t */\n\tcheckpointSequenceNumber?: number;\n\n\t/**\n\t * Represents the version of document at server.\n\t */\n\tepoch?: string;\n\n\t/**\n\t * A list of optional features that ordering service supports.\n\t * Features supported might be service specific.\n\t * If we have standardized features across all services, they need to be exposed in more structured way.\n\t */\n\tsupportedFeatures?: Record<string, unknown>;\n\n\t/**\n\t * The time the client connected\n\t */\n\ttimestamp?: number;\n\n\t/**\n\t * Properties that server can send to client to tell info about node that client is connected to. For ex, for spo\n\t * it could contain info like build version, environment, region etc. These properties can be logged by client\n\t * to better understand server environment etc. and use it in case error occurs.\n\t * Format: \"prop1:val1;prop2:val2;prop3:val3\"\n\t */\n\trelayServiceAgent?: string;\n}\n"]}
+{"version":3,"file":"sockets.js","sourceRoot":"","sources":["../../src/protocol/sockets.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ConnectionMode, IClient, ISignalClient } from \"./clients.js\";\nimport type { IClientConfiguration } from \"./config.js\";\nimport type { ISequencedDocumentMessage, ISignalMessage } from \"./protocol.js\";\nimport type { ITokenClaims } from \"./tokens.js\";\n\n/**\n * Message sent to connect to the given document.\n * @legacy @beta\n */\nexport interface IConnect {\n\t/**\n\t * The tenant ID for the document.\n\t */\n\ttenantId: string;\n\n\t/**\n\t * The document that is being connected to\n\t */\n\tid: string;\n\n\t/**\n\t * Authorization token\n\t */\n\t// TODO: Update this to use undefined instead of null.\n\t// eslint-disable-next-line @rushstack/no-new-null\n\ttoken: string | null;\n\n\t/**\n\t * Type of the client trying to connect\n\t */\n\tclient: IClient;\n\n\t/**\n\t * Semver list of protocol versions supported by the client ordered in priority of use\n\t */\n\tversions: string[];\n\n\t/**\n\t * Version of the driver which is connecting. It can be used at server to record in telemetry or\n\t * to block/allow specific driver version for specific features.\n\t */\n\tdriverVersion?: string;\n\n\t/**\n\t * Connection mode of client.\n\t */\n\tmode: ConnectionMode;\n\n\t/**\n\t * An optional nonce used during connection to identify connection attempts\n\t */\n\tnonce?: string;\n\n\t/**\n\t * Represents the version of document at client. It should match the version on server\n\t * for connection to be successful.\n\t */\n\tepoch?: string;\n\n\t/**\n\t * A list of optional features that client supports.\n\t * Features supported might be service specific.\n\t * If we have standardized features across all services, they need to be exposed in more structured way.\n\t */\n\tsupportedFeatures?: Record<string, unknown>;\n\n\t/**\n\t * Properties that client can send to server to tell info about client environment. These are a bunch of properties\n\t * separated by \";\" which server can log to better understand client environment etc.\n\t * Format: \"prop1:val1;prop2:val2;prop3:val3\"\n\t */\n\trelayUserAgent?: string;\n}\n\n/**\n * Message sent to indicate a client has connected to the server.\n * @legacy @beta\n */\nexport interface IConnected {\n\t/**\n\t * Claims for the client\n\t */\n\tclaims: ITokenClaims;\n\n\t/**\n\t * The client who is sending the message\n\t */\n\tclientId: string;\n\n\t/**\n\t * Whether or not this is an existing document\n\t */\n\texisting: boolean;\n\n\t/**\n\t * Maximum size of a message before chunking is required\n\t */\n\tmaxMessageSize: number;\n\n\t/**\n\t * Messages sent during the connection\n\t */\n\tinitialMessages: ISequencedDocumentMessage[];\n\n\t/**\n\t * Signals sent during the connection\n\t */\n\tinitialSignals: ISignalMessage[];\n\n\t/**\n\t * Prior clients already connected.\n\t */\n\tinitialClients: ISignalClient[];\n\n\t/**\n\t * Protocol version selected by the server to communicate with the client\n\t */\n\tversion: string;\n\n\t/**\n\t * List of protocol versions supported by the server\n\t */\n\tsupportedVersions: string[];\n\n\t/**\n\t * Configuration details provided by the service\n\t */\n\tserviceConfiguration: IClientConfiguration;\n\n\t/**\n\t * Connection mode of client.\n\t */\n\tmode: ConnectionMode;\n\n\t/**\n\t * An optional nonce used during connection to identify connection attempts\n\t */\n\tnonce?: string;\n\n\t/**\n\t * Last known sequence number to ordering service at the time of connection\n\t * It may lap actual last sequence number (quite a bit, if container  is very active).\n\t * But it's best information for client to figure out how far it is behind, at least\n\t * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n\t * that is likely to be more up-to-date.\n\t */\n\tcheckpointSequenceNumber?: number;\n\n\t/**\n\t * Represents the version of document at server.\n\t */\n\tepoch?: string;\n\n\t/**\n\t * A list of optional features that ordering service supports.\n\t * Features supported might be service specific.\n\t * If we have standardized features across all services, they need to be exposed in more structured way.\n\t */\n\tsupportedFeatures?: Record<string, unknown>;\n\n\t/**\n\t * The time the client connected\n\t */\n\ttimestamp?: number;\n\n\t/**\n\t * Properties that server can send to client to tell info about node that client is connected to. For ex, for spo\n\t * it could contain info like build version, environment, region etc. These properties can be logged by client\n\t * to better understand server environment etc. and use it in case error occurs.\n\t * Format: \"prop1:val1;prop2:val2;prop3:val3\"\n\t */\n\trelayServiceAgent?: string;\n}\n"]}

dist/protocol/storage.d.ts

@@ -7,4 +7,3 @@ /*!
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -22,4 +21,3 @@ export interface IDocumentAttributes {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -34,4 +32,3 @@ export declare enum FileMode {
  * Raw blob stored within the tree.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -49,4 +46,3 @@ export interface IBlob {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -57,4 +53,3 @@ export interface IAttachment {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -66,4 +61,3 @@ export interface ICreateBlobResponse {
  * A tree entry wraps a path with a type of node.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -92,4 +86,3 @@ export type ITreeEntry = {
  * Type of entries that can be stored in a tree.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -102,4 +95,3 @@ export declare enum TreeEntry {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -126,4 +118,3 @@ export interface ITree {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -161,4 +152,3 @@ export interface ISnapshotTree {
  * Represents a version of the snapshot of a data store.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -165,0 +155,0 @@ export interface IVersion {

dist/protocol/storage.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../src/protocol/storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,oBAAY,QAAQ;IACnB,IAAI,WAAW;IACf,UAAU,WAAW;IACrB,SAAS,WAAW;IACpB,OAAO,WAAW;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,KAAK;IACrB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IAEH,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B,EAAE,EAAE,MAAM,CAAC;CACX;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,EAAE,EAAE,MAAM,CAAC;CACX;AAED;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,IAAI,EAAE,QAAQ,CAAC;CACf,GAAG,CACD;IACA,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC;CACZ,GACD;IACA,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC;CACZ,GACD;IACA,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC;IAC3B,KAAK,EAAE,WAAW,CAAC;CAClB,CACH,CAAC;AAEF;;;;GAIG;AACH,oBAAY,SAAS;IACpB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,UAAU,eAAe;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACrB,OAAO,EAAE,UAAU,EAAE,CAAC;IAEtB;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC;IAEpB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAClC,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAAA;KAAE,CAAC;IAEzC;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC;IAEpB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,aAAa;IACrD,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,CAAA;KAAE,CAAC;CAC3C;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CACf"}
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../src/protocol/storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,mBAAmB;IACnC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,oBAAY,QAAQ;IACnB,IAAI,WAAW;IACf,UAAU,WAAW;IACrB,SAAS,WAAW;IACpB,OAAO,WAAW;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACrB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IAEH,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B,EAAE,EAAE,MAAM,CAAC;CACX;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IACnC,EAAE,EAAE,MAAM,CAAC;CACX;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,IAAI,EAAE,QAAQ,CAAC;CACf,GAAG,CACD;IACA,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC;CACZ,GACD;IACA,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC;CACZ,GACD;IACA,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC;IAC3B,KAAK,EAAE,WAAW,CAAC;CAClB,CACH,CAAC;AAEF;;;GAGG;AACH,oBAAY,SAAS;IACpB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,UAAU,eAAe;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACrB,OAAO,EAAE,UAAU,EAAE,CAAC;IAEtB;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC;IAEpB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAClC,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAAA;KAAE,CAAC;IAEzC;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC;IAEpB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,aAAa;IACrD,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,CAAA;KAAE,CAAC;CAC3C;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CACf"}

dist/protocol/storage.js

@@ -9,4 +9,3 @@ "use strict";
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -22,4 +21,3 @@ var FileMode;
  * Type of entries that can be stored in a tree.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -26,0 +24,0 @@ var TreeEntry;

dist/protocol/storage.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../src/protocol/storage.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAoBH;;;GAGG;AACH,IAAY,QAKX;AALD,WAAY,QAAQ;IACnB,2BAAe,CAAA;IACf,iCAAqB,CAAA;IACrB,gCAAoB,CAAA;IACpB,8BAAkB,CAAA;AACnB,CAAC,EALW,QAAQ,wBAAR,QAAQ,QAKnB;AAmED;;;;GAIG;AACH,IAAY,SAIX;AAJD,WAAY,SAAS;IACpB,0BAAa,CAAA;IACb,0BAAa,CAAA;IACb,sCAAyB,CAAA;AAC1B,CAAC,EAJW,SAAS,yBAAT,SAAS,QAIpB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IsoDate } from \"./date.js\";\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IDocumentAttributes {\n\t/**\n\t * Sequence number at which the snapshot was taken\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * Minimum sequence number when the snapshot was taken\n\t */\n\tminimumSequenceNumber: number;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport enum FileMode {\n\tFile = \"100644\",\n\tExecutable = \"100755\",\n\tDirectory = \"040000\",\n\tSymlink = \"120000\",\n}\n\n/**\n * Raw blob stored within the tree.\n * @legacy\n * @alpha\n */\nexport interface IBlob {\n\t/**\n\t * Contents of the blob\n\t */\n\tcontents: string;\n\n\t/**\n\t * The encoding of the contents string\n\t */\n\t// eslint-disable-next-line unicorn/text-encoding-identifier-case\n\tencoding: \"utf-8\" | \"base64\";\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IAttachment {\n\tid: string;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface ICreateBlobResponse {\n\tid: string;\n}\n\n/**\n * A tree entry wraps a path with a type of node.\n * @legacy\n * @alpha\n */\nexport type ITreeEntry = {\n\t/**\n\t * Path to the object\n\t */\n\tpath: string;\n\n\t/**\n\t * The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree)\n\t * or 120000 for a blob that specifies the path of a symlink\n\t */\n\tmode: FileMode;\n} & (\n\t| {\n\t\t\ttype: TreeEntry.Blob;\n\t\t\tvalue: IBlob;\n\t  }\n\t| {\n\t\t\ttype: TreeEntry.Tree;\n\t\t\tvalue: ITree;\n\t  }\n\t| {\n\t\t\ttype: TreeEntry.Attachment;\n\t\t\tvalue: IAttachment;\n\t  }\n);\n\n/**\n * Type of entries that can be stored in a tree.\n * @legacy\n * @alpha\n */\nexport enum TreeEntry {\n\tBlob = \"Blob\",\n\tTree = \"Tree\",\n\tAttachment = \"Attachment\",\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface ITree {\n\tentries: ITreeEntry[];\n\n\t/**\n\t * Unique ID representing all entries in the tree. Can be used to optimize snapshotting in the case\n\t * it is known that the `ITree` has already been created and stored\n\t */\n\tid?: string;\n\n\t/**\n\t * Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced.\n\t */\n\tunreferenced?: true;\n\n\t/**\n\t * Represents the loading group to which the tree belongs to. Please refer to this readme for more context.\n\t * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}\n\t * Also note that \"groupId\" is the same as \"loadingGroupId\" used elsewhere in the repo. The naming discrepancy is\n\t * intentional to minimize snapshot/summary size.\n\t */\n\tgroupId?: string;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface ISnapshotTree {\n\tid?: string;\n\tblobs: { [path: string]: string };\n\ttrees: { [path: string]: ISnapshotTree };\n\n\t/**\n\t * Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced.\n\t */\n\tunreferenced?: true;\n\n\t/**\n\t * Represents the loading group to which the snapshot tree belongs to. Please refer to this readme for more context.\n\t * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}\n\t * Also note that \"groupId\" is the same as \"loadingGroupId\" used elsewhere in the repo. The naming discrepancy is\n\t * intentional to minimize snapshot/summary size.\n\t */\n\tgroupId?: string;\n}\n\n/**\n * @internal\n */\nexport interface ISnapshotTreeEx extends ISnapshotTree {\n\tid: string;\n\ttrees: { [path: string]: ISnapshotTreeEx };\n}\n\n/**\n * Represents a version of the snapshot of a data store.\n * @legacy\n * @alpha\n */\nexport interface IVersion {\n\t/**\n\t * Version ID\n\t */\n\tid: string;\n\n\t/**\n\t * Tree ID for this version of the snapshot\n\t */\n\ttreeId: string;\n\n\t/**\n\t * Time when snapshot was generated.\n\t */\n\tdate?: IsoDate;\n}\n"]}
+{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../src/protocol/storage.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAmBH;;GAEG;AACH,IAAY,QAKX;AALD,WAAY,QAAQ;IACnB,2BAAe,CAAA;IACf,iCAAqB,CAAA;IACrB,gCAAoB,CAAA;IACpB,8BAAkB,CAAA;AACnB,CAAC,EALW,QAAQ,wBAAR,QAAQ,QAKnB;AA+DD;;;GAGG;AACH,IAAY,SAIX;AAJD,WAAY,SAAS;IACpB,0BAAa,CAAA;IACb,0BAAa,CAAA;IACb,sCAAyB,CAAA;AAC1B,CAAC,EAJW,SAAS,yBAAT,SAAS,QAIpB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IsoDate } from \"./date.js\";\n\n/**\n * @legacy @beta\n */\nexport interface IDocumentAttributes {\n\t/**\n\t * Sequence number at which the snapshot was taken\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * Minimum sequence number when the snapshot was taken\n\t */\n\tminimumSequenceNumber: number;\n}\n\n/**\n * @legacy @beta\n */\nexport enum FileMode {\n\tFile = \"100644\",\n\tExecutable = \"100755\",\n\tDirectory = \"040000\",\n\tSymlink = \"120000\",\n}\n\n/**\n * Raw blob stored within the tree.\n * @legacy @beta\n */\nexport interface IBlob {\n\t/**\n\t * Contents of the blob\n\t */\n\tcontents: string;\n\n\t/**\n\t * The encoding of the contents string\n\t */\n\t// 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\n\tencoding: \"utf-8\" | \"base64\";\n}\n\n/**\n * @legacy @beta\n */\nexport interface IAttachment {\n\tid: string;\n}\n\n/**\n * @legacy @beta\n */\nexport interface ICreateBlobResponse {\n\tid: string;\n}\n\n/**\n * A tree entry wraps a path with a type of node.\n * @legacy @beta\n */\nexport type ITreeEntry = {\n\t/**\n\t * Path to the object\n\t */\n\tpath: string;\n\n\t/**\n\t * The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree)\n\t * or 120000 for a blob that specifies the path of a symlink\n\t */\n\tmode: FileMode;\n} & (\n\t| {\n\t\t\ttype: TreeEntry.Blob;\n\t\t\tvalue: IBlob;\n\t  }\n\t| {\n\t\t\ttype: TreeEntry.Tree;\n\t\t\tvalue: ITree;\n\t  }\n\t| {\n\t\t\ttype: TreeEntry.Attachment;\n\t\t\tvalue: IAttachment;\n\t  }\n);\n\n/**\n * Type of entries that can be stored in a tree.\n * @legacy @beta\n */\nexport enum TreeEntry {\n\tBlob = \"Blob\",\n\tTree = \"Tree\",\n\tAttachment = \"Attachment\",\n}\n\n/**\n * @legacy @beta\n */\nexport interface ITree {\n\tentries: ITreeEntry[];\n\n\t/**\n\t * Unique ID representing all entries in the tree. Can be used to optimize snapshotting in the case\n\t * it is known that the `ITree` has already been created and stored\n\t */\n\tid?: string;\n\n\t/**\n\t * Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced.\n\t */\n\tunreferenced?: true;\n\n\t/**\n\t * Represents the loading group to which the tree belongs to. Please refer to this readme for more context.\n\t * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}\n\t * Also note that \"groupId\" is the same as \"loadingGroupId\" used elsewhere in the repo. The naming discrepancy is\n\t * intentional to minimize snapshot/summary size.\n\t */\n\tgroupId?: string;\n}\n\n/**\n * @legacy @beta\n */\nexport interface ISnapshotTree {\n\tid?: string;\n\tblobs: { [path: string]: string };\n\ttrees: { [path: string]: ISnapshotTree };\n\n\t/**\n\t * Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced.\n\t */\n\tunreferenced?: true;\n\n\t/**\n\t * Represents the loading group to which the snapshot tree belongs to. Please refer to this readme for more context.\n\t * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}\n\t * Also note that \"groupId\" is the same as \"loadingGroupId\" used elsewhere in the repo. The naming discrepancy is\n\t * intentional to minimize snapshot/summary size.\n\t */\n\tgroupId?: string;\n}\n\n/**\n * @internal\n */\nexport interface ISnapshotTreeEx extends ISnapshotTree {\n\tid: string;\n\ttrees: { [path: string]: ISnapshotTreeEx };\n}\n\n/**\n * Represents a version of the snapshot of a data store.\n * @legacy @beta\n */\nexport interface IVersion {\n\t/**\n\t * Version ID\n\t */\n\tid: string;\n\n\t/**\n\t * Tree ID for this version of the snapshot\n\t */\n\ttreeId: string;\n\n\t/**\n\t * Time when snapshot was generated.\n\t */\n\tdate?: IsoDate;\n}\n"]}

dist/protocol/summary.d.ts

@@ -15,4 +15,3 @@ /*!
  * The root of the summary tree.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -19,0 +18,0 @@ export type SummaryTree = ISummaryTree | ISummaryHandle;

dist/protocol/summary.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"summary.d.ts","sourceRoot":"","sources":["../../src/protocol/summary.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG,YAAY,GAAG,YAAY,GAAG,cAAc,GAAG,kBAAkB,CAAC;AAE9F;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,cAAc,CAAC;AAExD;;;GAGG;AAEH,yBAAiB,WAAW,CAAC;IAC5B;;OAEG;IACH,KAAY,IAAI,GAAG,CAAC,CAAC;IACrB;;OAEG;IACH,KAAY,IAAI,GAAG,CAAC,CAAC;IACrB;;OAEG;IACH,KAAY,MAAM,GAAG,CAAC,CAAC;IACvB;;OAEG;IACH,KAAY,UAAU,GAAG,CAAC,CAAC;IAE3B;;;OAGG;IACI,MAAM,IAAI,EAAE,IAAiB,CAAC;IAErC;;;;;OAKG;IACI,MAAM,IAAI,EAAE,IAAiB,CAAC;IAErC;;;OAGG;IACI,MAAM,MAAM,EAAE,MAAmB,CAAC;IAEzC;;;;;OAKG;IACI,MAAM,UAAU,EAAE,UAAuB,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GACpB,WAAW,CAAC,UAAU,GACtB,WAAW,CAAC,IAAI,GAChB,WAAW,CAAC,MAAM,GAClB,WAAW,CAAC,IAAI,CAAC;AAEpB;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,GAAG,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,UAAU,CAAC;AAE/F;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,mBAAmB,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,UAAU,CAAC;CAC7B;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,kBAAkB;IAClC,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC;IAC7B,EAAE,EAAE,MAAM,CAAC;CACX;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC;IAEvB;;;;OAIG;IACH,IAAI,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAAA;KAAE,CAAC;IAExC;;;OAGG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC;IAEpB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"summary.d.ts","sourceRoot":"","sources":["../../src/protocol/summary.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG,YAAY,GAAG,YAAY,GAAG,cAAc,GAAG,kBAAkB,CAAC;AAE9F;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,cAAc,CAAC;AAExD;;;GAGG;AAEH,yBAAiB,WAAW,CAAC;IAC5B;;OAEG;IACH,KAAY,IAAI,GAAG,CAAC,CAAC;IACrB;;OAEG;IACH,KAAY,IAAI,GAAG,CAAC,CAAC;IACrB;;OAEG;IACH,KAAY,MAAM,GAAG,CAAC,CAAC;IACvB;;OAEG;IACH,KAAY,UAAU,GAAG,CAAC,CAAC;IAE3B;;;OAGG;IACI,MAAM,IAAI,EAAE,IAAiB,CAAC;IAErC;;;;;OAKG;IACI,MAAM,IAAI,EAAE,IAAiB,CAAC;IAErC;;;OAGG;IACI,MAAM,MAAM,EAAE,MAAmB,CAAC;IAEzC;;;;;OAKG;IACI,MAAM,UAAU,EAAE,UAAuB,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GACpB,WAAW,CAAC,UAAU,GACtB,WAAW,CAAC,IAAI,GAChB,WAAW,CAAC,MAAM,GAClB,WAAW,CAAC,IAAI,CAAC;AAEpB;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,GAAG,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,UAAU,CAAC;AAE/F;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,mBAAmB,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,UAAU,CAAC;CAC7B;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,kBAAkB;IAClC,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC;IAC7B,EAAE,EAAE,MAAM,CAAC;CACX;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC;IAEvB;;;;OAIG;IACH,IAAI,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAAA;KAAE,CAAC;IAExC;;;OAGG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC;IAEpB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB"}

dist/protocol/summary.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"summary.js","sourceRoot":"","sources":["../../src/protocol/summary.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAkBH;;;GAGG;AACH,2DAA2D;AAC3D,IAAiB,WAAW,CA6C3B;AA7CD,WAAiB,WAAW;IAkB3B;;;OAGG;IACU,gBAAI,GAAS,CAAU,CAAC;IAErC;;;;;OAKG;IACU,gBAAI,GAAS,CAAU,CAAC;IAErC;;;OAGG;IACU,kBAAM,GAAW,CAAU,CAAC;IAEzC;;;;;OAKG;IACU,sBAAU,GAAe,CAAU,CAAC;AAClD,CAAC,EA7CgB,WAAW,2BAAX,WAAW,QA6C3B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Object representing a node within a summary tree.\n *\n * @remarks\n * If any particular node is an {@link ISummaryTree}, it can contain additional `SummaryObject`s as its children.\n * @public\n */\nexport type SummaryObject = ISummaryTree | ISummaryBlob | ISummaryHandle | ISummaryAttachment;\n\n/**\n * The root of the summary tree.\n * @legacy\n * @alpha\n */\nexport type SummaryTree = ISummaryTree | ISummaryHandle;\n\n/**\n * Type tag used to distinguish different types of nodes in a {@link ISummaryTree}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/no-namespace\nexport namespace SummaryType {\n\t/**\n\t * @internal\n\t */\n\texport type Tree = 1;\n\t/**\n\t * @internal\n\t */\n\texport type Blob = 2;\n\t/**\n\t * @internal\n\t */\n\texport type Handle = 3;\n\t/**\n\t * @internal\n\t */\n\texport type Attachment = 4;\n\n\t/**\n\t * Represents a sub-tree in the summary.\n\t * @public\n\t */\n\texport const Tree: Tree = 1 as const;\n\n\t/**\n\t * Represents a blob of data that is added to the summary.\n\t * Such as the user data that is added to the DDS or metadata added by runtime\n\t * such as data store / channel attributes.\n\t * @public\n\t */\n\texport const Blob: Blob = 2 as const;\n\n\t/**\n\t * Path to a summary tree object from the last successful summary.\n\t * @public\n\t */\n\texport const Handle: Handle = 3 as const;\n\n\t/**\n\t * Unique identifier to larger blobs uploaded outside of the summary.\n\t * Ex. DDS has large images or video that will be uploaded by the BlobManager and\n\t * receive an Id that can be used in the summary.\n\t * @public\n\t */\n\texport const Attachment: Attachment = 4 as const;\n}\n\n/**\n * {@inheritDoc (SummaryType:namespace)}\n * @public\n */\nexport type SummaryType =\n\t| SummaryType.Attachment\n\t| SummaryType.Blob\n\t| SummaryType.Handle\n\t| SummaryType.Tree;\n\n/**\n * Summary type that {@link ISummaryHandle} points to.\n *\n * @remarks\n * Summary handles are often used to point to summary tree objects contained within older summaries, thus avoiding\n * the need to re-send the entire subtree if summary object has not changed.\n * @public\n */\nexport type SummaryTypeNoHandle = SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment;\n\n/**\n * Path to a summary tree object from the last successful summary indicating the summary object hasn't\n * changed since it was uploaded.\n *\n * Special characters include '/'. '/' is used as a separator between different parts of the path as a way to traverse\n * different nodes in the previous summary/snapshot tree.\n *\n * Note, our algorithms use encodeURIComponent and decodeURIComponent to handle special characters in the path. If a string\n * causes this path to fail, the id will be invalid.\n *\n * @example\n * To illustrate, if a DataStore did not change since last summary, the framework runtime will use a handle for the\n * entire DataStore instead of re-sending the entire subtree. The same concept applies for a DDS.\n * An example of a handle string generated when the DDS did not change would be: '/.channels/<DataStoreId>/.channels/<DDSId>'.\n * An example of a handle string generated when the DataStore did not change would be: '/.channels/<DataStoreId>'.\n * An example of a handle string generated when the DDS blob did not change would be: `/.channels/<DataStoreId>/.channels/<DDSId>/<BlobId>`.\n * An example of a handle string generated when the DataStore .attributes blob did not change would be: `/.channels/<DataStoreId>/.attributes`.\n * @public\n */\nexport interface ISummaryHandle {\n\ttype: SummaryType.Handle;\n\n\t/**\n\t * Type of Summary Handle (SummaryType.Handle is not supported).\n\t */\n\thandleType: SummaryTypeNoHandle;\n\n\t/**\n\t * Unique path that identifies the corresponding sub-tree in a previous summary.\n\t */\n\thandle: string;\n}\n\n/**\n * String or Binary data to be uploaded to the server as part of the container's Summary.\n *\n * @remarks\n * Note: Already uploaded blobs would be referenced by an {@link ISummaryAttachment}.\n * Additional information can be found here: {@link https://github.com/microsoft/FluidFramework/issues/6568}\n *\n * @example\n * \"content\": \"\\{ \\\"pkg\\\":\\\"[\\\\\\\"OfficeRootComponent\\\\\\\",\\\\\\\"LastEditedComponent\\\\\\\"]\\\",\n *                    \\\"summaryFormatVersion\\\":2,\\\"isRootDataStore\\\":false \\}\"\n * @public\n */\nexport interface ISummaryBlob {\n\ttype: SummaryType.Blob;\n\tcontent: string | Uint8Array;\n}\n\n/**\n * Unique identifier for blobs uploaded outside of the summary.\n *\n * @remarks\n *\n * Attachment Blobs are uploaded and downloaded separately and do not take part of the snapshot payload.\n * The ID gets returned from the backend after the attachment has been uploaded.\n * Additional information can be found here: {@link https://github.com/microsoft/FluidFramework/issues/6374}\n *\n * @example\n * \"id\": \"bQAQKARDdMdTgqICmBa_ZB86YXwGP\"\n * @public\n */\nexport interface ISummaryAttachment {\n\ttype: SummaryType.Attachment;\n\tid: string;\n}\n\n/**\n * Tree Node data structure with children that are nodes of SummaryObject type:\n * Blob, Handle, Attachment or another Tree.\n * @public\n */\nexport interface ISummaryTree {\n\ttype: SummaryType.Tree;\n\n\t/**\n\t * The object containing all the tree's {@link SummaryObject} children.\n\t *\n\t * @param path - The key to store the SummaryObject at in the current summary tree being generated. Should not contain any \"/\" characters and should not change when encodeURIComponent is called on it.\n\t */\n\ttree: { [path: string]: SummaryObject };\n\n\t/**\n\t * Indicates that this tree entry is unreferenced.\n\t * If this is not present, the tree entry is considered referenced.\n\t */\n\tunreferenced?: true;\n\n\t/**\n\t * Represents the loading group to which the summary tree belongs to. Please refer to this readme for more context.\n\t * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}\n\t * Also note that \"groupId\" is the same as \"loadingGroupId\" used elsewhere in the repo. The naming discrepancy is\n\t * intentional to minimize snapshot/summary size.\n\t */\n\tgroupId?: string;\n}\n"]}
+{"version":3,"file":"summary.js","sourceRoot":"","sources":["../../src/protocol/summary.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAiBH;;;GAGG;AACH,2DAA2D;AAC3D,IAAiB,WAAW,CA6C3B;AA7CD,WAAiB,WAAW;IAkB3B;;;OAGG;IACU,gBAAI,GAAS,CAAU,CAAC;IAErC;;;;;OAKG;IACU,gBAAI,GAAS,CAAU,CAAC;IAErC;;;OAGG;IACU,kBAAM,GAAW,CAAU,CAAC;IAEzC;;;;;OAKG;IACU,sBAAU,GAAe,CAAU,CAAC;AAClD,CAAC,EA7CgB,WAAW,2BAAX,WAAW,QA6C3B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Object representing a node within a summary tree.\n *\n * @remarks\n * If any particular node is an {@link ISummaryTree}, it can contain additional `SummaryObject`s as its children.\n * @public\n */\nexport type SummaryObject = ISummaryTree | ISummaryBlob | ISummaryHandle | ISummaryAttachment;\n\n/**\n * The root of the summary tree.\n * @legacy @beta\n */\nexport type SummaryTree = ISummaryTree | ISummaryHandle;\n\n/**\n * Type tag used to distinguish different types of nodes in a {@link ISummaryTree}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/no-namespace\nexport namespace SummaryType {\n\t/**\n\t * @internal\n\t */\n\texport type Tree = 1;\n\t/**\n\t * @internal\n\t */\n\texport type Blob = 2;\n\t/**\n\t * @internal\n\t */\n\texport type Handle = 3;\n\t/**\n\t * @internal\n\t */\n\texport type Attachment = 4;\n\n\t/**\n\t * Represents a sub-tree in the summary.\n\t * @public\n\t */\n\texport const Tree: Tree = 1 as const;\n\n\t/**\n\t * Represents a blob of data that is added to the summary.\n\t * Such as the user data that is added to the DDS or metadata added by runtime\n\t * such as data store / channel attributes.\n\t * @public\n\t */\n\texport const Blob: Blob = 2 as const;\n\n\t/**\n\t * Path to a summary tree object from the last successful summary.\n\t * @public\n\t */\n\texport const Handle: Handle = 3 as const;\n\n\t/**\n\t * Unique identifier to larger blobs uploaded outside of the summary.\n\t * Ex. DDS has large images or video that will be uploaded by the BlobManager and\n\t * receive an Id that can be used in the summary.\n\t * @public\n\t */\n\texport const Attachment: Attachment = 4 as const;\n}\n\n/**\n * {@inheritDoc (SummaryType:namespace)}\n * @public\n */\nexport type SummaryType =\n\t| SummaryType.Attachment\n\t| SummaryType.Blob\n\t| SummaryType.Handle\n\t| SummaryType.Tree;\n\n/**\n * Summary type that {@link ISummaryHandle} points to.\n *\n * @remarks\n * Summary handles are often used to point to summary tree objects contained within older summaries, thus avoiding\n * the need to re-send the entire subtree if summary object has not changed.\n * @public\n */\nexport type SummaryTypeNoHandle = SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment;\n\n/**\n * Path to a summary tree object from the last successful summary indicating the summary object hasn't\n * changed since it was uploaded.\n *\n * Special characters include '/'. '/' is used as a separator between different parts of the path as a way to traverse\n * different nodes in the previous summary/snapshot tree.\n *\n * Note, our algorithms use encodeURIComponent and decodeURIComponent to handle special characters in the path. If a string\n * causes this path to fail, the id will be invalid.\n *\n * @example\n * To illustrate, if a DataStore did not change since last summary, the framework runtime will use a handle for the\n * entire DataStore instead of re-sending the entire subtree. The same concept applies for a DDS.\n * An example of a handle string generated when the DDS did not change would be: '/.channels/<DataStoreId>/.channels/<DDSId>'.\n * An example of a handle string generated when the DataStore did not change would be: '/.channels/<DataStoreId>'.\n * An example of a handle string generated when the DDS blob did not change would be: `/.channels/<DataStoreId>/.channels/<DDSId>/<BlobId>`.\n * An example of a handle string generated when the DataStore .attributes blob did not change would be: `/.channels/<DataStoreId>/.attributes`.\n * @public\n */\nexport interface ISummaryHandle {\n\ttype: SummaryType.Handle;\n\n\t/**\n\t * Type of Summary Handle (SummaryType.Handle is not supported).\n\t */\n\thandleType: SummaryTypeNoHandle;\n\n\t/**\n\t * Unique path that identifies the corresponding sub-tree in a previous summary.\n\t */\n\thandle: string;\n}\n\n/**\n * String or Binary data to be uploaded to the server as part of the container's Summary.\n *\n * @remarks\n * Note: Already uploaded blobs would be referenced by an {@link ISummaryAttachment}.\n * Additional information can be found here: {@link https://github.com/microsoft/FluidFramework/issues/6568}\n *\n * @example\n * \"content\": \"\\{ \\\"pkg\\\":\\\"[\\\\\\\"OfficeRootComponent\\\\\\\",\\\\\\\"LastEditedComponent\\\\\\\"]\\\",\n *                    \\\"summaryFormatVersion\\\":2,\\\"isRootDataStore\\\":false \\}\"\n * @public\n */\nexport interface ISummaryBlob {\n\ttype: SummaryType.Blob;\n\tcontent: string | Uint8Array;\n}\n\n/**\n * Unique identifier for blobs uploaded outside of the summary.\n *\n * @remarks\n *\n * Attachment Blobs are uploaded and downloaded separately and do not take part of the snapshot payload.\n * The ID gets returned from the backend after the attachment has been uploaded.\n * Additional information can be found here: {@link https://github.com/microsoft/FluidFramework/issues/6374}\n *\n * @example\n * \"id\": \"bQAQKARDdMdTgqICmBa_ZB86YXwGP\"\n * @public\n */\nexport interface ISummaryAttachment {\n\ttype: SummaryType.Attachment;\n\tid: string;\n}\n\n/**\n * Tree Node data structure with children that are nodes of SummaryObject type:\n * Blob, Handle, Attachment or another Tree.\n * @public\n */\nexport interface ISummaryTree {\n\ttype: SummaryType.Tree;\n\n\t/**\n\t * The object containing all the tree's {@link SummaryObject} children.\n\t *\n\t * @param path - The key to store the SummaryObject at in the current summary tree being generated. Should not contain any \"/\" characters and should not change when encodeURIComponent is called on it.\n\t */\n\ttree: { [path: string]: SummaryObject };\n\n\t/**\n\t * Indicates that this tree entry is unreferenced.\n\t * If this is not present, the tree entry is considered referenced.\n\t */\n\tunreferenced?: true;\n\n\t/**\n\t * Represents the loading group to which the summary tree belongs to. Please refer to this readme for more context.\n\t * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}\n\t * Also note that \"groupId\" is the same as \"loadingGroupId\" used elsewhere in the repo. The naming discrepancy is\n\t * intentional to minimize snapshot/summary size.\n\t */\n\tgroupId?: string;\n}\n"]}

dist/protocol/tokens.d.ts

@@ -10,4 +10,3 @@ /*!
  * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4}
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -14,0 +13,0 @@ export interface ITokenClaims {

dist/protocol/tokens.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../../src/protocol/tokens.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC;;;;;;GAMG;AACH,MAAM,WAAW,YAAY;IAC5B;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IAEZ;;;;;;OAMG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;;OAMG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACb"}
+{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../../src/protocol/tokens.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC5B;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IAEZ;;;;;;OAMG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;;OAMG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACb"}

dist/protocol/tokens.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../../src/protocol/tokens.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IUser } from \"./users.js\";\n\n/**\n * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} Claims\n *\n * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4}\n * @legacy\n * @alpha\n */\nexport interface ITokenClaims {\n\t/**\n\t * Identifies the document (a.k.a container) for which the token is being generated.\n\t * Generated by the service.\n\t */\n\tdocumentId: string;\n\n\t/**\n\t * Identifies the permissions required by the client on the document or summary.\n\t * For every scope, you can define the permissions you want to give to the client.\n\t */\n\tscopes: string[];\n\n\t/**\n\t * Unique tenant identifier.\n\t */\n\ttenantId: string;\n\n\t/**\n\t * User for whom the token was created.\n\t */\n\tuser: IUser;\n\n\t/**\n\t * \"Issued At\"\n\t * Indicates when the authentication for this token occurred.\n\t * Expressed in {@link https://en.wikipedia.org/wiki/Unix_time | Unix Time}.\n\t *\n\t * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.6}\n\t */\n\tiat: number;\n\n\t/**\n\t * \"Expiration Time\"\n\t * Identifies the expiration time on or after which the token must not be accepted for processing.\n\t * Expressed in {@link https://en.wikipedia.org/wiki/Unix_time | Unix Time}.\n\t *\n\t * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.4}\n\t */\n\texp: number;\n\n\t/**\n\t * \"Version\"\n\t * Version of the access token.\n\t */\n\tver: string;\n\n\t/**\n\t * \"JWT ID\"\n\t * A unique identifier for the token.\n\t *\n\t * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.7}\n\t */\n\tjti?: string;\n}\n"]}
+{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../../src/protocol/tokens.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IUser } from \"./users.js\";\n\n/**\n * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} Claims\n *\n * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4}\n * @legacy @beta\n */\nexport interface ITokenClaims {\n\t/**\n\t * Identifies the document (a.k.a container) for which the token is being generated.\n\t * Generated by the service.\n\t */\n\tdocumentId: string;\n\n\t/**\n\t * Identifies the permissions required by the client on the document or summary.\n\t * For every scope, you can define the permissions you want to give to the client.\n\t */\n\tscopes: string[];\n\n\t/**\n\t * Unique tenant identifier.\n\t */\n\ttenantId: string;\n\n\t/**\n\t * User for whom the token was created.\n\t */\n\tuser: IUser;\n\n\t/**\n\t * \"Issued At\"\n\t * Indicates when the authentication for this token occurred.\n\t * Expressed in {@link https://en.wikipedia.org/wiki/Unix_time | Unix Time}.\n\t *\n\t * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.6}\n\t */\n\tiat: number;\n\n\t/**\n\t * \"Expiration Time\"\n\t * Identifies the expiration time on or after which the token must not be accepted for processing.\n\t * Expressed in {@link https://en.wikipedia.org/wiki/Unix_time | Unix Time}.\n\t *\n\t * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.4}\n\t */\n\texp: number;\n\n\t/**\n\t * \"Version\"\n\t * Version of the access token.\n\t */\n\tver: string;\n\n\t/**\n\t * \"JWT ID\"\n\t * A unique identifier for the token.\n\t *\n\t * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.7}\n\t */\n\tjti?: string;\n}\n"]}

dist/storage.d.ts

@@ -45,4 +45,3 @@ /*!
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -57,4 +56,3 @@ export type IStreamResult<T> = {
  * Read interface for the Queue
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -66,4 +64,3 @@ export interface IStream<T> {
  * Interface to provide access to stored deltas for a shared object
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -84,4 +81,3 @@ export interface IDocumentDeltaStorageService {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -92,4 +88,3 @@ export type FiveDaysMs = 432_000_000;
  * to direct how other components interact with the driver
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -113,4 +108,3 @@ export interface IDocumentStorageServicePolicies {
  * Interface to provide access to snapshots saved for a shared object
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -171,4 +165,3 @@ export interface IDocumentStorageService extends Partial<IDisposable> {
  * Events emitted by {@link IDocumentService}.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -183,4 +176,3 @@ export interface IDocumentServiceEvents extends IEvent {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -204,4 +196,3 @@ export interface IDocumentDeltaConnectionEvents extends IErrorEvent {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -273,4 +264,3 @@ export interface IDocumentDeltaConnection extends IDisposable, IEventProvider<IDocumentDeltaConnectionEvents> {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -288,4 +278,3 @@ export declare enum LoaderCachingPolicy {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -309,4 +298,3 @@ export interface IDocumentServicePolicies {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -344,4 +332,3 @@ export interface IDocumentService extends IEventProvider<IDocumentServiceEvents> {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -377,4 +364,3 @@ export interface IDocumentServiceFactory {
  * Indicates the previously acked summary.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -393,4 +379,3 @@ export interface ISummaryContext {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -404,4 +389,3 @@ export declare enum FetchSource {
  *
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -425,4 +409,3 @@ export interface ISnapshot {
  * when fetching the snapshot.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -429,0 +412,0 @@ export interface ISnapshotFetchOptions {

dist/storage.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,WAAW,EACX,WAAW,EACX,MAAM,EACN,cAAc,EACd,oBAAoB,EACpB,MAAM,iCAAiC,CAAC;AAEzC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EACX,cAAc,EACd,OAAO,EACP,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,EAChB,KAAK,EACL,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,aAAa,EACb,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC;;;OAGG;IACH,QAAQ,EAAE,yBAAyB,EAAE,CAAC;IAEtC;;;;OAIG;IACH,aAAa,EAAE,OAAO,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACpC;;;;;;;;;OASG;IACH,GAAG,CACF,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,EAAE,YAAY;IAC1B,EAAE,EAAE,MAAM,EAAE,YAAY;IACxB,WAAW,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC;AAE1E;;;;GAIG;AACH,MAAM,WAAW,OAAO,CAAC,CAAC;IACzB,IAAI,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC5C;;;;;;;;;OASG;IACH,aAAa,CACZ,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,GAAG,SAAS,EACtB,WAAW,CAAC,EAAE,WAAW,EACzB,UAAU,CAAC,EAAE,OAAO,EACpB,WAAW,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;CACxC;AAMD;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,WAAW,CAAC;AAErC;;;;;GAKG;AACH,MAAM,WAAW,+BAA+B;IAC/C;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAEvC;;;;;;;OAOG;IACH,QAAQ,CAAC,sBAAsB,CAAC,EAAE,UAAU,CAAC;CAC7C;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAwB,SAAQ,OAAO,CAAC,WAAW,CAAC;IACpE;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,+BAA+B,GAAG,SAAS,CAAC;IAEhE;;;;;OAKG;IAGH,eAAe,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IAE1F;;;;;OAKG;IACH,WAAW,CAAC,CAAC,oBAAoB,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAE/E;;;;;;;;;;OAUG;IACH,WAAW,CAGV,SAAS,EAAE,MAAM,GAAG,IAAI,EACxB,KAAK,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,MAAM,EACrB,WAAW,CAAC,EAAE,WAAW,GACvB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEhE;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3F;;;OAGG;IACH,eAAe,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAC/D;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAuB,SAAQ,MAAM;IACrD;;;OAGG;IACH,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,IAAI,OAAE;CAChF;AAED;;;GAGG;AACH,MAAM,WAAW,8BAA+B,SAAQ,WAAW;IAClE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,IAAI,OAAE;IAC1E;;;;;;;OAOG;IACH,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,IAAI,OAAE;IACnE,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,yBAAyB,EAAE,KAAK,IAAI,OAAE;IAC7F,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,cAAc,GAAG,cAAc,EAAE,KAAK,IAAI,OAAE;IAClF,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,OAAE;IAGrD,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,OAAE;CACjD;AAED;;;GAGG;AACH,MAAM,WAAW,wBAChB,SAAQ,WAAW,EAClB,cAAc,CAAC,8BAA8B,CAAC;IAC/C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,EAAE,yBAAyB,EAAE,CAAC;IAE7C;;OAEG;IACH,cAAc,EAAE,cAAc,EAAE,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,aAAa,EAAE,CAAC;IAEhC;;OAEG;IACH,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC;IAE3C;;;;;OAKG;IACH,YAAY,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;CACjE;AAED;;;GAGG;AACH,oBAAY,mBAAmB;IAC9B;;OAEG;IACH,SAAS,IAAA;IAET;;OAEG;IACH,QAAQ,IAAA;CACR;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACxC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEzC;;;;OAIG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,cAAc,CAAC,sBAAsB,CAAC;IAC/E,WAAW,EAAE,YAAY,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IAEpC;;OAEG;IACH,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAErD;;OAEG;IACH,qBAAqB,IAAI,OAAO,CAAC,4BAA4B,CAAC,CAAC;IAE/D;;OAEG;IACH,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAEzE;;;;;;;;;OASG;IAGH,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACvC;;;;;;;;;;OAUG;IACH,qBAAqB,CACpB,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAE7B;;;;;;;;;;OAUG;IACH,eAAe,CACd,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,oBAAoB,EAAE,YAAY,EAClC,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAEvC,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;CACzC;AAED;;;GAGG;AACH,oBAAY,WAAW;IACtB,OAAO,YAAY;IACnB,OAAO,YAAY;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACzB,YAAY,EAAE,aAAa,CAAC;IAC5B,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACvC,GAAG,EAAE,yBAAyB,EAAE,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;OAEG;IACH,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAAC;IAEzC,eAAe,EAAE,CAAC,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACrC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAE3B;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;CAC1B"}
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,WAAW,EACX,WAAW,EACX,MAAM,EACN,cAAc,EACd,oBAAoB,EACpB,MAAM,iCAAiC,CAAC;AAEzC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EACX,cAAc,EACd,OAAO,EACP,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,EAChB,KAAK,EACL,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,aAAa,EACb,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC;;;OAGG;IACH,QAAQ,EAAE,yBAAyB,EAAE,CAAC;IAEtC;;;;OAIG;IACH,aAAa,EAAE,OAAO,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACpC;;;;;;;;;OASG;IACH,GAAG,CACF,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,EAAE,YAAY;IAC1B,EAAE,EAAE,MAAM,EAAE,YAAY;IACxB,WAAW,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC;AAE1E;;;GAGG;AACH,MAAM,WAAW,OAAO,CAAC,CAAC;IACzB,IAAI,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC5C;;;;;;;;;OASG;IACH,aAAa,CACZ,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,GAAG,SAAS,EACtB,WAAW,CAAC,EAAE,WAAW,EACzB,UAAU,CAAC,EAAE,OAAO,EACpB,WAAW,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;CACxC;AAMD;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,WAAW,CAAC;AAErC;;;;GAIG;AACH,MAAM,WAAW,+BAA+B;IAC/C;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAEvC;;;;;;;OAOG;IACH,QAAQ,CAAC,sBAAsB,CAAC,EAAE,UAAU,CAAC;CAC7C;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,OAAO,CAAC,WAAW,CAAC;IACpE;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,+BAA+B,GAAG,SAAS,CAAC;IAEhE;;;;;OAKG;IAGH,eAAe,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IAE1F;;;;;OAKG;IACH,WAAW,CAAC,CAAC,oBAAoB,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAE/E;;;;;;;;;;OAUG;IACH,WAAW,CAGV,SAAS,EAAE,MAAM,GAAG,IAAI,EACxB,KAAK,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,MAAM,EACrB,WAAW,CAAC,EAAE,WAAW,GACvB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEhE;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3F;;;OAGG;IACH,eAAe,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAC/D;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,MAAM;IACrD;;;OAGG;IACH,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,IAAI,OAAE;CAChF;AAED;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,WAAW;IAClE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,IAAI,OAAE;IAC1E;;;;;;;OAOG;IACH,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,IAAI,OAAE;IACnE,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,yBAAyB,EAAE,KAAK,IAAI,OAAE;IAC7F,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,cAAc,GAAG,cAAc,EAAE,KAAK,IAAI,OAAE;IAClF,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,OAAE;IAGrD,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,OAAE;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,wBAChB,SAAQ,WAAW,EAClB,cAAc,CAAC,8BAA8B,CAAC;IAC/C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,EAAE,yBAAyB,EAAE,CAAC;IAE7C;;OAEG;IACH,cAAc,EAAE,cAAc,EAAE,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,aAAa,EAAE,CAAC;IAEhC;;OAEG;IACH,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC;IAE3C;;;;;OAKG;IACH,YAAY,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;CACjE;AAED;;GAEG;AACH,oBAAY,mBAAmB;IAC9B;;OAEG;IACH,SAAS,IAAA;IAET;;OAEG;IACH,QAAQ,IAAA;CACR;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACxC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEzC;;;;OAIG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,cAAc,CAAC,sBAAsB,CAAC;IAC/E,WAAW,EAAE,YAAY,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IAEpC;;OAEG;IACH,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAErD;;OAEG;IACH,qBAAqB,IAAI,OAAO,CAAC,4BAA4B,CAAC,CAAC;IAE/D;;OAEG;IACH,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAEzE;;;;;;;;;OASG;IAGH,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC;;;;;;;;;;OAUG;IACH,qBAAqB,CACpB,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAE7B;;;;;;;;;;OAUG;IACH,eAAe,CACd,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,oBAAoB,EAAE,YAAY,EAClC,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAEvC,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;CACzC;AAED;;GAEG;AACH,oBAAY,WAAW;IACtB,OAAO,YAAY;IACnB,OAAO,YAAY;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACzB,YAAY,EAAE,aAAa,CAAC;IAC5B,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACvC,GAAG,EAAE,yBAAyB,EAAE,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;OAEG;IACH,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAAC;IAEzC,eAAe,EAAE,CAAC,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACrC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAE3B;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;CAC1B"}

dist/storage.js

@@ -9,4 +9,3 @@ "use strict";
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -25,4 +24,3 @@ var LoaderCachingPolicy;
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -29,0 +27,0 @@ var FetchSource;

dist/storage.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"storage.js","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAiVH;;;GAGG;AACH,IAAY,mBAUX;AAVD,WAAY,mBAAmB;IAC9B;;OAEG;IACH,uEAAS,CAAA;IAET;;OAEG;IACH,qEAAQ,CAAA;AACT,CAAC,EAVW,mBAAmB,mCAAnB,mBAAmB,QAU9B;AAgID;;;GAGG;AACH,IAAY,WAGX;AAHD,WAAY,WAAW;IACtB,kCAAmB,CAAA;IACnB,kCAAmB,CAAA;AACpB,CAAC,EAHW,WAAW,2BAAX,WAAW,QAGtB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type {\n\tIDisposable,\n\tIErrorEvent,\n\tIEvent,\n\tIEventProvider,\n\tITelemetryBaseLogger,\n} from \"@fluidframework/core-interfaces\";\n\nimport type { IAnyDriverError } from \"./driverError.js\";\nimport type {\n\tConnectionMode,\n\tIClient,\n\tIClientConfiguration,\n\tICreateBlobResponse,\n\tIDocumentMessage,\n\tINack,\n\tISequencedDocumentMessage,\n\tISignalClient,\n\tISignalMessage,\n\tISnapshotTree,\n\tISummaryHandle,\n\tISummaryTree,\n\tITokenClaims,\n\tIVersion,\n} from \"./protocol/index.js\";\nimport type { IResolvedUrl } from \"./urlResolver.js\";\n\n/**\n * @internal\n */\nexport interface IDeltasFetchResult {\n\t/**\n\t * Sequential set of messages starting from 'from' sequence number.\n\t * May be partial result, i.e. not fulfill original request in full.\n\t */\n\tmessages: ISequencedDocumentMessage[];\n\n\t/**\n\t * If true, storage only partially fulfilled request, but has more ops\n\t * If false, the request was fulfilled. If less ops were returned then\n\t * requested, then storage does not have more ops in this range.\n\t */\n\tpartialResult: boolean;\n}\n\n/**\n * Interface to provide access to stored deltas for a shared object\n * @internal\n */\nexport interface IDeltaStorageService {\n\t/**\n\t * Retrieves all the delta operations within the inclusive sequence number range\n\t * @param tenantId - Id of the tenant.\n\t * @param id - document id.\n\t * @param from - first op to retrieve (inclusive)\n\t * @param to - first op not to retrieve (exclusive end)\n\t * @param fetchReason - Reason for fetching the messages, for logging.\n\t * Example, gap between seq number of Op on wire and known seq number.\n\t * It can be logged by spo which could help in debugging sessions if any issue occurs.\n\t */\n\tget(\n\t\ttenantId: string,\n\t\tid: string,\n\t\tfrom: number, // inclusive\n\t\tto: number, // exclusive\n\t\tfetchReason?: string,\n\t): Promise<IDeltasFetchResult>;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport type IStreamResult<T> = { done: true } | { done: false; value: T };\n\n/**\n * Read interface for the Queue\n * @legacy\n * @alpha\n */\nexport interface IStream<T> {\n\tread(): Promise<IStreamResult<T>>;\n}\n\n/**\n * Interface to provide access to stored deltas for a shared object\n * @legacy\n * @alpha\n */\nexport interface IDocumentDeltaStorageService {\n\t/**\n\t * Retrieves all the delta operations within the exclusive sequence number range\n\t * @param from - first op to retrieve (inclusive)\n\t * @param to - first op not to retrieve (exclusive end)\n\t * @param abortSignal - signal that aborts operation\n\t * @param cachedOnly - return only cached ops, i.e. ops available locally on client.\n\t * @param fetchReason - Reason for fetching the messages, for logging.\n\t * Example, gap between seq number of Op on wire and known seq number.\n\t * It can be logged by spo which could help in debugging sessions if any issue occurs.\n\t */\n\tfetchMessages(\n\t\tfrom: number,\n\t\tto: number | undefined,\n\t\tabortSignal?: AbortSignal,\n\t\tcachedOnly?: boolean,\n\t\tfetchReason?: string,\n\t): IStream<ISequencedDocumentMessage[]>;\n}\n\n// DO NOT INCREASE THIS TYPE'S VALUE\n// If a driver started using a larger value,\n// internal assumptions of the Runtime's GC feature will be violated\n// DO NOT INCREASE THIS TYPE'S VALUE\n/**\n * @legacy\n * @alpha\n */\nexport type FiveDaysMs = 432_000_000; /* 5 days in milliseconds */\n\n/**\n * Policies describing attributes or characteristics of the driver's storage service,\n * to direct how other components interact with the driver\n * @legacy\n * @alpha\n */\nexport interface IDocumentStorageServicePolicies {\n\t/**\n\t * Should the Loader implement any sort of pre-fetching or caching mechanism?\n\t */\n\treadonly caching?: LoaderCachingPolicy;\n\n\t/**\n\t * IMPORTANT: This policy MUST be set to 5 days and PROPERLY ENFORCED for drivers that are used\n\t * in applications where Garbage Collection is enabled. Otherwise data loss may occur.\n\t *\n\t * This policy pertains to requests for the latest snapshot from the service.\n\t * If set, it means that the driver guarantees not to use a cached value that was fetched more than 5 days ago.\n\t * If undefined, the driver makes no guarantees about the age of snapshots used for loading.\n\t */\n\treadonly maximumCacheDurationMs?: FiveDaysMs;\n}\n\n/**\n * Interface to provide access to snapshots saved for a shared object\n * @legacy\n * @alpha\n */\nexport interface IDocumentStorageService extends Partial<IDisposable> {\n\t/**\n\t * Policies implemented/instructed by driver.\n\t */\n\treadonly policies?: IDocumentStorageServicePolicies | undefined;\n\n\t/**\n\t * Returns the snapshot tree.\n\t * @param version - Version of the snapshot to be fetched.\n\t * @param scenarioName - scenario in which this api is called. This will be recorded by server and would help\n\t * in debugging purposes to see why this call was made.\n\t */\n\t// TODO: use `undefined` instead.\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tgetSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;\n\n\t/**\n\t * Returns the snapshot which can contain other artifacts too like blob contents, ops etc. It is different from\n\t * `getSnapshotTree` api in that, that API only returns the snapshot tree from the snapshot.\n\t * @param snapshotFetchOptions - Options specified by the caller to specify and want certain behavior from the\n\t * driver when fetching the snapshot.\n\t */\n\tgetSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;\n\n\t/**\n\t * Retrieves all versions of the document starting at the specified versionId - or null if from the head\n\t * @param versionId - Version id of the requested version.\n\t * @param count - Number of the versions to be fetched.\n\t * @param scenarioName - scenario in which this api is called. This will be recorded by server and would help\n\t * in debugging purposes to see why this call was made.\n\t * @param fetchSource - Callers can specify the source of the response. For ex. Driver may choose to cache\n\t * requests and serve data from cache. That will result in stale info returned. Callers can disable this\n\t * functionality by passing fetchSource = noCache and ensuring that driver will return latest information\n\t * from storage.\n\t */\n\tgetVersions(\n\t\t// TODO: use `undefined` instead.\n\t\t// eslint-disable-next-line @rushstack/no-new-null\n\t\tversionId: string | null,\n\t\tcount: number,\n\t\tscenarioName?: string,\n\t\tfetchSource?: FetchSource,\n\t): Promise<IVersion[]>;\n\n\t/**\n\t * Creates a blob out of the given buffer\n\t */\n\tcreateBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;\n\n\t/**\n\t * Reads the object with the given ID, returns content in arrayBufferLike\n\t */\n\treadBlob(id: string): Promise<ArrayBufferLike>;\n\n\t/**\n\t * Uploads a summary tree to storage using the given context for reference of previous summary handle.\n\t * The ISummaryHandles in the uploaded tree should have paths to indicate which summary object they are\n\t * referencing from the previously acked summary.\n\t * Returns the uploaded summary handle.\n\t */\n\tuploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;\n\n\t/**\n\t * Retrieves the commit that matches the packfile handle. If the packfile has already been committed and the\n\t * server has deleted it this call may result in a broken promise.\n\t */\n\tdownloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;\n}\n\n/**\n * Events emitted by {@link IDocumentService}.\n * @legacy\n * @alpha\n */\nexport interface IDocumentServiceEvents extends IEvent {\n\t/**\n\t * This event is used to communicate any metadata related to the container. We might have received metadata from the service.\n\t * Read more info on this event from here `IContainer.containerMetadata`.\n\t */\n\t(event: \"metadataUpdate\", listener: (metadata: Record<string, string>) => void);\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IDocumentDeltaConnectionEvents extends IErrorEvent {\n\t(event: \"nack\", listener: (documentId: string, message: INack[]) => void);\n\t/**\n\t * @param reason - The reason for the disconnection.\n\t * Note: this parameter will also accept undefined in a future release to support clean disconnections.\n\t * When `reason` is provided, it indicates an error that caused the disconnection. When `undefined`, it represents\n\t * a clean, intentional disconnect that should not be treated as an error.\n\t * Signature will change from `(reason: IAnyDriverError) => void` to `(reason: IAnyDriverError | undefined) => void`.\n\t * Update your listener implementations to handle cases where `reason` is undefined.\n\t */\n\t(event: \"disconnect\", listener: (reason: IAnyDriverError) => void);\n\t(event: \"op\", listener: (documentId: string, messages: ISequencedDocumentMessage[]) => void);\n\t(event: \"signal\", listener: (message: ISignalMessage | ISignalMessage[]) => void);\n\t(event: \"pong\", listener: (latency: number) => void);\n\t// TODO: Use something other than `any`.\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t(event: \"error\", listener: (error: any) => void);\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IDocumentDeltaConnection\n\textends IDisposable,\n\t\tIEventProvider<IDocumentDeltaConnectionEvents> {\n\t/**\n\t * ClientID for the connection\n\t */\n\tclientId: string;\n\n\t/**\n\t * Claims for the client\n\t */\n\tclaims: ITokenClaims;\n\n\t/**\n\t * Mode of the client\n\t */\n\tmode: ConnectionMode;\n\n\t/**\n\t * Whether the connection was made to a new or existing document\n\t */\n\texisting: boolean;\n\n\t/**\n\t * Protocol version being used with the service\n\t */\n\tversion: string;\n\n\t/**\n\t * Messages sent during the connection\n\t */\n\tinitialMessages: ISequencedDocumentMessage[];\n\n\t/**\n\t * Signals sent during the connection\n\t */\n\tinitialSignals: ISignalMessage[];\n\n\t/**\n\t * Prior clients already connected.\n\t */\n\tinitialClients: ISignalClient[];\n\n\t/**\n\t * Configuration details provided by the service\n\t */\n\tserviceConfiguration: IClientConfiguration;\n\n\t/**\n\t * Last known sequence number to ordering service at the time of connection\n\t * It may lap actual last sequence number (quite a bit, if container  is very active).\n\t * But it's best information for client to figure out how far it is behind, at least\n\t * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n\t * that is likely to be more up-to-date.\n\t */\n\tcheckpointSequenceNumber?: number;\n\n\t/**\n\t * Properties that server can send to client to tell info about node that client is connected to. For ex, for spo\n\t * it could contain info like build version, environment, region etc. These properties can be logged by client\n\t * to better understand server environment etc. and use it in case error occurs.\n\t * Format: \"prop1:val1;prop2:val2;prop3:val3\"\n\t */\n\trelayServiceAgent?: string;\n\n\t/**\n\t * Submit a new message to the server\n\t */\n\tsubmit(messages: IDocumentMessage[]): void;\n\n\t/**\n\t * Submits a new signal to the server\n\t *\n\t * @privateRemarks\n\t * UnknownShouldBe<string> can be string if {@link IDocumentServiceFactory} becomes internal.\n\t */\n\tsubmitSignal: (content: string, targetClientId?: string) => void;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport enum LoaderCachingPolicy {\n\t/**\n\t * The loader should not implement any prefetching or caching policy.\n\t */\n\tNoCaching,\n\n\t/**\n\t * The loader should implement prefetching policy, i.e. it should prefetch resources from the latest snapshot.\n\t */\n\tPrefetch,\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IDocumentServicePolicies {\n\t/**\n\t * Do not connect to delta stream\n\t */\n\treadonly storageOnly?: boolean;\n\n\t/**\n\t * Summarizer uploads the protocol tree too when summarizing.\n\t */\n\treadonly summarizeProtocolTree?: boolean;\n\n\t/**\n\t * Whether the driver supports the new getSnapshot api which returns snapshot which\n\t * contains all contents along with the snapshot tree. Enable this by default when the\n\t * driver can fully support the api.\n\t */\n\treadonly supportGetSnapshotApi?: boolean;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IDocumentService extends IEventProvider<IDocumentServiceEvents> {\n\tresolvedUrl: IResolvedUrl;\n\n\t/**\n\t * Policies implemented/instructed by driver.\n\t */\n\tpolicies?: IDocumentServicePolicies;\n\n\t/**\n\t * Access to storage associated with the document\n\t */\n\tconnectToStorage(): Promise<IDocumentStorageService>;\n\n\t/**\n\t * Access to delta storage associated with the document\n\t */\n\tconnectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;\n\n\t/**\n\t * Subscribes to the document delta stream\n\t */\n\tconnectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;\n\n\t/**\n\t * Dispose storage. Called by storage consumer (Container) when it's done with storage (Container closed).\n\t * Useful for storage to commit any pending state if any (including any local caching).\n\t * Please note that it does not remove the need for caller to close all active delta connections,\n\t * as storage may not be tracking such objects.\n\t * @param error - tells if container (and storage) are closed due to critical error.\n\t * Error might be due to disconnect between client & server knowledge about file, like file being overwritten\n\t * in storage, but client having stale local cache.\n\t * If driver implements any kind of local caching, such caches needs to be cleared on on critical errors.\n\t */\n\t// TODO: Use something other than `any`.\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tdispose(error?: any): void;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IDocumentServiceFactory {\n\t/**\n\t * Creates the document service after extracting different endpoints URLs from a resolved URL.\n\t *\n\t * @param resolvedUrl - Endpoint URL data. See {@link IResolvedUrl}.\n\t * @param logger - Optional telemetry logger to which telemetry events will be forwarded.\n\t * @param clientIsSummarizer - Whether or not the client is the\n\t * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.\n\t * `undefined` =\\> false\n\t *\n\t * @returns An instance of {@link IDocumentService}.\n\t */\n\tcreateDocumentService(\n\t\tresolvedUrl: IResolvedUrl,\n\t\tlogger?: ITelemetryBaseLogger,\n\t\tclientIsSummarizer?: boolean,\n\t): Promise<IDocumentService>;\n\n\t/**\n\t * Creates a new document with the provided options. Returns the document service.\n\t *\n\t * @param createNewSummary - Summary used to create file. If undefined, an empty file will be created and a summary\n\t * should be posted later, before connecting to ordering service.\n\t * @param createNewResolvedUrl - Endpoint URL data. See {@link IResolvedUrl}.\n\t * @param logger - Optional telemetry logger to which telemetry events will be forwarded.\n\t * @param clientIsSummarizer - Whether or not the client is the\n\t * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.\n\t * `undefined` =\\> false\n\t */\n\tcreateContainer(\n\t\tcreateNewSummary: ISummaryTree | undefined,\n\t\tcreateNewResolvedUrl: IResolvedUrl,\n\t\tlogger?: ITelemetryBaseLogger,\n\t\tclientIsSummarizer?: boolean,\n\t): Promise<IDocumentService>;\n}\n\n/**\n * Context for uploading a summary to storage.\n * Indicates the previously acked summary.\n * @legacy\n * @alpha\n */\nexport interface ISummaryContext {\n\t/**\n\t * Parent summary proposed handle (from summary op)\n\t */\n\treadonly proposalHandle: string | undefined;\n\n\t/**\n\t * Parent summary acked handle (from summary ack)\n\t */\n\treadonly ackHandle: string | undefined;\n\n\treadonly referenceSequenceNumber: number;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport enum FetchSource {\n\tdefault = \"default\",\n\tnoCache = \"noCache\",\n}\n\n/**\n * A \"Full\" container Snapshot, including ISnapshotTree, blobs and outstanding ops (and other metadata)\n *\n * @legacy\n * @alpha\n */\nexport interface ISnapshot {\n\tsnapshotTree: ISnapshotTree;\n\tblobContents: Map<string, ArrayBuffer>;\n\tops: ISequencedDocumentMessage[];\n\n\t/**\n\t * Sequence number of the snapshot\n\t */\n\tsequenceNumber: number | undefined;\n\n\t/**\n\t * Sequence number for the latest op/snapshot for the file in ODSP\n\t */\n\tlatestSequenceNumber: number | undefined;\n\n\tsnapshotFormatV: 1;\n}\n\n/**\n * Snapshot fetch options which are used to communicate different things to the driver\n * when fetching the snapshot.\n * @legacy\n * @alpha\n */\nexport interface ISnapshotFetchOptions {\n\t/**\n\t * Indicates scenario in which the snapshot is fetched. It is a free form string  mostly\n\t * used for telemetry purposes.\n\t */\n\tscenarioName?: string;\n\t/**\n\t * Tell driver to cache the fetched snapshot. Driver is supposed to cache the fetched snapshot if this is\n\t * set to true. If undefined, then it is upto the driver, to cache it or not.\n\t */\n\tcacheSnapshot?: boolean;\n\n\t/**\n\t * Version of the snapshot to be fetched. Certain storage services just keep 1 snapshot for the\n\t * container, so specifying version is not necessary for storage services.\n\t */\n\tversionId?: string;\n\n\t/**\n\t * List of loading groupId of datastores for which the snapshot needs to be fetched. If not provided, content with\n\t * default/missing groupIDs will be requested from the service. It is upto the service, to include snapshot for\n\t * content with groupIds or not. Don't provide anything here for fetching content for initial container boot.\n\t */\n\tloadingGroupIds?: string[];\n\n\t/**\n\t * Specify if you want default behavior of the driver to fetch the snapshot like lets say simultaneously fetch from\n\t * network and cache or specify FetchSource.noCache to just fetch from network.\n\t */\n\tfetchSource?: FetchSource;\n}\n"]}
+{"version":3,"file":"storage.js","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAwUH;;GAEG;AACH,IAAY,mBAUX;AAVD,WAAY,mBAAmB;IAC9B;;OAEG;IACH,uEAAS,CAAA;IAET;;OAEG;IACH,qEAAQ,CAAA;AACT,CAAC,EAVW,mBAAmB,mCAAnB,mBAAmB,QAU9B;AA4HD;;GAEG;AACH,IAAY,WAGX;AAHD,WAAY,WAAW;IACtB,kCAAmB,CAAA;IACnB,kCAAmB,CAAA;AACpB,CAAC,EAHW,WAAW,2BAAX,WAAW,QAGtB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type {\n\tIDisposable,\n\tIErrorEvent,\n\tIEvent,\n\tIEventProvider,\n\tITelemetryBaseLogger,\n} from \"@fluidframework/core-interfaces\";\n\nimport type { IAnyDriverError } from \"./driverError.js\";\nimport type {\n\tConnectionMode,\n\tIClient,\n\tIClientConfiguration,\n\tICreateBlobResponse,\n\tIDocumentMessage,\n\tINack,\n\tISequencedDocumentMessage,\n\tISignalClient,\n\tISignalMessage,\n\tISnapshotTree,\n\tISummaryHandle,\n\tISummaryTree,\n\tITokenClaims,\n\tIVersion,\n} from \"./protocol/index.js\";\nimport type { IResolvedUrl } from \"./urlResolver.js\";\n\n/**\n * @internal\n */\nexport interface IDeltasFetchResult {\n\t/**\n\t * Sequential set of messages starting from 'from' sequence number.\n\t * May be partial result, i.e. not fulfill original request in full.\n\t */\n\tmessages: ISequencedDocumentMessage[];\n\n\t/**\n\t * If true, storage only partially fulfilled request, but has more ops\n\t * If false, the request was fulfilled. If less ops were returned then\n\t * requested, then storage does not have more ops in this range.\n\t */\n\tpartialResult: boolean;\n}\n\n/**\n * Interface to provide access to stored deltas for a shared object\n * @internal\n */\nexport interface IDeltaStorageService {\n\t/**\n\t * Retrieves all the delta operations within the inclusive sequence number range\n\t * @param tenantId - Id of the tenant.\n\t * @param id - document id.\n\t * @param from - first op to retrieve (inclusive)\n\t * @param to - first op not to retrieve (exclusive end)\n\t * @param fetchReason - Reason for fetching the messages, for logging.\n\t * Example, gap between seq number of Op on wire and known seq number.\n\t * It can be logged by spo which could help in debugging sessions if any issue occurs.\n\t */\n\tget(\n\t\ttenantId: string,\n\t\tid: string,\n\t\tfrom: number, // inclusive\n\t\tto: number, // exclusive\n\t\tfetchReason?: string,\n\t): Promise<IDeltasFetchResult>;\n}\n\n/**\n * @legacy @beta\n */\nexport type IStreamResult<T> = { done: true } | { done: false; value: T };\n\n/**\n * Read interface for the Queue\n * @legacy @beta\n */\nexport interface IStream<T> {\n\tread(): Promise<IStreamResult<T>>;\n}\n\n/**\n * Interface to provide access to stored deltas for a shared object\n * @legacy @beta\n */\nexport interface IDocumentDeltaStorageService {\n\t/**\n\t * Retrieves all the delta operations within the exclusive sequence number range\n\t * @param from - first op to retrieve (inclusive)\n\t * @param to - first op not to retrieve (exclusive end)\n\t * @param abortSignal - signal that aborts operation\n\t * @param cachedOnly - return only cached ops, i.e. ops available locally on client.\n\t * @param fetchReason - Reason for fetching the messages, for logging.\n\t * Example, gap between seq number of Op on wire and known seq number.\n\t * It can be logged by spo which could help in debugging sessions if any issue occurs.\n\t */\n\tfetchMessages(\n\t\tfrom: number,\n\t\tto: number | undefined,\n\t\tabortSignal?: AbortSignal,\n\t\tcachedOnly?: boolean,\n\t\tfetchReason?: string,\n\t): IStream<ISequencedDocumentMessage[]>;\n}\n\n// DO NOT INCREASE THIS TYPE'S VALUE\n// If a driver started using a larger value,\n// internal assumptions of the Runtime's GC feature will be violated\n// DO NOT INCREASE THIS TYPE'S VALUE\n/**\n * @legacy @beta\n */\nexport type FiveDaysMs = 432_000_000; /* 5 days in milliseconds */\n\n/**\n * Policies describing attributes or characteristics of the driver's storage service,\n * to direct how other components interact with the driver\n * @legacy @beta\n */\nexport interface IDocumentStorageServicePolicies {\n\t/**\n\t * Should the Loader implement any sort of pre-fetching or caching mechanism?\n\t */\n\treadonly caching?: LoaderCachingPolicy;\n\n\t/**\n\t * IMPORTANT: This policy MUST be set to 5 days and PROPERLY ENFORCED for drivers that are used\n\t * in applications where Garbage Collection is enabled. Otherwise data loss may occur.\n\t *\n\t * This policy pertains to requests for the latest snapshot from the service.\n\t * If set, it means that the driver guarantees not to use a cached value that was fetched more than 5 days ago.\n\t * If undefined, the driver makes no guarantees about the age of snapshots used for loading.\n\t */\n\treadonly maximumCacheDurationMs?: FiveDaysMs;\n}\n\n/**\n * Interface to provide access to snapshots saved for a shared object\n * @legacy @beta\n */\nexport interface IDocumentStorageService extends Partial<IDisposable> {\n\t/**\n\t * Policies implemented/instructed by driver.\n\t */\n\treadonly policies?: IDocumentStorageServicePolicies | undefined;\n\n\t/**\n\t * Returns the snapshot tree.\n\t * @param version - Version of the snapshot to be fetched.\n\t * @param scenarioName - scenario in which this api is called. This will be recorded by server and would help\n\t * in debugging purposes to see why this call was made.\n\t */\n\t// TODO: use `undefined` instead.\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tgetSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;\n\n\t/**\n\t * Returns the snapshot which can contain other artifacts too like blob contents, ops etc. It is different from\n\t * `getSnapshotTree` api in that, that API only returns the snapshot tree from the snapshot.\n\t * @param snapshotFetchOptions - Options specified by the caller to specify and want certain behavior from the\n\t * driver when fetching the snapshot.\n\t */\n\tgetSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;\n\n\t/**\n\t * Retrieves all versions of the document starting at the specified versionId - or null if from the head\n\t * @param versionId - Version id of the requested version.\n\t * @param count - Number of the versions to be fetched.\n\t * @param scenarioName - scenario in which this api is called. This will be recorded by server and would help\n\t * in debugging purposes to see why this call was made.\n\t * @param fetchSource - Callers can specify the source of the response. For ex. Driver may choose to cache\n\t * requests and serve data from cache. That will result in stale info returned. Callers can disable this\n\t * functionality by passing fetchSource = noCache and ensuring that driver will return latest information\n\t * from storage.\n\t */\n\tgetVersions(\n\t\t// TODO: use `undefined` instead.\n\t\t// eslint-disable-next-line @rushstack/no-new-null\n\t\tversionId: string | null,\n\t\tcount: number,\n\t\tscenarioName?: string,\n\t\tfetchSource?: FetchSource,\n\t): Promise<IVersion[]>;\n\n\t/**\n\t * Creates a blob out of the given buffer\n\t */\n\tcreateBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;\n\n\t/**\n\t * Reads the object with the given ID, returns content in arrayBufferLike\n\t */\n\treadBlob(id: string): Promise<ArrayBufferLike>;\n\n\t/**\n\t * Uploads a summary tree to storage using the given context for reference of previous summary handle.\n\t * The ISummaryHandles in the uploaded tree should have paths to indicate which summary object they are\n\t * referencing from the previously acked summary.\n\t * Returns the uploaded summary handle.\n\t */\n\tuploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;\n\n\t/**\n\t * Retrieves the commit that matches the packfile handle. If the packfile has already been committed and the\n\t * server has deleted it this call may result in a broken promise.\n\t */\n\tdownloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;\n}\n\n/**\n * Events emitted by {@link IDocumentService}.\n * @legacy @beta\n */\nexport interface IDocumentServiceEvents extends IEvent {\n\t/**\n\t * This event is used to communicate any metadata related to the container. We might have received metadata from the service.\n\t * Read more info on this event from here `IContainer.containerMetadata`.\n\t */\n\t(event: \"metadataUpdate\", listener: (metadata: Record<string, string>) => void);\n}\n\n/**\n * @legacy @beta\n */\nexport interface IDocumentDeltaConnectionEvents extends IErrorEvent {\n\t(event: \"nack\", listener: (documentId: string, message: INack[]) => void);\n\t/**\n\t * @param reason - The reason for the disconnection.\n\t * Note: this parameter will also accept undefined in a future release to support clean disconnections.\n\t * When `reason` is provided, it indicates an error that caused the disconnection. When `undefined`, it represents\n\t * a clean, intentional disconnect that should not be treated as an error.\n\t * Signature will change from `(reason: IAnyDriverError) => void` to `(reason: IAnyDriverError | undefined) => void`.\n\t * Update your listener implementations to handle cases where `reason` is undefined.\n\t */\n\t(event: \"disconnect\", listener: (reason: IAnyDriverError) => void);\n\t(event: \"op\", listener: (documentId: string, messages: ISequencedDocumentMessage[]) => void);\n\t(event: \"signal\", listener: (message: ISignalMessage | ISignalMessage[]) => void);\n\t(event: \"pong\", listener: (latency: number) => void);\n\t// TODO: Use something other than `any`.\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t(event: \"error\", listener: (error: any) => void);\n}\n\n/**\n * @legacy @beta\n */\nexport interface IDocumentDeltaConnection\n\textends IDisposable,\n\t\tIEventProvider<IDocumentDeltaConnectionEvents> {\n\t/**\n\t * ClientID for the connection\n\t */\n\tclientId: string;\n\n\t/**\n\t * Claims for the client\n\t */\n\tclaims: ITokenClaims;\n\n\t/**\n\t * Mode of the client\n\t */\n\tmode: ConnectionMode;\n\n\t/**\n\t * Whether the connection was made to a new or existing document\n\t */\n\texisting: boolean;\n\n\t/**\n\t * Protocol version being used with the service\n\t */\n\tversion: string;\n\n\t/**\n\t * Messages sent during the connection\n\t */\n\tinitialMessages: ISequencedDocumentMessage[];\n\n\t/**\n\t * Signals sent during the connection\n\t */\n\tinitialSignals: ISignalMessage[];\n\n\t/**\n\t * Prior clients already connected.\n\t */\n\tinitialClients: ISignalClient[];\n\n\t/**\n\t * Configuration details provided by the service\n\t */\n\tserviceConfiguration: IClientConfiguration;\n\n\t/**\n\t * Last known sequence number to ordering service at the time of connection\n\t * It may lap actual last sequence number (quite a bit, if container  is very active).\n\t * But it's best information for client to figure out how far it is behind, at least\n\t * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n\t * that is likely to be more up-to-date.\n\t */\n\tcheckpointSequenceNumber?: number;\n\n\t/**\n\t * Properties that server can send to client to tell info about node that client is connected to. For ex, for spo\n\t * it could contain info like build version, environment, region etc. These properties can be logged by client\n\t * to better understand server environment etc. and use it in case error occurs.\n\t * Format: \"prop1:val1;prop2:val2;prop3:val3\"\n\t */\n\trelayServiceAgent?: string;\n\n\t/**\n\t * Submit a new message to the server\n\t */\n\tsubmit(messages: IDocumentMessage[]): void;\n\n\t/**\n\t * Submits a new signal to the server\n\t *\n\t * @privateRemarks\n\t * UnknownShouldBe<string> can be string if {@link IDocumentServiceFactory} becomes internal.\n\t */\n\tsubmitSignal: (content: string, targetClientId?: string) => void;\n}\n\n/**\n * @legacy @beta\n */\nexport enum LoaderCachingPolicy {\n\t/**\n\t * The loader should not implement any prefetching or caching policy.\n\t */\n\tNoCaching,\n\n\t/**\n\t * The loader should implement prefetching policy, i.e. it should prefetch resources from the latest snapshot.\n\t */\n\tPrefetch,\n}\n\n/**\n * @legacy @beta\n */\nexport interface IDocumentServicePolicies {\n\t/**\n\t * Do not connect to delta stream\n\t */\n\treadonly storageOnly?: boolean;\n\n\t/**\n\t * Summarizer uploads the protocol tree too when summarizing.\n\t */\n\treadonly summarizeProtocolTree?: boolean;\n\n\t/**\n\t * Whether the driver supports the new getSnapshot api which returns snapshot which\n\t * contains all contents along with the snapshot tree. Enable this by default when the\n\t * driver can fully support the api.\n\t */\n\treadonly supportGetSnapshotApi?: boolean;\n}\n\n/**\n * @legacy @beta\n */\nexport interface IDocumentService extends IEventProvider<IDocumentServiceEvents> {\n\tresolvedUrl: IResolvedUrl;\n\n\t/**\n\t * Policies implemented/instructed by driver.\n\t */\n\tpolicies?: IDocumentServicePolicies;\n\n\t/**\n\t * Access to storage associated with the document\n\t */\n\tconnectToStorage(): Promise<IDocumentStorageService>;\n\n\t/**\n\t * Access to delta storage associated with the document\n\t */\n\tconnectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;\n\n\t/**\n\t * Subscribes to the document delta stream\n\t */\n\tconnectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;\n\n\t/**\n\t * Dispose storage. Called by storage consumer (Container) when it's done with storage (Container closed).\n\t * Useful for storage to commit any pending state if any (including any local caching).\n\t * Please note that it does not remove the need for caller to close all active delta connections,\n\t * as storage may not be tracking such objects.\n\t * @param error - tells if container (and storage) are closed due to critical error.\n\t * Error might be due to disconnect between client & server knowledge about file, like file being overwritten\n\t * in storage, but client having stale local cache.\n\t * If driver implements any kind of local caching, such caches needs to be cleared on on critical errors.\n\t */\n\t// TODO: Use something other than `any`.\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tdispose(error?: any): void;\n}\n\n/**\n * @legacy @beta\n */\nexport interface IDocumentServiceFactory {\n\t/**\n\t * Creates the document service after extracting different endpoints URLs from a resolved URL.\n\t *\n\t * @param resolvedUrl - Endpoint URL data. See {@link IResolvedUrl}.\n\t * @param logger - Optional telemetry logger to which telemetry events will be forwarded.\n\t * @param clientIsSummarizer - Whether or not the client is the\n\t * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.\n\t * `undefined` =\\> false\n\t *\n\t * @returns An instance of {@link IDocumentService}.\n\t */\n\tcreateDocumentService(\n\t\tresolvedUrl: IResolvedUrl,\n\t\tlogger?: ITelemetryBaseLogger,\n\t\tclientIsSummarizer?: boolean,\n\t): Promise<IDocumentService>;\n\n\t/**\n\t * Creates a new document with the provided options. Returns the document service.\n\t *\n\t * @param createNewSummary - Summary used to create file. If undefined, an empty file will be created and a summary\n\t * should be posted later, before connecting to ordering service.\n\t * @param createNewResolvedUrl - Endpoint URL data. See {@link IResolvedUrl}.\n\t * @param logger - Optional telemetry logger to which telemetry events will be forwarded.\n\t * @param clientIsSummarizer - Whether or not the client is the\n\t * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.\n\t * `undefined` =\\> false\n\t */\n\tcreateContainer(\n\t\tcreateNewSummary: ISummaryTree | undefined,\n\t\tcreateNewResolvedUrl: IResolvedUrl,\n\t\tlogger?: ITelemetryBaseLogger,\n\t\tclientIsSummarizer?: boolean,\n\t): Promise<IDocumentService>;\n}\n\n/**\n * Context for uploading a summary to storage.\n * Indicates the previously acked summary.\n * @legacy @beta\n */\nexport interface ISummaryContext {\n\t/**\n\t * Parent summary proposed handle (from summary op)\n\t */\n\treadonly proposalHandle: string | undefined;\n\n\t/**\n\t * Parent summary acked handle (from summary ack)\n\t */\n\treadonly ackHandle: string | undefined;\n\n\treadonly referenceSequenceNumber: number;\n}\n\n/**\n * @legacy @beta\n */\nexport enum FetchSource {\n\tdefault = \"default\",\n\tnoCache = \"noCache\",\n}\n\n/**\n * A \"Full\" container Snapshot, including ISnapshotTree, blobs and outstanding ops (and other metadata)\n *\n * @legacy @beta\n */\nexport interface ISnapshot {\n\tsnapshotTree: ISnapshotTree;\n\tblobContents: Map<string, ArrayBuffer>;\n\tops: ISequencedDocumentMessage[];\n\n\t/**\n\t * Sequence number of the snapshot\n\t */\n\tsequenceNumber: number | undefined;\n\n\t/**\n\t * Sequence number for the latest op/snapshot for the file in ODSP\n\t */\n\tlatestSequenceNumber: number | undefined;\n\n\tsnapshotFormatV: 1;\n}\n\n/**\n * Snapshot fetch options which are used to communicate different things to the driver\n * when fetching the snapshot.\n * @legacy @beta\n */\nexport interface ISnapshotFetchOptions {\n\t/**\n\t * Indicates scenario in which the snapshot is fetched. It is a free form string  mostly\n\t * used for telemetry purposes.\n\t */\n\tscenarioName?: string;\n\t/**\n\t * Tell driver to cache the fetched snapshot. Driver is supposed to cache the fetched snapshot if this is\n\t * set to true. If undefined, then it is upto the driver, to cache it or not.\n\t */\n\tcacheSnapshot?: boolean;\n\n\t/**\n\t * Version of the snapshot to be fetched. Certain storage services just keep 1 snapshot for the\n\t * container, so specifying version is not necessary for storage services.\n\t */\n\tversionId?: string;\n\n\t/**\n\t * List of loading groupId of datastores for which the snapshot needs to be fetched. If not provided, content with\n\t * default/missing groupIDs will be requested from the service. It is upto the service, to include snapshot for\n\t * content with groupIds or not. Don't provide anything here for fetching content for initial container boot.\n\t */\n\tloadingGroupIds?: string[];\n\n\t/**\n\t * Specify if you want default behavior of the driver to fetch the snapshot like lets say simultaneously fetch from\n\t * network and cache or specify FetchSource.noCache to just fetch from network.\n\t */\n\tfetchSource?: FetchSource;\n}\n"]}

dist/urlResolver.d.ts

@@ -7,4 +7,3 @@ /*!
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -27,4 +26,3 @@ export interface IResolvedUrl {
  * Container package info handed off to resolver.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -38,4 +36,3 @@ export interface IContainerPackageInfo {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -56,4 +53,3 @@ export interface IUrlResolver {
  * for driver compatibility and preload information.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -73,4 +69,3 @@ export interface DriverPreCheckInfo {
  * Additional key in the loader request header
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -77,0 +72,0 @@ export declare enum DriverHeader {

dist/urlResolver.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"urlResolver.d.ts","sourceRoot":"","sources":["../src/urlResolver.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAEhE;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACnC,SAAS,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACrC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAI5B,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;IAE9D;;;;;;OAMG;IACH,cAAc,CACb,WAAW,EAAE,YAAY,EACzB,WAAW,EAAE,MAAM,EACnB,iBAAiB,CAAC,EAAE,qBAAqB,GACvC,OAAO,CAAC,MAAM,CAAC,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IAClC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC/B;AAED;;;;GAIG;AACH,oBAAY,YAAY;IAEvB,iBAAiB,4BAA4B;IAE7C,SAAS,cAAc;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,CAAC,YAAY,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAG1C,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC;CAC9B;AAED,OAAO,QAAQ,iCAAiC,CAAC;IAChD;;;;OAIG;IAEH,UAAiB,cAAe,SAAQ,OAAO,CAAC,aAAa,CAAC;KAAG;CACjE"}
+{"version":3,"file":"urlResolver.d.ts","sourceRoot":"","sources":["../src/urlResolver.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACnC,SAAS,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACrC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAI5B,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;IAE9D;;;;;;OAMG;IACH,cAAc,CACb,WAAW,EAAE,YAAY,EACzB,WAAW,EAAE,MAAM,EACnB,iBAAiB,CAAC,EAAE,qBAAqB,GACvC,OAAO,CAAC,MAAM,CAAC,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAClC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC/B;AAED;;;GAGG;AACH,oBAAY,YAAY;IAEvB,iBAAiB,4BAA4B;IAE7C,SAAS,cAAc;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,CAAC,YAAY,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAG1C,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC;CAC9B;AAED,OAAO,QAAQ,iCAAiC,CAAC;IAChD;;;;OAIG;IAEH,UAAiB,cAAe,SAAQ,OAAO,CAAC,aAAa,CAAC;KAAG;CACjE"}

dist/urlResolver.js

@@ -10,4 +10,3 @@ "use strict";
  * Additional key in the loader request header
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -14,0 +13,0 @@ var DriverHeader;

dist/urlResolver.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"urlResolver.js","sourceRoot":"","sources":["../src/urlResolver.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA0EH;;;;GAIG;AACH,IAAY,YAKX;AALD,WAAY,YAAY;IACvB,qDAAqD;IACrD,6DAA6C,CAAA;IAC7C,iDAAiD;IACjD,uCAAuB,CAAA;AACxB,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IRequest } from \"@fluidframework/core-interfaces\";\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IResolvedUrl {\n\ttype: \"fluid\";\n\t/**\n\t * The id of the container this resolved url is for.\n\t */\n\tid: string;\n\turl: string;\n\ttokens: { [name: string]: string };\n\tendpoints: { [name: string]: string };\n}\n\n/**\n * Container package info handed off to resolver.\n * @legacy\n * @alpha\n */\nexport interface IContainerPackageInfo {\n\t/**\n\t * Container package name.\n\t */\n\tname: string;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IUrlResolver {\n\t// Like DNS should be able to cache resolution requests. Then possibly just have a token provider go and do stuff?\n\t// the expiration of it could be relative to the lifetime of the token? Requests after need to refresh?\n\t// or do we split the token access from this?\n\tresolve(request: IRequest): Promise<IResolvedUrl | undefined>;\n\n\t/**\n\t * Creates a url for the created container with any data store path given in the relative url.\n\t * @param resolvedUrl - resolved url for the container.\n\t * @param relativeUrl - relative url containing data store path; '/' represents root path.\n\t * @param packageInfoSource - optional, represents container package information to be included in url.\n\t * @returns absolute url combining container url with dta store path and optional additional information.\n\t */\n\tgetAbsoluteUrl(\n\t\tresolvedUrl: IResolvedUrl,\n\t\trelativeUrl: string,\n\t\tpackageInfoSource?: IContainerPackageInfo,\n\t): Promise<string>;\n}\n\n/**\n * Information that can be returned by a lightweight, seperately exported driver function. Used to preanalyze a URL\n * for driver compatibility and preload information.\n * @legacy\n * @alpha\n */\nexport interface DriverPreCheckInfo {\n\t/**\n\t * A code details hint that can potentially be used to prefetch container code prior to having a snapshot.\n\t */\n\tcodeDetailsHint?: string;\n\n\t/**\n\t * Domains that will be connected to on the critical boot path. Hosts can choose to preconnect to these for\n\t * improved performance.\n\t */\n\tcriticalBootDomains?: string[];\n}\n\n/**\n * Additional key in the loader request header\n * @legacy\n * @alpha\n */\nexport enum DriverHeader {\n\t// Key to indicate whether the request for summarizer\n\tsummarizingClient = \"fluid-client-summarizer\",\n\t// createNew information, specific to each driver\n\tcreateNew = \"createNew\",\n}\n\n/**\n * @internal\n */\nexport interface IDriverHeader {\n\t[DriverHeader.summarizingClient]: boolean;\n\t// TODO: Use something other than `any`.\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t[DriverHeader.createNew]: any;\n}\n\ndeclare module \"@fluidframework/core-interfaces\" {\n\t/**\n\t * Interface to represent headers to include in the container or data store load request.\n\t * For example, caller can use this to pass on various loader options in the container\n\t * load request.\n\t */\n\t// eslint-disable-next-line @typescript-eslint/no-empty-interface\n\texport interface IRequestHeader extends Partial<IDriverHeader> {}\n}\n"]}
+{"version":3,"file":"urlResolver.js","sourceRoot":"","sources":["../src/urlResolver.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAsEH;;;GAGG;AACH,IAAY,YAKX;AALD,WAAY,YAAY;IACvB,qDAAqD;IACrD,6DAA6C,CAAA;IAC7C,iDAAiD;IACjD,uCAAuB,CAAA;AACxB,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IRequest } from \"@fluidframework/core-interfaces\";\n\n/**\n * @legacy @beta\n */\nexport interface IResolvedUrl {\n\ttype: \"fluid\";\n\t/**\n\t * The id of the container this resolved url is for.\n\t */\n\tid: string;\n\turl: string;\n\ttokens: { [name: string]: string };\n\tendpoints: { [name: string]: string };\n}\n\n/**\n * Container package info handed off to resolver.\n * @legacy @beta\n */\nexport interface IContainerPackageInfo {\n\t/**\n\t * Container package name.\n\t */\n\tname: string;\n}\n\n/**\n * @legacy @beta\n */\nexport interface IUrlResolver {\n\t// Like DNS should be able to cache resolution requests. Then possibly just have a token provider go and do stuff?\n\t// the expiration of it could be relative to the lifetime of the token? Requests after need to refresh?\n\t// or do we split the token access from this?\n\tresolve(request: IRequest): Promise<IResolvedUrl | undefined>;\n\n\t/**\n\t * Creates a url for the created container with any data store path given in the relative url.\n\t * @param resolvedUrl - resolved url for the container.\n\t * @param relativeUrl - relative url containing data store path; '/' represents root path.\n\t * @param packageInfoSource - optional, represents container package information to be included in url.\n\t * @returns absolute url combining container url with dta store path and optional additional information.\n\t */\n\tgetAbsoluteUrl(\n\t\tresolvedUrl: IResolvedUrl,\n\t\trelativeUrl: string,\n\t\tpackageInfoSource?: IContainerPackageInfo,\n\t): Promise<string>;\n}\n\n/**\n * Information that can be returned by a lightweight, seperately exported driver function. Used to preanalyze a URL\n * for driver compatibility and preload information.\n * @legacy @beta\n */\nexport interface DriverPreCheckInfo {\n\t/**\n\t * A code details hint that can potentially be used to prefetch container code prior to having a snapshot.\n\t */\n\tcodeDetailsHint?: string;\n\n\t/**\n\t * Domains that will be connected to on the critical boot path. Hosts can choose to preconnect to these for\n\t * improved performance.\n\t */\n\tcriticalBootDomains?: string[];\n}\n\n/**\n * Additional key in the loader request header\n * @legacy @beta\n */\nexport enum DriverHeader {\n\t// Key to indicate whether the request for summarizer\n\tsummarizingClient = \"fluid-client-summarizer\",\n\t// createNew information, specific to each driver\n\tcreateNew = \"createNew\",\n}\n\n/**\n * @internal\n */\nexport interface IDriverHeader {\n\t[DriverHeader.summarizingClient]: boolean;\n\t// TODO: Use something other than `any`.\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t[DriverHeader.createNew]: any;\n}\n\ndeclare module \"@fluidframework/core-interfaces\" {\n\t/**\n\t * Interface to represent headers to include in the container or data store load request.\n\t * For example, caller can use this to pass on various loader options in the container\n\t * load request.\n\t */\n\t// eslint-disable-next-line @typescript-eslint/no-empty-interface\n\texport interface IRequestHeader extends Partial<IDriverHeader> {}\n}\n"]}

lib/driverError.d.ts

@@ -8,4 +8,3 @@ /*!
  * Different error types the Driver may report out to the Host.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -87,4 +86,3 @@ export declare const DriverErrorTypes: {
  * {@inheritDoc (DriverErrorTypes:variable)}
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -102,4 +100,3 @@ export type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErrorTypes];
  * but we can't reference a specific driver's error type enum in this code.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -116,4 +113,3 @@ export interface IAnyDriverError extends Omit<IDriverErrorBase, "errorType"> {
  * Base interface for all errors and warnings
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -146,4 +142,3 @@ export interface IDriverErrorBase {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -155,4 +150,3 @@ export interface IThrottlingWarning extends IDriverErrorBase {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -164,4 +158,3 @@ export interface IGenericNetworkError extends IDriverErrorBase {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -174,4 +167,3 @@ export interface IAuthorizationError extends IDriverErrorBase {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -185,4 +177,3 @@ export interface ILocationRedirectionError extends IDriverErrorBase {
  * allows compiler to differentiate interfaces based on error type
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -194,6 +185,5 @@ export interface IDriverBasicError extends IDriverErrorBase {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type DriverError = IThrottlingWarning | IGenericNetworkError | IAuthorizationError | ILocationRedirectionError | IDriverBasicError;
 //# sourceMappingURL=driverError.d.ts.map

lib/driverError.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"driverError.d.ts","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAMrD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB;IAI5B;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;IAQH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;;OAIG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;CAEM,CAAC;AACX;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAExF;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC;IAC3E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,gBAAgB,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC3D,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,eAAe,CAAC;IAC5D,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC7D,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,mBAAmB,CAAC;IAChE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC5D,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,kBAAkB,CAAC;IAC/D,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IAClE,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,mBAAmB,CAAC;IAChE,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;CACnC;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IAC1D,QAAQ,CAAC,SAAS,EACf,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,+BAA+B,GACvD,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,gCAAgC,GACxD,OAAO,gBAAgB,CAAC,UAAU,GAClC,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,eAAe,GACvC,OAAO,gBAAgB,CAAC,uBAAuB,GAC/C,OAAO,gBAAgB,CAAC,wBAAwB,GAChD,OAAO,gBAAgB,CAAC,kBAAkB,GAC1C,OAAO,gBAAgB,CAAC,UAAU,GAClC,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,iBAAiB,CAAC;IAC7C,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GACpB,kBAAkB,GAClB,oBAAoB,GACpB,mBAAmB,GACnB,yBAAyB,GACzB,iBAAiB,CAAC"}
+{"version":3,"file":"driverError.d.ts","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAMrD;;;GAGG;AACH,eAAO,MAAM,gBAAgB;IAI5B;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;IAQH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;;OAIG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;CAEM,CAAC;AACX;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAExF;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC;IAC3E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,gBAAgB,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC3D,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,eAAe,CAAC;IAC5D,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC7D,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,mBAAmB,CAAC;IAChE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC5D,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,kBAAkB,CAAC;IAC/D,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IAClE,QAAQ,CAAC,SAAS,EAAE,OAAO,gBAAgB,CAAC,mBAAmB,CAAC;IAChE,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IAC1D,QAAQ,CAAC,SAAS,EACf,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,+BAA+B,GACvD,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,gCAAgC,GACxD,OAAO,gBAAgB,CAAC,UAAU,GAClC,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,eAAe,GACvC,OAAO,gBAAgB,CAAC,uBAAuB,GAC/C,OAAO,gBAAgB,CAAC,wBAAwB,GAChD,OAAO,gBAAgB,CAAC,kBAAkB,GAC1C,OAAO,gBAAgB,CAAC,UAAU,GAClC,OAAO,gBAAgB,CAAC,YAAY,GACpC,OAAO,gBAAgB,CAAC,iBAAiB,CAAC;IAC7C,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GACpB,kBAAkB,GAClB,oBAAoB,GACpB,mBAAmB,GACnB,yBAAyB,GACzB,iBAAiB,CAAC"}

lib/driverError.js

@@ -10,4 +10,3 @@ /*!
  * Different error types the Driver may report out to the Host.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -14,0 +13,0 @@ export const DriverErrorTypes = {

lib/driverError.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"driverError.js","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAI3E,8GAA8G;AAC9G,MAAM,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,GAAG,8BAA8B,EAAE,GACpF,eAAe,CAAC;AAEjB;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC/B,2BAA2B;IAC3B,GAAG,8BAA8B;IAEjC;;;OAGG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;OAEG;IACH,kBAAkB,EAAE,oBAAoB;IAExC;;OAEG;IACH,+BAA+B,EAAE,iCAAiC;IAElE;;OAEG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,gCAAgC,EAAE,kCAAkC;IAEpE;;;OAGG;IACH,UAAU,EAAE,YAAY;IAExB;;;;;OAKG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,eAAe,EAAE,iBAAiB;IAElC;;OAEG;IACH,uBAAuB,EAAE,yBAAyB;IAElD;;;;;OAKG;IACH,wBAAwB,EAAE,0BAA0B;IAEpD;;OAEG;IACH,8BAA8B,EAAE,gCAAgC;IAEhE;;;OAGG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;;;OAIG;IACH,kBAAkB,EAAE,oBAAoB;IAExC;;OAEG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,iBAAiB,EAAE,mBAAmB;CAC7B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { FluidErrorTypes } from \"@fluidframework/core-interfaces/internal\";\n\nimport type { IResolvedUrl } from \"./urlResolver.js\";\n\n// Omit `dataCorruptionError` and `dataProcessingError` from the list of values inherited from FluidErrorTypes\nconst { dataCorruptionError, dataProcessingError, ...FluidErrorTypesExceptDataTypes } =\n\tFluidErrorTypes;\n\n/**\n * Different error types the Driver may report out to the Host.\n * @legacy\n * @alpha\n */\nexport const DriverErrorTypes = {\n\t// Inherit base error types\n\t...FluidErrorTypesExceptDataTypes,\n\n\t/**\n\t * Some non-categorized (below) networking error\n\t * Include errors like  fatal server error (usually 500).\n\t */\n\tgenericNetworkError: \"genericNetworkError\",\n\n\t/**\n\t * Access denied - user does not have enough privileges to open a file, or continue to operate on a file\n\t */\n\tauthorizationError: \"authorizationError\",\n\n\t/**\n\t * File not found, or file deleted during session\n\t */\n\tfileNotFoundOrAccessDeniedError: \"fileNotFoundOrAccessDeniedError\",\n\n\t/**\n\t * We can not reach server due to computer being offline.\n\t */\n\tofflineError: \"offlineError\",\n\n\t/*\n\t * Unsupported client protocol\n\t */\n\tunsupportedClientProtocolVersion: \"unsupportedClientProtocolVersion\",\n\n\t/**\n\t * User does not have write permissions to a file, but is changing content of a file.\n\t * That might be indication of some data store error - data stores should not generate ops in readonly mode.\n\t */\n\twriteError: \"writeError\",\n\n\t/**\n\t * A generic fetch failure that indicates we were not able to get a response from the server.\n\t * This may be due to the client being offline (though, if we are able to detect offline state it will be\n\t * logged as an offlineError instead).  Other possibilities could be DNS errors, malformed fetch request,\n\t * CSP violation, etc.\n\t */\n\tfetchFailure: \"fetchFailure\",\n\n\t/**\n\t * This error occurs when token provider fails to fetch orderer token\n\t */\n\tfetchTokenError: \"fetchTokenError\",\n\n\t/**\n\t * Unexpected response from server. Either JSON is malformed, or some required properties are missing\n\t */\n\tincorrectServerResponse: \"incorrectServerResponse\",\n\n\t/**\n\t * This error occurs when the file is modified externally (not through Fluid protocol) in storage.\n\t * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,\n\t * and storage / driver / loader detects such mismatch.\n\t * When it's hit, client needs to forget all the knowledge about this file and start over.\n\t */\n\tfileOverwrittenInStorage: \"fileOverwrittenInStorage\",\n\n\t/**\n\t * The document is read-only and delta stream connection is forbidden.\n\t */\n\tdeltaStreamConnectionForbidden: \"deltaStreamConnectionForbidden\",\n\n\t/**\n\t * The location of file/container can change on server. So if the file location moves and we try to access the old\n\t * location, then this error is thrown to let the client know about the new location info.\n\t */\n\tlocationRedirection: \"locationRedirection\",\n\n\t/**\n\t * When a file is not a Fluid file, but has Fluid extension such as \".note\",\n\t * server won't be able to open it and will return this error. The innerMostErrorCode will be\n\t * \"fluidInvalidSchema\"\n\t */\n\tfluidInvalidSchema: \"fluidInvalidSchema\",\n\n\t/**\n\t * File is locked for read/write by storage, e.g. whole collection is locked and access denied.\n\t */\n\tfileIsLocked: \"fileIsLocked\",\n\n\t/**\n\t * Storage is out of space\n\t */\n\toutOfStorageError: \"outOfStorageError\",\n} as const;\n/**\n * {@inheritDoc (DriverErrorTypes:variable)}\n * @legacy\n * @alpha\n */\nexport type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErrorTypes];\n\n/**\n * Interface describing errors and warnings raised by any driver code.\n *\n * @remarks\n * Not expected to be implemented by a class or an object literal, but rather used in place of\n * any or unknown in various function signatures that pass errors around.\n *\n * \"Any\" in the interface name is a nod to the fact that errorType has lost its type constraint.\n * It will be either {@link @fluidframework/driver-definitions#(DriverErrorTypes:variable)} or the specific driver's specialized error type enum,\n * but we can't reference a specific driver's error type enum in this code.\n * @legacy\n * @alpha\n */\nexport interface IAnyDriverError extends Omit<IDriverErrorBase, \"errorType\"> {\n\treadonly errorType: string;\n\t/**\n\t * This property is used predominantly for socket io errors. It captures the underlying socket event name which resulted in the error.\n\t * i.e. connect_error, connect_document_error etc.\n\t */\n\tscenarioName?: string;\n}\n\n/**\n * Base interface for all errors and warnings\n * @legacy\n * @alpha\n */\nexport interface IDriverErrorBase {\n\t/**\n\t * Classification of what type of error this is, used programmatically by consumers to interpret the error.\n\t *\n\t * @privateRemarks TODO: use {@link DriverErrorTypes} instead (breaking change).\n\t */\n\treadonly errorType: DriverErrorTypes;\n\n\t/**\n\t * Free-form error message\n\t */\n\treadonly message: string;\n\n\t/**\n\t * True indicates the caller may retry the failed action. False indicates it's a fatal error\n\t */\n\tcanRetry: boolean;\n\n\t/**\n\t * Best guess as to network conditions (online/offline) when the error arose.\n\t * See OnlineStatus enum in driver-utils package for expected values.\n\t */\n\tonline?: string;\n\n\t/**\n\t * Whether service was reachable and we got some response from service.\n\t */\n\tendpointReached?: boolean;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IThrottlingWarning extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.throttlingError;\n\treadonly retryAfterSeconds: number;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IGenericNetworkError extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.genericNetworkError;\n\treadonly statusCode?: number;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IAuthorizationError extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.authorizationError;\n\treadonly claims?: string;\n\treadonly tenantId?: string;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface ILocationRedirectionError extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.locationRedirection;\n\treadonly redirectUrl: IResolvedUrl;\n}\n\n/**\n * Having this uber interface without types that have their own interfaces\n * allows compiler to differentiate interfaces based on error type\n * @legacy\n * @alpha\n */\nexport interface IDriverBasicError extends IDriverErrorBase {\n\treadonly errorType:\n\t\t| typeof DriverErrorTypes.genericError\n\t\t| typeof DriverErrorTypes.fileNotFoundOrAccessDeniedError\n\t\t| typeof DriverErrorTypes.offlineError\n\t\t| typeof DriverErrorTypes.unsupportedClientProtocolVersion\n\t\t| typeof DriverErrorTypes.writeError\n\t\t| typeof DriverErrorTypes.fetchFailure\n\t\t| typeof DriverErrorTypes.fetchTokenError\n\t\t| typeof DriverErrorTypes.incorrectServerResponse\n\t\t| typeof DriverErrorTypes.fileOverwrittenInStorage\n\t\t| typeof DriverErrorTypes.fluidInvalidSchema\n\t\t| typeof DriverErrorTypes.usageError\n\t\t| typeof DriverErrorTypes.fileIsLocked\n\t\t| typeof DriverErrorTypes.outOfStorageError;\n\treadonly statusCode?: number;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport type DriverError =\n\t| IThrottlingWarning\n\t| IGenericNetworkError\n\t| IAuthorizationError\n\t| ILocationRedirectionError\n\t| IDriverBasicError;\n"]}
+{"version":3,"file":"driverError.js","sourceRoot":"","sources":["../src/driverError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAI3E,8GAA8G;AAC9G,MAAM,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,GAAG,8BAA8B,EAAE,GACpF,eAAe,CAAC;AAEjB;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC/B,2BAA2B;IAC3B,GAAG,8BAA8B;IAEjC;;;OAGG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;OAEG;IACH,kBAAkB,EAAE,oBAAoB;IAExC;;OAEG;IACH,+BAA+B,EAAE,iCAAiC;IAElE;;OAEG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,gCAAgC,EAAE,kCAAkC;IAEpE;;;OAGG;IACH,UAAU,EAAE,YAAY;IAExB;;;;;OAKG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,eAAe,EAAE,iBAAiB;IAElC;;OAEG;IACH,uBAAuB,EAAE,yBAAyB;IAElD;;;;;OAKG;IACH,wBAAwB,EAAE,0BAA0B;IAEpD;;OAEG;IACH,8BAA8B,EAAE,gCAAgC;IAEhE;;;OAGG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;;;OAIG;IACH,kBAAkB,EAAE,oBAAoB;IAExC;;OAEG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,iBAAiB,EAAE,mBAAmB;CAC7B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { FluidErrorTypes } from \"@fluidframework/core-interfaces/internal\";\n\nimport type { IResolvedUrl } from \"./urlResolver.js\";\n\n// Omit `dataCorruptionError` and `dataProcessingError` from the list of values inherited from FluidErrorTypes\nconst { dataCorruptionError, dataProcessingError, ...FluidErrorTypesExceptDataTypes } =\n\tFluidErrorTypes;\n\n/**\n * Different error types the Driver may report out to the Host.\n * @legacy @beta\n */\nexport const DriverErrorTypes = {\n\t// Inherit base error types\n\t...FluidErrorTypesExceptDataTypes,\n\n\t/**\n\t * Some non-categorized (below) networking error\n\t * Include errors like  fatal server error (usually 500).\n\t */\n\tgenericNetworkError: \"genericNetworkError\",\n\n\t/**\n\t * Access denied - user does not have enough privileges to open a file, or continue to operate on a file\n\t */\n\tauthorizationError: \"authorizationError\",\n\n\t/**\n\t * File not found, or file deleted during session\n\t */\n\tfileNotFoundOrAccessDeniedError: \"fileNotFoundOrAccessDeniedError\",\n\n\t/**\n\t * We can not reach server due to computer being offline.\n\t */\n\tofflineError: \"offlineError\",\n\n\t/*\n\t * Unsupported client protocol\n\t */\n\tunsupportedClientProtocolVersion: \"unsupportedClientProtocolVersion\",\n\n\t/**\n\t * User does not have write permissions to a file, but is changing content of a file.\n\t * That might be indication of some data store error - data stores should not generate ops in readonly mode.\n\t */\n\twriteError: \"writeError\",\n\n\t/**\n\t * A generic fetch failure that indicates we were not able to get a response from the server.\n\t * This may be due to the client being offline (though, if we are able to detect offline state it will be\n\t * logged as an offlineError instead).  Other possibilities could be DNS errors, malformed fetch request,\n\t * CSP violation, etc.\n\t */\n\tfetchFailure: \"fetchFailure\",\n\n\t/**\n\t * This error occurs when token provider fails to fetch orderer token\n\t */\n\tfetchTokenError: \"fetchTokenError\",\n\n\t/**\n\t * Unexpected response from server. Either JSON is malformed, or some required properties are missing\n\t */\n\tincorrectServerResponse: \"incorrectServerResponse\",\n\n\t/**\n\t * This error occurs when the file is modified externally (not through Fluid protocol) in storage.\n\t * It will occur in cases where client has some state or cache that is based on old content (identity) of a file,\n\t * and storage / driver / loader detects such mismatch.\n\t * When it's hit, client needs to forget all the knowledge about this file and start over.\n\t */\n\tfileOverwrittenInStorage: \"fileOverwrittenInStorage\",\n\n\t/**\n\t * The document is read-only and delta stream connection is forbidden.\n\t */\n\tdeltaStreamConnectionForbidden: \"deltaStreamConnectionForbidden\",\n\n\t/**\n\t * The location of file/container can change on server. So if the file location moves and we try to access the old\n\t * location, then this error is thrown to let the client know about the new location info.\n\t */\n\tlocationRedirection: \"locationRedirection\",\n\n\t/**\n\t * When a file is not a Fluid file, but has Fluid extension such as \".note\",\n\t * server won't be able to open it and will return this error. The innerMostErrorCode will be\n\t * \"fluidInvalidSchema\"\n\t */\n\tfluidInvalidSchema: \"fluidInvalidSchema\",\n\n\t/**\n\t * File is locked for read/write by storage, e.g. whole collection is locked and access denied.\n\t */\n\tfileIsLocked: \"fileIsLocked\",\n\n\t/**\n\t * Storage is out of space\n\t */\n\toutOfStorageError: \"outOfStorageError\",\n} as const;\n/**\n * {@inheritDoc (DriverErrorTypes:variable)}\n * @legacy @beta\n */\nexport type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErrorTypes];\n\n/**\n * Interface describing errors and warnings raised by any driver code.\n *\n * @remarks\n * Not expected to be implemented by a class or an object literal, but rather used in place of\n * any or unknown in various function signatures that pass errors around.\n *\n * \"Any\" in the interface name is a nod to the fact that errorType has lost its type constraint.\n * It will be either {@link @fluidframework/driver-definitions#(DriverErrorTypes:variable)} or the specific driver's specialized error type enum,\n * but we can't reference a specific driver's error type enum in this code.\n * @legacy @beta\n */\nexport interface IAnyDriverError extends Omit<IDriverErrorBase, \"errorType\"> {\n\treadonly errorType: string;\n\t/**\n\t * This property is used predominantly for socket io errors. It captures the underlying socket event name which resulted in the error.\n\t * i.e. connect_error, connect_document_error etc.\n\t */\n\tscenarioName?: string;\n}\n\n/**\n * Base interface for all errors and warnings\n * @legacy @beta\n */\nexport interface IDriverErrorBase {\n\t/**\n\t * Classification of what type of error this is, used programmatically by consumers to interpret the error.\n\t *\n\t * @privateRemarks TODO: use {@link DriverErrorTypes} instead (breaking change).\n\t */\n\treadonly errorType: DriverErrorTypes;\n\n\t/**\n\t * Free-form error message\n\t */\n\treadonly message: string;\n\n\t/**\n\t * True indicates the caller may retry the failed action. False indicates it's a fatal error\n\t */\n\tcanRetry: boolean;\n\n\t/**\n\t * Best guess as to network conditions (online/offline) when the error arose.\n\t * See OnlineStatus enum in driver-utils package for expected values.\n\t */\n\tonline?: string;\n\n\t/**\n\t * Whether service was reachable and we got some response from service.\n\t */\n\tendpointReached?: boolean;\n}\n\n/**\n * @legacy @beta\n */\nexport interface IThrottlingWarning extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.throttlingError;\n\treadonly retryAfterSeconds: number;\n}\n\n/**\n * @legacy @beta\n */\nexport interface IGenericNetworkError extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.genericNetworkError;\n\treadonly statusCode?: number;\n}\n\n/**\n * @legacy @beta\n */\nexport interface IAuthorizationError extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.authorizationError;\n\treadonly claims?: string;\n\treadonly tenantId?: string;\n}\n\n/**\n * @legacy @beta\n */\nexport interface ILocationRedirectionError extends IDriverErrorBase {\n\treadonly errorType: typeof DriverErrorTypes.locationRedirection;\n\treadonly redirectUrl: IResolvedUrl;\n}\n\n/**\n * Having this uber interface without types that have their own interfaces\n * allows compiler to differentiate interfaces based on error type\n * @legacy @beta\n */\nexport interface IDriverBasicError extends IDriverErrorBase {\n\treadonly errorType:\n\t\t| typeof DriverErrorTypes.genericError\n\t\t| typeof DriverErrorTypes.fileNotFoundOrAccessDeniedError\n\t\t| typeof DriverErrorTypes.offlineError\n\t\t| typeof DriverErrorTypes.unsupportedClientProtocolVersion\n\t\t| typeof DriverErrorTypes.writeError\n\t\t| typeof DriverErrorTypes.fetchFailure\n\t\t| typeof DriverErrorTypes.fetchTokenError\n\t\t| typeof DriverErrorTypes.incorrectServerResponse\n\t\t| typeof DriverErrorTypes.fileOverwrittenInStorage\n\t\t| typeof DriverErrorTypes.fluidInvalidSchema\n\t\t| typeof DriverErrorTypes.usageError\n\t\t| typeof DriverErrorTypes.fileIsLocked\n\t\t| typeof DriverErrorTypes.outOfStorageError;\n\treadonly statusCode?: number;\n}\n\n/**\n * @legacy @beta\n */\nexport type DriverError =\n\t| IThrottlingWarning\n\t| IGenericNetworkError\n\t| IAuthorizationError\n\t| ILocationRedirectionError\n\t| IDriverBasicError;\n"]}

lib/git/resources.d.ts

@@ -119,4 +119,3 @@ /*!
  * Required params to create ref
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -129,4 +128,3 @@ export interface ICreateRefParams {
  * Required params to patch ref
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -133,0 +131,0 @@ export interface IPatchRefParams {

lib/git/resources.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"resources.d.ts","sourceRoot":"","sources":["../../src/git/resources.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB,MAAM,EAAE,OAAO,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,UAAU,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,WAAW,EAAE,CAAC;CACvB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,cAAc;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE;QACP,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,OAAO,CAAC;QAChB,SAAS,EAAE,UAAU,CAAC;QACtB,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,WAAW,CAAC;KAClB,CAAC;IACF,OAAO,EAAE,WAAW,EAAE,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAEjC,OAAO,EAAE,MAAM,CAAC;IAIhB,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;KACZ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,OAAO,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IACjC,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,gBAAgB,EAAE,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,UAAU,EAAE,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;KACZ,CAAC;CACF"}
+{"version":3,"file":"resources.d.ts","sourceRoot":"","sources":["../../src/git/resources.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB,MAAM,EAAE,OAAO,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,UAAU,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,WAAW,EAAE,CAAC;CACvB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,cAAc;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE;QACP,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,OAAO,CAAC;QAChB,SAAS,EAAE,UAAU,CAAC;QACtB,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,WAAW,CAAC;KAClB,CAAC;IACF,OAAO,EAAE,WAAW,EAAE,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAEjC,OAAO,EAAE,MAAM,CAAC;IAIhB,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;KACZ,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,OAAO,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IACjC,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,gBAAgB,EAAE,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,UAAU,EAAE,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IAEd,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;KACZ,CAAC;CACF"}

lib/git/resources.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"resources.js","sourceRoot":"","sources":["../../src/git/resources.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// The types defined in this directory provide strong typing for the deserialized\n// REST payloads when communicating with the Git service.\n//\n// These should not be changed unless Git itself is changed, and should be aligned\n// with the service side definitions contained here:\n//\n// server/routerlicious/packages/gitresources/src/resources.ts\n\n/**\n * Details about the author of the commit\n * @internal\n */\nexport interface IAuthor {\n\tname: string;\n\temail: string;\n\t// ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ\n\tdate: string;\n}\n\n/**\n * Details about the committer of the commit\n * @internal\n */\nexport interface ICommitter {\n\tname: string;\n\temail: string;\n\t// ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ\n\tdate: string;\n}\n\n/**\n * Details of the commit\n * @internal\n */\nexport interface ICommitHash {\n\tsha: string;\n\turl: string;\n}\n\n/**\n * Required params to create commit\n * @internal\n */\nexport interface ICreateCommitParams {\n\tmessage: string;\n\ttree: string;\n\tparents: string[];\n\t// GitHub has signature verification on the author\n\tauthor: IAuthor;\n}\n\n/**\n * Commit content\n * @internal\n */\nexport interface ICommit {\n\tsha: string;\n\turl: string;\n\tauthor: IAuthor;\n\tcommitter: ICommitter;\n\tmessage: string;\n\ttree: ICommitHash;\n\tparents: ICommitHash[];\n}\n\n/**\n * Details of a commit\n *\n * GitHub differentiates the commit resource returned from its git and repos routes. The repos\n * route returns more site specific information (like links to the developer's account) while the git\n * route is what is actually stored in the Git repo\n *\n * https://developer.github.com/v3/git/commits/\n * https://developer.github.com/v3/repos/commits/\n * @internal\n */\nexport interface ICommitDetails {\n\turl: string;\n\tsha: string;\n\tcommit: {\n\t\turl: string;\n\t\tauthor: IAuthor;\n\t\tcommitter: ICommitter;\n\t\tmessage: string;\n\t\ttree: ICommitHash;\n\t};\n\tparents: ICommitHash[];\n}\n\n/**\n * Blob content\n * @internal\n */\nexport interface IBlob {\n\tcontent: string;\n\tencoding: string;\n\turl: string;\n\tsha: string;\n\tsize: number;\n}\n\n/**\n * Required params to create blob\n * @internal\n */\nexport interface ICreateBlobParams {\n\t// The encoded content\n\tcontent: string;\n\n\t// The encoding of the content.\n\t// eslint-disable-next-line unicorn/text-encoding-identifier-case\n\tencoding: \"utf-8\" | \"base64\";\n}\n\n/**\n * Response to create blob request\n * @internal\n */\nexport interface ICreateBlobResponse {\n\tsha: string;\n\turl: string;\n}\n\n/**\n * Ref content\n * @internal\n */\nexport interface IRef {\n\tref: string;\n\turl: string;\n\tobject: {\n\t\ttype: string;\n\t\tsha: string;\n\t\turl: string;\n\t};\n}\n\n/**\n * Required params to create ref\n * @legacy\n * @alpha\n */\nexport interface ICreateRefParams {\n\tref: string;\n\tsha: string;\n}\n\n/**\n * Required params to patch ref\n * @legacy\n * @alpha\n */\nexport interface IPatchRefParams {\n\tsha: string;\n\tforce: boolean;\n}\n\n/**\n * Required params to create repo\n * @param name - name of the repository\n * @internal\n */\nexport interface ICreateRepoParams {\n\tname: string;\n}\n\n/**\n * Required details to create tree entry\n * @internal\n */\nexport interface ICreateTreeEntry {\n\tpath: string;\n\tmode: string;\n\ttype: string;\n\tsha: string;\n}\n\n/**\n * Required params to create tree\n * @internal\n */\nexport interface ICreateTreeParams {\n\tbase_tree?: string;\n\ttree: ICreateTreeEntry[];\n}\n\n/**\n * Tree Entry Content\n * @internal\n */\nexport interface ITreeEntry {\n\tpath: string;\n\tmode: string;\n\ttype: string;\n\tsize: number;\n\tsha: string;\n\turl: string;\n}\n\n/**\n * Tree content\n * @internal\n */\nexport interface ITree {\n\tsha: string;\n\turl: string;\n\ttree: ITreeEntry[];\n}\n\n/**\n * Tagger content\n * @internal\n */\nexport interface ITagger {\n\tname: string;\n\temail: string;\n\t// ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ\n\tdate: string;\n}\n\n/**\n * Required params to create tag\n * @internal\n */\nexport interface ICreateTagParams {\n\ttag: string;\n\tmessage: string;\n\tobject: string;\n\ttype: string;\n\ttagger: ITagger;\n}\n\n/**\n * Tag content\n * @internal\n */\nexport interface ITag {\n\ttag: string;\n\tsha: string;\n\turl: string;\n\tmessage: string;\n\ttagger: ITagger;\n\tobject: {\n\t\ttype: string;\n\t\tsha: string;\n\t\turl: string;\n\t};\n}\n"]}
+{"version":3,"file":"resources.js","sourceRoot":"","sources":["../../src/git/resources.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// The types defined in this directory provide strong typing for the deserialized\n// REST payloads when communicating with the Git service.\n//\n// These should not be changed unless Git itself is changed, and should be aligned\n// with the service side definitions contained here:\n//\n// server/routerlicious/packages/gitresources/src/resources.ts\n\n/**\n * Details about the author of the commit\n * @internal\n */\nexport interface IAuthor {\n\tname: string;\n\temail: string;\n\t// ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ\n\tdate: string;\n}\n\n/**\n * Details about the committer of the commit\n * @internal\n */\nexport interface ICommitter {\n\tname: string;\n\temail: string;\n\t// ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ\n\tdate: string;\n}\n\n/**\n * Details of the commit\n * @internal\n */\nexport interface ICommitHash {\n\tsha: string;\n\turl: string;\n}\n\n/**\n * Required params to create commit\n * @internal\n */\nexport interface ICreateCommitParams {\n\tmessage: string;\n\ttree: string;\n\tparents: string[];\n\t// GitHub has signature verification on the author\n\tauthor: IAuthor;\n}\n\n/**\n * Commit content\n * @internal\n */\nexport interface ICommit {\n\tsha: string;\n\turl: string;\n\tauthor: IAuthor;\n\tcommitter: ICommitter;\n\tmessage: string;\n\ttree: ICommitHash;\n\tparents: ICommitHash[];\n}\n\n/**\n * Details of a commit\n *\n * GitHub differentiates the commit resource returned from its git and repos routes. The repos\n * route returns more site specific information (like links to the developer's account) while the git\n * route is what is actually stored in the Git repo\n *\n * https://developer.github.com/v3/git/commits/\n * https://developer.github.com/v3/repos/commits/\n * @internal\n */\nexport interface ICommitDetails {\n\turl: string;\n\tsha: string;\n\tcommit: {\n\t\turl: string;\n\t\tauthor: IAuthor;\n\t\tcommitter: ICommitter;\n\t\tmessage: string;\n\t\ttree: ICommitHash;\n\t};\n\tparents: ICommitHash[];\n}\n\n/**\n * Blob content\n * @internal\n */\nexport interface IBlob {\n\tcontent: string;\n\tencoding: string;\n\turl: string;\n\tsha: string;\n\tsize: number;\n}\n\n/**\n * Required params to create blob\n * @internal\n */\nexport interface ICreateBlobParams {\n\t// The encoded content\n\tcontent: string;\n\n\t// The encoding of the content.\n\t// eslint-disable-next-line unicorn/text-encoding-identifier-case\n\tencoding: \"utf-8\" | \"base64\";\n}\n\n/**\n * Response to create blob request\n * @internal\n */\nexport interface ICreateBlobResponse {\n\tsha: string;\n\turl: string;\n}\n\n/**\n * Ref content\n * @internal\n */\nexport interface IRef {\n\tref: string;\n\turl: string;\n\tobject: {\n\t\ttype: string;\n\t\tsha: string;\n\t\turl: string;\n\t};\n}\n\n/**\n * Required params to create ref\n * @legacy @beta\n */\nexport interface ICreateRefParams {\n\tref: string;\n\tsha: string;\n}\n\n/**\n * Required params to patch ref\n * @legacy @beta\n */\nexport interface IPatchRefParams {\n\tsha: string;\n\tforce: boolean;\n}\n\n/**\n * Required params to create repo\n * @param name - name of the repository\n * @internal\n */\nexport interface ICreateRepoParams {\n\tname: string;\n}\n\n/**\n * Required details to create tree entry\n * @internal\n */\nexport interface ICreateTreeEntry {\n\tpath: string;\n\tmode: string;\n\ttype: string;\n\tsha: string;\n}\n\n/**\n * Required params to create tree\n * @internal\n */\nexport interface ICreateTreeParams {\n\tbase_tree?: string;\n\ttree: ICreateTreeEntry[];\n}\n\n/**\n * Tree Entry Content\n * @internal\n */\nexport interface ITreeEntry {\n\tpath: string;\n\tmode: string;\n\ttype: string;\n\tsize: number;\n\tsha: string;\n\turl: string;\n}\n\n/**\n * Tree content\n * @internal\n */\nexport interface ITree {\n\tsha: string;\n\turl: string;\n\ttree: ITreeEntry[];\n}\n\n/**\n * Tagger content\n * @internal\n */\nexport interface ITagger {\n\tname: string;\n\temail: string;\n\t// ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ\n\tdate: string;\n}\n\n/**\n * Required params to create tag\n * @internal\n */\nexport interface ICreateTagParams {\n\ttag: string;\n\tmessage: string;\n\tobject: string;\n\ttype: string;\n\ttagger: ITagger;\n}\n\n/**\n * Tag content\n * @internal\n */\nexport interface ITag {\n\ttag: string;\n\tsha: string;\n\turl: string;\n\tmessage: string;\n\ttagger: ITagger;\n\tobject: {\n\t\ttype: string;\n\t\tsha: string;\n\t\turl: string;\n\t};\n}\n"]}

lib/protocol/clients.d.ts

@@ -99,4 +99,3 @@ /*!
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -103,0 +102,0 @@ export interface ISignalClient {

lib/protocol/clients.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"clients.d.ts","sourceRoot":"","sources":["../../src/protocol/clients.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,MAAM,CAAC;AAE9C;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC7B;;;;;;;;OAQG;IACH,WAAW,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,YAAY,EAAE,aAAa,CAAC;IAE5B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,cAAc,CAAC;IAExB,UAAU,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IAEZ;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CAChB"}
+{"version":3,"file":"clients.d.ts","sourceRoot":"","sources":["../../src/protocol/clients.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,MAAM,CAAC;AAE9C;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC7B;;;;;;;;OAQG;IACH,WAAW,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,YAAY,EAAE,aAAa,CAAC;IAE5B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,cAAc,CAAC;IAExB,UAAU,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IAEZ;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CAChB"}

lib/protocol/clients.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"clients.js","sourceRoot":"","sources":["../../src/protocol/clients.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IUser } from \"./users.js\";\n\n/**\n * A client's connection mode - either view-only (\"read\") or allowing edits (\"write\").\n *\n * @remarks\n *\n * Note: a user's connection mode is dependent on their permissions.\n * E.g. a user with read-only permissions will not be allowed a \"write\" connection mode.\n * @public\n */\nexport type ConnectionMode = \"write\" | \"read\";\n\n/**\n * Capabilities of a Client.\n * In particular, whether or not the client is {@link ICapabilities.interactive}.\n * @public\n */\nexport interface ICapabilities {\n\t/**\n\t * Indicates if the client represents a potentially interactive session with a user (if 'true') or if it's\n\t * a \"system entity\" (if 'false').\n\t *\n\t * @remarks\n\t *\n\t * The only \"system entity\" scenario at the moment is the\n\t * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer client}.\n\t */\n\tinteractive: boolean;\n}\n\n/**\n * {@link IClient} connection / environment metadata.\n * @public\n */\nexport interface IClientDetails {\n\t/**\n\t * {@inheritDoc ICapabilities}\n\t */\n\tcapabilities: ICapabilities;\n\n\t/**\n\t * The kind of client being described.\n\t *\n\t * `undefined` indicates that the kind could not be determined.\n\t */\n\ttype?: string;\n\n\t/**\n\t * @remarks\n\t *\n\t * If the environment needs to specify multiple properties which gives info about the environment, then\n\t * it should be in particular format like: \"prop1:val1;prop2:val2;prop3:val3\"\n\t */\n\tenvironment?: string;\n\tdevice?: string;\n}\n\n/**\n * Represents a client connected to a Fluid service, including associated user details, permissions, and connection mode.\n * @public\n */\nexport interface IClient {\n\t/**\n\t * {@inheritDoc ConnectionMode}\n\t */\n\tmode: ConnectionMode;\n\n\t/**\n\t * {@inheritDoc IClientDetails}\n\t */\n\tdetails: IClientDetails;\n\n\tpermission: string[];\n\n\t/**\n\t * The user information associated with this client connection.\n\t */\n\tuser: IUser;\n\n\t/**\n\t * Enumerates actions allowed for the client connection.\n\t */\n\tscopes: string[];\n\n\t/**\n\t * The time the client connected to the service.\n\t */\n\ttimestamp?: number;\n}\n\n/**\n * A {@link IClient} that has been acknowledged by the sequencer.\n * @public\n */\nexport interface ISequencedClient {\n\t/**\n\t * The underlying client details.\n\t */\n\tclient: IClient;\n\n\t/**\n\t * The sequence number of the \"join\" message sent when the client joined the session.\n\t */\n\tsequenceNumber: number;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface ISignalClient {\n\t/**\n\t * The {@link ISignalClient.client}'s unique ID.\n\t */\n\tclientId: string;\n\n\t/**\n\t * The underlying client details.\n\t */\n\tclient: IClient;\n\n\t/**\n\t * Counts the number of signals sent by the client.\n\t */\n\tclientConnectionNumber?: number;\n\n\t/**\n\t * Sequence number that indicates when the signal was created in relation to the delta stream.\n\t */\n\treferenceSequenceNumber?: number;\n}\n\n/**\n * Contents sent with a `ClientJoin` message.\n * @internal\n */\nexport interface IClientJoin {\n\t/**\n\t * The ID of the joining client.\n\t */\n\tclientId: string;\n\n\t/**\n\t * The underlying client details.\n\t */\n\tdetail: IClient;\n}\n"]}
+{"version":3,"file":"clients.js","sourceRoot":"","sources":["../../src/protocol/clients.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IUser } from \"./users.js\";\n\n/**\n * A client's connection mode - either view-only (\"read\") or allowing edits (\"write\").\n *\n * @remarks\n *\n * Note: a user's connection mode is dependent on their permissions.\n * E.g. a user with read-only permissions will not be allowed a \"write\" connection mode.\n * @public\n */\nexport type ConnectionMode = \"write\" | \"read\";\n\n/**\n * Capabilities of a Client.\n * In particular, whether or not the client is {@link ICapabilities.interactive}.\n * @public\n */\nexport interface ICapabilities {\n\t/**\n\t * Indicates if the client represents a potentially interactive session with a user (if 'true') or if it's\n\t * a \"system entity\" (if 'false').\n\t *\n\t * @remarks\n\t *\n\t * The only \"system entity\" scenario at the moment is the\n\t * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer client}.\n\t */\n\tinteractive: boolean;\n}\n\n/**\n * {@link IClient} connection / environment metadata.\n * @public\n */\nexport interface IClientDetails {\n\t/**\n\t * {@inheritDoc ICapabilities}\n\t */\n\tcapabilities: ICapabilities;\n\n\t/**\n\t * The kind of client being described.\n\t *\n\t * `undefined` indicates that the kind could not be determined.\n\t */\n\ttype?: string;\n\n\t/**\n\t * @remarks\n\t *\n\t * If the environment needs to specify multiple properties which gives info about the environment, then\n\t * it should be in particular format like: \"prop1:val1;prop2:val2;prop3:val3\"\n\t */\n\tenvironment?: string;\n\tdevice?: string;\n}\n\n/**\n * Represents a client connected to a Fluid service, including associated user details, permissions, and connection mode.\n * @public\n */\nexport interface IClient {\n\t/**\n\t * {@inheritDoc ConnectionMode}\n\t */\n\tmode: ConnectionMode;\n\n\t/**\n\t * {@inheritDoc IClientDetails}\n\t */\n\tdetails: IClientDetails;\n\n\tpermission: string[];\n\n\t/**\n\t * The user information associated with this client connection.\n\t */\n\tuser: IUser;\n\n\t/**\n\t * Enumerates actions allowed for the client connection.\n\t */\n\tscopes: string[];\n\n\t/**\n\t * The time the client connected to the service.\n\t */\n\ttimestamp?: number;\n}\n\n/**\n * A {@link IClient} that has been acknowledged by the sequencer.\n * @public\n */\nexport interface ISequencedClient {\n\t/**\n\t * The underlying client details.\n\t */\n\tclient: IClient;\n\n\t/**\n\t * The sequence number of the \"join\" message sent when the client joined the session.\n\t */\n\tsequenceNumber: number;\n}\n\n/**\n * @legacy @beta\n */\nexport interface ISignalClient {\n\t/**\n\t * The {@link ISignalClient.client}'s unique ID.\n\t */\n\tclientId: string;\n\n\t/**\n\t * The underlying client details.\n\t */\n\tclient: IClient;\n\n\t/**\n\t * Counts the number of signals sent by the client.\n\t */\n\tclientConnectionNumber?: number;\n\n\t/**\n\t * Sequence number that indicates when the signal was created in relation to the delta stream.\n\t */\n\treferenceSequenceNumber?: number;\n}\n\n/**\n * Contents sent with a `ClientJoin` message.\n * @internal\n */\nexport interface IClientJoin {\n\t/**\n\t * The ID of the joining client.\n\t */\n\tclientId: string;\n\n\t/**\n\t * The underlying client details.\n\t */\n\tdetail: IClient;\n}\n"]}

lib/protocol/config.d.ts

@@ -7,4 +7,3 @@ /*!
  * Key value store of service configuration properties provided to the client as part of connection.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -11,0 +10,0 @@ export interface IClientConfiguration {

lib/protocol/config.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/protocol/config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC5B"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/protocol/config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC5B"}

lib/protocol/config.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/protocol/config.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Key value store of service configuration properties provided to the client as part of connection.\n * @legacy\n * @alpha\n */\nexport interface IClientConfiguration {\n\t/**\n\t * Max message size the server will accept before requiring chunking.\n\t */\n\tmaxMessageSize: number;\n\n\t/**\n\t * Server-defined ideal block size for storing snapshots.\n\t */\n\tblockSize: number;\n\n\t/**\n\t * noopTimeFrequency & noopCountFrequency control how often a client with \"write\" connection needs to send\n\t * noop messages in case no other ops are being sent. Any op (including noops) result in client\n\t * communicating its reference sequence number to the relay service, which can recalculate MSN based on new info.\n\t * Clients send noops when either noopTimeFrequency ms elapsed from receiving the last op or when receiving\n\t * noopCountFrequency ops and only if the client did not have a chance to communicate its reference sequence\n\t * number via regular ops.\n\t * 'Infinity' will disable this feature and if no value is provided, the client choses some reasonable value.\n\t */\n\tnoopTimeFrequency?: number;\n\n\t/**\n\t * Set min op frequency with which noops would be sent in case of an active connection which is not sending any op.\n\t * See {@link IClientConfiguration.noopTimeFrequency} for more details.\n\t * 'Infinity' will disable this feature and if no value is provided, the client choses some reasonable value.\n\t */\n\tnoopCountFrequency?: number;\n}\n"]}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/protocol/config.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Key value store of service configuration properties provided to the client as part of connection.\n * @legacy @beta\n */\nexport interface IClientConfiguration {\n\t/**\n\t * Max message size the server will accept before requiring chunking.\n\t */\n\tmaxMessageSize: number;\n\n\t/**\n\t * Server-defined ideal block size for storing snapshots.\n\t */\n\tblockSize: number;\n\n\t/**\n\t * noopTimeFrequency & noopCountFrequency control how often a client with \"write\" connection needs to send\n\t * noop messages in case no other ops are being sent. Any op (including noops) result in client\n\t * communicating its reference sequence number to the relay service, which can recalculate MSN based on new info.\n\t * Clients send noops when either noopTimeFrequency ms elapsed from receiving the last op or when receiving\n\t * noopCountFrequency ops and only if the client did not have a chance to communicate its reference sequence\n\t * number via regular ops.\n\t * 'Infinity' will disable this feature and if no value is provided, the client choses some reasonable value.\n\t */\n\tnoopTimeFrequency?: number;\n\n\t/**\n\t * Set min op frequency with which noops would be sent in case of an active connection which is not sending any op.\n\t * See {@link IClientConfiguration.noopTimeFrequency} for more details.\n\t * 'Infinity' will disable this feature and if no value is provided, the client choses some reasonable value.\n\t */\n\tnoopCountFrequency?: number;\n}\n"]}

lib/protocol/consensus.d.ts

@@ -13,4 +13,3 @@ /*!
  * the proposal.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -29,4 +28,3 @@ export interface IProposal {
  * Similar to {@link IProposal} except it also includes the sequence number when it was made.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -38,4 +36,3 @@ export type ISequencedProposal = {
  * Adds the sequence number at which the message was approved to an {@link ISequencedProposal}.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -47,4 +44,3 @@ export type IApprovedProposal = {
  * Adds the sequence number at which the message was committed to an {@link IApprovedProposal}.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -69,4 +65,3 @@ export type ICommittedProposal = {
  * Interface for tracking proposals in the Quorum.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -85,4 +80,3 @@ export interface IQuorumProposals {
  * Interface combining tracking of clients as well as proposals in the Quorum.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -105,4 +99,3 @@ export interface IQuorum extends Omit<IQuorumClients, "on" | "once" | "off">, Omit<IQuorumProposals, "on" | "once" | "off"> {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -109,0 +102,0 @@ export interface IProcessMessageResult {

lib/protocol/consensus.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"consensus.d.ts","sourceRoot":"","sources":["../../src/protocol/consensus.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAErD;;;;;;;;;GASG;AACH,MAAM,WAAW,SAAS;IACzB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAAE,cAAc,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAAC;AAExE;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAAE,sBAAsB,EAAE,MAAM,CAAA;CAAE,GAAG,kBAAkB,CAAC;AAExF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAAE,oBAAoB,EAAE,MAAM,CAAA;CAAE,GAAG,iBAAiB,CAAC;AAEtF;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC5C,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAAC;IAC1D,EAAE,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,KAAK,IAAI,OAAE;IACxF,EAAE,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;IAEhE,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,OAAE;IACrD,IAAI,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;IAC3B,GAAG,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAE1B,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAE1B,EAAE,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,IAAI,OAAE;IAC3E,EAAE,CACD,KAAK,EAAE,iBAAiB,EACxB,QAAQ,EAAE,CACT,cAAc,EAAE,MAAM,EACtB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,sBAAsB,EAAE,MAAM,KAC1B,IAAI,OACR;IAEF,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAC3D,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC7B,GAAG,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,OAChB,SAAQ,IAAI,CAAC,cAAc,EAAE,IAAI,GAAG,MAAM,GAAG,KAAK,CAAC,EAClD,IAAI,CAAC,gBAAgB,EAAE,IAAI,GAAG,MAAM,GAAG,KAAK,CAAC;IAC9C,EAAE,EAAE,cAAc,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAClD,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACpB,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,cAAc,EAAE,MAAM,CAAC;IACvB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,OAAO,EAAE,CAAC,MAAM,EAAE,gBAAgB,CAAC,EAAE,CAAC;IACtC,SAAS,EAAE,CAAC,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IACpD,MAAM,EAAE,CAAC,MAAM,EAAE,kBAAkB,CAAC,EAAE,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACrC,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB"}
+{"version":3,"file":"consensus.d.ts","sourceRoot":"","sources":["../../src/protocol/consensus.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAErD;;;;;;;;GAQG;AACH,MAAM,WAAW,SAAS;IACzB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAAE,cAAc,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAAC;AAExE;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAAE,sBAAsB,EAAE,MAAM,CAAA;CAAE,GAAG,kBAAkB,CAAC;AAExF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAAE,oBAAoB,EAAE,MAAM,CAAA;CAAE,GAAG,iBAAiB,CAAC;AAEtF;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC5C,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAAC;IAC1D,EAAE,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,KAAK,IAAI,OAAE;IACxF,EAAE,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;IAEhE,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,OAAE;IACrD,IAAI,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;IAC3B,GAAG,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAE1B,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAE1B,EAAE,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,IAAI,OAAE;IAC3E,EAAE,CACD,KAAK,EAAE,iBAAiB,EACxB,QAAQ,EAAE,CACT,cAAc,EAAE,MAAM,EACtB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,sBAAsB,EAAE,MAAM,KAC1B,IAAI,OACR;IAEF,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAC3D,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC7B,GAAG,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,OAChB,SAAQ,IAAI,CAAC,cAAc,EAAE,IAAI,GAAG,MAAM,GAAG,KAAK,CAAC,EAClD,IAAI,CAAC,gBAAgB,EAAE,IAAI,GAAG,MAAM,GAAG,KAAK,CAAC;IAC9C,EAAE,EAAE,cAAc,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAClD,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACpB,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,cAAc,EAAE,MAAM,CAAC;IACvB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,OAAO,EAAE,CAAC,MAAM,EAAE,gBAAgB,CAAC,EAAE,CAAC;IACtC,SAAS,EAAE,CAAC,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IACpD,MAAM,EAAE,CAAC,MAAM,EAAE,kBAAkB,CAAC,EAAE,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB"}

lib/protocol/consensus.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"consensus.js","sourceRoot":"","sources":["../../src/protocol/consensus.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ISequencedClient } from \"./clients.js\";\n\n/**\n * Proposal to set the given key/value pair.\n *\n * @remarks\n * Consensus on the proposal is achieved if the MSN is \\>= the sequence number\n * at which the proposal is made and no client within the collaboration window rejects\n * the proposal.\n * @legacy\n * @alpha\n */\nexport interface IProposal {\n\t/**\n\t * The key for the proposal.\n\t */\n\tkey: string;\n\n\t/**\n\t * The value of the proposal.\n\t */\n\tvalue: unknown;\n}\n\n/**\n * Similar to {@link IProposal} except it also includes the sequence number when it was made.\n * @legacy\n * @alpha\n */\nexport type ISequencedProposal = { sequenceNumber: number } & IProposal;\n\n/**\n * Adds the sequence number at which the message was approved to an {@link ISequencedProposal}.\n * @legacy\n * @alpha\n */\nexport type IApprovedProposal = { approvalSequenceNumber: number } & ISequencedProposal;\n\n/**\n * Adds the sequence number at which the message was committed to an {@link IApprovedProposal}.\n * @legacy\n * @alpha\n */\nexport type ICommittedProposal = { commitSequenceNumber: number } & IApprovedProposal;\n\n/**\n * Interface for tracking clients in the Quorum.\n * @public\n */\nexport interface IQuorumClients {\n\tgetMembers(): Map<string, ISequencedClient>;\n\tgetMember(clientId: string): ISequencedClient | undefined;\n\ton(event: \"addMember\", listener: (clientId: string, details: ISequencedClient) => void);\n\ton(event: \"removeMember\", listener: (clientId: string) => void);\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\ton(event: \"error\", listener: (message: any) => void);\n\tonce: IQuorumClients[\"on\"];\n\toff: IQuorumClients[\"on\"];\n}\n\n/**\n * Interface for tracking proposals in the Quorum.\n * @legacy\n * @alpha\n */\nexport interface IQuorumProposals {\n\tpropose(key: string, value: unknown): Promise<void>;\n\n\thas(key: string): boolean;\n\n\tget(key: string): unknown;\n\n\ton(event: \"addProposal\", listener: (proposal: ISequencedProposal) => void);\n\ton(\n\t\tevent: \"approveProposal\",\n\t\tlistener: (\n\t\t\tsequenceNumber: number,\n\t\t\tkey: string,\n\t\t\tvalue: unknown,\n\t\t\tapprovalSequenceNumber: number,\n\t\t) => void,\n\t);\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\ton(event: \"error\", listener: (message: any) => void): void;\n\tonce: IQuorumProposals[\"on\"];\n\toff: IQuorumProposals[\"on\"];\n}\n\n/**\n * Interface combining tracking of clients as well as proposals in the Quorum.\n * @legacy\n * @alpha\n */\nexport interface IQuorum\n\textends Omit<IQuorumClients, \"on\" | \"once\" | \"off\">,\n\t\tOmit<IQuorumProposals, \"on\" | \"once\" | \"off\"> {\n\ton: IQuorumClients[\"on\"] & IQuorumProposals[\"on\"];\n\tonce: IQuorum[\"on\"];\n\toff: IQuorum[\"on\"];\n}\n\n/**\n * @internal\n */\nexport interface IProtocolState {\n\tsequenceNumber: number;\n\tminimumSequenceNumber: number;\n\tmembers: [string, ISequencedClient][];\n\tproposals: [number, ISequencedProposal, string[]][];\n\tvalues: [string, ICommittedProposal][];\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IProcessMessageResult {\n\timmediateNoOp?: boolean;\n}\n"]}
+{"version":3,"file":"consensus.js","sourceRoot":"","sources":["../../src/protocol/consensus.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ISequencedClient } from \"./clients.js\";\n\n/**\n * Proposal to set the given key/value pair.\n *\n * @remarks\n * Consensus on the proposal is achieved if the MSN is \\>= the sequence number\n * at which the proposal is made and no client within the collaboration window rejects\n * the proposal.\n * @legacy @beta\n */\nexport interface IProposal {\n\t/**\n\t * The key for the proposal.\n\t */\n\tkey: string;\n\n\t/**\n\t * The value of the proposal.\n\t */\n\tvalue: unknown;\n}\n\n/**\n * Similar to {@link IProposal} except it also includes the sequence number when it was made.\n * @legacy @beta\n */\nexport type ISequencedProposal = { sequenceNumber: number } & IProposal;\n\n/**\n * Adds the sequence number at which the message was approved to an {@link ISequencedProposal}.\n * @legacy @beta\n */\nexport type IApprovedProposal = { approvalSequenceNumber: number } & ISequencedProposal;\n\n/**\n * Adds the sequence number at which the message was committed to an {@link IApprovedProposal}.\n * @legacy @beta\n */\nexport type ICommittedProposal = { commitSequenceNumber: number } & IApprovedProposal;\n\n/**\n * Interface for tracking clients in the Quorum.\n * @public\n */\nexport interface IQuorumClients {\n\tgetMembers(): Map<string, ISequencedClient>;\n\tgetMember(clientId: string): ISequencedClient | undefined;\n\ton(event: \"addMember\", listener: (clientId: string, details: ISequencedClient) => void);\n\ton(event: \"removeMember\", listener: (clientId: string) => void);\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\ton(event: \"error\", listener: (message: any) => void);\n\tonce: IQuorumClients[\"on\"];\n\toff: IQuorumClients[\"on\"];\n}\n\n/**\n * Interface for tracking proposals in the Quorum.\n * @legacy @beta\n */\nexport interface IQuorumProposals {\n\tpropose(key: string, value: unknown): Promise<void>;\n\n\thas(key: string): boolean;\n\n\tget(key: string): unknown;\n\n\ton(event: \"addProposal\", listener: (proposal: ISequencedProposal) => void);\n\ton(\n\t\tevent: \"approveProposal\",\n\t\tlistener: (\n\t\t\tsequenceNumber: number,\n\t\t\tkey: string,\n\t\t\tvalue: unknown,\n\t\t\tapprovalSequenceNumber: number,\n\t\t) => void,\n\t);\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\ton(event: \"error\", listener: (message: any) => void): void;\n\tonce: IQuorumProposals[\"on\"];\n\toff: IQuorumProposals[\"on\"];\n}\n\n/**\n * Interface combining tracking of clients as well as proposals in the Quorum.\n * @legacy @beta\n */\nexport interface IQuorum\n\textends Omit<IQuorumClients, \"on\" | \"once\" | \"off\">,\n\t\tOmit<IQuorumProposals, \"on\" | \"once\" | \"off\"> {\n\ton: IQuorumClients[\"on\"] & IQuorumProposals[\"on\"];\n\tonce: IQuorum[\"on\"];\n\toff: IQuorum[\"on\"];\n}\n\n/**\n * @internal\n */\nexport interface IProtocolState {\n\tsequenceNumber: number;\n\tminimumSequenceNumber: number;\n\tmembers: [string, ISequencedClient][];\n\tproposals: [number, ISequencedProposal, string[]][];\n\tvalues: [string, ICommittedProposal][];\n}\n\n/**\n * @legacy @beta\n */\nexport interface IProcessMessageResult {\n\timmediateNoOp?: boolean;\n}\n"]}

lib/protocol/date.d.ts

@@ -7,6 +7,5 @@ /*!
  * {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601 format} date: `YYYY-MM-DDTHH:MM:SSZ`.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type IsoDate = string;
 //# sourceMappingURL=date.d.ts.map

lib/protocol/date.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"date.d.ts","sourceRoot":"","sources":["../../src/protocol/date.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC"}
+{"version":3,"file":"date.d.ts","sourceRoot":"","sources":["../../src/protocol/date.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC"}

lib/protocol/date.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"date.js","sourceRoot":"","sources":["../../src/protocol/date.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601 format} date: `YYYY-MM-DDTHH:MM:SSZ`.\n * @legacy\n * @alpha\n */\nexport type IsoDate = string;\n"]}
+{"version":3,"file":"date.js","sourceRoot":"","sources":["../../src/protocol/date.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601 format} date: `YYYY-MM-DDTHH:MM:SSZ`.\n * @legacy @beta\n */\nexport type IsoDate = string;\n"]}

lib/protocol/protocol.d.ts

@@ -7,4 +7,3 @@ /*!
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -83,4 +82,3 @@ export declare enum MessageType {
  * Messages to track latency trace.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -102,4 +100,3 @@ export interface ITrace {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -122,4 +119,3 @@ export interface INack {
  * Document-specific message.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -170,4 +166,3 @@ export interface IDocumentMessage {
  * Branch origin information.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -190,4 +185,3 @@ export interface IBranchOrigin {
  * Sequenced message for a distributed document.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -291,4 +285,3 @@ export interface ISequencedDocumentMessage {
  * Common interface between incoming and outgoing signals.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -320,4 +313,3 @@ export interface ISignalMessageBase<TMessage extends TypedMessage = TypedMessage> {
  * Interface for signals sent by the server to clients.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -337,4 +329,3 @@ export interface ISignalMessage<TMessage extends TypedMessage = TypedMessage> extends ISignalMessageBase<TMessage> {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -348,4 +339,3 @@ export interface IUploadedSummaryDetails {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -387,4 +377,3 @@ export interface ISummaryContent {
  * Data about the original proposed summary message.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -399,4 +388,3 @@ export interface ISummaryProposal {
  * Contents of summary ack expected from the server.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -415,4 +403,3 @@ export interface ISummaryAck {
  * Contents of summary nack expected from the server.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -443,4 +430,3 @@ export interface ISummaryNack {
  * Interface for nack content.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -471,4 +457,3 @@ export interface INackContent {
  * Type of the nack.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -475,0 +460,0 @@ export declare enum NackErrorType {

lib/protocol/protocol.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../../src/protocol/protocol.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0CAA0C,CAAC;AAE7E;;;GAGG;AACH,oBAAY,WAAW;IACtB;;;;;OAKG;IACH,IAAI,SAAS;IAEb;;OAEG;IACH,UAAU,SAAS;IAEnB;;OAEG;IACH,WAAW,UAAU;IAErB;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,UAAU,eAAe;IAEzB;;OAEG;IACH,WAAW,gBAAgB;IAE3B;;OAEG;IACH,SAAS,OAAO;IAEhB;;OAEG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,SAAS,iBAAiB;IAE1B;;OAEG;IACH,OAAO,YAAY;CACnB;AAED;;GAEG;AACH,oBAAY,UAAU;IACrB;;OAEG;IACH,UAAU,SAAS;IAEnB;;OAEG;IACH,WAAW,UAAU;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,MAAM;IACtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACrB;;OAEG;IACH,SAAS,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAExC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC/D,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACzC;;;OAGG;IAEH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;;OAIG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,qCAAqC,GAAG,IAAI,CACvD,yBAAyB,EACzB,UAAU,GAAG,aAAa,CAC1B,GAAG;IACH;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,+BAAgC,SAAQ,yBAAyB;IACjF,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,kCAAmC,SAAQ,yBAAyB;IACpF,iBAAiB,EAAE,MAAM,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY;IAC/E;;OAEG;IACH,OAAO,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,CAC3E,SAAQ,kBAAkB,CAAC,QAAQ,CAAC;IACpC;;;OAGG;IAEH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,IAC1E,kBAAkB,CAAC,QAAQ,CAAC,CAAC;AAE9B;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACvC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,uBAAuB,CAAC;CAIlC;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,eAAe,EAAE,gBAAgB,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,eAAe,EAAE,gBAAgB,CAAC;IAElC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC5B;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,oBAAY,aAAa;IACxB;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,iBAAiB,sBAAsB;IAEvC;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,kBAAkB,uBAAuB;CACzC"}
+{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../../src/protocol/protocol.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0CAA0C,CAAC;AAE7E;;GAEG;AACH,oBAAY,WAAW;IACtB;;;;;OAKG;IACH,IAAI,SAAS;IAEb;;OAEG;IACH,UAAU,SAAS;IAEnB;;OAEG;IACH,WAAW,UAAU;IAErB;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,UAAU,eAAe;IAEzB;;OAEG;IACH,WAAW,gBAAgB;IAE3B;;OAEG;IACH,SAAS,OAAO;IAEhB;;OAEG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,SAAS,iBAAiB;IAE1B;;OAEG;IACH,OAAO,YAAY;CACnB;AAED;;GAEG;AACH,oBAAY,UAAU;IACrB;;OAEG;IACH,UAAU,SAAS;IAEnB;;OAEG;IACH,WAAW,UAAU;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM;IACtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACrB;;OAEG;IACH,SAAS,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAExC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC/D,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACzC;;;OAGG;IAEH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;;OAIG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,qCAAqC,GAAG,IAAI,CACvD,yBAAyB,EACzB,UAAU,GAAG,aAAa,CAC1B,GAAG;IACH;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,+BAAgC,SAAQ,yBAAyB;IACjF,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,kCAAmC,SAAQ,yBAAyB;IACpF,iBAAiB,EAAE,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY;IAC/E;;OAEG;IACH,OAAO,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,CAC3E,SAAQ,kBAAkB,CAAC,QAAQ,CAAC;IACpC;;;OAGG;IAEH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,IAC1E,kBAAkB,CAAC,QAAQ,CAAC,CAAC;AAE9B;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,uBAAuB,CAAC;CAIlC;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,eAAe,EAAE,gBAAgB,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,eAAe,EAAE,gBAAgB,CAAC;IAElC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC5B;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,oBAAY,aAAa;IACxB;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,iBAAiB,sBAAsB;IAEvC;;OAEG;IACH,eAAe,oBAAoB;IAEnC;;OAEG;IACH,kBAAkB,uBAAuB;CACzC"}

lib/protocol/protocol.js

@@ -6,4 +6,3 @@ /*!
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -84,4 +83,3 @@ export var MessageType;
  * Type of the nack.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -88,0 +86,0 @@ export var NackErrorType;

lib/protocol/protocol.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../../src/protocol/protocol.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;;GAGG;AACH,MAAM,CAAN,IAAY,WAoEX;AApED,WAAY,WAAW;IACtB;;;;;OAKG;IACH,4BAAa,CAAA;IAEb;;OAEG;IACH,kCAAmB,CAAA;IAEnB;;OAEG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,kCAAmB,CAAA;IAEnB;;OAEG;IACH,gCAAiB,CAAA;IAEjB;;OAEG;IACH,gCAAiB,CAAA;IAEjB;;OAEG;IACH,sCAAuB,CAAA;IAEvB;;OAEG;IACH,wCAAyB,CAAA;IAEzB;;OAEG;IACH,0CAA2B,CAAA;IAE3B;;OAEG;IACH,+BAAgB,CAAA;IAEhB;;OAEG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,yCAA0B,CAAA;IAE1B;;OAEG;IACH,kCAAmB,CAAA;AACpB,CAAC,EApEW,WAAW,KAAX,WAAW,QAoEtB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,UAUX;AAVD,WAAY,UAAU;IACrB;;OAEG;IACH,iCAAmB,CAAA;IAEnB;;OAEG;IACH,mCAAqB,CAAA;AACtB,CAAC,EAVW,UAAU,KAAV,UAAU,QAUrB;AAicD;;;;GAIG;AACH,MAAM,CAAN,IAAY,aAoBX;AApBD,WAAY,aAAa;IACxB;;OAEG;IACH,oDAAmC,CAAA;IAEnC;;OAEG;IACH,wDAAuC,CAAA;IAEvC;;OAEG;IACH,oDAAmC,CAAA;IAEnC;;OAEG;IACH,0DAAyC,CAAA;AAC1C,CAAC,EApBW,aAAa,KAAb,aAAa,QAoBxB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { TypedMessage } from \"@fluidframework/core-interfaces/internal\";\n\n/**\n * @legacy\n * @alpha\n */\nexport enum MessageType {\n\t/**\n\t * Empty operation message. Used to send an updated reference sequence number.\n\t * Relay service is free to coalesce these messages or fully drop them, if\n\t * another message was used to update MSN to a number equal or higher than referenced\n\t * sequence number in Noop.\n\t */\n\tNoOp = \"noop\",\n\n\t/**\n\t * System message sent to indicate a new client has joined the collaboration.\n\t */\n\tClientJoin = \"join\",\n\n\t/**\n\t * System message sent to indicate a client has left the collaboration.\n\t */\n\tClientLeave = \"leave\",\n\n\t/**\n\t * Proposes a new consensus value.\n\t */\n\tPropose = \"propose\",\n\n\t/**\n\t * Message used to reject a pending proposal.\n\t */\n\tReject = \"reject\",\n\n\t/**\n\t * Message sent by client accepting proposal\n\t */\n\tAccept = \"accept\",\n\n\t/**\n\t * Summary operation (message).\n\t */\n\tSummarize = \"summarize\",\n\n\t/**\n\t * Summary operation (message) written.\n\t */\n\tSummaryAck = \"summaryAck\",\n\n\t/**\n\t * Summary operation (message) write failure.\n\t */\n\tSummaryNack = \"summaryNack\",\n\n\t/**\n\t * Operation (message) produced by container runtime.\n\t */\n\tOperation = \"op\",\n\n\t/**\n\t * Message to indicate that no active clients are present.\n\t */\n\tNoClient = \"noClient\",\n\n\t/**\n\t * Message to indicate successful round trip.\n\t */\n\tRoundTrip = \"tripComplete\",\n\n\t/**\n\t * Service specific control messages that are never sequenced.\n\t */\n\tControl = \"control\",\n}\n\n/**\n * @internal\n */\nexport enum SignalType {\n\t/**\n\t * System signal sent to indicate a new client has joined the collaboration.\n\t */\n\tClientJoin = \"join\",\n\n\t/**\n\t * System signal sent to indicate a client has left the collaboration.\n\t */\n\tClientLeave = \"leave\",\n}\n\n/**\n * Messages to track latency trace.\n * @legacy\n * @alpha\n */\nexport interface ITrace {\n\t/**\n\t * Service generating the trace.\n\t */\n\tservice: string;\n\n\t/**\n\t * Denotes receiving/sending.\n\t */\n\taction: string;\n\n\t/**\n\t * Floating point time in milliseconds with up to nanosecond precision.\n\t */\n\ttimestamp: number;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface INack {\n\t/**\n\t * The operation that was just nacked.\n\t */\n\toperation: IDocumentMessage | undefined;\n\n\t/**\n\t * The sequence number the client needs to catch up to before retrying.\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * Detail info about the nack.\n\t */\n\tcontent: INackContent;\n}\n\n/**\n * Document-specific message.\n * @legacy\n * @alpha\n */\nexport interface IDocumentMessage {\n\t/**\n\t * The document's client sequence number.\n\t */\n\tclientSequenceNumber: number;\n\n\t/**\n\t * The reference sequence number the message was sent relative to.\n\t */\n\treferenceSequenceNumber: number;\n\n\t/**\n\t * The type of document message being sent.\n\t */\n\ttype: string;\n\n\t/**\n\t * The contents of the message.\n\t */\n\tcontents: unknown;\n\n\t/**\n\t * App provided metadata about the operation.\n\t */\n\tmetadata?: unknown;\n\n\t/**\n\t * Server provided metadata about the operation.\n\t */\n\tserverMetadata?: unknown;\n\n\t/**\n\t * Traces related to the packet.\n\t */\n\ttraces?: ITrace[];\n\n\t/**\n\t * The compression algorithm that was used to compress contents of this message.\n\t * @experimental Not ready for use\n\t */\n\tcompression?: string;\n}\n\n/**\n * Document Message with optional system level data field.\n * @internal\n */\nexport interface IDocumentSystemMessage extends IDocumentMessage {\n\tdata: string;\n}\n\n/**\n * Branch origin information.\n * @legacy\n * @alpha\n */\nexport interface IBranchOrigin {\n\t/**\n\t * Origin branch of the message.\n\t */\n\tid: string;\n\n\t/**\n\t * Sequence number for the message in branch ID.\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * Minimum sequence number for the message in branch ID.\n\t */\n\tminimumSequenceNumber: number;\n}\n\n/**\n * Sequenced message for a distributed document.\n * @legacy\n * @alpha\n */\nexport interface ISequencedDocumentMessage {\n\t/**\n\t * The client ID that submitted the message.\n\t * For server generated messages the clientId will be null;\n\t */\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tclientId: string | null;\n\n\t/**\n\t * The sequenced identifier.\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * The minimum sequence number for all connected clients.\n\t */\n\tminimumSequenceNumber: number;\n\n\t/**\n\t * The document's client sequence number.\n\t */\n\tclientSequenceNumber: number;\n\n\t/**\n\t * The reference sequence number the message was sent relative to.\n\t */\n\treferenceSequenceNumber: number;\n\n\t/**\n\t * The type of operation.\n\t */\n\ttype: string;\n\n\t/**\n\t * The contents of the message.\n\t */\n\tcontents: unknown;\n\n\t/**\n\t * App provided metadata about the operation.\n\t */\n\tmetadata?: unknown;\n\n\t/**\n\t * Server provided metadata about the operation.\n\t */\n\tserverMetadata?: unknown;\n\n\t/**\n\t * Origin branch information for the message.\n\t *\n\t * @remarks Can be marked undefined if the current message is also the origin.\n\t */\n\torigin?: IBranchOrigin;\n\n\t/**\n\t * Traces related to the packet.\n\t */\n\ttraces?: ITrace[];\n\n\t/**\n\t * Timestamp when the server ticketed the message.\n\t */\n\ttimestamp: number;\n\n\t/**\n\t * Data provided by service. Only present in service generated messages.\n\t */\n\tdata?: string;\n\n\t/**\n\t * Experimental field for storing the rolling hash at sequence number.\n\t *\n\t * @deprecated Use ISequencedDocumentMessageExperimental instead.\n\t */\n\texpHash1?: string;\n\n\t/**\n\t * The compression algorithm that was used to compress contents of this message.\n\t *\n\t * @deprecated Use ISequencedDocumentMessageExperimental instead.\n\t */\n\tcompression?: string;\n}\n\n/**\n * {@link ISequencedDocumentAugmentedMessage} with experimental properties.\n * @internal\n */\nexport type ISequencedDocumentMessageExperimental = Omit<\n\tISequencedDocumentMessage,\n\t\"expHash1\" | \"compression\"\n> & {\n\t/**\n\t * Stores the rolling hash at sequence number.\n\t */\n\texpHash1?: string;\n\n\t/**\n\t * The compression algorithm that was used to compress contents of this message.\n\t */\n\tcompression?: string;\n};\n\n/**\n * @internal\n */\nexport interface ISequencedDocumentSystemMessage extends ISequencedDocumentMessage {\n\tdata: string;\n}\n\n/**\n * @internal\n */\nexport interface ISequencedDocumentAugmentedMessage extends ISequencedDocumentMessage {\n\tadditionalContent: string;\n}\n\n/**\n * Common interface between incoming and outgoing signals.\n * @legacy\n * @alpha\n */\nexport interface ISignalMessageBase<TMessage extends TypedMessage = TypedMessage> {\n\t/**\n\t * Signal content\n\t */\n\tcontent: TMessage[\"content\"];\n\n\t/**\n\t * Signal type\n\t */\n\ttype?: TMessage[\"type\"];\n\n\t/**\n\t * Counts the number of signals sent by the sending client.\n\t */\n\tclientConnectionNumber?: number;\n\n\t/**\n\t * Sequence number that indicates when the signal was created in relation to the delta stream\n\t */\n\treferenceSequenceNumber?: number;\n\n\t/**\n\t * Client ID of the singular client the signal is being (or has been) sent to.\n\t * May only be specified when IConnect.supportedFeatures['submit_signals_v2'] is true, will throw otherwise.\n\t */\n\ttargetClientId?: string;\n}\n\n/**\n * Interface for signals sent by the server to clients.\n * @legacy\n * @alpha\n */\nexport interface ISignalMessage<TMessage extends TypedMessage = TypedMessage>\n\textends ISignalMessageBase<TMessage> {\n\t/**\n\t * The client ID that submitted the message.\n\t * For server generated messages the clientId will be null.\n\t */\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tclientId: string | null;\n}\n\n/**\n * Interface for signals sent by clients to the server.\n * @internal\n */\nexport type ISentSignalMessage<TMessage extends TypedMessage = TypedMessage> =\n\tISignalMessageBase<TMessage>;\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IUploadedSummaryDetails {\n\t/**\n\t * Indicates whether the uploaded summary contains \".protocol\" tree.\n\t */\n\tincludesProtocolTree?: boolean;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface ISummaryContent {\n\t/**\n\t * Handle reference to the summary data.\n\t */\n\thandle: string;\n\n\t/**\n\t * Message included as part of the summary.\n\t */\n\tmessage: string;\n\n\t/**\n\t * Handles to parent summaries of the proposed new summary.\n\t */\n\tparents: string[];\n\n\t/**\n\t * Handle to the current latest summary stored by the service\n\t */\n\thead: string;\n\n\t/**\n\t * Details of the uploaded summary.\n\t */\n\tdetails?: IUploadedSummaryDetails;\n\n\t// TODO - need an epoch/reload bit to indicate to clients that the summary has changed and requires a reload\n\t// This could be encoded in the summary itself as well but then would require the client to download it to check\n}\n\n/**\n * General errors returned from the server.\n * May want to add error code or something similar in the future.\n * @internal\n */\nexport interface IServerError {\n\t/**\n\t * Message describing the server error.\n\t */\n\terrorMessage: string;\n}\n\n/**\n * Data about the original proposed summary message.\n * @legacy\n * @alpha\n */\nexport interface ISummaryProposal {\n\t/**\n\t * Actual sequence number of the summary message proposal.\n\t */\n\tsummarySequenceNumber: number;\n}\n\n/**\n * Contents of summary ack expected from the server.\n * @legacy\n * @alpha\n */\nexport interface ISummaryAck {\n\t/**\n\t * Handle of the complete summary.\n\t */\n\thandle: string;\n\n\t/**\n\t * Information about the proposed summary message.\n\t */\n\tsummaryProposal: ISummaryProposal;\n}\n\n/**\n * Contents of summary nack expected from the server.\n * @legacy\n * @alpha\n */\nexport interface ISummaryNack {\n\t/**\n\t * Information about the proposed summary message.\n\t */\n\tsummaryProposal: ISummaryProposal;\n\n\t/**\n\t * An error code number that represents the error. It will be a valid HTTP error code.\n\t * 403 errors are non retriable.\n\t * 400 errors are always immediately retriable.\n\t * 429 errors are retriable or non retriable (depends on type field).\n\t */\n\tcode?: number;\n\n\t/**\n\t * A message about the error for debugging/logging/telemetry purposes\n\t */\n\tmessage?: string;\n\n\t/**\n\t * Optional Retry-After time in seconds.\n\t * If specified, the client should wait this many seconds before retrying.8\n\t */\n\tretryAfter?: number;\n}\n\n/**\n * Interface for nack content.\n * @legacy\n * @alpha\n */\nexport interface INackContent {\n\t/**\n\t * An error code number that represents the error. It will be a valid HTTP error code.\n\t * 403 errors are non retriable and client should acquire a new identity before reconnection.\n\t * 400 errors are always immediately retriable\n\t * 429 errors are retriable or non retriable (depends on type field).\n\t */\n\tcode: number;\n\n\t/**\n\t * Type of the Nack.\n\t */\n\ttype: NackErrorType;\n\n\t/**\n\t * A message about the nack for debugging/logging/telemetry purposes\n\t */\n\tmessage: string;\n\n\t/**\n\t * Optional Retry-After time in seconds\n\t * If specified, the client should wait this many seconds before retrying\n\t */\n\tretryAfter?: number;\n}\n\n/**\n * Type of the nack.\n * @legacy\n * @alpha\n */\nexport enum NackErrorType {\n\t/**\n\t * Retriable after {@link ISummaryNack.retryAfter} seconds.\n\t */\n\tThrottlingError = \"ThrottlingError\",\n\n\t/**\n\t * Client's token is not valid for the intended message.\n\t */\n\tInvalidScopeError = \"InvalidScopeError\",\n\n\t/**\n\t * Clients message is invalid and should retry immediately with a valid message.\n\t */\n\tBadRequestError = \"BadRequestError\",\n\n\t/**\n\t * Service is having issues. Client should not retry.\n\t */\n\tLimitExceededError = \"LimitExceededError\",\n}\n"]}
+{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../../src/protocol/protocol.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;GAEG;AACH,MAAM,CAAN,IAAY,WAoEX;AApED,WAAY,WAAW;IACtB;;;;;OAKG;IACH,4BAAa,CAAA;IAEb;;OAEG;IACH,kCAAmB,CAAA;IAEnB;;OAEG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,kCAAmB,CAAA;IAEnB;;OAEG;IACH,gCAAiB,CAAA;IAEjB;;OAEG;IACH,gCAAiB,CAAA;IAEjB;;OAEG;IACH,sCAAuB,CAAA;IAEvB;;OAEG;IACH,wCAAyB,CAAA;IAEzB;;OAEG;IACH,0CAA2B,CAAA;IAE3B;;OAEG;IACH,+BAAgB,CAAA;IAEhB;;OAEG;IACH,oCAAqB,CAAA;IAErB;;OAEG;IACH,yCAA0B,CAAA;IAE1B;;OAEG;IACH,kCAAmB,CAAA;AACpB,CAAC,EApEW,WAAW,KAAX,WAAW,QAoEtB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,UAUX;AAVD,WAAY,UAAU;IACrB;;OAEG;IACH,iCAAmB,CAAA;IAEnB;;OAEG;IACH,mCAAqB,CAAA;AACtB,CAAC,EAVW,UAAU,KAAV,UAAU,QAUrB;AAobD;;;GAGG;AACH,MAAM,CAAN,IAAY,aAoBX;AApBD,WAAY,aAAa;IACxB;;OAEG;IACH,oDAAmC,CAAA;IAEnC;;OAEG;IACH,wDAAuC,CAAA;IAEvC;;OAEG;IACH,oDAAmC,CAAA;IAEnC;;OAEG;IACH,0DAAyC,CAAA;AAC1C,CAAC,EApBW,aAAa,KAAb,aAAa,QAoBxB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { TypedMessage } from \"@fluidframework/core-interfaces/internal\";\n\n/**\n * @legacy @beta\n */\nexport enum MessageType {\n\t/**\n\t * Empty operation message. Used to send an updated reference sequence number.\n\t * Relay service is free to coalesce these messages or fully drop them, if\n\t * another message was used to update MSN to a number equal or higher than referenced\n\t * sequence number in Noop.\n\t */\n\tNoOp = \"noop\",\n\n\t/**\n\t * System message sent to indicate a new client has joined the collaboration.\n\t */\n\tClientJoin = \"join\",\n\n\t/**\n\t * System message sent to indicate a client has left the collaboration.\n\t */\n\tClientLeave = \"leave\",\n\n\t/**\n\t * Proposes a new consensus value.\n\t */\n\tPropose = \"propose\",\n\n\t/**\n\t * Message used to reject a pending proposal.\n\t */\n\tReject = \"reject\",\n\n\t/**\n\t * Message sent by client accepting proposal\n\t */\n\tAccept = \"accept\",\n\n\t/**\n\t * Summary operation (message).\n\t */\n\tSummarize = \"summarize\",\n\n\t/**\n\t * Summary operation (message) written.\n\t */\n\tSummaryAck = \"summaryAck\",\n\n\t/**\n\t * Summary operation (message) write failure.\n\t */\n\tSummaryNack = \"summaryNack\",\n\n\t/**\n\t * Operation (message) produced by container runtime.\n\t */\n\tOperation = \"op\",\n\n\t/**\n\t * Message to indicate that no active clients are present.\n\t */\n\tNoClient = \"noClient\",\n\n\t/**\n\t * Message to indicate successful round trip.\n\t */\n\tRoundTrip = \"tripComplete\",\n\n\t/**\n\t * Service specific control messages that are never sequenced.\n\t */\n\tControl = \"control\",\n}\n\n/**\n * @internal\n */\nexport enum SignalType {\n\t/**\n\t * System signal sent to indicate a new client has joined the collaboration.\n\t */\n\tClientJoin = \"join\",\n\n\t/**\n\t * System signal sent to indicate a client has left the collaboration.\n\t */\n\tClientLeave = \"leave\",\n}\n\n/**\n * Messages to track latency trace.\n * @legacy @beta\n */\nexport interface ITrace {\n\t/**\n\t * Service generating the trace.\n\t */\n\tservice: string;\n\n\t/**\n\t * Denotes receiving/sending.\n\t */\n\taction: string;\n\n\t/**\n\t * Floating point time in milliseconds with up to nanosecond precision.\n\t */\n\ttimestamp: number;\n}\n\n/**\n * @legacy @beta\n */\nexport interface INack {\n\t/**\n\t * The operation that was just nacked.\n\t */\n\toperation: IDocumentMessage | undefined;\n\n\t/**\n\t * The sequence number the client needs to catch up to before retrying.\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * Detail info about the nack.\n\t */\n\tcontent: INackContent;\n}\n\n/**\n * Document-specific message.\n * @legacy @beta\n */\nexport interface IDocumentMessage {\n\t/**\n\t * The document's client sequence number.\n\t */\n\tclientSequenceNumber: number;\n\n\t/**\n\t * The reference sequence number the message was sent relative to.\n\t */\n\treferenceSequenceNumber: number;\n\n\t/**\n\t * The type of document message being sent.\n\t */\n\ttype: string;\n\n\t/**\n\t * The contents of the message.\n\t */\n\tcontents: unknown;\n\n\t/**\n\t * App provided metadata about the operation.\n\t */\n\tmetadata?: unknown;\n\n\t/**\n\t * Server provided metadata about the operation.\n\t */\n\tserverMetadata?: unknown;\n\n\t/**\n\t * Traces related to the packet.\n\t */\n\ttraces?: ITrace[];\n\n\t/**\n\t * The compression algorithm that was used to compress contents of this message.\n\t * @experimental Not ready for use\n\t */\n\tcompression?: string;\n}\n\n/**\n * Document Message with optional system level data field.\n * @internal\n */\nexport interface IDocumentSystemMessage extends IDocumentMessage {\n\tdata: string;\n}\n\n/**\n * Branch origin information.\n * @legacy @beta\n */\nexport interface IBranchOrigin {\n\t/**\n\t * Origin branch of the message.\n\t */\n\tid: string;\n\n\t/**\n\t * Sequence number for the message in branch ID.\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * Minimum sequence number for the message in branch ID.\n\t */\n\tminimumSequenceNumber: number;\n}\n\n/**\n * Sequenced message for a distributed document.\n * @legacy @beta\n */\nexport interface ISequencedDocumentMessage {\n\t/**\n\t * The client ID that submitted the message.\n\t * For server generated messages the clientId will be null;\n\t */\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tclientId: string | null;\n\n\t/**\n\t * The sequenced identifier.\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * The minimum sequence number for all connected clients.\n\t */\n\tminimumSequenceNumber: number;\n\n\t/**\n\t * The document's client sequence number.\n\t */\n\tclientSequenceNumber: number;\n\n\t/**\n\t * The reference sequence number the message was sent relative to.\n\t */\n\treferenceSequenceNumber: number;\n\n\t/**\n\t * The type of operation.\n\t */\n\ttype: string;\n\n\t/**\n\t * The contents of the message.\n\t */\n\tcontents: unknown;\n\n\t/**\n\t * App provided metadata about the operation.\n\t */\n\tmetadata?: unknown;\n\n\t/**\n\t * Server provided metadata about the operation.\n\t */\n\tserverMetadata?: unknown;\n\n\t/**\n\t * Origin branch information for the message.\n\t *\n\t * @remarks Can be marked undefined if the current message is also the origin.\n\t */\n\torigin?: IBranchOrigin;\n\n\t/**\n\t * Traces related to the packet.\n\t */\n\ttraces?: ITrace[];\n\n\t/**\n\t * Timestamp when the server ticketed the message.\n\t */\n\ttimestamp: number;\n\n\t/**\n\t * Data provided by service. Only present in service generated messages.\n\t */\n\tdata?: string;\n\n\t/**\n\t * Experimental field for storing the rolling hash at sequence number.\n\t *\n\t * @deprecated Use ISequencedDocumentMessageExperimental instead.\n\t */\n\texpHash1?: string;\n\n\t/**\n\t * The compression algorithm that was used to compress contents of this message.\n\t *\n\t * @deprecated Use ISequencedDocumentMessageExperimental instead.\n\t */\n\tcompression?: string;\n}\n\n/**\n * {@link ISequencedDocumentAugmentedMessage} with experimental properties.\n * @internal\n */\nexport type ISequencedDocumentMessageExperimental = Omit<\n\tISequencedDocumentMessage,\n\t\"expHash1\" | \"compression\"\n> & {\n\t/**\n\t * Stores the rolling hash at sequence number.\n\t */\n\texpHash1?: string;\n\n\t/**\n\t * The compression algorithm that was used to compress contents of this message.\n\t */\n\tcompression?: string;\n};\n\n/**\n * @internal\n */\nexport interface ISequencedDocumentSystemMessage extends ISequencedDocumentMessage {\n\tdata: string;\n}\n\n/**\n * @internal\n */\nexport interface ISequencedDocumentAugmentedMessage extends ISequencedDocumentMessage {\n\tadditionalContent: string;\n}\n\n/**\n * Common interface between incoming and outgoing signals.\n * @legacy @beta\n */\nexport interface ISignalMessageBase<TMessage extends TypedMessage = TypedMessage> {\n\t/**\n\t * Signal content\n\t */\n\tcontent: TMessage[\"content\"];\n\n\t/**\n\t * Signal type\n\t */\n\ttype?: TMessage[\"type\"];\n\n\t/**\n\t * Counts the number of signals sent by the sending client.\n\t */\n\tclientConnectionNumber?: number;\n\n\t/**\n\t * Sequence number that indicates when the signal was created in relation to the delta stream\n\t */\n\treferenceSequenceNumber?: number;\n\n\t/**\n\t * Client ID of the singular client the signal is being (or has been) sent to.\n\t * May only be specified when IConnect.supportedFeatures['submit_signals_v2'] is true, will throw otherwise.\n\t */\n\ttargetClientId?: string;\n}\n\n/**\n * Interface for signals sent by the server to clients.\n * @legacy @beta\n */\nexport interface ISignalMessage<TMessage extends TypedMessage = TypedMessage>\n\textends ISignalMessageBase<TMessage> {\n\t/**\n\t * The client ID that submitted the message.\n\t * For server generated messages the clientId will be null.\n\t */\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tclientId: string | null;\n}\n\n/**\n * Interface for signals sent by clients to the server.\n * @internal\n */\nexport type ISentSignalMessage<TMessage extends TypedMessage = TypedMessage> =\n\tISignalMessageBase<TMessage>;\n\n/**\n * @legacy @beta\n */\nexport interface IUploadedSummaryDetails {\n\t/**\n\t * Indicates whether the uploaded summary contains \".protocol\" tree.\n\t */\n\tincludesProtocolTree?: boolean;\n}\n\n/**\n * @legacy @beta\n */\nexport interface ISummaryContent {\n\t/**\n\t * Handle reference to the summary data.\n\t */\n\thandle: string;\n\n\t/**\n\t * Message included as part of the summary.\n\t */\n\tmessage: string;\n\n\t/**\n\t * Handles to parent summaries of the proposed new summary.\n\t */\n\tparents: string[];\n\n\t/**\n\t * Handle to the current latest summary stored by the service\n\t */\n\thead: string;\n\n\t/**\n\t * Details of the uploaded summary.\n\t */\n\tdetails?: IUploadedSummaryDetails;\n\n\t// TODO - need an epoch/reload bit to indicate to clients that the summary has changed and requires a reload\n\t// This could be encoded in the summary itself as well but then would require the client to download it to check\n}\n\n/**\n * General errors returned from the server.\n * May want to add error code or something similar in the future.\n * @internal\n */\nexport interface IServerError {\n\t/**\n\t * Message describing the server error.\n\t */\n\terrorMessage: string;\n}\n\n/**\n * Data about the original proposed summary message.\n * @legacy @beta\n */\nexport interface ISummaryProposal {\n\t/**\n\t * Actual sequence number of the summary message proposal.\n\t */\n\tsummarySequenceNumber: number;\n}\n\n/**\n * Contents of summary ack expected from the server.\n * @legacy @beta\n */\nexport interface ISummaryAck {\n\t/**\n\t * Handle of the complete summary.\n\t */\n\thandle: string;\n\n\t/**\n\t * Information about the proposed summary message.\n\t */\n\tsummaryProposal: ISummaryProposal;\n}\n\n/**\n * Contents of summary nack expected from the server.\n * @legacy @beta\n */\nexport interface ISummaryNack {\n\t/**\n\t * Information about the proposed summary message.\n\t */\n\tsummaryProposal: ISummaryProposal;\n\n\t/**\n\t * An error code number that represents the error. It will be a valid HTTP error code.\n\t * 403 errors are non retriable.\n\t * 400 errors are always immediately retriable.\n\t * 429 errors are retriable or non retriable (depends on type field).\n\t */\n\tcode?: number;\n\n\t/**\n\t * A message about the error for debugging/logging/telemetry purposes\n\t */\n\tmessage?: string;\n\n\t/**\n\t * Optional Retry-After time in seconds.\n\t * If specified, the client should wait this many seconds before retrying.8\n\t */\n\tretryAfter?: number;\n}\n\n/**\n * Interface for nack content.\n * @legacy @beta\n */\nexport interface INackContent {\n\t/**\n\t * An error code number that represents the error. It will be a valid HTTP error code.\n\t * 403 errors are non retriable and client should acquire a new identity before reconnection.\n\t * 400 errors are always immediately retriable\n\t * 429 errors are retriable or non retriable (depends on type field).\n\t */\n\tcode: number;\n\n\t/**\n\t * Type of the Nack.\n\t */\n\ttype: NackErrorType;\n\n\t/**\n\t * A message about the nack for debugging/logging/telemetry purposes\n\t */\n\tmessage: string;\n\n\t/**\n\t * Optional Retry-After time in seconds\n\t * If specified, the client should wait this many seconds before retrying\n\t */\n\tretryAfter?: number;\n}\n\n/**\n * Type of the nack.\n * @legacy @beta\n */\nexport enum NackErrorType {\n\t/**\n\t * Retriable after {@link ISummaryNack.retryAfter} seconds.\n\t */\n\tThrottlingError = \"ThrottlingError\",\n\n\t/**\n\t * Client's token is not valid for the intended message.\n\t */\n\tInvalidScopeError = \"InvalidScopeError\",\n\n\t/**\n\t * Clients message is invalid and should retry immediately with a valid message.\n\t */\n\tBadRequestError = \"BadRequestError\",\n\n\t/**\n\t * Service is having issues. Client should not retry.\n\t */\n\tLimitExceededError = \"LimitExceededError\",\n}\n"]}

lib/protocol/scopes.d.ts

@@ -7,4 +7,3 @@ /*!
  * Defines scope access for a Container/Document.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -11,0 +10,0 @@ export declare enum ScopeType {

lib/protocol/scopes.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"scopes.d.ts","sourceRoot":"","sources":["../../src/protocol/scopes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AACH,oBAAY,SAAS;IACpB;;OAEG;IACH,OAAO,aAAa;IAEpB;;OAEG;IACH,QAAQ,cAAc;IAEtB;;OAEG;IACH,YAAY,kBAAkB;CAC9B"}
+{"version":3,"file":"scopes.d.ts","sourceRoot":"","sources":["../../src/protocol/scopes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AACH,oBAAY,SAAS;IACpB;;OAEG;IACH,OAAO,aAAa;IAEpB;;OAEG;IACH,QAAQ,cAAc;IAEtB;;OAEG;IACH,YAAY,kBAAkB;CAC9B"}

lib/protocol/scopes.js

@@ -7,4 +7,3 @@ /*!
  * Defines scope access for a Container/Document.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -11,0 +10,0 @@ export var ScopeType;

lib/protocol/scopes.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"scopes.js","sourceRoot":"","sources":["../../src/protocol/scopes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AACH,MAAM,CAAN,IAAY,SAeX;AAfD,WAAY,SAAS;IACpB;;OAEG;IACH,iCAAoB,CAAA;IAEpB;;OAEG;IACH,mCAAsB,CAAA;IAEtB;;OAEG;IACH,2CAA8B,CAAA;AAC/B,CAAC,EAfW,SAAS,KAAT,SAAS,QAepB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Defines scope access for a Container/Document.\n * @legacy\n * @alpha\n */\nexport enum ScopeType {\n\t/**\n\t * Read access is supported on the Container/Document\n\t */\n\tDocRead = \"doc:read\",\n\n\t/**\n\t * Write access is supported on the Container/Document\n\t */\n\tDocWrite = \"doc:write\",\n\n\t/**\n\t * User can generate new summaries operations\n\t */\n\tSummaryWrite = \"summary:write\",\n}\n"]}
+{"version":3,"file":"scopes.js","sourceRoot":"","sources":["../../src/protocol/scopes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AACH,MAAM,CAAN,IAAY,SAeX;AAfD,WAAY,SAAS;IACpB;;OAEG;IACH,iCAAoB,CAAA;IAEpB;;OAEG;IACH,mCAAsB,CAAA;IAEtB;;OAEG;IACH,2CAA8B,CAAA;AAC/B,CAAC,EAfW,SAAS,KAAT,SAAS,QAepB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Defines scope access for a Container/Document.\n * @legacy @beta\n */\nexport enum ScopeType {\n\t/**\n\t * Read access is supported on the Container/Document\n\t */\n\tDocRead = \"doc:read\",\n\n\t/**\n\t * Write access is supported on the Container/Document\n\t */\n\tDocWrite = \"doc:write\",\n\n\t/**\n\t * User can generate new summaries operations\n\t */\n\tSummaryWrite = \"summary:write\",\n}\n"]}

lib/protocol/sockets.d.ts

@@ -11,4 +11,3 @@ /*!
  * Message sent to connect to the given document.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -69,4 +68,3 @@ export interface IConnect {
  * Message sent to indicate a client has connected to the server.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -73,0 +71,0 @@ export interface IConnected {

lib/protocol/sockets.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"sockets.d.ts","sourceRoot":"","sources":["../../src/protocol/sockets.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,KAAK,EAAE,yBAAyB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEhD;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACxB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IAGH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;IAEnB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE5C;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IAC1B;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,eAAe,EAAE,yBAAyB,EAAE,CAAC;IAE7C;;OAEG;IACH,cAAc,EAAE,cAAc,EAAE,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,aAAa,EAAE,CAAC;IAEhC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACH,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE5C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC3B"}
+{"version":3,"file":"sockets.d.ts","sourceRoot":"","sources":["../../src/protocol/sockets.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,KAAK,EAAE,yBAAyB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEhD;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACxB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IAGH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;IAEnB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE5C;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IAC1B;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,eAAe,EAAE,yBAAyB,EAAE,CAAC;IAE7C;;OAEG;IACH,cAAc,EAAE,cAAc,EAAE,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,aAAa,EAAE,CAAC;IAEhC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACH,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE5C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC3B"}

lib/protocol/sockets.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"sockets.js","sourceRoot":"","sources":["../../src/protocol/sockets.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ConnectionMode, IClient, ISignalClient } from \"./clients.js\";\nimport type { IClientConfiguration } from \"./config.js\";\nimport type { ISequencedDocumentMessage, ISignalMessage } from \"./protocol.js\";\nimport type { ITokenClaims } from \"./tokens.js\";\n\n/**\n * Message sent to connect to the given document.\n * @legacy\n * @alpha\n */\nexport interface IConnect {\n\t/**\n\t * The tenant ID for the document.\n\t */\n\ttenantId: string;\n\n\t/**\n\t * The document that is being connected to\n\t */\n\tid: string;\n\n\t/**\n\t * Authorization token\n\t */\n\t// TODO: Update this to use undefined instead of null.\n\t// eslint-disable-next-line @rushstack/no-new-null\n\ttoken: string | null;\n\n\t/**\n\t * Type of the client trying to connect\n\t */\n\tclient: IClient;\n\n\t/**\n\t * Semver list of protocol versions supported by the client ordered in priority of use\n\t */\n\tversions: string[];\n\n\t/**\n\t * Version of the driver which is connecting. It can be used at server to record in telemetry or\n\t * to block/allow specific driver version for specific features.\n\t */\n\tdriverVersion?: string;\n\n\t/**\n\t * Connection mode of client.\n\t */\n\tmode: ConnectionMode;\n\n\t/**\n\t * An optional nonce used during connection to identify connection attempts\n\t */\n\tnonce?: string;\n\n\t/**\n\t * Represents the version of document at client. It should match the version on server\n\t * for connection to be successful.\n\t */\n\tepoch?: string;\n\n\t/**\n\t * A list of optional features that client supports.\n\t * Features supported might be service specific.\n\t * If we have standardized features across all services, they need to be exposed in more structured way.\n\t */\n\tsupportedFeatures?: Record<string, unknown>;\n\n\t/**\n\t * Properties that client can send to server to tell info about client environment. These are a bunch of properties\n\t * separated by \";\" which server can log to better understand client environment etc.\n\t * Format: \"prop1:val1;prop2:val2;prop3:val3\"\n\t */\n\trelayUserAgent?: string;\n}\n\n/**\n * Message sent to indicate a client has connected to the server.\n * @legacy\n * @alpha\n */\nexport interface IConnected {\n\t/**\n\t * Claims for the client\n\t */\n\tclaims: ITokenClaims;\n\n\t/**\n\t * The client who is sending the message\n\t */\n\tclientId: string;\n\n\t/**\n\t * Whether or not this is an existing document\n\t */\n\texisting: boolean;\n\n\t/**\n\t * Maximum size of a message before chunking is required\n\t */\n\tmaxMessageSize: number;\n\n\t/**\n\t * Messages sent during the connection\n\t */\n\tinitialMessages: ISequencedDocumentMessage[];\n\n\t/**\n\t * Signals sent during the connection\n\t */\n\tinitialSignals: ISignalMessage[];\n\n\t/**\n\t * Prior clients already connected.\n\t */\n\tinitialClients: ISignalClient[];\n\n\t/**\n\t * Protocol version selected by the server to communicate with the client\n\t */\n\tversion: string;\n\n\t/**\n\t * List of protocol versions supported by the server\n\t */\n\tsupportedVersions: string[];\n\n\t/**\n\t * Configuration details provided by the service\n\t */\n\tserviceConfiguration: IClientConfiguration;\n\n\t/**\n\t * Connection mode of client.\n\t */\n\tmode: ConnectionMode;\n\n\t/**\n\t * An optional nonce used during connection to identify connection attempts\n\t */\n\tnonce?: string;\n\n\t/**\n\t * Last known sequence number to ordering service at the time of connection\n\t * It may lap actual last sequence number (quite a bit, if container  is very active).\n\t * But it's best information for client to figure out how far it is behind, at least\n\t * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n\t * that is likely to be more up-to-date.\n\t */\n\tcheckpointSequenceNumber?: number;\n\n\t/**\n\t * Represents the version of document at server.\n\t */\n\tepoch?: string;\n\n\t/**\n\t * A list of optional features that ordering service supports.\n\t * Features supported might be service specific.\n\t * If we have standardized features across all services, they need to be exposed in more structured way.\n\t */\n\tsupportedFeatures?: Record<string, unknown>;\n\n\t/**\n\t * The time the client connected\n\t */\n\ttimestamp?: number;\n\n\t/**\n\t * Properties that server can send to client to tell info about node that client is connected to. For ex, for spo\n\t * it could contain info like build version, environment, region etc. These properties can be logged by client\n\t * to better understand server environment etc. and use it in case error occurs.\n\t * Format: \"prop1:val1;prop2:val2;prop3:val3\"\n\t */\n\trelayServiceAgent?: string;\n}\n"]}
+{"version":3,"file":"sockets.js","sourceRoot":"","sources":["../../src/protocol/sockets.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ConnectionMode, IClient, ISignalClient } from \"./clients.js\";\nimport type { IClientConfiguration } from \"./config.js\";\nimport type { ISequencedDocumentMessage, ISignalMessage } from \"./protocol.js\";\nimport type { ITokenClaims } from \"./tokens.js\";\n\n/**\n * Message sent to connect to the given document.\n * @legacy @beta\n */\nexport interface IConnect {\n\t/**\n\t * The tenant ID for the document.\n\t */\n\ttenantId: string;\n\n\t/**\n\t * The document that is being connected to\n\t */\n\tid: string;\n\n\t/**\n\t * Authorization token\n\t */\n\t// TODO: Update this to use undefined instead of null.\n\t// eslint-disable-next-line @rushstack/no-new-null\n\ttoken: string | null;\n\n\t/**\n\t * Type of the client trying to connect\n\t */\n\tclient: IClient;\n\n\t/**\n\t * Semver list of protocol versions supported by the client ordered in priority of use\n\t */\n\tversions: string[];\n\n\t/**\n\t * Version of the driver which is connecting. It can be used at server to record in telemetry or\n\t * to block/allow specific driver version for specific features.\n\t */\n\tdriverVersion?: string;\n\n\t/**\n\t * Connection mode of client.\n\t */\n\tmode: ConnectionMode;\n\n\t/**\n\t * An optional nonce used during connection to identify connection attempts\n\t */\n\tnonce?: string;\n\n\t/**\n\t * Represents the version of document at client. It should match the version on server\n\t * for connection to be successful.\n\t */\n\tepoch?: string;\n\n\t/**\n\t * A list of optional features that client supports.\n\t * Features supported might be service specific.\n\t * If we have standardized features across all services, they need to be exposed in more structured way.\n\t */\n\tsupportedFeatures?: Record<string, unknown>;\n\n\t/**\n\t * Properties that client can send to server to tell info about client environment. These are a bunch of properties\n\t * separated by \";\" which server can log to better understand client environment etc.\n\t * Format: \"prop1:val1;prop2:val2;prop3:val3\"\n\t */\n\trelayUserAgent?: string;\n}\n\n/**\n * Message sent to indicate a client has connected to the server.\n * @legacy @beta\n */\nexport interface IConnected {\n\t/**\n\t * Claims for the client\n\t */\n\tclaims: ITokenClaims;\n\n\t/**\n\t * The client who is sending the message\n\t */\n\tclientId: string;\n\n\t/**\n\t * Whether or not this is an existing document\n\t */\n\texisting: boolean;\n\n\t/**\n\t * Maximum size of a message before chunking is required\n\t */\n\tmaxMessageSize: number;\n\n\t/**\n\t * Messages sent during the connection\n\t */\n\tinitialMessages: ISequencedDocumentMessage[];\n\n\t/**\n\t * Signals sent during the connection\n\t */\n\tinitialSignals: ISignalMessage[];\n\n\t/**\n\t * Prior clients already connected.\n\t */\n\tinitialClients: ISignalClient[];\n\n\t/**\n\t * Protocol version selected by the server to communicate with the client\n\t */\n\tversion: string;\n\n\t/**\n\t * List of protocol versions supported by the server\n\t */\n\tsupportedVersions: string[];\n\n\t/**\n\t * Configuration details provided by the service\n\t */\n\tserviceConfiguration: IClientConfiguration;\n\n\t/**\n\t * Connection mode of client.\n\t */\n\tmode: ConnectionMode;\n\n\t/**\n\t * An optional nonce used during connection to identify connection attempts\n\t */\n\tnonce?: string;\n\n\t/**\n\t * Last known sequence number to ordering service at the time of connection\n\t * It may lap actual last sequence number (quite a bit, if container  is very active).\n\t * But it's best information for client to figure out how far it is behind, at least\n\t * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n\t * that is likely to be more up-to-date.\n\t */\n\tcheckpointSequenceNumber?: number;\n\n\t/**\n\t * Represents the version of document at server.\n\t */\n\tepoch?: string;\n\n\t/**\n\t * A list of optional features that ordering service supports.\n\t * Features supported might be service specific.\n\t * If we have standardized features across all services, they need to be exposed in more structured way.\n\t */\n\tsupportedFeatures?: Record<string, unknown>;\n\n\t/**\n\t * The time the client connected\n\t */\n\ttimestamp?: number;\n\n\t/**\n\t * Properties that server can send to client to tell info about node that client is connected to. For ex, for spo\n\t * it could contain info like build version, environment, region etc. These properties can be logged by client\n\t * to better understand server environment etc. and use it in case error occurs.\n\t * Format: \"prop1:val1;prop2:val2;prop3:val3\"\n\t */\n\trelayServiceAgent?: string;\n}\n"]}

lib/protocol/storage.d.ts

@@ -7,4 +7,3 @@ /*!
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -22,4 +21,3 @@ export interface IDocumentAttributes {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -34,4 +32,3 @@ export declare enum FileMode {
  * Raw blob stored within the tree.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -49,4 +46,3 @@ export interface IBlob {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -57,4 +53,3 @@ export interface IAttachment {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -66,4 +61,3 @@ export interface ICreateBlobResponse {
  * A tree entry wraps a path with a type of node.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -92,4 +86,3 @@ export type ITreeEntry = {
  * Type of entries that can be stored in a tree.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -102,4 +95,3 @@ export declare enum TreeEntry {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -126,4 +118,3 @@ export interface ITree {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -161,4 +152,3 @@ export interface ISnapshotTree {
  * Represents a version of the snapshot of a data store.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -165,0 +155,0 @@ export interface IVersion {

lib/protocol/storage.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../src/protocol/storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,oBAAY,QAAQ;IACnB,IAAI,WAAW;IACf,UAAU,WAAW;IACrB,SAAS,WAAW;IACpB,OAAO,WAAW;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,KAAK;IACrB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IAEH,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B,EAAE,EAAE,MAAM,CAAC;CACX;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,EAAE,EAAE,MAAM,CAAC;CACX;AAED;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,IAAI,EAAE,QAAQ,CAAC;CACf,GAAG,CACD;IACA,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC;CACZ,GACD;IACA,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC;CACZ,GACD;IACA,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC;IAC3B,KAAK,EAAE,WAAW,CAAC;CAClB,CACH,CAAC;AAEF;;;;GAIG;AACH,oBAAY,SAAS;IACpB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,UAAU,eAAe;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACrB,OAAO,EAAE,UAAU,EAAE,CAAC;IAEtB;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC;IAEpB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAClC,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAAA;KAAE,CAAC;IAEzC;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC;IAEpB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,aAAa;IACrD,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,CAAA;KAAE,CAAC;CAC3C;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CACf"}
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../src/protocol/storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,mBAAmB;IACnC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,oBAAY,QAAQ;IACnB,IAAI,WAAW;IACf,UAAU,WAAW;IACrB,SAAS,WAAW;IACpB,OAAO,WAAW;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACrB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IAEH,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B,EAAE,EAAE,MAAM,CAAC;CACX;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IACnC,EAAE,EAAE,MAAM,CAAC;CACX;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,IAAI,EAAE,QAAQ,CAAC;CACf,GAAG,CACD;IACA,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC;CACZ,GACD;IACA,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC;CACZ,GACD;IACA,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC;IAC3B,KAAK,EAAE,WAAW,CAAC;CAClB,CACH,CAAC;AAEF;;;GAGG;AACH,oBAAY,SAAS;IACpB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,UAAU,eAAe;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACrB,OAAO,EAAE,UAAU,EAAE,CAAC;IAEtB;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC;IAEpB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAClC,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAAA;KAAE,CAAC;IAEzC;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC;IAEpB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,aAAa;IACrD,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,CAAA;KAAE,CAAC;CAC3C;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CACf"}

lib/protocol/storage.js

@@ -6,4 +6,3 @@ /*!
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -19,4 +18,3 @@ export var FileMode;
  * Type of entries that can be stored in a tree.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -23,0 +21,0 @@ export var TreeEntry;

lib/protocol/storage.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../src/protocol/storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAoBH;;;GAGG;AACH,MAAM,CAAN,IAAY,QAKX;AALD,WAAY,QAAQ;IACnB,2BAAe,CAAA;IACf,iCAAqB,CAAA;IACrB,gCAAoB,CAAA;IACpB,8BAAkB,CAAA;AACnB,CAAC,EALW,QAAQ,KAAR,QAAQ,QAKnB;AAmED;;;;GAIG;AACH,MAAM,CAAN,IAAY,SAIX;AAJD,WAAY,SAAS;IACpB,0BAAa,CAAA;IACb,0BAAa,CAAA;IACb,sCAAyB,CAAA;AAC1B,CAAC,EAJW,SAAS,KAAT,SAAS,QAIpB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IsoDate } from \"./date.js\";\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IDocumentAttributes {\n\t/**\n\t * Sequence number at which the snapshot was taken\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * Minimum sequence number when the snapshot was taken\n\t */\n\tminimumSequenceNumber: number;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport enum FileMode {\n\tFile = \"100644\",\n\tExecutable = \"100755\",\n\tDirectory = \"040000\",\n\tSymlink = \"120000\",\n}\n\n/**\n * Raw blob stored within the tree.\n * @legacy\n * @alpha\n */\nexport interface IBlob {\n\t/**\n\t * Contents of the blob\n\t */\n\tcontents: string;\n\n\t/**\n\t * The encoding of the contents string\n\t */\n\t// eslint-disable-next-line unicorn/text-encoding-identifier-case\n\tencoding: \"utf-8\" | \"base64\";\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IAttachment {\n\tid: string;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface ICreateBlobResponse {\n\tid: string;\n}\n\n/**\n * A tree entry wraps a path with a type of node.\n * @legacy\n * @alpha\n */\nexport type ITreeEntry = {\n\t/**\n\t * Path to the object\n\t */\n\tpath: string;\n\n\t/**\n\t * The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree)\n\t * or 120000 for a blob that specifies the path of a symlink\n\t */\n\tmode: FileMode;\n} & (\n\t| {\n\t\t\ttype: TreeEntry.Blob;\n\t\t\tvalue: IBlob;\n\t  }\n\t| {\n\t\t\ttype: TreeEntry.Tree;\n\t\t\tvalue: ITree;\n\t  }\n\t| {\n\t\t\ttype: TreeEntry.Attachment;\n\t\t\tvalue: IAttachment;\n\t  }\n);\n\n/**\n * Type of entries that can be stored in a tree.\n * @legacy\n * @alpha\n */\nexport enum TreeEntry {\n\tBlob = \"Blob\",\n\tTree = \"Tree\",\n\tAttachment = \"Attachment\",\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface ITree {\n\tentries: ITreeEntry[];\n\n\t/**\n\t * Unique ID representing all entries in the tree. Can be used to optimize snapshotting in the case\n\t * it is known that the `ITree` has already been created and stored\n\t */\n\tid?: string;\n\n\t/**\n\t * Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced.\n\t */\n\tunreferenced?: true;\n\n\t/**\n\t * Represents the loading group to which the tree belongs to. Please refer to this readme for more context.\n\t * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}\n\t * Also note that \"groupId\" is the same as \"loadingGroupId\" used elsewhere in the repo. The naming discrepancy is\n\t * intentional to minimize snapshot/summary size.\n\t */\n\tgroupId?: string;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface ISnapshotTree {\n\tid?: string;\n\tblobs: { [path: string]: string };\n\ttrees: { [path: string]: ISnapshotTree };\n\n\t/**\n\t * Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced.\n\t */\n\tunreferenced?: true;\n\n\t/**\n\t * Represents the loading group to which the snapshot tree belongs to. Please refer to this readme for more context.\n\t * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}\n\t * Also note that \"groupId\" is the same as \"loadingGroupId\" used elsewhere in the repo. The naming discrepancy is\n\t * intentional to minimize snapshot/summary size.\n\t */\n\tgroupId?: string;\n}\n\n/**\n * @internal\n */\nexport interface ISnapshotTreeEx extends ISnapshotTree {\n\tid: string;\n\ttrees: { [path: string]: ISnapshotTreeEx };\n}\n\n/**\n * Represents a version of the snapshot of a data store.\n * @legacy\n * @alpha\n */\nexport interface IVersion {\n\t/**\n\t * Version ID\n\t */\n\tid: string;\n\n\t/**\n\t * Tree ID for this version of the snapshot\n\t */\n\ttreeId: string;\n\n\t/**\n\t * Time when snapshot was generated.\n\t */\n\tdate?: IsoDate;\n}\n"]}
+{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../src/protocol/storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAmBH;;GAEG;AACH,MAAM,CAAN,IAAY,QAKX;AALD,WAAY,QAAQ;IACnB,2BAAe,CAAA;IACf,iCAAqB,CAAA;IACrB,gCAAoB,CAAA;IACpB,8BAAkB,CAAA;AACnB,CAAC,EALW,QAAQ,KAAR,QAAQ,QAKnB;AA+DD;;;GAGG;AACH,MAAM,CAAN,IAAY,SAIX;AAJD,WAAY,SAAS;IACpB,0BAAa,CAAA;IACb,0BAAa,CAAA;IACb,sCAAyB,CAAA;AAC1B,CAAC,EAJW,SAAS,KAAT,SAAS,QAIpB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IsoDate } from \"./date.js\";\n\n/**\n * @legacy @beta\n */\nexport interface IDocumentAttributes {\n\t/**\n\t * Sequence number at which the snapshot was taken\n\t */\n\tsequenceNumber: number;\n\n\t/**\n\t * Minimum sequence number when the snapshot was taken\n\t */\n\tminimumSequenceNumber: number;\n}\n\n/**\n * @legacy @beta\n */\nexport enum FileMode {\n\tFile = \"100644\",\n\tExecutable = \"100755\",\n\tDirectory = \"040000\",\n\tSymlink = \"120000\",\n}\n\n/**\n * Raw blob stored within the tree.\n * @legacy @beta\n */\nexport interface IBlob {\n\t/**\n\t * Contents of the blob\n\t */\n\tcontents: string;\n\n\t/**\n\t * The encoding of the contents string\n\t */\n\t// 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\n\tencoding: \"utf-8\" | \"base64\";\n}\n\n/**\n * @legacy @beta\n */\nexport interface IAttachment {\n\tid: string;\n}\n\n/**\n * @legacy @beta\n */\nexport interface ICreateBlobResponse {\n\tid: string;\n}\n\n/**\n * A tree entry wraps a path with a type of node.\n * @legacy @beta\n */\nexport type ITreeEntry = {\n\t/**\n\t * Path to the object\n\t */\n\tpath: string;\n\n\t/**\n\t * The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree)\n\t * or 120000 for a blob that specifies the path of a symlink\n\t */\n\tmode: FileMode;\n} & (\n\t| {\n\t\t\ttype: TreeEntry.Blob;\n\t\t\tvalue: IBlob;\n\t  }\n\t| {\n\t\t\ttype: TreeEntry.Tree;\n\t\t\tvalue: ITree;\n\t  }\n\t| {\n\t\t\ttype: TreeEntry.Attachment;\n\t\t\tvalue: IAttachment;\n\t  }\n);\n\n/**\n * Type of entries that can be stored in a tree.\n * @legacy @beta\n */\nexport enum TreeEntry {\n\tBlob = \"Blob\",\n\tTree = \"Tree\",\n\tAttachment = \"Attachment\",\n}\n\n/**\n * @legacy @beta\n */\nexport interface ITree {\n\tentries: ITreeEntry[];\n\n\t/**\n\t * Unique ID representing all entries in the tree. Can be used to optimize snapshotting in the case\n\t * it is known that the `ITree` has already been created and stored\n\t */\n\tid?: string;\n\n\t/**\n\t * Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced.\n\t */\n\tunreferenced?: true;\n\n\t/**\n\t * Represents the loading group to which the tree belongs to. Please refer to this readme for more context.\n\t * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}\n\t * Also note that \"groupId\" is the same as \"loadingGroupId\" used elsewhere in the repo. The naming discrepancy is\n\t * intentional to minimize snapshot/summary size.\n\t */\n\tgroupId?: string;\n}\n\n/**\n * @legacy @beta\n */\nexport interface ISnapshotTree {\n\tid?: string;\n\tblobs: { [path: string]: string };\n\ttrees: { [path: string]: ISnapshotTree };\n\n\t/**\n\t * Indicates that this tree is unreferenced. If this is not present, the tree is considered referenced.\n\t */\n\tunreferenced?: true;\n\n\t/**\n\t * Represents the loading group to which the snapshot tree belongs to. Please refer to this readme for more context.\n\t * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}\n\t * Also note that \"groupId\" is the same as \"loadingGroupId\" used elsewhere in the repo. The naming discrepancy is\n\t * intentional to minimize snapshot/summary size.\n\t */\n\tgroupId?: string;\n}\n\n/**\n * @internal\n */\nexport interface ISnapshotTreeEx extends ISnapshotTree {\n\tid: string;\n\ttrees: { [path: string]: ISnapshotTreeEx };\n}\n\n/**\n * Represents a version of the snapshot of a data store.\n * @legacy @beta\n */\nexport interface IVersion {\n\t/**\n\t * Version ID\n\t */\n\tid: string;\n\n\t/**\n\t * Tree ID for this version of the snapshot\n\t */\n\ttreeId: string;\n\n\t/**\n\t * Time when snapshot was generated.\n\t */\n\tdate?: IsoDate;\n}\n"]}

lib/protocol/summary.d.ts

@@ -15,4 +15,3 @@ /*!
  * The root of the summary tree.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -19,0 +18,0 @@ export type SummaryTree = ISummaryTree | ISummaryHandle;

lib/protocol/summary.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"summary.d.ts","sourceRoot":"","sources":["../../src/protocol/summary.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG,YAAY,GAAG,YAAY,GAAG,cAAc,GAAG,kBAAkB,CAAC;AAE9F;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,cAAc,CAAC;AAExD;;;GAGG;AAEH,yBAAiB,WAAW,CAAC;IAC5B;;OAEG;IACH,KAAY,IAAI,GAAG,CAAC,CAAC;IACrB;;OAEG;IACH,KAAY,IAAI,GAAG,CAAC,CAAC;IACrB;;OAEG;IACH,KAAY,MAAM,GAAG,CAAC,CAAC;IACvB;;OAEG;IACH,KAAY,UAAU,GAAG,CAAC,CAAC;IAE3B;;;OAGG;IACI,MAAM,IAAI,EAAE,IAAiB,CAAC;IAErC;;;;;OAKG;IACI,MAAM,IAAI,EAAE,IAAiB,CAAC;IAErC;;;OAGG;IACI,MAAM,MAAM,EAAE,MAAmB,CAAC;IAEzC;;;;;OAKG;IACI,MAAM,UAAU,EAAE,UAAuB,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GACpB,WAAW,CAAC,UAAU,GACtB,WAAW,CAAC,IAAI,GAChB,WAAW,CAAC,MAAM,GAClB,WAAW,CAAC,IAAI,CAAC;AAEpB;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,GAAG,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,UAAU,CAAC;AAE/F;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,mBAAmB,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,UAAU,CAAC;CAC7B;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,kBAAkB;IAClC,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC;IAC7B,EAAE,EAAE,MAAM,CAAC;CACX;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC;IAEvB;;;;OAIG;IACH,IAAI,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAAA;KAAE,CAAC;IAExC;;;OAGG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC;IAEpB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"summary.d.ts","sourceRoot":"","sources":["../../src/protocol/summary.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG,YAAY,GAAG,YAAY,GAAG,cAAc,GAAG,kBAAkB,CAAC;AAE9F;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,cAAc,CAAC;AAExD;;;GAGG;AAEH,yBAAiB,WAAW,CAAC;IAC5B;;OAEG;IACH,KAAY,IAAI,GAAG,CAAC,CAAC;IACrB;;OAEG;IACH,KAAY,IAAI,GAAG,CAAC,CAAC;IACrB;;OAEG;IACH,KAAY,MAAM,GAAG,CAAC,CAAC;IACvB;;OAEG;IACH,KAAY,UAAU,GAAG,CAAC,CAAC;IAE3B;;;OAGG;IACI,MAAM,IAAI,EAAE,IAAiB,CAAC;IAErC;;;;;OAKG;IACI,MAAM,IAAI,EAAE,IAAiB,CAAC;IAErC;;;OAGG;IACI,MAAM,MAAM,EAAE,MAAmB,CAAC;IAEzC;;;;;OAKG;IACI,MAAM,UAAU,EAAE,UAAuB,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GACpB,WAAW,CAAC,UAAU,GACtB,WAAW,CAAC,IAAI,GAChB,WAAW,CAAC,MAAM,GAClB,WAAW,CAAC,IAAI,CAAC;AAEpB;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,GAAG,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,UAAU,CAAC;AAE/F;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,mBAAmB,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,UAAU,CAAC;CAC7B;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,kBAAkB;IAClC,IAAI,EAAE,WAAW,CAAC,UAAU,CAAC;IAC7B,EAAE,EAAE,MAAM,CAAC;CACX;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC;IAEvB;;;;OAIG;IACH,IAAI,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAAA;KAAE,CAAC;IAExC;;;OAGG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC;IAEpB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB"}

lib/protocol/summary.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"summary.js","sourceRoot":"","sources":["../../src/protocol/summary.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAkBH;;;GAGG;AACH,2DAA2D;AAC3D,MAAM,KAAW,WAAW,CA6C3B;AA7CD,WAAiB,WAAW;IAkB3B;;;OAGG;IACU,gBAAI,GAAS,CAAU,CAAC;IAErC;;;;;OAKG;IACU,gBAAI,GAAS,CAAU,CAAC;IAErC;;;OAGG;IACU,kBAAM,GAAW,CAAU,CAAC;IAEzC;;;;;OAKG;IACU,sBAAU,GAAe,CAAU,CAAC;AAClD,CAAC,EA7CgB,WAAW,KAAX,WAAW,QA6C3B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Object representing a node within a summary tree.\n *\n * @remarks\n * If any particular node is an {@link ISummaryTree}, it can contain additional `SummaryObject`s as its children.\n * @public\n */\nexport type SummaryObject = ISummaryTree | ISummaryBlob | ISummaryHandle | ISummaryAttachment;\n\n/**\n * The root of the summary tree.\n * @legacy\n * @alpha\n */\nexport type SummaryTree = ISummaryTree | ISummaryHandle;\n\n/**\n * Type tag used to distinguish different types of nodes in a {@link ISummaryTree}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/no-namespace\nexport namespace SummaryType {\n\t/**\n\t * @internal\n\t */\n\texport type Tree = 1;\n\t/**\n\t * @internal\n\t */\n\texport type Blob = 2;\n\t/**\n\t * @internal\n\t */\n\texport type Handle = 3;\n\t/**\n\t * @internal\n\t */\n\texport type Attachment = 4;\n\n\t/**\n\t * Represents a sub-tree in the summary.\n\t * @public\n\t */\n\texport const Tree: Tree = 1 as const;\n\n\t/**\n\t * Represents a blob of data that is added to the summary.\n\t * Such as the user data that is added to the DDS or metadata added by runtime\n\t * such as data store / channel attributes.\n\t * @public\n\t */\n\texport const Blob: Blob = 2 as const;\n\n\t/**\n\t * Path to a summary tree object from the last successful summary.\n\t * @public\n\t */\n\texport const Handle: Handle = 3 as const;\n\n\t/**\n\t * Unique identifier to larger blobs uploaded outside of the summary.\n\t * Ex. DDS has large images or video that will be uploaded by the BlobManager and\n\t * receive an Id that can be used in the summary.\n\t * @public\n\t */\n\texport const Attachment: Attachment = 4 as const;\n}\n\n/**\n * {@inheritDoc (SummaryType:namespace)}\n * @public\n */\nexport type SummaryType =\n\t| SummaryType.Attachment\n\t| SummaryType.Blob\n\t| SummaryType.Handle\n\t| SummaryType.Tree;\n\n/**\n * Summary type that {@link ISummaryHandle} points to.\n *\n * @remarks\n * Summary handles are often used to point to summary tree objects contained within older summaries, thus avoiding\n * the need to re-send the entire subtree if summary object has not changed.\n * @public\n */\nexport type SummaryTypeNoHandle = SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment;\n\n/**\n * Path to a summary tree object from the last successful summary indicating the summary object hasn't\n * changed since it was uploaded.\n *\n * Special characters include '/'. '/' is used as a separator between different parts of the path as a way to traverse\n * different nodes in the previous summary/snapshot tree.\n *\n * Note, our algorithms use encodeURIComponent and decodeURIComponent to handle special characters in the path. If a string\n * causes this path to fail, the id will be invalid.\n *\n * @example\n * To illustrate, if a DataStore did not change since last summary, the framework runtime will use a handle for the\n * entire DataStore instead of re-sending the entire subtree. The same concept applies for a DDS.\n * An example of a handle string generated when the DDS did not change would be: '/.channels/<DataStoreId>/.channels/<DDSId>'.\n * An example of a handle string generated when the DataStore did not change would be: '/.channels/<DataStoreId>'.\n * An example of a handle string generated when the DDS blob did not change would be: `/.channels/<DataStoreId>/.channels/<DDSId>/<BlobId>`.\n * An example of a handle string generated when the DataStore .attributes blob did not change would be: `/.channels/<DataStoreId>/.attributes`.\n * @public\n */\nexport interface ISummaryHandle {\n\ttype: SummaryType.Handle;\n\n\t/**\n\t * Type of Summary Handle (SummaryType.Handle is not supported).\n\t */\n\thandleType: SummaryTypeNoHandle;\n\n\t/**\n\t * Unique path that identifies the corresponding sub-tree in a previous summary.\n\t */\n\thandle: string;\n}\n\n/**\n * String or Binary data to be uploaded to the server as part of the container's Summary.\n *\n * @remarks\n * Note: Already uploaded blobs would be referenced by an {@link ISummaryAttachment}.\n * Additional information can be found here: {@link https://github.com/microsoft/FluidFramework/issues/6568}\n *\n * @example\n * \"content\": \"\\{ \\\"pkg\\\":\\\"[\\\\\\\"OfficeRootComponent\\\\\\\",\\\\\\\"LastEditedComponent\\\\\\\"]\\\",\n *                    \\\"summaryFormatVersion\\\":2,\\\"isRootDataStore\\\":false \\}\"\n * @public\n */\nexport interface ISummaryBlob {\n\ttype: SummaryType.Blob;\n\tcontent: string | Uint8Array;\n}\n\n/**\n * Unique identifier for blobs uploaded outside of the summary.\n *\n * @remarks\n *\n * Attachment Blobs are uploaded and downloaded separately and do not take part of the snapshot payload.\n * The ID gets returned from the backend after the attachment has been uploaded.\n * Additional information can be found here: {@link https://github.com/microsoft/FluidFramework/issues/6374}\n *\n * @example\n * \"id\": \"bQAQKARDdMdTgqICmBa_ZB86YXwGP\"\n * @public\n */\nexport interface ISummaryAttachment {\n\ttype: SummaryType.Attachment;\n\tid: string;\n}\n\n/**\n * Tree Node data structure with children that are nodes of SummaryObject type:\n * Blob, Handle, Attachment or another Tree.\n * @public\n */\nexport interface ISummaryTree {\n\ttype: SummaryType.Tree;\n\n\t/**\n\t * The object containing all the tree's {@link SummaryObject} children.\n\t *\n\t * @param path - The key to store the SummaryObject at in the current summary tree being generated. Should not contain any \"/\" characters and should not change when encodeURIComponent is called on it.\n\t */\n\ttree: { [path: string]: SummaryObject };\n\n\t/**\n\t * Indicates that this tree entry is unreferenced.\n\t * If this is not present, the tree entry is considered referenced.\n\t */\n\tunreferenced?: true;\n\n\t/**\n\t * Represents the loading group to which the summary tree belongs to. Please refer to this readme for more context.\n\t * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}\n\t * Also note that \"groupId\" is the same as \"loadingGroupId\" used elsewhere in the repo. The naming discrepancy is\n\t * intentional to minimize snapshot/summary size.\n\t */\n\tgroupId?: string;\n}\n"]}
+{"version":3,"file":"summary.js","sourceRoot":"","sources":["../../src/protocol/summary.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAiBH;;;GAGG;AACH,2DAA2D;AAC3D,MAAM,KAAW,WAAW,CA6C3B;AA7CD,WAAiB,WAAW;IAkB3B;;;OAGG;IACU,gBAAI,GAAS,CAAU,CAAC;IAErC;;;;;OAKG;IACU,gBAAI,GAAS,CAAU,CAAC;IAErC;;;OAGG;IACU,kBAAM,GAAW,CAAU,CAAC;IAEzC;;;;;OAKG;IACU,sBAAU,GAAe,CAAU,CAAC;AAClD,CAAC,EA7CgB,WAAW,KAAX,WAAW,QA6C3B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Object representing a node within a summary tree.\n *\n * @remarks\n * If any particular node is an {@link ISummaryTree}, it can contain additional `SummaryObject`s as its children.\n * @public\n */\nexport type SummaryObject = ISummaryTree | ISummaryBlob | ISummaryHandle | ISummaryAttachment;\n\n/**\n * The root of the summary tree.\n * @legacy @beta\n */\nexport type SummaryTree = ISummaryTree | ISummaryHandle;\n\n/**\n * Type tag used to distinguish different types of nodes in a {@link ISummaryTree}.\n * @public\n */\n// eslint-disable-next-line @typescript-eslint/no-namespace\nexport namespace SummaryType {\n\t/**\n\t * @internal\n\t */\n\texport type Tree = 1;\n\t/**\n\t * @internal\n\t */\n\texport type Blob = 2;\n\t/**\n\t * @internal\n\t */\n\texport type Handle = 3;\n\t/**\n\t * @internal\n\t */\n\texport type Attachment = 4;\n\n\t/**\n\t * Represents a sub-tree in the summary.\n\t * @public\n\t */\n\texport const Tree: Tree = 1 as const;\n\n\t/**\n\t * Represents a blob of data that is added to the summary.\n\t * Such as the user data that is added to the DDS or metadata added by runtime\n\t * such as data store / channel attributes.\n\t * @public\n\t */\n\texport const Blob: Blob = 2 as const;\n\n\t/**\n\t * Path to a summary tree object from the last successful summary.\n\t * @public\n\t */\n\texport const Handle: Handle = 3 as const;\n\n\t/**\n\t * Unique identifier to larger blobs uploaded outside of the summary.\n\t * Ex. DDS has large images or video that will be uploaded by the BlobManager and\n\t * receive an Id that can be used in the summary.\n\t * @public\n\t */\n\texport const Attachment: Attachment = 4 as const;\n}\n\n/**\n * {@inheritDoc (SummaryType:namespace)}\n * @public\n */\nexport type SummaryType =\n\t| SummaryType.Attachment\n\t| SummaryType.Blob\n\t| SummaryType.Handle\n\t| SummaryType.Tree;\n\n/**\n * Summary type that {@link ISummaryHandle} points to.\n *\n * @remarks\n * Summary handles are often used to point to summary tree objects contained within older summaries, thus avoiding\n * the need to re-send the entire subtree if summary object has not changed.\n * @public\n */\nexport type SummaryTypeNoHandle = SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment;\n\n/**\n * Path to a summary tree object from the last successful summary indicating the summary object hasn't\n * changed since it was uploaded.\n *\n * Special characters include '/'. '/' is used as a separator between different parts of the path as a way to traverse\n * different nodes in the previous summary/snapshot tree.\n *\n * Note, our algorithms use encodeURIComponent and decodeURIComponent to handle special characters in the path. If a string\n * causes this path to fail, the id will be invalid.\n *\n * @example\n * To illustrate, if a DataStore did not change since last summary, the framework runtime will use a handle for the\n * entire DataStore instead of re-sending the entire subtree. The same concept applies for a DDS.\n * An example of a handle string generated when the DDS did not change would be: '/.channels/<DataStoreId>/.channels/<DDSId>'.\n * An example of a handle string generated when the DataStore did not change would be: '/.channels/<DataStoreId>'.\n * An example of a handle string generated when the DDS blob did not change would be: `/.channels/<DataStoreId>/.channels/<DDSId>/<BlobId>`.\n * An example of a handle string generated when the DataStore .attributes blob did not change would be: `/.channels/<DataStoreId>/.attributes`.\n * @public\n */\nexport interface ISummaryHandle {\n\ttype: SummaryType.Handle;\n\n\t/**\n\t * Type of Summary Handle (SummaryType.Handle is not supported).\n\t */\n\thandleType: SummaryTypeNoHandle;\n\n\t/**\n\t * Unique path that identifies the corresponding sub-tree in a previous summary.\n\t */\n\thandle: string;\n}\n\n/**\n * String or Binary data to be uploaded to the server as part of the container's Summary.\n *\n * @remarks\n * Note: Already uploaded blobs would be referenced by an {@link ISummaryAttachment}.\n * Additional information can be found here: {@link https://github.com/microsoft/FluidFramework/issues/6568}\n *\n * @example\n * \"content\": \"\\{ \\\"pkg\\\":\\\"[\\\\\\\"OfficeRootComponent\\\\\\\",\\\\\\\"LastEditedComponent\\\\\\\"]\\\",\n *                    \\\"summaryFormatVersion\\\":2,\\\"isRootDataStore\\\":false \\}\"\n * @public\n */\nexport interface ISummaryBlob {\n\ttype: SummaryType.Blob;\n\tcontent: string | Uint8Array;\n}\n\n/**\n * Unique identifier for blobs uploaded outside of the summary.\n *\n * @remarks\n *\n * Attachment Blobs are uploaded and downloaded separately and do not take part of the snapshot payload.\n * The ID gets returned from the backend after the attachment has been uploaded.\n * Additional information can be found here: {@link https://github.com/microsoft/FluidFramework/issues/6374}\n *\n * @example\n * \"id\": \"bQAQKARDdMdTgqICmBa_ZB86YXwGP\"\n * @public\n */\nexport interface ISummaryAttachment {\n\ttype: SummaryType.Attachment;\n\tid: string;\n}\n\n/**\n * Tree Node data structure with children that are nodes of SummaryObject type:\n * Blob, Handle, Attachment or another Tree.\n * @public\n */\nexport interface ISummaryTree {\n\ttype: SummaryType.Tree;\n\n\t/**\n\t * The object containing all the tree's {@link SummaryObject} children.\n\t *\n\t * @param path - The key to store the SummaryObject at in the current summary tree being generated. Should not contain any \"/\" characters and should not change when encodeURIComponent is called on it.\n\t */\n\ttree: { [path: string]: SummaryObject };\n\n\t/**\n\t * Indicates that this tree entry is unreferenced.\n\t * If this is not present, the tree entry is considered referenced.\n\t */\n\tunreferenced?: true;\n\n\t/**\n\t * Represents the loading group to which the summary tree belongs to. Please refer to this readme for more context.\n\t * {@link https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/README.md | README}\n\t * Also note that \"groupId\" is the same as \"loadingGroupId\" used elsewhere in the repo. The naming discrepancy is\n\t * intentional to minimize snapshot/summary size.\n\t */\n\tgroupId?: string;\n}\n"]}

lib/protocol/tokens.d.ts

@@ -10,4 +10,3 @@ /*!
  * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4}
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -14,0 +13,0 @@ export interface ITokenClaims {

lib/protocol/tokens.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../../src/protocol/tokens.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC;;;;;;GAMG;AACH,MAAM,WAAW,YAAY;IAC5B;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IAEZ;;;;;;OAMG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;;OAMG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACb"}
+{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../../src/protocol/tokens.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC5B;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IAEZ;;;;;;OAMG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;;OAMG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACb"}

lib/protocol/tokens.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../../src/protocol/tokens.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IUser } from \"./users.js\";\n\n/**\n * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} Claims\n *\n * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4}\n * @legacy\n * @alpha\n */\nexport interface ITokenClaims {\n\t/**\n\t * Identifies the document (a.k.a container) for which the token is being generated.\n\t * Generated by the service.\n\t */\n\tdocumentId: string;\n\n\t/**\n\t * Identifies the permissions required by the client on the document or summary.\n\t * For every scope, you can define the permissions you want to give to the client.\n\t */\n\tscopes: string[];\n\n\t/**\n\t * Unique tenant identifier.\n\t */\n\ttenantId: string;\n\n\t/**\n\t * User for whom the token was created.\n\t */\n\tuser: IUser;\n\n\t/**\n\t * \"Issued At\"\n\t * Indicates when the authentication for this token occurred.\n\t * Expressed in {@link https://en.wikipedia.org/wiki/Unix_time | Unix Time}.\n\t *\n\t * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.6}\n\t */\n\tiat: number;\n\n\t/**\n\t * \"Expiration Time\"\n\t * Identifies the expiration time on or after which the token must not be accepted for processing.\n\t * Expressed in {@link https://en.wikipedia.org/wiki/Unix_time | Unix Time}.\n\t *\n\t * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.4}\n\t */\n\texp: number;\n\n\t/**\n\t * \"Version\"\n\t * Version of the access token.\n\t */\n\tver: string;\n\n\t/**\n\t * \"JWT ID\"\n\t * A unique identifier for the token.\n\t *\n\t * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.7}\n\t */\n\tjti?: string;\n}\n"]}
+{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../../src/protocol/tokens.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IUser } from \"./users.js\";\n\n/**\n * {@link https://jwt.io/introduction/ | JSON Web Token (JWT)} Claims\n *\n * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4}\n * @legacy @beta\n */\nexport interface ITokenClaims {\n\t/**\n\t * Identifies the document (a.k.a container) for which the token is being generated.\n\t * Generated by the service.\n\t */\n\tdocumentId: string;\n\n\t/**\n\t * Identifies the permissions required by the client on the document or summary.\n\t * For every scope, you can define the permissions you want to give to the client.\n\t */\n\tscopes: string[];\n\n\t/**\n\t * Unique tenant identifier.\n\t */\n\ttenantId: string;\n\n\t/**\n\t * User for whom the token was created.\n\t */\n\tuser: IUser;\n\n\t/**\n\t * \"Issued At\"\n\t * Indicates when the authentication for this token occurred.\n\t * Expressed in {@link https://en.wikipedia.org/wiki/Unix_time | Unix Time}.\n\t *\n\t * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.6}\n\t */\n\tiat: number;\n\n\t/**\n\t * \"Expiration Time\"\n\t * Identifies the expiration time on or after which the token must not be accepted for processing.\n\t * Expressed in {@link https://en.wikipedia.org/wiki/Unix_time | Unix Time}.\n\t *\n\t * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.4}\n\t */\n\texp: number;\n\n\t/**\n\t * \"Version\"\n\t * Version of the access token.\n\t */\n\tver: string;\n\n\t/**\n\t * \"JWT ID\"\n\t * A unique identifier for the token.\n\t *\n\t * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.7}\n\t */\n\tjti?: string;\n}\n"]}

lib/storage.d.ts

@@ -45,4 +45,3 @@ /*!
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -57,4 +56,3 @@ export type IStreamResult<T> = {
  * Read interface for the Queue
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -66,4 +64,3 @@ export interface IStream<T> {
  * Interface to provide access to stored deltas for a shared object
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -84,4 +81,3 @@ export interface IDocumentDeltaStorageService {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -92,4 +88,3 @@ export type FiveDaysMs = 432_000_000;
  * to direct how other components interact with the driver
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -113,4 +108,3 @@ export interface IDocumentStorageServicePolicies {
  * Interface to provide access to snapshots saved for a shared object
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -171,4 +165,3 @@ export interface IDocumentStorageService extends Partial<IDisposable> {
  * Events emitted by {@link IDocumentService}.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -183,4 +176,3 @@ export interface IDocumentServiceEvents extends IEvent {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -204,4 +196,3 @@ export interface IDocumentDeltaConnectionEvents extends IErrorEvent {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -273,4 +264,3 @@ export interface IDocumentDeltaConnection extends IDisposable, IEventProvider<IDocumentDeltaConnectionEvents> {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -288,4 +278,3 @@ export declare enum LoaderCachingPolicy {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -309,4 +298,3 @@ export interface IDocumentServicePolicies {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -344,4 +332,3 @@ export interface IDocumentService extends IEventProvider<IDocumentServiceEvents> {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -377,4 +364,3 @@ export interface IDocumentServiceFactory {
  * Indicates the previously acked summary.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -393,4 +379,3 @@ export interface ISummaryContext {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -404,4 +389,3 @@ export declare enum FetchSource {
  *
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -425,4 +409,3 @@ export interface ISnapshot {
  * when fetching the snapshot.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -429,0 +412,0 @@ export interface ISnapshotFetchOptions {

lib/storage.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,WAAW,EACX,WAAW,EACX,MAAM,EACN,cAAc,EACd,oBAAoB,EACpB,MAAM,iCAAiC,CAAC;AAEzC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EACX,cAAc,EACd,OAAO,EACP,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,EAChB,KAAK,EACL,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,aAAa,EACb,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC;;;OAGG;IACH,QAAQ,EAAE,yBAAyB,EAAE,CAAC;IAEtC;;;;OAIG;IACH,aAAa,EAAE,OAAO,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACpC;;;;;;;;;OASG;IACH,GAAG,CACF,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,EAAE,YAAY;IAC1B,EAAE,EAAE,MAAM,EAAE,YAAY;IACxB,WAAW,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC;AAE1E;;;;GAIG;AACH,MAAM,WAAW,OAAO,CAAC,CAAC;IACzB,IAAI,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC5C;;;;;;;;;OASG;IACH,aAAa,CACZ,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,GAAG,SAAS,EACtB,WAAW,CAAC,EAAE,WAAW,EACzB,UAAU,CAAC,EAAE,OAAO,EACpB,WAAW,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;CACxC;AAMD;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,WAAW,CAAC;AAErC;;;;;GAKG;AACH,MAAM,WAAW,+BAA+B;IAC/C;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAEvC;;;;;;;OAOG;IACH,QAAQ,CAAC,sBAAsB,CAAC,EAAE,UAAU,CAAC;CAC7C;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAwB,SAAQ,OAAO,CAAC,WAAW,CAAC;IACpE;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,+BAA+B,GAAG,SAAS,CAAC;IAEhE;;;;;OAKG;IAGH,eAAe,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IAE1F;;;;;OAKG;IACH,WAAW,CAAC,CAAC,oBAAoB,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAE/E;;;;;;;;;;OAUG;IACH,WAAW,CAGV,SAAS,EAAE,MAAM,GAAG,IAAI,EACxB,KAAK,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,MAAM,EACrB,WAAW,CAAC,EAAE,WAAW,GACvB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEhE;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3F;;;OAGG;IACH,eAAe,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAC/D;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAuB,SAAQ,MAAM;IACrD;;;OAGG;IACH,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,IAAI,OAAE;CAChF;AAED;;;GAGG;AACH,MAAM,WAAW,8BAA+B,SAAQ,WAAW;IAClE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,IAAI,OAAE;IAC1E;;;;;;;OAOG;IACH,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,IAAI,OAAE;IACnE,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,yBAAyB,EAAE,KAAK,IAAI,OAAE;IAC7F,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,cAAc,GAAG,cAAc,EAAE,KAAK,IAAI,OAAE;IAClF,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,OAAE;IAGrD,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,OAAE;CACjD;AAED;;;GAGG;AACH,MAAM,WAAW,wBAChB,SAAQ,WAAW,EAClB,cAAc,CAAC,8BAA8B,CAAC;IAC/C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,EAAE,yBAAyB,EAAE,CAAC;IAE7C;;OAEG;IACH,cAAc,EAAE,cAAc,EAAE,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,aAAa,EAAE,CAAC;IAEhC;;OAEG;IACH,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC;IAE3C;;;;;OAKG;IACH,YAAY,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;CACjE;AAED;;;GAGG;AACH,oBAAY,mBAAmB;IAC9B;;OAEG;IACH,SAAS,IAAA;IAET;;OAEG;IACH,QAAQ,IAAA;CACR;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACxC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEzC;;;;OAIG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,cAAc,CAAC,sBAAsB,CAAC;IAC/E,WAAW,EAAE,YAAY,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IAEpC;;OAEG;IACH,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAErD;;OAEG;IACH,qBAAqB,IAAI,OAAO,CAAC,4BAA4B,CAAC,CAAC;IAE/D;;OAEG;IACH,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAEzE;;;;;;;;;OASG;IAGH,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACvC;;;;;;;;;;OAUG;IACH,qBAAqB,CACpB,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAE7B;;;;;;;;;;OAUG;IACH,eAAe,CACd,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,oBAAoB,EAAE,YAAY,EAClC,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAEvC,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;CACzC;AAED;;;GAGG;AACH,oBAAY,WAAW;IACtB,OAAO,YAAY;IACnB,OAAO,YAAY;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACzB,YAAY,EAAE,aAAa,CAAC;IAC5B,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACvC,GAAG,EAAE,yBAAyB,EAAE,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;OAEG;IACH,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAAC;IAEzC,eAAe,EAAE,CAAC,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACrC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAE3B;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;CAC1B"}
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,WAAW,EACX,WAAW,EACX,MAAM,EACN,cAAc,EACd,oBAAoB,EACpB,MAAM,iCAAiC,CAAC;AAEzC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EACX,cAAc,EACd,OAAO,EACP,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,EAChB,KAAK,EACL,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,aAAa,EACb,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC;;;OAGG;IACH,QAAQ,EAAE,yBAAyB,EAAE,CAAC;IAEtC;;;;OAIG;IACH,aAAa,EAAE,OAAO,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACpC;;;;;;;;;OASG;IACH,GAAG,CACF,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,EAAE,YAAY;IAC1B,EAAE,EAAE,MAAM,EAAE,YAAY;IACxB,WAAW,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC;AAE1E;;;GAGG;AACH,MAAM,WAAW,OAAO,CAAC,CAAC;IACzB,IAAI,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC5C;;;;;;;;;OASG;IACH,aAAa,CACZ,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,GAAG,SAAS,EACtB,WAAW,CAAC,EAAE,WAAW,EACzB,UAAU,CAAC,EAAE,OAAO,EACpB,WAAW,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;CACxC;AAMD;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,WAAW,CAAC;AAErC;;;;GAIG;AACH,MAAM,WAAW,+BAA+B;IAC/C;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAEvC;;;;;;;OAOG;IACH,QAAQ,CAAC,sBAAsB,CAAC,EAAE,UAAU,CAAC;CAC7C;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,OAAO,CAAC,WAAW,CAAC;IACpE;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,+BAA+B,GAAG,SAAS,CAAC;IAEhE;;;;;OAKG;IAGH,eAAe,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IAE1F;;;;;OAKG;IACH,WAAW,CAAC,CAAC,oBAAoB,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAE/E;;;;;;;;;;OAUG;IACH,WAAW,CAGV,SAAS,EAAE,MAAM,GAAG,IAAI,EACxB,KAAK,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,MAAM,EACrB,WAAW,CAAC,EAAE,WAAW,GACvB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEhE;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,wBAAwB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3F;;;OAGG;IACH,eAAe,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAC/D;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,MAAM;IACrD;;;OAGG;IACH,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,IAAI,OAAE;CAChF;AAED;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,WAAW;IAClE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,IAAI,OAAE;IAC1E;;;;;;;OAOG;IACH,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,IAAI,OAAE;IACnE,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,yBAAyB,EAAE,KAAK,IAAI,OAAE;IAC7F,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,cAAc,GAAG,cAAc,EAAE,KAAK,IAAI,OAAE;IAClF,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,OAAE;IAGrD,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,OAAE;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,wBAChB,SAAQ,WAAW,EAClB,cAAc,CAAC,8BAA8B,CAAC;IAC/C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,EAAE,yBAAyB,EAAE,CAAC;IAE7C;;OAEG;IACH,cAAc,EAAE,cAAc,EAAE,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,aAAa,EAAE,CAAC;IAEhC;;OAEG;IACH,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC;IAE3C;;;;;OAKG;IACH,YAAY,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;CACjE;AAED;;GAEG;AACH,oBAAY,mBAAmB;IAC9B;;OAEG;IACH,SAAS,IAAA;IAET;;OAEG;IACH,QAAQ,IAAA;CACR;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACxC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEzC;;;;OAIG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,cAAc,CAAC,sBAAsB,CAAC;IAC/E,WAAW,EAAE,YAAY,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IAEpC;;OAEG;IACH,gBAAgB,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAErD;;OAEG;IACH,qBAAqB,IAAI,OAAO,CAAC,4BAA4B,CAAC,CAAC;IAE/D;;OAEG;IACH,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAEzE;;;;;;;;;OASG;IAGH,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC;;;;;;;;;;OAUG;IACH,qBAAqB,CACpB,WAAW,EAAE,YAAY,EACzB,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAE7B;;;;;;;;;;OAUG;IACH,eAAe,CACd,gBAAgB,EAAE,YAAY,GAAG,SAAS,EAC1C,oBAAoB,EAAE,YAAY,EAClC,MAAM,CAAC,EAAE,oBAAoB,EAC7B,kBAAkB,CAAC,EAAE,OAAO,GAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAEvC,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;CACzC;AAED;;GAEG;AACH,oBAAY,WAAW;IACtB,OAAO,YAAY;IACnB,OAAO,YAAY;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACzB,YAAY,EAAE,aAAa,CAAC;IAC5B,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACvC,GAAG,EAAE,yBAAyB,EAAE,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;OAEG;IACH,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAAC;IAEzC,eAAe,EAAE,CAAC,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACrC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAE3B;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;CAC1B"}

lib/storage.js

@@ -6,4 +6,3 @@ /*!
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -22,4 +21,3 @@ export var LoaderCachingPolicy;
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -26,0 +24,0 @@ export var FetchSource;

lib/storage.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"storage.js","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAiVH;;;GAGG;AACH,MAAM,CAAN,IAAY,mBAUX;AAVD,WAAY,mBAAmB;IAC9B;;OAEG;IACH,uEAAS,CAAA;IAET;;OAEG;IACH,qEAAQ,CAAA;AACT,CAAC,EAVW,mBAAmB,KAAnB,mBAAmB,QAU9B;AAgID;;;GAGG;AACH,MAAM,CAAN,IAAY,WAGX;AAHD,WAAY,WAAW;IACtB,kCAAmB,CAAA;IACnB,kCAAmB,CAAA;AACpB,CAAC,EAHW,WAAW,KAAX,WAAW,QAGtB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type {\n\tIDisposable,\n\tIErrorEvent,\n\tIEvent,\n\tIEventProvider,\n\tITelemetryBaseLogger,\n} from \"@fluidframework/core-interfaces\";\n\nimport type { IAnyDriverError } from \"./driverError.js\";\nimport type {\n\tConnectionMode,\n\tIClient,\n\tIClientConfiguration,\n\tICreateBlobResponse,\n\tIDocumentMessage,\n\tINack,\n\tISequencedDocumentMessage,\n\tISignalClient,\n\tISignalMessage,\n\tISnapshotTree,\n\tISummaryHandle,\n\tISummaryTree,\n\tITokenClaims,\n\tIVersion,\n} from \"./protocol/index.js\";\nimport type { IResolvedUrl } from \"./urlResolver.js\";\n\n/**\n * @internal\n */\nexport interface IDeltasFetchResult {\n\t/**\n\t * Sequential set of messages starting from 'from' sequence number.\n\t * May be partial result, i.e. not fulfill original request in full.\n\t */\n\tmessages: ISequencedDocumentMessage[];\n\n\t/**\n\t * If true, storage only partially fulfilled request, but has more ops\n\t * If false, the request was fulfilled. If less ops were returned then\n\t * requested, then storage does not have more ops in this range.\n\t */\n\tpartialResult: boolean;\n}\n\n/**\n * Interface to provide access to stored deltas for a shared object\n * @internal\n */\nexport interface IDeltaStorageService {\n\t/**\n\t * Retrieves all the delta operations within the inclusive sequence number range\n\t * @param tenantId - Id of the tenant.\n\t * @param id - document id.\n\t * @param from - first op to retrieve (inclusive)\n\t * @param to - first op not to retrieve (exclusive end)\n\t * @param fetchReason - Reason for fetching the messages, for logging.\n\t * Example, gap between seq number of Op on wire and known seq number.\n\t * It can be logged by spo which could help in debugging sessions if any issue occurs.\n\t */\n\tget(\n\t\ttenantId: string,\n\t\tid: string,\n\t\tfrom: number, // inclusive\n\t\tto: number, // exclusive\n\t\tfetchReason?: string,\n\t): Promise<IDeltasFetchResult>;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport type IStreamResult<T> = { done: true } | { done: false; value: T };\n\n/**\n * Read interface for the Queue\n * @legacy\n * @alpha\n */\nexport interface IStream<T> {\n\tread(): Promise<IStreamResult<T>>;\n}\n\n/**\n * Interface to provide access to stored deltas for a shared object\n * @legacy\n * @alpha\n */\nexport interface IDocumentDeltaStorageService {\n\t/**\n\t * Retrieves all the delta operations within the exclusive sequence number range\n\t * @param from - first op to retrieve (inclusive)\n\t * @param to - first op not to retrieve (exclusive end)\n\t * @param abortSignal - signal that aborts operation\n\t * @param cachedOnly - return only cached ops, i.e. ops available locally on client.\n\t * @param fetchReason - Reason for fetching the messages, for logging.\n\t * Example, gap between seq number of Op on wire and known seq number.\n\t * It can be logged by spo which could help in debugging sessions if any issue occurs.\n\t */\n\tfetchMessages(\n\t\tfrom: number,\n\t\tto: number | undefined,\n\t\tabortSignal?: AbortSignal,\n\t\tcachedOnly?: boolean,\n\t\tfetchReason?: string,\n\t): IStream<ISequencedDocumentMessage[]>;\n}\n\n// DO NOT INCREASE THIS TYPE'S VALUE\n// If a driver started using a larger value,\n// internal assumptions of the Runtime's GC feature will be violated\n// DO NOT INCREASE THIS TYPE'S VALUE\n/**\n * @legacy\n * @alpha\n */\nexport type FiveDaysMs = 432_000_000; /* 5 days in milliseconds */\n\n/**\n * Policies describing attributes or characteristics of the driver's storage service,\n * to direct how other components interact with the driver\n * @legacy\n * @alpha\n */\nexport interface IDocumentStorageServicePolicies {\n\t/**\n\t * Should the Loader implement any sort of pre-fetching or caching mechanism?\n\t */\n\treadonly caching?: LoaderCachingPolicy;\n\n\t/**\n\t * IMPORTANT: This policy MUST be set to 5 days and PROPERLY ENFORCED for drivers that are used\n\t * in applications where Garbage Collection is enabled. Otherwise data loss may occur.\n\t *\n\t * This policy pertains to requests for the latest snapshot from the service.\n\t * If set, it means that the driver guarantees not to use a cached value that was fetched more than 5 days ago.\n\t * If undefined, the driver makes no guarantees about the age of snapshots used for loading.\n\t */\n\treadonly maximumCacheDurationMs?: FiveDaysMs;\n}\n\n/**\n * Interface to provide access to snapshots saved for a shared object\n * @legacy\n * @alpha\n */\nexport interface IDocumentStorageService extends Partial<IDisposable> {\n\t/**\n\t * Policies implemented/instructed by driver.\n\t */\n\treadonly policies?: IDocumentStorageServicePolicies | undefined;\n\n\t/**\n\t * Returns the snapshot tree.\n\t * @param version - Version of the snapshot to be fetched.\n\t * @param scenarioName - scenario in which this api is called. This will be recorded by server and would help\n\t * in debugging purposes to see why this call was made.\n\t */\n\t// TODO: use `undefined` instead.\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tgetSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;\n\n\t/**\n\t * Returns the snapshot which can contain other artifacts too like blob contents, ops etc. It is different from\n\t * `getSnapshotTree` api in that, that API only returns the snapshot tree from the snapshot.\n\t * @param snapshotFetchOptions - Options specified by the caller to specify and want certain behavior from the\n\t * driver when fetching the snapshot.\n\t */\n\tgetSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;\n\n\t/**\n\t * Retrieves all versions of the document starting at the specified versionId - or null if from the head\n\t * @param versionId - Version id of the requested version.\n\t * @param count - Number of the versions to be fetched.\n\t * @param scenarioName - scenario in which this api is called. This will be recorded by server and would help\n\t * in debugging purposes to see why this call was made.\n\t * @param fetchSource - Callers can specify the source of the response. For ex. Driver may choose to cache\n\t * requests and serve data from cache. That will result in stale info returned. Callers can disable this\n\t * functionality by passing fetchSource = noCache and ensuring that driver will return latest information\n\t * from storage.\n\t */\n\tgetVersions(\n\t\t// TODO: use `undefined` instead.\n\t\t// eslint-disable-next-line @rushstack/no-new-null\n\t\tversionId: string | null,\n\t\tcount: number,\n\t\tscenarioName?: string,\n\t\tfetchSource?: FetchSource,\n\t): Promise<IVersion[]>;\n\n\t/**\n\t * Creates a blob out of the given buffer\n\t */\n\tcreateBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;\n\n\t/**\n\t * Reads the object with the given ID, returns content in arrayBufferLike\n\t */\n\treadBlob(id: string): Promise<ArrayBufferLike>;\n\n\t/**\n\t * Uploads a summary tree to storage using the given context for reference of previous summary handle.\n\t * The ISummaryHandles in the uploaded tree should have paths to indicate which summary object they are\n\t * referencing from the previously acked summary.\n\t * Returns the uploaded summary handle.\n\t */\n\tuploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;\n\n\t/**\n\t * Retrieves the commit that matches the packfile handle. If the packfile has already been committed and the\n\t * server has deleted it this call may result in a broken promise.\n\t */\n\tdownloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;\n}\n\n/**\n * Events emitted by {@link IDocumentService}.\n * @legacy\n * @alpha\n */\nexport interface IDocumentServiceEvents extends IEvent {\n\t/**\n\t * This event is used to communicate any metadata related to the container. We might have received metadata from the service.\n\t * Read more info on this event from here `IContainer.containerMetadata`.\n\t */\n\t(event: \"metadataUpdate\", listener: (metadata: Record<string, string>) => void);\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IDocumentDeltaConnectionEvents extends IErrorEvent {\n\t(event: \"nack\", listener: (documentId: string, message: INack[]) => void);\n\t/**\n\t * @param reason - The reason for the disconnection.\n\t * Note: this parameter will also accept undefined in a future release to support clean disconnections.\n\t * When `reason` is provided, it indicates an error that caused the disconnection. When `undefined`, it represents\n\t * a clean, intentional disconnect that should not be treated as an error.\n\t * Signature will change from `(reason: IAnyDriverError) => void` to `(reason: IAnyDriverError | undefined) => void`.\n\t * Update your listener implementations to handle cases where `reason` is undefined.\n\t */\n\t(event: \"disconnect\", listener: (reason: IAnyDriverError) => void);\n\t(event: \"op\", listener: (documentId: string, messages: ISequencedDocumentMessage[]) => void);\n\t(event: \"signal\", listener: (message: ISignalMessage | ISignalMessage[]) => void);\n\t(event: \"pong\", listener: (latency: number) => void);\n\t// TODO: Use something other than `any`.\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t(event: \"error\", listener: (error: any) => void);\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IDocumentDeltaConnection\n\textends IDisposable,\n\t\tIEventProvider<IDocumentDeltaConnectionEvents> {\n\t/**\n\t * ClientID for the connection\n\t */\n\tclientId: string;\n\n\t/**\n\t * Claims for the client\n\t */\n\tclaims: ITokenClaims;\n\n\t/**\n\t * Mode of the client\n\t */\n\tmode: ConnectionMode;\n\n\t/**\n\t * Whether the connection was made to a new or existing document\n\t */\n\texisting: boolean;\n\n\t/**\n\t * Protocol version being used with the service\n\t */\n\tversion: string;\n\n\t/**\n\t * Messages sent during the connection\n\t */\n\tinitialMessages: ISequencedDocumentMessage[];\n\n\t/**\n\t * Signals sent during the connection\n\t */\n\tinitialSignals: ISignalMessage[];\n\n\t/**\n\t * Prior clients already connected.\n\t */\n\tinitialClients: ISignalClient[];\n\n\t/**\n\t * Configuration details provided by the service\n\t */\n\tserviceConfiguration: IClientConfiguration;\n\n\t/**\n\t * Last known sequence number to ordering service at the time of connection\n\t * It may lap actual last sequence number (quite a bit, if container  is very active).\n\t * But it's best information for client to figure out how far it is behind, at least\n\t * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n\t * that is likely to be more up-to-date.\n\t */\n\tcheckpointSequenceNumber?: number;\n\n\t/**\n\t * Properties that server can send to client to tell info about node that client is connected to. For ex, for spo\n\t * it could contain info like build version, environment, region etc. These properties can be logged by client\n\t * to better understand server environment etc. and use it in case error occurs.\n\t * Format: \"prop1:val1;prop2:val2;prop3:val3\"\n\t */\n\trelayServiceAgent?: string;\n\n\t/**\n\t * Submit a new message to the server\n\t */\n\tsubmit(messages: IDocumentMessage[]): void;\n\n\t/**\n\t * Submits a new signal to the server\n\t *\n\t * @privateRemarks\n\t * UnknownShouldBe<string> can be string if {@link IDocumentServiceFactory} becomes internal.\n\t */\n\tsubmitSignal: (content: string, targetClientId?: string) => void;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport enum LoaderCachingPolicy {\n\t/**\n\t * The loader should not implement any prefetching or caching policy.\n\t */\n\tNoCaching,\n\n\t/**\n\t * The loader should implement prefetching policy, i.e. it should prefetch resources from the latest snapshot.\n\t */\n\tPrefetch,\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IDocumentServicePolicies {\n\t/**\n\t * Do not connect to delta stream\n\t */\n\treadonly storageOnly?: boolean;\n\n\t/**\n\t * Summarizer uploads the protocol tree too when summarizing.\n\t */\n\treadonly summarizeProtocolTree?: boolean;\n\n\t/**\n\t * Whether the driver supports the new getSnapshot api which returns snapshot which\n\t * contains all contents along with the snapshot tree. Enable this by default when the\n\t * driver can fully support the api.\n\t */\n\treadonly supportGetSnapshotApi?: boolean;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IDocumentService extends IEventProvider<IDocumentServiceEvents> {\n\tresolvedUrl: IResolvedUrl;\n\n\t/**\n\t * Policies implemented/instructed by driver.\n\t */\n\tpolicies?: IDocumentServicePolicies;\n\n\t/**\n\t * Access to storage associated with the document\n\t */\n\tconnectToStorage(): Promise<IDocumentStorageService>;\n\n\t/**\n\t * Access to delta storage associated with the document\n\t */\n\tconnectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;\n\n\t/**\n\t * Subscribes to the document delta stream\n\t */\n\tconnectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;\n\n\t/**\n\t * Dispose storage. Called by storage consumer (Container) when it's done with storage (Container closed).\n\t * Useful for storage to commit any pending state if any (including any local caching).\n\t * Please note that it does not remove the need for caller to close all active delta connections,\n\t * as storage may not be tracking such objects.\n\t * @param error - tells if container (and storage) are closed due to critical error.\n\t * Error might be due to disconnect between client & server knowledge about file, like file being overwritten\n\t * in storage, but client having stale local cache.\n\t * If driver implements any kind of local caching, such caches needs to be cleared on on critical errors.\n\t */\n\t// TODO: Use something other than `any`.\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tdispose(error?: any): void;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IDocumentServiceFactory {\n\t/**\n\t * Creates the document service after extracting different endpoints URLs from a resolved URL.\n\t *\n\t * @param resolvedUrl - Endpoint URL data. See {@link IResolvedUrl}.\n\t * @param logger - Optional telemetry logger to which telemetry events will be forwarded.\n\t * @param clientIsSummarizer - Whether or not the client is the\n\t * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.\n\t * `undefined` =\\> false\n\t *\n\t * @returns An instance of {@link IDocumentService}.\n\t */\n\tcreateDocumentService(\n\t\tresolvedUrl: IResolvedUrl,\n\t\tlogger?: ITelemetryBaseLogger,\n\t\tclientIsSummarizer?: boolean,\n\t): Promise<IDocumentService>;\n\n\t/**\n\t * Creates a new document with the provided options. Returns the document service.\n\t *\n\t * @param createNewSummary - Summary used to create file. If undefined, an empty file will be created and a summary\n\t * should be posted later, before connecting to ordering service.\n\t * @param createNewResolvedUrl - Endpoint URL data. See {@link IResolvedUrl}.\n\t * @param logger - Optional telemetry logger to which telemetry events will be forwarded.\n\t * @param clientIsSummarizer - Whether or not the client is the\n\t * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.\n\t * `undefined` =\\> false\n\t */\n\tcreateContainer(\n\t\tcreateNewSummary: ISummaryTree | undefined,\n\t\tcreateNewResolvedUrl: IResolvedUrl,\n\t\tlogger?: ITelemetryBaseLogger,\n\t\tclientIsSummarizer?: boolean,\n\t): Promise<IDocumentService>;\n}\n\n/**\n * Context for uploading a summary to storage.\n * Indicates the previously acked summary.\n * @legacy\n * @alpha\n */\nexport interface ISummaryContext {\n\t/**\n\t * Parent summary proposed handle (from summary op)\n\t */\n\treadonly proposalHandle: string | undefined;\n\n\t/**\n\t * Parent summary acked handle (from summary ack)\n\t */\n\treadonly ackHandle: string | undefined;\n\n\treadonly referenceSequenceNumber: number;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport enum FetchSource {\n\tdefault = \"default\",\n\tnoCache = \"noCache\",\n}\n\n/**\n * A \"Full\" container Snapshot, including ISnapshotTree, blobs and outstanding ops (and other metadata)\n *\n * @legacy\n * @alpha\n */\nexport interface ISnapshot {\n\tsnapshotTree: ISnapshotTree;\n\tblobContents: Map<string, ArrayBuffer>;\n\tops: ISequencedDocumentMessage[];\n\n\t/**\n\t * Sequence number of the snapshot\n\t */\n\tsequenceNumber: number | undefined;\n\n\t/**\n\t * Sequence number for the latest op/snapshot for the file in ODSP\n\t */\n\tlatestSequenceNumber: number | undefined;\n\n\tsnapshotFormatV: 1;\n}\n\n/**\n * Snapshot fetch options which are used to communicate different things to the driver\n * when fetching the snapshot.\n * @legacy\n * @alpha\n */\nexport interface ISnapshotFetchOptions {\n\t/**\n\t * Indicates scenario in which the snapshot is fetched. It is a free form string  mostly\n\t * used for telemetry purposes.\n\t */\n\tscenarioName?: string;\n\t/**\n\t * Tell driver to cache the fetched snapshot. Driver is supposed to cache the fetched snapshot if this is\n\t * set to true. If undefined, then it is upto the driver, to cache it or not.\n\t */\n\tcacheSnapshot?: boolean;\n\n\t/**\n\t * Version of the snapshot to be fetched. Certain storage services just keep 1 snapshot for the\n\t * container, so specifying version is not necessary for storage services.\n\t */\n\tversionId?: string;\n\n\t/**\n\t * List of loading groupId of datastores for which the snapshot needs to be fetched. If not provided, content with\n\t * default/missing groupIDs will be requested from the service. It is upto the service, to include snapshot for\n\t * content with groupIds or not. Don't provide anything here for fetching content for initial container boot.\n\t */\n\tloadingGroupIds?: string[];\n\n\t/**\n\t * Specify if you want default behavior of the driver to fetch the snapshot like lets say simultaneously fetch from\n\t * network and cache or specify FetchSource.noCache to just fetch from network.\n\t */\n\tfetchSource?: FetchSource;\n}\n"]}
+{"version":3,"file":"storage.js","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAwUH;;GAEG;AACH,MAAM,CAAN,IAAY,mBAUX;AAVD,WAAY,mBAAmB;IAC9B;;OAEG;IACH,uEAAS,CAAA;IAET;;OAEG;IACH,qEAAQ,CAAA;AACT,CAAC,EAVW,mBAAmB,KAAnB,mBAAmB,QAU9B;AA4HD;;GAEG;AACH,MAAM,CAAN,IAAY,WAGX;AAHD,WAAY,WAAW;IACtB,kCAAmB,CAAA;IACnB,kCAAmB,CAAA;AACpB,CAAC,EAHW,WAAW,KAAX,WAAW,QAGtB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type {\n\tIDisposable,\n\tIErrorEvent,\n\tIEvent,\n\tIEventProvider,\n\tITelemetryBaseLogger,\n} from \"@fluidframework/core-interfaces\";\n\nimport type { IAnyDriverError } from \"./driverError.js\";\nimport type {\n\tConnectionMode,\n\tIClient,\n\tIClientConfiguration,\n\tICreateBlobResponse,\n\tIDocumentMessage,\n\tINack,\n\tISequencedDocumentMessage,\n\tISignalClient,\n\tISignalMessage,\n\tISnapshotTree,\n\tISummaryHandle,\n\tISummaryTree,\n\tITokenClaims,\n\tIVersion,\n} from \"./protocol/index.js\";\nimport type { IResolvedUrl } from \"./urlResolver.js\";\n\n/**\n * @internal\n */\nexport interface IDeltasFetchResult {\n\t/**\n\t * Sequential set of messages starting from 'from' sequence number.\n\t * May be partial result, i.e. not fulfill original request in full.\n\t */\n\tmessages: ISequencedDocumentMessage[];\n\n\t/**\n\t * If true, storage only partially fulfilled request, but has more ops\n\t * If false, the request was fulfilled. If less ops were returned then\n\t * requested, then storage does not have more ops in this range.\n\t */\n\tpartialResult: boolean;\n}\n\n/**\n * Interface to provide access to stored deltas for a shared object\n * @internal\n */\nexport interface IDeltaStorageService {\n\t/**\n\t * Retrieves all the delta operations within the inclusive sequence number range\n\t * @param tenantId - Id of the tenant.\n\t * @param id - document id.\n\t * @param from - first op to retrieve (inclusive)\n\t * @param to - first op not to retrieve (exclusive end)\n\t * @param fetchReason - Reason for fetching the messages, for logging.\n\t * Example, gap between seq number of Op on wire and known seq number.\n\t * It can be logged by spo which could help in debugging sessions if any issue occurs.\n\t */\n\tget(\n\t\ttenantId: string,\n\t\tid: string,\n\t\tfrom: number, // inclusive\n\t\tto: number, // exclusive\n\t\tfetchReason?: string,\n\t): Promise<IDeltasFetchResult>;\n}\n\n/**\n * @legacy @beta\n */\nexport type IStreamResult<T> = { done: true } | { done: false; value: T };\n\n/**\n * Read interface for the Queue\n * @legacy @beta\n */\nexport interface IStream<T> {\n\tread(): Promise<IStreamResult<T>>;\n}\n\n/**\n * Interface to provide access to stored deltas for a shared object\n * @legacy @beta\n */\nexport interface IDocumentDeltaStorageService {\n\t/**\n\t * Retrieves all the delta operations within the exclusive sequence number range\n\t * @param from - first op to retrieve (inclusive)\n\t * @param to - first op not to retrieve (exclusive end)\n\t * @param abortSignal - signal that aborts operation\n\t * @param cachedOnly - return only cached ops, i.e. ops available locally on client.\n\t * @param fetchReason - Reason for fetching the messages, for logging.\n\t * Example, gap between seq number of Op on wire and known seq number.\n\t * It can be logged by spo which could help in debugging sessions if any issue occurs.\n\t */\n\tfetchMessages(\n\t\tfrom: number,\n\t\tto: number | undefined,\n\t\tabortSignal?: AbortSignal,\n\t\tcachedOnly?: boolean,\n\t\tfetchReason?: string,\n\t): IStream<ISequencedDocumentMessage[]>;\n}\n\n// DO NOT INCREASE THIS TYPE'S VALUE\n// If a driver started using a larger value,\n// internal assumptions of the Runtime's GC feature will be violated\n// DO NOT INCREASE THIS TYPE'S VALUE\n/**\n * @legacy @beta\n */\nexport type FiveDaysMs = 432_000_000; /* 5 days in milliseconds */\n\n/**\n * Policies describing attributes or characteristics of the driver's storage service,\n * to direct how other components interact with the driver\n * @legacy @beta\n */\nexport interface IDocumentStorageServicePolicies {\n\t/**\n\t * Should the Loader implement any sort of pre-fetching or caching mechanism?\n\t */\n\treadonly caching?: LoaderCachingPolicy;\n\n\t/**\n\t * IMPORTANT: This policy MUST be set to 5 days and PROPERLY ENFORCED for drivers that are used\n\t * in applications where Garbage Collection is enabled. Otherwise data loss may occur.\n\t *\n\t * This policy pertains to requests for the latest snapshot from the service.\n\t * If set, it means that the driver guarantees not to use a cached value that was fetched more than 5 days ago.\n\t * If undefined, the driver makes no guarantees about the age of snapshots used for loading.\n\t */\n\treadonly maximumCacheDurationMs?: FiveDaysMs;\n}\n\n/**\n * Interface to provide access to snapshots saved for a shared object\n * @legacy @beta\n */\nexport interface IDocumentStorageService extends Partial<IDisposable> {\n\t/**\n\t * Policies implemented/instructed by driver.\n\t */\n\treadonly policies?: IDocumentStorageServicePolicies | undefined;\n\n\t/**\n\t * Returns the snapshot tree.\n\t * @param version - Version of the snapshot to be fetched.\n\t * @param scenarioName - scenario in which this api is called. This will be recorded by server and would help\n\t * in debugging purposes to see why this call was made.\n\t */\n\t// TODO: use `undefined` instead.\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tgetSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;\n\n\t/**\n\t * Returns the snapshot which can contain other artifacts too like blob contents, ops etc. It is different from\n\t * `getSnapshotTree` api in that, that API only returns the snapshot tree from the snapshot.\n\t * @param snapshotFetchOptions - Options specified by the caller to specify and want certain behavior from the\n\t * driver when fetching the snapshot.\n\t */\n\tgetSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;\n\n\t/**\n\t * Retrieves all versions of the document starting at the specified versionId - or null if from the head\n\t * @param versionId - Version id of the requested version.\n\t * @param count - Number of the versions to be fetched.\n\t * @param scenarioName - scenario in which this api is called. This will be recorded by server and would help\n\t * in debugging purposes to see why this call was made.\n\t * @param fetchSource - Callers can specify the source of the response. For ex. Driver may choose to cache\n\t * requests and serve data from cache. That will result in stale info returned. Callers can disable this\n\t * functionality by passing fetchSource = noCache and ensuring that driver will return latest information\n\t * from storage.\n\t */\n\tgetVersions(\n\t\t// TODO: use `undefined` instead.\n\t\t// eslint-disable-next-line @rushstack/no-new-null\n\t\tversionId: string | null,\n\t\tcount: number,\n\t\tscenarioName?: string,\n\t\tfetchSource?: FetchSource,\n\t): Promise<IVersion[]>;\n\n\t/**\n\t * Creates a blob out of the given buffer\n\t */\n\tcreateBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;\n\n\t/**\n\t * Reads the object with the given ID, returns content in arrayBufferLike\n\t */\n\treadBlob(id: string): Promise<ArrayBufferLike>;\n\n\t/**\n\t * Uploads a summary tree to storage using the given context for reference of previous summary handle.\n\t * The ISummaryHandles in the uploaded tree should have paths to indicate which summary object they are\n\t * referencing from the previously acked summary.\n\t * Returns the uploaded summary handle.\n\t */\n\tuploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;\n\n\t/**\n\t * Retrieves the commit that matches the packfile handle. If the packfile has already been committed and the\n\t * server has deleted it this call may result in a broken promise.\n\t */\n\tdownloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;\n}\n\n/**\n * Events emitted by {@link IDocumentService}.\n * @legacy @beta\n */\nexport interface IDocumentServiceEvents extends IEvent {\n\t/**\n\t * This event is used to communicate any metadata related to the container. We might have received metadata from the service.\n\t * Read more info on this event from here `IContainer.containerMetadata`.\n\t */\n\t(event: \"metadataUpdate\", listener: (metadata: Record<string, string>) => void);\n}\n\n/**\n * @legacy @beta\n */\nexport interface IDocumentDeltaConnectionEvents extends IErrorEvent {\n\t(event: \"nack\", listener: (documentId: string, message: INack[]) => void);\n\t/**\n\t * @param reason - The reason for the disconnection.\n\t * Note: this parameter will also accept undefined in a future release to support clean disconnections.\n\t * When `reason` is provided, it indicates an error that caused the disconnection. When `undefined`, it represents\n\t * a clean, intentional disconnect that should not be treated as an error.\n\t * Signature will change from `(reason: IAnyDriverError) => void` to `(reason: IAnyDriverError | undefined) => void`.\n\t * Update your listener implementations to handle cases where `reason` is undefined.\n\t */\n\t(event: \"disconnect\", listener: (reason: IAnyDriverError) => void);\n\t(event: \"op\", listener: (documentId: string, messages: ISequencedDocumentMessage[]) => void);\n\t(event: \"signal\", listener: (message: ISignalMessage | ISignalMessage[]) => void);\n\t(event: \"pong\", listener: (latency: number) => void);\n\t// TODO: Use something other than `any`.\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t(event: \"error\", listener: (error: any) => void);\n}\n\n/**\n * @legacy @beta\n */\nexport interface IDocumentDeltaConnection\n\textends IDisposable,\n\t\tIEventProvider<IDocumentDeltaConnectionEvents> {\n\t/**\n\t * ClientID for the connection\n\t */\n\tclientId: string;\n\n\t/**\n\t * Claims for the client\n\t */\n\tclaims: ITokenClaims;\n\n\t/**\n\t * Mode of the client\n\t */\n\tmode: ConnectionMode;\n\n\t/**\n\t * Whether the connection was made to a new or existing document\n\t */\n\texisting: boolean;\n\n\t/**\n\t * Protocol version being used with the service\n\t */\n\tversion: string;\n\n\t/**\n\t * Messages sent during the connection\n\t */\n\tinitialMessages: ISequencedDocumentMessage[];\n\n\t/**\n\t * Signals sent during the connection\n\t */\n\tinitialSignals: ISignalMessage[];\n\n\t/**\n\t * Prior clients already connected.\n\t */\n\tinitialClients: ISignalClient[];\n\n\t/**\n\t * Configuration details provided by the service\n\t */\n\tserviceConfiguration: IClientConfiguration;\n\n\t/**\n\t * Last known sequence number to ordering service at the time of connection\n\t * It may lap actual last sequence number (quite a bit, if container  is very active).\n\t * But it's best information for client to figure out how far it is behind, at least\n\t * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n\t * that is likely to be more up-to-date.\n\t */\n\tcheckpointSequenceNumber?: number;\n\n\t/**\n\t * Properties that server can send to client to tell info about node that client is connected to. For ex, for spo\n\t * it could contain info like build version, environment, region etc. These properties can be logged by client\n\t * to better understand server environment etc. and use it in case error occurs.\n\t * Format: \"prop1:val1;prop2:val2;prop3:val3\"\n\t */\n\trelayServiceAgent?: string;\n\n\t/**\n\t * Submit a new message to the server\n\t */\n\tsubmit(messages: IDocumentMessage[]): void;\n\n\t/**\n\t * Submits a new signal to the server\n\t *\n\t * @privateRemarks\n\t * UnknownShouldBe<string> can be string if {@link IDocumentServiceFactory} becomes internal.\n\t */\n\tsubmitSignal: (content: string, targetClientId?: string) => void;\n}\n\n/**\n * @legacy @beta\n */\nexport enum LoaderCachingPolicy {\n\t/**\n\t * The loader should not implement any prefetching or caching policy.\n\t */\n\tNoCaching,\n\n\t/**\n\t * The loader should implement prefetching policy, i.e. it should prefetch resources from the latest snapshot.\n\t */\n\tPrefetch,\n}\n\n/**\n * @legacy @beta\n */\nexport interface IDocumentServicePolicies {\n\t/**\n\t * Do not connect to delta stream\n\t */\n\treadonly storageOnly?: boolean;\n\n\t/**\n\t * Summarizer uploads the protocol tree too when summarizing.\n\t */\n\treadonly summarizeProtocolTree?: boolean;\n\n\t/**\n\t * Whether the driver supports the new getSnapshot api which returns snapshot which\n\t * contains all contents along with the snapshot tree. Enable this by default when the\n\t * driver can fully support the api.\n\t */\n\treadonly supportGetSnapshotApi?: boolean;\n}\n\n/**\n * @legacy @beta\n */\nexport interface IDocumentService extends IEventProvider<IDocumentServiceEvents> {\n\tresolvedUrl: IResolvedUrl;\n\n\t/**\n\t * Policies implemented/instructed by driver.\n\t */\n\tpolicies?: IDocumentServicePolicies;\n\n\t/**\n\t * Access to storage associated with the document\n\t */\n\tconnectToStorage(): Promise<IDocumentStorageService>;\n\n\t/**\n\t * Access to delta storage associated with the document\n\t */\n\tconnectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;\n\n\t/**\n\t * Subscribes to the document delta stream\n\t */\n\tconnectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;\n\n\t/**\n\t * Dispose storage. Called by storage consumer (Container) when it's done with storage (Container closed).\n\t * Useful for storage to commit any pending state if any (including any local caching).\n\t * Please note that it does not remove the need for caller to close all active delta connections,\n\t * as storage may not be tracking such objects.\n\t * @param error - tells if container (and storage) are closed due to critical error.\n\t * Error might be due to disconnect between client & server knowledge about file, like file being overwritten\n\t * in storage, but client having stale local cache.\n\t * If driver implements any kind of local caching, such caches needs to be cleared on on critical errors.\n\t */\n\t// TODO: Use something other than `any`.\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\tdispose(error?: any): void;\n}\n\n/**\n * @legacy @beta\n */\nexport interface IDocumentServiceFactory {\n\t/**\n\t * Creates the document service after extracting different endpoints URLs from a resolved URL.\n\t *\n\t * @param resolvedUrl - Endpoint URL data. See {@link IResolvedUrl}.\n\t * @param logger - Optional telemetry logger to which telemetry events will be forwarded.\n\t * @param clientIsSummarizer - Whether or not the client is the\n\t * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.\n\t * `undefined` =\\> false\n\t *\n\t * @returns An instance of {@link IDocumentService}.\n\t */\n\tcreateDocumentService(\n\t\tresolvedUrl: IResolvedUrl,\n\t\tlogger?: ITelemetryBaseLogger,\n\t\tclientIsSummarizer?: boolean,\n\t): Promise<IDocumentService>;\n\n\t/**\n\t * Creates a new document with the provided options. Returns the document service.\n\t *\n\t * @param createNewSummary - Summary used to create file. If undefined, an empty file will be created and a summary\n\t * should be posted later, before connecting to ordering service.\n\t * @param createNewResolvedUrl - Endpoint URL data. See {@link IResolvedUrl}.\n\t * @param logger - Optional telemetry logger to which telemetry events will be forwarded.\n\t * @param clientIsSummarizer - Whether or not the client is the\n\t * {@link https://fluidframework.com/docs/concepts/summarizer/ | summarizer}.\n\t * `undefined` =\\> false\n\t */\n\tcreateContainer(\n\t\tcreateNewSummary: ISummaryTree | undefined,\n\t\tcreateNewResolvedUrl: IResolvedUrl,\n\t\tlogger?: ITelemetryBaseLogger,\n\t\tclientIsSummarizer?: boolean,\n\t): Promise<IDocumentService>;\n}\n\n/**\n * Context for uploading a summary to storage.\n * Indicates the previously acked summary.\n * @legacy @beta\n */\nexport interface ISummaryContext {\n\t/**\n\t * Parent summary proposed handle (from summary op)\n\t */\n\treadonly proposalHandle: string | undefined;\n\n\t/**\n\t * Parent summary acked handle (from summary ack)\n\t */\n\treadonly ackHandle: string | undefined;\n\n\treadonly referenceSequenceNumber: number;\n}\n\n/**\n * @legacy @beta\n */\nexport enum FetchSource {\n\tdefault = \"default\",\n\tnoCache = \"noCache\",\n}\n\n/**\n * A \"Full\" container Snapshot, including ISnapshotTree, blobs and outstanding ops (and other metadata)\n *\n * @legacy @beta\n */\nexport interface ISnapshot {\n\tsnapshotTree: ISnapshotTree;\n\tblobContents: Map<string, ArrayBuffer>;\n\tops: ISequencedDocumentMessage[];\n\n\t/**\n\t * Sequence number of the snapshot\n\t */\n\tsequenceNumber: number | undefined;\n\n\t/**\n\t * Sequence number for the latest op/snapshot for the file in ODSP\n\t */\n\tlatestSequenceNumber: number | undefined;\n\n\tsnapshotFormatV: 1;\n}\n\n/**\n * Snapshot fetch options which are used to communicate different things to the driver\n * when fetching the snapshot.\n * @legacy @beta\n */\nexport interface ISnapshotFetchOptions {\n\t/**\n\t * Indicates scenario in which the snapshot is fetched. It is a free form string  mostly\n\t * used for telemetry purposes.\n\t */\n\tscenarioName?: string;\n\t/**\n\t * Tell driver to cache the fetched snapshot. Driver is supposed to cache the fetched snapshot if this is\n\t * set to true. If undefined, then it is upto the driver, to cache it or not.\n\t */\n\tcacheSnapshot?: boolean;\n\n\t/**\n\t * Version of the snapshot to be fetched. Certain storage services just keep 1 snapshot for the\n\t * container, so specifying version is not necessary for storage services.\n\t */\n\tversionId?: string;\n\n\t/**\n\t * List of loading groupId of datastores for which the snapshot needs to be fetched. If not provided, content with\n\t * default/missing groupIDs will be requested from the service. It is upto the service, to include snapshot for\n\t * content with groupIds or not. Don't provide anything here for fetching content for initial container boot.\n\t */\n\tloadingGroupIds?: string[];\n\n\t/**\n\t * Specify if you want default behavior of the driver to fetch the snapshot like lets say simultaneously fetch from\n\t * network and cache or specify FetchSource.noCache to just fetch from network.\n\t */\n\tfetchSource?: FetchSource;\n}\n"]}

lib/urlResolver.d.ts

@@ -7,4 +7,3 @@ /*!
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -27,4 +26,3 @@ export interface IResolvedUrl {
  * Container package info handed off to resolver.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -38,4 +36,3 @@ export interface IContainerPackageInfo {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -56,4 +53,3 @@ export interface IUrlResolver {
  * for driver compatibility and preload information.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -73,4 +69,3 @@ export interface DriverPreCheckInfo {
  * Additional key in the loader request header
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -77,0 +72,0 @@ export declare enum DriverHeader {

lib/urlResolver.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"urlResolver.d.ts","sourceRoot":"","sources":["../src/urlResolver.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAEhE;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACnC,SAAS,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACrC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAI5B,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;IAE9D;;;;;;OAMG;IACH,cAAc,CACb,WAAW,EAAE,YAAY,EACzB,WAAW,EAAE,MAAM,EACnB,iBAAiB,CAAC,EAAE,qBAAqB,GACvC,OAAO,CAAC,MAAM,CAAC,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IAClC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC/B;AAED;;;;GAIG;AACH,oBAAY,YAAY;IAEvB,iBAAiB,4BAA4B;IAE7C,SAAS,cAAc;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,CAAC,YAAY,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAG1C,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC;CAC9B;AAED,OAAO,QAAQ,iCAAiC,CAAC;IAChD;;;;OAIG;IAEH,UAAiB,cAAe,SAAQ,OAAO,CAAC,aAAa,CAAC;KAAG;CACjE"}
+{"version":3,"file":"urlResolver.d.ts","sourceRoot":"","sources":["../src/urlResolver.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACnC,SAAS,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACrC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAI5B,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;IAE9D;;;;;;OAMG;IACH,cAAc,CACb,WAAW,EAAE,YAAY,EACzB,WAAW,EAAE,MAAM,EACnB,iBAAiB,CAAC,EAAE,qBAAqB,GACvC,OAAO,CAAC,MAAM,CAAC,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAClC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC/B;AAED;;;GAGG;AACH,oBAAY,YAAY;IAEvB,iBAAiB,4BAA4B;IAE7C,SAAS,cAAc;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,CAAC,YAAY,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAG1C,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC;CAC9B;AAED,OAAO,QAAQ,iCAAiC,CAAC;IAChD;;;;OAIG;IAEH,UAAiB,cAAe,SAAQ,OAAO,CAAC,aAAa,CAAC;KAAG;CACjE"}

lib/urlResolver.js

@@ -7,4 +7,3 @@ /*!
  * Additional key in the loader request header
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -11,0 +10,0 @@ export var DriverHeader;

lib/urlResolver.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"urlResolver.js","sourceRoot":"","sources":["../src/urlResolver.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA0EH;;;;GAIG;AACH,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACvB,qDAAqD;IACrD,6DAA6C,CAAA;IAC7C,iDAAiD;IACjD,uCAAuB,CAAA;AACxB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IRequest } from \"@fluidframework/core-interfaces\";\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IResolvedUrl {\n\ttype: \"fluid\";\n\t/**\n\t * The id of the container this resolved url is for.\n\t */\n\tid: string;\n\turl: string;\n\ttokens: { [name: string]: string };\n\tendpoints: { [name: string]: string };\n}\n\n/**\n * Container package info handed off to resolver.\n * @legacy\n * @alpha\n */\nexport interface IContainerPackageInfo {\n\t/**\n\t * Container package name.\n\t */\n\tname: string;\n}\n\n/**\n * @legacy\n * @alpha\n */\nexport interface IUrlResolver {\n\t// Like DNS should be able to cache resolution requests. Then possibly just have a token provider go and do stuff?\n\t// the expiration of it could be relative to the lifetime of the token? Requests after need to refresh?\n\t// or do we split the token access from this?\n\tresolve(request: IRequest): Promise<IResolvedUrl | undefined>;\n\n\t/**\n\t * Creates a url for the created container with any data store path given in the relative url.\n\t * @param resolvedUrl - resolved url for the container.\n\t * @param relativeUrl - relative url containing data store path; '/' represents root path.\n\t * @param packageInfoSource - optional, represents container package information to be included in url.\n\t * @returns absolute url combining container url with dta store path and optional additional information.\n\t */\n\tgetAbsoluteUrl(\n\t\tresolvedUrl: IResolvedUrl,\n\t\trelativeUrl: string,\n\t\tpackageInfoSource?: IContainerPackageInfo,\n\t): Promise<string>;\n}\n\n/**\n * Information that can be returned by a lightweight, seperately exported driver function. Used to preanalyze a URL\n * for driver compatibility and preload information.\n * @legacy\n * @alpha\n */\nexport interface DriverPreCheckInfo {\n\t/**\n\t * A code details hint that can potentially be used to prefetch container code prior to having a snapshot.\n\t */\n\tcodeDetailsHint?: string;\n\n\t/**\n\t * Domains that will be connected to on the critical boot path. Hosts can choose to preconnect to these for\n\t * improved performance.\n\t */\n\tcriticalBootDomains?: string[];\n}\n\n/**\n * Additional key in the loader request header\n * @legacy\n * @alpha\n */\nexport enum DriverHeader {\n\t// Key to indicate whether the request for summarizer\n\tsummarizingClient = \"fluid-client-summarizer\",\n\t// createNew information, specific to each driver\n\tcreateNew = \"createNew\",\n}\n\n/**\n * @internal\n */\nexport interface IDriverHeader {\n\t[DriverHeader.summarizingClient]: boolean;\n\t// TODO: Use something other than `any`.\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t[DriverHeader.createNew]: any;\n}\n\ndeclare module \"@fluidframework/core-interfaces\" {\n\t/**\n\t * Interface to represent headers to include in the container or data store load request.\n\t * For example, caller can use this to pass on various loader options in the container\n\t * load request.\n\t */\n\t// eslint-disable-next-line @typescript-eslint/no-empty-interface\n\texport interface IRequestHeader extends Partial<IDriverHeader> {}\n}\n"]}
+{"version":3,"file":"urlResolver.js","sourceRoot":"","sources":["../src/urlResolver.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAsEH;;;GAGG;AACH,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACvB,qDAAqD;IACrD,6DAA6C,CAAA;IAC7C,iDAAiD;IACjD,uCAAuB,CAAA;AACxB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { IRequest } from \"@fluidframework/core-interfaces\";\n\n/**\n * @legacy @beta\n */\nexport interface IResolvedUrl {\n\ttype: \"fluid\";\n\t/**\n\t * The id of the container this resolved url is for.\n\t */\n\tid: string;\n\turl: string;\n\ttokens: { [name: string]: string };\n\tendpoints: { [name: string]: string };\n}\n\n/**\n * Container package info handed off to resolver.\n * @legacy @beta\n */\nexport interface IContainerPackageInfo {\n\t/**\n\t * Container package name.\n\t */\n\tname: string;\n}\n\n/**\n * @legacy @beta\n */\nexport interface IUrlResolver {\n\t// Like DNS should be able to cache resolution requests. Then possibly just have a token provider go and do stuff?\n\t// the expiration of it could be relative to the lifetime of the token? Requests after need to refresh?\n\t// or do we split the token access from this?\n\tresolve(request: IRequest): Promise<IResolvedUrl | undefined>;\n\n\t/**\n\t * Creates a url for the created container with any data store path given in the relative url.\n\t * @param resolvedUrl - resolved url for the container.\n\t * @param relativeUrl - relative url containing data store path; '/' represents root path.\n\t * @param packageInfoSource - optional, represents container package information to be included in url.\n\t * @returns absolute url combining container url with dta store path and optional additional information.\n\t */\n\tgetAbsoluteUrl(\n\t\tresolvedUrl: IResolvedUrl,\n\t\trelativeUrl: string,\n\t\tpackageInfoSource?: IContainerPackageInfo,\n\t): Promise<string>;\n}\n\n/**\n * Information that can be returned by a lightweight, seperately exported driver function. Used to preanalyze a URL\n * for driver compatibility and preload information.\n * @legacy @beta\n */\nexport interface DriverPreCheckInfo {\n\t/**\n\t * A code details hint that can potentially be used to prefetch container code prior to having a snapshot.\n\t */\n\tcodeDetailsHint?: string;\n\n\t/**\n\t * Domains that will be connected to on the critical boot path. Hosts can choose to preconnect to these for\n\t * improved performance.\n\t */\n\tcriticalBootDomains?: string[];\n}\n\n/**\n * Additional key in the loader request header\n * @legacy @beta\n */\nexport enum DriverHeader {\n\t// Key to indicate whether the request for summarizer\n\tsummarizingClient = \"fluid-client-summarizer\",\n\t// createNew information, specific to each driver\n\tcreateNew = \"createNew\",\n}\n\n/**\n * @internal\n */\nexport interface IDriverHeader {\n\t[DriverHeader.summarizingClient]: boolean;\n\t// TODO: Use something other than `any`.\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t[DriverHeader.createNew]: any;\n}\n\ndeclare module \"@fluidframework/core-interfaces\" {\n\t/**\n\t * Interface to represent headers to include in the container or data store load request.\n\t * For example, caller can use this to pass on various loader options in the container\n\t * load request.\n\t */\n\t// eslint-disable-next-line @typescript-eslint/no-empty-interface\n\texport interface IRequestHeader extends Partial<IDriverHeader> {}\n}\n"]}

package.json

 {
   "name": "@fluidframework/driver-definitions",
-  "version": "2.53.1",
+  "version": "2.60.0",
   "description": "Fluid driver definitions",
@@ -50,3 +50,3 @@ "homepage": "https://fluidframework.com",
   "dependencies": {
-    "@fluidframework/core-interfaces": "~2.53.1"
+    "@fluidframework/core-interfaces": "~2.60.0"
   },
@@ -60,3 +60,3 @@ "devDependencies": {
     "@fluidframework/driver-definitions-previous": "npm:@fluidframework/driver-definitions@2.53.0",
-    "@fluidframework/eslint-config-fluid": "^5.7.4",
+    "@fluidframework/eslint-config-fluid": "^6.0.0",
     "@microsoft/api-extractor": "7.52.8",
@@ -63,0 +63,0 @@ "concurrently": "^8.2.1",

src/driverError.ts

@@ -16,4 +16,3 @@ /*!
  * Different error types the Driver may report out to the Host.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -112,4 +111,3 @@ export const DriverErrorTypes = {
  * {@inheritDoc (DriverErrorTypes:variable)}
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -128,4 +126,3 @@ export type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErrorTypes];
  * but we can't reference a specific driver's error type enum in this code.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -143,4 +140,3 @@ export interface IAnyDriverError extends Omit<IDriverErrorBase, "errorType"> {
  * Base interface for all errors and warnings
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -178,4 +174,3 @@ export interface IDriverErrorBase {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -188,4 +183,3 @@ export interface IThrottlingWarning extends IDriverErrorBase {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -198,4 +192,3 @@ export interface IGenericNetworkError extends IDriverErrorBase {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -209,4 +202,3 @@ export interface IAuthorizationError extends IDriverErrorBase {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -221,4 +213,3 @@ export interface ILocationRedirectionError extends IDriverErrorBase {
  * allows compiler to differentiate interfaces based on error type
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -244,4 +235,3 @@ export interface IDriverBasicError extends IDriverErrorBase {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -248,0 +238,0 @@ export type DriverError =

src/git/resources.ts

@@ -145,4 +145,3 @@ /*!
  * Required params to create ref
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -156,4 +155,3 @@ export interface ICreateRefParams {
  * Required params to patch ref
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -160,0 +158,0 @@ export interface IPatchRefParams {

src/protocol/clients.ts

@@ -114,4 +114,3 @@ /*!
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -118,0 +117,0 @@ export interface ISignalClient {

src/protocol/config.ts

@@ -8,4 +8,3 @@ /*!
  * Key value store of service configuration properties provided to the client as part of connection.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -12,0 +11,0 @@ export interface IClientConfiguration {

src/protocol/consensus.ts

@@ -15,4 +15,3 @@ /*!
  * the proposal.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -33,4 +32,3 @@ export interface IProposal {
  * Similar to {@link IProposal} except it also includes the sequence number when it was made.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -41,4 +39,3 @@ export type ISequencedProposal = { sequenceNumber: number } & IProposal;
  * Adds the sequence number at which the message was approved to an {@link ISequencedProposal}.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -49,4 +46,3 @@ export type IApprovedProposal = { approvalSequenceNumber: number } & ISequencedProposal;
  * Adds the sequence number at which the message was committed to an {@link IApprovedProposal}.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -72,4 +68,3 @@ export type ICommittedProposal = { commitSequenceNumber: number } & IApprovedProposal;
  * Interface for tracking proposals in the Quorum.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -101,4 +96,3 @@ export interface IQuorumProposals {
  * Interface combining tracking of clients as well as proposals in the Quorum.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -125,4 +119,3 @@ export interface IQuorum
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -129,0 +122,0 @@ export interface IProcessMessageResult {

src/protocol/date.ts

@@ -8,5 +8,4 @@ /*!
  * {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601 format} date: `YYYY-MM-DDTHH:MM:SSZ`.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type IsoDate = string;

src/protocol/protocol.ts

@@ -9,4 +9,3 @@ /*!
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -100,4 +99,3 @@ export enum MessageType {
  * Messages to track latency trace.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -122,4 +120,3 @@ export interface ITrace {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -145,4 +142,3 @@ export interface INack {
  * Document-specific message.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -202,4 +198,3 @@ export interface IDocumentMessage {
  * Branch origin information.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -225,4 +220,3 @@ export interface IBranchOrigin {
  * Sequenced message for a distributed document.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -349,4 +343,3 @@ export interface ISequencedDocumentMessage {
  * Common interface between incoming and outgoing signals.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -383,4 +376,3 @@ export interface ISignalMessageBase<TMessage extends TypedMessage = TypedMessage> {
  * Interface for signals sent by the server to clients.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -405,4 +397,3 @@ export interface ISignalMessage<TMessage extends TypedMessage = TypedMessage>
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -417,4 +408,3 @@ export interface IUploadedSummaryDetails {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -465,4 +455,3 @@ export interface ISummaryContent {
  * Data about the original proposed summary message.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -478,4 +467,3 @@ export interface ISummaryProposal {
  * Contents of summary ack expected from the server.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -496,4 +484,3 @@ export interface ISummaryAck {
  * Contents of summary nack expected from the server.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -528,4 +515,3 @@ export interface ISummaryNack {
  * Interface for nack content.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -560,4 +546,3 @@ export interface INackContent {
  * Type of the nack.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -564,0 +549,0 @@ export enum NackErrorType {

src/protocol/scopes.ts

@@ -8,4 +8,3 @@ /*!
  * Defines scope access for a Container/Document.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -12,0 +11,0 @@ export enum ScopeType {

src/protocol/sockets.ts

@@ -13,4 +13,3 @@ /*!
  * Message sent to connect to the given document.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -84,4 +83,3 @@ export interface IConnect {
  * Message sent to indicate a client has connected to the server.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -88,0 +86,0 @@ export interface IConnected {

src/protocol/storage.ts

@@ -9,4 +9,3 @@ /*!
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -26,4 +25,3 @@ export interface IDocumentAttributes {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -39,4 +37,3 @@ export enum FileMode {
  * Raw blob stored within the tree.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -52,3 +49,3 @@ export interface IBlob {
 	 */
-	// 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";
@@ -58,4 +55,3 @@ }
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -67,4 +63,3 @@ export interface IAttachment {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -77,4 +72,3 @@ export interface ICreateBlobResponse {
  * A tree entry wraps a path with a type of node.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -109,4 +103,3 @@ export type ITreeEntry = {
  * Type of entries that can be stored in a tree.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -120,4 +113,3 @@ export enum TreeEntry {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -148,4 +140,3 @@ export interface ITree {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -181,4 +172,3 @@ export interface ISnapshotTree {
  * Represents a version of the snapshot of a data store.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -185,0 +175,0 @@ export interface IVersion {

src/protocol/summary.ts

@@ -17,4 +17,3 @@ /*!
  * The root of the summary tree.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -21,0 +20,0 @@ export type SummaryTree = ISummaryTree | ISummaryHandle;

src/protocol/tokens.ts

@@ -12,4 +12,3 @@ /*!
  * See {@link https://datatracker.ietf.org/doc/html/rfc7519#section-4}
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -16,0 +15,0 @@ export interface ITokenClaims {

src/storage.ts

@@ -76,4 +76,3 @@ /*!
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -84,4 +83,3 @@ export type IStreamResult<T> = { done: true } | { done: false; value: T };
  * Read interface for the Queue
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -94,4 +92,3 @@ export interface IStream<T> {
  * Interface to provide access to stored deltas for a shared object
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -123,4 +120,3 @@ export interface IDocumentDeltaStorageService {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -132,4 +128,3 @@ export type FiveDaysMs = 432_000_000; /* 5 days in milliseconds */
  * to direct how other components interact with the driver
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -155,4 +150,3 @@ export interface IDocumentStorageServicePolicies {
  * Interface to provide access to snapshots saved for a shared object
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -230,4 +224,3 @@ export interface IDocumentStorageService extends Partial<IDisposable> {
  * Events emitted by {@link IDocumentService}.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -243,4 +236,3 @@ export interface IDocumentServiceEvents extends IEvent {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -267,4 +259,3 @@ export interface IDocumentDeltaConnectionEvents extends IErrorEvent {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -351,4 +342,3 @@ export interface IDocumentDeltaConnection
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -368,4 +358,3 @@ export enum LoaderCachingPolicy {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -392,4 +381,3 @@ export interface IDocumentServicePolicies {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -435,4 +423,3 @@ export interface IDocumentService extends IEventProvider<IDocumentServiceEvents> {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -479,4 +466,3 @@ export interface IDocumentServiceFactory {
  * Indicates the previously acked summary.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -498,4 +484,3 @@ export interface ISummaryContext {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -510,4 +495,3 @@ export enum FetchSource {
  *
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -535,4 +519,3 @@ export interface ISnapshot {
  * when fetching the snapshot.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -539,0 +522,0 @@ export interface ISnapshotFetchOptions {

src/urlResolver.ts

@@ -9,4 +9,3 @@ /*!
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -26,4 +25,3 @@ export interface IResolvedUrl {
  * Container package info handed off to resolver.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -38,4 +36,3 @@ export interface IContainerPackageInfo {
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -65,4 +62,3 @@ export interface IUrlResolver {
  * for driver compatibility and preload information.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -84,4 +80,3 @@ export interface DriverPreCheckInfo {
  * Additional key in the loader request header
- * @legacy
- * @alpha
+ * @legacy @beta
  */
@@ -88,0 +83,0 @@ export enum DriverHeader {

api-report/driver-definitions.legacy.alpha.api.md

-## Alpha API Report File for "@fluidframework/driver-definitions"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-// @public
-export type ConnectionMode = "write" | "read";
-
-// @alpha @legacy (undocumented)
-export type DriverError = IThrottlingWarning | IGenericNetworkError | IAuthorizationError | ILocationRedirectionError | IDriverBasicError;
-
-// @alpha @legacy
-export const DriverErrorTypes: {
-    readonly genericNetworkError: "genericNetworkError";
-    readonly authorizationError: "authorizationError";
-    readonly fileNotFoundOrAccessDeniedError: "fileNotFoundOrAccessDeniedError";
-    readonly offlineError: "offlineError";
-    readonly unsupportedClientProtocolVersion: "unsupportedClientProtocolVersion";
-    readonly writeError: "writeError";
-    readonly fetchFailure: "fetchFailure";
-    readonly fetchTokenError: "fetchTokenError";
-    readonly incorrectServerResponse: "incorrectServerResponse";
-    readonly fileOverwrittenInStorage: "fileOverwrittenInStorage";
-    readonly deltaStreamConnectionForbidden: "deltaStreamConnectionForbidden";
-    readonly locationRedirection: "locationRedirection";
-    readonly fluidInvalidSchema: "fluidInvalidSchema";
-    readonly fileIsLocked: "fileIsLocked";
-    readonly outOfStorageError: "outOfStorageError";
-    readonly genericError: "genericError";
-    readonly throttlingError: "throttlingError";
-    readonly usageError: "usageError";
-};
-
-// @alpha @legacy
-export type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErrorTypes];
-
-// @alpha @legacy
-export enum DriverHeader {
-    // (undocumented)
-    createNew = "createNew",
-    // (undocumented)
-    summarizingClient = "fluid-client-summarizer"
-}
-
-// @alpha @legacy
-export interface DriverPreCheckInfo {
-    codeDetailsHint?: string;
-    criticalBootDomains?: string[];
-}
-
-// @alpha @legacy (undocumented)
-export enum FetchSource {
-    // (undocumented)
-    default = "default",
-    // (undocumented)
-    noCache = "noCache"
-}
-
-// @alpha @legacy (undocumented)
-export enum FileMode {
-    // (undocumented)
-    Directory = "040000",
-    // (undocumented)
-    Executable = "100755",
-    // (undocumented)
-    File = "100644",
-    // (undocumented)
-    Symlink = "120000"
-}
-
-// @alpha @legacy (undocumented)
-export type FiveDaysMs = 432_000_000;
-
-// @alpha @legacy
-export interface IAnyDriverError extends Omit<IDriverErrorBase, "errorType"> {
-    // (undocumented)
-    readonly errorType: string;
-    scenarioName?: string;
-}
-
-// @alpha @legacy
-export type IApprovedProposal = {
-    approvalSequenceNumber: number;
-} & ISequencedProposal;
-
-// @alpha @legacy (undocumented)
-export interface IAttachment {
-    // (undocumented)
-    id: string;
-}
-
-// @alpha @legacy (undocumented)
-export interface IAuthorizationError extends IDriverErrorBase {
-    // (undocumented)
-    readonly claims?: string;
-    // (undocumented)
-    readonly errorType: typeof DriverErrorTypes.authorizationError;
-    // (undocumented)
-    readonly tenantId?: string;
-}
-
-// @alpha @legacy
-export interface IBlob {
-    contents: string;
-    encoding: "utf-8" | "base64";
-}
-
-// @alpha @legacy
-export interface IBranchOrigin {
-    id: string;
-    minimumSequenceNumber: number;
-    sequenceNumber: number;
-}
-
-// @public
-export interface ICapabilities {
-    interactive: boolean;
-}
-
-// @public
-export interface IClient {
-    details: IClientDetails;
-    mode: ConnectionMode;
-    // (undocumented)
-    permission: string[];
-    scopes: string[];
-    timestamp?: number;
-    user: IUser;
-}
-
-// @alpha @legacy
-export interface IClientConfiguration {
-    blockSize: number;
-    maxMessageSize: number;
-    noopCountFrequency?: number;
-    noopTimeFrequency?: number;
-}
-
-// @public
-export interface IClientDetails {
-    capabilities: ICapabilities;
-    // (undocumented)
-    device?: string;
-    // (undocumented)
-    environment?: string;
-    type?: string;
-}
-
-// @alpha @legacy
-export type ICommittedProposal = {
-    commitSequenceNumber: number;
-} & IApprovedProposal;
-
-// @alpha @legacy
-export interface IConnect {
-    client: IClient;
-    driverVersion?: string;
-    epoch?: string;
-    id: string;
-    mode: ConnectionMode;
-    nonce?: string;
-    relayUserAgent?: string;
-    supportedFeatures?: Record<string, unknown>;
-    tenantId: string;
-    token: string | null;
-    versions: string[];
-}
-
-// @alpha @legacy
-export interface IConnected {
-    checkpointSequenceNumber?: number;
-    claims: ITokenClaims;
-    clientId: string;
-    epoch?: string;
-    existing: boolean;
-    initialClients: ISignalClient[];
-    initialMessages: ISequencedDocumentMessage[];
-    initialSignals: ISignalMessage[];
-    maxMessageSize: number;
-    mode: ConnectionMode;
-    nonce?: string;
-    relayServiceAgent?: string;
-    serviceConfiguration: IClientConfiguration;
-    supportedFeatures?: Record<string, unknown>;
-    supportedVersions: string[];
-    timestamp?: number;
-    version: string;
-}
-
-// @alpha @legacy
-export interface IContainerPackageInfo {
-    name: string;
-}
-
-// @alpha @legacy (undocumented)
-export interface ICreateBlobResponse {
-    // (undocumented)
-    id: string;
-}
-
-// @alpha @legacy (undocumented)
-export interface IDocumentAttributes {
-    minimumSequenceNumber: number;
-    sequenceNumber: number;
-}
-
-// @alpha @legacy (undocumented)
-export interface IDocumentDeltaConnection extends IDisposable, IEventProvider<IDocumentDeltaConnectionEvents> {
-    checkpointSequenceNumber?: number;
-    claims: ITokenClaims;
-    clientId: string;
-    existing: boolean;
-    initialClients: ISignalClient[];
-    initialMessages: ISequencedDocumentMessage[];
-    initialSignals: ISignalMessage[];
-    mode: ConnectionMode;
-    relayServiceAgent?: string;
-    serviceConfiguration: IClientConfiguration;
-    submit(messages: IDocumentMessage[]): void;
-    submitSignal: (content: string, targetClientId?: string) => void;
-    version: string;
-}
-
-// @alpha @legacy (undocumented)
-export interface IDocumentDeltaConnectionEvents extends IErrorEvent {
-    // (undocumented)
-    (event: "nack", listener: (documentId: string, message: INack[]) => void): any;
-    // (undocumented)
-    (event: "disconnect", listener: (reason: IAnyDriverError) => void): any;
-    // (undocumented)
-    (event: "op", listener: (documentId: string, messages: ISequencedDocumentMessage[]) => void): any;
-    // (undocumented)
-    (event: "signal", listener: (message: ISignalMessage | ISignalMessage[]) => void): any;
-    // (undocumented)
-    (event: "pong", listener: (latency: number) => void): any;
-    // (undocumented)
-    (event: "error", listener: (error: any) => void): any;
-}
-
-// @alpha @legacy
-export interface IDocumentDeltaStorageService {
-    fetchMessages(from: number, to: number | undefined, abortSignal?: AbortSignal, cachedOnly?: boolean, fetchReason?: string): IStream<ISequencedDocumentMessage[]>;
-}
-
-// @alpha @legacy
-export interface IDocumentMessage {
-    clientSequenceNumber: number;
-    compression?: string;
-    contents: unknown;
-    metadata?: unknown;
-    referenceSequenceNumber: number;
-    serverMetadata?: unknown;
-    traces?: ITrace[];
-    type: string;
-}
-
-// @alpha @legacy (undocumented)
-export interface IDocumentService extends IEventProvider<IDocumentServiceEvents> {
-    connectToDeltaStorage(): Promise<IDocumentDeltaStorageService>;
-    connectToDeltaStream(client: IClient): Promise<IDocumentDeltaConnection>;
-    connectToStorage(): Promise<IDocumentStorageService>;
-    dispose(error?: any): void;
-    policies?: IDocumentServicePolicies;
-    // (undocumented)
-    resolvedUrl: IResolvedUrl;
-}
-
-// @alpha @legacy
-export interface IDocumentServiceEvents extends IEvent {
-    (event: "metadataUpdate", listener: (metadata: Record<string, string>) => void): any;
-}
-
-// @alpha @legacy (undocumented)
-export interface IDocumentServiceFactory {
-    createContainer(createNewSummary: ISummaryTree | undefined, createNewResolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-    createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
-}
-
-// @alpha @legacy (undocumented)
-export interface IDocumentServicePolicies {
-    readonly storageOnly?: boolean;
-    readonly summarizeProtocolTree?: boolean;
-    readonly supportGetSnapshotApi?: boolean;
-}
-
-// @alpha @legacy
-export interface IDocumentStorageService extends Partial<IDisposable> {
-    createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
-    downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
-    getSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;
-    getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;
-    getVersions(versionId: string | null, count: number, scenarioName?: string, fetchSource?: FetchSource): Promise<IVersion[]>;
-    readonly policies?: IDocumentStorageServicePolicies | undefined;
-    readBlob(id: string): Promise<ArrayBufferLike>;
-    uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
-}
-
-// @alpha @legacy
-export interface IDocumentStorageServicePolicies {
-    readonly caching?: LoaderCachingPolicy;
-    readonly maximumCacheDurationMs?: FiveDaysMs;
-}
-
-// @alpha @legacy
-export interface IDriverBasicError extends IDriverErrorBase {
-    // (undocumented)
-    readonly errorType: typeof DriverErrorTypes.genericError | typeof DriverErrorTypes.fileNotFoundOrAccessDeniedError | typeof DriverErrorTypes.offlineError | typeof DriverErrorTypes.unsupportedClientProtocolVersion | typeof DriverErrorTypes.writeError | typeof DriverErrorTypes.fetchFailure | typeof DriverErrorTypes.fetchTokenError | typeof DriverErrorTypes.incorrectServerResponse | typeof DriverErrorTypes.fileOverwrittenInStorage | typeof DriverErrorTypes.fluidInvalidSchema | typeof DriverErrorTypes.usageError | typeof DriverErrorTypes.fileIsLocked | typeof DriverErrorTypes.outOfStorageError;
-    // (undocumented)
-    readonly statusCode?: number;
-}
-
-// @alpha @legacy
-export interface IDriverErrorBase {
-    canRetry: boolean;
-    endpointReached?: boolean;
-    readonly errorType: DriverErrorTypes;
-    readonly message: string;
-    online?: string;
-}
-
-// @alpha @legacy (undocumented)
-export interface IGenericNetworkError extends IDriverErrorBase {
-    // (undocumented)
-    readonly errorType: typeof DriverErrorTypes.genericNetworkError;
-    // (undocumented)
-    readonly statusCode?: number;
-}
-
-// @alpha @legacy (undocumented)
-export interface ILocationRedirectionError extends IDriverErrorBase {
-    // (undocumented)
-    readonly errorType: typeof DriverErrorTypes.locationRedirection;
-    // (undocumented)
-    readonly redirectUrl: IResolvedUrl;
-}
-
-// @alpha @legacy (undocumented)
-export interface INack {
-    content: INackContent;
-    operation: IDocumentMessage | undefined;
-    sequenceNumber: number;
-}
-
-// @alpha @legacy
-export interface INackContent {
-    code: number;
-    message: string;
-    retryAfter?: number;
-    type: NackErrorType;
-}
-
-// @alpha @legacy (undocumented)
-export interface IProcessMessageResult {
-    // (undocumented)
-    immediateNoOp?: boolean;
-}
-
-// @alpha @legacy
-export interface IProposal {
-    key: string;
-    value: unknown;
-}
-
-// @alpha @legacy
-export interface IQuorum extends Omit<IQuorumClients, "on" | "once" | "off">, Omit<IQuorumProposals, "on" | "once" | "off"> {
-    // (undocumented)
-    off: IQuorum["on"];
-    // (undocumented)
-    on: IQuorumClients["on"] & IQuorumProposals["on"];
-    // (undocumented)
-    once: IQuorum["on"];
-}
-
-// @public
-export interface IQuorumClients {
-    // (undocumented)
-    getMember(clientId: string): ISequencedClient | undefined;
-    // (undocumented)
-    getMembers(): Map<string, ISequencedClient>;
-    // (undocumented)
-    off: IQuorumClients["on"];
-    // (undocumented)
-    on(event: "addMember", listener: (clientId: string, details: ISequencedClient) => void): any;
-    // (undocumented)
-    on(event: "removeMember", listener: (clientId: string) => void): any;
-    // (undocumented)
-    on(event: "error", listener: (message: any) => void): any;
-    // (undocumented)
-    once: IQuorumClients["on"];
-}
-
-// @alpha @legacy
-export interface IQuorumProposals {
-    // (undocumented)
-    get(key: string): unknown;
-    // (undocumented)
-    has(key: string): boolean;
-    // (undocumented)
-    off: IQuorumProposals["on"];
-    // (undocumented)
-    on(event: "addProposal", listener: (proposal: ISequencedProposal) => void): any;
-    // (undocumented)
-    on(event: "approveProposal", listener: (sequenceNumber: number, key: string, value: unknown, approvalSequenceNumber: number) => void): any;
-    // (undocumented)
-    on(event: "error", listener: (message: any) => void): void;
-    // (undocumented)
-    once: IQuorumProposals["on"];
-    // (undocumented)
-    propose(key: string, value: unknown): Promise<void>;
-}
-
-// @alpha @legacy (undocumented)
-export interface IResolvedUrl {
-    // (undocumented)
-    endpoints: {
-        [name: string]: string;
-    };
-    id: string;
-    // (undocumented)
-    tokens: {
-        [name: string]: string;
-    };
-    // (undocumented)
-    type: "fluid";
-    // (undocumented)
-    url: string;
-}
-
-// @public
-export interface ISequencedClient {
-    client: IClient;
-    sequenceNumber: number;
-}
-
-// @alpha @legacy
-export interface ISequencedDocumentMessage {
-    clientId: string | null;
-    clientSequenceNumber: number;
-    // @deprecated
-    compression?: string;
-    contents: unknown;
-    data?: string;
-    // @deprecated
-    expHash1?: string;
-    metadata?: unknown;
-    minimumSequenceNumber: number;
-    origin?: IBranchOrigin;
-    referenceSequenceNumber: number;
-    sequenceNumber: number;
-    serverMetadata?: unknown;
-    timestamp: number;
-    traces?: ITrace[];
-    type: string;
-}
-
-// @alpha @legacy
-export type ISequencedProposal = {
-    sequenceNumber: number;
-} & IProposal;
-
-// @alpha @legacy (undocumented)
-export interface ISignalClient {
-    client: IClient;
-    clientConnectionNumber?: number;
-    clientId: string;
-    referenceSequenceNumber?: number;
-}
-
-// @alpha @legacy
-export interface ISignalMessage<TMessage extends TypedMessage = TypedMessage> extends ISignalMessageBase<TMessage> {
-    clientId: string | null;
-}
-
-// @alpha @legacy
-export interface ISignalMessageBase<TMessage extends TypedMessage = TypedMessage> {
-    clientConnectionNumber?: number;
-    content: TMessage["content"];
-    referenceSequenceNumber?: number;
-    targetClientId?: string;
-    type?: TMessage["type"];
-}
-
-// @alpha @legacy
-export interface ISnapshot {
-    // (undocumented)
-    blobContents: Map<string, ArrayBuffer>;
-    latestSequenceNumber: number | undefined;
-    // (undocumented)
-    ops: ISequencedDocumentMessage[];
-    sequenceNumber: number | undefined;
-    // (undocumented)
-    snapshotFormatV: 1;
-    // (undocumented)
-    snapshotTree: ISnapshotTree;
-}
-
-// @alpha @legacy
-export interface ISnapshotFetchOptions {
-    cacheSnapshot?: boolean;
-    fetchSource?: FetchSource;
-    loadingGroupIds?: string[];
-    scenarioName?: string;
-    versionId?: string;
-}
-
-// @alpha @legacy (undocumented)
-export interface ISnapshotTree {
-    // (undocumented)
-    blobs: {
-        [path: string]: string;
-    };
-    groupId?: string;
-    // (undocumented)
-    id?: string;
-    // (undocumented)
-    trees: {
-        [path: string]: ISnapshotTree;
-    };
-    unreferenced?: true;
-}
-
-// @alpha @legacy
-export type IsoDate = string;
-
-// @alpha @legacy
-export interface IStream<T> {
-    // (undocumented)
-    read(): Promise<IStreamResult<T>>;
-}
-
-// @alpha @legacy (undocumented)
-export type IStreamResult<T> = {
-    done: true;
-} | {
-    done: false;
-    value: T;
-};
-
-// @alpha @legacy
-export interface ISummaryAck {
-    handle: string;
-    summaryProposal: ISummaryProposal;
-}
-
-// @public
-export interface ISummaryAttachment {
-    // (undocumented)
-    id: string;
-    // (undocumented)
-    type: SummaryType.Attachment;
-}
-
-// @public
-export interface ISummaryBlob {
-    // (undocumented)
-    content: string | Uint8Array;
-    // (undocumented)
-    type: SummaryType.Blob;
-}
-
-// @alpha @legacy (undocumented)
-export interface ISummaryContent {
-    details?: IUploadedSummaryDetails;
-    handle: string;
-    head: string;
-    message: string;
-    parents: string[];
-}
-
-// @alpha @legacy
-export interface ISummaryContext {
-    readonly ackHandle: string | undefined;
-    readonly proposalHandle: string | undefined;
-    // (undocumented)
-    readonly referenceSequenceNumber: number;
-}
-
-// @public
-export interface ISummaryHandle {
-    handle: string;
-    handleType: SummaryTypeNoHandle;
-    // (undocumented)
-    type: SummaryType.Handle;
-}
-
-// @alpha @legacy
-export interface ISummaryNack {
-    code?: number;
-    message?: string;
-    retryAfter?: number;
-    summaryProposal: ISummaryProposal;
-}
-
-// @alpha @legacy
-export interface ISummaryProposal {
-    summarySequenceNumber: number;
-}
-
-// @public
-export interface ISummaryTree {
-    groupId?: string;
-    tree: {
-        [path: string]: SummaryObject;
-    };
-    // (undocumented)
-    type: SummaryType.Tree;
-    unreferenced?: true;
-}
-
-// @alpha @legacy (undocumented)
-export interface IThrottlingWarning extends IDriverErrorBase {
-    // (undocumented)
-    readonly errorType: typeof DriverErrorTypes.throttlingError;
-    // (undocumented)
-    readonly retryAfterSeconds: number;
-}
-
-// @alpha @legacy
-export interface ITokenClaims {
-    documentId: string;
-    exp: number;
-    iat: number;
-    jti?: string;
-    scopes: string[];
-    tenantId: string;
-    user: IUser;
-    ver: string;
-}
-
-// @alpha @legacy
-export interface ITrace {
-    action: string;
-    service: string;
-    timestamp: number;
-}
-
-// @alpha @legacy (undocumented)
-export interface ITree {
-    // (undocumented)
-    entries: ITreeEntry[];
-    groupId?: string;
-    id?: string;
-    unreferenced?: true;
-}
-
-// @alpha @legacy
-export type ITreeEntry = {
-    path: string;
-    mode: FileMode;
-} & ({
-    type: TreeEntry.Blob;
-    value: IBlob;
-} | {
-    type: TreeEntry.Tree;
-    value: ITree;
-} | {
-    type: TreeEntry.Attachment;
-    value: IAttachment;
-});
-
-// @alpha @legacy (undocumented)
-export interface IUploadedSummaryDetails {
-    includesProtocolTree?: boolean;
-}
-
-// @alpha @legacy (undocumented)
-export interface IUrlResolver {
-    getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string, packageInfoSource?: IContainerPackageInfo): Promise<string>;
-    // (undocumented)
-    resolve(request: IRequest): Promise<IResolvedUrl | undefined>;
-}
-
-// @public
-export interface IUser {
-    id: string;
-}
-
-// @alpha @legacy
-export interface IVersion {
-    date?: IsoDate;
-    id: string;
-    treeId: string;
-}
-
-// @alpha @legacy (undocumented)
-export enum LoaderCachingPolicy {
-    NoCaching = 0,
-    Prefetch = 1
-}
-
-// @alpha @legacy (undocumented)
-export enum MessageType {
-    Accept = "accept",
-    ClientJoin = "join",
-    ClientLeave = "leave",
-    Control = "control",
-    NoClient = "noClient",
-    NoOp = "noop",
-    Operation = "op",
-    Propose = "propose",
-    Reject = "reject",
-    RoundTrip = "tripComplete",
-    Summarize = "summarize",
-    SummaryAck = "summaryAck",
-    SummaryNack = "summaryNack"
-}
-
-// @alpha @legacy
-export enum NackErrorType {
-    BadRequestError = "BadRequestError",
-    InvalidScopeError = "InvalidScopeError",
-    LimitExceededError = "LimitExceededError",
-    ThrottlingError = "ThrottlingError"
-}
-
-// @alpha @legacy
-export enum ScopeType {
-    DocRead = "doc:read",
-    DocWrite = "doc:write",
-    SummaryWrite = "summary:write"
-}
-
-// @public
-export type SummaryObject = ISummaryTree | ISummaryBlob | ISummaryHandle | ISummaryAttachment;
-
-// @alpha @legacy
-export type SummaryTree = ISummaryTree | ISummaryHandle;
-
-// @public
-export namespace SummaryType {
-    const Tree: Tree;
-    const Blob: Blob;
-    const Handle: Handle;
-    const Attachment: Attachment;
-}
-
-// @public
-export type SummaryType = SummaryType.Attachment | SummaryType.Blob | SummaryType.Handle | SummaryType.Tree;
-
-// @public
-export type SummaryTypeNoHandle = SummaryType.Tree | SummaryType.Blob | SummaryType.Attachment;
-
-// @alpha @legacy
-export enum TreeEntry {
-    // (undocumented)
-    Attachment = "Attachment",
-    // (undocumented)
-    Blob = "Blob",
-    // (undocumented)
-    Tree = "Tree"
-}
-
-// (No @packageDocumentation comment for this package)
-
-```

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

547247

-0.25%

Lines of code

8200

-2.84%

Dependency changes

• + Added

  @fluidframework/core-interfaces@2.60.0
  (transitive)

• - Removed

  @fluidframework/core-interfaces@2.53.1
  (transitive)

• Updated

  @fluidframework/core-interfaces@~2.60.0