@typecaast/schema 0.4.0 → 0.4.1
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 +23 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# @typecaast/schema
|
|
2
|
+
|
|
3
|
+
The versioned, Zod-validated config schema for [Typecaast](https://typecaast.com)
|
|
4
|
+
— the single source of truth for a simulation. Exports `validateConfig`,
|
|
5
|
+
`configJsonSchema`, `STEP_TYPES`, and the Zod schemas/types.
|
|
6
|
+
|
|
7
|
+
Consumers normally never import this directly — `@typecaast/react` and the CLI use
|
|
8
|
+
it for you, and you pass plain JSON. Reach for it to validate a config
|
|
9
|
+
programmatically:
|
|
10
|
+
|
|
11
|
+
```ts
|
|
12
|
+
import { validateConfig } from "@typecaast/schema";
|
|
13
|
+
|
|
14
|
+
const diagnostics = validateConfig(myJson); // [] = valid
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Authoring configs
|
|
18
|
+
|
|
19
|
+
- [Authoring configs](https://typecaast.com/docs/authoring-configs) · [Pacing & timing](https://typecaast.com/docs/pacing)
|
|
20
|
+
- JSON Schema: <https://typecaast.com/schema/v1/typecaast.schema.json> — add a `$schema` line to a config for editor autocomplete.
|
|
21
|
+
- **For LLMs/agents:** <https://typecaast.com/llms.txt> and the [`@typecaast/mcp`](https://www.npmjs.com/package/@typecaast/mcp) server.
|
|
22
|
+
|
|
23
|
+
Full docs: <https://typecaast.com/docs>. Apache-2.0.
|