xstate 6.0.0-alpha.5 → 6.0.0-alpha.50

package/README.md

@@ -11,10 +11,35 @@
   <br />
 </p>
 
-XState is a state management and orchestration solution for JavaScript and TypeScript apps. It has _zero_ dependencies, and is useful for frontend and backend application logic.
+<!-- runtime dependencies and public entry points from package.json -->
+
+XState is a state management and orchestration solution for JavaScript and TypeScript apps. The main `xstate` entry point has _zero_ runtime dependencies; the optional `xstate/scxml` entry point uses an XML parser. XState is useful for frontend and backend application logic.
 
 It uses event-driven programming, state machines, statecharts, and the actor model to handle complex logic in predictable, robust, and visual ways. XState provides a powerful and flexible way to manage application and workflow state by allowing developers to model logic as actors and state machines.
 
+For flat finite state machines, `xstate/fsm` provides a self-contained compact
+runtime and a specialized actor:
+
+<!-- public exports from packages/core/src/fsm/index.ts; exact capabilities documented in docs/fsm.md -->
+
+```ts
+import { createFSM, createFSMActor } from 'xstate/fsm';
+
+const logic = createFSM({
+  initial: 'inactive',
+  states: {
+    inactive: { on: { toggle: { target: 'active' } } },
+    active: { on: { toggle: { target: 'inactive' } } }
+  }
+});
+
+const actor = createFSMActor(logic).start();
+```
+
+See the [exact supported surface](https://stately.ai/docs/fsm). Use the root `xstate`
+entry point for compound or parallel statecharts, invocation, named sources,
+schemas, serialization and inspection.
+
 ### ✨ Create state machines visually in Stately Studio → [state.new](https://state.new)
 
 ---
@@ -27,6 +52,10 @@ It uses event-driven programming, state machines, statecharts, and the actor mod
 
 📑 Inspired by the [SCXML specification](https://www.w3.org/TR/scxml/)
 
+<!-- public SCXML entry point from src/scxml/index.ts -->
+
+Create machines from SCXML documents with the opt-in `xstate/scxml` entry point. See the [SCXML guide](../../docs/scxml.md).
+
 💬 Chat on the [Stately Discord Community](https://discord.gg/xstate)
 
 ✍️ Browse through the many [XState examples](https://github.com/statelyai/xstate/tree/main/examples)
@@ -119,7 +148,7 @@ npm install xstate
 ```
 
 ```ts
-import { createMachine, createActor, assign } from 'xstate';
+import { createMachine, createActor } from 'xstate';
 
 // State machine
 const toggleMachine = createMachine({
@@ -135,7 +164,9 @@ const toggleMachine = createMachine({
       }
     },
     active: {
-      entry: assign({ count: ({ context }) => context.count + 1 }),
+      entry: ({ context }) => ({
+        context: { count: context.count + 1 }
+      }),
       on: {
         TOGGLE: { target: 'inactive' }
       }
@@ -164,7 +195,7 @@ toggleActor.send({ type: 'TOGGLE' });
 - Deploy to Stately Sky
 - Generate & modify machines with Stately AI
 
-<a href="stately.ai/registry/new?ref=github" title="Stately Studio">
+<a href="https://stately.ai/registry/new?ref=github" title="Stately Studio">
   <img src="https://github.com/statelyai/xstate/assets/1093738/74ed9cbc-b824-4ed7-a16d-f104947af8a7" alt="XState Viz" width="800" />
 </a>
 

package/bin/xstate.js

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+// Lightweight `xstate` CLI. Heavy commands are delegated to dedicated
+// packages fetched on demand so the core package stays dependency-free.
+const { spawnSync } = require('child_process');
+
+const [command, ...rest] = process.argv.slice(2);
+
+switch (command) {
+  case 'migrate': {
+    // Delegates to @xstate/codemod (ts-morph based v5 → v6 codemods).
+    const result = spawnSync(
+      process.platform === 'win32' ? 'npx.cmd' : 'npx',
+      ['-y', '@xstate/codemod', 'migrate', ...rest],
+      { stdio: 'inherit' }
+    );
+    process.exit(result.status ?? 1);
+    break;
+  }
+  case '--help':
+  case 'help':
+  case undefined:
+    console.log(
+      [
+        'Usage: xstate <command>',
+        '',
+        'Commands:',
+        '  migrate [globs...] [--dry]   Migrate source files to the current XState version',
+        '                               (delegates to @xstate/codemod)'
+      ].join('\n')
+    );
+    process.exit(command ? 0 : 1);
+    break;
+  default:
+    console.error(`Unknown command: ${command}`);
+    process.exit(1);
+}