@rotorjs/dashboard 0.0.0

package/dist/DashboardAction.d.ts

@@ -0,0 +1,20 @@
+export type VarDashboardAction = {
+    type: 'var';
+    name: string;
+    value: unknown;
+    exposed?: boolean;
+};
+export type FactDashboardAction = {
+    type: 'fact';
+    name: string;
+    value: unknown;
+};
+export type NavigateDashboardAction = {
+    type: 'navigate';
+    href: string;
+    replace?: boolean;
+};
+export type DashboardAction = {
+    type: string;
+    [key: string]: unknown;
+};

package/dist/DashboardEngine.d.ts

@@ -0,0 +1,26 @@
+import { StateEngine } from '@rotorjs/state';
+import { DashboardAction } from './DashboardAction';
+import { DashboardEventTarget } from './DashboardEventTarget';
+import { DashboardFact } from './DashboardFact';
+import { DashboardState } from './DashboardState';
+import { DashboardStateDescriptor } from './DashboardStateDescriptor';
+import { DashboardStateReducer } from './DashboardStateReducer';
+import { DashboardStateReducerConfig } from './DashboardStateReducerConfig';
+import { DashboardVar } from './DashboardVar';
+export type DashboardStateReducerMap<Engine extends DashboardEngine = DashboardEngine> = {
+    [type: string]: DashboardStateReducerConfig<Engine>;
+};
+export declare class DashboardEngine extends StateEngine<DashboardStateDescriptor, DashboardState, DashboardAction> implements DashboardEventTarget {
+    #private;
+    constructor(reducerInit: DashboardStateReducerMap);
+    protected onAction(action: DashboardAction): void;
+    dispatchVar(name: string, value: unknown, exposed?: boolean): void;
+    dispatchFact(name: string, value: unknown): void;
+    hasVar(name: string): boolean;
+    getVar(name: string): DashboardVar | undefined;
+    hasFact(name: string): boolean;
+    getFact(name: string): DashboardFact | undefined;
+    protected getReducerConfig(descriptor: DashboardStateDescriptor): DashboardStateReducerConfig;
+    getReducerID(descriptor: DashboardStateDescriptor): string;
+    protected createReducer(descriptor: DashboardStateDescriptor): DashboardStateReducer<DashboardEngine>;
+}

package/dist/DashboardEventTarget.d.ts

@@ -0,0 +1,8 @@
+import { StateEventTarget } from '@rotorjs/state';
+import { DashboardAction } from './DashboardAction';
+import { DashboardState } from './DashboardState';
+import { DashboardStateDescriptor } from './DashboardStateDescriptor';
+export declare class DashboardEventTarget extends StateEventTarget<DashboardStateDescriptor, DashboardState, DashboardAction> {
+    dispatchVar(name: string, value: unknown, exposed?: boolean): void;
+    dispatchFact(name: string, value: unknown): void;
+}

package/dist/DashboardFact.d.ts

@@ -0,0 +1,3 @@
+export type DashboardFact = {
+    value: unknown;
+};

package/dist/DashboardState.d.ts

@@ -0,0 +1,2 @@
+import { DashboardNode } from './nodes';
+export type DashboardState = DashboardNode[];

package/dist/DashboardStateConsumer.d.ts

@@ -0,0 +1,7 @@
+import { StateConsumer } from '@rotorjs/state';
+import { DashboardAction } from './DashboardAction';
+import { DashboardState } from './DashboardState';
+import { DashboardStateDescriptor } from './DashboardStateDescriptor';
+export declare class DashboardStateConsumer extends StateConsumer<DashboardStateDescriptor, DashboardState, DashboardAction> {
+    protected compareStates(nextState: DashboardState, prevState: DashboardState): boolean;
+}

package/dist/DashboardStateDescriptor.d.ts

@@ -0,0 +1,4 @@
+export type DashboardStateDescriptor = {
+    type: string;
+    params?: unknown;
+};

package/dist/DashboardStateReducer.d.ts

@@ -0,0 +1,9 @@
+import { StateReducer } from '@rotorjs/state';
+import { DashboardAction } from './DashboardAction';
+import { DashboardEngine } from './DashboardEngine';
+import { DashboardState } from './DashboardState';
+import { DashboardStateDescriptor } from './DashboardStateDescriptor';
+export declare abstract class DashboardStateReducer<Engine extends DashboardEngine = DashboardEngine> extends StateReducer<DashboardStateDescriptor, DashboardState, DashboardAction, Engine> {
+    recover(_prevState: DashboardState, error: unknown): DashboardState;
+    protected compareStates(nextState: DashboardState, prevState: DashboardState): boolean;
+}

package/dist/DashboardStateReducerConfig.d.ts

@@ -0,0 +1,11 @@
+import { DashboardEngine } from './DashboardEngine';
+import { DashboardStateDescriptor } from './DashboardStateDescriptor';
+import { DashboardStateReducer } from './DashboardStateReducer';
+export type GetDashboardStateReducerIDFunction = (params: unknown | undefined) => string;
+export type CreateDashboardStateReducerFunction<Engine extends DashboardEngine = DashboardEngine> = {
+    bivarianceHack(engine: Engine, descriptor: DashboardStateDescriptor): DashboardStateReducer<Engine>;
+}['bivarianceHack'];
+export type DashboardStateReducerConfig<Engine extends DashboardEngine = DashboardEngine> = {
+    getReducerID: GetDashboardStateReducerIDFunction;
+    createReducer: CreateDashboardStateReducerFunction<Engine>;
+};

package/dist/DashboardVar.d.ts

@@ -0,0 +1,4 @@
+export type DashboardVar = {
+    value: unknown;
+    exposed: boolean;
+};

package/dist/interests.d.ts

@@ -0,0 +1,2 @@
+export declare function dashboardVarInterest(name: string): string;
+export declare function dashboardFactInterest(name: string): string;

package/dist/main.d.ts

@@ -0,0 +1,12 @@
+export * from './DashboardAction';
+export * from './DashboardEngine';
+export * from './DashboardEventTarget';
+export * from './DashboardFact';
+export * from './DashboardState';
+export * from './DashboardStateConsumer';
+export * from './DashboardStateDescriptor';
+export * from './DashboardStateReducer';
+export * from './DashboardStateReducerConfig';
+export * from './DashboardVar';
+export * from './interests';
+export * from './nodes';

package/dist/main.js

@@ -0,0 +1,105 @@
+import { StateConsumer as e, StateEngine as t, StateEventTarget as n, StateReducer as r } from "@rotorjs/state";
+import i from "fast-deep-equal";
+import { v7 as a } from "uuid";
+//#region lib/interests.ts
+function o(e) {
+	return `dashboard://var/${encodeURIComponent(e)}`;
+}
+function s(e) {
+	return `dashboard://fact/${encodeURIComponent(e)}`;
+}
+//#endregion
+//#region lib/DashboardEngine.ts
+var c = class extends t {
+	#e;
+	#t = {};
+	#n = {};
+	constructor(e) {
+		super(), this.#e = e;
+	}
+	onAction(e) {
+		super.onAction(e);
+		let t = e;
+		switch (t.type) {
+			case "var":
+				this.#t[t.name] = {
+					value: t.value,
+					exposed: t.exposed ?? !1
+				}, this.dispatchInterest(o(t.name));
+				return;
+			case "fact":
+				this.#n[t.name] = { value: t.value }, this.dispatchInterest(s(t.name));
+				return;
+		}
+	}
+	dispatchVar(e, t, n) {
+		this.dispatchAction({
+			type: "var",
+			name: e,
+			value: t,
+			exposed: n
+		});
+	}
+	dispatchFact(e, t) {
+		this.dispatchAction({
+			type: "fact",
+			name: e,
+			value: t
+		});
+	}
+	hasVar(e) {
+		return Object.hasOwn(this.#t, e);
+	}
+	getVar(e) {
+		return this.#t[e];
+	}
+	hasFact(e) {
+		return Object.hasOwn(this.#n, e);
+	}
+	getFact(e) {
+		return this.#n[e];
+	}
+	getReducerConfig(e) {
+		if (!Object.hasOwn(this.#e, e.type)) throw Error(`Unknown reducer type "${e.type}"`);
+		return this.#e[e.type];
+	}
+	getReducerID(e) {
+		return `${encodeURIComponent(e.type)}:${encodeURIComponent(this.getReducerConfig(e).getReducerID(e.params))}`;
+	}
+	createReducer(e) {
+		return this.getReducerConfig(e).createReducer(this, e);
+	}
+}, l = class extends n {
+	dispatchVar(e, t, n) {
+		this.dispatchAction({
+			type: "var",
+			name: e,
+			value: t,
+			exposed: n
+		});
+	}
+	dispatchFact(e, t) {
+		this.dispatchAction({
+			type: "fact",
+			name: e,
+			value: t
+		});
+	}
+}, u = class extends e {
+	compareStates(e, t) {
+		return i(e, t);
+	}
+}, d = class extends r {
+	recover(e, t) {
+		return [{
+			type: "error",
+			id: a(),
+			error: t
+		}];
+	}
+	compareStates(e, t) {
+		return i(e, t);
+	}
+};
+//#endregion
+export { c as DashboardEngine, l as DashboardEventTarget, u as DashboardStateConsumer, d as DashboardStateReducer, s as dashboardFactInterest, o as dashboardVarInterest };

package/dist/nodes.d.ts

@@ -0,0 +1,19 @@
+export type DashboardNode = {
+    type: string;
+    id?: string;
+    [key: string]: unknown;
+};
+export type ErrorDashboardNode = {
+    type: 'error';
+    id?: string;
+    error: unknown;
+};
+export type DashboardLayoutNode = DashboardNode;
+export type ErrorDashboardLayoutNode = ErrorDashboardNode;
+export type DashboardLayoutConfig = unknown;
+export type DashboardTileNode = DashboardNode & {
+    layout?: DashboardLayoutConfig;
+};
+export type ErrorDashboardTileNode = ErrorDashboardNode & {
+    layout?: DashboardLayoutConfig;
+};

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@rotorjs/dashboard",
+  "version": "0.0.0",
+  "description": "Rotor",
+  "author": {
+    "name": "Aaron Burmeister"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rotorjs/dashboard.git"
+  },
+  "bugs": {
+    "url": "https://github.com/rotorjs/dashboard/issues"
+  },
+  "homepage": "https://github.com/rotorjs/",
+  "type": "module",
+  "keywords": [
+    "state",
+    "dashboards"
+  ],
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/main.js",
+  "types": "./dist/main.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/main.d.ts",
+        "default": "./dist/main.js"
+      }
+    }
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc -b ./tsconfig-build.json && vite build",
+    "lint": "eslint . --max-warnings 0",
+    "lint:fix": "npm run lint -- --fix",
+    "prettify": "prettier . --write",
+    "preview": "vite preview",
+    "postversion": "git commit -am$npm_package_version",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@types/react": "^19.1.12",
+    "@types/react-dom": "^19.1.9",
+    "@vitejs/plugin-react": "^6.0.2",
+    "eslint": "^10.4.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-import-x": "^4.16.2",
+    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-react-hooks": "^7.1.1",
+    "eslint-plugin-react-refresh": "^0.5.2",
+    "globals": "^17.6.0",
+    "prettier": "^3.8.3",
+    "react": "^19.2.6",
+    "react-dom": "^19.2.6",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.59.4",
+    "unplugin-dts": "^1.0.1",
+    "vite": "^8.0.13"
+  },
+  "dependencies": {
+    "@rotorjs/state": "^0.2.0",
+    "fast-deep-equal": "^3.1.3",
+    "uuid": "^14.0.0"
+  }
+}