@eigenpal/sdk 0.0.0-placeholder

package/src/generated/types.gen.ts

@@ -0,0 +1,608 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type ClientOptions = {
+  baseUrl: 'https://app.eigenpal.com' | (string & {});
+};
+
+export type RunWorkflowBody = {
+  /**
+   * Workflow inputs keyed by input name
+   */
+  input?: {
+    [key: string]: unknown;
+  };
+  /**
+   * Per-step output overrides for replay
+   */
+  overrides?: {
+    steps?: {
+      [key: string]: {
+        [key: string]: unknown;
+      };
+    };
+  } | null;
+  /**
+   * Caller surface (defaults to "api")
+   */
+  trigger?: 'api' | 'cli';
+};
+
+export type CancelExecutionResponse = {
+  executionId: string;
+  /**
+   * Outcome. `cancelled` (transitioned), `cancellation-requested` (worker will observe), or `already-terminal` (no-op).
+   */
+  status: 'cancelled' | 'cancellation-requested' | 'already-terminal';
+  /**
+   * Status at the moment of the cancel request
+   */
+  wasStatus: ExecutionStatus;
+};
+
+export type ExecutionStatus =
+  | 'created'
+  | 'pending'
+  | 'running'
+  | 'waiting'
+  | 'finalizing'
+  | 'completed'
+  | 'failed'
+  | 'cancelled'
+  | 'rejected';
+
+export type ApiErrorEnvelope = {
+  issues: Array<ApiErrorIssue>;
+  /**
+   * Request id echoed via the x-request-id header
+   */
+  requestId: string;
+  /**
+   * Suggested fix for known error patterns
+   */
+  hint?: string;
+  /**
+   * Link to relevant docs
+   */
+  docsUrl?: string;
+};
+
+export type ApiErrorIssue = {
+  /**
+   * JSON path of the offending field, or "<root>"
+   */
+  field: string;
+  /**
+   * Human-readable error message
+   */
+  message: string;
+  /**
+   * Machine-readable error code (e.g. invalid_value, not_found)
+   */
+  code: string;
+  /**
+   * Issue severity
+   */
+  severity: 'error' | 'warning';
+};
+
+export type ExecutionStatusResponse = {
+  executionId: string;
+  status: ExecutionStatus;
+  /**
+   * ISO-8601 creation timestamp
+   */
+  createdAt: string;
+  /**
+   * ISO-8601 completion timestamp; only set in terminal states
+   */
+  completedAt?: string | null;
+  /**
+   * Workflow output (status=completed)
+   */
+  result?: unknown | null;
+  /**
+   * Error message (status=failed)
+   */
+  error?: string | null;
+};
+
+export type ExecutionSummary = {
+  id: string;
+  tenantId: string;
+  workflowId: string;
+  versionId?: string | null;
+  status: ExecutionStatus;
+  triggerType?: string;
+  triggerInput?: unknown | null;
+  result?: unknown | null;
+  error?: string | null;
+  createdAt: string;
+  completedAt?: string | null;
+  /**
+   * Owning workflow (null when the workflow has been deleted)
+   */
+  workflow?: {
+    id: string;
+    name: string;
+  } | null;
+  [key: string]: unknown;
+};
+
+export type ListExecutionsResponse = {
+  data: Array<ExecutionSummary>;
+  total: number;
+  limit: number;
+  offset: number;
+};
+
+export type WorkflowSummary = {
+  id: string;
+  tenantId: string;
+  isBlock?: boolean;
+  createdAt: string;
+  updatedAt?: string;
+  currentVersion?: {
+    id?: string;
+    version?: string | null;
+    yamlContent?: string;
+    definition?: unknown;
+    message?: string | null;
+    createdAt?: string;
+    [key: string]: unknown;
+  } | null;
+  [key: string]: unknown;
+};
+
+export type RunWorkflowResponse = {
+  /**
+   * Newly created execution id (e.g. exec_xyz)
+   */
+  executionId: string;
+  /**
+   * Final execution status. Only set when the run completed within `wait_for_completion`.
+   */
+  status?: ExecutionStatus;
+  /**
+   * Workflow output (status=completed)
+   */
+  result?: unknown;
+  /**
+   * Error message (status=failed)
+   */
+  error?: string;
+};
+
+export type ListVersionsResponse = {
+  data: Array<WorkflowVersion>;
+  total: number;
+  limit: number;
+  offset: number;
+};
+
+export type WorkflowVersion = {
+  id: string;
+  workflowId: string;
+  version?: string | null;
+  yamlContent?: string;
+  definition?: unknown;
+  message?: string | null;
+  createdAt?: string;
+  isCurrentVersion?: boolean;
+  [key: string]: unknown;
+};
+
+export type ListWorkflowsResponse = {
+  data: Array<WorkflowSummary>;
+  total: number;
+  limit: number;
+  offset: number;
+};
+
+export type ExecutionsCancelData = {
+  body?: never;
+  path: {
+    /**
+     * Execution id to cancel
+     */
+    executionId: string;
+  };
+  query?: never;
+  url: '/v1/executions/{executionId}/cancel';
+};
+
+export type ExecutionsCancelErrors = {
+  /**
+   * Validation error. Request shape did not match the spec.
+   */
+  400: ApiErrorEnvelope;
+  /**
+   * Missing or invalid API key
+   */
+  401: ApiErrorEnvelope;
+  /**
+   * API key lacks required scope
+   */
+  403: ApiErrorEnvelope;
+  /**
+   * Resource not found
+   */
+  404: ApiErrorEnvelope;
+  /**
+   * Rate limit exceeded
+   */
+  429: ApiErrorEnvelope;
+  /**
+   * Internal server error
+   */
+  500: ApiErrorEnvelope;
+};
+
+export type ExecutionsCancelError = ExecutionsCancelErrors[keyof ExecutionsCancelErrors];
+
+export type ExecutionsCancelResponses = {
+  /**
+   * Cancellation outcome
+   */
+  200: CancelExecutionResponse;
+};
+
+export type ExecutionsCancelResponse = ExecutionsCancelResponses[keyof ExecutionsCancelResponses];
+
+export type ExecutionsGetData = {
+  body?: never;
+  path: {
+    /**
+     * Execution id (e.g. exec_xyz)
+     */
+    executionId: string;
+  };
+  query?: {
+    /**
+     * When "true", returns the full per-step execution payload instead of the summary
+     */
+    includeSteps?: 'true' | 'false';
+  };
+  url: '/v1/executions/{executionId}';
+};
+
+export type ExecutionsGetErrors = {
+  /**
+   * Validation error. Request shape did not match the spec.
+   */
+  400: ApiErrorEnvelope;
+  /**
+   * Missing or invalid API key
+   */
+  401: ApiErrorEnvelope;
+  /**
+   * API key lacks required scope
+   */
+  403: ApiErrorEnvelope;
+  /**
+   * Resource not found
+   */
+  404: ApiErrorEnvelope;
+  /**
+   * Rate limit exceeded
+   */
+  429: ApiErrorEnvelope;
+  /**
+   * Internal server error
+   */
+  500: ApiErrorEnvelope;
+};
+
+export type ExecutionsGetError = ExecutionsGetErrors[keyof ExecutionsGetErrors];
+
+export type ExecutionsGetResponses = {
+  /**
+   * Execution status (or full per-step payload when includeSteps=true)
+   */
+  200: ExecutionStatusResponse | ExecutionSummary;
+};
+
+export type ExecutionsGetResponse = ExecutionsGetResponses[keyof ExecutionsGetResponses];
+
+export type ExecutionsListData = {
+  body?: never;
+  path?: never;
+  query?: {
+    /**
+     * Comma-separated list of workflow ids to filter by
+     */
+    workflowId?: string;
+    /**
+     * Comma-separated list of execution statuses to filter by
+     */
+    status?: string;
+    /**
+     * ISO-8601 timestamp or relative expression (e.g. "now()-7d") for the lower bound on `createdAt`
+     */
+    fromDate?: string;
+    /**
+     * Upper bound on `createdAt`
+     */
+    toDate?: string;
+    /**
+     * Filter to executions launched from a specific eval example
+     */
+    exampleId?: string;
+    limit?: number;
+    offset?: number;
+  };
+  url: '/v1/executions';
+};
+
+export type ExecutionsListErrors = {
+  /**
+   * Validation error. Request shape did not match the spec.
+   */
+  400: ApiErrorEnvelope;
+  /**
+   * Missing or invalid API key
+   */
+  401: ApiErrorEnvelope;
+  /**
+   * API key lacks required scope
+   */
+  403: ApiErrorEnvelope;
+  /**
+   * Resource not found
+   */
+  404: ApiErrorEnvelope;
+  /**
+   * Rate limit exceeded
+   */
+  429: ApiErrorEnvelope;
+  /**
+   * Internal server error
+   */
+  500: ApiErrorEnvelope;
+};
+
+export type ExecutionsListError = ExecutionsListErrors[keyof ExecutionsListErrors];
+
+export type ExecutionsListResponses = {
+  /**
+   * Paginated list of executions
+   */
+  200: ListExecutionsResponse;
+};
+
+export type ExecutionsListResponse = ExecutionsListResponses[keyof ExecutionsListResponses];
+
+export type WorkflowsGetData = {
+  body?: never;
+  path: {
+    /**
+     * Workflow id (e.g. wf_abc123)
+     */
+    id: string;
+  };
+  query?: never;
+  url: '/v1/workflows/{id}';
+};
+
+export type WorkflowsGetErrors = {
+  /**
+   * Validation error. Request shape did not match the spec.
+   */
+  400: ApiErrorEnvelope;
+  /**
+   * Missing or invalid API key
+   */
+  401: ApiErrorEnvelope;
+  /**
+   * API key lacks required scope
+   */
+  403: ApiErrorEnvelope;
+  /**
+   * Resource not found
+   */
+  404: ApiErrorEnvelope;
+  /**
+   * Rate limit exceeded
+   */
+  429: ApiErrorEnvelope;
+  /**
+   * Internal server error
+   */
+  500: ApiErrorEnvelope;
+};
+
+export type WorkflowsGetError = WorkflowsGetErrors[keyof WorkflowsGetErrors];
+
+export type WorkflowsGetResponses = {
+  /**
+   * Workflow with current version
+   */
+  200: WorkflowSummary;
+};
+
+export type WorkflowsGetResponse = WorkflowsGetResponses[keyof WorkflowsGetResponses];
+
+export type WorkflowsRunData = {
+  body: RunWorkflowBody;
+  path: {
+    /**
+     * Workflow id (e.g. `wf_abc123`) or slug (e.g. `extract-invoice`, the workflow `name`).
+     */
+    id: string;
+  };
+  query?: {
+    /**
+     * Version id, or "latest" (default)
+     */
+    version?: string;
+    /**
+     * Seconds to hold the connection waiting for completion (max 60). Omit for async.
+     */
+    wait_for_completion?: number;
+  };
+  url: '/v1/workflows/{id}/run';
+};
+
+export type WorkflowsRunErrors = {
+  /**
+   * Validation error. Request shape did not match the spec.
+   */
+  400: ApiErrorEnvelope;
+  /**
+   * Missing or invalid API key
+   */
+  401: ApiErrorEnvelope;
+  /**
+   * API key lacks required scope
+   */
+  403: ApiErrorEnvelope;
+  /**
+   * Resource not found
+   */
+  404: ApiErrorEnvelope;
+  /**
+   * Rate limit exceeded
+   */
+  429: ApiErrorEnvelope;
+  /**
+   * Internal server error
+   */
+  500: ApiErrorEnvelope;
+};
+
+export type WorkflowsRunError = WorkflowsRunErrors[keyof WorkflowsRunErrors];
+
+export type WorkflowsRunResponses = {
+  /**
+   * Execution accepted. Body always includes `executionId`. When `wait_for_completion` is set and the run completes within the window, `status`/`result`/`error` are also returned; otherwise poll `/v1/executions/{executionId}` for status.
+   */
+  201: RunWorkflowResponse;
+};
+
+export type WorkflowsRunResponse = WorkflowsRunResponses[keyof WorkflowsRunResponses];
+
+export type WorkflowsVersionsListData = {
+  body?: never;
+  path: {
+    /**
+     * Workflow id
+     */
+    id: string;
+  };
+  query?: {
+    /**
+     * Page size (max 100, default 50)
+     */
+    limit?: number;
+    /**
+     * Page offset
+     */
+    offset?: number;
+  };
+  url: '/v1/workflows/{id}/versions';
+};
+
+export type WorkflowsVersionsListErrors = {
+  /**
+   * Validation error. Request shape did not match the spec.
+   */
+  400: ApiErrorEnvelope;
+  /**
+   * Missing or invalid API key
+   */
+  401: ApiErrorEnvelope;
+  /**
+   * API key lacks required scope
+   */
+  403: ApiErrorEnvelope;
+  /**
+   * Resource not found
+   */
+  404: ApiErrorEnvelope;
+  /**
+   * Rate limit exceeded
+   */
+  429: ApiErrorEnvelope;
+  /**
+   * Internal server error
+   */
+  500: ApiErrorEnvelope;
+};
+
+export type WorkflowsVersionsListError =
+  WorkflowsVersionsListErrors[keyof WorkflowsVersionsListErrors];
+
+export type WorkflowsVersionsListResponses = {
+  /**
+   * Paginated list of workflow versions
+   */
+  200: ListVersionsResponse;
+};
+
+export type WorkflowsVersionsListResponse =
+  WorkflowsVersionsListResponses[keyof WorkflowsVersionsListResponses];
+
+export type WorkflowsListData = {
+  body?: never;
+  path?: never;
+  query?: {
+    /**
+     * Substring match against workflow name
+     */
+    search?: string;
+    /**
+     * Exact-match lookup by workflow name (slug)
+     */
+    name?: string;
+    /**
+     * Filter by workflow kind
+     */
+    kind?: 'workflow' | 'block';
+    /**
+     * Page size (max 100, default 50)
+     */
+    limit?: number;
+    /**
+     * Page offset
+     */
+    offset?: number;
+  };
+  url: '/v1/workflows';
+};
+
+export type WorkflowsListErrors = {
+  /**
+   * Validation error. Request shape did not match the spec.
+   */
+  400: ApiErrorEnvelope;
+  /**
+   * Missing or invalid API key
+   */
+  401: ApiErrorEnvelope;
+  /**
+   * API key lacks required scope
+   */
+  403: ApiErrorEnvelope;
+  /**
+   * Resource not found
+   */
+  404: ApiErrorEnvelope;
+  /**
+   * Rate limit exceeded
+   */
+  429: ApiErrorEnvelope;
+  /**
+   * Internal server error
+   */
+  500: ApiErrorEnvelope;
+};
+
+export type WorkflowsListError = WorkflowsListErrors[keyof WorkflowsListErrors];
+
+export type WorkflowsListResponses = {
+  /**
+   * Paginated list of workflows
+   */
+  200: ListWorkflowsResponse;
+};
+
+export type WorkflowsListResponse = WorkflowsListResponses[keyof WorkflowsListResponses];

package/src/index.ts

@@ -0,0 +1,64 @@
+/**
+ * Official TypeScript SDK for the Eigenpal API.
+ *
+ * @example
+ * ```ts
+ * import { Eigenpal } from '@eigenpal/sdk';
+ *
+ * const client = new Eigenpal({ apiKey: process.env.EIGENPAL_API_KEY! });
+ *
+ * // Async — enqueue and poll later.
+ * const { executionId } = await client.workflows.run('wf_abc', { input: { ... } });
+ *
+ * // Sync (server holds the connection up to 60s).
+ * const result = await client.workflows.run('wf_abc', { input: { ... } }, {
+ *   waitForCompletion: 60,
+ * });
+ *
+ * // Client-side poll (up to 5min by default).
+ * const final = await client.executions.runAndWait('wf_abc', { input: { ... } });
+ * ```
+ */
+export { Eigenpal, type EigenpalOptions } from './client';
+
+export {
+  EigenpalAuthError,
+  EigenpalError,
+  EigenpalForbiddenError,
+  EigenpalNotFoundError,
+  EigenpalRateLimitError,
+  EigenpalServerError,
+  EigenpalTimeoutError,
+  EigenpalValidationError,
+} from './errors';
+
+export type { FileDescriptor, FileInput } from './lib/files';
+export type {
+  ListVersionsOptions,
+  ListWorkflowsOptions,
+  RunWorkflowOptions,
+  WorkflowInput,
+} from './resources/workflows';
+// Note: FileReference (by fileId) is intentionally NOT exported. From the
+// SDK perspective you always upload a file; fileId is an internal wire id
+// the server creates after upload — not something users construct.
+
+export type { ListExecutionsOptions, RunAndWaitOptions } from './resources/executions';
+
+// Re-export the canonical generated types so users can type their own
+// callbacks and helpers without reaching into `./generated`.
+export type {
+  ApiErrorEnvelope,
+  ApiErrorIssue,
+  CancelExecutionResponse,
+  ExecutionStatus,
+  ExecutionStatusResponse,
+  ExecutionSummary,
+  ListExecutionsResponse,
+  ListVersionsResponse,
+  ListWorkflowsResponse,
+  RunWorkflowBody,
+  RunWorkflowResponse,
+  WorkflowSummary,
+  WorkflowVersion,
+} from './generated/types.gen';