@trigora/sdk 0.5.0 → 0.6.0

package/README.md

@@ -86,18 +86,21 @@ Use webhook triggers for hosted HTTP entrypoints.
 import { defineFlow } from '@trigora/sdk';
 
 export default defineFlow({
-  id: 'ping',
-  trigger: { type: 'webhook' },
+  id: 'stripe-webhook',
+  trigger: { type: 'webhook', route: '/hooks/stripe' },
   async run() {
     return 'pong';
   },
 });
 ```
 
+`id` is the internal flow identifier used by the CLI. `route` is the optional public hosted webhook path.
+When `route` is omitted, hosted ingress defaults to `/${id}`.
+
 You can also include an optional event name:
 
 ```ts
-trigger: { type: 'webhook', event: 'orders.created' }
+trigger: { type: 'webhook', event: 'orders.created', route: '/hooks/orders' }
 ```
 
 ### Cron
@@ -139,7 +142,7 @@ import { defineFlow } from '@trigora/sdk';
 
 export default defineFlow({
   id: 'status',
-  trigger: { type: 'webhook' },
+  trigger: { type: 'webhook', route: '/status' },
   async run() {
     return {
       ok: true,
@@ -189,10 +192,19 @@ For webhook flows, request metadata may also be available on `event.request`, in
 Trigora includes a small helper for verifying Stripe webhook signatures:
 
 ```ts
+import { defineFlow } from '@trigora/sdk';
 import { verifyStripeWebhook } from '@trigora/sdk/stripe';
 
-const stripeEvent = await verifyStripeWebhook(event, {
-  secret: ctx.env.STRIPE_WEBHOOK_SECRET,
+export default defineFlow({
+  id: 'stripe-webhook',
+  trigger: { type: 'webhook', route: '/hooks/stripe' },
+  async run(event, ctx) {
+    await verifyStripeWebhook(event, {
+      secret: ctx.env.STRIPE_WEBHOOK_SECRET,
+    });
+
+    return { ok: true };
+  },
 });
 ```
 
@@ -205,10 +217,19 @@ Production Stripe webhooks should verify signatures before trusting payloads.
 Trigora includes a small helper for verifying GitHub webhook signatures:
 
 ```ts
+import { defineFlow } from '@trigora/sdk';
 import { verifyGitHubWebhook } from '@trigora/sdk/github';
 
-const githubEvent = await verifyGitHubWebhook(event, {
-  secret: ctx.env.GITHUB_WEBHOOK_SECRET,
+export default defineFlow({
+  id: 'github-webhook',
+  trigger: { type: 'webhook', route: '/hooks/github' },
+  async run(event, ctx) {
+    await verifyGitHubWebhook(event, {
+      secret: ctx.env.GITHUB_WEBHOOK_SECRET,
+    });
+
+    return { ok: true };
+  },
 });
 ```
 

package/dist/defineFlow.d.ts

@@ -9,12 +9,16 @@ type DefineFlowOutput<TPayload, TEnv extends Record<string, string>, TTrigger ex
  * Define a Trigora flow.
  *
  * Flows are plain TypeScript modules with three core parts:
- * - `id`: the source identifier for the flow in your project
+ * - `id`: the internal identifier for the flow in your project
  * - `trigger`: how the flow is invoked
  * - `run`: the function that executes when the flow is triggered
  *
  * `run` receives the incoming `event` and a `ctx` object with logging and environment access.
  *
+ * For webhook flows, `trigger.route` controls the public hosted path and defaults to `/${id}`.
+ * This is separate from the flow `id`, which is still what the CLI uses for commands like
+ * `trigora deploy hello` or `trigora flows inspect hello`.
+ *
  * Webhook flows can return HTTP-friendly values:
  * - `Response`
  * - plain objects / arrays / numbers / booleans
@@ -26,8 +30,8 @@ type DefineFlowOutput<TPayload, TEnv extends Record<string, string>, TTrigger ex
  * @example
  * ```ts
  * export default defineFlow({
- *   id: 'hello',
- *   trigger: { type: 'webhook' },
+ *   id: 'stripe-webhook',
+ *   trigger: { type: 'webhook', route: '/hooks/stripe' },
  *   async run(event, ctx) {
  *     await ctx.log.info('Received event', event.payload);
  *     return { ok: true };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trigora/sdk",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/trigora-dev/trigora"
@@ -45,7 +45,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@trigora/contracts": "0.5.5"
+    "@trigora/contracts": "0.6.5"
   },
   "devDependencies": {
     "tsup": "^8.5.1"