@github-tools/sdk 1.2.0 → 1.4.0

package/dist/workflow.d.mts

@@ -0,0 +1,727 @@
+import { n as createGithubAgent, t as CreateGithubAgentOptions } from "./agents-C6nqZiYp.mjs";
+import { ApprovalConfig, GithubToolPreset, GithubTools, GithubToolsOptions, GithubWriteToolName, createGithubTools } from "./index.mjs";
+import * as ai from "ai";
+import { CompatibleLanguageModel, DurableAgent } from "@workflow/ai/agent";
+
+//#region src/workflow.d.ts
+type CreateDurableGithubAgentOptions = {
+  model: string | CompatibleLanguageModel | (() => Promise<CompatibleLanguageModel>);
+  /**
+   * GitHub personal access token.
+   * Falls back to `process.env.GITHUB_TOKEN` when omitted.
+   */
+  token?: string;
+  preset?: GithubToolPreset | GithubToolPreset[];
+  requireApproval?: ApprovalConfig;
+  instructions?: string;
+  additionalInstructions?: string; /** Maximum number of LLM calls before stopping. Unlimited by default. */
+  maxSteps?: number;
+  temperature?: number;
+};
+/**
+ * Create a pre-configured durable GitHub agent powered by Vercel Workflow SDK's `DurableAgent`.
+ *
+ * Each tool call runs as a durable step with automatic retries and observability.
+ * Must be used inside a `"use workflow"` function.
+ *
+ * **Note:** `requireApproval` is accepted for forward-compatibility but is currently
+ * ignored by `DurableAgent` — the Workflow SDK does not yet support interactive tool
+ * approval. All tools execute immediately without user confirmation.
+ *
+ * @example
+ * ```ts
+ * import { createDurableGithubAgent } from '@github-tools/sdk/workflow'
+ * import { getWritable } from 'workflow'
+ * import type { ModelMessage, UIMessageChunk } from 'ai'
+ *
+ * async function chatWorkflow(messages: ModelMessage[], token: string) {
+ *   "use workflow"
+ *   const agent = createDurableGithubAgent({
+ *     model: 'anthropic/claude-sonnet-4.6',
+ *     token,
+ *     preset: 'code-review',
+ *   })
+ *   const writable = getWritable<UIMessageChunk>()
+ *   await agent.stream({ messages, writable })
+ * }
+ * ```
+ */
+declare function createDurableGithubAgent({
+  model,
+  token,
+  preset,
+  requireApproval,
+  instructions,
+  additionalInstructions,
+  ...agentOptions
+}: CreateDurableGithubAgentOptions): DurableAgent<Partial<{
+  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;
+  }>;
+  getBlame: 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;
+  }>;
+  createBranch: ai.Tool<{
+    owner: string;
+    repo: string;
+    branch: string;
+    from?: string | undefined;
+  }, {
+    ref: string;
+    sha: string;
+    url: string;
+  }>;
+  forkRepository: 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;
+  }>;
+  createRepository: 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;
+  }>;
+  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;
+  }>;
+  listPullRequestFiles: 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;
+  }[]>;
+  listPullRequestReviews: 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;
+  }[]>;
+  createPullRequestReview: 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;
+  }>;
+  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;
+  }>;
+  listLabels: ai.Tool<{
+    owner: string;
+    repo: string;
+    perPage: number;
+    page: number;
+  }, {
+    name: string;
+    color: string;
+    description: string | null;
+  }[]>;
+  addLabels: ai.Tool<{
+    owner: string;
+    repo: string;
+    issueNumber: number;
+    labels: string[];
+  }, {
+    name: string;
+    color: string;
+    description: string | null;
+  }[]>;
+  removeLabel: ai.Tool<{
+    owner: string;
+    repo: string;
+    issueNumber: number;
+    label: string;
+  }, {
+    removed: boolean;
+    label: string;
+    issueNumber: number;
+  }>;
+  listGists: 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;
+  }[]>;
+  getGist: 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;
+  }>;
+  listGistComments: ai.Tool<{
+    gistId: string;
+    perPage: number;
+    page: number;
+  }, {
+    id: number;
+    body: string;
+    author: string | undefined;
+    url: string;
+    createdAt: string;
+    updatedAt: string;
+  }[]>;
+  createGist: 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;
+  }>;
+  updateGist: 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[];
+  }>;
+  deleteGist: ai.Tool<{
+    gistId: string;
+  }, {
+    deleted: boolean;
+    gistId: string;
+  }>;
+  createGistComment: ai.Tool<{
+    gistId: string;
+    body: string;
+  }, {
+    id: number;
+    url: string;
+    body: string;
+    author: string | undefined;
+    createdAt: string;
+  }>;
+  listWorkflows: 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;
+    }[];
+  }>;
+  listWorkflowRuns: 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;
+    }[];
+  }>;
+  getWorkflowRun: 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;
+  }>;
+  listWorkflowJobs: 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;
+    }[];
+  }>;
+  triggerWorkflow: ai.Tool<{
+    owner: string;
+    repo: string;
+    workflowId: string | number;
+    ref: string;
+    inputs?: Record<string, string> | undefined;
+  }, {
+    triggered: boolean;
+    workflowId: string | number;
+    ref: string;
+  }>;
+  cancelWorkflowRun: ai.Tool<{
+    owner: string;
+    repo: string;
+    runId: number;
+  }, {
+    cancelled: boolean;
+    runId: number;
+  }>;
+  rerunWorkflowRun: ai.Tool<{
+    owner: string;
+    repo: string;
+    runId: number;
+    onlyFailedJobs: boolean;
+  }, {
+    rerun: boolean;
+    runId: number;
+    onlyFailedJobs: boolean;
+  }>;
+}>>;
+//#endregion
+export { type ApprovalConfig, CreateDurableGithubAgentOptions, type CreateGithubAgentOptions, type GithubToolPreset, type GithubTools, type GithubToolsOptions, type GithubWriteToolName, createDurableGithubAgent, createGithubAgent, createGithubTools };
+//# sourceMappingURL=workflow.d.mts.map

package/dist/workflow.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow.d.mts","names":[],"sources":["../src/workflow.ts"],"mappings":";;;;;;KAMY,+BAAA;EACV,KAAA,WAAgB,uBAAA,UAAiC,OAAA,CAAQ,uBAAA;;AAD3D;;;EAME,KAAA;EACA,MAAA,GAAS,gBAAA,GAAmB,gBAAA;EAC5B,eAAA,GAAkB,cAAA;EAClB,YAAA;EACA,sBAAA,WAFkB;EAIlB,QAAA;EACA,WAAA;AAAA;;;;;;;;;;;;;;;;AA+BF;;;;;;;;;;;;;iBAAgB,wBAAA,CAAA;EACd,KAAA;EACA,KAAA;EACA,MAAA;EACA,eAAA;EACA,YAAA;EACA,sBAAA;EAAA,GACG;AAAA,GACF,+BAAA,GAA+B,YAAA,CAAA,OAAA;iBAAA,EAAA,CAAA,IAAA"}