@fluidframework/container-runtime-definitions 2.1.0-274160 → 2.1.0-276985
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/README.md +14 -5
- package/dist/containerRuntime.d.ts +4 -0
- package/dist/containerRuntime.d.ts.map +1 -1
- package/dist/legacy.d.ts +1 -1
- package/lib/containerRuntime.d.ts +4 -0
- package/lib/containerRuntime.d.ts.map +1 -1
- package/lib/legacy.d.ts +1 -1
- package/package.json +7 -7
- package/src/containerRuntime.ts +4 -0
- /package/api-report/{container-runtime-definitions.alpha.api.md → container-runtime-definitions.legacy.alpha.api.md} +0 -0
package/README.md
CHANGED
|
@@ -9,10 +9,12 @@ Interface `IContainerRuntime` specify the container developer API.
|
|
|
9
9
|
|
|
10
10
|
## Using Fluid Framework libraries
|
|
11
11
|
|
|
12
|
-
When taking a dependency on a Fluid Framework library, we recommend using a `^` (caret) version range, such as `^1.3.4`.
|
|
12
|
+
When taking a dependency on a Fluid Framework library's public APIs, we recommend using a `^` (caret) version range, such as `^1.3.4`.
|
|
13
13
|
While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
|
|
14
14
|
library consumers should always prefer `^`.
|
|
15
15
|
|
|
16
|
+
If using any of Fluid Framework's unstable APIs (for example, its `beta` APIs), we recommend using a more constrained version range, such as `~`.
|
|
17
|
+
|
|
16
18
|
## Installation
|
|
17
19
|
|
|
18
20
|
To get started, install the package by running the following command:
|
|
@@ -21,6 +23,15 @@ To get started, install the package by running the following command:
|
|
|
21
23
|
npm i @fluidframework/container-runtime-definitions
|
|
22
24
|
```
|
|
23
25
|
|
|
26
|
+
## Importing from this package
|
|
27
|
+
|
|
28
|
+
This package leverages [package.json exports](https://nodejs.org/api/packages.html#exports) to separate its APIs by support level.
|
|
29
|
+
For more information on the related support guarantees, see [API Support Levels](https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels).
|
|
30
|
+
|
|
31
|
+
To access the `public` ([SemVer](https://semver.org/)) APIs, import via `@fluidframework/container-runtime-definitions` like normal.
|
|
32
|
+
|
|
33
|
+
To access the `legacy` APIs, import via `@fluidframework/container-runtime-definitions/legacy`.
|
|
34
|
+
|
|
24
35
|
## API Documentation
|
|
25
36
|
|
|
26
37
|
API documentation for **@fluidframework/container-runtime-definitions** is available at <https://fluidframework.com/docs/apis/container-runtime-definitions>.
|
|
@@ -45,11 +56,9 @@ Use of Microsoft trademarks or logos in modified versions of this project must n
|
|
|
45
56
|
|
|
46
57
|
## Help
|
|
47
58
|
|
|
48
|
-
Not finding what you're looking for in this README? Check out
|
|
49
|
-
Wiki](https://github.com/microsoft/FluidFramework/wiki) or [fluidframework.com](https://fluidframework.com/docs/).
|
|
59
|
+
Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).
|
|
50
60
|
|
|
51
|
-
Still not finding what you're looking for? Please [file an
|
|
52
|
-
issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
|
|
61
|
+
Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
|
|
53
62
|
|
|
54
63
|
Thank you!
|
|
55
64
|
|
|
@@ -11,6 +11,7 @@ import type { IDocumentStorageService, IDocumentMessage, ISequencedDocumentMessa
|
|
|
11
11
|
import type { FlushMode, IContainerRuntimeBase, IContainerRuntimeBaseEvents, IProvideFluidDataStoreRegistry } from "@fluidframework/runtime-definitions/internal";
|
|
12
12
|
/**
|
|
13
13
|
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
14
|
+
* @legacy
|
|
14
15
|
* @alpha
|
|
15
16
|
*/
|
|
16
17
|
export interface IContainerRuntimeWithResolveHandle_Deprecated extends IContainerRuntime {
|
|
@@ -19,6 +20,7 @@ export interface IContainerRuntimeWithResolveHandle_Deprecated extends IContaine
|
|
|
19
20
|
}
|
|
20
21
|
/**
|
|
21
22
|
* Events emitted by {@link IContainerRuntime}.
|
|
23
|
+
* @legacy
|
|
22
24
|
* @alpha
|
|
23
25
|
*/
|
|
24
26
|
export interface IContainerRuntimeEvents extends IContainerRuntimeBaseEvents {
|
|
@@ -26,11 +28,13 @@ export interface IContainerRuntimeEvents extends IContainerRuntimeBaseEvents {
|
|
|
26
28
|
(event: "connected", listener: (clientId: string) => void): any;
|
|
27
29
|
}
|
|
28
30
|
/**
|
|
31
|
+
* @legacy
|
|
29
32
|
* @alpha
|
|
30
33
|
*/
|
|
31
34
|
export type IContainerRuntimeBaseWithCombinedEvents = IContainerRuntimeBase & IEventProvider<IContainerRuntimeEvents>;
|
|
32
35
|
/**
|
|
33
36
|
* Represents the runtime of the container. Contains helper functions/state of the container.
|
|
37
|
+
* @legacy
|
|
34
38
|
* @alpha
|
|
35
39
|
*/
|
|
36
40
|
export interface IContainerRuntime extends IProvideFluidDataStoreRegistry, IContainerRuntimeBaseWithCombinedEvents {
|
|
@@ -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,YAAY,EACZ,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
|
|
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,YAAY,EACZ,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;;;;GAIG;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;;;GAGG;AACH,MAAM,MAAM,uCAAuC,GAAG,qBAAqB,GAC1E,cAAc,CAAC,uBAAuB,CAAC,CAAC;AAEzC;;;;GAIG;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;;;;;OAKG;IACH,6BAA6B,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC,CAAC;IAE7F;;;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/dist/legacy.d.ts
CHANGED
|
@@ -11,6 +11,7 @@ import type { IDocumentStorageService, IDocumentMessage, ISequencedDocumentMessa
|
|
|
11
11
|
import type { FlushMode, IContainerRuntimeBase, IContainerRuntimeBaseEvents, IProvideFluidDataStoreRegistry } from "@fluidframework/runtime-definitions/internal";
|
|
12
12
|
/**
|
|
13
13
|
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
14
|
+
* @legacy
|
|
14
15
|
* @alpha
|
|
15
16
|
*/
|
|
16
17
|
export interface IContainerRuntimeWithResolveHandle_Deprecated extends IContainerRuntime {
|
|
@@ -19,6 +20,7 @@ export interface IContainerRuntimeWithResolveHandle_Deprecated extends IContaine
|
|
|
19
20
|
}
|
|
20
21
|
/**
|
|
21
22
|
* Events emitted by {@link IContainerRuntime}.
|
|
23
|
+
* @legacy
|
|
22
24
|
* @alpha
|
|
23
25
|
*/
|
|
24
26
|
export interface IContainerRuntimeEvents extends IContainerRuntimeBaseEvents {
|
|
@@ -26,11 +28,13 @@ export interface IContainerRuntimeEvents extends IContainerRuntimeBaseEvents {
|
|
|
26
28
|
(event: "connected", listener: (clientId: string) => void): any;
|
|
27
29
|
}
|
|
28
30
|
/**
|
|
31
|
+
* @legacy
|
|
29
32
|
* @alpha
|
|
30
33
|
*/
|
|
31
34
|
export type IContainerRuntimeBaseWithCombinedEvents = IContainerRuntimeBase & IEventProvider<IContainerRuntimeEvents>;
|
|
32
35
|
/**
|
|
33
36
|
* Represents the runtime of the container. Contains helper functions/state of the container.
|
|
37
|
+
* @legacy
|
|
34
38
|
* @alpha
|
|
35
39
|
*/
|
|
36
40
|
export interface IContainerRuntime extends IProvideFluidDataStoreRegistry, IContainerRuntimeBaseWithCombinedEvents {
|
|
@@ -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,YAAY,EACZ,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
|
|
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,YAAY,EACZ,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;;;;GAIG;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;;;GAGG;AACH,MAAM,MAAM,uCAAuC,GAAG,qBAAqB,GAC1E,cAAc,CAAC,uBAAuB,CAAC,CAAC;AAEzC;;;;GAIG;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;;;;;OAKG;IACH,6BAA6B,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC,CAAC;IAE7F;;;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/legacy.d.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/container-runtime-definitions",
|
|
3
|
-
"version": "2.1.0-
|
|
3
|
+
"version": "2.1.0-276985",
|
|
4
4
|
"description": "Fluid Runtime definitions",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -41,10 +41,10 @@
|
|
|
41
41
|
"main": "",
|
|
42
42
|
"types": "lib/public.d.ts",
|
|
43
43
|
"dependencies": {
|
|
44
|
-
"@fluidframework/container-definitions": "2.1.0-
|
|
45
|
-
"@fluidframework/core-interfaces": "2.1.0-
|
|
46
|
-
"@fluidframework/driver-definitions": "2.1.0-
|
|
47
|
-
"@fluidframework/runtime-definitions": "2.1.0-
|
|
44
|
+
"@fluidframework/container-definitions": "2.1.0-276985",
|
|
45
|
+
"@fluidframework/core-interfaces": "2.1.0-276985",
|
|
46
|
+
"@fluidframework/driver-definitions": "2.1.0-276985",
|
|
47
|
+
"@fluidframework/runtime-definitions": "2.1.0-276985"
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|
|
50
50
|
"@arethetypeswrong/cli": "^0.15.2",
|
|
@@ -67,8 +67,8 @@
|
|
|
67
67
|
},
|
|
68
68
|
"scripts": {
|
|
69
69
|
"api": "fluid-build . --task api",
|
|
70
|
-
"api-extractor:commonjs": "flub generate entrypoints --
|
|
71
|
-
"api-extractor:esnext": "flub generate entrypoints --
|
|
70
|
+
"api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
|
|
71
|
+
"api-extractor:esnext": "flub generate entrypoints --outDir ./lib --node10TypeCompat",
|
|
72
72
|
"build": "fluid-build . --task build",
|
|
73
73
|
"build:compile": "fluid-build . --task compile",
|
|
74
74
|
"build:docs": "concurrently \"npm:build:docs:*\"",
|
package/src/containerRuntime.ts
CHANGED
|
@@ -28,6 +28,7 @@ import type {
|
|
|
28
28
|
|
|
29
29
|
/**
|
|
30
30
|
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
31
|
+
* @legacy
|
|
31
32
|
* @alpha
|
|
32
33
|
*/
|
|
33
34
|
export interface IContainerRuntimeWithResolveHandle_Deprecated extends IContainerRuntime {
|
|
@@ -37,6 +38,7 @@ export interface IContainerRuntimeWithResolveHandle_Deprecated extends IContaine
|
|
|
37
38
|
|
|
38
39
|
/**
|
|
39
40
|
* Events emitted by {@link IContainerRuntime}.
|
|
41
|
+
* @legacy
|
|
40
42
|
* @alpha
|
|
41
43
|
*/
|
|
42
44
|
export interface IContainerRuntimeEvents extends IContainerRuntimeBaseEvents {
|
|
@@ -45,6 +47,7 @@ export interface IContainerRuntimeEvents extends IContainerRuntimeBaseEvents {
|
|
|
45
47
|
}
|
|
46
48
|
|
|
47
49
|
/**
|
|
50
|
+
* @legacy
|
|
48
51
|
* @alpha
|
|
49
52
|
*/
|
|
50
53
|
export type IContainerRuntimeBaseWithCombinedEvents = IContainerRuntimeBase &
|
|
@@ -52,6 +55,7 @@ export type IContainerRuntimeBaseWithCombinedEvents = IContainerRuntimeBase &
|
|
|
52
55
|
|
|
53
56
|
/**
|
|
54
57
|
* Represents the runtime of the container. Contains helper functions/state of the container.
|
|
58
|
+
* @legacy
|
|
55
59
|
* @alpha
|
|
56
60
|
*/
|
|
57
61
|
export interface IContainerRuntime
|
|
File without changes
|