@vercel/slack-bolt 1.3.1 → 1.4.1

package/dist/index.d.ts

@@ -1,6 +1,8 @@
-import { Receiver, StringIndexed, App } from '@slack/bolt';
-import { Logger, LogLevel } from '@slack/logger';
+import { App, Receiver, StringIndexed } from "@slack/bolt";
+import { LogLevel, Logger } from "@slack/logger";
+import { CallbackOptions, InstallPathOptions, InstallProvider, InstallProviderOptions, StateStore } from "@slack/oauth";
 
+//#region src/index.d.ts
 /**
  * A function to handle the request from the Slack app.
  * @param req - The request from the Slack app.
@@ -15,38 +17,97 @@ type VercelHandler = (req: Request) => Promise<Response>;
  * @property logLevel - The log level to use for the VercelReceiver.
  * @property customPropertiesExtractor - A function to extract custom properties from the request.
  */
+/**
+ * Options for customizing the OAuth installer behavior.
+ * Mirrors the relevant subset of HTTPReceiverInstallerOptions,
+ * excluding path-related options (serverless uses file-based routing).
+ */
+interface VercelInstallerOptions {
+  directInstall?: boolean;
+  renderHtmlForInstallPath?: (url: string) => string;
+  stateStore?: StateStore;
+  stateVerification?: boolean;
+  legacyStateVerification?: boolean;
+  stateCookieName?: string;
+  stateCookieExpirationSeconds?: number;
+  authVersion?: "v1" | "v2";
+  clientOptions?: InstallProviderOptions["clientOptions"];
+  authorizationUrl?: string;
+  metadata?: string;
+  userScopes?: string[];
+  installPathOptions?: InstallPathOptions;
+  callbackOptions?: CallbackOptions;
+}
+/**
+ * Configuration options for the VercelReceiver.
+ */
 interface VercelReceiverOptions {
-    /**
-     * The signing secret for the Slack app.
-     * @default process.env.SLACK_SIGNING_SECRET
-     */
-    signingSecret?: string;
-    /**
-     * If true, verifies the Slack request signature.
-     * @default true
-     */
-    signatureVerification?: boolean;
-    /**
-     * The logger to use for the VercelReceiver.
-     * @default new ConsoleLogger()
-     */
-    logger?: Logger;
-    /**
-     * The log level to use for the VercelReceiver.
-     * @default LogLevel.INFO
-     */
-    logLevel?: LogLevel;
-    /**
-     * A function to extract custom properties from incoming events.
-     * @default undefined
-     * @returns An object with custom properties.
-     */
-    customPropertiesExtractor?: (req: Request) => StringIndexed;
-    /**
-     * The timeout in milliseconds for event acknowledgment.
-     * @default 3001
-     */
-    ackTimeoutMs?: number;
+  /**
+   * The signing secret for the Slack app.
+   * @default process.env.SLACK_SIGNING_SECRET
+   */
+  signingSecret?: string;
+  /**
+   * If true, verifies the Slack request signature.
+   * @default true
+   */
+  signatureVerification?: boolean;
+  /**
+   * The logger to use for the VercelReceiver.
+   * @default new ConsoleLogger()
+   */
+  logger?: Logger;
+  /**
+   * The log level to use for the VercelReceiver.
+   * @default LogLevel.INFO
+   */
+  logLevel?: LogLevel;
+  /**
+   * A function to extract custom properties from incoming events.
+   * @default undefined
+   * @returns An object with custom properties.
+   */
+  customPropertiesExtractor?: (req: Request) => StringIndexed;
+  /**
+   * The timeout in milliseconds for event acknowledgment.
+   * @default 3001
+   */
+  ackTimeoutMs?: number;
+  /**
+   * Your app's client ID, found under Basic Information on api.slack.com.
+   * Required for OAuth.
+   * @default process.env.SLACK_CLIENT_ID
+   */
+  clientId?: string;
+  /**
+   * Your app's client secret, found under Basic Information on api.slack.com.
+   * Required for OAuth.
+   * @default process.env.SLACK_CLIENT_SECRET
+   */
+  clientSecret?: string;
+  /**
+   * Secret used to generate and verify the state parameter for OAuth CSRF protection.
+   * Required unless a custom stateStore or stateVerification: false is provided.
+   * @default process.env.SLACK_STATE_SECRET
+   */
+  stateSecret?: string;
+  /**
+   * The bot scopes to request during the OAuth flow.
+   */
+  scopes?: string[];
+  /**
+   * The redirect URI registered with your Slack app for OAuth callbacks.
+   */
+  redirectUri?: string;
+  /**
+   * Storage backend for OAuth installations (tokens, team info, etc.).
+   * Required for OAuth in serverless -- the default in-memory store does not persist.
+   */
+  installationStore?: InstallProviderOptions["installationStore"];
+  /**
+   * Advanced options for the OAuth installer.
+   */
+  installerOptions?: VercelInstallerOptions;
 }
 /**
  * A Slack Bolt receiver implementation designed for Vercel's serverless environment.
@@ -69,61 +130,90 @@ interface VercelReceiverOptions {
  *
  */
 declare class VercelReceiver implements Receiver {
-    private readonly signingSecret;
-    private readonly signatureVerification;
-    private readonly logger;
-    private readonly customPropertiesExtractor?;
-    private readonly ackTimeoutMs;
-    private app?;
-    /**
-     * Gets the logger instance used by this receiver.
-     * @returns The logger instance
-     */
-    getLogger(): Logger;
-    /**
-     * Creates a new VercelReceiver instance.
-     *
-     * @param options - Configuration options for the receiver
-     * @throws {VercelReceiverError} When signing secret is not provided
-     *
-     * @example
-     * ```typescript
-     * const receiver = new VercelReceiver();
-     * ```
-     */
-    constructor({ signingSecret, signatureVerification, logger, logLevel, customPropertiesExtractor, ackTimeoutMs, }?: VercelReceiverOptions);
-    /**
-     * Initializes the receiver with a Slack Bolt app instance.
-     * This method is called automatically by the Bolt framework.
-     *
-     * @param app - The Slack Bolt app instance
-     */
-    init(app: App): void;
-    /**
-     * Starts the receiver and returns a handler function for processing requests.
-     * This method is called automatically by the Bolt framework.
-     *
-     * @returns A handler function that processes incoming Slack requests
-     */
-    start(): Promise<VercelHandler>;
-    /**
-     * Stops the receiver. This method is called automatically by the Bolt framework.
-     */
-    stop(): Promise<void>;
-    /**
-     * Creates a handler function that processes incoming Slack requests.
-     * This is the main entry point for handling Slack events in Vercel.
-     * It is called automatically by the Bolt framework in the start() method.
-     *
-     * @returns A handler function compatible with Vercel's function signature
-     */
-    toHandler(): VercelHandler;
-    private parseRequestBody;
-    private handleSlackEvent;
-    private verifyRequest;
-    private createSlackReceiverEvent;
-    handleError(error: unknown): Response;
-    private createScopedLogger;
+  private readonly signingSecret;
+  private readonly signatureVerification;
+  private readonly logger;
+  private readonly customPropertiesExtractor?;
+  private readonly ackTimeoutMs;
+  private app?;
+  installer?: InstallProvider;
+  private installUrlOptions?;
+  private installCallbackOptions?;
+  private installPathOptions?;
+  private stateVerification?;
+  /**
+   * Gets the logger instance used by this receiver.
+   * @returns The logger instance
+   */
+  getLogger(): Logger;
+  /**
+   * Creates a new VercelReceiver instance.
+   *
+   * @param options - Configuration options for the receiver
+   * @throws {VercelReceiverError} When signing secret is not provided
+   *
+   * @example
+   * ```typescript
+   * const receiver = new VercelReceiver();
+   * ```
+   */
+  constructor({
+    signingSecret,
+    signatureVerification,
+    logger,
+    logLevel,
+    customPropertiesExtractor,
+    ackTimeoutMs,
+    clientId,
+    clientSecret,
+    stateSecret,
+    scopes,
+    redirectUri,
+    installationStore,
+    installerOptions
+  }?: VercelReceiverOptions);
+  /**
+   * Initializes the receiver with a Slack Bolt app instance.
+   * This method is called automatically by the Bolt framework.
+   *
+   * @param app - The Slack Bolt app instance
+   */
+  init(app: App): void;
+  /**
+   * Starts the receiver and returns a handler function for processing requests.
+   * This method is called automatically by the Bolt framework.
+   *
+   * @returns A handler function that processes incoming Slack requests
+   */
+  start(): Promise<VercelHandler>;
+  /**
+   * Stops the receiver. This method is called automatically by the Bolt framework.
+   */
+  stop(): Promise<void>;
+  /**
+   * Handles requests to the OAuth install path.
+   * Renders an "Add to Slack" page or redirects directly to Slack's authorize URL.
+   */
+  handleInstall: (req: Request) => Promise<Response>;
+  /**
+   * Handles the OAuth redirect callback from Slack.
+   * Exchanges the authorization code for tokens and stores the installation.
+   */
+  handleCallback: (req: Request) => Promise<Response>;
+  /**
+   * Creates a handler function that processes incoming Slack requests.
+   * This is the main entry point for handling Slack events in Vercel.
+   * It is called automatically by the Bolt framework in the start() method.
+   *
+   * @returns A handler function compatible with Vercel's function signature
+   */
+  toHandler(): VercelHandler;
+  private parseRequestBody;
+  private handleSlackEvent;
+  private verifyRequest;
+  private createSlackReceiverEvent;
+  handleError(error: unknown): Response;
+  private createScopedLogger;
 }
 /**
  * Creates a Vercel-compatible handler function for a Slack Bolt app.
@@ -150,5 +240,6 @@ declare class VercelReceiver implements Receiver {
  * @throws {VercelReceiverError} If request processing fails.
  */
 declare function createHandler(app: App, receiver: VercelReceiver): VercelHandler;
-
-export { type VercelHandler, VercelReceiver, type VercelReceiverOptions, createHandler };
+//#endregion
+export { VercelHandler, VercelInstallerOptions, VercelReceiver, VercelReceiverOptions, createHandler };
+//# sourceMappingURL=index.d.ts.map