@fluidframework/fluid-static 2.0.0-internal.6.4.0 → 2.0.0-internal.7.1.0
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 +64 -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 +16 -5
- package/dist/rootDataObject.js.map +1 -1
- package/dist/tsdoc-metadata.json +1 -1
- package/dist/types.d.ts +8 -8
- package/dist/types.d.ts.map +1 -1
- package/lib/rootDataObject.d.ts.map +1 -1
- package/lib/rootDataObject.js +19 -6
- package/lib/rootDataObject.js.map +1 -1
- package/lib/types.d.ts +8 -8
- package/lib/types.d.ts.map +1 -1
- package/package.json +26 -26
- package/src/rootDataObject.ts +16 -7
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,69 @@
|
|
|
1
1
|
# @fluidframework/fluid-static
|
|
2
2
|
|
|
3
|
+
## 2.0.0-internal.7.1.0
|
|
4
|
+
|
|
5
|
+
Dependency updates only.
|
|
6
|
+
|
|
7
|
+
## 2.0.0-internal.7.0.0
|
|
8
|
+
|
|
9
|
+
### Major Changes
|
|
10
|
+
|
|
11
|
+
- Dependencies on @fluidframework/protocol-definitions package updated to 3.0.0 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
12
|
+
|
|
13
|
+
This included the following changes from the protocol-definitions release:
|
|
14
|
+
|
|
15
|
+
- Updating signal interfaces for some planned improvements. The intention is split the interface between signals
|
|
16
|
+
submitted by clients to the server and the resulting signals sent from the server to clients.
|
|
17
|
+
- A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has
|
|
18
|
+
been added, which will be the typing for signals sent from the client to the server. Both extend a new
|
|
19
|
+
ISignalMessageBase interface that contains common members.
|
|
20
|
+
- The @fluidframework/common-definitions package dependency has been updated to version 1.0.0.
|
|
21
|
+
|
|
22
|
+
- Server upgrade: dependencies on Fluid server packages updated to 2.0.1 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
23
|
+
|
|
24
|
+
Dependencies on the following Fluid server package have been updated to version 2.0.1:
|
|
25
|
+
|
|
26
|
+
- @fluidframework/gitresources: 2.0.1
|
|
27
|
+
- @fluidframework/server-kafka-orderer: 2.0.1
|
|
28
|
+
- @fluidframework/server-lambdas: 2.0.1
|
|
29
|
+
- @fluidframework/server-lambdas-driver: 2.0.1
|
|
30
|
+
- @fluidframework/server-local-server: 2.0.1
|
|
31
|
+
- @fluidframework/server-memory-orderer: 2.0.1
|
|
32
|
+
- @fluidframework/protocol-base: 2.0.1
|
|
33
|
+
- @fluidframework/server-routerlicious: 2.0.1
|
|
34
|
+
- @fluidframework/server-routerlicious-base: 2.0.1
|
|
35
|
+
- @fluidframework/server-services: 2.0.1
|
|
36
|
+
- @fluidframework/server-services-client: 2.0.1
|
|
37
|
+
- @fluidframework/server-services-core: 2.0.1
|
|
38
|
+
- @fluidframework/server-services-ordering-kafkanode: 2.0.1
|
|
39
|
+
- @fluidframework/server-services-ordering-rdkafka: 2.0.1
|
|
40
|
+
- @fluidframework/server-services-ordering-zookeeper: 2.0.1
|
|
41
|
+
- @fluidframework/server-services-shared: 2.0.1
|
|
42
|
+
- @fluidframework/server-services-telemetry: 2.0.1
|
|
43
|
+
- @fluidframework/server-services-utils: 2.0.1
|
|
44
|
+
- @fluidframework/server-test-utils: 2.0.1
|
|
45
|
+
- tinylicious: 2.0.1
|
|
46
|
+
|
|
47
|
+
- test-utils: provideEntryPoint is required [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
48
|
+
|
|
49
|
+
The optional `provideEntryPoint` method has become required on a number of constructors. A value will need to be provided to the following classes:
|
|
50
|
+
|
|
51
|
+
- `BaseContainerRuntimeFactory`
|
|
52
|
+
- `RuntimeFactory`
|
|
53
|
+
- `ContainerRuntime` (constructor and `loadRuntime`)
|
|
54
|
+
- `FluidDataStoreRuntime`
|
|
55
|
+
|
|
56
|
+
See [testContainerRuntimeFactoryWithDefaultDataStore.ts](https://github.com/microsoft/FluidFramework/tree/main/packages/test/test-utils/src/testContainerRuntimeFactoryWithDefaultDataStore.ts) for an example implemtation of `provideEntryPoint` for ContainerRuntime.
|
|
57
|
+
See [pureDataObjectFactory.ts](https://github.com/microsoft/FluidFramework/tree/main/packages/framework/aqueduct/src/data-object-factories/pureDataObjectFactory.ts#L83) for an example implementation of `provideEntryPoint` for DataStoreRuntime.
|
|
58
|
+
|
|
59
|
+
Subsequently, various `entryPoint` and `getEntryPoint()` endpoints have become required. Please see [containerRuntime.ts](https://github.com/microsoft/FluidFramework/tree/main/packages/runtime/container-runtime/src/containerRuntime.ts) for example implementations of these APIs.
|
|
60
|
+
|
|
61
|
+
For more details, see [Removing-IFluidRouter.md](https://github.com/microsoft/FluidFramework/blob/main/packages/common/core-interfaces/Removing-IFluidRouter.md)
|
|
62
|
+
|
|
63
|
+
- Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
64
|
+
|
|
65
|
+
The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
|
|
66
|
+
|
|
3
67
|
## 2.0.0-internal.6.4.0
|
|
4
68
|
|
|
5
69
|
Dependency updates only.
|
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
|
+
```
|