@fluidframework/container-definitions 2.0.0-internal.1.0.0.83139 → 2.0.0-internal.1.1.1

package/dist/deltas.d.ts

@@ -18,7 +18,7 @@ export interface IConnectionDetails {
     /**
      * Last known sequence number to ordering service at the time of connection
      * It may lap actual last sequence number (quite a bit, if container  is very active).
-     * But it's best information for client to figure out how far it is behind, at least
+     * But it's the best information for client to figure out how far it is behind, at least
      * for "read" connections. "write" connections may use own "join" op to similar information,
      * that is likely to be more up-to-date.
      */
@@ -82,7 +82,7 @@ export interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>
     /** The initial sequence number set when attaching the op handler */
     readonly initialSequenceNumber: number;
     /**
-     * Tells if  current connection has checkpoint information.
+     * Tells if current connection has checkpoint information.
      * I.e. we know how far behind the client was at the time of establishing connection
      */
     readonly hasCheckpointSequenceNumber: boolean;

package/dist/deltas.js.map

@@ -1 +1 @@
-{"version":3,"file":"deltas.js","sourceRoot":"","sources":["../src/deltas.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 { IDisposable, IEventProvider, IEvent, IErrorEvent } from \"@fluidframework/common-definitions\";\nimport {\n    ConnectionMode,\n    IClientConfiguration,\n    IClientDetails,\n    IDocumentMessage,\n    ISequencedDocumentMessage,\n    ISignalClient,\n    ISignalMessage,\n    ITokenClaims,\n} from \"@fluidframework/protocol-definitions\";\n\n/**\n * Contract representing the result of a newly established connection to the server for syncing deltas\n */\nexport interface IConnectionDetails {\n    clientId: string;\n    claims: ITokenClaims;\n    existing: boolean;\n    mode: ConnectionMode;\n    version: string;\n    initialClients: ISignalClient[];\n    serviceConfiguration: IClientConfiguration;\n    /**\n     * Last known sequence number to ordering service at the time of connection\n     * It may lap actual last sequence number (quite a bit, if container  is very active).\n     * But it's best information for client to figure out how far it is behind, at least\n     * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n     * that is likely to be more up-to-date.\n     */\n    checkpointSequenceNumber: number | undefined;\n}\n\n/**\n * Interface used to define a strategy for handling incoming delta messages\n */\nexport interface IDeltaHandlerStrategy {\n    /**\n     * Processes the message.\n     */\n    process: (message: ISequencedDocumentMessage) => void;\n\n    /**\n     * Processes the signal.\n     */\n    processSignal: (message: ISignalMessage) => void;\n}\n\n/**\n * Contract supporting delivery of outbound messages to the server\n */\nexport interface IDeltaSender {\n    /**\n     * Flush all pending messages through the outbound queue\n     */\n    flush(): void;\n}\n\n/** Events emitted by the Delta Manager */\nexport interface IDeltaManagerEvents extends IEvent {\n    (event: \"prepareSend\", listener: (messageBuffer: any[]) => void);\n    (event: \"submitOp\", listener: (message: IDocumentMessage) => void);\n    (event: \"op\", listener: (message: ISequencedDocumentMessage, processingTime: number) => void);\n    (event: \"allSentOpsAckd\", listener: () => void);\n    (event: \"pong\" | \"processTime\", listener: (latency: number) => void);\n    /**\n     * The connect event fires once we've received the connect_document_success message from the\n     * server.  This happens prior to the client's join message (if there is a join message).\n     */\n    (event: \"connect\", listener: (details: IConnectionDetails, opsBehind?: number) => void);\n    (event: \"disconnect\", listener: (reason: string) => void);\n    (event: \"readonly\", listener: (readonly: boolean) => void);\n}\n\n/**\n * Manages the transmission of ops between the runtime and storage.\n */\nexport interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>, IDeltaSender, IDisposable {\n    /** The queue of inbound delta messages */\n    readonly inbound: IDeltaQueue<T>;\n\n    /** The queue of outbound delta messages */\n    readonly outbound: IDeltaQueue<U[]>;\n\n    /** The queue of inbound delta signals */\n    readonly inboundSignal: IDeltaQueue<ISignalMessage>;\n\n    /** The current minimum sequence number */\n    readonly minimumSequenceNumber: number;\n\n    /** The last sequence number processed by the delta manager */\n    readonly lastSequenceNumber: number;\n\n    /** The last message processed by the delta manager */\n    readonly lastMessage: ISequencedDocumentMessage | undefined;\n\n    /** The latest sequence number the delta manager is aware of */\n    readonly lastKnownSeqNumber: number;\n\n    /** The initial sequence number set when attaching the op handler */\n    readonly initialSequenceNumber: number;\n\n    /**\n     * Tells if  current connection has checkpoint information.\n     * I.e. we know how far behind the client was at the time of establishing connection\n     */\n    readonly hasCheckpointSequenceNumber: boolean;\n\n    /** Details of client */\n    readonly clientDetails: IClientDetails;\n\n    /** Protocol version being used to communicate with the service */\n    readonly version: string;\n\n    /** Max message size allowed to the delta manager */\n    readonly maxMessageSize: number;\n\n    /** Service configuration provided by the service. */\n    readonly serviceConfiguration: IClientConfiguration | undefined;\n\n    /** Flag to indicate whether the client can write or not. */\n    readonly active: boolean;\n\n    readonly readOnlyInfo: ReadOnlyInfo;\n\n    /** Submit a signal to the service to be broadcast to other connected clients, but not persisted */\n    submitSignal(content: any): void;\n}\n\n/** Events emitted by a Delta Queue */\nexport interface IDeltaQueueEvents<T> extends IErrorEvent {\n    (event: \"push\" | \"op\", listener: (task: T) => void);\n    /**\n     * @param count - number of events (T) processed before becoming idle\n     * @param duration - amount of time it took to process elements (milliseconds).\n     */\n    (event: \"idle\", listener: (count: number, duration: number) => void);\n}\n\n/**\n * Queue of ops to be sent to or processed from storage\n */\nexport interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents<T>>, IDisposable {\n    /**\n     * Flag indicating whether or not the queue was paused\n     */\n    paused: boolean;\n\n    /**\n     * The number of messages remaining in the queue\n     */\n    length: number;\n\n    /**\n     * Flag indicating whether or not the queue is idle\n     */\n    idle: boolean;\n\n    /**\n     * Pauses processing on the queue\n     * @returns A promise which resolves when processing has been paused.\n     */\n    pause(): Promise<void>;\n\n    /**\n     * Resumes processing on the queue\n     */\n    resume(): void;\n\n    /**\n     * Peeks at the next message in the queue\n     */\n    peek(): T | undefined;\n\n    /**\n     * Returns all the items in the queue as an array. Does not remove them from the queue.\n     */\n    toArray(): T[];\n\n    /**\n     * returns number of ops processed and time it took to process these ops.\n     * Zeros if queue did not process anything (had no messages, was paused or had hit an error before)\n     */\n    waitTillProcessingDone(): Promise<{ count: number; duration: number; }>;\n}\n\nexport type ReadOnlyInfo = {\n    readonly readonly: false | undefined;\n} | {\n    readonly readonly: true;\n    /** read-only because forceReadOnly() was called */\n    readonly forced: boolean;\n    /** read-only because client does not have write permissions for document */\n    readonly permissions: boolean | undefined;\n    /** read-only with no delta stream connection */\n    readonly storageOnly: boolean;\n};\n"]}
+{"version":3,"file":"deltas.js","sourceRoot":"","sources":["../src/deltas.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 { IDisposable, IEventProvider, IEvent, IErrorEvent } from \"@fluidframework/common-definitions\";\nimport {\n    ConnectionMode,\n    IClientConfiguration,\n    IClientDetails,\n    IDocumentMessage,\n    ISequencedDocumentMessage,\n    ISignalClient,\n    ISignalMessage,\n    ITokenClaims,\n} from \"@fluidframework/protocol-definitions\";\n\n/**\n * Contract representing the result of a newly established connection to the server for syncing deltas\n */\nexport interface IConnectionDetails {\n    clientId: string;\n    claims: ITokenClaims;\n    existing: boolean;\n    mode: ConnectionMode;\n    version: string;\n    initialClients: ISignalClient[];\n    serviceConfiguration: IClientConfiguration;\n    /**\n     * Last known sequence number to ordering service at the time of connection\n     * It may lap actual last sequence number (quite a bit, if container  is very active).\n     * But it's the best information for client to figure out how far it is behind, at least\n     * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n     * that is likely to be more up-to-date.\n     */\n    checkpointSequenceNumber: number | undefined;\n}\n\n/**\n * Interface used to define a strategy for handling incoming delta messages\n */\nexport interface IDeltaHandlerStrategy {\n    /**\n     * Processes the message.\n     */\n    process: (message: ISequencedDocumentMessage) => void;\n\n    /**\n     * Processes the signal.\n     */\n    processSignal: (message: ISignalMessage) => void;\n}\n\n/**\n * Contract supporting delivery of outbound messages to the server\n */\nexport interface IDeltaSender {\n    /**\n     * Flush all pending messages through the outbound queue\n     */\n    flush(): void;\n}\n\n/** Events emitted by the Delta Manager */\nexport interface IDeltaManagerEvents extends IEvent {\n    (event: \"prepareSend\", listener: (messageBuffer: any[]) => void);\n    (event: \"submitOp\", listener: (message: IDocumentMessage) => void);\n    (event: \"op\", listener: (message: ISequencedDocumentMessage, processingTime: number) => void);\n    (event: \"allSentOpsAckd\", listener: () => void);\n    (event: \"pong\" | \"processTime\", listener: (latency: number) => void);\n    /**\n     * The connect event fires once we've received the connect_document_success message from the\n     * server.  This happens prior to the client's join message (if there is a join message).\n     */\n    (event: \"connect\", listener: (details: IConnectionDetails, opsBehind?: number) => void);\n    (event: \"disconnect\", listener: (reason: string) => void);\n    (event: \"readonly\", listener: (readonly: boolean) => void);\n}\n\n/**\n * Manages the transmission of ops between the runtime and storage.\n */\nexport interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>, IDeltaSender, IDisposable {\n    /** The queue of inbound delta messages */\n    readonly inbound: IDeltaQueue<T>;\n\n    /** The queue of outbound delta messages */\n    readonly outbound: IDeltaQueue<U[]>;\n\n    /** The queue of inbound delta signals */\n    readonly inboundSignal: IDeltaQueue<ISignalMessage>;\n\n    /** The current minimum sequence number */\n    readonly minimumSequenceNumber: number;\n\n    /** The last sequence number processed by the delta manager */\n    readonly lastSequenceNumber: number;\n\n    /** The last message processed by the delta manager */\n    readonly lastMessage: ISequencedDocumentMessage | undefined;\n\n    /** The latest sequence number the delta manager is aware of */\n    readonly lastKnownSeqNumber: number;\n\n    /** The initial sequence number set when attaching the op handler */\n    readonly initialSequenceNumber: number;\n\n    /**\n     * Tells if current connection has checkpoint information.\n     * I.e. we know how far behind the client was at the time of establishing connection\n     */\n    readonly hasCheckpointSequenceNumber: boolean;\n\n    /** Details of client */\n    readonly clientDetails: IClientDetails;\n\n    /** Protocol version being used to communicate with the service */\n    readonly version: string;\n\n    /** Max message size allowed to the delta manager */\n    readonly maxMessageSize: number;\n\n    /** Service configuration provided by the service. */\n    readonly serviceConfiguration: IClientConfiguration | undefined;\n\n    /** Flag to indicate whether the client can write or not. */\n    readonly active: boolean;\n\n    readonly readOnlyInfo: ReadOnlyInfo;\n\n    /** Submit a signal to the service to be broadcast to other connected clients, but not persisted */\n    submitSignal(content: any): void;\n}\n\n/** Events emitted by a Delta Queue */\nexport interface IDeltaQueueEvents<T> extends IErrorEvent {\n    (event: \"push\" | \"op\", listener: (task: T) => void);\n    /**\n     * @param count - number of events (T) processed before becoming idle\n     * @param duration - amount of time it took to process elements (milliseconds).\n     */\n    (event: \"idle\", listener: (count: number, duration: number) => void);\n}\n\n/**\n * Queue of ops to be sent to or processed from storage\n */\nexport interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents<T>>, IDisposable {\n    /**\n     * Flag indicating whether or not the queue was paused\n     */\n    paused: boolean;\n\n    /**\n     * The number of messages remaining in the queue\n     */\n    length: number;\n\n    /**\n     * Flag indicating whether or not the queue is idle\n     */\n    idle: boolean;\n\n    /**\n     * Pauses processing on the queue\n     * @returns A promise which resolves when processing has been paused.\n     */\n    pause(): Promise<void>;\n\n    /**\n     * Resumes processing on the queue\n     */\n    resume(): void;\n\n    /**\n     * Peeks at the next message in the queue\n     */\n    peek(): T | undefined;\n\n    /**\n     * Returns all the items in the queue as an array. Does not remove them from the queue.\n     */\n    toArray(): T[];\n\n    /**\n     * returns number of ops processed and time it took to process these ops.\n     * Zeros if queue did not process anything (had no messages, was paused or had hit an error before)\n     */\n    waitTillProcessingDone(): Promise<{ count: number; duration: number; }>;\n}\n\nexport type ReadOnlyInfo = {\n    readonly readonly: false | undefined;\n} | {\n    readonly readonly: true;\n    /** read-only because forceReadOnly() was called */\n    readonly forced: boolean;\n    /** read-only because client does not have write permissions for document */\n    readonly permissions: boolean | undefined;\n    /** read-only with no delta stream connection */\n    readonly storageOnly: boolean;\n};\n"]}

package/lib/deltas.d.ts

@@ -18,7 +18,7 @@ export interface IConnectionDetails {
     /**
      * Last known sequence number to ordering service at the time of connection
      * It may lap actual last sequence number (quite a bit, if container  is very active).
-     * But it's best information for client to figure out how far it is behind, at least
+     * But it's the best information for client to figure out how far it is behind, at least
      * for "read" connections. "write" connections may use own "join" op to similar information,
      * that is likely to be more up-to-date.
      */
@@ -82,7 +82,7 @@ export interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>
     /** The initial sequence number set when attaching the op handler */
     readonly initialSequenceNumber: number;
     /**
-     * Tells if  current connection has checkpoint information.
+     * Tells if current connection has checkpoint information.
      * I.e. we know how far behind the client was at the time of establishing connection
      */
     readonly hasCheckpointSequenceNumber: boolean;

package/lib/deltas.js.map

@@ -1 +1 @@
-{"version":3,"file":"deltas.js","sourceRoot":"","sources":["../src/deltas.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 { IDisposable, IEventProvider, IEvent, IErrorEvent } from \"@fluidframework/common-definitions\";\nimport {\n    ConnectionMode,\n    IClientConfiguration,\n    IClientDetails,\n    IDocumentMessage,\n    ISequencedDocumentMessage,\n    ISignalClient,\n    ISignalMessage,\n    ITokenClaims,\n} from \"@fluidframework/protocol-definitions\";\n\n/**\n * Contract representing the result of a newly established connection to the server for syncing deltas\n */\nexport interface IConnectionDetails {\n    clientId: string;\n    claims: ITokenClaims;\n    existing: boolean;\n    mode: ConnectionMode;\n    version: string;\n    initialClients: ISignalClient[];\n    serviceConfiguration: IClientConfiguration;\n    /**\n     * Last known sequence number to ordering service at the time of connection\n     * It may lap actual last sequence number (quite a bit, if container  is very active).\n     * But it's best information for client to figure out how far it is behind, at least\n     * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n     * that is likely to be more up-to-date.\n     */\n    checkpointSequenceNumber: number | undefined;\n}\n\n/**\n * Interface used to define a strategy for handling incoming delta messages\n */\nexport interface IDeltaHandlerStrategy {\n    /**\n     * Processes the message.\n     */\n    process: (message: ISequencedDocumentMessage) => void;\n\n    /**\n     * Processes the signal.\n     */\n    processSignal: (message: ISignalMessage) => void;\n}\n\n/**\n * Contract supporting delivery of outbound messages to the server\n */\nexport interface IDeltaSender {\n    /**\n     * Flush all pending messages through the outbound queue\n     */\n    flush(): void;\n}\n\n/** Events emitted by the Delta Manager */\nexport interface IDeltaManagerEvents extends IEvent {\n    (event: \"prepareSend\", listener: (messageBuffer: any[]) => void);\n    (event: \"submitOp\", listener: (message: IDocumentMessage) => void);\n    (event: \"op\", listener: (message: ISequencedDocumentMessage, processingTime: number) => void);\n    (event: \"allSentOpsAckd\", listener: () => void);\n    (event: \"pong\" | \"processTime\", listener: (latency: number) => void);\n    /**\n     * The connect event fires once we've received the connect_document_success message from the\n     * server.  This happens prior to the client's join message (if there is a join message).\n     */\n    (event: \"connect\", listener: (details: IConnectionDetails, opsBehind?: number) => void);\n    (event: \"disconnect\", listener: (reason: string) => void);\n    (event: \"readonly\", listener: (readonly: boolean) => void);\n}\n\n/**\n * Manages the transmission of ops between the runtime and storage.\n */\nexport interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>, IDeltaSender, IDisposable {\n    /** The queue of inbound delta messages */\n    readonly inbound: IDeltaQueue<T>;\n\n    /** The queue of outbound delta messages */\n    readonly outbound: IDeltaQueue<U[]>;\n\n    /** The queue of inbound delta signals */\n    readonly inboundSignal: IDeltaQueue<ISignalMessage>;\n\n    /** The current minimum sequence number */\n    readonly minimumSequenceNumber: number;\n\n    /** The last sequence number processed by the delta manager */\n    readonly lastSequenceNumber: number;\n\n    /** The last message processed by the delta manager */\n    readonly lastMessage: ISequencedDocumentMessage | undefined;\n\n    /** The latest sequence number the delta manager is aware of */\n    readonly lastKnownSeqNumber: number;\n\n    /** The initial sequence number set when attaching the op handler */\n    readonly initialSequenceNumber: number;\n\n    /**\n     * Tells if  current connection has checkpoint information.\n     * I.e. we know how far behind the client was at the time of establishing connection\n     */\n    readonly hasCheckpointSequenceNumber: boolean;\n\n    /** Details of client */\n    readonly clientDetails: IClientDetails;\n\n    /** Protocol version being used to communicate with the service */\n    readonly version: string;\n\n    /** Max message size allowed to the delta manager */\n    readonly maxMessageSize: number;\n\n    /** Service configuration provided by the service. */\n    readonly serviceConfiguration: IClientConfiguration | undefined;\n\n    /** Flag to indicate whether the client can write or not. */\n    readonly active: boolean;\n\n    readonly readOnlyInfo: ReadOnlyInfo;\n\n    /** Submit a signal to the service to be broadcast to other connected clients, but not persisted */\n    submitSignal(content: any): void;\n}\n\n/** Events emitted by a Delta Queue */\nexport interface IDeltaQueueEvents<T> extends IErrorEvent {\n    (event: \"push\" | \"op\", listener: (task: T) => void);\n    /**\n     * @param count - number of events (T) processed before becoming idle\n     * @param duration - amount of time it took to process elements (milliseconds).\n     */\n    (event: \"idle\", listener: (count: number, duration: number) => void);\n}\n\n/**\n * Queue of ops to be sent to or processed from storage\n */\nexport interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents<T>>, IDisposable {\n    /**\n     * Flag indicating whether or not the queue was paused\n     */\n    paused: boolean;\n\n    /**\n     * The number of messages remaining in the queue\n     */\n    length: number;\n\n    /**\n     * Flag indicating whether or not the queue is idle\n     */\n    idle: boolean;\n\n    /**\n     * Pauses processing on the queue\n     * @returns A promise which resolves when processing has been paused.\n     */\n    pause(): Promise<void>;\n\n    /**\n     * Resumes processing on the queue\n     */\n    resume(): void;\n\n    /**\n     * Peeks at the next message in the queue\n     */\n    peek(): T | undefined;\n\n    /**\n     * Returns all the items in the queue as an array. Does not remove them from the queue.\n     */\n    toArray(): T[];\n\n    /**\n     * returns number of ops processed and time it took to process these ops.\n     * Zeros if queue did not process anything (had no messages, was paused or had hit an error before)\n     */\n    waitTillProcessingDone(): Promise<{ count: number; duration: number; }>;\n}\n\nexport type ReadOnlyInfo = {\n    readonly readonly: false | undefined;\n} | {\n    readonly readonly: true;\n    /** read-only because forceReadOnly() was called */\n    readonly forced: boolean;\n    /** read-only because client does not have write permissions for document */\n    readonly permissions: boolean | undefined;\n    /** read-only with no delta stream connection */\n    readonly storageOnly: boolean;\n};\n"]}
+{"version":3,"file":"deltas.js","sourceRoot":"","sources":["../src/deltas.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 { IDisposable, IEventProvider, IEvent, IErrorEvent } from \"@fluidframework/common-definitions\";\nimport {\n    ConnectionMode,\n    IClientConfiguration,\n    IClientDetails,\n    IDocumentMessage,\n    ISequencedDocumentMessage,\n    ISignalClient,\n    ISignalMessage,\n    ITokenClaims,\n} from \"@fluidframework/protocol-definitions\";\n\n/**\n * Contract representing the result of a newly established connection to the server for syncing deltas\n */\nexport interface IConnectionDetails {\n    clientId: string;\n    claims: ITokenClaims;\n    existing: boolean;\n    mode: ConnectionMode;\n    version: string;\n    initialClients: ISignalClient[];\n    serviceConfiguration: IClientConfiguration;\n    /**\n     * Last known sequence number to ordering service at the time of connection\n     * It may lap actual last sequence number (quite a bit, if container  is very active).\n     * But it's the best information for client to figure out how far it is behind, at least\n     * for \"read\" connections. \"write\" connections may use own \"join\" op to similar information,\n     * that is likely to be more up-to-date.\n     */\n    checkpointSequenceNumber: number | undefined;\n}\n\n/**\n * Interface used to define a strategy for handling incoming delta messages\n */\nexport interface IDeltaHandlerStrategy {\n    /**\n     * Processes the message.\n     */\n    process: (message: ISequencedDocumentMessage) => void;\n\n    /**\n     * Processes the signal.\n     */\n    processSignal: (message: ISignalMessage) => void;\n}\n\n/**\n * Contract supporting delivery of outbound messages to the server\n */\nexport interface IDeltaSender {\n    /**\n     * Flush all pending messages through the outbound queue\n     */\n    flush(): void;\n}\n\n/** Events emitted by the Delta Manager */\nexport interface IDeltaManagerEvents extends IEvent {\n    (event: \"prepareSend\", listener: (messageBuffer: any[]) => void);\n    (event: \"submitOp\", listener: (message: IDocumentMessage) => void);\n    (event: \"op\", listener: (message: ISequencedDocumentMessage, processingTime: number) => void);\n    (event: \"allSentOpsAckd\", listener: () => void);\n    (event: \"pong\" | \"processTime\", listener: (latency: number) => void);\n    /**\n     * The connect event fires once we've received the connect_document_success message from the\n     * server.  This happens prior to the client's join message (if there is a join message).\n     */\n    (event: \"connect\", listener: (details: IConnectionDetails, opsBehind?: number) => void);\n    (event: \"disconnect\", listener: (reason: string) => void);\n    (event: \"readonly\", listener: (readonly: boolean) => void);\n}\n\n/**\n * Manages the transmission of ops between the runtime and storage.\n */\nexport interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>, IDeltaSender, IDisposable {\n    /** The queue of inbound delta messages */\n    readonly inbound: IDeltaQueue<T>;\n\n    /** The queue of outbound delta messages */\n    readonly outbound: IDeltaQueue<U[]>;\n\n    /** The queue of inbound delta signals */\n    readonly inboundSignal: IDeltaQueue<ISignalMessage>;\n\n    /** The current minimum sequence number */\n    readonly minimumSequenceNumber: number;\n\n    /** The last sequence number processed by the delta manager */\n    readonly lastSequenceNumber: number;\n\n    /** The last message processed by the delta manager */\n    readonly lastMessage: ISequencedDocumentMessage | undefined;\n\n    /** The latest sequence number the delta manager is aware of */\n    readonly lastKnownSeqNumber: number;\n\n    /** The initial sequence number set when attaching the op handler */\n    readonly initialSequenceNumber: number;\n\n    /**\n     * Tells if current connection has checkpoint information.\n     * I.e. we know how far behind the client was at the time of establishing connection\n     */\n    readonly hasCheckpointSequenceNumber: boolean;\n\n    /** Details of client */\n    readonly clientDetails: IClientDetails;\n\n    /** Protocol version being used to communicate with the service */\n    readonly version: string;\n\n    /** Max message size allowed to the delta manager */\n    readonly maxMessageSize: number;\n\n    /** Service configuration provided by the service. */\n    readonly serviceConfiguration: IClientConfiguration | undefined;\n\n    /** Flag to indicate whether the client can write or not. */\n    readonly active: boolean;\n\n    readonly readOnlyInfo: ReadOnlyInfo;\n\n    /** Submit a signal to the service to be broadcast to other connected clients, but not persisted */\n    submitSignal(content: any): void;\n}\n\n/** Events emitted by a Delta Queue */\nexport interface IDeltaQueueEvents<T> extends IErrorEvent {\n    (event: \"push\" | \"op\", listener: (task: T) => void);\n    /**\n     * @param count - number of events (T) processed before becoming idle\n     * @param duration - amount of time it took to process elements (milliseconds).\n     */\n    (event: \"idle\", listener: (count: number, duration: number) => void);\n}\n\n/**\n * Queue of ops to be sent to or processed from storage\n */\nexport interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents<T>>, IDisposable {\n    /**\n     * Flag indicating whether or not the queue was paused\n     */\n    paused: boolean;\n\n    /**\n     * The number of messages remaining in the queue\n     */\n    length: number;\n\n    /**\n     * Flag indicating whether or not the queue is idle\n     */\n    idle: boolean;\n\n    /**\n     * Pauses processing on the queue\n     * @returns A promise which resolves when processing has been paused.\n     */\n    pause(): Promise<void>;\n\n    /**\n     * Resumes processing on the queue\n     */\n    resume(): void;\n\n    /**\n     * Peeks at the next message in the queue\n     */\n    peek(): T | undefined;\n\n    /**\n     * Returns all the items in the queue as an array. Does not remove them from the queue.\n     */\n    toArray(): T[];\n\n    /**\n     * returns number of ops processed and time it took to process these ops.\n     * Zeros if queue did not process anything (had no messages, was paused or had hit an error before)\n     */\n    waitTillProcessingDone(): Promise<{ count: number; duration: number; }>;\n}\n\nexport type ReadOnlyInfo = {\n    readonly readonly: false | undefined;\n} | {\n    readonly readonly: true;\n    /** read-only because forceReadOnly() was called */\n    readonly forced: boolean;\n    /** read-only because client does not have write permissions for document */\n    readonly permissions: boolean | undefined;\n    /** read-only with no delta stream connection */\n    readonly storageOnly: boolean;\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-definitions",
-  "version": "2.0.0-internal.1.0.0.83139",
+  "version": "2.0.0-internal.1.1.1",
   "description": "Fluid container definitions",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -40,20 +40,20 @@
   },
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
-    "@fluidframework/core-interfaces": "2.0.0-internal.1.0.0.83139",
-    "@fluidframework/driver-definitions": "2.0.0-internal.1.0.0.83139",
-    "@fluidframework/protocol-definitions": "^0.1029.1000-0"
+    "@fluidframework/core-interfaces": "^2.0.0-internal.1.1.1",
+    "@fluidframework/driver-definitions": "^2.0.0-internal.1.1.1",
+    "@fluidframework/protocol-definitions": "^1.0.0"
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/build-tools": "^0.3.0-0",
-    "@fluidframework/container-definitions-previous": "npm:@fluidframework/container-definitions@1.1.0",
+    "@fluidframework/build-tools": "^0.3.1000",
+    "@fluidframework/container-definitions-previous": "npm:@fluidframework/container-definitions@^1.1.0",
     "@fluidframework/eslint-config-fluid": "^0.28.2000",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/node": "^14.18.0",
     "concurrently": "^6.2.0",
-    "copyfiles": "^2.1.0",
+    "copyfiles": "^2.4.1",
     "eslint": "~8.6.0",
     "rimraf": "^2.6.2",
     "typescript": "~4.5.5",

package/src/deltas.ts

@@ -29,7 +29,7 @@ export interface IConnectionDetails {
     /**
      * Last known sequence number to ordering service at the time of connection
      * It may lap actual last sequence number (quite a bit, if container  is very active).
-     * But it's best information for client to figure out how far it is behind, at least
+     * But it's the best information for client to figure out how far it is behind, at least
      * for "read" connections. "write" connections may use own "join" op to similar information,
      * that is likely to be more up-to-date.
      */
@@ -106,7 +106,7 @@ export interface IDeltaManager<T, U> extends IEventProvider<IDeltaManagerEvents>
     readonly initialSequenceNumber: number;
 
     /**
-     * Tells if  current connection has checkpoint information.
+     * Tells if current connection has checkpoint information.
      * I.e. we know how far behind the client was at the time of establishing connection
      */
     readonly hasCheckpointSequenceNumber: boolean;