Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

fluid-framework

Package Overview
Dependencies
Maintainers
3
Versions
438
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

fluid-framework - npm Package Compare versions

Comparing version 2.0.0-rc.4.0.6 to 2.0.0-rc.5.0.0

api-extractor/api-extractor-lint-bundle.json

2

api-extractor.json
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"extends": "../../../common/build/build-common/api-extractor-base.esm.primary.json",
"extends": "../../../common/build/build-common/api-extractor-base.esm.current.json",
"bundledPackages": ["@fluidframework/*"],

@@ -5,0 +5,0 @@ "messages": {

# fluid-framework
## 2.0.0-rc.5.0.0
### Minor Changes
- fluid-framework: Type Erase ISharedObjectKind ([#21081](https://github.com/microsoft/FluidFramework/pull/21081)) [78f228e370](https://github.com/microsoft/FluidFramework/commit/78f228e37055bd4d9a8f02b3a1eefebf4da9c59c)
A new type, `SharedObjectKind` is added as a type erased version of `ISharedObjectKind` and `DataObjectClass`.
This type fills the role of both `ISharedObjectKind` and `DataObjectClass` in the `@public` "declarative API" exposed in the `fluid-framework` package.
This allows several types referenced by `ISharedObjectKind` to be made `@alpha` as they should only need to be used by legacy code and users of the unstable/alpha/legacy "encapsulated API".
Access to these now less public types should not be required for users of the `@public` "declarative API" exposed in the `fluid-framework` package, but can still be accessed for those who need them under the `/legacy` import paths.
The full list of such types is:
- `SharedTree` as exported from `@fluidframwork/tree`: It is still exported as `@public` from `fluid-framework` as `SharedObjectKind`.
- `ISharedObjectKind`: See new `SharedObjectKind` type for use in `@public` APIs.
`ISharedObject`
- `IChannel`
- `IChannelAttributes`
- `IChannelFactory`
- `IExperimentalIncrementalSummaryContext`
- `IGarbageCollectionData`
- `ISummaryStats`
- `ISummaryTreeWithStats`
- `ITelemetryContext`
- `IDeltaManagerErased`
- `IFluidDataStoreRuntimeEvents`
- `IFluidHandleContext`
- `IProvideFluidHandleContext`
Removed APIs:
- `DataObjectClass`: Usages replaced with `SharedObjectKind`.
- `LoadableObjectClass`: Replaced with `SharedObjectKind`.
- `LoadableObjectClassRecord`: Replaced with `Record<string, SharedObjectKind>`.
-
- tree: Added support for optional schema validation on newly inserted content in SharedTree ([#21011](https://github.com/microsoft/FluidFramework/pull/21011)) [b14e9fa607](https://github.com/microsoft/FluidFramework/commit/b14e9fa607a8281f86d0cfac631e33ef12033e21)
When defining how to view a SharedTree, an application can now specify that new content inserted into the tree should
be subject to schema validation at the time it is inserted, so if it's not valid according to the stored schema in the
tree an error is thrown immediately.
This can be accomplished by passing an `ITreeConfigurationOptions` argument with `enableSchemaValidation` set to `true`
when creating a `TreeConfiguration` to use with the SharedTree.
Since this feature requires additional compute when inserting new content into the tree, it is not enabled by default.
- Update to TypeScript 5.4 ([#21214](https://github.com/microsoft/FluidFramework/pull/21214)) [0e6256c722](https://github.com/microsoft/FluidFramework/commit/0e6256c722d8bf024f4325bf02547daeeb18bfa6)
Update package implementations to use TypeScript 5.4.5.
- fluid-framework: Remove some types from `@public` that are not needed ([#21326](https://github.com/microsoft/FluidFramework/pull/21326)) [b629cb80b0](https://github.com/microsoft/FluidFramework/commit/b629cb80b0e5ecdc750270807f77a0e30fab4559)
Mark the following APIs `@alpha` instead of `@public`:
- IBranchOrigin
- ISequencedDocumentMessage
- ISignalMessage
- ISignalMessageBase
- ITrace
- tree: A new tree status has been added for SharedTree nodes. ([#21270](https://github.com/microsoft/FluidFramework/pull/21270)) [8760e321b0](https://github.com/microsoft/FluidFramework/commit/8760e321b02177babfb187ae293a17a65723f249)
`TreeStatus.Created` indicates that a SharedTree node has been constructed but not yet inserted into the tree.
Constraints passed to the `runTransaction` API are now marked as `readonly`.
- fluid-framework: Remove several types from `@public` scope ([#21142](https://github.com/microsoft/FluidFramework/pull/21142)) [983e9f09f7](https://github.com/microsoft/FluidFramework/commit/983e9f09f7b10fef9ffa1e9af86166f0ccda7e14)
The following types have been moved from `@public` to `@alpha`:
- `IFluidSerializer`
- `ISharedObjectEvents`
- `IChannelServices`
- `IChannelStorageService`
- `IDeltaConnection`
- `IDeltaHandler`
These should not be needed by users of the declarative API, which is what `@public` is targeting.
- sequence: Stop ISharedString extending SharedObject ([#21067](https://github.com/microsoft/FluidFramework/pull/21067)) [47465f4b12](https://github.com/microsoft/FluidFramework/commit/47465f4b12056810112df30a6dad89282afc7a2d)
ISharedString no longer extends SharedSegmentSequence and instead extends the new ISharedSegmentSequence, which may be missing some APIs.
Attempt to migrate off the missing APIs, but if that is not practical, request they be added to ISharedSegmentSequence and cast to SharedSegmentSequence as a workaround temporally.
- Update to ES 2022 ([#21292](https://github.com/microsoft/FluidFramework/pull/21292)) [68921502f7](https://github.com/microsoft/FluidFramework/commit/68921502f79b1833c4cd6d0fe339bfb126a712c7)
Update tsconfig to target ES 2022.
- tree: Move several types into InternalTypes ([#21482](https://github.com/microsoft/FluidFramework/pull/21482)) [64d49dd362](https://github.com/microsoft/FluidFramework/commit/64d49dd3629cefe6260a1d6223e58b10c2ac0cb6)
The stable public API surface for Tree has been reduced.
Several types have been moved into InternalTypes, indicating that they are not fully stable nor intended to be referenced by users of Tree.
- NodeBuilderData
- FieldHasDefault
- TreeNodeSchemaNonClass
- TreeArrayNodeBase
- ScopedSchemaName
- DefaultProvider
- typeNameSymbol
- InsertableObjectFromSchemaRecord
- ObjectFromSchemaRecord
- FieldHasDefaultUnsafe
- ObjectFromSchemaRecordUnsafe
- TreeObjectNodeUnsafe
- TreeFieldFromImplicitFieldUnsafe
- TreeNodeFromImplicitAllowedTypesUnsafe
- InsertableTreeNodeFromImplicitAllowedTypesUnsafe
- TreeArrayNodeUnsafe
- TreeMapNodeUnsafe
- InsertableObjectFromSchemaRecordUnsafe
- InsertableTreeFieldFromImplicitFieldUnsafe
- InsertableTypedNodeUnsafe
- NodeBuilderDataUnsafe
- NodeFromSchemaUnsafe
- FlexList
- TreeApi
Additionally a few more types which could not be moved due to technically limitations have been documented that they should be treated similarly.
- TreeNodeApi
- TreeNodeSchemaCore
- All \*Unsafe type (use for construction of recursive schema).
- WithType
- AllowedTypes
- FieldSchemaUnsafe
Also to reduce confusion `type` was renamed to `typeNameSymbol`, and is now only type exported. `Tree.is` should be used to get type information from `TreeNodes` instead.
- tree: object node fields with statically known default values are now optional ([#21193](https://github.com/microsoft/FluidFramework/pull/21193)) [21eac41660](https://github.com/microsoft/FluidFramework/commit/21eac41660944208bad42b156d7df05fe6dc6b97)
Makes object node fields with statically known default values (i.e., `optional` and `identifier` fields) optional when creating trees, where they were previously required.
Example:
```typescript
class Foo extends schemaFactory.object("Foo", {
name: schemaFactory.string,
id: schemaFactory.identifier,
nickname: schemaFactory.optional(schemaFactory.string),
}) {}
// Before
const foo = new Foo({
name: "Bar",
id: undefined, // Had to explicitly specify `undefined` to opt into default behavior
nickname: undefined, // Had to explicitly specify `undefined` for optional field
});
// After
const foo = new Foo({
name: "Bar",
// Can omit `id` and `nickname` fields, as both have statically known defaults!
});
```
- tree: Breaking change: `TreeStatus.Created` is now `TreeStatus.New` ([#21278](https://github.com/microsoft/FluidFramework/pull/21278)) [5a26346a14](https://github.com/microsoft/FluidFramework/commit/5a26346a145ed54d08cd5a9b4f1c9b177711bd7c)
`TreeStatus.Created` has been renamed to `TreeStatus.New`.
- core-interfaces, tree: Unify `IDisposable` interfaces ([#21184](https://github.com/microsoft/FluidFramework/pull/21184)) [cfcb827851](https://github.com/microsoft/FluidFramework/commit/cfcb827851ffc81486db6c718380150189fb95c5)
Public APIs in `@fluidframework/tree` now use `IDisposable` from `@fluidframework/core-interfaces` replacing `disposeSymbol` with "dispose".
`IDisposable` in `@fluidframework/core-interfaces` is now `@sealed` indicating that third parties should not implement it to reserve the ability for Fluid Framework to extend it to include `Symbol.dispose` as a future non-breaking change.
- fluid-framework: Cleanup `fluid-framework` legacy exports ([#21153](https://github.com/microsoft/FluidFramework/pull/21153)) [efee21c296](https://github.com/microsoft/FluidFramework/commit/efee21c2965a02288db6e0345fcf9b3713210953)
Cleanup `fluid-framework` legacy exports to remove no longer required types.
## 2.0.0-rc.4.0.0

@@ -4,0 +177,0 @@

@@ -15,9 +15,28 @@ /*!

export { ConnectionState } from "@fluidframework/container-loader";
export type { ContainerAttachProps, ContainerSchema, DataObjectClass, IConnection, IFluidContainer, IFluidContainerEvents, IMember, InitialObjects, IServiceAudience, IServiceAudienceEvents, LoadableObjectClass, LoadableObjectClassRecord, MemberChangedListener, Myself, } from "@fluidframework/fluid-static";
export type { ContainerAttachProps, ContainerSchema, IConnection, IFluidContainer, IFluidContainerEvents, IMember, InitialObjects, IServiceAudience, IServiceAudienceEvents, MemberChangedListener, Myself, } from "@fluidframework/fluid-static";
export type { SharedObjectKind } from "@fluidframework/shared-object-base";
export type { IErrorBase, IEventProvider, IDisposable, IEvent, IEventThisPlaceHolder, IErrorEvent, ErasedType, IFluidHandle, IFluidLoadable, ITelemetryBaseProperties, IEventTransformer, IProvideFluidLoadable, IFluidHandleErased, TransformedEvent, TelemetryBaseEventPropertyType, Tagged, ReplaceIEventThisPlaceHolder, FluidObject, // Linked in doc comment
FluidObjectProviderKeys, } from "@fluidframework/core-interfaces";
export * from "@fluidframework/tree";
export { ContainerErrorTypes } from "@fluidframework/container-definitions/internal";
import type { SharedObjectKind } from "@fluidframework/shared-object-base";
import type { ITree } from "@fluidframework/tree";
/**
* A hierarchical data structure for collaboratively editing strongly typed JSON-like trees
* of objects, arrays, and other data types.
* @privateRemarks
* Here we reexport SharedTree, but with the `@alpha` types (`ISharedObjectKind`) removed, just keeping the `SharedObjectKind`.
* Doing this requires creating this new typed export rather than relying on a reexport directly from the tree package.
* The tree package itself does not do this because it's API needs to be usable from the encapsulated API which requires `ISharedObjectKind`.
* This package however is not intended for use by users of the encapsulated API, and therefor it can discard that interface.
* @public
*/
export declare const SharedTree: SharedObjectKind<ITree>;
export type { IDirectory, IDirectoryEvents, IDirectoryValueChanged, ISharedDirectory, ISharedDirectoryEvents, ISharedMap, ISharedMapEvents, IValueChanged, } from "@fluidframework/map/internal";
export { DirectoryFactory, MapFactory, SharedDirectory, SharedMap, } from "@fluidframework/map/internal";
export type { DeserializeCallback, InteriorSequencePlace, IInterval, IIntervalCollectionEvent, IIntervalCollection, IntervalIndex, IntervalStickiness, ISequenceDeltaRange, ISerializableInterval, ISerializedInterval, ISharedIntervalCollection, ISharedSegmentSequenceEvents, ISharedString, SequencePlace, SharedStringSegment, Side, } from "@fluidframework/sequence/internal";
export { IntervalType, SequenceDeltaEvent, SequenceEvent, SequenceInterval, SequenceMaintenanceEvent, SharedSegmentSequence, SharedString, } from "@fluidframework/sequence/internal";
export { SharedDirectory, SharedMap } from "@fluidframework/map/internal";
export type { DeserializeCallback, InteriorSequencePlace, IInterval, IIntervalCollectionEvent, IIntervalCollection, IntervalIndex, IntervalStickiness, ISequenceDeltaRange, ISerializableInterval, ISerializedInterval, ISharedIntervalCollection, ISharedSegmentSequenceEvents, ISharedString, SequencePlace, SharedStringSegment, Side, ISharedSegmentSequence, } from "@fluidframework/sequence/internal";
export { IntervalType, SequenceDeltaEvent, SequenceEvent, SequenceInterval, SequenceMaintenanceEvent, SharedString, } from "@fluidframework/sequence/internal";
export type { ISharedObject, ISharedObjectEvents, } from "@fluidframework/shared-object-base/internal";
export type { ISequencedDocumentMessage, // Leaked via ISharedObjectEvents
IBranchOrigin, // Required for ISequencedDocumentMessage
ITrace, } from "@fluidframework/driver-definitions/internal";
//# sourceMappingURL=index.d.ts.map

@@ -21,3 +21,3 @@ "use strict";

Object.defineProperty(exports, "__esModule", { value: true });
exports.SharedString = exports.SharedSegmentSequence = exports.SequenceMaintenanceEvent = exports.SequenceInterval = exports.SequenceEvent = exports.SequenceDeltaEvent = exports.IntervalType = exports.SharedMap = exports.SharedDirectory = exports.MapFactory = exports.DirectoryFactory = exports.ContainerErrorTypes = exports.ConnectionState = exports.AttachState = void 0;
exports.SharedString = exports.SequenceMaintenanceEvent = exports.SequenceInterval = exports.SequenceEvent = exports.SequenceDeltaEvent = exports.IntervalType = exports.SharedMap = exports.SharedDirectory = exports.SharedTree = exports.ConnectionState = exports.AttachState = void 0;
var container_definitions_1 = require("@fluidframework/container-definitions");

@@ -31,11 +31,17 @@ Object.defineProperty(exports, "AttachState", { enumerable: true, get: function () { return container_definitions_1.AttachState; } });

// alpha` to surface everything `@alpha` and higher).
// eslint-disable-next-line no-restricted-syntax
// eslint-disable-next-line no-restricted-syntax, import/export
__exportStar(require("@fluidframework/tree"), exports);
// ===============================================================
// Legacy exports
var internal_1 = require("@fluidframework/container-definitions/internal");
Object.defineProperty(exports, "ContainerErrorTypes", { enumerable: true, get: function () { return internal_1.ContainerErrorTypes; } });
const internal_1 = require("@fluidframework/tree/internal");
/**
* A hierarchical data structure for collaboratively editing strongly typed JSON-like trees
* of objects, arrays, and other data types.
* @privateRemarks
* Here we reexport SharedTree, but with the `@alpha` types (`ISharedObjectKind`) removed, just keeping the `SharedObjectKind`.
* Doing this requires creating this new typed export rather than relying on a reexport directly from the tree package.
* The tree package itself does not do this because it's API needs to be usable from the encapsulated API which requires `ISharedObjectKind`.
* This package however is not intended for use by users of the encapsulated API, and therefor it can discard that interface.
* @public
*/
exports.SharedTree = internal_1.SharedTree;
var internal_2 = require("@fluidframework/map/internal");
Object.defineProperty(exports, "DirectoryFactory", { enumerable: true, get: function () { return internal_2.DirectoryFactory; } });
Object.defineProperty(exports, "MapFactory", { enumerable: true, get: function () { return internal_2.MapFactory; } });
Object.defineProperty(exports, "SharedDirectory", { enumerable: true, get: function () { return internal_2.SharedDirectory; } });

@@ -49,4 +55,4 @@ Object.defineProperty(exports, "SharedMap", { enumerable: true, get: function () { return internal_2.SharedMap; } });

Object.defineProperty(exports, "SequenceMaintenanceEvent", { enumerable: true, get: function () { return internal_3.SequenceMaintenanceEvent; } });
Object.defineProperty(exports, "SharedSegmentSequence", { enumerable: true, get: function () { return internal_3.SharedSegmentSequence; } });
Object.defineProperty(exports, "SharedString", { enumerable: true, get: function () { return internal_3.SharedString; } });
// #endregion Legacy exports
//# sourceMappingURL=index.js.map

@@ -12,5 +12,7 @@ /*!

export {
// Unrestricted APIs
InternalTypes,
// @public APIs
AllowedTypes,
ApplyKind,
AttachState,

@@ -23,6 +25,3 @@ CommitKind,

ContainerSchema,
DataObjectClass,
DefaultProvider,
Events,
ExtractItemType,
ErasedType,
FieldKind,

@@ -32,18 +31,29 @@ FieldProps,

FieldSchemaUnsafe,
FlexList,
FlexListToUnion,
FluidObject,
FluidObjectProviderKeys,
IConnection,
ICriticalContainerError,
IDisposable,
IErrorBase,
IErrorEvent,
IEvent,
IEventProvider,
IEventThisPlaceHolder,
IEventTransformer,
IFluidContainer,
IFluidContainerEvents,
IFluidHandle,
IFluidHandleErased,
IFluidLoadable,
IMember,
IProvideFluidLoadable,
IServiceAudience,
IServiceAudienceEvents,
ISubscribable,
ITelemetryBaseProperties,
ITree,
ITreeConfigurationOptions,
ITreeViewConfiguration,
ImplicitAllowedTypes,
ImplicitFieldSchema,
InitialObjects,
InsertableObjectFromSchemaRecord,
InsertableObjectFromSchemaRecordUnsafe,

@@ -55,20 +65,16 @@ InsertableTreeFieldFromImplicitField,

InsertableTypedNode,
InsertableTypedNodeUnsafe,
InternalTreeNode,
IsEvent,
IsListener,
IterableTreeArrayContent,
LazyItem,
LoadableObjectClass,
LoadableObjectClassRecord,
Listenable,
Listeners,
MakeNominal,
MemberChangedListener,
Myself,
NodeBuilderData,
NodeBuilderDataUnsafe,
NodeFromSchema,
NodeFromSchemaUnsafe,
NodeInDocumentConstraint,
NodeKind,
ObjectFromSchemaRecord,
ObjectFromSchemaRecordUnsafe,
Off,
ReplaceIEventThisPlaceHolder,
RestrictiveReadonlyRecord,

@@ -79,16 +85,15 @@ Revertible,

RunTransaction,
SchemaCompatibilityStatus,
SchemaFactory,
SchemaIncompatible,
ScopedSchemaName,
SharedObjectKind,
SharedTree,
Tagged,
TelemetryBaseEventPropertyType,
TransactionConstraint,
TransformedEvent,
Tree,
TreeApi,
TreeArrayNode,
TreeArrayNodeBase,
TreeArrayNodeUnsafe,
TreeChangeEvents,
TreeConfiguration,
TreeFieldFromImplicitField,
TreeFieldFromImplicitFieldUnsafe,
TreeLeafValue,

@@ -100,7 +105,5 @@ TreeMapNode,

TreeNodeFromImplicitAllowedTypes,
TreeNodeFromImplicitAllowedTypesUnsafe,
TreeNodeSchema,
TreeNodeSchemaClass,
TreeNodeSchemaCore,
TreeNodeSchemaNonClass,
TreeObjectNode,

@@ -110,2 +113,3 @@ TreeObjectNodeUnsafe,

TreeView,
TreeViewConfiguration,
TreeViewEvents,

@@ -116,10 +120,7 @@ Unenforced,

WithType,
disposeSymbol,
rollback,
type,
rollback,
// @alpha APIs
ContainerErrorTypes,
DeserializeCallback,
DirectoryFactory,
IBranchOrigin,
IDirectory,

@@ -132,2 +133,3 @@ IDirectoryEvents,

ISequenceDeltaRange,
ISequencedDocumentMessage,
ISerializableInterval,

@@ -140,4 +142,8 @@ ISerializedInterval,

ISharedMapEvents,
ISharedObject,
ISharedObjectEvents,
ISharedSegmentSequence,
ISharedSegmentSequenceEvents,
ISharedString,
ITrace,
IValueChanged,

@@ -148,3 +154,2 @@ InteriorSequencePlace,

IntervalType,
MapFactory,
SequenceDeltaEvent,

@@ -157,3 +162,2 @@ SequenceEvent,

SharedMap,
SharedSegmentSequence,
SharedString,

@@ -160,0 +164,0 @@ SharedStringSegment,

@@ -12,5 +12,7 @@ /*!

export {
// Unrestricted APIs
InternalTypes,
// @public APIs
AllowedTypes,
ApplyKind,
AttachState,

@@ -23,6 +25,3 @@ CommitKind,

ContainerSchema,
DataObjectClass,
DefaultProvider,
Events,
ExtractItemType,
ErasedType,
FieldKind,

@@ -32,18 +31,29 @@ FieldProps,

FieldSchemaUnsafe,
FlexList,
FlexListToUnion,
FluidObject,
FluidObjectProviderKeys,
IConnection,
ICriticalContainerError,
IDisposable,
IErrorBase,
IErrorEvent,
IEvent,
IEventProvider,
IEventThisPlaceHolder,
IEventTransformer,
IFluidContainer,
IFluidContainerEvents,
IFluidHandle,
IFluidHandleErased,
IFluidLoadable,
IMember,
IProvideFluidLoadable,
IServiceAudience,
IServiceAudienceEvents,
ISubscribable,
ITelemetryBaseProperties,
ITree,
ITreeConfigurationOptions,
ITreeViewConfiguration,
ImplicitAllowedTypes,
ImplicitFieldSchema,
InitialObjects,
InsertableObjectFromSchemaRecord,
InsertableObjectFromSchemaRecordUnsafe,

@@ -55,20 +65,16 @@ InsertableTreeFieldFromImplicitField,

InsertableTypedNode,
InsertableTypedNodeUnsafe,
InternalTreeNode,
IsEvent,
IsListener,
IterableTreeArrayContent,
LazyItem,
LoadableObjectClass,
LoadableObjectClassRecord,
Listenable,
Listeners,
MakeNominal,
MemberChangedListener,
Myself,
NodeBuilderData,
NodeBuilderDataUnsafe,
NodeFromSchema,
NodeFromSchemaUnsafe,
NodeInDocumentConstraint,
NodeKind,
ObjectFromSchemaRecord,
ObjectFromSchemaRecordUnsafe,
Off,
ReplaceIEventThisPlaceHolder,
RestrictiveReadonlyRecord,

@@ -79,16 +85,15 @@ Revertible,

RunTransaction,
SchemaCompatibilityStatus,
SchemaFactory,
SchemaIncompatible,
ScopedSchemaName,
SharedObjectKind,
SharedTree,
Tagged,
TelemetryBaseEventPropertyType,
TransactionConstraint,
TransformedEvent,
Tree,
TreeApi,
TreeArrayNode,
TreeArrayNodeBase,
TreeArrayNodeUnsafe,
TreeChangeEvents,
TreeConfiguration,
TreeFieldFromImplicitField,
TreeFieldFromImplicitFieldUnsafe,
TreeLeafValue,

@@ -100,7 +105,5 @@ TreeMapNode,

TreeNodeFromImplicitAllowedTypes,
TreeNodeFromImplicitAllowedTypesUnsafe,
TreeNodeSchema,
TreeNodeSchemaClass,
TreeNodeSchemaCore,
TreeNodeSchemaNonClass,
TreeObjectNode,

@@ -110,2 +113,3 @@ TreeObjectNodeUnsafe,

TreeView,
TreeViewConfiguration,
TreeViewEvents,

@@ -116,5 +120,3 @@ Unenforced,

WithType,
disposeSymbol,
rollback,
type
rollback
} from "./index.js";

@@ -15,9 +15,28 @@ /*!

export { ConnectionState } from "@fluidframework/container-loader";
export type { ContainerAttachProps, ContainerSchema, DataObjectClass, IConnection, IFluidContainer, IFluidContainerEvents, IMember, InitialObjects, IServiceAudience, IServiceAudienceEvents, LoadableObjectClass, LoadableObjectClassRecord, MemberChangedListener, Myself, } from "@fluidframework/fluid-static";
export type { ContainerAttachProps, ContainerSchema, IConnection, IFluidContainer, IFluidContainerEvents, IMember, InitialObjects, IServiceAudience, IServiceAudienceEvents, MemberChangedListener, Myself, } from "@fluidframework/fluid-static";
export type { SharedObjectKind } from "@fluidframework/shared-object-base";
export type { IErrorBase, IEventProvider, IDisposable, IEvent, IEventThisPlaceHolder, IErrorEvent, ErasedType, IFluidHandle, IFluidLoadable, ITelemetryBaseProperties, IEventTransformer, IProvideFluidLoadable, IFluidHandleErased, TransformedEvent, TelemetryBaseEventPropertyType, Tagged, ReplaceIEventThisPlaceHolder, FluidObject, // Linked in doc comment
FluidObjectProviderKeys, } from "@fluidframework/core-interfaces";
export * from "@fluidframework/tree";
export { ContainerErrorTypes } from "@fluidframework/container-definitions/internal";
import type { SharedObjectKind } from "@fluidframework/shared-object-base";
import type { ITree } from "@fluidframework/tree";
/**
* A hierarchical data structure for collaboratively editing strongly typed JSON-like trees
* of objects, arrays, and other data types.
* @privateRemarks
* Here we reexport SharedTree, but with the `@alpha` types (`ISharedObjectKind`) removed, just keeping the `SharedObjectKind`.
* Doing this requires creating this new typed export rather than relying on a reexport directly from the tree package.
* The tree package itself does not do this because it's API needs to be usable from the encapsulated API which requires `ISharedObjectKind`.
* This package however is not intended for use by users of the encapsulated API, and therefor it can discard that interface.
* @public
*/
export declare const SharedTree: SharedObjectKind<ITree>;
export type { IDirectory, IDirectoryEvents, IDirectoryValueChanged, ISharedDirectory, ISharedDirectoryEvents, ISharedMap, ISharedMapEvents, IValueChanged, } from "@fluidframework/map/internal";
export { DirectoryFactory, MapFactory, SharedDirectory, SharedMap, } from "@fluidframework/map/internal";
export type { DeserializeCallback, InteriorSequencePlace, IInterval, IIntervalCollectionEvent, IIntervalCollection, IntervalIndex, IntervalStickiness, ISequenceDeltaRange, ISerializableInterval, ISerializedInterval, ISharedIntervalCollection, ISharedSegmentSequenceEvents, ISharedString, SequencePlace, SharedStringSegment, Side, } from "@fluidframework/sequence/internal";
export { IntervalType, SequenceDeltaEvent, SequenceEvent, SequenceInterval, SequenceMaintenanceEvent, SharedSegmentSequence, SharedString, } from "@fluidframework/sequence/internal";
export { SharedDirectory, SharedMap } from "@fluidframework/map/internal";
export type { DeserializeCallback, InteriorSequencePlace, IInterval, IIntervalCollectionEvent, IIntervalCollection, IntervalIndex, IntervalStickiness, ISequenceDeltaRange, ISerializableInterval, ISerializedInterval, ISharedIntervalCollection, ISharedSegmentSequenceEvents, ISharedString, SequencePlace, SharedStringSegment, Side, ISharedSegmentSequence, } from "@fluidframework/sequence/internal";
export { IntervalType, SequenceDeltaEvent, SequenceEvent, SequenceInterval, SequenceMaintenanceEvent, SharedString, } from "@fluidframework/sequence/internal";
export type { ISharedObject, ISharedObjectEvents, } from "@fluidframework/shared-object-base/internal";
export type { ISequencedDocumentMessage, // Leaked via ISharedObjectEvents
IBranchOrigin, // Required for ISequencedDocumentMessage
ITrace, } from "@fluidframework/driver-definitions/internal";
//# sourceMappingURL=index.d.ts.map

@@ -11,9 +11,19 @@ /*!

// alpha` to surface everything `@alpha` and higher).
// eslint-disable-next-line no-restricted-syntax
// eslint-disable-next-line no-restricted-syntax, import/export
export * from "@fluidframework/tree";
// ===============================================================
// Legacy exports
export { ContainerErrorTypes } from "@fluidframework/container-definitions/internal";
export { DirectoryFactory, MapFactory, SharedDirectory, SharedMap, } from "@fluidframework/map/internal";
export { IntervalType, SequenceDeltaEvent, SequenceEvent, SequenceInterval, SequenceMaintenanceEvent, SharedSegmentSequence, SharedString, } from "@fluidframework/sequence/internal";
import { SharedTree as OriginalSharedTree } from "@fluidframework/tree/internal";
/**
* A hierarchical data structure for collaboratively editing strongly typed JSON-like trees
* of objects, arrays, and other data types.
* @privateRemarks
* Here we reexport SharedTree, but with the `@alpha` types (`ISharedObjectKind`) removed, just keeping the `SharedObjectKind`.
* Doing this requires creating this new typed export rather than relying on a reexport directly from the tree package.
* The tree package itself does not do this because it's API needs to be usable from the encapsulated API which requires `ISharedObjectKind`.
* This package however is not intended for use by users of the encapsulated API, and therefor it can discard that interface.
* @public
*/
export const SharedTree = OriginalSharedTree;
export { SharedDirectory, SharedMap } from "@fluidframework/map/internal";
export { IntervalType, SequenceDeltaEvent, SequenceEvent, SequenceInterval, SequenceMaintenanceEvent, SharedString, } from "@fluidframework/sequence/internal";
// #endregion Legacy exports
//# sourceMappingURL=index.js.map

@@ -12,5 +12,7 @@ /*!

export {
// Unrestricted APIs
InternalTypes,
// @public APIs
AllowedTypes,
ApplyKind,
AttachState,

@@ -23,6 +25,3 @@ CommitKind,

ContainerSchema,
DataObjectClass,
DefaultProvider,
Events,
ExtractItemType,
ErasedType,
FieldKind,

@@ -32,18 +31,29 @@ FieldProps,

FieldSchemaUnsafe,
FlexList,
FlexListToUnion,
FluidObject,
FluidObjectProviderKeys,
IConnection,
ICriticalContainerError,
IDisposable,
IErrorBase,
IErrorEvent,
IEvent,
IEventProvider,
IEventThisPlaceHolder,
IEventTransformer,
IFluidContainer,
IFluidContainerEvents,
IFluidHandle,
IFluidHandleErased,
IFluidLoadable,
IMember,
IProvideFluidLoadable,
IServiceAudience,
IServiceAudienceEvents,
ISubscribable,
ITelemetryBaseProperties,
ITree,
ITreeConfigurationOptions,
ITreeViewConfiguration,
ImplicitAllowedTypes,
ImplicitFieldSchema,
InitialObjects,
InsertableObjectFromSchemaRecord,
InsertableObjectFromSchemaRecordUnsafe,

@@ -55,20 +65,16 @@ InsertableTreeFieldFromImplicitField,

InsertableTypedNode,
InsertableTypedNodeUnsafe,
InternalTreeNode,
IsEvent,
IsListener,
IterableTreeArrayContent,
LazyItem,
LoadableObjectClass,
LoadableObjectClassRecord,
Listenable,
Listeners,
MakeNominal,
MemberChangedListener,
Myself,
NodeBuilderData,
NodeBuilderDataUnsafe,
NodeFromSchema,
NodeFromSchemaUnsafe,
NodeInDocumentConstraint,
NodeKind,
ObjectFromSchemaRecord,
ObjectFromSchemaRecordUnsafe,
Off,
ReplaceIEventThisPlaceHolder,
RestrictiveReadonlyRecord,

@@ -79,16 +85,15 @@ Revertible,

RunTransaction,
SchemaCompatibilityStatus,
SchemaFactory,
SchemaIncompatible,
ScopedSchemaName,
SharedObjectKind,
SharedTree,
Tagged,
TelemetryBaseEventPropertyType,
TransactionConstraint,
TransformedEvent,
Tree,
TreeApi,
TreeArrayNode,
TreeArrayNodeBase,
TreeArrayNodeUnsafe,
TreeChangeEvents,
TreeConfiguration,
TreeFieldFromImplicitField,
TreeFieldFromImplicitFieldUnsafe,
TreeLeafValue,

@@ -100,7 +105,5 @@ TreeMapNode,

TreeNodeFromImplicitAllowedTypes,
TreeNodeFromImplicitAllowedTypesUnsafe,
TreeNodeSchema,
TreeNodeSchemaClass,
TreeNodeSchemaCore,
TreeNodeSchemaNonClass,
TreeObjectNode,

@@ -110,2 +113,3 @@ TreeObjectNodeUnsafe,

TreeView,
TreeViewConfiguration,
TreeViewEvents,

@@ -116,10 +120,7 @@ Unenforced,

WithType,
disposeSymbol,
rollback,
type,
rollback,
// @alpha APIs
ContainerErrorTypes,
DeserializeCallback,
DirectoryFactory,
IBranchOrigin,
IDirectory,

@@ -132,2 +133,3 @@ IDirectoryEvents,

ISequenceDeltaRange,
ISequencedDocumentMessage,
ISerializableInterval,

@@ -140,4 +142,8 @@ ISerializedInterval,

ISharedMapEvents,
ISharedObject,
ISharedObjectEvents,
ISharedSegmentSequence,
ISharedSegmentSequenceEvents,
ISharedString,
ITrace,
IValueChanged,

@@ -148,3 +154,2 @@ InteriorSequencePlace,

IntervalType,
MapFactory,
SequenceDeltaEvent,

@@ -157,3 +162,2 @@ SequenceEvent,

SharedMap,
SharedSegmentSequence,
SharedString,

@@ -160,0 +164,0 @@ SharedStringSegment,

@@ -12,5 +12,7 @@ /*!

export {
// Unrestricted APIs
InternalTypes,
// @public APIs
AllowedTypes,
ApplyKind,
AttachState,

@@ -23,6 +25,3 @@ CommitKind,

ContainerSchema,
DataObjectClass,
DefaultProvider,
Events,
ExtractItemType,
ErasedType,
FieldKind,

@@ -32,18 +31,29 @@ FieldProps,

FieldSchemaUnsafe,
FlexList,
FlexListToUnion,
FluidObject,
FluidObjectProviderKeys,
IConnection,
ICriticalContainerError,
IDisposable,
IErrorBase,
IErrorEvent,
IEvent,
IEventProvider,
IEventThisPlaceHolder,
IEventTransformer,
IFluidContainer,
IFluidContainerEvents,
IFluidHandle,
IFluidHandleErased,
IFluidLoadable,
IMember,
IProvideFluidLoadable,
IServiceAudience,
IServiceAudienceEvents,
ISubscribable,
ITelemetryBaseProperties,
ITree,
ITreeConfigurationOptions,
ITreeViewConfiguration,
ImplicitAllowedTypes,
ImplicitFieldSchema,
InitialObjects,
InsertableObjectFromSchemaRecord,
InsertableObjectFromSchemaRecordUnsafe,

@@ -55,20 +65,16 @@ InsertableTreeFieldFromImplicitField,

InsertableTypedNode,
InsertableTypedNodeUnsafe,
InternalTreeNode,
IsEvent,
IsListener,
IterableTreeArrayContent,
LazyItem,
LoadableObjectClass,
LoadableObjectClassRecord,
Listenable,
Listeners,
MakeNominal,
MemberChangedListener,
Myself,
NodeBuilderData,
NodeBuilderDataUnsafe,
NodeFromSchema,
NodeFromSchemaUnsafe,
NodeInDocumentConstraint,
NodeKind,
ObjectFromSchemaRecord,
ObjectFromSchemaRecordUnsafe,
Off,
ReplaceIEventThisPlaceHolder,
RestrictiveReadonlyRecord,

@@ -79,16 +85,15 @@ Revertible,

RunTransaction,
SchemaCompatibilityStatus,
SchemaFactory,
SchemaIncompatible,
ScopedSchemaName,
SharedObjectKind,
SharedTree,
Tagged,
TelemetryBaseEventPropertyType,
TransactionConstraint,
TransformedEvent,
Tree,
TreeApi,
TreeArrayNode,
TreeArrayNodeBase,
TreeArrayNodeUnsafe,
TreeChangeEvents,
TreeConfiguration,
TreeFieldFromImplicitField,
TreeFieldFromImplicitFieldUnsafe,
TreeLeafValue,

@@ -100,7 +105,5 @@ TreeMapNode,

TreeNodeFromImplicitAllowedTypes,
TreeNodeFromImplicitAllowedTypesUnsafe,
TreeNodeSchema,
TreeNodeSchemaClass,
TreeNodeSchemaCore,
TreeNodeSchemaNonClass,
TreeObjectNode,

@@ -110,2 +113,3 @@ TreeObjectNodeUnsafe,

TreeView,
TreeViewConfiguration,
TreeViewEvents,

@@ -116,5 +120,3 @@ Unenforced,

WithType,
disposeSymbol,
rollback,
type
rollback
} from "./index.js";

@@ -8,5 +8,5 @@ // This file is read by tools that parse documentation comments conforming to the TSDoc standard.

"packageName": "@microsoft/api-extractor",
"packageVersion": "7.43.1"
"packageVersion": "7.45.1"
}
]
}
{
"name": "fluid-framework",
"version": "2.0.0-rc.4.0.6",
"version": "2.0.0-rc.5.0.0",
"description": "The main entry point into Fluid Framework public packages",

@@ -40,19 +40,22 @@ "homepage": "https://fluidframework.com",

"dependencies": {
"@fluidframework/container-definitions": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0",
"@fluidframework/container-loader": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0",
"@fluidframework/driver-definitions": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0",
"@fluidframework/fluid-static": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0",
"@fluidframework/map": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0",
"@fluidframework/sequence": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0",
"@fluidframework/tree": ">=2.0.0-rc.4.0.6 <2.0.0-rc.4.1.0"
"@fluidframework/container-definitions": ">=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0",
"@fluidframework/container-loader": ">=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0",
"@fluidframework/core-interfaces": ">=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0",
"@fluidframework/driver-definitions": ">=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0",
"@fluidframework/fluid-static": ">=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0",
"@fluidframework/map": ">=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0",
"@fluidframework/sequence": ">=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0",
"@fluidframework/shared-object-base": ">=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0",
"@fluidframework/tree": ">=2.0.0-rc.5.0.0 <2.0.0-rc.5.1.0"
},
"devDependencies": {
"@arethetypeswrong/cli": "^0.15.2",
"@biomejs/biome": "^1.6.2",
"@fluid-tools/build-cli": "^0.38.0",
"@biomejs/biome": "^1.7.3",
"@fluid-tools/build-cli": "^0.39.0",
"@fluidframework/build-common": "^2.0.3",
"@fluidframework/build-tools": "^0.38.0",
"@fluidframework/eslint-config-fluid": "^5.1.0",
"@microsoft/api-extractor": "^7.43.1",
"@fluidframework/build-tools": "^0.39.0",
"@fluidframework/eslint-config-fluid": "^5.3.0",
"@microsoft/api-extractor": "^7.45.1",
"@types/node": "^18.19.0",
"concurrently": "^8.2.1",
"copyfiles": "^2.4.1",

@@ -62,3 +65,3 @@ "eslint": "~8.55.0",

"rimraf": "^4.4.0",
"typescript": "~5.1.6"
"typescript": "~5.4.5"
},

@@ -86,4 +89,11 @@ "fluidBuild": {

"check:are-the-types-wrong": "attw --pack .",
"check:biome": "biome check . --formatter-enabled=true",
"check:exports": "concurrently \"npm:check:exports:*\"",
"check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
"check:exports:cjs:legacy": "echo AB#8288 skip api-extractor run --config api-extractor/api-extractor-lint-legacy.cjs.json",
"check:exports:cjs:public": "echo AB#8288 skip api-extractor run --config api-extractor/api-extractor-lint-public.cjs.json",
"check:exports:esm:legacy": "echo AB#8288 skip api-extractor run --config api-extractor/api-extractor-lint-legacy.esm.json",
"check:exports:esm:public": "echo AB#8288 skip api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
"check:format": "npm run check:biome",
"check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
"check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
"ci:build:docs": "api-extractor run",

@@ -93,3 +103,4 @@ "clean": "rimraf --glob _api-extractor-temp dist lib \"*.d.ts\" \"**/*.tsbuildinfo\" \"**/*.build.log\"",

"eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
"format": "fluid-build --task format .",
"format": "npm run format:biome",
"format:biome": "biome check . --formatter-enabled=true --apply",
"format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",

@@ -96,0 +107,0 @@ "lint": "fluid-build . --task lint",

@@ -13,2 +13,6 @@ /*!

// ===============================================================
// #region Public exports
// #region Basic re-exports
export type {

@@ -23,3 +27,2 @@ ConnectionState as ConnectionStateType, // TODO: deduplicate ConnectionState types

ContainerSchema,
DataObjectClass,
IConnection,

@@ -32,7 +35,27 @@ IFluidContainer,

IServiceAudienceEvents,
LoadableObjectClass,
LoadableObjectClassRecord,
MemberChangedListener,
Myself,
} from "@fluidframework/fluid-static";
export type { SharedObjectKind } from "@fluidframework/shared-object-base";
export type {
IErrorBase,
IEventProvider,
IDisposable,
IEvent,
IEventThisPlaceHolder,
IErrorEvent,
ErasedType,
IFluidHandle,
IFluidLoadable,
ITelemetryBaseProperties,
IEventTransformer,
IProvideFluidLoadable,
IFluidHandleErased,
TransformedEvent,
TelemetryBaseEventPropertyType,
Tagged,
ReplaceIEventThisPlaceHolder,
FluidObject, // Linked in doc comment
FluidObjectProviderKeys, // Used by FluidObject
} from "@fluidframework/core-interfaces";

@@ -43,10 +66,33 @@ // Let the tree package manage its own API surface, we will simply reflect it here.

// alpha` to surface everything `@alpha` and higher).
// eslint-disable-next-line no-restricted-syntax
// eslint-disable-next-line no-restricted-syntax, import/export
export * from "@fluidframework/tree";
// End of basic public exports - nothing above this line should
// depend on an /internal path.
// #endregion Basic re-exports
// ---------------------------------------------------------------
// #region Custom re-exports
import type { SharedObjectKind } from "@fluidframework/shared-object-base";
import type { ITree } from "@fluidframework/tree";
import { SharedTree as OriginalSharedTree } from "@fluidframework/tree/internal";
/**
* A hierarchical data structure for collaboratively editing strongly typed JSON-like trees
* of objects, arrays, and other data types.
* @privateRemarks
* Here we reexport SharedTree, but with the `@alpha` types (`ISharedObjectKind`) removed, just keeping the `SharedObjectKind`.
* Doing this requires creating this new typed export rather than relying on a reexport directly from the tree package.
* The tree package itself does not do this because it's API needs to be usable from the encapsulated API which requires `ISharedObjectKind`.
* This package however is not intended for use by users of the encapsulated API, and therefor it can discard that interface.
* @public
*/
export const SharedTree: SharedObjectKind<ITree> = OriginalSharedTree;
// #endregion Custom re-exports
// #endregion Public exports
// ===============================================================
// Legacy exports
// #region Legacy exports
export { ContainerErrorTypes } from "@fluidframework/container-definitions/internal";
export type {

@@ -63,8 +109,3 @@ IDirectory,

export {
DirectoryFactory,
MapFactory,
SharedDirectory,
SharedMap,
} from "@fluidframework/map/internal";
export { SharedDirectory, SharedMap } from "@fluidframework/map/internal";

@@ -88,2 +129,3 @@ export type {

Side,
ISharedSegmentSequence,
} from "@fluidframework/sequence/internal";

@@ -97,4 +139,16 @@

SequenceMaintenanceEvent,
SharedSegmentSequence,
SharedString,
} from "@fluidframework/sequence/internal";
export type {
ISharedObject,
ISharedObjectEvents,
} from "@fluidframework/shared-object-base/internal";
export type {
ISequencedDocumentMessage, // Leaked via ISharedObjectEvents
IBranchOrigin, // Required for ISequencedDocumentMessage
ITrace, // Required for ISequencedDocumentMessage
} from "@fluidframework/driver-definitions/internal";
// #endregion Legacy exports

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc