@fluidframework/map 2.0.0-internal.7.1.1 → 2.0.0-internal.7.2.1

package/src/interfaces.ts

@@ -13,6 +13,8 @@ import {
 
 /**
  * Type of "valueChanged" event parameter.
+ *
+ * @public
  */
 export interface IValueChanged {
 	/**
@@ -32,6 +34,8 @@ export interface IValueChanged {
  * Interface describing actions on a directory.
  *
  * @remarks When used as a Map, operates on its keys.
+ *
+ * @public
  */
 // TODO: Use `unknown` instead (breaking change).
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -112,7 +116,11 @@ export interface IDirectory
 
 /**
  * Events emitted in response to changes to the directory data.
+ *
+ * @remarks
  * These events only emit on the {@link ISharedDirectory} itself, and not on subdirectories.
+ *
+ * @public
  */
 export interface ISharedDirectoryEvents extends ISharedObjectEvents {
 	/**
@@ -185,6 +193,8 @@ export interface ISharedDirectoryEvents extends ISharedObjectEvents {
 
 /**
  * Events emitted in response to changes to the directory data.
+ *
+ * @public
  */
 export interface IDirectoryEvents extends IEvent {
 	/**
@@ -265,6 +275,8 @@ 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.
+ *
+ * @public
  */
 export interface ISharedDirectory
 	extends ISharedObject<ISharedDirectoryEvents & IDirectoryEvents>,
@@ -278,7 +290,9 @@ export interface ISharedDirectory
 }
 
 /**
- * Type of "valueChanged" event parameter for {@link ISharedDirectory}
+ * Type of "valueChanged" event parameter for {@link ISharedDirectory}.
+ *
+ * @public
  */
 export interface IDirectoryValueChanged extends IValueChanged {
 	/**
@@ -289,6 +303,8 @@ export interface IDirectoryValueChanged extends IValueChanged {
 
 /**
  * Events emitted in response to changes to the {@link ISharedMap | map} data.
+ *
+ * @public
  */
 export interface ISharedMapEvents extends ISharedObjectEvents {
 	/**
@@ -327,6 +343,8 @@ export interface ISharedMapEvents extends ISharedObjectEvents {
  * {@link @fluidframework/datastore#FluidObjectHandle}.
  *
  * For more information, including example usages, see {@link https://fluidframework.com/docs/data-structures/map/}.
+ *
+ * @public
  */
 // TODO: Use `unknown` instead (breaking change).
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -371,6 +389,8 @@ export interface ISharedMap extends ISharedObject<ISharedMapEvents>, Map<string,
  * channel ID.
  *
  * @deprecated This type is legacy and deprecated.
+ *
+ * @public
  */
 export interface ISerializableValue {
 	/**
@@ -387,6 +407,8 @@ export interface ISerializableValue {
 
 /**
  * Serialized {@link ISerializableValue} counterpart.
+ *
+ * @public
  */
 export interface ISerializedValue {
 	/**

package/src/localValues.ts

@@ -16,6 +16,8 @@ import { ISerializableValue, ISerializedValue } from "./interfaces";
 
 /**
  * A local value to be stored in a container type Distributed Data Store (DDS).
+ *
+ * @public
  */
 export interface ILocalValue {
 	/**
@@ -97,6 +99,8 @@ 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.
+ *
+ * @public
  */
 export class LocalValueMaker {
 	/**

package/src/map.ts

@@ -30,6 +30,7 @@ const snapshotFileName = "header";
  * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link SharedMap}.
  *
  * @sealed
+ * @public
  */
 export class MapFactory implements IChannelFactory {
 	/**
@@ -88,6 +89,8 @@ export class MapFactory implements IChannelFactory {
 
 /**
  * {@inheritDoc ISharedMap}
+ *
+ * @public
  */
 export class SharedMap extends SharedObject<ISharedMapEvents> implements ISharedMap {
 	/**

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/map";
-export const pkgVersion = "2.0.0-internal.7.1.1";
+export const pkgVersion = "2.0.0-internal.7.2.1";