fluid-framework 2.71.0 → 2.73.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 +122 -45
- package/api-report/fluid-framework.alpha.api.md +44 -48
- package/api-report/fluid-framework.beta.api.md +42 -0
- package/api-report/fluid-framework.legacy.beta.api.md +42 -0
- package/dist/alpha.d.ts +12 -8
- package/dist/beta.d.ts +7 -0
- package/dist/index.js +2 -2
- package/dist/index.js.map +1 -1
- package/dist/legacy.d.ts +7 -0
- package/lib/alpha.d.ts +12 -8
- package/lib/beta.d.ts +7 -0
- package/lib/index.js +2 -2
- package/lib/index.js.map +1 -1
- package/lib/legacy.d.ts +7 -0
- package/package.json +15 -15
- package/src/index.ts +4 -4
package/lib/alpha.d.ts
CHANGED
|
@@ -141,10 +141,14 @@ export {
|
|
|
141
141
|
AllowedTypesFull,
|
|
142
142
|
AllowedTypesFullEvaluated,
|
|
143
143
|
AllowedTypesFullFromMixed,
|
|
144
|
+
AllowedTypesFullFromMixedUnsafe,
|
|
144
145
|
AllowedTypesMetadata,
|
|
145
146
|
AnnotateAllowedTypesList,
|
|
147
|
+
AnnotateAllowedTypesListUnsafe,
|
|
146
148
|
AnnotatedAllowedType,
|
|
149
|
+
AnnotatedAllowedTypeUnsafe,
|
|
147
150
|
AnnotatedAllowedTypes,
|
|
151
|
+
AnnotatedAllowedTypesUnsafe,
|
|
148
152
|
ConciseTree,
|
|
149
153
|
ErasedBaseType,
|
|
150
154
|
FixRecursiveArraySchema,
|
|
@@ -162,6 +166,7 @@ export {
|
|
|
162
166
|
PopUnion,
|
|
163
167
|
RecordNodeInsertableData,
|
|
164
168
|
SchemaFactoryBeta,
|
|
169
|
+
SchemaStaticsBeta,
|
|
165
170
|
SchemaUpgrade,
|
|
166
171
|
SharedTreeOptionsBeta,
|
|
167
172
|
TreeBeta,
|
|
@@ -171,7 +176,9 @@ export {
|
|
|
171
176
|
TreeRecordNode,
|
|
172
177
|
TreeRecordNodeUnsafe,
|
|
173
178
|
TreeViewBeta,
|
|
179
|
+
UnannotateAllowedTypeUnsafe,
|
|
174
180
|
UnannotateAllowedTypesList,
|
|
181
|
+
UnannotateAllowedTypesListUnsafe,
|
|
175
182
|
UnionToTuple,
|
|
176
183
|
adaptEnum,
|
|
177
184
|
asBeta,
|
|
@@ -182,11 +189,7 @@ export {
|
|
|
182
189
|
// #endregion
|
|
183
190
|
|
|
184
191
|
// #region @alpha APIs
|
|
185
|
-
AllowedTypesFullFromMixedUnsafe,
|
|
186
192
|
AllowedTypesFullUnsafe,
|
|
187
|
-
AnnotateAllowedTypesListUnsafe,
|
|
188
|
-
AnnotatedAllowedTypeUnsafe,
|
|
189
|
-
AnnotatedAllowedTypesUnsafe,
|
|
190
193
|
ArrayNodeCustomizableSchema,
|
|
191
194
|
ArrayNodeCustomizableSchemaUnsafe,
|
|
192
195
|
ArrayNodePojoEmulationSchema,
|
|
@@ -246,9 +249,7 @@ export {
|
|
|
246
249
|
RevertibleAlphaFactory,
|
|
247
250
|
RunTransactionParams,
|
|
248
251
|
SchemaFactoryAlpha,
|
|
249
|
-
SchemaStaticsAlpha,
|
|
250
252
|
SharedTreeFormatOptions,
|
|
251
|
-
SharedTreeFormatVersion,
|
|
252
253
|
SharedTreeOptions,
|
|
253
254
|
SimpleAllowedTypeAttributes,
|
|
254
255
|
SimpleArrayNodeSchema,
|
|
@@ -283,8 +284,6 @@ export {
|
|
|
283
284
|
TreeSchemaEncodingOptions,
|
|
284
285
|
TreeViewAlpha,
|
|
285
286
|
TreeViewConfigurationAlpha,
|
|
286
|
-
UnannotateAllowedTypeUnsafe,
|
|
287
|
-
UnannotateAllowedTypesListUnsafe,
|
|
288
287
|
UnsafeUnknownSchema,
|
|
289
288
|
ValueSchema,
|
|
290
289
|
VerboseTree,
|
|
@@ -294,6 +293,7 @@ export {
|
|
|
294
293
|
allowUnused,
|
|
295
294
|
asAlpha,
|
|
296
295
|
asTreeViewAlpha,
|
|
296
|
+
checkCompatibility,
|
|
297
297
|
cloneWithReplacements,
|
|
298
298
|
comparePersistedSchema,
|
|
299
299
|
configuredSharedTree,
|
|
@@ -301,12 +301,16 @@ export {
|
|
|
301
301
|
createIdentifierIndex,
|
|
302
302
|
createIndependentTreeAlpha,
|
|
303
303
|
createSimpleTreeIndex,
|
|
304
|
+
decodeSimpleSchema,
|
|
305
|
+
encodeSimpleSchema,
|
|
304
306
|
evaluateLazySchema,
|
|
307
|
+
exportCompatibilitySchemaSnapshot,
|
|
305
308
|
extractPersistedSchema,
|
|
306
309
|
generateSchemaFromSimpleSchema,
|
|
307
310
|
getBranch,
|
|
308
311
|
getJsonSchema,
|
|
309
312
|
getSimpleSchema,
|
|
313
|
+
importCompatibilitySchemaSnapshot,
|
|
310
314
|
independentInitializedView,
|
|
311
315
|
independentView,
|
|
312
316
|
normalizeAllowedTypes,
|
package/lib/beta.d.ts
CHANGED
|
@@ -141,10 +141,14 @@ export {
|
|
|
141
141
|
AllowedTypesFull,
|
|
142
142
|
AllowedTypesFullEvaluated,
|
|
143
143
|
AllowedTypesFullFromMixed,
|
|
144
|
+
AllowedTypesFullFromMixedUnsafe,
|
|
144
145
|
AllowedTypesMetadata,
|
|
145
146
|
AnnotateAllowedTypesList,
|
|
147
|
+
AnnotateAllowedTypesListUnsafe,
|
|
146
148
|
AnnotatedAllowedType,
|
|
149
|
+
AnnotatedAllowedTypeUnsafe,
|
|
147
150
|
AnnotatedAllowedTypes,
|
|
151
|
+
AnnotatedAllowedTypesUnsafe,
|
|
148
152
|
ConciseTree,
|
|
149
153
|
ErasedBaseType,
|
|
150
154
|
FixRecursiveArraySchema,
|
|
@@ -162,6 +166,7 @@ export {
|
|
|
162
166
|
PopUnion,
|
|
163
167
|
RecordNodeInsertableData,
|
|
164
168
|
SchemaFactoryBeta,
|
|
169
|
+
SchemaStaticsBeta,
|
|
165
170
|
SchemaUpgrade,
|
|
166
171
|
SharedTreeOptionsBeta,
|
|
167
172
|
TreeBeta,
|
|
@@ -171,7 +176,9 @@ export {
|
|
|
171
176
|
TreeRecordNode,
|
|
172
177
|
TreeRecordNodeUnsafe,
|
|
173
178
|
TreeViewBeta,
|
|
179
|
+
UnannotateAllowedTypeUnsafe,
|
|
174
180
|
UnannotateAllowedTypesList,
|
|
181
|
+
UnannotateAllowedTypesListUnsafe,
|
|
175
182
|
UnionToTuple,
|
|
176
183
|
adaptEnum,
|
|
177
184
|
asBeta,
|
package/lib/index.js
CHANGED
|
@@ -10,8 +10,8 @@ export { onAssertionFailure } from "@fluidframework/core-utils/internal";
|
|
|
10
10
|
// Note: this only surfaces the `@public, @beta and @alpha` API items from the tree package.
|
|
11
11
|
/* eslint-disable-next-line
|
|
12
12
|
no-restricted-syntax,
|
|
13
|
-
import/no-internal-modules,
|
|
14
|
-
import/export -- This re-exports all non-conflicting APIs from `@fluidframework/tree`. In cases where * exports conflict with named exports, the named exports take precedence per https://tc39.es/ecma262/multipage/ecmascript-language-scripts-and-modules.html#sec-getexportednames. This does trigger the `import/export` lint warning (which is intentionally disabled here). This approach ensures that the non-deprecated versions of the event APIs from `@fluidframework/core-interfaces` (provided as named indirect exports) eclipse the deprecated ones from `@fluidframework/tree`. The preferred versions of the event APIs are those exported via `@fluidframework/core-interfaces`.
|
|
13
|
+
import-x/no-internal-modules,
|
|
14
|
+
import-x/export -- This re-exports all non-conflicting APIs from `@fluidframework/tree`. In cases where * exports conflict with named exports, the named exports take precedence per https://tc39.es/ecma262/multipage/ecmascript-language-scripts-and-modules.html#sec-getexportednames. This does trigger the `import-x/export` lint warning (which is intentionally disabled here). This approach ensures that the non-deprecated versions of the event APIs from `@fluidframework/core-interfaces` (provided as named indirect exports) eclipse the deprecated ones from `@fluidframework/tree`. The preferred versions of the event APIs are those exported via `@fluidframework/core-interfaces`.
|
|
15
15
|
*/
|
|
16
16
|
export * from "@fluidframework/tree/alpha";
|
|
17
17
|
import { SharedTree as OriginalSharedTree, configuredSharedTree as originalConfiguredSharedTree, } from "@fluidframework/tree/internal";
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAiBH,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AA4CnE,4GAA4G;AAC5G,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAIzE,mDAAmD;AACnD,4FAA4F;AAC5F;;;;MAIG;AACH,cAAc,4BAA4B,CAAC;AAU3C,OAAO,EACN,UAAU,IAAI,kBAAkB,EAChC,oBAAoB,IAAI,4BAA4B,GAEpD,MAAM,+BAA+B,CAAC;AAEvC;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,UAAU,GAA4B,kBAAkB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAA0B;IAC9D,OAAO,4BAA4B,CAAC,OAAO,CAAC,CAAC;AAC9C,CAAC;AAmBD,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AA4B1E,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAajE,4BAA4B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Bundles a collection of Fluid Framework client libraries for easy use when paired with a corresponding service client\n * package (e.g. `@fluidframework/azure-client`, `@fluidframework/tinylicious-client`, or `@fluidframework/odsp-client (BETA)`).\n *\n * @packageDocumentation\n */\n\n// ===============================================================\n// #region Public, Beta and Alpha (non-legacy) exports\n// #region Basic re-exports\n\nexport type {\n\tConnectionState as ConnectionStateType, // TODO: deduplicate ConnectionState types\n\tICriticalContainerError,\n} from \"@fluidframework/container-definitions\";\nexport { AttachState } from \"@fluidframework/container-definitions\";\nexport { ConnectionState } from \"@fluidframework/container-loader\";\nexport type {\n\tContainerAttachProps,\n\tContainerSchema,\n\tIConnection,\n\tIFluidContainer,\n\tIFluidContainerEvents,\n\tIMember,\n\tInitialObjects,\n\tIServiceAudience,\n\tIServiceAudienceEvents,\n\tMemberChangedListener,\n\tMyself,\n} from \"@fluidframework/fluid-static\";\nexport type { SharedObjectKind } from \"@fluidframework/shared-object-base\";\nexport type {\n\tIErrorBase,\n\tIEventProvider,\n\tIDisposable,\n\tIEvent,\n\tIEventThisPlaceHolder,\n\tIErrorEvent,\n\tErasedType,\n\tIFluidHandle,\n\tIFluidLoadable,\n\tITelemetryBaseProperties,\n\tIEventTransformer,\n\tIProvideFluidLoadable,\n\tIFluidHandleErased,\n\tTransformedEvent,\n\tTelemetryBaseEventPropertyType,\n\tTagged,\n\tReplaceIEventThisPlaceHolder,\n\tFluidObject, // Linked in doc comment\n\tFluidObjectProviderKeys, // Used by FluidObject\n\t/* eslint-disable import/export -- The event APIs are known to conflict, and this is intended as the exports via `@fluidframework/core-interfaces` are preferred over the deprecated ones from `@fluidframework/tree`. */\n\tListeners,\n\tIsListener,\n\tListenable,\n\tOff,\n\t/* eslint-enable import/export */\n} from \"@fluidframework/core-interfaces\";\nexport type { ErasedBaseType } from \"@fluidframework/core-interfaces/internal\";\n\n// This is an alpha API, but this package doesn't have an alpha entry point so its imported from \"internal\".\nexport { onAssertionFailure } from \"@fluidframework/core-utils/internal\";\n\nexport type { isFluidHandle } from \"@fluidframework/runtime-utils\";\n\n// Let the tree package manage its own API surface.\n// Note: this only surfaces the `@public, @beta and @alpha` API items from the tree package.\n/* eslint-disable-next-line\n\tno-restricted-syntax,\n\timport/no-internal-modules,\n\timport/export -- This re-exports all non-conflicting APIs from `@fluidframework/tree`. In cases where * exports conflict with named exports, the named exports take precedence per https://tc39.es/ecma262/multipage/ecmascript-language-scripts-and-modules.html#sec-getexportednames. This does trigger the `import/export` lint warning (which is intentionally disabled here). This approach ensures that the non-deprecated versions of the event APIs from `@fluidframework/core-interfaces` (provided as named indirect exports) eclipse the deprecated ones from `@fluidframework/tree`. The preferred versions of the event APIs are those exported via `@fluidframework/core-interfaces`.\n\t*/\nexport * from \"@fluidframework/tree/alpha\";\n\n// End of basic public+beta+alpha exports - nothing above this line should\n// depend on an /internal path.\n// #endregion Basic re-exports\n// ---------------------------------------------------------------\n// #region Custom re-exports\n\nimport type { SharedObjectKind } from \"@fluidframework/shared-object-base\";\nimport type { ITree } from \"@fluidframework/tree\";\nimport {\n\tSharedTree as OriginalSharedTree,\n\tconfiguredSharedTree as originalConfiguredSharedTree,\n\ttype SharedTreeOptions,\n} from \"@fluidframework/tree/internal\";\n\n/**\n * A hierarchical data structure for collaboratively editing strongly typed JSON-like trees\n * of objects, arrays, and other data types.\n * @privateRemarks\n * Here we reexport SharedTree, but with the `@alpha` types (`ISharedObjectKind`) removed, just keeping the `SharedObjectKind`.\n * Doing this requires creating this new typed export rather than relying on a reexport directly from the tree package.\n * The tree package itself does not do this because it's API needs to be usable from the encapsulated API which requires `ISharedObjectKind`.\n * This package however is not intended for use by users of the encapsulated API, and therefor it can discard that interface.\n * @public\n */\nexport const SharedTree: SharedObjectKind<ITree> = OriginalSharedTree;\n\n/**\n * {@link SharedTree} but allowing a non-default configuration.\n * @remarks\n * This is useful for debugging and testing.\n * For example, it can be used to opt into extra validation or see if opting out of some optimizations fixes an issue.\n *\n * With great care, and knowledge of the support and stability of the options exposed here,\n * this can also be used to opt into some features early or for performance tuning.\n *\n * @example\n * ```typescript\n * import {\n * \tTreeCompressionStrategy,\n * \tconfiguredSharedTree,\n * \tFormatValidatorBasic,\n * \tForestTypeReference,\n * } from \"fluid-framework/alpha\";\n * const SharedTree = configuredSharedTree({\n * \tforest: ForestTypeReference,\n * \tjsonValidator: FormatValidatorBasic,\n * \ttreeEncodeType: TreeCompressionStrategy.Uncompressed,\n * });\n * ```\n * @alpha\n */\nexport function configuredSharedTree(options: SharedTreeOptions): SharedObjectKind<ITree> {\n\treturn originalConfiguredSharedTree(options);\n}\n\n// #endregion Custom re-exports\n// #endregion\n\n// ===============================================================\n// #region Legacy exports\n\nexport type {\n\tIDirectory,\n\tIDirectoryEvents,\n\tIDirectoryValueChanged,\n\tISharedDirectory,\n\tISharedDirectoryEvents,\n\tISharedMap,\n\tISharedMapEvents,\n\tIValueChanged,\n} from \"@fluidframework/map/internal\";\n\nexport { SharedDirectory, SharedMap } from \"@fluidframework/map/internal\";\n\nexport type {\n\tDeserializeCallback,\n\tInteriorSequencePlace,\n\tIInterval,\n\tIntervalStickiness,\n\tISequenceDeltaRange,\n\tISerializedInterval,\n\tISharedSegmentSequenceEvents,\n\tISharedString,\n\tSequencePlace,\n\tSharedStringSegment,\n\tSide,\n\tISharedSegmentSequence,\n\tISequenceIntervalCollection,\n\tISequenceIntervalCollectionEvents,\n\tSequenceIntervalIndex,\n} from \"@fluidframework/sequence/internal\";\n\nexport type {\n\tIntervalType,\n\tSequenceDeltaEvent,\n\tSequenceEvent,\n\tSequenceInterval,\n\tSequenceMaintenanceEvent,\n} from \"@fluidframework/sequence/internal\";\n\nexport { SharedString } from \"@fluidframework/sequence/internal\";\n\nexport type {\n\tISharedObject,\n\tISharedObjectEvents,\n} from \"@fluidframework/shared-object-base/internal\";\n\nexport type {\n\tISequencedDocumentMessage, // Leaked via ISharedObjectEvents\n\tIBranchOrigin, // Required for ISequencedDocumentMessage\n\tITrace, // Required for ISequencedDocumentMessage\n} from \"@fluidframework/driver-definitions/internal\";\n\n// #endregion Legacy exports\n"]}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAiBH,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AA4CnE,4GAA4G;AAC5G,OAAO,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAIzE,mDAAmD;AACnD,4FAA4F;AAC5F;;;;MAIG;AACH,cAAc,4BAA4B,CAAC;AAU3C,OAAO,EACN,UAAU,IAAI,kBAAkB,EAChC,oBAAoB,IAAI,4BAA4B,GAEpD,MAAM,+BAA+B,CAAC;AAEvC;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,UAAU,GAA4B,kBAAkB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAA0B;IAC9D,OAAO,4BAA4B,CAAC,OAAO,CAAC,CAAC;AAC9C,CAAC;AAmBD,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AA4B1E,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAajE,4BAA4B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Bundles a collection of Fluid Framework client libraries for easy use when paired with a corresponding service client\n * package (e.g. `@fluidframework/azure-client`, `@fluidframework/tinylicious-client`, or `@fluidframework/odsp-client (BETA)`).\n *\n * @packageDocumentation\n */\n\n// ===============================================================\n// #region Public, Beta and Alpha (non-legacy) exports\n// #region Basic re-exports\n\nexport type {\n\tConnectionState as ConnectionStateType, // TODO: deduplicate ConnectionState types\n\tICriticalContainerError,\n} from \"@fluidframework/container-definitions\";\nexport { AttachState } from \"@fluidframework/container-definitions\";\nexport { ConnectionState } from \"@fluidframework/container-loader\";\nexport type {\n\tContainerAttachProps,\n\tContainerSchema,\n\tIConnection,\n\tIFluidContainer,\n\tIFluidContainerEvents,\n\tIMember,\n\tInitialObjects,\n\tIServiceAudience,\n\tIServiceAudienceEvents,\n\tMemberChangedListener,\n\tMyself,\n} from \"@fluidframework/fluid-static\";\nexport type { SharedObjectKind } from \"@fluidframework/shared-object-base\";\nexport type {\n\tIErrorBase,\n\tIEventProvider,\n\tIDisposable,\n\tIEvent,\n\tIEventThisPlaceHolder,\n\tIErrorEvent,\n\tErasedType,\n\tIFluidHandle,\n\tIFluidLoadable,\n\tITelemetryBaseProperties,\n\tIEventTransformer,\n\tIProvideFluidLoadable,\n\tIFluidHandleErased,\n\tTransformedEvent,\n\tTelemetryBaseEventPropertyType,\n\tTagged,\n\tReplaceIEventThisPlaceHolder,\n\tFluidObject, // Linked in doc comment\n\tFluidObjectProviderKeys, // Used by FluidObject\n\t/* eslint-disable import-x/export -- The event APIs are known to conflict, and this is intended as the exports via `@fluidframework/core-interfaces` are preferred over the deprecated ones from `@fluidframework/tree`. */\n\tListeners,\n\tIsListener,\n\tListenable,\n\tOff,\n\t/* eslint-enable import-x/export */\n} from \"@fluidframework/core-interfaces\";\nexport type { ErasedBaseType } from \"@fluidframework/core-interfaces/internal\";\n\n// This is an alpha API, but this package doesn't have an alpha entry point so its imported from \"internal\".\nexport { onAssertionFailure } from \"@fluidframework/core-utils/internal\";\n\nexport type { isFluidHandle } from \"@fluidframework/runtime-utils\";\n\n// Let the tree package manage its own API surface.\n// Note: this only surfaces the `@public, @beta and @alpha` API items from the tree package.\n/* eslint-disable-next-line\n\tno-restricted-syntax,\n\timport-x/no-internal-modules,\n\timport-x/export -- This re-exports all non-conflicting APIs from `@fluidframework/tree`. In cases where * exports conflict with named exports, the named exports take precedence per https://tc39.es/ecma262/multipage/ecmascript-language-scripts-and-modules.html#sec-getexportednames. This does trigger the `import-x/export` lint warning (which is intentionally disabled here). This approach ensures that the non-deprecated versions of the event APIs from `@fluidframework/core-interfaces` (provided as named indirect exports) eclipse the deprecated ones from `@fluidframework/tree`. The preferred versions of the event APIs are those exported via `@fluidframework/core-interfaces`.\n\t*/\nexport * from \"@fluidframework/tree/alpha\";\n\n// End of basic public+beta+alpha exports - nothing above this line should\n// depend on an /internal path.\n// #endregion Basic re-exports\n// ---------------------------------------------------------------\n// #region Custom re-exports\n\nimport type { SharedObjectKind } from \"@fluidframework/shared-object-base\";\nimport type { ITree } from \"@fluidframework/tree\";\nimport {\n\tSharedTree as OriginalSharedTree,\n\tconfiguredSharedTree as originalConfiguredSharedTree,\n\ttype SharedTreeOptions,\n} from \"@fluidframework/tree/internal\";\n\n/**\n * A hierarchical data structure for collaboratively editing strongly typed JSON-like trees\n * of objects, arrays, and other data types.\n * @privateRemarks\n * Here we reexport SharedTree, but with the `@alpha` types (`ISharedObjectKind`) removed, just keeping the `SharedObjectKind`.\n * Doing this requires creating this new typed export rather than relying on a reexport directly from the tree package.\n * The tree package itself does not do this because it's API needs to be usable from the encapsulated API which requires `ISharedObjectKind`.\n * This package however is not intended for use by users of the encapsulated API, and therefor it can discard that interface.\n * @public\n */\nexport const SharedTree: SharedObjectKind<ITree> = OriginalSharedTree;\n\n/**\n * {@link SharedTree} but allowing a non-default configuration.\n * @remarks\n * This is useful for debugging and testing.\n * For example, it can be used to opt into extra validation or see if opting out of some optimizations fixes an issue.\n *\n * With great care, and knowledge of the support and stability of the options exposed here,\n * this can also be used to opt into some features early or for performance tuning.\n *\n * @example\n * ```typescript\n * import {\n * \tTreeCompressionStrategy,\n * \tconfiguredSharedTree,\n * \tFormatValidatorBasic,\n * \tForestTypeReference,\n * } from \"fluid-framework/alpha\";\n * const SharedTree = configuredSharedTree({\n * \tforest: ForestTypeReference,\n * \tjsonValidator: FormatValidatorBasic,\n * \ttreeEncodeType: TreeCompressionStrategy.Uncompressed,\n * });\n * ```\n * @alpha\n */\nexport function configuredSharedTree(options: SharedTreeOptions): SharedObjectKind<ITree> {\n\treturn originalConfiguredSharedTree(options);\n}\n\n// #endregion Custom re-exports\n// #endregion\n\n// ===============================================================\n// #region Legacy exports\n\nexport type {\n\tIDirectory,\n\tIDirectoryEvents,\n\tIDirectoryValueChanged,\n\tISharedDirectory,\n\tISharedDirectoryEvents,\n\tISharedMap,\n\tISharedMapEvents,\n\tIValueChanged,\n} from \"@fluidframework/map/internal\";\n\nexport { SharedDirectory, SharedMap } from \"@fluidframework/map/internal\";\n\nexport type {\n\tDeserializeCallback,\n\tInteriorSequencePlace,\n\tIInterval,\n\tIntervalStickiness,\n\tISequenceDeltaRange,\n\tISerializedInterval,\n\tISharedSegmentSequenceEvents,\n\tISharedString,\n\tSequencePlace,\n\tSharedStringSegment,\n\tSide,\n\tISharedSegmentSequence,\n\tISequenceIntervalCollection,\n\tISequenceIntervalCollectionEvents,\n\tSequenceIntervalIndex,\n} from \"@fluidframework/sequence/internal\";\n\nexport type {\n\tIntervalType,\n\tSequenceDeltaEvent,\n\tSequenceEvent,\n\tSequenceInterval,\n\tSequenceMaintenanceEvent,\n} from \"@fluidframework/sequence/internal\";\n\nexport { SharedString } from \"@fluidframework/sequence/internal\";\n\nexport type {\n\tISharedObject,\n\tISharedObjectEvents,\n} from \"@fluidframework/shared-object-base/internal\";\n\nexport type {\n\tISequencedDocumentMessage, // Leaked via ISharedObjectEvents\n\tIBranchOrigin, // Required for ISequencedDocumentMessage\n\tITrace, // Required for ISequencedDocumentMessage\n} from \"@fluidframework/driver-definitions/internal\";\n\n// #endregion Legacy exports\n"]}
|
package/lib/legacy.d.ts
CHANGED
|
@@ -148,10 +148,14 @@ export {
|
|
|
148
148
|
AllowedTypesFull,
|
|
149
149
|
AllowedTypesFullEvaluated,
|
|
150
150
|
AllowedTypesFullFromMixed,
|
|
151
|
+
AllowedTypesFullFromMixedUnsafe,
|
|
151
152
|
AllowedTypesMetadata,
|
|
152
153
|
AnnotateAllowedTypesList,
|
|
154
|
+
AnnotateAllowedTypesListUnsafe,
|
|
153
155
|
AnnotatedAllowedType,
|
|
156
|
+
AnnotatedAllowedTypeUnsafe,
|
|
154
157
|
AnnotatedAllowedTypes,
|
|
158
|
+
AnnotatedAllowedTypesUnsafe,
|
|
155
159
|
ConciseTree,
|
|
156
160
|
ErasedBaseType,
|
|
157
161
|
FixRecursiveArraySchema,
|
|
@@ -169,6 +173,7 @@ export {
|
|
|
169
173
|
PopUnion,
|
|
170
174
|
RecordNodeInsertableData,
|
|
171
175
|
SchemaFactoryBeta,
|
|
176
|
+
SchemaStaticsBeta,
|
|
172
177
|
SchemaUpgrade,
|
|
173
178
|
SharedTreeOptionsBeta,
|
|
174
179
|
TreeBeta,
|
|
@@ -178,7 +183,9 @@ export {
|
|
|
178
183
|
TreeRecordNode,
|
|
179
184
|
TreeRecordNodeUnsafe,
|
|
180
185
|
TreeViewBeta,
|
|
186
|
+
UnannotateAllowedTypeUnsafe,
|
|
181
187
|
UnannotateAllowedTypesList,
|
|
188
|
+
UnannotateAllowedTypesListUnsafe,
|
|
182
189
|
UnionToTuple,
|
|
183
190
|
adaptEnum,
|
|
184
191
|
asBeta,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "fluid-framework",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.73.0",
|
|
4
4
|
"description": "The main entry point into Fluid Framework public packages",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -57,25 +57,25 @@
|
|
|
57
57
|
"main": "lib/index.js",
|
|
58
58
|
"types": "lib/public.d.ts",
|
|
59
59
|
"dependencies": {
|
|
60
|
-
"@fluidframework/container-definitions": "~2.
|
|
61
|
-
"@fluidframework/container-loader": "~2.
|
|
62
|
-
"@fluidframework/core-interfaces": "~2.
|
|
63
|
-
"@fluidframework/core-utils": "~2.
|
|
64
|
-
"@fluidframework/driver-definitions": "~2.
|
|
65
|
-
"@fluidframework/fluid-static": "~2.
|
|
66
|
-
"@fluidframework/map": "~2.
|
|
67
|
-
"@fluidframework/runtime-utils": "~2.
|
|
68
|
-
"@fluidframework/sequence": "~2.
|
|
69
|
-
"@fluidframework/shared-object-base": "~2.
|
|
70
|
-
"@fluidframework/tree": "~2.
|
|
60
|
+
"@fluidframework/container-definitions": "~2.73.0",
|
|
61
|
+
"@fluidframework/container-loader": "~2.73.0",
|
|
62
|
+
"@fluidframework/core-interfaces": "~2.73.0",
|
|
63
|
+
"@fluidframework/core-utils": "~2.73.0",
|
|
64
|
+
"@fluidframework/driver-definitions": "~2.73.0",
|
|
65
|
+
"@fluidframework/fluid-static": "~2.73.0",
|
|
66
|
+
"@fluidframework/map": "~2.73.0",
|
|
67
|
+
"@fluidframework/runtime-utils": "~2.73.0",
|
|
68
|
+
"@fluidframework/sequence": "~2.73.0",
|
|
69
|
+
"@fluidframework/shared-object-base": "~2.73.0",
|
|
70
|
+
"@fluidframework/tree": "~2.73.0"
|
|
71
71
|
},
|
|
72
72
|
"devDependencies": {
|
|
73
73
|
"@arethetypeswrong/cli": "^0.17.1",
|
|
74
74
|
"@biomejs/biome": "~1.9.3",
|
|
75
|
-
"@fluid-tools/build-cli": "^0.
|
|
75
|
+
"@fluid-tools/build-cli": "^0.60.0",
|
|
76
76
|
"@fluidframework/build-common": "^2.0.3",
|
|
77
|
-
"@fluidframework/build-tools": "^0.
|
|
78
|
-
"@fluidframework/eslint-config-fluid": "
|
|
77
|
+
"@fluidframework/build-tools": "^0.60.0",
|
|
78
|
+
"@fluidframework/eslint-config-fluid": "~2.73.0",
|
|
79
79
|
"@microsoft/api-extractor": "7.52.11",
|
|
80
80
|
"@types/node": "^18.19.0",
|
|
81
81
|
"concurrently": "^8.2.1",
|
package/src/index.ts
CHANGED
|
@@ -54,12 +54,12 @@ export type {
|
|
|
54
54
|
ReplaceIEventThisPlaceHolder,
|
|
55
55
|
FluidObject, // Linked in doc comment
|
|
56
56
|
FluidObjectProviderKeys, // Used by FluidObject
|
|
57
|
-
/* eslint-disable import/export -- The event APIs are known to conflict, and this is intended as the exports via `@fluidframework/core-interfaces` are preferred over the deprecated ones from `@fluidframework/tree`. */
|
|
57
|
+
/* eslint-disable import-x/export -- The event APIs are known to conflict, and this is intended as the exports via `@fluidframework/core-interfaces` are preferred over the deprecated ones from `@fluidframework/tree`. */
|
|
58
58
|
Listeners,
|
|
59
59
|
IsListener,
|
|
60
60
|
Listenable,
|
|
61
61
|
Off,
|
|
62
|
-
/* eslint-enable import/export */
|
|
62
|
+
/* eslint-enable import-x/export */
|
|
63
63
|
} from "@fluidframework/core-interfaces";
|
|
64
64
|
export type { ErasedBaseType } from "@fluidframework/core-interfaces/internal";
|
|
65
65
|
|
|
@@ -72,8 +72,8 @@ export type { isFluidHandle } from "@fluidframework/runtime-utils";
|
|
|
72
72
|
// Note: this only surfaces the `@public, @beta and @alpha` API items from the tree package.
|
|
73
73
|
/* eslint-disable-next-line
|
|
74
74
|
no-restricted-syntax,
|
|
75
|
-
import/no-internal-modules,
|
|
76
|
-
import/export -- This re-exports all non-conflicting APIs from `@fluidframework/tree`. In cases where * exports conflict with named exports, the named exports take precedence per https://tc39.es/ecma262/multipage/ecmascript-language-scripts-and-modules.html#sec-getexportednames. This does trigger the `import/export` lint warning (which is intentionally disabled here). This approach ensures that the non-deprecated versions of the event APIs from `@fluidframework/core-interfaces` (provided as named indirect exports) eclipse the deprecated ones from `@fluidframework/tree`. The preferred versions of the event APIs are those exported via `@fluidframework/core-interfaces`.
|
|
75
|
+
import-x/no-internal-modules,
|
|
76
|
+
import-x/export -- This re-exports all non-conflicting APIs from `@fluidframework/tree`. In cases where * exports conflict with named exports, the named exports take precedence per https://tc39.es/ecma262/multipage/ecmascript-language-scripts-and-modules.html#sec-getexportednames. This does trigger the `import-x/export` lint warning (which is intentionally disabled here). This approach ensures that the non-deprecated versions of the event APIs from `@fluidframework/core-interfaces` (provided as named indirect exports) eclipse the deprecated ones from `@fluidframework/tree`. The preferred versions of the event APIs are those exported via `@fluidframework/core-interfaces`.
|
|
77
77
|
*/
|
|
78
78
|
export * from "@fluidframework/tree/alpha";
|
|
79
79
|
|