@caatinga/core 0.2.0
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/LICENSE +21 -0
- package/README.md +33 -0
- package/dist/index.cjs +1104 -0
- package/dist/index.d.cts +575 -0
- package/dist/index.d.ts +575 -0
- package/dist/index.js +1033 -0
- package/package.json +58 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) Kaleido contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# @caatinga/core
|
|
2
|
+
|
|
3
|
+
Core config, artifacts, command orchestration, and error primitives for Caatinga.
|
|
4
|
+
|
|
5
|
+
## Supported Use
|
|
6
|
+
|
|
7
|
+
`@caatinga/core` is primarily an internal package for the Caatinga CLI and templates; direct use beyond the documented config/template helpers is advanced and less stable than the CLI contract.
|
|
8
|
+
|
|
9
|
+
## What Is In This Package
|
|
10
|
+
|
|
11
|
+
- `defineConfig` for Caatinga project config files generated by Caatinga templates
|
|
12
|
+
- config loading and validation
|
|
13
|
+
- artifact resolution and update helpers
|
|
14
|
+
- shared command orchestration primitives
|
|
15
|
+
- public `CAATINGA_*` error foundations used by higher-level packages
|
|
16
|
+
|
|
17
|
+
## Consumer Guidance
|
|
18
|
+
|
|
19
|
+
If you want the supported end-user workflow, use `@caatinga/cli`.
|
|
20
|
+
|
|
21
|
+
If you are authoring a Caatinga project, importing `defineConfig` from `@caatinga/core` in `caatinga.config.ts` is part of the intended template/config surface.
|
|
22
|
+
|
|
23
|
+
Reach for broader `@caatinga/core` APIs directly only when you are building advanced tooling on top of Caatinga internals and are prepared to track lower-level package changes more closely than a CLI consumer.
|
|
24
|
+
|
|
25
|
+
## Stability Posture
|
|
26
|
+
|
|
27
|
+
Being published does not make every export a first-class end-user contract. The stable consumer surfaces are:
|
|
28
|
+
|
|
29
|
+
- the documented CLI workflow in `@caatinga/cli`
|
|
30
|
+
- the documented `@caatinga/client` APIs
|
|
31
|
+
- the narrow `@caatinga/core` config/template surface used by generated projects, including `defineConfig`
|
|
32
|
+
|
|
33
|
+
Direct `@caatinga/core` usage should be treated as advanced integration with a narrower support posture than the CLI package.
|