Skip to content

Latest commit

 

History

History
96 lines (53 loc) · 5.17 KB

File metadata and controls

96 lines (53 loc) · 5.17 KB

@fluidframework/protocol-definitions Changelog

BREAKING CHANGE: Some APIs no longer exported

The public API surface of this package has been trimmed. This means that some APIs may no longer be available.

Explicit package entrypoints using "exports" field

This release adds the "exports" field to package.json to enforce package entrypoints. Any imports of APIs that are not explicitly exported will no longer work.

In addition, TypeScript users should compile Fluid Framework using the following tsconfig settings:

This release includes new optional properties on several interfaces. Note that these new properties are not yet used by services or clients. They are intended for future opt-in features.

Added new optional targetClientId property to ISequencedClient

ISequencedClient has a new optional property called targetClientId which is the client ID of the singular client the signal is being (or has been) sent to.

(#19555) af2d678db1

Added new optional omitted property to ISnapshotTree

ISnapshotTree has a new optional property, omitted. This property will be used by the service to communicate that it omitted the blobs contents in the snapshot.

(#19555) 198235d46d

Added new optional property groupId to ISnapshotTree, ISummaryTree, and ITree

ISnapshotTree, ISummaryTree, and ITree have a new optional property, groupId.

For more information, see the Data Virtualization for Datastores documentation.

(#19555) ef873e618e

Deprecated properties on ISequencedDocumentMessage

ISequencedDocumentMessage properties compression and expHash1 are deprecated. They have been extracted into a separate interface ISequencedDocumentMessageExperimental and should be used from there instead.

Package now works properly with TypeScript's node16 moduleResolution

The package now has an "exports" field in its package.json so node16 moduleResolution will work for both CJS and ESM.

Updated @fluidframework/common-definitions

The @fluidframework/common-definitions package dependency has been updated to version 1.0.0.

Updated signal interfaces

Updating signal interfaces for some planned improvements. The intention is split the interface between signals submitted by clients to the server and the resulting signals sent from the server to clients.

A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has been added, which will be the typing for signals sent from the client to the server. Both extend a new ISignalMessageBase interface that contains common members.

Remove RemoteHelp from MessageType

This was deprecated in 1.2.0 and is now removed.

Remove IHelpMessage and IQueueMessage

These are unused and have been removed.

IQuorumClients and IQuorumProposals members disposed and dispose() removed

Directly calling dispose() on the IQuorumClients and IQuorumProposals puts the system in an inconsistent state, and inspecting the disposed state of the IQuorumClients and IQuorumProposals is not recommended (instead, prefer to inspect either the IContainer.disposed, IContainerRuntime.disposed, or IFluidDataStoreRuntime.disposed depending on your scenario). These members have been removed.

1.2.0 (2023-04-05)

Deprecate term member from IDocumentAttributes and ISequencedDocumentMessage

This member was related to an experimental feature that did not ship. As a result it is unused/ignored by all consumers. This change deprecates it, to be removed in a later release.

Deprecate RemoteHelp from MessageType

The RemoteHelp MessageType is no longer used by the server side so it is safe to deprecate this op type. This change deprecates it, to be removed in a later release.