+
This repository holds the two public npm packages of AntelopeJS Cloud:
- `@antelopejs/cloud-sdk` in [`sdk/`](sdk/README.md) is a typed client for the AntelopeJS Cloud API. Its types are generated from the OpenAPI spec in `sdk/openapi/`, which the package also ships.
@@ -108,3 +120,11 @@ The CLI depends on a range of SDK versions, so release in this order:
3. Run the workflow with `package: cli`. The first CLI release also sets `release-version` to `0.1.0`.
The CLI run fails before it publishes when no version of `@antelopejs/cloud-sdk` that matches its range is on npm. When a CLI change needs a new SDK release, raise the range in `cli/package.json` and release the SDK first.
+
+## Part of AntelopeJS
+
+This tooling belongs to [AntelopeJS](https://github.com/AntelopeJS/antelopejs), the TypeScript framework where modules depend on contracts and the application chooses the provider. The open-source back office [AntelopeJS DMS](https://github.com/AntelopeJS/dms) is built on it.
+
+## License
+
+Both packages are licensed under Apache-2.0, as declared in [`sdk/package.json`](./sdk/package.json) and [`cli/package.json`](./cli/package.json).
diff --git a/cli/package.json b/cli/package.json
index 5b32dde..7d8d4d5 100644
--- a/cli/package.json
+++ b/cli/package.json
@@ -58,7 +58,7 @@
},
"devDependencies": {
"@antelopejs/core": "^1.21.0",
- "@antelopejs/tooling-configs": "^0.5.2",
+ "@antelopejs/tooling-configs": "^0.5.5",
"@types/busboy": "^1.5.4",
"@types/node": "^22.19.15",
"@types/tar-stream": "^3.1.4",
diff --git a/package.json b/package.json
index eea9e01..bb06fb6 100644
--- a/package.json
+++ b/package.json
@@ -24,7 +24,7 @@
"knip": "knip"
},
"devDependencies": {
- "@antelopejs/tooling-configs": "^0.5.2",
+ "@antelopejs/tooling-configs": "^0.5.5",
"@types/node": "^22.20.5",
"knip": "^6.34.0",
"lefthook": "^2.2.2",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index e412e3e..0c40970 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -16,8 +16,8 @@ importers:
.:
devDependencies:
'@antelopejs/tooling-configs':
- specifier: ^0.5.2
- version: 0.5.2(knip@6.45.1)(oxfmt@0.77.0)(oxlint@1.81.0(oxlint-tsgolint@7.0.2006))
+ specifier: ^0.5.5
+ version: 0.5.5(knip@6.45.1)(oxfmt@0.77.0)(oxlint@1.81.0(oxlint-tsgolint@7.0.2006))
'@types/node':
specifier: ^22.20.5
version: 22.20.5
@@ -56,8 +56,8 @@ importers:
specifier: ^1.21.0
version: 1.21.2
'@antelopejs/tooling-configs':
- specifier: ^0.5.2
- version: 0.5.2(knip@6.45.1)(oxfmt@0.77.0)(oxlint@1.81.0(oxlint-tsgolint@7.0.2006))
+ specifier: ^0.5.5
+ version: 0.5.5(knip@6.45.1)(oxfmt@0.77.0)(oxlint@1.81.0(oxlint-tsgolint@7.0.2006))
'@types/busboy':
specifier: ^1.5.4
version: 1.5.5
@@ -99,8 +99,8 @@ importers:
version: 0.14.1
devDependencies:
'@antelopejs/tooling-configs':
- specifier: ^0.5.2
- version: 0.5.2(knip@6.45.1)(oxfmt@0.77.0)(oxlint@1.81.0(oxlint-tsgolint@7.0.2006))
+ specifier: ^0.5.5
+ version: 0.5.5(knip@6.45.1)(oxfmt@0.77.0)(oxlint@1.81.0(oxlint-tsgolint@7.0.2006))
'@types/node':
specifier: ^22.19.15
version: 22.20.5
@@ -139,8 +139,8 @@ packages:
'@antelopejs/interface-core@0.4.1':
resolution: {integrity: sha512-6UZWBp4IXHUNqP26uaqG+kmDfJW79LvPpskITmoouv57zsZ0RgyCLfc0sHs7Bcj/88hvhy/KLYgQ51p11IlBjQ==}
- '@antelopejs/tooling-configs@0.5.2':
- resolution: {integrity: sha512-xBDfki+csG8C1Rn7rWk+oItUcHkE/LuxKHSrM2y7x390un4cASR9jsxKLXXBjlx6DaBm32pCL4RKtRQsfFMZkA==}
+ '@antelopejs/tooling-configs@0.5.5':
+ resolution: {integrity: sha512-03QagBC3hE4GAtEF+vwEYWvQfD1oqik+3OrvzT6MaII88vwHdWJOiyqUcHW0ul+ujG4GBL5nDO+wmBciTxQB+g==}
engines: {node: '>=22.18.0'}
hasBin: true
peerDependencies:
@@ -2436,7 +2436,7 @@ snapshots:
dependencies:
reflect-metadata: 0.2.2
- '@antelopejs/tooling-configs@0.5.2(knip@6.45.1)(oxfmt@0.77.0)(oxlint@1.81.0(oxlint-tsgolint@7.0.2006))':
+ '@antelopejs/tooling-configs@0.5.5(knip@6.45.1)(oxfmt@0.77.0)(oxlint@1.81.0(oxlint-tsgolint@7.0.2006))':
dependencies:
'@oxlint/plugins': 1.81.0
dts-bundle-generator: 9.5.1
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml
index 7c0318b..e5871b7 100644
--- a/pnpm-workspace.yaml
+++ b/pnpm-workspace.yaml
@@ -8,3 +8,5 @@ overrides:
"brace-expansion@>=5.0.0 <5.0.11": "^5.0.11"
"js-yaml@>=4.0.0 <4.3.2": "^4.3.2"
"tinypool@>=2.0.0 <2.1.2": "^2.1.2"
+allowBuilds:
+ lefthook: false
diff --git a/sdk/package.json b/sdk/package.json
index 64d8693..8aece64 100644
--- a/sdk/package.json
+++ b/sdk/package.json
@@ -53,7 +53,7 @@
"openapi-fetch": "^0.14.0"
},
"devDependencies": {
- "@antelopejs/tooling-configs": "^0.5.2",
+ "@antelopejs/tooling-configs": "^0.5.5",
"@types/node": "^22.19.15",
"openapi-typescript": "^7.9.1",
"oxfmt": "^0.77.0",
+
+**Antelope Cloud SDK (@antelopejs/cloud-sdk) and CLI (@antelopejs/cloud)**
+
+[CLI documentation](./cli/README.md) · [SDK documentation](./sdk/README.md) · [All interfaces and providers](https://github.com/AntelopeJS/antelopejs#ecosystem)
+
+