Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drivly/state.do
Finite State Machine implementation with Durable Objects
https://github.com/drivly/state.do
Last synced: 3 months ago
JSON representation
Finite State Machine implementation with Durable Objects
- Host: GitHub
- URL: https://github.com/drivly/state.do
- Owner: drivly
- License: mit
- Created: 2022-08-07T12:03:30.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-15T06:11:53.000Z (6 months ago)
- Last Synced: 2024-05-15T21:37:44.228Z (6 months ago)
- Language: JavaScript
- Homepage: https://state.do
- Size: 424 KB
- Stars: 41
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [state.do](https://state.do)
Finite State Machine implementation with Durable Objects based on [xstate](https://xstate.js.org).
Use the [editor](https://stately.ai/editor) to create and export your state machine, then optionally add callback fetch URLs/inits to automate the machine events.
## API
Read current state:
```curl
https://state.do/:key
```
Send event to machine:
```curl
https://state.do/:key/:event
```
Initialize machine:
```curl
https://state.do/:key?{"id":"fetch","initial":"init","states":{"init":{"on":{"FETCH":"loading"}},"loading":{"callback":"https://fetcher.do/60sec/https://example.com/","on":{"4XX":"fault","5XX":"failure","*":"success"}},"failure":{"callback":"https://alarms.do/?fromnow=10sec&callback=https://state.do/:key/RETRY","on":{"RETRY":{"target":"loading"}}},"fault":{"callback":"https://example.logging.do/error?message=","type":"final"},"success":{"callback":"https://graphology.do.cf/:key?newnode?example|","type":"final"}}}
```
or POST the machine to `https://state.do/:key`
## Callbacks
Callbacks can be added to the state's `meta` property as a url or as a configuration object with url and init or body:
```json
"State": {
"meta": {
"callback": "https://webhooks.do/state",
"body": {
"Hello": "world"
}
},
"on": {
"Event": {
"target": "State 2"
}
}
},
```
More than one callback can be called by passing an array of callbacks.
HTTP status codes from the callback can be passed as events to the state machine by adding the status code as an event, optionally with wildcards (e.g. 4XX to trap client-side errors).
## Example machine with callbacks
```mermaid
stateDiagram-v2
[*]-->loading: FETCH
loading-->⦿ fault: 4XX
loading-->failure: 5XX
loading-->⦿ success: *
failure-->loading: RETRY
```
```json
{
"id": "fetch",
"initial": "init",
"states": {
"init": {
"on": {
"FETCH": "loading"
}
},
"loading": {
"callback": "https://fetcher.do/60sec/https://example.com/",
"on": {
"4XX": "fault",
"5XX": "failure",
"*": "success"
}
},
"failure": {
"callback": "https://alarms.do/?fromnow=10sec&callback=https://state.do/:key/RETRY",
"on": {
"RETRY": {
"target": "loading"
}
}
},
"fault": {
"callback": "https://example.logging.do/error",
"type": "final"
},
"success": {
"callback": {
"url": "https://graphology.do.cf/:key?newnode?example",
"init": {
"method": "POST"
}
},
"type": "final"
}
}
}
```
## [🚀 We're hiring!](https://careers.do/apply)
[Driv.ly](https://driv.ly) is simple APIs to buy & sell cars online, funded by some of the [biggest names](https://twitter.com/TurnerNovak) in [automotive](https://fontinalis.com/team/#bill-ford) and [finance & insurance](https://www.detroit.vc)
We're building our entire infrastructure on Cloudflare Workers, Durable Objects, KV, R2, and PubSub. If you're as passionate about these transformational technologies as we are, we'd love for you to join our rapidly-growing team.