@fluidframework/fluid-static 2.0.0-dev.7.4.0.215930 → 2.0.0-dev.7.4.0.217212
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/api-extractor-lint.json +13 -0
- package/api-extractor.json +0 -4
- package/api-report/fluid-static.api.md +24 -25
- package/dist/fluid-static-alpha.d.ts +37 -540
- package/dist/fluid-static-beta.d.ts +53 -548
- package/dist/fluid-static-public.d.ts +53 -548
- package/dist/fluid-static-untrimmed.d.ts +32 -2
- package/dist/fluidContainer.cjs +4 -2
- package/dist/fluidContainer.cjs.map +1 -1
- package/dist/fluidContainer.d.ts +7 -2
- package/dist/fluidContainer.d.ts.map +1 -1
- package/dist/rootDataObject.cjs +4 -0
- package/dist/rootDataObject.cjs.map +1 -1
- package/dist/rootDataObject.d.ts +4 -0
- package/dist/rootDataObject.d.ts.map +1 -1
- package/dist/serviceAudience.cjs +4 -0
- package/dist/serviceAudience.cjs.map +1 -1
- package/dist/serviceAudience.d.ts +4 -0
- package/dist/serviceAudience.d.ts.map +1 -1
- package/dist/types.cjs.map +1 -1
- package/dist/types.d.ts +17 -0
- package/dist/types.d.ts.map +1 -1
- package/lib/fluid-static-alpha.d.ts +37 -540
- package/lib/fluid-static-beta.d.ts +53 -548
- package/lib/fluid-static-public.d.ts +53 -548
- package/lib/fluid-static-untrimmed.d.ts +32 -2
- package/lib/fluidContainer.d.ts +7 -2
- package/lib/fluidContainer.d.ts.map +1 -1
- package/lib/fluidContainer.mjs +4 -2
- package/lib/fluidContainer.mjs.map +1 -1
- package/lib/rootDataObject.d.ts +4 -0
- package/lib/rootDataObject.d.ts.map +1 -1
- package/lib/rootDataObject.mjs +4 -0
- package/lib/rootDataObject.mjs.map +1 -1
- package/lib/serviceAudience.d.ts +4 -0
- package/lib/serviceAudience.d.ts.map +1 -1
- package/lib/serviceAudience.mjs +4 -0
- package/lib/serviceAudience.mjs.map +1 -1
- package/lib/types.d.ts +17 -0
- package/lib/types.d.ts.map +1 -1
- package/lib/types.mjs.map +1 -1
- package/package.json +16 -15
- package/src/fluidContainer.ts +7 -2
- package/src/rootDataObject.ts +4 -0
- package/src/serviceAudience.ts +4 -0
- package/src/types.ts +17 -0
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
+
"extends": "../../../common/build/build-common/api-extractor-lint.json",
|
|
4
|
+
"messages": {
|
|
5
|
+
"extractorMessageReporting": {
|
|
6
|
+
// TODO: remove once base config has this enabled as an error
|
|
7
|
+
"ae-incompatible-release-tags": {
|
|
8
|
+
"logLevel": "error",
|
|
9
|
+
"addToApiReportFile": false
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
}
|
|
13
|
+
}
|
package/api-extractor.json
CHANGED
|
@@ -6,10 +6,6 @@
|
|
|
6
6
|
},
|
|
7
7
|
"messages": {
|
|
8
8
|
"extractorMessageReporting": {
|
|
9
|
-
// TODO: Fix violations and remove this rule override
|
|
10
|
-
"ae-missing-release-tag": {
|
|
11
|
-
"logLevel": "none"
|
|
12
|
-
},
|
|
13
9
|
// TODO: Add missing documentation and remove this rule override
|
|
14
10
|
"ae-undocumented": {
|
|
15
11
|
"logLevel": "none"
|
|
@@ -20,42 +20,42 @@ import { IFluidLoadable } from '@fluidframework/core-interfaces';
|
|
|
20
20
|
import { IRuntimeFactory } from '@fluidframework/container-definitions';
|
|
21
21
|
import { TypedEventEmitter } from '@fluid-internal/client-utils';
|
|
22
22
|
|
|
23
|
-
// @
|
|
23
|
+
// @internal
|
|
24
24
|
export interface ContainerSchema {
|
|
25
25
|
dynamicObjectTypes?: LoadableObjectClass<any>[];
|
|
26
26
|
initialObjects: LoadableObjectClassRecord;
|
|
27
27
|
}
|
|
28
28
|
|
|
29
|
-
// @
|
|
29
|
+
// @internal (undocumented)
|
|
30
30
|
export function createDOProviderContainerRuntimeFactory(props: {
|
|
31
31
|
schema: ContainerSchema;
|
|
32
32
|
}): IRuntimeFactory;
|
|
33
33
|
|
|
34
|
-
// @
|
|
34
|
+
// @internal (undocumented)
|
|
35
35
|
export function createFluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema>(props: {
|
|
36
36
|
container: IContainer;
|
|
37
37
|
rootDataObject: IRootDataObject;
|
|
38
38
|
}): IFluidContainer<TContainerSchema>;
|
|
39
39
|
|
|
40
|
-
// @
|
|
40
|
+
// @internal (undocumented)
|
|
41
41
|
export function createServiceAudience<M extends IMember = IMember>(props: {
|
|
42
42
|
container: IContainer;
|
|
43
43
|
createServiceMember: (audienceMember: IClient) => M;
|
|
44
44
|
}): IServiceAudience<M>;
|
|
45
45
|
|
|
46
|
-
// @
|
|
46
|
+
// @internal
|
|
47
47
|
export type DataObjectClass<T extends IFluidLoadable> = {
|
|
48
48
|
readonly factory: IFluidDataStoreFactory;
|
|
49
49
|
} & LoadableObjectCtor<T>;
|
|
50
50
|
|
|
51
|
-
// @
|
|
51
|
+
// @internal @deprecated
|
|
52
52
|
export class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory {
|
|
53
53
|
constructor(schema: ContainerSchema);
|
|
54
54
|
// (undocumented)
|
|
55
55
|
protected containerInitializingFirstTime(runtime: IContainerRuntime): Promise<void>;
|
|
56
56
|
}
|
|
57
57
|
|
|
58
|
-
// @
|
|
58
|
+
// @internal @deprecated
|
|
59
59
|
export class FluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema> extends TypedEventEmitter<IFluidContainerEvents> implements IFluidContainer<TContainerSchema> {
|
|
60
60
|
constructor(container: IContainer, rootDataObject: IRootDataObject);
|
|
61
61
|
attach(): Promise<string>;
|
|
@@ -67,18 +67,17 @@ export class FluidContainer<TContainerSchema extends ContainerSchema = Container
|
|
|
67
67
|
dispose(): void;
|
|
68
68
|
get disposed(): boolean;
|
|
69
69
|
get initialObjects(): InitialObjects<TContainerSchema>;
|
|
70
|
-
// @internal
|
|
71
70
|
readonly INTERNAL_CONTAINER_DO_NOT_USE?: () => IContainer;
|
|
72
71
|
get isDirty(): boolean;
|
|
73
72
|
}
|
|
74
73
|
|
|
75
|
-
// @
|
|
74
|
+
// @internal
|
|
76
75
|
export interface IConnection {
|
|
77
76
|
id: string;
|
|
78
77
|
mode: "write" | "read";
|
|
79
78
|
}
|
|
80
79
|
|
|
81
|
-
// @
|
|
80
|
+
// @internal
|
|
82
81
|
export interface IFluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema> extends IEventProvider<IFluidContainerEvents> {
|
|
83
82
|
attach(): Promise<string>;
|
|
84
83
|
readonly attachState: AttachState;
|
|
@@ -92,7 +91,7 @@ export interface IFluidContainer<TContainerSchema extends ContainerSchema = Cont
|
|
|
92
91
|
readonly isDirty: boolean;
|
|
93
92
|
}
|
|
94
93
|
|
|
95
|
-
// @
|
|
94
|
+
// @internal
|
|
96
95
|
export interface IFluidContainerEvents extends IEvent {
|
|
97
96
|
(event: "connected", listener: () => void): void;
|
|
98
97
|
(event: "disconnected", listener: () => void): void;
|
|
@@ -101,36 +100,36 @@ export interface IFluidContainerEvents extends IEvent {
|
|
|
101
100
|
(event: "disposed", listener: (error?: ICriticalContainerError) => void): any;
|
|
102
101
|
}
|
|
103
102
|
|
|
104
|
-
// @
|
|
103
|
+
// @internal
|
|
105
104
|
export interface IMember {
|
|
106
105
|
connections: IConnection[];
|
|
107
106
|
userId: string;
|
|
108
107
|
}
|
|
109
108
|
|
|
110
|
-
// @
|
|
109
|
+
// @internal
|
|
111
110
|
export type InitialObjects<T extends ContainerSchema> = {
|
|
112
111
|
[K in keyof T["initialObjects"]]: T["initialObjects"][K] extends LoadableObjectClass<infer TChannel> ? TChannel : never;
|
|
113
112
|
};
|
|
114
113
|
|
|
115
|
-
// @
|
|
114
|
+
// @internal (undocumented)
|
|
116
115
|
export interface IProvideRootDataObject {
|
|
117
116
|
// (undocumented)
|
|
118
117
|
readonly IRootDataObject?: IRootDataObject;
|
|
119
118
|
}
|
|
120
119
|
|
|
121
|
-
// @
|
|
120
|
+
// @internal
|
|
122
121
|
export interface IRootDataObject extends IProvideRootDataObject {
|
|
123
122
|
create<T extends IFluidLoadable>(objectClass: LoadableObjectClass<T>): Promise<T>;
|
|
124
123
|
readonly initialObjects: LoadableObjectRecord;
|
|
125
124
|
}
|
|
126
125
|
|
|
127
|
-
// @
|
|
126
|
+
// @internal
|
|
128
127
|
export interface IServiceAudience<M extends IMember> extends IEventProvider<IServiceAudienceEvents<M>> {
|
|
129
128
|
getMembers(): Map<string, M>;
|
|
130
129
|
getMyself(): Myself<M> | undefined;
|
|
131
130
|
}
|
|
132
131
|
|
|
133
|
-
// @
|
|
132
|
+
// @internal
|
|
134
133
|
export interface IServiceAudienceEvents<M extends IMember> extends IEvent {
|
|
135
134
|
// @eventProperty
|
|
136
135
|
(event: "membersChanged", listener: () => void): void;
|
|
@@ -140,27 +139,27 @@ export interface IServiceAudienceEvents<M extends IMember> extends IEvent {
|
|
|
140
139
|
(event: "memberRemoved", listener: MemberChangedListener<M>): void;
|
|
141
140
|
}
|
|
142
141
|
|
|
143
|
-
// @
|
|
142
|
+
// @internal
|
|
144
143
|
export type LoadableObjectClass<T extends IFluidLoadable> = DataObjectClass<T> | SharedObjectClass<T>;
|
|
145
144
|
|
|
146
|
-
// @
|
|
145
|
+
// @internal
|
|
147
146
|
export type LoadableObjectClassRecord = Record<string, LoadableObjectClass<any>>;
|
|
148
147
|
|
|
149
|
-
// @
|
|
148
|
+
// @internal
|
|
150
149
|
export type LoadableObjectCtor<T extends IFluidLoadable> = new (...args: any[]) => T;
|
|
151
150
|
|
|
152
|
-
// @
|
|
151
|
+
// @internal
|
|
153
152
|
export type LoadableObjectRecord = Record<string, IFluidLoadable>;
|
|
154
153
|
|
|
155
|
-
// @
|
|
154
|
+
// @internal
|
|
156
155
|
export type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;
|
|
157
156
|
|
|
158
|
-
// @
|
|
157
|
+
// @internal
|
|
159
158
|
export type Myself<M extends IMember = IMember> = M & {
|
|
160
159
|
currentConnection: string;
|
|
161
160
|
};
|
|
162
161
|
|
|
163
|
-
// @
|
|
162
|
+
// @internal @deprecated
|
|
164
163
|
export abstract class ServiceAudience<M extends IMember = IMember> extends TypedEventEmitter<IServiceAudienceEvents<M>> implements IServiceAudience<M> {
|
|
165
164
|
constructor(
|
|
166
165
|
container: IContainer);
|
|
@@ -173,7 +172,7 @@ export abstract class ServiceAudience<M extends IMember = IMember> extends Typed
|
|
|
173
172
|
protected shouldIncludeAsMember(member: IClient): boolean;
|
|
174
173
|
}
|
|
175
174
|
|
|
176
|
-
// @
|
|
175
|
+
// @internal
|
|
177
176
|
export type SharedObjectClass<T extends IFluidLoadable> = {
|
|
178
177
|
readonly getFactory: () => IChannelFactory;
|
|
179
178
|
} & LoadableObjectCtor<T>;
|