@fluidframework/container-runtime-definitions 2.0.0-rc.2.0.2 → 2.0.0-rc.3.0.1
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 +23 -0
- package/api-extractor-lint.json +1 -1
- package/api-extractor.json +1 -1
- package/api-report/container-runtime-definitions.api.md +5 -5
- package/dist/containerRuntime.d.ts +3 -3
- package/dist/containerRuntime.d.ts.map +1 -1
- package/dist/legacy.d.ts +17 -0
- package/dist/package.json +3 -0
- package/dist/public.d.ts +12 -0
- package/internal.d.ts +11 -0
- package/legacy.d.ts +11 -0
- package/{dist/container-runtime-definitions-alpha.d.ts → lib/containerRuntime.d.ts} +66 -78
- package/lib/containerRuntime.d.ts.map +1 -0
- package/lib/index.d.ts +6 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/legacy.d.ts +17 -0
- package/lib/public.d.ts +12 -0
- package/package.json +47 -49
- package/src/containerRuntime.ts +5 -5
- package/tsconfig.cjs.json +7 -0
- package/tsconfig.json +3 -5
- package/dist/container-runtime-definitions-beta.d.ts +0 -36
- package/dist/container-runtime-definitions-public.d.ts +0 -36
- package/dist/container-runtime-definitions-untrimmed.d.ts +0 -78
- package/dist/containerRuntime.js +0 -7
- package/dist/containerRuntime.js.map +0 -1
- package/dist/index.js +0 -7
- package/dist/index.js.map +0 -1
- /package/{dist → lib}/tsdoc-metadata.json +0 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,28 @@
|
|
|
1
1
|
# @fluidframework/container-runtime-definitions
|
|
2
2
|
|
|
3
|
+
## 2.0.0-rc.3.0.0
|
|
4
|
+
|
|
5
|
+
### Major Changes
|
|
6
|
+
|
|
7
|
+
- Packages now use package.json "exports" and require modern module resolution [97d68aa06b](https://github.com/microsoft/FluidFramework/commit/97d68aa06bd5c022ecb026655814aea222a062ae)
|
|
8
|
+
|
|
9
|
+
Fluid Framework packages have been updated to use the [package.json "exports"
|
|
10
|
+
field](https://nodejs.org/docs/latest-v18.x/api/packages.html#exports) to define explicit entry points for both
|
|
11
|
+
TypeScript types and implementation code.
|
|
12
|
+
|
|
13
|
+
This means that using Fluid Framework packages require the following TypeScript settings in tsconfig.json:
|
|
14
|
+
|
|
15
|
+
- `"moduleResolution": "Node16"` with `"module": "Node16"`
|
|
16
|
+
- `"moduleResolution": "Bundler"` with `"module": "ESNext"`
|
|
17
|
+
|
|
18
|
+
We recommend using Node16/Node16 unless absolutely necessary. That will produce transpiled JavaScript that is suitable
|
|
19
|
+
for use with modern versions of Node.js _and_ Bundlers.
|
|
20
|
+
[See the TypeScript documentation](https://www.typescriptlang.org/tsconfig#moduleResolution) for more information
|
|
21
|
+
regarding the module and moduleResolution options.
|
|
22
|
+
|
|
23
|
+
**Node10 moduleResolution is not supported; it does not support Fluid Framework's API structuring pattern that is used
|
|
24
|
+
to distinguish stable APIs from those that are in development.**
|
|
25
|
+
|
|
3
26
|
## 2.0.0-rc.2.0.0
|
|
4
27
|
|
|
5
28
|
### Minor Changes
|
package/api-extractor-lint.json
CHANGED
package/api-extractor.json
CHANGED
|
@@ -6,17 +6,17 @@
|
|
|
6
6
|
|
|
7
7
|
import type { AttachState } from '@fluidframework/container-definitions';
|
|
8
8
|
import type { FluidObject } from '@fluidframework/core-interfaces';
|
|
9
|
-
import { FlushMode } from '@fluidframework/runtime-definitions';
|
|
9
|
+
import { FlushMode } from '@fluidframework/runtime-definitions/internal';
|
|
10
10
|
import { IClientDetails } from '@fluidframework/protocol-definitions';
|
|
11
|
-
import { IContainerRuntimeBase } from '@fluidframework/runtime-definitions';
|
|
12
|
-
import { IContainerRuntimeBaseEvents } from '@fluidframework/runtime-definitions';
|
|
11
|
+
import { IContainerRuntimeBase } from '@fluidframework/runtime-definitions/internal';
|
|
12
|
+
import { IContainerRuntimeBaseEvents } from '@fluidframework/runtime-definitions/internal';
|
|
13
13
|
import type { IDeltaManager } from '@fluidframework/container-definitions';
|
|
14
14
|
import { IDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
15
|
-
import type { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
15
|
+
import type { IDocumentStorageService } from '@fluidframework/driver-definitions/internal';
|
|
16
16
|
import type { IEventProvider } from '@fluidframework/core-interfaces';
|
|
17
17
|
import type { IFluidHandle } from '@fluidframework/core-interfaces';
|
|
18
18
|
import type { IFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
19
|
-
import { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions';
|
|
19
|
+
import { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions/internal';
|
|
20
20
|
import type { IRequest } from '@fluidframework/core-interfaces';
|
|
21
21
|
import type { IResponse } from '@fluidframework/core-interfaces';
|
|
22
22
|
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
* Licensed under the MIT License.
|
|
4
4
|
*/
|
|
5
5
|
import type { AttachState, IDeltaManager } from "@fluidframework/container-definitions";
|
|
6
|
-
import type {
|
|
7
|
-
import type { IDocumentStorageService } from "@fluidframework/driver-definitions";
|
|
6
|
+
import type { FluidObject, IEventProvider, IFluidHandle, IFluidHandleContext, IRequest, IResponse } from "@fluidframework/core-interfaces";
|
|
7
|
+
import type { IDocumentStorageService } from "@fluidframework/driver-definitions/internal";
|
|
8
8
|
import { type IClientDetails, type IDocumentMessage, type ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
|
|
9
|
-
import { type FlushMode, type IContainerRuntimeBase, type IContainerRuntimeBaseEvents, type IProvideFluidDataStoreRegistry } from "@fluidframework/runtime-definitions";
|
|
9
|
+
import { type FlushMode, type IContainerRuntimeBase, type IContainerRuntimeBaseEvents, type IProvideFluidDataStoreRegistry } from "@fluidframework/runtime-definitions/internal";
|
|
10
10
|
/**
|
|
11
11
|
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
12
12
|
* @alpha
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"containerRuntime.d.ts","sourceRoot":"","sources":["../src/containerRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACxF,OAAO,KAAK,EACX,cAAc,EACd,QAAQ,EACR,SAAS,EACT,
|
|
1
|
+
{"version":3,"file":"containerRuntime.d.ts","sourceRoot":"","sources":["../src/containerRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACxF,OAAO,KAAK,EACX,WAAW,EACX,cAAc,EACd,YAAY,EACZ,mBAAmB,EACnB,QAAQ,EACR,SAAS,EACT,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AAC3F,OAAO,EACN,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,yBAAyB,EAC9B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACN,KAAK,SAAS,EACd,KAAK,qBAAqB,EAC1B,KAAK,2BAA2B,EAChC,KAAK,8BAA8B,EACnC,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"}
|
package/dist/legacy.d.ts
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
+
* Licensed under the MIT License.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
/*
|
|
7
|
+
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
|
8
|
+
* Generated by "flub generate entrypoints" in @fluidframework/build-tools.
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
export {
|
|
12
|
+
// alpha APIs
|
|
13
|
+
IContainerRuntime,
|
|
14
|
+
IContainerRuntimeBaseWithCombinedEvents,
|
|
15
|
+
IContainerRuntimeEvents,
|
|
16
|
+
IContainerRuntimeWithResolveHandle_Deprecated
|
|
17
|
+
} from "./index.js";
|
package/dist/public.d.ts
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
+
* Licensed under the MIT License.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
/*
|
|
7
|
+
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
|
8
|
+
* Generated by "flub generate entrypoints" in @fluidframework/build-tools.
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
export {}
|
|
12
|
+
|
package/internal.d.ts
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
+
* Licensed under the MIT License.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
/*
|
|
7
|
+
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
|
8
|
+
* Generated by "flub generate entrypoints" in @fluidframework/build-tools.
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
export type * from "./lib/index.d.ts";
|
package/legacy.d.ts
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
+
* Licensed under the MIT License.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
/*
|
|
7
|
+
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
|
8
|
+
* Generated by "flub generate entrypoints" in @fluidframework/build-tools.
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
export type * from "./lib/legacy.d.ts";
|
|
@@ -1,78 +1,66 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
7
|
-
import type {
|
|
8
|
-
import { IDocumentMessage } from
|
|
9
|
-
import type
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
/**
|
|
19
|
-
*
|
|
20
|
-
* @alpha
|
|
21
|
-
*/
|
|
22
|
-
export
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
*
|
|
45
|
-
*/
|
|
46
|
-
readonly
|
|
47
|
-
/**
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
* @
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
}
|
|
68
|
-
|
|
69
|
-
/**
|
|
70
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
71
|
-
* @alpha
|
|
72
|
-
*/
|
|
73
|
-
export declare interface IContainerRuntimeWithResolveHandle_Deprecated extends IContainerRuntime {
|
|
74
|
-
readonly IFluidHandleContext: IFluidHandleContext;
|
|
75
|
-
resolveHandle(request: IRequest): Promise<IResponse>;
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
export { }
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
+
* Licensed under the MIT License.
|
|
4
|
+
*/
|
|
5
|
+
import type { AttachState, IDeltaManager } from "@fluidframework/container-definitions";
|
|
6
|
+
import type { FluidObject, IEventProvider, IFluidHandle, IFluidHandleContext, IRequest, IResponse } from "@fluidframework/core-interfaces";
|
|
7
|
+
import type { IDocumentStorageService } from "@fluidframework/driver-definitions/internal";
|
|
8
|
+
import { type IClientDetails, type IDocumentMessage, type ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
|
|
9
|
+
import { type FlushMode, type IContainerRuntimeBase, type IContainerRuntimeBaseEvents, type IProvideFluidDataStoreRegistry } from "@fluidframework/runtime-definitions/internal";
|
|
10
|
+
/**
|
|
11
|
+
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
12
|
+
* @alpha
|
|
13
|
+
*/
|
|
14
|
+
export interface IContainerRuntimeWithResolveHandle_Deprecated extends IContainerRuntime {
|
|
15
|
+
readonly IFluidHandleContext: IFluidHandleContext;
|
|
16
|
+
resolveHandle(request: IRequest): Promise<IResponse>;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Events emitted by {@link IContainerRuntime}.
|
|
20
|
+
* @alpha
|
|
21
|
+
*/
|
|
22
|
+
export interface IContainerRuntimeEvents extends IContainerRuntimeBaseEvents {
|
|
23
|
+
(event: "dirty" | "disconnected" | "saved" | "attached", listener: () => void): any;
|
|
24
|
+
(event: "connected", listener: (clientId: string) => void): any;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* @alpha
|
|
28
|
+
*/
|
|
29
|
+
export type IContainerRuntimeBaseWithCombinedEvents = IContainerRuntimeBase & IEventProvider<IContainerRuntimeEvents>;
|
|
30
|
+
/**
|
|
31
|
+
* Represents the runtime of the container. Contains helper functions/state of the container.
|
|
32
|
+
* @alpha
|
|
33
|
+
*/
|
|
34
|
+
export interface IContainerRuntime extends IProvideFluidDataStoreRegistry, IContainerRuntimeBaseWithCombinedEvents {
|
|
35
|
+
readonly options: Record<string | number, any>;
|
|
36
|
+
readonly clientId: string | undefined;
|
|
37
|
+
readonly clientDetails: IClientDetails;
|
|
38
|
+
readonly connected: boolean;
|
|
39
|
+
readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
|
|
40
|
+
readonly storage: IDocumentStorageService;
|
|
41
|
+
readonly flushMode: FlushMode;
|
|
42
|
+
readonly scope: FluidObject;
|
|
43
|
+
/**
|
|
44
|
+
* Indicates the attachment state of the container to a host service.
|
|
45
|
+
*/
|
|
46
|
+
readonly attachState: AttachState;
|
|
47
|
+
/**
|
|
48
|
+
* Returns the aliased data store's entryPoint, given the alias.
|
|
49
|
+
* @param alias - The alias for the data store.
|
|
50
|
+
* @returns The data store's entry point ({@link @fluidframework/core-interfaces#IFluidHandle}) if it exists and is aliased.
|
|
51
|
+
* Returns undefined if no data store has been assigned the given alias.
|
|
52
|
+
*/
|
|
53
|
+
getAliasedDataStoreEntryPoint(alias: string): Promise<IFluidHandle<FluidObject> | undefined>;
|
|
54
|
+
/**
|
|
55
|
+
* Returns true if document is dirty, i.e. there are some pending local changes that
|
|
56
|
+
* either were not sent out to delta stream or were not yet acknowledged.
|
|
57
|
+
*/
|
|
58
|
+
readonly isDirty: boolean;
|
|
59
|
+
/**
|
|
60
|
+
* Get an absolute url for a provided container-relative request.
|
|
61
|
+
* Returns undefined if the container isn't attached to storage.
|
|
62
|
+
* @param relativeUrl - A relative request within the container
|
|
63
|
+
*/
|
|
64
|
+
getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
|
|
65
|
+
}
|
|
66
|
+
//# sourceMappingURL=containerRuntime.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"containerRuntime.d.ts","sourceRoot":"","sources":["../src/containerRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACxF,OAAO,KAAK,EACX,WAAW,EACX,cAAc,EACd,YAAY,EACZ,mBAAmB,EACnB,QAAQ,EACR,SAAS,EACT,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AAC3F,OAAO,EACN,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,yBAAyB,EAC9B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACN,KAAK,SAAS,EACd,KAAK,qBAAqB,EAC1B,KAAK,2BAA2B,EAChC,KAAK,8BAA8B,EACnC,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"}
|
package/lib/index.d.ts
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
+
* Licensed under the MIT License.
|
|
4
|
+
*/
|
|
5
|
+
export type { IContainerRuntime, IContainerRuntimeBaseWithCombinedEvents, IContainerRuntimeEvents, IContainerRuntimeWithResolveHandle_Deprecated, } from "./containerRuntime.js";
|
|
6
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EACX,iBAAiB,EACjB,uCAAuC,EACvC,uBAAuB,EACvB,6CAA6C,GAC7C,MAAM,uBAAuB,CAAC"}
|
package/lib/legacy.d.ts
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
+
* Licensed under the MIT License.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
/*
|
|
7
|
+
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
|
8
|
+
* Generated by "flub generate entrypoints" in @fluidframework/build-tools.
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
export {
|
|
12
|
+
// alpha APIs
|
|
13
|
+
IContainerRuntime,
|
|
14
|
+
IContainerRuntimeBaseWithCombinedEvents,
|
|
15
|
+
IContainerRuntimeEvents,
|
|
16
|
+
IContainerRuntimeWithResolveHandle_Deprecated
|
|
17
|
+
} from "./index.js";
|
package/lib/public.d.ts
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
+
* Licensed under the MIT License.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
/*
|
|
7
|
+
* THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
|
8
|
+
* Generated by "flub generate entrypoints" in @fluidframework/build-tools.
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
export {}
|
|
12
|
+
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/container-runtime-definitions",
|
|
3
|
-
"version": "2.0.0-rc.
|
|
3
|
+
"version": "2.0.0-rc.3.0.1",
|
|
4
4
|
"description": "Fluid Runtime definitions",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -11,45 +11,50 @@
|
|
|
11
11
|
"license": "MIT",
|
|
12
12
|
"author": "Microsoft and contributors",
|
|
13
13
|
"sideEffects": false,
|
|
14
|
-
"type": "
|
|
14
|
+
"type": "module",
|
|
15
15
|
"exports": {
|
|
16
16
|
".": {
|
|
17
|
-
"
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
17
|
+
"import": {
|
|
18
|
+
"types": "./lib/public.d.ts"
|
|
19
|
+
},
|
|
20
|
+
"require": {
|
|
21
|
+
"types": "./dist/public.d.ts"
|
|
22
|
+
}
|
|
23
23
|
},
|
|
24
|
-
"./
|
|
25
|
-
"
|
|
26
|
-
|
|
24
|
+
"./legacy": {
|
|
25
|
+
"import": {
|
|
26
|
+
"types": "./lib/legacy.d.ts"
|
|
27
|
+
},
|
|
28
|
+
"require": {
|
|
29
|
+
"types": "./dist/legacy.d.ts"
|
|
30
|
+
}
|
|
27
31
|
},
|
|
28
32
|
"./internal": {
|
|
29
|
-
"
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
33
|
+
"import": {
|
|
34
|
+
"types": "./lib/index.d.ts"
|
|
35
|
+
},
|
|
36
|
+
"require": {
|
|
37
|
+
"types": "./dist/index.d.ts"
|
|
38
|
+
}
|
|
35
39
|
}
|
|
36
40
|
},
|
|
37
|
-
"main": "
|
|
38
|
-
"types": "
|
|
41
|
+
"main": "",
|
|
42
|
+
"types": "lib/public.d.ts",
|
|
39
43
|
"dependencies": {
|
|
40
|
-
"@fluidframework/container-definitions": ">=2.0.0-rc.
|
|
41
|
-
"@fluidframework/core-interfaces": ">=2.0.0-rc.
|
|
42
|
-
"@fluidframework/driver-definitions": ">=2.0.0-rc.
|
|
44
|
+
"@fluidframework/container-definitions": ">=2.0.0-rc.3.0.1 <2.0.0-rc.3.1.0",
|
|
45
|
+
"@fluidframework/core-interfaces": ">=2.0.0-rc.3.0.1 <2.0.0-rc.3.1.0",
|
|
46
|
+
"@fluidframework/driver-definitions": ">=2.0.0-rc.3.0.1 <2.0.0-rc.3.1.0",
|
|
43
47
|
"@fluidframework/protocol-definitions": "^3.2.0",
|
|
44
|
-
"@fluidframework/runtime-definitions": ">=2.0.0-rc.
|
|
48
|
+
"@fluidframework/runtime-definitions": ">=2.0.0-rc.3.0.1 <2.0.0-rc.3.1.0"
|
|
45
49
|
},
|
|
46
50
|
"devDependencies": {
|
|
47
|
-
"@arethetypeswrong/cli": "^0.
|
|
48
|
-
"@
|
|
51
|
+
"@arethetypeswrong/cli": "^0.15.2",
|
|
52
|
+
"@biomejs/biome": "^1.6.2",
|
|
53
|
+
"@fluid-tools/build-cli": "^0.37.0",
|
|
49
54
|
"@fluidframework/build-common": "^2.0.3",
|
|
50
|
-
"@fluidframework/build-tools": "^0.
|
|
55
|
+
"@fluidframework/build-tools": "^0.37.0",
|
|
51
56
|
"@fluidframework/container-runtime-definitions-previous": "npm:@fluidframework/container-runtime-definitions@2.0.0-internal.8.0.0",
|
|
52
|
-
"@fluidframework/eslint-config-fluid": "^
|
|
57
|
+
"@fluidframework/eslint-config-fluid": "^5.1.0",
|
|
53
58
|
"@microsoft/api-extractor": "^7.42.3",
|
|
54
59
|
"copyfiles": "^2.4.1",
|
|
55
60
|
"eslint": "~8.55.0",
|
|
@@ -57,17 +62,6 @@
|
|
|
57
62
|
"rimraf": "^4.4.0",
|
|
58
63
|
"typescript": "~5.1.6"
|
|
59
64
|
},
|
|
60
|
-
"fluidBuild": {
|
|
61
|
-
"tasks": {
|
|
62
|
-
"build:docs": {
|
|
63
|
-
"dependsOn": [
|
|
64
|
-
"...",
|
|
65
|
-
"api-extractor:commonjs"
|
|
66
|
-
],
|
|
67
|
-
"script": false
|
|
68
|
-
}
|
|
69
|
-
}
|
|
70
|
-
},
|
|
71
65
|
"typeValidation": {
|
|
72
66
|
"broken": {
|
|
73
67
|
"InterfaceDeclaration_IContainerRuntime": {
|
|
@@ -85,23 +79,27 @@
|
|
|
85
79
|
},
|
|
86
80
|
"scripts": {
|
|
87
81
|
"api": "fluid-build . --task api",
|
|
88
|
-
"api-extractor:commonjs": "
|
|
82
|
+
"api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",
|
|
83
|
+
"api-extractor:esnext": "flub generate entrypoints --outFileAlpha legacy --outDir ./lib --node10TypeCompat",
|
|
89
84
|
"build": "fluid-build . --task build",
|
|
90
85
|
"build:compile": "fluid-build . --task compile",
|
|
91
|
-
"build:docs": "
|
|
92
|
-
"build:
|
|
93
|
-
"
|
|
86
|
+
"build:docs": "api-extractor run --local",
|
|
87
|
+
"build:esnext": "tsc --project ./tsconfig.json",
|
|
88
|
+
"build:test": "npm run build:test:esm && npm run build:test:cjs",
|
|
89
|
+
"build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
|
|
90
|
+
"build:test:esm": "tsc --project ./src/test/tsconfig.json",
|
|
91
|
+
"check:are-the-types-wrong": "attw --pack .",
|
|
92
|
+
"check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
|
|
94
93
|
"check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
|
|
95
94
|
"ci:build:docs": "api-extractor run",
|
|
96
|
-
"clean": "rimraf --glob dist \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",
|
|
95
|
+
"clean": "rimraf --glob dist lib \"*.d.ts\" \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp",
|
|
97
96
|
"eslint": "eslint --format stylish src",
|
|
98
97
|
"eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
|
|
99
|
-
"format": "
|
|
100
|
-
"
|
|
101
|
-
"lint
|
|
102
|
-
"
|
|
103
|
-
"
|
|
104
|
-
"tsc": "tsc",
|
|
98
|
+
"format": "fluid-build --task format .",
|
|
99
|
+
"format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",
|
|
100
|
+
"lint": "fluid-build . --task lint",
|
|
101
|
+
"lint:fix": "fluid-build . --task eslint:fix --task format",
|
|
102
|
+
"tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
|
|
105
103
|
"typetests:gen": "fluid-type-test-generator",
|
|
106
104
|
"typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
|
|
107
105
|
}
|
package/src/containerRuntime.ts
CHANGED
|
@@ -5,14 +5,14 @@
|
|
|
5
5
|
|
|
6
6
|
import type { AttachState, IDeltaManager } from "@fluidframework/container-definitions";
|
|
7
7
|
import type {
|
|
8
|
-
IEventProvider,
|
|
9
|
-
IRequest,
|
|
10
|
-
IResponse,
|
|
11
8
|
FluidObject,
|
|
9
|
+
IEventProvider,
|
|
12
10
|
IFluidHandle,
|
|
13
11
|
IFluidHandleContext,
|
|
12
|
+
IRequest,
|
|
13
|
+
IResponse,
|
|
14
14
|
} from "@fluidframework/core-interfaces";
|
|
15
|
-
import type { IDocumentStorageService } from "@fluidframework/driver-definitions";
|
|
15
|
+
import type { IDocumentStorageService } from "@fluidframework/driver-definitions/internal";
|
|
16
16
|
import {
|
|
17
17
|
type IClientDetails,
|
|
18
18
|
type IDocumentMessage,
|
|
@@ -23,7 +23,7 @@ import {
|
|
|
23
23
|
type IContainerRuntimeBase,
|
|
24
24
|
type IContainerRuntimeBaseEvents,
|
|
25
25
|
type IProvideFluidDataStoreRegistry,
|
|
26
|
-
} from "@fluidframework/runtime-definitions";
|
|
26
|
+
} from "@fluidframework/runtime-definitions/internal";
|
|
27
27
|
|
|
28
28
|
/**
|
|
29
29
|
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
package/tsconfig.json
CHANGED
|
@@ -1,12 +1,10 @@
|
|
|
1
1
|
{
|
|
2
|
-
"extends":
|
|
3
|
-
"../../../common/build/build-common/tsconfig.base.json",
|
|
4
|
-
"../../../common/build/build-common/tsconfig.esm-only.json",
|
|
5
|
-
],
|
|
2
|
+
"extends": "../../../common/build/build-common/tsconfig.node16.json",
|
|
6
3
|
"include": ["src/**/*"],
|
|
7
4
|
"exclude": ["src/test/**/*"],
|
|
8
5
|
"compilerOptions": {
|
|
9
6
|
"rootDir": "./src",
|
|
10
|
-
"outDir": "./
|
|
7
|
+
"outDir": "./lib",
|
|
8
|
+
"emitDeclarationOnly": true,
|
|
11
9
|
},
|
|
12
10
|
}
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
import type { AttachState } from '@fluidframework/container-definitions';
|
|
2
|
-
import type { FluidObject } from '@fluidframework/core-interfaces';
|
|
3
|
-
import { FlushMode } from '@fluidframework/runtime-definitions';
|
|
4
|
-
import { IClientDetails } from '@fluidframework/protocol-definitions';
|
|
5
|
-
import { IContainerRuntimeBase } from '@fluidframework/runtime-definitions';
|
|
6
|
-
import { IContainerRuntimeBaseEvents } from '@fluidframework/runtime-definitions';
|
|
7
|
-
import type { IDeltaManager } from '@fluidframework/container-definitions';
|
|
8
|
-
import { IDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
9
|
-
import type { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
10
|
-
import type { IEventProvider } from '@fluidframework/core-interfaces';
|
|
11
|
-
import type { IFluidHandle } from '@fluidframework/core-interfaces';
|
|
12
|
-
import type { IFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
13
|
-
import { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions';
|
|
14
|
-
import type { IRequest } from '@fluidframework/core-interfaces';
|
|
15
|
-
import type { IResponse } from '@fluidframework/core-interfaces';
|
|
16
|
-
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
17
|
-
|
|
18
|
-
/* Excluded from this release type: FlushMode */
|
|
19
|
-
|
|
20
|
-
/* Excluded from this release type: IContainerRuntime */
|
|
21
|
-
|
|
22
|
-
/* Excluded from this release type: IContainerRuntimeBase */
|
|
23
|
-
|
|
24
|
-
/* Excluded from this release type: IContainerRuntimeBaseEvents */
|
|
25
|
-
|
|
26
|
-
/* Excluded from this release type: IContainerRuntimeBaseWithCombinedEvents */
|
|
27
|
-
|
|
28
|
-
/* Excluded from this release type: IContainerRuntimeEvents */
|
|
29
|
-
|
|
30
|
-
/* Excluded from this release type: IContainerRuntimeWithResolveHandle_Deprecated */
|
|
31
|
-
|
|
32
|
-
/* Excluded from this release type: IDocumentStorageService */
|
|
33
|
-
|
|
34
|
-
/* Excluded from this release type: IProvideFluidDataStoreRegistry */
|
|
35
|
-
|
|
36
|
-
export { }
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
import type { AttachState } from '@fluidframework/container-definitions';
|
|
2
|
-
import type { FluidObject } from '@fluidframework/core-interfaces';
|
|
3
|
-
import { FlushMode } from '@fluidframework/runtime-definitions';
|
|
4
|
-
import { IClientDetails } from '@fluidframework/protocol-definitions';
|
|
5
|
-
import { IContainerRuntimeBase } from '@fluidframework/runtime-definitions';
|
|
6
|
-
import { IContainerRuntimeBaseEvents } from '@fluidframework/runtime-definitions';
|
|
7
|
-
import type { IDeltaManager } from '@fluidframework/container-definitions';
|
|
8
|
-
import { IDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
9
|
-
import type { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
10
|
-
import type { IEventProvider } from '@fluidframework/core-interfaces';
|
|
11
|
-
import type { IFluidHandle } from '@fluidframework/core-interfaces';
|
|
12
|
-
import type { IFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
13
|
-
import { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions';
|
|
14
|
-
import type { IRequest } from '@fluidframework/core-interfaces';
|
|
15
|
-
import type { IResponse } from '@fluidframework/core-interfaces';
|
|
16
|
-
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
17
|
-
|
|
18
|
-
/* Excluded from this release type: FlushMode */
|
|
19
|
-
|
|
20
|
-
/* Excluded from this release type: IContainerRuntime */
|
|
21
|
-
|
|
22
|
-
/* Excluded from this release type: IContainerRuntimeBase */
|
|
23
|
-
|
|
24
|
-
/* Excluded from this release type: IContainerRuntimeBaseEvents */
|
|
25
|
-
|
|
26
|
-
/* Excluded from this release type: IContainerRuntimeBaseWithCombinedEvents */
|
|
27
|
-
|
|
28
|
-
/* Excluded from this release type: IContainerRuntimeEvents */
|
|
29
|
-
|
|
30
|
-
/* Excluded from this release type: IContainerRuntimeWithResolveHandle_Deprecated */
|
|
31
|
-
|
|
32
|
-
/* Excluded from this release type: IDocumentStorageService */
|
|
33
|
-
|
|
34
|
-
/* Excluded from this release type: IProvideFluidDataStoreRegistry */
|
|
35
|
-
|
|
36
|
-
export { }
|
|
@@ -1,78 +0,0 @@
|
|
|
1
|
-
import type { AttachState } from '@fluidframework/container-definitions';
|
|
2
|
-
import type { FluidObject } from '@fluidframework/core-interfaces';
|
|
3
|
-
import { FlushMode } from '@fluidframework/runtime-definitions';
|
|
4
|
-
import { IClientDetails } from '@fluidframework/protocol-definitions';
|
|
5
|
-
import { IContainerRuntimeBase } from '@fluidframework/runtime-definitions';
|
|
6
|
-
import { IContainerRuntimeBaseEvents } from '@fluidframework/runtime-definitions';
|
|
7
|
-
import type { IDeltaManager } from '@fluidframework/container-definitions';
|
|
8
|
-
import { IDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
9
|
-
import type { IDocumentStorageService } from '@fluidframework/driver-definitions';
|
|
10
|
-
import type { IEventProvider } from '@fluidframework/core-interfaces';
|
|
11
|
-
import type { IFluidHandle } from '@fluidframework/core-interfaces';
|
|
12
|
-
import type { IFluidHandleContext } from '@fluidframework/core-interfaces';
|
|
13
|
-
import { IProvideFluidDataStoreRegistry } from '@fluidframework/runtime-definitions';
|
|
14
|
-
import type { IRequest } from '@fluidframework/core-interfaces';
|
|
15
|
-
import type { IResponse } from '@fluidframework/core-interfaces';
|
|
16
|
-
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
17
|
-
|
|
18
|
-
/**
|
|
19
|
-
* Represents the runtime of the container. Contains helper functions/state of the container.
|
|
20
|
-
* @alpha
|
|
21
|
-
*/
|
|
22
|
-
export declare interface IContainerRuntime extends IProvideFluidDataStoreRegistry, IContainerRuntimeBaseWithCombinedEvents {
|
|
23
|
-
readonly options: Record<string | number, any>;
|
|
24
|
-
readonly clientId: string | undefined;
|
|
25
|
-
readonly clientDetails: IClientDetails;
|
|
26
|
-
readonly connected: boolean;
|
|
27
|
-
readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;
|
|
28
|
-
readonly storage: IDocumentStorageService;
|
|
29
|
-
readonly flushMode: FlushMode;
|
|
30
|
-
readonly scope: FluidObject;
|
|
31
|
-
/**
|
|
32
|
-
* Indicates the attachment state of the container to a host service.
|
|
33
|
-
*/
|
|
34
|
-
readonly attachState: AttachState;
|
|
35
|
-
/**
|
|
36
|
-
* Returns the aliased data store's entryPoint, given the alias.
|
|
37
|
-
* @param alias - The alias for the data store.
|
|
38
|
-
* @returns The data store's entry point ({@link @fluidframework/core-interfaces#IFluidHandle}) if it exists and is aliased.
|
|
39
|
-
* Returns undefined if no data store has been assigned the given alias.
|
|
40
|
-
*/
|
|
41
|
-
getAliasedDataStoreEntryPoint(alias: string): Promise<IFluidHandle<FluidObject> | undefined>;
|
|
42
|
-
/**
|
|
43
|
-
* Returns true if document is dirty, i.e. there are some pending local changes that
|
|
44
|
-
* either were not sent out to delta stream or were not yet acknowledged.
|
|
45
|
-
*/
|
|
46
|
-
readonly isDirty: boolean;
|
|
47
|
-
/**
|
|
48
|
-
* Get an absolute url for a provided container-relative request.
|
|
49
|
-
* Returns undefined if the container isn't attached to storage.
|
|
50
|
-
* @param relativeUrl - A relative request within the container
|
|
51
|
-
*/
|
|
52
|
-
getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
/**
|
|
56
|
-
* @alpha
|
|
57
|
-
*/
|
|
58
|
-
export declare type IContainerRuntimeBaseWithCombinedEvents = IContainerRuntimeBase & IEventProvider<IContainerRuntimeEvents>;
|
|
59
|
-
|
|
60
|
-
/**
|
|
61
|
-
* Events emitted by {@link IContainerRuntime}.
|
|
62
|
-
* @alpha
|
|
63
|
-
*/
|
|
64
|
-
export declare interface IContainerRuntimeEvents extends IContainerRuntimeBaseEvents {
|
|
65
|
-
(event: "dirty" | "disconnected" | "saved" | "attached", listener: () => void): any;
|
|
66
|
-
(event: "connected", listener: (clientId: string) => void): any;
|
|
67
|
-
}
|
|
68
|
-
|
|
69
|
-
/**
|
|
70
|
-
* @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
|
|
71
|
-
* @alpha
|
|
72
|
-
*/
|
|
73
|
-
export declare interface IContainerRuntimeWithResolveHandle_Deprecated extends IContainerRuntime {
|
|
74
|
-
readonly IFluidHandleContext: IFluidHandleContext;
|
|
75
|
-
resolveHandle(request: IRequest): Promise<IResponse>;
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
export { }
|
package/dist/containerRuntime.js
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"containerRuntime.js","sourceRoot":"","sources":["../src/containerRuntime.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { AttachState, IDeltaManager } from \"@fluidframework/container-definitions\";\nimport type {\n\tIEventProvider,\n\tIRequest,\n\tIResponse,\n\tFluidObject,\n\tIFluidHandle,\n\tIFluidHandleContext,\n} from \"@fluidframework/core-interfaces\";\nimport type { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport {\n\ttype IClientDetails,\n\ttype IDocumentMessage,\n\ttype ISequencedDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport {\n\ttype FlushMode,\n\ttype IContainerRuntimeBase,\n\ttype IContainerRuntimeBaseEvents,\n\ttype IProvideFluidDataStoreRegistry,\n} from \"@fluidframework/runtime-definitions\";\n\n/**\n * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the \"entryPoint\" pattern. Refer to Removing-IFluidRouter.md\n * @alpha\n */\nexport interface IContainerRuntimeWithResolveHandle_Deprecated extends IContainerRuntime {\n\treadonly IFluidHandleContext: IFluidHandleContext;\n\tresolveHandle(request: IRequest): Promise<IResponse>;\n}\n\n/**\n * Events emitted by {@link IContainerRuntime}.\n * @alpha\n */\nexport interface IContainerRuntimeEvents extends IContainerRuntimeBaseEvents {\n\t(event: \"dirty\" | \"disconnected\" | \"saved\" | \"attached\", listener: () => void);\n\t(event: \"connected\", listener: (clientId: string) => void);\n}\n\n/**\n * @alpha\n */\nexport type IContainerRuntimeBaseWithCombinedEvents = IContainerRuntimeBase &\n\tIEventProvider<IContainerRuntimeEvents>;\n\n/**\n * Represents the runtime of the container. Contains helper functions/state of the container.\n * @alpha\n */\nexport interface IContainerRuntime\n\textends IProvideFluidDataStoreRegistry,\n\t\tIContainerRuntimeBaseWithCombinedEvents {\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\treadonly options: Record<string | number, any>;\n\treadonly clientId: string | undefined;\n\treadonly clientDetails: IClientDetails;\n\treadonly connected: boolean;\n\treadonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n\treadonly storage: IDocumentStorageService;\n\treadonly flushMode: FlushMode;\n\treadonly scope: FluidObject;\n\t/**\n\t * Indicates the attachment state of the container to a host service.\n\t */\n\treadonly attachState: AttachState;\n\n\t/**\n\t * Returns the aliased data store's entryPoint, given the alias.\n\t * @param alias - The alias for the data store.\n\t * @returns The data store's entry point ({@link @fluidframework/core-interfaces#IFluidHandle}) if it exists and is aliased.\n\t * Returns undefined if no data store has been assigned the given alias.\n\t */\n\tgetAliasedDataStoreEntryPoint(alias: string): Promise<IFluidHandle<FluidObject> | undefined>;\n\n\t/**\n\t * Returns true if document is dirty, i.e. there are some pending local changes that\n\t * either were not sent out to delta stream or were not yet acknowledged.\n\t */\n\treadonly isDirty: boolean;\n\n\t/**\n\t * Get an absolute url for a provided container-relative request.\n\t * Returns undefined if the container 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"]}
|
package/dist/index.js
DELETED
package/dist/index.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport type {\n\tIContainerRuntime,\n\tIContainerRuntimeBaseWithCombinedEvents,\n\tIContainerRuntimeEvents,\n\tIContainerRuntimeWithResolveHandle_Deprecated,\n} from \"./containerRuntime.js\";\n"]}
|
|
File without changes
|