@greatwait/contracts 0.1.0-alpha.8 → 0.2.1
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 +13 -12
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,12 +4,8 @@ The public contracts for [GreatWait](https://greatwait.dev): the schemas every
|
|
|
4
4
|
response is parsed with, the stable refusal catalog, the operation registry, and
|
|
5
5
|
the generated OpenAPI documents.
|
|
6
6
|
|
|
7
|
-
> **Alpha.** This package publishes on the `alpha` dist-tag and has no
|
|
8
|
-
> `latest`. Install it explicitly, and pin the exact version in anything you
|
|
9
|
-
> care about.
|
|
10
|
-
|
|
11
7
|
```bash
|
|
12
|
-
npm install @greatwait/contracts
|
|
8
|
+
npm install @greatwait/contracts
|
|
13
9
|
```
|
|
14
10
|
|
|
15
11
|
Most people arrive here through [`@greatwait/api-client`](https://www.npmjs.com/package/@greatwait/api-client),
|
|
@@ -67,13 +63,18 @@ That internal QA surface is deliberately excluded from the published package.
|
|
|
67
63
|
of any deployment, because a service that ships twice a day must not imply the
|
|
68
64
|
contract changed twice a day.
|
|
69
65
|
|
|
70
|
-
##
|
|
66
|
+
## First callback
|
|
67
|
+
|
|
68
|
+
For a signed-in credential, a call scheduled directly to your HTTPS URL, and a
|
|
69
|
+
read of the delivery attempt, follow the
|
|
70
|
+
[JavaScript quickstart](https://docs.greatwait.dev/guides/javascript) with
|
|
71
|
+
[`@greatwait/api-client`](https://www.npmjs.com/package/@greatwait/api-client),
|
|
72
|
+
or the [CLI quickstart](https://docs.greatwait.dev/guides/cli).
|
|
73
|
+
The client already depends on this package; you only need a separate install
|
|
74
|
+
when importing the schemas directly.
|
|
71
75
|
|
|
72
|
-
`generated/v1/first-value-journey.json`
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
it rather than restating the steps: each entry carries the operation, the
|
|
76
|
-
method, the path, the scopes it needs, the refusals it can produce and what to
|
|
77
|
-
do about each of them.
|
|
76
|
+
`generated/v1/first-value-journey.json` contains the expanded operation-by-operation
|
|
77
|
+
journey, including idempotent replay and destination setup. The hosted
|
|
78
|
+
quickstarts use the shorter direct-URL path. Both use the same public contracts.
|
|
78
79
|
|
|
79
80
|
MIT licensed. Issues: <https://github.com/flowxo/greatwait/issues>.
|
package/package.json
CHANGED