@fluidframework/map 2.0.0-internal.7.3.0 → 2.0.0-internal.7.4.0

package/src/interfaces.ts

@@ -13,8 +13,7 @@ import {
 
 /**
  * Type of "valueChanged" event parameter.
- *
- * @public
+ * @alpha
  */
 export interface IValueChanged {
 	/**
@@ -34,8 +33,7 @@ export interface IValueChanged {
  * Interface describing actions on a directory.
  *
  * @remarks When used as a Map, operates on its keys.
- *
- * @public
+ * @alpha
  */
 // TODO: Use `unknown` instead (breaking change).
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -119,8 +117,7 @@ export interface IDirectory
  *
  * @remarks
  * These events only emit on the {@link ISharedDirectory} itself, and not on subdirectories.
- *
- * @public
+ * @alpha
  */
 export interface ISharedDirectoryEvents extends ISharedObjectEvents {
 	/**
@@ -193,8 +190,7 @@ export interface ISharedDirectoryEvents extends ISharedObjectEvents {
 
 /**
  * Events emitted in response to changes to the directory data.
- *
- * @public
+ * @alpha
  */
 export interface IDirectoryEvents extends IEvent {
 	/**
@@ -275,8 +271,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.
- *
- * @public
+ * @alpha
  */
 export interface ISharedDirectory
 	extends ISharedObject<ISharedDirectoryEvents & IDirectoryEvents>,
@@ -291,8 +286,7 @@ export interface ISharedDirectory
 
 /**
  * Type of "valueChanged" event parameter for {@link ISharedDirectory}.
- *
- * @public
+ * @alpha
  */
 export interface IDirectoryValueChanged extends IValueChanged {
 	/**
@@ -303,8 +297,7 @@ export interface IDirectoryValueChanged extends IValueChanged {
 
 /**
  * Events emitted in response to changes to the {@link ISharedMap | map} data.
- *
- * @public
+ * @alpha
  */
 export interface ISharedMapEvents extends ISharedObjectEvents {
 	/**
@@ -343,8 +336,7 @@ 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
+ * @alpha
  */
 // TODO: Use `unknown` instead (breaking change).
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -389,8 +381,7 @@ export interface ISharedMap extends ISharedObject<ISharedMapEvents>, Map<string,
  * channel ID.
  *
  * @deprecated This type is legacy and deprecated.
- *
- * @public
+ * @alpha
  */
 export interface ISerializableValue {
 	/**
@@ -407,8 +398,7 @@ export interface ISerializableValue {
 
 /**
  * Serialized {@link ISerializableValue} counterpart.
- *
- * @public
+ * @alpha
  */
 export interface ISerializedValue {
 	/**

package/src/localValues.ts

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

package/src/map.ts

@@ -30,7 +30,7 @@ const snapshotFileName = "header";
  * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link SharedMap}.
  *
  * @sealed
- * @public
+ * @alpha
  */
 export class MapFactory implements IChannelFactory {
 	/**
@@ -89,8 +89,7 @@ export class MapFactory implements IChannelFactory {
 
 /**
  * {@inheritDoc ISharedMap}
- *
- * @public
+ * @alpha
  */
 export class SharedMap extends SharedObject<ISharedMapEvents> implements ISharedMap {
 	/**
@@ -250,7 +249,6 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
-	 * @internal
 	 */
 	protected summarizeCore(
 		serializer: IFluidSerializer,
@@ -330,7 +328,6 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
-	 * @internal
 	 */
 	protected async loadCore(storage: IChannelStorageService): Promise<void> {
 		const json = await readAndParse<object>(storage, snapshotFileName);
@@ -350,13 +347,11 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
-	 * @internal
 	 */
 	protected onDisconnect(): void {}
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.reSubmitCore}
-	 * @internal
 	 */
 	protected reSubmitCore(content: unknown, localOpMetadata: unknown): void {
 		this.kernel.trySubmitMessage(content as IMapOperation, localOpMetadata);
@@ -364,7 +359,6 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
-	 * @internal
 	 */
 	protected applyStashedOp(content: unknown): unknown {
 		return this.kernel.tryApplyStashedOp(content as IMapOperation);
@@ -372,7 +366,6 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}
-	 * @internal
 	 */
 	protected processCore(
 		message: ISequencedDocumentMessage,
@@ -390,7 +383,6 @@ export class SharedMap extends SharedObject<ISharedMapEvents> implements IShared
 
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.rollback}
-	 * @internal
 	 */
 	protected rollback(content: unknown, localOpMetadata: unknown): void {
 		this.kernel.rollback(content, localOpMetadata);

package/src/packageVersion.ts

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