@fluidframework/container-runtime-definitions 2.3.0-288113 → 2.4.0-294316
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 +4 -0
- package/api-report/container-runtime-definitions.legacy.alpha.api.md +3 -4
- package/dist/containerRuntime.d.ts +4 -8
- package/dist/containerRuntime.d.ts.map +1 -1
- package/lib/containerRuntime.d.ts +4 -8
- package/lib/containerRuntime.d.ts.map +1 -1
- package/lib/tsdoc-metadata.json +1 -1
- package/package.json +12 -11
- package/src/containerRuntime.ts +3 -9
package/CHANGELOG.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
```ts
|
|
6
6
|
|
|
7
|
-
// @alpha
|
|
7
|
+
// @alpha @sealed
|
|
8
8
|
export interface IContainerRuntime extends IProvideFluidDataStoreRegistry, IContainerRuntimeBaseWithCombinedEvents {
|
|
9
9
|
readonly attachState: AttachState;
|
|
10
10
|
// (undocumented)
|
|
@@ -18,7 +18,6 @@ export interface IContainerRuntime extends IProvideFluidDataStoreRegistry, ICont
|
|
|
18
18
|
// (undocumented)
|
|
19
19
|
readonly flushMode: FlushMode;
|
|
20
20
|
getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
|
|
21
|
-
getAliasedDataStoreEntryPoint(alias: string): Promise<IFluidHandle<FluidObject> | undefined>;
|
|
22
21
|
readonly isDirty: boolean;
|
|
23
22
|
// (undocumented)
|
|
24
23
|
readonly options: Record<string | number, any>;
|
|
@@ -28,10 +27,10 @@ export interface IContainerRuntime extends IProvideFluidDataStoreRegistry, ICont
|
|
|
28
27
|
readonly storage: IDocumentStorageService;
|
|
29
28
|
}
|
|
30
29
|
|
|
31
|
-
// @alpha (undocumented)
|
|
30
|
+
// @alpha @sealed (undocumented)
|
|
32
31
|
export type IContainerRuntimeBaseWithCombinedEvents = IContainerRuntimeBase & IEventProvider<IContainerRuntimeEvents>;
|
|
33
32
|
|
|
34
|
-
// @alpha
|
|
33
|
+
// @alpha @sealed
|
|
35
34
|
export interface IContainerRuntimeEvents extends IContainerRuntimeBaseEvents {
|
|
36
35
|
// (undocumented)
|
|
37
36
|
(event: "dirty" | "disconnected" | "saved" | "attached", listener: () => void): any;
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
*/
|
|
5
5
|
import type { AttachState } from "@fluidframework/container-definitions";
|
|
6
6
|
import type { IDeltaManager } from "@fluidframework/container-definitions/internal";
|
|
7
|
-
import type { FluidObject, IEventProvider,
|
|
7
|
+
import type { FluidObject, IEventProvider, IRequest, IResponse } from "@fluidframework/core-interfaces";
|
|
8
8
|
import type { IFluidHandleContext } from "@fluidframework/core-interfaces/internal";
|
|
9
9
|
import type { IClientDetails } from "@fluidframework/driver-definitions";
|
|
10
10
|
import type { IDocumentStorageService, IDocumentMessage, ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
|
|
@@ -22,6 +22,7 @@ export interface IContainerRuntimeWithResolveHandle_Deprecated extends IContaine
|
|
|
22
22
|
* Events emitted by {@link IContainerRuntime}.
|
|
23
23
|
* @legacy
|
|
24
24
|
* @alpha
|
|
25
|
+
* @sealed
|
|
25
26
|
*/
|
|
26
27
|
export interface IContainerRuntimeEvents extends IContainerRuntimeBaseEvents {
|
|
27
28
|
(event: "dirty" | "disconnected" | "saved" | "attached", listener: () => void): any;
|
|
@@ -30,12 +31,14 @@ export interface IContainerRuntimeEvents extends IContainerRuntimeBaseEvents {
|
|
|
30
31
|
/**
|
|
31
32
|
* @legacy
|
|
32
33
|
* @alpha
|
|
34
|
+
* @sealed
|
|
33
35
|
*/
|
|
34
36
|
export type IContainerRuntimeBaseWithCombinedEvents = IContainerRuntimeBase & IEventProvider<IContainerRuntimeEvents>;
|
|
35
37
|
/**
|
|
36
38
|
* Represents the runtime of the container. Contains helper functions/state of the container.
|
|
37
39
|
* @legacy
|
|
38
40
|
* @alpha
|
|
41
|
+
* @sealed
|
|
39
42
|
*/
|
|
40
43
|
export interface IContainerRuntime extends IProvideFluidDataStoreRegistry, IContainerRuntimeBaseWithCombinedEvents {
|
|
41
44
|
readonly options: Record<string | number, any>;
|
|
@@ -50,13 +53,6 @@ export interface IContainerRuntime extends IProvideFluidDataStoreRegistry, ICont
|
|
|
50
53
|
* Indicates the attachment state of the container to a host service.
|
|
51
54
|
*/
|
|
52
55
|
readonly attachState: AttachState;
|
|
53
|
-
/**
|
|
54
|
-
* Returns the aliased data store's entryPoint, given the alias.
|
|
55
|
-
* @param alias - The alias for the data store.
|
|
56
|
-
* @returns The data store's entry point ({@link @fluidframework/core-interfaces#IFluidHandle}) if it exists and is aliased.
|
|
57
|
-
* Returns undefined if no data store has been assigned the given alias.
|
|
58
|
-
*/
|
|
59
|
-
getAliasedDataStoreEntryPoint(alias: string): Promise<IFluidHandle<FluidObject> | undefined>;
|
|
60
56
|
/**
|
|
61
57
|
* Returns true if document is dirty, i.e. there are some pending local changes that
|
|
62
58
|
* either were not sent out to delta stream or were not yet acknowledged.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"containerRuntime.d.ts","sourceRoot":"","sources":["../src/containerRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACzE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gDAAgD,CAAC;AACpF,OAAO,KAAK,EACX,WAAW,EACX,cAAc,EACd,
|
|
1
|
+
{"version":3,"file":"containerRuntime.d.ts","sourceRoot":"","sources":["../src/containerRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACzE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gDAAgD,CAAC;AACpF,OAAO,KAAK,EACX,WAAW,EACX,cAAc,EACd,QAAQ,EACR,SAAS,EACT,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,KAAK,EACX,uBAAuB,EACvB,gBAAgB,EAChB,yBAAyB,EACzB,MAAM,6CAA6C,CAAC;AACrD,OAAO,KAAK,EACX,SAAS,EACT,qBAAqB,EACrB,2BAA2B,EAC3B,8BAA8B,EAC9B,MAAM,8CAA8C,CAAC;AAEtD;;;;GAIG;AACH,MAAM,WAAW,6CAA8C,SAAQ,iBAAiB;IACvF,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAClD,aAAa,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CACrD;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAwB,SAAQ,2BAA2B;IAC3E,CAAC,KAAK,EAAE,OAAO,GAAG,cAAc,GAAG,OAAO,GAAG,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC/E,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CAC3D;AAED;;;;GAIG;AACH,MAAM,MAAM,uCAAuC,GAAG,qBAAqB,GAC1E,cAAc,CAAC,uBAAuB,CAAC,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,WAAW,iBAChB,SAAQ,8BAA8B,EACrC,uCAAuC;IAExC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IACvC,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,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;;;OAIG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CACjE"}
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
*/
|
|
5
5
|
import type { AttachState } from "@fluidframework/container-definitions";
|
|
6
6
|
import type { IDeltaManager } from "@fluidframework/container-definitions/internal";
|
|
7
|
-
import type { FluidObject, IEventProvider,
|
|
7
|
+
import type { FluidObject, IEventProvider, IRequest, IResponse } from "@fluidframework/core-interfaces";
|
|
8
8
|
import type { IFluidHandleContext } from "@fluidframework/core-interfaces/internal";
|
|
9
9
|
import type { IClientDetails } from "@fluidframework/driver-definitions";
|
|
10
10
|
import type { IDocumentStorageService, IDocumentMessage, ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
|
|
@@ -22,6 +22,7 @@ export interface IContainerRuntimeWithResolveHandle_Deprecated extends IContaine
|
|
|
22
22
|
* Events emitted by {@link IContainerRuntime}.
|
|
23
23
|
* @legacy
|
|
24
24
|
* @alpha
|
|
25
|
+
* @sealed
|
|
25
26
|
*/
|
|
26
27
|
export interface IContainerRuntimeEvents extends IContainerRuntimeBaseEvents {
|
|
27
28
|
(event: "dirty" | "disconnected" | "saved" | "attached", listener: () => void): any;
|
|
@@ -30,12 +31,14 @@ export interface IContainerRuntimeEvents extends IContainerRuntimeBaseEvents {
|
|
|
30
31
|
/**
|
|
31
32
|
* @legacy
|
|
32
33
|
* @alpha
|
|
34
|
+
* @sealed
|
|
33
35
|
*/
|
|
34
36
|
export type IContainerRuntimeBaseWithCombinedEvents = IContainerRuntimeBase & IEventProvider<IContainerRuntimeEvents>;
|
|
35
37
|
/**
|
|
36
38
|
* Represents the runtime of the container. Contains helper functions/state of the container.
|
|
37
39
|
* @legacy
|
|
38
40
|
* @alpha
|
|
41
|
+
* @sealed
|
|
39
42
|
*/
|
|
40
43
|
export interface IContainerRuntime extends IProvideFluidDataStoreRegistry, IContainerRuntimeBaseWithCombinedEvents {
|
|
41
44
|
readonly options: Record<string | number, any>;
|
|
@@ -50,13 +53,6 @@ export interface IContainerRuntime extends IProvideFluidDataStoreRegistry, ICont
|
|
|
50
53
|
* Indicates the attachment state of the container to a host service.
|
|
51
54
|
*/
|
|
52
55
|
readonly attachState: AttachState;
|
|
53
|
-
/**
|
|
54
|
-
* Returns the aliased data store's entryPoint, given the alias.
|
|
55
|
-
* @param alias - The alias for the data store.
|
|
56
|
-
* @returns The data store's entry point ({@link @fluidframework/core-interfaces#IFluidHandle}) if it exists and is aliased.
|
|
57
|
-
* Returns undefined if no data store has been assigned the given alias.
|
|
58
|
-
*/
|
|
59
|
-
getAliasedDataStoreEntryPoint(alias: string): Promise<IFluidHandle<FluidObject> | undefined>;
|
|
60
56
|
/**
|
|
61
57
|
* Returns true if document is dirty, i.e. there are some pending local changes that
|
|
62
58
|
* either were not sent out to delta stream or were not yet acknowledged.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"containerRuntime.d.ts","sourceRoot":"","sources":["../src/containerRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACzE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gDAAgD,CAAC;AACpF,OAAO,KAAK,EACX,WAAW,EACX,cAAc,EACd,
|
|
1
|
+
{"version":3,"file":"containerRuntime.d.ts","sourceRoot":"","sources":["../src/containerRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACzE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gDAAgD,CAAC;AACpF,OAAO,KAAK,EACX,WAAW,EACX,cAAc,EACd,QAAQ,EACR,SAAS,EACT,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,KAAK,EACX,uBAAuB,EACvB,gBAAgB,EAChB,yBAAyB,EACzB,MAAM,6CAA6C,CAAC;AACrD,OAAO,KAAK,EACX,SAAS,EACT,qBAAqB,EACrB,2BAA2B,EAC3B,8BAA8B,EAC9B,MAAM,8CAA8C,CAAC;AAEtD;;;;GAIG;AACH,MAAM,WAAW,6CAA8C,SAAQ,iBAAiB;IACvF,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAClD,aAAa,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CACrD;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAwB,SAAQ,2BAA2B;IAC3E,CAAC,KAAK,EAAE,OAAO,GAAG,cAAc,GAAG,OAAO,GAAG,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC/E,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CAC3D;AAED;;;;GAIG;AACH,MAAM,MAAM,uCAAuC,GAAG,qBAAqB,GAC1E,cAAc,CAAC,uBAAuB,CAAC,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,WAAW,iBAChB,SAAQ,8BAA8B,EACrC,uCAAuC;IAExC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IACvC,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,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;;;OAIG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CACjE"}
|
package/lib/tsdoc-metadata.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/container-runtime-definitions",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.4.0-294316",
|
|
4
4
|
"description": "Fluid Runtime definitions",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -41,20 +41,20 @@
|
|
|
41
41
|
"main": "",
|
|
42
42
|
"types": "lib/public.d.ts",
|
|
43
43
|
"dependencies": {
|
|
44
|
-
"@fluidframework/container-definitions": "2.
|
|
45
|
-
"@fluidframework/core-interfaces": "2.
|
|
46
|
-
"@fluidframework/driver-definitions": "2.
|
|
47
|
-
"@fluidframework/runtime-definitions": "2.
|
|
44
|
+
"@fluidframework/container-definitions": "2.4.0-294316",
|
|
45
|
+
"@fluidframework/core-interfaces": "2.4.0-294316",
|
|
46
|
+
"@fluidframework/driver-definitions": "2.4.0-294316",
|
|
47
|
+
"@fluidframework/runtime-definitions": "2.4.0-294316"
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|
|
50
50
|
"@arethetypeswrong/cli": "^0.15.2",
|
|
51
51
|
"@biomejs/biome": "~1.8.3",
|
|
52
|
-
"@fluid-tools/build-cli": "^0.
|
|
52
|
+
"@fluid-tools/build-cli": "^0.46.0",
|
|
53
53
|
"@fluidframework/build-common": "^2.0.3",
|
|
54
|
-
"@fluidframework/build-tools": "^0.
|
|
55
|
-
"@fluidframework/container-runtime-definitions-previous": "npm:@fluidframework/container-runtime-definitions@2.
|
|
56
|
-
"@fluidframework/eslint-config-fluid": "^5.
|
|
57
|
-
"@microsoft/api-extractor": "
|
|
54
|
+
"@fluidframework/build-tools": "^0.46.0",
|
|
55
|
+
"@fluidframework/container-runtime-definitions-previous": "npm:@fluidframework/container-runtime-definitions@2.3.0",
|
|
56
|
+
"@fluidframework/eslint-config-fluid": "^5.4.0",
|
|
57
|
+
"@microsoft/api-extractor": "7.47.8",
|
|
58
58
|
"concurrently": "^8.2.1",
|
|
59
59
|
"copyfiles": "^2.4.1",
|
|
60
60
|
"eslint": "~8.55.0",
|
|
@@ -63,7 +63,8 @@
|
|
|
63
63
|
"typescript": "~5.4.5"
|
|
64
64
|
},
|
|
65
65
|
"typeValidation": {
|
|
66
|
-
"broken": {}
|
|
66
|
+
"broken": {},
|
|
67
|
+
"entrypoint": "internal"
|
|
67
68
|
},
|
|
68
69
|
"scripts": {
|
|
69
70
|
"api": "fluid-build . --task api",
|
package/src/containerRuntime.ts
CHANGED
|
@@ -8,7 +8,6 @@ import type { IDeltaManager } from "@fluidframework/container-definitions/intern
|
|
|
8
8
|
import type {
|
|
9
9
|
FluidObject,
|
|
10
10
|
IEventProvider,
|
|
11
|
-
IFluidHandle,
|
|
12
11
|
IRequest,
|
|
13
12
|
IResponse,
|
|
14
13
|
} from "@fluidframework/core-interfaces";
|
|
@@ -40,6 +39,7 @@ export interface IContainerRuntimeWithResolveHandle_Deprecated extends IContaine
|
|
|
40
39
|
* Events emitted by {@link IContainerRuntime}.
|
|
41
40
|
* @legacy
|
|
42
41
|
* @alpha
|
|
42
|
+
* @sealed
|
|
43
43
|
*/
|
|
44
44
|
export interface IContainerRuntimeEvents extends IContainerRuntimeBaseEvents {
|
|
45
45
|
(event: "dirty" | "disconnected" | "saved" | "attached", listener: () => void);
|
|
@@ -49,6 +49,7 @@ export interface IContainerRuntimeEvents extends IContainerRuntimeBaseEvents {
|
|
|
49
49
|
/**
|
|
50
50
|
* @legacy
|
|
51
51
|
* @alpha
|
|
52
|
+
* @sealed
|
|
52
53
|
*/
|
|
53
54
|
export type IContainerRuntimeBaseWithCombinedEvents = IContainerRuntimeBase &
|
|
54
55
|
IEventProvider<IContainerRuntimeEvents>;
|
|
@@ -57,6 +58,7 @@ export type IContainerRuntimeBaseWithCombinedEvents = IContainerRuntimeBase &
|
|
|
57
58
|
* Represents the runtime of the container. Contains helper functions/state of the container.
|
|
58
59
|
* @legacy
|
|
59
60
|
* @alpha
|
|
61
|
+
* @sealed
|
|
60
62
|
*/
|
|
61
63
|
export interface IContainerRuntime
|
|
62
64
|
extends IProvideFluidDataStoreRegistry,
|
|
@@ -75,14 +77,6 @@ export interface IContainerRuntime
|
|
|
75
77
|
*/
|
|
76
78
|
readonly attachState: AttachState;
|
|
77
79
|
|
|
78
|
-
/**
|
|
79
|
-
* Returns the aliased data store's entryPoint, given the alias.
|
|
80
|
-
* @param alias - The alias for the data store.
|
|
81
|
-
* @returns The data store's entry point ({@link @fluidframework/core-interfaces#IFluidHandle}) if it exists and is aliased.
|
|
82
|
-
* Returns undefined if no data store has been assigned the given alias.
|
|
83
|
-
*/
|
|
84
|
-
getAliasedDataStoreEntryPoint(alias: string): Promise<IFluidHandle<FluidObject> | undefined>;
|
|
85
|
-
|
|
86
80
|
/**
|
|
87
81
|
* Returns true if document is dirty, i.e. there are some pending local changes that
|
|
88
82
|
* either were not sent out to delta stream or were not yet acknowledged.
|