@botonic/plugin-ai-agents 0.48.1 → 0.49.0-alpha.0

package/lib/cjs/structured-output/index.d.ts

@@ -5,78 +5,25 @@ export interface Output {
 }
 export declare const OutputSchema: z.ZodObject<{
     messages: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
-        type: z.ZodEnum<["text"]>;
+        type: z.ZodLiteral<import("@botonic/core").OutputMessageType.Text>;
         content: z.ZodObject<{
             text: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            text: string;
-        }, {
-            text: string;
-        }>;
-    }, "strip", z.ZodTypeAny, {
-        type: "text";
-        content: {
-            text: string;
-        };
-    }, {
-        type: "text";
-        content: {
-            text: string;
-        };
-    }>, z.ZodObject<{
-        type: z.ZodEnum<["textWithButtons"]>;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<import("@botonic/core").OutputMessageType.TextWithButtons>;
         content: z.ZodObject<{
             text: z.ZodString;
             buttons: z.ZodArray<z.ZodObject<{
                 text: z.ZodString;
                 url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-                target: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodEnum<["_blank", "_self"]>>>>;
-            }, "strip", z.ZodTypeAny, {
-                text: string;
-                url?: string | null | undefined;
-                target?: "_blank" | "_self" | null | undefined;
-            }, {
-                text: string;
-                url?: string | null | undefined;
-                target?: "_blank" | "_self" | null | undefined;
-            }>, "many">;
-        }, "strip", z.ZodTypeAny, {
-            text: string;
-            buttons: {
-                text: string;
-                url?: string | null | undefined;
-                target?: "_blank" | "_self" | null | undefined;
-            }[];
-        }, {
-            text: string;
-            buttons: {
-                text: string;
-                url?: string | null | undefined;
-                target?: "_blank" | "_self" | null | undefined;
-            }[];
-        }>;
-    }, "strip", z.ZodTypeAny, {
-        type: "textWithButtons";
-        content: {
-            text: string;
-            buttons: {
-                text: string;
-                url?: string | null | undefined;
-                target?: "_blank" | "_self" | null | undefined;
-            }[];
-        };
-    }, {
-        type: "textWithButtons";
-        content: {
-            text: string;
-            buttons: {
-                text: string;
-                url?: string | null | undefined;
-                target?: "_blank" | "_self" | null | undefined;
-            }[];
-        };
-    }>, z.ZodObject<{
-        type: z.ZodEnum<["carousel"]>;
+                target: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodEnum<{
+                    _blank: "_blank";
+                    _self: "_self";
+                }>>>>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<import("@botonic/core").OutputMessageType.Carousel>;
         content: z.ZodObject<{
             text: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             elements: z.ZodArray<z.ZodObject<{
@@ -86,292 +33,43 @@ export declare const OutputSchema: z.ZodObject<{
                 button: z.ZodObject<{
                     text: z.ZodString;
                     url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-                }, "strip", z.ZodTypeAny, {
-                    text: string;
-                    url?: string | null | undefined;
-                }, {
-                    text: string;
-                    url?: string | null | undefined;
-                }>;
-            }, "strip", z.ZodTypeAny, {
-                title: string;
-                subtitle: string;
-                image: string;
-                button: {
-                    text: string;
-                    url?: string | null | undefined;
-                };
-            }, {
-                title: string;
-                subtitle: string;
-                image: string;
-                button: {
-                    text: string;
-                    url?: string | null | undefined;
-                };
-            }>, "many">;
-        }, "strip", z.ZodTypeAny, {
-            elements: {
-                title: string;
-                subtitle: string;
-                image: string;
-                button: {
-                    text: string;
-                    url?: string | null | undefined;
-                };
-            }[];
-            text?: string | null | undefined;
-        }, {
-            elements: {
-                title: string;
-                subtitle: string;
-                image: string;
-                button: {
-                    text: string;
-                    url?: string | null | undefined;
-                };
-            }[];
-            text?: string | null | undefined;
-        }>;
-    }, "strip", z.ZodTypeAny, {
-        type: "carousel";
-        content: {
-            elements: {
-                title: string;
-                subtitle: string;
-                image: string;
-                button: {
-                    text: string;
-                    url?: string | null | undefined;
-                };
-            }[];
-            text?: string | null | undefined;
-        };
-    }, {
-        type: "carousel";
-        content: {
-            elements: {
-                title: string;
-                subtitle: string;
-                image: string;
-                button: {
-                    text: string;
-                    url?: string | null | undefined;
-                };
-            }[];
-            text?: string | null | undefined;
-        };
-    }>, z.ZodObject<{
-        type: z.ZodEnum<["exit"]>;
-    }, "strip", z.ZodTypeAny, {
-        type: "exit";
-    }, {
-        type: "exit";
-    }>, z.ZodObject<{
-        type: z.ZodEnum<["botExecutor"]>;
+                }, z.core.$strip>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<import("@botonic/core").OutputMessageType.Exit>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<import("@botonic/core").OutputMessageType.BotExecutor>;
         content: z.ZodObject<{
             text: z.ZodString;
             buttons: z.ZodArray<z.ZodObject<{
                 text: z.ZodString;
                 payload: z.ZodString;
-            }, "strip", z.ZodTypeAny, {
-                text: string;
-                payload: string;
-            }, {
-                text: string;
-                payload: string;
-            }>, "many">;
-        }, "strip", z.ZodTypeAny, {
-            text: string;
-            buttons: {
-                text: string;
-                payload: string;
-            }[];
-        }, {
-            text: string;
-            buttons: {
-                text: string;
-                payload: string;
-            }[];
-        }>;
-    }, "strip", z.ZodTypeAny, {
-        type: "botExecutor";
-        content: {
-            text: string;
-            buttons: {
-                text: string;
-                payload: string;
-            }[];
-        };
-    }, {
-        type: "botExecutor";
-        content: {
-            text: string;
-            buttons: {
-                text: string;
-                payload: string;
-            }[];
-        };
-    }>]>, "many">;
-}, "strip", z.ZodTypeAny, {
-    messages: ({
-        type: "botExecutor";
-        content: {
-            text: string;
-            buttons: {
-                text: string;
-                payload: string;
-            }[];
-        };
-    } | {
-        type: "carousel";
-        content: {
-            elements: {
-                title: string;
-                subtitle: string;
-                image: string;
-                button: {
-                    text: string;
-                    url?: string | null | undefined;
-                };
-            }[];
-            text?: string | null | undefined;
-        };
-    } | {
-        type: "exit";
-    } | {
-        type: "text";
-        content: {
-            text: string;
-        };
-    } | {
-        type: "textWithButtons";
-        content: {
-            text: string;
-            buttons: {
-                text: string;
-                url?: string | null | undefined;
-                target?: "_blank" | "_self" | null | undefined;
-            }[];
-        };
-    })[];
-}, {
-    messages: ({
-        type: "botExecutor";
-        content: {
-            text: string;
-            buttons: {
-                text: string;
-                payload: string;
-            }[];
-        };
-    } | {
-        type: "carousel";
-        content: {
-            elements: {
-                title: string;
-                subtitle: string;
-                image: string;
-                button: {
-                    text: string;
-                    url?: string | null | undefined;
-                };
-            }[];
-            text?: string | null | undefined;
-        };
-    } | {
-        type: "exit";
-    } | {
-        type: "text";
-        content: {
-            text: string;
-        };
-    } | {
-        type: "textWithButtons";
-        content: {
-            text: string;
-            buttons: {
-                text: string;
-                url?: string | null | undefined;
-                target?: "_blank" | "_self" | null | undefined;
-            }[];
-        };
-    })[];
-}>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>]>>;
+}, z.core.$strip>;
 export declare function getOutputSchema(externalOutputMessagesSchemas: z.ZodObject<any>[]): z.ZodObject<{
-    messages: z.ZodArray<z.ZodUnion<[z.ZodObject<{
-        type: z.ZodEnum<["text"]>;
+    messages: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+        type: z.ZodLiteral<import("@botonic/core").OutputMessageType.Text>;
         content: z.ZodObject<{
             text: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            text: string;
-        }, {
-            text: string;
-        }>;
-    }, "strip", z.ZodTypeAny, {
-        type: "text";
-        content: {
-            text: string;
-        };
-    }, {
-        type: "text";
-        content: {
-            text: string;
-        };
-    }>, z.ZodObject<{
-        type: z.ZodEnum<["textWithButtons"]>;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<import("@botonic/core").OutputMessageType.TextWithButtons>;
         content: z.ZodObject<{
             text: z.ZodString;
             buttons: z.ZodArray<z.ZodObject<{
                 text: z.ZodString;
                 url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-                target: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodEnum<["_blank", "_self"]>>>>;
-            }, "strip", z.ZodTypeAny, {
-                text: string;
-                url?: string | null | undefined;
-                target?: "_blank" | "_self" | null | undefined;
-            }, {
-                text: string;
-                url?: string | null | undefined;
-                target?: "_blank" | "_self" | null | undefined;
-            }>, "many">;
-        }, "strip", z.ZodTypeAny, {
-            text: string;
-            buttons: {
-                text: string;
-                url?: string | null | undefined;
-                target?: "_blank" | "_self" | null | undefined;
-            }[];
-        }, {
-            text: string;
-            buttons: {
-                text: string;
-                url?: string | null | undefined;
-                target?: "_blank" | "_self" | null | undefined;
-            }[];
-        }>;
-    }, "strip", z.ZodTypeAny, {
-        type: "textWithButtons";
-        content: {
-            text: string;
-            buttons: {
-                text: string;
-                url?: string | null | undefined;
-                target?: "_blank" | "_self" | null | undefined;
-            }[];
-        };
-    }, {
-        type: "textWithButtons";
-        content: {
-            text: string;
-            buttons: {
-                text: string;
-                url?: string | null | undefined;
-                target?: "_blank" | "_self" | null | undefined;
-            }[];
-        };
-    }>, z.ZodObject<{
-        type: z.ZodEnum<["carousel"]>;
+                target: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodEnum<{
+                    _blank: "_blank";
+                    _self: "_self";
+                }>>>>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<import("@botonic/core").OutputMessageType.Carousel>;
         content: z.ZodObject<{
             text: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             elements: z.ZodArray<z.ZodObject<{
@@ -381,223 +79,20 @@ export declare function getOutputSchema(externalOutputMessagesSchemas: z.ZodObje
                 button: z.ZodObject<{
                     text: z.ZodString;
                     url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-                }, "strip", z.ZodTypeAny, {
-                    text: string;
-                    url?: string | null | undefined;
-                }, {
-                    text: string;
-                    url?: string | null | undefined;
-                }>;
-            }, "strip", z.ZodTypeAny, {
-                title: string;
-                subtitle: string;
-                image: string;
-                button: {
-                    text: string;
-                    url?: string | null | undefined;
-                };
-            }, {
-                title: string;
-                subtitle: string;
-                image: string;
-                button: {
-                    text: string;
-                    url?: string | null | undefined;
-                };
-            }>, "many">;
-        }, "strip", z.ZodTypeAny, {
-            elements: {
-                title: string;
-                subtitle: string;
-                image: string;
-                button: {
-                    text: string;
-                    url?: string | null | undefined;
-                };
-            }[];
-            text?: string | null | undefined;
-        }, {
-            elements: {
-                title: string;
-                subtitle: string;
-                image: string;
-                button: {
-                    text: string;
-                    url?: string | null | undefined;
-                };
-            }[];
-            text?: string | null | undefined;
-        }>;
-    }, "strip", z.ZodTypeAny, {
-        type: "carousel";
-        content: {
-            elements: {
-                title: string;
-                subtitle: string;
-                image: string;
-                button: {
-                    text: string;
-                    url?: string | null | undefined;
-                };
-            }[];
-            text?: string | null | undefined;
-        };
-    }, {
-        type: "carousel";
-        content: {
-            elements: {
-                title: string;
-                subtitle: string;
-                image: string;
-                button: {
-                    text: string;
-                    url?: string | null | undefined;
-                };
-            }[];
-            text?: string | null | undefined;
-        };
-    }>, z.ZodObject<{
-        type: z.ZodEnum<["exit"]>;
-    }, "strip", z.ZodTypeAny, {
-        type: "exit";
-    }, {
-        type: "exit";
-    }>, z.ZodObject<{
-        type: z.ZodEnum<["botExecutor"]>;
+                }, z.core.$strip>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<import("@botonic/core").OutputMessageType.Exit>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<import("@botonic/core").OutputMessageType.BotExecutor>;
         content: z.ZodObject<{
             text: z.ZodString;
             buttons: z.ZodArray<z.ZodObject<{
                 text: z.ZodString;
                 payload: z.ZodString;
-            }, "strip", z.ZodTypeAny, {
-                text: string;
-                payload: string;
-            }, {
-                text: string;
-                payload: string;
-            }>, "many">;
-        }, "strip", z.ZodTypeAny, {
-            text: string;
-            buttons: {
-                text: string;
-                payload: string;
-            }[];
-        }, {
-            text: string;
-            buttons: {
-                text: string;
-                payload: string;
-            }[];
-        }>;
-    }, "strip", z.ZodTypeAny, {
-        type: "botExecutor";
-        content: {
-            text: string;
-            buttons: {
-                text: string;
-                payload: string;
-            }[];
-        };
-    }, {
-        type: "botExecutor";
-        content: {
-            text: string;
-            buttons: {
-                text: string;
-                payload: string;
-            }[];
-        };
-    }>, ...z.ZodObject<any, z.UnknownKeysParam, z.ZodTypeAny, {
-        [x: string]: any;
-    }, {
-        [x: string]: any;
-    }>[]]>, "many">;
-}, "strip", z.ZodTypeAny, {
-    messages: ({
-        type: "botExecutor";
-        content: {
-            text: string;
-            buttons: {
-                text: string;
-                payload: string;
-            }[];
-        };
-    } | {
-        type: "carousel";
-        content: {
-            elements: {
-                title: string;
-                subtitle: string;
-                image: string;
-                button: {
-                    text: string;
-                    url?: string | null | undefined;
-                };
-            }[];
-            text?: string | null | undefined;
-        };
-    } | {
-        type: "exit";
-    } | {
-        type: "text";
-        content: {
-            text: string;
-        };
-    } | {
-        type: "textWithButtons";
-        content: {
-            text: string;
-            buttons: {
-                text: string;
-                url?: string | null | undefined;
-                target?: "_blank" | "_self" | null | undefined;
-            }[];
-        };
-    } | {
-        [x: string]: any;
-    })[];
-}, {
-    messages: ({
-        type: "botExecutor";
-        content: {
-            text: string;
-            buttons: {
-                text: string;
-                payload: string;
-            }[];
-        };
-    } | {
-        type: "carousel";
-        content: {
-            elements: {
-                title: string;
-                subtitle: string;
-                image: string;
-                button: {
-                    text: string;
-                    url?: string | null | undefined;
-                };
-            }[];
-            text?: string | null | undefined;
-        };
-    } | {
-        type: "exit";
-    } | {
-        type: "text";
-        content: {
-            text: string;
-        };
-    } | {
-        type: "textWithButtons";
-        content: {
-            text: string;
-            buttons: {
-                text: string;
-                url?: string | null | undefined;
-                target?: "_blank" | "_self" | null | undefined;
-            }[];
-        };
-    } | {
-        [x: string]: any;
-    })[];
-}>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>, ...z.ZodObject<any, z.core.$strip>[]]>>;
+}, z.core.$strip>;
+export declare function getOutputInstructions(): string;

package/lib/cjs/structured-output/index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OutputSchema = void 0;
 exports.getOutputSchema = getOutputSchema;
+exports.getOutputInstructions = getOutputInstructions;
 const zod_1 = require("zod");
 const bot_executor_1 = require("./bot-executor");
 const carousel_1 = require("./carousel");
@@ -25,4 +26,18 @@ function getOutputSchema(externalOutputMessagesSchemas) {
         messages: zod_1.z.array(zod_1.z.union([...baseMessageSchemas, ...externalOutputMessagesSchemas])),
     });
 }
+function getOutputInstructions() {
+    const example = {
+        messages: [
+            {
+                type: 'text',
+                content: {
+                    text: 'Hello, how can I help you today?',
+                },
+            },
+        ],
+    };
+    const output = `Return a JSON that follows the output schema provided. Never return multiple output schemas concatenated by a line break.\n<example>\n${JSON.stringify(example)}\n</example>`;
+    return `<output>\n${output}\n</output>`;
+}
 //# sourceMappingURL=index.js.map

package/lib/cjs/structured-output/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/structured-output/index.ts"],"names":[],"mappings":";;;AAyBA,0CAQC;AAhCD,6BAAuB;AACvB,iDAAkD;AAClD,yCAA2C;AAC3C,iCAAmC;AACnC,iCAAmC;AACnC,2DAA2D;AAM3D,MAAM,kBAAkB,GAAG;IACzB,iBAAU;IACV,yCAAqB;IACrB,yBAAc;IACd,iBAAU;IACV,gCAAiB;CACT,CAAA;AACG,QAAA,YAAY,GAAG,OAAC;KAC1B,MAAM,CAAC;IACN,QAAQ,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;CAC/C,CAAC;KACD,QAAQ,CAAC,qCAAqC,CAAC,CAAA;AAElD,SAAgB,eAAe,CAC7B,6BAAiD;IAEjD,OAAO,OAAC,CAAC,MAAM,CAAC;QACd,QAAQ,EAAE,OAAC,CAAC,KAAK,CACf,OAAC,CAAC,KAAK,CAAC,CAAC,GAAG,kBAAkB,EAAE,GAAG,6BAA6B,CAAC,CAAC,CACnE;KACF,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/structured-output/index.ts"],"names":[],"mappings":";;;AAyBA,0CAQC;AAED,sDAaC;AA/CD,6BAAuB;AACvB,iDAAkD;AAClD,yCAA2C;AAC3C,iCAAmC;AACnC,iCAAmC;AACnC,2DAA2D;AAM3D,MAAM,kBAAkB,GAAG;IACzB,iBAAU;IACV,yCAAqB;IACrB,yBAAc;IACd,iBAAU;IACV,gCAAiB;CACT,CAAA;AACG,QAAA,YAAY,GAAG,OAAC;KAC1B,MAAM,CAAC;IACN,QAAQ,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;CAC/C,CAAC;KACD,QAAQ,CAAC,qCAAqC,CAAC,CAAA;AAElD,SAAgB,eAAe,CAC7B,6BAAiD;IAEjD,OAAO,OAAC,CAAC,MAAM,CAAC;QACd,QAAQ,EAAE,OAAC,CAAC,KAAK,CACf,OAAC,CAAC,KAAK,CAAC,CAAC,GAAG,kBAAkB,EAAE,GAAG,6BAA6B,CAAC,CAAC,CACnE;KACF,CAAC,CAAA;AACJ,CAAC;AAED,SAAgB,qBAAqB;IACnC,MAAM,OAAO,GAAG;QACd,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE;oBACP,IAAI,EAAE,kCAAkC;iBACzC;aACF;SACF;KACF,CAAA;IACD,MAAM,MAAM,GAAG,yIAAyI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,cAAc,CAAA;IAC7L,OAAO,aAAa,MAAM,aAAa,CAAA;AACzC,CAAC"}