@simpleapps-com/augur-api 2026.9.7 → 2026.10.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.
Files changed (15) hide show
  1. package/README.md +2 -0
  2. package/SKILL.md +7 -5
  3. package/dist/client-8B1GuTFg.d.mts +33942 -0
  4. package/dist/client-8B1GuTFg.d.ts +33942 -0
  5. package/dist/index.d.mts +15 -5
  6. package/dist/index.d.ts +15 -5
  7. package/dist/index.js +5286 -1274
  8. package/dist/index.js.map +1 -1
  9. package/dist/index.mjs +5286 -1274
  10. package/dist/index.mjs.map +1 -1
  11. package/dist/testing.d.mts +1 -1
  12. package/dist/testing.d.ts +1 -1
  13. package/package.json +5 -5
  14. package/dist/client-BbTOVex4.d.mts +0 -9268
  15. package/dist/client-BbTOVex4.d.ts +0 -9268
package/README.md CHANGED
@@ -8,6 +8,8 @@ TypeScript client library for Augur microservices.
8
8
  npm install @simpleapps-com/augur-api
9
9
  ```
10
10
 
11
+ **Pin the version.** Versions are CalVer (`YYYY.MM.PATCH`), and a month roll can carry breaking changes when the Augur API changes upstream, but npm treats `^2026.9.7` as accepting `2026.10.0`. Use an exact version or `~` (patch updates only), and read the [release notes](https://github.com/simpleapps-com/augur-api/releases) before moving to a new month.
12
+
11
13
  ## Quick Start
12
14
 
13
15
  ```typescript
package/SKILL.md CHANGED
@@ -110,9 +110,11 @@ Apply same pattern to any service:
110
110
 
111
111
  | Resource | URL Pattern | Use When |
112
112
  |----------|-------------|----------|
113
- | **llms.txt** | `https://{service}.augur-api.com/llms.txt` | Discover endpoints |
114
- | **endpoints.jsonl** | `https://{service}.augur-api.com/endpoints.jsonl` | Get parameters |
115
- | **openapi.json** | `https://{service}.augur-api.com/openapi.json` | Full schemas |
113
+ | **endpoints.jsonl** | `https://{service}.augur-api.com/endpoints.jsonl` | **Start here.** One JSON line per endpoint: method, path, path params and query params, each with type and required flag. Grep it for a path; for a GET that line is all you need. It has no request or response bodies |
114
+ | **openapi.json** | `https://{service}.augur-api.com/openapi.json` | Request and response bodies field by field, descriptions, formats, documented errors |
115
+ | **llms.txt** | `https://{service}.augur-api.com/llms.txt` | Plain-text endpoint list and the other Augur services |
116
+
117
+ The generated code carries the same information: every method's doc lists its summary, documented errors, path and query params, body and response fields with their meaning, and a link to its operation in `openapi.json`.
116
118
 
117
119
  **Central Reference:** https://augur-api.info
118
120
 
@@ -147,8 +149,8 @@ Every client also inherits `healthCheck`, `ping`, and `whoami` (each with a `…
147
149
 
148
150
  1. **Start** - `new AugurAPI({ siteId, bearerToken })`
149
151
  2. **Discover** - Fetch any `llms.txt`, find "Other Services"
150
- 3. **Find endpoints** - Fetch target service's `llms.txt`
151
- 4. **Get parameters** - Fetch `endpoints.jsonl` for method signatures
152
+ 3. **Find the endpoint and its params** - Grep the service's `endpoints.jsonl`; for a GET, that line is everything you need
153
+ 4. **Bodies** - For POST/PUT bodies and response fields, read the method's doc in `src/services/{service}/generated/types.ts` (or the `openapi.json` operation it links)
152
154
  5. **Convert to code** - Apply the path→property pattern
153
155
  6. **Verify** - Check `src/services/{service}/client.ts` if unsure
154
156