@rivi-software/radiotools-contract 0.2.0 → 0.2.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 +25 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# @rivi-software/radiotools-contract
|
|
2
|
+
|
|
3
|
+
The RadioTools listener API contract (v1): the source of truth the SDK generators read from. Station-facing routes only; studio administration is out of scope.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @rivi-software/radiotools-contract
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## What's inside
|
|
12
|
+
|
|
13
|
+
- `listenerSdkManifest`: the public client methods, auth scopes and environment variables.
|
|
14
|
+
- `LISTENER_CONTRACT_VERSION` and `PUBLIC_SOCKET_PROTOCOL`: version constants.
|
|
15
|
+
- `readGraphqlSchema()` and `graphqlSchemaPath()`: access to the checked-in GraphQL schema.
|
|
16
|
+
- `@rivi-software/radiotools-contract/graphql`: the raw `schema.graphql` file.
|
|
17
|
+
|
|
18
|
+
```ts
|
|
19
|
+
import { listenerSdkManifest, readGraphqlSchema } from "@rivi-software/radiotools-contract";
|
|
20
|
+
|
|
21
|
+
console.log(listenerSdkManifest);
|
|
22
|
+
const sdl = readGraphqlSchema();
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Most applications want [`@rivi-software/radiotools-sdk`](../sdk-typescript) instead. Use this package when building tooling or a new SDK target.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rivi-software/radiotools-contract",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.2",
|
|
4
4
|
"description": "RadioTools listener API contract (manifest and GraphQL schema)",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
},
|
|
21
21
|
"repository": {
|
|
22
22
|
"type": "git",
|
|
23
|
-
"url": "https://github.com/
|
|
23
|
+
"url": "https://github.com/rivi-software/radiotools-sdk.git",
|
|
24
24
|
"directory": "packages/contract"
|
|
25
25
|
}
|
|
26
26
|
}
|