const fs = require('fs'); const path = require('path'); // Configuration const OUTPUT_FILE = './simplex-types.ts'; const OPENAPI_SPEC_PATH = './api-reference/openapi.json'; console.log('Starting unified type generation...'); // Read the OpenAPI spec const openApiSpec = JSON.parse(fs.readFileSync(OPENAPI_SPEC_PATH, 'utf8')); // Helper function to convert path to PascalCase action name function pathToActionName(path, method) { const parts = path.replace(/^\//, '') .replace(/\{[^}]+\}/g, '') .replace(/[_-]/g, '/') .split('/') .filter(p => p.length > 0) .map(part => part.charAt(0).toUpperCase() + part.slice(1)); return parts.join(''); } // Helper function to resolve $ref function resolveRef(ref, spec) { if (!ref || !ref.$ref) return ref; const path = ref.$ref.replace('#/', '').split('/'); let result = spec; for (const segment of path) { result = result[segment]; } return result; } // Helper function to convert OpenAPI schema to TypeScript type function schemaToTypeScript(schema, spec, inline = false, depth = 0) { if (!schema) return 'any'; if (schema.$ref) { schema = resolveRef(schema, spec); } if (schema.type === 'string') { if (schema.enum) { return schema.enum.map(e => `'${e}'`).join(' | '); } if (schema.format === 'binary') return 'File'; return 'string'; } if (schema.type === 'integer' || schema.type === 'number') return 'number'; if (schema.type === 'boolean') return 'boolean'; if (schema.type === 'array') { const itemType = schemaToTypeScript(schema.items, spec, true, depth + 1); if (itemType.includes('\n') || itemType.includes('{')) { return `Array<${itemType}>`; } return `${itemType}[]`; } if (schema.type === 'object' || schema.properties) { if (!schema.properties && schema.additionalProperties) { const valueType = schemaToTypeScript(schema.additionalProperties, spec, true, depth + 1); return `Record`; } if (!schema.properties) { return 'Record'; } const indent = ' '.repeat(depth + 1); const properties = Object.entries(schema.properties) .map(([key, prop]) => { const type = schemaToTypeScript(prop, spec, true, depth + 1); const optional = !schema.required || !schema.required.includes(key) ? '?' : ''; const description = prop.description ? `\n${indent}/** ${prop.description} */` : ''; const cleanKey = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(key) ? key : `"${key}"`; return `${description}\n${indent}${cleanKey}${optional}: ${type};`; }) .join(''); if (depth > 0) { return `{${properties}\n${' '.repeat(depth)}}`; } return `{${properties}\n}`; } if (schema.allOf) { const merged = { type: 'object', properties: {}, required: [] }; for (const item of schema.allOf) { const resolved = item.$ref ? resolveRef(item, spec) : item; if (resolved.properties) { Object.assign(merged.properties, resolved.properties); } if (resolved.required) { merged.required.push(...resolved.required); } } return schemaToTypeScript(merged, spec, inline, depth); } if (schema.oneOf) { const types = schema.oneOf.map(s => schemaToTypeScript(s, spec, true, depth)); return types.join(' | '); } if (schema.anyOf) { return schema.anyOf.map(s => schemaToTypeScript(s, spec, true, depth)).join(' | '); } return 'any'; } // Extract request/response schemas function getRequestSchema(operation, spec) { if (!operation.requestBody) return null; const content = operation.requestBody.content; if (!content) return null; return content['application/json']?.schema || content['multipart/form-data']?.schema || content['application/x-www-form-urlencoded']?.schema; } function getResponseSchema(operation, spec) { if (!operation.responses) return null; const response = operation.responses['200'] || operation.responses['201'] || operation.responses['default']; if (!response || !response.content) return null; const content = response.content; return content['application/json']?.schema || content['text/plain']?.schema; } // Extract parameters function getPathParameters(operation) { if (!operation.parameters) return []; return operation.parameters .filter(p => p.in === 'path') .map(p => ({ name: p.name, type: p.schema?.type === 'integer' ? 'number' : 'string', required: true, description: p.description })); } function getQueryParameters(operation) { if (!operation.parameters) return []; return operation.parameters .filter(p => p.in === 'query') .map(p => ({ name: p.name, type: schemaToTypeScript(p.schema, openApiSpec, true), required: p.required || false, description: p.description })); } // Generate the unified types file const output = []; // Add header output.push(`// Complete TypeScript interfaces for Simplex API // Auto-generated from OpenAPI specification with accurate nested types // Based on actual FastAPI implementation // Generated on ${new Date().toISOString()} // =========================================== // API Endpoint Request/Response Interfaces // =========================================== `); // Process all endpoints const endpoints = []; for (const [path, pathItem] of Object.entries(openApiSpec.paths)) { for (const [method, operation] of Object.entries(pathItem)) { if (['get', 'post', 'put', 'delete', 'patch'].includes(method)) { const actionName = pathToActionName(path, method); const description = operation.description || operation.summary || ''; endpoints.push({ path, method, actionName, description, operation }); } } } // Sort endpoints alphabetically endpoints.sort((a, b) => a.actionName.localeCompare(b.actionName)); // Generate interfaces for each endpoint for (const { path, method, actionName, description, operation } of endpoints) { output.push(`// ${method.toUpperCase()} ${path}`); if (description) { output.push(`// ${description}`); } // Generate Request interface const requestSchema = getRequestSchema(operation, openApiSpec); const pathParams = getPathParameters(operation); const queryParams = getQueryParameters(operation); if (requestSchema || pathParams.length > 0 || queryParams.length > 0) { let requestInterface = `export interface ${actionName}Request `; if (requestSchema) { const tsType = schemaToTypeScript(requestSchema, openApiSpec); requestInterface += tsType; } else { const props = []; for (const param of pathParams) { const optional = param.required ? '' : '?'; const desc = param.description ? `\n /** ${param.description} */` : ''; props.push(`${desc}\n ${param.name}${optional}: ${param.type};`); } for (const param of queryParams) { const optional = param.required ? '' : '?'; const desc = param.description ? `\n /** ${param.description} */` : ''; props.push(`${desc}\n ${param.name}${optional}: ${param.type};`); } if (props.length > 0) { requestInterface += `{${props.join('')}\n}`; } else { requestInterface += '{}'; } } output.push(requestInterface); } // Generate Response interface const responseSchema = getResponseSchema(operation, openApiSpec); if (responseSchema) { let responseInterface = `export interface ${actionName}Response `; let tsType = schemaToTypeScript(responseSchema, openApiSpec); // Fix for array response types (ExtractBbox, ExtractImage) if (tsType.startsWith('Array<') && tsType.includes('{')) { // Extract the object type from Array<{...}> const match = tsType.match(/^Array<(.+)>$/s); if (match) { tsType = match[1]; } } // Replace generic types with specific ones if (actionName === 'RunWorkflowStatus' && tsType.includes('results?: Record[]')) { tsType = tsType.replace('results?: Record[]', 'results?: WorkflowResult[]'); } if (actionName === 'Agentic' && tsType.includes('result?: Record')) { tsType = tsType.replace('result?: Record', 'result?: AgentResult'); } if (actionName === 'MultiAgent' && tsType.includes('result?: Record')) { tsType = tsType.replace('result?: Record', 'result?: AgentResult'); } if (actionName === 'GetNetworkResponse' && tsType.includes('responses?: Record[]')) { tsType = tsType.replace('responses?: Record[]', 'responses?: NetworkResponseData[]'); } if (actionName === 'GetSessionLogs' && tsType.includes('logs?: Record[]')) { tsType = tsType.replace('logs?: Record[]', 'logs?: SessionLog[]'); } if (actionName === 'GetSessionStore' && tsType.includes('session_store?: Record[]')) { tsType = tsType.replace('session_store?: Record[]', 'session_store?: SessionStoreItem[]'); } responseInterface += tsType; output.push(responseInterface); } output.push(''); } // Add detailed types based on FastAPI implementation output.push(`// =========================================== // Detailed Types Based on FastAPI Implementation // =========================================== // Agent result structure export interface AgentResult { action?: string; output?: string; error?: string; [key: string]: any; } // Workflow-related types with proper structure export interface WorkflowResult { action: string; params: Record; result: Record; timestamp: string; } export interface WorkflowStatusResult { succeeded: boolean; completed: boolean; results?: WorkflowResult[]; total_actions?: number; session_id?: string; completed_at?: string; } // Multi-agent configuration export interface SubAgentConfig { name: string; prompt: string; tool_schema: { description: string; input_schema: Record; }; } // Enqueue actions with detailed structure export interface EnqueueAction { function: string; params: Record; options?: { override_fail_state?: boolean; fail?: boolean; }; } // Login session types export interface LoginSessionData { cookies?: any[]; localStorage?: Record; sessionStorage?: Record; } // ServiceTitan specific types export interface ServiceTitanCall { id: string; [key: string]: any; } export interface ServiceTitanAvailability { date: string; time_blocks: string[]; available: boolean; } // VGS Token handling (for secure data) export interface VGSTokenMessage { request_id?: string; vgs_key: string; vgs_token: string; vgs_env: 'stg' | 'prod'; session_id?: string; } export interface VGSTokenResponse { success: boolean; env?: string; key?: string; token?: string; value?: string; request_id?: string; timestamp?: string; error?: string; error_type?: string; } // Network response monitoring export interface NetworkResponseData { url: string; status: number; headers: Record; body?: any; timestamp: string; } // Session logs export interface SessionLog { timestamp: string; action: string; params?: Record; result?: Record; error?: string; } // Session store item export interface SessionStoreItem { key: string; value: any; timestamp?: string; } // =========================================== // Common Types and Utilities // =========================================== export interface SimplexConfig { apiKey: string; baseUrl?: string; } export interface ErrorResponse { succeeded: false; error: string; status?: string; message?: string; } // Helper type for API responses export type ApiResponse = T | ErrorResponse; // Generic action response export interface ActionResponse { succeeded: boolean; error?: string; } // Session-related types export interface SessionInfo { session_id: string; livestream_url?: string; connect_url?: string; vnc_url?: string; } // Workflow info export interface WorkflowInfo { workflow_id: string; session_id?: string; completed?: boolean; results?: WorkflowResult[]; } // Element-based action helpers export interface ElementActionRequest { element_description: string; session_id?: string; override_fail_state?: boolean; } // Alternative names for commonly used types export type NavigationRequest = GotoRequest; export type NavigationResponse = GotoResponse; export type SessionConnection = { session_id: string }; `); // Write to file fs.writeFileSync(OUTPUT_FILE, output.join('\n'), 'utf8'); console.log(`✅ Generated ${OUTPUT_FILE} with ${endpoints.length} endpoints`); console.log(`📁 File size: ${(fs.statSync(OUTPUT_FILE).size / 1024).toFixed(2)} KB`); console.log(`📊 Total lines: ${output.join('\n').split('\n').length}`); // Clean up old files const filesToDelete = [ './simple-types.ts', './complete-types.ts', './detailed-types.ts', './accurate-types.ts', './generate-simple-types.js', './generate-complete-types.js', './generate-detailed-types.js', './generate-accurate-types.js', './remove-endpoints.js', './remove-more-endpoints.js' ]; console.log('\n🧹 Cleaning up old files...'); for (const file of filesToDelete) { if (fs.existsSync(file)) { fs.unlinkSync(file); console.log(` ❌ Deleted: ${file}`); } } console.log('\n✨ Type generation complete!');

Getting Started

Further Functionality

Moving Into Production

FAQ + Education

​1. Request API Key

​2. Install SDK

1. Request API Key

2. Install SDK