@fluidframework/container-definitions 2.0.0-internal.2.3.0 → 2.0.0-internal.2.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/deltas.d.ts +12 -0
- package/dist/deltas.d.ts.map +1 -1
- package/dist/deltas.js.map +1 -1
- package/lib/deltas.d.ts +12 -0
- package/lib/deltas.d.ts.map +1 -1
- package/lib/deltas.js.map +1 -1
- package/package.json +6 -5
- package/src/deltas.ts +16 -0
package/dist/deltas.d.ts
CHANGED
|
@@ -10,9 +10,21 @@ import { ConnectionMode, IClientConfiguration, IClientDetails, IDocumentMessage,
|
|
|
10
10
|
export interface IConnectionDetails {
|
|
11
11
|
clientId: string;
|
|
12
12
|
claims: ITokenClaims;
|
|
13
|
+
/**
|
|
14
|
+
* @deprecated No replacement API recommended.
|
|
15
|
+
*/
|
|
13
16
|
existing: boolean;
|
|
17
|
+
/**
|
|
18
|
+
* @deprecated No replacement API recommended.
|
|
19
|
+
*/
|
|
14
20
|
mode: ConnectionMode;
|
|
21
|
+
/**
|
|
22
|
+
* @deprecated No replacement API recommended.
|
|
23
|
+
*/
|
|
15
24
|
version: string;
|
|
25
|
+
/**
|
|
26
|
+
* @deprecated No replacement API recommended.
|
|
27
|
+
*/
|
|
16
28
|
initialClients: ISignalClient[];
|
|
17
29
|
serviceConfiguration: IClientConfiguration;
|
|
18
30
|
/**
|
package/dist/deltas.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deltas.d.ts","sourceRoot":"","sources":["../src/deltas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACtG,OAAO,EACH,cAAc,EACd,oBAAoB,EACpB,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,YAAY,EACf,MAAM,sCAAsC,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"deltas.d.ts","sourceRoot":"","sources":["../src/deltas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACtG,OAAO,EACH,cAAc,EACd,oBAAoB,EACpB,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,YAAY,EACf,MAAM,sCAAsC,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C;;;;;;;;;OASG;IACH,wBAAwB,EAAE,MAAM,GAAG,SAAS,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,CAAC;IAEtD;;OAEG;IACH,aAAa,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAC;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;CACjB;AAED;;GAEG;AAEH,MAAM,WAAW,mBAAoB,SAAQ,MAAM;IAC/C;;OAEG;IACH,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE,KAAK,IAAI,OAAE;IAEjE;;OAEG;IACH,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,OAAE;IAEnE;;;;;;;;;;;;;;OAcG;IACH,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,EAAE,cAAc,EAAE,MAAM,KAAK,IAAI,OAAE;IAE9F;;OAEG;IACH,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAEhD;;OAEG;IACH,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,OAAE;IAErD;;OAEG;IACH,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,OAAE;IAE5D;;;;;;;;;;;;;OAaG;IACH,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,kBAAkB,EAAE,SAAS,CAAC,EAAE,MAAM,KAAK,IAAI,OAAE;IAExF;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,OAAE;IAE1D;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,OAAE;CAC9D;AAGD;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,cAAc,CAAC,mBAAmB,CAAC,EAAE,YAAY,EAAE,WAAW;IACvG,0CAA0C;IAC1C,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAEjC,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC;IAEpC,yCAAyC;IACzC,QAAQ,CAAC,aAAa,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC;IAEpD,0CAA0C;IAC1C,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAEvC,8DAA8D;IAC9D,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,sDAAsD;IACtD,QAAQ,CAAC,WAAW,EAAE,yBAAyB,GAAG,SAAS,CAAC;IAE5D,+DAA+D;IAC/D,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,oEAAoE;IACpE,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAEvC;;;OAGG;IACH,QAAQ,CAAC,2BAA2B,EAAE,OAAO,CAAC;IAE9C,wBAAwB;IACxB,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IAEvC,kEAAkE;IAClE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,oDAAoD;IACpD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAEhC,qDAAqD;IACrD,QAAQ,CAAC,oBAAoB,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAEhE,4DAA4D;IAC5D,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEzB,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IAEpC,mGAAmG;IACnG,YAAY,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;CACpC;AAED;;GAEG;AAEH,MAAM,WAAW,iBAAiB,CAAC,CAAC,CAAE,SAAQ,WAAW;IACrD;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,OAAE;IAE7C;;;;;;;;;;;;OAYG;IACH,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,OAAE;IAE3C;;;;;;;;;;OAUG;IACH,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CACxE;AAGD;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,CAAE,SAAQ,cAAc,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW;IACrF;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;OAEG;IACH,MAAM,IAAI,IAAI,CAAC;IAEf;;OAEG;IACH,IAAI,IAAI,CAAC,GAAG,SAAS,CAAC;IAEtB;;OAEG;IACH,OAAO,IAAI,CAAC,EAAE,CAAC;IAEf;;;OAGG;IACH,sBAAsB,IAAI,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;KAAE,CAAC,CAAC;CAC3E;AAED,oBAAY,YAAY,GAAG;IACvB,QAAQ,CAAC,QAAQ,EAAE,KAAK,GAAG,SAAS,CAAC;CACxC,GAAG;IACA,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;IACxB,mDAAmD;IACnD,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,4EAA4E;IAC5E,QAAQ,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS,CAAC;IAC1C,gDAAgD;IAChD,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;CACjC,CAAC"}
|
package/dist/deltas.js.map
CHANGED
|
@@ -1 +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 /**\n * Last known sequence number to ordering service at the time of connection.\n *\n * @remarks\n *\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/**\n * Events emitted by {@link IDeltaManager}.\n */\n/* eslint-disable @typescript-eslint/unified-signatures */\nexport interface IDeltaManagerEvents extends IEvent {\n /**\n * @deprecated No replacement API recommended.\n */\n (event: \"prepareSend\", listener: (messageBuffer: any[]) => void);\n\n /**\n * @deprecated No replacement API recommended.\n */\n (event: \"submitOp\", listener: (message: IDocumentMessage) => void);\n\n /**\n * Emitted immediately after processing an incoming operation (op).\n *\n * @remarks\n *\n * Note: this event is not intended for general use.\n * Prefer to listen to events on the appropriate ultimate recipients of the ops, rather than listening to the\n * ops directly on the {@link IDeltaManager}.\n *\n * Listener parameters:\n *\n * - `message`: The op that was processed.\n *\n * - `processingTime`: The amount of time it took to process the inbound operation (op), expressed in milliseconds.\n */\n (event: \"op\", listener: (message: ISequencedDocumentMessage, processingTime: number) => void);\n\n /**\n * @deprecated No replacement API recommended.\n */\n (event: \"allSentOpsAckd\", listener: () => void);\n\n /**\n * @deprecated No replacement API recommended.\n */\n (event: \"pong\", listener: (latency: number) => void);\n\n /**\n * @deprecated No replacement API recommended.\n */\n (event: \"processTime\", listener: (latency: number) => void);\n\n /**\n * Emitted when the {@link IDeltaManager} completes connecting to the Fluid service.\n *\n * @remarks\n * This occurs once we've received the connect_document_success message from the server,\n * and happens prior to the client's join message (if there is a join message).\n *\n * Listener parameters:\n *\n * - `details`: Connection metadata.\n *\n * - `opsBehind`: An estimate of far behind the client is relative to the service in terms of ops.\n * Will not be specified if an estimate cannot be determined.\n */\n (event: \"connect\", listener: (details: IConnectionDetails, opsBehind?: number) => void);\n\n /**\n * Emitted when the {@link IDeltaManager} becomes disconnected from the Fluid service.\n *\n * @remarks Listener parameters:\n *\n * - `reason`: Describes the reason for which the delta manager was disconnected.\n */\n (event: \"disconnect\", listener: (reason: string) => void);\n\n /**\n * Emitted when read/write permissions change.\n *\n * @remarks Listener parameters:\n *\n * - `readonly`: Whether or not the delta manager is now read-only.\n */\n (event: \"readonly\", listener: (readonly: boolean) => void);\n}\n/* eslint-enable @typescript-eslint/unified-signatures */\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/**\n * Events emitted by {@link IDeltaQueue}.\n */\n/* eslint-disable @typescript-eslint/unified-signatures */\nexport interface IDeltaQueueEvents<T> extends IErrorEvent {\n /**\n * Emitted when a task is enqueued.\n *\n * @remarks Listener parameters:\n *\n * - `task`: The task being enqueued.\n */\n (event: \"push\", listener: (task: T) => void);\n\n /**\n * Emitted immediately after processing an enqueued task and removing it from the queue.\n *\n * @remarks\n *\n * Note: this event is not intended for general use.\n * Prefer to listen to events on the appropriate ultimate recipients of the ops, rather than listening to the\n * ops directly on the {@link IDeltaQueue}.\n *\n * Listener parameters:\n *\n * - `task`: The task that was processed.\n */\n (event: \"op\", listener: (task: T) => void);\n\n /**\n * Emitted when the queue of tasks to process is emptied.\n *\n * @remarks Listener parameters:\n *\n * - `count`: The number of events (`T`) processed before becoming idle.\n *\n * - `duration`: The amount of time it took to process elements (in milliseconds).\n *\n * @see {@link IDeltaQueue.idle}\n */\n (event: \"idle\", listener: (count: number, duration: number) => void);\n}\n/* eslint-enable @typescript-eslint/unified-signatures */\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 * I.e. there are no remaining messages to processes.\n */\n idle: boolean;\n\n /**\n * Pauses processing on the queue.\n *\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"]}
|
|
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\n /**\n * @deprecated No replacement API recommended.\n */\n existing: boolean;\n\n /**\n * @deprecated No replacement API recommended.\n */\n mode: ConnectionMode;\n\n /**\n * @deprecated No replacement API recommended.\n */\n version: string;\n\n /**\n * @deprecated No replacement API recommended.\n */\n initialClients: ISignalClient[];\n serviceConfiguration: IClientConfiguration;\n\n /**\n * Last known sequence number to ordering service at the time of connection.\n *\n * @remarks\n *\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/**\n * Events emitted by {@link IDeltaManager}.\n */\n/* eslint-disable @typescript-eslint/unified-signatures */\nexport interface IDeltaManagerEvents extends IEvent {\n /**\n * @deprecated No replacement API recommended.\n */\n (event: \"prepareSend\", listener: (messageBuffer: any[]) => void);\n\n /**\n * @deprecated No replacement API recommended.\n */\n (event: \"submitOp\", listener: (message: IDocumentMessage) => void);\n\n /**\n * Emitted immediately after processing an incoming operation (op).\n *\n * @remarks\n *\n * Note: this event is not intended for general use.\n * Prefer to listen to events on the appropriate ultimate recipients of the ops, rather than listening to the\n * ops directly on the {@link IDeltaManager}.\n *\n * Listener parameters:\n *\n * - `message`: The op that was processed.\n *\n * - `processingTime`: The amount of time it took to process the inbound operation (op), expressed in milliseconds.\n */\n (event: \"op\", listener: (message: ISequencedDocumentMessage, processingTime: number) => void);\n\n /**\n * @deprecated No replacement API recommended.\n */\n (event: \"allSentOpsAckd\", listener: () => void);\n\n /**\n * @deprecated No replacement API recommended.\n */\n (event: \"pong\", listener: (latency: number) => void);\n\n /**\n * @deprecated No replacement API recommended.\n */\n (event: \"processTime\", listener: (latency: number) => void);\n\n /**\n * Emitted when the {@link IDeltaManager} completes connecting to the Fluid service.\n *\n * @remarks\n * This occurs once we've received the connect_document_success message from the server,\n * and happens prior to the client's join message (if there is a join message).\n *\n * Listener parameters:\n *\n * - `details`: Connection metadata.\n *\n * - `opsBehind`: An estimate of far behind the client is relative to the service in terms of ops.\n * Will not be specified if an estimate cannot be determined.\n */\n (event: \"connect\", listener: (details: IConnectionDetails, opsBehind?: number) => void);\n\n /**\n * Emitted when the {@link IDeltaManager} becomes disconnected from the Fluid service.\n *\n * @remarks Listener parameters:\n *\n * - `reason`: Describes the reason for which the delta manager was disconnected.\n */\n (event: \"disconnect\", listener: (reason: string) => void);\n\n /**\n * Emitted when read/write permissions change.\n *\n * @remarks Listener parameters:\n *\n * - `readonly`: Whether or not the delta manager is now read-only.\n */\n (event: \"readonly\", listener: (readonly: boolean) => void);\n}\n/* eslint-enable @typescript-eslint/unified-signatures */\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/**\n * Events emitted by {@link IDeltaQueue}.\n */\n/* eslint-disable @typescript-eslint/unified-signatures */\nexport interface IDeltaQueueEvents<T> extends IErrorEvent {\n /**\n * Emitted when a task is enqueued.\n *\n * @remarks Listener parameters:\n *\n * - `task`: The task being enqueued.\n */\n (event: \"push\", listener: (task: T) => void);\n\n /**\n * Emitted immediately after processing an enqueued task and removing it from the queue.\n *\n * @remarks\n *\n * Note: this event is not intended for general use.\n * Prefer to listen to events on the appropriate ultimate recipients of the ops, rather than listening to the\n * ops directly on the {@link IDeltaQueue}.\n *\n * Listener parameters:\n *\n * - `task`: The task that was processed.\n */\n (event: \"op\", listener: (task: T) => void);\n\n /**\n * Emitted when the queue of tasks to process is emptied.\n *\n * @remarks Listener parameters:\n *\n * - `count`: The number of events (`T`) processed before becoming idle.\n *\n * - `duration`: The amount of time it took to process elements (in milliseconds).\n *\n * @see {@link IDeltaQueue.idle}\n */\n (event: \"idle\", listener: (count: number, duration: number) => void);\n}\n/* eslint-enable @typescript-eslint/unified-signatures */\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 * I.e. there are no remaining messages to processes.\n */\n idle: boolean;\n\n /**\n * Pauses processing on the queue.\n *\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
CHANGED
|
@@ -10,9 +10,21 @@ import { ConnectionMode, IClientConfiguration, IClientDetails, IDocumentMessage,
|
|
|
10
10
|
export interface IConnectionDetails {
|
|
11
11
|
clientId: string;
|
|
12
12
|
claims: ITokenClaims;
|
|
13
|
+
/**
|
|
14
|
+
* @deprecated No replacement API recommended.
|
|
15
|
+
*/
|
|
13
16
|
existing: boolean;
|
|
17
|
+
/**
|
|
18
|
+
* @deprecated No replacement API recommended.
|
|
19
|
+
*/
|
|
14
20
|
mode: ConnectionMode;
|
|
21
|
+
/**
|
|
22
|
+
* @deprecated No replacement API recommended.
|
|
23
|
+
*/
|
|
15
24
|
version: string;
|
|
25
|
+
/**
|
|
26
|
+
* @deprecated No replacement API recommended.
|
|
27
|
+
*/
|
|
16
28
|
initialClients: ISignalClient[];
|
|
17
29
|
serviceConfiguration: IClientConfiguration;
|
|
18
30
|
/**
|
package/lib/deltas.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deltas.d.ts","sourceRoot":"","sources":["../src/deltas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACtG,OAAO,EACH,cAAc,EACd,oBAAoB,EACpB,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,YAAY,EACf,MAAM,sCAAsC,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"deltas.d.ts","sourceRoot":"","sources":["../src/deltas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACtG,OAAO,EACH,cAAc,EACd,oBAAoB,EACpB,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,YAAY,EACf,MAAM,sCAAsC,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C;;;;;;;;;OASG;IACH,wBAAwB,EAAE,MAAM,GAAG,SAAS,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,IAAI,CAAC;IAEtD;;OAEG;IACH,aAAa,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAC;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;CACjB;AAED;;GAEG;AAEH,MAAM,WAAW,mBAAoB,SAAQ,MAAM;IAC/C;;OAEG;IACH,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE,KAAK,IAAI,OAAE;IAEjE;;OAEG;IACH,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,OAAE;IAEnE;;;;;;;;;;;;;;OAcG;IACH,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,yBAAyB,EAAE,cAAc,EAAE,MAAM,KAAK,IAAI,OAAE;IAE9F;;OAEG;IACH,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAEhD;;OAEG;IACH,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,OAAE;IAErD;;OAEG;IACH,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,OAAE;IAE5D;;;;;;;;;;;;;OAaG;IACH,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,kBAAkB,EAAE,SAAS,CAAC,EAAE,MAAM,KAAK,IAAI,OAAE;IAExF;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,OAAE;IAE1D;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,OAAE;CAC9D;AAGD;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,cAAc,CAAC,mBAAmB,CAAC,EAAE,YAAY,EAAE,WAAW;IACvG,0CAA0C;IAC1C,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAEjC,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC;IAEpC,yCAAyC;IACzC,QAAQ,CAAC,aAAa,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC;IAEpD,0CAA0C;IAC1C,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAEvC,8DAA8D;IAC9D,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,sDAAsD;IACtD,QAAQ,CAAC,WAAW,EAAE,yBAAyB,GAAG,SAAS,CAAC;IAE5D,+DAA+D;IAC/D,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAEpC,oEAAoE;IACpE,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAEvC;;;OAGG;IACH,QAAQ,CAAC,2BAA2B,EAAE,OAAO,CAAC;IAE9C,wBAAwB;IACxB,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IAEvC,kEAAkE;IAClE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,oDAAoD;IACpD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAEhC,qDAAqD;IACrD,QAAQ,CAAC,oBAAoB,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAEhE,4DAA4D;IAC5D,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEzB,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IAEpC,mGAAmG;IACnG,YAAY,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;CACpC;AAED;;GAEG;AAEH,MAAM,WAAW,iBAAiB,CAAC,CAAC,CAAE,SAAQ,WAAW;IACrD;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,OAAE;IAE7C;;;;;;;;;;;;OAYG;IACH,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,OAAE;IAE3C;;;;;;;;;;OAUG;IACH,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CACxE;AAGD;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,CAAE,SAAQ,cAAc,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW;IACrF;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;OAEG;IACH,MAAM,IAAI,IAAI,CAAC;IAEf;;OAEG;IACH,IAAI,IAAI,CAAC,GAAG,SAAS,CAAC;IAEtB;;OAEG;IACH,OAAO,IAAI,CAAC,EAAE,CAAC;IAEf;;;OAGG;IACH,sBAAsB,IAAI,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;KAAE,CAAC,CAAC;CAC3E;AAED,oBAAY,YAAY,GAAG;IACvB,QAAQ,CAAC,QAAQ,EAAE,KAAK,GAAG,SAAS,CAAC;CACxC,GAAG;IACA,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;IACxB,mDAAmD;IACnD,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,4EAA4E;IAC5E,QAAQ,CAAC,WAAW,EAAE,OAAO,GAAG,SAAS,CAAC;IAC1C,gDAAgD;IAChD,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;CACjC,CAAC"}
|
package/lib/deltas.js.map
CHANGED
|
@@ -1 +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 /**\n * Last known sequence number to ordering service at the time of connection.\n *\n * @remarks\n *\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/**\n * Events emitted by {@link IDeltaManager}.\n */\n/* eslint-disable @typescript-eslint/unified-signatures */\nexport interface IDeltaManagerEvents extends IEvent {\n /**\n * @deprecated No replacement API recommended.\n */\n (event: \"prepareSend\", listener: (messageBuffer: any[]) => void);\n\n /**\n * @deprecated No replacement API recommended.\n */\n (event: \"submitOp\", listener: (message: IDocumentMessage) => void);\n\n /**\n * Emitted immediately after processing an incoming operation (op).\n *\n * @remarks\n *\n * Note: this event is not intended for general use.\n * Prefer to listen to events on the appropriate ultimate recipients of the ops, rather than listening to the\n * ops directly on the {@link IDeltaManager}.\n *\n * Listener parameters:\n *\n * - `message`: The op that was processed.\n *\n * - `processingTime`: The amount of time it took to process the inbound operation (op), expressed in milliseconds.\n */\n (event: \"op\", listener: (message: ISequencedDocumentMessage, processingTime: number) => void);\n\n /**\n * @deprecated No replacement API recommended.\n */\n (event: \"allSentOpsAckd\", listener: () => void);\n\n /**\n * @deprecated No replacement API recommended.\n */\n (event: \"pong\", listener: (latency: number) => void);\n\n /**\n * @deprecated No replacement API recommended.\n */\n (event: \"processTime\", listener: (latency: number) => void);\n\n /**\n * Emitted when the {@link IDeltaManager} completes connecting to the Fluid service.\n *\n * @remarks\n * This occurs once we've received the connect_document_success message from the server,\n * and happens prior to the client's join message (if there is a join message).\n *\n * Listener parameters:\n *\n * - `details`: Connection metadata.\n *\n * - `opsBehind`: An estimate of far behind the client is relative to the service in terms of ops.\n * Will not be specified if an estimate cannot be determined.\n */\n (event: \"connect\", listener: (details: IConnectionDetails, opsBehind?: number) => void);\n\n /**\n * Emitted when the {@link IDeltaManager} becomes disconnected from the Fluid service.\n *\n * @remarks Listener parameters:\n *\n * - `reason`: Describes the reason for which the delta manager was disconnected.\n */\n (event: \"disconnect\", listener: (reason: string) => void);\n\n /**\n * Emitted when read/write permissions change.\n *\n * @remarks Listener parameters:\n *\n * - `readonly`: Whether or not the delta manager is now read-only.\n */\n (event: \"readonly\", listener: (readonly: boolean) => void);\n}\n/* eslint-enable @typescript-eslint/unified-signatures */\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/**\n * Events emitted by {@link IDeltaQueue}.\n */\n/* eslint-disable @typescript-eslint/unified-signatures */\nexport interface IDeltaQueueEvents<T> extends IErrorEvent {\n /**\n * Emitted when a task is enqueued.\n *\n * @remarks Listener parameters:\n *\n * - `task`: The task being enqueued.\n */\n (event: \"push\", listener: (task: T) => void);\n\n /**\n * Emitted immediately after processing an enqueued task and removing it from the queue.\n *\n * @remarks\n *\n * Note: this event is not intended for general use.\n * Prefer to listen to events on the appropriate ultimate recipients of the ops, rather than listening to the\n * ops directly on the {@link IDeltaQueue}.\n *\n * Listener parameters:\n *\n * - `task`: The task that was processed.\n */\n (event: \"op\", listener: (task: T) => void);\n\n /**\n * Emitted when the queue of tasks to process is emptied.\n *\n * @remarks Listener parameters:\n *\n * - `count`: The number of events (`T`) processed before becoming idle.\n *\n * - `duration`: The amount of time it took to process elements (in milliseconds).\n *\n * @see {@link IDeltaQueue.idle}\n */\n (event: \"idle\", listener: (count: number, duration: number) => void);\n}\n/* eslint-enable @typescript-eslint/unified-signatures */\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 * I.e. there are no remaining messages to processes.\n */\n idle: boolean;\n\n /**\n * Pauses processing on the queue.\n *\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"]}
|
|
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\n /**\n * @deprecated No replacement API recommended.\n */\n existing: boolean;\n\n /**\n * @deprecated No replacement API recommended.\n */\n mode: ConnectionMode;\n\n /**\n * @deprecated No replacement API recommended.\n */\n version: string;\n\n /**\n * @deprecated No replacement API recommended.\n */\n initialClients: ISignalClient[];\n serviceConfiguration: IClientConfiguration;\n\n /**\n * Last known sequence number to ordering service at the time of connection.\n *\n * @remarks\n *\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/**\n * Events emitted by {@link IDeltaManager}.\n */\n/* eslint-disable @typescript-eslint/unified-signatures */\nexport interface IDeltaManagerEvents extends IEvent {\n /**\n * @deprecated No replacement API recommended.\n */\n (event: \"prepareSend\", listener: (messageBuffer: any[]) => void);\n\n /**\n * @deprecated No replacement API recommended.\n */\n (event: \"submitOp\", listener: (message: IDocumentMessage) => void);\n\n /**\n * Emitted immediately after processing an incoming operation (op).\n *\n * @remarks\n *\n * Note: this event is not intended for general use.\n * Prefer to listen to events on the appropriate ultimate recipients of the ops, rather than listening to the\n * ops directly on the {@link IDeltaManager}.\n *\n * Listener parameters:\n *\n * - `message`: The op that was processed.\n *\n * - `processingTime`: The amount of time it took to process the inbound operation (op), expressed in milliseconds.\n */\n (event: \"op\", listener: (message: ISequencedDocumentMessage, processingTime: number) => void);\n\n /**\n * @deprecated No replacement API recommended.\n */\n (event: \"allSentOpsAckd\", listener: () => void);\n\n /**\n * @deprecated No replacement API recommended.\n */\n (event: \"pong\", listener: (latency: number) => void);\n\n /**\n * @deprecated No replacement API recommended.\n */\n (event: \"processTime\", listener: (latency: number) => void);\n\n /**\n * Emitted when the {@link IDeltaManager} completes connecting to the Fluid service.\n *\n * @remarks\n * This occurs once we've received the connect_document_success message from the server,\n * and happens prior to the client's join message (if there is a join message).\n *\n * Listener parameters:\n *\n * - `details`: Connection metadata.\n *\n * - `opsBehind`: An estimate of far behind the client is relative to the service in terms of ops.\n * Will not be specified if an estimate cannot be determined.\n */\n (event: \"connect\", listener: (details: IConnectionDetails, opsBehind?: number) => void);\n\n /**\n * Emitted when the {@link IDeltaManager} becomes disconnected from the Fluid service.\n *\n * @remarks Listener parameters:\n *\n * - `reason`: Describes the reason for which the delta manager was disconnected.\n */\n (event: \"disconnect\", listener: (reason: string) => void);\n\n /**\n * Emitted when read/write permissions change.\n *\n * @remarks Listener parameters:\n *\n * - `readonly`: Whether or not the delta manager is now read-only.\n */\n (event: \"readonly\", listener: (readonly: boolean) => void);\n}\n/* eslint-enable @typescript-eslint/unified-signatures */\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/**\n * Events emitted by {@link IDeltaQueue}.\n */\n/* eslint-disable @typescript-eslint/unified-signatures */\nexport interface IDeltaQueueEvents<T> extends IErrorEvent {\n /**\n * Emitted when a task is enqueued.\n *\n * @remarks Listener parameters:\n *\n * - `task`: The task being enqueued.\n */\n (event: \"push\", listener: (task: T) => void);\n\n /**\n * Emitted immediately after processing an enqueued task and removing it from the queue.\n *\n * @remarks\n *\n * Note: this event is not intended for general use.\n * Prefer to listen to events on the appropriate ultimate recipients of the ops, rather than listening to the\n * ops directly on the {@link IDeltaQueue}.\n *\n * Listener parameters:\n *\n * - `task`: The task that was processed.\n */\n (event: \"op\", listener: (task: T) => void);\n\n /**\n * Emitted when the queue of tasks to process is emptied.\n *\n * @remarks Listener parameters:\n *\n * - `count`: The number of events (`T`) processed before becoming idle.\n *\n * - `duration`: The amount of time it took to process elements (in milliseconds).\n *\n * @see {@link IDeltaQueue.idle}\n */\n (event: \"idle\", listener: (count: number, duration: number) => void);\n}\n/* eslint-enable @typescript-eslint/unified-signatures */\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 * I.e. there are no remaining messages to processes.\n */\n idle: boolean;\n\n /**\n * Pauses processing on the queue.\n *\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
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/container-definitions",
|
|
3
|
-
"version": "2.0.0-internal.2.
|
|
3
|
+
"version": "2.0.0-internal.2.4.0",
|
|
4
4
|
"description": "Fluid container definitions",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -30,6 +30,7 @@
|
|
|
30
30
|
"clean": "rimraf dist lib *.tsbuildinfo *.build.log",
|
|
31
31
|
"eslint": "eslint --format stylish src",
|
|
32
32
|
"eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
|
|
33
|
+
"format": "npm run prettier:fix",
|
|
33
34
|
"lint": "npm run eslint",
|
|
34
35
|
"lint:fix": "npm run eslint:fix",
|
|
35
36
|
"prettier": "prettier --check . --ignore-path ../../../.prettierignore",
|
|
@@ -41,15 +42,15 @@
|
|
|
41
42
|
},
|
|
42
43
|
"dependencies": {
|
|
43
44
|
"@fluidframework/common-definitions": "^0.20.1",
|
|
44
|
-
"@fluidframework/core-interfaces": ">=2.0.0-internal.2.
|
|
45
|
-
"@fluidframework/driver-definitions": ">=2.0.0-internal.2.
|
|
45
|
+
"@fluidframework/core-interfaces": ">=2.0.0-internal.2.4.0 <2.0.0-internal.3.0.0",
|
|
46
|
+
"@fluidframework/driver-definitions": ">=2.0.0-internal.2.4.0 <2.0.0-internal.3.0.0",
|
|
46
47
|
"@fluidframework/protocol-definitions": "^1.1.0",
|
|
47
48
|
"events": "^3.1.0"
|
|
48
49
|
},
|
|
49
50
|
"devDependencies": {
|
|
50
|
-
"@fluid-tools/build-cli": "^0.
|
|
51
|
+
"@fluid-tools/build-cli": "^0.8.0",
|
|
51
52
|
"@fluidframework/build-common": "^1.1.0",
|
|
52
|
-
"@fluidframework/build-tools": "^0.
|
|
53
|
+
"@fluidframework/build-tools": "^0.8.0",
|
|
53
54
|
"@fluidframework/container-definitions-previous": "npm:@fluidframework/container-definitions@2.0.0-internal.2.2.0",
|
|
54
55
|
"@fluidframework/eslint-config-fluid": "^2.0.0",
|
|
55
56
|
"@microsoft/api-extractor": "^7.22.2",
|
package/src/deltas.ts
CHANGED
|
@@ -21,9 +21,25 @@ import {
|
|
|
21
21
|
export interface IConnectionDetails {
|
|
22
22
|
clientId: string;
|
|
23
23
|
claims: ITokenClaims;
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* @deprecated No replacement API recommended.
|
|
27
|
+
*/
|
|
24
28
|
existing: boolean;
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* @deprecated No replacement API recommended.
|
|
32
|
+
*/
|
|
25
33
|
mode: ConnectionMode;
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* @deprecated No replacement API recommended.
|
|
37
|
+
*/
|
|
26
38
|
version: string;
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* @deprecated No replacement API recommended.
|
|
42
|
+
*/
|
|
27
43
|
initialClients: ISignalClient[];
|
|
28
44
|
serviceConfiguration: IClientConfiguration;
|
|
29
45
|
|