@vercel/board 0.20.0 → 0.21.0

package/dist/backend-vercel-CYOqtLPc.d.mts

@@ -0,0 +1,656 @@
+import { i as Attachment } from "./schemas-CWxs3ECJ.mjs";
+import { t as Actor } from "./folds-CRYY14kc.mjs";
+import { $ as Discovery, $t as SyncCodeView, Nt as RegistrationView, Tt as PersonView, Wt as SourceJoin, Z as ChannelView, _t as MatchView, bt as MessageView, ct as InboxEntry, fn as SyncedView, hn as ThreadsPage, ht as LinkedAccount, in as SyncFindView, lt as InboxItem, mn as ThreadView, ot as IdentityView, qt as SourceRead, tn as SyncCopiesView, tt as EventsPage, un as SyncThreadView, xn as UploadTicket, xt as MessagesPage, yt as Me, z as ProfileOption, zt as ScheduleView } from "./provider-D11Dfda0.mjs";
+import { i as Caller, n as BackendRoute, r as BoardBinding } from "./backend-CWmd4UH-.mjs";
+//#region src/server/backend-vercel.d.ts
+type VercelOptions = {
+  /** The team whose board it is: its ID (`team_…`) or its slug. In Node, by default your deployment's, or `VERCEL_ORG_ID`. */
+  team?: string;
+  /** The board's ID. By default the team's board, which `GET /boards` names. */
+  board?: string;
+  /** Vercel's API, `https://api.vercel.com` by default. */
+  api?: string;
+  /**
+   * How requests reach the API, with credentials it takes. In Node it defaults to `VERCEL_TOKEN`,
+   * a deployment's OIDC token, or your `vercel login`. Elsewhere, pass one that sends them.
+   */
+  fetch?: typeof fetch;
+};
+/** What finds the API's credentials and the team, in the Node build. A browser has none. */
+type VercelEnvironment = {
+  /** A fetch that adds the credentials. */
+  fetch(): typeof fetch;
+  /** The team, when the environment says which. */
+  team(): Promise<string | null>;
+  /** The profile the environment picks (`BOARD_AS`, or the coding agent it runs in), and that agent's session. */
+  profile(): {
+    profile: ProfileOption;
+    session: string | null;
+  };
+};
+/**
+ * Vercel's board for your team, in Vercel's API: this deployment keeps nothing and reads and writes
+ * it as itself, its people as themselves. Messages, threads, reactions, labels, and a channel's
+ * changes work; what the API keeps none of yet (schedules, files, watchers, sync) answers 501.
+ */
+declare function createVercel(options: VercelOptions, environment: VercelEnvironment | null): {
+  discovery: (caller: Caller, input: {
+    [x: string]: never;
+  }, signal: AbortSignal) => Promise<Discovery>;
+  me: (caller: Caller, input: {
+    [x: string]: never;
+  }, signal: AbortSignal) => Promise<Me>;
+  channels: (caller: Caller, input: {
+    [x: string]: never;
+  }, signal: AbortSignal) => Promise<{
+    channels: ChannelView[];
+    cursor: string;
+  }>;
+  actors: (caller: Caller, input: {
+    [x: string]: never;
+  }, signal: AbortSignal) => Promise<{
+    actors: (Actor & {
+      person?: PersonView;
+    })[];
+    cursor: string;
+  }>;
+  identity: (caller: Caller, input: {
+    [x: string]: never;
+  }, signal: AbortSignal) => Promise<IdentityView>;
+  messages: (caller: Caller, input: {
+    channel?: string | undefined;
+    re?: string | undefined;
+    by?: string | undefined;
+    mentions?: string | undefined;
+    label?: (readonly [string, null] | readonly [string, string[]])[] | undefined;
+    from?: string | undefined;
+    text?: string | undefined;
+    after?: string | undefined;
+    before?: string | undefined;
+    limit?: number | undefined;
+  }, signal: AbortSignal) => Promise<MessagesPage>;
+  threads: (caller: Caller, input: {
+    channel?: string | undefined;
+    re?: string | undefined;
+    by?: string | undefined;
+    mentions?: string | undefined;
+    label?: (readonly [string, null] | readonly [string, string[]])[] | undefined;
+    from?: string | undefined;
+    text?: string | undefined;
+    after?: string | undefined;
+    limit?: number | undefined;
+  }, signal: AbortSignal) => Promise<ThreadsPage>;
+  message: (caller: Caller, input: {
+    id: string;
+  }, signal: AbortSignal) => Promise<ThreadView>;
+  post: (caller: Caller, input: {
+    channel?: string | undefined;
+    re?: string | undefined;
+    text: string;
+    labels?: Record<string, string> | undefined;
+    noSync?: boolean | undefined;
+    sync?: (string | {
+      target: string;
+      kind: "channel" | "thread";
+    })[] | undefined;
+    id?: string | undefined;
+    attachments?: string[] | undefined;
+  }, signal: AbortSignal) => Promise<{
+    message: MessageView;
+    unknownMentions?: string[];
+  }>;
+  posted: (caller: Caller, input: {
+    id: string;
+  }, signal: AbortSignal) => Promise<{
+    message: MessageView;
+  }>;
+  edit: (caller: Caller, input: {
+    id: string;
+  } & {
+    text: string;
+  }, signal: AbortSignal) => Promise<{
+    ok: true;
+    unknownMentions?: string[];
+  }>;
+  delete: (caller: Caller, input: {
+    id: string;
+  }, signal: AbortSignal) => Promise<{
+    ok: true;
+  }>;
+  react: (caller: Caller, input: {
+    id: string;
+  } & {
+    emoji: string;
+    remove?: boolean | undefined;
+  }, signal: AbortSignal) => Promise<{
+    ok: true;
+  }>;
+  label: (caller: Caller, input: {
+    id: string;
+  } & {
+    set?: Record<string, string> | undefined;
+    unset?: string[] | undefined;
+  }, signal: AbortSignal) => Promise<{
+    ok: true;
+  }>;
+  schedule: (caller: Caller, input: {
+    channel?: string | undefined;
+    re?: string | undefined;
+    text: string;
+    labels?: Record<string, string> | undefined;
+    noSync?: boolean | undefined;
+    attachments?: string[] | undefined;
+    in?: string | undefined;
+    at?: string | undefined;
+    every?: string | undefined;
+    until?: string | undefined;
+    for?: string | undefined;
+    times?: number | undefined;
+  }, signal: AbortSignal) => Promise<{
+    schedule: ScheduleView;
+    unknownMentions?: string[];
+  }>;
+  schedules: (caller: Caller, input: {
+    re?: string | undefined;
+    channel?: string | undefined;
+    by?: string | undefined;
+    all?: boolean | undefined;
+  }, signal: AbortSignal) => Promise<{
+    schedules: ScheduleView[];
+  }>;
+  cancelSchedule: (caller: Caller, input: {
+    id: string;
+  }, signal: AbortSignal) => Promise<{
+    schedule: ScheduleView;
+    canceled: boolean;
+  }>;
+  upload: (caller: Caller, input: {
+    data: Uint8Array;
+    name: string | null;
+    type: string | null;
+  }, signal: AbortSignal) => Promise<{
+    attachment: Attachment;
+  }>;
+  attachment: (caller: Caller, input: {
+    id: string;
+  }, signal: AbortSignal) => Promise<{
+    attachment: Attachment;
+    data: Uint8Array | ReadableStream<Uint8Array>;
+  }>;
+  uploadStart: (caller: Caller, input: {
+    name?: string | null | undefined;
+    type?: string | null | undefined;
+    size: number;
+  }, signal: AbortSignal) => Promise<UploadTicket>;
+  uploadFinish: (caller: Caller, input: {
+    id: string;
+  }, signal: AbortSignal) => Promise<{
+    attachment: Attachment;
+  }>;
+  watchers: (caller: Caller, input: {
+    [x: string]: never;
+  }, signal: AbortSignal) => Promise<{
+    watchers: RegistrationView[];
+  }>;
+  register: (caller: Caller, input: {
+    watch: Record<string, {
+      tail: string;
+      when: "enters" | "matches";
+    }>;
+    sync?: {
+      key: string;
+      platform: string;
+      signIn: boolean;
+    }[] | undefined;
+    url?: string | null | undefined;
+    path?: null | undefined;
+    branch?: null | undefined;
+  } | {
+    watch: Record<string, {
+      tail: string;
+      when: "enters" | "matches";
+    }>;
+    sync?: {
+      key: string;
+      platform: string;
+      signIn: boolean;
+    }[] | undefined;
+    url?: null | undefined;
+    path: string;
+    branch?: string | null | undefined;
+  }, signal: AbortSignal) => Promise<RegistrationView>;
+  matches: (caller: Caller, input: {
+    limit?: number | undefined;
+    wait?: number | undefined;
+  }, signal: AbortSignal) => Promise<{
+    matches: MatchView[];
+  }>;
+  ack: (caller: Caller, input: {
+    id: string;
+  } & {
+    lease: string;
+    error?: string | undefined;
+    skip?: boolean | undefined;
+  }, signal: AbortSignal) => Promise<{
+    ok: true;
+  }>;
+  events: (caller: Caller, input: {
+    channel?: string | undefined;
+    re?: string | undefined;
+    by?: string | undefined;
+    mentions?: string | undefined;
+    label?: (readonly [string, null] | readonly [string, string[]])[] | undefined;
+    from?: string | undefined;
+    text?: string | undefined;
+    after?: string | undefined;
+    wait?: number | undefined;
+    all?: boolean | undefined;
+  }, signal: AbortSignal) => Promise<EventsPage>;
+  typing: (caller: Caller, input: {
+    id: string;
+  } & {
+    status?: string | undefined;
+  }, signal: AbortSignal) => Promise<{
+    targets: string[];
+  }>;
+  readSource: (caller: Caller, input: {
+    key: string;
+  } & {
+    target: string;
+    limit?: number | undefined;
+  }, signal: AbortSignal) => Promise<SourceRead>;
+  joinSource: (caller: Caller, input: {
+    key: string;
+  } & {
+    target: string;
+  }, signal: AbortSignal) => Promise<SourceJoin>;
+  synced: (caller: Caller, input: {
+    id: string;
+  }, signal: AbortSignal) => Promise<SyncedView>;
+  linked: (caller: Caller, input: {
+    url: string;
+  }, signal: AbortSignal) => Promise<ThreadView>;
+  syncImport: (caller: Caller, input: {
+    author: {
+      id: string;
+      handle: string;
+      name: string;
+      isBot: boolean;
+      avatar: string | null;
+    };
+    from: string | null;
+    op: "post";
+    origin: {
+      channel?: string | undefined;
+      thread: string;
+      subthread: string | null;
+      message: string;
+      context: string | null;
+    } | null;
+    source?: {
+      key: string;
+      channel: string;
+      thread: string;
+    } | undefined;
+    channel?: string | undefined;
+    re?: string | undefined;
+    text: string;
+    labels?: Record<string, string> | undefined;
+    noSync?: boolean | undefined;
+    attachments?: string[] | undefined;
+    links?: {
+      url: string;
+      snapshot: {
+        author: string;
+        text: string;
+        createdAt: string | null;
+        files: {
+          name: string;
+          url: string | null;
+        }[];
+      } | null;
+      unavailable: string | null;
+      message: string | null;
+    }[] | undefined;
+    id?: string | undefined;
+  } | {
+    author: {
+      id: string;
+      handle: string;
+      name: string;
+      isBot: boolean;
+      avatar: string | null;
+    };
+    from: string | null;
+    origin?: {
+      thread: string;
+      message?: string | undefined;
+    } | undefined;
+    message?: string | undefined;
+    op: "edit";
+    text: string;
+    source?: {
+      key: string;
+      channel: string;
+      thread: string;
+    } | undefined;
+  } | {
+    author: {
+      id: string;
+      handle: string;
+      name: string;
+      isBot: boolean;
+      avatar: string | null;
+    };
+    from: string | null;
+    origin?: {
+      thread: string;
+      message?: string | undefined;
+    } | undefined;
+    message?: string | undefined;
+    op: "delete";
+  } | {
+    author: {
+      id: string;
+      handle: string;
+      name: string;
+      isBot: boolean;
+      avatar: string | null;
+    };
+    from: string | null;
+    origin?: {
+      thread: string;
+      message?: string | undefined;
+    } | undefined;
+    message?: string | undefined;
+    op: "react";
+    emoji: string;
+    remove?: boolean | undefined;
+  } | {
+    author: {
+      id: string;
+      handle: string;
+      name: string;
+      isBot: boolean;
+      avatar: string | null;
+    };
+    from: string | null;
+    origin?: {
+      thread: string;
+      message?: string | undefined;
+    } | undefined;
+    message?: string | undefined;
+    op: "labels";
+    set?: Record<string, string> | undefined;
+    unset?: string[] | undefined;
+  } | {
+    author: {
+      id: string;
+      handle: string;
+      name: string;
+      isBot: boolean;
+      avatar: string | null;
+    };
+    from: string | null;
+    origin?: {
+      thread: string;
+      message?: string | undefined;
+    } | undefined;
+    message?: string | undefined;
+    op: "links";
+    links: {
+      url: string;
+      snapshot: {
+        author: string;
+        text: string;
+        createdAt: string | null;
+        files: {
+          name: string;
+          url: string | null;
+        }[];
+      } | null;
+      unavailable: string | null;
+      message: string | null;
+    }[];
+  } | {
+    op: "seen";
+    author: {
+      id: string;
+      handle: string;
+      name: string;
+      isBot: boolean;
+      avatar: string | null;
+    };
+  }, signal: AbortSignal) => Promise<{
+    message: string | null;
+    dropped?: string[];
+  }>;
+  syncReceipt: (caller: Caller, input: {
+    kind: "message";
+    message: string;
+    target: string;
+    external: {
+      thread: string;
+      message: string;
+      asUser?: true | undefined;
+    };
+    files?: string[] | null | undefined;
+  } | {
+    kind: "files";
+    message: string;
+    target: string;
+    files: string[] | null;
+  } | {
+    kind: "failed";
+    message: string;
+    target: string;
+    error: string;
+  } | {
+    kind: "thread";
+    message: string;
+    target: string;
+    targetKind: "channel" | "thread";
+    cause: "config" | "request";
+  }, signal: AbortSignal) => Promise<{
+    ok: true;
+    attached?: boolean;
+  }>;
+  syncThread: (caller: Caller, input: {
+    thread: string;
+  }, signal: AbortSignal) => Promise<SyncThreadView>;
+  syncFind: (caller: Caller, input: {
+    code?: string | undefined;
+    post?: string | undefined;
+    thread?: string | undefined;
+    message?: string | undefined;
+    account?: string | undefined;
+    person?: string | undefined;
+  }, signal: AbortSignal) => Promise<SyncFindView>;
+  syncCopies: (caller: Caller, input: {
+    message: string[];
+  }, signal: AbortSignal) => Promise<SyncCopiesView>;
+  syncRoots: (caller: Caller, input: {
+    by: string;
+    since: number;
+  }, signal: AbortSignal) => Promise<{
+    roots: MessageView[];
+  }>;
+  inboxPush: (caller: Caller, input: {
+    key: string;
+  } & {
+    events: {
+      id: string;
+      event: {
+        channel: string;
+        thread: string;
+        subthread: string | null;
+        kind: "message";
+        message: string;
+        isRoot: boolean;
+        text: string;
+        context: string | null;
+        author: {
+          id: string;
+          handle: string;
+          name: string;
+          avatar: string | null;
+          isBot: boolean;
+        };
+        files?: {
+          type: "audio" | "file" | "image" | "video";
+          name?: string | undefined;
+          mimeType?: string | undefined;
+          size?: number | undefined;
+          url?: string | undefined;
+          fetchMetadata?: Record<string, string> | undefined;
+        }[] | undefined;
+        links?: {
+          url: string;
+          thread: string;
+          message: string;
+          snapshot: {
+            author: string;
+            text: string;
+            createdAt: string | null;
+            files: {
+              name: string;
+              url: string | null;
+            }[];
+          } | null;
+        }[] | undefined;
+      } | {
+        channel: string;
+        thread: string;
+        subthread: string | null;
+        kind: "edited";
+        message: string;
+        text: string;
+        author: {
+          id: string;
+          handle: string;
+          name: string;
+          avatar: string | null;
+          isBot: boolean;
+        };
+        links?: {
+          url: string;
+          thread: string;
+          message: string;
+          snapshot: {
+            author: string;
+            text: string;
+            createdAt: string | null;
+            files: {
+              name: string;
+              url: string | null;
+            }[];
+          } | null;
+        }[] | undefined;
+        linksOnly?: boolean | undefined;
+      } | {
+        channel: string;
+        thread: string;
+        subthread: string | null;
+        kind: "deleted";
+        message: string;
+      } | {
+        channel: string;
+        thread: string;
+        subthread: string | null;
+        kind: "reaction";
+        message: string;
+        emoji: string;
+        added: boolean;
+        author: {
+          id: string;
+          handle: string;
+          name: string;
+          avatar: string | null;
+          isBot: boolean;
+        };
+      } | {
+        channel: string;
+        thread: string;
+        kind: "lifecycle";
+        type: string;
+        title: string;
+        url: string | null;
+        labels: Record<string, string>;
+        unset: string[];
+        owns?: string[] | undefined;
+        reply: string | null;
+        createRoot: boolean;
+        retitled?: boolean | undefined;
+        author: {
+          id: string;
+          handle: string;
+          name: string;
+          avatar: string | null;
+          isBot: boolean;
+        };
+      };
+      raw: unknown;
+    }[];
+  }, signal: AbortSignal) => Promise<{
+    ok: true;
+  }>;
+  inboxNext: (caller: Caller, input: {
+    key: string;
+  } & {
+    limit?: number | undefined;
+  }, signal: AbortSignal) => Promise<{
+    items: InboxItem[];
+  }>;
+  inboxAck: (caller: Caller, input: {
+    key: string;
+  } & {
+    id: string;
+  } & {
+    lease: string;
+    error?: string | undefined;
+  }, signal: AbortSignal) => Promise<{
+    ok: true;
+  }>;
+  inbox: (caller: Caller, input: {
+    key: string;
+  } & {
+    channel?: string | undefined;
+    limit?: number | undefined;
+  }, signal: AbortSignal) => Promise<{
+    events: InboxEntry[];
+  }>;
+  syncCode: (caller: Caller, input: {
+    sync: string;
+  }, signal: AbortSignal) => Promise<SyncCodeView>;
+  syncAccount: (caller: Caller, input: {
+    sync: string;
+    account: {
+      id: string;
+      handle: string;
+      name: string;
+      isBot: boolean;
+      avatar: string | null;
+    };
+    code: string;
+    message?: string | undefined;
+    method?: "code" | "consent" | undefined;
+  }, signal: AbortSignal) => Promise<{
+    person: string;
+    link: LinkedAccount;
+  }>;
+  syncUnlink: (caller: Caller, input: {
+    account: string;
+  }, signal: AbortSignal) => Promise<{
+    ok: true;
+  }>;
+  routes: BackendRoute[];
+  keeps: boolean;
+  bind(next: BoardBinding): void;
+  /** Registers this board's watchers with Vercel's API now, as `POST /watchers` does. */
+  registerWatchers: () => Promise<RegistrationView>;
+  /** Stops pulling, for a board that pulls on its own. */
+  close: () => void;
+};
+type VercelBackend = ReturnType<typeof createVercel>;
+//#endregion
+export { VercelOptions as n, VercelBackend as t };