@fluidframework/fluid-static 2.0.0-dev-rc.5.0.0.267932 → 2.0.0-dev-rc.5.0.0.268409
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.
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## API Report File for "@fluidframework/fluid-static"
|
|
1
|
+
## Alpha API Report File for "@fluidframework/fluid-static"
|
|
2
2
|
|
|
3
3
|
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
4
|
|
|
@@ -27,24 +27,6 @@ export interface ContainerSchema {
|
|
|
27
27
|
readonly initialObjects: Record<string, SharedObjectKind>;
|
|
28
28
|
}
|
|
29
29
|
|
|
30
|
-
// @internal
|
|
31
|
-
export function createDOProviderContainerRuntimeFactory(props: {
|
|
32
|
-
schema: ContainerSchema;
|
|
33
|
-
compatibilityMode: CompatibilityMode;
|
|
34
|
-
}): IRuntimeFactory;
|
|
35
|
-
|
|
36
|
-
// @internal
|
|
37
|
-
export function createFluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema>(props: {
|
|
38
|
-
container: IContainer;
|
|
39
|
-
rootDataObject: IRootDataObject;
|
|
40
|
-
}): IFluidContainer<TContainerSchema>;
|
|
41
|
-
|
|
42
|
-
// @internal
|
|
43
|
-
export function createServiceAudience<TMember extends IMember = IMember>(props: {
|
|
44
|
-
container: IContainer;
|
|
45
|
-
createServiceMember: (audienceMember: IClient) => TMember;
|
|
46
|
-
}): IServiceAudience<TMember>;
|
|
47
|
-
|
|
48
30
|
// @public
|
|
49
31
|
export interface IConnection {
|
|
50
32
|
readonly id: string;
|
|
@@ -85,18 +67,6 @@ export type InitialObjects<T extends ContainerSchema> = {
|
|
|
85
67
|
[K in keyof T["initialObjects"]]: T["initialObjects"][K] extends SharedObjectKind<infer TChannel> ? TChannel : never;
|
|
86
68
|
};
|
|
87
69
|
|
|
88
|
-
// @internal (undocumented)
|
|
89
|
-
export interface IProvideRootDataObject {
|
|
90
|
-
// (undocumented)
|
|
91
|
-
readonly IRootDataObject: IRootDataObject;
|
|
92
|
-
}
|
|
93
|
-
|
|
94
|
-
// @internal
|
|
95
|
-
export interface IRootDataObject extends IProvideRootDataObject {
|
|
96
|
-
create<T>(objectClass: SharedObjectKind<T>): Promise<T>;
|
|
97
|
-
readonly initialObjects: LoadableObjectRecord;
|
|
98
|
-
}
|
|
99
|
-
|
|
100
70
|
// @public
|
|
101
71
|
export interface IServiceAudience<M extends IMember> extends IEventProvider<IServiceAudienceEvents<M>> {
|
|
102
72
|
getMembers(): ReadonlyMap<string, M>;
|
|
@@ -113,9 +83,6 @@ export interface IServiceAudienceEvents<M extends IMember> extends IEvent {
|
|
|
113
83
|
(event: "memberRemoved", listener: MemberChangedListener<M>): void;
|
|
114
84
|
}
|
|
115
85
|
|
|
116
|
-
// @internal
|
|
117
|
-
export type LoadableObjectRecord = Record<string, IFluidLoadable>;
|
|
118
|
-
|
|
119
86
|
// @public
|
|
120
87
|
export type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;
|
|
121
88
|
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
## Beta API Report File for "@fluidframework/fluid-static"
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
|
|
7
|
+
import { AttachState } from '@fluidframework/container-definitions';
|
|
8
|
+
import { ConnectionState } from '@fluidframework/container-definitions';
|
|
9
|
+
import { IClient } from '@fluidframework/driver-definitions';
|
|
10
|
+
import { IContainer } from '@fluidframework/container-definitions/internal';
|
|
11
|
+
import { ICriticalContainerError } from '@fluidframework/container-definitions';
|
|
12
|
+
import { IEvent } from '@fluidframework/core-interfaces';
|
|
13
|
+
import { IEventProvider } from '@fluidframework/core-interfaces';
|
|
14
|
+
import { IFluidLoadable } from '@fluidframework/core-interfaces';
|
|
15
|
+
import { IRuntimeFactory } from '@fluidframework/container-definitions/internal';
|
|
16
|
+
import { SharedObjectKind } from '@fluidframework/shared-object-base';
|
|
17
|
+
|
|
18
|
+
// @public
|
|
19
|
+
export type CompatibilityMode = "1" | "2";
|
|
20
|
+
|
|
21
|
+
// @public
|
|
22
|
+
export type ContainerAttachProps<T = unknown> = T;
|
|
23
|
+
|
|
24
|
+
// @public
|
|
25
|
+
export interface ContainerSchema {
|
|
26
|
+
readonly dynamicObjectTypes?: readonly SharedObjectKind[];
|
|
27
|
+
readonly initialObjects: Record<string, SharedObjectKind>;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
// @public
|
|
31
|
+
export interface IConnection {
|
|
32
|
+
readonly id: string;
|
|
33
|
+
readonly mode: "write" | "read";
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
// @public @sealed
|
|
37
|
+
export interface IFluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema> extends IEventProvider<IFluidContainerEvents> {
|
|
38
|
+
attach(props?: ContainerAttachProps): Promise<string>;
|
|
39
|
+
readonly attachState: AttachState;
|
|
40
|
+
connect(): void;
|
|
41
|
+
readonly connectionState: ConnectionState;
|
|
42
|
+
create<T extends IFluidLoadable>(objectClass: SharedObjectKind<T>): Promise<T>;
|
|
43
|
+
disconnect(): void;
|
|
44
|
+
dispose(): void;
|
|
45
|
+
readonly disposed: boolean;
|
|
46
|
+
readonly initialObjects: InitialObjects<TContainerSchema>;
|
|
47
|
+
readonly isDirty: boolean;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
// @public @sealed
|
|
51
|
+
export interface IFluidContainerEvents extends IEvent {
|
|
52
|
+
(event: "connected", listener: () => void): void;
|
|
53
|
+
(event: "disconnected", listener: () => void): void;
|
|
54
|
+
(event: "saved", listener: () => void): void;
|
|
55
|
+
(event: "dirty", listener: () => void): void;
|
|
56
|
+
(event: "disposed", listener: (error?: ICriticalContainerError) => void): any;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
// @public
|
|
60
|
+
export interface IMember {
|
|
61
|
+
readonly connections: IConnection[];
|
|
62
|
+
readonly id: string;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
// @public
|
|
66
|
+
export type InitialObjects<T extends ContainerSchema> = {
|
|
67
|
+
[K in keyof T["initialObjects"]]: T["initialObjects"][K] extends SharedObjectKind<infer TChannel> ? TChannel : never;
|
|
68
|
+
};
|
|
69
|
+
|
|
70
|
+
// @public
|
|
71
|
+
export interface IServiceAudience<M extends IMember> extends IEventProvider<IServiceAudienceEvents<M>> {
|
|
72
|
+
getMembers(): ReadonlyMap<string, M>;
|
|
73
|
+
getMyself(): Myself<M> | undefined;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
// @public
|
|
77
|
+
export interface IServiceAudienceEvents<M extends IMember> extends IEvent {
|
|
78
|
+
// @eventProperty
|
|
79
|
+
(event: "membersChanged", listener: () => void): void;
|
|
80
|
+
// @eventProperty
|
|
81
|
+
(event: "memberAdded", listener: MemberChangedListener<M>): void;
|
|
82
|
+
// @eventProperty
|
|
83
|
+
(event: "memberRemoved", listener: MemberChangedListener<M>): void;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
// @public
|
|
87
|
+
export type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;
|
|
88
|
+
|
|
89
|
+
// @public
|
|
90
|
+
export type Myself<M extends IMember = IMember> = M & {
|
|
91
|
+
readonly currentConnection: string;
|
|
92
|
+
};
|
|
93
|
+
|
|
94
|
+
```
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
## Public API Report File for "@fluidframework/fluid-static"
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
|
|
7
|
+
import { AttachState } from '@fluidframework/container-definitions';
|
|
8
|
+
import { ConnectionState } from '@fluidframework/container-definitions';
|
|
9
|
+
import { IClient } from '@fluidframework/driver-definitions';
|
|
10
|
+
import { IContainer } from '@fluidframework/container-definitions/internal';
|
|
11
|
+
import { ICriticalContainerError } from '@fluidframework/container-definitions';
|
|
12
|
+
import { IEvent } from '@fluidframework/core-interfaces';
|
|
13
|
+
import { IEventProvider } from '@fluidframework/core-interfaces';
|
|
14
|
+
import { IFluidLoadable } from '@fluidframework/core-interfaces';
|
|
15
|
+
import { IRuntimeFactory } from '@fluidframework/container-definitions/internal';
|
|
16
|
+
import { SharedObjectKind } from '@fluidframework/shared-object-base';
|
|
17
|
+
|
|
18
|
+
// @public
|
|
19
|
+
export type CompatibilityMode = "1" | "2";
|
|
20
|
+
|
|
21
|
+
// @public
|
|
22
|
+
export type ContainerAttachProps<T = unknown> = T;
|
|
23
|
+
|
|
24
|
+
// @public
|
|
25
|
+
export interface ContainerSchema {
|
|
26
|
+
readonly dynamicObjectTypes?: readonly SharedObjectKind[];
|
|
27
|
+
readonly initialObjects: Record<string, SharedObjectKind>;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
// @public
|
|
31
|
+
export interface IConnection {
|
|
32
|
+
readonly id: string;
|
|
33
|
+
readonly mode: "write" | "read";
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
// @public @sealed
|
|
37
|
+
export interface IFluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema> extends IEventProvider<IFluidContainerEvents> {
|
|
38
|
+
attach(props?: ContainerAttachProps): Promise<string>;
|
|
39
|
+
readonly attachState: AttachState;
|
|
40
|
+
connect(): void;
|
|
41
|
+
readonly connectionState: ConnectionState;
|
|
42
|
+
create<T extends IFluidLoadable>(objectClass: SharedObjectKind<T>): Promise<T>;
|
|
43
|
+
disconnect(): void;
|
|
44
|
+
dispose(): void;
|
|
45
|
+
readonly disposed: boolean;
|
|
46
|
+
readonly initialObjects: InitialObjects<TContainerSchema>;
|
|
47
|
+
readonly isDirty: boolean;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
// @public @sealed
|
|
51
|
+
export interface IFluidContainerEvents extends IEvent {
|
|
52
|
+
(event: "connected", listener: () => void): void;
|
|
53
|
+
(event: "disconnected", listener: () => void): void;
|
|
54
|
+
(event: "saved", listener: () => void): void;
|
|
55
|
+
(event: "dirty", listener: () => void): void;
|
|
56
|
+
(event: "disposed", listener: (error?: ICriticalContainerError) => void): any;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
// @public
|
|
60
|
+
export interface IMember {
|
|
61
|
+
readonly connections: IConnection[];
|
|
62
|
+
readonly id: string;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
// @public
|
|
66
|
+
export type InitialObjects<T extends ContainerSchema> = {
|
|
67
|
+
[K in keyof T["initialObjects"]]: T["initialObjects"][K] extends SharedObjectKind<infer TChannel> ? TChannel : never;
|
|
68
|
+
};
|
|
69
|
+
|
|
70
|
+
// @public
|
|
71
|
+
export interface IServiceAudience<M extends IMember> extends IEventProvider<IServiceAudienceEvents<M>> {
|
|
72
|
+
getMembers(): ReadonlyMap<string, M>;
|
|
73
|
+
getMyself(): Myself<M> | undefined;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
// @public
|
|
77
|
+
export interface IServiceAudienceEvents<M extends IMember> extends IEvent {
|
|
78
|
+
// @eventProperty
|
|
79
|
+
(event: "membersChanged", listener: () => void): void;
|
|
80
|
+
// @eventProperty
|
|
81
|
+
(event: "memberAdded", listener: MemberChangedListener<M>): void;
|
|
82
|
+
// @eventProperty
|
|
83
|
+
(event: "memberRemoved", listener: MemberChangedListener<M>): void;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
// @public
|
|
87
|
+
export type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;
|
|
88
|
+
|
|
89
|
+
// @public
|
|
90
|
+
export type Myself<M extends IMember = IMember> = M & {
|
|
91
|
+
readonly currentConnection: string;
|
|
92
|
+
};
|
|
93
|
+
|
|
94
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluidframework/fluid-static",
|
|
3
|
-
"version": "2.0.0-dev-rc.5.0.0.
|
|
3
|
+
"version": "2.0.0-dev-rc.5.0.0.268409",
|
|
4
4
|
"description": "A tool to enable consumption of Fluid Data Objects without requiring custom container code.",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -57,32 +57,32 @@
|
|
|
57
57
|
"temp-directory": "nyc/.nyc_output"
|
|
58
58
|
},
|
|
59
59
|
"dependencies": {
|
|
60
|
-
"@fluid-internal/client-utils": "2.0.0-dev-rc.5.0.0.
|
|
61
|
-
"@fluidframework/aqueduct": "2.0.0-dev-rc.5.0.0.
|
|
62
|
-
"@fluidframework/container-definitions": "2.0.0-dev-rc.5.0.0.
|
|
63
|
-
"@fluidframework/container-loader": "2.0.0-dev-rc.5.0.0.
|
|
64
|
-
"@fluidframework/container-runtime": "2.0.0-dev-rc.5.0.0.
|
|
65
|
-
"@fluidframework/container-runtime-definitions": "2.0.0-dev-rc.5.0.0.
|
|
66
|
-
"@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.
|
|
67
|
-
"@fluidframework/datastore-definitions": "2.0.0-dev-rc.5.0.0.
|
|
68
|
-
"@fluidframework/driver-definitions": "2.0.0-dev-rc.5.0.0.
|
|
69
|
-
"@fluidframework/request-handler": "2.0.0-dev-rc.5.0.0.
|
|
70
|
-
"@fluidframework/runtime-definitions": "2.0.0-dev-rc.5.0.0.
|
|
71
|
-
"@fluidframework/runtime-utils": "2.0.0-dev-rc.5.0.0.
|
|
72
|
-
"@fluidframework/shared-object-base": "2.0.0-dev-rc.5.0.0.
|
|
73
|
-
"@fluidframework/telemetry-utils": "2.0.0-dev-rc.5.0.0.
|
|
60
|
+
"@fluid-internal/client-utils": "2.0.0-dev-rc.5.0.0.268409",
|
|
61
|
+
"@fluidframework/aqueduct": "2.0.0-dev-rc.5.0.0.268409",
|
|
62
|
+
"@fluidframework/container-definitions": "2.0.0-dev-rc.5.0.0.268409",
|
|
63
|
+
"@fluidframework/container-loader": "2.0.0-dev-rc.5.0.0.268409",
|
|
64
|
+
"@fluidframework/container-runtime": "2.0.0-dev-rc.5.0.0.268409",
|
|
65
|
+
"@fluidframework/container-runtime-definitions": "2.0.0-dev-rc.5.0.0.268409",
|
|
66
|
+
"@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.268409",
|
|
67
|
+
"@fluidframework/datastore-definitions": "2.0.0-dev-rc.5.0.0.268409",
|
|
68
|
+
"@fluidframework/driver-definitions": "2.0.0-dev-rc.5.0.0.268409",
|
|
69
|
+
"@fluidframework/request-handler": "2.0.0-dev-rc.5.0.0.268409",
|
|
70
|
+
"@fluidframework/runtime-definitions": "2.0.0-dev-rc.5.0.0.268409",
|
|
71
|
+
"@fluidframework/runtime-utils": "2.0.0-dev-rc.5.0.0.268409",
|
|
72
|
+
"@fluidframework/shared-object-base": "2.0.0-dev-rc.5.0.0.268409",
|
|
73
|
+
"@fluidframework/telemetry-utils": "2.0.0-dev-rc.5.0.0.268409"
|
|
74
74
|
},
|
|
75
75
|
"devDependencies": {
|
|
76
76
|
"@arethetypeswrong/cli": "^0.15.2",
|
|
77
|
-
"@biomejs/biome": "^1.
|
|
78
|
-
"@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.5.0.0.
|
|
77
|
+
"@biomejs/biome": "^1.7.3",
|
|
78
|
+
"@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.5.0.0.268409",
|
|
79
79
|
"@fluid-tools/build-cli": "^0.39.0-264124",
|
|
80
80
|
"@fluidframework/build-common": "^2.0.3",
|
|
81
81
|
"@fluidframework/build-tools": "^0.39.0-264124",
|
|
82
|
-
"@fluidframework/eslint-config-fluid": "^5.
|
|
82
|
+
"@fluidframework/eslint-config-fluid": "^5.3.0",
|
|
83
83
|
"@fluidframework/fluid-static-previous": "npm:@fluidframework/fluid-static@2.0.0-rc.4.0.0",
|
|
84
|
-
"@fluidframework/map": "2.0.0-dev-rc.5.0.0.
|
|
85
|
-
"@fluidframework/sequence": "2.0.0-dev-rc.5.0.0.
|
|
84
|
+
"@fluidframework/map": "2.0.0-dev-rc.5.0.0.268409",
|
|
85
|
+
"@fluidframework/sequence": "2.0.0-dev-rc.5.0.0.268409",
|
|
86
86
|
"@microsoft/api-extractor": "^7.45.1",
|
|
87
87
|
"@types/mocha": "^9.1.1",
|
|
88
88
|
"@types/node": "^18.19.0",
|