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

package/.eslintrc.js

@@ -4,10 +4,8 @@
  */
 
 module.exports = {
-    "extends": [
-        require.resolve("@fluidframework/eslint-config-fluid")
-    ],
-    "parserOptions": {
-        "project": ["./tsconfig.json", "./src/test/tsconfig.json"]
-    },
-}
+	extends: [require.resolve("@fluidframework/eslint-config-fluid/strict"), "prettier"],
+	parserOptions: {
+		project: ["./tsconfig.json", "./src/test/tsconfig.json"],
+	},
+};

package/.mocharc.js

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+"use strict";
+
+const getFluidTestMochaConfig = require("@fluidframework/mocha-test-setup/mocharc-common");
+
+const packageDir = __dirname;
+const config = getFluidTestMochaConfig(packageDir);
+module.exports = config;

package/CHANGELOG.md

@@ -0,0 +1,117 @@
+# @fluidframework/counter
+
+## 2.0.0-internal.8.0.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.7.0.0
+
+### Major Changes
+
+-   Dependencies on @fluidframework/protocol-definitions package updated to 3.0.0 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    This included the following changes from the protocol-definitions release:
+
+    -   Updating signal interfaces for some planned improvements. The intention is split the interface between signals
+        submitted by clients to the server and the resulting signals sent from the server to clients.
+        -   A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has
+            been added, which will be the typing for signals sent from the client to the server. Both extend a new
+            ISignalMessageBase interface that contains common members.
+    -   The @fluidframework/common-definitions package dependency has been updated to version 1.0.0.
+
+-   Server upgrade: dependencies on Fluid server packages updated to 2.0.1 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    Dependencies on the following Fluid server package have been updated to version 2.0.1:
+
+    -   @fluidframework/gitresources: 2.0.1
+    -   @fluidframework/server-kafka-orderer: 2.0.1
+    -   @fluidframework/server-lambdas: 2.0.1
+    -   @fluidframework/server-lambdas-driver: 2.0.1
+    -   @fluidframework/server-local-server: 2.0.1
+    -   @fluidframework/server-memory-orderer: 2.0.1
+    -   @fluidframework/protocol-base: 2.0.1
+    -   @fluidframework/server-routerlicious: 2.0.1
+    -   @fluidframework/server-routerlicious-base: 2.0.1
+    -   @fluidframework/server-services: 2.0.1
+    -   @fluidframework/server-services-client: 2.0.1
+    -   @fluidframework/server-services-core: 2.0.1
+    -   @fluidframework/server-services-ordering-kafkanode: 2.0.1
+    -   @fluidframework/server-services-ordering-rdkafka: 2.0.1
+    -   @fluidframework/server-services-ordering-zookeeper: 2.0.1
+    -   @fluidframework/server-services-shared: 2.0.1
+    -   @fluidframework/server-services-telemetry: 2.0.1
+    -   @fluidframework/server-services-utils: 2.0.1
+    -   @fluidframework/server-test-utils: 2.0.1
+    -   tinylicious: 2.0.1
+
+-   Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
+
+    The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
+
+## 2.0.0-internal.6.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.6.0.0
+
+### Major Changes
+
+-   Upgraded typescript transpilation target to ES2020 [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
+
+    Upgraded typescript transpilation target to ES2020. This is done in order to decrease the bundle sizes of Fluid Framework packages. This has provided size improvements across the board for ex. Loader, Driver, Runtime etc. Reduced bundle sizes helps to load lesser code in apps and hence also helps to improve the perf.If any app wants to target any older versions of browsers with which this target version is not compatible, then they can use packages like babel to transpile to a older target.
+
+## 2.0.0-internal.5.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.3.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.2.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.1.0
+
+Dependency updates only.
+
+## 2.0.0-internal.5.0.0
+
+Dependency updates only.
+
+## 2.0.0-internal.4.4.0
+
+Dependency updates only.
+
+## 2.0.0-internal.4.1.0
+
+Dependency updates only.

package/README.md

@@ -1,3 +1,199 @@
 # @fluidframework/counter
 
-Documentation available at https://fluidframework.com/docs/apis/counter/.
+<!-- AUTO-GENERATED-CONTENT:START (README_DEPENDENCY_GUIDELINES_SECTION:includeHeading=TRUE) -->
+
+<!-- prettier-ignore-start -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+
+## Using Fluid Framework libraries
+
+When taking a dependency on a Fluid Framework library, we recommend using a `^` (caret) version range, such as `^1.3.4`.
+While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
+library consumers should always prefer `^`.
+
+Note that when depending on a library version of the form `2.0.0-internal.x.y.z`, called the Fluid internal version scheme,
+you must use a `>= <` dependency range (such as `>=2.0.0-internal.x.y.z <2.0.0-internal.w.0.0` where `w` is `x+1`).
+Standard `^` and `~` ranges will not work as expected.
+See the [@fluid-tools/version-tools](https://github.com/microsoft/FluidFramework/blob/main/build-tools/packages/version-tools/README.md)
+package for more information including tools to convert between version schemes.
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+## Introduction
+
+The `SharedCounter` distributed data structure (DDS) is used to store an integer counter value that can be modified by multiple clients simultaneously.
+The data structure affords incrementing and decrementing the shared value via its `increment` method. Decrements are done by providing a negative value.
+
+The `SharedCounter` is a specialized [Optimistic DDS][].
+It operates on communicated _deltas_ (amounts by which the shared value should be incremented or decremented), rather than direct changes to the shared value.
+In this way, it avoids the pitfalls of DDSes with simpler merge strategies, in which one user's edit may clobber another's (see [below](#why-a-specialized-dds)).
+
+Note that the `SharedCounter` only operates on integer values.
+
+### Why a specialized DDS?
+
+You may be asking yourself, why not just store the shared integer value directly in another DDS like a [SharedMap][]?
+Why incur the overhead of another runtime type?
+
+The key to the answer here is that DDSes with simpler merge strategies (like `SharedMap`) take a somewhat brute-force approach to merging concurrent edits.
+For a semantic data type like a counter, this can result in undesirable behavior.
+
+#### SharedMap Example
+
+Let's illustrate the issue with an example.
+
+Consider a polling widget.
+The widget displays a list of options and allows users to click a checkbox to vote for a given option.
+Next to each option in the list, a live counter is displayed that shows the number of votes for that item.
+
+Whenever a user checks an option, all users should see the counter corresponding to that option increment by 1.
+
+In this example, the application is storing its vote counts in a [SharedMap][], where the map keys are `strings` representing the IDs of the options, and the values are `numbers` representing the associated vote counts.
+
+For simplicity, we will look at a scenario in which 2 users vote for the same option at around the same time.
+
+Specifically, **User A** clicks the checkbox for option **Foo**, which currently has **0** votes.
+The application then optimistically updates the vote count for that object by writing the updated counter value of **1** for option **Foo** to its `SharedMap`.
+
+The value change operation (op) is then transmitted to the service to be sequenced and eventually sent to other users in the collaborative session.
+
+At around the same time, **User B** clicks the checkbox for option **Foo**, which in their view currently has **0** votes.
+Similarly to before, the application optimistically updates the associated counter value to **1**, and transmits its own update op.
+
+The service receives the op from **User A** first, and sequences their op updating **Foo** to **1** as **op 0**. **User B**'s op is received second, and is sequenced as **op 1**.
+
+Both users then receive acknowledgement of their update, and receive **op 0** and **op 1** to be applied in order.
+Both clients apply **op 0** by setting **Foo** to **1**.
+Then both clients apply **op 1** by setting **Foo** to **1**.
+
+But this isn't right.
+Two different users voted for option **Foo**, but the counter now displays **1**.
+
+`SharedCounter` solves this problem by expressing its operations in terms of _increments_ and _decrements_ rather than as direct value updates.
+
+So for the scenario above, if the system was using `SharedCounter`s to represent the vote counts, **User A** would submit an op _incrementing_ **Foo** by **+1**, rather than updating the value of **Foo** from **0** to **1**.
+At around the same time, **User B** would submit their own **+1** op for **Foo**.
+
+Assuming the same sequencing, both users first apply **op 0** and increment their counter for **Foo** by **+1** (from **0** to **1**).
+Next, they both apply **op 1** and increment their counter for **Foo** by **+1** a second time (from **1** to **2**).
+
+Now both users see the right vote count for `Foo`!
+
+## Usage
+
+The `SharedCounter` object provides a simple API surface for managing a shared integer whose value may be incremented and decremented by collaborators.
+
+A new `SharedCounter` value will be initialized with its value set to `0`.
+If you wish to initialize the counter to a different value, you may [modify the value](#incrementing--decrementing-the-value) before attaching the container, or before storing it in another shared object like a `SharedMap`.
+
+## Installation
+
+The package containing the `SharedCounter` library is [@fluidframework/shared-counter](https://www.npmjs.com/package/@fluidframework/counter).
+
+To get started, run the following from a terminal in your repository:
+
+```bash
+npm install @fluidframework/shared-counter
+```
+
+### Creation
+
+The workflow for creating a `SharedCounter` is effectively the same as many of our other DDSes.
+For an example of how to create one, please see our workflow examples for [SharedMap creation][].
+
+### Incrementing / decrementing the value
+
+Once you have created your `SharedCounter`, you can change its value using the [increment][] method.
+This method accepts a positive or negative _integer_ to be applied to the shared value.
+
+```javascript
+sharedCounter.increment(3); // Adds 3 to the current value
+sharedCounter.increment(-5); // Subtracts 5 from the current value
+```
+
+### `incremented` event
+
+The [incremented][] event is sent when a client in the collaborative session changes the counter value via the `increment` method.
+
+Signature:
+
+```javascript
+(event: "incremented", listener: (incrementAmount: number, newValue: number) => void)
+```
+
+By listening to this event, you can receive and apply the changes coming from other collaborators.
+Consider the following code example for configuring a Counter widget:
+
+```javascript
+const sharedCounter = container.initialObjects.sharedCounter;
+let counterValue = sharedCounter.value;
+
+const incrementButton = document.createElement("button");
+button.textContent = "Increment";
+const decrementButton = document.createElement("button");
+button.textContent = "Decrement";
+
+// Increment / decrement shared counter value when the corresponding button is clicked
+incrementButton.addEventListener("click", () => sharedCounter.increment(1));
+decrementButton.addEventListener("click", () => sharedCounter.increment(-1));
+
+const counterValueLabel = document.createElement("label");
+counterValueLabel.textContent = `${counterValue}`;
+
+// This function will be called each time the shared counter value is incremented
+// (including increments from this client).
+// Update the local counter value and the corresponding label being displayed in the widget.
+const updateCounterValueLabel = (delta) => {
+	counterValue += delta;
+	counterValueLabel.textContent = `${counterValue}`;
+};
+
+// Register to be notified when the counter is incremented
+sharedCounter.on("incremented", updateCounterValueLabel);
+```
+
+In the code above, whenever a user presses either the Increment or Decrement button, the `sharedCounter.increment` is called with +/- 1.
+This causes the `incremented` event to be sent to all of the clients who have this container open.
+
+Since `updateCounterValueLabel` is listening for all `incremented` events, the view will always refresh with the appropriate updated value any time a collaborator increments or decrements the counter value.
+
+<!-- AUTO-GENERATED-CONTENT:START (README_API_DOCS_SECTION:includeHeading=TRUE) -->
+
+<!-- prettier-ignore-start -->
+
+<!-- This section is automatically generated. To update it, make the appropriate changes to docs/md-magic.config.js or the embedded content, then run 'npm run build:md-magic' in the docs folder. -->
+
+## API Documentation
+
+API documentation for **@fluidframework/counter** is available at <https://fluidframework.com/docs/apis/counter>.
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+<!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) -->
+
+<!-- prettier-ignore-start -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+
+## Trademark
+
+This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
+
+Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
+
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+<!-- Links -->
+
+[increment]: https://fluidframework.com/docs/apis/counter/isharedcounter-interface#increment-methodsignature
+[incremented]: https://fluidframework.com/docs/apis/counter/isharedcounterevents-interface#_call_-callsignature
+[optimistic dds]: https://fluidframework.com/docs/build/dds/#optimistic-data-structures
+[sharedmap]: https://fluidframework.com/docs/data-structures/map
+[sharedmap creation]: https://fluidframework.com/docs/data-structures/map/#creation

package/api-extractor-esm.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-base-esm.json"
+}

package/api-extractor-lint.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-lint.json"
+}

package/api-extractor.json

@@ -1,4 +1,4 @@
 {
-  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "extends": "@fluidframework/build-common/api-extractor-common-report.json"
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "../../../common/build/build-common/api-extractor-base.json"
 }

package/api-report/counter.api.md

@@ -0,0 +1,46 @@
+## API Report File for "@fluidframework/counter"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+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';
+
+// @alpha
+export interface ISharedCounter extends ISharedObject<ISharedCounterEvents> {
+    increment(incrementAmount: number): void;
+    value: number;
+}
+
+// @alpha
+export interface ISharedCounterEvents extends ISharedObjectEvents {
+    // @eventProperty
+    (event: "incremented", listener: (incrementAmount: number, newValue: number) => void): any;
+}
+
+// @alpha
+export class SharedCounter extends SharedObject<ISharedCounterEvents> implements ISharedCounter {
+    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
+    // (undocumented)
+    protected applyStashedOp(op: unknown): void;
+    static create(runtime: IFluidDataStoreRuntime, id?: string): SharedCounter;
+    static getFactory(): IChannelFactory;
+    increment(incrementAmount: number): void;
+    // (undocumented)
+    protected loadCore(storage: IChannelStorageService): Promise<void>;
+    protected onDisconnect(): void;
+    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
+    get value(): number;
+}
+
+```

package/dist/counter-alpha.d.ts

@@ -0,0 +1,150 @@
+/**
+ * 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}`);
+ * });
+ * ```
+ * @alpha
+ */
+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}.
+ * @alpha
+ */
+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}
+ * @alpha
+ */
+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/dist/counter-beta.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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';
+
+/* Excluded from this release type: ISharedCounter */
+
+/* Excluded from this release type: ISharedCounterEvents */
+
+/* Excluded from this release type: SharedCounter */
+
+export { }

package/dist/counter-public.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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';
+
+/* Excluded from this release type: ISharedCounter */
+
+/* Excluded from this release type: ISharedCounterEvents */
+
+/* Excluded from this release type: SharedCounter */
+
+export { }