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

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @fluidframework/counter
 
+## 2.0.0-internal.7.3.0
+
+Dependency updates only.
+
 ## 2.0.0-internal.7.2.0
 
 Dependency updates only.

package/api-extractor.json

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

package/dist/counter-alpha.d.ts

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

package/dist/counter-beta.d.ts

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

package/dist/counter-public.d.ts

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

package/dist/counter-untrimmed.d.ts

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

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

@@ -9,7 +9,7 @@ const core_utils_1 = require("@fluidframework/core-utils");
 const protocol_definitions_1 = require("@fluidframework/protocol-definitions");
 const driver_utils_1 = require("@fluidframework/driver-utils");
 const shared_object_base_1 = require("@fluidframework/shared-object-base");
-const counterFactory_1 = require("./counterFactory");
+const counterFactory_1 = require("./counterFactory.cjs");
 const snapshotFileName = "header";
 /**
  * {@inheritDoc ISharedCounter}
@@ -125,4 +125,4 @@ class SharedCounter extends shared_object_base_1.SharedObject {
     }
 }
 exports.SharedCounter = SharedCounter;
-//# sourceMappingURL=counter.js.map
+//# sourceMappingURL=counter.cjs.map

package/dist/counter.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"counter.cjs","sourceRoot":"","sources":["../src/counter.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAoD;AACpD,+EAAmG;AAOnG,+DAA4D;AAE5D,2EAI4C;AAC5C,yDAAkD;AAqBlD,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAElC;;;;GAIG;AACH,MAAa,aAAc,SAAQ,iCAAkC;IACpE;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,OAA+B,EAAE,EAAW;QAChE,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,+BAAc,CAAC,IAAI,CAAkB,CAAC;IACxE,CAAC;IAED,YACC,EAAU,EACV,OAA+B,EAC/B,UAA8B;QAE9B,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,gBAAgB,CAAC,CAAC;QAY1C,WAAM,GAAW,CAAC,CAAC;IAX3B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU;QACvB,OAAO,IAAI,+BAAc,EAAE,CAAC;IAC7B,CAAC;IAID;;OAEG;IACH,IAAW,KAAK;QACf,OAAO,IAAI,CAAC,MAAM,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,eAAuB;QACvC,uGAAuG;QACvG,wGAAwG;QACxG,IAAI,eAAe,GAAG,CAAC,KAAK,CAAC,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;SACpD;QAED,MAAM,EAAE,GAAwB;YAC/B,IAAI,EAAE,WAAW;YACjB,eAAe;SACf,CAAC;QAEF,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;QACpC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC;IAEO,aAAa,CAAC,eAAuB;QAC5C,IAAI,CAAC,MAAM,IAAI,eAAe,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,eAAe,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACO,aAAa,CAAC,UAA4B;QACnD,kCAAkC;QAClC,MAAM,OAAO,GAA2B;YACvC,KAAK,EAAE,IAAI,CAAC,KAAK;SACjB,CAAC;QAEF,wCAAwC;QACxC,OAAO,IAAA,4CAAuB,EAAC,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,QAAQ,CAAC,OAA+B;QACvD,MAAM,OAAO,GAAG,MAAM,IAAA,2BAAY,EAAyB,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAEtF,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAC7B,CAAC;IAED;;OAEG;IACO,YAAY,KAAU,CAAC;IAEjC;;;;;;;OAOG;IACO,WAAW,CACpB,OAAkC,EAClC,KAAc,EACd,eAAwB;QAExB,wEAAwE;QACxE,IAAI,OAAO,CAAC,IAAI,KAAK,kCAAW,CAAC,SAAS,IAAI,CAAC,KAAK,EAAE;YACrD,MAAM,EAAE,GAAG,OAAO,CAAC,QAA+B,CAAC;YAEnD,QAAQ,EAAE,CAAC,IAAI,EAAE;gBAChB,KAAK,WAAW,CAAC,CAAC;oBACjB,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC;oBACvC,MAAM;iBACN;gBAED,OAAO,CAAC,CAAC;oBACR,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;iBACrC;aACD;SACD;IACF,CAAC;IAED;;OAEG;IACO,cAAc,CAAC,EAAW;QACnC,MAAM,SAAS,GAAG,EAAyB,CAAC;QAE5C,yDAAyD;QAEzD,4DAA4D;QAC5D,IAAA,mBAAM,EAAC,SAAS,CAAC,IAAI,KAAK,WAAW,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAE7E,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAC/C,CAAC;CACD;AAvID,sCAuIC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils\";\nimport { type ISequencedDocumentMessage, MessageType } from \"@fluidframework/protocol-definitions\";\nimport {\n\ttype IFluidDataStoreRuntime,\n\ttype IChannelStorageService,\n\ttype IChannelFactory,\n\ttype IChannelAttributes,\n} from \"@fluidframework/datastore-definitions\";\nimport { readAndParse } from \"@fluidframework/driver-utils\";\nimport { type ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\nimport {\n\tcreateSingleBlobSummary,\n\ttype IFluidSerializer,\n\tSharedObject,\n} from \"@fluidframework/shared-object-base\";\nimport { CounterFactory } from \"./counterFactory\";\nimport { type ISharedCounter, type ISharedCounterEvents } from \"./interfaces\";\n\n/**\n * Describes the operation (op) format for incrementing the {@link SharedCounter}.\n */\ninterface IIncrementOperation {\n\ttype: \"increment\";\n\tincrementAmount: number;\n}\n\n/**\n * @remarks Used in snapshotting.\n */\ninterface ICounterSnapshotFormat {\n\t/**\n\t * The value of the counter.\n\t */\n\tvalue: number;\n}\n\nconst snapshotFileName = \"header\";\n\n/**\n * {@inheritDoc ISharedCounter}\n *\n * @public\n */\nexport class SharedCounter extends SharedObject<ISharedCounterEvents> implements ISharedCounter {\n\t/**\n\t * Create a new {@link SharedCounter}.\n\t *\n\t * @param runtime - The data store runtime to which the new `SharedCounter` will belong.\n\t * @param id - Optional name of the `SharedCounter`. If not provided, one will be generated.\n\t *\n\t * @returns newly create shared counter (but not attached yet)\n\t */\n\tpublic static create(runtime: IFluidDataStoreRuntime, id?: string): SharedCounter {\n\t\treturn runtime.createChannel(id, CounterFactory.Type) as SharedCounter;\n\t}\n\n\tpublic constructor(\n\t\tid: string,\n\t\truntime: IFluidDataStoreRuntime,\n\t\tattributes: IChannelAttributes,\n\t) {\n\t\tsuper(id, runtime, attributes, \"fluid_counter_\");\n\t}\n\n\t/**\n\t * Get a factory for {@link SharedCounter} to register with the data store.\n\t *\n\t * @returns a factory that creates and load SharedCounter\n\t */\n\tpublic static getFactory(): IChannelFactory {\n\t\treturn new CounterFactory();\n\t}\n\n\tprivate _value: number = 0;\n\n\t/**\n\t * {@inheritDoc ISharedCounter.value}\n\t */\n\tpublic get value(): number {\n\t\treturn this._value;\n\t}\n\n\t/**\n\t * {@inheritDoc ISharedCounter.increment}\n\t */\n\tpublic increment(incrementAmount: number): void {\n\t\t// Incrementing by floating point numbers will be eventually inconsistent, since the order in which the\n\t\t// increments are applied affects the result.  A more-robust solution would be required to support this.\n\t\tif (incrementAmount % 1 !== 0) {\n\t\t\tthrow new Error(\"Must increment by a whole number\");\n\t\t}\n\n\t\tconst op: IIncrementOperation = {\n\t\t\ttype: \"increment\",\n\t\t\tincrementAmount,\n\t\t};\n\n\t\tthis.incrementCore(incrementAmount);\n\t\tthis.submitLocalMessage(op);\n\t}\n\n\tprivate incrementCore(incrementAmount: number): void {\n\t\tthis._value += incrementAmount;\n\t\tthis.emit(\"incremented\", incrementAmount, this._value);\n\t}\n\n\t/**\n\t * Create a summary for the counter.\n\t *\n\t * @returns The summary of the current state of the counter.\n\t */\n\tprotected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats {\n\t\t// Get a serializable form of data\n\t\tconst content: ICounterSnapshotFormat = {\n\t\t\tvalue: this.value,\n\t\t};\n\n\t\t// And then construct the summary for it\n\t\treturn createSingleBlobSummary(snapshotFileName, JSON.stringify(content));\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}\n\t */\n\tprotected async loadCore(storage: IChannelStorageService): Promise<void> {\n\t\tconst content = await readAndParse<ICounterSnapshotFormat>(storage, snapshotFileName);\n\n\t\tthis._value = content.value;\n\t}\n\n\t/**\n\t * Called when the object has disconnected from the delta stream.\n\t */\n\tprotected onDisconnect(): void {}\n\n\t/**\n\t * Process a counter operation (op).\n\t *\n\t * @param message - The message to prepare.\n\t * @param local - Whether or not the message was sent by the local client.\n\t * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.\n\t * For messages from a remote client, this will be `undefined`.\n\t */\n\tprotected processCore(\n\t\tmessage: ISequencedDocumentMessage,\n\t\tlocal: boolean,\n\t\tlocalOpMetadata: unknown,\n\t): void {\n\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison\n\t\tif (message.type === MessageType.Operation && !local) {\n\t\t\tconst op = message.contents as IIncrementOperation;\n\n\t\t\tswitch (op.type) {\n\t\t\t\tcase \"increment\": {\n\t\t\t\t\tthis.incrementCore(op.incrementAmount);\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\n\t\t\t\tdefault: {\n\t\t\t\t\tthrow new Error(\"Unknown operation\");\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * {@inheritdoc @fluidframework/shared-object-base#SharedObjectCore.applyStashedOp}\n\t */\n\tprotected applyStashedOp(op: unknown): void {\n\t\tconst counterOp = op as IIncrementOperation;\n\n\t\t// TODO: Clean up error code linter violations repo-wide.\n\n\t\t// eslint-disable-next-line unicorn/numeric-separators-style\n\t\tassert(counterOp.type === \"increment\", 0x3ec /* Op type is not increment */);\n\n\t\tthis.incrementCore(counterOp.incrementAmount);\n\t}\n}\n"]}

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

@@ -5,8 +5,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CounterFactory = void 0;
-const counter_1 = require("./counter");
-const packageVersion_1 = require("./packageVersion");
+const counter_1 = require("./counter.cjs");
+const packageVersion_1 = require("./packageVersion.cjs");
 /**
  * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link SharedCounter}.
  *
@@ -55,4 +55,4 @@ CounterFactory.Attributes = {
     snapshotFormatVersion: "0.1",
     packageVersion: packageVersion_1.pkgVersion,
 };
-//# sourceMappingURL=counterFactory.js.map
+//# sourceMappingURL=counterFactory.cjs.map