agents 0.20.1 → 0.22.0

package/dist/schedule.d.ts

@@ -1,130 +1,61 @@
-import { z } from "zod";
+import {
+  ParsedSchedule,
+  getSchedulePrompt,
+  scheduleSchema
+} from "./schedules/parser.js";
 
 //#region src/schedule.d.ts
-/**
- * Get the schedule prompt for a given event
- * @param event - The event to get the schedule prompt for
- * @returns The schedule prompt
- */
-declare function getSchedulePrompt(event: { date: Date }): string;
 /**
  * @deprecated this has been renamed to getSchedulePrompt, and unstable_getSchedulePrompt will be removed in the next major version
  * @param event - The event to get the schedule prompt for
  * @returns The schedule prompt
  */
 declare function unstable_getSchedulePrompt(event: { date: Date }): string;
-/**
- * The schema for parsing natural language scheduling requests.
- *
- * @example
- * ```typescript
- * import { generateObject } from "ai";
- * import { scheduleSchema, getSchedulePrompt } from "agents/schedule";
- *
- * const result = await generateObject({
- *   model,
- *   prompt: `${getSchedulePrompt({ date: new Date() })} Input: "${userInput}"`,
- *   schema: scheduleSchema,
- *   // Required for OpenAI to avoid strict JSON schema validation errors
- *   providerOptions: {
- *     openai: { strictJsonSchema: false }
- *   }
- * });
- * ```
- *
- * @remarks
- * When using this schema with OpenAI models via the AI SDK, you must pass
- * `providerOptions: { openai: { strictJsonSchema: false } }` to `generateObject`.
- * This is because the schema uses a discriminated union which is not compatible
- * with OpenAI's strict structured outputs mode.
- */
-declare const scheduleSchema: z.ZodObject<
-  {
-    description: z.ZodString;
-    when: z.ZodDiscriminatedUnion<
-      [
-        z.ZodObject<
-          {
-            type: z.ZodLiteral<"scheduled">;
-            date: z.ZodString;
-          },
-          z.core.$strip
-        >,
-        z.ZodObject<
-          {
-            type: z.ZodLiteral<"delayed">;
-            delayInSeconds: z.ZodNumber;
-          },
-          z.core.$strip
-        >,
-        z.ZodObject<
-          {
-            type: z.ZodLiteral<"cron">;
-            cron: z.ZodString;
-          },
-          z.core.$strip
-        >,
-        z.ZodObject<
-          {
-            type: z.ZodLiteral<"no-schedule">;
-          },
-          z.core.$strip
-        >
-      ],
-      "type"
-    >;
-  },
-  z.core.$strip
->;
-/**
- * The type for the schedule prompt
- */
-type Schedule = z.infer<typeof scheduleSchema>;
 /**
  * @deprecated this has been renamed to scheduleSchema, and unstable_scheduleSchema will be removed in the next major version
  * @returns The schedule schema
  */
-declare const unstable_scheduleSchema: z.ZodObject<
+declare const unstable_scheduleSchema: import("zod").ZodObject<
   {
-    description: z.ZodString;
-    when: z.ZodDiscriminatedUnion<
+    description: import("zod").ZodString;
+    when: import("zod").ZodDiscriminatedUnion<
       [
-        z.ZodObject<
+        import("zod").ZodObject<
           {
-            type: z.ZodLiteral<"scheduled">;
-            date: z.ZodString;
+            type: import("zod").ZodLiteral<"scheduled">;
+            date: import("zod").ZodString;
           },
-          z.core.$strip
+          import("zod/v4/core").$strip
         >,
-        z.ZodObject<
+        import("zod").ZodObject<
           {
-            type: z.ZodLiteral<"delayed">;
-            delayInSeconds: z.ZodNumber;
+            type: import("zod").ZodLiteral<"delayed">;
+            delayInSeconds: import("zod").ZodNumber;
           },
-          z.core.$strip
+          import("zod/v4/core").$strip
         >,
-        z.ZodObject<
+        import("zod").ZodObject<
           {
-            type: z.ZodLiteral<"cron">;
-            cron: z.ZodString;
+            type: import("zod").ZodLiteral<"cron">;
+            cron: import("zod").ZodString;
           },
-          z.core.$strip
+          import("zod/v4/core").$strip
         >,
-        z.ZodObject<
+        import("zod").ZodObject<
           {
-            type: z.ZodLiteral<"no-schedule">;
+            type: import("zod").ZodLiteral<"no-schedule">;
           },
-          z.core.$strip
+          import("zod/v4/core").$strip
         >
       ],
       "type"
     >;
   },
-  z.core.$strip
+  import("zod/v4/core").$strip
 >;
 //#endregion
 export {
-  Schedule,
+  type ParsedSchedule as Schedule,
   getSchedulePrompt,
   scheduleSchema,
   unstable_getSchedulePrompt,

package/dist/schedule.js

@@ -1,59 +1,5 @@
-import { z } from "zod";
+import { getSchedulePrompt, scheduleSchema } from "./schedules/parser.js";
 //#region src/schedule.ts
-/**
-* Get the schedule prompt for a given event
-* @param event - The event to get the schedule prompt for
-* @returns The schedule prompt
-*/
-function getSchedulePrompt(event) {
-	return `
-[Schedule Parser Component]
-
-Current time: ${event.date.toUTCString()}
-
-This component parses natural language scheduling requests into a structured format. It extracts:
-1. A clean task description (without timing information)
-2. Scheduling details in one of these formats:
-   - scheduled: Specific date/time events
-   - delayed: Relative time delays (in seconds)
-   - cron: Recurring patterns
-   - no-schedule: Tasks without timing
-
-Rules:
-- Task descriptions should be clean and focused on the action
-- Use numbers (0-6) for days in cron patterns (0=Sunday)
-- For recurring tasks, use standard cron syntax
-- For relative times, convert to seconds
-- For specific dates, use the current time as reference
-
-Example outputs:
-{
-  "description": "meeting with team",
-  "when": {
-    "type": "scheduled",
-    "date": "tomorrow at 14:00"
-  }
-}
-
-{
-  "description": "backup database",
-  "when": {
-    "type": "cron",
-    "cron": "0 0 * * *"
-  }
-}
-
-{
-  "description": "send report",
-  "when": {
-    "type": "delayed",
-    "delayInSeconds": 1800
-  }
-}
-
-[End Schedule Parser Component]
-`;
-}
 let didWarnAboutUnstableGetSchedulePrompt = false;
 /**
 * @deprecated this has been renamed to getSchedulePrompt, and unstable_getSchedulePrompt will be removed in the next major version
@@ -68,49 +14,6 @@ function unstable_getSchedulePrompt(event) {
 	return getSchedulePrompt(event);
 }
 /**
-* The schema for parsing natural language scheduling requests.
-*
-* @example
-* ```typescript
-* import { generateObject } from "ai";
-* import { scheduleSchema, getSchedulePrompt } from "agents/schedule";
-*
-* const result = await generateObject({
-*   model,
-*   prompt: `${getSchedulePrompt({ date: new Date() })} Input: "${userInput}"`,
-*   schema: scheduleSchema,
-*   // Required for OpenAI to avoid strict JSON schema validation errors
-*   providerOptions: {
-*     openai: { strictJsonSchema: false }
-*   }
-* });
-* ```
-*
-* @remarks
-* When using this schema with OpenAI models via the AI SDK, you must pass
-* `providerOptions: { openai: { strictJsonSchema: false } }` to `generateObject`.
-* This is because the schema uses a discriminated union which is not compatible
-* with OpenAI's strict structured outputs mode.
-*/
-const scheduleSchema = z.object({
-	description: z.string().describe("A description of the task"),
-	when: z.discriminatedUnion("type", [
-		z.object({
-			type: z.literal("scheduled"),
-			date: z.string().describe("Execute task at the specified date and time in ISO 8601 format")
-		}),
-		z.object({
-			type: z.literal("delayed"),
-			delayInSeconds: z.number().describe("Execute task after a delay in seconds")
-		}),
-		z.object({
-			type: z.literal("cron"),
-			cron: z.string().describe("Execute task on a recurring interval specified as cron syntax")
-		}),
-		z.object({ type: z.literal("no-schedule") })
-	])
-});
-/**
 * @deprecated this has been renamed to scheduleSchema, and unstable_scheduleSchema will be removed in the next major version
 * @returns The schedule schema
 */

package/dist/schedule.js.map

@@ -1 +1 @@
-{"version":3,"file":"schedule.js","names":[],"sources":["../src/schedule.ts"],"sourcesContent":["import { z } from \"zod\";\n\n/**\n * Get the schedule prompt for a given event\n * @param event - The event to get the schedule prompt for\n * @returns The schedule prompt\n */\nexport function getSchedulePrompt(event: { date: Date }) {\n  return `\n[Schedule Parser Component]\n\nCurrent time: ${event.date.toUTCString()}\n\nThis component parses natural language scheduling requests into a structured format. It extracts:\n1. A clean task description (without timing information)\n2. Scheduling details in one of these formats:\n   - scheduled: Specific date/time events\n   - delayed: Relative time delays (in seconds)\n   - cron: Recurring patterns\n   - no-schedule: Tasks without timing\n\nRules:\n- Task descriptions should be clean and focused on the action\n- Use numbers (0-6) for days in cron patterns (0=Sunday)\n- For recurring tasks, use standard cron syntax\n- For relative times, convert to seconds\n- For specific dates, use the current time as reference\n\nExample outputs:\n{\n  \"description\": \"meeting with team\",\n  \"when\": {\n    \"type\": \"scheduled\",\n    \"date\": \"tomorrow at 14:00\"\n  }\n}\n\n{\n  \"description\": \"backup database\",\n  \"when\": {\n    \"type\": \"cron\",\n    \"cron\": \"0 0 * * *\"\n  }\n}\n\n{\n  \"description\": \"send report\",\n  \"when\": {\n    \"type\": \"delayed\",\n    \"delayInSeconds\": 1800\n  }\n}\n\n[End Schedule Parser Component]\n`;\n}\n\nlet didWarnAboutUnstableGetSchedulePrompt = false;\n\n/**\n * @deprecated this has been renamed to getSchedulePrompt, and unstable_getSchedulePrompt will be removed in the next major version\n * @param event - The event to get the schedule prompt for\n * @returns The schedule prompt\n */\nexport function unstable_getSchedulePrompt(event: { date: Date }) {\n  if (!didWarnAboutUnstableGetSchedulePrompt) {\n    didWarnAboutUnstableGetSchedulePrompt = true;\n    console.warn(\n      \"unstable_getSchedulePrompt is deprecated, use getSchedulePrompt instead. unstable_getSchedulePrompt will be removed in the next major version.\"\n    );\n  }\n  return getSchedulePrompt(event);\n}\n\n/**\n * The schema for parsing natural language scheduling requests.\n *\n * @example\n * ```typescript\n * import { generateObject } from \"ai\";\n * import { scheduleSchema, getSchedulePrompt } from \"agents/schedule\";\n *\n * const result = await generateObject({\n *   model,\n *   prompt: `${getSchedulePrompt({ date: new Date() })} Input: \"${userInput}\"`,\n *   schema: scheduleSchema,\n *   // Required for OpenAI to avoid strict JSON schema validation errors\n *   providerOptions: {\n *     openai: { strictJsonSchema: false }\n *   }\n * });\n * ```\n *\n * @remarks\n * When using this schema with OpenAI models via the AI SDK, you must pass\n * `providerOptions: { openai: { strictJsonSchema: false } }` to `generateObject`.\n * This is because the schema uses a discriminated union which is not compatible\n * with OpenAI's strict structured outputs mode.\n */\nexport const scheduleSchema = z.object({\n  description: z.string().describe(\"A description of the task\"),\n  when: z.discriminatedUnion(\"type\", [\n    z.object({\n      type: z.literal(\"scheduled\"),\n      date: z\n        .string()\n        .describe(\n          \"Execute task at the specified date and time in ISO 8601 format\"\n        )\n    }),\n    z.object({\n      type: z.literal(\"delayed\"),\n      delayInSeconds: z\n        .number()\n        .describe(\"Execute task after a delay in seconds\")\n    }),\n    z.object({\n      type: z.literal(\"cron\"),\n      cron: z\n        .string()\n        .describe(\n          \"Execute task on a recurring interval specified as cron syntax\"\n        )\n    }),\n    z.object({\n      type: z.literal(\"no-schedule\")\n    })\n  ])\n});\n\n/**\n * The type for the schedule prompt\n */\nexport type Schedule = z.infer<typeof scheduleSchema>;\n\n/**\n * @deprecated this has been renamed to scheduleSchema, and unstable_scheduleSchema will be removed in the next major version\n * @returns The schedule schema\n */\nexport const unstable_scheduleSchema = scheduleSchema;\n"],"mappings":";;;;;;;AAOA,SAAgB,kBAAkB,OAAuB;CACvD,OAAO;;;gBAGO,MAAM,KAAK,YAAY,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4CzC;AAEA,IAAI,wCAAwC;;;;;;AAO5C,SAAgB,2BAA2B,OAAuB;CAChE,IAAI,CAAC,uCAAuC;EAC1C,wCAAwC;EACxC,QAAQ,KACN,gJACF;CACF;CACA,OAAO,kBAAkB,KAAK;AAChC;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,MAAa,iBAAiB,EAAE,OAAO;CACrC,aAAa,EAAE,OAAO,CAAC,CAAC,SAAS,2BAA2B;CAC5D,MAAM,EAAE,mBAAmB,QAAQ;EACjC,EAAE,OAAO;GACP,MAAM,EAAE,QAAQ,WAAW;GAC3B,MAAM,EACH,OAAO,CAAC,CACR,SACC,gEACF;EACJ,CAAC;EACD,EAAE,OAAO;GACP,MAAM,EAAE,QAAQ,SAAS;GACzB,gBAAgB,EACb,OAAO,CAAC,CACR,SAAS,uCAAuC;EACrD,CAAC;EACD,EAAE,OAAO;GACP,MAAM,EAAE,QAAQ,MAAM;GACtB,MAAM,EACH,OAAO,CAAC,CACR,SACC,+DACF;EACJ,CAAC;EACD,EAAE,OAAO,EACP,MAAM,EAAE,QAAQ,aAAa,EAC/B,CAAC;CACH,CAAC;AACH,CAAC;;;;;AAWD,MAAa,0BAA0B"}
+{"version":3,"file":"schedule.js","names":[],"sources":["../src/schedule.ts"],"sourcesContent":["/**\n * @deprecated Import schedule parsing helpers from `agents/schedules/parser`.\n * This compatibility entry point will be removed in a future major release.\n */\nexport { getSchedulePrompt, scheduleSchema } from \"./schedules/parser\";\n/**\n * @deprecated Import `ParsedSchedule` from `agents/schedules/parser`.\n */\nexport type { ParsedSchedule as Schedule } from \"./schedules/parser\";\n\nimport { getSchedulePrompt, scheduleSchema } from \"./schedules/parser\";\n\nlet didWarnAboutUnstableGetSchedulePrompt = false;\n\n/**\n * @deprecated this has been renamed to getSchedulePrompt, and unstable_getSchedulePrompt will be removed in the next major version\n * @param event - The event to get the schedule prompt for\n * @returns The schedule prompt\n */\nexport function unstable_getSchedulePrompt(event: { date: Date }) {\n  if (!didWarnAboutUnstableGetSchedulePrompt) {\n    didWarnAboutUnstableGetSchedulePrompt = true;\n    console.warn(\n      \"unstable_getSchedulePrompt is deprecated, use getSchedulePrompt instead. unstable_getSchedulePrompt will be removed in the next major version.\"\n    );\n  }\n  return getSchedulePrompt(event);\n}\n\n/**\n * @deprecated this has been renamed to scheduleSchema, and unstable_scheduleSchema will be removed in the next major version\n * @returns The schedule schema\n */\nexport const unstable_scheduleSchema = scheduleSchema;\n"],"mappings":";;AAYA,IAAI,wCAAwC;;;;;;AAO5C,SAAgB,2BAA2B,OAAuB;CAChE,IAAI,CAAC,uCAAuC;EAC1C,wCAAwC;EACxC,QAAQ,KACN,gJACF;CACF;CACA,OAAO,kBAAkB,KAAK;AAChC;;;;;AAMA,MAAa,0BAA0B"}