@figliolia/galena 2.3.5 → 3.0.0

package/dist/cjs/Galena/Galena.js

@@ -1,223 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Galena = void 0;
-const event_emitter_1 = require("@figliolia/event-emitter");
-const State_1 = require("./State");
-const Guards_1 = require("./Guards");
-/**
- * ## 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!
- * });
- * ```
- */
-class Galena extends Guards_1.Guards {
-    constructor(middleware = []) {
-        super();
-        this.state = {};
-        this.middleware = [];
-        this.IDs = new event_emitter_1.AutoIncrementingID();
-        this.subscriptions = new Map();
-        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
-     */
-    composeState(name, initialState, Model) {
-        this.guardDuplicateStates(name, this.state);
-        const StateModel = Model || (State_1.State);
-        const state = new StateModel(name, initialState);
-        state.registerMiddleware(...this.middleware);
-        this.mutable[name] = state;
-        this.reIndexSubscriptions(name);
-        return state;
-    }
-    /**
-     * Get State
-     *
-     * Returns a mutable state instance
-     */
-    getState() {
-        return this.state;
-    }
-    /**
-     * Get
-     *
-     * Returns a unit of `State` by name
-     */
-    get(name) {
-        this.warnForUndefinedStates(name, this.state);
-        return this.state[name];
-    }
-    /**
-     * Mutable
-     *
-     * Returns a mutable state instance
-     */
-    get mutable() {
-        return this.state;
-    }
-    /**
-     * Update
-     *
-     * Runs a mutation on the specified unit of state
-     */
-    update(name, mutation) {
-        return this.get(name).update(mutation);
-    }
-    /**
-     * Background Update
-     *
-     * Runs a higher priority mutation on the specified unit of
-     * state
-     */
-    backgroundUpdate(name, mutation) {
-        return this.get(name).backgroundUpdate(mutation);
-    }
-    /**
-     * Priority Update
-     *
-     * Runs an immediate priority mutation on the specified unit
-     * of state
-     */
-    priorityUpdate(name, mutation) {
-        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
-     */
-    subscribe(name, callback) {
-        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
-     */
-    unsubscribe(name, ID) {
-        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
-     */
-    subscribeAll(callback) {
-        const stateSubscriptions = [];
-        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
-     */
-    unsubscribeAll(ID) {
-        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
-     */
-    reIndexSubscriptions(name) {
-        var _a, _b;
-        for (const [ID, unitSubscriptions] of this.subscriptions) {
-            const [stateName, listenerID] = unitSubscriptions[0];
-            const subscriptions = this.state[stateName]["emitter"].storage.get(stateName);
-            const listener = (_b = (_a = subscriptions === null || subscriptions === void 0 ? void 0 : subscriptions.storage) === null || _a === void 0 ? void 0 : _a.get) === null || _b === void 0 ? void 0 : _b.call(_a, listenerID);
-            if (listener) {
-                unitSubscriptions.push([name, this.state[name].subscribe(listener)]);
-                this.subscriptions.set(ID, unitSubscriptions);
-            }
-        }
-    }
-}
-exports.Galena = Galena;

package/dist/cjs/Galena/Guards.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Guards = void 0;
-/**
- * Guards
- *
- * Development-only warnings and runtime errors designed to
- * guard developers against possible pitfalls when using
- * Galena. This interface provides composable error and
- * warning methods that can be used to prevent invalid usage
- * of the library
- */
-class Guards {
-    /**
-     * Warn For Undefined States
-     *
-     * In Galena, it's normal to lazy initialize a unit of state
-     * in attached to a `Galena` instance. This warning lets
-     * developers know that they are attempting to manipulate a
-     * unit of state that has not yet been initialized
-     */
-    warnForUndefinedStates(name, state) {
-        if (!(name in state)) {
-            console.warn(`A unit of state with the name "${name}" does not yet exist on this Galena instance. If this is expected, you can ignore this warning`);
-        }
-    }
-    /**
-     * Guard Duplicate States
-     *
-     * Throws an error if a developer attempts to create
-     * more than one state with the same name on a single
-     * `Galena` instance
-     */
-    guardDuplicateStates(name, state) {
-        if (name in state) {
-            console.warn(`A unit of state with the name "${name}" already exists on this Galena instance. Please re-name this new unit of state to something unique`);
-        }
-    }
-}
-exports.Guards = Guards;

package/dist/cjs/Galena/Scheduler.js

@@ -1,84 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Scheduler = void 0;
-const types_1 = require("./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
- */
-class Scheduler {
-    constructor() {
-        this.task = null;
-        this.schedule = null;
-        this.executeTasks = this.executeTasks.bind(this);
-    }
-    /**
-     * 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
-     */
-    scheduleTask(task, priority) {
-        this.task = task;
-        switch (priority) {
-            case types_1.Priority.IMMEDIATE:
-                return this.executeTasks();
-            case types_1.Priority.MICROTASK:
-                return Promise.resolve().then(() => {
-                    return this.executeTasks();
-                });
-            case types_1.Priority.BATCHED:
-            default:
-                if (!this.schedule) {
-                    this.createSchedule();
-                }
-        }
-    }
-    /**
-     * Create Schedule
-     *
-     * Schedules the execution of the current task after 5 milliseconds
-     */
-    createSchedule() {
-        this.clearSchedule();
-        this.schedule = setTimeout(this.executeTasks, 5);
-    }
-    /**
-     * Clear Schedule
-     *
-     * Clears the schedule if it exists
-     */
-    clearSchedule() {
-        if (this.schedule !== null) {
-            clearTimeout(this.schedule);
-            this.schedule = null;
-        }
-    }
-    /**
-     * Execute Tasks
-     *
-     * Clears the schedule if it exists and executes the current task
-     */
-    executeTasks() {
-        var _a;
-        this.clearSchedule();
-        (_a = this.task) === null || _a === void 0 ? void 0 : _a.call(this);
-        this.task = null;
-    }
-}
-exports.Scheduler = Scheduler;

package/dist/cjs/Galena/State.js

@@ -1,314 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.State = void 0;
-const event_emitter_1 = require("@figliolia/event-emitter");
-const types_1 = require("../Middleware/types");
-const Scheduler_1 = require("./Scheduler");
-const types_2 = require("./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!
- * });
- * ```
- */
-class State extends Scheduler_1.Scheduler {
-    constructor(name, initialState) {
-        super();
-        this.middleware = [];
-        this.emitter = new event_emitter_1.EventEmitter();
-        /**
-         * 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;
-         * });
-         * ```
-         */
-        this.update = this.mutation((func) => {
-            return func(this.state, this.initialState);
-        }, types_2.Priority.BATCHED);
-        /**
-         * 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;
-         * });
-         * ```
-         */
-        this.backgroundUpdate = this.mutation((func) => {
-            return func(this.state, this.initialState);
-        }, types_2.Priority.MICROTASK);
-        /**
-         * 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;
-         * });
-         * ```
-         */
-        this.priorityUpdate = this.mutation((func) => {
-            return func(this.state, this.initialState);
-        }, types_2.Priority.IMMEDIATE);
-        /**
-         * Reset
-         *
-         * Resets the current state to its initial state
-         */
-        this.reset = this.mutation(() => {
-            this.state = State.clone(this.initialState);
-        });
-        this.name = name;
-        this.state = initialState;
-        this.initialState = State.clone(initialState);
-    }
-    /**
-     * Get State
-     *
-     * Returns a readonly snapshot of the current state
-     */
-    getState() {
-        return this.state;
-    }
-    /**
-     * 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");
-     * ```
-     */
-    mutation(func, priority = types_2.Priority.BATCHED) {
-        return (...args) => {
-            this.lifeCycleEvent(types_1.MiddlewareEvents.onBeforeUpdate);
-            const returnValue = func(...args);
-            if (returnValue instanceof Promise) {
-                return returnValue.then(v => {
-                    this.scheduleUpdate(priority);
-                    return v;
-                });
-            }
-            this.scheduleUpdate(priority);
-            return returnValue;
-        };
-    }
-    /**
-     * Schedule Update
-     *
-     * Schedules an update to State subscribers and emits the
-     * `onUpdate` lifecycle hook
-     */
-    scheduleUpdate(priority) {
-        this.lifeCycleEvent(types_1.MiddlewareEvents.onUpdate);
-        void this.scheduleTask(() => this.emitter.emit(this.name, this.state), priority);
-    }
-    /**
-     * Register Middleware
-     *
-     * Caches a `Middleware` instance and invokes its
-     * lifecycle subscriptions on all state transitions
-     */
-    registerMiddleware(...middleware) {
-        this.middleware.push(...middleware);
-    }
-    /**
-     * 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) {
-        return this.emitter.on(this.name, callback);
-    }
-    /**
-     * Unsubscribe
-     *
-     * Given a subscription ID, removes a registered subscription
-     * from the `State` instance
-     */
-    unsubscribe(ID) {
-        return this.emitter.off(this.name, ID);
-    }
-    /**
-     * Clear All Subscriptions
-     *
-     * Removes all open subscriptions to the `State` instance
-     */
-    clearAllSubscriptions() {
-        return this.emitter.storage.clear();
-    }
-    /**
-     * Life Cycle Event
-     *
-     * Triggers a life cycle event for each registered middleware
-     */
-    lifeCycleEvent(event) {
-        const maxIndex = this.middleware.length - 1;
-        for (let i = maxIndex; i > -1; i--) {
-            this.middleware[i][event](this);
-        }
-    }
-    /**
-     * 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(state) {
-        switch (typeof state) {
-            case "string":
-                return String(state);
-            case "bigint":
-                return BigInt(state);
-            case "boolean":
-                return Boolean(state);
-            case "number":
-                return Number(state);
-            case "symbol":
-            case "function":
-                return state;
-            case "undefined":
-                return undefined;
-            case "object":
-            default:
-                if (!state) {
-                    return null;
-                }
-                if (Array.isArray(state)) {
-                    return [...state];
-                }
-                if (state instanceof Set) {
-                    return new Set(state);
-                }
-                if (state instanceof Map) {
-                    return new Map(state);
-                }
-                if (state && typeof state === "object") {
-                    return Object.assign({}, state);
-                }
-                return state;
-        }
-    }
-}
-exports.State = State;

package/dist/cjs/Galena/index.js

@@ -1,22 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.State = exports.Galena = void 0;
-var Galena_1 = require("./Galena");
-Object.defineProperty(exports, "Galena", { enumerable: true, get: function () { return Galena_1.Galena; } });
-var State_1 = require("./State");
-Object.defineProperty(exports, "State", { enumerable: true, get: function () { return State_1.State; } });
-__exportStar(require("./types"), exports);

package/dist/cjs/Galena/types.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Priority = void 0;
-var Priority;
-(function (Priority) {
-    Priority[Priority["IMMEDIATE"] = 1] = "IMMEDIATE";
-    Priority[Priority["MICROTASK"] = 2] = "MICROTASK";
-    Priority[Priority["BATCHED"] = 3] = "BATCHED";
-})(Priority || (exports.Priority = Priority = {}));