effectable 0.1.0

package/build/store/types.d.ts

@@ -0,0 +1,259 @@
+/**
+ * Redux-RxJS Store Types
+ *
+ * Defines types for a Redux-like store with RxJS support.
+ * Maximum compatibility with Redux v4 API plus reactive extensions.
+ *
+ * @module Effectable/store/types
+ */
+import { Observable } from 'rxjs';
+/**
+ * Base Action type
+ *
+ * All actions must have a type field and an optional payload.
+ */
+export interface Action<T = any> {
+    type: string;
+    payload?: T;
+}
+/**
+ * Base action for middleware and default dispatch.
+ *
+ * Used as “any action” with a required `type`
+ * and an optional `payload`.
+ */
+export interface AnyAction extends Action<unknown> {
+}
+/**
+ * Reducer function
+ *
+ * Takes the current state and an action, returns the new state.
+ * Must be a pure function (no side-effects).
+ *
+ * @template S - State type
+ * @template A - Action type
+ */
+export type Reducer<S = any, A extends Action = Action> = (state: S, action: A) => S;
+/**
+ * Dispatch function
+ *
+ * Sends an action to the Store for processing through the middleware chain and reducer.
+ * Supports both synchronous and asynchronous middleware.
+ *
+ * @template A - Action type
+ */
+export type Dispatch<A = AnyAction> = (action: A) => A | Promise<A>;
+/**
+ * Dispatch as a Store method with an optional generic to narrow the action type at the call site.
+ * Allows calling store.dispatch&lt;ConcreteAction&gt;({ type, payload }) without a type cast.
+ *
+ * @template A - Base action type (e.g. RootAction)
+ */
+export type DispatchMethod<A extends Action = Action> = <B extends A = A>(action: B) => B | Promise<B>;
+/**
+ * Selector function
+ *
+ * Extracts a slice of state from the Store.
+ * Can be used for memoization and composition.
+ *
+ * @template S - State type
+ * @template R - Result type
+ */
+export type Selector<S, R> = (state: S) => R;
+/**
+ * Parametric Selector (with extra parameters)
+ *
+ * A selector that takes not only state but also additional parameters.
+ *
+ * @template S - State type
+ * @template P - Parameters type
+ * @template R - Result type
+ */
+export type ParametricSelector<S, P, R> = (state: S, props: P) => R;
+/**
+ * Store Creator
+ *
+ * Function that creates a Store. Used for typing createStore.
+ */
+export type StoreCreator<S = any, A extends Action = Action> = (reducer: Reducer<S, A>, initialState: S) => Store<S, A>;
+/**
+ * Store Enhancer
+ *
+ * Higher-order function for modifying Store behavior.
+ * Used to apply middleware via applyMiddleware.
+ */
+export type StoreEnhancer<S = any, A extends Action = Action> = (createStore: StoreCreator<S, A>) => StoreCreator<S, A>;
+/**
+ * Store interface
+ *
+ * Main Redux Store interface with RxJS extensions.
+ *
+ * @template S - State type
+ * @template A - Action type
+ */
+export interface Store<S = any, A extends Action = Action> {
+    /**
+     * Dispatches an action to the Store.
+     * Supports an optional generic to narrow the type: store.dispatch&lt;ConcreteAction&gt;({ type, payload }).
+     *
+     * The action goes through the middleware chain, then the reducer,
+     * and the new state is emitted on the state$ Observable.
+     *
+     * @param action - Action to process
+     * @returns The same action (for chaining)
+     */
+    dispatch: DispatchMethod<A>;
+    /**
+     * Returns the current state synchronously
+     *
+     * Useful for taking a state snapshot without subscribing.
+     *
+     * @returns Current Store state
+     */
+    getState(): S;
+    /**
+     * Observable of the current state (RxJS extension)
+     *
+     * Emits a new value on every state change.
+     * Starts with the current state (BehaviorSubject).
+     *
+     * @example
+     * store.state$.subscribe(state => {
+     *   console.log('State changed:', state);
+     * });
+     */
+    state$: Observable<S>;
+    /**
+     * Universal method for applying selectors (RxJS extension)
+     *
+     * Automatically applies distinctUntilChanged to avoid
+     * unnecessary emissions when the selector result is unchanged.
+     *
+     * @template T - Selector result type
+     * @param selectorFn - Selector function
+     * @returns Observable of the selector result
+     *
+     * @example
+     * const currentPath$ = store.select(state => state.navigation.currentPath);
+     * currentPath$.subscribe(path => console.log('Path:', path));
+     */
+    select<T>(selectorFn: Selector<S, T>): Observable<T>;
+    /**
+     * Completes all subscriptions and cleans up resources
+     *
+     * After destroy() the Store is no longer usable.
+     * Call when unmounting the app or in tests.
+     */
+    destroy(): void;
+}
+/**
+ * Middleware API
+ *
+ * API provided to each middleware: dispatch and getState.
+ * Calling api.dispatch(action) runs the action through the entire chain again.
+ *
+ * @template D - Dispatch type
+ * @template S - State type
+ */
+export interface MiddlewareAPI<D = Dispatch, S = unknown> {
+    /**
+     * Dispatch function for sending new actions
+     *
+     * IMPORTANT: This is the wrapped dispatch that goes through the middleware chain.
+     * Can be used to dispatch additional actions inside middleware.
+     */
+    dispatch: D;
+    /**
+     * Function to get the current state
+     *
+     * Returns a state snapshot at the time of the call.
+     */
+    getState(): S;
+}
+/**
+ * Middleware function
+ *
+ * Redux-style middleware with a triple-curried signature:
+ * (store) => (next) => (action) => result
+ *
+ * Middleware can:
+ * - Intercept actions
+ * - Perform side-effects
+ * - Dispatch new actions
+ * - Modify or block actions
+ * - Call next() multiple times
+ * - Use async/await
+ * - Subscribe to state$ for reactive logic
+ *
+ * @template S - State type
+ * @template A - Action type
+ *
+ * @example
+ * const loggingMiddleware: Middleware = (store) => (next) => (action) => {
+ *   console.log('Action:', action.type);
+ *   const result = next(action);
+ *   console.log('New state:', store.getState());
+ *   return result;
+ * };
+ *
+ * @example
+ * // Async middleware
+ * const asyncMiddleware: Middleware = (store) => (next) => async (action) => {
+ *   const result = next(action);
+ *   await saveToServer(action);
+ *   return result;
+ * };
+ */
+export interface Middleware<DispatchExt = {}, S = unknown, D = Dispatch> {
+    /**
+     * Creates middleware in redux-style format `(api) => (next) => (action)`.
+     * `next(action)` forwards the action down the current chain.
+     * `api.dispatch(action)` starts the action from the beginning of the entire chain.
+     *
+     * The action handler may be synchronous or asynchronous.
+     *
+     * @param {MiddlewareAPI<D, S>} api - Middleware API: dispatch, getState
+     * @returns {(next: D) => (action: unknown) => unknown | Promise<unknown>} wrapper over dispatch
+     */
+    (api: MiddlewareAPI<D, S>): (next: D) => (action: unknown) => unknown | Promise<unknown>;
+}
+/**
+ * Memoized selector
+ *
+ * Selector with extra methods for memoization control
+ * and performance debugging.
+ *
+ * @template S - State type
+ * @template R - Result type
+ */
+export interface MemoizedSelector<S, R> extends Selector<S, R> {
+    /**
+     * Resets the selector cache
+     *
+     * After calling, the next selector invocation will recompute
+     * regardless of input data.
+     *
+     * Useful for testing or when you need to force
+     * a result recomputation.
+     */
+    resetMemoization(): void;
+    /**
+     * Returns the number of combiner function calls
+     *
+     * Used for debugging and optimization.
+     * If recomputations() grows too quickly,
+     * the selector may need optimization.
+     *
+     * @returns Recomputation count
+     */
+    recomputations(): number;
+}
+/**
+ * Type guard to check whether an object is an Action
+ */
+export declare function isAction(obj: any): obj is Action;
+/**
+ * Type guard to check whether a function is Middleware
+ */
+export declare function isMiddleware<DispatchExt = {}, S = unknown, D extends Dispatch = Dispatch>(fn: any): fn is Middleware<DispatchExt, S, D>;
+//# sourceMappingURL=types.d.ts.map

package/build/store/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/store/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAMlC;;;;GAIG;AACH,MAAM,WAAW,MAAM,CAAC,CAAC,GAAG,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,CAAC,CAAC;CACb;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAU,SAAQ,MAAM,CAAC,OAAO,CAAC;CAAG;AAErD;;;;;;;;GAQG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CACxD,KAAK,EAAE,CAAC,EACR,MAAM,EAAE,CAAC,KACN,CAAC,CAAC;AAEP;;;;;;;GAOG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,GAAG,SAAS,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAEvG;;;;;;;;GAQG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC;AAE7C;;;;;;;;GAQG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC;AAMpE;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAC7D,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EACtB,YAAY,EAAE,CAAC,KACZ,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAEjB;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAC9D,WAAW,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,KAC5B,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAExB;;;;;;;GAOG;AACH,MAAM,WAAW,KAAK,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,SAAS,MAAM,GAAG,MAAM;IACvD;;;;;;;;;OASG;IACH,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;IAE5B;;;;;;OAMG;IACH,QAAQ,IAAI,CAAC,CAAC;IAEd;;;;;;;;;;OAUG;IACH,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAEtB;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,CAAC,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;IAErD;;;;;OAKG;IACH,OAAO,IAAI,IAAI,CAAC;CACjB;AAMD;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,QAAQ,EAAE,CAAC,GAAG,OAAO;IACtD;;;;;OAKG;IACH,QAAQ,EAAE,CAAC,CAAC;IAEZ;;;;OAIG;IACH,QAAQ,IAAI,CAAC,CAAC;CACf;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,WAAW,UAAU,CACzB,WAAW,GAAG,EAAE,EAChB,CAAC,GAAG,OAAO,EACX,CAAC,GAAG,QAAQ;IAEZ;;;;;;;;;OASG;IACH,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC1F;AAMD;;;;;;;;GAQG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5D;;;;;;;;OAQG;IACH,gBAAgB,IAAI,IAAI,CAAC;IAEzB;;;;;;;;OAQG;IACH,cAAc,IAAI,MAAM,CAAC;CAC1B;AAMD;;GAEG;AACH,wBAAgB,QAAQ,CAAE,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,MAAM,CAEjD;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,WAAW,GAAG,EAAE,EAAE,CAAC,GAAG,OAAO,EAAE,CAAC,SAAS,QAAQ,GAAG,QAAQ,EACvF,EAAE,EAAE,GAAG,GACN,EAAE,IAAI,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,CAAC,CAErC"}

package/build/store/types.js

@@ -0,0 +1,28 @@
+"use strict";
+/**
+ * Redux-RxJS Store Types
+ *
+ * Defines types for a Redux-like store with RxJS support.
+ * Maximum compatibility with Redux v4 API plus reactive extensions.
+ *
+ * @module Effectable/store/types
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isAction = isAction;
+exports.isMiddleware = isMiddleware;
+// ============================================================================
+// Type Guards
+// ============================================================================
+/**
+ * Type guard to check whether an object is an Action
+ */
+function isAction(obj) {
+    return typeof obj === 'object' && obj !== null && typeof obj.type === 'string';
+}
+/**
+ * Type guard to check whether a function is Middleware
+ */
+function isMiddleware(fn) {
+    return typeof fn === 'function';
+}
+//# sourceMappingURL=types.js.map

package/build/store/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/store/types.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;AA0SH,4BAEC;AAKD,oCAIC;AAlBD,+EAA+E;AAC/E,cAAc;AACd,+EAA+E;AAE/E;;GAEG;AACH,SAAgB,QAAQ,CAAE,GAAQ;IAChC,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC;AACjF,CAAC;AAED;;GAEG;AACH,SAAgB,YAAY,CAC1B,EAAO;IAEP,OAAO,OAAO,EAAE,KAAK,UAAU,CAAC;AAClC,CAAC"}

package/package.json

@@ -0,0 +1,109 @@
+{
+  "name": "effectable",
+  "version": "0.1.0",
+  "description": "Declarative reactive runtime for Node.js: bootstrap, Redux-style RxJS store, Component lifecycle, class-based connect, and GraphRuntime.",
+  "license": "MIT",
+  "author": {
+    "name": "Nick Nask",
+    "email": "spb.nikas@gmail.com",
+    "url": "https://github.com/iamnikas"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/iamnikas/effectable.git"
+  },
+  "bugs": {
+    "url": "https://github.com/iamnikas/effectable/issues"
+  },
+  "homepage": "https://github.com/iamnikas/effectable#readme",
+  "keywords": [
+    "effectable",
+    "typescript",
+    "nodejs",
+    "reactive",
+    "runtime",
+    "bootstrap",
+    "store",
+    "rxjs",
+    "redux",
+    "component",
+    "lifecycle",
+    "connect",
+    "graph-runtime",
+    "event-bus",
+    "command-bus"
+  ],
+  "type": "commonjs",
+  "main": "./build/index.js",
+  "types": "./build/index.d.ts",
+  "sideEffects": [
+    "./build/runtime/HandleRegistry.js",
+    "./build/runtime/BusDecorators.js"
+  ],
+  "files": [
+    "build",
+    "LICENSE",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "types": "./build/index.d.ts",
+      "default": "./build/index.js"
+    },
+    "./bootstrap": {
+      "types": "./build/bootstrap/index.d.ts",
+      "default": "./build/bootstrap/index.js"
+    },
+    "./store": {
+      "types": "./build/store/index.d.ts",
+      "default": "./build/store/index.js"
+    },
+    "./component": {
+      "types": "./build/component/index.d.ts",
+      "default": "./build/component/index.js"
+    },
+    "./component/*": {
+      "types": "./build/component/*.d.ts",
+      "default": "./build/component/*.js"
+    },
+    "./connect": {
+      "types": "./build/connect/index.d.ts",
+      "default": "./build/connect/index.js"
+    },
+    "./runtime": {
+      "types": "./build/runtime/index.d.ts",
+      "default": "./build/runtime/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "clean": "rm -rf ./build",
+    "build": "npm run clean && tsc --project ./tsconfig.build.json && npm run build:license",
+    "build:license": "cp ./LICENSE ./build/LICENSE",
+    "typecheck": "tsc --noEmit --project ./tsconfig.json",
+    "test": "jest --config ./jest.config.js --runInBand",
+    "test:watch": "jest --config ./jest.config.js --watch",
+    "test:spec": "jest --config ./jest.config.js --runInBand --testPathPatterns=spec",
+    "test:entity": "jest --config ./jest.config.js --runInBand --testPathPatterns=entity",
+    "bench": "jest --config ./jest.bench.config.js --runInBand",
+    "prepublishOnly": "npm run typecheck && npm test && npm run build"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18.18.0",
+    "npm": ">=9"
+  },
+  "dependencies": {
+    "reflect-metadata": "^0.2.2",
+    "rxjs": "^7.8.2"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.16.0",
+    "jest": "^30.1.3",
+    "ts-jest": "^29.4.9",
+    "typescript": "^6.0.3"
+  }
+}