@github-tools/sdk 1.2.0 → 1.4.0

package/dist/agents-C6nqZiYp.d.mts

@@ -0,0 +1,781 @@
+import { ApprovalConfig, GithubToolPreset } from "./index.mjs";
+import * as ai from "ai";
+import { Tool, ToolLoopAgent, ToolLoopAgentSettings } from "ai";
+import { Octokit, Octokit as Octokit$1 } from "octokit";
+
+//#region src/types.d.ts
+type ToolOptions = {
+  needsApproval?: boolean;
+};
+/**
+ * Per-tool overrides for customizing tool behavior without changing the underlying implementation.
+ * Properties like `execute`, `inputSchema`, and `outputSchema` are intentionally excluded.
+ */
+type ToolOverrides = Partial<Pick<Tool, 'description' | 'needsApproval' | 'onInputAvailable' | 'onInputDelta' | 'onInputStart' | 'providerOptions' | 'strict' | 'title' | 'toModelOutput'>>;
+//#endregion
+//#region src/client.d.ts
+declare function createOctokit(token: string): Octokit;
+//#endregion
+//#region src/tools/repository.d.ts
+declare const getRepository: (token: string) => ai.Tool<{
+  owner: string;
+  repo: string;
+}, {
+  name: string;
+  fullName: string;
+  description: string | null;
+  url: string;
+  defaultBranch: string;
+  stars: number;
+  forks: number;
+  openIssues: number;
+  language: string | null;
+  private: boolean;
+  createdAt: string;
+  updatedAt: string;
+}>;
+declare const listBranches: (token: string) => ai.Tool<{
+  owner: string;
+  repo: string;
+  perPage: number;
+}, {
+  name: string;
+  sha: string;
+  protected: boolean;
+}[]>;
+declare const getFileContent: (token: string) => ai.Tool<{
+  owner: string;
+  repo: string;
+  path: string;
+  ref?: string | undefined;
+}, {
+  type: string;
+  entries: {
+    name: string;
+    type: "file" | "dir" | "submodule" | "symlink";
+    path: string;
+  }[];
+  path?: undefined;
+  sha?: undefined;
+  size?: undefined;
+  content?: undefined;
+} | {
+  type: "submodule" | "symlink";
+  path: string;
+  entries?: undefined;
+  sha?: undefined;
+  size?: undefined;
+  content?: undefined;
+} | {
+  type: string;
+  path: string;
+  sha: string;
+  size: number;
+  content: string;
+  entries?: undefined;
+}>;
+declare const createBranch: (token: string, {
+  needsApproval
+}?: ToolOptions) => ai.Tool<{
+  owner: string;
+  repo: string;
+  branch: string;
+  from?: string | undefined;
+}, {
+  ref: string;
+  sha: string;
+  url: string;
+}>;
+declare const forkRepository: (token: string, {
+  needsApproval
+}?: ToolOptions) => ai.Tool<{
+  owner: string;
+  repo: string;
+  organization?: string | undefined;
+  name?: string | undefined;
+}, {
+  name: string;
+  fullName: string;
+  url: string;
+  cloneUrl: string;
+  sshUrl: string;
+  defaultBranch: string;
+  private: boolean;
+  parent: {
+    fullName: string;
+    url: string;
+  } | null;
+}>;
+declare const createRepository: (token: string, {
+  needsApproval
+}?: ToolOptions) => ai.Tool<{
+  name: string;
+  isPrivate: boolean;
+  autoInit: boolean;
+  description?: string | undefined;
+  gitignoreTemplate?: string | undefined;
+  licenseTemplate?: string | undefined;
+  org?: string | undefined;
+}, {
+  name: string;
+  fullName: string;
+  description: string | null;
+  url: string;
+  cloneUrl: string;
+  sshUrl: string;
+  defaultBranch: string;
+  private: boolean;
+  createdAt: string;
+}>;
+declare const createOrUpdateFile: (token: string, {
+  needsApproval
+}?: ToolOptions) => ai.Tool<{
+  owner: string;
+  repo: string;
+  path: string;
+  message: string;
+  content: string;
+  branch?: string | undefined;
+  sha?: string | undefined;
+}, {
+  path: string | undefined;
+  sha: string | undefined;
+  commitSha: string | undefined;
+  commitUrl: string | undefined;
+}>;
+//#endregion
+//#region src/tools/pull-requests.d.ts
+declare const listPullRequests: (token: string) => ai.Tool<{
+  owner: string;
+  repo: string;
+  state: "open" | "closed" | "all";
+  perPage: number;
+}, {
+  number: number;
+  title: string;
+  state: string;
+  url: string;
+  author: string | undefined;
+  branch: string;
+  base: string;
+  draft: boolean | undefined;
+  createdAt: string;
+  updatedAt: string;
+}[]>;
+declare const getPullRequest: (token: string) => ai.Tool<{
+  owner: string;
+  repo: string;
+  pullNumber: number;
+}, {
+  number: number;
+  title: string;
+  body: string | null;
+  state: "open" | "closed";
+  url: string;
+  author: string;
+  branch: string;
+  base: string;
+  draft: boolean | undefined;
+  merged: boolean;
+  mergeable: boolean | null;
+  additions: number;
+  deletions: number;
+  changedFiles: number;
+  createdAt: string;
+  updatedAt: string;
+  mergedAt: string | null;
+}>;
+declare const createPullRequest: (token: string, {
+  needsApproval
+}?: ToolOptions) => ai.Tool<{
+  owner: string;
+  repo: string;
+  title: string;
+  head: string;
+  base: string;
+  draft: boolean;
+  body?: string | undefined;
+}, {
+  number: number;
+  title: string;
+  url: string;
+  state: "open" | "closed";
+  draft: boolean | undefined;
+  branch: string;
+  base: string;
+}>;
+declare const mergePullRequest: (token: string, {
+  needsApproval
+}?: ToolOptions) => ai.Tool<{
+  owner: string;
+  repo: string;
+  pullNumber: number;
+  mergeMethod: "merge" | "squash" | "rebase";
+  commitTitle?: string | undefined;
+  commitMessage?: string | undefined;
+}, {
+  merged: boolean;
+  message: string;
+  sha: string;
+}>;
+declare const addPullRequestComment: (token: string, {
+  needsApproval
+}?: ToolOptions) => ai.Tool<{
+  owner: string;
+  repo: string;
+  pullNumber: number;
+  body: string;
+}, {
+  id: number;
+  url: string;
+  body: string | undefined;
+  author: string | undefined;
+  createdAt: string;
+}>;
+declare const listPullRequestFiles: (token: string) => ai.Tool<{
+  owner: string;
+  repo: string;
+  pullNumber: number;
+  perPage: number;
+  page: number;
+}, {
+  filename: string;
+  status: "added" | "removed" | "modified" | "renamed" | "copied" | "changed" | "unchanged";
+  additions: number;
+  deletions: number;
+  changes: number;
+  patch: string | undefined;
+}[]>;
+declare const listPullRequestReviews: (token: string) => ai.Tool<{
+  owner: string;
+  repo: string;
+  pullNumber: number;
+  perPage: number;
+  page: number;
+}, {
+  id: number;
+  state: string;
+  body: string;
+  author: string | undefined;
+  url: string;
+  submittedAt: string | undefined;
+}[]>;
+declare const createPullRequestReview: (token: string, {
+  needsApproval
+}?: ToolOptions) => ai.Tool<{
+  owner: string;
+  repo: string;
+  pullNumber: number;
+  event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT";
+  body?: string | undefined;
+  comments?: {
+    path: string;
+    body: string;
+    line?: number | undefined;
+    side?: "LEFT" | "RIGHT" | undefined;
+  }[] | undefined;
+}, {
+  id: number;
+  state: string;
+  body: string;
+  url: string;
+  author: string | undefined;
+  submittedAt: string | undefined;
+}>;
+//#endregion
+//#region src/tools/issues.d.ts
+declare const listIssues: (token: string) => ai.Tool<{
+  owner: string;
+  repo: string;
+  state: "open" | "closed" | "all";
+  perPage: number;
+  labels?: string | undefined;
+}, {
+  number: number;
+  title: string;
+  state: string;
+  url: string;
+  author: string | undefined;
+  labels: (string | undefined)[];
+  createdAt: string;
+  updatedAt: string;
+}[]>;
+declare const getIssue: (token: string) => ai.Tool<{
+  owner: string;
+  repo: string;
+  issueNumber: number;
+}, {
+  number: number;
+  title: string;
+  body: string | null | undefined;
+  state: string;
+  url: string;
+  author: string | undefined;
+  assignees: string[] | undefined;
+  labels: (string | undefined)[];
+  comments: number;
+  createdAt: string;
+  updatedAt: string;
+  closedAt: string | null;
+}>;
+declare const createIssue: (token: string, {
+  needsApproval
+}?: ToolOptions) => ai.Tool<{
+  owner: string;
+  repo: string;
+  title: string;
+  body?: string | undefined;
+  labels?: string[] | undefined;
+  assignees?: string[] | undefined;
+}, {
+  number: number;
+  title: string;
+  url: string;
+  state: string;
+  labels: (string | undefined)[];
+}>;
+declare const addIssueComment: (token: string, {
+  needsApproval
+}?: ToolOptions) => ai.Tool<{
+  owner: string;
+  repo: string;
+  issueNumber: number;
+  body: string;
+}, {
+  id: number;
+  url: string;
+  body: string | undefined;
+  author: string | undefined;
+  createdAt: string;
+}>;
+declare const closeIssue: (token: string, {
+  needsApproval
+}?: ToolOptions) => ai.Tool<{
+  owner: string;
+  repo: string;
+  issueNumber: number;
+  stateReason: "completed" | "not_planned";
+}, {
+  number: number;
+  title: string;
+  state: string;
+  url: string;
+  closedAt: string | null;
+}>;
+declare const listLabels: (token: string) => ai.Tool<{
+  owner: string;
+  repo: string;
+  perPage: number;
+  page: number;
+}, {
+  name: string;
+  color: string;
+  description: string | null;
+}[]>;
+declare const addLabels: (token: string, {
+  needsApproval
+}?: ToolOptions) => ai.Tool<{
+  owner: string;
+  repo: string;
+  issueNumber: number;
+  labels: string[];
+}, {
+  name: string;
+  color: string;
+  description: string | null;
+}[]>;
+declare const removeLabel: (token: string, {
+  needsApproval
+}?: ToolOptions) => ai.Tool<{
+  owner: string;
+  repo: string;
+  issueNumber: number;
+  label: string;
+}, {
+  removed: boolean;
+  label: string;
+  issueNumber: number;
+}>;
+//#endregion
+//#region src/tools/search.d.ts
+declare const searchCode: (token: string) => ai.Tool<{
+  query: string;
+  perPage: number;
+}, {
+  totalCount: number;
+  items: {
+    name: string;
+    path: string;
+    url: string;
+    repository: string;
+    sha: string;
+  }[];
+}>;
+declare const searchRepositories: (token: string) => ai.Tool<{
+  query: string;
+  perPage: number;
+  order: "asc" | "desc";
+  sort?: "stars" | "forks" | "help-wanted-issues" | "updated" | undefined;
+}, {
+  totalCount: number;
+  items: {
+    name: string;
+    fullName: string;
+    description: string | null;
+    url: string;
+    stars: number;
+    forks: number;
+    language: string | null;
+    topics: string[] | undefined;
+  }[];
+}>;
+//#endregion
+//#region src/tools/commits.d.ts
+declare const listCommits: (token: string) => ai.Tool<{
+  owner: string;
+  repo: string;
+  perPage: number;
+  path?: string | undefined;
+  sha?: string | undefined;
+  author?: string | undefined;
+  since?: string | undefined;
+  until?: string | undefined;
+}, {
+  sha: string;
+  message: string;
+  author: string | undefined;
+  authorLogin: string | undefined;
+  date: string | undefined;
+  url: string;
+}[]>;
+declare const getCommit: (token: string) => ai.Tool<{
+  owner: string;
+  repo: string;
+  ref: string;
+}, {
+  sha: string;
+  message: string;
+  author: string | undefined;
+  authorLogin: string | undefined;
+  date: string | undefined;
+  url: string;
+  stats: {
+    additions: number | undefined;
+    deletions: number | undefined;
+    total: number | undefined;
+  } | null;
+  files: {
+    filename: string;
+    status: "added" | "removed" | "modified" | "renamed" | "copied" | "changed" | "unchanged";
+    additions: number;
+    deletions: number;
+    patch: string | undefined;
+  }[] | undefined;
+}>;
+declare const getBlame: (token: string) => ai.Tool<{
+  owner: string;
+  repo: string;
+  path: string;
+  ref?: string | undefined;
+  line?: number | undefined;
+  lineStart?: number | undefined;
+  lineEnd?: number | undefined;
+}, {
+  error: string;
+  ref?: undefined;
+  tipSha?: undefined;
+  path?: undefined;
+  rangeCount?: undefined;
+  ranges?: undefined;
+} | {
+  ref: string;
+  tipSha: string;
+  path: string;
+  rangeCount: number;
+  ranges: {
+    startingLine: number;
+    endingLine: number;
+    age: number;
+    commit: {
+      sha: string;
+      abbreviatedSha: string;
+      messageHeadline: string;
+      authoredDate: string;
+      url: string;
+      authorName: string | null;
+      authorEmail: string | null;
+      authorLogin: string | null;
+    };
+  }[];
+  error?: undefined;
+}>;
+//#endregion
+//#region src/tools/gists.d.ts
+declare const listGists: (token: string) => ai.Tool<{
+  perPage: number;
+  page: number;
+  username?: string | undefined;
+}, {
+  id: string;
+  description: string | null;
+  public: boolean;
+  url: string;
+  files: string[];
+  owner: string | undefined;
+  comments: number;
+  createdAt: string;
+  updatedAt: string;
+}[]>;
+declare const getGist: (token: string) => ai.Tool<{
+  gistId: string;
+}, {
+  id: string | undefined;
+  description: string | null | undefined;
+  public: boolean | undefined;
+  url: string | undefined;
+  owner: string | undefined;
+  files: {
+    filename: string | undefined;
+    language: string | undefined;
+    size: number | undefined;
+    content: string | undefined;
+  }[];
+  comments: number | undefined;
+  createdAt: string | undefined;
+  updatedAt: string | undefined;
+}>;
+declare const listGistComments: (token: string) => ai.Tool<{
+  gistId: string;
+  perPage: number;
+  page: number;
+}, {
+  id: number;
+  body: string;
+  author: string | undefined;
+  url: string;
+  createdAt: string;
+  updatedAt: string;
+}[]>;
+declare const createGist: (token: string, {
+  needsApproval
+}?: ToolOptions) => ai.Tool<{
+  files: Record<string, {
+    content: string;
+  }>;
+  isPublic: boolean;
+  description?: string | undefined;
+}, {
+  id: string | undefined;
+  description: string | null | undefined;
+  public: boolean | undefined;
+  url: string | undefined;
+  files: string[];
+  owner: string | undefined;
+}>;
+declare const updateGist: (token: string, {
+  needsApproval
+}?: ToolOptions) => ai.Tool<{
+  gistId: string;
+  description?: string | undefined;
+  files?: Record<string, {
+    content: string;
+  }> | undefined;
+  filesToDelete?: string[] | undefined;
+}, {
+  id: string | undefined;
+  description: string | null | undefined;
+  url: string | undefined;
+  files: string[];
+}>;
+declare const deleteGist: (token: string, {
+  needsApproval
+}?: ToolOptions) => ai.Tool<{
+  gistId: string;
+}, {
+  deleted: boolean;
+  gistId: string;
+}>;
+declare const createGistComment: (token: string, {
+  needsApproval
+}?: ToolOptions) => ai.Tool<{
+  gistId: string;
+  body: string;
+}, {
+  id: number;
+  url: string;
+  body: string;
+  author: string | undefined;
+  createdAt: string;
+}>;
+//#endregion
+//#region src/tools/workflows.d.ts
+declare const listWorkflows: (token: string) => ai.Tool<{
+  owner: string;
+  repo: string;
+  perPage: number;
+  page: number;
+}, {
+  totalCount: number;
+  workflows: {
+    id: number;
+    name: string;
+    path: string;
+    state: "active" | "deleted" | "disabled_fork" | "disabled_inactivity" | "disabled_manually";
+    url: string;
+    createdAt: string;
+    updatedAt: string;
+  }[];
+}>;
+declare const listWorkflowRuns: (token: string) => ai.Tool<{
+  owner: string;
+  repo: string;
+  perPage: number;
+  page: number;
+  workflowId?: string | number | undefined;
+  branch?: string | undefined;
+  event?: string | undefined;
+  status?: "success" | "completed" | "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "timed_out" | "in_progress" | "queued" | "requested" | "waiting" | "pending" | undefined;
+}, {
+  totalCount: number;
+  runs: {
+    id: number;
+    name: string | null | undefined;
+    status: string | null;
+    conclusion: string | null;
+    branch: string | null;
+    event: string;
+    url: string;
+    actor: string | undefined;
+    createdAt: string;
+    updatedAt: string;
+    runNumber: number;
+    runAttempt: number | undefined;
+  }[];
+}>;
+declare const getWorkflowRun: (token: string) => ai.Tool<{
+  owner: string;
+  repo: string;
+  runId: number;
+}, {
+  id: number;
+  name: string | null | undefined;
+  status: string | null;
+  conclusion: string | null;
+  branch: string | null;
+  sha: string;
+  event: string;
+  url: string;
+  actor: string | undefined;
+  runNumber: number;
+  runAttempt: number | undefined;
+  createdAt: string;
+  updatedAt: string;
+  runStartedAt: string | undefined;
+}>;
+declare const listWorkflowJobs: (token: string) => ai.Tool<{
+  owner: string;
+  repo: string;
+  runId: number;
+  filter: "all" | "latest";
+  perPage: number;
+  page: number;
+}, {
+  totalCount: number;
+  jobs: {
+    id: number;
+    name: string;
+    status: "completed" | "in_progress" | "queued" | "requested" | "waiting" | "pending";
+    conclusion: "success" | "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "timed_out" | null;
+    url: string | null;
+    startedAt: string;
+    completedAt: string | null;
+    runnerName: string | null;
+    steps: {
+      name: string;
+      status: "completed" | "in_progress" | "queued";
+      conclusion: string | null;
+      number: number;
+      startedAt: string | null | undefined;
+      completedAt: string | null | undefined;
+    }[] | undefined;
+  }[];
+}>;
+declare const triggerWorkflow: (token: string, {
+  needsApproval
+}?: ToolOptions) => ai.Tool<{
+  owner: string;
+  repo: string;
+  workflowId: string | number;
+  ref: string;
+  inputs?: Record<string, string> | undefined;
+}, {
+  triggered: boolean;
+  workflowId: string | number;
+  ref: string;
+}>;
+declare const cancelWorkflowRun: (token: string, {
+  needsApproval
+}?: ToolOptions) => ai.Tool<{
+  owner: string;
+  repo: string;
+  runId: number;
+}, {
+  cancelled: boolean;
+  runId: number;
+}>;
+declare const rerunWorkflowRun: (token: string, {
+  needsApproval
+}?: ToolOptions) => ai.Tool<{
+  owner: string;
+  repo: string;
+  runId: number;
+  onlyFailedJobs: boolean;
+}, {
+  rerun: boolean;
+  runId: number;
+  onlyFailedJobs: boolean;
+}>;
+//#endregion
+//#region src/agents.d.ts
+type AgentOptions = Omit<ToolLoopAgentSettings, 'model' | 'tools' | 'instructions'>;
+type CreateGithubAgentOptions = AgentOptions & {
+  model: ToolLoopAgentSettings['model'];
+  /**
+   * GitHub personal access token.
+   * Falls back to `process.env.GITHUB_TOKEN` when omitted.
+   */
+  token?: string;
+  preset?: GithubToolPreset | GithubToolPreset[];
+  requireApproval?: ApprovalConfig;
+  instructions?: string;
+  additionalInstructions?: string;
+};
+/**
+ * Create a pre-configured GitHub agent powered by the AI SDK's `ToolLoopAgent`.
+ *
+ * Returns a `ToolLoopAgent` instance with `.generate()` and `.stream()` methods.
+ *
+ * @example
+ * ```ts
+ * import { createGithubAgent } from '@github-tools/sdk'
+ *
+ * const agent = createGithubAgent({
+ *   model: 'anthropic/claude-sonnet-4.6',
+ *   token: process.env.GITHUB_TOKEN!,
+ *   preset: 'code-review',
+ * })
+ *
+ * const result = await agent.generate({ prompt: 'Review PR #42 on vercel/ai' })
+ * ```
+ */
+declare function createGithubAgent({
+  token,
+  preset,
+  requireApproval,
+  instructions,
+  additionalInstructions,
+  ...agentOptions
+}: CreateGithubAgentOptions): ToolLoopAgent<never, {}, never>;
+//#endregion
+export { addPullRequestComment as A, createRepository as B, addLabels as C, listIssues as D, getIssue as E, listPullRequestReviews as F, createOctokit as G, getFileContent as H, listPullRequests as I, ToolOverrides as J, Octokit$1 as K, mergePullRequest as L, createPullRequestReview as M, getPullRequest as N, listLabels as O, listPullRequestFiles as P, createBranch as R, addIssueComment as S, createIssue as T, getRepository as U, forkRepository as V, listBranches as W, getBlame as _, listWorkflowJobs as a, searchCode as b, rerunWorkflowRun as c, createGistComment as d, deleteGist as f, updateGist as g, listGists as h, getWorkflowRun as i, createPullRequest as j, removeLabel as k, triggerWorkflow as l, listGistComments as m, createGithubAgent as n, listWorkflowRuns as o, getGist as p, ToolOptions as q, cancelWorkflowRun as r, listWorkflows as s, CreateGithubAgentOptions as t, createGist as u, getCommit as v, closeIssue as w, searchRepositories as x, listCommits as y, createOrUpdateFile as z };
+//# sourceMappingURL=agents-C6nqZiYp.d.mts.map