spaps-types 1.4.2 → 1.5.1

package/README.md

@@ -24,6 +24,7 @@ yarn add spaps-types
 | One source of truth for app contracts | Shared auth, payment, entitlement, issue-reporting, and user shapes |
 | Lightweight runtime checks | Guards for roles, permissions, severities, and chain types |
 | Structured validation | Zod-backed secure-message schema helpers |
+| Webhook consumers | Generated event catalog, envelope parser, and signature verifier |
 | Docs tooling contracts | Types for `docs/manifest.json` style metadata |
 
 ## Quick Example
@@ -83,6 +84,28 @@ messageSchema.parse({
 });
 ```
 
+## Webhook Event Helpers
+
+```ts
+import {
+  SPAPS_WEBHOOK_EVENT_CATALOG,
+  parseSpapsWebhookEnvelope,
+  verifySpapsWebhookSignature,
+} from "spaps-types";
+
+verifySpapsWebhookSignature({
+  body: rawBody,
+  signature: request.headers["x-spaps-signature"],
+  secret: webhookSecret,
+});
+
+const event = parseSpapsWebhookEnvelope(rawBody);
+console.log(SPAPS_WEBHOOK_EVENT_CATALOG[event.type].schemaVersion);
+```
+
+Use the raw request body for signature verification. The catalog is generated
+from the Python server event registry.
+
 ## Export Groups
 
 | Group | Examples |
@@ -90,9 +113,10 @@ messageSchema.parse({
 | Core models | `Application`, `User`, `UserProfile`, `UserWallet` |
 | Auth and sessions | `TokenPayload`, `RefreshTokenPayload`, `TokenPair`, `AuthResponse` |
 | Payments | `CheckoutSession`, `Subscription`, `Product`, `Price`, `UsageBalance` |
-| Entitlements | `Entitlement`, `ResourceType` |
+| Entitlements | `Entitlement`, `ResourceType`, `ProjectGrant`, `ListProjectGrantsResponse`, `ProjectAccessCheckResponse` |
 | Issue reporting | `IssueReport`, `IssueReportTarget`, `IssueReportAttachmentOut`, `IssueReportListResult` |
 | Secure messages | `SecureMessage`, `CreateSecureMessageRequest`, schema helpers |
+| Webhooks | `SPAPS_WEBHOOK_EVENT_CATALOG`, `SpapsWebhookEnvelope`, `verifySpapsWebhookSignature` |
 | Docs tooling | `DocsManifest`, `DocsManifestEndpoint`, related manifest types |
 
 ## Runtime Guards
@@ -104,6 +128,7 @@ Common helpers include:
 - `isValidSeverity`
 - `isValidAlertSeverity`
 - `isValidChainType`
+- `isSpapsWebhookEventType`
 
 ## Validation
 

package/dist/docs.d.ts

@@ -3,12 +3,34 @@ export interface DocsManifestEndpointSDKRef {
     method: string;
     file?: string;
 }
+export interface DocsManifestEndpointAuth {
+    auth_type: string;
+    required: boolean;
+    schemes: string[];
+    api_key: {
+        required: boolean;
+        accepted: string[];
+    };
+    jwt: {
+        required: boolean;
+        optional: boolean;
+    };
+    roles: string[];
+    provider_signature?: {
+        required: boolean;
+        scheme: string;
+    };
+}
 export interface DocsManifestEndpoint {
     method: string;
     path: string;
     docs: string[];
     tests: string[];
     tags: string[];
+    auth: DocsManifestEndpointAuth;
+    rate_tier: string;
+    publishable_scope: string[] | null;
+    entitlement_key: string | null;
     category?: string;
     authentication?: string;
     description?: string;

package/dist/docs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"docs.d.ts","sourceRoot":"","sources":["../src/docs.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,0BAA0B,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,oBAAoB;IACnC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE;QACb,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACnC;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,QAAQ,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACjC,SAAS,EAAE,oBAAoB,EAAE,CAAC;IAClC,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC7C,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;CAC1D"}
+{"version":3,"file":"docs.d.ts","sourceRoot":"","sources":["../src/docs.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,EAAE;QACP,QAAQ,EAAE,OAAO,CAAC;QAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;KACpB,CAAC;IACF,GAAG,EAAE;QACH,QAAQ,EAAE,OAAO,CAAC;QAClB,QAAQ,EAAE,OAAO,CAAC;KACnB,CAAC;IACF,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,kBAAkB,CAAC,EAAE;QACnB,QAAQ,EAAE,OAAO,CAAC;QAClB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,IAAI,EAAE,wBAAwB,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACnC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,0BAA0B,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,oBAAoB;IACnC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE;QACb,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACnC;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,QAAQ,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACjC,SAAS,EAAE,oBAAoB,EAAE,CAAC;IAClC,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC7C,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;CAC1D"}