@fluidframework/counter 0.47.1 → 0.48.0-38105

package/dist/counter.d.ts

@@ -9,6 +9,7 @@ import { SharedObject } from "@fluidframework/shared-object-base";
 import { ISharedCounter, ISharedCounterEvents } from "./interfaces";
 /**
  * A `SharedCounter` is a shared object which holds a number that can be incremented or decremented.
+ * @public
  *
  * @remarks
  * ### Creation
@@ -66,18 +67,22 @@ export declare class SharedCounter extends SharedObject<ISharedCounterEvents> im
      * Create a snapshot for the counter
      *
      * @returns the snapshot of the current state of the counter
+     * @internal
      */
     protected snapshotCore(serializer: IFluidSerializer): ITree;
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
+     * @internal
      */
     protected loadCore(storage: IChannelStorageService): Promise<void>;
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.registerCore}
+     * @internal
      */
     protected registerCore(): void;
     /**
-     * Call back on disconnect
+     * Called when the object has disconnected from the delta stream.
+     * @internal
      */
     protected onDisconnect(): void;
     /**
@@ -91,6 +96,7 @@ export declare class SharedCounter extends SharedObject<ISharedCounterEvents> im
     protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
     /**
      * Not implemented.
+     * @internal
      */
     protected applyStashedOp(): void;
 }

package/dist/counter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"counter.d.ts","sourceRoot":"","sources":["../src/counter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAEH,yBAAyB,EACzB,KAAK,EAGR,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACH,sBAAsB,EACtB,sBAAsB,EACtB,eAAe,EAClB,MAAM,uCAAuC,CAAC;AAE/C,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAoBpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,aAAc,SAAQ,YAAY,CAAC,oBAAoB,CAAE,YAAW,cAAc;IAC3F;;;;;;OAMG;WACW,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM;IAIjE;;;;OAIG;WACW,UAAU,IAAI,eAAe;IAI3C,OAAO,CAAC,MAAM,CAAa;IAE3B;;OAEG;IACH,IAAW,KAAK,WAEf;IAED;;OAEG;IACI,SAAS,CAAC,eAAe,EAAE,MAAM;IAgBxC,OAAO,CAAC,aAAa;IAKrB;;;;OAIG;IACH,SAAS,CAAC,YAAY,CAAC,UAAU,EAAE,gBAAgB,GAAG,KAAK;IAwB3D;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMxE;;OAEG;IACH,SAAS,CAAC,YAAY;IAGtB;;OAEG;IACH,SAAS,CAAC,YAAY;IAEtB;;;;;;;OAOG;IACH,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;IAelG;;OAEG;IACH,SAAS,CAAC,cAAc;CAG3B"}
+{"version":3,"file":"counter.d.ts","sourceRoot":"","sources":["../src/counter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAEH,yBAAyB,EACzB,KAAK,EAGR,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACH,sBAAsB,EACtB,sBAAsB,EACtB,eAAe,EAClB,MAAM,uCAAuC,CAAC;AAE/C,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAoBpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,aAAc,SAAQ,YAAY,CAAC,oBAAoB,CAAE,YAAW,cAAc;IAC3F;;;;;;OAMG;WACW,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM;IAIjE;;;;OAIG;WACW,UAAU,IAAI,eAAe;IAI3C,OAAO,CAAC,MAAM,CAAa;IAE3B;;OAEG;IACH,IAAW,KAAK,WAEf;IAED;;OAEG;IACI,SAAS,CAAC,eAAe,EAAE,MAAM;IAgBxC,OAAO,CAAC,aAAa;IAKrB;;;;;OAKG;IACH,SAAS,CAAC,YAAY,CAAC,UAAU,EAAE,gBAAgB,GAAG,KAAK;IAwB3D;;;OAGG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMxE;;;OAGG;IACH,SAAS,CAAC,YAAY;IAGtB;;;OAGG;IACH,SAAS,CAAC,YAAY;IAEtB;;;;;;;OAOG;IACH,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;IAelG;;;OAGG;IACH,SAAS,CAAC,cAAc;CAG3B"}

package/dist/counter.js

@@ -12,6 +12,7 @@ const counterFactory_1 = require("./counterFactory");
 const snapshotFileName = "header";
 /**
  * A `SharedCounter` is a shared object which holds a number that can be incremented or decremented.
+ * @public
  *
  * @remarks
  * ### Creation
@@ -93,6 +94,7 @@ class SharedCounter extends shared_object_base_1.SharedObject {
      * Create a snapshot for the counter
      *
      * @returns the snapshot of the current state of the counter
+     * @internal
      */
     snapshotCore(serializer) {
         // Get a serializable form of data
@@ -117,6 +119,7 @@ class SharedCounter extends shared_object_base_1.SharedObject {
     }
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
+     * @internal
      */
     async loadCore(storage) {
         const content = await driver_utils_1.readAndParse(storage, snapshotFileName);
@@ -124,11 +127,13 @@ class SharedCounter extends shared_object_base_1.SharedObject {
     }
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.registerCore}
+     * @internal
      */
     registerCore() {
     }
     /**
-     * Call back on disconnect
+     * Called when the object has disconnected from the delta stream.
+     * @internal
      */
     onDisconnect() { }
     /**
@@ -153,6 +158,7 @@ class SharedCounter extends shared_object_base_1.SharedObject {
     }
     /**
      * Not implemented.
+     * @internal
      */
     applyStashedOp() {
         throw new Error("not implemented");

package/dist/counter.js.map

@@ -1 +1 @@
-{"version":3,"file":"counter.js","sourceRoot":"","sources":["../src/counter.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+EAM8C;AAM9C,+DAA4D;AAC5D,2EAAkE;AAClE,qDAAkD;AAmBlD,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAa,aAAc,SAAQ,iCAAkC;IAArE;;QAqBY,WAAM,GAAW,CAAC,CAAC;IA+G/B,CAAC;IAnIG;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,OAA+B,EAAE,EAAW;QAC7D,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,+BAAc,CAAC,IAAI,CAAkB,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,+BAAc,EAAE,CAAC;IAChC,CAAC;IAID;;OAEG;IACH,IAAW,KAAK;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,eAAuB;QACpC,uGAAuG;QACvG,wGAAwG;QACxG,IAAI,eAAe,GAAG,CAAC,KAAK,CAAC,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;SACvD;QAED,MAAM,EAAE,GAAwB;YAC5B,IAAI,EAAE,WAAW;YACjB,eAAe;SAClB,CAAC;QAEF,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;QACpC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC;IAEO,aAAa,CAAC,eAAuB;QACzC,IAAI,CAAC,MAAM,IAAI,eAAe,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,eAAe,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACO,YAAY,CAAC,UAA4B;QAC/C,kCAAkC;QAClC,MAAM,OAAO,GAA2B;YACpC,KAAK,EAAE,IAAI,CAAC,KAAK;SACpB,CAAC;QAEF,qCAAqC;QACrC,MAAM,IAAI,GAAU;YAChB,OAAO,EAAE;gBACL;oBACI,IAAI,EAAE,+BAAQ,CAAC,IAAI;oBACnB,IAAI,EAAE,gBAAgB;oBACtB,IAAI,EAAE,gCAAS,CAAC,IAAI;oBACpB,KAAK,EAAE;wBACH,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;wBACjC,QAAQ,EAAE,OAAO;qBACpB;iBACJ;aACJ;SACJ,CAAC;QAEF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,QAAQ,CAAC,OAA+B;QACpD,MAAM,OAAO,GAAG,MAAM,2BAAY,CAAyB,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAEtF,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAChC,CAAC;IAED;;OAEG;IACO,YAAY;IACtB,CAAC;IAED;;OAEG;IACO,YAAY,KAAI,CAAC;IAE3B;;;;;;;OAOG;IACO,WAAW,CAAC,OAAkC,EAAE,KAAc,EAAE,eAAwB;QAC9F,IAAI,OAAO,CAAC,IAAI,KAAK,kCAAW,CAAC,SAAS,IAAI,CAAC,KAAK,EAAE;YAClD,MAAM,EAAE,GAAG,OAAO,CAAC,QAA+B,CAAC;YAEnD,QAAQ,EAAE,CAAC,IAAI,EAAE;gBACb,KAAK,WAAW;oBACZ,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC;oBACvC,MAAM;gBAEV;oBACI,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;aAC5C;SACJ;IACL,CAAC;IAED;;OAEG;IACO,cAAc;QACpB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;CACJ;AApID,sCAoIC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidSerializer } from \"@fluidframework/core-interfaces\";\nimport {\n    FileMode,\n    ISequencedDocumentMessage,\n    ITree,\n    MessageType,\n    TreeEntry,\n} from \"@fluidframework/protocol-definitions\";\nimport {\n    IFluidDataStoreRuntime,\n    IChannelStorageService,\n    IChannelFactory,\n} from \"@fluidframework/datastore-definitions\";\nimport { readAndParse } from \"@fluidframework/driver-utils\";\nimport { SharedObject } from \"@fluidframework/shared-object-base\";\nimport { CounterFactory } from \"./counterFactory\";\nimport { ISharedCounter, ISharedCounterEvents } from \"./interfaces\";\n\n/**\n * Describes the op format for incrementing the counter\n */\ninterface IIncrementOperation {\n    type: \"increment\";\n    incrementAmount: number;\n}\n\n/**\n * Used in snapshotting.\n */\ninterface ICounterSnapshotFormat {\n    // The value of the counter\n    value: number;\n}\n\nconst snapshotFileName = \"header\";\n\n/**\n * A `SharedCounter` is a shared object which holds a number that can be incremented or decremented.\n *\n * @remarks\n * ### Creation\n *\n * To create a `SharedCounter`, get the factory and call create 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 * ### Usage\n *\n * Once created, you can call `increment` to modify the value with either a positive or 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 `\"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 */\nexport class SharedCounter extends SharedObject<ISharedCounterEvents> implements ISharedCounter {\n    /**\n     * Create a new shared counter\n     *\n     * @param runtime - data store runtime the new shared counter belongs to\n     * @param id - optional name of the shared counter\n     * @returns newly create shared counter (but not attached yet)\n     */\n    public static create(runtime: IFluidDataStoreRuntime, id?: string) {\n        return runtime.createChannel(id, CounterFactory.Type) as SharedCounter;\n    }\n\n    /**\n     * Get a factory for SharedCounter to register with the data store.\n     *\n     * @returns a factory that creates and load SharedCounter\n     */\n    public static getFactory(): IChannelFactory {\n        return new CounterFactory();\n    }\n\n    private _value: number = 0;\n\n    /**\n     * {@inheritDoc ISharedCounter.value}\n     */\n    public get value() {\n        return this._value;\n    }\n\n    /**\n     * {@inheritDoc ISharedCounter.increment}\n     */\n    public increment(incrementAmount: number) {\n        // Incrementing by floating point numbers will be eventually inconsistent, since the order in which the\n        // increments are applied affects the result.  A more-robust solution would be required to support this.\n        if (incrementAmount % 1 !== 0) {\n            throw new Error(\"Must increment by a whole number\");\n        }\n\n        const op: IIncrementOperation = {\n            type: \"increment\",\n            incrementAmount,\n        };\n\n        this.incrementCore(incrementAmount);\n        this.submitLocalMessage(op);\n    }\n\n    private incrementCore(incrementAmount: number) {\n        this._value += incrementAmount;\n        this.emit(\"incremented\", incrementAmount, this._value);\n    }\n\n    /**\n     * Create a snapshot for the counter\n     *\n     * @returns the snapshot of the current state of the counter\n     */\n    protected snapshotCore(serializer: IFluidSerializer): ITree {\n        // Get a serializable form of data\n        const content: ICounterSnapshotFormat = {\n            value: this.value,\n        };\n\n        // And then construct the tree for it\n        const tree: ITree = {\n            entries: [\n                {\n                    mode: FileMode.File,\n                    path: snapshotFileName,\n                    type: TreeEntry.Blob,\n                    value: {\n                        contents: JSON.stringify(content),\n                        encoding: \"utf-8\",\n                    },\n                },\n            ],\n        };\n\n        return tree;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}\n     */\n    protected async loadCore(storage: IChannelStorageService): Promise<void> {\n        const content = await readAndParse<ICounterSnapshotFormat>(storage, snapshotFileName);\n\n        this._value = content.value;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.registerCore}\n     */\n    protected registerCore() {\n    }\n\n    /**\n     * Call back on disconnect\n     */\n    protected onDisconnect() {}\n\n    /**\n     * Process a counter operation\n     *\n     * @param message - the message to prepare\n     * @param local - whether the message was sent by the local client\n     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n     * For messages from a remote client, this will be undefined.\n     */\n    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) {\n        if (message.type === MessageType.Operation && !local) {\n            const op = message.contents as IIncrementOperation;\n\n            switch (op.type) {\n                case \"increment\":\n                    this.incrementCore(op.incrementAmount);\n                    break;\n\n                default:\n                    throw new Error(\"Unknown operation\");\n            }\n        }\n    }\n\n    /**\n     * Not implemented.\n     */\n    protected applyStashedOp() {\n        throw new Error(\"not implemented\");\n    }\n}\n"]}
+{"version":3,"file":"counter.js","sourceRoot":"","sources":["../src/counter.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+EAM8C;AAM9C,+DAA4D;AAC5D,2EAAkE;AAClE,qDAAkD;AAmBlD,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAa,aAAc,SAAQ,iCAAkC;IAArE;;QAqBY,WAAM,GAAW,CAAC,CAAC;IAoH/B,CAAC;IAxIG;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,OAA+B,EAAE,EAAW;QAC7D,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,+BAAc,CAAC,IAAI,CAAkB,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,+BAAc,EAAE,CAAC;IAChC,CAAC;IAID;;OAEG;IACH,IAAW,KAAK;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,eAAuB;QACpC,uGAAuG;QACvG,wGAAwG;QACxG,IAAI,eAAe,GAAG,CAAC,KAAK,CAAC,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;SACvD;QAED,MAAM,EAAE,GAAwB;YAC5B,IAAI,EAAE,WAAW;YACjB,eAAe;SAClB,CAAC;QAEF,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;QACpC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC;IAEO,aAAa,CAAC,eAAuB;QACzC,IAAI,CAAC,MAAM,IAAI,eAAe,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,eAAe,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACO,YAAY,CAAC,UAA4B;QAC/C,kCAAkC;QAClC,MAAM,OAAO,GAA2B;YACpC,KAAK,EAAE,IAAI,CAAC,KAAK;SACpB,CAAC;QAEF,qCAAqC;QACrC,MAAM,IAAI,GAAU;YAChB,OAAO,EAAE;gBACL;oBACI,IAAI,EAAE,+BAAQ,CAAC,IAAI;oBACnB,IAAI,EAAE,gBAAgB;oBACtB,IAAI,EAAE,gCAAS,CAAC,IAAI;oBACpB,KAAK,EAAE;wBACH,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;wBACjC,QAAQ,EAAE,OAAO;qBACpB;iBACJ;aACJ;SACJ,CAAC;QAEF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,QAAQ,CAAC,OAA+B;QACpD,MAAM,OAAO,GAAG,MAAM,2BAAY,CAAyB,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAEtF,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAChC,CAAC;IAED;;;OAGG;IACO,YAAY;IACtB,CAAC;IAED;;;OAGG;IACO,YAAY,KAAK,CAAC;IAE5B;;;;;;;OAOG;IACO,WAAW,CAAC,OAAkC,EAAE,KAAc,EAAE,eAAwB;QAC9F,IAAI,OAAO,CAAC,IAAI,KAAK,kCAAW,CAAC,SAAS,IAAI,CAAC,KAAK,EAAE;YAClD,MAAM,EAAE,GAAG,OAAO,CAAC,QAA+B,CAAC;YAEnD,QAAQ,EAAE,CAAC,IAAI,EAAE;gBACb,KAAK,WAAW;oBACZ,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC;oBACvC,MAAM;gBAEV;oBACI,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;aAC5C;SACJ;IACL,CAAC;IAED;;;OAGG;IACO,cAAc;QACpB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;CACJ;AAzID,sCAyIC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidSerializer } from \"@fluidframework/core-interfaces\";\nimport {\n    FileMode,\n    ISequencedDocumentMessage,\n    ITree,\n    MessageType,\n    TreeEntry,\n} from \"@fluidframework/protocol-definitions\";\nimport {\n    IFluidDataStoreRuntime,\n    IChannelStorageService,\n    IChannelFactory,\n} from \"@fluidframework/datastore-definitions\";\nimport { readAndParse } from \"@fluidframework/driver-utils\";\nimport { SharedObject } from \"@fluidframework/shared-object-base\";\nimport { CounterFactory } from \"./counterFactory\";\nimport { ISharedCounter, ISharedCounterEvents } from \"./interfaces\";\n\n/**\n * Describes the op format for incrementing the counter\n */\ninterface IIncrementOperation {\n    type: \"increment\";\n    incrementAmount: number;\n}\n\n/**\n * Used in snapshotting.\n */\ninterface ICounterSnapshotFormat {\n    // The value of the counter\n    value: number;\n}\n\nconst snapshotFileName = \"header\";\n\n/**\n * A `SharedCounter` is a shared object which holds a number that can be incremented or decremented.\n * @public\n *\n * @remarks\n * ### Creation\n *\n * To create a `SharedCounter`, get the factory and call create 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 * ### Usage\n *\n * Once created, you can call `increment` to modify the value with either a positive or 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 `\"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 */\nexport class SharedCounter extends SharedObject<ISharedCounterEvents> implements ISharedCounter {\n    /**\n     * Create a new shared counter\n     *\n     * @param runtime - data store runtime the new shared counter belongs to\n     * @param id - optional name of the shared counter\n     * @returns newly create shared counter (but not attached yet)\n     */\n    public static create(runtime: IFluidDataStoreRuntime, id?: string) {\n        return runtime.createChannel(id, CounterFactory.Type) as SharedCounter;\n    }\n\n    /**\n     * Get a factory for SharedCounter to register with the data store.\n     *\n     * @returns a factory that creates and load SharedCounter\n     */\n    public static getFactory(): IChannelFactory {\n        return new CounterFactory();\n    }\n\n    private _value: number = 0;\n\n    /**\n     * {@inheritDoc ISharedCounter.value}\n     */\n    public get value() {\n        return this._value;\n    }\n\n    /**\n     * {@inheritDoc ISharedCounter.increment}\n     */\n    public increment(incrementAmount: number) {\n        // Incrementing by floating point numbers will be eventually inconsistent, since the order in which the\n        // increments are applied affects the result.  A more-robust solution would be required to support this.\n        if (incrementAmount % 1 !== 0) {\n            throw new Error(\"Must increment by a whole number\");\n        }\n\n        const op: IIncrementOperation = {\n            type: \"increment\",\n            incrementAmount,\n        };\n\n        this.incrementCore(incrementAmount);\n        this.submitLocalMessage(op);\n    }\n\n    private incrementCore(incrementAmount: number) {\n        this._value += incrementAmount;\n        this.emit(\"incremented\", incrementAmount, this._value);\n    }\n\n    /**\n     * Create a snapshot for the counter\n     *\n     * @returns the snapshot of the current state of the counter\n     * @internal\n     */\n    protected snapshotCore(serializer: IFluidSerializer): ITree {\n        // Get a serializable form of data\n        const content: ICounterSnapshotFormat = {\n            value: this.value,\n        };\n\n        // And then construct the tree for it\n        const tree: ITree = {\n            entries: [\n                {\n                    mode: FileMode.File,\n                    path: snapshotFileName,\n                    type: TreeEntry.Blob,\n                    value: {\n                        contents: JSON.stringify(content),\n                        encoding: \"utf-8\",\n                    },\n                },\n            ],\n        };\n\n        return tree;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}\n     * @internal\n     */\n    protected async loadCore(storage: IChannelStorageService): Promise<void> {\n        const content = await readAndParse<ICounterSnapshotFormat>(storage, snapshotFileName);\n\n        this._value = content.value;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.registerCore}\n     * @internal\n     */\n    protected registerCore() {\n    }\n\n    /**\n     * Called when the object has disconnected from the delta stream.\n     * @internal\n     */\n    protected onDisconnect() { }\n\n    /**\n     * Process a counter operation\n     *\n     * @param message - the message to prepare\n     * @param local - whether the message was sent by the local client\n     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n     * For messages from a remote client, this will be undefined.\n     */\n    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) {\n        if (message.type === MessageType.Operation && !local) {\n            const op = message.contents as IIncrementOperation;\n\n            switch (op.type) {\n                case \"increment\":\n                    this.incrementCore(op.incrementAmount);\n                    break;\n\n                default:\n                    throw new Error(\"Unknown operation\");\n            }\n        }\n    }\n\n    /**\n     * Not implemented.\n     * @internal\n     */\n    protected applyStashedOp() {\n        throw new Error(\"not implemented\");\n    }\n}\n"]}

package/dist/index.d.ts

@@ -3,7 +3,8 @@
  * Licensed under the MIT License.
  */
 /**
- * This package contains the SharedCounter distributed data structure.
+ * This package contains the SharedCounter distributed data structure. A SharedCounter is a shared object
+ * which holds a number that can be incremented or decremented.
  *
  * @packageDocumentation
  */

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AAEH,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAEH,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC"}

package/dist/index.js

@@ -15,7 +15,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
- * This package contains the SharedCounter distributed data structure.
+ * This package contains the SharedCounter distributed data structure. A SharedCounter is a shared object
+ * which holds a number that can be incremented or decremented.
  *
  * @packageDocumentation
  */

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;AAEH;;;;GAIG;AAEH,4CAA0B;AAC1B,+CAA6B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * This package contains the SharedCounter distributed data structure.\n *\n * @packageDocumentation\n */\n\nexport * from \"./counter\";\nexport * from \"./interfaces\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;AAEH;;;;;GAKG;AAEH,4CAA0B;AAC1B,+CAA6B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * This package contains the SharedCounter distributed data structure. A SharedCounter is a shared object\n * which holds a number that can be incremented or decremented.\n *\n * @packageDocumentation\n */\n\nexport * from \"./counter\";\nexport * from \"./interfaces\";\n"]}

package/dist/interfaces.d.ts

@@ -3,6 +3,10 @@
  * Licensed under the MIT License.
  */
 import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base";
+/**
+ * Events sent by SharedCounters.
+ * @public
+ */
 export interface ISharedCounterEvents extends ISharedObjectEvents {
     /**
      * This event is raised when the counter is incremented or decremented.
@@ -15,7 +19,8 @@ export interface ISharedCounterEvents extends ISharedObjectEvents {
     (event: "incremented", listener: (incrementAmount: number, newValue: number) => void): any;
 }
 /**
- * Shared counter interface
+ * SharedCounter interface.
+ * @public
  */
 export interface ISharedCounter extends ISharedObject<ISharedCounterEvents> {
     /**
@@ -25,7 +30,7 @@ export interface ISharedCounter extends ISharedObject<ISharedCounterEvents> {
     /**
      * 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
+     * @param incrementAmount - a whole number to increment or decrement by.
      */
     increment(incrementAmount: number): void;
 }

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,aAAa,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAExF,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAC7D;;;;;;;OAOG;IACH,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CACzF;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,aAAa,CAAC,oBAAoB,CAAC;IACvE;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,SAAS,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5C"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAExF;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAC7D;;;;;;;OAOG;IACH,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CACzF;AAED;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,aAAa,CAAC,oBAAoB,CAAC;IACvE;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,SAAS,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5C"}

package/dist/interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","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 { ISharedObject, ISharedObjectEvents } from \"@fluidframework/shared-object-base\";\n\nexport interface ISharedCounterEvents extends ISharedObjectEvents {\n    /**\n     * This event is raised when the counter is incremented or decremented.\n     *\n     * @param event - The event name.\n     * @param listener - An event listener.\n     *\n     * @eventProperty\n     */\n    (event: \"incremented\", listener: (incrementAmount: number, newValue: number) => void);\n}\n\n/**\n * Shared counter interface\n */\nexport interface ISharedCounter extends ISharedObject<ISharedCounterEvents> {\n    /**\n     * The counter value.\n     */\n    value: number;\n\n    /**\n     * Increments or decrements the value.  Must only increment or decrement by a whole number value.\n     *\n     * @param incrementAmount - a whole number to increment or decrement by\n     */\n    increment(incrementAmount: number): void;\n}\n"]}
+{"version":3,"file":"interfaces.js","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 { ISharedObject, ISharedObjectEvents } from \"@fluidframework/shared-object-base\";\n\n/**\n * Events sent by SharedCounters.\n * @public\n */\nexport interface ISharedCounterEvents extends ISharedObjectEvents {\n    /**\n     * This event is raised when the counter is incremented or decremented.\n     *\n     * @param event - The event name.\n     * @param listener - An event listener.\n     *\n     * @eventProperty\n     */\n    (event: \"incremented\", listener: (incrementAmount: number, newValue: number) => void);\n}\n\n/**\n * SharedCounter interface.\n * @public\n */\nexport interface ISharedCounter extends ISharedObject<ISharedCounterEvents> {\n    /**\n     * The counter value.\n     */\n    value: number;\n\n    /**\n     * Increments or decrements the value.  Must only increment or decrement by a whole number value.\n     *\n     * @param incrementAmount - a whole number to increment or decrement by.\n     */\n    increment(incrementAmount: number): void;\n}\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 = "0.47.1";
+export declare const pkgVersion = "0.48.0-38105";
 //# 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,4BAA4B,CAAC;AACjD,eAAO,MAAM,UAAU,WAAW,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,4BAA4B,CAAC;AACjD,eAAO,MAAM,UAAU,iBAAiB,CAAC"}

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/counter";
-exports.pkgVersion = "0.47.1";
+exports.pkgVersion = "0.48.0-38105";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,yBAAyB,CAAC;AACpC,QAAA,UAAU,GAAG,QAAQ,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 = \"0.47.1\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,yBAAyB,CAAC;AACpC,QAAA,UAAU,GAAG,cAAc,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 = \"0.48.0-38105\";\n"]}

package/lib/counter.d.ts

@@ -9,6 +9,7 @@ import { SharedObject } from "@fluidframework/shared-object-base";
 import { ISharedCounter, ISharedCounterEvents } from "./interfaces";
 /**
  * A `SharedCounter` is a shared object which holds a number that can be incremented or decremented.
+ * @public
  *
  * @remarks
  * ### Creation
@@ -66,18 +67,22 @@ export declare class SharedCounter extends SharedObject<ISharedCounterEvents> im
      * Create a snapshot for the counter
      *
      * @returns the snapshot of the current state of the counter
+     * @internal
      */
     protected snapshotCore(serializer: IFluidSerializer): ITree;
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
+     * @internal
      */
     protected loadCore(storage: IChannelStorageService): Promise<void>;
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.registerCore}
+     * @internal
      */
     protected registerCore(): void;
     /**
-     * Call back on disconnect
+     * Called when the object has disconnected from the delta stream.
+     * @internal
      */
     protected onDisconnect(): void;
     /**
@@ -91,6 +96,7 @@ export declare class SharedCounter extends SharedObject<ISharedCounterEvents> im
     protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
     /**
      * Not implemented.
+     * @internal
      */
     protected applyStashedOp(): void;
 }

package/lib/counter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"counter.d.ts","sourceRoot":"","sources":["../src/counter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAEH,yBAAyB,EACzB,KAAK,EAGR,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACH,sBAAsB,EACtB,sBAAsB,EACtB,eAAe,EAClB,MAAM,uCAAuC,CAAC;AAE/C,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAoBpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,aAAc,SAAQ,YAAY,CAAC,oBAAoB,CAAE,YAAW,cAAc;IAC3F;;;;;;OAMG;WACW,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM;IAIjE;;;;OAIG;WACW,UAAU,IAAI,eAAe;IAI3C,OAAO,CAAC,MAAM,CAAa;IAE3B;;OAEG;IACH,IAAW,KAAK,WAEf;IAED;;OAEG;IACI,SAAS,CAAC,eAAe,EAAE,MAAM;IAgBxC,OAAO,CAAC,aAAa;IAKrB;;;;OAIG;IACH,SAAS,CAAC,YAAY,CAAC,UAAU,EAAE,gBAAgB,GAAG,KAAK;IAwB3D;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMxE;;OAEG;IACH,SAAS,CAAC,YAAY;IAGtB;;OAEG;IACH,SAAS,CAAC,YAAY;IAEtB;;;;;;;OAOG;IACH,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;IAelG;;OAEG;IACH,SAAS,CAAC,cAAc;CAG3B"}
+{"version":3,"file":"counter.d.ts","sourceRoot":"","sources":["../src/counter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAEH,yBAAyB,EACzB,KAAK,EAGR,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACH,sBAAsB,EACtB,sBAAsB,EACtB,eAAe,EAClB,MAAM,uCAAuC,CAAC;AAE/C,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAoBpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,aAAc,SAAQ,YAAY,CAAC,oBAAoB,CAAE,YAAW,cAAc;IAC3F;;;;;;OAMG;WACW,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM;IAIjE;;;;OAIG;WACW,UAAU,IAAI,eAAe;IAI3C,OAAO,CAAC,MAAM,CAAa;IAE3B;;OAEG;IACH,IAAW,KAAK,WAEf;IAED;;OAEG;IACI,SAAS,CAAC,eAAe,EAAE,MAAM;IAgBxC,OAAO,CAAC,aAAa;IAKrB;;;;;OAKG;IACH,SAAS,CAAC,YAAY,CAAC,UAAU,EAAE,gBAAgB,GAAG,KAAK;IAwB3D;;;OAGG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMxE;;;OAGG;IACH,SAAS,CAAC,YAAY;IAGtB;;;OAGG;IACH,SAAS,CAAC,YAAY;IAEtB;;;;;;;OAOG;IACH,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;IAelG;;;OAGG;IACH,SAAS,CAAC,cAAc;CAG3B"}

package/lib/counter.js

@@ -9,6 +9,7 @@ import { CounterFactory } from "./counterFactory";
 const snapshotFileName = "header";
 /**
  * A `SharedCounter` is a shared object which holds a number that can be incremented or decremented.
+ * @public
  *
  * @remarks
  * ### Creation
@@ -90,6 +91,7 @@ export class SharedCounter extends SharedObject {
      * Create a snapshot for the counter
      *
      * @returns the snapshot of the current state of the counter
+     * @internal
      */
     snapshotCore(serializer) {
         // Get a serializable form of data
@@ -114,6 +116,7 @@ export class SharedCounter extends SharedObject {
     }
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
+     * @internal
      */
     async loadCore(storage) {
         const content = await readAndParse(storage, snapshotFileName);
@@ -121,11 +124,13 @@ export class SharedCounter extends SharedObject {
     }
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.registerCore}
+     * @internal
      */
     registerCore() {
     }
     /**
-     * Call back on disconnect
+     * Called when the object has disconnected from the delta stream.
+     * @internal
      */
     onDisconnect() { }
     /**
@@ -150,6 +155,7 @@ export class SharedCounter extends SharedObject {
     }
     /**
      * Not implemented.
+     * @internal
      */
     applyStashedOp() {
         throw new Error("not implemented");

package/lib/counter.js.map

@@ -1 +1 @@
-{"version":3,"file":"counter.js","sourceRoot":"","sources":["../src/counter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACH,QAAQ,EAGR,WAAW,EACX,SAAS,GACZ,MAAM,sCAAsC,CAAC;AAM9C,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAmBlD,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,OAAO,aAAc,SAAQ,YAAkC;IAArE;;QAqBY,WAAM,GAAW,CAAC,CAAC;IA+G/B,CAAC;IAnIG;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,OAA+B,EAAE,EAAW;QAC7D,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,cAAc,CAAC,IAAI,CAAkB,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,cAAc,EAAE,CAAC;IAChC,CAAC;IAID;;OAEG;IACH,IAAW,KAAK;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,eAAuB;QACpC,uGAAuG;QACvG,wGAAwG;QACxG,IAAI,eAAe,GAAG,CAAC,KAAK,CAAC,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;SACvD;QAED,MAAM,EAAE,GAAwB;YAC5B,IAAI,EAAE,WAAW;YACjB,eAAe;SAClB,CAAC;QAEF,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;QACpC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC;IAEO,aAAa,CAAC,eAAuB;QACzC,IAAI,CAAC,MAAM,IAAI,eAAe,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,eAAe,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACO,YAAY,CAAC,UAA4B;QAC/C,kCAAkC;QAClC,MAAM,OAAO,GAA2B;YACpC,KAAK,EAAE,IAAI,CAAC,KAAK;SACpB,CAAC;QAEF,qCAAqC;QACrC,MAAM,IAAI,GAAU;YAChB,OAAO,EAAE;gBACL;oBACI,IAAI,EAAE,QAAQ,CAAC,IAAI;oBACnB,IAAI,EAAE,gBAAgB;oBACtB,IAAI,EAAE,SAAS,CAAC,IAAI;oBACpB,KAAK,EAAE;wBACH,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;wBACjC,QAAQ,EAAE,OAAO;qBACpB;iBACJ;aACJ;SACJ,CAAC;QAEF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,QAAQ,CAAC,OAA+B;QACpD,MAAM,OAAO,GAAG,MAAM,YAAY,CAAyB,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAEtF,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAChC,CAAC;IAED;;OAEG;IACO,YAAY;IACtB,CAAC;IAED;;OAEG;IACO,YAAY,KAAI,CAAC;IAE3B;;;;;;;OAOG;IACO,WAAW,CAAC,OAAkC,EAAE,KAAc,EAAE,eAAwB;QAC9F,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS,IAAI,CAAC,KAAK,EAAE;YAClD,MAAM,EAAE,GAAG,OAAO,CAAC,QAA+B,CAAC;YAEnD,QAAQ,EAAE,CAAC,IAAI,EAAE;gBACb,KAAK,WAAW;oBACZ,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC;oBACvC,MAAM;gBAEV;oBACI,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;aAC5C;SACJ;IACL,CAAC;IAED;;OAEG;IACO,cAAc;QACpB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidSerializer } from \"@fluidframework/core-interfaces\";\nimport {\n    FileMode,\n    ISequencedDocumentMessage,\n    ITree,\n    MessageType,\n    TreeEntry,\n} from \"@fluidframework/protocol-definitions\";\nimport {\n    IFluidDataStoreRuntime,\n    IChannelStorageService,\n    IChannelFactory,\n} from \"@fluidframework/datastore-definitions\";\nimport { readAndParse } from \"@fluidframework/driver-utils\";\nimport { SharedObject } from \"@fluidframework/shared-object-base\";\nimport { CounterFactory } from \"./counterFactory\";\nimport { ISharedCounter, ISharedCounterEvents } from \"./interfaces\";\n\n/**\n * Describes the op format for incrementing the counter\n */\ninterface IIncrementOperation {\n    type: \"increment\";\n    incrementAmount: number;\n}\n\n/**\n * Used in snapshotting.\n */\ninterface ICounterSnapshotFormat {\n    // The value of the counter\n    value: number;\n}\n\nconst snapshotFileName = \"header\";\n\n/**\n * A `SharedCounter` is a shared object which holds a number that can be incremented or decremented.\n *\n * @remarks\n * ### Creation\n *\n * To create a `SharedCounter`, get the factory and call create 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 * ### Usage\n *\n * Once created, you can call `increment` to modify the value with either a positive or 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 `\"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 */\nexport class SharedCounter extends SharedObject<ISharedCounterEvents> implements ISharedCounter {\n    /**\n     * Create a new shared counter\n     *\n     * @param runtime - data store runtime the new shared counter belongs to\n     * @param id - optional name of the shared counter\n     * @returns newly create shared counter (but not attached yet)\n     */\n    public static create(runtime: IFluidDataStoreRuntime, id?: string) {\n        return runtime.createChannel(id, CounterFactory.Type) as SharedCounter;\n    }\n\n    /**\n     * Get a factory for SharedCounter to register with the data store.\n     *\n     * @returns a factory that creates and load SharedCounter\n     */\n    public static getFactory(): IChannelFactory {\n        return new CounterFactory();\n    }\n\n    private _value: number = 0;\n\n    /**\n     * {@inheritDoc ISharedCounter.value}\n     */\n    public get value() {\n        return this._value;\n    }\n\n    /**\n     * {@inheritDoc ISharedCounter.increment}\n     */\n    public increment(incrementAmount: number) {\n        // Incrementing by floating point numbers will be eventually inconsistent, since the order in which the\n        // increments are applied affects the result.  A more-robust solution would be required to support this.\n        if (incrementAmount % 1 !== 0) {\n            throw new Error(\"Must increment by a whole number\");\n        }\n\n        const op: IIncrementOperation = {\n            type: \"increment\",\n            incrementAmount,\n        };\n\n        this.incrementCore(incrementAmount);\n        this.submitLocalMessage(op);\n    }\n\n    private incrementCore(incrementAmount: number) {\n        this._value += incrementAmount;\n        this.emit(\"incremented\", incrementAmount, this._value);\n    }\n\n    /**\n     * Create a snapshot for the counter\n     *\n     * @returns the snapshot of the current state of the counter\n     */\n    protected snapshotCore(serializer: IFluidSerializer): ITree {\n        // Get a serializable form of data\n        const content: ICounterSnapshotFormat = {\n            value: this.value,\n        };\n\n        // And then construct the tree for it\n        const tree: ITree = {\n            entries: [\n                {\n                    mode: FileMode.File,\n                    path: snapshotFileName,\n                    type: TreeEntry.Blob,\n                    value: {\n                        contents: JSON.stringify(content),\n                        encoding: \"utf-8\",\n                    },\n                },\n            ],\n        };\n\n        return tree;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}\n     */\n    protected async loadCore(storage: IChannelStorageService): Promise<void> {\n        const content = await readAndParse<ICounterSnapshotFormat>(storage, snapshotFileName);\n\n        this._value = content.value;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.registerCore}\n     */\n    protected registerCore() {\n    }\n\n    /**\n     * Call back on disconnect\n     */\n    protected onDisconnect() {}\n\n    /**\n     * Process a counter operation\n     *\n     * @param message - the message to prepare\n     * @param local - whether the message was sent by the local client\n     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n     * For messages from a remote client, this will be undefined.\n     */\n    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) {\n        if (message.type === MessageType.Operation && !local) {\n            const op = message.contents as IIncrementOperation;\n\n            switch (op.type) {\n                case \"increment\":\n                    this.incrementCore(op.incrementAmount);\n                    break;\n\n                default:\n                    throw new Error(\"Unknown operation\");\n            }\n        }\n    }\n\n    /**\n     * Not implemented.\n     */\n    protected applyStashedOp() {\n        throw new Error(\"not implemented\");\n    }\n}\n"]}
+{"version":3,"file":"counter.js","sourceRoot":"","sources":["../src/counter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACH,QAAQ,EAGR,WAAW,EACX,SAAS,GACZ,MAAM,sCAAsC,CAAC;AAM9C,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAmBlD,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,OAAO,aAAc,SAAQ,YAAkC;IAArE;;QAqBY,WAAM,GAAW,CAAC,CAAC;IAoH/B,CAAC;IAxIG;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,OAA+B,EAAE,EAAW;QAC7D,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,cAAc,CAAC,IAAI,CAAkB,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU;QACpB,OAAO,IAAI,cAAc,EAAE,CAAC;IAChC,CAAC;IAID;;OAEG;IACH,IAAW,KAAK;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,eAAuB;QACpC,uGAAuG;QACvG,wGAAwG;QACxG,IAAI,eAAe,GAAG,CAAC,KAAK,CAAC,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;SACvD;QAED,MAAM,EAAE,GAAwB;YAC5B,IAAI,EAAE,WAAW;YACjB,eAAe;SAClB,CAAC;QAEF,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;QACpC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC;IAEO,aAAa,CAAC,eAAuB;QACzC,IAAI,CAAC,MAAM,IAAI,eAAe,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,eAAe,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACO,YAAY,CAAC,UAA4B;QAC/C,kCAAkC;QAClC,MAAM,OAAO,GAA2B;YACpC,KAAK,EAAE,IAAI,CAAC,KAAK;SACpB,CAAC;QAEF,qCAAqC;QACrC,MAAM,IAAI,GAAU;YAChB,OAAO,EAAE;gBACL;oBACI,IAAI,EAAE,QAAQ,CAAC,IAAI;oBACnB,IAAI,EAAE,gBAAgB;oBACtB,IAAI,EAAE,SAAS,CAAC,IAAI;oBACpB,KAAK,EAAE;wBACH,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;wBACjC,QAAQ,EAAE,OAAO;qBACpB;iBACJ;aACJ;SACJ,CAAC;QAEF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,QAAQ,CAAC,OAA+B;QACpD,MAAM,OAAO,GAAG,MAAM,YAAY,CAAyB,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAEtF,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAChC,CAAC;IAED;;;OAGG;IACO,YAAY;IACtB,CAAC;IAED;;;OAGG;IACO,YAAY,KAAK,CAAC;IAE5B;;;;;;;OAOG;IACO,WAAW,CAAC,OAAkC,EAAE,KAAc,EAAE,eAAwB;QAC9F,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS,IAAI,CAAC,KAAK,EAAE;YAClD,MAAM,EAAE,GAAG,OAAO,CAAC,QAA+B,CAAC;YAEnD,QAAQ,EAAE,CAAC,IAAI,EAAE;gBACb,KAAK,WAAW;oBACZ,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC;oBACvC,MAAM;gBAEV;oBACI,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;aAC5C;SACJ;IACL,CAAC;IAED;;;OAGG;IACO,cAAc;QACpB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidSerializer } from \"@fluidframework/core-interfaces\";\nimport {\n    FileMode,\n    ISequencedDocumentMessage,\n    ITree,\n    MessageType,\n    TreeEntry,\n} from \"@fluidframework/protocol-definitions\";\nimport {\n    IFluidDataStoreRuntime,\n    IChannelStorageService,\n    IChannelFactory,\n} from \"@fluidframework/datastore-definitions\";\nimport { readAndParse } from \"@fluidframework/driver-utils\";\nimport { SharedObject } from \"@fluidframework/shared-object-base\";\nimport { CounterFactory } from \"./counterFactory\";\nimport { ISharedCounter, ISharedCounterEvents } from \"./interfaces\";\n\n/**\n * Describes the op format for incrementing the counter\n */\ninterface IIncrementOperation {\n    type: \"increment\";\n    incrementAmount: number;\n}\n\n/**\n * Used in snapshotting.\n */\ninterface ICounterSnapshotFormat {\n    // The value of the counter\n    value: number;\n}\n\nconst snapshotFileName = \"header\";\n\n/**\n * A `SharedCounter` is a shared object which holds a number that can be incremented or decremented.\n * @public\n *\n * @remarks\n * ### Creation\n *\n * To create a `SharedCounter`, get the factory and call create 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 * ### Usage\n *\n * Once created, you can call `increment` to modify the value with either a positive or 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 `\"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 */\nexport class SharedCounter extends SharedObject<ISharedCounterEvents> implements ISharedCounter {\n    /**\n     * Create a new shared counter\n     *\n     * @param runtime - data store runtime the new shared counter belongs to\n     * @param id - optional name of the shared counter\n     * @returns newly create shared counter (but not attached yet)\n     */\n    public static create(runtime: IFluidDataStoreRuntime, id?: string) {\n        return runtime.createChannel(id, CounterFactory.Type) as SharedCounter;\n    }\n\n    /**\n     * Get a factory for SharedCounter to register with the data store.\n     *\n     * @returns a factory that creates and load SharedCounter\n     */\n    public static getFactory(): IChannelFactory {\n        return new CounterFactory();\n    }\n\n    private _value: number = 0;\n\n    /**\n     * {@inheritDoc ISharedCounter.value}\n     */\n    public get value() {\n        return this._value;\n    }\n\n    /**\n     * {@inheritDoc ISharedCounter.increment}\n     */\n    public increment(incrementAmount: number) {\n        // Incrementing by floating point numbers will be eventually inconsistent, since the order in which the\n        // increments are applied affects the result.  A more-robust solution would be required to support this.\n        if (incrementAmount % 1 !== 0) {\n            throw new Error(\"Must increment by a whole number\");\n        }\n\n        const op: IIncrementOperation = {\n            type: \"increment\",\n            incrementAmount,\n        };\n\n        this.incrementCore(incrementAmount);\n        this.submitLocalMessage(op);\n    }\n\n    private incrementCore(incrementAmount: number) {\n        this._value += incrementAmount;\n        this.emit(\"incremented\", incrementAmount, this._value);\n    }\n\n    /**\n     * Create a snapshot for the counter\n     *\n     * @returns the snapshot of the current state of the counter\n     * @internal\n     */\n    protected snapshotCore(serializer: IFluidSerializer): ITree {\n        // Get a serializable form of data\n        const content: ICounterSnapshotFormat = {\n            value: this.value,\n        };\n\n        // And then construct the tree for it\n        const tree: ITree = {\n            entries: [\n                {\n                    mode: FileMode.File,\n                    path: snapshotFileName,\n                    type: TreeEntry.Blob,\n                    value: {\n                        contents: JSON.stringify(content),\n                        encoding: \"utf-8\",\n                    },\n                },\n            ],\n        };\n\n        return tree;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}\n     * @internal\n     */\n    protected async loadCore(storage: IChannelStorageService): Promise<void> {\n        const content = await readAndParse<ICounterSnapshotFormat>(storage, snapshotFileName);\n\n        this._value = content.value;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/shared-object-base#SharedObject.registerCore}\n     * @internal\n     */\n    protected registerCore() {\n    }\n\n    /**\n     * Called when the object has disconnected from the delta stream.\n     * @internal\n     */\n    protected onDisconnect() { }\n\n    /**\n     * Process a counter operation\n     *\n     * @param message - the message to prepare\n     * @param local - whether the message was sent by the local client\n     * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n     * For messages from a remote client, this will be undefined.\n     */\n    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown) {\n        if (message.type === MessageType.Operation && !local) {\n            const op = message.contents as IIncrementOperation;\n\n            switch (op.type) {\n                case \"increment\":\n                    this.incrementCore(op.incrementAmount);\n                    break;\n\n                default:\n                    throw new Error(\"Unknown operation\");\n            }\n        }\n    }\n\n    /**\n     * Not implemented.\n     * @internal\n     */\n    protected applyStashedOp() {\n        throw new Error(\"not implemented\");\n    }\n}\n"]}

package/lib/index.d.ts

@@ -3,7 +3,8 @@
  * Licensed under the MIT License.
  */
 /**
- * This package contains the SharedCounter distributed data structure.
+ * This package contains the SharedCounter distributed data structure. A SharedCounter is a shared object
+ * which holds a number that can be incremented or decremented.
  *
  * @packageDocumentation
  */

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AAEH,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAEH,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC"}

package/lib/index.js

@@ -3,7 +3,8 @@
  * Licensed under the MIT License.
  */
 /**
- * This package contains the SharedCounter distributed data structure.
+ * This package contains the SharedCounter distributed data structure. A SharedCounter is a shared object
+ * which holds a number that can be incremented or decremented.
  *
  * @packageDocumentation
  */

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AAEH,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * This package contains the SharedCounter distributed data structure.\n *\n * @packageDocumentation\n */\n\nexport * from \"./counter\";\nexport * from \"./interfaces\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;GAKG;AAEH,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * This package contains the SharedCounter distributed data structure. A SharedCounter is a shared object\n * which holds a number that can be incremented or decremented.\n *\n * @packageDocumentation\n */\n\nexport * from \"./counter\";\nexport * from \"./interfaces\";\n"]}

package/lib/interfaces.d.ts

@@ -3,6 +3,10 @@
  * Licensed under the MIT License.
  */
 import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base";
+/**
+ * Events sent by SharedCounters.
+ * @public
+ */
 export interface ISharedCounterEvents extends ISharedObjectEvents {
     /**
      * This event is raised when the counter is incremented or decremented.
@@ -15,7 +19,8 @@ export interface ISharedCounterEvents extends ISharedObjectEvents {
     (event: "incremented", listener: (incrementAmount: number, newValue: number) => void): any;
 }
 /**
- * Shared counter interface
+ * SharedCounter interface.
+ * @public
  */
 export interface ISharedCounter extends ISharedObject<ISharedCounterEvents> {
     /**
@@ -25,7 +30,7 @@ export interface ISharedCounter extends ISharedObject<ISharedCounterEvents> {
     /**
      * 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
+     * @param incrementAmount - a whole number to increment or decrement by.
      */
     increment(incrementAmount: number): void;
 }

package/lib/interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAExF,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAC7D;;;;;;;OAOG;IACH,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CACzF;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,aAAa,CAAC,oBAAoB,CAAC;IACvE;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,SAAS,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5C"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAExF;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAC7D;;;;;;;OAOG;IACH,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CACzF;AAED;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,aAAa,CAAC,oBAAoB,CAAC;IACvE;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,SAAS,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5C"}

package/lib/interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","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 { ISharedObject, ISharedObjectEvents } from \"@fluidframework/shared-object-base\";\n\nexport interface ISharedCounterEvents extends ISharedObjectEvents {\n    /**\n     * This event is raised when the counter is incremented or decremented.\n     *\n     * @param event - The event name.\n     * @param listener - An event listener.\n     *\n     * @eventProperty\n     */\n    (event: \"incremented\", listener: (incrementAmount: number, newValue: number) => void);\n}\n\n/**\n * Shared counter interface\n */\nexport interface ISharedCounter extends ISharedObject<ISharedCounterEvents> {\n    /**\n     * The counter value.\n     */\n    value: number;\n\n    /**\n     * Increments or decrements the value.  Must only increment or decrement by a whole number value.\n     *\n     * @param incrementAmount - a whole number to increment or decrement by\n     */\n    increment(incrementAmount: number): void;\n}\n"]}
+{"version":3,"file":"interfaces.js","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 { ISharedObject, ISharedObjectEvents } from \"@fluidframework/shared-object-base\";\n\n/**\n * Events sent by SharedCounters.\n * @public\n */\nexport interface ISharedCounterEvents extends ISharedObjectEvents {\n    /**\n     * This event is raised when the counter is incremented or decremented.\n     *\n     * @param event - The event name.\n     * @param listener - An event listener.\n     *\n     * @eventProperty\n     */\n    (event: \"incremented\", listener: (incrementAmount: number, newValue: number) => void);\n}\n\n/**\n * SharedCounter interface.\n * @public\n */\nexport interface ISharedCounter extends ISharedObject<ISharedCounterEvents> {\n    /**\n     * The counter value.\n     */\n    value: number;\n\n    /**\n     * Increments or decrements the value.  Must only increment or decrement by a whole number value.\n     *\n     * @param incrementAmount - a whole number to increment or decrement by.\n     */\n    increment(incrementAmount: number): void;\n}\n"]}

package/lib/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 = "0.47.1";
+export declare const pkgVersion = "0.48.0-38105";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/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,4BAA4B,CAAC;AACjD,eAAO,MAAM,UAAU,WAAW,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,4BAA4B,CAAC;AACjD,eAAO,MAAM,UAAU,iBAAiB,CAAC"}

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/counter";
-export const pkgVersion = "0.47.1";
+export const pkgVersion = "0.48.0-38105";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,yBAAyB,CAAC;AACjD,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,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 = \"0.47.1\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,yBAAyB,CAAC;AACjD,MAAM,CAAC,MAAM,UAAU,GAAG,cAAc,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 = \"0.48.0-38105\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/counter",
-  "version": "0.47.1",
+  "version": "0.48.0-38105",
   "description": "Counter DDS",
   "homepage": "https://fluidframework.com",
   "repository": "https://github.com/microsoft/FluidFramework",
@@ -55,16 +55,16 @@
   "dependencies": {
     "@fluidframework/common-utils": "^0.32.1",
     "@fluidframework/core-interfaces": "^0.39.7",
-    "@fluidframework/datastore-definitions": "^0.47.1",
-    "@fluidframework/driver-utils": "^0.47.1",
+    "@fluidframework/datastore-definitions": "0.48.0-38105",
+    "@fluidframework/driver-utils": "0.48.0-38105",
     "@fluidframework/protocol-definitions": "^0.1024.0",
-    "@fluidframework/shared-object-base": "^0.47.1"
+    "@fluidframework/shared-object-base": "0.48.0-38105"
   },
   "devDependencies": {
-    "@fluidframework/build-common": "^0.23.0",
+    "@fluidframework/build-common": "^0.23.0-0",
     "@fluidframework/eslint-config-fluid": "^0.23.0",
-    "@fluidframework/mocha-test-setup": "^0.47.1",
-    "@fluidframework/test-runtime-utils": "^0.47.1",
+    "@fluidframework/mocha-test-setup": "0.48.0-38105",
+    "@fluidframework/test-runtime-utils": "0.48.0-38105",
     "@microsoft/api-extractor": "^7.16.1",
     "@types/mocha": "^8.2.2",
     "@types/node": "^12.19.0",

package/src/counter.ts

@@ -41,6 +41,7 @@ const snapshotFileName = "header";
 
 /**
  * A `SharedCounter` is a shared object which holds a number that can be incremented or decremented.
+ * @public
  *
  * @remarks
  * ### Creation
@@ -127,6 +128,7 @@ export class SharedCounter extends SharedObject<ISharedCounterEvents> implements
      * Create a snapshot for the counter
      *
      * @returns the snapshot of the current state of the counter
+     * @internal
      */
     protected snapshotCore(serializer: IFluidSerializer): ITree {
         // Get a serializable form of data
@@ -154,6 +156,7 @@ export class SharedCounter extends SharedObject<ISharedCounterEvents> implements
 
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
+     * @internal
      */
     protected async loadCore(storage: IChannelStorageService): Promise<void> {
         const content = await readAndParse<ICounterSnapshotFormat>(storage, snapshotFileName);
@@ -163,14 +166,16 @@ export class SharedCounter extends SharedObject<ISharedCounterEvents> implements
 
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.registerCore}
+     * @internal
      */
     protected registerCore() {
     }
 
     /**
-     * Call back on disconnect
+     * Called when the object has disconnected from the delta stream.
+     * @internal
      */
-    protected onDisconnect() {}
+    protected onDisconnect() { }
 
     /**
      * Process a counter operation
@@ -197,6 +202,7 @@ export class SharedCounter extends SharedObject<ISharedCounterEvents> implements
 
     /**
      * Not implemented.
+     * @internal
      */
     protected applyStashedOp() {
         throw new Error("not implemented");

package/src/index.ts

@@ -4,7 +4,8 @@
  */
 
 /**
- * This package contains the SharedCounter distributed data structure.
+ * This package contains the SharedCounter distributed data structure. A SharedCounter is a shared object
+ * which holds a number that can be incremented or decremented.
  *
  * @packageDocumentation
  */

package/src/interfaces.ts

@@ -5,6 +5,10 @@
 
 import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base";
 
+/**
+ * Events sent by SharedCounters.
+ * @public
+ */
 export interface ISharedCounterEvents extends ISharedObjectEvents {
     /**
      * This event is raised when the counter is incremented or decremented.
@@ -18,7 +22,8 @@ export interface ISharedCounterEvents extends ISharedObjectEvents {
 }
 
 /**
- * Shared counter interface
+ * SharedCounter interface.
+ * @public
  */
 export interface ISharedCounter extends ISharedObject<ISharedCounterEvents> {
     /**
@@ -29,7 +34,7 @@ export interface ISharedCounter extends ISharedObject<ISharedCounterEvents> {
     /**
      * 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
+     * @param incrementAmount - a whole number to increment or decrement by.
      */
     increment(incrementAmount: number): void;
 }

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/counter";
-export const pkgVersion = "0.47.1";
+export const pkgVersion = "0.48.0-38105";