@vercel/board 0.0.0-stage → 0.15.0

package/dist/sync-github.d.mts

@@ -0,0 +1,473 @@
+import { d as ResolvedTarget, g as UserTokens, i as ProviderDelivery, m as SyncHandler, p as SyncContext, s as ProviderPost, t as EventMapping, u as RenderInput, v as withUserTokens } from "./provider-BGjz-mDa.mjs";
+import { n as ChatSyncProvider } from "./chat-provider-XCnQlxq6.mjs";
+import { z } from "zod";
+import { Adapter } from "chat";
+//#region src/sync/github.d.ts
+export declare const GitHubPayload: z.ZodObject<{
+  pull_request: z.ZodOptional<z.ZodObject<{
+    number: z.ZodNumber;
+    title: z.ZodString;
+    html_url: z.ZodString;
+    body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    draft: z.ZodOptional<z.ZodBoolean>;
+    state: z.ZodOptional<z.ZodString>;
+    base: z.ZodOptional<z.ZodObject<{
+      ref: z.ZodString;
+    }, z.core.$loose>>;
+    head: z.ZodOptional<z.ZodObject<{
+      ref: z.ZodString;
+    }, z.core.$loose>>;
+  }, z.core.$loose>>;
+  issue: z.ZodOptional<z.ZodObject<{
+    number: z.ZodNumber;
+    title: z.ZodString;
+    html_url: z.ZodString;
+    body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    draft: z.ZodOptional<z.ZodBoolean>;
+    state: z.ZodOptional<z.ZodString>;
+    base: z.ZodOptional<z.ZodObject<{
+      ref: z.ZodString;
+    }, z.core.$loose>>;
+    head: z.ZodOptional<z.ZodObject<{
+      ref: z.ZodString;
+    }, z.core.$loose>>;
+  }, z.core.$loose>>;
+  action: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>;
+export declare const GitHubEvent: z.ZodDiscriminatedUnion<[z.ZodObject<{
+  channel: z.ZodString;
+  thread: z.ZodString;
+  subthread: z.ZodNullable<z.ZodString>;
+  kind: z.ZodLiteral<"message">;
+  message: z.ZodString;
+  isRoot: z.ZodBoolean;
+  text: z.ZodString;
+  context: z.ZodNullable<z.ZodString>;
+  author: z.ZodObject<{
+    id: z.ZodString;
+    handle: z.ZodString;
+    name: z.ZodString;
+    avatar: z.ZodNullable<z.ZodString>;
+    isBot: z.ZodBoolean;
+  }, z.core.$strip>;
+  files: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    type: z.ZodEnum<{
+      audio: "audio";
+      file: "file";
+      image: "image";
+      video: "video";
+    }>;
+    name: z.ZodOptional<z.ZodString>;
+    mimeType: z.ZodOptional<z.ZodString>;
+    size: z.ZodOptional<z.ZodNumber>;
+    url: z.ZodOptional<z.ZodString>;
+    fetchMetadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+  }, z.core.$strip>>>;
+  links: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    url: z.ZodString;
+    thread: z.ZodString;
+    message: z.ZodString;
+    snapshot: z.ZodNullable<z.ZodObject<{
+      author: z.ZodString;
+      text: z.ZodString;
+      createdAt: z.ZodNullable<z.ZodString>;
+      files: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        url: z.ZodNullable<z.ZodString>;
+      }, z.core.$strip>>;
+    }, z.core.$strip>>;
+  }, z.core.$strip>>>;
+  id: z.ZodString;
+  key: z.ZodString;
+  platform: z.ZodLiteral<"github">;
+  type: z.ZodLiteral<"comment">;
+  subject: z.ZodObject<{
+    type: z.ZodEnum<{
+      issue: "issue";
+      pull_request: "pull_request";
+    }>;
+    repo: z.ZodString;
+    number: z.ZodNumber;
+  }, z.core.$strip>;
+  raw: z.ZodObject<{
+    pull_request: z.ZodOptional<z.ZodObject<{
+      number: z.ZodNumber;
+      title: z.ZodString;
+      html_url: z.ZodString;
+      body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      draft: z.ZodOptional<z.ZodBoolean>;
+      state: z.ZodOptional<z.ZodString>;
+      base: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+      head: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+    }, z.core.$loose>>;
+    issue: z.ZodOptional<z.ZodObject<{
+      number: z.ZodNumber;
+      title: z.ZodString;
+      html_url: z.ZodString;
+      body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      draft: z.ZodOptional<z.ZodBoolean>;
+      state: z.ZodOptional<z.ZodString>;
+      base: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+      head: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+    }, z.core.$loose>>;
+    action: z.ZodOptional<z.ZodString>;
+  }, z.core.$loose>;
+}, z.core.$strip>, z.ZodObject<{
+  channel: z.ZodString;
+  thread: z.ZodString;
+  subthread: z.ZodNullable<z.ZodString>;
+  kind: z.ZodLiteral<"edited">;
+  message: z.ZodString;
+  text: z.ZodString;
+  author: z.ZodObject<{
+    id: z.ZodString;
+    handle: z.ZodString;
+    name: z.ZodString;
+    avatar: z.ZodNullable<z.ZodString>;
+    isBot: z.ZodBoolean;
+  }, z.core.$strip>;
+  links: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    url: z.ZodString;
+    thread: z.ZodString;
+    message: z.ZodString;
+    snapshot: z.ZodNullable<z.ZodObject<{
+      author: z.ZodString;
+      text: z.ZodString;
+      createdAt: z.ZodNullable<z.ZodString>;
+      files: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        url: z.ZodNullable<z.ZodString>;
+      }, z.core.$strip>>;
+    }, z.core.$strip>>;
+  }, z.core.$strip>>>;
+  linksOnly: z.ZodOptional<z.ZodBoolean>;
+  id: z.ZodString;
+  key: z.ZodString;
+  platform: z.ZodLiteral<"github">;
+  type: z.ZodLiteral<"message.edited">;
+  subject: z.ZodObject<{
+    type: z.ZodEnum<{
+      issue: "issue";
+      pull_request: "pull_request";
+    }>;
+    repo: z.ZodString;
+    number: z.ZodNumber;
+  }, z.core.$strip>;
+  raw: z.ZodObject<{
+    pull_request: z.ZodOptional<z.ZodObject<{
+      number: z.ZodNumber;
+      title: z.ZodString;
+      html_url: z.ZodString;
+      body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      draft: z.ZodOptional<z.ZodBoolean>;
+      state: z.ZodOptional<z.ZodString>;
+      base: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+      head: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+    }, z.core.$loose>>;
+    issue: z.ZodOptional<z.ZodObject<{
+      number: z.ZodNumber;
+      title: z.ZodString;
+      html_url: z.ZodString;
+      body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      draft: z.ZodOptional<z.ZodBoolean>;
+      state: z.ZodOptional<z.ZodString>;
+      base: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+      head: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+    }, z.core.$loose>>;
+    action: z.ZodOptional<z.ZodString>;
+  }, z.core.$loose>;
+}, z.core.$strip>, z.ZodObject<{
+  channel: z.ZodString;
+  thread: z.ZodString;
+  subthread: z.ZodNullable<z.ZodString>;
+  kind: z.ZodLiteral<"deleted">;
+  message: z.ZodString;
+  id: z.ZodString;
+  key: z.ZodString;
+  platform: z.ZodLiteral<"github">;
+  type: z.ZodLiteral<"message.deleted">;
+  subject: z.ZodObject<{
+    type: z.ZodEnum<{
+      issue: "issue";
+      pull_request: "pull_request";
+    }>;
+    repo: z.ZodString;
+    number: z.ZodNumber;
+  }, z.core.$strip>;
+  raw: z.ZodObject<{
+    pull_request: z.ZodOptional<z.ZodObject<{
+      number: z.ZodNumber;
+      title: z.ZodString;
+      html_url: z.ZodString;
+      body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      draft: z.ZodOptional<z.ZodBoolean>;
+      state: z.ZodOptional<z.ZodString>;
+      base: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+      head: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+    }, z.core.$loose>>;
+    issue: z.ZodOptional<z.ZodObject<{
+      number: z.ZodNumber;
+      title: z.ZodString;
+      html_url: z.ZodString;
+      body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      draft: z.ZodOptional<z.ZodBoolean>;
+      state: z.ZodOptional<z.ZodString>;
+      base: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+      head: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+    }, z.core.$loose>>;
+    action: z.ZodOptional<z.ZodString>;
+  }, z.core.$loose>;
+}, z.core.$strip>, z.ZodObject<{
+  channel: z.ZodString;
+  thread: z.ZodString;
+  subthread: z.ZodNullable<z.ZodString>;
+  kind: z.ZodLiteral<"reaction">;
+  message: z.ZodString;
+  emoji: z.ZodString;
+  added: z.ZodBoolean;
+  author: z.ZodObject<{
+    id: z.ZodString;
+    handle: z.ZodString;
+    name: z.ZodString;
+    avatar: z.ZodNullable<z.ZodString>;
+    isBot: z.ZodBoolean;
+  }, z.core.$strip>;
+  id: z.ZodString;
+  key: z.ZodString;
+  platform: z.ZodLiteral<"github">;
+  type: z.ZodEnum<{
+    "reaction.added": "reaction.added";
+    "reaction.removed": "reaction.removed";
+  }>;
+  subject: z.ZodObject<{
+    type: z.ZodEnum<{
+      issue: "issue";
+      pull_request: "pull_request";
+    }>;
+    repo: z.ZodString;
+    number: z.ZodNumber;
+  }, z.core.$strip>;
+  raw: z.ZodObject<{
+    pull_request: z.ZodOptional<z.ZodObject<{
+      number: z.ZodNumber;
+      title: z.ZodString;
+      html_url: z.ZodString;
+      body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      draft: z.ZodOptional<z.ZodBoolean>;
+      state: z.ZodOptional<z.ZodString>;
+      base: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+      head: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+    }, z.core.$loose>>;
+    issue: z.ZodOptional<z.ZodObject<{
+      number: z.ZodNumber;
+      title: z.ZodString;
+      html_url: z.ZodString;
+      body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      draft: z.ZodOptional<z.ZodBoolean>;
+      state: z.ZodOptional<z.ZodString>;
+      base: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+      head: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+    }, z.core.$loose>>;
+    action: z.ZodOptional<z.ZodString>;
+  }, z.core.$loose>;
+}, z.core.$strip>, ...(z.ZodObject<{
+  channel: z.ZodString;
+  thread: z.ZodString;
+  subthread: z.ZodNullable<z.ZodString>;
+  kind: z.ZodLiteral<"lifecycle">;
+  title: z.ZodString;
+  url: z.ZodNullable<z.ZodString>;
+  labels: z.ZodRecord<z.ZodString, z.ZodString>;
+  unset: z.ZodArray<z.ZodString>;
+  owns: z.ZodOptional<z.ZodArray<z.ZodString>>;
+  reply: z.ZodNullable<z.ZodString>;
+  createRoot: z.ZodBoolean;
+  author: z.ZodObject<{
+    id: z.ZodString;
+    handle: z.ZodString;
+    name: z.ZodString;
+    avatar: z.ZodNullable<z.ZodString>;
+    isBot: z.ZodBoolean;
+  }, z.core.$strip>;
+  id: z.ZodString;
+  key: z.ZodString;
+  platform: z.ZodLiteral<"github">;
+  type: z.ZodLiteral<"pr.assigned" | "pr.closed" | "pr.draft" | "pr.labeled" | "pr.opened" | "pr.ready" | "pr.reopened" | "pr.unassigned" | "pr.unlabeled" | "review.dismissed" | "review.submitted">;
+  subject: z.ZodObject<{
+    repo: z.ZodString;
+    number: z.ZodNumber;
+    type: z.ZodLiteral<"pull_request">;
+  }, z.core.$strip>;
+  raw: z.ZodObject<{
+    issue: z.ZodOptional<z.ZodObject<{
+      number: z.ZodNumber;
+      title: z.ZodString;
+      html_url: z.ZodString;
+      body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      draft: z.ZodOptional<z.ZodBoolean>;
+      state: z.ZodOptional<z.ZodString>;
+      base: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+      head: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+    }, z.core.$loose>>;
+    action: z.ZodOptional<z.ZodString>;
+    pull_request: z.ZodObject<{
+      number: z.ZodNumber;
+      title: z.ZodString;
+      html_url: z.ZodString;
+      body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      draft: z.ZodOptional<z.ZodBoolean>;
+      state: z.ZodOptional<z.ZodString>;
+      base: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+      head: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+    }, z.core.$loose>;
+  }, z.core.$loose>;
+}, z.core.$strip> | z.ZodObject<{
+  channel: z.ZodString;
+  thread: z.ZodString;
+  subthread: z.ZodNullable<z.ZodString>;
+  kind: z.ZodLiteral<"lifecycle">;
+  title: z.ZodString;
+  url: z.ZodNullable<z.ZodString>;
+  labels: z.ZodRecord<z.ZodString, z.ZodString>;
+  unset: z.ZodArray<z.ZodString>;
+  owns: z.ZodOptional<z.ZodArray<z.ZodString>>;
+  reply: z.ZodNullable<z.ZodString>;
+  createRoot: z.ZodBoolean;
+  author: z.ZodObject<{
+    id: z.ZodString;
+    handle: z.ZodString;
+    name: z.ZodString;
+    avatar: z.ZodNullable<z.ZodString>;
+    isBot: z.ZodBoolean;
+  }, z.core.$strip>;
+  id: z.ZodString;
+  key: z.ZodString;
+  platform: z.ZodLiteral<"github">;
+  type: z.ZodLiteral<"issue.assigned" | "issue.closed" | "issue.labeled" | "issue.opened" | "issue.reopened" | "issue.unassigned" | "issue.unlabeled">;
+  subject: z.ZodObject<{
+    repo: z.ZodString;
+    number: z.ZodNumber;
+    type: z.ZodLiteral<"issue">;
+  }, z.core.$strip>;
+  raw: z.ZodObject<{
+    pull_request: z.ZodOptional<z.ZodObject<{
+      number: z.ZodNumber;
+      title: z.ZodString;
+      html_url: z.ZodString;
+      body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      draft: z.ZodOptional<z.ZodBoolean>;
+      state: z.ZodOptional<z.ZodString>;
+      base: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+      head: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+    }, z.core.$loose>>;
+    action: z.ZodOptional<z.ZodString>;
+    issue: z.ZodObject<{
+      number: z.ZodNumber;
+      title: z.ZodString;
+      html_url: z.ZodString;
+      body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      draft: z.ZodOptional<z.ZodBoolean>;
+      state: z.ZodOptional<z.ZodString>;
+      base: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+      head: z.ZodOptional<z.ZodObject<{
+        ref: z.ZodString;
+      }, z.core.$loose>>;
+    }, z.core.$loose>;
+  }, z.core.$loose>;
+}, z.core.$strip>)[]], "type">;
+export type GitHubEvent = z.infer<typeof GitHubEvent>;
+export type GitHubHandler = SyncHandler<GitHubEvent>;
+export type GitHubRepo = EventMapping<GitHubEvent> | {
+  pulls?: EventMapping<GitHubEvent>;
+  issues?: EventMapping<GitHubEvent>;
+};
+export type GitHubOptions = {
+  /**
+   * A Vercel Connect connector (`'github/acme'`): board builds the GitHub adapter
+   * and people's sign-in, so comments they write on the board post as them.
+   * Or your own Chat SDK adapter, wrapped in `withUserTokens` to post as people.
+   */
+  adapter: Adapter | string;
+  /**
+   * The app's bot user ID, so its own comments never echo back. With a connector,
+   * board looks it up from the installation token; set it to skip that call.
+   */
+  botUserId?: number;
+  render?: (input: RenderInput) => string;
+  repos: Record<string, GitHubRepo>;
+};
+/**
+ * Syncs GitHub repos with board channels. Keys are repos (`'owner/repo'`);
+ * values are a board channel (PRs and issues become threads there), a
+ * function, or `{ pulls, issues }` to send each somewhere else. Roots never
+ * flow into GitHub: a board thread doesn't open an issue.
+ */
+export declare function github(options: GitHubOptions): GitHubProvider;
+export declare class GitHubProvider extends ChatSyncProvider<GitHubEvent> {
+  private readonly body;
+  constructor(given: GitHubOptions);
+  whoAmI(token: string): Promise<{
+    id: string;
+    handle: string;
+    name: string;
+    avatar: string | null;
+    isBot: boolean;
+  }>;
+  postAs(token: string, target: string, kind: ResolvedTarget['kind'], post: ProviderPost): Promise<ProviderDelivery>;
+  editAs(token: string, thread: string, message: string, post: ProviderPost): Promise<void>;
+  deleteAs(token: string, thread: string, message: string): Promise<void>;
+  /**
+   * A thread's root is the PR or issue itself, not a comment: its copy has no comment ID
+   * (`root:<event>` or `lifecycle:<event>`), so its reactions go on the PR or issue.
+   */
+  react(thread: string, message: string, emoji: string, added: boolean): Promise<void>;
+  event(context: Pick<SyncContext, 'id' | 'key' | 'event' | 'raw'>): GitHubEvent;
+}
+//#endregion
+export { type UserTokens, withUserTokens };