@owlmeans/flow 0.1.6 → 0.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -67,3 +67,20 @@ Config record type key for registering flows in the application config.
|
|
|
67
67
|
|
|
68
68
|
- [`@owlmeans/client-flow`](../client-flow) — client-side flow service that executes flow steps
|
|
69
69
|
- [`@owlmeans/web-flow`](../web-flow) — React components for flow UI rendering
|
|
70
|
+
|
|
71
|
+
<!-- owlmeans:agent-guidance:start -->
|
|
72
|
+
## Agent guidance
|
|
73
|
+
|
|
74
|
+
This package ships embedded Claude Code skills and GitHub Copilot instructions under
|
|
75
|
+
`agent-meta/`. After installing your `@owlmeans/*` packages, run the OwlMeans
|
|
76
|
+
agent-skills installer to place them into your project's native locations
|
|
77
|
+
(`.claude/skills/` and `.github/instructions/`):
|
|
78
|
+
|
|
79
|
+
```sh
|
|
80
|
+
npx @owlmeans/agent-skills
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
The embedded files are version-matched to this package release. Do not edit them
|
|
84
|
+
directly — they are regenerated on each publish. To contribute guidance edits,
|
|
85
|
+
open a PR against the source monorepo.
|
|
86
|
+
<!-- owlmeans:agent-guidance:end -->
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: "How to use @owlmeans/flow — state-machine / workflow execution framework with typed state, transitions, and flow definitions. Use when implementing multi-step workflows."
|
|
3
|
+
applyTo: "**/*.ts, **/*.tsx"
|
|
4
|
+
---
|
|
5
|
+
<!-- AUTO-GENERATED — do not edit. Regenerate via sync-agent-meta. -->
|
|
6
|
+
|
|
7
|
+
# @owlmeans/flow
|
|
8
|
+
|
|
9
|
+
**Layer:** Core
|
|
10
|
+
**Install:** `"@owlmeans/flow": "^0.1.8"` in `dependencies`
|
|
11
|
+
|
|
12
|
+
## Key Exports
|
|
13
|
+
|
|
14
|
+
| Export | Description |
|
|
15
|
+
|--------|-------------|
|
|
16
|
+
| `Flow` types | Flow definition shape (states, transitions, payload) |
|
|
17
|
+
| `FlowState` | State management primitives |
|
|
18
|
+
| Errors | Flow execution errors |
|
|
19
|
+
| Constants | Built-in state names, transition types |
|
|
20
|
+
| Helpers | Flow construction and validation |
|
|
21
|
+
| `flows` submodule | Built-in flow definitions |
|
|
22
|
+
| i18n | Translatable error messages |
|
|
23
|
+
|
|
24
|
+
## Usage
|
|
25
|
+
|
|
26
|
+
```typescript
|
|
27
|
+
import { Flow } from '@owlmeans/flow'
|
|
28
|
+
|
|
29
|
+
const onboardingFlow: Flow = {
|
|
30
|
+
alias: 'onboarding',
|
|
31
|
+
initial: 'welcome',
|
|
32
|
+
states: {
|
|
33
|
+
welcome: { on: { NEXT: 'profile' } },
|
|
34
|
+
profile: { on: { NEXT: 'done', BACK: 'welcome' } },
|
|
35
|
+
done: { type: 'final' }
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Depends On
|
|
41
|
+
|
|
42
|
+
- `@owlmeans/error`, `@owlmeans/i18n`
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
{
|
|
2
|
+
"schemaVersion": 1,
|
|
3
|
+
"package": "@owlmeans/flow",
|
|
4
|
+
"version": "0.1.8",
|
|
5
|
+
"generatedAt": "2026-06-11T16:30:27.184Z",
|
|
6
|
+
"canonicalRepo": "https://github.com/owlmeans/common",
|
|
7
|
+
"entries": [
|
|
8
|
+
{
|
|
9
|
+
"kind": "skill",
|
|
10
|
+
"name": "flow",
|
|
11
|
+
"category": "package-specific",
|
|
12
|
+
"file": "skills/flow/SKILL.md",
|
|
13
|
+
"canonicalPath": ".claude/skills/flow/SKILL.md"
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
"kind": "instruction",
|
|
17
|
+
"name": "flow",
|
|
18
|
+
"category": "package-specific",
|
|
19
|
+
"file": "instructions/flow.instructions.md",
|
|
20
|
+
"canonicalPath": ".github/instructions/flow.instructions.md"
|
|
21
|
+
}
|
|
22
|
+
]
|
|
23
|
+
}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: flow
|
|
3
|
+
description: How to use @owlmeans/flow — state-machine / workflow execution framework with typed state, transitions, and flow definitions. Auto-invoked when importing from this package or implementing multi-step workflows.
|
|
4
|
+
user-invocable: false
|
|
5
|
+
---
|
|
6
|
+
<!-- AUTO-GENERATED — do not edit. Regenerate via sync-agent-meta. -->
|
|
7
|
+
|
|
8
|
+
# @owlmeans/flow
|
|
9
|
+
|
|
10
|
+
**Layer:** Core
|
|
11
|
+
**Install:** `"@owlmeans/flow": "^0.1.8"` in `dependencies`
|
|
12
|
+
|
|
13
|
+
## Key Exports
|
|
14
|
+
|
|
15
|
+
| Export | Description |
|
|
16
|
+
|--------|-------------|
|
|
17
|
+
| `Flow` types | Flow definition shape (states, transitions, payload) |
|
|
18
|
+
| `FlowState` | State management primitives |
|
|
19
|
+
| Errors | Flow execution errors |
|
|
20
|
+
| Constants | Built-in state names, transition types |
|
|
21
|
+
| Helpers | Flow construction and validation |
|
|
22
|
+
| `flows` submodule | Built-in flow definitions |
|
|
23
|
+
| i18n | Translatable error messages |
|
|
24
|
+
|
|
25
|
+
## Usage
|
|
26
|
+
|
|
27
|
+
Define a flow with typed states, then drive it from `@owlmeans/client-flow` (cross-platform) or `@owlmeans/web-flow` (web):
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
import { Flow, FlowState } from '@owlmeans/flow'
|
|
31
|
+
|
|
32
|
+
const onboardingFlow: Flow = {
|
|
33
|
+
alias: 'onboarding',
|
|
34
|
+
initial: 'welcome',
|
|
35
|
+
states: {
|
|
36
|
+
welcome: { on: { NEXT: 'profile' } },
|
|
37
|
+
profile: { on: { NEXT: 'done', BACK: 'welcome' } },
|
|
38
|
+
done: { type: 'final' }
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Depends On
|
|
44
|
+
|
|
45
|
+
- `@owlmeans/error` — flow errors
|
|
46
|
+
- `@owlmeans/i18n` — translatable error messages
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@owlmeans/flow",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.8",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"scripts": {
|
|
@@ -21,11 +21,11 @@
|
|
|
21
21
|
}
|
|
22
22
|
},
|
|
23
23
|
"dependencies": {
|
|
24
|
-
"@owlmeans/auth": "^0.1.
|
|
25
|
-
"@owlmeans/config": "^0.1.
|
|
26
|
-
"@owlmeans/error": "^0.1.
|
|
27
|
-
"@owlmeans/i18n": "^0.1.
|
|
28
|
-
"@owlmeans/resource": "^0.1.
|
|
24
|
+
"@owlmeans/auth": "^0.1.8",
|
|
25
|
+
"@owlmeans/config": "^0.1.8",
|
|
26
|
+
"@owlmeans/error": "^0.1.8",
|
|
27
|
+
"@owlmeans/i18n": "^0.1.8",
|
|
28
|
+
"@owlmeans/resource": "^0.1.8",
|
|
29
29
|
"@scure/base": "^1.1.9"
|
|
30
30
|
},
|
|
31
31
|
"devDependencies": {
|