@fluidframework/fluid-static 2.0.0-internal.8.0.1 → 2.0.0-rc.1.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.
Files changed (64) hide show
  1. package/CHANGELOG.md +34 -0
  2. package/README.md +0 -6
  3. package/api-extractor-esm.json +4 -0
  4. package/api-extractor-lint.json +1 -10
  5. package/api-extractor.json +1 -9
  6. package/api-report/fluid-static.api.md +16 -16
  7. package/dist/fluid-static-alpha.d.ts +20 -20
  8. package/dist/fluid-static-beta.d.ts +363 -29
  9. package/dist/fluid-static-public.d.ts +363 -29
  10. package/dist/fluid-static-untrimmed.d.ts +20 -16
  11. package/dist/fluidContainer.d.ts +7 -3
  12. package/dist/fluidContainer.d.ts.map +1 -1
  13. package/dist/{fluidContainer.cjs → fluidContainer.js} +1 -1
  14. package/dist/fluidContainer.js.map +1 -0
  15. package/dist/{index.cjs → index.js} +4 -4
  16. package/dist/index.js.map +1 -0
  17. package/dist/{rootDataObject.cjs → rootDataObject.js} +9 -5
  18. package/dist/rootDataObject.js.map +1 -0
  19. package/dist/{serviceAudience.cjs → serviceAudience.js} +1 -1
  20. package/dist/serviceAudience.js.map +1 -0
  21. package/dist/types.d.ts +13 -13
  22. package/dist/{types.cjs → types.js} +1 -1
  23. package/dist/types.js.map +1 -0
  24. package/dist/{utils.cjs → utils.js} +1 -1
  25. package/dist/utils.js.map +1 -0
  26. package/lib/fluid-static-alpha.d.mts +402 -0
  27. package/lib/{fluid-static-alpha.d.ts → fluid-static-beta.d.mts} +24 -26
  28. package/lib/fluid-static-public.d.mts +406 -0
  29. package/lib/{fluid-static-untrimmed.d.ts → fluid-static-untrimmed.d.mts} +20 -22
  30. package/lib/{fluidContainer.d.ts → fluidContainer.d.mts} +8 -4
  31. package/lib/fluidContainer.d.mts.map +1 -0
  32. package/lib/fluidContainer.mjs.map +1 -1
  33. package/lib/{index.d.ts → index.d.mts} +1 -1
  34. package/lib/index.d.mts.map +1 -0
  35. package/lib/{rootDataObject.d.ts → rootDataObject.d.mts} +1 -1
  36. package/lib/rootDataObject.d.mts.map +1 -0
  37. package/lib/rootDataObject.mjs +7 -3
  38. package/lib/rootDataObject.mjs.map +1 -1
  39. package/lib/{serviceAudience.d.ts → serviceAudience.d.mts} +1 -1
  40. package/lib/serviceAudience.d.mts.map +1 -0
  41. package/lib/{types.d.ts → types.d.mts} +14 -14
  42. package/lib/types.d.mts.map +1 -0
  43. package/lib/types.mjs.map +1 -1
  44. package/lib/{utils.d.ts → utils.d.mts} +1 -1
  45. package/lib/utils.d.mts.map +1 -0
  46. package/package.json +84 -48
  47. package/src/fluidContainer.ts +7 -3
  48. package/src/rootDataObject.ts +7 -3
  49. package/src/types.ts +13 -13
  50. package/dist/fluidContainer.cjs.map +0 -1
  51. package/dist/index.cjs.map +0 -1
  52. package/dist/rootDataObject.cjs.map +0 -1
  53. package/dist/serviceAudience.cjs.map +0 -1
  54. package/dist/types.cjs.map +0 -1
  55. package/dist/utils.cjs.map +0 -1
  56. package/lib/fluid-static-beta.d.ts +0 -78
  57. package/lib/fluid-static-public.d.ts +0 -78
  58. package/lib/fluidContainer.d.ts.map +0 -1
  59. package/lib/index.d.ts.map +0 -1
  60. package/lib/rootDataObject.d.ts.map +0 -1
  61. package/lib/serviceAudience.d.ts.map +0 -1
  62. package/lib/types.d.ts.map +0 -1
  63. package/lib/utils.d.ts.map +0 -1
  64. package/tsc-multi.test.json +0 -4
package/CHANGELOG.md CHANGED
@@ -1,5 +1,39 @@
1
1
  # @fluidframework/fluid-static
2
2
 
3
+ ## 2.0.0-rc.1.0.0
4
+
5
+ ### Minor Changes
6
+
7
+ - Updated server dependencies ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902)
8
+
9
+ The following Fluid server dependencies have been updated to the latest version, 3.0.0. [See the full changelog.](https://github.com/microsoft/FluidFramework/releases/tag/server_v3.0.0)
10
+
11
+ - @fluidframework/gitresources
12
+ - @fluidframework/server-kafka-orderer
13
+ - @fluidframework/server-lambdas
14
+ - @fluidframework/server-lambdas-driver
15
+ - @fluidframework/server-local-server
16
+ - @fluidframework/server-memory-orderer
17
+ - @fluidframework/protocol-base
18
+ - @fluidframework/server-routerlicious
19
+ - @fluidframework/server-routerlicious-base
20
+ - @fluidframework/server-services
21
+ - @fluidframework/server-services-client
22
+ - @fluidframework/server-services-core
23
+ - @fluidframework/server-services-ordering-kafkanode
24
+ - @fluidframework/server-services-ordering-rdkafka
25
+ - @fluidframework/server-services-ordering-zookeeper
26
+ - @fluidframework/server-services-shared
27
+ - @fluidframework/server-services-telemetry
28
+ - @fluidframework/server-services-utils
29
+ - @fluidframework/server-test-utils
30
+ - tinylicious
31
+
32
+ - Updated @fluidframework/protocol-definitions ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902)
33
+
34
+ The @fluidframework/protocol-definitions dependency has been upgraded to v3.1.0. [See the full
35
+ changelog.](https://github.com/microsoft/FluidFramework/blob/main/common/lib/protocol-definitions/CHANGELOG.md#310)
36
+
3
37
  ## 2.0.0-internal.8.0.0
4
38
 
5
39
  ### Major Changes
package/README.md CHANGED
@@ -13,12 +13,6 @@ When taking a dependency on a Fluid Framework library, we recommend using a `^`
13
13
  While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
14
14
  library consumers should always prefer `^`.
15
15
 
16
- Note that when depending on a library version of the form `2.0.0-internal.x.y.z`, called the Fluid internal version scheme,
17
- you must use a `>= <` dependency range (such as `>=2.0.0-internal.x.y.z <2.0.0-internal.w.0.0` where `w` is `x+1`).
18
- Standard `^` and `~` ranges will not work as expected.
19
- See the [@fluid-tools/version-tools](https://github.com/microsoft/FluidFramework/blob/main/build-tools/packages/version-tools/README.md)
20
- package for more information including tools to convert between version schemes.
21
-
22
16
  <!-- prettier-ignore-end -->
23
17
 
24
18
  <!-- AUTO-GENERATED-CONTENT:END -->
@@ -0,0 +1,4 @@
1
+ {
2
+ "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
+ "extends": "../../../common/build/build-common/api-extractor-base-esm.json"
4
+ }
@@ -1,13 +1,4 @@
1
1
  {
2
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
- }
3
+ "extends": "../../../common/build/build-common/api-extractor-lint.json"
13
4
  }
@@ -1,12 +1,4 @@
1
1
  {
2
2
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "../../../common/build/build-common/api-extractor-base.json",
4
- "messages": {
5
- "extractorMessageReporting": {
6
- // TODO: Add missing documentation and remove this rule override
7
- "ae-undocumented": {
8
- "logLevel": "none"
9
- }
10
- }
11
- }
3
+ "extends": "../../../common/build/build-common/api-extractor-base.json"
12
4
  }
@@ -15,7 +15,7 @@ import { IEventProvider } from '@fluidframework/core-interfaces';
15
15
  import { IFluidLoadable } from '@fluidframework/core-interfaces';
16
16
  import { IRuntimeFactory } from '@fluidframework/container-definitions';
17
17
 
18
- // @alpha
18
+ // @public
19
19
  export interface ContainerSchema {
20
20
  dynamicObjectTypes?: LoadableObjectClass<any>[];
21
21
  initialObjects: LoadableObjectClassRecord;
@@ -38,20 +38,20 @@ export function createServiceAudience<M extends IMember = IMember>(props: {
38
38
  createServiceMember: (audienceMember: IClient) => M;
39
39
  }): IServiceAudience<M>;
40
40
 
41
- // @alpha
41
+ // @public
42
42
  export type DataObjectClass<T extends IFluidLoadable> = {
43
43
  readonly factory: {
44
44
  IFluidDataStoreFactory: DataObjectClass<T>["factory"];
45
45
  };
46
46
  } & LoadableObjectCtor<T>;
47
47
 
48
- // @alpha
48
+ // @public
49
49
  export interface IConnection {
50
50
  id: string;
51
51
  mode: "write" | "read";
52
52
  }
53
53
 
54
- // @alpha
54
+ // @public @sealed
55
55
  export interface IFluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema> extends IEventProvider<IFluidContainerEvents> {
56
56
  attach(): Promise<string>;
57
57
  readonly attachState: AttachState;
@@ -65,7 +65,7 @@ export interface IFluidContainer<TContainerSchema extends ContainerSchema = Cont
65
65
  readonly isDirty: boolean;
66
66
  }
67
67
 
68
- // @alpha
68
+ // @public @sealed
69
69
  export interface IFluidContainerEvents extends IEvent {
70
70
  (event: "connected", listener: () => void): void;
71
71
  (event: "disconnected", listener: () => void): void;
@@ -74,13 +74,13 @@ export interface IFluidContainerEvents extends IEvent {
74
74
  (event: "disposed", listener: (error?: ICriticalContainerError) => void): any;
75
75
  }
76
76
 
77
- // @alpha
77
+ // @public
78
78
  export interface IMember {
79
79
  connections: IConnection[];
80
80
  userId: string;
81
81
  }
82
82
 
83
- // @alpha
83
+ // @public
84
84
  export type InitialObjects<T extends ContainerSchema> = {
85
85
  [K in keyof T["initialObjects"]]: T["initialObjects"][K] extends LoadableObjectClass<infer TChannel> ? TChannel : never;
86
86
  };
@@ -97,13 +97,13 @@ export interface IRootDataObject extends IProvideRootDataObject {
97
97
  readonly initialObjects: LoadableObjectRecord;
98
98
  }
99
99
 
100
- // @alpha
100
+ // @public
101
101
  export interface IServiceAudience<M extends IMember> extends IEventProvider<IServiceAudienceEvents<M>> {
102
102
  getMembers(): Map<string, M>;
103
103
  getMyself(): Myself<M> | undefined;
104
104
  }
105
105
 
106
- // @alpha
106
+ // @public
107
107
  export interface IServiceAudienceEvents<M extends IMember> extends IEvent {
108
108
  // @eventProperty
109
109
  (event: "membersChanged", listener: () => void): void;
@@ -113,27 +113,27 @@ export interface IServiceAudienceEvents<M extends IMember> extends IEvent {
113
113
  (event: "memberRemoved", listener: MemberChangedListener<M>): void;
114
114
  }
115
115
 
116
- // @alpha
116
+ // @public
117
117
  export type LoadableObjectClass<T extends IFluidLoadable> = DataObjectClass<T> | SharedObjectClass<T>;
118
118
 
119
- // @alpha
119
+ // @public
120
120
  export type LoadableObjectClassRecord = Record<string, LoadableObjectClass<any>>;
121
121
 
122
- // @alpha
122
+ // @public
123
123
  export type LoadableObjectCtor<T extends IFluidLoadable> = new (...args: any[]) => T;
124
124
 
125
- // @alpha
125
+ // @internal
126
126
  export type LoadableObjectRecord = Record<string, IFluidLoadable>;
127
127
 
128
- // @alpha
128
+ // @public
129
129
  export type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;
130
130
 
131
- // @alpha
131
+ // @public
132
132
  export type Myself<M extends IMember = IMember> = M & {
133
133
  currentConnection: string;
134
134
  };
135
135
 
136
- // @alpha
136
+ // @public
137
137
  export type SharedObjectClass<T extends IFluidLoadable> = {
138
138
  readonly getFactory: () => IChannelFactory;
139
139
  } & LoadableObjectCtor<T>;
@@ -22,7 +22,7 @@ import { IRuntimeFactory } from '@fluidframework/container-definitions';
22
22
  *
23
23
  * It includes both the instances of objects that are initially available upon `Container` creation, as well
24
24
  * as the types of objects that may be dynamically created throughout the lifetime of the `Container`.
25
- * @alpha
25
+ * @public
26
26
  */
27
27
  export declare interface ContainerSchema {
28
28
  /**
@@ -68,7 +68,7 @@ export declare interface ContainerSchema {
68
68
  * constructor that will return the type of the `DataObject`.
69
69
  *
70
70
  * @typeParam T - The class of the `DataObject`.
71
- * @alpha
71
+ * @public
72
72
  */
73
73
  export declare type DataObjectClass<T extends IFluidLoadable> = {
74
74
  readonly factory: {
@@ -80,7 +80,7 @@ export declare type DataObjectClass<T extends IFluidLoadable> = {
80
80
  * Base interface for information for each connection made to the Fluid session.
81
81
  *
82
82
  * @remarks This interface can be extended to provide additional information specific to each service.
83
- * @alpha
83
+ * @public
84
84
  */
85
85
  export declare interface IConnection {
86
86
  /**
@@ -100,7 +100,8 @@ export declare interface IConnection {
100
100
  * @typeparam TContainerSchema - Used to determine the type of 'initialObjects'.
101
101
  *
102
102
  * @remarks Note: external implementations of this interface are not supported.
103
- * @alpha
103
+ * @sealed
104
+ * @public
104
105
  */
105
106
  export declare interface IFluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema> extends IEventProvider<IFluidContainerEvents> {
106
107
  /**
@@ -207,7 +208,10 @@ export declare interface IFluidContainer<TContainerSchema extends ContainerSchem
207
208
 
208
209
  /**
209
210
  * Events emitted from {@link IFluidContainer}.
210
- * @alpha
211
+ *
212
+ * @remarks Note: external implementations of this interface are not supported.
213
+ * @sealed
214
+ * @public
211
215
  */
212
216
  export declare interface IFluidContainerEvents extends IEvent {
213
217
  /**
@@ -265,7 +269,7 @@ export declare interface IFluidContainerEvents extends IEvent {
265
269
  * Base interface to be implemented to fetch each service's member.
266
270
  *
267
271
  * @remarks This interface can be extended by each service to provide additional service-specific user metadata.
268
- * @alpha
272
+ * @public
269
273
  */
270
274
  export declare interface IMember {
271
275
  /**
@@ -280,7 +284,7 @@ export declare interface IMember {
280
284
 
281
285
  /**
282
286
  * Extract the type of 'initialObjects' from the given {@link ContainerSchema} type.
283
- * @alpha
287
+ * @public
284
288
  */
285
289
  export declare type InitialObjects<T extends ContainerSchema> = {
286
290
  [K in keyof T["initialObjects"]]: T["initialObjects"][K] extends LoadableObjectClass<infer TChannel> ? TChannel : never;
@@ -299,7 +303,7 @@ export declare type InitialObjects<T extends ContainerSchema> = {
299
303
  * details about the connecting client, such as device information, environment, or a username.
300
304
  *
301
305
  * @typeParam M - A service-specific {@link IMember} type.
302
- * @alpha
306
+ * @public
303
307
  */
304
308
  export declare interface IServiceAudience<M extends IMember> extends IEventProvider<IServiceAudienceEvents<M>> {
305
309
  /**
@@ -323,7 +327,7 @@ export declare interface IServiceAudience<M extends IMember> extends IEventProvi
323
327
  * {@link IServiceAudience.getMembers} method will emit events.
324
328
  *
325
329
  * @typeParam M - A service-specific {@link IMember} implementation.
326
- * @alpha
330
+ * @public
327
331
  */
328
332
  export declare interface IServiceAudienceEvents<M extends IMember> extends IEvent {
329
333
  /**
@@ -350,14 +354,14 @@ export declare interface IServiceAudienceEvents<M extends IMember> extends IEven
350
354
  * A class object of `DataObject` or `SharedObject`.
351
355
  *
352
356
  * @typeParam T - The class of the `DataObject` or `SharedObject`.
353
- * @alpha
357
+ * @public
354
358
  */
355
359
  export declare type LoadableObjectClass<T extends IFluidLoadable> = DataObjectClass<T> | SharedObjectClass<T>;
356
360
 
357
361
  /**
358
362
  * A mapping of string identifiers to classes that will later be used to instantiate a corresponding `DataObject`
359
363
  * or `SharedObject` in a {@link LoadableObjectRecord}.
360
- * @alpha
364
+ * @public
361
365
  */
362
366
  export declare type LoadableObjectClassRecord = Record<string, LoadableObjectClass<any>>;
363
367
 
@@ -365,15 +369,11 @@ export declare type LoadableObjectClassRecord = Record<string, LoadableObjectCla
365
369
  * An object with a constructor that will return an {@link @fluidframework/core-interfaces#IFluidLoadable}.
366
370
  *
367
371
  * @typeParam T - The class of the loadable object.
368
- * @alpha
372
+ * @public
369
373
  */
370
374
  export declare type LoadableObjectCtor<T extends IFluidLoadable> = new (...args: any[]) => T;
371
375
 
372
- /**
373
- * A mapping of string identifiers to instantiated `DataObject`s or `SharedObject`s.
374
- * @alpha
375
- */
376
- export declare type LoadableObjectRecord = Record<string, IFluidLoadable>;
376
+ /* Excluded from this release type: LoadableObjectRecord */
377
377
 
378
378
  /**
379
379
  * Signature for {@link IMember} change events.
@@ -382,13 +382,13 @@ export declare type LoadableObjectRecord = Record<string, IFluidLoadable>;
382
382
  * @param member - The service-specific member object for the client.
383
383
  *
384
384
  * @see See {@link IServiceAudienceEvents} for usage details.
385
- * @alpha
385
+ * @public
386
386
  */
387
387
  export declare type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;
388
388
 
389
389
  /**
390
390
  * An extended member object that includes currentConnection
391
- * @alpha
391
+ * @public
392
392
  */
393
393
  export declare type Myself<M extends IMember = IMember> = M & {
394
394
  currentConnection: string;
@@ -399,7 +399,7 @@ export declare type Myself<M extends IMember = IMember> = M & {
399
399
  * constructor that will return the type of the `DataObject`.
400
400
  *
401
401
  * @typeParam T - The class of the `SharedObject`.
402
- * @alpha
402
+ * @public
403
403
  */
404
404
  export declare type SharedObjectClass<T extends IFluidLoadable> = {
405
405
  readonly getFactory: () => IChannelFactory;