@fluidframework/register-collection 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.225277

package/dist/{interfaces.js → interfaces.cjs}

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReadPolicy = void 0;
 /**
  * Read policies used when reading the map value.
+ * @alpha
  */
 var ReadPolicy;
 (function (ReadPolicy) {
@@ -14,5 +15,5 @@ var ReadPolicy;
     ReadPolicy[ReadPolicy["Atomic"] = 0] = "Atomic";
     // Last writer wins. Simply returns the last written value.
     ReadPolicy[ReadPolicy["LWW"] = 1] = "LWW";
-})(ReadPolicy = exports.ReadPolicy || (exports.ReadPolicy = {}));
-//# sourceMappingURL=interfaces.js.map
+})(ReadPolicy || (exports.ReadPolicy = ReadPolicy = {}));
+//# sourceMappingURL=interfaces.cjs.map

package/dist/interfaces.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.cjs","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAsFH;;;GAGG;AACH,IAAY,UAMX;AAND,WAAY,UAAU;IACrB,mFAAmF;IACnF,+CAAM,CAAA;IAEN,2DAA2D;IAC3D,yCAAG,CAAA;AACJ,CAAC,EANW,UAAU,0BAAV,UAAU,QAMrB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIFluidDataStoreRuntime,\n\tIChannelServices,\n\tIChannelAttributes,\n\tIChannelFactory,\n} from \"@fluidframework/datastore-definitions\";\nimport { ISharedObject, ISharedObjectEvents } from \"@fluidframework/shared-object-base\";\n\n/**\n * Consensus Register Collection channel factory interface\n *\n * Extends the base IChannelFactory to return a more definite type of IConsensusRegisterCollection\n * Use for the runtime to create and load distributed data structure by type name of each channel.\n * @alpha\n */\nexport interface IConsensusRegisterCollectionFactory extends IChannelFactory {\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}\n\t */\n\tload(\n\t\tdocument: IFluidDataStoreRuntime,\n\t\tid: string,\n\t\tservices: IChannelServices,\n\t\tattributes: IChannelAttributes,\n\t): Promise<IConsensusRegisterCollection>;\n\n\tcreate(document: IFluidDataStoreRuntime, id: string): IConsensusRegisterCollection;\n}\n\n/**\n * Events emitted by {@link IConsensusRegisterCollection}.\n * @alpha\n */\nexport interface IConsensusRegisterCollectionEvents extends ISharedObjectEvents {\n\t(\n\t\tevent: \"atomicChanged\" | \"versionChanged\",\n\t\tlistener: (key: string, value: any, local: boolean) => void,\n\t);\n}\n\n/**\n * A distributed data structure that holds a set of registers with update\n * versions. On concurrent updates, a register internally stores all possible versions of a value by using reference\n * sequence number of the incoming update.\n *\n * Using all the stored versions, we can then distinguish amongst different read policies. Below are the policies\n * we support:\n *\n * Atomic: Atomicity requires a linearizable register. A linearizable register behaves as if there is only a single\n * copy of the data, and that every operation appears to take effect atomically at one point in time. This definition\n * implies that operations are executed in an well-defined order. On a concurrent update, we perform a compare-and-set\n * operation, where we compare a register sequence number with the incoming reference sequence number.\n * The earliest operation overwriting prior sequence numbers wins since every client reaches to an agreement on\n * the value. So we can safely return the first value.\n *\n * LWW: The last write to a key always wins.\n * @alpha\n */\nexport interface IConsensusRegisterCollection<T = any>\n\textends ISharedObject<IConsensusRegisterCollectionEvents> {\n\t/**\n\t * Attempts to write a register with a value. Returns a promise to indicate the roundtrip completion.\n\t * For a non existent register, it will attempt to create a new register with the specified value.\n\t *\n\t * @returns Promise<true> if write was non-concurrent\n\t */\n\twrite(key: string, value: T): Promise<boolean>;\n\n\t/**\n\t * Retrieves the agreed upon value for the register based on policy. Returns undefined if not present.\n\t */\n\tread(key: string, policy?: ReadPolicy): T | undefined;\n\n\t/**\n\t * Retrives all concurrent versions. Undefined if not present.\n\t */\n\treadVersions(key: string): T[] | undefined;\n\n\t/**\n\t * Returns the keys.\n\t */\n\tkeys(): string[];\n}\n\n/**\n * Read policies used when reading the map value.\n * @alpha\n */\nexport enum ReadPolicy {\n\t// On a concurrent update, returns the first agreed upon value amongst all clients.\n\tAtomic,\n\n\t// Last writer wins. Simply returns the last written value.\n\tLWW,\n}\n"]}

package/dist/interfaces.d.ts

@@ -8,7 +8,8 @@ import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-objec
  * Consensus Register Collection channel factory interface
  *
  * Extends the base IChannelFactory to return a more definite type of IConsensusRegisterCollection
- * Use for the runtime to create and load distributed data structure by type name of each channel
+ * Use for the runtime to create and load distributed data structure by type name of each channel.
+ * @alpha
  */
 export interface IConsensusRegisterCollectionFactory extends IChannelFactory {
     /**
@@ -17,13 +18,15 @@ export interface IConsensusRegisterCollectionFactory extends IChannelFactory {
     load(document: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<IConsensusRegisterCollection>;
     create(document: IFluidDataStoreRuntime, id: string): IConsensusRegisterCollection;
 }
+/**
+ * Events emitted by {@link IConsensusRegisterCollection}.
+ * @alpha
+ */
 export interface IConsensusRegisterCollectionEvents extends ISharedObjectEvents {
     (event: "atomicChanged" | "versionChanged", listener: (key: string, value: any, local: boolean) => void): any;
 }
 /**
- * Consensus Register Collection.
- *
- * A consensus register collection is a distributed data structure, which holds a set of registers with update
+ * A distributed data structure that holds a set of registers with update
  * versions. On concurrent updates, a register internally stores all possible versions of a value by using reference
  * sequence number of the incoming update.
  *
@@ -38,7 +41,7 @@ export interface IConsensusRegisterCollectionEvents extends ISharedObjectEvents
  * the value. So we can safely return the first value.
  *
  * LWW: The last write to a key always wins.
- *
+ * @alpha
  */
 export interface IConsensusRegisterCollection<T = any> extends ISharedObject<IConsensusRegisterCollectionEvents> {
     /**
@@ -63,6 +66,7 @@ export interface IConsensusRegisterCollection<T = any> extends ISharedObject<ICo
 }
 /**
  * Read policies used when reading the map value.
+ * @alpha
  */
 export declare enum ReadPolicy {
     Atomic = 0,

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,EACH,sBAAsB,EACtB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EAClB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAExF;;;;;GAKG;AACH,MAAM,WAAW,mCAAoC,SAAQ,eAAe;IACxE;;OAEG;IACH,IAAI,CACA,QAAQ,EAAE,sBAAsB,EAChC,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;IAE3E,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,4BAA4B,CAAC;CACtF;AAED,MAAM,WAAW,kCAAmC,SAAQ,mBAAmB;IAC3E,CAAC,KAAK,EAAE,eAAe,GAAG,gBAAgB,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,OAAE;CAC5G;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,4BAA4B,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,aAAa,CAAC,kCAAkC,CAAC;IAC5G;;;;;OAKG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE/C;;OAEG;IACH,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,UAAU,GAAG,CAAC,GAAG,SAAS,CAAC;IAEtD;;OAEG;IACH,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,EAAE,GAAG,SAAS,CAAC;IAE3C;;OAEG;IACH,IAAI,IAAI,MAAM,EAAE,CAAC;CACpB;AAED;;GAEG;AACH,oBAAY,UAAU;IAElB,MAAM,IAAA;IAGN,GAAG,IAAA;CACN"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,sBAAsB,EACtB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAExF;;;;;;GAMG;AACH,MAAM,WAAW,mCAAoC,SAAQ,eAAe;IAC3E;;OAEG;IACH,IAAI,CACH,QAAQ,EAAE,sBAAsB,EAChC,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,GAC5B,OAAO,CAAC,4BAA4B,CAAC,CAAC;IAEzC,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,4BAA4B,CAAC;CACnF;AAED;;;GAGG;AACH,MAAM,WAAW,kCAAmC,SAAQ,mBAAmB;IAC9E,CACC,KAAK,EAAE,eAAe,GAAG,gBAAgB,EACzC,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,OAC1D;CACF;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,4BAA4B,CAAC,CAAC,GAAG,GAAG,CACpD,SAAQ,aAAa,CAAC,kCAAkC,CAAC;IACzD;;;;;OAKG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE/C;;OAEG;IACH,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,UAAU,GAAG,CAAC,GAAG,SAAS,CAAC;IAEtD;;OAEG;IACH,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,EAAE,GAAG,SAAS,CAAC;IAE3C;;OAEG;IACH,IAAI,IAAI,MAAM,EAAE,CAAC;CACjB;AAED;;;GAGG;AACH,oBAAY,UAAU;IAErB,MAAM,IAAA;IAGN,GAAG,IAAA;CACH"}

package/dist/{packageVersion.js → packageVersion.cjs}

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/register-collection";
-exports.pkgVersion = "1.4.0-121020";
-//# sourceMappingURL=packageVersion.js.map
+exports.pkgVersion = "2.0.0-dev-rc.1.0.0.225277";
+//# sourceMappingURL=packageVersion.cjs.map

package/dist/packageVersion.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"packageVersion.cjs","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,qCAAqC,CAAC;AAChD,QAAA,UAAU,GAAG,2BAA2B,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 = \"@fluidframework/register-collection\";\nexport const pkgVersion = \"2.0.0-dev-rc.1.0.0.225277\";\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 = "@fluidframework/register-collection";
-export declare const pkgVersion = "1.4.0-121020";
+export declare const pkgVersion = "2.0.0-dev-rc.1.0.0.225277";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,wCAAwC,CAAC;AAC7D,eAAO,MAAM,UAAU,iBAAiB,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,wCAAwC,CAAC;AAC7D,eAAO,MAAM,UAAU,8BAA8B,CAAC"}

package/dist/register-collection-alpha.d.ts

@@ -0,0 +1,163 @@
+import { IChannelAttributes } from '@fluidframework/datastore-definitions';
+import { IChannelFactory } from '@fluidframework/datastore-definitions';
+import { IChannelServices } 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';
+
+/**
+ * {@inheritDoc IConsensusRegisterCollection}
+ * @alpha
+ */
+export declare class ConsensusRegisterCollection<T> extends SharedObject<IConsensusRegisterCollectionEvents> implements IConsensusRegisterCollection<T> {
+    /**
+     * Create a new consensus register collection
+     *
+     * @param runtime - data store runtime the new consensus register collection belongs to
+     * @param id - optional name of the consensus register collection
+     * @returns newly create consensus register collection (but not attached yet)
+     */
+    static create<T>(runtime: IFluidDataStoreRuntime, id?: string): ConsensusRegisterCollection<T>;
+    /**
+     * Get a factory for ConsensusRegisterCollection to register with the data store.
+     *
+     * @returns a factory that creates and load ConsensusRegisterCollection
+     */
+    static getFactory(): ConsensusRegisterCollectionFactory;
+    private readonly data;
+    /**
+     * Constructs a new consensus register collection. If the object is non-local an id and service interfaces will
+     * be provided
+     */
+    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
+    /**
+     * Creates a new register or writes a new value.
+     * Returns a promise that will resolve when the write is acked.
+     *
+     * @returns Promise<true> if write was non-concurrent
+     */
+    write(key: string, value: T): Promise<boolean>;
+    /**
+     * Returns the most recent local value of a register.
+     * @param key - The key to read
+     * @param readPolicy - The ReadPolicy to apply. Defaults to Atomic.
+     */
+    read(key: string, readPolicy?: ReadPolicy): T | undefined;
+    readVersions(key: string): T[] | undefined;
+    keys(): string[];
+    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
+     */
+    protected loadCore(storage: IChannelStorageService): Promise<void>;
+    protected onDisconnect(): void;
+    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    private readAtomic;
+    /**
+     * Process an inbound write op
+     * @param key - Key that was written to
+     * @param value - Incoming value
+     * @param refSeq - RefSeq at the time of write on the remote client
+     * @param sequenceNumber - Sequence Number of this write op
+     * @param local - Did this write originate on this client
+     */
+    private processInboundWrite;
+    private stringify;
+    private parse;
+    protected applyStashedOp(): () => void;
+}
+
+/**
+ * The factory that defines the consensus queue.
+ * @alpha
+ */
+export declare class ConsensusRegisterCollectionFactory implements IConsensusRegisterCollectionFactory {
+    static Type: string;
+    static readonly Attributes: IChannelAttributes;
+    get type(): string;
+    get attributes(): IChannelAttributes;
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
+     */
+    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<IConsensusRegisterCollection>;
+    create(document: IFluidDataStoreRuntime, id: string): IConsensusRegisterCollection;
+}
+
+/**
+ * A distributed data structure that holds a set of registers with update
+ * versions. On concurrent updates, a register internally stores all possible versions of a value by using reference
+ * sequence number of the incoming update.
+ *
+ * Using all the stored versions, we can then distinguish amongst different read policies. Below are the policies
+ * we support:
+ *
+ * Atomic: Atomicity requires a linearizable register. A linearizable register behaves as if there is only a single
+ * copy of the data, and that every operation appears to take effect atomically at one point in time. This definition
+ * implies that operations are executed in an well-defined order. On a concurrent update, we perform a compare-and-set
+ * operation, where we compare a register sequence number with the incoming reference sequence number.
+ * The earliest operation overwriting prior sequence numbers wins since every client reaches to an agreement on
+ * the value. So we can safely return the first value.
+ *
+ * LWW: The last write to a key always wins.
+ * @alpha
+ */
+export declare interface IConsensusRegisterCollection<T = any> extends ISharedObject<IConsensusRegisterCollectionEvents> {
+    /**
+     * Attempts to write a register with a value. Returns a promise to indicate the roundtrip completion.
+     * For a non existent register, it will attempt to create a new register with the specified value.
+     *
+     * @returns Promise<true> if write was non-concurrent
+     */
+    write(key: string, value: T): Promise<boolean>;
+    /**
+     * Retrieves the agreed upon value for the register based on policy. Returns undefined if not present.
+     */
+    read(key: string, policy?: ReadPolicy): T | undefined;
+    /**
+     * Retrives all concurrent versions. Undefined if not present.
+     */
+    readVersions(key: string): T[] | undefined;
+    /**
+     * Returns the keys.
+     */
+    keys(): string[];
+}
+
+/**
+ * Events emitted by {@link IConsensusRegisterCollection}.
+ * @alpha
+ */
+export declare interface IConsensusRegisterCollectionEvents extends ISharedObjectEvents {
+    (event: "atomicChanged" | "versionChanged", listener: (key: string, value: any, local: boolean) => void): any;
+}
+
+/**
+ * Consensus Register Collection channel factory interface
+ *
+ * Extends the base IChannelFactory to return a more definite type of IConsensusRegisterCollection
+ * Use for the runtime to create and load distributed data structure by type name of each channel.
+ * @alpha
+ */
+export declare interface IConsensusRegisterCollectionFactory extends IChannelFactory {
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
+     */
+    load(document: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<IConsensusRegisterCollection>;
+    create(document: IFluidDataStoreRuntime, id: string): IConsensusRegisterCollection;
+}
+
+/**
+ * Read policies used when reading the map value.
+ * @alpha
+ */
+export declare enum ReadPolicy {
+    Atomic = 0,
+    LWW = 1
+}
+
+export { }

package/dist/register-collection-beta.d.ts

@@ -0,0 +1,25 @@
+import { IChannelAttributes } from '@fluidframework/datastore-definitions';
+import { IChannelFactory } from '@fluidframework/datastore-definitions';
+import { IChannelServices } 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';
+
+/* Excluded from this release type: ConsensusRegisterCollection */
+
+/* Excluded from this release type: ConsensusRegisterCollectionFactory */
+
+/* Excluded from this release type: IConsensusRegisterCollection */
+
+/* Excluded from this release type: IConsensusRegisterCollectionEvents */
+
+/* Excluded from this release type: IConsensusRegisterCollectionFactory */
+
+/* Excluded from this release type: ReadPolicy */
+
+export { }

package/dist/register-collection-public.d.ts

@@ -0,0 +1,25 @@
+import { IChannelAttributes } from '@fluidframework/datastore-definitions';
+import { IChannelFactory } from '@fluidframework/datastore-definitions';
+import { IChannelServices } 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';
+
+/* Excluded from this release type: ConsensusRegisterCollection */
+
+/* Excluded from this release type: ConsensusRegisterCollectionFactory */
+
+/* Excluded from this release type: IConsensusRegisterCollection */
+
+/* Excluded from this release type: IConsensusRegisterCollectionEvents */
+
+/* Excluded from this release type: IConsensusRegisterCollectionFactory */
+
+/* Excluded from this release type: ReadPolicy */
+
+export { }

package/dist/register-collection-untrimmed.d.ts

@@ -0,0 +1,163 @@
+import { IChannelAttributes } from '@fluidframework/datastore-definitions';
+import { IChannelFactory } from '@fluidframework/datastore-definitions';
+import { IChannelServices } 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';
+
+/**
+ * {@inheritDoc IConsensusRegisterCollection}
+ * @alpha
+ */
+export declare class ConsensusRegisterCollection<T> extends SharedObject<IConsensusRegisterCollectionEvents> implements IConsensusRegisterCollection<T> {
+    /**
+     * Create a new consensus register collection
+     *
+     * @param runtime - data store runtime the new consensus register collection belongs to
+     * @param id - optional name of the consensus register collection
+     * @returns newly create consensus register collection (but not attached yet)
+     */
+    static create<T>(runtime: IFluidDataStoreRuntime, id?: string): ConsensusRegisterCollection<T>;
+    /**
+     * Get a factory for ConsensusRegisterCollection to register with the data store.
+     *
+     * @returns a factory that creates and load ConsensusRegisterCollection
+     */
+    static getFactory(): ConsensusRegisterCollectionFactory;
+    private readonly data;
+    /**
+     * Constructs a new consensus register collection. If the object is non-local an id and service interfaces will
+     * be provided
+     */
+    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
+    /**
+     * Creates a new register or writes a new value.
+     * Returns a promise that will resolve when the write is acked.
+     *
+     * @returns Promise<true> if write was non-concurrent
+     */
+    write(key: string, value: T): Promise<boolean>;
+    /**
+     * Returns the most recent local value of a register.
+     * @param key - The key to read
+     * @param readPolicy - The ReadPolicy to apply. Defaults to Atomic.
+     */
+    read(key: string, readPolicy?: ReadPolicy): T | undefined;
+    readVersions(key: string): T[] | undefined;
+    keys(): string[];
+    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
+     */
+    protected loadCore(storage: IChannelStorageService): Promise<void>;
+    protected onDisconnect(): void;
+    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    private readAtomic;
+    /**
+     * Process an inbound write op
+     * @param key - Key that was written to
+     * @param value - Incoming value
+     * @param refSeq - RefSeq at the time of write on the remote client
+     * @param sequenceNumber - Sequence Number of this write op
+     * @param local - Did this write originate on this client
+     */
+    private processInboundWrite;
+    private stringify;
+    private parse;
+    protected applyStashedOp(): () => void;
+}
+
+/**
+ * The factory that defines the consensus queue.
+ * @alpha
+ */
+export declare class ConsensusRegisterCollectionFactory implements IConsensusRegisterCollectionFactory {
+    static Type: string;
+    static readonly Attributes: IChannelAttributes;
+    get type(): string;
+    get attributes(): IChannelAttributes;
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
+     */
+    load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<IConsensusRegisterCollection>;
+    create(document: IFluidDataStoreRuntime, id: string): IConsensusRegisterCollection;
+}
+
+/**
+ * A distributed data structure that holds a set of registers with update
+ * versions. On concurrent updates, a register internally stores all possible versions of a value by using reference
+ * sequence number of the incoming update.
+ *
+ * Using all the stored versions, we can then distinguish amongst different read policies. Below are the policies
+ * we support:
+ *
+ * Atomic: Atomicity requires a linearizable register. A linearizable register behaves as if there is only a single
+ * copy of the data, and that every operation appears to take effect atomically at one point in time. This definition
+ * implies that operations are executed in an well-defined order. On a concurrent update, we perform a compare-and-set
+ * operation, where we compare a register sequence number with the incoming reference sequence number.
+ * The earliest operation overwriting prior sequence numbers wins since every client reaches to an agreement on
+ * the value. So we can safely return the first value.
+ *
+ * LWW: The last write to a key always wins.
+ * @alpha
+ */
+export declare interface IConsensusRegisterCollection<T = any> extends ISharedObject<IConsensusRegisterCollectionEvents> {
+    /**
+     * Attempts to write a register with a value. Returns a promise to indicate the roundtrip completion.
+     * For a non existent register, it will attempt to create a new register with the specified value.
+     *
+     * @returns Promise<true> if write was non-concurrent
+     */
+    write(key: string, value: T): Promise<boolean>;
+    /**
+     * Retrieves the agreed upon value for the register based on policy. Returns undefined if not present.
+     */
+    read(key: string, policy?: ReadPolicy): T | undefined;
+    /**
+     * Retrives all concurrent versions. Undefined if not present.
+     */
+    readVersions(key: string): T[] | undefined;
+    /**
+     * Returns the keys.
+     */
+    keys(): string[];
+}
+
+/**
+ * Events emitted by {@link IConsensusRegisterCollection}.
+ * @alpha
+ */
+export declare interface IConsensusRegisterCollectionEvents extends ISharedObjectEvents {
+    (event: "atomicChanged" | "versionChanged", listener: (key: string, value: any, local: boolean) => void): any;
+}
+
+/**
+ * Consensus Register Collection channel factory interface
+ *
+ * Extends the base IChannelFactory to return a more definite type of IConsensusRegisterCollection
+ * Use for the runtime to create and load distributed data structure by type name of each channel.
+ * @alpha
+ */
+export declare interface IConsensusRegisterCollectionFactory extends IChannelFactory {
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
+     */
+    load(document: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<IConsensusRegisterCollection>;
+    create(document: IFluidDataStoreRuntime, id: string): IConsensusRegisterCollection;
+}
+
+/**
+ * Read policies used when reading the map value.
+ * @alpha
+ */
+export declare enum ReadPolicy {
+    Atomic = 0,
+    LWW = 1
+}
+
+export { }

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.38.3"
+    }
+  ]
+}

package/lib/{consensusRegisterCollection.d.ts → consensusRegisterCollection.d.mts}

@@ -6,10 +6,11 @@ import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions"
 import { IChannelAttributes, IFluidDataStoreRuntime, IChannelStorageService } from "@fluidframework/datastore-definitions";
 import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
 import { IFluidSerializer, SharedObject } from "@fluidframework/shared-object-base";
-import { ConsensusRegisterCollectionFactory } from "./consensusRegisterCollectionFactory";
-import { IConsensusRegisterCollection, ReadPolicy, IConsensusRegisterCollectionEvents } from "./interfaces";
+import { ConsensusRegisterCollectionFactory } from "./consensusRegisterCollectionFactory.mjs";
+import { IConsensusRegisterCollection, ReadPolicy, IConsensusRegisterCollectionEvents } from "./interfaces.mjs";
 /**
- * Implementation of a consensus register collection
+ * {@inheritDoc IConsensusRegisterCollection}
+ * @alpha
  */
 export declare class ConsensusRegisterCollection<T> extends SharedObject<IConsensusRegisterCollectionEvents> implements IConsensusRegisterCollection<T> {
     /**
@@ -68,4 +69,4 @@ export declare class ConsensusRegisterCollection<T> extends SharedObject<IConsen
     private parse;
     protected applyStashedOp(): () => void;
 }
-//# sourceMappingURL=consensusRegisterCollection.d.ts.map
+//# sourceMappingURL=consensusRegisterCollection.d.mts.map

package/lib/consensusRegisterCollection.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consensusRegisterCollection.d.mts","sourceRoot":"","sources":["../src/consensusRegisterCollection.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAII,EAAE,yBAAyB,EAAe,MAAM,sCAAsC;OACtF,EACN,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,uCAAuC;OACvC,EAAE,qBAAqB,EAAE,MAAM,qCAAqC;OACpE,EAEN,gBAAgB,EAChB,YAAY,EACZ,MAAM,oCAAoC;OACpC,EAAE,kCAAkC,EAAE;OACtC,EACN,4BAA4B,EAC5B,UAAU,EACV,kCAAkC,EAClC;AAoED;;;GAGG;AACH,qBAAa,2BAA2B,CAAC,CAAC,CACzC,SAAQ,YAAY,CAAC,kCAAkC,CACvD,YAAW,4BAA4B,CAAC,CAAC,CAAC;IAE1C;;;;;;OAMG;WACW,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM;IAOpE;;;;OAIG;WACW,UAAU;IAIxB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAoC;IAEzD;;;OAGG;gBAEF,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB;IAK/B;;;;;OAKG;IACU,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAwB3D;;;;OAIG;IACI,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,GAAE,UAA8B,GAAG,CAAC,GAAG,SAAS;IAe5E,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,EAAE,GAAG,SAAS;IAK1C,IAAI,IAAI,MAAM,EAAE;IAIvB,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;IAS5E;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAexE,SAAS,CAAC,YAAY;IAEtB,SAAS,CAAC,WAAW,CACpB,OAAO,EAAE,yBAAyB,EAClC,KAAK,EAAE,OAAO,EACd,eAAe,EAAE,OAAO;IA0CzB,OAAO,CAAC,UAAU;IAKlB;;;;;;;OAOG;IACH,OAAO,CAAC,mBAAmB;IA2D3B,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,KAAK;IAIb,SAAS,CAAC,cAAc;CAIxB"}