@figliolia/galena 3.0.2 → 4.0.0

package/src/Middleware.ts

@@ -19,7 +19,7 @@ import type { State } from "./State";
  *
  *   public override onBeforeUpdate(state: State<T>) {
  *     this.startTime = performance.now();
- *     this.previousState = state.getSnapshot();
+ *     this.previousState = state.getState();
  *   }
  *
  *   public override onUpdate(state: T) {
@@ -27,7 +27,7 @@ import type { State } from "./State";
  *     if(diff >= this.threshold) {
  *       console.warn(`A slow state transition was detected when transitioning the following piece of state`);
  *       console.log('Previous state', this.previousState);
- *       console.log('Current state', state.getSnapshot());
+ *       console.log('Current state', state.getState());
  *     }
  *   }
  * }

package/src/Profiler.ts

@@ -26,7 +26,7 @@ export class Profiler<T = any> extends Middleware<T> {
 
   public override onBeforeUpdate(state: State<T>) {
     this.startTime = performance.now();
-    this.previousState = state.getSnapshot();
+    this.previousState = state.getState();
   }
 
   public override onUpdate(state: State<T>) {
@@ -46,7 +46,7 @@ export class Profiler<T = any> extends Middleware<T> {
       console.log(
         "   %cCurrent State    ",
         "color: rgb(17, 118, 249); font-weight: bold",
-        state.getSnapshot(),
+        state.getState(),
       );
     }
   }

package/src/State.ts

@@ -1,19 +1,20 @@
 import { EventEmitter } from "@figliolia/event-emitter";
+import { API } from "./API";
 import type { Middleware } from "./Middleware";
 import type { NonFunction, Setter, Subscriber } from "./types";
 
 /**
- * State
+ * ### State
  *
  * The unit of reactivity for Galena. `State`'s can act
  * as isolated instances or be part of your global app
  * state (via `Galena` instances).
  *
- * There are three ways to create state instances
+ * There are two ways to create state instances
  *
  * ```typescript
- * import { State, createState, useState, Profiler } from "@figliolia/galena";
- * // for island states that can be shared between react components
+ * import { State, createState, Profiler } from "@figliolia/galena";
+ 
  * const myState = new State("<any value>", ...middleware);
  * // or
  * const myState = createState("<any value>", ...middleware);
@@ -22,29 +23,20 @@ import type { NonFunction, Setter, Subscriber } from "./types";
  * myState.update(previousValue => "<new-value>");
  * myState.subscribe(nextValue => {});
  * myState.registerMiddleware(new Profiler());
- *
- * // Similarly if you wish to use your state inside a react component
- * const MyComponent = () => {
- *   const [state, setState] = useState(myState);
- *   // or
- *   const [state, setState] = useMyState("<any-value>", ...middlware);
- *
- *   return (
- *      // your jsx
- *   );
- * }
+ * myState.reset(); // reset back to it's original value
+ * // to get the current value at any point in time
+ * const currentValue = myState.getState();
  * ```
  */
-export class State<T> {
+export class State<T> extends API<T, NonFunction<T>> {
   private state: NonFunction<T>;
-  public readonly middleware: Middleware<T>[] = [];
   private readonly Emitter = new EventEmitter<{ change: NonFunction<T> }>();
   constructor(
     public readonly initialState: NonFunction<T>,
     ...middleware: Middleware<T>[]
   ) {
+    super(...middleware);
     this.state = initialState;
-    this.registerMiddleware(...middleware);
   }
 
   /**
@@ -83,7 +75,7 @@ export class State<T> {
    * Returns the current state. Designed for compatibility with
    * `useSyncExternalStore`
    */
-  public readonly getSnapshot = () => {
+  public readonly getState = () => {
     return this.state;
   };
 
@@ -143,21 +135,28 @@ export class State<T> {
 }
 
 /**
- * Create State
+ * ### createState
  *
- * Returns the unit of reactivity for Galena. `State`'s can act
+ * The unit of reactivity for Galena. `State`'s can act
  * as isolated instances or be part of your global app
- * state (via `Galena` instances);
+ * state (via `Galena` instances).
  *
- * ```typescript
- * import { createState, Profiler } from "@figliolia/galena";
+ * There are two ways to create state instances
  *
+ * ```typescript
+ * import { State, createState, Profiler } from "@figliolia/galena";
+ 
+ * const myState = new State("<any value>", ...middleware);
+ * // or
  * const myState = createState("<any value>", ...middleware);
  *
  * myState.set("<new-value>");
  * myState.update(previousValue => "<new-value>");
  * myState.subscribe(nextValue => {});
  * myState.registerMiddleware(new Profiler());
+ * myState.reset(); // reset back to it's original value
+ * // to get the current value at any point in time
+ * const currentValue = myState.getState();
  * ```
  */
 export function createState<T>(

package/src/types.ts

@@ -24,5 +24,11 @@ export type AppSubscriber<
 > = ((payload: GalenaSnapshot<T, K>) => void) | (() => void);
 
 export type StateTypes<T extends Record<string, State<any>>> = ReturnType<
-  T[keyof T]["getSnapshot"]
+  StateType<T[keyof T]>
 >;
+
+export type StateType<T extends State<any>> = ReturnType<T["getState"]>;
+
+export type GalenaState<T extends Record<string, State<any>>> = {
+  [K in keyof T]: StateType<T[K]>;
+};