@simpleapps-com/augur-api 2026.9.4 → 2026.9.6

package/SKILL.md

@@ -7,7 +7,7 @@ description: |
 
 # Augur API Client - Agent Guide
 
-TypeScript client library for 27 Augur microservices via a unified API.
+TypeScript client library for 26 Augur microservices via a unified API.
 
 ## Ecosystem Entry Point
 
@@ -135,11 +135,12 @@ agr-site             →  api.agrSite
 
 ```
 src/services/{service}/
-├── client.ts          # {Service}Client class with all resources
-├── resources/*.ts     # Resource implementations
-└── schemas/*.ts       # Zod validation schemas
+├── client.ts          # Generated {Service}Client (proxy-backed resources)
+└── generated/*.ts     # Generated endpoints, types, and valibot schemas
 ```
 
+Every client also inherits `healthCheck`, `ping`, and `whoami` (each with a `…Data` twin, called as `.get()`) from `BaseServiceClient` in `src/core/base-client.ts`.
+
 **To verify exact property names:** Read `src/services/{service}/client.ts`
 
 ## Strategy for Agents
@@ -193,20 +194,23 @@ response.message   // Status message
 response.status    // HTTP status code
 ```
 
-## Zod Schemas
+## Types and Validation
 
-All request params and response data use Zod schemas:
+Request params and responses are validated with Valibot schemas. Types are exported per service as
+a namespace (`{Service}Types`): params are `{Chain}{Action}Params`, request bodies
+`{Chain}{Action}Body`, response data `{Chain}{Action}Data`.
 
 ```typescript
-import { InvMastListParams, InvMast } from '@simpleapps-com/augur-api';
+import type { ItemsTypes } from '@simpleapps-com/augur-api';
 
 // Type-safe params
-const params: InvMastListParams = { limit: 10, offset: 0 };
-const response = await api.items.invMast.list(params);
+const params: ItemsTypes.InvMastFaqListParams = { limit: 10, offset: 0 };
+const response = await api.items.invMast.faq.list(invMastUid, params);
 
-// Type-safe response
-for (const item of response.data) {
-  console.log(item.itemId);  // IDE autocomplete works
+// Type-safe response data
+const faqs: ItemsTypes.InvMastFaqListData = response.data;
+for (const faq of faqs) {
+  console.log(faq.question);  // IDE autocomplete works
 }
 ```
 
@@ -218,4 +222,4 @@ for (const item of response.data) {
 | Service: brand-folder | api.brandFolder | api.brand_folder |
 | Resource: inv-mast | .invMast | .inv_mast |
 | Method: invMastUid | invMastUid | inv_mast_uid |
-| Validation | Zod | Pydantic v2 |
+| Validation | Valibot | Pydantic v2 |