@lovable.dev/sdk 0.1.9 → 1.1.0

package/src/index.ts

@@ -0,0 +1,93 @@
+export { LovableClient } from "./client.js";
+export { ApiError } from "./types.js";
+export type { RateLimitInfo } from "./types.js";
+export type {
+  LovableClientOptions,
+  LovableError,
+  CreateProjectOptions,
+  ChatMessageOptions,
+  CreateVariantOptions,
+  ContinuationOverride,
+  WaitOptions,
+  WorkspaceWithMembership,
+  WorkspaceMembership,
+  ProjectResponse,
+  EmbedURLResponse,
+  CreateProjectResponse,
+  CreateProjectBody,
+  ChatRequest,
+  ProjectVisibility,
+  ProjectStatus,
+  MemberRole,
+  DeploymentResponse,
+  ChatResponse,
+  ChatResponseOptions,
+  UnscopedFile,
+  FileInput,
+  RemixProjectOptions,
+  RemixResult,
+  RemixWaitOptions,
+  RemixJobStatus,
+  RemixJobStep,
+  RemixJobStepInfo,
+  RemixMode,
+  MeResponse,
+  MeWorkspace,
+  DatabaseStatus,
+  EnableDatabaseResult,
+  DatabaseQueryResult,
+  GetWorkspacesResponse,
+  // New types for MCP parity
+  SendMessageResponse,
+  GetMessageResponse,
+  MessageSummary,
+  ListMessagesResponse,
+  ListMessagesOptions,
+  CreateVariantResponse,
+  MessageCompletionResult,
+  MessageCompletionOptions,
+  KnowledgeResponse,
+  FileUploadUrlResponse,
+  DiffLine,
+  DiffHunk,
+  DiffEntry,
+  GitDiffResponse,
+  GitFileEntry,
+  GitFilesResponse,
+  EditSummary,
+  EditsResponse,
+  ListProjectItem,
+  ListProjectsResponse,
+  ListProjectsOptions,
+  ListConnectorsOptions,
+  ListCursorPaginationOptions,
+  ListHybridPaginationOptions,
+  ListPaginationOptions,
+  ListOffsetPaginationOptions,
+  CursorPaginationOptions,
+  LibraryProjectResponse,
+  TemplateProjectResponse,
+  ListLibraryProjectsResponse,
+  ListTemplateProjectsResponse,
+  ConnectorResponse,
+  AvailableConnectorEntry,
+  AddConnectorBody,
+  ConnectorItem,
+  StandardConnectorItem,
+  SeamlessConnectorItem,
+  MCPConnectorItem,
+  ConnectionItem,
+  ListConnectorsResponse,
+  ListAvailableConnectorsResponse,
+  ListStandardConnectorsResponse,
+  ListSeamlessConnectorsResponse,
+  ListMCPConnectorsResponse,
+  ListConnectionsResponse,
+  TimeSeriesDataPoint,
+  TimeSeriesData,
+  ListDataPoint,
+  ListData,
+  ProjectAnalyticsResponse,
+  TrendDataPoint,
+  ProjectAnalyticsTrendResponse,
+} from "./types.js";

package/src/retryFetch.ts

@@ -0,0 +1,44 @@
+const RETRY_DELAYS_MS = [100, 300, 500] as const;
+
+const sleep = (ms: number): Promise<void> => new Promise((resolve) => setTimeout(resolve, ms));
+
+function parseRetryAfterMs(headers: Headers): number | undefined {
+  const raw = headers.get("retry-after");
+  if (!raw) return undefined;
+  const seconds = Number(raw);
+  if (Number.isFinite(seconds) && seconds >= 0) return seconds * 1000;
+  const dateMs = Date.parse(raw);
+  if (!Number.isNaN(dateMs)) {
+    const delta = dateMs - Date.now();
+    return delta > 0 ? delta : 0;
+  }
+  return undefined;
+}
+
+export type RetryFetch = (input: Request) => Promise<Response>;
+
+/**
+ * Wraps a fetch implementation with retry on HTTP 429. Up to three retries
+ * at 100ms / 300ms / 500ms; if the server sends `Retry-After` and it's
+ * larger than the planned delay, we honor the server value. The Request is
+ * cloned before each attempt so its body remains replayable.
+ *
+ * Matches openapi-fetch's `fetch` option signature: a single `Request` in,
+ * `Promise<Response>` out.
+ */
+export function makeRetryFetch(baseFetch: RetryFetch = (input) => globalThis.fetch(input)): RetryFetch {
+  return async (input) => {
+    // Request.clone() and the fetch parameter resolve to different Request type
+    // definitions when @types/node (undici) and @types/bun are both in scope;
+    // the cloned object is structurally the same Request, so assert the param type.
+    const clone = (): Parameters<RetryFetch>[0] => input.clone() as Parameters<RetryFetch>[0];
+    let response = await baseFetch(clone());
+    for (const planned of RETRY_DELAYS_MS) {
+      if (response.status !== 429) break;
+      const serverDelay = parseRetryAfterMs(response.headers);
+      await sleep(Math.max(planned, serverDelay ?? 0));
+      response = await baseFetch(clone());
+    }
+    return response;
+  };
+}

package/src/schemas.ts

@@ -0,0 +1,22 @@
+/**
+ * Zod schemas for the Lovable public API, generated by `@hey-api/openapi-ts`
+ * from the Go OpenAPI spec operations marked as public API.
+ *
+ * Consumers import schemas to validate API responses or to advertise them as
+ * MCP tool output schemas. The published SDK keeps the typed openapi-fetch
+ * client unchanged; this module is the runtime-validation entry point.
+ */
+export * from "./generated/zod/zod.gen.js";
+
+import { z } from "zod";
+
+// POST /v1/database/query is served but sits outside the public OpenAPI
+// boundary, so its schemas are not generated; hand-maintained for the MCP
+// query_database tool's output validation.
+export const V1DatabaseQueryOutputBodySchema = z.object({
+  rows: z.array(z.record(z.string(), z.unknown())).nullable(),
+});
+
+export const V1DatabaseQueryOutputBodyWritableSchema = z.object({
+  rows: z.array(z.record(z.string(), z.unknown())).nullable(),
+});

package/src/types.ts

@@ -0,0 +1,493 @@
+// Type definitions for the Lovable SDK.
+//
+// Response and request body types come straight from the generated OpenAPI
+// types (`./generated/paths.ts`, produced by `openapi-typescript` from the
+// trimmed v1 spec). The same trimmed spec also drives `./generated/zod/`
+// (consumed by `@lovable.dev/sdk/schemas` for runtime validation), so the
+// type aliases here are guaranteed to match the schemas the MCP server
+// uses — there is no hand-maintained parallel shape to drift.
+//
+// Types that don't have a 1:1 OpenAPI counterpart (request options, SDK
+// wrappers like `MessageCompletionResult` that re-shape responses, helper
+// interfaces like `FileInput`) stay hand-written below.
+
+import type { components, paths } from "./generated/paths.js";
+
+type Schemas = components["schemas"];
+
+type ListProjectsQuery = NonNullable<paths["/v1/projects"]["get"]["parameters"]["query"]>;
+type ListConnectorsQuery = NonNullable<paths["/v1/connectors"]["get"]["parameters"]["query"]>;
+
+// =============================================================================
+// API types — derived from the OpenAPI spec
+// =============================================================================
+
+// --- Users & workspaces ---
+
+export type MeWorkspace = Schemas["GetMeWorkspace"];
+export type MeResponse = Schemas["GetMeOutputBody"];
+export type WorkspaceMembership = Schemas["WorkspaceMembership"];
+export type WorkspaceWithMembership = Schemas["WorkspaceWithMembership"];
+export type GetWorkspacesResponse = Schemas["V1ListWorkspacesBody"];
+
+// Role enum lives on WorkspaceMembership in the spec; reuse it so SDK callers
+// always pick from the same set the server returns.
+export type MemberRole = WorkspaceMembership["role"];
+
+// --- Projects ---
+
+// Lean shape returned by GET /v1/projects/{id} and POST /v1/projects.
+export type ProjectResponse = Schemas["V1ProjectResponse"];
+export type CreateProjectResponse = Schemas["PublicV1CreateProjectResponse"] & { id: string };
+export type CreateProjectBody = Omit<Schemas["PublicV1ProjectCreateInputBody"], "workspace_id">;
+export type UpdateProjectOptions = Schemas["PublicV1PatchProjectBody"];
+export type EmbedURLResponse = Schemas["V1CreateEmbedURLOutputBody"];
+
+// Wider listing shape returned by the search endpoint.
+export type ListProjectItem = Schemas["SearchProjectItem"];
+export type ListProjectsResponse = Schemas["CursorListResponseSearchProjectItem"] & {
+  projects: ListProjectItem[] | null;
+  total?: number;
+  has_more?: boolean;
+};
+export type GetWorkspaceProjectsResponse = ListProjectsResponse;
+export type MoveProjectsToFolderResponse = Schemas["AddProjectsToFolderResult"];
+
+// Visibility enum is narrowest on SearchProjectItem ("public" | "private" | "draft");
+// V1ProjectResponse types visibility as plain string. Use the narrower one.
+export type ProjectVisibility = NonNullable<ListProjectItem["visibility"]>;
+export type ProjectPatchVisibility = NonNullable<UpdateProjectOptions["visibility"]>;
+
+// --- Messages ---
+
+export type SendMessageResponse = Schemas["V1SendMessageOutputBody"];
+export type GetMessageResponse = Schemas["V1MessageResponse"];
+export type MessageSummary = Schemas["V1MessageListItem"];
+type AwaitingInputSummary = Partial<Schemas["V1AwaitingInputSummary"]>;
+export type ListMessagesResponse = Schemas["CursorListResponseV1MessageListItem"] & {
+  messages: MessageSummary[] | null;
+  has_more: boolean;
+};
+export interface ListMessagesOptions {
+  limit?: number;
+  cursor?: string;
+  /** @deprecated Use `cursor` from `pagination.next_cursor`; kept for source compatibility. */
+  before?: string;
+}
+
+export interface ChatResponse {
+  content: string;
+  previewUrl: string;
+  messageId: string;
+}
+
+export interface ChatResponseOptions {
+  timeout?: number;
+}
+
+export type CreateVariantResponse = Schemas["V1CreateVariantOutputBody"];
+
+// --- Deployment ---
+
+export type DeploymentResponse = Schemas["V1DeployProjectOutputBody"];
+
+// --- Database ---
+
+export type DatabaseStatus = Schemas["V1GetDatabaseStatusOutputBody"];
+export type EnableDatabaseResult = Schemas["V1EnableDatabaseOutputBody"];
+// POST /v1/database/query is served but sits outside the public OpenAPI
+// boundary, so no generated type exists; hand-maintained for queryDatabase
+// and the MCP query_database tool.
+export type DatabaseQueryResult = {
+  rows: Record<string, unknown>[] | null;
+};
+
+// --- Knowledge ---
+
+export type KnowledgeResponse = Schemas["V1KnowledgeResponse"];
+
+// --- Skills ---
+
+export type WorkspaceSkillFile = Schemas["ProjectFileInfo"];
+export type WorkspaceSkill = Schemas["V1WorkspaceSkillDTO"];
+export type ListWorkspaceSkillsResponse = Schemas["V1ListWorkspaceSkillsOutputBody"];
+export type WorkspaceSkillResponse = Schemas["V1GetWorkspaceSkillOutputBody"];
+export type WorkspaceSkillWriteResponse = Schemas["V1WriteWorkspaceSkillOutputBody"];
+export type WorkspaceSkillDeleteResponse = Schemas["V1DeleteWorkspaceSkillOutputBody"];
+
+export type ProjectSkill = Schemas["V1ProjectSkillDTO"];
+export type ListProjectSkillsResponse = Schemas["CursorListResponseV1ProjectSkillDTO"] & {
+  skills: ProjectSkill[];
+};
+export type ProjectSkillResponse = Schemas["V1SetProjectSkillEnabledOutputBody"];
+
+// --- File upload ---
+
+export type FileUploadUrlResponse = Schemas["V1FileUploadURLOutputBody"];
+export type UnscopedFile = Schemas["V1UnscopedFile"];
+
+// --- Git / diffs / files / edits ---
+
+export type DiffLine = Schemas["DiffLine"];
+export type DiffHunk = Schemas["DiffHunk"];
+export type DiffEntry = Schemas["V1DiffEntry"];
+export type GitDiffResponse = Schemas["V1DiffResponse"];
+export type GitFileEntry = Schemas["GitFileEntryLite"];
+export type GitFilesResponse = Schemas["PublicV1GitFilesResponse"] & { files: GitFileEntry[] };
+export type EditSummary = Schemas["V1EditSummary"];
+export type EditsResponse = Schemas["V1GetEditsOutputBody"];
+
+// --- Libraries & templates ---
+
+export type LibraryProjectResponse = Record<string, unknown>;
+export type TemplateProjectResponse = Record<string, unknown>;
+export type ListLibraryProjectsResponse = {
+  libraries: LibraryProjectResponse[];
+  total?: number;
+  has_more?: boolean;
+};
+export type ListTemplateProjectsResponse = {
+  templates: TemplateProjectResponse[];
+  total?: number;
+  has_more?: boolean;
+};
+
+// --- Connectors ---
+
+export type ConnectorResponse = Schemas["V1ConnectorResponse"];
+export type AvailableConnectorEntry = Schemas["V1AvailableConnectorEntry"];
+export type AddConnectorBody = Omit<Schemas["PublicV1AddConnectorBody"], "workspace_id">;
+export type ConnectorItem = Schemas["PublicV1ConnectorItem"];
+export type StandardConnectorItem = ConnectorItem;
+export type SeamlessConnectorItem = ConnectorItem;
+export type MCPConnectorItem = ConnectorItem;
+export type ConnectionItem = Schemas["V1ConnectionItem"];
+export type ListConnectorsResponse = Omit<Schemas["CursorListResponsePublicV1ConnectorItem"], "data"> & {
+  data: ConnectorItem[];
+  connectors: ConnectorItem[];
+  has_more: boolean;
+};
+export type ListAvailableConnectorsResponse = Omit<Schemas["CursorListResponseV1AvailableConnectorEntry"], "data"> & {
+  data: AvailableConnectorEntry[];
+  catalog: AvailableConnectorEntry[];
+  has_more: boolean;
+};
+export type ListStandardConnectorsResponse = Omit<ListConnectorsResponse, "connectors"> & {
+  connectors: StandardConnectorItem[];
+};
+export type ListSeamlessConnectorsResponse = Omit<ListConnectorsResponse, "connectors"> & {
+  connectors: SeamlessConnectorItem[];
+};
+export type ListMCPConnectorsResponse = Omit<ListConnectorsResponse, "connectors"> &
+  Partial<Omit<Schemas["V1ListMCPConnectorsResponse"], "connectors">> & {
+    data: MCPConnectorItem[];
+    connectors: MCPConnectorItem[];
+  };
+export type ListConnectionsResponse = Omit<Schemas["CursorListResponseV1ConnectionItem"], "data"> & {
+  data: ConnectionItem[];
+  connections: ConnectionItem[];
+  has_more: boolean;
+};
+
+// --- Analytics ---
+
+export type TimeSeriesDataPoint = Schemas["TimeSeriesDataPoint"];
+export type TimeSeriesData = Schemas["TimeSeriesData"];
+export type ListDataPoint = Schemas["ListDataPoint"];
+export type ListData = Schemas["ListData"];
+export type ProjectAnalyticsResponse = Schemas["ProjectAnalyticsResponse"];
+export type TrendDataPoint = Schemas["TrendDataPoint"];
+export type ProjectAnalyticsTrendResponse = Schemas["ProjectTrendResponse"];
+
+// --- Remix ---
+
+export type RemixJobStepInfo = Schemas["RemixJobStepInfo"];
+export type RemixInitResponse = { job_id: string };
+export type RemixProgressResult = Schemas["V1RemixProgressResult"];
+export type RemixProgressResponse = {
+  status: string;
+  step?: RemixJobStepInfo;
+  result?: RemixProgressResult;
+  error_message?: string;
+  error_code?: string;
+};
+
+// The V1 spec types `status` as plain string. The Go handler returns one of
+// these five values — keep the narrow union here as an SDK-side aid for
+// callers that switch on it. If the spec ever exposes this as an enum,
+// replace with `Schemas["V1RemixProgressOutputBody"]["status"]`.
+export type RemixJobStatus = "unknown" | "preparing" | "running" | "completed" | "error";
+export type RemixJobStep =
+  | "starting"
+  | "creating_new_project"
+  | "restoring_supabase"
+  | "copying_history"
+  | "preparing_repository"
+  | "remixing_integration"
+  | "pushing_repository"
+  | "finalizing"
+  | "completed";
+
+// V1 status field on V1ProjectResponse is plain string; the Go handler returns
+// one of these three. Same rationale as RemixJobStatus.
+export type ProjectStatus = "completed" | "in_progress" | "failed";
+
+// =============================================================================
+// SDK helpers — no OpenAPI counterpart
+// =============================================================================
+
+export interface ChatRequest {
+  id: string;
+  message: string;
+  chat_only: boolean;
+  headless: boolean;
+  ai_message_id?: string;
+  intent?: string;
+  model?: string;
+  temperature?: number;
+  current_page?: string;
+  view?: string;
+  view_description?: string;
+  prev_session_id?: string;
+  is_creation?: boolean;
+  files?: UnscopedFile[];
+}
+
+/** @deprecated `remixProject()` now uses POST /v1/projects with `source_project_id`. */
+export interface RemixInitBody extends Omit<Schemas["V1RemixInitInputBody"], "initial_message"> {
+  initial_message?: ChatRequest;
+  message_id?: string;
+  remix_mode?: RemixMode;
+  skip_integrations?: boolean;
+}
+
+export type RemixCreateProjectBody = Schemas["PublicV1ProjectRemixInputBody"];
+
+export interface FileInput {
+  name: string;
+  data: Blob | ArrayBuffer | Uint8Array;
+  type: string;
+}
+
+export interface CreateProjectOptions {
+  description: string;
+  projectName?: string;
+  techStack?: string;
+  /** Sandbox runtime template. Requires a workspace with access to the requested template. */
+  sandboxTemplate?: string;
+  visibility?: ProjectVisibility;
+  templateProjectId?: string;
+  initialMessage?: string;
+  /** Files to upload and attach to the initial message. The SDK handles uploading. */
+  files?: (File | FileInput)[];
+  /** Pre-uploaded file references to attach to the initial message. Skips upload. */
+  uploadedFiles?: UnscopedFile[];
+  /** Public image or HTML file URLs to fetch server-side and attach to the initial message. */
+  fileUrls?: string[];
+  /** Design system library projects to connect to the new project. */
+  selectedLibraries?: { project_id: string }[];
+}
+
+/**
+ * Controls prompt cache continuation behavior for a message.
+ *
+ * - `"force"` — skip cache TTL and token/criteria checks (force continuation)
+ * - `"fresh_build"` — force a full prompt rebuild from scratch
+ * - `"allow_expired_cache"` — skip cache TTL check but respect token/criteria limits
+ *
+ * Omit for default behavior (5-min TTL, token and criteria checks apply).
+ */
+export type ContinuationOverride = "force" | "fresh_build" | "allow_expired_cache";
+
+export interface ChatMessageOptions {
+  message: string;
+  /** Send the message to this project variant instead of the main agent. */
+  variantId?: string;
+  /** Files to upload and attach. The SDK handles uploading them first. */
+  files?: (File | FileInput)[];
+  /** Pre-uploaded file references. Skips upload. */
+  uploadedFiles?: UnscopedFile[];
+  /** Enable plan mode: the agent discusses and plans without editing code. */
+  planMode?: boolean;
+  /**
+   * Override continuation behavior for this message.
+   * Controls whether the agent reuses the prompt cache or rebuilds from scratch.
+   */
+  continuation?: ContinuationOverride;
+}
+
+export interface CreateVariantOptions {
+  /** Display name. The API assigns the next Draft number when omitted. */
+  label?: string;
+  /** Full 40-character commit SHA to base the variant branch on. Defaults to the project main branch. */
+  baseSha?: string;
+}
+
+export interface LovableClientOptions {
+  /** API key for authentication (mutually exclusive with bearerToken) */
+  apiKey?: string;
+  /** Bearer token for OAuth authentication (mutually exclusive with apiKey) */
+  bearerToken?: string;
+  baseUrl?: string;
+  /** Additional headers to include on every request */
+  headers?: Record<string, string>;
+  /**
+   * Identifier for the originating client, sent as the `X-Client-Source` header.
+   * Used by the API to tag audit logs and observability with the message origin.
+   * Defaults to `"sdk"`. The Go API allowlist accepts `"mcp"`, `"sdk"`, `"cli"`.
+   */
+  clientSource?: string;
+}
+
+export interface LovableError extends Error {
+  status: number;
+  type?: string;
+  detail?: string;
+}
+
+export interface WaitOptions {
+  pollInterval?: number;
+  timeout?: number;
+  onProgress?: (project: ProjectResponse) => void;
+}
+
+export interface ListCursorPaginationOptions {
+  limit?: number;
+  cursor?: string;
+}
+
+export interface ListOffsetPaginationOptions {
+  limit?: number;
+  offset?: number;
+}
+
+export interface ListHybridPaginationOptions {
+  limit?: number;
+  cursor?: string;
+  offset?: number;
+}
+
+export type ListConnectorsOptions = Omit<ListConnectorsQuery, "workspace_id">;
+
+/** @deprecated Use the cursor, offset, or hybrid pagination option type that matches the route. */
+export type ListPaginationOptions = ListHybridPaginationOptions;
+
+export type CursorPaginationOptions = ListCursorPaginationOptions;
+
+export type RemixMode = "before" | "including";
+
+export interface RemixProjectOptions {
+  workspaceId: string;
+  messageId?: string;
+  remixMode?: RemixMode;
+  includeHistory?: boolean;
+  includeCustomKnowledge?: boolean;
+  initialMessage?: string;
+  description?: string;
+  projectName?: string;
+  skipInitialRemixMessage?: boolean;
+  skipIntegrations?: boolean;
+}
+
+// camelCase wrapper — not a direct alias of V1RemixProgressResult.
+export interface RemixResult {
+  projectId: string;
+}
+
+export interface RemixWaitOptions {
+  pollInterval?: number;
+  timeout?: number;
+  onProgress?: (status: RemixJobStatus, step?: RemixJobStepInfo) => void;
+}
+
+export interface MessageCompletionResult {
+  status: "completed" | "stopped" | "awaiting_input" | "timeout" | "error";
+  message_id: string;
+  content: string;
+  awaiting_input?: AwaitingInputSummary;
+  edit_id?: string;
+  commit_sha?: string;
+  summary?: string;
+  cost_credits?: number;
+  error?: string;
+}
+
+export interface MessageCompletionOptions {
+  /** Trajectory thread returned by chat(). Enables thread-aware completion. */
+  threadId?: string;
+  /**
+   * Maximum seconds the server holds each long-poll request before returning
+   * a non-terminal snapshot. Clamped server-side to [0, 55]. Defaults to 30.
+   */
+  waitSeconds?: number;
+  /** Maximum total time to wait in ms (default: 600000 = 10 minutes) */
+  timeout?: number;
+  /**
+   * @deprecated Long-poll replaces client-side polling; this is ignored.
+   * Kept for source-compat with callers that still pass it.
+   */
+  pollInterval?: number;
+}
+
+export interface GetMessageOptions {
+  /** Trajectory thread returned by chat(). Enables thread-aware status reads. */
+  threadId?: string;
+  /**
+   * Long-poll: ask the server to hold the request until the message reaches a
+   * terminal state or this many seconds elapse. Clamped server-side to [0, 55].
+   */
+  waitSeconds?: number;
+}
+
+export interface ListProjectsOptions {
+  /** Full-text search; mapped to `q` on the wire. */
+  query?: string;
+  visibility?: ListProjectsQuery["visibility"];
+  publish_status?: ListProjectsQuery["publish_status"];
+  folder_id?: ListProjectsQuery["folder_id"];
+  folder_ids?: ListProjectsQuery["folder_ids"];
+  user_id?: ListProjectsQuery["user_id"];
+  type?: ListProjectsQuery["type"];
+  include_risk?: ListProjectsQuery["include_risk"];
+  search_fields?: ListProjectsQuery["search_fields"];
+  viewed_by_me?: ListProjectsQuery["viewed_by_me"];
+  cursor?: ListProjectsQuery["cursor"];
+  limit?: ListProjectsQuery["limit"];
+}
+
+// =============================================================================
+// Runtime exports
+// =============================================================================
+
+export interface RateLimitInfo {
+  /** X-RateLimit-Limit: the request budget for the current window. */
+  limit?: number;
+  /** X-RateLimit-Remaining: requests left in the current window. */
+  remaining?: number;
+  /** Retry-After in milliseconds (parsed from the Retry-After header). */
+  retryAfterMs?: number;
+}
+
+export class ApiError extends Error {
+  readonly status: number;
+  readonly type?: string;
+  readonly detail?: string;
+  readonly props?: Record<string, unknown>;
+  readonly rateLimit?: RateLimitInfo;
+
+  constructor(
+    status: number,
+    message: string,
+    type?: string,
+    detail?: string,
+    props?: Record<string, unknown>,
+    rateLimit?: RateLimitInfo,
+  ) {
+    super(message);
+    this.status = status;
+    this.type = type;
+    this.detail = detail;
+    this.props = props;
+    this.rateLimit = rateLimit;
+  }
+}