@fluidframework/counter 2.0.0-dev.7.3.0.210328 → 2.0.0-dev.7.3.0.212138

package/dist/counterFactory.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"counterFactory.cjs","sourceRoot":"","sources":["../src/counterFactory.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAQH,2CAA0C;AAE1C,yDAA8C;AAE9C;;;;GAIG;AACH,MAAa,cAAc;IAe1B;;OAEG;IACH,IAAW,IAAI;QACd,OAAO,cAAc,CAAC,IAAI,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACpB,OAAO,cAAc,CAAC,UAAU,CAAC;IAClC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,CAChB,OAA+B,EAC/B,EAAU,EACV,QAA0B,EAC1B,UAA8B;QAE9B,MAAM,OAAO,GAAG,IAAI,uBAAa,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAC3D,MAAM,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7B,OAAO,OAAO,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAgC,EAAE,EAAU;QACzD,MAAM,OAAO,GAAG,IAAI,uBAAa,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACjE,OAAO,CAAC,eAAe,EAAE,CAAC;QAC1B,OAAO,OAAO,CAAC;IAChB,CAAC;;AAlDF,wCAmDC;AAlDA;;GAEG;AACoB,mBAAI,GAAG,2CAA2C,CAAC;AAE1E;;GAEG;AACoB,yBAAU,GAAuB;IACvD,IAAI,EAAE,cAAc,CAAC,IAAI;IACzB,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,2BAAU;CAC1B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\ttype IChannelAttributes,\n\ttype IFluidDataStoreRuntime,\n\ttype IChannelServices,\n\ttype IChannelFactory,\n} from \"@fluidframework/datastore-definitions\";\nimport { SharedCounter } from \"./counter\";\nimport { type ISharedCounter } from \"./interfaces\";\nimport { pkgVersion } from \"./packageVersion\";\n\n/**\n * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link SharedCounter}.\n *\n * @sealed\n */\nexport class CounterFactory implements IChannelFactory {\n\t/**\n\t * Static value for {@link CounterFactory.\"type\"}.\n\t */\n\tpublic static readonly Type = \"https://graph.microsoft.com/types/counter\";\n\n\t/**\n\t * Static value for {@link CounterFactory.attributes}.\n\t */\n\tpublic static readonly Attributes: IChannelAttributes = {\n\t\ttype: CounterFactory.Type,\n\t\tsnapshotFormatVersion: \"0.1\",\n\t\tpackageVersion: pkgVersion,\n\t};\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.\"type\"}\n\t */\n\tpublic get type(): string {\n\t\treturn CounterFactory.Type;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.attributes}\n\t */\n\tpublic get attributes(): IChannelAttributes {\n\t\treturn CounterFactory.Attributes;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}\n\t */\n\tpublic async load(\n\t\truntime: IFluidDataStoreRuntime,\n\t\tid: string,\n\t\tservices: IChannelServices,\n\t\tattributes: IChannelAttributes,\n\t): Promise<ISharedCounter> {\n\t\tconst counter = new SharedCounter(id, runtime, attributes);\n\t\tawait counter.load(services);\n\t\treturn counter;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}\n\t */\n\tpublic create(document: IFluidDataStoreRuntime, id: string): ISharedCounter {\n\t\tconst counter = new SharedCounter(id, document, this.attributes);\n\t\tcounter.initializeLocal();\n\t\treturn counter;\n\t}\n}\n"]}

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

@@ -11,6 +11,6 @@ exports.SharedCounter = void 0;
  *
  * @packageDocumentation
  */
-var counter_1 = require("./counter");
+var counter_1 = require("./counter.cjs");
 Object.defineProperty(exports, "SharedCounter", { enumerable: true, get: function () { return counter_1.SharedCounter; } });
-//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;;;;GAKG;AAEH,yCAA0C;AAAjC,wGAAA,aAAa,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * This library contains the {@link ISharedCounter | SharedCounter} distributed data structure.\n * A `SharedCounter` is a shared object which holds a whole number that can be incremented or decremented.\n *\n * @packageDocumentation\n */\n\nexport { SharedCounter } from \"./counter\";\nexport type { ISharedCounter, ISharedCounterEvents } from \"./interfaces\";\n"]}

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

@@ -4,4 +4,4 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=interfaces.js.map
+//# 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","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 sent by {@link SharedCounter}.\n *\n * @public\n */\nexport interface ISharedCounterEvents extends ISharedObjectEvents {\n\t/**\n\t * This event is raised when the counter is incremented or decremented.\n\t *\n\t * @param event - The event name.\n\t * @param listener - An event listener.\n\t *\n\t * @eventProperty\n\t */\n\t(event: \"incremented\", listener: (incrementAmount: number, newValue: number) => void);\n}\n\n/**\n * A shared object that holds a number that can be incremented or decremented.\n *\n * @remarks Note that `SharedCounter` only operates on integer values. This is validated at runtime.\n *\n * @example Creating a `SharedCounter`\n *\n * First, get the factory and call {@link @fluidframework/datastore-definitions#IChannelFactory.create}\n * with a runtime and string ID:\n *\n * ```typescript\n * const factory = SharedCounter.getFactory();\n * const counter = factory.create(this.runtime, id) as SharedCounter;\n * ```\n *\n * The initial value of a new `SharedCounter` is 0.\n * If you wish to initialize the counter to a different value, you may call {@link SharedCounter.increment} before\n * attaching the Container, or before inserting it into an existing shared object.\n *\n * @example Using the `SharedCounter`\n *\n * Once created, you can call {@link SharedCounter.increment} to modify the value with either a positive or\n * negative number:\n *\n * ```typescript\n * counter.increment(10); // add 10 to the counter value\n * counter.increment(-5); // subtract 5 from the counter value\n * ```\n *\n * To observe changes to the value (including those from remote clients), register for the\n * {@link ISharedCounterEvents | incremented} event:\n *\n * ```typescript\n * counter.on(\"incremented\", (incrementAmount, newValue) => {\n *     console.log(`The counter incremented by ${incrementAmount} and now has a value of ${newValue}`);\n * });\n * ```\n *\n * @public\n */\nexport interface ISharedCounter extends ISharedObject<ISharedCounterEvents> {\n\t/**\n\t * The counter value.\n\t *\n\t * @remarks Must be a whole number.\n\t */\n\tvalue: number;\n\n\t/**\n\t * Increments or decrements the value.\n\t * Must only increment or decrement by a whole number value.\n\t *\n\t * @param incrementAmount - A whole number to increment or decrement by.\n\t */\n\tincrement(incrementAmount: number): void;\n}\n"]}

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/counter";
-exports.pkgVersion = "2.0.0-dev.7.3.0.210328";
-//# sourceMappingURL=packageVersion.js.map
+exports.pkgVersion = "2.0.0-dev.7.3.0.212138";
+//# 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,yBAAyB,CAAC;AACpC,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 = \"@fluidframework/counter\";\nexport const pkgVersion = \"2.0.0-dev.7.3.0.212138\";\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/counter";
-export declare const pkgVersion = "2.0.0-dev.7.3.0.210328";
+export declare const pkgVersion = "2.0.0-dev.7.3.0.212138";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.38.0"
+      "packageVersion": "7.38.3"
     }
   ]
 }

package/lib/counter-alpha.d.ts

@@ -0,0 +1,153 @@
+/**
+ * This library contains the {@link ISharedCounter | SharedCounter} distributed data structure.
+ * A `SharedCounter` is a shared object which holds a whole number that can be incremented or decremented.
+ *
+ * @packageDocumentation
+ */
+
+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';
+
+/**
+ * A shared object that holds a number that can be incremented or decremented.
+ *
+ * @remarks Note that `SharedCounter` only operates on integer values. This is validated at runtime.
+ *
+ * @example Creating a `SharedCounter`
+ *
+ * First, get the factory and call {@link @fluidframework/datastore-definitions#IChannelFactory.create}
+ * with a runtime and string ID:
+ *
+ * ```typescript
+ * const factory = SharedCounter.getFactory();
+ * const counter = factory.create(this.runtime, id) as SharedCounter;
+ * ```
+ *
+ * The initial value of a new `SharedCounter` is 0.
+ * If you wish to initialize the counter to a different value, you may call {@link SharedCounter.increment} before
+ * attaching the Container, or before inserting it into an existing shared object.
+ *
+ * @example Using the `SharedCounter`
+ *
+ * Once created, you can call {@link SharedCounter.increment} to modify the value with either a positive or
+ * negative number:
+ *
+ * ```typescript
+ * counter.increment(10); // add 10 to the counter value
+ * counter.increment(-5); // subtract 5 from the counter value
+ * ```
+ *
+ * To observe changes to the value (including those from remote clients), register for the
+ * {@link ISharedCounterEvents | incremented} event:
+ *
+ * ```typescript
+ * counter.on("incremented", (incrementAmount, newValue) => {
+ *     console.log(`The counter incremented by ${incrementAmount} and now has a value of ${newValue}`);
+ * });
+ * ```
+ *
+ * @public
+ */
+export declare interface ISharedCounter extends ISharedObject<ISharedCounterEvents> {
+    /**
+     * The counter value.
+     *
+     * @remarks Must be a whole number.
+     */
+    value: number;
+    /**
+     * Increments or decrements the value.
+     * Must only increment or decrement by a whole number value.
+     *
+     * @param incrementAmount - A whole number to increment or decrement by.
+     */
+    increment(incrementAmount: number): void;
+}
+
+/**
+ * Events sent by {@link SharedCounter}.
+ *
+ * @public
+ */
+export declare interface ISharedCounterEvents extends ISharedObjectEvents {
+    /**
+     * This event is raised when the counter is incremented or decremented.
+     *
+     * @param event - The event name.
+     * @param listener - An event listener.
+     *
+     * @eventProperty
+     */
+    (event: "incremented", listener: (incrementAmount: number, newValue: number) => void): any;
+}
+
+/**
+ * {@inheritDoc ISharedCounter}
+ *
+ * @public
+ */
+export declare class SharedCounter extends SharedObject<ISharedCounterEvents> implements ISharedCounter {
+    /**
+     * Create a new {@link SharedCounter}.
+     *
+     * @param runtime - The data store runtime to which the new `SharedCounter` will belong.
+     * @param id - Optional name of the `SharedCounter`. If not provided, one will be generated.
+     *
+     * @returns newly create shared counter (but not attached yet)
+     */
+    static create(runtime: IFluidDataStoreRuntime, id?: string): SharedCounter;
+    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
+    /**
+     * Get a factory for {@link SharedCounter} to register with the data store.
+     *
+     * @returns a factory that creates and load SharedCounter
+     */
+    static getFactory(): IChannelFactory;
+    private _value;
+    /**
+     * {@inheritDoc ISharedCounter.value}
+     */
+    get value(): number;
+    /**
+     * {@inheritDoc ISharedCounter.increment}
+     */
+    increment(incrementAmount: number): void;
+    private incrementCore;
+    /**
+     * Create a summary for the counter.
+     *
+     * @returns The summary of the current state of the counter.
+     */
+    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
+     */
+    protected loadCore(storage: IChannelStorageService): Promise<void>;
+    /**
+     * Called when the object has disconnected from the delta stream.
+     */
+    protected onDisconnect(): void;
+    /**
+     * Process a counter operation (op).
+     *
+     * @param message - The message to prepare.
+     * @param local - Whether or not the message was sent by the local client.
+     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
+     * For messages from a remote client, this will be `undefined`.
+     */
+    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    /**
+     * {@inheritdoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
+     */
+    protected applyStashedOp(op: unknown): void;
+}
+
+export { }

package/lib/counter-beta.d.ts

@@ -0,0 +1,153 @@
+/**
+ * This library contains the {@link ISharedCounter | SharedCounter} distributed data structure.
+ * A `SharedCounter` is a shared object which holds a whole number that can be incremented or decremented.
+ *
+ * @packageDocumentation
+ */
+
+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';
+
+/**
+ * A shared object that holds a number that can be incremented or decremented.
+ *
+ * @remarks Note that `SharedCounter` only operates on integer values. This is validated at runtime.
+ *
+ * @example Creating a `SharedCounter`
+ *
+ * First, get the factory and call {@link @fluidframework/datastore-definitions#IChannelFactory.create}
+ * with a runtime and string ID:
+ *
+ * ```typescript
+ * const factory = SharedCounter.getFactory();
+ * const counter = factory.create(this.runtime, id) as SharedCounter;
+ * ```
+ *
+ * The initial value of a new `SharedCounter` is 0.
+ * If you wish to initialize the counter to a different value, you may call {@link SharedCounter.increment} before
+ * attaching the Container, or before inserting it into an existing shared object.
+ *
+ * @example Using the `SharedCounter`
+ *
+ * Once created, you can call {@link SharedCounter.increment} to modify the value with either a positive or
+ * negative number:
+ *
+ * ```typescript
+ * counter.increment(10); // add 10 to the counter value
+ * counter.increment(-5); // subtract 5 from the counter value
+ * ```
+ *
+ * To observe changes to the value (including those from remote clients), register for the
+ * {@link ISharedCounterEvents | incremented} event:
+ *
+ * ```typescript
+ * counter.on("incremented", (incrementAmount, newValue) => {
+ *     console.log(`The counter incremented by ${incrementAmount} and now has a value of ${newValue}`);
+ * });
+ * ```
+ *
+ * @public
+ */
+export declare interface ISharedCounter extends ISharedObject<ISharedCounterEvents> {
+    /**
+     * The counter value.
+     *
+     * @remarks Must be a whole number.
+     */
+    value: number;
+    /**
+     * Increments or decrements the value.
+     * Must only increment or decrement by a whole number value.
+     *
+     * @param incrementAmount - A whole number to increment or decrement by.
+     */
+    increment(incrementAmount: number): void;
+}
+
+/**
+ * Events sent by {@link SharedCounter}.
+ *
+ * @public
+ */
+export declare interface ISharedCounterEvents extends ISharedObjectEvents {
+    /**
+     * This event is raised when the counter is incremented or decremented.
+     *
+     * @param event - The event name.
+     * @param listener - An event listener.
+     *
+     * @eventProperty
+     */
+    (event: "incremented", listener: (incrementAmount: number, newValue: number) => void): any;
+}
+
+/**
+ * {@inheritDoc ISharedCounter}
+ *
+ * @public
+ */
+export declare class SharedCounter extends SharedObject<ISharedCounterEvents> implements ISharedCounter {
+    /**
+     * Create a new {@link SharedCounter}.
+     *
+     * @param runtime - The data store runtime to which the new `SharedCounter` will belong.
+     * @param id - Optional name of the `SharedCounter`. If not provided, one will be generated.
+     *
+     * @returns newly create shared counter (but not attached yet)
+     */
+    static create(runtime: IFluidDataStoreRuntime, id?: string): SharedCounter;
+    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
+    /**
+     * Get a factory for {@link SharedCounter} to register with the data store.
+     *
+     * @returns a factory that creates and load SharedCounter
+     */
+    static getFactory(): IChannelFactory;
+    private _value;
+    /**
+     * {@inheritDoc ISharedCounter.value}
+     */
+    get value(): number;
+    /**
+     * {@inheritDoc ISharedCounter.increment}
+     */
+    increment(incrementAmount: number): void;
+    private incrementCore;
+    /**
+     * Create a summary for the counter.
+     *
+     * @returns The summary of the current state of the counter.
+     */
+    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
+     */
+    protected loadCore(storage: IChannelStorageService): Promise<void>;
+    /**
+     * Called when the object has disconnected from the delta stream.
+     */
+    protected onDisconnect(): void;
+    /**
+     * Process a counter operation (op).
+     *
+     * @param message - The message to prepare.
+     * @param local - Whether or not the message was sent by the local client.
+     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
+     * For messages from a remote client, this will be `undefined`.
+     */
+    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    /**
+     * {@inheritdoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
+     */
+    protected applyStashedOp(op: unknown): void;
+}
+
+export { }

package/lib/counter-public.d.ts

@@ -0,0 +1,153 @@
+/**
+ * This library contains the {@link ISharedCounter | SharedCounter} distributed data structure.
+ * A `SharedCounter` is a shared object which holds a whole number that can be incremented or decremented.
+ *
+ * @packageDocumentation
+ */
+
+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';
+
+/**
+ * A shared object that holds a number that can be incremented or decremented.
+ *
+ * @remarks Note that `SharedCounter` only operates on integer values. This is validated at runtime.
+ *
+ * @example Creating a `SharedCounter`
+ *
+ * First, get the factory and call {@link @fluidframework/datastore-definitions#IChannelFactory.create}
+ * with a runtime and string ID:
+ *
+ * ```typescript
+ * const factory = SharedCounter.getFactory();
+ * const counter = factory.create(this.runtime, id) as SharedCounter;
+ * ```
+ *
+ * The initial value of a new `SharedCounter` is 0.
+ * If you wish to initialize the counter to a different value, you may call {@link SharedCounter.increment} before
+ * attaching the Container, or before inserting it into an existing shared object.
+ *
+ * @example Using the `SharedCounter`
+ *
+ * Once created, you can call {@link SharedCounter.increment} to modify the value with either a positive or
+ * negative number:
+ *
+ * ```typescript
+ * counter.increment(10); // add 10 to the counter value
+ * counter.increment(-5); // subtract 5 from the counter value
+ * ```
+ *
+ * To observe changes to the value (including those from remote clients), register for the
+ * {@link ISharedCounterEvents | incremented} event:
+ *
+ * ```typescript
+ * counter.on("incremented", (incrementAmount, newValue) => {
+ *     console.log(`The counter incremented by ${incrementAmount} and now has a value of ${newValue}`);
+ * });
+ * ```
+ *
+ * @public
+ */
+export declare interface ISharedCounter extends ISharedObject<ISharedCounterEvents> {
+    /**
+     * The counter value.
+     *
+     * @remarks Must be a whole number.
+     */
+    value: number;
+    /**
+     * Increments or decrements the value.
+     * Must only increment or decrement by a whole number value.
+     *
+     * @param incrementAmount - A whole number to increment or decrement by.
+     */
+    increment(incrementAmount: number): void;
+}
+
+/**
+ * Events sent by {@link SharedCounter}.
+ *
+ * @public
+ */
+export declare interface ISharedCounterEvents extends ISharedObjectEvents {
+    /**
+     * This event is raised when the counter is incremented or decremented.
+     *
+     * @param event - The event name.
+     * @param listener - An event listener.
+     *
+     * @eventProperty
+     */
+    (event: "incremented", listener: (incrementAmount: number, newValue: number) => void): any;
+}
+
+/**
+ * {@inheritDoc ISharedCounter}
+ *
+ * @public
+ */
+export declare class SharedCounter extends SharedObject<ISharedCounterEvents> implements ISharedCounter {
+    /**
+     * Create a new {@link SharedCounter}.
+     *
+     * @param runtime - The data store runtime to which the new `SharedCounter` will belong.
+     * @param id - Optional name of the `SharedCounter`. If not provided, one will be generated.
+     *
+     * @returns newly create shared counter (but not attached yet)
+     */
+    static create(runtime: IFluidDataStoreRuntime, id?: string): SharedCounter;
+    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
+    /**
+     * Get a factory for {@link SharedCounter} to register with the data store.
+     *
+     * @returns a factory that creates and load SharedCounter
+     */
+    static getFactory(): IChannelFactory;
+    private _value;
+    /**
+     * {@inheritDoc ISharedCounter.value}
+     */
+    get value(): number;
+    /**
+     * {@inheritDoc ISharedCounter.increment}
+     */
+    increment(incrementAmount: number): void;
+    private incrementCore;
+    /**
+     * Create a summary for the counter.
+     *
+     * @returns The summary of the current state of the counter.
+     */
+    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
+     */
+    protected loadCore(storage: IChannelStorageService): Promise<void>;
+    /**
+     * Called when the object has disconnected from the delta stream.
+     */
+    protected onDisconnect(): void;
+    /**
+     * Process a counter operation (op).
+     *
+     * @param message - The message to prepare.
+     * @param local - Whether or not the message was sent by the local client.
+     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
+     * For messages from a remote client, this will be `undefined`.
+     */
+    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    /**
+     * {@inheritdoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
+     */
+    protected applyStashedOp(op: unknown): void;
+}
+
+export { }

package/lib/counter-untrimmed.d.ts

@@ -0,0 +1,153 @@
+/**
+ * This library contains the {@link ISharedCounter | SharedCounter} distributed data structure.
+ * A `SharedCounter` is a shared object which holds a whole number that can be incremented or decremented.
+ *
+ * @packageDocumentation
+ */
+
+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';
+
+/**
+ * A shared object that holds a number that can be incremented or decremented.
+ *
+ * @remarks Note that `SharedCounter` only operates on integer values. This is validated at runtime.
+ *
+ * @example Creating a `SharedCounter`
+ *
+ * First, get the factory and call {@link @fluidframework/datastore-definitions#IChannelFactory.create}
+ * with a runtime and string ID:
+ *
+ * ```typescript
+ * const factory = SharedCounter.getFactory();
+ * const counter = factory.create(this.runtime, id) as SharedCounter;
+ * ```
+ *
+ * The initial value of a new `SharedCounter` is 0.
+ * If you wish to initialize the counter to a different value, you may call {@link SharedCounter.increment} before
+ * attaching the Container, or before inserting it into an existing shared object.
+ *
+ * @example Using the `SharedCounter`
+ *
+ * Once created, you can call {@link SharedCounter.increment} to modify the value with either a positive or
+ * negative number:
+ *
+ * ```typescript
+ * counter.increment(10); // add 10 to the counter value
+ * counter.increment(-5); // subtract 5 from the counter value
+ * ```
+ *
+ * To observe changes to the value (including those from remote clients), register for the
+ * {@link ISharedCounterEvents | incremented} event:
+ *
+ * ```typescript
+ * counter.on("incremented", (incrementAmount, newValue) => {
+ *     console.log(`The counter incremented by ${incrementAmount} and now has a value of ${newValue}`);
+ * });
+ * ```
+ *
+ * @public
+ */
+export declare interface ISharedCounter extends ISharedObject<ISharedCounterEvents> {
+    /**
+     * The counter value.
+     *
+     * @remarks Must be a whole number.
+     */
+    value: number;
+    /**
+     * Increments or decrements the value.
+     * Must only increment or decrement by a whole number value.
+     *
+     * @param incrementAmount - A whole number to increment or decrement by.
+     */
+    increment(incrementAmount: number): void;
+}
+
+/**
+ * Events sent by {@link SharedCounter}.
+ *
+ * @public
+ */
+export declare interface ISharedCounterEvents extends ISharedObjectEvents {
+    /**
+     * This event is raised when the counter is incremented or decremented.
+     *
+     * @param event - The event name.
+     * @param listener - An event listener.
+     *
+     * @eventProperty
+     */
+    (event: "incremented", listener: (incrementAmount: number, newValue: number) => void): any;
+}
+
+/**
+ * {@inheritDoc ISharedCounter}
+ *
+ * @public
+ */
+export declare class SharedCounter extends SharedObject<ISharedCounterEvents> implements ISharedCounter {
+    /**
+     * Create a new {@link SharedCounter}.
+     *
+     * @param runtime - The data store runtime to which the new `SharedCounter` will belong.
+     * @param id - Optional name of the `SharedCounter`. If not provided, one will be generated.
+     *
+     * @returns newly create shared counter (but not attached yet)
+     */
+    static create(runtime: IFluidDataStoreRuntime, id?: string): SharedCounter;
+    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
+    /**
+     * Get a factory for {@link SharedCounter} to register with the data store.
+     *
+     * @returns a factory that creates and load SharedCounter
+     */
+    static getFactory(): IChannelFactory;
+    private _value;
+    /**
+     * {@inheritDoc ISharedCounter.value}
+     */
+    get value(): number;
+    /**
+     * {@inheritDoc ISharedCounter.increment}
+     */
+    increment(incrementAmount: number): void;
+    private incrementCore;
+    /**
+     * Create a summary for the counter.
+     *
+     * @returns The summary of the current state of the counter.
+     */
+    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
+    /**
+     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
+     */
+    protected loadCore(storage: IChannelStorageService): Promise<void>;
+    /**
+     * Called when the object has disconnected from the delta stream.
+     */
+    protected onDisconnect(): void;
+    /**
+     * Process a counter operation (op).
+     *
+     * @param message - The message to prepare.
+     * @param local - Whether or not the message was sent by the local client.
+     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
+     * For messages from a remote client, this will be `undefined`.
+     */
+    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    /**
+     * {@inheritdoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}
+     */
+    protected applyStashedOp(op: unknown): void;
+}
+
+export { }