@fluid-experimental/pact-map 2.0.0-dev.7.4.0.215747 → 2.0.0-dev.7.4.0.216897

package/api-extractor-lint.json

@@ -0,0 +1,13 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-lint.json",
+	"messages": {
+		"extractorMessageReporting": {
+			// TODO: remove once base config has this enabled as an error
+			"ae-incompatible-release-tags": {
+				"logLevel": "error",
+				"addToApiReportFile": false
+			}
+		}
+	}
+}

package/api-report/pact-map.api.md

@@ -15,13 +15,13 @@ import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
 import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
 import { SharedObject } from '@fluidframework/shared-object-base';
 
-// @public
+// @internal
 export interface IAcceptedPact<T> {
     acceptedSequenceNumber: number;
     value: T | undefined;
 }
 
-// @public
+// @internal
 export interface IPactMap<T = unknown> extends ISharedObject<IPactMapEvents> {
     delete(key: string): void;
     get(key: string): T | undefined;
@@ -31,12 +31,12 @@ export interface IPactMap<T = unknown> extends ISharedObject<IPactMapEvents> {
     set(key: string, value: T | undefined): void;
 }
 
-// @public
+// @internal
 export interface IPactMapEvents extends ISharedObjectEvents {
     (event: "pending" | "accepted", listener: (key: string) => void): any;
 }
 
-// @public
+// @internal
 export class PactMap<T = unknown> extends SharedObject<IPactMapEvents> implements IPactMap<T> {
     constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
     // (undocumented)
@@ -47,19 +47,17 @@ export class PactMap<T = unknown> extends SharedObject<IPactMapEvents> implement
     static getFactory(): IChannelFactory;
     getPending(key: string): T | undefined;
     getWithDetails(key: string): IAcceptedPact<T> | undefined;
-    // @internal (undocumented)
+    // (undocumented)
     protected initializeLocalCore(): void;
     isPending(key: string): boolean;
-    // @internal (undocumented)
+    // (undocumented)
     protected loadCore(storage: IChannelStorageService): Promise<void>;
-    // @internal (undocumented)
+    // (undocumented)
     protected onDisconnect(): void;
-    // @internal
     protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
-    // @internal (undocumented)
+    // (undocumented)
     protected reSubmitCore(content: unknown, localOpMetadata: unknown): void;
     set(key: string, value: T | undefined): void;
-    // @internal
     protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
 }
 

package/dist/interfaces.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.cjs","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { type ISharedObject, type ISharedObjectEvents } from \"@fluidframework/shared-object-base\";\n\n/**\n * Events emitted by {@link IPactMap}.\n *\n * @public\n */\nexport interface IPactMapEvents extends ISharedObjectEvents {\n\t/**\n\t * Notifies when a new value goes pending or has been accepted.\n\t */\n\t(event: \"pending\" | \"accepted\", listener: (key: string) => void);\n}\n\n/**\n * Details of the accepted pact.\n *\n * @public\n */\nexport interface IAcceptedPact<T> {\n\t/**\n\t * The accepted value of the given type or undefined (typically in case of delete).\n\t */\n\tvalue: T | undefined;\n\n\t/**\n\t * The sequence number when the value was accepted.\n\t *\n\t * For values set in detached state, it will be 0.\n\t */\n\tacceptedSequenceNumber: number;\n}\n\n/**\n * An IPactMap is a key-value storage, in which setting a value is done via a proposal system.  All collaborators\n * who were connected at the time of the proposal must accept the change before it is considered accepted (or, if\n * those clients disconnect they are considered to have implicitly accepted).  As a result, the value goes through\n * two phases:\n * 1. \"pending\" state where the proposal has been sequenced, but there are still outstanding acceptances\n * 2. \"accepted\" state where all clients who were connected at the time the proposal was made have either accepted\n * or disconnected.\n *\n * @public\n */\nexport interface IPactMap<T = unknown> extends ISharedObject<IPactMapEvents> {\n\t/**\n\t * Gets the accepted value for the given key.\n\t * @param key - The key to retrieve from\n\t */\n\tget(key: string): T | undefined;\n\n\t/**\n\t * Gets the accepted value and details for the given key.\n\t * @param key - The key to retrieve from\n\t */\n\tgetWithDetails(key: string): IAcceptedPact<T> | undefined;\n\n\t/**\n\t * Returns whether there is a pending value for the given key.  Can be used to distinguish a pending delete vs.\n\t * nothing pending when getPending would just return undefined.\n\t * @param key - The key to check\n\t */\n\tisPending(key: string): boolean;\n\n\t/**\n\t * Gets the pending value for the given key.\n\t * @param key - The key to retrieve from\n\t */\n\tgetPending(key: string): T | undefined;\n\n\t/**\n\t * Sets the value for the given key.  After setting the value, it will be in \"pending\" state until all connected\n\t * clients have approved the change.  The accepted value remains unchanged until that time.\n\t * @param key - The key to set\n\t * @param value - The value to store\n\t */\n\tset(key: string, value: T | undefined): void;\n\n\t/**\n\t * Deletes the key/value pair at the given key.  After issuing the delete, the delete is in \"pending\" state until\n\t * all connected clients have approved the delete.  The accepted value remains unchanged until that time.\n\t * @param key - the key to delete\n\t */\n\tdelete(key: string): void;\n}\n"]}
+{"version":3,"file":"interfaces.cjs","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { type ISharedObject, type ISharedObjectEvents } from \"@fluidframework/shared-object-base\";\n\n/**\n * Events emitted by {@link IPactMap}.\n * @internal\n */\nexport interface IPactMapEvents extends ISharedObjectEvents {\n\t/**\n\t * Notifies when a new value goes pending or has been accepted.\n\t */\n\t(event: \"pending\" | \"accepted\", listener: (key: string) => void);\n}\n\n/**\n * Details of the accepted pact.\n * @internal\n */\nexport interface IAcceptedPact<T> {\n\t/**\n\t * The accepted value of the given type or undefined (typically in case of delete).\n\t */\n\tvalue: T | undefined;\n\n\t/**\n\t * The sequence number when the value was accepted.\n\t *\n\t * For values set in detached state, it will be 0.\n\t */\n\tacceptedSequenceNumber: number;\n}\n\n/**\n * An IPactMap is a key-value storage, in which setting a value is done via a proposal system.  All collaborators\n * who were connected at the time of the proposal must accept the change before it is considered accepted (or, if\n * those clients disconnect they are considered to have implicitly accepted).  As a result, the value goes through\n * two phases:\n * 1. \"pending\" state where the proposal has been sequenced, but there are still outstanding acceptances\n * 2. \"accepted\" state where all clients who were connected at the time the proposal was made have either accepted\n * or disconnected.\n * @internal\n */\nexport interface IPactMap<T = unknown> extends ISharedObject<IPactMapEvents> {\n\t/**\n\t * Gets the accepted value for the given key.\n\t * @param key - The key to retrieve from\n\t */\n\tget(key: string): T | undefined;\n\n\t/**\n\t * Gets the accepted value and details for the given key.\n\t * @param key - The key to retrieve from\n\t */\n\tgetWithDetails(key: string): IAcceptedPact<T> | undefined;\n\n\t/**\n\t * Returns whether there is a pending value for the given key.  Can be used to distinguish a pending delete vs.\n\t * nothing pending when getPending would just return undefined.\n\t * @param key - The key to check\n\t */\n\tisPending(key: string): boolean;\n\n\t/**\n\t * Gets the pending value for the given key.\n\t * @param key - The key to retrieve from\n\t */\n\tgetPending(key: string): T | undefined;\n\n\t/**\n\t * Sets the value for the given key.  After setting the value, it will be in \"pending\" state until all connected\n\t * clients have approved the change.  The accepted value remains unchanged until that time.\n\t * @param key - The key to set\n\t * @param value - The value to store\n\t */\n\tset(key: string, value: T | undefined): void;\n\n\t/**\n\t * Deletes the key/value pair at the given key.  After issuing the delete, the delete is in \"pending\" state until\n\t * all connected clients have approved the delete.  The accepted value remains unchanged until that time.\n\t * @param key - the key to delete\n\t */\n\tdelete(key: string): void;\n}\n"]}

package/dist/interfaces.d.ts

@@ -5,8 +5,7 @@
 import { type ISharedObject, type ISharedObjectEvents } from "@fluidframework/shared-object-base";
 /**
  * Events emitted by {@link IPactMap}.
- *
- * @public
+ * @internal
  */
 export interface IPactMapEvents extends ISharedObjectEvents {
     /**
@@ -16,8 +15,7 @@ export interface IPactMapEvents extends ISharedObjectEvents {
 }
 /**
  * Details of the accepted pact.
- *
- * @public
+ * @internal
  */
 export interface IAcceptedPact<T> {
     /**
@@ -39,8 +37,7 @@ export interface IAcceptedPact<T> {
  * 1. "pending" state where the proposal has been sequenced, but there are still outstanding acceptances
  * 2. "accepted" state where all clients who were connected at the time the proposal was made have either accepted
  * or disconnected.
- *
- * @public
+ * @internal
  */
 export interface IPactMap<T = unknown> extends ISharedObject<IPactMapEvents> {
     /**

package/dist/interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAElG;;;;GAIG;AACH,MAAM,WAAW,cAAe,SAAQ,mBAAmB;IAC1D;;OAEG;IACH,CAAC,KAAK,EAAE,SAAS,GAAG,UAAU,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,OAAE;CACjE;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAC/B;;OAEG;IACH,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC;IAErB;;;;OAIG;IACH,sBAAsB,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,aAAa,CAAC,cAAc,CAAC;IAC3E;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC;IAEhC;;;OAGG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IAE1D;;;;OAIG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAEhC;;;OAGG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC;IAEvC;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC;IAE7C;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAElG;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,mBAAmB;IAC1D;;OAEG;IACH,CAAC,KAAK,EAAE,SAAS,GAAG,UAAU,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,OAAE;CACjE;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAC/B;;OAEG;IACH,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC;IAErB;;;;OAIG;IACH,sBAAsB,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,aAAa,CAAC,cAAc,CAAC;IAC3E;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC;IAEhC;;;OAGG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IAE1D;;;;OAIG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAEhC;;;OAGG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC;IAEvC;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC;IAE7C;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B"}

package/dist/packageVersion.cjs

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluid-experimental/pact-map";
-exports.pkgVersion = "2.0.0-dev.7.4.0.215747";
+exports.pkgVersion = "2.0.0-dev.7.4.0.216897";
 //# sourceMappingURL=packageVersion.cjs.map

package/dist/packageVersion.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.cjs","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,8BAA8B,CAAC;AACzC,QAAA,UAAU,GAAG,wBAAwB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluid-experimental/pact-map\";\nexport const pkgVersion = \"2.0.0-dev.7.4.0.215747\";\n"]}
+{"version":3,"file":"packageVersion.cjs","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,8BAA8B,CAAC;AACzC,QAAA,UAAU,GAAG,wBAAwB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluid-experimental/pact-map\";\nexport const pkgVersion = \"2.0.0-dev.7.4.0.216897\";\n"]}

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluid-experimental/pact-map";
-export declare const pkgVersion = "2.0.0-dev.7.4.0.215747";
+export declare const pkgVersion = "2.0.0-dev.7.4.0.216897";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/pact-map-alpha.d.ts

@@ -1,218 +1,29 @@
-import { IChannelAttributes } from '@fluidframework/datastore-definitions';
-import { IChannelFactory } from '@fluidframework/datastore-definitions';
-import { IChannelStorageService } from '@fluidframework/datastore-definitions';
-import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
-import { IFluidSerializer } from '@fluidframework/shared-object-base';
 import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISharedObject } from '@fluidframework/shared-object-base';
-import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
-import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
-import { SharedObject } from '@fluidframework/shared-object-base';
 
-/**
- * Details of the accepted pact.
- *
- * @public
- */
-export declare interface IAcceptedPact<T> {
-    /**
-     * The accepted value of the given type or undefined (typically in case of delete).
-     */
-    value: T | undefined;
-    /**
-     * The sequence number when the value was accepted.
-     *
-     * For values set in detached state, it will be 0.
-     */
-    acceptedSequenceNumber: number;
-}
+/* Excluded from this release type: IAcceptedPact */
 
-/**
- * An IPactMap is a key-value storage, in which setting a value is done via a proposal system.  All collaborators
- * who were connected at the time of the proposal must accept the change before it is considered accepted (or, if
- * those clients disconnect they are considered to have implicitly accepted).  As a result, the value goes through
- * two phases:
- * 1. "pending" state where the proposal has been sequenced, but there are still outstanding acceptances
- * 2. "accepted" state where all clients who were connected at the time the proposal was made have either accepted
- * or disconnected.
- *
- * @public
- */
-export declare interface IPactMap<T = unknown> extends ISharedObject<IPactMapEvents> {
-    /**
-     * Gets the accepted value for the given key.
-     * @param key - The key to retrieve from
-     */
-    get(key: string): T | undefined;
-    /**
-     * Gets the accepted value and details for the given key.
-     * @param key - The key to retrieve from
-     */
-    getWithDetails(key: string): IAcceptedPact<T> | undefined;
-    /**
-     * Returns whether there is a pending value for the given key.  Can be used to distinguish a pending delete vs.
-     * nothing pending when getPending would just return undefined.
-     * @param key - The key to check
-     */
-    isPending(key: string): boolean;
-    /**
-     * Gets the pending value for the given key.
-     * @param key - The key to retrieve from
-     */
-    getPending(key: string): T | undefined;
-    /**
-     * Sets the value for the given key.  After setting the value, it will be in "pending" state until all connected
-     * clients have approved the change.  The accepted value remains unchanged until that time.
-     * @param key - The key to set
-     * @param value - The value to store
-     */
-    set(key: string, value: T | undefined): void;
-    /**
-     * Deletes the key/value pair at the given key.  After issuing the delete, the delete is in "pending" state until
-     * all connected clients have approved the delete.  The accepted value remains unchanged until that time.
-     * @param key - the key to delete
-     */
-    delete(key: string): void;
-}
+/* Excluded from this release type: IChannelAttributes */
 
-/**
- * Events emitted by {@link IPactMap}.
- *
- * @public
- */
-export declare interface IPactMapEvents extends ISharedObjectEvents {
-    /**
-     * Notifies when a new value goes pending or has been accepted.
-     */
-    (event: "pending" | "accepted", listener: (key: string) => void): any;
-}
+/* Excluded from this release type: IChannelFactory */
 
-/**
- * The PactMap distributed data structure provides key/value storage with a cautious conflict resolution strategy.
- * This strategy optimizes for all clients being aware of the change prior to considering the value as accepted.
- *
- * It is still experimental and under development.  Please do try it out, but expect breaking changes in the future.
- *
- * @remarks
- * ### Creation
- *
- * To create a `PactMap`, call the static create method:
- *
- * ```typescript
- * const pactMap = PactMap.create(this.runtime, id);
- * ```
- *
- * ### Usage
- *
- * Setting and reading values is somewhat similar to a `SharedMap`.  However, because the acceptance strategy
- * cannot be resolved until other clients have witnessed the set, the new value will only be reflected in the data
- * after the consensus is reached.
- *
- * ```typescript
- * pactMap.on("pending", (key: string) => {
- *     console.log(pactMap.getPending(key));
- * });
- * pactMap.on("accepted", (key: string) => {
- *     console.log(pactMap.get(key));
- * });
- * pactMap.set("myKey", "myValue");
- *
- * // Reading from the pact map prior to the async operation's completion will still return the old value.
- * console.log(pactMap.get("myKey"));
- * ```
- *
- * The acceptance process has two stages.  When an op indicating a client's attempt to set a value is sequenced,
- * we first verify that it was set with knowledge of the most recently accepted value (consensus-like FWW).  If it
- * meets this bar, then the value is "pending".  During this time, clients may observe the pending value and act
- * upon it, but should be aware that not all other clients may have witnessed the value yet.  Once all clients
- * that were connected at the time of the value being set have explicitly acknowledged the new value, the value
- * becomes "accepted".  Once the value is accepted, it once again becomes possible to set the value, again with
- * consensus-like FWW resolution.
- *
- * Since all connected clients must explicitly accept the new value, it is important that all connected clients
- * have the PactMap loaded, including e.g. the summarizing client.  Otherwise, those clients who have not loaded
- * the PactMap will not be responding to proposals and delay their acceptance (until they disconnect, which implicitly
- * removes them from consideration).  The easiest way to ensure all clients load the PactMap is to instantiate it
- * as part of instantiating the IRuntime for the container (containerHasInitialized if using Aqueduct).
- *
- * ### Eventing
- *
- * `PactMap` is an `EventEmitter`, and will emit events when a new value is accepted for a key.
- *
- * ```typescript
- * pactMap.on("accept", (key: string) => {
- *     console.log(`New value was accepted for key: ${ key }, value: ${ pactMap.get(key) }`);
- * });
- * ```
- *
- * @public
- */
-export declare class PactMap<T = unknown> extends SharedObject<IPactMapEvents> implements IPactMap<T> {
-    /**
-     * Create a new PactMap
-     *
-     * @param runtime - data store runtime the new PactMap belongs to
-     * @param id - optional name of the PactMap
-     * @returns newly created PactMap (but not attached yet)
-     */
-    static create(runtime: IFluidDataStoreRuntime, id?: string): PactMap;
-    /**
-     * Get a factory for PactMap to register with the data store.
-     *
-     * @returns a factory that creates and loads PactMaps
-     */
-    static getFactory(): IChannelFactory;
-    private readonly values;
-    private readonly incomingOp;
-    /**
-     * Constructs a new PactMap. If the object is non-local an id and service interfaces will
-     * be provided
-     *
-     * @param runtime - data store runtime the PactMap belongs to
-     * @param id - optional name of the PactMap
-     */
-    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
-    /**
-     * {@inheritDoc IPactMap.get}
-     */
-    get(key: string): T | undefined;
-    /**
-     * {@inheritDoc IPactMap.getWithDetails}
-     */
-    getWithDetails(key: string): IAcceptedPact<T> | undefined;
-    /**
-     * {@inheritDoc IPactMap.isPending}
-     */
-    isPending(key: string): boolean;
-    /**
-     * {@inheritDoc IPactMap.getPending}
-     */
-    getPending(key: string): T | undefined;
-    /**
-     * {@inheritDoc IPactMap.set}
-     */
-    set(key: string, value: T | undefined): void;
-    /**
-     * {@inheritDoc IPactMap.delete}
-     */
-    delete(key: string): void;
-    /**
-     * Get a point-in-time list of clients who must sign off on values coming in for them to move from "pending" to
-     * "accepted" state.  This list is finalized for a value at the moment it goes pending (i.e. if more clients
-     * join later, they are not added to the list of signoffs).
-     * @returns The list of clientIds for clients who must sign off to accept the incoming pending value
-     */
-    private getSignoffClients;
-    private readonly handleIncomingSet;
-    private readonly handleIncomingAccept;
-    private readonly handleQuorumRemoveMember;
-    /* Excluded from this release type: summarizeCore */
-    /* Excluded from this release type: loadCore */
-    /* Excluded from this release type: initializeLocalCore */
-    /* Excluded from this release type: onDisconnect */
-    /* Excluded from this release type: reSubmitCore */
-    /* Excluded from this release type: processCore */
-    applyStashedOp(): void;
-}
+/* Excluded from this release type: IChannelStorageService */
+
+/* Excluded from this release type: IFluidDataStoreRuntime */
+
+/* Excluded from this release type: IFluidSerializer */
+
+/* Excluded from this release type: IPactMap */
+
+/* Excluded from this release type: IPactMapEvents */
+
+/* Excluded from this release type: ISharedObject */
+
+/* Excluded from this release type: ISharedObjectEvents */
+
+/* Excluded from this release type: ISummaryTreeWithStats */
+
+/* Excluded from this release type: PactMap */
+
+/* Excluded from this release type: SharedObject */
 
 export { }

package/dist/pact-map-beta.d.ts

@@ -1,218 +1,29 @@
-import { IChannelAttributes } from '@fluidframework/datastore-definitions';
-import { IChannelFactory } from '@fluidframework/datastore-definitions';
-import { IChannelStorageService } from '@fluidframework/datastore-definitions';
-import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
-import { IFluidSerializer } from '@fluidframework/shared-object-base';
 import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISharedObject } from '@fluidframework/shared-object-base';
-import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
-import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
-import { SharedObject } from '@fluidframework/shared-object-base';
 
-/**
- * Details of the accepted pact.
- *
- * @public
- */
-export declare interface IAcceptedPact<T> {
-    /**
-     * The accepted value of the given type or undefined (typically in case of delete).
-     */
-    value: T | undefined;
-    /**
-     * The sequence number when the value was accepted.
-     *
-     * For values set in detached state, it will be 0.
-     */
-    acceptedSequenceNumber: number;
-}
+/* Excluded from this release type: IAcceptedPact */
 
-/**
- * An IPactMap is a key-value storage, in which setting a value is done via a proposal system.  All collaborators
- * who were connected at the time of the proposal must accept the change before it is considered accepted (or, if
- * those clients disconnect they are considered to have implicitly accepted).  As a result, the value goes through
- * two phases:
- * 1. "pending" state where the proposal has been sequenced, but there are still outstanding acceptances
- * 2. "accepted" state where all clients who were connected at the time the proposal was made have either accepted
- * or disconnected.
- *
- * @public
- */
-export declare interface IPactMap<T = unknown> extends ISharedObject<IPactMapEvents> {
-    /**
-     * Gets the accepted value for the given key.
-     * @param key - The key to retrieve from
-     */
-    get(key: string): T | undefined;
-    /**
-     * Gets the accepted value and details for the given key.
-     * @param key - The key to retrieve from
-     */
-    getWithDetails(key: string): IAcceptedPact<T> | undefined;
-    /**
-     * Returns whether there is a pending value for the given key.  Can be used to distinguish a pending delete vs.
-     * nothing pending when getPending would just return undefined.
-     * @param key - The key to check
-     */
-    isPending(key: string): boolean;
-    /**
-     * Gets the pending value for the given key.
-     * @param key - The key to retrieve from
-     */
-    getPending(key: string): T | undefined;
-    /**
-     * Sets the value for the given key.  After setting the value, it will be in "pending" state until all connected
-     * clients have approved the change.  The accepted value remains unchanged until that time.
-     * @param key - The key to set
-     * @param value - The value to store
-     */
-    set(key: string, value: T | undefined): void;
-    /**
-     * Deletes the key/value pair at the given key.  After issuing the delete, the delete is in "pending" state until
-     * all connected clients have approved the delete.  The accepted value remains unchanged until that time.
-     * @param key - the key to delete
-     */
-    delete(key: string): void;
-}
+/* Excluded from this release type: IChannelAttributes */
 
-/**
- * Events emitted by {@link IPactMap}.
- *
- * @public
- */
-export declare interface IPactMapEvents extends ISharedObjectEvents {
-    /**
-     * Notifies when a new value goes pending or has been accepted.
-     */
-    (event: "pending" | "accepted", listener: (key: string) => void): any;
-}
+/* Excluded from this release type: IChannelFactory */
 
-/**
- * The PactMap distributed data structure provides key/value storage with a cautious conflict resolution strategy.
- * This strategy optimizes for all clients being aware of the change prior to considering the value as accepted.
- *
- * It is still experimental and under development.  Please do try it out, but expect breaking changes in the future.
- *
- * @remarks
- * ### Creation
- *
- * To create a `PactMap`, call the static create method:
- *
- * ```typescript
- * const pactMap = PactMap.create(this.runtime, id);
- * ```
- *
- * ### Usage
- *
- * Setting and reading values is somewhat similar to a `SharedMap`.  However, because the acceptance strategy
- * cannot be resolved until other clients have witnessed the set, the new value will only be reflected in the data
- * after the consensus is reached.
- *
- * ```typescript
- * pactMap.on("pending", (key: string) => {
- *     console.log(pactMap.getPending(key));
- * });
- * pactMap.on("accepted", (key: string) => {
- *     console.log(pactMap.get(key));
- * });
- * pactMap.set("myKey", "myValue");
- *
- * // Reading from the pact map prior to the async operation's completion will still return the old value.
- * console.log(pactMap.get("myKey"));
- * ```
- *
- * The acceptance process has two stages.  When an op indicating a client's attempt to set a value is sequenced,
- * we first verify that it was set with knowledge of the most recently accepted value (consensus-like FWW).  If it
- * meets this bar, then the value is "pending".  During this time, clients may observe the pending value and act
- * upon it, but should be aware that not all other clients may have witnessed the value yet.  Once all clients
- * that were connected at the time of the value being set have explicitly acknowledged the new value, the value
- * becomes "accepted".  Once the value is accepted, it once again becomes possible to set the value, again with
- * consensus-like FWW resolution.
- *
- * Since all connected clients must explicitly accept the new value, it is important that all connected clients
- * have the PactMap loaded, including e.g. the summarizing client.  Otherwise, those clients who have not loaded
- * the PactMap will not be responding to proposals and delay their acceptance (until they disconnect, which implicitly
- * removes them from consideration).  The easiest way to ensure all clients load the PactMap is to instantiate it
- * as part of instantiating the IRuntime for the container (containerHasInitialized if using Aqueduct).
- *
- * ### Eventing
- *
- * `PactMap` is an `EventEmitter`, and will emit events when a new value is accepted for a key.
- *
- * ```typescript
- * pactMap.on("accept", (key: string) => {
- *     console.log(`New value was accepted for key: ${ key }, value: ${ pactMap.get(key) }`);
- * });
- * ```
- *
- * @public
- */
-export declare class PactMap<T = unknown> extends SharedObject<IPactMapEvents> implements IPactMap<T> {
-    /**
-     * Create a new PactMap
-     *
-     * @param runtime - data store runtime the new PactMap belongs to
-     * @param id - optional name of the PactMap
-     * @returns newly created PactMap (but not attached yet)
-     */
-    static create(runtime: IFluidDataStoreRuntime, id?: string): PactMap;
-    /**
-     * Get a factory for PactMap to register with the data store.
-     *
-     * @returns a factory that creates and loads PactMaps
-     */
-    static getFactory(): IChannelFactory;
-    private readonly values;
-    private readonly incomingOp;
-    /**
-     * Constructs a new PactMap. If the object is non-local an id and service interfaces will
-     * be provided
-     *
-     * @param runtime - data store runtime the PactMap belongs to
-     * @param id - optional name of the PactMap
-     */
-    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
-    /**
-     * {@inheritDoc IPactMap.get}
-     */
-    get(key: string): T | undefined;
-    /**
-     * {@inheritDoc IPactMap.getWithDetails}
-     */
-    getWithDetails(key: string): IAcceptedPact<T> | undefined;
-    /**
-     * {@inheritDoc IPactMap.isPending}
-     */
-    isPending(key: string): boolean;
-    /**
-     * {@inheritDoc IPactMap.getPending}
-     */
-    getPending(key: string): T | undefined;
-    /**
-     * {@inheritDoc IPactMap.set}
-     */
-    set(key: string, value: T | undefined): void;
-    /**
-     * {@inheritDoc IPactMap.delete}
-     */
-    delete(key: string): void;
-    /**
-     * Get a point-in-time list of clients who must sign off on values coming in for them to move from "pending" to
-     * "accepted" state.  This list is finalized for a value at the moment it goes pending (i.e. if more clients
-     * join later, they are not added to the list of signoffs).
-     * @returns The list of clientIds for clients who must sign off to accept the incoming pending value
-     */
-    private getSignoffClients;
-    private readonly handleIncomingSet;
-    private readonly handleIncomingAccept;
-    private readonly handleQuorumRemoveMember;
-    /* Excluded from this release type: summarizeCore */
-    /* Excluded from this release type: loadCore */
-    /* Excluded from this release type: initializeLocalCore */
-    /* Excluded from this release type: onDisconnect */
-    /* Excluded from this release type: reSubmitCore */
-    /* Excluded from this release type: processCore */
-    applyStashedOp(): void;
-}
+/* Excluded from this release type: IChannelStorageService */
+
+/* Excluded from this release type: IFluidDataStoreRuntime */
+
+/* Excluded from this release type: IFluidSerializer */
+
+/* Excluded from this release type: IPactMap */
+
+/* Excluded from this release type: IPactMapEvents */
+
+/* Excluded from this release type: ISharedObject */
+
+/* Excluded from this release type: ISharedObjectEvents */
+
+/* Excluded from this release type: ISummaryTreeWithStats */
+
+/* Excluded from this release type: PactMap */
+
+/* Excluded from this release type: SharedObject */
 
 export { }