@trigora/sdk 0.2.0 → 0.3.0

package/README.md

@@ -25,9 +25,7 @@ export default defineFlow({
   id: 'hello',
   trigger: { type: 'manual' },
   async run(event, ctx) {
-    await ctx.log.info('Hello from Trigora', {
-      payload: event.payload,
-    });
+    await ctx.log.info('Hello from Trigora', event.payload);
   },
 });
 ```
@@ -75,9 +73,7 @@ export default defineFlow({
   id: 'hello',
   trigger: { type: 'manual' },
   async run(event, ctx) {
-    await ctx.log.info('Triggered manually', {
-      payload: event.payload,
-    });
+    await ctx.log.info('Triggered manually', event.payload);
   },
 });
 ```
@@ -115,9 +111,7 @@ export default defineFlow({
   id: 'nightly-sync',
   trigger: { type: 'cron', cron: '0 2 * * *' },
   async run(event, ctx) {
-    await ctx.log.info('Nightly sync started', {
-      payload: event.payload,
-    });
+    await ctx.log.info('Nightly sync started', event.payload);
   },
 });
 ```
@@ -170,15 +164,25 @@ This matches how Trigora uses them:
 Flows receive an event object:
 
 ```ts
-type FlowEvent<TPayload = unknown> = {
+type FlowEvent<TPayload = JsonValue> = {
   id: string;
   type: string;
   timestamp: string;
   payload: TPayload;
+  request?: {
+    headers: Record<string, string>;
+    method: string;
+    url: string;
+    rawBody: string;
+  };
 };
 ```
 
-In local CLI runs, the payload comes from your JSON payload file when one is provided.
+In local manual runs, the payload comes from your JSON payload file when one is provided. In local webhook dev and deployed webhook flows, the payload is the parsed JSON request body.
+
+If you do not provide your own payload type, `event.payload` defaults to `JsonValue`.
+
+For webhook flows, request metadata may also be available on `event.request`, including headers, method, URL, and the raw request body. `event.request.rawBody` is useful when you want to verify webhook signatures yourself.
 
 ## Context
 
@@ -211,7 +215,10 @@ That means most flow authors can stay entirely within `@trigora/sdk`.
 ## Typical Workflow
 
 1. Define a flow with `defineFlow`
-2. Run it locally with `trigora trigger` or `trigora dev`
+2. Run it locally with:
+   - `trigora trigger hello --payload payload.json` for one-off runs
+   - `trigora dev hello --payload payload.json` for manual or payload watch mode
+   - `trigora dev stripe-checkout` for a local webhook server
 3. Deploy webhook flows with `trigora deploy`
 4. Manage hosted flows with `trigora flows`
 

package/dist/defineFlow.d.ts

@@ -1,4 +1,4 @@
-import type { FlowDefinition, Trigger } from '@trigora/contracts';
+import type { CronFlowDefinition, JsonValue, ManualFlowDefinition, WebhookFlowDefinition } from '@trigora/contracts';
 /**
  * Define a Trigora flow.
  *
@@ -23,10 +23,12 @@ import type { FlowDefinition, Trigger } from '@trigora/contracts';
  *   id: 'hello',
  *   trigger: { type: 'webhook' },
  *   async run(event, ctx) {
- *     await ctx.log.info('Received event', { payload: event.payload });
+ *     await ctx.log.info('Received event', event.payload);
  *     return { ok: true };
  *   },
  * });
  * ```
  */
-export declare function defineFlow<TPayload = unknown, TEnv extends Record<string, string> = Record<string, string>, TTrigger extends Trigger = Trigger>(flow: FlowDefinition<TPayload, TEnv, TTrigger>): FlowDefinition<TPayload, TEnv, TTrigger>;
+export declare function defineFlow<TPayload = JsonValue, TEnv extends Record<string, string> = Record<string, string>>(flow: ManualFlowDefinition<TPayload, TEnv>): ManualFlowDefinition<TPayload, TEnv>;
+export declare function defineFlow<TPayload = JsonValue, TEnv extends Record<string, string> = Record<string, string>>(flow: WebhookFlowDefinition<TPayload, TEnv>): WebhookFlowDefinition<TPayload, TEnv>;
+export declare function defineFlow<TPayload = JsonValue, TEnv extends Record<string, string> = Record<string, string>>(flow: CronFlowDefinition<TPayload, TEnv>): CronFlowDefinition<TPayload, TEnv>;

package/package.json

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