@healflow/shared 0.1.0 → 0.1.2
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 +71 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# @healflow/shared
|
|
2
|
+
|
|
3
|
+
Shared types, enums, contracts, events, and configuration for the HealFlow platform.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
Foundation package used across CLI, Playwright plugin, API, and internal engines. Provides domain models, policy rules, healing constraints, and the `healflow.yml` config schema.
|
|
8
|
+
|
|
9
|
+
**Published to npm** as a transitive dependency of `@healflow/playwright` and `@healflow/cli`. You typically do not install it directly.
|
|
10
|
+
|
|
11
|
+
## Installation
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install @healflow/shared
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Exports
|
|
18
|
+
|
|
19
|
+
| Subpath | Purpose |
|
|
20
|
+
| ------- | ------- |
|
|
21
|
+
| `@healflow/shared` | Enums, domain types, policy, healing rules |
|
|
22
|
+
| `@healflow/shared/config` | `HealFlowConfig`, YAML loader, artifact types |
|
|
23
|
+
| `@healflow/shared/events` | Domain events for the job pipeline |
|
|
24
|
+
| `@healflow/shared/contracts` | API and service contracts |
|
|
25
|
+
|
|
26
|
+
## Config
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import { loadHealFlowConfig, mergeHealFlowConfig } from '@healflow/shared/config';
|
|
30
|
+
|
|
31
|
+
const config = loadHealFlowConfig(process.cwd());
|
|
32
|
+
// reads healflow.yml or healflow.yaml
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Example `healflow.yml`:
|
|
36
|
+
|
|
37
|
+
```yaml
|
|
38
|
+
mode: local
|
|
39
|
+
output: verbose
|
|
40
|
+
|
|
41
|
+
healing:
|
|
42
|
+
selector: true
|
|
43
|
+
timing: true
|
|
44
|
+
overlay: true
|
|
45
|
+
|
|
46
|
+
validation:
|
|
47
|
+
requiredRuns: 3
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Key types
|
|
51
|
+
|
|
52
|
+
- `FailureCategory` — selector, timing, overlay, iframe, product bug, etc.
|
|
53
|
+
- `FailureSource` — runtime, report, trace, CI, manual
|
|
54
|
+
- `HealFlowConfig` — local/cloud mode, healing toggles, backend sync
|
|
55
|
+
- `RuntimeHealRecord`, `FixProposalRecord`, `HealFlowRunArtifacts` — `.healflow/` artifact shapes
|
|
56
|
+
|
|
57
|
+
## Development
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
pnpm --filter @healflow/shared build
|
|
61
|
+
pnpm --filter @healflow/shared typecheck
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Related packages
|
|
65
|
+
|
|
66
|
+
- [@healflow/classification](https://www.npmjs.com/package/@healflow/classification) — failure classification
|
|
67
|
+
- [@healflow/playwright](https://www.npmjs.com/package/@healflow/playwright) — runtime plugin
|
|
68
|
+
|
|
69
|
+
## License
|
|
70
|
+
|
|
71
|
+
MIT
|