@github-tools/sdk 1.20.0 → 1.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/README.md +50 -17
  2. package/dist/{approval-policy--kByBqhT.mjs → approval-policy-C2rcAY77.mjs} +3 -4
  3. package/dist/{approval-policy--kByBqhT.mjs.map → approval-policy-C2rcAY77.mjs.map} +1 -1
  4. package/dist/connect/eve.d.mts +2 -4
  5. package/dist/connect/eve.d.mts.map +1 -1
  6. package/dist/connect/eve.mjs +3 -4
  7. package/dist/connect/eve.mjs.map +1 -1
  8. package/dist/connect.d.mts +5 -11
  9. package/dist/connect.d.mts.map +1 -1
  10. package/dist/connect.mjs +3 -4
  11. package/dist/{cores-FLzAv2tu.mjs → cores-CMUr_SEv.mjs} +21 -4
  12. package/dist/cores-CMUr_SEv.mjs.map +1 -0
  13. package/dist/{tool-types-OFyE3z0C.d.mts → dry-run-BAbes7Mv.d.mts} +168 -40
  14. package/dist/dry-run-BAbes7Mv.d.mts.map +1 -0
  15. package/dist/{evaluation-BtoHbxuQ.mjs → evaluation-DskA4Lzk.mjs} +4 -6
  16. package/dist/{evaluation-BtoHbxuQ.mjs.map → evaluation-DskA4Lzk.mjs.map} +1 -1
  17. package/dist/eve-runtime-Bmdw1C-K.d.mts +127 -0
  18. package/dist/eve-runtime-Bmdw1C-K.d.mts.map +1 -0
  19. package/dist/{eve-runtime-C-0doyHq.mjs → eve-runtime-DM9yjOsG.mjs} +193 -22
  20. package/dist/eve-runtime-DM9yjOsG.mjs.map +1 -0
  21. package/dist/eve-runtime.d.mts +5 -5
  22. package/dist/eve-runtime.mjs +4 -4
  23. package/dist/eve.d.mts +103 -63
  24. package/dist/eve.d.mts.map +1 -1
  25. package/dist/eve.mjs +104 -63
  26. package/dist/eve.mjs.map +1 -1
  27. package/dist/{index-C3wlz660.d.mts → index-DgCZi9Ns.d.mts} +52 -56
  28. package/dist/index-DgCZi9Ns.d.mts.map +1 -0
  29. package/dist/index.d.mts +3 -3
  30. package/dist/index.mjs +4 -4
  31. package/dist/{interrupts-BSDPwdJ2.d.mts → interrupts-MwQ_v_PF.d.mts} +1 -3
  32. package/dist/interrupts-MwQ_v_PF.d.mts.map +1 -0
  33. package/dist/rolldown-runtime-D8jQpDG7.mjs +12 -0
  34. package/dist/{src-DyiAVHKl.mjs → src-Djn_FFj1.mjs} +183 -55
  35. package/dist/src-Djn_FFj1.mjs.map +1 -0
  36. package/dist/tanstack/interrupts.d.mts +1 -1
  37. package/dist/tanstack/interrupts.mjs +1 -2
  38. package/dist/tanstack.d.mts +534 -208
  39. package/dist/tanstack.d.mts.map +1 -1
  40. package/dist/tanstack.mjs +37 -21
  41. package/dist/tanstack.mjs.map +1 -1
  42. package/dist/{token-DIwB-wtp.mjs → token-HpJhSRkl.mjs} +7 -10
  43. package/dist/token-HpJhSRkl.mjs.map +1 -0
  44. package/dist/{types-CJqhvQwi.d.mts → types-8KtcPTao.d.mts} +3 -7
  45. package/dist/types-8KtcPTao.d.mts.map +1 -0
  46. package/dist/{types-ITYfXMtY.d.mts → types-C-BIKmas.d.mts} +14 -4
  47. package/dist/types-C-BIKmas.d.mts.map +1 -0
  48. package/dist/workflow.d.mts +9 -4
  49. package/dist/workflow.d.mts.map +1 -1
  50. package/dist/workflow.mjs +7 -6
  51. package/dist/workflow.mjs.map +1 -1
  52. package/dist/{write-tools-DnGZw-RD.mjs → write-tools-BR29EOoM.mjs} +483 -113
  53. package/dist/write-tools-BR29EOoM.mjs.map +1 -0
  54. package/package.json +1 -1
  55. package/dist/cores-FLzAv2tu.mjs.map +0 -1
  56. package/dist/eve-runtime-C-0doyHq.mjs.map +0 -1
  57. package/dist/eve-runtime-CflZNuXD.d.mts +0 -85
  58. package/dist/eve-runtime-CflZNuXD.d.mts.map +0 -1
  59. package/dist/index-C3wlz660.d.mts.map +0 -1
  60. package/dist/interrupts-BSDPwdJ2.d.mts.map +0 -1
  61. package/dist/src-DyiAVHKl.mjs.map +0 -1
  62. package/dist/token-DIwB-wtp.mjs.map +0 -1
  63. package/dist/tool-types-OFyE3z0C.d.mts.map +0 -1
  64. package/dist/types-CJqhvQwi.d.mts.map +0 -1
  65. package/dist/types-ITYfXMtY.d.mts.map +0 -1
  66. package/dist/write-tools-DnGZw-RD.mjs.map +0 -1
@@ -1,7 +1,6 @@
1
- import { A as GithubTokenCall, B as GithubToolName, F as GithubToolPreset, n as GithubToolsBaseOptions } from "./tool-types-OFyE3z0C.mjs";
2
- import { r as EveGithubToolsOptions } from "./types-ITYfXMtY.mjs";
1
+ import { B as GithubToolPreset, G as GithubToolName, M as GithubTokenCall, i as GithubToolsBaseOptions } from "./dry-run-BAbes7Mv.mjs";
2
+ import { r as EveGithubToolsOptions } from "./types-C-BIKmas.mjs";
3
3
  import { ConnectOptions, ConnectTokenParams } from "@vercel/connect";
4
- //#region src/connect/connector.d.ts
5
4
  /**
6
5
  * A Vercel Connect connector name, or a resolver that returns one.
7
6
  *
@@ -12,8 +11,6 @@ import { ConnectOptions, ConnectTokenParams } from "@vercel/connect";
12
11
  type GithubConnectorInput = string | (() => string | Promise<string>);
13
12
  /** Resolves a {@link GithubConnectorInput} to a connector name string. */
14
13
  declare function resolveGithubConnector(connector: GithubConnectorInput): Promise<string>;
15
- //#endregion
16
- //#region src/connect/types.d.ts
17
14
  /**
18
15
  * Token parameters for Vercel Connect GitHub connectors.
19
16
  * `subject` defaults to `{ type: 'app' }` — the project's GitHub App
@@ -58,6 +55,5 @@ type ConnectGithubTokenOptions = {
58
55
  params?: GithubConnectParamsInput;
59
56
  connectOptions?: ConnectOptions;
60
57
  };
61
- //#endregion
62
58
  export { GithubConnectParamsInput as a, resolveGithubConnector as c, GithubConnectParams as i, ConnectGithubTokenOptions as n, GithubConnectParamsResolver as o, ConnectGithubToolsOptions as r, GithubConnectorInput as s, ConnectGithubEveToolsOptions as t };
63
- //# sourceMappingURL=types-CJqhvQwi.d.mts.map
59
+ //# sourceMappingURL=types-8KtcPTao.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types-8KtcPTao.d.mts","names":[],"sources":["../src/connect/connector.ts","../src/connect/types.ts"],"mappings":";;;;;;;;;;KAOY,gDAAgD;;iBAGtC,uBAAuB,WAAW,uBAAuB;;;;;;;;KCInE,sBAAsB,KAAK;;;;;;;;EAQrC,UAAU;;EAEV;;;;;;;;KASU,+BACV,OAAO,oBACJ,sBAAsB,QAAQ;;KAGvB,2BAA2B,sBAAsB;KAEjD,4BAA4B;EACtC,SAAS,mBAAmB;EAC5B,UAAU;;KAGA,+BAA+B,KAAK;EAC9C,UAAU;;KAGA;EACV,SAAS,mBAAmB;;EAE5B,mBAAmB;;EAEnB,mBAAmB;EACnB,SAAS;EACT,iBAAiB"}
@@ -1,8 +1,7 @@
1
- import { B as GithubToolName, F as GithubToolPreset, V as GithubWriteToolName, a as GithubToolsContext, j as GithubTokenInput, o as CommitIdentity } from "./tool-types-OFyE3z0C.mjs";
1
+ import { B as GithubToolPreset, G as GithubToolName, K as GithubWriteToolName, L as GithubGuardrails, N as GithubTokenInput, c as CommitIdentity, s as GithubToolsContext, t as GithubDryRunApproval } from "./dry-run-BAbes7Mv.mjs";
2
2
  import { z } from "zod";
3
3
  import { ToolModelOutput } from "eve/tools";
4
4
  import { Approval } from "eve/tools/approval";
5
- //#region src/eve/types.d.ts
6
5
  /**
7
6
  * Approval value for eve tools.
8
7
  * - `true` / `'always'` → require approval on every call
@@ -59,6 +58,18 @@ type EveGithubToolsOptions = {
59
58
  committer?: CommitIdentity;
60
59
  /** Co-authors to attribute on all commits created by tools. */
61
60
  coAuthors?: CommitIdentity[];
61
+ /**
62
+ * Repositories and branches the tools may act on, checked before each call reaches GitHub.
63
+ * A blocked call returns a `github_tools.GUARDRAIL_BLOCKED` error, whoever approved it.
64
+ */
65
+ guardrails?: GithubGuardrails;
66
+ /**
67
+ * Run reads as usual but send no write to GitHub: each write returns a `GithubDryRunResult`
68
+ * instead, after the approval and guardrail checks.
69
+ */
70
+ dryRun?: boolean;
71
+ /** What approval would have decided for this call, reported in its dry-run result. Set per call by the eve extension. */
72
+ dryRunApproval?: GithubDryRunApproval;
62
73
  /**
63
74
  * Default owner / repo / PR / issue / ref values.
64
75
  * Softens matching tool input fields and fills them when omitted.
@@ -66,6 +77,5 @@ type EveGithubToolsOptions = {
66
77
  context?: GithubToolsContext;
67
78
  };
68
79
  type EveToolFactoryOptions = Omit<EveGithubToolsOptions, 'preset' | 'include' | 'exclude'>;
69
- //#endregion
70
80
  export { EveToolOverrides as a, EveToolFactoryOptions as i, EveApprovalValue as n, EveGithubToolsOptions as r, EveApprovalConfig as t };
71
- //# sourceMappingURL=types-ITYfXMtY.d.mts.map
81
+ //# sourceMappingURL=types-C-BIKmas.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types-C-BIKmas.d.mts","names":[],"sources":["../src/eve/types.ts"],"mappings":";;;;;;;;;;;;KAoBY,2DAKR;KAEQ,8BAER,QAAQ,OAAO,qBAAqB;KAE5B,mBAAmB,QAAQ,OAAO;EAC5C;EACA,WAAW;EACX,iBAAiB,oBAAoB,kBAAkB,QAAQ;;EAE/D,eAAe,EAAE;;KAGP;;EAEV,QAAQ;;;;;;EAMR,SAAS,mBAAmB;;;;;;EAM5B,UAAU;;;;;;EAMV,UAAU;;;;;;EAMV,kBAAkB;;;;;;EAMlB,YAAY;;EAEZ,SAAS;;EAET,YAAY;;EAEZ,YAAY;;;;;EAKZ,aAAa;;;;;EAKb;;EAEA,iBAAiB;;;;;EAKjB,UAAU;;KAGA,wBAAwB,KAAK"}
@@ -1,9 +1,8 @@
1
- import { B as GithubToolName, E as GITHUB_WRITE_TOOLS, F as GithubToolPreset, I as PRESET_TOOLS, L as PresetToolName, M as resolveGithubToken, P as CombinedPresetToolNames, R as GITHUB_TOOL_NAMES, V as GithubWriteToolName, a as GithubToolsContext, d as ToolOverrides, f as ApprovalConfig, i as PickGithubTools, j as GithubTokenInput, n as GithubToolsBaseOptions, o as CommitIdentity, p as StaticApprovalConfig, r as GithubToolsForPreset, s as CommitToolOptions, t as AllGithubTools } from "./tool-types-OFyE3z0C.mjs";
2
- import { Gt as CreateGithubAgentOptions, Kt as createGithubAgent, n as GithubToolsOptions, r as createGithubTools, t as GithubTools } from "./index-C3wlz660.mjs";
1
+ import { B as GithubToolPreset, F as resolveGithubToken, G as GithubToolName, H as PresetToolName, K as GithubWriteToolName, N as GithubTokenInput, O as GITHUB_WRITE_TOOLS, U as GITHUB_TOOL_NAMES, V as PRESET_TOOLS, a as GithubToolsForPreset, c as CommitIdentity, h as StaticApprovalConfig, i as GithubToolsBaseOptions, l as CommitToolOptions, m as ApprovalConfig, o as PickGithubTools, p as ToolOverrides, r as AllGithubTools, s as GithubToolsContext, z as CombinedPresetToolNames } from "./dry-run-BAbes7Mv.mjs";
2
+ import { Qt as createGithubAgent, Zt as CreateGithubAgentOptions, n as GithubToolsOptions, r as createGithubTools, t as GithubTools } from "./index-DgCZi9Ns.mjs";
3
3
  import { LanguageModel, Output, ToolSet } from "ai";
4
4
  import { WorkflowAgent, WorkflowAgentOptions, WorkflowAgentStreamOptions, WorkflowAgentStreamResult } from "@ai-sdk/workflow";
5
5
  import { Context } from "@ai-sdk/provider-utils";
6
- //#region src/workflow.d.ts
7
6
  type WorkflowGenerate<TTools extends ToolSet> = WorkflowAgent<TTools> extends {
8
7
  generate: infer Generate;
9
8
  } ? Generate : never;
@@ -76,6 +75,13 @@ export type CreateDurableGithubAgentOptions = Omit<WorkflowAgentOptions, 'model'
76
75
  * `execute`, `inputSchema`, and `outputSchema` cannot be overridden.
77
76
  */
78
77
  overrides?: GithubToolsBaseOptions['overrides'];
78
+ /**
79
+ * Repositories and branches the tools may act on, checked before each call reaches GitHub,
80
+ * as on `createGithubTools`.
81
+ */
82
+ guardrails?: GithubToolsBaseOptions['guardrails'];
83
+ /** Send no write to GitHub, as on `createGithubTools`. */
84
+ dryRun?: boolean;
79
85
  /**
80
86
  * Fully replace the default system prompt.
81
87
  * When set, `preset` system prompts and `additionalInstructions` are ignored.
@@ -145,6 +151,5 @@ export declare function createDurableGithubAgent<P extends GithubToolPreset>(opt
145
151
  export declare function createDurableGithubAgent<P extends readonly GithubToolPreset[]>(options: CreateDurableGithubAgentOptions & {
146
152
  preset: P;
147
153
  }): DurableGithubAgent<Pick<AllGithubTools, CombinedPresetToolNames<P>>>;
148
- //#endregion
149
154
  export { type AllGithubTools, type ApprovalConfig, type CombinedPresetToolNames, type CommitIdentity, type CommitToolOptions, type CreateGithubAgentOptions, GITHUB_TOOL_NAMES, GITHUB_WRITE_TOOLS, type GithubTokenInput, type GithubToolName, type GithubToolPreset, type GithubTools, type GithubToolsContext, type GithubToolsForPreset, type GithubToolsOptions, type GithubWriteToolName, PRESET_TOOLS, type PickGithubTools, type PresetToolName, type ToolOverrides, createGithubAgent, createGithubTools, resolveGithubToken };
150
155
  //# sourceMappingURL=workflow.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"workflow.d.mts","names":[],"sources":["../src/workflow.ts"],"mappings":";;;;;;KAuBK,iBAAiB,eAAe,WAAW,cAAc;EAAkB,gBAAgB;IAAa;;YAGjG,kCAAkC,eAAe,UAAU,WAAW,iBAAiB,kBAAiB,eAAe,uBAAsB;;;;;YAM7I,iCAAiC,eAAe,UAAU,WAAW,iBAAiB,kBAAiB,mBAAmB,cAAc,WAAU;;;;;;;;;qBAUjJ,mBAAmB,eAAe,UAAU;UAC/C;EAEI,YAAA,SAAS,qBAAqB;;MAKtC,SAAS;;EAKb,OAAO,qBAAqB,SAAS,QAAQ,gBAAgB,wBAC3D,SAAS,2BAA2B,cAAc,SAAS,QAAQ,kBAClE,QAAQ,0BAA0B,cAAc;;;;;;;EAUnD,SAAS,iBACP,SAAS,kCAAkC;IAAY,SAAS,OAAO,OAAO;MAC7E,QAAQ,KAAK,iCAAiC;aAAgC,QAAQ;;;;;;;;;YAY/E,kCACV,KAAK;EACH,gBAAgB;;;;;EAKhB,QAAQ;;;;;;;;;EASR,SAAS,mBAAmB;;;;;;;;EAQ5B,kBAAkB;;;;;EAKlB,YAAY;;;;;EAKZ;;;;;EAKA;;;;EAIA,UAAU;;;;;EAKV,SAAS;;;;;EAKT,YAAY;;;;;EAKZ,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAiCA,yBACd,SAAS;EAAoC;IAC5C,mBAAmB;wBACN,yBAAyB,UAAU,kBACjD,SAAS;EAAoC,QAAQ;IACpD,mBAAmB,KAAK,gBAAgB,eAAe;wBAC1C,yBAAyB,mBAAmB,oBAC1D,SAAS;EAAoC,QAAQ;IACpD,mBAAmB,KAAK,gBAAgB,wBAAwB"}
1
+ {"version":3,"file":"workflow.d.mts","names":[],"sources":["../src/workflow.ts"],"mappings":";;;;;KAuBK,iBAAiB,eAAe,WAAW,cAAc;EAAkB,gBAAgB;IAAa;;YAGjG,kCAAkC,eAAe,UAAU,WAAW,iBAAiB,kBAAiB,eAAe,uBAAsB;;;;;YAM7I,iCAAiC,eAAe,UAAU,WAAW,iBAAiB,kBAAiB,mBAAmB,cAAc,WAAU;;;;;;;;;qBAUjJ,mBAAmB,eAAe,UAAU;UAC/C;EAEI,YAAA,SAAS,qBAAqB;;MAKtC,SAAS;;EAKb,OAAO,qBAAqB,SAAS,QAAQ,gBAAgB,wBAC3D,SAAS,2BAA2B,cAAc,SAAS,QAAQ,kBAClE,QAAQ,0BAA0B,cAAc;;;;;;;EAUnD,SAAS,iBACP,SAAS,kCAAkC;IAAY,SAAS,OAAO,OAAO;MAC7E,QAAQ,KAAK,iCAAiC;aAAgC,QAAQ;;;;;;;;;YAY/E,kCACV,KAAK;EACH,gBAAgB;;;;;EAKhB,QAAQ;;;;;;;;;EASR,SAAS,mBAAmB;;;;;;;;EAQ5B,kBAAkB;;;;;EAKlB,YAAY;;;;;EAKZ,aAAa;;EAEb;;;;;EAKA;;;;;EAKA;;;;EAIA,UAAU;;;;;EAKV,SAAS;;;;;EAKT,YAAY;;;;;EAKZ,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAiCA,yBACd,SAAS;EAAoC;IAC5C,mBAAmB;wBACN,yBAAyB,UAAU,kBACjD,SAAS;EAAoC,QAAQ;IACpD,mBAAmB,KAAK,gBAAgB,eAAe;wBAC1C,yBAAyB,mBAAmB,oBAC1D,SAAS;EAAoC,QAAQ;IACpD,mBAAmB,KAAK,gBAAgB,wBAAwB"}
package/dist/workflow.mjs CHANGED
@@ -1,7 +1,7 @@
1
- import { Aa as githubToolsErrors, _ as PRESET_TOOLS, h as GITHUB_TOOL_NAMES, n as resolveInstructions, t as GITHUB_WRITE_TOOLS, x as resolveGithubToken } from "./write-tools-DnGZw-RD.mjs";
2
- import { r as createGithubAgent, t as createGithubTools } from "./src-DyiAVHKl.mjs";
1
+ import { r as createGithubAgent, t as createGithubTools } from "./src-Djn_FFj1.mjs";
2
+ import { S as resolveGithubToken, Za as githubToolsErrors, g as GITHUB_TOOL_NAMES, n as resolveInstructions, t as GITHUB_WRITE_TOOLS, v as PRESET_TOOLS } from "./write-tools-BR29EOoM.mjs";
3
3
  import { WorkflowAgent } from "@ai-sdk/workflow";
4
- //#region src/workflow.ts
4
+ // src/workflow.ts
5
5
  /**
6
6
  * A GitHub agent built on {@link WorkflowAgent}. Call both methods from a `"use workflow"`
7
7
  * function: each model call and each tool call runs as its own retriable workflow step, and
@@ -34,7 +34,7 @@ var DurableGithubAgent = class {
34
34
  return this.agent.generate(options);
35
35
  }
36
36
  };
37
- function createDurableGithubAgent({ model, token, preset, requireApproval, overrides, context, instructions, additionalInstructions, author, committer, coAuthors, ...agentOptions }) {
37
+ function createDurableGithubAgent({ model, token, preset, requireApproval, overrides, context, instructions, additionalInstructions, author, committer, coAuthors, guardrails, dryRun, ...agentOptions }) {
38
38
  const tools = createGithubTools({
39
39
  token,
40
40
  requireApproval,
@@ -43,7 +43,9 @@ function createDurableGithubAgent({ model, token, preset, requireApproval, overr
43
43
  context,
44
44
  author,
45
45
  committer,
46
- coAuthors
46
+ coAuthors,
47
+ guardrails,
48
+ dryRun
47
49
  });
48
50
  return new DurableGithubAgent({
49
51
  ...agentOptions,
@@ -57,7 +59,6 @@ function createDurableGithubAgent({ model, token, preset, requireApproval, overr
57
59
  })
58
60
  });
59
61
  }
60
- //#endregion
61
62
  export { DurableGithubAgent, GITHUB_TOOL_NAMES, GITHUB_WRITE_TOOLS, PRESET_TOOLS, createDurableGithubAgent, createGithubAgent, createGithubTools, resolveGithubToken };
62
63
 
63
64
  //# sourceMappingURL=workflow.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"workflow.mjs","names":[],"sources":["../src/workflow.ts"],"sourcesContent":["import { WorkflowAgent } from '@ai-sdk/workflow'\nimport type {\n WorkflowAgentOptions,\n WorkflowAgentStreamOptions,\n WorkflowAgentStreamResult,\n} from '@ai-sdk/workflow'\nimport type { LanguageModel, Output, ToolSet } from 'ai'\nimport { createGithubTools } from './index'\nimport { resolveInstructions } from './agents'\nimport { githubToolsErrors } from './core/errors'\nimport type { AllGithubTools } from './core/tool-types'\nimport type { CombinedPresetToolNames, GithubToolPreset, PresetToolName } from './core/presets'\nimport type { GithubToolName } from './core/tool-names'\nimport type { GithubToolsBaseOptions } from './core/tool-types'\nimport type { StaticApprovalConfig } from './index'\nimport type { CommitIdentity } from './types'\nimport type { GithubTokenInput } from './core/token'\nimport type { GithubToolsContext } from './core/context'\nimport type { Context } from '@ai-sdk/provider-utils'\n\n// Read from `WorkflowAgent` instead of importing `WorkflowAgentGenerateOptions` and\n// `WorkflowAgentGenerateResult`, which `@ai-sdk/workflow` only exports from 2.0.59: importing them\n// would break type checking for `.stream()` users on older supported versions.\ntype WorkflowGenerate<TTools extends ToolSet> = WorkflowAgent<TTools> extends { generate: infer Generate } ? Generate : never\n\n/** Options of {@link DurableGithubAgent.generate}: those of `WorkflowAgent.generate()`. */\nexport type DurableGithubAgentGenerateOptions<TTools extends ToolSet = ToolSet> = WorkflowGenerate<TTools> extends (options: infer Options) => unknown ? Options : never\n\n/**\n * Result of {@link DurableGithubAgent.generate}: the `WorkflowAgent` generation result. Read the\n * fields you need inside the workflow and return those, since the result itself is not serializable.\n */\nexport type DurableGithubAgentGenerateResult<TTools extends ToolSet = ToolSet> = WorkflowGenerate<TTools> extends (options: never) => Promise<infer Result> ? Result : never\n\n/**\n * A GitHub agent built on {@link WorkflowAgent}. Call both methods from a `\"use workflow\"`\n * function: each model call and each tool call runs as its own retriable workflow step, and\n * tools with `needsApproval` pause the run until the user answers.\n *\n * - `.stream()` writes the response to a `writable` for chat UIs.\n * - `.generate()` returns the finished result, for bots, webhooks, and background jobs.\n */\nexport class DurableGithubAgent<TTools extends ToolSet = ToolSet> {\n private agent: WorkflowAgent<TTools>\n\n constructor(options: WorkflowAgentOptions<TTools>) {\n this.agent = new WorkflowAgent(options)\n }\n\n /** The tool set configured for this agent. */\n get tools(): TTools {\n return this.agent.tools\n }\n\n /** Stream the agent's response. Delegates to `WorkflowAgent.stream()`. */\n stream<TStreamTools extends TTools = TTools, OUTPUT = never, PARTIAL_OUTPUT = never>(\n options: WorkflowAgentStreamOptions<TStreamTools, Context, OUTPUT, PARTIAL_OUTPUT>,\n ): Promise<WorkflowAgentStreamResult<TStreamTools, OUTPUT>> {\n return this.agent.stream(options)\n }\n\n /**\n * Generate the full response without streaming. Delegates to `WorkflowAgent.generate()`, which\n * needs `@ai-sdk/workflow` 2.0.59 or later. Stops after 20 steps unless `stopWhen` says otherwise.\n * A write that needs approval ends the call with a `tool-approval-request` in\n * `responseMessages`; append the user's `tool-approval-response` and call `generate()` again.\n */\n generate<OUTPUT = string>(\n options: DurableGithubAgentGenerateOptions<TTools> & { output?: Output.Output<OUTPUT> },\n ): Promise<Omit<DurableGithubAgentGenerateResult<TTools>, 'output'> & { readonly output: OUTPUT }> {\n if (typeof this.agent.generate !== 'function') throw githubToolsErrors.DURABLE_GENERATE_UNAVAILABLE()\n return this.agent.generate(options)\n }\n}\n\n/**\n * Options for creating a durable GitHub agent via {@link createDurableGithubAgent}.\n *\n * Extends all `WorkflowAgentOptions` (temperature, telemetry, callbacks, etc.)\n * and adds GitHub-specific fields (token, preset, approval config).\n */\nexport type CreateDurableGithubAgentOptions =\n Omit<WorkflowAgentOptions, 'model' | 'tools' | 'instructions'> & {\n model: string | LanguageModel\n /**\n * GitHub personal access token or async token provider.\n * Falls back to `process.env.GITHUB_TOKEN` when omitted.\n */\n token?: GithubTokenInput\n /**\n * Restrict tools and system prompt to a predefined preset.\n *\n * Selects a subset of tools and sets the preset's system prompt. Combine presets with an array\n * to merge their tool sets and system prompts.\n *\n * @see {@link GithubToolPreset} for available presets and included tools.\n */\n preset?: GithubToolPreset | GithubToolPreset[]\n /**\n * Control whether write operations require user approval before execution.\n *\n * `'auto'` is not supported: the evaluation call cannot run inside a workflow function.\n *\n * @see {@link StaticApprovalConfig} for global and per-tool options.\n */\n requireApproval?: StaticApprovalConfig\n /**\n * Per-tool overrides (`description`, `title`, `needsApproval`, …), as on `createGithubTools`.\n * `execute`, `inputSchema`, and `outputSchema` cannot be overridden.\n */\n overrides?: GithubToolsBaseOptions['overrides']\n /**\n * Fully replace the default system prompt.\n * When set, `preset` system prompts and `additionalInstructions` are ignored.\n */\n instructions?: string\n /**\n * Append text to the preset-specific (or default) system prompt.\n * Ignored when `instructions` is set.\n */\n additionalInstructions?: string\n /**\n * Default owner / repo / PR / issue / ref values for tools and the system prompt.\n */\n context?: GithubToolsContext\n /**\n * Default author for commit-creating tools.\n * Falls back to the authenticated user when omitted.\n */\n author?: CommitIdentity\n /**\n * Default committer for commit-creating tools.\n * Falls back to the authenticated user when omitted.\n */\n committer?: CommitIdentity\n /**\n * Co-authors to attribute on all commits.\n * Added as \"Co-authored-by\" trailers to commit messages.\n */\n coAuthors?: CommitIdentity[]\n }\n\n/**\n * Create a pre-configured durable GitHub agent powered by `WorkflowAgent`\n * from `@ai-sdk/workflow`.\n *\n * Returns a {@link DurableGithubAgent} with two interaction modes:\n *\n * - `.stream()` — works directly in workflow scope; each tool call is a durable step.\n * Write tools honor `requireApproval` via `needsApproval` and pause the workflow\n * until the user approves or denies.\n * - `.generate()` — uses `generateText` from the AI SDK; must be called from\n * within a `\"use step\"` function when running inside a workflow.\n *\n * @example Streaming (chat UI — works in workflow scope)\n * ```ts\n * import { createDurableGithubAgent } from '@github-tools/sdk/workflow'\n * import { getWritable } from 'workflow'\n * import type { ModelMessage, ModelCallStreamPart } from 'ai'\n *\n * async function chatWorkflow(messages: ModelMessage[], token: string) {\n * \"use workflow\"\n * const agent = createDurableGithubAgent({\n * model: 'anthropic/claude-opus-5.5',\n * token,\n * preset: 'code-review',\n * })\n * const writable = getWritable<ModelCallStreamPart>()\n * await agent.stream({ messages, writable })\n * }\n * ```\n */\nexport function createDurableGithubAgent(\n options: CreateDurableGithubAgentOptions & { preset?: undefined },\n): DurableGithubAgent<AllGithubTools>\nexport function createDurableGithubAgent<P extends GithubToolPreset>(\n options: CreateDurableGithubAgentOptions & { preset: P },\n): DurableGithubAgent<Pick<AllGithubTools, PresetToolName<P>>>\nexport function createDurableGithubAgent<P extends readonly GithubToolPreset[]>(\n options: CreateDurableGithubAgentOptions & { preset: P },\n): DurableGithubAgent<Pick<AllGithubTools, CombinedPresetToolNames<P>>>\nexport function createDurableGithubAgent({\n model,\n token,\n preset,\n requireApproval,\n overrides,\n context,\n instructions,\n additionalInstructions,\n author,\n committer,\n coAuthors,\n ...agentOptions\n}: CreateDurableGithubAgentOptions): DurableGithubAgent<AllGithubTools | Pick<AllGithubTools, GithubToolName>> {\n const tools = createGithubTools({ token, requireApproval, preset, overrides, context, author, committer, coAuthors })\n\n return new DurableGithubAgent({\n ...agentOptions,\n model,\n tools,\n instructions: resolveInstructions({ preset, instructions, additionalInstructions, context }),\n }) as DurableGithubAgent<typeof tools>\n}\n\nexport { createGithubTools, createGithubAgent } from './index'\nexport type { CommitIdentity, CommitToolOptions, GithubTools, GithubToolsOptions, GithubToolPreset, GithubToolName, GithubWriteToolName, ApprovalConfig, ToolOverrides, AllGithubTools, PresetToolName, CombinedPresetToolNames, GithubToolsForPreset, PickGithubTools, GithubTokenInput, GithubToolsContext } from './index'\nexport { PRESET_TOOLS, GITHUB_TOOL_NAMES, GITHUB_WRITE_TOOLS, resolveGithubToken } from './index'\nexport type { CreateGithubAgentOptions } from './agents'\n"],"mappings":";;;;;;;;;;;;AA0CA,IAAa,qBAAb,MAAkE;CAChE;CAEA,YAAY,SAAuC;EACjD,KAAK,QAAQ,IAAI,cAAc,OAAO;CACxC;;CAGA,IAAI,QAAgB;EAClB,OAAO,KAAK,MAAM;CACpB;;CAGA,OACE,SAC0D;EAC1D,OAAO,KAAK,MAAM,OAAO,OAAO;CAClC;;;;;;;CAQA,SACE,SACiG;EACjG,IAAI,OAAO,KAAK,MAAM,aAAa,YAAY,MAAM,kBAAkB,6BAA6B;EACpG,OAAO,KAAK,MAAM,SAAS,OAAO;CACpC;AACF;AA4GA,SAAgB,yBAAyB,EACvC,OACA,OACA,QACA,iBACA,WACA,SACA,cACA,wBACA,QACA,WACA,WACA,GAAG,gBAC0G;CAC7G,MAAM,QAAQ,kBAAkB;EAAE;EAAO;EAAiB;EAAQ;EAAW;EAAS;EAAQ;EAAW;CAAU,CAAC;CAEpH,OAAO,IAAI,mBAAmB;EAC5B,GAAG;EACH;EACA;EACA,cAAc,oBAAoB;GAAE;GAAQ;GAAc;GAAwB;EAAQ,CAAC;CAC7F,CAAC;AACH"}
1
+ {"version":3,"file":"workflow.mjs","names":[],"sources":["../src/workflow.ts"],"sourcesContent":["import { WorkflowAgent } from '@ai-sdk/workflow'\nimport type {\n WorkflowAgentOptions,\n WorkflowAgentStreamOptions,\n WorkflowAgentStreamResult,\n} from '@ai-sdk/workflow'\nimport type { LanguageModel, Output, ToolSet } from 'ai'\nimport { createGithubTools } from './index'\nimport { resolveInstructions } from './agents'\nimport { githubToolsErrors } from './core/errors'\nimport type { AllGithubTools } from './core/tool-types'\nimport type { CombinedPresetToolNames, GithubToolPreset, PresetToolName } from './core/presets'\nimport type { GithubToolName } from './core/tool-names'\nimport type { GithubToolsBaseOptions } from './core/tool-types'\nimport type { StaticApprovalConfig } from './index'\nimport type { CommitIdentity } from './types'\nimport type { GithubTokenInput } from './core/token'\nimport type { GithubToolsContext } from './core/context'\nimport type { Context } from '@ai-sdk/provider-utils'\n\n// Read from `WorkflowAgent` instead of importing `WorkflowAgentGenerateOptions` and\n// `WorkflowAgentGenerateResult`, which `@ai-sdk/workflow` only exports from 2.0.59: importing them\n// would break type checking for `.stream()` users on older supported versions.\ntype WorkflowGenerate<TTools extends ToolSet> = WorkflowAgent<TTools> extends { generate: infer Generate } ? Generate : never\n\n/** Options of {@link DurableGithubAgent.generate}: those of `WorkflowAgent.generate()`. */\nexport type DurableGithubAgentGenerateOptions<TTools extends ToolSet = ToolSet> = WorkflowGenerate<TTools> extends (options: infer Options) => unknown ? Options : never\n\n/**\n * Result of {@link DurableGithubAgent.generate}: the `WorkflowAgent` generation result. Read the\n * fields you need inside the workflow and return those, since the result itself is not serializable.\n */\nexport type DurableGithubAgentGenerateResult<TTools extends ToolSet = ToolSet> = WorkflowGenerate<TTools> extends (options: never) => Promise<infer Result> ? Result : never\n\n/**\n * A GitHub agent built on {@link WorkflowAgent}. Call both methods from a `\"use workflow\"`\n * function: each model call and each tool call runs as its own retriable workflow step, and\n * tools with `needsApproval` pause the run until the user answers.\n *\n * - `.stream()` writes the response to a `writable` for chat UIs.\n * - `.generate()` returns the finished result, for bots, webhooks, and background jobs.\n */\nexport class DurableGithubAgent<TTools extends ToolSet = ToolSet> {\n private agent: WorkflowAgent<TTools>\n\n constructor(options: WorkflowAgentOptions<TTools>) {\n this.agent = new WorkflowAgent(options)\n }\n\n /** The tool set configured for this agent. */\n get tools(): TTools {\n return this.agent.tools\n }\n\n /** Stream the agent's response. Delegates to `WorkflowAgent.stream()`. */\n stream<TStreamTools extends TTools = TTools, OUTPUT = never, PARTIAL_OUTPUT = never>(\n options: WorkflowAgentStreamOptions<TStreamTools, Context, OUTPUT, PARTIAL_OUTPUT>,\n ): Promise<WorkflowAgentStreamResult<TStreamTools, OUTPUT>> {\n return this.agent.stream(options)\n }\n\n /**\n * Generate the full response without streaming. Delegates to `WorkflowAgent.generate()`, which\n * needs `@ai-sdk/workflow` 2.0.59 or later. Stops after 20 steps unless `stopWhen` says otherwise.\n * A write that needs approval ends the call with a `tool-approval-request` in\n * `responseMessages`; append the user's `tool-approval-response` and call `generate()` again.\n */\n generate<OUTPUT = string>(\n options: DurableGithubAgentGenerateOptions<TTools> & { output?: Output.Output<OUTPUT> },\n ): Promise<Omit<DurableGithubAgentGenerateResult<TTools>, 'output'> & { readonly output: OUTPUT }> {\n if (typeof this.agent.generate !== 'function') throw githubToolsErrors.DURABLE_GENERATE_UNAVAILABLE()\n return this.agent.generate(options)\n }\n}\n\n/**\n * Options for creating a durable GitHub agent via {@link createDurableGithubAgent}.\n *\n * Extends all `WorkflowAgentOptions` (temperature, telemetry, callbacks, etc.)\n * and adds GitHub-specific fields (token, preset, approval config).\n */\nexport type CreateDurableGithubAgentOptions =\n Omit<WorkflowAgentOptions, 'model' | 'tools' | 'instructions'> & {\n model: string | LanguageModel\n /**\n * GitHub personal access token or async token provider.\n * Falls back to `process.env.GITHUB_TOKEN` when omitted.\n */\n token?: GithubTokenInput\n /**\n * Restrict tools and system prompt to a predefined preset.\n *\n * Selects a subset of tools and sets the preset's system prompt. Combine presets with an array\n * to merge their tool sets and system prompts.\n *\n * @see {@link GithubToolPreset} for available presets and included tools.\n */\n preset?: GithubToolPreset | GithubToolPreset[]\n /**\n * Control whether write operations require user approval before execution.\n *\n * `'auto'` is not supported: the evaluation call cannot run inside a workflow function.\n *\n * @see {@link StaticApprovalConfig} for global and per-tool options.\n */\n requireApproval?: StaticApprovalConfig\n /**\n * Per-tool overrides (`description`, `title`, `needsApproval`, …), as on `createGithubTools`.\n * `execute`, `inputSchema`, and `outputSchema` cannot be overridden.\n */\n overrides?: GithubToolsBaseOptions['overrides']\n /**\n * Repositories and branches the tools may act on, checked before each call reaches GitHub,\n * as on `createGithubTools`.\n */\n guardrails?: GithubToolsBaseOptions['guardrails']\n /** Send no write to GitHub, as on `createGithubTools`. */\n dryRun?: boolean\n /**\n * Fully replace the default system prompt.\n * When set, `preset` system prompts and `additionalInstructions` are ignored.\n */\n instructions?: string\n /**\n * Append text to the preset-specific (or default) system prompt.\n * Ignored when `instructions` is set.\n */\n additionalInstructions?: string\n /**\n * Default owner / repo / PR / issue / ref values for tools and the system prompt.\n */\n context?: GithubToolsContext\n /**\n * Default author for commit-creating tools.\n * Falls back to the authenticated user when omitted.\n */\n author?: CommitIdentity\n /**\n * Default committer for commit-creating tools.\n * Falls back to the authenticated user when omitted.\n */\n committer?: CommitIdentity\n /**\n * Co-authors to attribute on all commits.\n * Added as \"Co-authored-by\" trailers to commit messages.\n */\n coAuthors?: CommitIdentity[]\n }\n\n/**\n * Create a pre-configured durable GitHub agent powered by `WorkflowAgent`\n * from `@ai-sdk/workflow`.\n *\n * Returns a {@link DurableGithubAgent} with two interaction modes:\n *\n * - `.stream()` — works directly in workflow scope; each tool call is a durable step.\n * Write tools honor `requireApproval` via `needsApproval` and pause the workflow\n * until the user approves or denies.\n * - `.generate()` — uses `generateText` from the AI SDK; must be called from\n * within a `\"use step\"` function when running inside a workflow.\n *\n * @example Streaming (chat UI — works in workflow scope)\n * ```ts\n * import { createDurableGithubAgent } from '@github-tools/sdk/workflow'\n * import { getWritable } from 'workflow'\n * import type { ModelMessage, ModelCallStreamPart } from 'ai'\n *\n * async function chatWorkflow(messages: ModelMessage[], token: string) {\n * \"use workflow\"\n * const agent = createDurableGithubAgent({\n * model: 'anthropic/claude-opus-5.5',\n * token,\n * preset: 'code-review',\n * })\n * const writable = getWritable<ModelCallStreamPart>()\n * await agent.stream({ messages, writable })\n * }\n * ```\n */\nexport function createDurableGithubAgent(\n options: CreateDurableGithubAgentOptions & { preset?: undefined },\n): DurableGithubAgent<AllGithubTools>\nexport function createDurableGithubAgent<P extends GithubToolPreset>(\n options: CreateDurableGithubAgentOptions & { preset: P },\n): DurableGithubAgent<Pick<AllGithubTools, PresetToolName<P>>>\nexport function createDurableGithubAgent<P extends readonly GithubToolPreset[]>(\n options: CreateDurableGithubAgentOptions & { preset: P },\n): DurableGithubAgent<Pick<AllGithubTools, CombinedPresetToolNames<P>>>\nexport function createDurableGithubAgent({\n model,\n token,\n preset,\n requireApproval,\n overrides,\n context,\n instructions,\n additionalInstructions,\n author,\n committer,\n coAuthors,\n guardrails,\n dryRun,\n ...agentOptions\n}: CreateDurableGithubAgentOptions): DurableGithubAgent<AllGithubTools | Pick<AllGithubTools, GithubToolName>> {\n const tools = createGithubTools({ token, requireApproval, preset, overrides, context, author, committer, coAuthors, guardrails, dryRun })\n\n return new DurableGithubAgent({\n ...agentOptions,\n model,\n tools,\n instructions: resolveInstructions({ preset, instructions, additionalInstructions, context }),\n }) as DurableGithubAgent<typeof tools>\n}\n\nexport { createGithubTools, createGithubAgent } from './index'\nexport type { CommitIdentity, CommitToolOptions, GithubTools, GithubToolsOptions, GithubToolPreset, GithubToolName, GithubWriteToolName, ApprovalConfig, ToolOverrides, AllGithubTools, PresetToolName, CombinedPresetToolNames, GithubToolsForPreset, PickGithubTools, GithubTokenInput, GithubToolsContext } from './index'\nexport { PRESET_TOOLS, GITHUB_TOOL_NAMES, GITHUB_WRITE_TOOLS, resolveGithubToken } from './index'\nexport type { CreateGithubAgentOptions } from './agents'\n"],"mappings":";;;;;;;;;;;;AA0CA,IAAa,qBAAb,MAAkE;CAChE;CAEA,YAAY,SAAuC;EACjD,KAAK,QAAQ,IAAI,cAAc,OAAO;CACxC;;CAGA,IAAI,QAAgB;EAClB,OAAO,KAAK,MAAM;CACpB;;CAGA,OACE,SAC0D;EAC1D,OAAO,KAAK,MAAM,OAAO,OAAO;CAClC;;;;;;;CAQA,SACE,SACiG;EACjG,IAAI,OAAO,KAAK,MAAM,aAAa,YAAY,MAAM,kBAAkB,6BAA6B;EACpG,OAAO,KAAK,MAAM,SAAS,OAAO;CACpC;AACF;AAmHA,SAAgB,yBAAyB,EACvC,OACA,OACA,QACA,iBACA,WACA,SACA,cACA,wBACA,QACA,WACA,WACA,YACA,QACA,GAAG,gBAC0G;CAC7G,MAAM,QAAQ,kBAAkB;EAAE;EAAO;EAAiB;EAAQ;EAAW;EAAS;EAAQ;EAAW;EAAW;EAAY;CAAO,CAAC;CAExI,OAAO,IAAI,mBAAmB;EAC5B,GAAG;EACH;EACA;EACA,cAAc,oBAAoB;GAAE;GAAQ;GAAc;GAAwB;EAAQ,CAAC;CAC7F,CAAC;AACH"}