@figliolia/galena 2.3.5 → 3.0.0

package/dist/types/Galena/Scheduler.d.ts

@@ -1,51 +0,0 @@
-import type { Task } from "./types";
-import { Priority } from "./types";
-/**
- * Scheduler
- *
- * Scheduling dispatched events to state consumers is how Galena
- * out-performs just about every state management library out there.
- * The scheduler offers the ability to dispatch state updates on 3
- * priorities:
- *
- * 1. Immediate - Immediate synchronous task execution and propagation of
- * changes to consumers
- * 2. Microtask - Immediate task execution and scheduled propagation of
- * changes to consumers
- * 3. Batched - Immediate task execution and batched propagation of
- * changes to consumers
- *
- * This module manages the propagation of changes to State consumers
- * by implementing the three priorities outlined above
- */
-export declare class Scheduler<T extends Task = Task> {
-    private task;
-    private schedule;
-    constructor();
-    /**
-     * Schedule Task
-     *
-     * Given a task (the emission of state changes to consumers)
-     * and a priority, this method executes the task on the priority
-     * level specified
-     */
-    protected scheduleTask(task: T, priority: Priority): void | Promise<void>;
-    /**
-     * Create Schedule
-     *
-     * Schedules the execution of the current task after 5 milliseconds
-     */
-    private createSchedule;
-    /**
-     * Clear Schedule
-     *
-     * Clears the schedule if it exists
-     */
-    private clearSchedule;
-    /**
-     * Execute Tasks
-     *
-     * Clears the schedule if it exists and executes the current task
-     */
-    private executeTasks;
-}

package/dist/types/Galena/State.d.ts

@@ -1,235 +0,0 @@
-import type { Middleware } from "../Middleware/Middleware";
-import { Scheduler } from "./Scheduler";
-import type { Subscription } from "./types";
-import { Priority } from "./types";
-/**
- * ### State
- *
- * The root of all reactivity in Galena. State instances can
- * operate in isolation by calling `new State(...args)` or as
- * part of your application's larger global state by using
- * `new Galena().composeState()`.
- *
- * `State` instances operate on the premise of pub-sub and mutability.
- * This provides significant performance improvement over more traditional
- * state management tools because
- *
- * 1. Mutations can occur in O(1) space
- * 2. Mutations can be batched when dispatching updates to subscribers
- *
- * When deciding how many `State` instances are required for your
- * applications needs, we suggest creating and organizing state in
- * accordance with your application logic. Meaning, you might have a
- * `State` instance for navigation/routing, another `State` instance
- * for storing user information, and so on. Performance can improve
- * significantly when state is dispersed amongst multiple instances
- *
- * #### Creating State Instances
- *
- * ```typescript
- * const MyState = new State("MyState", {
- *   someData: true,
- *   listItems: [1, 2, 3, 4];
- *   // ...etc
- * });
- * ```
- *
- * #### Updating State
- * ##### Synchronous updates
- * ```typescript
- * MyState.update((state) => {
- *   state.listItems.push(5);
- * });
- * ```
- * ##### Asynchronous updates
- * ```typescript
- * MyState.update(async (state) => {
- *   const listItems = await fetch("/list-items");
- *   state.listItems = listItems;
- * });
- * ```
- *
- * #### Subscribing to State Changes
- * ```typescript
- * MyState.subscribe((state) => {
- *   const { listItems } = state
- *   // Do something with your list items!
- * });
- * ```
- */
-export declare class State<T extends any = any> extends Scheduler {
-    state: T;
-    readonly name: string;
-    readonly initialState: T;
-    private readonly middleware;
-    private readonly emitter;
-    constructor(name: string, initialState: T);
-    /**
-     * Get State
-     *
-     * Returns a readonly snapshot of the current state
-     */
-    getState(): Readonly<T>;
-    /**
-     * Update
-     *
-     * Mutates state and notifies any open subscriptions. This method
-     * by default uses task batching for optimized performance. In almost
-     * every use-case, this method is the correct way to mutate state. If
-     * you need to bypass batching for higher-priority state updates, you
-     * can use `State.priorityUpdate()` or `State.backgroundUpdate()`
-     *
-     * ##### Synchronous updates
-     * ```typescript
-     * MyState.update((state, initialState) => {
-     *   state.listItems.push(5);
-     * });
-     * ```
-     * ##### Asynchronous updates
-     * ```typescript
-     * MyState.update(async (state, initialState) => {
-     *   const listItems = await fetch("/list-items");
-     *   state.listItems = listItems;
-     * });
-     * ```
-     */
-    update: (func: (state: T, initialState: T) => void | Promise<void>) => any;
-    /**
-     * Background Update
-     *
-     * Mutates state and notifies any open subscriptions. This method
-     * bypasses Galena's internal task batching for a more immediate
-     * state update and propagation of state to consumers. It utilizes
-     * a micro-task that allows for the current call stack to clear
-     * ahead of propagating state updates to consumers
-     *
-     * ##### Synchronous updates
-     * ```typescript
-     * MyState.backgroundUpdate((state, initialState) => {
-     *   state.listItems.push(5);
-     * });
-     * ```
-     * ##### Asynchronous updates
-     * ```typescript
-     * MyState.backgroundUpdate(async (state, initialState) => {
-     *   const listItems = await fetch("/list-items");
-     *   state.listItems = listItems;
-     * });
-     * ```
-     */
-    backgroundUpdate: (func: (state: T, initialState: T) => void | Promise<void>) => any;
-    /**
-     * Priority Update
-     *
-     * Mutates state and notifies any open subscriptions. This method
-     * bypasses optimizations for task batching and scheduling. This means
-     * that state updates made with this method propagate to subscriptions
-     * as immediately as possible. Overusing this method can cause your
-     * state updates to perform slower in certain cases. The usage of this
-     * method should be conserved for state mutations that need to occur
-     * at a certain frame rate
-     *
-     * ##### Synchronous updates
-     * ```typescript
-     * MyState.priorityUpdate((state, initialState) => {
-     *   state.listItems.push(5);
-     * });
-     * ```
-     * ##### Asynchronous updates
-     * ```typescript
-     * MyState.priorityUpdate(async (state, initialState) => {
-     *   const listItems = await fetch("/list-items");
-     *   state.listItems = listItems;
-     * });
-     * ```
-     */
-    priorityUpdate: (func: (state: T, initialState: T) => void | Promise<void>) => any;
-    /**
-     * Reset
-     *
-     * Resets the current state to its initial state
-     */
-    reset: () => any;
-    /**
-     * Mutation
-     *
-     * This method can be used to wrap arbitrary functions that when invoked
-     * will:
-     * 1. Notify your subscriptions with the latest state
-     * 2. Execute any registered middleware (such as loggers or profiling tools)
-     *
-     * Using this method, developers can compose and extend `Galena`'s internal
-     * infrastructure for state mutations to create proprietary models for your
-     * state
-     *
-     * ```typescript
-     * import { State } from "@figliolia/galena";
-     *
-     * // Extend of Galena State
-     * class MyState extends State {
-     *   addListItem = mutation((newListItem) => {
-     *     this.state.list.push(newListItem);
-     *   });
-     * }
-     *
-     * // Create an instance
-     * const myState = new MyState("myState", { list: [] });
-     *
-     * // Invoke your custom mutation method
-     * myState.addListItem("new-item");
-     * ```
-     */
-    protected mutation<F extends (...args: any[]) => any>(func: F, priority?: Priority): (...args: Parameters<F>) => any;
-    /**
-     * Schedule Update
-     *
-     * Schedules an update to State subscribers and emits the
-     * `onUpdate` lifecycle hook
-     */
-    private scheduleUpdate;
-    /**
-     * Register Middleware
-     *
-     * Caches a `Middleware` instance and invokes its
-     * lifecycle subscriptions on all state transitions
-     */
-    registerMiddleware(...middleware: Middleware[]): void;
-    /**
-     * Subscribe
-     *
-     * Registers a subscription on the state instance. The
-     * callback you provide will execute each time state changes.
-     * Returns a unique identifier for your subscription
-     */
-    subscribe(callback: Subscription<T>): string;
-    /**
-     * Unsubscribe
-     *
-     * Given a subscription ID, removes a registered subscription
-     * from the `State` instance
-     */
-    unsubscribe(ID: string): boolean | undefined;
-    /**
-     * Clear All Subscriptions
-     *
-     * Removes all open subscriptions to the `State` instance
-     */
-    clearAllSubscriptions(): void;
-    /**
-     * Life Cycle Event
-     *
-     * Triggers a life cycle event for each registered middleware
-     */
-    private lifeCycleEvent;
-    /**
-     * Clone
-     *
-     * `State` instances accept any value as a form of reactive
-     * state. In order to maintain the initial state past any state
-     * transitions, this method clones the initial values provided
-     * to the `State` constructor and caches them to allow for
-     * developers to easily reset their current state back to its
-     * initial value
-     */
-    static clone<T>(state: T): T;
-}

package/dist/types/Galena/index.d.ts

@@ -1,3 +0,0 @@
-export { Galena } from "./Galena";
-export { State } from "./State";
-export * from "./types";

package/dist/types/Galena/types.d.ts

@@ -1,13 +0,0 @@
-import type { Callback } from "@figliolia/event-emitter";
-import type { State } from "./State";
-export type MutationEvent<T extends any> = {
-    [key: State<T>["name"]]: T;
-};
-export declare enum Priority {
-    "IMMEDIATE" = 1,
-    "MICROTASK" = 2,
-    "BATCHED" = 3
-}
-export type Task = () => void;
-export type SubscriptionTuple = [state: string, ID: string];
-export type Subscription<T> = Callback<[nextState: T]>;

package/dist/types/Middleware/Middleware.d.ts

@@ -1,43 +0,0 @@
-import type { State } from "../Galena/State";
-/**
- * # Middleware
- *
- * A root interface for all `Galena` Middleware. When creating
- * a middleware for your `Galena` state, simply extend this
- * class any override any of its public lifecycle methods.
- *
- * ### Creating a Profiling Middleware
- *
- * ```typescript
- * export class ProfilerMiddleware extends Middleware {
- *   updateState: number | null = null;
- *
- *   override onBeforeUpdate(state: State) {
- *     this.updateStart = performance.now();
- *   }
- *
- *   override onUpdate(state: State) {
- *     if(this.updateStart) {
- *       const timeToUpdate = performance.now() - this.updateStart;
- *       if(timeToUpdate > 16) {
- *         console.warn("A state transition took more than 16 milliseconds!", State);
- *       }
- *     }
- *   }
- * }
- * ```
- */
-export declare class Middleware<T extends any = any> {
-    /**
-     * On Before Update
-     *
-     * An event emitted each time a `State` mutation is enqueued
-     */
-    onBeforeUpdate(_state: State<T>): void;
-    /**
-     * On Update
-     *
-     * An event emitted each time a `State` instance is mutated
-     */
-    onUpdate(_state: State<T>): void;
-}

package/dist/types/Middleware/index.d.ts

@@ -1,2 +0,0 @@
-export { Middleware } from "./Middleware";
-export * from "./types";

package/dist/types/Middleware/types.d.ts

@@ -1,4 +0,0 @@
-export declare enum MiddlewareEvents {
-    "onUpdate" = "onUpdate",
-    "onBeforeUpdate" = "onBeforeUpdate"
-}

package/dist/types/Middlewares/Logger.d.ts

@@ -1,27 +0,0 @@
-import { State } from "../Galena/State";
-import { Middleware } from "../Middleware/Middleware";
-/**
- * Logger
- *
- * A middleware for Redux-style logging! Each state transition
- * will log to the console the `State` instance that changed
- * along with a before and after snapshot of the current state:
- *
- * ```typescript
- * const State = new Galena([new Logger()]);
- * // if using isolated state instances:
- * const MyState = new State(...args);
- * MyState.registerMiddleware(new Logger())
- * ```
- */
-export declare class Logger extends Middleware {
-    private previousState;
-    onBeforeUpdate(state: State): void;
-    onUpdate(state: State): void;
-    /**
-     * Time
-     *
-     * Returns the time in which a given state transition completed
-     */
-    private get time();
-}

package/dist/types/Middlewares/Profiler.d.ts

@@ -1,22 +0,0 @@
-import type { State } from "../Galena/State";
-import { Middleware } from "../Middleware/Middleware";
-/**
- * Profiler
- *
- * A logger for state transitions exceeding a given threshold
- * for duration:
- *
- * ```typescript
- * const State = new Galena([new Profiler()]);
- * // if using isolated state instances:
- * const MyState = new State(...args);
- * MyState.registerMiddleware(new Profiler())
- * ```
- */
-export declare class Profiler extends Middleware {
-    private threshold;
-    private startTime;
-    constructor(threshold?: number);
-    onBeforeUpdate(_: State): void;
-    onUpdate(nextState: State): void;
-}

package/dist/types/Middlewares/index.d.ts

@@ -1,2 +0,0 @@
-export { Logger } from "./Logger";
-export { Profiler } from "./Profiler";

package/dist/types/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./Galena";
-export * from "./Middleware";
-export * from "./Middlewares";

package/src/Galena/Galena.ts

@@ -1,252 +0,0 @@
-import { AutoIncrementingID } from "@figliolia/event-emitter";
-import { State } from "Galena/State";
-import type { Middleware } from "Middleware/Middleware";
-import { Guards } from "./Guards";
-import type { Subscription, SubscriptionTuple } from "./types";
-
-/**
- * ## Galena
- *
- * A performant global state solution that scales
- *
- * ### Creating State
- *
- * ```typescript
- * // AppState.ts
- * import { Galena } from "@figliolia/galena";
- *
- * const AppState = new Galena([...middleware]);
- *
- * const NavigationState = AppState.composeState("navigation", {
- *   currentRoute: "/",
- *   userID: "12345",
- *   permittedRoutes: ["/*"]
- * });
- * ```
- *
- * ### Subscribing to State Changes
- * #### Using the Galena Instance
- * ```typescript
- * import { AppState } from "./AppState";
- *
- * AppState.subscribe(appState => {
- *   const navState = appState.get("navigation");
- *   const { currentRoute } = navState.state;
- *   // do something with state changes!
- * });
- * ```
- * #### Using the State Instance
- * ```typescript
- * NavigationState.subscribe(navigation => {
- *   const { currentRoute } = navigation
- *   // do something with state changes!
- * });
- * ```
- *
- * #### Using Global Subscriptions
- * ```typescript
- * NavigationState.subscribeAll(nextState => {
- *   const { currentRoute } = nextState.navigation
- *   // do something with state changes!
- * });
- * ```
- *
- * ### Mutating State
- * ```typescript
- * NavigationState.update(state => {
- *   state.currentRoute = "/profile";
- *   // You can mutate state without creating new objects!
- * });
- * ```
- */
-export class Galena<
-  T extends Record<string, State<any>> = Record<string, State<any>>,
-> extends Guards {
-  public readonly state = {} as T;
-  private readonly middleware: Middleware[] = [];
-  private readonly IDs = new AutoIncrementingID();
-  private readonly subscriptions = new Map<string, SubscriptionTuple[]>();
-  constructor(middleware: Middleware[] = []) {
-    super();
-    this.middleware = middleware;
-  }
-
-  /**
-   * Compose State
-   *
-   * Creates a new `State` instance and returns it. Your new state
-   * becomes immediately available on your `Galena` instance and
-   * is wired into your middleware. All existing subscriptions to
-   * state will automatically receive updates when your new unit of
-   * state updates
-   */
-  public composeState<S extends Record<string, any>, M extends typeof State<S>>(
-    name: string,
-    initialState: S,
-    Model?: M,
-  ) {
-    this.guardDuplicateStates(name, this.state);
-    const StateModel = Model || State<S>;
-    const state = new StateModel(name, initialState);
-    state.registerMiddleware(...this.middleware);
-    this.mutable[name] = state;
-    this.reIndexSubscriptions(name);
-    return state as InstanceType<M>;
-  }
-
-  /**
-   * Get State
-   *
-   * Returns a mutable state instance
-   */
-  public getState() {
-    return this.state as Readonly<T>;
-  }
-
-  /**
-   * Get
-   *
-   * Returns a unit of `State` by name
-   */
-  public get<K extends Extract<keyof T, string>>(name: K): T[K] {
-    this.warnForUndefinedStates(name, this.state);
-    return this.state[name];
-  }
-
-  /**
-   * Mutable
-   *
-   * Returns a mutable state instance
-   */
-  private get mutable() {
-    return this.state as Record<string, State>;
-  }
-
-  /**
-   * Update
-   *
-   * Runs a mutation on the specified unit of state
-   */
-  public update<K extends Extract<keyof T, string>>(
-    name: K,
-    mutation: Parameters<T[K]["update"]>["0"],
-  ) {
-    return this.get(name).update(mutation);
-  }
-
-  /**
-   * Background Update
-   *
-   * Runs a higher priority mutation on the specified unit of
-   * state
-   */
-  public backgroundUpdate<K extends Extract<keyof T, string>>(
-    name: K,
-    mutation: Parameters<T[K]["backgroundUpdate"]>["0"],
-  ) {
-    return this.get(name).backgroundUpdate(mutation);
-  }
-
-  /**
-   * Priority Update
-   *
-   * Runs an immediate priority mutation on the specified unit
-   * of state
-   */
-  public priorityUpdate<K extends Extract<keyof T, string>>(
-    name: K,
-    mutation: Parameters<T[K]["priorityUpdate"]>["0"],
-  ) {
-    return this.get(name).priorityUpdate(mutation);
-  }
-
-  /**
-   * Subscribe
-   *
-   * Given the name of a unit of state, this method registers
-   * a subscription on the target state instance. The callback
-   * you provide will execute each time state changes. Returns
-   * a unique identifier for your subscription. To clean up your
-   * subscription, call `Galena.unsubscribe()` with the ID returned
-   * by this method
-   */
-  public subscribe<K extends Extract<keyof T, string>>(
-    name: K,
-    callback: Parameters<T[K]["subscribe"]>["0"],
-  ) {
-    return this.get(name).subscribe(callback);
-  }
-
-  /**
-   * Unsubscribe
-   *
-   * Given a subscription ID returned from the `subscribe` method,
-   * this method removes and cleans up the corresponding subscription
-   */
-  public unsubscribe<K extends Extract<keyof T, string>>(name: K, ID: string) {
-    return this.get(name).unsubscribe(ID);
-  }
-
-  /**
-   * Subscribe All
-   *
-   * Registers a callback on each registered `State` instance and
-   * is invoked each time your state changes. Using `Galena`'s
-   * `subscribeAll` method, although performant, can be less
-   * performant than subscribing directly to a target `State`
-   * instance using `Galena.subscribe()`. To clean up your
-   * subscription, call `Galena.unsubscribeAll()` with the ID
-   * returned
-   */
-  public subscribeAll(callback: Subscription<T>) {
-    const stateSubscriptions: [state: string, ID: string][] = [];
-    for (const key in this.state) {
-      stateSubscriptions.push([
-        key,
-        this.state[key].subscribe(() => {
-          void callback(this.state);
-        }),
-      ]);
-    }
-    const subscriptionID = this.IDs.get();
-    this.subscriptions.set(subscriptionID, stateSubscriptions);
-    return subscriptionID;
-  }
-
-  /**
-   * Unsubscribe
-   *
-   * Given a subscription ID returned from the `subscribeAll()` method,
-   * this method removes and cleans up the corresponding subscription
-   */
-  public unsubscribeAll(ID: string) {
-    const IDs = this.subscriptions.get(ID);
-    if (IDs) {
-      for (const [state, ID] of IDs) {
-        this.state[state].unsubscribe(ID);
-      }
-      this.subscriptions.delete(ID);
-    }
-  }
-
-  /**
-   * ReIndex Subscriptions
-   *
-   * When units of state are created lazily, this method updates
-   * each existing subscription to receive mutations occurring on
-   * recently created `State` instances that post-date prior
-   * subscriptions
-   */
-  private reIndexSubscriptions(name: string) {
-    for (const [ID, unitSubscriptions] of this.subscriptions) {
-      const [stateName, listenerID] = unitSubscriptions[0];
-      const subscriptions =
-        this.state[stateName]["emitter"].storage.get(stateName);
-      const listener = subscriptions?.storage?.get?.(listenerID);
-      if (listener) {
-        unitSubscriptions.push([name, this.state[name].subscribe(listener)]);
-        this.subscriptions.set(ID, unitSubscriptions);
-      }
-    }
-  }
-}