@ivan-angelkoski/counter 1.0.10 → 1.1.1

package/dist/index.cjs

@@ -1 +1 @@
-var e=class{count=0;listeners=new Set;constructor(){this.count=0}subscribe(e){return this.listeners.add(e),()=>{this.listeners.delete(e)}}notify(){for(let e of this.listeners)e(this.getState())}getState(){return{count:this.count}}increment(e=1){this.count+=e,this.notify()}decrement(e=1){this.count-=e,this.notify()}};exports.Counter=e;
+var e=class{count;initialValue;min;max;step;listeners=new Set;constructor(e={}){let{initialValue:t=0,min:n=-1/0,max:r=1/0,step:i=1}=e;if(n>r)throw Error(`min cannot be greater than max`);this.min=n,this.max=r,this.step=i,this.initialValue=this.clamp(t),this.count=this.initialValue}clamp(e){return Math.min(Math.max(e,this.min),this.max)}subscribe(e){return this.listeners.add(e),()=>{this.listeners.delete(e)}}notify(){for(let e of this.listeners)e(this.getState())}getState(){return{count:this.count}}getCount(){return this.count}increment(e){let t=e??this.step;this.count=this.clamp(this.count+t),this.notify()}decrement(e){let t=e??this.step;this.count=this.clamp(this.count-t),this.notify()}set(e){this.count=this.clamp(e),this.notify()}reset(e){this.count=this.clamp(e??this.initialValue),this.notify()}getMin(){return this.min}getMax(){return this.max}getStep(){return this.step}getInitialValue(){return this.initialValue}};exports.Counter=e;

package/dist/index.d.cts

@@ -1,20 +1,99 @@
 //#region src/index.d.ts
+/**
+ * Represents the state of the counter
+ */
 type State = {
   count: number;
 };
+/**
+ * A function that listens to state changes
+ */
 type Listener = (state: State) => void;
+/**
+ * Configuration options for the Counter
+ */
+type CounterOptions = {
+  /** Initial value for the counter (default: 0) */initialValue?: number; /** Minimum allowed value (default: -Infinity) */
+  min?: number; /** Maximum allowed value (default: Infinity) */
+  max?: number; /** Default step for increment/decrement (default: 1) */
+  step?: number;
+};
+/**
+ * A flexible counter class with subscription support and configurable boundaries
+ */
 declare class Counter {
   private count;
+  private readonly initialValue;
+  private readonly min;
+  private readonly max;
+  private readonly step;
   private listeners;
-  constructor();
+  /**
+   * Creates a new Counter instance
+   * @param options - Configuration options for the counter
+   */
+  constructor(options?: CounterOptions);
+  /**
+   * Clamps a value within the min/max boundaries
+   */
+  private clamp;
+  /**
+   * Subscribe to state changes
+   * @param listener - The listener function to call on state changes
+   * @returns An unsubscribe function
+   */
   subscribe(listener: Listener): () => void;
+  /**
+   * Notify all listeners of a state change
+   */
   private notify;
-  getState(): {
-    count: number;
-  };
+  /**
+   * Get the current state object
+   * @returns The current state containing the count
+   */
+  getState(): State;
+  /**
+   * Get the current count value
+   * @returns The current count number
+   */
+  getCount(): number;
+  /**
+   * Increment the counter
+   * @param amount - The amount to increment by (default: configured step)
+   */
   increment(amount?: number): void;
+  /**
+   * Decrement the counter
+   * @param amount - The amount to decrement by (default: configured step)
+   */
   decrement(amount?: number): void;
+  /**
+   * Set the counter to a specific value
+   * @param value - The value to set the counter to (will be clamped to min/max)
+   */
+  set(value: number): void;
+  /**
+   * Reset the counter to the initial value or a new value
+   * @param value - Optional new value to reset to (default: initial value)
+   */
+  reset(value?: number): void;
+  /**
+   * Get the configured minimum value
+   */
+  getMin(): number;
+  /**
+   * Get the configured maximum value
+   */
+  getMax(): number;
+  /**
+   * Get the configured step value
+   */
+  getStep(): number;
+  /**
+   * Get the initial value the counter was created with
+   */
+  getInitialValue(): number;
 }
 //#endregion
-export { Counter };
+export { Counter, CounterOptions, Listener, State };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"mappings":";KAAK,KAAA;EACH,KAAA;AAAA;AAAA,KAGG,QAAA,IAAY,KAAA,EAAO,KAAA;AAAA,cAEX,OAAA;EAAA,QACH,KAAA;EAAA,QAEA,SAAA;;EAMR,SAAA,CAAU,QAAA,EAAU,QAAA;EAAA,QAQZ,MAAA;EAMR,QAAA,CAAA;;;EAIA,SAAA,CAAU,MAAA;EAKV,SAAA,CAAU,MAAA;AAAA"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"mappings":";;AAGA;;KAAY,KAAA;EACV,KAAA;AAAA;AAMF;;;AAAA,KAAY,QAAA,IAAY,KAAA,EAAO,KAAA;;AAK/B;;KAAY,cAAA;EAAc,iDAExB,YAAA,WAEA;EAAA,GAAA,WAIA;EAFA,GAAA,WAEI;EAAJ,IAAA;AAAA;;;;cAMW,OAAA;EAAA,QACH,KAAA;EAAA,iBACS,YAAA;EAAA,iBACA,GAAA;EAAA,iBACA,GAAA;EAAA,iBACA,IAAA;EAAA,QACT,SAAA;EADS;;;;cAOL,OAAA,GAAS,cAAA;EAiBb;;;EAAA,QAAA,KAAA;EAoBA;;;;;EAXR,SAAA,CAAU,QAAA,EAAU,QAAA;EA+CpB;;;EAAA,QApCQ,MAAA;EAuDR;;;;EA7CA,QAAA,CAAA,GAAY,KAAA;EA0EZ;;;;EAlEA,QAAA,CAAA;;;;;EAQA,SAAA,CAAU,MAAA;;;;;EAUV,SAAA,CAAU,MAAA;;;;;EAUV,GAAA,CAAI,KAAA;;;;;EASJ,KAAA,CAAM,KAAA;;;;EAQN,MAAA,CAAA;;;;EAOA,MAAA,CAAA;;;;EAOA,OAAA,CAAA;;;;EAOA,eAAA,CAAA;AAAA"}

package/dist/index.d.ts

@@ -1,20 +1,99 @@
 //#region src/index.d.ts
+/**
+ * Represents the state of the counter
+ */
 type State = {
   count: number;
 };
+/**
+ * A function that listens to state changes
+ */
 type Listener = (state: State) => void;
+/**
+ * Configuration options for the Counter
+ */
+type CounterOptions = {
+  /** Initial value for the counter (default: 0) */initialValue?: number; /** Minimum allowed value (default: -Infinity) */
+  min?: number; /** Maximum allowed value (default: Infinity) */
+  max?: number; /** Default step for increment/decrement (default: 1) */
+  step?: number;
+};
+/**
+ * A flexible counter class with subscription support and configurable boundaries
+ */
 declare class Counter {
   private count;
+  private readonly initialValue;
+  private readonly min;
+  private readonly max;
+  private readonly step;
   private listeners;
-  constructor();
+  /**
+   * Creates a new Counter instance
+   * @param options - Configuration options for the counter
+   */
+  constructor(options?: CounterOptions);
+  /**
+   * Clamps a value within the min/max boundaries
+   */
+  private clamp;
+  /**
+   * Subscribe to state changes
+   * @param listener - The listener function to call on state changes
+   * @returns An unsubscribe function
+   */
   subscribe(listener: Listener): () => void;
+  /**
+   * Notify all listeners of a state change
+   */
   private notify;
-  getState(): {
-    count: number;
-  };
+  /**
+   * Get the current state object
+   * @returns The current state containing the count
+   */
+  getState(): State;
+  /**
+   * Get the current count value
+   * @returns The current count number
+   */
+  getCount(): number;
+  /**
+   * Increment the counter
+   * @param amount - The amount to increment by (default: configured step)
+   */
   increment(amount?: number): void;
+  /**
+   * Decrement the counter
+   * @param amount - The amount to decrement by (default: configured step)
+   */
   decrement(amount?: number): void;
+  /**
+   * Set the counter to a specific value
+   * @param value - The value to set the counter to (will be clamped to min/max)
+   */
+  set(value: number): void;
+  /**
+   * Reset the counter to the initial value or a new value
+   * @param value - Optional new value to reset to (default: initial value)
+   */
+  reset(value?: number): void;
+  /**
+   * Get the configured minimum value
+   */
+  getMin(): number;
+  /**
+   * Get the configured maximum value
+   */
+  getMax(): number;
+  /**
+   * Get the configured step value
+   */
+  getStep(): number;
+  /**
+   * Get the initial value the counter was created with
+   */
+  getInitialValue(): number;
 }
 //#endregion
-export { Counter };
+export { Counter, CounterOptions, Listener, State };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";KAAK,KAAA;EACH,KAAA;AAAA;AAAA,KAGG,QAAA,IAAY,KAAA,EAAO,KAAA;AAAA,cAEX,OAAA;EAAA,QACH,KAAA;EAAA,QAEA,SAAA;;EAMR,SAAA,CAAU,QAAA,EAAU,QAAA;EAAA,QAQZ,MAAA;EAMR,QAAA,CAAA;;;EAIA,SAAA,CAAU,MAAA;EAKV,SAAA,CAAU,MAAA;AAAA"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";;AAGA;;KAAY,KAAA;EACV,KAAA;AAAA;AAMF;;;AAAA,KAAY,QAAA,IAAY,KAAA,EAAO,KAAA;;AAK/B;;KAAY,cAAA;EAAc,iDAExB,YAAA,WAEA;EAAA,GAAA,WAIA;EAFA,GAAA,WAEI;EAAJ,IAAA;AAAA;;;;cAMW,OAAA;EAAA,QACH,KAAA;EAAA,iBACS,YAAA;EAAA,iBACA,GAAA;EAAA,iBACA,GAAA;EAAA,iBACA,IAAA;EAAA,QACT,SAAA;EADS;;;;cAOL,OAAA,GAAS,cAAA;EAiBb;;;EAAA,QAAA,KAAA;EAoBA;;;;;EAXR,SAAA,CAAU,QAAA,EAAU,QAAA;EA+CpB;;;EAAA,QApCQ,MAAA;EAuDR;;;;EA7CA,QAAA,CAAA,GAAY,KAAA;EA0EZ;;;;EAlEA,QAAA,CAAA;;;;;EAQA,SAAA,CAAU,MAAA;;;;;EAUV,SAAA,CAAU,MAAA;;;;;EAUV,GAAA,CAAI,KAAA;;;;;EASJ,KAAA,CAAM,KAAA;;;;EAQN,MAAA,CAAA;;;;EAOA,MAAA,CAAA;;;;EAOA,OAAA,CAAA;;;;EAOA,eAAA,CAAA;AAAA"}

package/dist/index.js

@@ -1,2 +1,2 @@
-var e=class{count=0;listeners=new Set;constructor(){this.count=0}subscribe(e){return this.listeners.add(e),()=>{this.listeners.delete(e)}}notify(){for(let e of this.listeners)e(this.getState())}getState(){return{count:this.count}}increment(e=1){this.count+=e,this.notify()}decrement(e=1){this.count-=e,this.notify()}};export{e as Counter};
+var e=class{count;initialValue;min;max;step;listeners=new Set;constructor(e={}){let{initialValue:t=0,min:n=-1/0,max:r=1/0,step:i=1}=e;if(n>r)throw Error(`min cannot be greater than max`);this.min=n,this.max=r,this.step=i,this.initialValue=this.clamp(t),this.count=this.initialValue}clamp(e){return Math.min(Math.max(e,this.min),this.max)}subscribe(e){return this.listeners.add(e),()=>{this.listeners.delete(e)}}notify(){for(let e of this.listeners)e(this.getState())}getState(){return{count:this.count}}getCount(){return this.count}increment(e){let t=e??this.step;this.count=this.clamp(this.count+t),this.notify()}decrement(e){let t=e??this.step;this.count=this.clamp(this.count-t),this.notify()}set(e){this.count=this.clamp(e),this.notify()}reset(e){this.count=this.clamp(e??this.initialValue),this.notify()}getMin(){return this.min}getMax(){return this.max}getStep(){return this.step}getInitialValue(){return this.initialValue}};export{e as Counter};
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["type State = {\n  count: number;\n};\n\ntype Listener = (state: State) => void;\n\nexport class Counter {\n  private count: number = 0;\n\n  private listeners: Set<Listener> = new Set();\n\n  constructor() {\n    this.count = 0;\n  }\n\n  subscribe(listener: Listener) {\n    this.listeners.add(listener);\n\n    return () => {\n      this.listeners.delete(listener);\n    };\n  }\n\n  private notify() {\n    for (const listener of this.listeners) {\n      listener(this.getState());\n    }\n  }\n\n  getState() {\n    return { count: this.count };\n  }\n\n  increment(amount: number = 1) {\n    this.count += amount;\n    this.notify();\n  }\n\n  decrement(amount: number = 1) {\n    this.count -= amount;\n    this.notify();\n  }\n}\n"],"mappings":"AAMA,IAAa,EAAb,KAAqB,CACnB,MAAwB,EAExB,UAAmC,IAAI,IAEvC,aAAc,CACZ,KAAK,MAAQ,EAGf,UAAU,EAAoB,CAG5B,OAFA,KAAK,UAAU,IAAI,EAAS,KAEf,CACX,KAAK,UAAU,OAAO,EAAS,EAInC,QAAiB,CACf,IAAK,IAAM,KAAY,KAAK,UAC1B,EAAS,KAAK,UAAU,CAAC,CAI7B,UAAW,CACT,MAAO,CAAE,MAAO,KAAK,MAAO,CAG9B,UAAU,EAAiB,EAAG,CAC5B,KAAK,OAAS,EACd,KAAK,QAAQ,CAGf,UAAU,EAAiB,EAAG,CAC5B,KAAK,OAAS,EACd,KAAK,QAAQ"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["/**\n * Represents the state of the counter\n */\nexport type State = {\n  count: number;\n};\n\n/**\n * A function that listens to state changes\n */\nexport type Listener = (state: State) => void;\n\n/**\n * Configuration options for the Counter\n */\nexport type CounterOptions = {\n  /** Initial value for the counter (default: 0) */\n  initialValue?: number;\n  /** Minimum allowed value (default: -Infinity) */\n  min?: number;\n  /** Maximum allowed value (default: Infinity) */\n  max?: number;\n  /** Default step for increment/decrement (default: 1) */\n  step?: number;\n};\n\n/**\n * A flexible counter class with subscription support and configurable boundaries\n */\nexport class Counter {\n  private count: number;\n  private readonly initialValue: number;\n  private readonly min: number;\n  private readonly max: number;\n  private readonly step: number;\n  private listeners: Set<Listener> = new Set();\n\n  /**\n   * Creates a new Counter instance\n   * @param options - Configuration options for the counter\n   */\n  constructor(options: CounterOptions = {}) {\n    const { initialValue = 0, min = -Infinity, max = Infinity, step = 1 } = options;\n\n    if (min > max) {\n      throw new Error(\"min cannot be greater than max\");\n    }\n\n    this.min = min;\n    this.max = max;\n    this.step = step;\n    this.initialValue = this.clamp(initialValue);\n    this.count = this.initialValue;\n  }\n\n  /**\n   * Clamps a value within the min/max boundaries\n   */\n  private clamp(value: number): number {\n    return Math.min(Math.max(value, this.min), this.max);\n  }\n\n  /**\n   * Subscribe to state changes\n   * @param listener - The listener function to call on state changes\n   * @returns An unsubscribe function\n   */\n  subscribe(listener: Listener) {\n    this.listeners.add(listener);\n\n    return () => {\n      this.listeners.delete(listener);\n    };\n  }\n\n  /**\n   * Notify all listeners of a state change\n   */\n  private notify() {\n    for (const listener of this.listeners) {\n      listener(this.getState());\n    }\n  }\n\n  /**\n   * Get the current state object\n   * @returns The current state containing the count\n   */\n  getState(): State {\n    return { count: this.count };\n  }\n\n  /**\n   * Get the current count value\n   * @returns The current count number\n   */\n  getCount(): number {\n    return this.count;\n  }\n\n  /**\n   * Increment the counter\n   * @param amount - The amount to increment by (default: configured step)\n   */\n  increment(amount?: number) {\n    const incrementBy = amount ?? this.step;\n    this.count = this.clamp(this.count + incrementBy);\n    this.notify();\n  }\n\n  /**\n   * Decrement the counter\n   * @param amount - The amount to decrement by (default: configured step)\n   */\n  decrement(amount?: number) {\n    const decrementBy = amount ?? this.step;\n    this.count = this.clamp(this.count - decrementBy);\n    this.notify();\n  }\n\n  /**\n   * Set the counter to a specific value\n   * @param value - The value to set the counter to (will be clamped to min/max)\n   */\n  set(value: number) {\n    this.count = this.clamp(value);\n    this.notify();\n  }\n\n  /**\n   * Reset the counter to the initial value or a new value\n   * @param value - Optional new value to reset to (default: initial value)\n   */\n  reset(value?: number) {\n    this.count = this.clamp(value ?? this.initialValue);\n    this.notify();\n  }\n\n  /**\n   * Get the configured minimum value\n   */\n  getMin(): number {\n    return this.min;\n  }\n\n  /**\n   * Get the configured maximum value\n   */\n  getMax(): number {\n    return this.max;\n  }\n\n  /**\n   * Get the configured step value\n   */\n  getStep(): number {\n    return this.step;\n  }\n\n  /**\n   * Get the initial value the counter was created with\n   */\n  getInitialValue(): number {\n    return this.initialValue;\n  }\n}\n"],"mappings":"AA6BA,IAAa,EAAb,KAAqB,CACnB,MACA,aACA,IACA,IACA,KACA,UAAmC,IAAI,IAMvC,YAAY,EAA0B,EAAE,CAAE,CACxC,GAAM,CAAE,eAAe,EAAG,MAAM,KAAW,MAAM,IAAU,OAAO,GAAM,EAExE,GAAI,EAAM,EACR,MAAU,MAAM,iCAAiC,CAGnD,KAAK,IAAM,EACX,KAAK,IAAM,EACX,KAAK,KAAO,EACZ,KAAK,aAAe,KAAK,MAAM,EAAa,CAC5C,KAAK,MAAQ,KAAK,aAMpB,MAAc,EAAuB,CACnC,OAAO,KAAK,IAAI,KAAK,IAAI,EAAO,KAAK,IAAI,CAAE,KAAK,IAAI,CAQtD,UAAU,EAAoB,CAG5B,OAFA,KAAK,UAAU,IAAI,EAAS,KAEf,CACX,KAAK,UAAU,OAAO,EAAS,EAOnC,QAAiB,CACf,IAAK,IAAM,KAAY,KAAK,UAC1B,EAAS,KAAK,UAAU,CAAC,CAQ7B,UAAkB,CAChB,MAAO,CAAE,MAAO,KAAK,MAAO,CAO9B,UAAmB,CACjB,OAAO,KAAK,MAOd,UAAU,EAAiB,CACzB,IAAM,EAAc,GAAU,KAAK,KACnC,KAAK,MAAQ,KAAK,MAAM,KAAK,MAAQ,EAAY,CACjD,KAAK,QAAQ,CAOf,UAAU,EAAiB,CACzB,IAAM,EAAc,GAAU,KAAK,KACnC,KAAK,MAAQ,KAAK,MAAM,KAAK,MAAQ,EAAY,CACjD,KAAK,QAAQ,CAOf,IAAI,EAAe,CACjB,KAAK,MAAQ,KAAK,MAAM,EAAM,CAC9B,KAAK,QAAQ,CAOf,MAAM,EAAgB,CACpB,KAAK,MAAQ,KAAK,MAAM,GAAS,KAAK,aAAa,CACnD,KAAK,QAAQ,CAMf,QAAiB,CACf,OAAO,KAAK,IAMd,QAAiB,CACf,OAAO,KAAK,IAMd,SAAkB,CAChB,OAAO,KAAK,KAMd,iBAA0B,CACxB,OAAO,KAAK"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ivan-angelkoski/counter",
-  "version": "1.0.10",
-  "description": "Test counter package with changesets",
+  "version": "1.1.1",
+  "description": "Test counter package with changesets automation",
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",