@vev-software/atlas-contracts 0.1.1 → 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 +38 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# @vev-software/atlas-contracts
|
|
2
|
+
|
|
3
|
+
Public, versioned **data model and interop contracts** for VEV Atlas — the portability and
|
|
4
|
+
interoperability surface that the Atlas runtime and third-party importers/exporters all build
|
|
5
|
+
against, without reaching into anyone's internals.
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm i @vev-software/atlas-contracts
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
```ts
|
|
12
|
+
import type { LandscapeDocument, Asset } from "@vev-software/atlas-contracts";
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## What's inside
|
|
16
|
+
|
|
17
|
+
- **Asset data model** — the catalogue of systems, applications, servers and infrastructure,
|
|
18
|
+
plus the manual **relationships** and **tags** that connect and classify them.
|
|
19
|
+
- **Landscape import/export document** — the schema that carries a whole landscape across a
|
|
20
|
+
boundary (customer-owned export; community importers/exporters).
|
|
21
|
+
- **Authoritative JSON Schemas** — shipped under `schemas/` in the package, so you can validate
|
|
22
|
+
payloads against the exact same contracts the TypeScript types describe.
|
|
23
|
+
|
|
24
|
+
Ships type declarations (`dist/index.d.ts`) and ESM; no runtime dependencies.
|
|
25
|
+
|
|
26
|
+
## Versioning
|
|
27
|
+
|
|
28
|
+
[SemVer](https://semver.org), derived from the git tag (`vX.Y.Z`) at release. Pre-1.0, the v1
|
|
29
|
+
contract evolves additively across minor/patch versions.
|
|
30
|
+
|
|
31
|
+
## Links
|
|
32
|
+
|
|
33
|
+
- **Source & issues:** https://github.com/Vev-software/atlas-contracts
|
|
34
|
+
- **.NET SDK (NuGet):** [`Vev.Atlas.Contracts`](https://www.nuget.org/packages/Vev.Atlas.Contracts)
|
|
35
|
+
|
|
36
|
+
## Licence
|
|
37
|
+
|
|
38
|
+
[Apache-2.0](https://github.com/Vev-software/atlas-contracts/blob/main/LICENSE).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vev-software/atlas-contracts",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "Public, versioned data model and interop contracts for VEV Atlas — the catalogue asset model plus manual relationships, tags and the landscape import/export document.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"type": "module",
|