@remoraflow/core 0.1.0

package/dist/example-tasks.d.ts

@@ -0,0 +1,834 @@
+export declare const EXAMPLE_TASKS: {
+    "ticket-review": {
+        availableTools: {
+            "get-open-tickets": import("ai").Tool<object, {
+                tickets: {
+                    id: string;
+                    subject: string;
+                    body: string;
+                    submittedAt: string;
+                }[];
+            }>;
+            "page-on-call-engineer": import("ai").Tool<{
+                ticketId: string;
+                reason: string;
+            }, {
+                success: boolean;
+            }>;
+            "send-slack-message": import("ai").Tool<{
+                channel: string;
+                message: string;
+            }, {
+                success: boolean;
+            }>;
+        };
+        task: string;
+    };
+    "order-fulfillment": {
+        availableTools: {
+            "get-pending-orders": import("ai").Tool<object, {
+                orders: {
+                    id: string;
+                    customerEmail: string;
+                    items: {
+                        itemId: string;
+                        name: string;
+                        quantity: number;
+                    }[];
+                }[];
+            }>;
+            "check-inventory": import("ai").Tool<{
+                itemId: string;
+            }, {
+                available: boolean;
+                stock: number;
+            }>;
+            "reserve-inventory": import("ai").Tool<{
+                itemId: string;
+                quantity: number;
+            }, {
+                reservationId: string;
+            }>;
+            "create-shipment": import("ai").Tool<{
+                orderId: string;
+                reservationId: string;
+            }, {
+                trackingNumber: string;
+            }>;
+            "notify-customer": import("ai").Tool<{
+                email: string;
+                subject: string;
+                body: string;
+            }, {
+                sent: boolean;
+            }>;
+            "flag-for-review": import("ai").Tool<{
+                orderId: string;
+                reason: string;
+            }, {
+                flagged: boolean;
+            }>;
+        };
+        task: string;
+        workflow: {
+            initialStepId: string;
+            steps: ({
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    toolName: string;
+                    toolInput: {
+                        itemId?: undefined;
+                        quantity?: undefined;
+                        orderId?: undefined;
+                        reservationId?: undefined;
+                        email?: undefined;
+                        subject?: undefined;
+                        body?: undefined;
+                        reason?: undefined;
+                    };
+                    target?: undefined;
+                    itemName?: undefined;
+                    loopBodyStepId?: undefined;
+                    switchOn?: undefined;
+                    cases?: undefined;
+                };
+                nextStepId: string;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    target: {
+                        type: string;
+                        expression: string;
+                    };
+                    itemName: string;
+                    loopBodyStepId: string;
+                    toolName?: undefined;
+                    toolInput?: undefined;
+                    switchOn?: undefined;
+                    cases?: undefined;
+                };
+                nextStepId: string;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    toolName: string;
+                    toolInput: {
+                        itemId: {
+                            type: string;
+                            expression: string;
+                        };
+                        quantity?: undefined;
+                        orderId?: undefined;
+                        reservationId?: undefined;
+                        email?: undefined;
+                        subject?: undefined;
+                        body?: undefined;
+                        reason?: undefined;
+                    };
+                    target?: undefined;
+                    itemName?: undefined;
+                    loopBodyStepId?: undefined;
+                    switchOn?: undefined;
+                    cases?: undefined;
+                };
+                nextStepId: string;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    switchOn: {
+                        type: string;
+                        expression: string;
+                    };
+                    cases: ({
+                        value: {
+                            type: string;
+                            value: boolean;
+                        };
+                        branchBodyStepId: string;
+                    } | {
+                        value: {
+                            type: string;
+                            value?: undefined;
+                        };
+                        branchBodyStepId: string;
+                    })[];
+                    toolName?: undefined;
+                    toolInput?: undefined;
+                    target?: undefined;
+                    itemName?: undefined;
+                    loopBodyStepId?: undefined;
+                };
+                nextStepId?: undefined;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    toolName: string;
+                    toolInput: {
+                        itemId: {
+                            type: string;
+                            expression: string;
+                        };
+                        quantity: {
+                            type: string;
+                            expression: string;
+                        };
+                        orderId?: undefined;
+                        reservationId?: undefined;
+                        email?: undefined;
+                        subject?: undefined;
+                        body?: undefined;
+                        reason?: undefined;
+                    };
+                    target?: undefined;
+                    itemName?: undefined;
+                    loopBodyStepId?: undefined;
+                    switchOn?: undefined;
+                    cases?: undefined;
+                };
+                nextStepId: string;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    toolName: string;
+                    toolInput: {
+                        orderId: {
+                            type: string;
+                            expression: string;
+                        };
+                        reservationId: {
+                            type: string;
+                            expression: string;
+                        };
+                        itemId?: undefined;
+                        quantity?: undefined;
+                        email?: undefined;
+                        subject?: undefined;
+                        body?: undefined;
+                        reason?: undefined;
+                    };
+                    target?: undefined;
+                    itemName?: undefined;
+                    loopBodyStepId?: undefined;
+                    switchOn?: undefined;
+                    cases?: undefined;
+                };
+                nextStepId: string;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    toolName: string;
+                    toolInput: {
+                        email: {
+                            type: string;
+                            expression: string;
+                            value?: undefined;
+                        };
+                        subject: {
+                            type: string;
+                            value: string;
+                        };
+                        body: {
+                            type: string;
+                            expression: string;
+                            value?: undefined;
+                        };
+                        itemId?: undefined;
+                        quantity?: undefined;
+                        orderId?: undefined;
+                        reservationId?: undefined;
+                        reason?: undefined;
+                    };
+                    target?: undefined;
+                    itemName?: undefined;
+                    loopBodyStepId?: undefined;
+                    switchOn?: undefined;
+                    cases?: undefined;
+                };
+                nextStepId?: undefined;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    toolName: string;
+                    toolInput: {
+                        orderId: {
+                            type: string;
+                            expression: string;
+                        };
+                        reason: {
+                            type: string;
+                            value: string;
+                        };
+                        itemId?: undefined;
+                        quantity?: undefined;
+                        reservationId?: undefined;
+                        email?: undefined;
+                        subject?: undefined;
+                        body?: undefined;
+                    };
+                    target?: undefined;
+                    itemName?: undefined;
+                    loopBodyStepId?: undefined;
+                    switchOn?: undefined;
+                    cases?: undefined;
+                };
+                nextStepId: string;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    toolName: string;
+                    toolInput: {
+                        email: {
+                            type: string;
+                            expression: string;
+                            value?: undefined;
+                        };
+                        subject: {
+                            type: string;
+                            value: string;
+                        };
+                        body: {
+                            type: string;
+                            value: string;
+                            expression?: undefined;
+                        };
+                        itemId?: undefined;
+                        quantity?: undefined;
+                        orderId?: undefined;
+                        reservationId?: undefined;
+                        reason?: undefined;
+                    };
+                    target?: undefined;
+                    itemName?: undefined;
+                    loopBodyStepId?: undefined;
+                    switchOn?: undefined;
+                    cases?: undefined;
+                };
+                nextStepId?: undefined;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    toolName: string;
+                    toolInput: {
+                        email: {
+                            type: string;
+                            value: string;
+                            expression?: undefined;
+                        };
+                        subject: {
+                            type: string;
+                            value: string;
+                        };
+                        body: {
+                            type: string;
+                            value: string;
+                            expression?: undefined;
+                        };
+                        itemId?: undefined;
+                        quantity?: undefined;
+                        orderId?: undefined;
+                        reservationId?: undefined;
+                        reason?: undefined;
+                    };
+                    target?: undefined;
+                    itemName?: undefined;
+                    loopBodyStepId?: undefined;
+                    switchOn?: undefined;
+                    cases?: undefined;
+                };
+                nextStepId: string;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params?: undefined;
+                nextStepId?: undefined;
+            })[];
+        };
+    };
+    "content-moderation": {
+        availableTools: {
+            "fetch-submissions": import("ai").Tool<object, {
+                submissions: {
+                    id: string;
+                    userId: string;
+                    text: string;
+                }[];
+            }>;
+            "publish-content": import("ai").Tool<{
+                submissionId: string;
+            }, {
+                publishedUrl: string;
+            }>;
+            "quarantine-content": import("ai").Tool<{
+                submissionId: string;
+                reason: string;
+            }, {
+                quarantineId: string;
+            }>;
+            "send-notification": import("ai").Tool<{
+                userId: string;
+                message: string;
+            }, {
+                sent: boolean;
+            }>;
+        };
+        task: string;
+        workflow: {
+            initialStepId: string;
+            steps: ({
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    toolName: string;
+                    toolInput: {
+                        submissionId?: undefined;
+                        userId?: undefined;
+                        message?: undefined;
+                        reason?: undefined;
+                    };
+                    target?: undefined;
+                    itemName?: undefined;
+                    loopBodyStepId?: undefined;
+                    sourceData?: undefined;
+                    outputFormat?: undefined;
+                    switchOn?: undefined;
+                    cases?: undefined;
+                    prompt?: undefined;
+                };
+                nextStepId: string;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    target: {
+                        type: string;
+                        expression: string;
+                    };
+                    itemName: string;
+                    loopBodyStepId: string;
+                    toolName?: undefined;
+                    toolInput?: undefined;
+                    sourceData?: undefined;
+                    outputFormat?: undefined;
+                    switchOn?: undefined;
+                    cases?: undefined;
+                    prompt?: undefined;
+                };
+                nextStepId: string;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    sourceData: {
+                        type: string;
+                        expression: string;
+                    };
+                    outputFormat: {
+                        type: string;
+                        properties: {
+                            action: {
+                                type: string;
+                                enum: string[];
+                            };
+                            reason: {
+                                type: string;
+                            };
+                            totalProcessed?: undefined;
+                            summary?: undefined;
+                        };
+                        required: string[];
+                    };
+                    toolName?: undefined;
+                    toolInput?: undefined;
+                    target?: undefined;
+                    itemName?: undefined;
+                    loopBodyStepId?: undefined;
+                    switchOn?: undefined;
+                    cases?: undefined;
+                    prompt?: undefined;
+                };
+                nextStepId: string;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    switchOn: {
+                        type: string;
+                        expression: string;
+                    };
+                    cases: ({
+                        value: {
+                            type: string;
+                            value: string;
+                        };
+                        branchBodyStepId: string;
+                    } | {
+                        value: {
+                            type: string;
+                            value?: undefined;
+                        };
+                        branchBodyStepId: string;
+                    })[];
+                    toolName?: undefined;
+                    toolInput?: undefined;
+                    target?: undefined;
+                    itemName?: undefined;
+                    loopBodyStepId?: undefined;
+                    sourceData?: undefined;
+                    outputFormat?: undefined;
+                    prompt?: undefined;
+                };
+                nextStepId?: undefined;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    toolName: string;
+                    toolInput: {
+                        submissionId: {
+                            type: string;
+                            expression: string;
+                        };
+                        userId?: undefined;
+                        message?: undefined;
+                        reason?: undefined;
+                    };
+                    target?: undefined;
+                    itemName?: undefined;
+                    loopBodyStepId?: undefined;
+                    sourceData?: undefined;
+                    outputFormat?: undefined;
+                    switchOn?: undefined;
+                    cases?: undefined;
+                    prompt?: undefined;
+                };
+                nextStepId: string;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    toolName: string;
+                    toolInput: {
+                        userId: {
+                            type: string;
+                            expression: string;
+                        };
+                        message: {
+                            type: string;
+                            value: string;
+                        };
+                        submissionId?: undefined;
+                        reason?: undefined;
+                    };
+                    target?: undefined;
+                    itemName?: undefined;
+                    loopBodyStepId?: undefined;
+                    sourceData?: undefined;
+                    outputFormat?: undefined;
+                    switchOn?: undefined;
+                    cases?: undefined;
+                    prompt?: undefined;
+                };
+                nextStepId?: undefined;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    toolName: string;
+                    toolInput: {
+                        submissionId: {
+                            type: string;
+                            expression: string;
+                        };
+                        reason: {
+                            type: string;
+                            expression: string;
+                            value?: undefined;
+                        };
+                        userId?: undefined;
+                        message?: undefined;
+                    };
+                    target?: undefined;
+                    itemName?: undefined;
+                    loopBodyStepId?: undefined;
+                    sourceData?: undefined;
+                    outputFormat?: undefined;
+                    switchOn?: undefined;
+                    cases?: undefined;
+                    prompt?: undefined;
+                };
+                nextStepId: string;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    toolName: string;
+                    toolInput: {
+                        submissionId: {
+                            type: string;
+                            expression: string;
+                        };
+                        reason: {
+                            type: string;
+                            value: string;
+                            expression?: undefined;
+                        };
+                        userId?: undefined;
+                        message?: undefined;
+                    };
+                    target?: undefined;
+                    itemName?: undefined;
+                    loopBodyStepId?: undefined;
+                    sourceData?: undefined;
+                    outputFormat?: undefined;
+                    switchOn?: undefined;
+                    cases?: undefined;
+                    prompt?: undefined;
+                };
+                nextStepId?: undefined;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    prompt: string;
+                    outputFormat: {
+                        type: string;
+                        properties: {
+                            totalProcessed: {
+                                type: string;
+                            };
+                            summary: {
+                                type: string;
+                            };
+                            action?: undefined;
+                            reason?: undefined;
+                        };
+                        required: string[];
+                    };
+                    toolName?: undefined;
+                    toolInput?: undefined;
+                    target?: undefined;
+                    itemName?: undefined;
+                    loopBodyStepId?: undefined;
+                    sourceData?: undefined;
+                    switchOn?: undefined;
+                    cases?: undefined;
+                };
+                nextStepId: string;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params?: undefined;
+                nextStepId?: undefined;
+            })[];
+        };
+    };
+    "course-assignment": {
+        availableTools: {
+            "get-students": import("ai").Tool<object, {
+                students: {
+                    id: string;
+                    name: string;
+                    grade: string;
+                }[];
+            }>;
+            "get-available-courses": import("ai").Tool<object, {
+                courses: {
+                    id: string;
+                    name: string;
+                    capacity: number;
+                }[];
+            }>;
+            "enroll-student": import("ai").Tool<{
+                studentId: string;
+                courseId: string;
+            }, {
+                enrolled: boolean;
+                enrollmentId: string;
+            }>;
+            "send-schedule": import("ai").Tool<{
+                studentId: string;
+                courseSummary: string;
+            }, {
+                sent: boolean;
+            }>;
+        };
+        task: string;
+        workflow: {
+            initialStepId: string;
+            steps: ({
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    toolName: string;
+                    toolInput: {
+                        studentId?: undefined;
+                        courseId?: undefined;
+                        courseSummary?: undefined;
+                    };
+                    target?: undefined;
+                    itemName?: undefined;
+                    loopBodyStepId?: undefined;
+                    prompt?: undefined;
+                    outputFormat?: undefined;
+                };
+                nextStepId: string;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    target: {
+                        type: string;
+                        expression: string;
+                    };
+                    itemName: string;
+                    loopBodyStepId: string;
+                    toolName?: undefined;
+                    toolInput?: undefined;
+                    prompt?: undefined;
+                    outputFormat?: undefined;
+                };
+                nextStepId: string;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    prompt: string;
+                    outputFormat: {
+                        type: string;
+                        properties: {
+                            selectedCourseIds: {
+                                type: string;
+                                items: {
+                                    type: string;
+                                };
+                            };
+                        };
+                        required: string[];
+                    };
+                    toolName?: undefined;
+                    toolInput?: undefined;
+                    target?: undefined;
+                    itemName?: undefined;
+                    loopBodyStepId?: undefined;
+                };
+                nextStepId: string;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    toolName: string;
+                    toolInput: {
+                        studentId: {
+                            type: string;
+                            expression: string;
+                        };
+                        courseId: {
+                            type: string;
+                            expression: string;
+                        };
+                        courseSummary?: undefined;
+                    };
+                    target?: undefined;
+                    itemName?: undefined;
+                    loopBodyStepId?: undefined;
+                    prompt?: undefined;
+                    outputFormat?: undefined;
+                };
+                nextStepId?: undefined;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params: {
+                    toolName: string;
+                    toolInput: {
+                        studentId: {
+                            type: string;
+                            expression: string;
+                        };
+                        courseSummary: {
+                            type: string;
+                            value: string;
+                        };
+                        courseId?: undefined;
+                    };
+                    target?: undefined;
+                    itemName?: undefined;
+                    loopBodyStepId?: undefined;
+                    prompt?: undefined;
+                    outputFormat?: undefined;
+                };
+                nextStepId?: undefined;
+            } | {
+                id: string;
+                name: string;
+                description: string;
+                type: string;
+                params?: undefined;
+                nextStepId?: undefined;
+            })[];
+        };
+    };
+};
+//# sourceMappingURL=example-tasks.d.ts.map