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

package/lib/register-collection-untrimmed.d.mts

@@ -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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/register-collection",
-  "version": "1.4.0-121020",
+  "version": "2.0.0-dev-rc.1.0.0.225277",
   "description": "Consensus Register",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -11,44 +11,72 @@
   "license": "MIT",
   "author": "Microsoft and contributors",
   "sideEffects": false,
-  "main": "dist/index.js",
-  "module": "lib/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "npm run build:genver && concurrently npm:build:compile npm:lint && npm run build:docs",
-    "build:commonjs": "npm run tsc && npm run typetests:gen && npm run build:test",
-    "build:compile": "concurrently npm:build:commonjs npm:build:esnext",
-    "build:docs": "api-extractor run --local --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/doc-models/* ../../../_api-extractor-temp/",
-    "build:esnext": "tsc --project ./tsconfig.esnext.json",
-    "build:full": "npm run build",
-    "build:full:compile": "npm run build:compile",
-    "build:genver": "gen-version",
-    "build:test": "tsc --project ./src/test/tsconfig.json",
-    "ci:build:docs": "api-extractor run --typescript-compiler-folder ../../../node_modules/typescript && copyfiles -u 1 ./_api-extractor-temp/* ../../../_api-extractor-temp/",
-    "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
-    "eslint": "eslint --format stylish src",
-    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
-    "lint": "npm run eslint",
-    "lint:fix": "npm run eslint:fix",
-    "test": "npm run test:mocha",
-    "test:coverage": "nyc npm test -- --reporter xunit --reporter-option output=nyc/junit-report.xml",
-    "test:mocha": "mocha --ignore 'dist/test/types/*' --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup --unhandled-rejections=strict",
-    "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
-    "tsc": "tsc",
-    "typetests:gen": "flub generate typetests --generate --dir . --no-generateInName",
-    "typetests:prepare": "flub generate typetests --prepare --dir . --pin"
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/index.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./alpha": {
+      "import": {
+        "types": "./lib/register-collection-alpha.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./dist/register-collection-alpha.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./beta": {
+      "import": {
+        "types": "./lib/register-collection-beta.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./dist/register-collection-beta.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./internal": {
+      "import": {
+        "types": "./lib/index.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./public": {
+      "import": {
+        "types": "./lib/register-collection-public.d.mts",
+        "default": "./lib/index.mjs"
+      },
+      "require": {
+        "types": "./dist/register-collection-public.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    }
   },
-  "nyc": {
+  "main": "dist/index.cjs",
+  "module": "lib/index.mjs",
+  "types": "dist/index.d.ts",
+  "c8": {
     "all": true,
     "cache-dir": "nyc/.cache",
     "exclude": [
-      "src/test/**/*.ts",
-      "dist/test/**/*.js"
+      "src/test/**/*.*ts",
+      "dist/test/**/*.*js"
     ],
     "exclude-after-remap": false,
     "include": [
-      "src/**/*.ts",
-      "dist/**/*.js"
+      "src/**/*.*ts",
+      "dist/**/*.*js"
     ],
     "report-dir": "nyc/report",
     "reporter": [
@@ -59,40 +87,85 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/core-interfaces": "1.4.0-121020",
-    "@fluidframework/datastore-definitions": "1.4.0-121020",
-    "@fluidframework/protocol-base": "^0.1036.5000",
-    "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/runtime-definitions": "1.4.0-121020",
-    "@fluidframework/shared-object-base": "1.4.0-121020"
+    "@fluid-internal/client-utils": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/core-utils": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/datastore-definitions": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/driver-utils": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/protocol-definitions": "^3.1.0-223007",
+    "@fluidframework/runtime-definitions": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/shared-object-base": "2.0.0-dev-rc.1.0.0.225277"
   },
   "devDependencies": {
-    "@fluid-internal/test-dds-utils": "1.4.0-121020",
-    "@fluidframework/build-common": "^0.24.0",
-    "@fluidframework/build-tools": "^0.6.0-110101",
-    "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/mocha-test-setup": "1.4.0-121020",
-    "@fluidframework/register-collection-previous": "npm:@fluidframework/register-collection@1.3.1",
-    "@fluidframework/test-runtime-utils": "1.4.0-121020",
-    "@microsoft/api-extractor": "^7.22.2",
-    "@rushstack/eslint-config": "^2.5.1",
+    "@arethetypeswrong/cli": "^0.13.3",
+    "@fluid-private/test-dds-utils": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluid-tools/build-cli": "0.29.0-222379",
+    "@fluidframework/build-common": "^2.0.3",
+    "@fluidframework/build-tools": "0.29.0-222379",
+    "@fluidframework/eslint-config-fluid": "^3.1.0",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev-rc.1.0.0.225277",
+    "@fluidframework/register-collection-previous": "npm:@fluidframework/register-collection@2.0.0-internal.8.0.0",
+    "@fluidframework/test-runtime-utils": "2.0.0-dev-rc.1.0.0.225277",
+    "@microsoft/api-extractor": "^7.38.3",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^14.18.0",
-    "concurrently": "^6.2.0",
-    "copyfiles": "^2.1.0",
-    "cross-env": "^7.0.2",
-    "eslint": "~8.6.0",
-    "mocha": "^10.0.0",
-    "nyc": "^15.0.0",
-    "rimraf": "^2.6.2",
-    "typescript": "~4.5.5",
-    "typescript-formatter": "7.1.0"
+    "@types/node": "^18.19.0",
+    "c8": "^8.0.1",
+    "copyfiles": "^2.4.1",
+    "cross-env": "^7.0.3",
+    "eslint": "~8.50.0",
+    "mocha": "^10.2.0",
+    "mocha-json-output-reporter": "^2.0.1",
+    "mocha-multi-reporters": "^1.5.1",
+    "moment": "^2.21.0",
+    "prettier": "~3.0.3",
+    "replace-in-file": "^6.3.5",
+    "rimraf": "^4.4.0",
+    "tsc-multi": "^1.1.0",
+    "typescript": "~5.1.6"
+  },
+  "fluidBuild": {
+    "tasks": {
+      "build:docs": {
+        "dependsOn": [
+          "...",
+          "api-extractor:commonjs",
+          "api-extractor:esnext"
+        ],
+        "script": false
+      }
+    }
   },
   "typeValidation": {
-    "version": "1.4.0",
-    "baselineRange": "~1.3.0",
-    "baselineVersion": "1.3.1",
     "broken": {}
+  },
+  "scripts": {
+    "api": "fluid-build . --task api",
+    "api-extractor:commonjs": "api-extractor run --local",
+    "api-extractor:esnext": "api-extractor run --config ./api-extractor-esm.json",
+    "build": "fluid-build . --task build",
+    "build:commonjs": "fluid-build . --task commonjs",
+    "build:compile": "fluid-build . --task compile",
+    "build:docs": "fluid-build . --task api",
+    "build:esnext": "tsc-multi --config ../../../common/build/build-common/tsc-multi.esm.json",
+    "build:genver": "gen-version",
+    "build:test": "tsc-multi --config ./tsc-multi.test.json",
+    "check:are-the-types-wrong": "attw --pack . --entrypoints .",
+    "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
+    "ci:build:docs": "api-extractor run",
+    "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
+    "eslint": "eslint --format stylish src",
+    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+    "format": "npm run prettier:fix",
+    "lint": "npm run prettier && npm run check:release-tags && npm run eslint",
+    "lint:fix": "npm run prettier:fix && npm run eslint:fix",
+    "prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
+    "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",
+    "test": "npm run test:mocha",
+    "test:coverage": "c8 npm test",
+    "test:mocha": "mocha --ignore \"dist/test/types/*\" --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup",
+    "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
+    "tsc": "tsc-multi --config ../../../common/build/build-common/tsc-multi.cjs.json",
+    "typetests:gen": "fluid-type-test-generator",
+    "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
   }
-}
+}

package/prettier.config.cjs

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+module.exports = {
+	...require("@fluidframework/build-common/prettier.config.cjs"),
+};