Gathering detailed insights and metrics for @xstate/inspect
Gathering detailed insights and metrics for @xstate/inspect
Actor-based state management & orchestration for complex app logic.
Installations
npm install @xstate/inspectDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
16.19.1
NPM Version
8.19.3
Score
98.5
Supply Chain
99.6
Quality
80
Maintenance
100
Vulnerability
100
License
Releases
433
@xstate/store@3.8.0
@xstate/store@3.8.0
Updated on Jun 29, 2025
@xstate/store@3.7.1
@xstate/store@3.7.1
Updated on Jun 26, 2025
@xstate/store@3.7.0
@xstate/store@3.7.0
Updated on Jun 21, 2025
@xstate/react@6.0.0
@xstate/react@6.0.0
Updated on Jun 19, 2025
@xstate/vue@5.0.0
@xstate/vue@5.0.0
Updated on Jun 19, 2025
@xstate/svelte@5.0.0
@xstate/svelte@5.0.0
Updated on Jun 19, 2025
Languages
6
TypeScript
Vue
JavaScript
Svelte
CSS
HTML
TypeScript (97.98%)
Vue (0.78%)
JavaScript (0.48%)
Svelte (0.42%)
CSS (0.26%)
HTML (0.08%)
Developer
Download Statistics
Total Downloads
21,104,050
Last Day
3,817
Last Week
149,806
Last Month
650,321
Last Year
6,380,923
GitHub Statistics
MIT License
28,421 Stars
6,806 Commits
1,315 Forks
191 Watchers
296 Branches
346 Contributors
Updated on Jul 04, 2025
Bundle Size
9.64 kB
Minified
3.33 kB
Minified + Gzipped
Maintainers
3
Package Meta Information
Latest Version
0.8.0
Package Id
@xstate/inspect@0.8.0
Unpacked Size
70.56 kB
Size
13.32 kB
File Count
30
NPM Version
8.19.3
Node Version
16.19.1
Published on
Mar 02, 2023
Total Downloads
Cumulative downloads
Total Downloads
21,104,050
Dependencies
1
@xstate/inspect
This package contains inspection tools for XState.
Templates
Check out the XState + Vue Minute Timer + Viz example on CodeSandbox
Installation
- Install with npm or yarn:
1npm install @xstate/inspect 2# or yarn add @xstate/inspect
Via CDN
1<script src="https://unpkg.com/@xstate/inspect/dist/xstate-inspect.umd.min.js"></script>
By using the global variable XStateInspect
- Import it at the beginning of your project, before any other code is called:
1import { inspect } from '@xstate/inspect'; 2 3inspect({ 4 // options 5 // url: 'https://stately.ai/viz?inspect', // (default) 6 iframe: false // open in new window 7});
- Add
{ devTools: true }to any interpreted machines you want to visualize:
1import { interpret } from 'xstate'; 2import { inspect } from '@xstate/inspect'; 3// ... 4 5const service = interpret(someMachine, { devTools: true }); 6service.start();
Configuration
url(optional) - The endpoint that the Inspector sends events to. Default: https://stately.ai/viz?inspectiframe(optional) - The iframe that loads the provided URL. If iframe is set tofalse, then a new tab is opened instead.devTools(optional) - Allows custom implementation for lifecycle hooks.serialize(optional) - A custom serializer for messages sent to the URL endpoint. Useful for sanitizing sensitive information, such as credentials, from leaving your application.targetWindow(optional) - Provide a pre-existing window location that will be used instead of opening a new window etc. When using this option, you must still provide theurlvalue due to security checks in browser APIs, and theiframeoption is ignored in such a case.
Examples
Add a custom serializer to @xstate/inspector events and transitions messages
When is this useful?
- Remove sensitive items, such as
credentials - Add additional custom handling
1// Remove credentials from being forwarded 2inspect({ 3 serialize: (key: string, value: any) => { 4 return key === "credentials" && typeof value === "object" ? {} : value; 5 }, 6}); 7 8// Add a custom local log 9inspect({ 10 serialize: (key: string, value: any) => { 11 if (key === "ready") { 12 console.log("Detected ready key"); 13 } 14 return value; 15 }, 16});
Easily log all machine events and transitions
When is this useful?
- Allows you to quickly see all events and transitions for your machines
- No need to add manual
console.logstatements to your machine definitions
1// The URL and port of your local project (ex. Vite, Webpack, etc). 2const url = "http://127.0.0.1:5174/" 3 4const inspector = inspect({ 5 url, 6 iframe: undefined, 7 targetWindow: window 8}); 9 10// In the same window, subsribe to messages from @xstate/inspector 11createWindowReceiver({}).subscribe(console.log); 12 13// Start your machine, and all events generated are logged to the console 14interpret(machine, { devTools: true }).start({}); 15
Send events to a separate, locally hosted tool
When is this useful?
- Forward messages to a custom endpoint, that you can then listen to and add custom handling for messages
1// In your client application 2const url = "http://127.0.0.1:8443/" 3const targetWindow = window.open(url); 4 5const inspector = inspect({ 6 // The URL must still be provided. This is used by postMessage, as it's 7 // not possible to do targetWindow.location for security reasons 8 url, 9 targetWindow 10}); 11 12 13// In the second, hosted application 14createWindowReceiver({}).subscribe((event) => { 15 if (event.type === "service.register") { 16 // Do something when a new machine is started 17 18 } else if (event.type === "service.stop") { 19 // Do something when a machine enters a terminal state 20 21 } else if (event.type === "service.event") { 22 // Do something when a machine recieves an event 23 24 } else if (event.type === "service.state") { 25 // Do something when a machine enters to a new state 26 // Note: Does not handle transitional states. 27 } 28});
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
30 commit(s) and 9 issue activity found in the last 90 days -- score normalized to 10
Reason
GitHub workflow tokens follow principle of least privilege
Details
- Warn: jobLevel 'contents' permission set to 'write': .github/workflows/release.yml:16
- Info: topLevel 'contents' permission set to 'read': .github/workflows/nodejs.yml:13
- Info: found token with 'none' permissions: .github/workflows/release.yml:1
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 17/20 approved changesets -- score normalized to 8
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/statelyai/xstate/nodejs.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/statelyai/xstate/release.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/statelyai/xstate/release.yml/main?enable=pin
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 27 are checked with a SAST tool
Reason
101 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-64vr-g452-qvp3
- Warn: Project is vulnerable to: GHSA-9cwx-2883-4wfx
- Warn: Project is vulnerable to: GHSA-vg6x-rcgg-rjx6
- Warn: Project is vulnerable to: GHSA-x574-m823-4x7w
- Warn: Project is vulnerable to: GHSA-4r4m-qw57-chr8
- Warn: Project is vulnerable to: GHSA-xcj6-pq6g-qj4x
- Warn: Project is vulnerable to: GHSA-356w-63v5-8wf4
- Warn: Project is vulnerable to: GHSA-859w-5945-r5v3
- Warn: Project is vulnerable to: GHSA-g3ch-rx76-35fx
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
- Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh
- Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
- Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
- Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
- Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
- Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
- Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
- Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
- Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6
- Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59
- Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-qxrj-hx23-xp82
- Warn: Project is vulnerable to: GHSA-593f-38f6-jp5m
- Warn: Project is vulnerable to: GHSA-x2rg-q646-7m2v
- Warn: Project is vulnerable to: GHSA-mv48-hcvh-8jj8
- Warn: Project is vulnerable to: GHSA-353f-5xf4-qw67
- Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6
- Warn: Project is vulnerable to: GHSA-vc8w-jr9v-vj7f
- Warn: Project is vulnerable to: GHSA-hqq7-2q2v-82xq
- Warn: Project is vulnerable to: GHSA-q8gg-vj6m-hgmj
- Warn: Project is vulnerable to: GHSA-h452-7996-h45h
- Warn: Project is vulnerable to: GHSA-36jr-mh4h-2g58
- Warn: Project is vulnerable to: GHSA-p3vf-v8qc-cwcr
- Warn: Project is vulnerable to: GHSA-gx9m-whjm-85jf
- Warn: Project is vulnerable to: GHSA-mmhx-hmjr-r674
- Warn: Project is vulnerable to: GHSA-vhxf-7vqr-mrjg
- Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2
- Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
- Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
- Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
- Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
- Warn: Project is vulnerable to: GHSA-8mmm-9v2q-x3f9
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-7wwv-vh3v-89cq
- Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m
- Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
- Warn: Project is vulnerable to: GHSA-4www-5p9h-95mh
- Warn: Project is vulnerable to: GHSA-9gqv-wp59-fq42
- Warn: Project is vulnerable to: GHSA-8g7p-74h8-hg48
- Warn: Project is vulnerable to: GHSA-pc5p-h8pf-mvwp
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-6vfc-qv3f-vr6c
- Warn: Project is vulnerable to: GHSA-x3vm-38hw-55wf
- Warn: Project is vulnerable to: GHSA-m4gq-x24j-jpmf
- Warn: Project is vulnerable to: GHSA-wrvr-8mpx-r7pp
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-5g97-whc9-8g7j
- Warn: Project is vulnerable to: GHSA-8r4g-cg4m-x23c
- Warn: Project is vulnerable to: GHSA-6fw4-hr69-g3rv
- Warn: Project is vulnerable to: GHSA-gqgv-6jq5-jjj9
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
- Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
- Warn: Project is vulnerable to: GHSA-3f95-r44v-8mrg
- Warn: Project is vulnerable to: GHSA-28xr-mwxg-3qc8
- Warn: Project is vulnerable to: GHSA-9p95-fxvg-qgq2
- Warn: Project is vulnerable to: GHSA-9w5j-4mwv-2wj8
- Warn: Project is vulnerable to: GHSA-8225-6cvr-8pqp
- Warn: Project is vulnerable to: GHSA-8266-84wp-wv5c
- Warn: Project is vulnerable to: GHSA-5j4c-8p2g-v4jx
- Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
- Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v
- Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-c24v-8rfc-w8vw
- Warn: Project is vulnerable to: GHSA-8jhw-289h-jh2g
Score
5.7
/10
Last Scanned on 2025-06-23
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More