@fluidframework/container-runtime-definitions 2.0.2 → 2.1.0-276326

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.
Files changed (13) hide show
  1. package/README.md +9 -0
  2. package/api-extractor/api-extractor.legacy.json +4 -0
  3. package/api-report/container-runtime-definitions.beta.api.md +0 -17
  4. package/api-report/{container-runtime-definitions.alpha.api.md → container-runtime-definitions.legacy.alpha.api.md} +0 -17
  5. package/api-report/container-runtime-definitions.public.api.md +0 -17
  6. package/dist/containerRuntime.d.ts +4 -0
  7. package/dist/containerRuntime.d.ts.map +1 -1
  8. package/dist/legacy.d.ts +1 -1
  9. package/lib/containerRuntime.d.ts +4 -0
  10. package/lib/containerRuntime.d.ts.map +1 -1
  11. package/lib/legacy.d.ts +1 -1
  12. package/package.json +16 -25
  13. package/src/containerRuntime.ts +4 -0
package/README.md CHANGED
@@ -21,6 +21,15 @@ To get started, install the package by running the following command:
21
21
  npm i @fluidframework/container-runtime-definitions
22
22
  ```
23
23
 
24
+ ## Importing from this package
25
+
26
+ This package leverages [package.json exports](https://nodejs.org/api/packages.html#exports) to separate its APIs by support level.
27
+ For more information on the related support guarantees, see [API Support Levels](https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels).
28
+
29
+ To access the `public` ([SemVer](https://semver.org/)) APIs, import via `@fluidframework/container-runtime-definitions` like normal.
30
+
31
+ To access the `legacy` APIs, import via `@fluidframework/container-runtime-definitions/legacy`.
32
+
24
33
  ## API Documentation
25
34
 
26
35
  API documentation for **@fluidframework/container-runtime-definitions** is available at <https://fluidframework.com/docs/apis/container-runtime-definitions>.
package/api-extractor/api-extractor.legacy.json ADDED
@@ -0,0 +1,4 @@
1
+ {
2
+ "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
+ "extends": "<projectFolder>/../../../common/build/build-common/api-extractor-base.esm.legacy.json"
4
+ }
package/api-report/container-runtime-definitions.beta.api.md CHANGED
@@ -4,23 +4,6 @@
4
4
 
5
5
  ```ts
6
6
 
7
- import type { AttachState } from '@fluidframework/container-definitions';
8
- import type { FluidObject } from '@fluidframework/core-interfaces';
9
- import type { FlushMode } from '@fluidframework/runtime-definitions/internal';
10
- import type { IClientDetails } from '@fluidframework/driver-definitions';
11
- import type { IContainerRuntimeBase } from '@fluidframework/runtime-definitions/internal';
12
- import type { IContainerRuntimeBaseEvents } from '@fluidframework/runtime-definitions/internal';
13
- import type { IDeltaManager } from '@fluidframework/container-definitions/internal';
14
- import type { IDocumentMessage } from '@fluidframework/driver-definitions/internal';
15
- import type { IDocumentStorageService } from '@fluidframework/driver-definitions/internal';
16
- import type { IEventProvider } from '@fluidframework/core-interfaces';
17
- import type { IFluidHandle } from '@fluidframework/core-interfaces';
18
- import type { IFluidHandleContext } from '@fluidframework/core-interfaces/internal';
19
- import type { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions/internal';
20
- import type { IRequest } from '@fluidframework/core-interfaces';
21
- import type { IResponse } from '@fluidframework/core-interfaces';
22
- import type { ISequencedDocumentMessage } from '@fluidframework/driver-definitions/internal';
23
-
24
7
  // (No @packageDocumentation comment for this package)
25
8
 
26
9
  ```
package/api-report/{container-runtime-definitions.alpha.api.md → container-runtime-definitions.legacy.alpha.api.md} RENAMED
@@ -4,23 +4,6 @@
4
4
 
5
5
  ```ts
6
6
 
7
- import type { AttachState } from '@fluidframework/container-definitions';
8
- import type { FluidObject } from '@fluidframework/core-interfaces';
9
- import type { FlushMode } from '@fluidframework/runtime-definitions/internal';
10
- import type { IClientDetails } from '@fluidframework/driver-definitions';
11
- import type { IContainerRuntimeBase } from '@fluidframework/runtime-definitions/internal';
12
- import type { IContainerRuntimeBaseEvents } from '@fluidframework/runtime-definitions/internal';
13
- import type { IDeltaManager } from '@fluidframework/container-definitions/internal';
14
- import type { IDocumentMessage } from '@fluidframework/driver-definitions/internal';
15
- import type { IDocumentStorageService } from '@fluidframework/driver-definitions/internal';
16
- import type { IEventProvider } from '@fluidframework/core-interfaces';
17
- import type { IFluidHandle } from '@fluidframework/core-interfaces';
18
- import type { IFluidHandleContext } from '@fluidframework/core-interfaces/internal';
19
- import type { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions/internal';
20
- import type { IRequest } from '@fluidframework/core-interfaces';
21
- import type { IResponse } from '@fluidframework/core-interfaces';
22
- import type { ISequencedDocumentMessage } from '@fluidframework/driver-definitions/internal';
23
-
24
7
  // @alpha
25
8
  export interface IContainerRuntime extends IProvideFluidDataStoreRegistry, IContainerRuntimeBaseWithCombinedEvents {
26
9
  readonly attachState: AttachState;
package/api-report/container-runtime-definitions.public.api.md CHANGED
@@ -4,23 +4,6 @@
4
4
 
5
5
  ```ts
6
6
 
7
- import type { AttachState } from '@fluidframework/container-definitions';
8
- import type { FluidObject } from '@fluidframework/core-interfaces';
9
- import type { FlushMode } from '@fluidframework/runtime-definitions/internal';
10
- import type { IClientDetails } from '@fluidframework/driver-definitions';
11
- import type { IContainerRuntimeBase } from '@fluidframework/runtime-definitions/internal';
12
- import type { IContainerRuntimeBaseEvents } from '@fluidframework/runtime-definitions/internal';
13
- import type { IDeltaManager } from '@fluidframework/container-definitions/internal';
14
- import type { IDocumentMessage } from '@fluidframework/driver-definitions/internal';
15
- import type { IDocumentStorageService } from '@fluidframework/driver-definitions/internal';
16
- import type { IEventProvider } from '@fluidframework/core-interfaces';
17
- import type { IFluidHandle } from '@fluidframework/core-interfaces';
18
- import type { IFluidHandleContext } from '@fluidframework/core-interfaces/internal';
19
- import type { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions/internal';
20
- import type { IRequest } from '@fluidframework/core-interfaces';
21
- import type { IResponse } from '@fluidframework/core-interfaces';
22
- import type { ISequencedDocumentMessage } from '@fluidframework/driver-definitions/internal';
23
-
24
7
  // (No @packageDocumentation comment for this package)
25
8
 
26
9
  ```
package/dist/containerRuntime.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 {
package/dist/containerRuntime.d.ts.map CHANGED
@@ -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;;;GAGG;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;;;GAGG;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;;GAEG;AACH,MAAM,MAAM,uCAAuC,GAAG,qBAAqB,GAC1E,cAAc,CAAC,uBAAuB,CAAC,CAAC;AAEzC;;;GAGG;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"}
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
@@ -9,7 +9,7 @@
9
9
  */
10
10
 
11
11
  export {
12
- // @alpha APIs
12
+ // @legacy APIs
13
13
  IContainerRuntime,
14
14
  IContainerRuntimeBaseWithCombinedEvents,
15
15
  IContainerRuntimeEvents,
package/lib/containerRuntime.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 {
package/lib/containerRuntime.d.ts.map CHANGED
@@ -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;;;GAGG;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;;;GAGG;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;;GAEG;AACH,MAAM,MAAM,uCAAuC,GAAG,qBAAqB,GAC1E,cAAc,CAAC,uBAAuB,CAAC,CAAC;AAEzC;;;GAGG;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"}
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
@@ -9,7 +9,7 @@
9
9
  */
10
10
 
11
11
  export {
12
- // @alpha APIs
12
+ // @legacy APIs
13
13
  IContainerRuntime,
14
14
  IContainerRuntimeBaseWithCombinedEvents,
15
15
  IContainerRuntimeEvents,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluidframework/container-runtime-definitions",
3
- "version": "2.0.2",
3
+ "version": "2.1.0-276326",
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.0.2",
45
- "@fluidframework/core-interfaces": "~2.0.2",
46
- "@fluidframework/driver-definitions": "~2.0.2",
47
- "@fluidframework/runtime-definitions": "~2.0.2"
44
+ "@fluidframework/container-definitions": "2.1.0-276326",
45
+ "@fluidframework/core-interfaces": "2.1.0-276326",
46
+ "@fluidframework/driver-definitions": "2.1.0-276326",
47
+ "@fluidframework/runtime-definitions": "2.1.0-276326"
48
48
  },
49
49
  "devDependencies": {
50
50
  "@arethetypeswrong/cli": "^0.15.2",
@@ -52,7 +52,7 @@
52
52
  "@fluid-tools/build-cli": "^0.39.0",
53
53
  "@fluidframework/build-common": "^2.0.3",
54
54
  "@fluidframework/build-tools": "^0.39.0",
55
- "@fluidframework/container-runtime-definitions-previous": "npm:@fluidframework/container-runtime-definitions@2.0.0-rc.4.0.0",
55
+ "@fluidframework/container-runtime-definitions-previous": "npm:@fluidframework/container-runtime-definitions@2.0.0-rc.5.0.0",
56
56
  "@fluidframework/eslint-config-fluid": "^5.3.0",
57
57
  "@microsoft/api-extractor": "^7.45.1",
58
58
  "concurrently": "^8.2.1",
@@ -63,28 +63,17 @@
63
63
  "typescript": "~5.4.5"
64
64
  },
65
65
  "typeValidation": {
66
- "broken": {
67
- "InterfaceDeclaration_IContainerRuntime": {
68
- "backCompat": false,
69
- "forwardCompat": false
70
- },
71
- "InterfaceDeclaration_IContainerRuntimeWithResolveHandle_Deprecated": {
72
- "backCompat": false,
73
- "forwardCompat": false
74
- },
75
- "TypeAliasDeclaration_IContainerRuntimeBaseWithCombinedEvents": {
76
- "backCompat": false,
77
- "forwardCompat": false
78
- }
79
- }
66
+ "broken": {}
80
67
  },
81
68
  "scripts": {
82
69
  "api": "fluid-build . --task api",
83
- "api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",
84
- "api-extractor:esnext": "flub generate entrypoints --outFileAlpha legacy --outDir ./lib --node10TypeCompat",
70
+ "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
71
+ "api-extractor:esnext": "flub generate entrypoints --outDir ./lib --node10TypeCompat",
85
72
  "build": "fluid-build . --task build",
86
73
  "build:compile": "fluid-build . --task compile",
87
- "build:docs": "api-extractor run --local",
74
+ "build:docs": "concurrently \"npm:build:docs:*\"",
75
+ "build:docs:current": "api-extractor run --local",
76
+ "build:docs:legacy": "api-extractor run --local --config api-extractor/api-extractor.legacy.json",
88
77
  "build:esnext": "tsc --project ./tsconfig.json",
89
78
  "build:test": "npm run build:test:esm && npm run build:test:cjs",
90
79
  "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
@@ -99,7 +88,9 @@
99
88
  "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
100
89
  "check:format": "npm run check:biome",
101
90
  "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
102
- "ci:build:docs": "api-extractor run",
91
+ "ci:build:docs": "concurrently \"npm:ci:build:docs:*\"",
92
+ "ci:build:docs:current": "api-extractor run",
93
+ "ci:build:docs:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
103
94
  "clean": "rimraf --glob dist lib \"*.d.ts\" \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",
104
95
  "eslint": "eslint --format stylish src",
105
96
  "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
@@ -109,7 +100,7 @@
109
100
  "lint": "fluid-build . --task lint",
110
101
  "lint:fix": "fluid-build . --task eslint:fix --task format",
111
102
  "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
112
- "typetests:gen": "flub generate typetests --dir . -v --publicFallback",
103
+ "typetests:gen": "flub generate typetests --dir . -v",
113
104
  "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
114
105
  }
115
106
  }
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