@fluidframework/runtime-definitions 2.70.0-361248 → 2.70.0-361788
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/api-report/runtime-definitions.legacy.alpha.api.md +0 -18
- package/api-report/runtime-definitions.legacy.beta.api.md +0 -18
- package/dist/protocol.d.ts +1 -53
- package/dist/protocol.d.ts.map +1 -1
- package/dist/protocol.js.map +1 -1
- package/lib/protocol.d.ts +1 -53
- package/lib/protocol.d.ts.map +1 -1
- package/lib/protocol.js.map +1 -1
- package/package.json +20 -7
- package/src/protocol.ts +0 -79
|
@@ -309,25 +309,7 @@ export interface IRuntimeMessagesContent {
|
|
|
309
309
|
|
|
310
310
|
// @beta @legacy
|
|
311
311
|
export interface IRuntimeStorageService {
|
|
312
|
-
// @deprecated (undocumented)
|
|
313
|
-
createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
|
|
314
|
-
// @deprecated
|
|
315
|
-
dispose?(error?: Error): void;
|
|
316
|
-
// @deprecated
|
|
317
|
-
readonly disposed?: boolean;
|
|
318
|
-
// @deprecated (undocumented)
|
|
319
|
-
downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
|
|
320
|
-
// @deprecated (undocumented)
|
|
321
|
-
getSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;
|
|
322
|
-
// @deprecated (undocumented)
|
|
323
|
-
getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;
|
|
324
|
-
// @deprecated (undocumented)
|
|
325
|
-
getVersions(versionId: string | null, count: number, scenarioName?: string, fetchSource?: FetchSource): Promise<IVersion[]>;
|
|
326
|
-
// @deprecated (undocumented)
|
|
327
|
-
readonly policies?: IDocumentStorageServicePolicies | undefined;
|
|
328
312
|
readBlob(id: string): Promise<ArrayBufferLike>;
|
|
329
|
-
// @deprecated (undocumented)
|
|
330
|
-
uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
|
|
331
313
|
}
|
|
332
314
|
|
|
333
315
|
// @beta @legacy
|
|
@@ -300,25 +300,7 @@ export interface IRuntimeMessagesContent {
|
|
|
300
300
|
|
|
301
301
|
// @beta @legacy
|
|
302
302
|
export interface IRuntimeStorageService {
|
|
303
|
-
// @deprecated (undocumented)
|
|
304
|
-
createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
|
|
305
|
-
// @deprecated
|
|
306
|
-
dispose?(error?: Error): void;
|
|
307
|
-
// @deprecated
|
|
308
|
-
readonly disposed?: boolean;
|
|
309
|
-
// @deprecated (undocumented)
|
|
310
|
-
downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
|
|
311
|
-
// @deprecated (undocumented)
|
|
312
|
-
getSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;
|
|
313
|
-
// @deprecated (undocumented)
|
|
314
|
-
getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;
|
|
315
|
-
// @deprecated (undocumented)
|
|
316
|
-
getVersions(versionId: string | null, count: number, scenarioName?: string, fetchSource?: FetchSource): Promise<IVersion[]>;
|
|
317
|
-
// @deprecated (undocumented)
|
|
318
|
-
readonly policies?: IDocumentStorageServicePolicies | undefined;
|
|
319
303
|
readBlob(id: string): Promise<ArrayBufferLike>;
|
|
320
|
-
// @deprecated (undocumented)
|
|
321
|
-
uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
|
|
322
304
|
}
|
|
323
305
|
|
|
324
306
|
// @beta @legacy
|
package/dist/protocol.d.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
import type { TypedMessage } from "@fluidframework/core-interfaces/internal";
|
|
6
|
-
import type { ITree, ISignalMessage, ISequencedDocumentMessage
|
|
6
|
+
import type { ITree, ISignalMessage, ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
|
|
7
7
|
/**
|
|
8
8
|
* An envelope wraps the contents with the intended target
|
|
9
9
|
* @legacy @beta
|
|
@@ -110,57 +110,5 @@ export interface IRuntimeStorageService {
|
|
|
110
110
|
* Reads the object with the given ID, returns content in arrayBufferLike
|
|
111
111
|
*/
|
|
112
112
|
readBlob(id: string): Promise<ArrayBufferLike>;
|
|
113
|
-
/**
|
|
114
|
-
* Whether or not the object has been disposed.
|
|
115
|
-
* If true, the object should be considered invalid, and its other state should be disregarded.
|
|
116
|
-
*
|
|
117
|
-
* @deprecated This API is deprecated and will be removed in a future release. No replacement is planned as
|
|
118
|
-
* it is unused in the DataStore layer.
|
|
119
|
-
*/
|
|
120
|
-
readonly disposed?: boolean;
|
|
121
|
-
/**
|
|
122
|
-
* Dispose of the object and its resources.
|
|
123
|
-
* @param error - Optional error indicating the reason for the disposal, if the object was
|
|
124
|
-
* disposed as the result of an error.
|
|
125
|
-
*
|
|
126
|
-
* @deprecated This API is deprecated and will be removed in a future release. No replacement is planned as
|
|
127
|
-
* it is unused in the DataStore layer.
|
|
128
|
-
*/
|
|
129
|
-
dispose?(error?: Error): void;
|
|
130
|
-
/**
|
|
131
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
132
|
-
* it is unused in the DataStore layer.
|
|
133
|
-
*/
|
|
134
|
-
readonly policies?: IDocumentStorageServicePolicies | undefined;
|
|
135
|
-
/**
|
|
136
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
137
|
-
* it is unused in the DataStore layer.
|
|
138
|
-
*/
|
|
139
|
-
getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;
|
|
140
|
-
/**
|
|
141
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
142
|
-
* it is unused in the DataStore layer.
|
|
143
|
-
*/
|
|
144
|
-
getSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;
|
|
145
|
-
/**
|
|
146
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
147
|
-
* it is unused in the DataStore layer.
|
|
148
|
-
*/
|
|
149
|
-
getVersions(versionId: string | null, count: number, scenarioName?: string, fetchSource?: FetchSource): Promise<IVersion[]>;
|
|
150
|
-
/**
|
|
151
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
152
|
-
* it is unused in the DataStore layer.
|
|
153
|
-
*/
|
|
154
|
-
createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
|
|
155
|
-
/**
|
|
156
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
157
|
-
* it is unused in the DataStore layer.
|
|
158
|
-
*/
|
|
159
|
-
uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
|
|
160
|
-
/**
|
|
161
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
162
|
-
* it is unused in the DataStore layer.
|
|
163
|
-
*/
|
|
164
|
-
downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
|
|
165
113
|
}
|
|
166
114
|
//# sourceMappingURL=protocol.d.ts.map
|
package/dist/protocol.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0CAA0C,CAAC;AAC7E,OAAO,KAAK,EACX,KAAK,EACL,cAAc,EACd,yBAAyB,EACzB
|
|
1
|
+
{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0CAA0C,CAAC;AAC7E,OAAO,KAAK,EACX,KAAK,EACL,cAAc,EACd,yBAAyB,EACzB,MAAM,6CAA6C,CAAC;AAErD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACzB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IAEH,QAAQ,EAAE,GAAG,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,CAClF,SAAQ,cAAc,CAAC,QAAQ,CAAC;IAChC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC;CAChB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,cAAc,EAAE,UAAU,CAAC,GAAG;IAErE,QAAQ,EAAE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;CAC5C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAC3C,yBAAyB,EACzB,UAAU,GAAG,sBAAsB,CACnC,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACvC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACzC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,yBAAyB,CAAC;IAC7C;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,SAAS,uBAAuB,EAAE,CAAC;CAC7D;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACtC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;CAC/C"}
|
package/dist/protocol.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../src/protocol.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 { TypedMessage } from \"@fluidframework/core-interfaces/internal\";\nimport type {\n\tITree,\n\tISignalMessage,\n\tISequencedDocumentMessage,\n
|
|
1
|
+
{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../src/protocol.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 { TypedMessage } from \"@fluidframework/core-interfaces/internal\";\nimport type {\n\tITree,\n\tISignalMessage,\n\tISequencedDocumentMessage,\n} from \"@fluidframework/driver-definitions/internal\";\n\n/**\n * An envelope wraps the contents with the intended target\n * @legacy @beta\n */\nexport interface IEnvelope {\n\t/**\n\t * The target for the envelope\n\t */\n\taddress: string;\n\n\t/**\n\t * The contents of the envelope\n\t */\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO (#28746): breaking change\n\tcontents: any;\n}\n\n/**\n * Represents ISignalMessage with its type.\n * @legacy @beta\n */\nexport interface IInboundSignalMessage<TMessage extends TypedMessage = TypedMessage>\n\textends ISignalMessage<TMessage> {\n\treadonly type: TMessage[\"type\"];\n}\n\n/**\n * Message send by client attaching local data structure.\n * Contains snapshot of data structure which is the current state of this data structure.\n * @legacy @beta\n */\nexport interface IAttachMessage {\n\t/**\n\t * The identifier for the object\n\t */\n\tid: string;\n\n\t/**\n\t * The type of object\n\t */\n\ttype: string;\n\n\t/**\n\t * Initial snapshot of the document (contains ownership)\n\t */\n\tsnapshot: ITree;\n}\n\n/**\n * This type should be used when reading an incoming attach op,\n * but it should not be used when creating a new attach op.\n * Older versions of attach messages could have null snapshots,\n * so this gives correct typings for writing backward compatible code.\n * @legacy @beta\n */\nexport type InboundAttachMessage = Omit<IAttachMessage, \"snapshot\"> & {\n\t// eslint-disable-next-line @rushstack/no-new-null -- TODO: breaking change; protocol might even explicitly use null\n\tsnapshot: IAttachMessage[\"snapshot\"] | null;\n};\n\n/**\n * This is the message type that is used within the runtime when processing a sequenced message.\n * It is the same as ISequencedDocumentMessage, but without the contents and clientSequenceNumbers\n * which are sent separately. The contents are modified at multiple layers in the stack so having it\n * separate doesn't require packing and unpacking the entire message.\n * @legacy @beta\n */\nexport type ISequencedMessageEnvelope = Omit<\n\tISequencedDocumentMessage,\n\t\"contents\" | \"clientSequenceNumber\"\n>;\n\n/**\n * These are the contents of a runtime message as it is processed throughout the stack.\n * @legacy @beta\n * @sealed\n */\nexport interface IRuntimeMessagesContent {\n\t/**\n\t * The contents of the message, i.e., the payload\n\t */\n\treadonly contents: unknown;\n\t/**\n\t * The local metadata associated with the original message that was submitted\n\t */\n\treadonly localOpMetadata: unknown;\n\t/**\n\t * The client sequence number of the message\n\t */\n\treadonly clientSequenceNumber: number;\n}\n\n/**\n * A collection of messages that are processed by the runtime.\n * @legacy @beta\n * @sealed\n */\nexport interface IRuntimeMessageCollection {\n\t/**\n\t * The envelope for all the messages in the collection\n\t */\n\treadonly envelope: ISequencedMessageEnvelope;\n\t/**\n\t * Whether these messages were originally generated by the client processing them\n\t */\n\treadonly local: boolean;\n\t/**\n\t * The contents of the messages in the collection\n\t */\n\treadonly messagesContent: readonly IRuntimeMessagesContent[];\n}\n\n/**\n * Interface to provide access to snapshot blobs to DataStore layer.\n *\n * @legacy @beta\n */\nexport interface IRuntimeStorageService {\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"]}
|
package/lib/protocol.d.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
import type { TypedMessage } from "@fluidframework/core-interfaces/internal";
|
|
6
|
-
import type { ITree, ISignalMessage, ISequencedDocumentMessage
|
|
6
|
+
import type { ITree, ISignalMessage, ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
|
|
7
7
|
/**
|
|
8
8
|
* An envelope wraps the contents with the intended target
|
|
9
9
|
* @legacy @beta
|
|
@@ -110,57 +110,5 @@ export interface IRuntimeStorageService {
|
|
|
110
110
|
* Reads the object with the given ID, returns content in arrayBufferLike
|
|
111
111
|
*/
|
|
112
112
|
readBlob(id: string): Promise<ArrayBufferLike>;
|
|
113
|
-
/**
|
|
114
|
-
* Whether or not the object has been disposed.
|
|
115
|
-
* If true, the object should be considered invalid, and its other state should be disregarded.
|
|
116
|
-
*
|
|
117
|
-
* @deprecated This API is deprecated and will be removed in a future release. No replacement is planned as
|
|
118
|
-
* it is unused in the DataStore layer.
|
|
119
|
-
*/
|
|
120
|
-
readonly disposed?: boolean;
|
|
121
|
-
/**
|
|
122
|
-
* Dispose of the object and its resources.
|
|
123
|
-
* @param error - Optional error indicating the reason for the disposal, if the object was
|
|
124
|
-
* disposed as the result of an error.
|
|
125
|
-
*
|
|
126
|
-
* @deprecated This API is deprecated and will be removed in a future release. No replacement is planned as
|
|
127
|
-
* it is unused in the DataStore layer.
|
|
128
|
-
*/
|
|
129
|
-
dispose?(error?: Error): void;
|
|
130
|
-
/**
|
|
131
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
132
|
-
* it is unused in the DataStore layer.
|
|
133
|
-
*/
|
|
134
|
-
readonly policies?: IDocumentStorageServicePolicies | undefined;
|
|
135
|
-
/**
|
|
136
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
137
|
-
* it is unused in the DataStore layer.
|
|
138
|
-
*/
|
|
139
|
-
getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;
|
|
140
|
-
/**
|
|
141
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
142
|
-
* it is unused in the DataStore layer.
|
|
143
|
-
*/
|
|
144
|
-
getSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;
|
|
145
|
-
/**
|
|
146
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
147
|
-
* it is unused in the DataStore layer.
|
|
148
|
-
*/
|
|
149
|
-
getVersions(versionId: string | null, count: number, scenarioName?: string, fetchSource?: FetchSource): Promise<IVersion[]>;
|
|
150
|
-
/**
|
|
151
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
152
|
-
* it is unused in the DataStore layer.
|
|
153
|
-
*/
|
|
154
|
-
createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
|
|
155
|
-
/**
|
|
156
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
157
|
-
* it is unused in the DataStore layer.
|
|
158
|
-
*/
|
|
159
|
-
uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
|
|
160
|
-
/**
|
|
161
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
162
|
-
* it is unused in the DataStore layer.
|
|
163
|
-
*/
|
|
164
|
-
downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
|
|
165
113
|
}
|
|
166
114
|
//# sourceMappingURL=protocol.d.ts.map
|
package/lib/protocol.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0CAA0C,CAAC;AAC7E,OAAO,KAAK,EACX,KAAK,EACL,cAAc,EACd,yBAAyB,EACzB
|
|
1
|
+
{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0CAA0C,CAAC;AAC7E,OAAO,KAAK,EACX,KAAK,EACL,cAAc,EACd,yBAAyB,EACzB,MAAM,6CAA6C,CAAC;AAErD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACzB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IAEH,QAAQ,EAAE,GAAG,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,CAClF,SAAQ,cAAc,CAAC,QAAQ,CAAC;IAChC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC;CAChB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,cAAc,EAAE,UAAU,CAAC,GAAG;IAErE,QAAQ,EAAE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;CAC5C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAC3C,yBAAyB,EACzB,UAAU,GAAG,sBAAsB,CACnC,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACvC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACzC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,yBAAyB,CAAC;IAC7C;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,SAAS,uBAAuB,EAAE,CAAC;CAC7D;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACtC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;CAC/C"}
|
package/lib/protocol.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../src/protocol.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 { TypedMessage } from \"@fluidframework/core-interfaces/internal\";\nimport type {\n\tITree,\n\tISignalMessage,\n\tISequencedDocumentMessage,\n
|
|
1
|
+
{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../src/protocol.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 { TypedMessage } from \"@fluidframework/core-interfaces/internal\";\nimport type {\n\tITree,\n\tISignalMessage,\n\tISequencedDocumentMessage,\n} from \"@fluidframework/driver-definitions/internal\";\n\n/**\n * An envelope wraps the contents with the intended target\n * @legacy @beta\n */\nexport interface IEnvelope {\n\t/**\n\t * The target for the envelope\n\t */\n\taddress: string;\n\n\t/**\n\t * The contents of the envelope\n\t */\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO (#28746): breaking change\n\tcontents: any;\n}\n\n/**\n * Represents ISignalMessage with its type.\n * @legacy @beta\n */\nexport interface IInboundSignalMessage<TMessage extends TypedMessage = TypedMessage>\n\textends ISignalMessage<TMessage> {\n\treadonly type: TMessage[\"type\"];\n}\n\n/**\n * Message send by client attaching local data structure.\n * Contains snapshot of data structure which is the current state of this data structure.\n * @legacy @beta\n */\nexport interface IAttachMessage {\n\t/**\n\t * The identifier for the object\n\t */\n\tid: string;\n\n\t/**\n\t * The type of object\n\t */\n\ttype: string;\n\n\t/**\n\t * Initial snapshot of the document (contains ownership)\n\t */\n\tsnapshot: ITree;\n}\n\n/**\n * This type should be used when reading an incoming attach op,\n * but it should not be used when creating a new attach op.\n * Older versions of attach messages could have null snapshots,\n * so this gives correct typings for writing backward compatible code.\n * @legacy @beta\n */\nexport type InboundAttachMessage = Omit<IAttachMessage, \"snapshot\"> & {\n\t// eslint-disable-next-line @rushstack/no-new-null -- TODO: breaking change; protocol might even explicitly use null\n\tsnapshot: IAttachMessage[\"snapshot\"] | null;\n};\n\n/**\n * This is the message type that is used within the runtime when processing a sequenced message.\n * It is the same as ISequencedDocumentMessage, but without the contents and clientSequenceNumbers\n * which are sent separately. The contents are modified at multiple layers in the stack so having it\n * separate doesn't require packing and unpacking the entire message.\n * @legacy @beta\n */\nexport type ISequencedMessageEnvelope = Omit<\n\tISequencedDocumentMessage,\n\t\"contents\" | \"clientSequenceNumber\"\n>;\n\n/**\n * These are the contents of a runtime message as it is processed throughout the stack.\n * @legacy @beta\n * @sealed\n */\nexport interface IRuntimeMessagesContent {\n\t/**\n\t * The contents of the message, i.e., the payload\n\t */\n\treadonly contents: unknown;\n\t/**\n\t * The local metadata associated with the original message that was submitted\n\t */\n\treadonly localOpMetadata: unknown;\n\t/**\n\t * The client sequence number of the message\n\t */\n\treadonly clientSequenceNumber: number;\n}\n\n/**\n * A collection of messages that are processed by the runtime.\n * @legacy @beta\n * @sealed\n */\nexport interface IRuntimeMessageCollection {\n\t/**\n\t * The envelope for all the messages in the collection\n\t */\n\treadonly envelope: ISequencedMessageEnvelope;\n\t/**\n\t * Whether these messages were originally generated by the client processing them\n\t */\n\treadonly local: boolean;\n\t/**\n\t * The contents of the messages in the collection\n\t */\n\treadonly messagesContent: readonly IRuntimeMessagesContent[];\n}\n\n/**\n * Interface to provide access to snapshot blobs to DataStore layer.\n *\n * @legacy @beta\n */\nexport interface IRuntimeStorageService {\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"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/runtime-definitions",
|
|
3
|
-
"version": "2.70.0-
|
|
3
|
+
"version": "2.70.0-361788",
|
|
4
4
|
"description": "Fluid Runtime definitions",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -57,11 +57,11 @@
|
|
|
57
57
|
"main": "lib/index.js",
|
|
58
58
|
"types": "lib/public.d.ts",
|
|
59
59
|
"dependencies": {
|
|
60
|
-
"@fluidframework/container-definitions": "2.70.0-
|
|
61
|
-
"@fluidframework/core-interfaces": "2.70.0-
|
|
62
|
-
"@fluidframework/driver-definitions": "2.70.0-
|
|
63
|
-
"@fluidframework/id-compressor": "2.70.0-
|
|
64
|
-
"@fluidframework/telemetry-utils": "2.70.0-
|
|
60
|
+
"@fluidframework/container-definitions": "2.70.0-361788",
|
|
61
|
+
"@fluidframework/core-interfaces": "2.70.0-361788",
|
|
62
|
+
"@fluidframework/driver-definitions": "2.70.0-361788",
|
|
63
|
+
"@fluidframework/id-compressor": "2.70.0-361788",
|
|
64
|
+
"@fluidframework/telemetry-utils": "2.70.0-361788"
|
|
65
65
|
},
|
|
66
66
|
"devDependencies": {
|
|
67
67
|
"@arethetypeswrong/cli": "^0.17.1",
|
|
@@ -79,7 +79,20 @@
|
|
|
79
79
|
"typescript": "~5.4.5"
|
|
80
80
|
},
|
|
81
81
|
"typeValidation": {
|
|
82
|
-
"broken": {
|
|
82
|
+
"broken": {
|
|
83
|
+
"Interface_IFluidDataStoreContext": {
|
|
84
|
+
"backCompat": false
|
|
85
|
+
},
|
|
86
|
+
"Interface_IFluidDataStoreContextDetached": {
|
|
87
|
+
"backCompat": false
|
|
88
|
+
},
|
|
89
|
+
"Interface_IFluidParentContext": {
|
|
90
|
+
"backCompat": false
|
|
91
|
+
},
|
|
92
|
+
"Interface_IRuntimeStorageService": {
|
|
93
|
+
"backCompat": false
|
|
94
|
+
}
|
|
95
|
+
},
|
|
83
96
|
"entrypoint": "legacy"
|
|
84
97
|
},
|
|
85
98
|
"scripts": {
|
package/src/protocol.ts
CHANGED
|
@@ -8,16 +8,6 @@ import type {
|
|
|
8
8
|
ITree,
|
|
9
9
|
ISignalMessage,
|
|
10
10
|
ISequencedDocumentMessage,
|
|
11
|
-
IDocumentStorageServicePolicies,
|
|
12
|
-
IVersion,
|
|
13
|
-
ISnapshotTree,
|
|
14
|
-
ISnapshotFetchOptions,
|
|
15
|
-
ISnapshot,
|
|
16
|
-
FetchSource,
|
|
17
|
-
ICreateBlobResponse,
|
|
18
|
-
ISummaryTree,
|
|
19
|
-
ISummaryHandle,
|
|
20
|
-
ISummaryContext,
|
|
21
11
|
} from "@fluidframework/driver-definitions/internal";
|
|
22
12
|
|
|
23
13
|
/**
|
|
@@ -142,73 +132,4 @@ export interface IRuntimeStorageService {
|
|
|
142
132
|
* Reads the object with the given ID, returns content in arrayBufferLike
|
|
143
133
|
*/
|
|
144
134
|
readBlob(id: string): Promise<ArrayBufferLike>;
|
|
145
|
-
|
|
146
|
-
/**
|
|
147
|
-
* Whether or not the object has been disposed.
|
|
148
|
-
* If true, the object should be considered invalid, and its other state should be disregarded.
|
|
149
|
-
*
|
|
150
|
-
* @deprecated This API is deprecated and will be removed in a future release. No replacement is planned as
|
|
151
|
-
* it is unused in the DataStore layer.
|
|
152
|
-
*/
|
|
153
|
-
readonly disposed?: boolean;
|
|
154
|
-
|
|
155
|
-
/**
|
|
156
|
-
* Dispose of the object and its resources.
|
|
157
|
-
* @param error - Optional error indicating the reason for the disposal, if the object was
|
|
158
|
-
* disposed as the result of an error.
|
|
159
|
-
*
|
|
160
|
-
* @deprecated This API is deprecated and will be removed in a future release. No replacement is planned as
|
|
161
|
-
* it is unused in the DataStore layer.
|
|
162
|
-
*/
|
|
163
|
-
dispose?(error?: Error): void;
|
|
164
|
-
|
|
165
|
-
/**
|
|
166
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
167
|
-
* it is unused in the DataStore layer.
|
|
168
|
-
*/
|
|
169
|
-
readonly policies?: IDocumentStorageServicePolicies | undefined;
|
|
170
|
-
|
|
171
|
-
/**
|
|
172
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
173
|
-
* it is unused in the DataStore layer.
|
|
174
|
-
*/
|
|
175
|
-
// eslint-disable-next-line @rushstack/no-new-null
|
|
176
|
-
getSnapshotTree(version?: IVersion, scenarioName?: string): Promise<ISnapshotTree | null>;
|
|
177
|
-
|
|
178
|
-
/**
|
|
179
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
180
|
-
* it is unused in the DataStore layer.
|
|
181
|
-
*/
|
|
182
|
-
getSnapshot?(snapshotFetchOptions?: ISnapshotFetchOptions): Promise<ISnapshot>;
|
|
183
|
-
|
|
184
|
-
/**
|
|
185
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
186
|
-
* it is unused in the DataStore layer.
|
|
187
|
-
*/
|
|
188
|
-
getVersions(
|
|
189
|
-
// TODO: use `undefined` instead.
|
|
190
|
-
// eslint-disable-next-line @rushstack/no-new-null
|
|
191
|
-
versionId: string | null,
|
|
192
|
-
count: number,
|
|
193
|
-
scenarioName?: string,
|
|
194
|
-
fetchSource?: FetchSource,
|
|
195
|
-
): Promise<IVersion[]>;
|
|
196
|
-
|
|
197
|
-
/**
|
|
198
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
199
|
-
* it is unused in the DataStore layer.
|
|
200
|
-
*/
|
|
201
|
-
createBlob(file: ArrayBufferLike): Promise<ICreateBlobResponse>;
|
|
202
|
-
|
|
203
|
-
/**
|
|
204
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
205
|
-
* it is unused in the DataStore layer.
|
|
206
|
-
*/
|
|
207
|
-
uploadSummaryWithContext(summary: ISummaryTree, context: ISummaryContext): Promise<string>;
|
|
208
|
-
|
|
209
|
-
/**
|
|
210
|
-
* @deprecated This will be removed in a future release. No replacement is planned as
|
|
211
|
-
* it is unused in the DataStore layer.
|
|
212
|
-
*/
|
|
213
|
-
downloadSummary(handle: ISummaryHandle): Promise<ISummaryTree>;
|
|
214
135
|
}
|