@recur-tw/cli 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,196 @@
+//#region src/client.d.ts
+interface ClientOptions {
+  baseUrl: string;
+  secretKey: string;
+}
+interface ApiResponse<T = unknown> {
+  ok: boolean;
+  status: number;
+  data: T;
+}
+declare class RecurClient {
+  private baseUrl;
+  private secretKey;
+  constructor(opts: ClientOptions);
+  request<T = unknown>(method: string, path: string, opts?: {
+    body?: unknown;
+    params?: Record<string, string | undefined>;
+  }): Promise<T>;
+  get<T = unknown>(path: string, params?: Record<string, string | undefined>): Promise<T>;
+  post<T = unknown>(path: string, body?: unknown): Promise<T>;
+  patch<T = unknown>(path: string, body?: unknown): Promise<T>;
+  delete<T = unknown>(path: string): Promise<T>;
+}
+/**
+ * Strip a single string of dangerous characters:
+ * - ASCII control chars (0x00-0x08, 0x0B, 0x0C, 0x0E-0x1F) — keep \t \n \r
+ * - DEL (0x7F)
+ * - Zero-width / invisible Unicode (U+200B-200F, U+FEFF)
+ * - Line/paragraph separators (U+2028-2029)
+ * - ANSI escape sequences (CSI + OSC patterns)
+ */
+declare function sanitizeString(str: string): string;
+//#endregion
+//#region src/config.d.ts
+interface Profile {
+  secretKey: string;
+  environment: 'sandbox' | 'production';
+  baseUrl?: string;
+}
+declare function getProfile(profileName?: string): Profile | null;
+declare function saveProfile(name: string, profile: Profile): void;
+/**
+ * Resolve the secret key from (in priority order):
+ * 1. --key flag
+ * 2. RECUR_SECRET_KEY env var
+ * 3. Active profile in ~/.recur/credentials.json
+ *
+ * Validates format before returning.
+ */
+declare function resolveSecretKey(opts: {
+  key?: string;
+  profile?: string;
+}): string;
+/**
+ * Validate a URL uses HTTPS (or HTTP for localhost in development).
+ * Rejects non-http(s) schemes like file://, javascript://, data://.
+ */
+declare function validateUrl(url: string, label: string): string;
+/**
+ * Resolve the base URL for API calls.
+ */
+declare function resolveBaseUrl(opts: {
+  baseUrl?: string;
+  profile?: string;
+}): string;
+//#endregion
+//#region src/output.d.ts
+type OutputFormat = 'json' | 'table' | 'csv' | 'ndjson';
+interface OutputOptions {
+  format: OutputFormat;
+  fields?: string[];
+  noHeaders?: boolean;
+}
+/**
+ * Render data in the specified format.
+ * Agent-optimized: --output json produces clean, parseable JSON to stdout.
+ * Human-optimized: table format with colors to stderr-safe stdout.
+ */
+declare function render(data: unknown, opts?: OutputOptions): void;
+/**
+ * Pick specific fields from data (for --fields flag).
+ */
+declare function pickFields<T extends Record<string, unknown>>(data: T | T[], fields: string[]): Partial<T> | Partial<T>[];
+//#endregion
+//#region src/validator.d.ts
+/**
+ * Validate a resource ID or slug against dangerous input patterns.
+ * Rejects path traversals, embedded query params, control chars.
+ *
+ * Does NOT enforce ID prefixes — Recur uses CUID-format IDs (e.g.
+ * "ro91zsticf41uwq8bungmklk") without a prefix like "cus_".
+ */
+declare function validateResourceId(id: string): string;
+/**
+ * Parse and validate a raw JSON payload from --json flag.
+ */
+declare function parseJsonPayload(raw: string): Record<string, unknown>;
+/**
+ * Validate that a string looks like a valid API key.
+ */
+declare function validateApiKey(key: string): string;
+//#endregion
+//#region ../core/src/api/resources.d.ts
+/**
+ * Canonical API resource definitions — single source of truth.
+ *
+ * Consumed by:
+ *   - CLI (`packages/cli`) — schema introspection, --fields validation, --dry-run
+ *   - MCP (`apps/mcp`) — tool descriptions, enum values, field names
+ *
+ * ⚠️  ZERO DEPENDENCIES — no Prisma, no zod, no workspace imports.
+ *     This file is bundled into the standalone CLI npm package.
+ */
+type FieldType = 'string' | 'number' | 'boolean' | 'datetime' | 'object' | 'array';
+interface ResponseFieldDef {
+  name: string;
+  type: FieldType;
+  description?: string;
+  nullable?: boolean;
+}
+interface ParamDef {
+  type: 'string' | 'number' | 'boolean';
+  description: string;
+  required?: boolean;
+  enum?: readonly string[];
+  default?: string | number | boolean;
+  /** CLI flag name when different from API field (e.g. --product-id for productId) */
+  cliFlag?: string;
+}
+interface PaginationDef {
+  /** Query param name for cursor (e.g. 'starting_after') */
+  cursor: string;
+  defaultLimit: number;
+  maxLimit: number;
+}
+interface ActionDef {
+  method: string;
+  path: string;
+  description: string;
+  params?: Record<string, ParamDef>;
+  bodySchema?: Record<string, ParamDef>;
+  responseFields: readonly ResponseFieldDef[];
+  supportsDryRun?: boolean;
+  pagination?: PaginationDef;
+}
+interface ResourceDef {
+  resource: string;
+  description: string;
+  actions: Record<string, ActionDef>;
+}
+/** Extract field names from ResponseFieldDef[] (for --fields validation) */
+declare function fieldNames(fields: readonly ResponseFieldDef[]): string[];
+//#endregion
+//#region src/schema.d.ts
+declare function getResource(name: string): ResourceDef | undefined;
+declare function getAllResources(): ResourceDef[];
+declare function getAction(resourceAction: string): ActionDef | undefined;
+/**
+ * Dump schema as machine-readable JSON for agents.
+ * Throws CLIError for unknown resources/actions (non-zero exit).
+ */
+declare function dumpSchema(resourceAction?: string): unknown;
+//#endregion
+//#region src/extract.d.ts
+/**
+ * Extract list data from API responses.
+ *
+ * All list endpoints return a standard envelope: { object: 'list', data: [...] }.
+ * This function also handles legacy shapes and direct arrays as fallback.
+ */
+declare function extractList(response: unknown): unknown[];
+/**
+ * Result of extracting a paginated list response.
+ */
+interface PaginatedListResult {
+  data: unknown[];
+  hasMore: boolean;
+  nextCursor: string | null;
+}
+/**
+ * Extract list data with pagination metadata.
+ *
+ * API responses include:
+ * - has_more: boolean — whether more pages exist
+ * - next_cursor: string | null — ID to pass as starting_after for next page
+ */
+declare function extractPaginatedList(response: unknown): PaginatedListResult;
+//#endregion
+//#region src/errors.d.ts
+declare class CLIError extends Error {
+  readonly statusCode?: number | undefined;
+  constructor(message: string, statusCode?: number | undefined);
+}
+//#endregion
+export { type ActionDef, type ApiResponse, CLIError, type ClientOptions, type FieldType, type OutputFormat, type OutputOptions, type PaginatedListResult, type PaginationDef, type ParamDef, type Profile, RecurClient, type ResourceDef, type ResponseFieldDef, dumpSchema, extractList, extractPaginatedList, fieldNames, getAction, getAllResources, getProfile, getResource, parseJsonPayload, pickFields, render, resolveBaseUrl, resolveSecretKey, sanitizeString, saveProfile, validateApiKey, validateResourceId, validateUrl };
+//# sourceMappingURL=index.d.mts.map