yieldstar 0.1.5-alpha.1 → 0.2.0-alpha.0

package/dist/index.js

@@ -1,32 +1,30 @@
 // @bun
 // src/exports/sdk-local.ts
-import { randomUUID } from "crypto";
+var {randomUUIDv7 } = globalThis.Bun;
 function createLocalSdk(invoker) {
   return {
-    async trigger(workflowId, opts) {
-      const { workflowParams } = opts ?? {};
-      const executionId = opts?.executionId ?? randomUUID();
-      await invoker.execute({
-        executionId,
-        workflowId,
-        params: workflowParams
-      });
-      return { executionId };
+    async trigger(event) {
+      const executionEvent = {
+        executionId: event.executionId ?? randomUUIDv7(),
+        workflowId: event.workflowId,
+        params: event.params
+      };
+      await invoker.execute(executionEvent);
+      return { executionId: executionEvent.executionId };
     },
-    async triggerAndWait(workflowId, opts) {
-      const { workflowParams } = opts ?? {};
-      const executionId = opts?.executionId ?? randomUUID();
+    async triggerAndWait(event) {
+      const executionId = event.executionId ?? randomUUIDv7();
       const workflowCompletePromise = new Promise((resolve) => {
         invoker.workflowEndEmitter.once(executionId, resolve);
       });
-      await this.trigger(workflowId, { executionId, workflowParams });
+      await this.trigger({ ...event, executionId });
       return workflowCompletePromise;
     }
   };
 }
 // src/exports/sdk-http.ts
+var {randomUUIDv7: randomUUIDv72 } = globalThis.Bun;
 import { deserializeError as deserializeError2, isErrorLike as isErrorLike2 } from "serialize-error";
-import { randomUUID as randomUUID2 } from "crypto";
 
 // src/internal/serialise.ts
 import {
@@ -78,16 +76,15 @@ function deserializeStepResponse(jsonString) {
 function createHttpSdkFactory() {
   return (params) => {
     return {
-      async trigger(workflowId, opts) {
-        const { workflowParams } = opts ?? {};
-        const executionId = opts?.executionId ?? randomUUID2();
+      async trigger(event) {
+        const executionEvent = {
+          executionId: event?.executionId ?? randomUUIDv72(),
+          workflowId: event?.workflowId,
+          params: event?.params
+        };
         const res = await fetch(`${params.host}:${params.port}/trigger`, {
           method: "POST",
-          body: JSON.stringify({
-            executionId,
-            workflowId,
-            params: workflowParams
-          })
+          body: JSON.stringify(executionEvent)
         });
         if (res.ok) {
           return res.json();
@@ -95,10 +92,8 @@ function createHttpSdkFactory() {
           throw res.statusText;
         }
       },
-      async triggerAndWait(workflowId, opts) {
-        const { workflowParams } = opts ?? {};
-        const executionId = opts?.executionId ?? randomUUID2();
-        await this.trigger(workflowId, { executionId, workflowParams });
+      async triggerAndWait(event) {
+        const { executionId } = await this.trigger(event);
         const result = await fetch(`${params.host}:${params.port}/events`, {
           method: "POST",
           body: JSON.stringify({ executionId })
@@ -230,10 +225,10 @@ import {
   StepInvalid,
   WorkflowResult as WorkflowResult2
 } from "@yieldstar/core";
-function createWorkflow(workflowFn) {
-  return async function* workflowGenerator(params) {
-    const { executionId, heapClient, logger } = params;
-    const workflowIterator = workflowFn(stepRunner, logger);
+function workflow(workflowFn) {
+  return async function* workflowGenerator({ event, heapClient, logger }) {
+    const workflowIterator = workflowFn(stepRunner, event, logger);
+    const { executionId } = event;
     let keylessStepIndex = -1;
     let iteratorResult = null;
     let nextIteratorResult = null;
@@ -326,7 +321,9 @@ function createWorkflow(workflowFn) {
     throw new Error("Critical error");
   };
 }
+var createWorkflow = workflow;
 export {
+  workflow,
   createWorkflowRouter,
   createWorkflow,
   createLocalSdk,

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "yieldstar",
-  "version": "0.1.5-alpha.1",
+  "version": "0.2.0-alpha.0",
   "type": "module",
   "main": "dist/index.js",
   "types": "src/index.ts",
   "scripts": {
-    "build": "bun build src/index.ts --outfile dist/index.js --target bun --packages=external"
+    "build": "bun build src/index.ts --outfile dist/index.js --target bun --packages=external",
+    "check": "tsc --noEmit"
   },
   "dependencies": {
     "serialize-error": "^11.0.3"

package/src/exports/sdk-http.ts

@@ -1,52 +1,43 @@
 import type {
+  EventParamsOf,
   WorkflowRouter,
   WorkflowGeneratorReturnType,
+  TriggerEvent,
+  ExecutionEvent,
 } from "@yieldstar/core";
+import { randomUUIDv7 } from "bun";
 import { deserializeError, isErrorLike } from "serialize-error";
-import { randomUUID } from "node:crypto";
 import { errorWithOriginalStack } from "../internal/serialise";
 
 export function createHttpSdkFactory<W extends WorkflowRouter>() {
   return (params: { host: string; port: number }) => {
     return {
-      async trigger<K extends keyof W>(
-        workflowId: K,
-        opts?: {
-          executionId?: string;
-          workflowParams?: Parameters<W[K]>[0] extends never
-            ? never
-            : Parameters<W[K]>[0];
-        }
+      async trigger<K extends string & keyof W>(
+        event: TriggerEvent<K, EventParamsOf<W[K]>>
       ) {
-        const { workflowParams } = opts ?? {};
-        const executionId = opts?.executionId ?? randomUUID();
+        const executionEvent: ExecutionEvent = {
+          executionId: event?.executionId ?? randomUUIDv7(),
+          workflowId: event?.workflowId as string,
+          params: event?.params,
+        };
+
         const res = await fetch(`${params.host}:${params.port}/trigger`, {
           method: "POST",
-          body: JSON.stringify({
-            executionId,
-            workflowId,
-            params: workflowParams,
-          }),
+          body: JSON.stringify(executionEvent),
         });
+
         if (res.ok) {
           return res.json() as Promise<{ executionId: string }>;
         } else {
           throw res.statusText;
         }
       },
-      async triggerAndWait<K extends keyof W>(
-        workflowId: K,
-        opts?: {
-          executionId?: string;
-          workflowParams?: Parameters<W[K]>[0] extends never
-            ? never
-            : Parameters<W[K]>[0];
-        }
+      async triggerAndWait<K extends string & keyof W>(
+        event: TriggerEvent<K, EventParamsOf<W[K]>>
       ) {
-        const { workflowParams } = opts ?? {};
-        const executionId = opts?.executionId ?? randomUUID();
         // todo: add timeout and cancel request
-        await this.trigger(workflowId, { executionId, workflowParams });
+        const { executionId } = await this.trigger(event);
+
         // todo: set up subscription first (maybe just use ws)
         const result = await fetch(`${params.host}:${params.port}/events`, {
           method: "POST",

package/src/exports/sdk-local.ts

@@ -1,47 +1,36 @@
 import type {
+  EventParamsOf,
   WorkflowRouter,
   WorkflowGeneratorReturnType,
   WorkflowInvoker,
+  TriggerEvent,
+  ExecutionEvent,
 } from "@yieldstar/core";
-import { randomUUID } from "node:crypto";
+import { randomUUIDv7 } from "bun";
 
 export function createLocalSdk<W extends WorkflowRouter>(
   invoker: WorkflowInvoker
 ) {
   return {
-    async trigger<K extends keyof W>(
-      workflowId: K,
-      opts?: {
-        executionId?: string;
-        workflowParams?: Parameters<W[K]>[0] extends never
-          ? never
-          : Parameters<W[K]>[0];
-      }
+    async trigger<K extends string & keyof W>(
+      event: TriggerEvent<K, EventParamsOf<W[K]>>
     ) {
-      const { workflowParams } = opts ?? {};
-      const executionId = opts?.executionId ?? randomUUID();
-      await invoker.execute({
-        executionId,
-        workflowId: workflowId as string,
-        params: workflowParams,
-      });
-      return { executionId };
+      const executionEvent: ExecutionEvent = {
+        executionId: event.executionId ?? randomUUIDv7(),
+        workflowId: event.workflowId,
+        params: event.params,
+      };
+      await invoker.execute(executionEvent);
+      return { executionId: executionEvent.executionId };
     },
-    async triggerAndWait<K extends keyof W>(
-      workflowId: K,
-      opts?: {
-        executionId?: string;
-        workflowParams?: Parameters<W[K]>[0] extends never
-          ? never
-          : Parameters<W[K]>[0];
-      }
+    async triggerAndWait<K extends string & keyof W>(
+      event: TriggerEvent<K, EventParamsOf<W[K]>>
     ) {
-      const { workflowParams } = opts ?? {};
-      const executionId = opts?.executionId ?? randomUUID();
+      const executionId = event.executionId ?? randomUUIDv7();
       const workflowCompletePromise = new Promise((resolve) => {
         invoker.workflowEndEmitter.once(executionId, resolve);
       });
-      await this.trigger(workflowId, { executionId, workflowParams });
+      await this.trigger({ ...event, executionId });
       return workflowCompletePromise as Promise<
         WorkflowGeneratorReturnType<W[K]>
       >;

package/src/exports/workflow.ts

@@ -1,5 +1,5 @@
 import type { Logger } from "pino";
-import type { WorkflowGenerator } from "@yieldstar/core";
+import type { ExecutionEvent, WorkflowGenerator } from "@yieldstar/core";
 import type { StepRunner } from "../internal/step-runner";
 import { isIterable } from "../internal/utils";
 import {
@@ -18,22 +18,23 @@ import {
   WorkflowResult,
 } from "@yieldstar/core";
 
-export type WorkflowFn<T> = (
+export type WorkflowFn<EventParams, Result> = (
   step: StepRunner,
+  event: ExecutionEvent<EventParams>,
   logger: Logger
-) => AsyncGenerator<any, T>;
+) => AsyncGenerator<any, Result>;
 
-export function createWorkflow<T>(
-  workflowFn: WorkflowFn<T>
-): WorkflowGenerator<T> {
+export function workflow<EventParams = void, Result = void>(
+  workflowFn: WorkflowFn<EventParams, Result>
+): WorkflowGenerator<EventParams, Result> {
   /**
    * @description Advances workflow steps, handling any workflow logic, and
    * yielding control to a workflow executor to do async work
    * @yields {StepResponse}
    */
-  return async function* workflowGenerator(params) {
-    const { executionId, heapClient, logger } = params;
-    const workflowIterator = workflowFn(stepRunner, logger);
+  return async function* workflowGenerator({ event, heapClient, logger }) {
+    const workflowIterator = workflowFn(stepRunner, event, logger);
+    const { executionId } = event;
 
     let keylessStepIndex = -1;
     let iteratorResult: IteratorResult<any> | null = null;
@@ -225,3 +226,5 @@ export function createWorkflow<T>(
     throw new Error("Critical error");
   };
 }
+
+export const createWorkflow = workflow;

package/src/index.ts

@@ -2,5 +2,5 @@ export { createLocalSdk } from "./exports/sdk-local";
 export { createHttpSdkFactory } from "./exports/sdk-http";
 export { createWorkflowRouter } from "./exports/router";
 export { RetryableError } from "./exports/errors";
-export { createWorkflow } from "./exports/workflow";
+export { createWorkflow, workflow } from "./exports/workflow";
 export type { WorkflowFn } from "./exports/workflow";