@figliolia/galena 2.3.4 → 3.0.0

package/dist/cjs/Middleware/Middleware.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Middleware = void 0;
-/**
- * # 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);
- *       }
- *     }
- *   }
- * }
- * ```
- */
-class Middleware {
-    /**
-     * On Before Update
-     *
-     * An event emitted each time a `State` mutation is enqueued
-     */
-    onBeforeUpdate(_state) { }
-    /**
-     * On Update
-     *
-     * An event emitted each time a `State` instance is mutated
-     */
-    onUpdate(_state) { }
-}
-exports.Middleware = Middleware;

package/dist/cjs/Middleware/index.js

@@ -1,20 +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.Middleware = void 0;
-var Middleware_1 = require("./Middleware");
-Object.defineProperty(exports, "Middleware", { enumerable: true, get: function () { return Middleware_1.Middleware; } });
-__exportStar(require("./types"), exports);

package/dist/cjs/Middleware/types.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MiddlewareEvents = void 0;
-var MiddlewareEvents;
-(function (MiddlewareEvents) {
-    MiddlewareEvents["onUpdate"] = "onUpdate";
-    MiddlewareEvents["onBeforeUpdate"] = "onBeforeUpdate";
-})(MiddlewareEvents || (exports.MiddlewareEvents = MiddlewareEvents = {}));

package/dist/cjs/Middlewares/Logger.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Logger = void 0;
-const State_1 = require("../Galena/State");
-const Middleware_1 = require("../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())
- * ```
- */
-class Logger extends Middleware_1.Middleware {
-    constructor() {
-        super(...arguments);
-        this.previousState = null;
-    }
-    onBeforeUpdate(state) {
-        this.previousState = State_1.State.clone(state.state);
-    }
-    onUpdate(state) {
-        console.log("%cMutation:", "color: rgb(187, 186, 186); font-weight: bold", state.name, "@", this.time);
-        console.log("   %cPrevious State", "color: #26ad65; font-weight: bold", this.previousState);
-        console.log("   %cNext State    ", "color: rgb(17, 118, 249); font-weight: bold", state.getState());
-        this.previousState = null;
-    }
-    /**
-     * Time
-     *
-     * Returns the time in which a given state transition completed
-     */
-    get time() {
-        const date = new Date();
-        const mHours = date.getHours();
-        const hours = mHours > 12 ? mHours - 12 : mHours;
-        const mins = date.getMinutes();
-        const minutes = mins.toString().length === 1 ? `0${mins}` : mins;
-        const secs = date.getSeconds();
-        const seconds = secs.toString().length === 1 ? `0${secs}` : secs;
-        const milliseconds = date.getMilliseconds();
-        return `${hours}:${minutes}:${seconds}:${milliseconds}`;
-    }
-}
-exports.Logger = Logger;

package/dist/cjs/Middlewares/Profiler.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Profiler = void 0;
-const Middleware_1 = require("../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())
- * ```
- */
-class Profiler extends Middleware_1.Middleware {
-    constructor(threshold = 16) {
-        super();
-        this.startTime = null;
-        this.threshold = threshold;
-    }
-    onBeforeUpdate(_) {
-        this.startTime = performance.now();
-    }
-    onUpdate(nextState) {
-        if (this.startTime) {
-            const endTime = performance.now();
-            const diff = endTime - this.startTime;
-            if (diff > this.threshold) {
-                console.warn(`A slow state transition was detected on ${nextState.name}`, nextState.getState());
-                console.warn(`The last transition took ${diff}ms`);
-            }
-        }
-    }
-}
-exports.Profiler = Profiler;

package/dist/cjs/Middlewares/index.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Profiler = exports.Logger = void 0;
-var Logger_1 = require("./Logger");
-Object.defineProperty(exports, "Logger", { enumerable: true, get: function () { return Logger_1.Logger; } });
-var Profiler_1 = require("./Profiler");
-Object.defineProperty(exports, "Profiler", { enumerable: true, get: function () { return Profiler_1.Profiler; } });

package/dist/cjs/index.js

@@ -1,19 +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 });
-__exportStar(require("./Galena"), exports);
-__exportStar(require("./Middleware"), exports);
-__exportStar(require("./Middlewares"), exports);

package/dist/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/dist/mjs/Galena/Galena.js

@@ -1,218 +0,0 @@
-import { AutoIncrementingID } from "@figliolia/event-emitter";
-import { State } from "./State.js";
-import { Guards } from "./Guards.js";
-/**
- * ## 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 extends Guards {
-    state = {};
-    middleware = [];
-    IDs = new AutoIncrementingID();
-    subscriptions = new Map();
-    constructor(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
-     */
-    composeState(name, initialState, Model) {
-        this.guardDuplicateStates(name, this.state);
-        const StateModel = Model || (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) {
-        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);
-            }
-        }
-    }
-}

package/dist/mjs/Galena/Guards.js

@@ -1,36 +0,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
- */
-export 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`);
-        }
-    }
-}

package/dist/mjs/Galena/Scheduler.js

@@ -1,79 +0,0 @@
-import { Priority } from "./types.js";
-/**
- * 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 class Scheduler {
-    task = null;
-    schedule = null;
-    constructor() {
-        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 Priority.IMMEDIATE:
-                return this.executeTasks();
-            case Priority.MICROTASK:
-                return Promise.resolve().then(() => {
-                    return this.executeTasks();
-                });
-            case 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() {
-        this.clearSchedule();
-        this.task?.();
-        this.task = null;
-    }
-}