@fluidframework/map 2.0.2 → 2.1.0-276326

package/src/directory.ts

@@ -85,6 +85,7 @@ interface IDirectoryMessageHandler {
 
 /**
  * Operation indicating a value should be set for a key.
+ * @legacy
  * @alpha
  */
 export interface IDirectorySetOperation {
@@ -112,6 +113,7 @@ export interface IDirectorySetOperation {
 
 /**
  * Operation indicating a key should be deleted from the directory.
+ * @legacy
  * @alpha
  */
 export interface IDirectoryDeleteOperation {
@@ -133,12 +135,14 @@ export interface IDirectoryDeleteOperation {
 
 /**
  * An operation on a specific key within a directory.
+ * @legacy
  * @alpha
  */
 export type IDirectoryKeyOperation = IDirectorySetOperation | IDirectoryDeleteOperation;
 
 /**
  * Operation indicating the directory should be cleared.
+ * @legacy
  * @alpha
  */
 export interface IDirectoryClearOperation {
@@ -155,12 +159,14 @@ export interface IDirectoryClearOperation {
 
 /**
  * An operation on one or more of the keys within a directory.
+ * @legacy
  * @alpha
  */
 export type IDirectoryStorageOperation = IDirectoryKeyOperation | IDirectoryClearOperation;
 
 /**
  * Operation indicating a subdirectory should be created.
+ * @legacy
  * @alpha
  */
 export interface IDirectoryCreateSubDirectoryOperation {
@@ -182,6 +188,7 @@ export interface IDirectoryCreateSubDirectoryOperation {
 
 /**
  * Operation indicating a subdirectory should be deleted.
+ * @legacy
  * @alpha
  */
 export interface IDirectoryDeleteSubDirectoryOperation {
@@ -203,6 +210,7 @@ export interface IDirectoryDeleteSubDirectoryOperation {
 
 /**
  * An operation on the subdirectories within a directory.
+ * @legacy
  * @alpha
  */
 export type IDirectorySubDirectoryOperation =
@@ -211,6 +219,7 @@ export type IDirectorySubDirectoryOperation =
 
 /**
  * Any operation on a directory.
+ * @legacy
  * @alpha
  */
 export type IDirectoryOperation = IDirectoryStorageOperation | IDirectorySubDirectoryOperation;
@@ -220,6 +229,7 @@ export type IDirectoryOperation = IDirectoryStorageOperation | IDirectorySubDire
  *
  * @deprecated - This interface will no longer be exported in the future(AB#8004).
  *
+ * @legacy
  * @alpha
  */
 export interface ICreateInfo {
@@ -244,6 +254,7 @@ export interface ICreateInfo {
  *
  * @deprecated - This interface will no longer be exported in the future(AB#8004).
  *
+ * @legacy
  * @alpha
  */
 export interface IDirectoryDataObject {
@@ -273,6 +284,7 @@ export interface IDirectoryDataObject {
  *
  * @deprecated - This interface will no longer be exported in the future(AB#8004).
  *
+ * @legacy
  * @alpha
  */
 export interface IDirectoryNewStorageFormat {
@@ -412,6 +424,7 @@ class DirectoryCreationTracker {
  * ```
  *
  * @sealed
+ * @legacy
  * @alpha
  */
 export class SharedDirectory

package/src/directoryFactory.ts

@@ -19,6 +19,7 @@ import { pkgVersion } from "./packageVersion.js";
  * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link ISharedDirectory}.
  *
  * @sealed
+ * @legacy
  * @alpha
  */
 export class DirectoryFactory implements IChannelFactory<ISharedDirectory> {
@@ -78,12 +79,14 @@ export class DirectoryFactory implements IChannelFactory<ISharedDirectory> {
 
 /**
  * Entrypoint for {@link ISharedDirectory} creation.
+ * @legacy
  * @alpha
  */
 export const SharedDirectory = createSharedObjectKind<ISharedDirectory>(DirectoryFactory);
 
 /**
  * Entrypoint for {@link ISharedDirectory} creation.
+ * @legacy
  * @alpha
  * @privateRemarks
  * This alias is for legacy compat from when the SharedDirectory class was exported as public.

package/src/interfaces.ts

@@ -17,6 +17,7 @@ import type {
 /**
  * Type of "valueChanged" event parameter.
  * @sealed
+ * @legacy
  * @alpha
  */
 export interface IValueChanged {
@@ -37,6 +38,7 @@ export interface IValueChanged {
  * Interface describing actions on a directory.
  *
  * @remarks When used as a Map, operates on its keys.
+ * @legacy
  * @alpha
  */
 export interface IDirectory
@@ -121,6 +123,7 @@ export interface IDirectory
  *
  * @remarks
  * These events only emit on the {@link ISharedDirectory} itself, and not on subdirectories.
+ * @legacy
  * @alpha
  */
 export interface ISharedDirectoryEvents extends ISharedObjectEvents {
@@ -194,6 +197,7 @@ export interface ISharedDirectoryEvents extends ISharedObjectEvents {
 
 /**
  * Events emitted in response to changes to the directory data.
+ * @legacy
  * @alpha
  */
 export interface IDirectoryEvents extends IEvent {
@@ -275,6 +279,7 @@ export interface IDirectoryEvents extends IEvent {
  * Provides a hierarchical organization of map-like data structures as SubDirectories.
  * The values stored within can be accessed like a map, and the hierarchy can be navigated using path syntax.
  * SubDirectories can be retrieved for use as working directories.
+ * @legacy
  * @alpha
  */
 export interface ISharedDirectory
@@ -290,6 +295,7 @@ export interface ISharedDirectory
 
 /**
  * Type of "valueChanged" event parameter for {@link ISharedDirectory}.
+ * @legacy
  * @alpha
  */
 export interface IDirectoryValueChanged extends IValueChanged {
@@ -302,6 +308,7 @@ export interface IDirectoryValueChanged extends IValueChanged {
 /**
  * Events emitted in response to changes to the {@link ISharedMap | map} data.
  * @sealed
+ * @legacy
  * @alpha
  */
 export interface ISharedMapEvents extends ISharedObjectEvents {
@@ -346,6 +353,7 @@ export interface ISharedMapEvents extends ISharedObjectEvents {
  *
  * For more information, including example usages, see {@link https://fluidframework.com/docs/data-structures/map/}.
  * @sealed
+ * @legacy
  * @alpha
  */
 // TODO: Use `unknown` instead (breaking change).

package/src/internalInterfaces.ts

@@ -137,6 +137,7 @@ export type MapLocalOpMetadata = IMapClearLocalOpMetadata | MapKeyLocalOpMetadat
  * channel ID.
  *
  * @deprecated This type is legacy and deprecated(AB#8004).
+ * @legacy
  * @alpha
  */
 export interface ISerializableValue {
@@ -154,6 +155,7 @@ export interface ISerializableValue {
 
 /**
  * Serialized {@link ISerializableValue} counterpart.
+ * @legacy
  * @alpha
  */
 export interface ISerializedValue {

package/src/localValues.ts

@@ -17,6 +17,7 @@ import type { ISerializableValue, ISerializedValue } from "./internalInterfaces.
 
 /**
  * A local value to be stored in a container type Distributed Data Store (DDS).
+ * @legacy
  * @alpha
  */
 export interface ILocalValue {
@@ -99,6 +100,7 @@ export class PlainLocalValue implements ILocalValue {
 /**
  * Enables a container type {@link https://fluidframework.com/docs/build/dds/ | DDS} to produce and store local
  * values with minimal awareness of how those objects are stored, serialized, and deserialized.
+ * @legacy
  * @alpha
  */
 export class LocalValueMaker {

package/src/mapFactory.ts

@@ -19,6 +19,7 @@ import { pkgVersion } from "./packageVersion.js";
  * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link ISharedMap}.
  *
  * @sealed
+ * @legacy
  * @alpha
  */
 export class MapFactory implements IChannelFactory<ISharedMap> {
@@ -78,12 +79,14 @@ export class MapFactory implements IChannelFactory<ISharedMap> {
 
 /**
  * Entrypoint for {@link ISharedMap} creation.
+ * @legacy
  * @alpha
  */
 export const SharedMap = createSharedObjectKind<ISharedMap>(MapFactory);
 
 /**
  * Entrypoint for {@link ISharedMap} creation.
+ * @legacy
  * @alpha
  * @privateRemarks
  * This alias is for legacy compat from when the SharedMap class was exported as public.

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/map";
-export const pkgVersion = "2.0.2";
+export const pkgVersion = "2.1.0-276326";