@fluidframework/fluid-static 2.0.0-internal.7.0.1 → 2.0.0-internal.7.1.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 +4 -0
- package/api-extractor.json +9 -1
- package/api-report/fluid-static.api.md +152 -0
- package/dist/fluid-static-alpha.d.ts +548 -0
- package/dist/fluid-static-beta.d.ts +548 -0
- package/dist/fluid-static-public.d.ts +548 -0
- package/dist/fluid-static.d.ts +557 -0
- package/dist/rootDataObject.d.ts.map +1 -1
- package/dist/rootDataObject.js.map +1 -1
- package/dist/tsdoc-metadata.json +1 -1
- package/lib/rootDataObject.d.ts.map +1 -1
- package/lib/rootDataObject.js.map +1 -1
- package/package.json +23 -23
- package/src/rootDataObject.ts +2 -3
package/CHANGELOG.md
CHANGED
package/api-extractor.json
CHANGED
|
@@ -1,4 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
-
"extends": "@fluidframework/build-common/api-extractor-
|
|
3
|
+
"extends": "@fluidframework/build-common/api-extractor-base.json",
|
|
4
|
+
"messages": {
|
|
5
|
+
"extractorMessageReporting": {
|
|
6
|
+
"ae-missing-release-tag": {
|
|
7
|
+
// TODO: Fix violations and remove this rule override
|
|
8
|
+
"logLevel": "none"
|
|
9
|
+
}
|
|
10
|
+
}
|
|
11
|
+
}
|
|
4
12
|
}
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
## 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 { BaseContainerRuntimeFactory } from '@fluidframework/aqueduct';
|
|
9
|
+
import { ConnectionState } from '@fluidframework/container-definitions';
|
|
10
|
+
import { IAudience } from '@fluidframework/container-definitions';
|
|
11
|
+
import { IChannelFactory } from '@fluidframework/datastore-definitions';
|
|
12
|
+
import { IClient } from '@fluidframework/protocol-definitions';
|
|
13
|
+
import { IContainer } from '@fluidframework/container-definitions';
|
|
14
|
+
import { IContainerRuntime } from '@fluidframework/container-runtime-definitions';
|
|
15
|
+
import { ICriticalContainerError } from '@fluidframework/container-definitions';
|
|
16
|
+
import { IEvent } from '@fluidframework/core-interfaces';
|
|
17
|
+
import { IEventProvider } from '@fluidframework/core-interfaces';
|
|
18
|
+
import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions';
|
|
19
|
+
import { IFluidLoadable } from '@fluidframework/core-interfaces';
|
|
20
|
+
import { TypedEventEmitter } from '@fluid-internal/client-utils';
|
|
21
|
+
|
|
22
|
+
// @public
|
|
23
|
+
export interface ContainerSchema {
|
|
24
|
+
dynamicObjectTypes?: LoadableObjectClass<any>[];
|
|
25
|
+
initialObjects: LoadableObjectClassRecord;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
// @public
|
|
29
|
+
export type DataObjectClass<T extends IFluidLoadable> = {
|
|
30
|
+
readonly factory: IFluidDataStoreFactory;
|
|
31
|
+
} & LoadableObjectCtor<T>;
|
|
32
|
+
|
|
33
|
+
// @public
|
|
34
|
+
export class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory {
|
|
35
|
+
constructor(schema: ContainerSchema);
|
|
36
|
+
// (undocumented)
|
|
37
|
+
protected containerInitializingFirstTime(runtime: IContainerRuntime): Promise<void>;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
// @public
|
|
41
|
+
export class FluidContainer extends TypedEventEmitter<IFluidContainerEvents> implements IFluidContainer {
|
|
42
|
+
constructor(container: IContainer, rootDataObject: IRootDataObject);
|
|
43
|
+
attach(): Promise<string>;
|
|
44
|
+
get attachState(): AttachState;
|
|
45
|
+
connect(): Promise<void>;
|
|
46
|
+
get connectionState(): ConnectionState;
|
|
47
|
+
create<T extends IFluidLoadable>(objectClass: LoadableObjectClass<T>): Promise<T>;
|
|
48
|
+
disconnect(): Promise<void>;
|
|
49
|
+
dispose(): void;
|
|
50
|
+
get disposed(): boolean;
|
|
51
|
+
get initialObjects(): LoadableObjectRecord;
|
|
52
|
+
// @internal
|
|
53
|
+
readonly INTERNAL_CONTAINER_DO_NOT_USE?: () => IContainer;
|
|
54
|
+
get isDirty(): boolean;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
// @public
|
|
58
|
+
export interface IConnection {
|
|
59
|
+
id: string;
|
|
60
|
+
mode: "write" | "read";
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
// @public
|
|
64
|
+
export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
|
|
65
|
+
attach(): Promise<string>;
|
|
66
|
+
readonly attachState: AttachState;
|
|
67
|
+
connect(): void;
|
|
68
|
+
readonly connectionState: ConnectionState;
|
|
69
|
+
create<T extends IFluidLoadable>(objectClass: LoadableObjectClass<T>): Promise<T>;
|
|
70
|
+
disconnect(): void;
|
|
71
|
+
dispose(): void;
|
|
72
|
+
readonly disposed: boolean;
|
|
73
|
+
readonly initialObjects: LoadableObjectRecord;
|
|
74
|
+
readonly isDirty: boolean;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
// @public
|
|
78
|
+
export interface IFluidContainerEvents extends IEvent {
|
|
79
|
+
(event: "connected", listener: () => void): void;
|
|
80
|
+
(event: "disconnected", listener: () => void): void;
|
|
81
|
+
(event: "saved", listener: () => void): void;
|
|
82
|
+
(event: "dirty", listener: () => void): void;
|
|
83
|
+
(event: "disposed", listener: (error?: ICriticalContainerError) => void): any;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
// @public
|
|
87
|
+
export interface IMember {
|
|
88
|
+
connections: IConnection[];
|
|
89
|
+
userId: string;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
// @public
|
|
93
|
+
export interface IRootDataObject {
|
|
94
|
+
create<T extends IFluidLoadable>(objectClass: LoadableObjectClass<T>): Promise<T>;
|
|
95
|
+
readonly initialObjects: LoadableObjectRecord;
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
// @public
|
|
99
|
+
export interface IServiceAudience<M extends IMember> extends IEventProvider<IServiceAudienceEvents<M>> {
|
|
100
|
+
getMembers(): Map<string, M>;
|
|
101
|
+
getMyself(): Myself<M> | undefined;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
// @public
|
|
105
|
+
export interface IServiceAudienceEvents<M extends IMember> extends IEvent {
|
|
106
|
+
// @eventProperty
|
|
107
|
+
(event: "membersChanged", listener: () => void): void;
|
|
108
|
+
// @eventProperty
|
|
109
|
+
(event: "memberAdded", listener: MemberChangedListener<M>): void;
|
|
110
|
+
// @eventProperty
|
|
111
|
+
(event: "memberRemoved", listener: MemberChangedListener<M>): void;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
// @public
|
|
115
|
+
export type LoadableObjectClass<T extends IFluidLoadable> = DataObjectClass<T> | SharedObjectClass<T>;
|
|
116
|
+
|
|
117
|
+
// @public
|
|
118
|
+
export type LoadableObjectClassRecord = Record<string, LoadableObjectClass<any>>;
|
|
119
|
+
|
|
120
|
+
// @public
|
|
121
|
+
export type LoadableObjectCtor<T extends IFluidLoadable> = new (...args: any[]) => T;
|
|
122
|
+
|
|
123
|
+
// @public
|
|
124
|
+
export type LoadableObjectRecord = Record<string, IFluidLoadable>;
|
|
125
|
+
|
|
126
|
+
// @public
|
|
127
|
+
export type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;
|
|
128
|
+
|
|
129
|
+
// @public
|
|
130
|
+
export type Myself<M extends IMember = IMember> = M & {
|
|
131
|
+
currentConnection: string;
|
|
132
|
+
};
|
|
133
|
+
|
|
134
|
+
// @public
|
|
135
|
+
export abstract class ServiceAudience<M extends IMember = IMember> extends TypedEventEmitter<IServiceAudienceEvents<M>> implements IServiceAudience<M> {
|
|
136
|
+
constructor(
|
|
137
|
+
container: IContainer);
|
|
138
|
+
protected readonly audience: IAudience;
|
|
139
|
+
protected readonly container: IContainer;
|
|
140
|
+
protected abstract createServiceMember(audienceMember: IClient): M;
|
|
141
|
+
getMembers(): Map<string, M>;
|
|
142
|
+
getMyself(): Myself<M> | undefined;
|
|
143
|
+
protected lastMembers: Map<string, M>;
|
|
144
|
+
protected shouldIncludeAsMember(member: IClient): boolean;
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
// @public
|
|
148
|
+
export type SharedObjectClass<T extends IFluidLoadable> = {
|
|
149
|
+
readonly getFactory: () => IChannelFactory;
|
|
150
|
+
} & LoadableObjectCtor<T>;
|
|
151
|
+
|
|
152
|
+
```
|