@vielzeug/clockwork 2.1.0 → 2.2.0

package/README.md

@@ -51,7 +51,6 @@ actor.dispose();
 | `machine.createActor(options?)` | Create an owned runtime actor |
 | `Actor` | Runtime resource with a readonly snapshot, subscriptions, and disposal |
 | `ClockworkError` | Validation error with stable `code` |
-| `debugActor(actor, options?)` | Observe committed actor snapshots from `/devtools` |
 
 ## Async invokes and timers
 
@@ -84,23 +83,22 @@ const loader = defineMachine<{ data: string }, Event>()({
 });
 ```
 
-## Devtools
+## Observability
 
-`debugActor(actor, options?)` observes committed snapshots with `console.debug`. It does not modify actor behavior or trace dispatches and runtime errors.
+`actor.subscribe(listener)` observes committed snapshots. It does not modify actor behavior or trace dispatches and runtime errors.
 
 ```ts
 import { defineMachine } from '@vielzeug/clockwork';
-import { debugActor } from '@vielzeug/clockwork/devtools';
 
 const machine = defineMachine<Record<string, never>, { type: 'NEXT' }>()({
   initial: 'idle',
   states: { idle: { on: { NEXT: { target: 'idle' } } } },
 });
 const actor = machine.createActor();
-const stopDebugging = debugActor(actor);
+const stop = actor.subscribe((snapshot) => console.debug(snapshot.state));
 
 actor.send({ type: 'NEXT' });
-stopDebugging();
+stop();
 actor.dispose();
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vielzeug/clockwork",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Framework-neutral typed finite state machines with pure transitions and actors",
   "repository": {
     "type": "git",
@@ -22,20 +22,9 @@
       "import": "./dist/index.js",
       "require": "./dist/index.cjs",
       "types": "./dist/index.d.ts"
-    },
-    "./devtools": {
-      "import": "./dist/devtools.js",
-      "require": "./dist/devtools.cjs",
-      "types": "./dist/devtools.d.ts"
-    }
-  },
-  "typesVersions": {
-    "*": {
-      "devtools": [
-        "dist/devtools.d.ts"
-      ]
     }
   },
+  "sideEffects": false,
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"

package/dist/devtools.cjs

@@ -1,2 +0,0 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});var e=(e,t={})=>{let n=t.logger??(e=>console.debug(`[clockwork] snapshot`,e));return e.subscribe(e=>{try{n(e)}catch{}})};exports.debugActor=e;
-//# sourceMappingURL=devtools.cjs.map

package/dist/devtools.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"devtools.cjs","names":[],"sources":["../src/devtools.ts"],"sourcesContent":["import type { Actor, MachineEvent, MachineSnapshot } from './types.js';\n\nexport type DebugActorOptions<State extends string, Context extends Record<string, unknown>> = {\n  readonly logger?: (snapshot: MachineSnapshot<State, Context>) => void;\n};\n\n/**\n * Observes committed actor snapshots with `console.debug` without changing actor behavior.\n * Import from `@vielzeug/clockwork/devtools` so this development-only observability stays opt-in.\n */\nexport const debugActor = <State extends string, Context extends Record<string, unknown>, Event extends MachineEvent>(\n  actor: Actor<State, Context, Event>,\n  options: DebugActorOptions<State, Context> = {},\n): (() => void) => {\n  const logger =\n    options.logger ?? ((snapshot: MachineSnapshot<State, Context>) => console.debug('[clockwork] snapshot', snapshot));\n\n  return actor.subscribe((snapshot) => {\n    try {\n      logger(snapshot);\n    } catch {\n      // Observability must not affect the actor's error policy.\n    }\n  });\n};\n"],"mappings":"mEAUA,IAAa,GACX,EACA,EAA6C,CAAC,IAC7B,CACjB,IAAM,EACJ,EAAQ,SAAY,GAA8C,QAAQ,MAAM,uBAAwB,CAAQ,GAElH,OAAO,EAAM,UAAW,GAAa,CACnC,GAAI,CACF,EAAO,CAAQ,CACjB,MAAQ,CAER,CACF,CAAC,CACH"}

package/dist/devtools.d.ts

@@ -1,10 +0,0 @@
-import type { Actor, MachineEvent, MachineSnapshot } from './types.js';
-export type DebugActorOptions<State extends string, Context extends Record<string, unknown>> = {
-    readonly logger?: (snapshot: MachineSnapshot<State, Context>) => void;
-};
-/**
- * Observes committed actor snapshots with `console.debug` without changing actor behavior.
- * Import from `@vielzeug/clockwork/devtools` so this development-only observability stays opt-in.
- */
-export declare const debugActor: <State extends string, Context extends Record<string, unknown>, Event extends MachineEvent>(actor: Actor<State, Context, Event>, options?: DebugActorOptions<State, Context>) => (() => void);
-//# sourceMappingURL=devtools.d.ts.map

package/dist/devtools.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"devtools.d.ts","sourceRoot":"","sources":["../src/devtools.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAEvE,MAAM,MAAM,iBAAiB,CAAC,KAAK,SAAS,MAAM,EAAE,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IAC7F,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;CACvE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,UAAU,GAAI,KAAK,SAAS,MAAM,EAAE,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,SAAS,YAAY,EAClH,OAAO,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,EACnC,UAAS,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAM,KAC9C,CAAC,MAAM,IAAI,CAWb,CAAC"}

package/dist/devtools.js

@@ -1,13 +0,0 @@
-//#region src/devtools.ts
-var e = (e, t = {}) => {
-	let n = t.logger ?? ((e) => console.debug("[clockwork] snapshot", e));
-	return e.subscribe((e) => {
-		try {
-			n(e);
-		} catch {}
-	});
-};
-//#endregion
-export { e as debugActor };
-
-//# sourceMappingURL=devtools.js.map

package/dist/devtools.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"devtools.js","names":[],"sources":["../src/devtools.ts"],"sourcesContent":["import type { Actor, MachineEvent, MachineSnapshot } from './types.js';\n\nexport type DebugActorOptions<State extends string, Context extends Record<string, unknown>> = {\n  readonly logger?: (snapshot: MachineSnapshot<State, Context>) => void;\n};\n\n/**\n * Observes committed actor snapshots with `console.debug` without changing actor behavior.\n * Import from `@vielzeug/clockwork/devtools` so this development-only observability stays opt-in.\n */\nexport const debugActor = <State extends string, Context extends Record<string, unknown>, Event extends MachineEvent>(\n  actor: Actor<State, Context, Event>,\n  options: DebugActorOptions<State, Context> = {},\n): (() => void) => {\n  const logger =\n    options.logger ?? ((snapshot: MachineSnapshot<State, Context>) => console.debug('[clockwork] snapshot', snapshot));\n\n  return actor.subscribe((snapshot) => {\n    try {\n      logger(snapshot);\n    } catch {\n      // Observability must not affect the actor's error policy.\n    }\n  });\n};\n"],"mappings":";AAUA,IAAa,KACX,GACA,IAA6C,CAAC,MAC7B;CACjB,IAAM,IACJ,EAAQ,YAAY,MAA8C,QAAQ,MAAM,wBAAwB,CAAQ;CAElH,OAAO,EAAM,WAAW,MAAa;EACnC,IAAI;GACF,EAAO,CAAQ;EACjB,QAAQ,CAER;CACF,CAAC;AACH"}