@fluidframework/aqueduct 2.0.0-dev-rc.1.0.0.225277 → 2.0.0-dev-rc.1.0.0.232845

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 (102) hide show
  1. package/README.md +0 -6
  2. package/dist/aqueduct-alpha.d.ts +80 -38
  3. package/dist/aqueduct-beta.d.ts +4 -0
  4. package/dist/aqueduct-public.d.ts +4 -0
  5. package/dist/aqueduct-untrimmed.d.ts +80 -38
  6. package/dist/container-runtime-factories/baseContainerRuntimeFactory.d.ts +39 -23
  7. package/dist/container-runtime-factories/baseContainerRuntimeFactory.d.ts.map +1 -1
  8. package/dist/container-runtime-factories/{baseContainerRuntimeFactory.cjs → baseContainerRuntimeFactory.js} +4 -9
  9. package/dist/container-runtime-factories/baseContainerRuntimeFactory.js.map +1 -0
  10. package/dist/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.d.ts +36 -24
  11. package/dist/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.d.ts.map +1 -1
  12. package/dist/container-runtime-factories/{containerRuntimeFactoryWithDefaultDataStore.cjs → containerRuntimeFactoryWithDefaultDataStore.js} +4 -13
  13. package/dist/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.js.map +1 -0
  14. package/dist/container-runtime-factories/index.d.ts +2 -2
  15. package/dist/container-runtime-factories/index.d.ts.map +1 -1
  16. package/dist/container-runtime-factories/{index.cjs → index.js} +3 -3
  17. package/dist/container-runtime-factories/index.js.map +1 -0
  18. package/dist/data-object-factories/dataObjectFactory.d.ts +4 -4
  19. package/dist/data-object-factories/dataObjectFactory.d.ts.map +1 -1
  20. package/dist/data-object-factories/{dataObjectFactory.cjs → dataObjectFactory.js} +4 -4
  21. package/dist/data-object-factories/dataObjectFactory.js.map +1 -0
  22. package/dist/data-object-factories/{index.cjs → index.js} +3 -3
  23. package/dist/data-object-factories/index.js.map +1 -0
  24. package/dist/data-object-factories/pureDataObjectFactory.d.ts +11 -5
  25. package/dist/data-object-factories/pureDataObjectFactory.d.ts.map +1 -1
  26. package/dist/data-object-factories/{pureDataObjectFactory.cjs → pureDataObjectFactory.js} +7 -1
  27. package/dist/data-object-factories/pureDataObjectFactory.js.map +1 -0
  28. package/dist/data-objects/dataObject.d.ts +2 -2
  29. package/dist/data-objects/dataObject.d.ts.map +1 -1
  30. package/dist/data-objects/{dataObject.cjs → dataObject.js} +8 -8
  31. package/dist/data-objects/dataObject.js.map +1 -0
  32. package/dist/data-objects/index.d.ts +1 -1
  33. package/dist/data-objects/index.d.ts.map +1 -1
  34. package/dist/data-objects/{index.cjs → index.js} +3 -3
  35. package/dist/data-objects/index.js.map +1 -0
  36. package/dist/data-objects/pureDataObject.d.ts +12 -6
  37. package/dist/data-objects/pureDataObject.d.ts.map +1 -1
  38. package/dist/data-objects/{pureDataObject.cjs → pureDataObject.js} +11 -1
  39. package/dist/data-objects/pureDataObject.js.map +1 -0
  40. package/dist/data-objects/types.d.ts +7 -7
  41. package/dist/data-objects/types.d.ts.map +1 -1
  42. package/dist/data-objects/{types.cjs → types.js} +1 -1
  43. package/dist/data-objects/types.js.map +1 -0
  44. package/dist/index.d.ts +2 -2
  45. package/dist/index.d.ts.map +1 -1
  46. package/dist/{index.cjs → index.js} +4 -4
  47. package/dist/index.js.map +1 -0
  48. package/dist/tsdoc-metadata.json +1 -1
  49. package/lib/aqueduct-alpha.d.mts +80 -38
  50. package/lib/aqueduct-beta.d.mts +4 -0
  51. package/lib/aqueduct-public.d.mts +4 -0
  52. package/lib/aqueduct-untrimmed.d.mts +80 -38
  53. package/lib/container-runtime-factories/baseContainerRuntimeFactory.d.mts +39 -23
  54. package/lib/container-runtime-factories/baseContainerRuntimeFactory.d.mts.map +1 -1
  55. package/lib/container-runtime-factories/baseContainerRuntimeFactory.mjs +4 -9
  56. package/lib/container-runtime-factories/baseContainerRuntimeFactory.mjs.map +1 -1
  57. package/lib/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.d.mts +36 -24
  58. package/lib/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.d.mts.map +1 -1
  59. package/lib/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.mjs +2 -11
  60. package/lib/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.mjs.map +1 -1
  61. package/lib/container-runtime-factories/index.d.mts +2 -2
  62. package/lib/container-runtime-factories/index.d.mts.map +1 -1
  63. package/lib/container-runtime-factories/index.mjs +2 -2
  64. package/lib/container-runtime-factories/index.mjs.map +1 -1
  65. package/lib/data-object-factories/dataObjectFactory.d.mts +4 -4
  66. package/lib/data-object-factories/dataObjectFactory.d.mts.map +1 -1
  67. package/lib/data-object-factories/dataObjectFactory.mjs +2 -2
  68. package/lib/data-object-factories/dataObjectFactory.mjs.map +1 -1
  69. package/lib/data-object-factories/pureDataObjectFactory.d.mts +11 -5
  70. package/lib/data-object-factories/pureDataObjectFactory.d.mts.map +1 -1
  71. package/lib/data-object-factories/pureDataObjectFactory.mjs +6 -0
  72. package/lib/data-object-factories/pureDataObjectFactory.mjs.map +1 -1
  73. package/lib/data-objects/dataObject.d.mts +2 -2
  74. package/lib/data-objects/dataObject.d.mts.map +1 -1
  75. package/lib/data-objects/dataObject.mjs +6 -6
  76. package/lib/data-objects/dataObject.mjs.map +1 -1
  77. package/lib/data-objects/index.d.mts +1 -1
  78. package/lib/data-objects/index.d.mts.map +1 -1
  79. package/lib/data-objects/index.mjs.map +1 -1
  80. package/lib/data-objects/pureDataObject.d.mts +12 -6
  81. package/lib/data-objects/pureDataObject.d.mts.map +1 -1
  82. package/lib/data-objects/pureDataObject.mjs +10 -0
  83. package/lib/data-objects/pureDataObject.mjs.map +1 -1
  84. package/lib/data-objects/types.d.mts +7 -7
  85. package/lib/data-objects/types.d.mts.map +1 -1
  86. package/lib/data-objects/types.mjs.map +1 -1
  87. package/lib/index.d.mts +2 -2
  88. package/lib/index.d.mts.map +1 -1
  89. package/lib/index.mjs +1 -1
  90. package/lib/index.mjs.map +1 -1
  91. package/package.json +28 -28
  92. package/dist/container-runtime-factories/baseContainerRuntimeFactory.cjs.map +0 -1
  93. package/dist/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.cjs.map +0 -1
  94. package/dist/container-runtime-factories/index.cjs.map +0 -1
  95. package/dist/data-object-factories/dataObjectFactory.cjs.map +0 -1
  96. package/dist/data-object-factories/index.cjs.map +0 -1
  97. package/dist/data-object-factories/pureDataObjectFactory.cjs.map +0 -1
  98. package/dist/data-objects/dataObject.cjs.map +0 -1
  99. package/dist/data-objects/index.cjs.map +0 -1
  100. package/dist/data-objects/pureDataObject.cjs.map +0 -1
  101. package/dist/data-objects/types.cjs.map +0 -1
  102. package/dist/index.cjs.map +0 -1
package/README.md CHANGED
@@ -11,12 +11,6 @@ When taking a dependency on a Fluid Framework library, we recommend using a `^`
11
11
  While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
12
12
  library consumers should always prefer `^`.
13
13
 
14
- Note that when depending on a library version of the form `2.0.0-internal.x.y.z`, called the Fluid internal version scheme,
15
- 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`).
16
- Standard `^` and `~` ranges will not work as expected.
17
- See the [@fluid-tools/version-tools](https://github.com/microsoft/FluidFramework/blob/main/build-tools/packages/version-tools/README.md)
18
- package for more information including tools to convert between version schemes.
19
-
20
14
  <!-- prettier-ignore-end -->
21
15
 
22
16
  <!-- AUTO-GENERATED-CONTENT:END -->
@@ -50,6 +50,9 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
50
50
  * @alpha
51
51
  */
52
52
  export declare class BaseContainerRuntimeFactory extends RuntimeFactoryHelper implements IProvideFluidDataStoreRegistry {
53
+ /**
54
+ * {@inheritDoc @fluidframework/runtime-definitions#IProvideFluidDataStoreRegistry.IFluidDataStoreRegistry}
55
+ */
53
56
  get IFluidDataStoreRegistry(): IFluidDataStoreRegistry;
54
57
  private readonly registry;
55
58
  private readonly registryEntries;
@@ -57,22 +60,7 @@ export declare class BaseContainerRuntimeFactory extends RuntimeFactoryHelper im
57
60
  private readonly runtimeOptions?;
58
61
  private readonly requestHandlers;
59
62
  private readonly provideEntryPoint;
60
- /**
61
- * @param registryEntries - The data store registry for containers produced
62
- * @param dependencyContainer - deprecated, will be removed in a future release
63
- * @param requestHandlers - Request handlers for containers produced
64
- * @param runtimeOptions - The runtime options passed to the ContainerRuntime when instantiating it
65
- * @param provideEntryPoint - Function that will initialize the entryPoint of the ContainerRuntime instances
66
- * created with this factory
67
- */
68
- constructor(props: {
69
- registryEntries: NamedFluidDataStoreRegistryEntries;
70
- dependencyContainer?: IFluidDependencySynthesizer;
71
- /** @deprecated Will be removed once Loader LTS version is "2.0.0-internal.7.0.0". Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md */
72
- requestHandlers?: RuntimeRequestHandler[];
73
- runtimeOptions?: IContainerRuntimeOptions;
74
- provideEntryPoint: (runtime: IContainerRuntime) => Promise<FluidObject>;
75
- });
63
+ constructor(props: BaseContainerRuntimeFactoryProps);
76
64
  instantiateFirstTime(runtime: ContainerRuntime): Promise<void>;
77
65
  instantiateFromExisting(runtime: ContainerRuntime): Promise<void>;
78
66
  preInitialize(context: IContainerContext, existing: boolean): Promise<ContainerRuntime>;
@@ -90,6 +78,35 @@ export declare class BaseContainerRuntimeFactory extends RuntimeFactoryHelper im
90
78
  protected containerHasInitialized(runtime: IContainerRuntime): Promise<void>;
91
79
  }
92
80
 
81
+ /**
82
+ * {@link BaseContainerRuntimeFactory} construction properties.
83
+ * @alpha
84
+ */
85
+ export declare interface BaseContainerRuntimeFactoryProps {
86
+ /**
87
+ * The data store registry for containers produced.
88
+ */
89
+ registryEntries: NamedFluidDataStoreRegistryEntries;
90
+ /**
91
+ * @deprecated Will be removed in a future release.
92
+ */
93
+ dependencyContainer?: IFluidDependencySynthesizer;
94
+ /**
95
+ * Request handlers for containers produced.
96
+ * @deprecated Will be removed once Loader LTS version is "2.0.0-internal.7.0.0". Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
97
+ */
98
+ requestHandlers?: RuntimeRequestHandler[];
99
+ /**
100
+ * The runtime options passed to the ContainerRuntime when instantiating it
101
+ */
102
+ runtimeOptions?: IContainerRuntimeOptions;
103
+ /**
104
+ * Function that will initialize the entryPoint of the ContainerRuntime instances
105
+ * created with this factory
106
+ */
107
+ provideEntryPoint: (runtime: IContainerRuntime) => Promise<FluidObject>;
108
+ }
109
+
93
110
  /**
94
111
  * A ContainerRuntimeFactory that initializes Containers with a single default data store, which can be requested from
95
112
  * the container with an empty URL.
@@ -100,30 +117,43 @@ export declare class BaseContainerRuntimeFactory extends RuntimeFactoryHelper im
100
117
  export declare class ContainerRuntimeFactoryWithDefaultDataStore extends BaseContainerRuntimeFactory {
101
118
  static readonly defaultDataStoreId = "default";
102
119
  protected readonly defaultFactory: IFluidDataStoreFactory;
103
- /**
104
- * Constructor
105
- * @param defaultFactory -
106
- * @param registryEntries -
107
- * @param dependencyContainer - deprecated, will be removed in a future release
108
- * @param requestHandlers -
109
- * @param runtimeOptions -
110
- * @param provideEntryPoint -
111
- */
112
- constructor(props: {
113
- defaultFactory: IFluidDataStoreFactory;
114
- registryEntries: NamedFluidDataStoreRegistryEntries;
115
- dependencyContainer?: IFluidDependencySynthesizer;
116
- /** @deprecated Will be removed once Loader LTS version is "2.0.0-internal.7.0.0". Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md */
117
- requestHandlers?: RuntimeRequestHandler[];
118
- runtimeOptions?: IContainerRuntimeOptions;
119
- provideEntryPoint?: (runtime: IContainerRuntime) => Promise<FluidObject>;
120
- });
120
+ constructor(props: ContainerRuntimeFactoryWithDefaultDataStoreProps);
121
121
  /**
122
122
  * {@inheritDoc BaseContainerRuntimeFactory.containerInitializingFirstTime}
123
123
  */
124
124
  protected containerInitializingFirstTime(runtime: IContainerRuntime): Promise<void>;
125
125
  }
126
126
 
127
+ /**
128
+ * {@link ContainerRuntimeFactoryWithDefaultDataStore} construction properties.
129
+ * @alpha
130
+ */
131
+ export declare interface ContainerRuntimeFactoryWithDefaultDataStoreProps {
132
+ defaultFactory: IFluidDataStoreFactory;
133
+ /**
134
+ * The data store registry for containers produced.
135
+ */
136
+ registryEntries: NamedFluidDataStoreRegistryEntries;
137
+ /**
138
+ * @deprecated Will be removed in a future release.
139
+ */
140
+ dependencyContainer?: IFluidDependencySynthesizer;
141
+ /**
142
+ * Request handlers for containers produced.
143
+ * @deprecated Will be removed once Loader LTS version is "2.0.0-internal.7.0.0". Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
144
+ */
145
+ requestHandlers?: RuntimeRequestHandler[];
146
+ /**
147
+ * The runtime options passed to the ContainerRuntime when instantiating it
148
+ */
149
+ runtimeOptions?: IContainerRuntimeOptions;
150
+ /**
151
+ * Function that will initialize the entryPoint of the ContainerRuntime instances
152
+ * created with this factory
153
+ */
154
+ provideEntryPoint?: (runtime: IContainerRuntime) => Promise<FluidObject>;
155
+ }
156
+
127
157
  /**
128
158
  * DataObject is a base data store that is primed with a root directory. It
129
159
  * ensures that it is created and ready before you can access it.
@@ -174,15 +204,15 @@ export declare class DataObjectFactory<TObj extends DataObject<I>, I extends Dat
174
204
  */
175
205
  export declare interface DataObjectTypes {
176
206
  /**
177
- * represents a type that will define optional providers that will be injected
207
+ * Represents a type that will define optional providers that will be injected.
178
208
  */
179
209
  OptionalProviders?: FluidObject;
180
210
  /**
181
- * the initial state type that the produced data object may take during creation
211
+ * The initial state type that the produced data object may take during creation.
182
212
  */
183
213
  InitialState?: any;
184
214
  /**
185
- * represents events that will be available in the EventForwarder
215
+ * Represents events that will be available in the EventForwarder.
186
216
  */
187
217
  Events?: IEvent;
188
218
  }
@@ -225,13 +255,19 @@ export declare abstract class PureDataObject<I extends DataObjectTypes = DataObj
225
255
  protected initProps?: I["InitialState"];
226
256
  protected initializeP: Promise<void> | undefined;
227
257
  get id(): string;
258
+ /**
259
+ * {@inheritDoc @fluidframework/core-interfaces#IProvideFluidLoadable.IFluidLoadable}
260
+ */
228
261
  get IFluidLoadable(): this;
262
+ /**
263
+ * {@inheritDoc @fluidframework/core-interfaces#IProvideFluidHandle.IFluidHandle}
264
+ */
229
265
  get IFluidHandle(): IFluidHandle<this>;
230
266
  /**
231
267
  * Handle to a data store
232
268
  */
233
269
  get handle(): IFluidHandle<this>;
234
- static getDataObject(runtime: IFluidDataStoreRuntime): Promise<PureDataObject<DataObjectTypes>>;
270
+ static getDataObject(runtime: IFluidDataStoreRuntime): Promise<PureDataObject>;
235
271
  constructor(props: IDataObjectProps<I>);
236
272
  /**
237
273
  * Return this object if someone requests it directly
@@ -298,7 +334,13 @@ export declare class PureDataObjectFactory<TObj extends PureDataObject<I>, I ext
298
334
  private readonly sharedObjectRegistry;
299
335
  private readonly registry;
300
336
  constructor(type: string, ctor: new (props: IDataObjectProps<I>) => TObj, sharedObjects: readonly IChannelFactory[], optionalProviders: FluidObjectSymbolProvider<I["OptionalProviders"]>, registryEntries?: NamedFluidDataStoreRegistryEntries, runtimeClass?: typeof FluidDataStoreRuntime);
337
+ /**
338
+ * {@inheritDoc @fluidframework/runtime-definitions#IProvideFluidDataStoreFactory.IFluidDataStoreFactory}
339
+ */
301
340
  get IFluidDataStoreFactory(): this;
341
+ /**
342
+ * {@inheritDoc @fluidframework/runtime-definitions#IProvideFluidDataStoreRegistry.IFluidDataStoreRegistry}
343
+ */
302
344
  get IFluidDataStoreRegistry(): IFluidDataStoreRegistry | undefined;
303
345
  /**
304
346
  * Convenience helper to get the data store's/factory's data store registry entry.
@@ -47,10 +47,14 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
47
47
 
48
48
  /* Excluded from this release type: BaseContainerRuntimeFactory */
49
49
 
50
+ /* Excluded from this release type: BaseContainerRuntimeFactoryProps */
51
+
50
52
  /* Excluded from this release type: ContainerRuntime */
51
53
 
52
54
  /* Excluded from this release type: ContainerRuntimeFactoryWithDefaultDataStore */
53
55
 
56
+ /* Excluded from this release type: ContainerRuntimeFactoryWithDefaultDataStoreProps */
57
+
54
58
  /* Excluded from this release type: DataObject */
55
59
 
56
60
  /* Excluded from this release type: DataObjectFactory */
@@ -47,10 +47,14 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
47
47
 
48
48
  /* Excluded from this release type: BaseContainerRuntimeFactory */
49
49
 
50
+ /* Excluded from this release type: BaseContainerRuntimeFactoryProps */
51
+
50
52
  /* Excluded from this release type: ContainerRuntime */
51
53
 
52
54
  /* Excluded from this release type: ContainerRuntimeFactoryWithDefaultDataStore */
53
55
 
56
+ /* Excluded from this release type: ContainerRuntimeFactoryWithDefaultDataStoreProps */
57
+
54
58
  /* Excluded from this release type: DataObject */
55
59
 
56
60
  /* Excluded from this release type: DataObjectFactory */
@@ -50,6 +50,9 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
50
50
  * @alpha
51
51
  */
52
52
  export declare class BaseContainerRuntimeFactory extends RuntimeFactoryHelper implements IProvideFluidDataStoreRegistry {
53
+ /**
54
+ * {@inheritDoc @fluidframework/runtime-definitions#IProvideFluidDataStoreRegistry.IFluidDataStoreRegistry}
55
+ */
53
56
  get IFluidDataStoreRegistry(): IFluidDataStoreRegistry;
54
57
  private readonly registry;
55
58
  private readonly registryEntries;
@@ -57,22 +60,7 @@ export declare class BaseContainerRuntimeFactory extends RuntimeFactoryHelper im
57
60
  private readonly runtimeOptions?;
58
61
  private readonly requestHandlers;
59
62
  private readonly provideEntryPoint;
60
- /**
61
- * @param registryEntries - The data store registry for containers produced
62
- * @param dependencyContainer - deprecated, will be removed in a future release
63
- * @param requestHandlers - Request handlers for containers produced
64
- * @param runtimeOptions - The runtime options passed to the ContainerRuntime when instantiating it
65
- * @param provideEntryPoint - Function that will initialize the entryPoint of the ContainerRuntime instances
66
- * created with this factory
67
- */
68
- constructor(props: {
69
- registryEntries: NamedFluidDataStoreRegistryEntries;
70
- dependencyContainer?: IFluidDependencySynthesizer;
71
- /** @deprecated Will be removed once Loader LTS version is "2.0.0-internal.7.0.0". Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md */
72
- requestHandlers?: RuntimeRequestHandler[];
73
- runtimeOptions?: IContainerRuntimeOptions;
74
- provideEntryPoint: (runtime: IContainerRuntime) => Promise<FluidObject>;
75
- });
63
+ constructor(props: BaseContainerRuntimeFactoryProps);
76
64
  instantiateFirstTime(runtime: ContainerRuntime): Promise<void>;
77
65
  instantiateFromExisting(runtime: ContainerRuntime): Promise<void>;
78
66
  preInitialize(context: IContainerContext, existing: boolean): Promise<ContainerRuntime>;
@@ -90,6 +78,35 @@ export declare class BaseContainerRuntimeFactory extends RuntimeFactoryHelper im
90
78
  protected containerHasInitialized(runtime: IContainerRuntime): Promise<void>;
91
79
  }
92
80
 
81
+ /**
82
+ * {@link BaseContainerRuntimeFactory} construction properties.
83
+ * @alpha
84
+ */
85
+ export declare interface BaseContainerRuntimeFactoryProps {
86
+ /**
87
+ * The data store registry for containers produced.
88
+ */
89
+ registryEntries: NamedFluidDataStoreRegistryEntries;
90
+ /**
91
+ * @deprecated Will be removed in a future release.
92
+ */
93
+ dependencyContainer?: IFluidDependencySynthesizer;
94
+ /**
95
+ * Request handlers for containers produced.
96
+ * @deprecated Will be removed once Loader LTS version is "2.0.0-internal.7.0.0". Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
97
+ */
98
+ requestHandlers?: RuntimeRequestHandler[];
99
+ /**
100
+ * The runtime options passed to the ContainerRuntime when instantiating it
101
+ */
102
+ runtimeOptions?: IContainerRuntimeOptions;
103
+ /**
104
+ * Function that will initialize the entryPoint of the ContainerRuntime instances
105
+ * created with this factory
106
+ */
107
+ provideEntryPoint: (runtime: IContainerRuntime) => Promise<FluidObject>;
108
+ }
109
+
93
110
  /**
94
111
  * A ContainerRuntimeFactory that initializes Containers with a single default data store, which can be requested from
95
112
  * the container with an empty URL.
@@ -100,30 +117,43 @@ export declare class BaseContainerRuntimeFactory extends RuntimeFactoryHelper im
100
117
  export declare class ContainerRuntimeFactoryWithDefaultDataStore extends BaseContainerRuntimeFactory {
101
118
  static readonly defaultDataStoreId = "default";
102
119
  protected readonly defaultFactory: IFluidDataStoreFactory;
103
- /**
104
- * Constructor
105
- * @param defaultFactory -
106
- * @param registryEntries -
107
- * @param dependencyContainer - deprecated, will be removed in a future release
108
- * @param requestHandlers -
109
- * @param runtimeOptions -
110
- * @param provideEntryPoint -
111
- */
112
- constructor(props: {
113
- defaultFactory: IFluidDataStoreFactory;
114
- registryEntries: NamedFluidDataStoreRegistryEntries;
115
- dependencyContainer?: IFluidDependencySynthesizer;
116
- /** @deprecated Will be removed once Loader LTS version is "2.0.0-internal.7.0.0". Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md */
117
- requestHandlers?: RuntimeRequestHandler[];
118
- runtimeOptions?: IContainerRuntimeOptions;
119
- provideEntryPoint?: (runtime: IContainerRuntime) => Promise<FluidObject>;
120
- });
120
+ constructor(props: ContainerRuntimeFactoryWithDefaultDataStoreProps);
121
121
  /**
122
122
  * {@inheritDoc BaseContainerRuntimeFactory.containerInitializingFirstTime}
123
123
  */
124
124
  protected containerInitializingFirstTime(runtime: IContainerRuntime): Promise<void>;
125
125
  }
126
126
 
127
+ /**
128
+ * {@link ContainerRuntimeFactoryWithDefaultDataStore} construction properties.
129
+ * @alpha
130
+ */
131
+ export declare interface ContainerRuntimeFactoryWithDefaultDataStoreProps {
132
+ defaultFactory: IFluidDataStoreFactory;
133
+ /**
134
+ * The data store registry for containers produced.
135
+ */
136
+ registryEntries: NamedFluidDataStoreRegistryEntries;
137
+ /**
138
+ * @deprecated Will be removed in a future release.
139
+ */
140
+ dependencyContainer?: IFluidDependencySynthesizer;
141
+ /**
142
+ * Request handlers for containers produced.
143
+ * @deprecated Will be removed once Loader LTS version is "2.0.0-internal.7.0.0". Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
144
+ */
145
+ requestHandlers?: RuntimeRequestHandler[];
146
+ /**
147
+ * The runtime options passed to the ContainerRuntime when instantiating it
148
+ */
149
+ runtimeOptions?: IContainerRuntimeOptions;
150
+ /**
151
+ * Function that will initialize the entryPoint of the ContainerRuntime instances
152
+ * created with this factory
153
+ */
154
+ provideEntryPoint?: (runtime: IContainerRuntime) => Promise<FluidObject>;
155
+ }
156
+
127
157
  /**
128
158
  * DataObject is a base data store that is primed with a root directory. It
129
159
  * ensures that it is created and ready before you can access it.
@@ -174,15 +204,15 @@ export declare class DataObjectFactory<TObj extends DataObject<I>, I extends Dat
174
204
  */
175
205
  export declare interface DataObjectTypes {
176
206
  /**
177
- * represents a type that will define optional providers that will be injected
207
+ * Represents a type that will define optional providers that will be injected.
178
208
  */
179
209
  OptionalProviders?: FluidObject;
180
210
  /**
181
- * the initial state type that the produced data object may take during creation
211
+ * The initial state type that the produced data object may take during creation.
182
212
  */
183
213
  InitialState?: any;
184
214
  /**
185
- * represents events that will be available in the EventForwarder
215
+ * Represents events that will be available in the EventForwarder.
186
216
  */
187
217
  Events?: IEvent;
188
218
  }
@@ -225,13 +255,19 @@ export declare abstract class PureDataObject<I extends DataObjectTypes = DataObj
225
255
  protected initProps?: I["InitialState"];
226
256
  protected initializeP: Promise<void> | undefined;
227
257
  get id(): string;
258
+ /**
259
+ * {@inheritDoc @fluidframework/core-interfaces#IProvideFluidLoadable.IFluidLoadable}
260
+ */
228
261
  get IFluidLoadable(): this;
262
+ /**
263
+ * {@inheritDoc @fluidframework/core-interfaces#IProvideFluidHandle.IFluidHandle}
264
+ */
229
265
  get IFluidHandle(): IFluidHandle<this>;
230
266
  /**
231
267
  * Handle to a data store
232
268
  */
233
269
  get handle(): IFluidHandle<this>;
234
- static getDataObject(runtime: IFluidDataStoreRuntime): Promise<PureDataObject<DataObjectTypes>>;
270
+ static getDataObject(runtime: IFluidDataStoreRuntime): Promise<PureDataObject>;
235
271
  constructor(props: IDataObjectProps<I>);
236
272
  /**
237
273
  * Return this object if someone requests it directly
@@ -298,7 +334,13 @@ export declare class PureDataObjectFactory<TObj extends PureDataObject<I>, I ext
298
334
  private readonly sharedObjectRegistry;
299
335
  private readonly registry;
300
336
  constructor(type: string, ctor: new (props: IDataObjectProps<I>) => TObj, sharedObjects: readonly IChannelFactory[], optionalProviders: FluidObjectSymbolProvider<I["OptionalProviders"]>, registryEntries?: NamedFluidDataStoreRegistryEntries, runtimeClass?: typeof FluidDataStoreRuntime);
337
+ /**
338
+ * {@inheritDoc @fluidframework/runtime-definitions#IProvideFluidDataStoreFactory.IFluidDataStoreFactory}
339
+ */
301
340
  get IFluidDataStoreFactory(): this;
341
+ /**
342
+ * {@inheritDoc @fluidframework/runtime-definitions#IProvideFluidDataStoreRegistry.IFluidDataStoreRegistry}
343
+ */
302
344
  get IFluidDataStoreRegistry(): IFluidDataStoreRegistry | undefined;
303
345
  /**
304
346
  * Convenience helper to get the data store's/factory's data store registry entry.
@@ -2,14 +2,42 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- import { IContainerContext } from "@fluidframework/container-definitions";
6
- import { IContainerRuntimeOptions, ContainerRuntime } from "@fluidframework/container-runtime";
7
- import { IContainerRuntime } from "@fluidframework/container-runtime-definitions";
8
- import { RuntimeRequestHandler } from "@fluidframework/request-handler";
9
- import { IFluidDataStoreRegistry, IProvideFluidDataStoreRegistry, NamedFluidDataStoreRegistryEntries } from "@fluidframework/runtime-definitions";
10
- import { IFluidDependencySynthesizer } from "@fluidframework/synthesize";
5
+ import { type IContainerContext } from "@fluidframework/container-definitions";
6
+ import { type IContainerRuntimeOptions, ContainerRuntime } from "@fluidframework/container-runtime";
7
+ import { type IContainerRuntime } from "@fluidframework/container-runtime-definitions";
8
+ import { type RuntimeRequestHandler } from "@fluidframework/request-handler";
9
+ import { type IFluidDataStoreRegistry, type IProvideFluidDataStoreRegistry, type NamedFluidDataStoreRegistryEntries } from "@fluidframework/runtime-definitions";
10
+ import { type IFluidDependencySynthesizer } from "@fluidframework/synthesize";
11
11
  import { RuntimeFactoryHelper } from "@fluidframework/runtime-utils";
12
- import { FluidObject } from "@fluidframework/core-interfaces";
12
+ import { type FluidObject } from "@fluidframework/core-interfaces";
13
+ /**
14
+ * {@link BaseContainerRuntimeFactory} construction properties.
15
+ * @alpha
16
+ */
17
+ export interface BaseContainerRuntimeFactoryProps {
18
+ /**
19
+ * The data store registry for containers produced.
20
+ */
21
+ registryEntries: NamedFluidDataStoreRegistryEntries;
22
+ /**
23
+ * @deprecated Will be removed in a future release.
24
+ */
25
+ dependencyContainer?: IFluidDependencySynthesizer;
26
+ /**
27
+ * Request handlers for containers produced.
28
+ * @deprecated Will be removed once Loader LTS version is "2.0.0-internal.7.0.0". Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
29
+ */
30
+ requestHandlers?: RuntimeRequestHandler[];
31
+ /**
32
+ * The runtime options passed to the ContainerRuntime when instantiating it
33
+ */
34
+ runtimeOptions?: IContainerRuntimeOptions;
35
+ /**
36
+ * Function that will initialize the entryPoint of the ContainerRuntime instances
37
+ * created with this factory
38
+ */
39
+ provideEntryPoint: (runtime: IContainerRuntime) => Promise<FluidObject>;
40
+ }
13
41
  /**
14
42
  * BaseContainerRuntimeFactory produces container runtimes with the specified data store and service registries,
15
43
  * request handlers, runtimeOptions, and entryPoint initialization function.
@@ -17,6 +45,9 @@ import { FluidObject } from "@fluidframework/core-interfaces";
17
45
  * @alpha
18
46
  */
19
47
  export declare class BaseContainerRuntimeFactory extends RuntimeFactoryHelper implements IProvideFluidDataStoreRegistry {
48
+ /**
49
+ * {@inheritDoc @fluidframework/runtime-definitions#IProvideFluidDataStoreRegistry.IFluidDataStoreRegistry}
50
+ */
20
51
  get IFluidDataStoreRegistry(): IFluidDataStoreRegistry;
21
52
  private readonly registry;
22
53
  private readonly registryEntries;
@@ -24,22 +55,7 @@ export declare class BaseContainerRuntimeFactory extends RuntimeFactoryHelper im
24
55
  private readonly runtimeOptions?;
25
56
  private readonly requestHandlers;
26
57
  private readonly provideEntryPoint;
27
- /**
28
- * @param registryEntries - The data store registry for containers produced
29
- * @param dependencyContainer - deprecated, will be removed in a future release
30
- * @param requestHandlers - Request handlers for containers produced
31
- * @param runtimeOptions - The runtime options passed to the ContainerRuntime when instantiating it
32
- * @param provideEntryPoint - Function that will initialize the entryPoint of the ContainerRuntime instances
33
- * created with this factory
34
- */
35
- constructor(props: {
36
- registryEntries: NamedFluidDataStoreRegistryEntries;
37
- dependencyContainer?: IFluidDependencySynthesizer;
38
- /** @deprecated Will be removed once Loader LTS version is "2.0.0-internal.7.0.0". Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md */
39
- requestHandlers?: RuntimeRequestHandler[];
40
- runtimeOptions?: IContainerRuntimeOptions;
41
- provideEntryPoint: (runtime: IContainerRuntime) => Promise<FluidObject>;
42
- });
58
+ constructor(props: BaseContainerRuntimeFactoryProps);
43
59
  instantiateFirstTime(runtime: ContainerRuntime): Promise<void>;
44
60
  instantiateFromExisting(runtime: ContainerRuntime): Promise<void>;
45
61
  preInitialize(context: IContainerContext, existing: boolean): Promise<ContainerRuntime>;
@@ -1 +1 @@
1
- {"version":3,"file":"baseContainerRuntimeFactory.d.ts","sourceRoot":"","sources":["../../src/container-runtime-factories/baseContainerRuntimeFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,uCAAuC,CAAC;AAC1E,OAAO,EACN,wBAAwB,EAExB,gBAAgB,EAChB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF,OAAO,EAAE,qBAAqB,EAA8B,MAAM,iCAAiC,CAAC;AACpG,OAAO,EACN,uBAAuB,EACvB,8BAA8B,EAC9B,kCAAkC,EAClC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAEN,2BAA2B,EAE3B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAE9D;;;;;GAKG;AACH,qBAAa,2BACZ,SAAQ,oBACR,YAAW,8BAA8B;IAEzC,IAAW,uBAAuB,4BAEjC;IACD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA0B;IAEnD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAqC;IACrE,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAA8B;IACnE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAA2B;IAC3D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA0B;IAC1D,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAuD;IAEzF;;;;;;;OAOG;gBACS,KAAK,EAAE;QAClB,eAAe,EAAE,kCAAkC,CAAC;QACpD,mBAAmB,CAAC,EAAE,2BAA2B,CAAC;QAClD,sLAAsL;QACtL,eAAe,CAAC,EAAE,qBAAqB,EAAE,CAAC;QAC1C,cAAc,CAAC,EAAE,wBAAwB,CAAC;QAC1C,iBAAiB,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;KACxE;IAWY,oBAAoB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAK9D,uBAAuB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjE,aAAa,CACzB,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,OAAO,GACf,OAAO,CAAC,gBAAgB,CAAC;IAsB5B;;;;OAIG;cACa,8BAA8B,CAAC,OAAO,EAAE,iBAAiB;IAEzE;;;;OAIG;cACa,uBAAuB,CAAC,OAAO,EAAE,iBAAiB;CAClE"}
1
+ {"version":3,"file":"baseContainerRuntimeFactory.d.ts","sourceRoot":"","sources":["../../src/container-runtime-factories/baseContainerRuntimeFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,uCAAuC,CAAC;AAC/E,OAAO,EACN,KAAK,wBAAwB,EAE7B,gBAAgB,EAChB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAEvF,OAAO,EACN,KAAK,qBAAqB,EAE1B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACN,KAAK,uBAAuB,EAC5B,KAAK,8BAA8B,EACnC,KAAK,kCAAkC,EACvC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAEN,KAAK,2BAA2B,EAEhC,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAEnE;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAChD;;OAEG;IACH,eAAe,EAAE,kCAAkC,CAAC;IACpD;;OAEG;IACH,mBAAmB,CAAC,EAAE,2BAA2B,CAAC;IAClD;;;OAGG;IACH,eAAe,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAC1C;;OAEG;IACH,cAAc,CAAC,EAAE,wBAAwB,CAAC;IAC1C;;;OAGG;IACH,iBAAiB,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;CACxE;AAED;;;;;GAKG;AACH,qBAAa,2BACZ,SAAQ,oBACR,YAAW,8BAA8B;IAEzC;;OAEG;IACH,IAAW,uBAAuB,IAAI,uBAAuB,CAE5D;IACD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA0B;IAEnD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAqC;IACrE,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAA8B;IACnE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAA2B;IAC3D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA0B;IAC1D,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAuD;gBAEtE,KAAK,EAAE,gCAAgC;IAW7C,oBAAoB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAK9D,uBAAuB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjE,aAAa,CACzB,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,OAAO,GACf,OAAO,CAAC,gBAAgB,CAAC;IAsB5B;;;;OAIG;cACa,8BAA8B,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAEzF;;;;OAIG;cACa,uBAAuB,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;CAClF"}
@@ -17,17 +17,12 @@ const runtime_utils_1 = require("@fluidframework/runtime-utils");
17
17
  * @alpha
18
18
  */
19
19
  class BaseContainerRuntimeFactory extends runtime_utils_1.RuntimeFactoryHelper {
20
+ /**
21
+ * {@inheritDoc @fluidframework/runtime-definitions#IProvideFluidDataStoreRegistry.IFluidDataStoreRegistry}
22
+ */
20
23
  get IFluidDataStoreRegistry() {
21
24
  return this.registry;
22
25
  }
23
- /**
24
- * @param registryEntries - The data store registry for containers produced
25
- * @param dependencyContainer - deprecated, will be removed in a future release
26
- * @param requestHandlers - Request handlers for containers produced
27
- * @param runtimeOptions - The runtime options passed to the ContainerRuntime when instantiating it
28
- * @param provideEntryPoint - Function that will initialize the entryPoint of the ContainerRuntime instances
29
- * created with this factory
30
- */
31
26
  constructor(props) {
32
27
  super();
33
28
  this.registryEntries = props.registryEntries;
@@ -75,4 +70,4 @@ class BaseContainerRuntimeFactory extends runtime_utils_1.RuntimeFactoryHelper {
75
70
  async containerHasInitialized(runtime) { }
76
71
  }
77
72
  exports.BaseContainerRuntimeFactory = BaseContainerRuntimeFactory;
78
- //# sourceMappingURL=baseContainerRuntimeFactory.cjs.map
73
+ //# sourceMappingURL=baseContainerRuntimeFactory.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"baseContainerRuntimeFactory.js","sourceRoot":"","sources":["../../src/container-runtime-factories/baseContainerRuntimeFactory.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,yEAI2C;AAE3C,gDAAgD;AAChD,qEAGyC;AAMzC,2DAIoC;AACpC,iEAAqE;AAgCrE;;;;;GAKG;AACH,MAAa,2BACZ,SAAQ,oCAAoB;IAG5B;;OAEG;IACH,IAAW,uBAAuB;QACjC,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IASD,YAAmB,KAAuC;QACzD,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;QAC7C,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,mBAAmB,CAAC;QACrD,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC;QAC3C,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACjD,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,IAAI,EAAE,CAAC;QACnD,IAAI,CAAC,QAAQ,GAAG,IAAI,0CAAsB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAClE,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,OAAyB;QAC1D,MAAM,IAAI,CAAC,8BAA8B,CAAC,OAAO,CAAC,CAAC;QACnD,MAAM,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,uBAAuB,CAAC,OAAyB;QAC7D,MAAM,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,aAAa,CACzB,OAA0B,EAC1B,QAAiB;QAEjB,MAAM,KAAK,GAAgD,OAAO,CAAC,KAAK,CAAC;QACzE,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC7B,MAAM,EAAE,GAAG,IAAI,gCAAmB,CACjC,IAAI,CAAC,mBAAmB,EACxB,KAAK,CAAC,2BAA2B,CACjC,CAAC;YACF,KAAK,CAAC,2BAA2B,GAAG,EAAE,CAAC;SACvC;QAED,OAAO,oCAAgB,CAAC,WAAW,CAAC;YACnC,OAAO;YACP,QAAQ;YACR,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,cAAc,EAAE,KAAK;YACrB,gDAAgD;YAChD,cAAc,EAAE,IAAA,4CAA0B,EAAC,GAAG,IAAI,CAAC,eAAe,CAAC;YACnE,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;SACzC,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,8BAA8B,CAAC,OAA0B,IAAkB,CAAC;IAE5F;;;;OAIG;IACO,KAAK,CAAC,uBAAuB,CAAC,OAA0B,IAAkB,CAAC;CACrF;AA5ED,kEA4EC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { type IContainerContext } from \"@fluidframework/container-definitions\";\nimport {\n\ttype IContainerRuntimeOptions,\n\tFluidDataStoreRegistry,\n\tContainerRuntime,\n} from \"@fluidframework/container-runtime\";\nimport { type IContainerRuntime } from \"@fluidframework/container-runtime-definitions\";\n// eslint-disable-next-line import/no-deprecated\nimport {\n\ttype RuntimeRequestHandler,\n\tbuildRuntimeRequestHandler,\n} from \"@fluidframework/request-handler\";\nimport {\n\ttype IFluidDataStoreRegistry,\n\ttype IProvideFluidDataStoreRegistry,\n\ttype NamedFluidDataStoreRegistryEntries,\n} from \"@fluidframework/runtime-definitions\";\nimport {\n\tDependencyContainer,\n\ttype IFluidDependencySynthesizer,\n\ttype IProvideFluidDependencySynthesizer,\n} from \"@fluidframework/synthesize\";\nimport { RuntimeFactoryHelper } from \"@fluidframework/runtime-utils\";\nimport { type FluidObject } from \"@fluidframework/core-interfaces\";\n\n/**\n * {@link BaseContainerRuntimeFactory} construction properties.\n * @alpha\n */\nexport interface BaseContainerRuntimeFactoryProps {\n\t/**\n\t * The data store registry for containers produced.\n\t */\n\tregistryEntries: NamedFluidDataStoreRegistryEntries;\n\t/**\n\t * @deprecated Will be removed in a future release.\n\t */\n\tdependencyContainer?: IFluidDependencySynthesizer;\n\t/**\n\t * Request handlers for containers produced.\n\t * @deprecated Will be removed once Loader LTS version is \"2.0.0-internal.7.0.0\". Migrate all usage of IFluidRouter to the \"entryPoint\" pattern. Refer to Removing-IFluidRouter.md\n\t */\n\trequestHandlers?: RuntimeRequestHandler[];\n\t/**\n\t * The runtime options passed to the ContainerRuntime when instantiating it\n\t */\n\truntimeOptions?: IContainerRuntimeOptions;\n\t/**\n\t * Function that will initialize the entryPoint of the ContainerRuntime instances\n\t * created with this factory\n\t */\n\tprovideEntryPoint: (runtime: IContainerRuntime) => Promise<FluidObject>;\n}\n\n/**\n * BaseContainerRuntimeFactory produces container runtimes with the specified data store and service registries,\n * request handlers, runtimeOptions, and entryPoint initialization function.\n * It can be subclassed to implement a first-time initialization procedure for the containers it creates.\n * @alpha\n */\nexport class BaseContainerRuntimeFactory\n\textends RuntimeFactoryHelper\n\timplements IProvideFluidDataStoreRegistry\n{\n\t/**\n\t * {@inheritDoc @fluidframework/runtime-definitions#IProvideFluidDataStoreRegistry.IFluidDataStoreRegistry}\n\t */\n\tpublic get IFluidDataStoreRegistry(): IFluidDataStoreRegistry {\n\t\treturn this.registry;\n\t}\n\tprivate readonly registry: IFluidDataStoreRegistry;\n\n\tprivate readonly registryEntries: NamedFluidDataStoreRegistryEntries;\n\tprivate readonly dependencyContainer?: IFluidDependencySynthesizer;\n\tprivate readonly runtimeOptions?: IContainerRuntimeOptions;\n\tprivate readonly requestHandlers: RuntimeRequestHandler[];\n\tprivate readonly provideEntryPoint: (runtime: IContainerRuntime) => Promise<FluidObject>;\n\n\tpublic constructor(props: BaseContainerRuntimeFactoryProps) {\n\t\tsuper();\n\n\t\tthis.registryEntries = props.registryEntries;\n\t\tthis.dependencyContainer = props.dependencyContainer;\n\t\tthis.runtimeOptions = props.runtimeOptions;\n\t\tthis.provideEntryPoint = props.provideEntryPoint;\n\t\tthis.requestHandlers = props.requestHandlers ?? [];\n\t\tthis.registry = new FluidDataStoreRegistry(this.registryEntries);\n\t}\n\n\tpublic async instantiateFirstTime(runtime: ContainerRuntime): Promise<void> {\n\t\tawait this.containerInitializingFirstTime(runtime);\n\t\tawait this.containerHasInitialized(runtime);\n\t}\n\n\tpublic async instantiateFromExisting(runtime: ContainerRuntime): Promise<void> {\n\t\tawait this.containerHasInitialized(runtime);\n\t}\n\n\tpublic async preInitialize(\n\t\tcontext: IContainerContext,\n\t\texisting: boolean,\n\t): Promise<ContainerRuntime> {\n\t\tconst scope: Partial<IProvideFluidDependencySynthesizer> = context.scope;\n\t\tif (this.dependencyContainer) {\n\t\t\tconst dc = new DependencyContainer<FluidObject>(\n\t\t\t\tthis.dependencyContainer,\n\t\t\t\tscope.IFluidDependencySynthesizer,\n\t\t\t);\n\t\t\tscope.IFluidDependencySynthesizer = dc;\n\t\t}\n\n\t\treturn ContainerRuntime.loadRuntime({\n\t\t\tcontext,\n\t\t\texisting,\n\t\t\truntimeOptions: this.runtimeOptions,\n\t\t\tregistryEntries: this.registryEntries,\n\t\t\tcontainerScope: scope,\n\t\t\t// eslint-disable-next-line import/no-deprecated\n\t\t\trequestHandler: buildRuntimeRequestHandler(...this.requestHandlers),\n\t\t\tprovideEntryPoint: this.provideEntryPoint,\n\t\t});\n\t}\n\n\t/**\n\t * Subclasses may override containerInitializingFirstTime to perform any setup steps at the time the container\n\t * is created. This likely includes creating any initial data stores that are expected to be there at the outset.\n\t * @param runtime - The container runtime for the container being initialized\n\t */\n\tprotected async containerInitializingFirstTime(runtime: IContainerRuntime): Promise<void> {}\n\n\t/**\n\t * Subclasses may override containerHasInitialized to perform any steps after the container has initialized.\n\t * This likely includes loading any data stores that are expected to be there at the outset.\n\t * @param runtime - The container runtime for the container being initialized\n\t */\n\tprotected async containerHasInitialized(runtime: IContainerRuntime): Promise<void> {}\n}\n"]}
@@ -2,13 +2,42 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- import { IContainerRuntimeOptions } from "@fluidframework/container-runtime";
6
- import { IFluidDataStoreFactory, NamedFluidDataStoreRegistryEntries } from "@fluidframework/runtime-definitions";
7
- import { IContainerRuntime } from "@fluidframework/container-runtime-definitions";
8
- import { IFluidDependencySynthesizer } from "@fluidframework/synthesize";
9
- import { RuntimeRequestHandler } from "@fluidframework/request-handler";
10
- import { FluidObject } from "@fluidframework/core-interfaces";
5
+ import { type IContainerRuntimeOptions } from "@fluidframework/container-runtime";
6
+ import { type NamedFluidDataStoreRegistryEntries, type IFluidDataStoreFactory } from "@fluidframework/runtime-definitions";
7
+ import { type IContainerRuntime } from "@fluidframework/container-runtime-definitions";
8
+ import { type FluidObject } from "@fluidframework/core-interfaces";
9
+ import { type IFluidDependencySynthesizer } from "@fluidframework/synthesize";
10
+ import { type RuntimeRequestHandler } from "@fluidframework/request-handler";
11
11
  import { BaseContainerRuntimeFactory } from "./baseContainerRuntimeFactory";
12
+ /**
13
+ * {@link ContainerRuntimeFactoryWithDefaultDataStore} construction properties.
14
+ * @alpha
15
+ */
16
+ export interface ContainerRuntimeFactoryWithDefaultDataStoreProps {
17
+ defaultFactory: IFluidDataStoreFactory;
18
+ /**
19
+ * The data store registry for containers produced.
20
+ */
21
+ registryEntries: NamedFluidDataStoreRegistryEntries;
22
+ /**
23
+ * @deprecated Will be removed in a future release.
24
+ */
25
+ dependencyContainer?: IFluidDependencySynthesizer;
26
+ /**
27
+ * Request handlers for containers produced.
28
+ * @deprecated Will be removed once Loader LTS version is "2.0.0-internal.7.0.0". Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
29
+ */
30
+ requestHandlers?: RuntimeRequestHandler[];
31
+ /**
32
+ * The runtime options passed to the ContainerRuntime when instantiating it
33
+ */
34
+ runtimeOptions?: IContainerRuntimeOptions;
35
+ /**
36
+ * Function that will initialize the entryPoint of the ContainerRuntime instances
37
+ * created with this factory
38
+ */
39
+ provideEntryPoint?: (runtime: IContainerRuntime) => Promise<FluidObject>;
40
+ }
12
41
  /**
13
42
  * A ContainerRuntimeFactory that initializes Containers with a single default data store, which can be requested from
14
43
  * the container with an empty URL.
@@ -19,24 +48,7 @@ import { BaseContainerRuntimeFactory } from "./baseContainerRuntimeFactory";
19
48
  export declare class ContainerRuntimeFactoryWithDefaultDataStore extends BaseContainerRuntimeFactory {
20
49
  static readonly defaultDataStoreId = "default";
21
50
  protected readonly defaultFactory: IFluidDataStoreFactory;
22
- /**
23
- * Constructor
24
- * @param defaultFactory -
25
- * @param registryEntries -
26
- * @param dependencyContainer - deprecated, will be removed in a future release
27
- * @param requestHandlers -
28
- * @param runtimeOptions -
29
- * @param provideEntryPoint -
30
- */
31
- constructor(props: {
32
- defaultFactory: IFluidDataStoreFactory;
33
- registryEntries: NamedFluidDataStoreRegistryEntries;
34
- dependencyContainer?: IFluidDependencySynthesizer;
35
- /** @deprecated Will be removed once Loader LTS version is "2.0.0-internal.7.0.0". Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md */
36
- requestHandlers?: RuntimeRequestHandler[];
37
- runtimeOptions?: IContainerRuntimeOptions;
38
- provideEntryPoint?: (runtime: IContainerRuntime) => Promise<FluidObject>;
39
- });
51
+ constructor(props: ContainerRuntimeFactoryWithDefaultDataStoreProps);
40
52
  /**
41
53
  * {@inheritDoc BaseContainerRuntimeFactory.containerInitializingFirstTime}
42
54
  */
@@ -1 +1 @@
1
- {"version":3,"file":"containerRuntimeFactoryWithDefaultDataStore.d.ts","sourceRoot":"","sources":["../../src/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAoB,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAC/F,OAAO,EACN,sBAAsB,EACtB,kCAAkC,EAClC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAClF,OAAO,EAAE,2BAA2B,EAAE,MAAM,4BAA4B,CAAC;AACzE,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,WAAW,EAAY,MAAM,iCAAiC,CAAC;AAExE,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAY5E;;;;;;GAMG;AACH,qBAAa,2CAA4C,SAAQ,2BAA2B;IAC3F,gBAAuB,kBAAkB,aAAsB;IAE/D,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,sBAAsB,CAAC;IAE1D;;;;;;;;OAQG;gBACS,KAAK,EAAE;QAClB,cAAc,EAAE,sBAAsB,CAAC;QACvC,eAAe,EAAE,kCAAkC,CAAC;QACpD,mBAAmB,CAAC,EAAE,2BAA2B,CAAC;QAClD,sLAAsL;QACtL,eAAe,CAAC,EAAE,qBAAqB,EAAE,CAAC;QAC1C,cAAc,CAAC,EAAE,wBAAwB,CAAC;QAC1C,iBAAiB,CAAC,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;KACzE;IAyBD;;OAEG;cACa,8BAA8B,CAAC,OAAO,EAAE,iBAAiB;CAIzE"}
1
+ {"version":3,"file":"containerRuntimeFactoryWithDefaultDataStore.d.ts","sourceRoot":"","sources":["../../src/container-runtime-factories/containerRuntimeFactoryWithDefaultDataStore.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,KAAK,wBAAwB,EAE7B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACN,KAAK,kCAAkC,EACvC,KAAK,sBAAsB,EAC3B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AACvF,OAAO,EAAE,KAAK,WAAW,EAAiC,MAAM,iCAAiC,CAAC;AAElG,OAAO,EAAE,KAAK,2BAA2B,EAAE,MAAM,4BAA4B,CAAC;AAC9E,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAY5E;;;GAGG;AACH,MAAM,WAAW,gDAAgD;IAChE,cAAc,EAAE,sBAAsB,CAAC;IACvC;;OAEG;IACH,eAAe,EAAE,kCAAkC,CAAC;IACpD;;OAEG;IACH,mBAAmB,CAAC,EAAE,2BAA2B,CAAC;IAClD;;;OAGG;IACH,eAAe,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAC1C;;OAEG;IACH,cAAc,CAAC,EAAE,wBAAwB,CAAC;IAC1C;;;OAGG;IACH,iBAAiB,CAAC,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;CACzE;AAED;;;;;;GAMG;AACH,qBAAa,2CAA4C,SAAQ,2BAA2B;IAC3F,gBAAuB,kBAAkB,aAAsB;IAE/D,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,sBAAsB,CAAC;gBAEvC,KAAK,EAAE,gDAAgD;IA6B1E;;OAEG;cACa,8BAA8B,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;CAIzF"}