@remoraflow/core 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,481 @@
+declare const workflowStepSchema: import("arktype/internal/variants/object.ts").ObjectType<{
+    id: string;
+    name: string;
+    description: string;
+    nextStepId?: string | undefined;
+    type: "tool-call";
+    params: {
+        toolName: string;
+        toolInput: {
+            [x: string]: {
+                type: "literal";
+                value: unknown;
+            } | {
+                type: "jmespath";
+                expression: string;
+            } | {
+                type: "template";
+                template: string;
+            };
+        };
+    };
+} | {
+    id: string;
+    name: string;
+    description: string;
+    nextStepId?: string | undefined;
+    type: "switch-case";
+    params: {
+        switchOn: {
+            type: "literal";
+            value: unknown;
+        } | {
+            type: "jmespath";
+            expression: string;
+        } | {
+            type: "template";
+            template: string;
+        };
+        cases: {
+            value: {
+                type: "literal";
+                value: unknown;
+            } | {
+                type: "jmespath";
+                expression: string;
+            } | {
+                type: "template";
+                template: string;
+            } | {
+                type: "default";
+            };
+            branchBodyStepId: string;
+        }[];
+    };
+} | {
+    id: string;
+    name: string;
+    description: string;
+    nextStepId?: string | undefined;
+    type: "for-each";
+    params: {
+        target: {
+            type: "literal";
+            value: unknown;
+        } | {
+            type: "jmespath";
+            expression: string;
+        } | {
+            type: "template";
+            template: string;
+        };
+        itemName: string;
+        loopBodyStepId: string;
+    };
+} | {
+    id: string;
+    name: string;
+    description: string;
+    nextStepId?: string | undefined;
+    type: "llm-prompt";
+    params: {
+        prompt: string;
+        outputFormat: object;
+    };
+} | {
+    id: string;
+    name: string;
+    description: string;
+    nextStepId?: string | undefined;
+    type: "extract-data";
+    params: {
+        sourceData: {
+            type: "literal";
+            value: unknown;
+        } | {
+            type: "jmespath";
+            expression: string;
+        } | {
+            type: "template";
+            template: string;
+        };
+        outputFormat: object;
+    };
+} | {
+    id: string;
+    name: string;
+    description: string;
+    nextStepId?: string | undefined;
+    type: "sleep";
+    params: {
+        durationMs: {
+            type: "literal";
+            value: unknown;
+        } | {
+            type: "jmespath";
+            expression: string;
+        } | {
+            type: "template";
+            template: string;
+        };
+    };
+} | {
+    id: string;
+    name: string;
+    description: string;
+    nextStepId?: string | undefined;
+    type: "wait-for-condition";
+    params: {
+        conditionStepId: string;
+        condition: {
+            type: "literal";
+            value: unknown;
+        } | {
+            type: "jmespath";
+            expression: string;
+        } | {
+            type: "template";
+            template: string;
+        };
+        maxAttempts?: {
+            type: "literal";
+            value: unknown;
+        } | {
+            type: "jmespath";
+            expression: string;
+        } | {
+            type: "template";
+            template: string;
+        } | undefined;
+        intervalMs?: {
+            type: "literal";
+            value: unknown;
+        } | {
+            type: "jmespath";
+            expression: string;
+        } | {
+            type: "template";
+            template: string;
+        } | undefined;
+        backoffMultiplier?: {
+            type: "literal";
+            value: unknown;
+        } | {
+            type: "jmespath";
+            expression: string;
+        } | {
+            type: "template";
+            template: string;
+        } | undefined;
+        timeoutMs?: {
+            type: "literal";
+            value: unknown;
+        } | {
+            type: "jmespath";
+            expression: string;
+        } | {
+            type: "template";
+            template: string;
+        } | undefined;
+    };
+} | {
+    id: string;
+    name: string;
+    description: string;
+    nextStepId?: string | undefined;
+    type: "agent-loop";
+    params: {
+        instructions: string;
+        tools: string[];
+        outputFormat: object;
+        maxSteps?: {
+            type: "literal";
+            value: unknown;
+        } | {
+            type: "jmespath";
+            expression: string;
+        } | {
+            type: "template";
+            template: string;
+        } | undefined;
+    };
+} | {
+    id: string;
+    name: string;
+    description: string;
+    nextStepId?: string | undefined;
+    type: "start";
+} | {
+    id: string;
+    name: string;
+    description: string;
+    nextStepId?: string | undefined;
+    type: "end";
+    params?: {
+        output: {
+            type: "literal";
+            value: unknown;
+        } | {
+            type: "jmespath";
+            expression: string;
+        } | {
+            type: "template";
+            template: string;
+        };
+    } | undefined;
+}, {}>;
+/**
+ * ArkType schema for validating workflow definitions. Use this to validate
+ * workflow JSON before passing it to {@link compileWorkflow}.
+ */
+export declare const workflowDefinitionSchema: import("arktype/internal/variants/object.ts").ObjectType<{
+    initialStepId: string;
+    steps: ({
+        id: string;
+        name: string;
+        description: string;
+        nextStepId?: string | undefined;
+        type: "tool-call";
+        params: {
+            toolName: string;
+            toolInput: {
+                [x: string]: {
+                    type: "literal";
+                    value: unknown;
+                } | {
+                    type: "jmespath";
+                    expression: string;
+                } | {
+                    type: "template";
+                    template: string;
+                };
+            };
+        };
+    } | {
+        id: string;
+        name: string;
+        description: string;
+        nextStepId?: string | undefined;
+        type: "switch-case";
+        params: {
+            switchOn: {
+                type: "literal";
+                value: unknown;
+            } | {
+                type: "jmespath";
+                expression: string;
+            } | {
+                type: "template";
+                template: string;
+            };
+            cases: {
+                value: {
+                    type: "literal";
+                    value: unknown;
+                } | {
+                    type: "jmespath";
+                    expression: string;
+                } | {
+                    type: "template";
+                    template: string;
+                } | {
+                    type: "default";
+                };
+                branchBodyStepId: string;
+            }[];
+        };
+    } | {
+        id: string;
+        name: string;
+        description: string;
+        nextStepId?: string | undefined;
+        type: "for-each";
+        params: {
+            target: {
+                type: "literal";
+                value: unknown;
+            } | {
+                type: "jmespath";
+                expression: string;
+            } | {
+                type: "template";
+                template: string;
+            };
+            itemName: string;
+            loopBodyStepId: string;
+        };
+    } | {
+        id: string;
+        name: string;
+        description: string;
+        nextStepId?: string | undefined;
+        type: "llm-prompt";
+        params: {
+            prompt: string;
+            outputFormat: object;
+        };
+    } | {
+        id: string;
+        name: string;
+        description: string;
+        nextStepId?: string | undefined;
+        type: "extract-data";
+        params: {
+            sourceData: {
+                type: "literal";
+                value: unknown;
+            } | {
+                type: "jmespath";
+                expression: string;
+            } | {
+                type: "template";
+                template: string;
+            };
+            outputFormat: object;
+        };
+    } | {
+        id: string;
+        name: string;
+        description: string;
+        nextStepId?: string | undefined;
+        type: "sleep";
+        params: {
+            durationMs: {
+                type: "literal";
+                value: unknown;
+            } | {
+                type: "jmespath";
+                expression: string;
+            } | {
+                type: "template";
+                template: string;
+            };
+        };
+    } | {
+        id: string;
+        name: string;
+        description: string;
+        nextStepId?: string | undefined;
+        type: "wait-for-condition";
+        params: {
+            conditionStepId: string;
+            condition: {
+                type: "literal";
+                value: unknown;
+            } | {
+                type: "jmespath";
+                expression: string;
+            } | {
+                type: "template";
+                template: string;
+            };
+            maxAttempts?: {
+                type: "literal";
+                value: unknown;
+            } | {
+                type: "jmespath";
+                expression: string;
+            } | {
+                type: "template";
+                template: string;
+            } | undefined;
+            intervalMs?: {
+                type: "literal";
+                value: unknown;
+            } | {
+                type: "jmespath";
+                expression: string;
+            } | {
+                type: "template";
+                template: string;
+            } | undefined;
+            backoffMultiplier?: {
+                type: "literal";
+                value: unknown;
+            } | {
+                type: "jmespath";
+                expression: string;
+            } | {
+                type: "template";
+                template: string;
+            } | undefined;
+            timeoutMs?: {
+                type: "literal";
+                value: unknown;
+            } | {
+                type: "jmespath";
+                expression: string;
+            } | {
+                type: "template";
+                template: string;
+            } | undefined;
+        };
+    } | {
+        id: string;
+        name: string;
+        description: string;
+        nextStepId?: string | undefined;
+        type: "agent-loop";
+        params: {
+            instructions: string;
+            tools: string[];
+            outputFormat: object;
+            maxSteps?: {
+                type: "literal";
+                value: unknown;
+            } | {
+                type: "jmespath";
+                expression: string;
+            } | {
+                type: "template";
+                template: string;
+            } | undefined;
+        };
+    } | {
+        id: string;
+        name: string;
+        description: string;
+        nextStepId?: string | undefined;
+        type: "start";
+    } | {
+        id: string;
+        name: string;
+        description: string;
+        nextStepId?: string | undefined;
+        type: "end";
+        params?: {
+            output: {
+                type: "literal";
+                value: unknown;
+            } | {
+                type: "jmespath";
+                expression: string;
+            } | {
+                type: "template";
+                template: string;
+            };
+        } | undefined;
+    })[];
+    inputSchema?: object | undefined;
+    outputSchema?: object | undefined;
+}, {}>;
+/**
+ * A single step in a workflow. Each step has a type that determines its behavior:
+ * - `start` — entry point, declares input schema
+ * - `tool-call` — calls a tool with literal or expression-based arguments
+ * - `llm-prompt` — prompts an LLM with template string interpolation
+ * - `extract-data` — uses an LLM to extract structured data from unstructured source
+ * - `switch-case` — branches to different step chains based on an expression value
+ * - `for-each` — iterates over an array, executing a chain of steps per item
+ * - `agent-loop` — delegates work to an autonomous agent with its own tool-calling loop (use sparingly)
+ * - `end` — terminates a branch, optionally producing workflow output
+ */
+export type WorkflowStep = typeof workflowStepSchema.infer;
+/**
+ * A complete workflow definition. Contains an initial step ID and an ordered list of steps.
+ * Execution flow is determined by each step's `nextStepId` and branching/looping logic,
+ * not by the order of steps in the array.
+ */
+export type WorkflowDefinition = typeof workflowDefinitionSchema.infer;
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAmMA,QAAA,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAgBvB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAiBnC,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,kBAAkB,CAAC,KAAK,CAAC;AAE3D;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,wBAAwB,CAAC,KAAK,CAAC"}

package/package.json

@@ -0,0 +1,54 @@
+{
+	"name": "@remoraflow/core",
+	"version": "0.1.0",
+	"description": "A workflow DSL for agents — compile, execute, and visualize agent workflows",
+	"publishConfig": {
+		"access": "public"
+	},
+	"homepage": "https://isaacwasserman.github.io/remora/",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/isaacwasserman/remora",
+		"directory": "packages/core"
+	},
+	"license": "GPL-3.0",
+	"type": "module",
+	"exports": {
+		".": {
+			"import": "./dist/lib.js",
+			"types": "./dist/lib.d.ts"
+		}
+	},
+	"files": [
+		"dist",
+		"README.md",
+		"LICENSE"
+	],
+	"scripts": {
+		"build": "bun scripts/build.ts",
+		"prepublishOnly": "bun run build",
+		"test": "bun test",
+		"test:e2e": "bun test src/e2e.ts"
+	},
+	"dependencies": {
+		"arktype": "^2.1.29",
+		"@jmespath-community/jmespath": "^1.3.0"
+	},
+	"peerDependencies": {
+		"ai": "^6.0.0",
+		"@ai-sdk/provider-utils": "^4.0.0"
+	},
+	"peerDependenciesMeta": {
+		"ai": {
+			"optional": true
+		},
+		"@ai-sdk/provider-utils": {
+			"optional": true
+		}
+	},
+	"devDependencies": {
+		"@ai-sdk/anthropic": "^3.0.50",
+		"@ai-sdk/openai": "^3.0.37",
+		"ai": "^6.0.105"
+	}
+}