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

package/lib/map-alpha.d.ts

@@ -32,7 +32,7 @@ import { SharedObject } from '@fluidframework/shared-object-base';
  * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link SharedDirectory}.
  *
  * @sealed
- * @public
+ * @alpha
  */
 export declare class DirectoryFactory implements IChannelFactory {
     /**
@@ -63,8 +63,7 @@ export declare class DirectoryFactory implements IChannelFactory {
 
 /**
  * Create info for the subdirectory.
- *
- * @public
+ * @alpha
  */
 export declare interface ICreateInfo {
     /**
@@ -81,8 +80,7 @@ export declare interface ICreateInfo {
  * Interface describing actions on a directory.
  *
  * @remarks When used as a Map, operates on its keys.
- *
- * @public
+ * @alpha
  */
 export declare interface IDirectory extends Map<string, any>, IEventProvider<IDirectoryEvents>, Partial<IDisposable> {
     /**
@@ -147,8 +145,7 @@ export declare interface IDirectory extends Map<string, any>, IEventProvider<IDi
 
 /**
  * Operation indicating the directory should be cleared.
- *
- * @public
+ * @alpha
  */
 export declare interface IDirectoryClearOperation {
     /**
@@ -163,8 +160,7 @@ export declare interface IDirectoryClearOperation {
 
 /**
  * Operation indicating a subdirectory should be created.
- *
- * @public
+ * @alpha
  */
 export declare interface IDirectoryCreateSubDirectoryOperation {
     /**
@@ -188,8 +184,7 @@ export declare interface IDirectoryCreateSubDirectoryOperation {
  * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
  * | JSON.stringify}, direct result from
  * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse | JSON.parse}.
- *
- * @public
+ * @alpha
  */
 export declare interface IDirectoryDataObject {
     /**
@@ -216,8 +211,7 @@ export declare interface IDirectoryDataObject {
 
 /**
  * Operation indicating a key should be deleted from the directory.
- *
- * @public
+ * @alpha
  */
 export declare interface IDirectoryDeleteOperation {
     /**
@@ -236,8 +230,7 @@ export declare interface IDirectoryDeleteOperation {
 
 /**
  * Operation indicating a subdirectory should be deleted.
- *
- * @public
+ * @alpha
  */
 export declare interface IDirectoryDeleteSubDirectoryOperation {
     /**
@@ -256,8 +249,7 @@ export declare interface IDirectoryDeleteSubDirectoryOperation {
 
 /**
  * Events emitted in response to changes to the directory data.
- *
- * @public
+ * @alpha
  */
 export declare interface IDirectoryEvents extends IEvent {
     /**
@@ -323,8 +315,7 @@ export declare interface IDirectoryEvents extends IEvent {
 
 /**
  * An operation on a specific key within a directory.
- *
- * @public
+ * @alpha
  */
 export declare type IDirectoryKeyOperation = IDirectorySetOperation | IDirectoryDeleteOperation;
 
@@ -332,15 +323,13 @@ export declare type IDirectoryKeyOperation = IDirectorySetOperation | IDirectory
 
 /**
  * Any operation on a directory.
- *
- * @public
+ * @alpha
  */
 export declare type IDirectoryOperation = IDirectoryStorageOperation | IDirectorySubDirectoryOperation;
 
 /**
  * Operation indicating a value should be set for a key.
- *
- * @public
+ * @alpha
  */
 export declare interface IDirectorySetOperation {
     /**
@@ -363,22 +352,19 @@ export declare interface IDirectorySetOperation {
 
 /**
  * An operation on one or more of the keys within a directory.
- *
- * @public
+ * @alpha
  */
 export declare type IDirectoryStorageOperation = IDirectoryKeyOperation | IDirectoryClearOperation;
 
 /**
  * An operation on the subdirectories within a directory.
- *
- * @public
+ * @alpha
  */
 export declare type IDirectorySubDirectoryOperation = IDirectoryCreateSubDirectoryOperation | IDirectoryDeleteSubDirectoryOperation;
 
 /**
  * Type of "valueChanged" event parameter for {@link ISharedDirectory}.
- *
- * @public
+ * @alpha
  */
 export declare interface IDirectoryValueChanged extends IValueChanged {
     /**
@@ -389,8 +375,7 @@ export declare interface IDirectoryValueChanged extends IValueChanged {
 
 /**
  * A local value to be stored in a container type Distributed Data Store (DDS).
- *
- * @public
+ * @alpha
  */
 export declare interface ILocalValue {
     /**
@@ -432,8 +417,7 @@ export declare interface ILocalValue {
  * channel ID.
  *
  * @deprecated This type is legacy and deprecated.
- *
- * @public
+ * @alpha
  */
 export declare interface ISerializableValue {
     /**
@@ -448,8 +432,7 @@ export declare interface ISerializableValue {
 
 /**
  * Serialized {@link ISerializableValue} counterpart.
- *
- * @public
+ * @alpha
  */
 export declare interface ISerializedValue {
     /**
@@ -468,8 +451,7 @@ export declare interface ISerializedValue {
  * 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 declare interface ISharedDirectory extends ISharedObject<ISharedDirectoryEvents & IDirectoryEvents>, Omit<IDirectory, "on" | "once" | "off"> {
     [Symbol.iterator](): IterableIterator<[string, any]>;
@@ -481,8 +463,7 @@ export declare interface ISharedDirectory extends ISharedObject<ISharedDirectory
  *
  * @remarks
  * These events only emit on the {@link ISharedDirectory} itself, and not on subdirectories.
- *
- * @public
+ * @alpha
  */
 export declare interface ISharedDirectoryEvents extends ISharedObjectEvents {
     /**
@@ -545,8 +526,7 @@ export declare interface ISharedDirectoryEvents extends ISharedObjectEvents {
  * {@link @fluidframework/datastore#FluidObjectHandle}.
  *
  * For more information, including example usages, see {@link https://fluidframework.com/docs/data-structures/map/}.
- *
- * @public
+ * @alpha
  */
 export declare interface ISharedMap extends ISharedObject<ISharedMapEvents>, Map<string, any> {
     /**
@@ -566,8 +546,7 @@ export declare interface ISharedMap extends ISharedObject<ISharedMapEvents>, Map
 
 /**
  * Events emitted in response to changes to the {@link ISharedMap | map} data.
- *
- * @public
+ * @alpha
  */
 export declare interface ISharedMapEvents extends ISharedObjectEvents {
     /**
@@ -596,8 +575,7 @@ export declare interface ISharedMapEvents extends ISharedObjectEvents {
 
 /**
  * Type of "valueChanged" event parameter.
- *
- * @public
+ * @alpha
  */
 export declare interface IValueChanged {
     /**
@@ -613,8 +591,7 @@ export declare interface IValueChanged {
 /**
  * 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 declare class LocalValueMaker {
     private readonly serializer;
@@ -640,7 +617,7 @@ export declare class LocalValueMaker {
  * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link SharedMap}.
  *
  * @sealed
- * @public
+ * @alpha
  */
 export declare class MapFactory implements IChannelFactory {
     /**
@@ -681,7 +658,7 @@ export declare class MapFactory implements IChannelFactory {
  * ```
  *
  * @sealed
- * @public
+ * @alpha
  */
 export declare class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implements ISharedDirectory {
     /**
@@ -706,7 +683,8 @@ export declare class SharedDirectory extends SharedObject<ISharedDirectoryEvents
      * {@inheritDoc IDirectory.absolutePath}
      */
     get absolutePath(): string;
-    /* Excluded from this release type: localValueMaker */
+    /***/
+    readonly localValueMaker: LocalValueMaker;
     /**
      * Root of the SharedDirectory, most operations on the SharedDirectory itself act on the root.
      */
@@ -806,14 +784,42 @@ export declare class SharedDirectory extends SharedObject<ISharedDirectoryEvents
      * {@inheritDoc IDirectory.getWorkingDirectory}
      */
     getWorkingDirectory(relativePath: string): IDirectory | undefined;
-    /* Excluded from this release type: summarizeCore */
-    /* Excluded from this release type: submitDirectoryMessage */
-    /* Excluded from this release type: onDisconnect */
-    /* Excluded from this release type: reSubmitCore */
-    /* Excluded from this release type: loadCore */
-    /* Excluded from this release type: populate */
-    /* Excluded from this release type: processCore */
-    /* Excluded from this release type: rollback */
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
+     */
+    protected summarizeCore(serializer: IFluidSerializer, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
+    /**
+     * Submits an operation
+     * @param op - Op to submit
+     * @param localOpMetadata - The local metadata associated with the op. We send a unique id that is used to track
+     * this op while it has not been ack'd. This will be sent when we receive this op back from the server.
+     */
+    submitDirectoryMessage(op: IDirectoryOperation, localOpMetadata: unknown): void;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
+     */
+    protected onDisconnect(): void;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.reSubmitCore}
+     */
+    protected reSubmitCore(content: unknown, localOpMetadata: unknown): void;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
+     */
+    protected loadCore(storage: IChannelStorageService): Promise<void>;
+    /**
+     * Populate the directory with the given directory data.
+     * @param data - A JSON string containing serialized directory data
+     */
+    protected populate(data: IDirectoryDataObject): void;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}
+     */
+    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.rollback}
+     */
+    protected rollback(content: unknown, localOpMetadata: unknown): void;
     /**
      * Converts the given relative path to absolute against the root.
      * @param relativePath - The path to convert
@@ -840,14 +846,16 @@ export declare class SharedDirectory extends SharedObject<ISharedDirectoryEvents
      * Set the message handlers for the directory.
      */
     private setMessageHandlers;
-    /* Excluded from this release type: applyStashedOp */
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
+     */
+    protected applyStashedOp(op: unknown): unknown;
     private serializeDirectory;
 }
 
 /**
  * {@inheritDoc ISharedMap}
- *
- * @public
+ * @alpha
  */
 export declare class SharedMap extends SharedObject<ISharedMapEvents> implements ISharedMap {
     /**
@@ -938,13 +946,34 @@ export declare class SharedMap extends SharedObject<ISharedMapEvents> implements
      * Clear all data from the map.
      */
     clear(): void;
-    /* Excluded from this release type: summarizeCore */
-    /* Excluded from this release type: loadCore */
-    /* Excluded from this release type: onDisconnect */
-    /* Excluded from this release type: reSubmitCore */
-    /* Excluded from this release type: applyStashedOp */
-    /* Excluded from this release type: processCore */
-    /* Excluded from this release type: rollback */
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.summarizeCore}
+     */
+    protected summarizeCore(serializer: IFluidSerializer, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
+     */
+    protected loadCore(storage: IChannelStorageService): Promise<void>;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.onDisconnect}
+     */
+    protected onDisconnect(): void;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.reSubmitCore}
+     */
+    protected reSubmitCore(content: unknown, localOpMetadata: unknown): void;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
+     */
+    protected applyStashedOp(content: unknown): unknown;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}
+     */
+    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.rollback}
+     */
+    protected rollback(content: unknown, localOpMetadata: unknown): void;
 }
 
 export { }