@resistdesign/voltra 3.0.0-alpha.6 → 3.0.0-alpha.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 +36 -7
- package/api/index.d.ts +1 -1
- package/api/index.js +2209 -1741
- package/common/index.d.ts +1 -1
- package/common/index.js +64 -606
- package/{index-C3-iD9Mh.d.ts → index-sIX5qe0K.d.ts} +2 -12
- package/{index-DbLgMAxB.d.ts → index-t9LXRpCu.d.ts} +1 -1
- package/index.d.ts +2 -2
- package/index.js +2327 -1836
- package/package.json +6 -1
package/README.md
CHANGED
|
@@ -21,9 +21,9 @@ Prefer the public entrypoints below to keep imports stable and IDE auto-imports
|
|
|
21
21
|
Preferred:
|
|
22
22
|
|
|
23
23
|
```ts
|
|
24
|
-
import {
|
|
25
|
-
import {
|
|
26
|
-
import {
|
|
24
|
+
import {IaC} from "@resistdesign/voltra";
|
|
25
|
+
import {Packs} from "@resistdesign/voltra/iac";
|
|
26
|
+
import {addDNS} from "@resistdesign/voltra/iac/packs";
|
|
27
27
|
```
|
|
28
28
|
|
|
29
29
|
Not supported:
|
|
@@ -41,6 +41,30 @@ Public entrypoints:
|
|
|
41
41
|
- `@resistdesign/voltra/iac`
|
|
42
42
|
- `@resistdesign/voltra/iac/packs`
|
|
43
43
|
|
|
44
|
+
------------
|
|
45
|
+
|
|
46
|
+
## Build-time Type Parsing (Advanced)
|
|
47
|
+
|
|
48
|
+
Voltra exposes TypeScript compiler–powered parsing utilities intended **only for build-time tooling** (scripts,
|
|
49
|
+
generators, CI).
|
|
50
|
+
|
|
51
|
+
These APIs depend on the TypeScript compiler and **must not be imported into runtime code** (e.g. Lambdas, servers,
|
|
52
|
+
browsers).
|
|
53
|
+
|
|
54
|
+
Build entrypoint:
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
import {getTypeInfoMapFromTypeScript} from "@resistdesign/voltra/build";
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Use this entrypoint for:
|
|
61
|
+
|
|
62
|
+
- Code generation
|
|
63
|
+
- Pre-build analysis
|
|
64
|
+
- Producing static artifacts (JSON / TS)
|
|
65
|
+
|
|
66
|
+
Do **not** import `@resistdesign/voltra/build` from runtime code.
|
|
67
|
+
|
|
44
68
|
## With our powers combined!
|
|
45
69
|
|
|
46
70
|
<table style="border: 0 solid black;">
|
|
@@ -74,8 +98,10 @@ The docs site is both reference documentation and a canonical usage example.
|
|
|
74
98
|
Key pieces:
|
|
75
99
|
|
|
76
100
|
- Astro app in `site/app` builds the UI into `site-dist/app` via `yarn site:build:app`.
|
|
77
|
-
- API bundle for the docs site is built by `yarn site:build:api` (see `site/build-api.mjs`) and written to
|
|
78
|
-
|
|
101
|
+
- API bundle for the docs site is built by `yarn site:build:api` (see `site/build-api.mjs`) and written to
|
|
102
|
+
`site-dist/api`.
|
|
103
|
+
- The IaC demo template is generated by `yarn site:build:iac` from `site/iac/index.ts` and written to
|
|
104
|
+
`site-dist/iac/index.yml`.
|
|
79
105
|
|
|
80
106
|
API docs flow:
|
|
81
107
|
|
|
@@ -89,12 +115,15 @@ IaC types are generated from the AWS CloudFormation resource specification.
|
|
|
89
115
|
When updating, follow this flow:
|
|
90
116
|
|
|
91
117
|
1) Download the latest CloudFormation resource specification JSON from AWS (region: `us-east-1`).
|
|
92
|
-
2) Replace the contents of `src/iac/types/CloudFormationResourceSpecification.ts` with the JSON payload (as the exported
|
|
118
|
+
2) Replace the contents of `src/iac/types/CloudFormationResourceSpecification.ts` with the JSON payload (as the exported
|
|
119
|
+
data).
|
|
93
120
|
3) Run `yarn iac:types:gen` to regenerate `dist/IaCTypes.ts`.
|
|
94
121
|
4) Verify `dist/IaCTypes.ts` looks correct, then commit both files.
|
|
95
122
|
|
|
96
123
|
Notes:
|
|
97
|
-
|
|
124
|
+
|
|
125
|
+
- `src/iac/types/IaCTypes.ts` and `src/iac/types/CloudFormationResourceSpecification.ts` are generated artifacts; do not
|
|
126
|
+
edit by hand.
|
|
98
127
|
- The generator entrypoint is `src/iac/types/generate.ts` and uses `src/iac/types/Renderers.ts` for output.
|
|
99
128
|
|
|
100
129
|
## Releasing
|
package/api/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { D as DAC, a as Indexing, b as ORM, c as Routing } from '../index-
|
|
1
|
+
export { D as DAC, a as Indexing, b as ORM, c as Routing } from '../index-t9LXRpCu.js';
|
|
2
2
|
import '@aws-sdk/client-dynamodb';
|
|
3
3
|
import '@aws-sdk/client-s3';
|
|
4
4
|
import '../SearchTypes-DjN6YQzE.js';
|