@fluidframework/runtime-definitions 2.0.0-internal.7.4.0 → 2.0.0-internal.8.0.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/CHANGELOG.md +40 -0
- package/api-report/runtime-definitions.api.md +0 -20
- package/dist/dataStoreContext.d.ts +1 -45
- package/dist/dataStoreContext.d.ts.map +1 -1
- package/dist/dataStoreContext.js.map +1 -1
- package/dist/index.d.ts +1 -5
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -5
- package/dist/index.js.map +1 -1
- package/dist/runtime-definitions-alpha.d.ts +0 -49
- package/dist/runtime-definitions-beta.d.ts +0 -9
- package/dist/runtime-definitions-public.d.ts +0 -9
- package/dist/runtime-definitions-untrimmed.d.ts +0 -49
- package/lib/runtime-definitions-alpha.d.ts +0 -49
- package/lib/runtime-definitions-beta.d.ts +0 -9
- package/lib/runtime-definitions-public.d.ts +0 -9
- package/lib/runtime-definitions-untrimmed.d.ts +0 -49
- package/package.json +31 -5
- package/src/dataStoreContext.ts +0 -52
- package/src/index.ts +0 -4
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,45 @@
|
|
|
1
1
|
# @fluidframework/runtime-definitions
|
|
2
2
|
|
|
3
|
+
## 2.0.0-internal.8.0.0
|
|
4
|
+
|
|
5
|
+
### Major Changes
|
|
6
|
+
|
|
7
|
+
- container-runtime-definitions: Removed resolveHandle and IFluidHandleContext from ContainerRuntime interfaces [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
|
|
8
|
+
|
|
9
|
+
The `IContainerRuntime.resolveHandle(...)` method and the `IContainerRuntimeBase.IFluidHandleContext` property have been
|
|
10
|
+
removed. Please remove all usage of these APIs.
|
|
11
|
+
|
|
12
|
+
See
|
|
13
|
+
[Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md)
|
|
14
|
+
for more details.
|
|
15
|
+
|
|
16
|
+
- container-runtime: Removed request pattern from ContainerRuntime, IRuntime, and IContainerRuntimeBase [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
|
|
17
|
+
|
|
18
|
+
The `request(...)` method and `IFluidRouter` property have been removed from the following places:
|
|
19
|
+
|
|
20
|
+
- `ContainerRuntime`
|
|
21
|
+
- `IRuntime`
|
|
22
|
+
- `IContainerRuntimeBase`
|
|
23
|
+
|
|
24
|
+
Please use the `IRuntime.getEntryPoint()` method to get the runtime's entry point.
|
|
25
|
+
|
|
26
|
+
See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
|
|
27
|
+
|
|
28
|
+
- runtime-definitions: Removed IFluidRouter from IFluidDataStoreChannel and FluidDataStoreRuntime [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
|
|
29
|
+
|
|
30
|
+
The `IFluidRouter` property has been removed from `IFluidDataStoreChannel` and `FluidDataStoreRuntime`. Please migrate
|
|
31
|
+
all usage to the `IFluidDataStoreChannel.entryPoint` API.
|
|
32
|
+
|
|
33
|
+
See
|
|
34
|
+
[Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md)
|
|
35
|
+
for more details.
|
|
36
|
+
|
|
37
|
+
- runtime-definitions: Removed request and IFluidRouter from IDataStore [9a451d4946](https://github.com/microsoft/FluidFramework/commits/9a451d4946b5c51a52e4d1ab5bf51e7b285b0d74)
|
|
38
|
+
|
|
39
|
+
The `request` method and `IFluidRouter` property have been removed from `IDataStore`. Please migrate all usage to the `IDataStore.entryPoint` API.
|
|
40
|
+
|
|
41
|
+
See [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md) for more details.
|
|
42
|
+
|
|
3
43
|
## 2.0.0-internal.7.4.0
|
|
4
44
|
|
|
5
45
|
### Minor Changes
|
|
@@ -17,12 +17,9 @@ import { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
|
17
17
|
import { IEvent } from '@fluidframework/core-interfaces';
|
|
18
18
|
import { IEventProvider } from '@fluidframework/core-interfaces';
|
|
19
19
|
import { IFluidHandle } from '@fluidframework/core-interfaces';
|
|
20
|
-
import { IFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
21
|
-
import { IFluidRouter } from '@fluidframework/core-interfaces';
|
|
22
20
|
import { IIdCompressor } from '@fluidframework/id-compressor';
|
|
23
21
|
import { IIdCompressorCore } from '@fluidframework/id-compressor';
|
|
24
22
|
import { ILoaderOptions } from '@fluidframework/container-definitions';
|
|
25
|
-
import { initialClusterCapacity } from '@fluidframework/id-compressor';
|
|
26
23
|
import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
27
24
|
import { IQuorumClients } from '@fluidframework/protocol-definitions';
|
|
28
25
|
import { IRequest } from '@fluidframework/core-interfaces';
|
|
@@ -138,13 +135,9 @@ export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeB
|
|
|
138
135
|
getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
|
|
139
136
|
getAudience(): IAudience;
|
|
140
137
|
getQuorum(): IQuorumClients;
|
|
141
|
-
// @deprecated (undocumented)
|
|
142
|
-
readonly IFluidHandleContext: IFluidHandleContext;
|
|
143
138
|
// (undocumented)
|
|
144
139
|
readonly logger: ITelemetryBaseLogger;
|
|
145
140
|
orderSequentially(callback: () => void): void;
|
|
146
|
-
// @deprecated
|
|
147
|
-
request(request: IRequest): Promise<IResponse>;
|
|
148
141
|
submitSignal(type: string, content: any): void;
|
|
149
142
|
// (undocumented)
|
|
150
143
|
uploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandle<ArrayBufferLike>>;
|
|
@@ -165,15 +158,6 @@ export interface IContainerRuntimeBaseEvents extends IEvent {
|
|
|
165
158
|
// @alpha
|
|
166
159
|
export interface IDataStore {
|
|
167
160
|
readonly entryPoint: IFluidHandle<FluidObject>;
|
|
168
|
-
// @deprecated (undocumented)
|
|
169
|
-
readonly IFluidRouter: IFluidRouter;
|
|
170
|
-
// @deprecated (undocumented)
|
|
171
|
-
request(request: {
|
|
172
|
-
url: "/";
|
|
173
|
-
headers?: undefined;
|
|
174
|
-
}): Promise<IResponse>;
|
|
175
|
-
// @deprecated
|
|
176
|
-
request(request: IRequest): Promise<IResponse>;
|
|
177
161
|
trySetAlias(alias: string): Promise<AliasResult>;
|
|
178
162
|
}
|
|
179
163
|
|
|
@@ -206,8 +190,6 @@ export interface IFluidDataStoreChannel extends IDisposable {
|
|
|
206
190
|
getGCData(fullGC?: boolean): Promise<IGarbageCollectionData>;
|
|
207
191
|
// (undocumented)
|
|
208
192
|
readonly id: string;
|
|
209
|
-
// @deprecated (undocumented)
|
|
210
|
-
readonly IFluidRouter: IFluidRouter;
|
|
211
193
|
makeVisibleAndAttachGraph(): void;
|
|
212
194
|
process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
|
|
213
195
|
processSignal(message: any, local: boolean): void;
|
|
@@ -328,8 +310,6 @@ export type InboundAttachMessage = Omit<IAttachMessage, "snapshot"> & {
|
|
|
328
310
|
snapshot: IAttachMessage["snapshot"] | null;
|
|
329
311
|
};
|
|
330
312
|
|
|
331
|
-
export { initialClusterCapacity }
|
|
332
|
-
|
|
333
313
|
// @alpha (undocumented)
|
|
334
314
|
export interface IProvideFluidDataStoreFactory {
|
|
335
315
|
// (undocumented)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
|
-
import { IEvent, IEventProvider, ITelemetryBaseLogger, IDisposable,
|
|
5
|
+
import { IEvent, IEventProvider, ITelemetryBaseLogger, IDisposable, IProvideFluidHandleContext, IFluidHandle, IRequest, IResponse, FluidObject } from "@fluidframework/core-interfaces";
|
|
6
6
|
import { IAudience, IDeltaManager, AttachState, ILoaderOptions } from "@fluidframework/container-definitions";
|
|
7
7
|
import { IDocumentStorageService } from "@fluidframework/driver-definitions";
|
|
8
8
|
import { IClientDetails, IDocumentMessage, IQuorumClients, ISequencedDocumentMessage, ISnapshotTree } from "@fluidframework/protocol-definitions";
|
|
@@ -119,37 +119,6 @@ export interface IDataStore {
|
|
|
119
119
|
* with it.
|
|
120
120
|
*/
|
|
121
121
|
readonly entryPoint: IFluidHandle<FluidObject>;
|
|
122
|
-
/**
|
|
123
|
-
* @deprecated Requesting will not be supported in a future major release.
|
|
124
|
-
* Instead, access the objects within the DataStore using entryPoint, and then navigate from there using
|
|
125
|
-
* app-specific logic (e.g. retrieving a handle from a DDS, or the entryPoint object could implement a request paradigm itself)
|
|
126
|
-
*
|
|
127
|
-
* IMPORTANT: This overload is provided for back-compat where IDataStore.request(\{ url: "/" \}) is already implemented and used.
|
|
128
|
-
* The functionality it can provide (if the DataStore implementation is built for it) is redundant with @see {@link IDataStore.entryPoint}.
|
|
129
|
-
*
|
|
130
|
-
* Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.
|
|
131
|
-
*
|
|
132
|
-
* @param request - Only requesting \{ url: "/" \} is supported, requesting arbitrary URLs is deprecated.
|
|
133
|
-
*/
|
|
134
|
-
request(request: {
|
|
135
|
-
url: "/";
|
|
136
|
-
headers?: undefined;
|
|
137
|
-
}): Promise<IResponse>;
|
|
138
|
-
/**
|
|
139
|
-
* Issue a request against the DataStore for a resource within it.
|
|
140
|
-
* @param request - The request to be issued against the DataStore
|
|
141
|
-
*
|
|
142
|
-
* @deprecated Requesting an arbitrary URL with headers will not be supported in a future major release.
|
|
143
|
-
* Instead, access the objects within the DataStore using entryPoint, and then navigate from there using
|
|
144
|
-
* app-specific logic (e.g. retrieving a handle from a DDS, or the entryPoint object could implement a request paradigm itself)
|
|
145
|
-
*
|
|
146
|
-
* Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.
|
|
147
|
-
*/
|
|
148
|
-
request(request: IRequest): Promise<IResponse>;
|
|
149
|
-
/**
|
|
150
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
151
|
-
*/
|
|
152
|
-
readonly IFluidRouter: IFluidRouter;
|
|
153
122
|
}
|
|
154
123
|
/**
|
|
155
124
|
* A reduced set of functionality of IContainerRuntime that a data store context/data store runtime will need
|
|
@@ -164,11 +133,6 @@ export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeB
|
|
|
164
133
|
* sequentially. Total size of all messages must be less than maxOpSize.
|
|
165
134
|
*/
|
|
166
135
|
orderSequentially(callback: () => void): void;
|
|
167
|
-
/**
|
|
168
|
-
* Executes a request against the container runtime
|
|
169
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
170
|
-
*/
|
|
171
|
-
request(request: IRequest): Promise<IResponse>;
|
|
172
136
|
/**
|
|
173
137
|
* Submits a container runtime level signal to be sent to other clients.
|
|
174
138
|
* @param type - Type of the signal.
|
|
@@ -208,10 +172,6 @@ export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeB
|
|
|
208
172
|
* Returns the current audience.
|
|
209
173
|
*/
|
|
210
174
|
getAudience(): IAudience;
|
|
211
|
-
/**
|
|
212
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
213
|
-
*/
|
|
214
|
-
readonly IFluidHandleContext: IFluidHandleContext;
|
|
215
175
|
}
|
|
216
176
|
/**
|
|
217
177
|
* Minimal interface a data store runtime needs to provide for IFluidDataStoreContext to bind to control.
|
|
@@ -296,10 +256,6 @@ export interface IFluidDataStoreChannel extends IDisposable {
|
|
|
296
256
|
*/
|
|
297
257
|
readonly entryPoint: IFluidHandle<FluidObject>;
|
|
298
258
|
request(request: IRequest): Promise<IResponse>;
|
|
299
|
-
/**
|
|
300
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
301
|
-
*/
|
|
302
|
-
readonly IFluidRouter: IFluidRouter;
|
|
303
259
|
}
|
|
304
260
|
/**
|
|
305
261
|
* @alpha
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dataStoreContext.d.ts","sourceRoot":"","sources":["../src/dataStoreContext.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,MAAM,EACN,cAAc,EACd,oBAAoB,EACpB,WAAW,
|
|
1
|
+
{"version":3,"file":"dataStoreContext.d.ts","sourceRoot":"","sources":["../src/dataStoreContext.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,MAAM,EACN,cAAc,EACd,oBAAoB,EACpB,WAAW,EACX,0BAA0B,EAC1B,YAAY,EACZ,QAAQ,EACR,SAAS,EACT,WAAW,EACX,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACN,SAAS,EACT,aAAa,EACb,WAAW,EACX,cAAc,EACd,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EACN,cAAc,EACd,gBAAgB,EAChB,cAAc,EACd,yBAAyB,EACzB,aAAa,EACb,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,6BAA6B,EAAE,MAAM,oBAAoB,CAAC;AACnE,OAAO,EAAE,8BAA8B,EAAE,MAAM,qBAAqB,CAAC;AACrE,OAAO,EAAE,sBAAsB,EAAE,6BAA6B,EAAE,MAAM,qBAAqB,CAAC;AAC5F,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EACN,8BAA8B,EAC9B,qBAAqB,EACrB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,MAAM,WAAW,CAAC;AAEnB;;;GAGG;AACH,oBAAY,SAAS;IACpB;;OAEG;IACH,SAAS,IAAA;IAET;;;OAGG;IACH,SAAS,IAAA;CACT;AAED;;GAEG;AACH,oBAAY,qBAAqB;IAChC;;;;;;;;OAQG;IACH,KAAK,IAAI;CACT;AAED;;;;GAIG;AACH,eAAO,MAAM,eAAe;IAC3B;;OAEG;;IAGH;;;;OAIG;;IAGH;;;;;;;;OAQG;;CAEH,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC;AAErF;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,MAAM;IAC1D,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,yBAAyB,KAAK,IAAI,OAAE;IACzE;;;OAGG;IACH,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,yBAAyB,EAAE,cAAc,CAAC,EAAE,OAAO,KAAK,IAAI,OAAE;IAC3F,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,yBAAyB,KAAK,IAAI,OAAE;IACnF,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;CACtF;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG,UAAU,GAAG,gBAAgB,CAAC;AAEpE;;;;;;GAMG;AACH,MAAM,WAAW,UAAU;IAC1B;;;;;;;OAOG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAEjD;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;CAC/C;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAsB,SAAQ,cAAc,CAAC,2BAA2B,CAAC;IACzF,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IACtC,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IAEvC;;;OAGG;IACH,iBAAiB,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAE9C;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,yBAAyB,CACxB,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EACtB,KAAK,CAAC,EAAE,GAAG,EACX,EAAE,CAAC,EAAE,MAAM,GACT,OAAO,CAAC,UAAU,CAAC,CAAC;IAEvB;;;;;;;OAOG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAE7D;;;OAGG;IACH,uBAAuB,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,GAAG,8BAA8B,CAAC;IAEjF;;;;OAIG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAEjE,UAAU,CAAC,IAAI,EAAE,eAAe,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;IAEhG;;OAEG;IACH,SAAS,IAAI,cAAc,CAAC;IAE5B;;OAEG;IACH,WAAW,IAAI,SAAS,CAAC;CACzB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,sBAAuB,SAAQ,WAAW;IAC1D,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;IAE1C;;;OAGG;IACH,WAAW,IAAI,IAAI,CAAC;IAEpB;;;OAGG;IACH,yBAAyB,IAAI,IAAI,CAAC;IAElC;;OAEG;IACH,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,iBAAiB,GAAG,qBAAqB,CAAC;IAE9E;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5F;;OAEG;IACH,aAAa,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;IAElD;;;;;;OAMG;IACH,SAAS,CACR,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAElC;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAE7D;;;OAGG;IACH,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAE7C;;;;;OAKG;IACH,kBAAkB,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,OAAE;IAE1D;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,OAAE;IAE/D,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtE;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;IAE/C,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,CACzC,iBAAiB,EAAE,mBAAmB,EACtC,WAAW,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,sBAAsB,CAAC;AAClE;;GAEG;AACH,kBAAkB,CAAC,EAAE,MAAM,OAAO,CAAC,6BAA6B,CAAC,KAC7D,qBAAqB,CAAC;AAE3B;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,MAAM;IAC3D,CAAC,KAAK,EAAE,WAAW,GAAG,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;CACxD;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAChB,SAAQ,cAAc,CAAC,4BAA4B,CAAC,EACnD,OAAO,CAAC,8BAA8B,CAAC,EACvC,0BAA0B;IAC3B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB;;;;;;;OAOG;IACH,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACnC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,SAAS,MAAM,EAAE,CAAC;IACxC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAAC;IAClF,QAAQ,CAAC,OAAO,EAAE,uBAAuB,CAAC;IAC1C,QAAQ,CAAC,YAAY,EAAE,aAAa,GAAG,SAAS,CAAC;IACjD,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IACtC,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IACvC,QAAQ,CAAC,YAAY,CAAC,EAAE,aAAa,CAAC;IACtC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,QAAQ,CAAC,gBAAgB,EAAE,qBAAqB,CAAC;IAEjD;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAE5B;;OAEG;IACH,SAAS,IAAI,cAAc,CAAC;IAE5B;;OAEG;IACH,WAAW,IAAI,SAAS,CAAC;IAEzB;;;;;;;OAOG;IACH,wBAAwB,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;IAElD;;;;;;;OAOG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1E;;;;;OAKG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExE;;;OAGG;IACH,kBAAkB,IAAI,IAAI,CAAC;IAE3B;;;OAGG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;;;OAIG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAEjE,8BAA8B;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM;IACV;;;;;OAKG;IACH,WAAW,EAAE,8BAA8B,GACzC,2BAA2B,CAAC;IAE/B,UAAU,CAAC,IAAI,EAAE,eAAe,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;IAEhG;;;;;OAKG;IACH,gBAAgB,IAAI,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAE3D;;;;;OAKG;IACH,wBAAwB,CAAC,CAAC,SAAS,EAAE,YAAY,EAAE,cAAc,EAAE,YAAY,GAAG,IAAI,CAAC;CACvF;AAED;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,sBAAsB;IAC7E;;OAEG;IACH,aAAa,CACZ,OAAO,EAAE,6BAA6B,EACtC,gBAAgB,EAAE,sBAAsB,GACtC,OAAO,CAAC,IAAI,CAAC,CAAC;CACjB"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dataStoreContext.js","sourceRoot":"","sources":["../src/dataStoreContext.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA2CH;;;GAGG;AACH,IAAY,SAWX;AAXD,WAAY,SAAS;IACpB;;OAEG;IACH,mDAAS,CAAA;IAET;;;OAGG;IACH,mDAAS,CAAA;AACV,CAAC,EAXW,SAAS,yBAAT,SAAS,QAWpB;AAED;;GAEG;AACH,IAAY,qBAWX;AAXD,WAAY,qBAAqB;IAChC;;;;;;;;OAQG;IACH,mEAAS,CAAA;AACV,CAAC,EAXW,qBAAqB,qCAArB,qBAAqB,QAWhC;AAED;;;;GAIG;AACU,QAAA,eAAe,GAAG;IAC9B;;OAEG;IACH,UAAU,EAAE,YAAY;IAExB;;;;OAIG;IACH,cAAc,EAAE,gBAAgB;IAEhC;;;;;;;;OAQG;IACH,eAAe,EAAE,iBAAiB;CAClC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIEvent,\n\tIEventProvider,\n\tITelemetryBaseLogger,\n\tIDisposable,\n\t// eslint-disable-next-line import/no-deprecated\n\tIFluidRouter,\n\tIProvideFluidHandleContext,\n\tIFluidHandle,\n\tIRequest,\n\tIResponse,\n\tFluidObject,\n\tIFluidHandleContext,\n} from \"@fluidframework/core-interfaces\";\nimport {\n\tIAudience,\n\tIDeltaManager,\n\tAttachState,\n\tILoaderOptions,\n} from \"@fluidframework/container-definitions\";\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport {\n\tIClientDetails,\n\tIDocumentMessage,\n\tIQuorumClients,\n\tISequencedDocumentMessage,\n\tISnapshotTree,\n} from \"@fluidframework/protocol-definitions\";\nimport { IIdCompressor } from \"@fluidframework/id-compressor\";\nimport { IProvideFluidDataStoreFactory } from \"./dataStoreFactory\";\nimport { IProvideFluidDataStoreRegistry } from \"./dataStoreRegistry\";\nimport { IGarbageCollectionData, IGarbageCollectionDetailsBase } from \"./garbageCollection\";\nimport { IInboundSignalMessage } from \"./protocol\";\nimport {\n\tCreateChildSummarizerNodeParam,\n\tISummarizerNodeWithGC,\n\tISummaryTreeWithStats,\n\tITelemetryContext,\n\tSummarizeInternalFn,\n} from \"./summary\";\n\n/**\n * Runtime flush mode handling\n * @alpha\n */\nexport enum FlushMode {\n\t/**\n\t * In Immediate flush mode the runtime will immediately send all operations to the driver layer.\n\t */\n\tImmediate,\n\n\t/**\n\t * When in TurnBased flush mode the runtime will buffer operations in the current turn and send them as a single\n\t * batch at the end of the turn. The flush call on the runtime can be used to force send the current batch.\n\t */\n\tTurnBased,\n}\n\n/**\n * @internal\n */\nexport enum FlushModeExperimental {\n\t/**\n\t * When in Async flush mode, the runtime will accumulate all operations across JS turns and send them as a single\n\t * batch when all micro-tasks are complete.\n\t *\n\t * This feature requires a version of the loader which supports reference sequence numbers. If an older version of\n\t * the loader is used, the runtime will fall back on FlushMode.TurnBased.\n\t *\n\t * @experimental - Not ready for use\n\t */\n\tAsync = 2,\n}\n\n/**\n * This tells the visibility state of a Fluid object. It basically tracks whether the object is not visible, visible\n * locally within the container only or visible globally to all clients.\n * @alpha\n */\nexport const VisibilityState = {\n\t/**\n\t * Indicates that the object is not visible. This is the state when an object is first created.\n\t */\n\tNotVisible: \"NotVisible\",\n\n\t/**\n\t * Indicates that the object is visible locally within the container. This is the state when an object is attached\n\t * to the container's graph but the container itself isn't globally visible. The object's state goes from not\n\t * visible to locally visible.\n\t */\n\tLocallyVisible: \"LocallyVisible\",\n\n\t/**\n\t * Indicates that the object is visible globally to all clients. This is the state of an object in 2 scenarios:\n\t *\n\t * 1. It is attached to the container's graph when the container is globally visible. The object's state goes from\n\t * not visible to globally visible.\n\t *\n\t * 2. When a container becomes globally visible, all locally visible objects go from locally visible to globally\n\t * visible.\n\t */\n\tGloballyVisible: \"GloballyVisible\",\n};\n/**\n * @alpha\n */\nexport type VisibilityState = (typeof VisibilityState)[keyof typeof VisibilityState];\n\n/**\n * @alpha\n */\nexport interface IContainerRuntimeBaseEvents extends IEvent {\n\t(event: \"batchBegin\", listener: (op: ISequencedDocumentMessage) => void);\n\t/**\n\t * @param runtimeMessage - tells if op is runtime op. If it is, it was unpacked, i.e. it's type and content\n\t * represent internal container runtime type / content.\n\t */\n\t(event: \"op\", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void);\n\t(event: \"batchEnd\", listener: (error: any, op: ISequencedDocumentMessage) => void);\n\t(event: \"signal\", listener: (message: IInboundSignalMessage, local: boolean) => void);\n}\n\n/**\n * Encapsulates the return codes of the aliasing API.\n *\n * 'Success' - the datastore has been successfully aliased. It can now be used.\n * 'Conflict' - there is already a datastore bound to the provided alias. To acquire it's entry point, use\n * the `IContainerRuntime.getAliasedDataStoreEntryPoint` function. The current datastore should be discarded\n * and will be garbage collected. The current datastore cannot be aliased to a different value.\n * 'AlreadyAliased' - the datastore has already been previously bound to another alias name.\n * @alpha\n */\nexport type AliasResult = \"Success\" | \"Conflict\" | \"AlreadyAliased\";\n\n/**\n * Exposes some functionality/features of a data store:\n * - Handle to the data store's entryPoint\n * - Fluid router for the data store\n * - Can be assigned an alias\n * @alpha\n */\nexport interface IDataStore {\n\t/**\n\t * Attempt to assign an alias to the datastore.\n\t * If the operation succeeds, the datastore can be referenced\n\t * by the supplied alias and will not be garbage collected.\n\t *\n\t * @param alias - Given alias for this datastore.\n\t * @returns A promise with the {@link AliasResult}\n\t */\n\ttrySetAlias(alias: string): Promise<AliasResult>;\n\n\t/**\n\t * Exposes a handle to the root object / entryPoint of the data store. Use this as the primary way of interacting\n\t * with it.\n\t */\n\treadonly entryPoint: IFluidHandle<FluidObject>;\n\n\t/**\n\t * @deprecated Requesting will not be supported in a future major release.\n\t * Instead, access the objects within the DataStore using entryPoint, and then navigate from there using\n\t * app-specific logic (e.g. retrieving a handle from a DDS, or the entryPoint object could implement a request paradigm itself)\n\t *\n\t * IMPORTANT: This overload is provided for back-compat where IDataStore.request(\\{ url: \"/\" \\}) is already implemented and used.\n\t * The functionality it can provide (if the DataStore implementation is built for it) is redundant with @see {@link IDataStore.entryPoint}.\n\t *\n\t * Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.\n\t *\n\t * @param request - Only requesting \\{ url: \"/\" \\} is supported, requesting arbitrary URLs is deprecated.\n\t */\n\trequest(request: { url: \"/\"; headers?: undefined }): Promise<IResponse>;\n\n\t/**\n\t * Issue a request against the DataStore for a resource within it.\n\t * @param request - The request to be issued against the DataStore\n\t *\n\t * @deprecated Requesting an arbitrary URL with headers will not be supported in a future major release.\n\t * Instead, access the objects within the DataStore using entryPoint, and then navigate from there using\n\t * app-specific logic (e.g. retrieving a handle from a DDS, or the entryPoint object could implement a request paradigm itself)\n\t *\n\t * Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.\n\t */\n\trequest(request: IRequest): Promise<IResponse>;\n\n\t/**\n\t * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the \"entryPoint\" pattern. Refer to Removing-IFluidRouter.md\n\t */\n\t// eslint-disable-next-line import/no-deprecated\n\treadonly IFluidRouter: IFluidRouter;\n}\n\n/**\n * A reduced set of functionality of IContainerRuntime that a data store context/data store runtime will need\n * TODO: this should be merged into IFluidDataStoreContext\n * @alpha\n */\nexport interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeBaseEvents> {\n\treadonly logger: ITelemetryBaseLogger;\n\treadonly clientDetails: IClientDetails;\n\n\t/**\n\t * Invokes the given callback and guarantees that all operations generated within the callback will be ordered\n\t * sequentially. Total size of all messages must be less than maxOpSize.\n\t */\n\torderSequentially(callback: () => void): void;\n\n\t/**\n\t * Executes a request against the container runtime\n\t * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the \"entryPoint\" pattern. Refer to Removing-IFluidRouter.md\n\t */\n\trequest(request: IRequest): Promise<IResponse>;\n\n\t/**\n\t * Submits a container runtime level signal to be sent to other clients.\n\t * @param type - Type of the signal.\n\t * @param content - Content of the signal.\n\t */\n\tsubmitSignal(type: string, content: any): void;\n\n\t/**\n\t * @deprecated 0.16 Issue #1537, #3631\n\t */\n\t_createDataStoreWithProps(\n\t\tpkg: string | string[],\n\t\tprops?: any,\n\t\tid?: string,\n\t): Promise<IDataStore>;\n\n\t/**\n\t * Creates a data store and returns an object that exposes a handle to the data store's entryPoint, and also serves\n\t * as the data store's router. The data store is not bound to a container, and in such state is not persisted to\n\t * storage (file). Storing the entryPoint handle (or any other handle inside the data store, e.g. for DDS) into an\n\t * already attached DDS (or non-attached DDS that will eventually get attached to storage) will result in this\n\t * store being attached to storage.\n\t * @param pkg - Package name of the data store factory\n\t */\n\tcreateDataStore(pkg: string | string[]): Promise<IDataStore>;\n\n\t/**\n\t * Creates detached data store context. Only after context.attachRuntime() is called,\n\t * data store initialization is considered complete.\n\t */\n\tcreateDetachedDataStore(pkg: Readonly<string[]>): IFluidDataStoreContextDetached;\n\n\t/**\n\t * Get an absolute url for a provided container-relative request.\n\t * Returns undefined if the container or data store isn't attached to storage.\n\t * @param relativeUrl - A relative request within the container\n\t */\n\tgetAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;\n\n\tuploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandle<ArrayBufferLike>>;\n\n\t/**\n\t * Returns the current quorum.\n\t */\n\tgetQuorum(): IQuorumClients;\n\n\t/**\n\t * Returns the current audience.\n\t */\n\tgetAudience(): IAudience;\n\n\t/**\n\t * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the \"entryPoint\" pattern. Refer to Removing-IFluidRouter.md\n\t */\n\treadonly IFluidHandleContext: IFluidHandleContext;\n}\n\n/**\n * Minimal interface a data store runtime needs to provide for IFluidDataStoreContext to bind to control.\n *\n * Functionality include attach, snapshot, op/signal processing, request routes, expose an entryPoint,\n * and connection state notifications\n * @alpha\n */\nexport interface IFluidDataStoreChannel extends IDisposable {\n\treadonly id: string;\n\n\t/**\n\t * Indicates the attachment state of the channel to a host service.\n\t */\n\treadonly attachState: AttachState;\n\n\treadonly visibilityState: VisibilityState;\n\n\t/**\n\t * Runs through the graph and attaches the bound handles. Then binds this runtime to the container.\n\t * @deprecated This will be removed in favor of {@link IFluidDataStoreChannel.makeVisibleAndAttachGraph}.\n\t */\n\tattachGraph(): void;\n\n\t/**\n\t * Makes the data store channel visible in the container. Also, runs through its graph and attaches all\n\t * bound handles that represent its dependencies in the container's graph.\n\t */\n\tmakeVisibleAndAttachGraph(): void;\n\n\t/**\n\t * Retrieves the summary used as part of the initial summary message\n\t */\n\tgetAttachSummary(telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;\n\n\t/**\n\t * Processes the op.\n\t */\n\tprocess(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;\n\n\t/**\n\t * Processes the signal.\n\t */\n\tprocessSignal(message: any, local: boolean): void;\n\n\t/**\n\t * Generates a summary for the channel.\n\t * Introduced with summarizerNode - will be required in a future release.\n\t * @param fullTree - true to bypass optimizations and force a full summary tree.\n\t * @param trackState - This tells whether we should track state from this summary.\n\t * @param telemetryContext - summary data passed through the layers for telemetry purposes\n\t */\n\tsummarize(\n\t\tfullTree?: boolean,\n\t\ttrackState?: boolean,\n\t\ttelemetryContext?: ITelemetryContext,\n\t): Promise<ISummaryTreeWithStats>;\n\n\t/**\n\t * Returns the data used for garbage collection. This includes a list of GC nodes that represent this context\n\t * including any of its children. Each node has a list of outbound routes to other GC nodes in the document.\n\t * @param fullGC - true to bypass optimizations and force full generation of GC data.\n\t */\n\tgetGCData(fullGC?: boolean): Promise<IGarbageCollectionData>;\n\n\t/**\n\t * After GC has run, called to notify this channel of routes that are used in it.\n\t * @param usedRoutes - The routes that are used in this channel.\n\t */\n\tupdateUsedRoutes(usedRoutes: string[]): void;\n\n\t/**\n\t * Notifies this object about changes in the connection state.\n\t * @param value - New connection state.\n\t * @param clientId - ID of the client. It's old ID when in disconnected state and\n\t * it's new client ID when we are connecting or connected.\n\t */\n\tsetConnectionState(connected: boolean, clientId?: string);\n\n\t/**\n\t * Ask the DDS to resubmit a message. This could be because we reconnected and this message was not acked.\n\t * @param type - The type of the original message.\n\t * @param content - The content of the original message.\n\t * @param localOpMetadata - The local metadata associated with the original message.\n\t */\n\treSubmit(type: string, content: any, localOpMetadata: unknown);\n\n\tapplyStashedOp(content: any): Promise<unknown>;\n\n\t/**\n\t * Revert a local message.\n\t * @param type - The type of the original message.\n\t * @param content - The content of the original message.\n\t * @param localOpMetadata - The local metadata associated with the original message.\n\t */\n\trollback?(type: string, content: any, localOpMetadata: unknown): void;\n\n\t/**\n\t * Exposes a handle to the root object / entryPoint of the component. Use this as the primary way of interacting\n\t * with the component.\n\t */\n\treadonly entryPoint: IFluidHandle<FluidObject>;\n\n\trequest(request: IRequest): Promise<IResponse>;\n\n\t/**\n\t * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the \"entryPoint\" pattern. Refer to Removing-IFluidRouter.md\n\t */\n\t// eslint-disable-next-line import/no-deprecated\n\treadonly IFluidRouter: IFluidRouter;\n}\n\n/**\n * @alpha\n */\nexport type CreateChildSummarizerNodeFn = (\n\tsummarizeInternal: SummarizeInternalFn,\n\tgetGCDataFn: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n\t/**\n\t * @deprecated The functionality to get base GC details has been moved to summarizer node.\n\t */\n\tgetBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,\n) => ISummarizerNodeWithGC;\n\n/**\n * @alpha\n */\nexport interface IFluidDataStoreContextEvents extends IEvent {\n\t(event: \"attaching\" | \"attached\", listener: () => void);\n}\n\n/**\n * Represents the context for the data store. It is used by the data store runtime to\n * get information and call functionality to the container.\n * @alpha\n */\nexport interface IFluidDataStoreContext\n\textends IEventProvider<IFluidDataStoreContextEvents>,\n\t\tPartial<IProvideFluidDataStoreRegistry>,\n\t\tIProvideFluidHandleContext {\n\treadonly id: string;\n\t/**\n\t * A data store created by a client, is a local data store for that client. Also, when a detached container loads\n\t * from a snapshot, all the data stores are treated as local data stores because at that stage the container\n\t * still doesn't exists in storage and so the data store couldn't have been created by any other client.\n\t * Value of this never changes even after the data store is attached.\n\t * As implementer of data store runtime, you can use this property to check that this data store belongs to this\n\t * client and hence implement any scenario based on that.\n\t */\n\treadonly isLocalDataStore: boolean;\n\t/**\n\t * The package path of the data store as per the package factory.\n\t */\n\treadonly packagePath: readonly string[];\n\treadonly options: ILoaderOptions;\n\treadonly clientId: string | undefined;\n\treadonly connected: boolean;\n\treadonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n\treadonly storage: IDocumentStorageService;\n\treadonly baseSnapshot: ISnapshotTree | undefined;\n\treadonly logger: ITelemetryBaseLogger;\n\treadonly clientDetails: IClientDetails;\n\treadonly idCompressor?: IIdCompressor;\n\t/**\n\t * Indicates the attachment state of the data store to a host service.\n\t */\n\treadonly attachState: AttachState;\n\n\treadonly containerRuntime: IContainerRuntimeBase;\n\n\t/**\n\t * @deprecated 0.16 Issue #1635, #3631\n\t */\n\treadonly createProps?: any;\n\n\t/**\n\t * Ambient services provided with the context\n\t */\n\treadonly scope: FluidObject;\n\n\t/**\n\t * Returns the current quorum.\n\t */\n\tgetQuorum(): IQuorumClients;\n\n\t/**\n\t * Returns the current audience.\n\t */\n\tgetAudience(): IAudience;\n\n\t/**\n\t * Invokes the given callback and expects that no ops are submitted\n\t * until execution finishes. If an op is submitted, an error will be raised.\n\t *\n\t * Can be disabled by feature gate `Fluid.ContainerRuntime.DisableOpReentryCheck`\n\t *\n\t * @param callback - the callback to be invoked\n\t */\n\tensureNoDataModelChanges<T>(callback: () => T): T;\n\n\t/**\n\t * Submits the message to be sent to other clients.\n\t * @param type - Type of the message.\n\t * @param content - Content of the message.\n\t * @param localOpMetadata - The local metadata associated with the message. This is kept locally and not sent to\n\t * the server. This will be sent back when this message is received back from the server. This is also sent if\n\t * we are asked to resubmit the message.\n\t */\n\tsubmitMessage(type: string, content: any, localOpMetadata: unknown): void;\n\n\t/**\n\t * Submits the signal to be sent to other clients.\n\t * @param type - Type of the signal.\n\t * @param content - Content of the signal.\n\t * @param targetClientId - When specified, the signal is only sent to the provided client id.\n\t */\n\tsubmitSignal(type: string, content: any, targetClientId?: string): void;\n\n\t/**\n\t * Called to make the data store locally visible in the container. This happens automatically for root data stores\n\t * when they are marked as root. For non-root data stores, this happens when their handle is added to a visible DDS.\n\t */\n\tmakeLocallyVisible(): void;\n\n\t/**\n\t * Call by IFluidDataStoreChannel, indicates that a channel is dirty and needs to be part of the summary.\n\t * @param address - The address of the channel that is dirty.\n\t */\n\tsetChannelDirty(address: string): void;\n\n\t/**\n\t * Get an absolute url to the container based on the provided relativeUrl.\n\t * Returns undefined if the container or data store isn't attached to storage.\n\t * @param relativeUrl - A relative request within the container\n\t */\n\tgetAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;\n\n\tgetCreateChildSummarizerNodeFn(\n\t\t/**\n\t\t * Initial id or path part of this node\n\t\t */\n\t\tid: string,\n\t\t/**\n\t\t * Information needed to create the node.\n\t\t * If it is from a base summary, it will assert that a summary has been seen.\n\t\t * Attach information if it is created from an attach op.\n\t\t * If it is local, it will throw unsupported errors on calls to summarize.\n\t\t */\n\t\tcreateParam: CreateChildSummarizerNodeParam,\n\t): CreateChildSummarizerNodeFn;\n\n\tuploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandle<ArrayBufferLike>>;\n\n\t/**\n\t * @deprecated The functionality to get base GC details has been moved to summarizer node.\n\t *\n\t * Returns the GC details in the initial summary of this data store. This is used to initialize the data store\n\t * and its children with the GC details from the previous summary.\n\t */\n\tgetBaseGCDetails(): Promise<IGarbageCollectionDetailsBase>;\n\n\t/**\n\t * Called when a new outbound reference is added to another node. This is used by garbage collection to identify\n\t * all references added in the system.\n\t * @param srcHandle - The handle of the node that added the reference.\n\t * @param outboundHandle - The handle of the outbound node that is referenced.\n\t */\n\taddedGCOutboundReference?(srcHandle: IFluidHandle, outboundHandle: IFluidHandle): void;\n}\n\n/**\n * @alpha\n */\nexport interface IFluidDataStoreContextDetached extends IFluidDataStoreContext {\n\t/**\n\t * Binds a runtime to the context.\n\t */\n\tattachRuntime(\n\t\tfactory: IProvideFluidDataStoreFactory,\n\t\tdataStoreRuntime: IFluidDataStoreChannel,\n\t): Promise<void>;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"dataStoreContext.js","sourceRoot":"","sources":["../src/dataStoreContext.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAwCH;;;GAGG;AACH,IAAY,SAWX;AAXD,WAAY,SAAS;IACpB;;OAEG;IACH,mDAAS,CAAA;IAET;;;OAGG;IACH,mDAAS,CAAA;AACV,CAAC,EAXW,SAAS,yBAAT,SAAS,QAWpB;AAED;;GAEG;AACH,IAAY,qBAWX;AAXD,WAAY,qBAAqB;IAChC;;;;;;;;OAQG;IACH,mEAAS,CAAA;AACV,CAAC,EAXW,qBAAqB,qCAArB,qBAAqB,QAWhC;AAED;;;;GAIG;AACU,QAAA,eAAe,GAAG;IAC9B;;OAEG;IACH,UAAU,EAAE,YAAY;IAExB;;;;OAIG;IACH,cAAc,EAAE,gBAAgB;IAEhC;;;;;;;;OAQG;IACH,eAAe,EAAE,iBAAiB;CAClC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIEvent,\n\tIEventProvider,\n\tITelemetryBaseLogger,\n\tIDisposable,\n\tIProvideFluidHandleContext,\n\tIFluidHandle,\n\tIRequest,\n\tIResponse,\n\tFluidObject,\n} from \"@fluidframework/core-interfaces\";\nimport {\n\tIAudience,\n\tIDeltaManager,\n\tAttachState,\n\tILoaderOptions,\n} from \"@fluidframework/container-definitions\";\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport {\n\tIClientDetails,\n\tIDocumentMessage,\n\tIQuorumClients,\n\tISequencedDocumentMessage,\n\tISnapshotTree,\n} from \"@fluidframework/protocol-definitions\";\nimport { IIdCompressor } from \"@fluidframework/id-compressor\";\nimport { IProvideFluidDataStoreFactory } from \"./dataStoreFactory\";\nimport { IProvideFluidDataStoreRegistry } from \"./dataStoreRegistry\";\nimport { IGarbageCollectionData, IGarbageCollectionDetailsBase } from \"./garbageCollection\";\nimport { IInboundSignalMessage } from \"./protocol\";\nimport {\n\tCreateChildSummarizerNodeParam,\n\tISummarizerNodeWithGC,\n\tISummaryTreeWithStats,\n\tITelemetryContext,\n\tSummarizeInternalFn,\n} from \"./summary\";\n\n/**\n * Runtime flush mode handling\n * @alpha\n */\nexport enum FlushMode {\n\t/**\n\t * In Immediate flush mode the runtime will immediately send all operations to the driver layer.\n\t */\n\tImmediate,\n\n\t/**\n\t * When in TurnBased flush mode the runtime will buffer operations in the current turn and send them as a single\n\t * batch at the end of the turn. The flush call on the runtime can be used to force send the current batch.\n\t */\n\tTurnBased,\n}\n\n/**\n * @internal\n */\nexport enum FlushModeExperimental {\n\t/**\n\t * When in Async flush mode, the runtime will accumulate all operations across JS turns and send them as a single\n\t * batch when all micro-tasks are complete.\n\t *\n\t * This feature requires a version of the loader which supports reference sequence numbers. If an older version of\n\t * the loader is used, the runtime will fall back on FlushMode.TurnBased.\n\t *\n\t * @experimental - Not ready for use\n\t */\n\tAsync = 2,\n}\n\n/**\n * This tells the visibility state of a Fluid object. It basically tracks whether the object is not visible, visible\n * locally within the container only or visible globally to all clients.\n * @alpha\n */\nexport const VisibilityState = {\n\t/**\n\t * Indicates that the object is not visible. This is the state when an object is first created.\n\t */\n\tNotVisible: \"NotVisible\",\n\n\t/**\n\t * Indicates that the object is visible locally within the container. This is the state when an object is attached\n\t * to the container's graph but the container itself isn't globally visible. The object's state goes from not\n\t * visible to locally visible.\n\t */\n\tLocallyVisible: \"LocallyVisible\",\n\n\t/**\n\t * Indicates that the object is visible globally to all clients. This is the state of an object in 2 scenarios:\n\t *\n\t * 1. It is attached to the container's graph when the container is globally visible. The object's state goes from\n\t * not visible to globally visible.\n\t *\n\t * 2. When a container becomes globally visible, all locally visible objects go from locally visible to globally\n\t * visible.\n\t */\n\tGloballyVisible: \"GloballyVisible\",\n};\n/**\n * @alpha\n */\nexport type VisibilityState = (typeof VisibilityState)[keyof typeof VisibilityState];\n\n/**\n * @alpha\n */\nexport interface IContainerRuntimeBaseEvents extends IEvent {\n\t(event: \"batchBegin\", listener: (op: ISequencedDocumentMessage) => void);\n\t/**\n\t * @param runtimeMessage - tells if op is runtime op. If it is, it was unpacked, i.e. it's type and content\n\t * represent internal container runtime type / content.\n\t */\n\t(event: \"op\", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void);\n\t(event: \"batchEnd\", listener: (error: any, op: ISequencedDocumentMessage) => void);\n\t(event: \"signal\", listener: (message: IInboundSignalMessage, local: boolean) => void);\n}\n\n/**\n * Encapsulates the return codes of the aliasing API.\n *\n * 'Success' - the datastore has been successfully aliased. It can now be used.\n * 'Conflict' - there is already a datastore bound to the provided alias. To acquire it's entry point, use\n * the `IContainerRuntime.getAliasedDataStoreEntryPoint` function. The current datastore should be discarded\n * and will be garbage collected. The current datastore cannot be aliased to a different value.\n * 'AlreadyAliased' - the datastore has already been previously bound to another alias name.\n * @alpha\n */\nexport type AliasResult = \"Success\" | \"Conflict\" | \"AlreadyAliased\";\n\n/**\n * Exposes some functionality/features of a data store:\n * - Handle to the data store's entryPoint\n * - Fluid router for the data store\n * - Can be assigned an alias\n * @alpha\n */\nexport interface IDataStore {\n\t/**\n\t * Attempt to assign an alias to the datastore.\n\t * If the operation succeeds, the datastore can be referenced\n\t * by the supplied alias and will not be garbage collected.\n\t *\n\t * @param alias - Given alias for this datastore.\n\t * @returns A promise with the {@link AliasResult}\n\t */\n\ttrySetAlias(alias: string): Promise<AliasResult>;\n\n\t/**\n\t * Exposes a handle to the root object / entryPoint of the data store. Use this as the primary way of interacting\n\t * with it.\n\t */\n\treadonly entryPoint: IFluidHandle<FluidObject>;\n}\n\n/**\n * A reduced set of functionality of IContainerRuntime that a data store context/data store runtime will need\n * TODO: this should be merged into IFluidDataStoreContext\n * @alpha\n */\nexport interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeBaseEvents> {\n\treadonly logger: ITelemetryBaseLogger;\n\treadonly clientDetails: IClientDetails;\n\n\t/**\n\t * Invokes the given callback and guarantees that all operations generated within the callback will be ordered\n\t * sequentially. Total size of all messages must be less than maxOpSize.\n\t */\n\torderSequentially(callback: () => void): void;\n\n\t/**\n\t * Submits a container runtime level signal to be sent to other clients.\n\t * @param type - Type of the signal.\n\t * @param content - Content of the signal.\n\t */\n\tsubmitSignal(type: string, content: any): void;\n\n\t/**\n\t * @deprecated 0.16 Issue #1537, #3631\n\t */\n\t_createDataStoreWithProps(\n\t\tpkg: string | string[],\n\t\tprops?: any,\n\t\tid?: string,\n\t): Promise<IDataStore>;\n\n\t/**\n\t * Creates a data store and returns an object that exposes a handle to the data store's entryPoint, and also serves\n\t * as the data store's router. The data store is not bound to a container, and in such state is not persisted to\n\t * storage (file). Storing the entryPoint handle (or any other handle inside the data store, e.g. for DDS) into an\n\t * already attached DDS (or non-attached DDS that will eventually get attached to storage) will result in this\n\t * store being attached to storage.\n\t * @param pkg - Package name of the data store factory\n\t */\n\tcreateDataStore(pkg: string | string[]): Promise<IDataStore>;\n\n\t/**\n\t * Creates detached data store context. Only after context.attachRuntime() is called,\n\t * data store initialization is considered complete.\n\t */\n\tcreateDetachedDataStore(pkg: Readonly<string[]>): IFluidDataStoreContextDetached;\n\n\t/**\n\t * Get an absolute url for a provided container-relative request.\n\t * Returns undefined if the container or data store isn't attached to storage.\n\t * @param relativeUrl - A relative request within the container\n\t */\n\tgetAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;\n\n\tuploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandle<ArrayBufferLike>>;\n\n\t/**\n\t * Returns the current quorum.\n\t */\n\tgetQuorum(): IQuorumClients;\n\n\t/**\n\t * Returns the current audience.\n\t */\n\tgetAudience(): IAudience;\n}\n\n/**\n * Minimal interface a data store runtime needs to provide for IFluidDataStoreContext to bind to control.\n *\n * Functionality include attach, snapshot, op/signal processing, request routes, expose an entryPoint,\n * and connection state notifications\n * @alpha\n */\nexport interface IFluidDataStoreChannel extends IDisposable {\n\treadonly id: string;\n\n\t/**\n\t * Indicates the attachment state of the channel to a host service.\n\t */\n\treadonly attachState: AttachState;\n\n\treadonly visibilityState: VisibilityState;\n\n\t/**\n\t * Runs through the graph and attaches the bound handles. Then binds this runtime to the container.\n\t * @deprecated This will be removed in favor of {@link IFluidDataStoreChannel.makeVisibleAndAttachGraph}.\n\t */\n\tattachGraph(): void;\n\n\t/**\n\t * Makes the data store channel visible in the container. Also, runs through its graph and attaches all\n\t * bound handles that represent its dependencies in the container's graph.\n\t */\n\tmakeVisibleAndAttachGraph(): void;\n\n\t/**\n\t * Retrieves the summary used as part of the initial summary message\n\t */\n\tgetAttachSummary(telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;\n\n\t/**\n\t * Processes the op.\n\t */\n\tprocess(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;\n\n\t/**\n\t * Processes the signal.\n\t */\n\tprocessSignal(message: any, local: boolean): void;\n\n\t/**\n\t * Generates a summary for the channel.\n\t * Introduced with summarizerNode - will be required in a future release.\n\t * @param fullTree - true to bypass optimizations and force a full summary tree.\n\t * @param trackState - This tells whether we should track state from this summary.\n\t * @param telemetryContext - summary data passed through the layers for telemetry purposes\n\t */\n\tsummarize(\n\t\tfullTree?: boolean,\n\t\ttrackState?: boolean,\n\t\ttelemetryContext?: ITelemetryContext,\n\t): Promise<ISummaryTreeWithStats>;\n\n\t/**\n\t * Returns the data used for garbage collection. This includes a list of GC nodes that represent this context\n\t * including any of its children. Each node has a list of outbound routes to other GC nodes in the document.\n\t * @param fullGC - true to bypass optimizations and force full generation of GC data.\n\t */\n\tgetGCData(fullGC?: boolean): Promise<IGarbageCollectionData>;\n\n\t/**\n\t * After GC has run, called to notify this channel of routes that are used in it.\n\t * @param usedRoutes - The routes that are used in this channel.\n\t */\n\tupdateUsedRoutes(usedRoutes: string[]): void;\n\n\t/**\n\t * Notifies this object about changes in the connection state.\n\t * @param value - New connection state.\n\t * @param clientId - ID of the client. It's old ID when in disconnected state and\n\t * it's new client ID when we are connecting or connected.\n\t */\n\tsetConnectionState(connected: boolean, clientId?: string);\n\n\t/**\n\t * Ask the DDS to resubmit a message. This could be because we reconnected and this message was not acked.\n\t * @param type - The type of the original message.\n\t * @param content - The content of the original message.\n\t * @param localOpMetadata - The local metadata associated with the original message.\n\t */\n\treSubmit(type: string, content: any, localOpMetadata: unknown);\n\n\tapplyStashedOp(content: any): Promise<unknown>;\n\n\t/**\n\t * Revert a local message.\n\t * @param type - The type of the original message.\n\t * @param content - The content of the original message.\n\t * @param localOpMetadata - The local metadata associated with the original message.\n\t */\n\trollback?(type: string, content: any, localOpMetadata: unknown): void;\n\n\t/**\n\t * Exposes a handle to the root object / entryPoint of the component. Use this as the primary way of interacting\n\t * with the component.\n\t */\n\treadonly entryPoint: IFluidHandle<FluidObject>;\n\n\trequest(request: IRequest): Promise<IResponse>;\n}\n\n/**\n * @alpha\n */\nexport type CreateChildSummarizerNodeFn = (\n\tsummarizeInternal: SummarizeInternalFn,\n\tgetGCDataFn: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n\t/**\n\t * @deprecated The functionality to get base GC details has been moved to summarizer node.\n\t */\n\tgetBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,\n) => ISummarizerNodeWithGC;\n\n/**\n * @alpha\n */\nexport interface IFluidDataStoreContextEvents extends IEvent {\n\t(event: \"attaching\" | \"attached\", listener: () => void);\n}\n\n/**\n * Represents the context for the data store. It is used by the data store runtime to\n * get information and call functionality to the container.\n * @alpha\n */\nexport interface IFluidDataStoreContext\n\textends IEventProvider<IFluidDataStoreContextEvents>,\n\t\tPartial<IProvideFluidDataStoreRegistry>,\n\t\tIProvideFluidHandleContext {\n\treadonly id: string;\n\t/**\n\t * A data store created by a client, is a local data store for that client. Also, when a detached container loads\n\t * from a snapshot, all the data stores are treated as local data stores because at that stage the container\n\t * still doesn't exists in storage and so the data store couldn't have been created by any other client.\n\t * Value of this never changes even after the data store is attached.\n\t * As implementer of data store runtime, you can use this property to check that this data store belongs to this\n\t * client and hence implement any scenario based on that.\n\t */\n\treadonly isLocalDataStore: boolean;\n\t/**\n\t * The package path of the data store as per the package factory.\n\t */\n\treadonly packagePath: readonly string[];\n\treadonly options: ILoaderOptions;\n\treadonly clientId: string | undefined;\n\treadonly connected: boolean;\n\treadonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n\treadonly storage: IDocumentStorageService;\n\treadonly baseSnapshot: ISnapshotTree | undefined;\n\treadonly logger: ITelemetryBaseLogger;\n\treadonly clientDetails: IClientDetails;\n\treadonly idCompressor?: IIdCompressor;\n\t/**\n\t * Indicates the attachment state of the data store to a host service.\n\t */\n\treadonly attachState: AttachState;\n\n\treadonly containerRuntime: IContainerRuntimeBase;\n\n\t/**\n\t * @deprecated 0.16 Issue #1635, #3631\n\t */\n\treadonly createProps?: any;\n\n\t/**\n\t * Ambient services provided with the context\n\t */\n\treadonly scope: FluidObject;\n\n\t/**\n\t * Returns the current quorum.\n\t */\n\tgetQuorum(): IQuorumClients;\n\n\t/**\n\t * Returns the current audience.\n\t */\n\tgetAudience(): IAudience;\n\n\t/**\n\t * Invokes the given callback and expects that no ops are submitted\n\t * until execution finishes. If an op is submitted, an error will be raised.\n\t *\n\t * Can be disabled by feature gate `Fluid.ContainerRuntime.DisableOpReentryCheck`\n\t *\n\t * @param callback - the callback to be invoked\n\t */\n\tensureNoDataModelChanges<T>(callback: () => T): T;\n\n\t/**\n\t * Submits the message to be sent to other clients.\n\t * @param type - Type of the message.\n\t * @param content - Content of the message.\n\t * @param localOpMetadata - The local metadata associated with the message. This is kept locally and not sent to\n\t * the server. This will be sent back when this message is received back from the server. This is also sent if\n\t * we are asked to resubmit the message.\n\t */\n\tsubmitMessage(type: string, content: any, localOpMetadata: unknown): void;\n\n\t/**\n\t * Submits the signal to be sent to other clients.\n\t * @param type - Type of the signal.\n\t * @param content - Content of the signal.\n\t * @param targetClientId - When specified, the signal is only sent to the provided client id.\n\t */\n\tsubmitSignal(type: string, content: any, targetClientId?: string): void;\n\n\t/**\n\t * Called to make the data store locally visible in the container. This happens automatically for root data stores\n\t * when they are marked as root. For non-root data stores, this happens when their handle is added to a visible DDS.\n\t */\n\tmakeLocallyVisible(): void;\n\n\t/**\n\t * Call by IFluidDataStoreChannel, indicates that a channel is dirty and needs to be part of the summary.\n\t * @param address - The address of the channel that is dirty.\n\t */\n\tsetChannelDirty(address: string): void;\n\n\t/**\n\t * Get an absolute url to the container based on the provided relativeUrl.\n\t * Returns undefined if the container or data store isn't attached to storage.\n\t * @param relativeUrl - A relative request within the container\n\t */\n\tgetAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;\n\n\tgetCreateChildSummarizerNodeFn(\n\t\t/**\n\t\t * Initial id or path part of this node\n\t\t */\n\t\tid: string,\n\t\t/**\n\t\t * Information needed to create the node.\n\t\t * If it is from a base summary, it will assert that a summary has been seen.\n\t\t * Attach information if it is created from an attach op.\n\t\t * If it is local, it will throw unsupported errors on calls to summarize.\n\t\t */\n\t\tcreateParam: CreateChildSummarizerNodeParam,\n\t): CreateChildSummarizerNodeFn;\n\n\tuploadBlob(blob: ArrayBufferLike, signal?: AbortSignal): Promise<IFluidHandle<ArrayBufferLike>>;\n\n\t/**\n\t * @deprecated The functionality to get base GC details has been moved to summarizer node.\n\t *\n\t * Returns the GC details in the initial summary of this data store. This is used to initialize the data store\n\t * and its children with the GC details from the previous summary.\n\t */\n\tgetBaseGCDetails(): Promise<IGarbageCollectionDetailsBase>;\n\n\t/**\n\t * Called when a new outbound reference is added to another node. This is used by garbage collection to identify\n\t * all references added in the system.\n\t * @param srcHandle - The handle of the node that added the reference.\n\t * @param outboundHandle - The handle of the outbound node that is referenced.\n\t */\n\taddedGCOutboundReference?(srcHandle: IFluidHandle, outboundHandle: IFluidHandle): void;\n}\n\n/**\n * @alpha\n */\nexport interface IFluidDataStoreContextDetached extends IFluidDataStoreContext {\n\t/**\n\t * Binds a runtime to the context.\n\t */\n\tattachRuntime(\n\t\tfactory: IProvideFluidDataStoreFactory,\n\t\tdataStoreRuntime: IFluidDataStoreChannel,\n\t): Promise<void>;\n}\n"]}
|
package/dist/index.d.ts
CHANGED
|
@@ -53,9 +53,5 @@ SessionSpaceCompressedId,
|
|
|
53
53
|
/**
|
|
54
54
|
* @deprecated Import from `@fluidframework/id-compressor` instead.
|
|
55
55
|
*/
|
|
56
|
-
StableId,
|
|
57
|
-
/**
|
|
58
|
-
* @deprecated Import from `@fluidframework/id-compressor` instead.
|
|
59
|
-
*/
|
|
60
|
-
initialClusterCapacity, } from "@fluidframework/id-compressor";
|
|
56
|
+
StableId, } from "@fluidframework/id-compressor";
|
|
61
57
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,eAAe,EACf,cAAc,EACd,sBAAsB,EACtB,mBAAmB,EACnB,gBAAgB,GAChB,MAAM,eAAe,CAAC;AACvB,OAAO,EACN,WAAW,EACX,2BAA2B,EAC3B,SAAS,EACT,qBAAqB,EACrB,qBAAqB,EACrB,2BAA2B,EAC3B,UAAU,EACV,sBAAsB,EACtB,sBAAsB,EACtB,8BAA8B,EAC9B,4BAA4B,EAC5B,eAAe,GACf,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,sBAAsB,EAAE,6BAA6B,EAAE,MAAM,oBAAoB,CAAC;AAC3F,OAAO,EACN,2BAA2B,EAC3B,uBAAuB,EACvB,8BAA8B,EAC9B,kCAAkC,EAClC,gCAAgC,GAChC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACN,YAAY,EACZ,gBAAgB,EAChB,kBAAkB,EAClB,SAAS,EACT,sBAAsB,EACtB,6BAA6B,GAC7B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACN,cAAc,EACd,SAAS,EACT,qBAAqB,EACrB,oBAAoB,EACpB,eAAe,GACf,MAAM,YAAY,CAAC;AACpB,OAAO,EACN,qBAAqB,EACrB,gBAAgB,EAChB,8BAA8B,EAC9B,0BAA0B,EAC1B,sCAAsC,EACtC,wBAAwB,EACxB,gBAAgB,EAChB,eAAe,EACf,qBAAqB,EACrB,2BAA2B,EAC3B,qBAAqB,EACrB,aAAa,EACb,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,yBAAyB,GACzB,MAAM,WAAW,CAAC;AAInB,OAAO;AACN;;GAEG;AACH,YAAY;AACZ;;GAEG;AACH,aAAa;AACb;;GAEG;AACH,iBAAiB;AACjB;;GAEG;AACH,eAAe;AACf;;GAEG;AACH,mBAAmB;AACnB;;GAEG;AACH,sBAAsB;AACtB;;GAEG;AACH,mCAAmC;AACnC;;GAEG;AACH,wCAAwC;AACxC;;GAEG;AACH,SAAS;AACT;;GAEG;AACH,wBAAwB;AACxB;;GAEG;AACH,QAAQ
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,eAAe,EACf,cAAc,EACd,sBAAsB,EACtB,mBAAmB,EACnB,gBAAgB,GAChB,MAAM,eAAe,CAAC;AACvB,OAAO,EACN,WAAW,EACX,2BAA2B,EAC3B,SAAS,EACT,qBAAqB,EACrB,qBAAqB,EACrB,2BAA2B,EAC3B,UAAU,EACV,sBAAsB,EACtB,sBAAsB,EACtB,8BAA8B,EAC9B,4BAA4B,EAC5B,eAAe,GACf,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,sBAAsB,EAAE,6BAA6B,EAAE,MAAM,oBAAoB,CAAC;AAC3F,OAAO,EACN,2BAA2B,EAC3B,uBAAuB,EACvB,8BAA8B,EAC9B,kCAAkC,EAClC,gCAAgC,GAChC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACN,YAAY,EACZ,gBAAgB,EAChB,kBAAkB,EAClB,SAAS,EACT,sBAAsB,EACtB,6BAA6B,GAC7B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACN,cAAc,EACd,SAAS,EACT,qBAAqB,EACrB,oBAAoB,EACpB,eAAe,GACf,MAAM,YAAY,CAAC;AACpB,OAAO,EACN,qBAAqB,EACrB,gBAAgB,EAChB,8BAA8B,EAC9B,0BAA0B,EAC1B,sCAAsC,EACtC,wBAAwB,EACxB,gBAAgB,EAChB,eAAe,EACf,qBAAqB,EACrB,2BAA2B,EAC3B,qBAAqB,EACrB,aAAa,EACb,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,yBAAyB,GACzB,MAAM,WAAW,CAAC;AAInB,OAAO;AACN;;GAEG;AACH,YAAY;AACZ;;GAEG;AACH,aAAa;AACb;;GAEG;AACH,iBAAiB;AACjB;;GAEG;AACH,eAAe;AACf;;GAEG;AACH,mBAAmB;AACnB;;GAEG;AACH,sBAAsB;AACtB;;GAEG;AACH,mCAAmC;AACnC;;GAEG;AACH,wCAAwC;AACxC;;GAEG;AACH,SAAS;AACT;;GAEG;AACH,wBAAwB;AACxB;;GAEG;AACH,QAAQ,GACR,MAAM,+BAA+B,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Licensed under the MIT License.
|
|
5
5
|
*/
|
|
6
6
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
-
exports.
|
|
7
|
+
exports.IdCompressor = exports.totalBlobSizePropertyName = exports.CreateSummarizerNodeSource = exports.channelsTreeName = exports.blobCountPropertyName = exports.gcTreeKey = exports.gcTombstoneBlobKey = exports.gcDeletedBlobKey = exports.gcBlobPrefix = exports.IFluidDataStoreRegistry = exports.IFluidDataStoreFactory = exports.VisibilityState = exports.FlushModeExperimental = exports.FlushMode = void 0;
|
|
8
8
|
var dataStoreContext_1 = require("./dataStoreContext");
|
|
9
9
|
Object.defineProperty(exports, "FlushMode", { enumerable: true, get: function () { return dataStoreContext_1.FlushMode; } });
|
|
10
10
|
Object.defineProperty(exports, "FlushModeExperimental", { enumerable: true, get: function () { return dataStoreContext_1.FlushModeExperimental; } });
|
|
@@ -30,8 +30,4 @@ var id_compressor_1 = require("@fluidframework/id-compressor");
|
|
|
30
30
|
* @deprecated Import from `@fluidframework/id-compressor` instead.
|
|
31
31
|
*/
|
|
32
32
|
Object.defineProperty(exports, "IdCompressor", { enumerable: true, get: function () { return id_compressor_1.IdCompressor; } });
|
|
33
|
-
/**
|
|
34
|
-
* @deprecated Import from `@fluidframework/id-compressor` instead.
|
|
35
|
-
*/
|
|
36
|
-
Object.defineProperty(exports, "initialClusterCapacity", { enumerable: true, get: function () { return id_compressor_1.initialClusterCapacity; } });
|
|
37
33
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AASH,uDAa4B;AAV3B,6GAAA,SAAS,OAAA;AACT,yHAAA,qBAAqB,OAAA;AAQrB,mHAAA,eAAe,OAAA;AAEhB,uDAA2F;AAAlF,0HAAA,sBAAsB,OAAA;AAC/B,yDAM6B;AAJ5B,4HAAA,uBAAuB,OAAA;AAKxB,yDAO6B;AAN5B,iHAAA,YAAY,OAAA;AACZ,qHAAA,gBAAgB,OAAA;AAChB,uHAAA,kBAAkB,OAAA;AAClB,8GAAA,SAAS,OAAA;AAWV,qCAiBmB;AAhBlB,gHAAA,qBAAqB,OAAA;AACrB,2GAAA,gBAAgB,OAAA;AAEhB,qHAAA,0BAA0B,OAAA;AAY1B,oHAAA,yBAAyB,OAAA;AAG1B,0CAA0C;AAC1C,iCAAiC;AACjC,+
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AASH,uDAa4B;AAV3B,6GAAA,SAAS,OAAA;AACT,yHAAA,qBAAqB,OAAA;AAQrB,mHAAA,eAAe,OAAA;AAEhB,uDAA2F;AAAlF,0HAAA,sBAAsB,OAAA;AAC/B,yDAM6B;AAJ5B,4HAAA,uBAAuB,OAAA;AAKxB,yDAO6B;AAN5B,iHAAA,YAAY,OAAA;AACZ,qHAAA,gBAAgB,OAAA;AAChB,uHAAA,kBAAkB,OAAA;AAClB,8GAAA,SAAS,OAAA;AAWV,qCAiBmB;AAhBlB,gHAAA,qBAAqB,OAAA;AACrB,2GAAA,gBAAgB,OAAA;AAEhB,qHAAA,0BAA0B,OAAA;AAY1B,oHAAA,yBAAyB,OAAA;AAG1B,0CAA0C;AAC1C,iCAAiC;AACjC,+DA6CuC;AA5CtC;;GAEG;AACH,6GAAA,YAAY,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tAttributionInfo,\n\tAttributionKey,\n\tDetachedAttributionKey,\n\tLocalAttributionKey,\n\tOpAttributionKey,\n} from \"./attribution\";\nexport {\n\tAliasResult,\n\tCreateChildSummarizerNodeFn,\n\tFlushMode,\n\tFlushModeExperimental,\n\tIContainerRuntimeBase,\n\tIContainerRuntimeBaseEvents,\n\tIDataStore,\n\tIFluidDataStoreChannel,\n\tIFluidDataStoreContext,\n\tIFluidDataStoreContextDetached,\n\tIFluidDataStoreContextEvents,\n\tVisibilityState,\n} from \"./dataStoreContext\";\nexport { IFluidDataStoreFactory, IProvideFluidDataStoreFactory } from \"./dataStoreFactory\";\nexport {\n\tFluidDataStoreRegistryEntry,\n\tIFluidDataStoreRegistry,\n\tIProvideFluidDataStoreRegistry,\n\tNamedFluidDataStoreRegistryEntries,\n\tNamedFluidDataStoreRegistryEntry,\n} from \"./dataStoreRegistry\";\nexport {\n\tgcBlobPrefix,\n\tgcDeletedBlobKey,\n\tgcTombstoneBlobKey,\n\tgcTreeKey,\n\tIGarbageCollectionData,\n\tIGarbageCollectionDetailsBase,\n} from \"./garbageCollection\";\nexport {\n\tIAttachMessage,\n\tIEnvelope,\n\tIInboundSignalMessage,\n\tInboundAttachMessage,\n\tISignalEnvelope,\n} from \"./protocol\";\nexport {\n\tblobCountPropertyName,\n\tchannelsTreeName,\n\tCreateChildSummarizerNodeParam,\n\tCreateSummarizerNodeSource,\n\tIExperimentalIncrementalSummaryContext,\n\tISummarizeInternalResult,\n\tISummarizeResult,\n\tISummarizerNode,\n\tISummarizerNodeConfig,\n\tISummarizerNodeConfigWithGC,\n\tISummarizerNodeWithGC,\n\tISummaryStats,\n\tISummaryTreeWithStats,\n\tITelemetryContext,\n\tSummarizeInternalFn,\n\ttotalBlobSizePropertyName,\n} from \"./summary\";\n\n// Re-exports for backwards compatibility.\n// Will be removed in the future.\nexport {\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tIdCompressor,\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tIIdCompressor,\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tIIdCompressorCore,\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tIdCreationRange,\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tOpSpaceCompressedId,\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tSerializedIdCompressor,\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tSerializedIdCompressorWithNoSession,\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tSerializedIdCompressorWithOngoingSession,\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tSessionId,\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tSessionSpaceCompressedId,\n\t/**\n\t * @deprecated Import from `@fluidframework/id-compressor` instead.\n\t */\n\tStableId,\n} from \"@fluidframework/id-compressor\";\n"]}
|
|
@@ -11,12 +11,9 @@ import { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
|
11
11
|
import { IEvent } from '@fluidframework/core-interfaces';
|
|
12
12
|
import { IEventProvider } from '@fluidframework/core-interfaces';
|
|
13
13
|
import { IFluidHandle } from '@fluidframework/core-interfaces';
|
|
14
|
-
import { IFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
15
|
-
import { IFluidRouter } from '@fluidframework/core-interfaces';
|
|
16
14
|
import { IIdCompressor } from '@fluidframework/id-compressor';
|
|
17
15
|
import { IIdCompressorCore } from '@fluidframework/id-compressor';
|
|
18
16
|
import { ILoaderOptions } from '@fluidframework/container-definitions';
|
|
19
|
-
import { initialClusterCapacity } from '@fluidframework/id-compressor';
|
|
20
17
|
import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
21
18
|
import { IQuorumClients } from '@fluidframework/protocol-definitions';
|
|
22
19
|
import { IRequest } from '@fluidframework/core-interfaces';
|
|
@@ -163,11 +160,6 @@ export declare interface IContainerRuntimeBase extends IEventProvider<IContainer
|
|
|
163
160
|
* sequentially. Total size of all messages must be less than maxOpSize.
|
|
164
161
|
*/
|
|
165
162
|
orderSequentially(callback: () => void): void;
|
|
166
|
-
/**
|
|
167
|
-
* Executes a request against the container runtime
|
|
168
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
169
|
-
*/
|
|
170
|
-
request(request: IRequest): Promise<IResponse>;
|
|
171
163
|
/**
|
|
172
164
|
* Submits a container runtime level signal to be sent to other clients.
|
|
173
165
|
* @param type - Type of the signal.
|
|
@@ -207,10 +199,6 @@ export declare interface IContainerRuntimeBase extends IEventProvider<IContainer
|
|
|
207
199
|
* Returns the current audience.
|
|
208
200
|
*/
|
|
209
201
|
getAudience(): IAudience;
|
|
210
|
-
/**
|
|
211
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
212
|
-
*/
|
|
213
|
-
readonly IFluidHandleContext: IFluidHandleContext;
|
|
214
202
|
}
|
|
215
203
|
|
|
216
204
|
/**
|
|
@@ -249,37 +237,6 @@ export declare interface IDataStore {
|
|
|
249
237
|
* with it.
|
|
250
238
|
*/
|
|
251
239
|
readonly entryPoint: IFluidHandle<FluidObject>;
|
|
252
|
-
/**
|
|
253
|
-
* @deprecated Requesting will not be supported in a future major release.
|
|
254
|
-
* Instead, access the objects within the DataStore using entryPoint, and then navigate from there using
|
|
255
|
-
* app-specific logic (e.g. retrieving a handle from a DDS, or the entryPoint object could implement a request paradigm itself)
|
|
256
|
-
*
|
|
257
|
-
* IMPORTANT: This overload is provided for back-compat where IDataStore.request(\{ url: "/" \}) is already implemented and used.
|
|
258
|
-
* The functionality it can provide (if the DataStore implementation is built for it) is redundant with @see {@link IDataStore.entryPoint}.
|
|
259
|
-
*
|
|
260
|
-
* Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.
|
|
261
|
-
*
|
|
262
|
-
* @param request - Only requesting \{ url: "/" \} is supported, requesting arbitrary URLs is deprecated.
|
|
263
|
-
*/
|
|
264
|
-
request(request: {
|
|
265
|
-
url: "/";
|
|
266
|
-
headers?: undefined;
|
|
267
|
-
}): Promise<IResponse>;
|
|
268
|
-
/**
|
|
269
|
-
* Issue a request against the DataStore for a resource within it.
|
|
270
|
-
* @param request - The request to be issued against the DataStore
|
|
271
|
-
*
|
|
272
|
-
* @deprecated Requesting an arbitrary URL with headers will not be supported in a future major release.
|
|
273
|
-
* Instead, access the objects within the DataStore using entryPoint, and then navigate from there using
|
|
274
|
-
* app-specific logic (e.g. retrieving a handle from a DDS, or the entryPoint object could implement a request paradigm itself)
|
|
275
|
-
*
|
|
276
|
-
* Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.
|
|
277
|
-
*/
|
|
278
|
-
request(request: IRequest): Promise<IResponse>;
|
|
279
|
-
/**
|
|
280
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
281
|
-
*/
|
|
282
|
-
readonly IFluidRouter: IFluidRouter;
|
|
283
240
|
}
|
|
284
241
|
|
|
285
242
|
export { IdCompressor }
|
|
@@ -398,10 +355,6 @@ export declare interface IFluidDataStoreChannel extends IDisposable {
|
|
|
398
355
|
*/
|
|
399
356
|
readonly entryPoint: IFluidHandle<FluidObject>;
|
|
400
357
|
request(request: IRequest): Promise<IResponse>;
|
|
401
|
-
/**
|
|
402
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
403
|
-
*/
|
|
404
|
-
readonly IFluidRouter: IFluidRouter;
|
|
405
358
|
}
|
|
406
359
|
|
|
407
360
|
/**
|
|
@@ -621,8 +574,6 @@ export declare interface IInboundSignalMessage extends ISignalMessage {
|
|
|
621
574
|
|
|
622
575
|
/* Excluded from this release type: InboundAttachMessage */
|
|
623
576
|
|
|
624
|
-
/* Excluded from this release type: initialClusterCapacity */
|
|
625
|
-
|
|
626
577
|
/**
|
|
627
578
|
* @alpha
|
|
628
579
|
*/
|
|
@@ -11,12 +11,9 @@ import { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
|
11
11
|
import { IEvent } from '@fluidframework/core-interfaces';
|
|
12
12
|
import { IEventProvider } from '@fluidframework/core-interfaces';
|
|
13
13
|
import { IFluidHandle } from '@fluidframework/core-interfaces';
|
|
14
|
-
import { IFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
15
|
-
import { IFluidRouter } from '@fluidframework/core-interfaces';
|
|
16
14
|
import { IIdCompressor } from '@fluidframework/id-compressor';
|
|
17
15
|
import { IIdCompressorCore } from '@fluidframework/id-compressor';
|
|
18
16
|
import { ILoaderOptions } from '@fluidframework/container-definitions';
|
|
19
|
-
import { initialClusterCapacity } from '@fluidframework/id-compressor';
|
|
20
17
|
import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
21
18
|
import { IQuorumClients } from '@fluidframework/protocol-definitions';
|
|
22
19
|
import { IRequest } from '@fluidframework/core-interfaces';
|
|
@@ -116,10 +113,6 @@ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
|
|
|
116
113
|
|
|
117
114
|
/* Excluded from this release type: IFluidHandle */
|
|
118
115
|
|
|
119
|
-
/* Excluded from this release type: IFluidHandleContext */
|
|
120
|
-
|
|
121
|
-
/* Excluded from this release type: IFluidRouter */
|
|
122
|
-
|
|
123
116
|
/* Excluded from this release type: IGarbageCollectionData */
|
|
124
117
|
|
|
125
118
|
/* Excluded from this release type: IGarbageCollectionDetailsBase */
|
|
@@ -134,8 +127,6 @@ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
|
|
|
134
127
|
|
|
135
128
|
/* Excluded from this release type: InboundAttachMessage */
|
|
136
129
|
|
|
137
|
-
/* Excluded from this release type: initialClusterCapacity */
|
|
138
|
-
|
|
139
130
|
/* Excluded from this release type: IProvideFluidDataStoreFactory */
|
|
140
131
|
|
|
141
132
|
/* Excluded from this release type: IProvideFluidDataStoreRegistry */
|
|
@@ -11,12 +11,9 @@ import { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
|
11
11
|
import { IEvent } from '@fluidframework/core-interfaces';
|
|
12
12
|
import { IEventProvider } from '@fluidframework/core-interfaces';
|
|
13
13
|
import { IFluidHandle } from '@fluidframework/core-interfaces';
|
|
14
|
-
import { IFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
15
|
-
import { IFluidRouter } from '@fluidframework/core-interfaces';
|
|
16
14
|
import { IIdCompressor } from '@fluidframework/id-compressor';
|
|
17
15
|
import { IIdCompressorCore } from '@fluidframework/id-compressor';
|
|
18
16
|
import { ILoaderOptions } from '@fluidframework/container-definitions';
|
|
19
|
-
import { initialClusterCapacity } from '@fluidframework/id-compressor';
|
|
20
17
|
import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
21
18
|
import { IQuorumClients } from '@fluidframework/protocol-definitions';
|
|
22
19
|
import { IRequest } from '@fluidframework/core-interfaces';
|
|
@@ -116,10 +113,6 @@ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
|
|
|
116
113
|
|
|
117
114
|
/* Excluded from this release type: IFluidHandle */
|
|
118
115
|
|
|
119
|
-
/* Excluded from this release type: IFluidHandleContext */
|
|
120
|
-
|
|
121
|
-
/* Excluded from this release type: IFluidRouter */
|
|
122
|
-
|
|
123
116
|
/* Excluded from this release type: IGarbageCollectionData */
|
|
124
117
|
|
|
125
118
|
/* Excluded from this release type: IGarbageCollectionDetailsBase */
|
|
@@ -134,8 +127,6 @@ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
|
|
|
134
127
|
|
|
135
128
|
/* Excluded from this release type: InboundAttachMessage */
|
|
136
129
|
|
|
137
|
-
/* Excluded from this release type: initialClusterCapacity */
|
|
138
|
-
|
|
139
130
|
/* Excluded from this release type: IProvideFluidDataStoreFactory */
|
|
140
131
|
|
|
141
132
|
/* Excluded from this release type: IProvideFluidDataStoreRegistry */
|
|
@@ -11,12 +11,9 @@ import { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
|
11
11
|
import { IEvent } from '@fluidframework/core-interfaces';
|
|
12
12
|
import { IEventProvider } from '@fluidframework/core-interfaces';
|
|
13
13
|
import { IFluidHandle } from '@fluidframework/core-interfaces';
|
|
14
|
-
import { IFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
15
|
-
import { IFluidRouter } from '@fluidframework/core-interfaces';
|
|
16
14
|
import { IIdCompressor } from '@fluidframework/id-compressor';
|
|
17
15
|
import { IIdCompressorCore } from '@fluidframework/id-compressor';
|
|
18
16
|
import { ILoaderOptions } from '@fluidframework/container-definitions';
|
|
19
|
-
import { initialClusterCapacity } from '@fluidframework/id-compressor';
|
|
20
17
|
import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
21
18
|
import { IQuorumClients } from '@fluidframework/protocol-definitions';
|
|
22
19
|
import { IRequest } from '@fluidframework/core-interfaces';
|
|
@@ -234,11 +231,6 @@ export declare interface IContainerRuntimeBase extends IEventProvider<IContainer
|
|
|
234
231
|
* sequentially. Total size of all messages must be less than maxOpSize.
|
|
235
232
|
*/
|
|
236
233
|
orderSequentially(callback: () => void): void;
|
|
237
|
-
/**
|
|
238
|
-
* Executes a request against the container runtime
|
|
239
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
240
|
-
*/
|
|
241
|
-
request(request: IRequest): Promise<IResponse>;
|
|
242
234
|
/**
|
|
243
235
|
* Submits a container runtime level signal to be sent to other clients.
|
|
244
236
|
* @param type - Type of the signal.
|
|
@@ -278,10 +270,6 @@ export declare interface IContainerRuntimeBase extends IEventProvider<IContainer
|
|
|
278
270
|
* Returns the current audience.
|
|
279
271
|
*/
|
|
280
272
|
getAudience(): IAudience;
|
|
281
|
-
/**
|
|
282
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
283
|
-
*/
|
|
284
|
-
readonly IFluidHandleContext: IFluidHandleContext;
|
|
285
273
|
}
|
|
286
274
|
|
|
287
275
|
/**
|
|
@@ -320,37 +308,6 @@ export declare interface IDataStore {
|
|
|
320
308
|
* with it.
|
|
321
309
|
*/
|
|
322
310
|
readonly entryPoint: IFluidHandle<FluidObject>;
|
|
323
|
-
/**
|
|
324
|
-
* @deprecated Requesting will not be supported in a future major release.
|
|
325
|
-
* Instead, access the objects within the DataStore using entryPoint, and then navigate from there using
|
|
326
|
-
* app-specific logic (e.g. retrieving a handle from a DDS, or the entryPoint object could implement a request paradigm itself)
|
|
327
|
-
*
|
|
328
|
-
* IMPORTANT: This overload is provided for back-compat where IDataStore.request(\{ url: "/" \}) is already implemented and used.
|
|
329
|
-
* The functionality it can provide (if the DataStore implementation is built for it) is redundant with @see {@link IDataStore.entryPoint}.
|
|
330
|
-
*
|
|
331
|
-
* Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.
|
|
332
|
-
*
|
|
333
|
-
* @param request - Only requesting \{ url: "/" \} is supported, requesting arbitrary URLs is deprecated.
|
|
334
|
-
*/
|
|
335
|
-
request(request: {
|
|
336
|
-
url: "/";
|
|
337
|
-
headers?: undefined;
|
|
338
|
-
}): Promise<IResponse>;
|
|
339
|
-
/**
|
|
340
|
-
* Issue a request against the DataStore for a resource within it.
|
|
341
|
-
* @param request - The request to be issued against the DataStore
|
|
342
|
-
*
|
|
343
|
-
* @deprecated Requesting an arbitrary URL with headers will not be supported in a future major release.
|
|
344
|
-
* Instead, access the objects within the DataStore using entryPoint, and then navigate from there using
|
|
345
|
-
* app-specific logic (e.g. retrieving a handle from a DDS, or the entryPoint object could implement a request paradigm itself)
|
|
346
|
-
*
|
|
347
|
-
* Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.
|
|
348
|
-
*/
|
|
349
|
-
request(request: IRequest): Promise<IResponse>;
|
|
350
|
-
/**
|
|
351
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
352
|
-
*/
|
|
353
|
-
readonly IFluidRouter: IFluidRouter;
|
|
354
311
|
}
|
|
355
312
|
|
|
356
313
|
export { IdCompressor }
|
|
@@ -482,10 +439,6 @@ export declare interface IFluidDataStoreChannel extends IDisposable {
|
|
|
482
439
|
*/
|
|
483
440
|
readonly entryPoint: IFluidHandle<FluidObject>;
|
|
484
441
|
request(request: IRequest): Promise<IResponse>;
|
|
485
|
-
/**
|
|
486
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
487
|
-
*/
|
|
488
|
-
readonly IFluidRouter: IFluidRouter;
|
|
489
442
|
}
|
|
490
443
|
|
|
491
444
|
/**
|
|
@@ -714,8 +667,6 @@ export declare type InboundAttachMessage = Omit<IAttachMessage, "snapshot"> & {
|
|
|
714
667
|
snapshot: IAttachMessage["snapshot"] | null;
|
|
715
668
|
};
|
|
716
669
|
|
|
717
|
-
export { initialClusterCapacity }
|
|
718
|
-
|
|
719
670
|
/**
|
|
720
671
|
* @alpha
|
|
721
672
|
*/
|
|
@@ -11,12 +11,9 @@ import { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
|
11
11
|
import { IEvent } from '@fluidframework/core-interfaces';
|
|
12
12
|
import { IEventProvider } from '@fluidframework/core-interfaces';
|
|
13
13
|
import { IFluidHandle } from '@fluidframework/core-interfaces';
|
|
14
|
-
import { IFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
15
|
-
import { IFluidRouter } from '@fluidframework/core-interfaces';
|
|
16
14
|
import { IIdCompressor } from '@fluidframework/id-compressor';
|
|
17
15
|
import { IIdCompressorCore } from '@fluidframework/id-compressor';
|
|
18
16
|
import { ILoaderOptions } from '@fluidframework/container-definitions';
|
|
19
|
-
import { initialClusterCapacity } from '@fluidframework/id-compressor';
|
|
20
17
|
import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
21
18
|
import { IQuorumClients } from '@fluidframework/protocol-definitions';
|
|
22
19
|
import { IRequest } from '@fluidframework/core-interfaces';
|
|
@@ -163,11 +160,6 @@ export declare interface IContainerRuntimeBase extends IEventProvider<IContainer
|
|
|
163
160
|
* sequentially. Total size of all messages must be less than maxOpSize.
|
|
164
161
|
*/
|
|
165
162
|
orderSequentially(callback: () => void): void;
|
|
166
|
-
/**
|
|
167
|
-
* Executes a request against the container runtime
|
|
168
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
169
|
-
*/
|
|
170
|
-
request(request: IRequest): Promise<IResponse>;
|
|
171
163
|
/**
|
|
172
164
|
* Submits a container runtime level signal to be sent to other clients.
|
|
173
165
|
* @param type - Type of the signal.
|
|
@@ -207,10 +199,6 @@ export declare interface IContainerRuntimeBase extends IEventProvider<IContainer
|
|
|
207
199
|
* Returns the current audience.
|
|
208
200
|
*/
|
|
209
201
|
getAudience(): IAudience;
|
|
210
|
-
/**
|
|
211
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
212
|
-
*/
|
|
213
|
-
readonly IFluidHandleContext: IFluidHandleContext;
|
|
214
202
|
}
|
|
215
203
|
|
|
216
204
|
/**
|
|
@@ -249,37 +237,6 @@ export declare interface IDataStore {
|
|
|
249
237
|
* with it.
|
|
250
238
|
*/
|
|
251
239
|
readonly entryPoint: IFluidHandle<FluidObject>;
|
|
252
|
-
/**
|
|
253
|
-
* @deprecated Requesting will not be supported in a future major release.
|
|
254
|
-
* Instead, access the objects within the DataStore using entryPoint, and then navigate from there using
|
|
255
|
-
* app-specific logic (e.g. retrieving a handle from a DDS, or the entryPoint object could implement a request paradigm itself)
|
|
256
|
-
*
|
|
257
|
-
* IMPORTANT: This overload is provided for back-compat where IDataStore.request(\{ url: "/" \}) is already implemented and used.
|
|
258
|
-
* The functionality it can provide (if the DataStore implementation is built for it) is redundant with @see {@link IDataStore.entryPoint}.
|
|
259
|
-
*
|
|
260
|
-
* Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.
|
|
261
|
-
*
|
|
262
|
-
* @param request - Only requesting \{ url: "/" \} is supported, requesting arbitrary URLs is deprecated.
|
|
263
|
-
*/
|
|
264
|
-
request(request: {
|
|
265
|
-
url: "/";
|
|
266
|
-
headers?: undefined;
|
|
267
|
-
}): Promise<IResponse>;
|
|
268
|
-
/**
|
|
269
|
-
* Issue a request against the DataStore for a resource within it.
|
|
270
|
-
* @param request - The request to be issued against the DataStore
|
|
271
|
-
*
|
|
272
|
-
* @deprecated Requesting an arbitrary URL with headers will not be supported in a future major release.
|
|
273
|
-
* Instead, access the objects within the DataStore using entryPoint, and then navigate from there using
|
|
274
|
-
* app-specific logic (e.g. retrieving a handle from a DDS, or the entryPoint object could implement a request paradigm itself)
|
|
275
|
-
*
|
|
276
|
-
* Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.
|
|
277
|
-
*/
|
|
278
|
-
request(request: IRequest): Promise<IResponse>;
|
|
279
|
-
/**
|
|
280
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
281
|
-
*/
|
|
282
|
-
readonly IFluidRouter: IFluidRouter;
|
|
283
240
|
}
|
|
284
241
|
|
|
285
242
|
export { IdCompressor }
|
|
@@ -398,10 +355,6 @@ export declare interface IFluidDataStoreChannel extends IDisposable {
|
|
|
398
355
|
*/
|
|
399
356
|
readonly entryPoint: IFluidHandle<FluidObject>;
|
|
400
357
|
request(request: IRequest): Promise<IResponse>;
|
|
401
|
-
/**
|
|
402
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
403
|
-
*/
|
|
404
|
-
readonly IFluidRouter: IFluidRouter;
|
|
405
358
|
}
|
|
406
359
|
|
|
407
360
|
/**
|
|
@@ -621,8 +574,6 @@ export declare interface IInboundSignalMessage extends ISignalMessage {
|
|
|
621
574
|
|
|
622
575
|
/* Excluded from this release type: InboundAttachMessage */
|
|
623
576
|
|
|
624
|
-
/* Excluded from this release type: initialClusterCapacity */
|
|
625
|
-
|
|
626
577
|
/**
|
|
627
578
|
* @alpha
|
|
628
579
|
*/
|
|
@@ -11,12 +11,9 @@ import { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
|
11
11
|
import { IEvent } from '@fluidframework/core-interfaces';
|
|
12
12
|
import { IEventProvider } from '@fluidframework/core-interfaces';
|
|
13
13
|
import { IFluidHandle } from '@fluidframework/core-interfaces';
|
|
14
|
-
import { IFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
15
|
-
import { IFluidRouter } from '@fluidframework/core-interfaces';
|
|
16
14
|
import { IIdCompressor } from '@fluidframework/id-compressor';
|
|
17
15
|
import { IIdCompressorCore } from '@fluidframework/id-compressor';
|
|
18
16
|
import { ILoaderOptions } from '@fluidframework/container-definitions';
|
|
19
|
-
import { initialClusterCapacity } from '@fluidframework/id-compressor';
|
|
20
17
|
import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
21
18
|
import { IQuorumClients } from '@fluidframework/protocol-definitions';
|
|
22
19
|
import { IRequest } from '@fluidframework/core-interfaces';
|
|
@@ -116,10 +113,6 @@ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
|
|
|
116
113
|
|
|
117
114
|
/* Excluded from this release type: IFluidHandle */
|
|
118
115
|
|
|
119
|
-
/* Excluded from this release type: IFluidHandleContext */
|
|
120
|
-
|
|
121
|
-
/* Excluded from this release type: IFluidRouter */
|
|
122
|
-
|
|
123
116
|
/* Excluded from this release type: IGarbageCollectionData */
|
|
124
117
|
|
|
125
118
|
/* Excluded from this release type: IGarbageCollectionDetailsBase */
|
|
@@ -134,8 +127,6 @@ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
|
|
|
134
127
|
|
|
135
128
|
/* Excluded from this release type: InboundAttachMessage */
|
|
136
129
|
|
|
137
|
-
/* Excluded from this release type: initialClusterCapacity */
|
|
138
|
-
|
|
139
130
|
/* Excluded from this release type: IProvideFluidDataStoreFactory */
|
|
140
131
|
|
|
141
132
|
/* Excluded from this release type: IProvideFluidDataStoreRegistry */
|
|
@@ -11,12 +11,9 @@ import { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
|
11
11
|
import { IEvent } from '@fluidframework/core-interfaces';
|
|
12
12
|
import { IEventProvider } from '@fluidframework/core-interfaces';
|
|
13
13
|
import { IFluidHandle } from '@fluidframework/core-interfaces';
|
|
14
|
-
import { IFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
15
|
-
import { IFluidRouter } from '@fluidframework/core-interfaces';
|
|
16
14
|
import { IIdCompressor } from '@fluidframework/id-compressor';
|
|
17
15
|
import { IIdCompressorCore } from '@fluidframework/id-compressor';
|
|
18
16
|
import { ILoaderOptions } from '@fluidframework/container-definitions';
|
|
19
|
-
import { initialClusterCapacity } from '@fluidframework/id-compressor';
|
|
20
17
|
import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
21
18
|
import { IQuorumClients } from '@fluidframework/protocol-definitions';
|
|
22
19
|
import { IRequest } from '@fluidframework/core-interfaces';
|
|
@@ -116,10 +113,6 @@ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
|
|
|
116
113
|
|
|
117
114
|
/* Excluded from this release type: IFluidHandle */
|
|
118
115
|
|
|
119
|
-
/* Excluded from this release type: IFluidHandleContext */
|
|
120
|
-
|
|
121
|
-
/* Excluded from this release type: IFluidRouter */
|
|
122
|
-
|
|
123
116
|
/* Excluded from this release type: IGarbageCollectionData */
|
|
124
117
|
|
|
125
118
|
/* Excluded from this release type: IGarbageCollectionDetailsBase */
|
|
@@ -134,8 +127,6 @@ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
|
|
|
134
127
|
|
|
135
128
|
/* Excluded from this release type: InboundAttachMessage */
|
|
136
129
|
|
|
137
|
-
/* Excluded from this release type: initialClusterCapacity */
|
|
138
|
-
|
|
139
130
|
/* Excluded from this release type: IProvideFluidDataStoreFactory */
|
|
140
131
|
|
|
141
132
|
/* Excluded from this release type: IProvideFluidDataStoreRegistry */
|
|
@@ -11,12 +11,9 @@ import { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
|
11
11
|
import { IEvent } from '@fluidframework/core-interfaces';
|
|
12
12
|
import { IEventProvider } from '@fluidframework/core-interfaces';
|
|
13
13
|
import { IFluidHandle } from '@fluidframework/core-interfaces';
|
|
14
|
-
import { IFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
15
|
-
import { IFluidRouter } from '@fluidframework/core-interfaces';
|
|
16
14
|
import { IIdCompressor } from '@fluidframework/id-compressor';
|
|
17
15
|
import { IIdCompressorCore } from '@fluidframework/id-compressor';
|
|
18
16
|
import { ILoaderOptions } from '@fluidframework/container-definitions';
|
|
19
|
-
import { initialClusterCapacity } from '@fluidframework/id-compressor';
|
|
20
17
|
import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
21
18
|
import { IQuorumClients } from '@fluidframework/protocol-definitions';
|
|
22
19
|
import { IRequest } from '@fluidframework/core-interfaces';
|
|
@@ -234,11 +231,6 @@ export declare interface IContainerRuntimeBase extends IEventProvider<IContainer
|
|
|
234
231
|
* sequentially. Total size of all messages must be less than maxOpSize.
|
|
235
232
|
*/
|
|
236
233
|
orderSequentially(callback: () => void): void;
|
|
237
|
-
/**
|
|
238
|
-
* Executes a request against the container runtime
|
|
239
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
240
|
-
*/
|
|
241
|
-
request(request: IRequest): Promise<IResponse>;
|
|
242
234
|
/**
|
|
243
235
|
* Submits a container runtime level signal to be sent to other clients.
|
|
244
236
|
* @param type - Type of the signal.
|
|
@@ -278,10 +270,6 @@ export declare interface IContainerRuntimeBase extends IEventProvider<IContainer
|
|
|
278
270
|
* Returns the current audience.
|
|
279
271
|
*/
|
|
280
272
|
getAudience(): IAudience;
|
|
281
|
-
/**
|
|
282
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
283
|
-
*/
|
|
284
|
-
readonly IFluidHandleContext: IFluidHandleContext;
|
|
285
273
|
}
|
|
286
274
|
|
|
287
275
|
/**
|
|
@@ -320,37 +308,6 @@ export declare interface IDataStore {
|
|
|
320
308
|
* with it.
|
|
321
309
|
*/
|
|
322
310
|
readonly entryPoint: IFluidHandle<FluidObject>;
|
|
323
|
-
/**
|
|
324
|
-
* @deprecated Requesting will not be supported in a future major release.
|
|
325
|
-
* Instead, access the objects within the DataStore using entryPoint, and then navigate from there using
|
|
326
|
-
* app-specific logic (e.g. retrieving a handle from a DDS, or the entryPoint object could implement a request paradigm itself)
|
|
327
|
-
*
|
|
328
|
-
* IMPORTANT: This overload is provided for back-compat where IDataStore.request(\{ url: "/" \}) is already implemented and used.
|
|
329
|
-
* The functionality it can provide (if the DataStore implementation is built for it) is redundant with @see {@link IDataStore.entryPoint}.
|
|
330
|
-
*
|
|
331
|
-
* Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.
|
|
332
|
-
*
|
|
333
|
-
* @param request - Only requesting \{ url: "/" \} is supported, requesting arbitrary URLs is deprecated.
|
|
334
|
-
*/
|
|
335
|
-
request(request: {
|
|
336
|
-
url: "/";
|
|
337
|
-
headers?: undefined;
|
|
338
|
-
}): Promise<IResponse>;
|
|
339
|
-
/**
|
|
340
|
-
* Issue a request against the DataStore for a resource within it.
|
|
341
|
-
* @param request - The request to be issued against the DataStore
|
|
342
|
-
*
|
|
343
|
-
* @deprecated Requesting an arbitrary URL with headers will not be supported in a future major release.
|
|
344
|
-
* Instead, access the objects within the DataStore using entryPoint, and then navigate from there using
|
|
345
|
-
* app-specific logic (e.g. retrieving a handle from a DDS, or the entryPoint object could implement a request paradigm itself)
|
|
346
|
-
*
|
|
347
|
-
* Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.
|
|
348
|
-
*/
|
|
349
|
-
request(request: IRequest): Promise<IResponse>;
|
|
350
|
-
/**
|
|
351
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
352
|
-
*/
|
|
353
|
-
readonly IFluidRouter: IFluidRouter;
|
|
354
311
|
}
|
|
355
312
|
|
|
356
313
|
export { IdCompressor }
|
|
@@ -482,10 +439,6 @@ export declare interface IFluidDataStoreChannel extends IDisposable {
|
|
|
482
439
|
*/
|
|
483
440
|
readonly entryPoint: IFluidHandle<FluidObject>;
|
|
484
441
|
request(request: IRequest): Promise<IResponse>;
|
|
485
|
-
/**
|
|
486
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
487
|
-
*/
|
|
488
|
-
readonly IFluidRouter: IFluidRouter;
|
|
489
442
|
}
|
|
490
443
|
|
|
491
444
|
/**
|
|
@@ -714,8 +667,6 @@ export declare type InboundAttachMessage = Omit<IAttachMessage, "snapshot"> & {
|
|
|
714
667
|
snapshot: IAttachMessage["snapshot"] | null;
|
|
715
668
|
};
|
|
716
669
|
|
|
717
|
-
export { initialClusterCapacity }
|
|
718
|
-
|
|
719
670
|
/**
|
|
720
671
|
* @alpha
|
|
721
672
|
*/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/runtime-definitions",
|
|
3
|
-
"version": "2.0.0-internal.
|
|
3
|
+
"version": "2.0.0-internal.8.0.0",
|
|
4
4
|
"description": "Fluid Runtime definitions",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -14,10 +14,10 @@
|
|
|
14
14
|
"main": "dist/index.js",
|
|
15
15
|
"types": "dist/index.d.ts",
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@fluidframework/container-definitions": ">=2.0.0-internal.
|
|
18
|
-
"@fluidframework/core-interfaces": ">=2.0.0-internal.
|
|
19
|
-
"@fluidframework/driver-definitions": ">=2.0.0-internal.
|
|
20
|
-
"@fluidframework/id-compressor": ">=2.0.0-internal.
|
|
17
|
+
"@fluidframework/container-definitions": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
|
|
18
|
+
"@fluidframework/core-interfaces": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
|
|
19
|
+
"@fluidframework/driver-definitions": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
|
|
20
|
+
"@fluidframework/id-compressor": ">=2.0.0-internal.8.0.0 <2.0.0-internal.8.1.0",
|
|
21
21
|
"@fluidframework/protocol-definitions": "^3.0.0"
|
|
22
22
|
},
|
|
23
23
|
"devDependencies": {
|
|
@@ -56,6 +56,32 @@
|
|
|
56
56
|
"RemovedTypeAliasDeclaration_IdCreationRangeWithStashedState": {
|
|
57
57
|
"forwardCompat": false,
|
|
58
58
|
"backCompat": false
|
|
59
|
+
},
|
|
60
|
+
"InterfaceDeclaration_IdCreationRange": {
|
|
61
|
+
"forwardCompat": false
|
|
62
|
+
},
|
|
63
|
+
"VariableDeclaration_initialClusterCapacity": {
|
|
64
|
+
"backCompat": false,
|
|
65
|
+
"forwardCompat": false
|
|
66
|
+
},
|
|
67
|
+
"RemovedVariableDeclaration_initialClusterCapacity": {
|
|
68
|
+
"forwardCompat": false,
|
|
69
|
+
"backCompat": false
|
|
70
|
+
},
|
|
71
|
+
"InterfaceDeclaration_IContainerRuntimeBase": {
|
|
72
|
+
"backCompat": false
|
|
73
|
+
},
|
|
74
|
+
"InterfaceDeclaration_IFluidDataStoreContext": {
|
|
75
|
+
"backCompat": false
|
|
76
|
+
},
|
|
77
|
+
"InterfaceDeclaration_IFluidDataStoreContextDetached": {
|
|
78
|
+
"backCompat": false
|
|
79
|
+
},
|
|
80
|
+
"InterfaceDeclaration_IDataStore": {
|
|
81
|
+
"backCompat": false
|
|
82
|
+
},
|
|
83
|
+
"InterfaceDeclaration_IFluidDataStoreChannel": {
|
|
84
|
+
"backCompat": false
|
|
59
85
|
}
|
|
60
86
|
}
|
|
61
87
|
},
|
package/src/dataStoreContext.ts
CHANGED
|
@@ -8,14 +8,11 @@ import {
|
|
|
8
8
|
IEventProvider,
|
|
9
9
|
ITelemetryBaseLogger,
|
|
10
10
|
IDisposable,
|
|
11
|
-
// eslint-disable-next-line import/no-deprecated
|
|
12
|
-
IFluidRouter,
|
|
13
11
|
IProvideFluidHandleContext,
|
|
14
12
|
IFluidHandle,
|
|
15
13
|
IRequest,
|
|
16
14
|
IResponse,
|
|
17
15
|
FluidObject,
|
|
18
|
-
IFluidHandleContext,
|
|
19
16
|
} from "@fluidframework/core-interfaces";
|
|
20
17
|
import {
|
|
21
18
|
IAudience,
|
|
@@ -160,38 +157,6 @@ export interface IDataStore {
|
|
|
160
157
|
* with it.
|
|
161
158
|
*/
|
|
162
159
|
readonly entryPoint: IFluidHandle<FluidObject>;
|
|
163
|
-
|
|
164
|
-
/**
|
|
165
|
-
* @deprecated Requesting will not be supported in a future major release.
|
|
166
|
-
* Instead, access the objects within the DataStore using entryPoint, and then navigate from there using
|
|
167
|
-
* app-specific logic (e.g. retrieving a handle from a DDS, or the entryPoint object could implement a request paradigm itself)
|
|
168
|
-
*
|
|
169
|
-
* IMPORTANT: This overload is provided for back-compat where IDataStore.request(\{ url: "/" \}) is already implemented and used.
|
|
170
|
-
* The functionality it can provide (if the DataStore implementation is built for it) is redundant with @see {@link IDataStore.entryPoint}.
|
|
171
|
-
*
|
|
172
|
-
* Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.
|
|
173
|
-
*
|
|
174
|
-
* @param request - Only requesting \{ url: "/" \} is supported, requesting arbitrary URLs is deprecated.
|
|
175
|
-
*/
|
|
176
|
-
request(request: { url: "/"; headers?: undefined }): Promise<IResponse>;
|
|
177
|
-
|
|
178
|
-
/**
|
|
179
|
-
* Issue a request against the DataStore for a resource within it.
|
|
180
|
-
* @param request - The request to be issued against the DataStore
|
|
181
|
-
*
|
|
182
|
-
* @deprecated Requesting an arbitrary URL with headers will not be supported in a future major release.
|
|
183
|
-
* Instead, access the objects within the DataStore using entryPoint, and then navigate from there using
|
|
184
|
-
* app-specific logic (e.g. retrieving a handle from a DDS, or the entryPoint object could implement a request paradigm itself)
|
|
185
|
-
*
|
|
186
|
-
* Refer to Removing-IFluidRouter.md for details on migrating from the request pattern to using entryPoint.
|
|
187
|
-
*/
|
|
188
|
-
request(request: IRequest): Promise<IResponse>;
|
|
189
|
-
|
|
190
|
-
/**
|
|
191
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
192
|
-
*/
|
|
193
|
-
// eslint-disable-next-line import/no-deprecated
|
|
194
|
-
readonly IFluidRouter: IFluidRouter;
|
|
195
160
|
}
|
|
196
161
|
|
|
197
162
|
/**
|
|
@@ -209,12 +174,6 @@ export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeB
|
|
|
209
174
|
*/
|
|
210
175
|
orderSequentially(callback: () => void): void;
|
|
211
176
|
|
|
212
|
-
/**
|
|
213
|
-
* Executes a request against the container runtime
|
|
214
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
215
|
-
*/
|
|
216
|
-
request(request: IRequest): Promise<IResponse>;
|
|
217
|
-
|
|
218
177
|
/**
|
|
219
178
|
* Submits a container runtime level signal to be sent to other clients.
|
|
220
179
|
* @param type - Type of the signal.
|
|
@@ -265,11 +224,6 @@ export interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeB
|
|
|
265
224
|
* Returns the current audience.
|
|
266
225
|
*/
|
|
267
226
|
getAudience(): IAudience;
|
|
268
|
-
|
|
269
|
-
/**
|
|
270
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
271
|
-
*/
|
|
272
|
-
readonly IFluidHandleContext: IFluidHandleContext;
|
|
273
227
|
}
|
|
274
228
|
|
|
275
229
|
/**
|
|
@@ -375,12 +329,6 @@ export interface IFluidDataStoreChannel extends IDisposable {
|
|
|
375
329
|
readonly entryPoint: IFluidHandle<FluidObject>;
|
|
376
330
|
|
|
377
331
|
request(request: IRequest): Promise<IResponse>;
|
|
378
|
-
|
|
379
|
-
/**
|
|
380
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
381
|
-
*/
|
|
382
|
-
// eslint-disable-next-line import/no-deprecated
|
|
383
|
-
readonly IFluidRouter: IFluidRouter;
|
|
384
332
|
}
|
|
385
333
|
|
|
386
334
|
/**
|
package/src/index.ts
CHANGED
|
@@ -113,8 +113,4 @@ export {
|
|
|
113
113
|
* @deprecated Import from `@fluidframework/id-compressor` instead.
|
|
114
114
|
*/
|
|
115
115
|
StableId,
|
|
116
|
-
/**
|
|
117
|
-
* @deprecated Import from `@fluidframework/id-compressor` instead.
|
|
118
|
-
*/
|
|
119
|
-
initialClusterCapacity,
|
|
120
116
|
} from "@fluidframework/id-compressor";
|