march-hare 0.6.0

package/dist/src/library/utils/index.d.ts

@@ -0,0 +1,42 @@
+import { Pk } from '../types/index.ts';
+/**
+ * Returns a promise that resolves after the specified number of milliseconds.
+ * The sleep will reject with an AbortError when the signal is aborted,
+ * allowing cleanup of pending operations.
+ *
+ * @param ms The number of milliseconds to sleep.
+ * @param signal AbortSignal to cancel the sleep early.
+ * @returns A promise that resolves after the delay or rejects if aborted.
+ */
+export declare function sleep(ms: number, signal: AbortSignal | undefined): Promise<void>;
+/** Shorthand alias for {@link sleep}. */
+export declare const ζ: typeof sleep;
+/**
+ * Repeatedly calls a function at a fixed interval until it returns `true` or
+ * the signal is aborted. The function is invoked immediately on the first
+ * iteration, then after each interval.
+ *
+ * @param ms The interval in milliseconds between invocations.
+ * @param signal Optional AbortSignal to cancel polling early.
+ * @param fn Callback invoked each iteration. Return `true` to stop polling.
+ * @returns A promise that resolves when `fn` returns `true`, or rejects with
+ *          an AbortError if the signal is aborted.
+ */
+export declare function poll(ms: number, signal: AbortSignal | undefined, fn: () => boolean | Promise<boolean>): Promise<void>;
+/** Shorthand alias for {@link poll}. */
+export declare const π: typeof poll;
+/**
+ * Generates a unique primary key.
+ * @returns A new unique symbol representing the primary key.
+ */
+export declare function pk(): symbol;
+/**
+ * Checks if the provided ID is a valid primary key.
+ * A valid primary key is considered any value that is not a symbol.
+ * @template T The type of the object.
+ * @param id The primary key to validate.
+ * @returns `true` if the ID is valid, `false` otherwise.
+ */
+export declare function pk<T>(id: Pk<T>): boolean;
+/** Shorthand alias for {@link pk}. */
+export declare const κ: typeof pk;

package/dist/src/library/utils/utils.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Returns a function to force a component re-render.
+ * Useful when state is managed externally (e.g., refs) but the UI needs updating.
+ */
+export declare function useRerender(): () => void;

package/dist/src/library/utils.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Internal symbol description factories. Each function returns a namespaced
+ * string suitable for `Symbol()` descriptions or `startsWith` checks.
+ *
+ * @internal
+ */
+export declare const describe: {
+    /** Unicast action description. `describe.action("Fetch")` → `"march-hare.action/Fetch"` */
+    action: (name?: string) => string;
+    /** Broadcast action description. `describe.broadcast("User")` → `"march-hare.action/broadcast/User"` */
+    broadcast: (name?: string) => string;
+    /** Multicast action description. `describe.multicast("Update")` → `"march-hare.action/multicast/Update"` */
+    multicast: (name?: string) => string;
+    /** Channeled action description. `describe.channel("user")` → `"march-hare.channel/user"` */
+    channel: (name?: string) => string;
+    /** Cache entry description. `describe.cache("users")` → `"march-hare.cache/users"` */
+    cache: (name?: string) => string;
+    /** Lifecycle action description. `describe.lifecycle("Mount")` → `"march-hare.action.lifecycle/Mount"` */
+    lifecycle: (name?: string) => string;
+    /** Mount replay sentinel description. Used to create the {@link replay} symbol. */
+    replay: (name?: string) => string;
+};
+/**
+ * Flat record used for shallow property comparison in {@link changes}.
+ * @internal
+ */
+type Changes = Record<string, unknown>;
+/**
+ * Get high-level changed paths between two objects.
+ * Returns an object containing only the properties that were added or updated.
+ *
+ * @param previous - The previous state object
+ * @param next - The next state object
+ * @returns Object with changed property keys and their new values
+ */
+export declare function changes(previous: Changes, next: Changes): Changes;
+export {};

package/package.json

@@ -0,0 +1,104 @@
+{
+  "name": "march-hare",
+  "version": "0.6.0",
+  "type": "module",
+  "license": "MIT",
+  "packageManager": "yarn@1.22.22",
+  "main": "./dist/march-hare.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/march-hare.js",
+      "require": "./dist/march-hare.umd.cjs"
+    }
+  },
+  "dependencies": {
+    "eventemitter3": "^5.0.4",
+    "immertation": "^0.1.26"
+  },
+  "peerDependencies": {
+    "@mobily/ts-belt": "^3.0.0",
+    "immer": "^10.0.0",
+    "react": "^18.0.0 || ^19.0.0"
+  },
+  "resolutions": {
+    "vitest/vite": "^7.3.1"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "vite build",
+    "build:example": "vite build --mode example --outDir dist-example --base /march-hare/",
+    "dev": "vite",
+    "preview": "vite preview",
+    "release": "make checks",
+    "prepare": "husky"
+  },
+  "devDependencies": {
+    "@babel/plugin-proposal-decorators": "^7.29.0",
+    "@babel/preset-env": "^7.29.0",
+    "@babel/preset-react": "^7.28.5",
+    "@babel/preset-typescript": "^7.28.5",
+    "@emotion/css": "^11.13.5",
+    "@eslint/js": "^9.39.3",
+    "@faker-js/faker": "^10.3.0",
+    "@jest/globals": "^30.2.0",
+    "@js-temporal/polyfill": "^0.5.1",
+    "@mobily/ts-belt": "4.0.0-rc.5",
+    "@playwright/test": "^1.58.2",
+    "@testing-library/dom": "^10.4.1",
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.3.2",
+    "@types/dom-navigation": "^1.0.7",
+    "@types/lodash": "^4.17.23",
+    "@types/ms": "^2.1.0",
+    "@types/ramda": "^0.31.1",
+    "@types/react": "^19.2.14",
+    "@types/react-dom": "^19.2.3",
+    "@types/traverse": "^0.6.37",
+    "@vitejs/plugin-react": "^5.1.4",
+    "antd": "^6.3.0",
+    "commit-and-tag-version": "^12.6.1",
+    "dayjs": "^1.11.19",
+    "dexie": "^4.3.0",
+    "eslint": "^9.39.3",
+    "eslint-plugin-fp": "^2.3.0",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-react": "^7.37.5",
+    "fslint": "^1.1.0",
+    "get-port-cli": "^3.0.0",
+    "globals": "^17.3.0",
+    "happy-dom": "^20.6.1",
+    "husky": "^9.1.7",
+    "immer": "^11.1.4",
+    "jest": "^30.2.0",
+    "jest-environment-jsdom": "^30.2.0",
+    "jsdom": "^28.1.0",
+    "ky": "^2.0.2",
+    "lodash": "^4.17.23",
+    "lucide-react": "^0.564.0",
+    "madge": "^8.0.0",
+    "ms": "2",
+    "prettier": "^3.8.1",
+    "ramda": "^0.32.0",
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4",
+    "react-flip-numbers": "^3.0.9",
+    "react-router-dom": "^7.13.0",
+    "react-test-renderer": "^19.2.4",
+    "react-wayfinder": "^0.1.3",
+    "rollup-plugin-visualizer": "^6.0.5",
+    "terser": "^5.46.0",
+    "traverse": "^0.6.11",
+    "ts-jest": "^29.4.6",
+    "ts-node": "^10.9.2",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.55.0",
+    "vite": "^7.3.1",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^4.0.18",
+    "wait-on": "^9.0.4"
+  }
+}