@coexist/devtools 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Coaction
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,68 @@
+# @coexist/devtools
+
+> Timeline inspection plugin for [Coexist](../../README.md): records a chronological log of app setup, module creation, actions, patches, state changes, and errors for development tooling.
+
+This is a headless data source — it records events and lets you subscribe to or read the timeline. Build your own UI on top, or pipe it into logging.
+
+## Installation
+
+```sh
+pnpm add -D @coexist/devtools
+```
+
+## Quick start
+
+```ts
+import { createApp } from "@coexist/core";
+import { createDevtoolsPlugin } from "@coexist/devtools";
+
+const devtools = createDevtoolsPlugin();
+
+const app = createApp({
+  plugins: [devtools],
+  providers: [Counter],
+});
+
+const unsubscribe = devtools.subscribe((event) => {
+  console.log(event.type, event.time);
+});
+
+console.log(devtools.getTimeline());
+unsubscribe();
+```
+
+## Options
+
+| Option      | Type           | Default    | Description                                            |
+| ----------- | -------------- | ---------- | ------------------------------------------------------ |
+| `maxEvents` | `number`       | `1000`     | Ring-buffer size; oldest events are dropped past this. |
+| `now`       | `() => number` | `Date.now` | Clock used for the `time` stamp on every event.        |
+
+## Timeline events
+
+Each entry is a `DevtoolsTimelineEvent` with a `type` and a `time`:
+
+| `type`                            | Payload                         |
+| --------------------------------- | ------------------------------- |
+| `"setup"`                         | `{ app }`                       |
+| `"module"`                        | `{ event: ModuleCreatedEvent }` |
+| `"action:start"` / `"action:end"` | `{ event: ActionEvent }`        |
+| `"patch"`                         | `{ event: PatchEvent }`         |
+| `"state"`                         | `{ event: StateChangeEvent }`   |
+| `"error"`                         | `{ error, context }`            |
+
+## Plugin methods
+
+```ts
+devtools.getTimeline(); // readonly snapshot of recorded events
+devtools.subscribe(listener); // → unsubscribe; fires on each new event
+devtools.clearTimeline(); // reset the buffer
+```
+
+## Exports
+
+`createDevtoolsPlugin`, and the `DevtoolsPlugin`, `DevtoolsOptions`, `DevtoolsTimelineEvent`, `DevtoolsTimelineListener` types.
+
+## License
+
+[MIT](../../LICENSE) © Coaction

package/dist/index.d.ts

@@ -0,0 +1,43 @@
+import { ActionEvent, App, ErrorContext, ModuleCreatedEvent, PatchEvent, Plugin, StateChangeEvent } from "@coexist/core";
+
+//#region src/index.d.ts
+type DevtoolsTimelineEvent = {
+  readonly type: "setup";
+  readonly app: App;
+  readonly time: number;
+} | {
+  readonly type: "action:start" | "action:end";
+  readonly event: ActionEvent;
+  readonly time: number;
+} | {
+  readonly type: "module";
+  readonly event: ModuleCreatedEvent;
+  readonly time: number;
+} | {
+  readonly type: "patch";
+  readonly event: PatchEvent;
+  readonly time: number;
+} | {
+  readonly type: "state";
+  readonly event: StateChangeEvent;
+  readonly time: number;
+} | {
+  readonly type: "error";
+  readonly error: unknown;
+  readonly context: ErrorContext;
+  readonly time: number;
+};
+interface DevtoolsPlugin extends Plugin {
+  getTimeline(): readonly DevtoolsTimelineEvent[];
+  subscribe(listener: DevtoolsTimelineListener): () => void;
+  clearTimeline(): void;
+}
+type DevtoolsTimelineListener = (event: DevtoolsTimelineEvent) => void;
+interface DevtoolsOptions {
+  readonly maxEvents?: number;
+  readonly now?: () => number;
+}
+declare function createDevtoolsPlugin(options?: DevtoolsOptions): DevtoolsPlugin;
+//#endregion
+export { DevtoolsOptions, DevtoolsPlugin, DevtoolsTimelineEvent, DevtoolsTimelineListener, createDevtoolsPlugin };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";;;KAUY,qBAAA;EAAA,SAEG,IAAA;EAAA,SACA,GAAA,EAAK,GAAA;EAAA,SACL,IAAA;AAAA;EAAA,SAGA,IAAA;EAAA,SACA,KAAA,EAAO,WAAA;EAAA,SACP,IAAA;AAAA;EAAA,SAGA,IAAA;EAAA,SACA,KAAA,EAAO,kBAAA;EAAA,SACP,IAAA;AAAA;EAAA,SAGA,IAAA;EAAA,SACA,KAAA,EAAO,UAAA;EAAA,SACP,IAAA;AAAA;EAAA,SAGA,IAAA;EAAA,SACA,KAAA,EAAO,gBAAA;EAAA,SACP,IAAA;AAAA;EAAA,SAGA,IAAA;EAAA,SACA,KAAA;EAAA,SACA,OAAA,EAAS,YAAA;EAAA,SACT,IAAA;AAAA;AAAA,UAGE,cAAA,SAAuB,MAAA;EACtC,WAAA,aAAwB,qBAAA;EACxB,SAAA,CAAU,QAAA,EAAU,wBAAA;EACpB,aAAA;AAAA;AAAA,KAGU,wBAAA,IAA4B,KAAO,EAAA,qBAAA;AAAA,UAE9B,eAAA;EAAA,SACN,SAAA;EAAA,SACA,GAAA;AAAA;AAAA,iBAGK,oBAAA,CAAqB,OAAA,GAAS,eAAA,GAAuB,cAAA"}

package/dist/index.js

@@ -0,0 +1,87 @@
+//#region src/index.ts
+function createDevtoolsPlugin(options = {}) {
+	const timeline = [];
+	const listeners = /* @__PURE__ */ new Set();
+	const maxEvents = options.maxEvents ?? 1e3;
+	const now = options.now ?? Date.now;
+	const push = (event) => {
+		timeline.push(event);
+		if (timeline.length > maxEvents) timeline.splice(0, timeline.length - maxEvents);
+		for (const listener of listeners) try {
+			const result = listener(event);
+			if (isPromiseLike(result)) Promise.resolve(result).catch(() => void 0);
+		} catch {}
+	};
+	return {
+		name: "coexist:devtools",
+		clearTimeline() {
+			timeline.length = 0;
+		},
+		getTimeline() {
+			return [...timeline];
+		},
+		subscribe(listener) {
+			listeners.add(listener);
+			return () => {
+				listeners.delete(listener);
+			};
+		},
+		onActionEnd(event) {
+			push({
+				event,
+				time: now(),
+				type: "action:end"
+			});
+		},
+		onActionStart(event) {
+			push({
+				event,
+				time: now(),
+				type: "action:start"
+			});
+		},
+		onError(error, context) {
+			push({
+				context,
+				error,
+				time: now(),
+				type: "error"
+			});
+		},
+		onModuleCreated(event) {
+			push({
+				event,
+				time: now(),
+				type: "module"
+			});
+		},
+		onPatch(event) {
+			push({
+				event,
+				time: now(),
+				type: "patch"
+			});
+		},
+		onStateChange(event) {
+			push({
+				event,
+				time: now(),
+				type: "state"
+			});
+		},
+		setup(app) {
+			push({
+				app,
+				time: now(),
+				type: "setup"
+			});
+		}
+	};
+}
+function isPromiseLike(value) {
+	return (typeof value === "object" || typeof value === "function") && value !== null && "then" in value && typeof value.then === "function";
+}
+//#endregion
+export { createDevtoolsPlugin };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type {\n  ActionEvent,\n  App,\n  ErrorContext,\n  ModuleCreatedEvent,\n  PatchEvent,\n  Plugin,\n  StateChangeEvent,\n} from \"@coexist/core\";\n\nexport type DevtoolsTimelineEvent =\n  | {\n      readonly type: \"setup\";\n      readonly app: App;\n      readonly time: number;\n    }\n  | {\n      readonly type: \"action:start\" | \"action:end\";\n      readonly event: ActionEvent;\n      readonly time: number;\n    }\n  | {\n      readonly type: \"module\";\n      readonly event: ModuleCreatedEvent;\n      readonly time: number;\n    }\n  | {\n      readonly type: \"patch\";\n      readonly event: PatchEvent;\n      readonly time: number;\n    }\n  | {\n      readonly type: \"state\";\n      readonly event: StateChangeEvent;\n      readonly time: number;\n    }\n  | {\n      readonly type: \"error\";\n      readonly error: unknown;\n      readonly context: ErrorContext;\n      readonly time: number;\n    };\n\nexport interface DevtoolsPlugin extends Plugin {\n  getTimeline(): readonly DevtoolsTimelineEvent[];\n  subscribe(listener: DevtoolsTimelineListener): () => void;\n  clearTimeline(): void;\n}\n\nexport type DevtoolsTimelineListener = (event: DevtoolsTimelineEvent) => void;\n\nexport interface DevtoolsOptions {\n  readonly maxEvents?: number;\n  readonly now?: () => number;\n}\n\nexport function createDevtoolsPlugin(options: DevtoolsOptions = {}): DevtoolsPlugin {\n  const timeline: DevtoolsTimelineEvent[] = [];\n  const listeners = new Set<DevtoolsTimelineListener>();\n  const maxEvents = options.maxEvents ?? 1_000;\n  const now = options.now ?? Date.now;\n\n  const push = (event: DevtoolsTimelineEvent): void => {\n    timeline.push(event);\n\n    if (timeline.length > maxEvents) {\n      timeline.splice(0, timeline.length - maxEvents);\n    }\n\n    for (const listener of listeners) {\n      try {\n        const result = (listener as (event: DevtoolsTimelineEvent) => unknown)(event);\n\n        if (isPromiseLike(result)) {\n          void Promise.resolve(result).catch(() => undefined);\n        }\n      } catch {\n        // Timeline observers must not interrupt app hooks or later subscribers.\n      }\n    }\n  };\n\n  return {\n    name: \"coexist:devtools\",\n    clearTimeline() {\n      timeline.length = 0;\n    },\n    getTimeline() {\n      return [...timeline];\n    },\n    subscribe(listener) {\n      listeners.add(listener);\n\n      return () => {\n        listeners.delete(listener);\n      };\n    },\n    onActionEnd(event) {\n      push({\n        event,\n        time: now(),\n        type: \"action:end\",\n      });\n    },\n    onActionStart(event) {\n      push({\n        event,\n        time: now(),\n        type: \"action:start\",\n      });\n    },\n    onError(error, context) {\n      push({\n        context,\n        error,\n        time: now(),\n        type: \"error\",\n      });\n    },\n    onModuleCreated(event) {\n      push({\n        event,\n        time: now(),\n        type: \"module\",\n      });\n    },\n    onPatch(event) {\n      push({\n        event,\n        time: now(),\n        type: \"patch\",\n      });\n    },\n    onStateChange(event) {\n      push({\n        event,\n        time: now(),\n        type: \"state\",\n      });\n    },\n    setup(app) {\n      push({\n        app,\n        time: now(),\n        type: \"setup\",\n      });\n    },\n  };\n}\n\nfunction isPromiseLike(value: unknown): value is PromiseLike<unknown> {\n  return (\n    (typeof value === \"object\" || typeof value === \"function\") &&\n    value !== null &&\n    \"then\" in value &&\n    typeof value.then === \"function\"\n  );\n}\n"],"mappings":";AAwDA,SAAgB,qBAAqB,UAA2B,CAAC,GAAmB;CAClF,MAAM,WAAoC,CAAC;CAC3C,MAAM,4BAAY,IAAI,IAA8B;CACpD,MAAM,YAAY,QAAQ,aAAa;CACvC,MAAM,MAAM,QAAQ,OAAO,KAAK;CAEhC,MAAM,QAAQ,UAAuC;EACnD,SAAS,KAAK,KAAK;EAEnB,IAAI,SAAS,SAAS,WACpB,SAAS,OAAO,GAAG,SAAS,SAAS,SAAS;EAGhD,KAAK,MAAM,YAAY,WACrB,IAAI;GACF,MAAM,SAAU,SAAuD,KAAK;GAE5E,IAAI,cAAc,MAAM,GACtB,QAAa,QAAQ,MAAM,CAAC,CAAC,YAAY,KAAA,CAAS;EAEtD,QAAQ,CAER;CAEJ;CAEA,OAAO;EACL,MAAM;EACN,gBAAgB;GACd,SAAS,SAAS;EACpB;EACA,cAAc;GACZ,OAAO,CAAC,GAAG,QAAQ;EACrB;EACA,UAAU,UAAU;GAClB,UAAU,IAAI,QAAQ;GAEtB,aAAa;IACX,UAAU,OAAO,QAAQ;GAC3B;EACF;EACA,YAAY,OAAO;GACjB,KAAK;IACH;IACA,MAAM,IAAI;IACV,MAAM;GACR,CAAC;EACH;EACA,cAAc,OAAO;GACnB,KAAK;IACH;IACA,MAAM,IAAI;IACV,MAAM;GACR,CAAC;EACH;EACA,QAAQ,OAAO,SAAS;GACtB,KAAK;IACH;IACA;IACA,MAAM,IAAI;IACV,MAAM;GACR,CAAC;EACH;EACA,gBAAgB,OAAO;GACrB,KAAK;IACH;IACA,MAAM,IAAI;IACV,MAAM;GACR,CAAC;EACH;EACA,QAAQ,OAAO;GACb,KAAK;IACH;IACA,MAAM,IAAI;IACV,MAAM;GACR,CAAC;EACH;EACA,cAAc,OAAO;GACnB,KAAK;IACH;IACA,MAAM,IAAI;IACV,MAAM;GACR,CAAC;EACH;EACA,MAAM,KAAK;GACT,KAAK;IACH;IACA,MAAM,IAAI;IACV,MAAM;GACR,CAAC;EACH;CACF;AACF;AAEA,SAAS,cAAc,OAA+C;CACpE,QACG,OAAO,UAAU,YAAY,OAAO,UAAU,eAC/C,UAAU,QACV,UAAU,SACV,OAAO,MAAM,SAAS;AAE1B"}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@coexist/devtools",
+  "version": "0.2.0",
+  "description": "Dev inspection plugin for Coexist.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/coactionjs/coexist.git",
+    "directory": "packages/devtools"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@coexist/core": "0.2.0"
+  },
+  "devDependencies": {
+    "tsdown": "0.22.3",
+    "typescript": "6.0.3",
+    "vitest": "4.1.9",
+    "@coexist/tsconfig": "0.1.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "clean": "rm -rf coverage dist .turbo",
+    "dev": "tsdown --watch",
+    "test": "cd ../.. && vitest run --project @coexist/devtools",
+    "test:coverage": "cd ../.. && vitest run --coverage --project @coexist/devtools",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
+}