@github-tools/sdk 0.0.1

package/dist/index.d.mts

@@ -0,0 +1,689 @@
+import { Octokit, Octokit as Octokit$1 } from "@octokit/rest";
+import * as ai from "ai";
+
+//#region src/client.d.ts
+declare function createOctokit(token: string): Octokit$1;
+//#endregion
+//#region src/types.d.ts
+type ToolOptions = {
+  needsApproval?: boolean;
+};
+//#endregion
+//#region src/tools/repository.d.ts
+declare const getRepository: (octokit: Octokit) => 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: (octokit: Octokit) => ai.Tool<{
+  owner: string;
+  repo: string;
+  perPage: number;
+}, {
+  name: string;
+  sha: string;
+  protected: boolean;
+}[]>;
+declare const getFileContent: (octokit: Octokit) => 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 createOrUpdateFile: (octokit: Octokit, {
+  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: (octokit: Octokit) => 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: (octokit: Octokit) => 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: (octokit: Octokit, {
+  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: (octokit: Octokit, {
+  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: (octokit: Octokit, {
+  needsApproval
+}?: ToolOptions) => ai.Tool<{
+  owner: string;
+  repo: string;
+  pullNumber: number;
+  body: string;
+}, {
+  id: number;
+  url: string;
+  body: string | undefined;
+  author: string | undefined;
+  createdAt: string;
+}>;
+//#endregion
+//#region src/tools/issues.d.ts
+declare const listIssues: (octokit: Octokit) => 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: (octokit: Octokit) => 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: (octokit: Octokit, {
+  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: (octokit: Octokit, {
+  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: (octokit: Octokit, {
+  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;
+}>;
+//#endregion
+//#region src/tools/search.d.ts
+declare const searchCode: (octokit: Octokit) => ai.Tool<{
+  query: string;
+  perPage: number;
+}, {
+  totalCount: number;
+  items: {
+    name: string;
+    path: string;
+    url: string;
+    repository: string;
+    sha: string;
+  }[];
+}>;
+declare const searchRepositories: (octokit: Octokit) => 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: (octokit: Octokit) => 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: (octokit: Octokit) => 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;
+}>;
+//#endregion
+//#region src/index.d.ts
+type GithubWriteToolName = 'createOrUpdateFile' | 'createPullRequest' | 'mergePullRequest' | 'addPullRequestComment' | 'createIssue' | 'addIssueComment' | 'closeIssue';
+/**
+ * Whether write operations require user approval.
+ * - `true`  — all write tools need approval (default)
+ * - `false` — no approval needed for any write tool
+ * - object  — per-tool override; unspecified write tools default to `true`
+ *
+ * @example
+ * ```ts
+ * // Only merging and file changes need approval, comments are fine
+ * requireApproval: {
+ *   mergePullRequest: true,
+ *   createOrUpdateFile: true,
+ *   addPullRequestComment: false,
+ *   addIssueComment: false,
+ * }
+ * ```
+ */
+type ApprovalConfig = boolean | Partial<Record<GithubWriteToolName, boolean>>;
+type GithubToolsOptions = {
+  token: string;
+  requireApproval?: ApprovalConfig;
+};
+/**
+ * Create a set of GitHub tools for the Vercel AI SDK.
+ *
+ * Write operations require user approval by default.
+ * Control this globally or per-tool via `requireApproval`.
+ *
+ * @example
+ * ```ts
+ * // All writes need approval (default)
+ * createGithubTools({ token })
+ *
+ * // No approval at all
+ * createGithubTools({ token, requireApproval: false })
+ *
+ * // Granular: only destructive actions need approval
+ * createGithubTools({
+ *   token,
+ *   requireApproval: {
+ *     mergePullRequest: true,
+ *     createOrUpdateFile: true,
+ *     closeIssue: true,
+ *     createPullRequest: false,
+ *     addPullRequestComment: false,
+ *     createIssue: false,
+ *     addIssueComment: false,
+ *   }
+ * })
+ * ```
+ */
+declare function createGithubTools({
+  token,
+  requireApproval
+}: GithubToolsOptions): {
+  getRepository: 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;
+  }>;
+  listBranches: ai.Tool<{
+    owner: string;
+    repo: string;
+    perPage: number;
+  }, {
+    name: string;
+    sha: string;
+    protected: boolean;
+  }[]>;
+  getFileContent: 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;
+  }>;
+  listPullRequests: 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;
+  }[]>;
+  getPullRequest: 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;
+  }>;
+  listIssues: 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;
+  }[]>;
+  getIssue: 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;
+  }>;
+  searchCode: ai.Tool<{
+    query: string;
+    perPage: number;
+  }, {
+    totalCount: number;
+    items: {
+      name: string;
+      path: string;
+      url: string;
+      repository: string;
+      sha: string;
+    }[];
+  }>;
+  searchRepositories: 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;
+    }[];
+  }>;
+  listCommits: 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;
+  }[]>;
+  getCommit: 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;
+  }>;
+  createOrUpdateFile: 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;
+  }>;
+  createPullRequest: 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;
+  }>;
+  mergePullRequest: ai.Tool<{
+    owner: string;
+    repo: string;
+    pullNumber: number;
+    mergeMethod: "merge" | "squash" | "rebase";
+    commitTitle?: string | undefined;
+    commitMessage?: string | undefined;
+  }, {
+    merged: boolean;
+    message: string;
+    sha: string;
+  }>;
+  addPullRequestComment: ai.Tool<{
+    owner: string;
+    repo: string;
+    pullNumber: number;
+    body: string;
+  }, {
+    id: number;
+    url: string;
+    body: string | undefined;
+    author: string | undefined;
+    createdAt: string;
+  }>;
+  createIssue: 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)[];
+  }>;
+  addIssueComment: ai.Tool<{
+    owner: string;
+    repo: string;
+    issueNumber: number;
+    body: string;
+  }, {
+    id: number;
+    url: string;
+    body: string | undefined;
+    author: string | undefined;
+    createdAt: string;
+  }>;
+  closeIssue: ai.Tool<{
+    owner: string;
+    repo: string;
+    issueNumber: number;
+    stateReason: "completed" | "not_planned";
+  }, {
+    number: number;
+    title: string;
+    state: string;
+    url: string;
+    closedAt: string | null;
+  }>;
+};
+type GithubTools = ReturnType<typeof createGithubTools>;
+//#endregion
+export { ApprovalConfig, GithubTools, GithubToolsOptions, GithubWriteToolName, type Octokit, type ToolOptions, addIssueComment, addPullRequestComment, closeIssue, createGithubTools, createIssue, createOctokit, createOrUpdateFile, createPullRequest, getCommit, getFileContent, getIssue, getPullRequest, getRepository, listBranches, listCommits, listIssues, listPullRequests, mergePullRequest, searchCode, searchRepositories };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/client.ts","../src/types.ts","../src/tools/repository.ts","../src/tools/pull-requests.ts","../src/tools/issues.ts","../src/tools/search.ts","../src/tools/commits.ts","../src/index.ts"],"mappings":";;;;iBAEgB,aAAA,CAAc,KAAA,WAAgB,SAAA;;;KCAlC,WAAA;EAAgB,aAAA;AAAA;;;cCEf,aAAA,GAAiB,OAAA,EAAS,OAAA,KAAO,EAAA,CAAA,IAAA;;;;;;;;;;;;;;;;;cA0BjC,YAAA,GAAgB,OAAA,EAAS,OAAA,KAAO,EAAA,CAAA,IAAA;;;;;;;;;cAkBhC,cAAA,GAAkB,OAAA,EAAS,OAAA,KAAO,EAAA,CAAA,IAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cA4BlC,kBAAA,GAAsB,OAAA,EAAS,OAAA;EAAS;AAAA,IAA0B,WAAA,KAAgB,EAAA,CAAA,IAAA;;;;;;;;;;;;;;;;cCxElF,gBAAA,GAAoB,OAAA,EAAS,OAAA,KAAO,EAAA,CAAA,IAAA;;;;;;;;;;;;;;;;;cA0BpC,cAAA,GAAkB,OAAA,EAAS,OAAA,KAAO,EAAA,CAAA,IAAA;;;;;;;;;;;;;;;;;;;;;;;cAgClC,iBAAA,GAAqB,OAAA,EAAS,OAAA;EAAS;AAAA,IAA0B,WAAA,KAAgB,EAAA,CAAA,IAAA;;;;;;;;;;;;;;;;;cA2BjF,gBAAA,GAAoB,OAAA,EAAS,OAAA;EAAS;AAAA,IAA0B,WAAA,KAAgB,EAAA,CAAA,IAAA;;;;;;;;;;;;cA6BhF,qBAAA,GAAyB,OAAA,EAAS,OAAA;EAAS;AAAA,IAA0B,WAAA,KAAgB,EAAA,CAAA,IAAA;;;;;;;;;;;;;;cClHrF,UAAA,GAAc,OAAA,EAAS,OAAA,KAAO,EAAA,CAAA,IAAA;;;;;;;;;;;;;;;;cAiC9B,QAAA,GAAY,OAAA,EAAS,OAAA,KAAO,EAAA,CAAA,IAAA;;;;;;;;;;;;;;;;;;cA2B5B,WAAA,GAAe,OAAA,EAAS,OAAA;EAAS;AAAA,IAA0B,WAAA,KAAgB,EAAA,CAAA,IAAA;;;;;;;;;;;;;;cAwB3E,eAAA,GAAmB,OAAA,EAAS,OAAA;EAAS;AAAA,IAA0B,WAAA,KAAgB,EAAA,CAAA,IAAA;;;;;;;;;;;;cAsB/E,UAAA,GAAc,OAAA,EAAS,OAAA;EAAS;AAAA,IAA0B,WAAA,KAAgB,EAAA,CAAA,IAAA;;;;;;;;;;;;;;cC1G1E,UAAA,GAAc,OAAA,EAAS,OAAA,KAAO,EAAA,CAAA,IAAA;;;;;;;;;;;;;cAsB9B,kBAAA,GAAsB,OAAA,EAAS,OAAA,KAAO,EAAA,CAAA,IAAA;;;;;;;;;;;;;;;;;;;;cCtBtC,WAAA,GAAe,OAAA,EAAS,OAAA,KAAO,EAAA,CAAA,IAAA;;;;;;;;;;;;;;;;;cAmC/B,SAAA,GAAa,OAAA,EAAS,OAAA,KAAO,EAAA,CAAA,IAAA;;;;;;;;;;;;;;;;;;;;;;;;;;KChC9B,mBAAA;;;;APLZ;;;;;;;;ACAA;;;;;;KM+BY,cAAA,aAA2B,OAAA,CAAQ,MAAA,CAAO,mBAAA;AAAA,KAE1C,kBAAA;EACV,KAAA;EACA,eAAA,GAAkB,cAAA;AAAA;;;;;;;;;;;;;;;;;;;;;ALPpB;;;;;;;;;iBK4CgB,iBAAA,CAAA;EAAoB,KAAA;EAAO;AAAA,GAA0B,kBAAA;iBAAkB,EAAA,CAAA,IAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KA4B3E,WAAA,GAAc,UAAA,QAAkB,iBAAA"}