+ {apiDocData && `API documentation loaded for ${serviceName} with ${Object.keys(apiDocData.paths || {}).length} endpoints`}
+
+ {errorDetails.message}
+ + {adminId && ( +
+ Admin ID: {adminId}
+
+ Error Code: {errorDetails.statusCode} +
+ )} + + {retryCount > 0 && ( ++ Retry attempt {retryCount} of {maxRetries} +
+ )} + + {lastRetryTime && ( ++ Last retry: {lastRetryTime.toLocaleTimeString()} +
+ )} +Error Message:
+{error.message}
+ {(error as any).digest && ( + <> +Digest:
+{(error as any).digest}
+ + )} +Stack Trace:
+{error.stack}
+ {description}
+ )} ++ {description} +
+ )} + {error && ( +
+
{description}
+ )} +Loading administrator details...
++ {error.message || 'Failed to load administrator details'} +
++ Modify administrator profile and permissions +
+{parsedMessage}
++ An error occurred while creating the administrator account. +
++ Retrying... (Attempt {retryCount + 1} of {maxRetries}) +
+Message: {error.message}
+ {error.code &&Code: {error.code}
} + {error.field &&Field: {error.field}
} + {error.stack && ( +{error.stack}
+ + Create a new administrator account with comprehensive access controls and role management. +
+{submitError}
++ {retryCount === 1 ? '1 retry attempt' : `${retryCount} retry attempts`} +
+ )} ++ {error instanceof Error ? error.message : 'An unexpected error occurred'} +
+ ++ Manage administrator accounts and permissions +
++ {errors.query.message} +
+ )} ++ {errors.isActive.message} +
+ )} ++ {errors.role.message} +
+ )} ++ Browse and interact with your API service documentation +
++ {filters.search || filters.type !== 'all' || filters.status !== 'all' + ? 'Try adjusting your filters to see more results.' + : 'No API services are currently available for documentation.'} +
+ {(filters.search || filters.type !== 'all' || filters.status !== 'all') && ( + + )} ++ {error?.message || 'An unexpected error occurred'} +
++ The service '{serviceName}' could not be found. +
+ ++ API Documentation +
++ Something went wrong while loading the API documentation. +
+Thank you for joining us.
', + body_text: 'Welcome! Thank you for joining us.', + created_date: '2024-01-15T10:00:00Z', + last_modified_date: '2024-01-20T14:30:00Z' + }, + { + id: 2, + name: 'password_reset', + description: 'Password reset email template', + subject: 'Password Reset Request', + body_html: 'Click the link below to reset your password.
', + body_text: 'Password Reset: Click the link below to reset your password.', + created_date: '2024-01-15T10:00:00Z', + last_modified_date: '2024-01-18T09:15:00Z' + }, + { + id: 3, + name: 'invitation', + description: 'User invitation email template', + subject: 'You have been invited to join our platform', + body_html: 'You have been invited to join our platform.
', + body_text: 'Invitation: You have been invited to join our platform.', + created_date: '2024-01-16T11:00:00Z', + last_modified_date: '2024-01-22T16:45:00Z' + } + ] + + const response = createApiResponse(templates, { + count: templates.length, + total: templates.length + }) + + return HttpResponse.json(response, { status: 200 }) + }), + + // GET /api/v2/email/_template/{id} - Get specific email template + http.get(`${baseUrl}/email/_template/:id`, async ({ request, params }) => { + await simulateNetworkConditions(config) + + // Validate authentication + const auth = validateAuthentication(request, config) + if (!auth.isValid) { + return HttpResponse.json(auth.error, { status: auth.error!.status }) + } + + const templateId = parseInt(params.id as string, 10) + + if (isNaN(templateId) || templateId < 1 || templateId > 3) { + return HttpResponse.json( + createErrorResponse({ + code: 'TEMPLATE_NOT_FOUND', + message: `Email template with ID ${params.id} not found`, + status: 404 + }, 404), + { status: 404 } + ) + } + + const templates = { + 1: { + id: 1, + name: 'welcome_email', + description: 'Welcome email template for new users', + subject: 'Welcome to DreamFactory!', + body_html: 'Thank you for joining us.
', + body_text: 'Welcome! Thank you for joining us.', + from_name: 'DreamFactory Team', + from_email: 'noreply@dreamfactory.com', + reply_to_name: 'Support Team', + reply_to_email: 'support@dreamfactory.com', + created_date: '2024-01-15T10:00:00Z', + last_modified_date: '2024-01-20T14:30:00Z', + created_by_id: 1, + last_modified_by_id: 1 + }, + 2: { + id: 2, + name: 'password_reset', + description: 'Password reset email template', + subject: 'Password Reset Request', + body_html: 'Click the link below to reset your password: Reset Password
', + body_text: 'Password Reset: Click the link below to reset your password: {reset_url}', + from_name: 'DreamFactory Security', + from_email: 'security@dreamfactory.com', + reply_to_name: 'Support Team', + reply_to_email: 'support@dreamfactory.com', + created_date: '2024-01-15T10:00:00Z', + last_modified_date: '2024-01-18T09:15:00Z', + created_by_id: 1, + last_modified_by_id: 2 + }, + 3: { + id: 3, + name: 'invitation', + description: 'User invitation email template', + subject: 'You have been invited to join our platform', + body_html: 'You have been invited to join our platform. Click here to accept.
', + body_text: 'Invitation: You have been invited to join our platform. Visit: {invitation_url}', + from_name: 'DreamFactory Team', + from_email: 'invitations@dreamfactory.com', + reply_to_name: 'Support Team', + reply_to_email: 'support@dreamfactory.com', + created_date: '2024-01-16T11:00:00Z', + last_modified_date: '2024-01-22T16:45:00Z', + created_by_id: 1, + last_modified_by_id: 1 + } + } + + const template = templates[templateId as keyof typeof templates] + const response = createApiResponse(template) + + return HttpResponse.json(response, { status: 200 }) + }) + ] +} + +// ============================================================================= +// API DOCUMENTATION ENDPOINT HANDLERS +// ============================================================================= + +/** + * Creates MSW handlers for API documentation generation endpoints + * Simulates OpenAPI specification generation and schema operations + */ +export function createApiDocumentationHandlers(config: MSWHandlerConfig = DEFAULT_MSW_CONFIG) { + const baseUrl = config.baseUrl || '/api/v2' + + return [ + // GET /api/v2/{service}/_schema - Get OpenAPI specification + http.get(`${baseUrl}/:service/_schema`, async ({ request, params }) => { + await simulateNetworkConditions(config, true) // Schema generation is slow + + // Validate authentication + const auth = validateAuthentication(request, config) + if (!auth.isValid) { + return HttpResponse.json(auth.error, { status: auth.error!.status }) + } + + const serviceName = params.service as string + + // Validate service exists + const validServices = ['email', 'mysql_customers', 'postgresql_db', 'mongodb_data'] + if (!validServices.includes(serviceName)) { + return HttpResponse.json( + createErrorResponse({ + code: 'SERVICE_NOT_FOUND', + message: `Service '${serviceName}' not found`, + status: 404 + }, 404), + { status: 404 } + ) + } + + // Generate service-specific OpenAPI specification + const serviceType = serviceName === 'email' ? 'email' : 'database' + const openApiSpec = createMockApiDocsData({ + serviceName: serviceName, + serviceType: serviceType, + description: `Auto-generated API documentation for ${serviceName} service`, + baseUrl: `${baseUrl}/${serviceName}` + }) + + // Add generation metadata + const enhancedSpec = { + ...openApiSpec, + 'x-generation-meta': { + generated_at: new Date().toISOString(), + generated_by: auth.userId, + service_id: validServices.indexOf(serviceName) + 1, + performance: { + generation_time: Math.floor(Math.random() * 2000) + 1000, // 1-3 seconds + endpoint_count: Object.keys(openApiSpec.paths).length, + schema_count: Object.keys(openApiSpec.components?.schemas || {}).length + } + } + } + + return HttpResponse.json(enhancedSpec, { status: 200 }) + }), + + // POST /api/v2/{service}/_schema/_generate - Generate API documentation + http.post(`${baseUrl}/:service/_schema/_generate`, async ({ request, params }) => { + await simulateNetworkConditions(config, true) // Generation is slow + + // Validate authentication + const auth = validateAuthentication(request, config) + if (!auth.isValid) { + return HttpResponse.json(auth.error, { status: auth.error!.status }) + } + + // Check admin permissions for generation + const permission = validateRolePermissions('POST', request.url, auth.isAdmin, auth.role) + if (!permission.hasPermission) { + return HttpResponse.json(permission.error, { status: permission.error!.status }) + } + + const serviceName = params.service as string + + try { + const body = await request.json() + + // Simulate generation process with progress tracking + const generationId = `gen_${Date.now()}_${serviceName}` + + // Simulate realistic generation time + const estimatedTime = (body.tableCount || 10) * 200 // 200ms per table + await delay(Math.min(estimatedTime, 5000)) // Max 5 seconds + + const result: GenerationResult = { + id: generationId, + serviceId: 1, + status: 'success', + message: 'API documentation generated successfully', + service: apiDocsTestDataFactory.service.create({ + name: serviceName, + type: serviceName === 'email' ? 'smtp' : 'mysql' + }), + openapi: createMockApiDocsData({ + serviceName: serviceName, + serviceType: serviceName === 'email' ? 'email' : 'database', + customEndpoints: body.customEndpoints || {} + }), + endpoints: apiDocsTestDataFactory.generation.createEndpointConfigs(), + metadata: { + generatedAt: new Date().toISOString(), + generatedBy: `user_${auth.userId}`, + version: '1.0.0', + source: 'DreamFactory Admin Interface React', + settings: { + includeViews: body.includeViews || false, + enableCaching: body.enableCaching !== false, + enablePagination: body.enablePagination !== false, + tableCount: body.tableCount || 10 + } + }, + validation: validateOpenAPISpecification(createMockApiDocsData()), + performance: { + totalTime: estimatedTime, + phases: { + discovery: Math.floor(estimatedTime * 0.3), + generation: Math.floor(estimatedTime * 0.5), + validation: Math.floor(estimatedTime * 0.2) + }, + resourceUsage: { + memory: Math.floor(Math.random() * 100) + 50, // 50-150 MB + cpu: Math.floor(Math.random() * 30) + 10 // 10-40% + } + } + } + + const response = createApiResponse(result) + return HttpResponse.json(response, { status: 201 }) + + } catch (error) { + return HttpResponse.json( + createErrorResponse({ + code: 'GENERATION_FAILED', + message: 'API documentation generation failed', + status: 500, + details: { + phase: 'initialization', + error: error instanceof Error ? error.message : 'Unknown error' + } + }, 500), + { status: 500 } + ) + } + }), + + // GET /api/v2/{service}/_schema/_progress/{id} - Get generation progress + http.get(`${baseUrl}/:service/_schema/_progress/:id`, async ({ request, params }) => { + await simulateNetworkConditions(config) + + // Validate authentication + const auth = validateAuthentication(request, config) + if (!auth.isValid) { + return HttpResponse.json(auth.error, { status: auth.error!.status }) + } + + const progressId = params.id as string + + // Simulate progressive generation status + const phases = ['initializing', 'analyzing', 'generating', 'validating', 'completing'] + const currentPhase = phases[Math.floor(Math.random() * phases.length)] + const progress = Math.floor(Math.random() * 100) + + const progressData: GenerationProgress = { + id: progressId, + serviceId: 1, + phase: currentPhase as any, + progress, + operation: `${currentPhase.charAt(0).toUpperCase() + currentPhase.slice(1)} API documentation...`, + message: getProgressMessage(currentPhase, progress), + startedAt: new Date(Date.now() - 30000).toISOString(), // Started 30 seconds ago + metrics: { + duration: 30000 + Math.random() * 60000, // 30-90 seconds + endpointsGenerated: Math.floor(progress / 10), + specSize: Math.floor(progress * 1000), + validationTime: Math.floor(Math.random() * 500) + } + } + + const response = createApiResponse(progressData) + return HttpResponse.json(response, { status: 200 }) + }), + + // POST /api/v2/{service}/_schema/_validate - Validate OpenAPI specification + http.post(`${baseUrl}/:service/_schema/_validate`, async ({ request }) => { + await simulateNetworkConditions(config) + + // Validate authentication + const auth = validateAuthentication(request, config) + if (!auth.isValid) { + return HttpResponse.json(auth.error, { status: auth.error!.status }) + } + + try { + const body = await request.json() + + // Validate the provided OpenAPI specification + const validation = validateOpenAPISpecification(body) + const quality = assessApiDocumentationQuality(body) + + const response = createApiResponse({ + validation, + quality, + compliance: { + openapi_version: body.openapi || 'unknown', + specification_valid: validation.isValid, + quality_score: quality.score, + recommendations: quality.recommendations, + security_analysis: { + authentication_required: !!body.security, + security_schemes_defined: !!body.components?.securitySchemes, + endpoints_secured: body.paths ? + Object.values(body.paths).every((path: any) => + Object.values(path).some((op: any) => op.security) + ) : false + } + }, + timestamp: new Date().toISOString() + }) + + return HttpResponse.json(response, { status: 200 }) + + } catch (error) { + return HttpResponse.json( + createErrorResponse({ + code: 'VALIDATION_ERROR', + message: 'Invalid OpenAPI specification format', + status: 422, + details: { + error: error instanceof Error ? error.message : 'Parse error' + } + }, 422), + { status: 422 } + ) + } + }) + ] +} + +// ============================================================================= +// SERVICE MANAGEMENT HANDLERS +// ============================================================================= + +/** + * Creates MSW handlers for service management operations + * Simulates CRUD operations for DreamFactory services + */ +export function createServiceManagementHandlers(config: MSWHandlerConfig = DEFAULT_MSW_CONFIG) { + const baseUrl = config.baseUrl || '/api/v2' + + return [ + // GET /api/v2/system/service - List all services + http.get(`${baseUrl}/system/service`, async ({ request }) => { + await simulateNetworkConditions(config) + + // Validate authentication + const auth = validateAuthentication(request, config) + if (!auth.isValid) { + return HttpResponse.json(auth.error, { status: auth.error!.status }) + } + + // Parse query parameters for filtering and pagination + const url = new URL(request.url) + const limit = parseInt(url.searchParams.get('limit') || '25', 10) + const offset = parseInt(url.searchParams.get('offset') || '0', 10) + const filter = url.searchParams.get('filter') + const fields = url.searchParams.get('fields') + + // Generate services data + let services = apiDocsTestDataFactory.service.createMany(15) + + // Apply filtering + if (filter) { + services = services.filter(service => + service.name.toLowerCase().includes(filter.toLowerCase()) || + service.type.toLowerCase().includes(filter.toLowerCase()) + ) + } + + // Apply pagination + const total = services.length + const paginatedServices = services.slice(offset, offset + limit) + + // Apply field selection + if (fields) { + const fieldList = fields.split(',').map(f => f.trim()) + // In real implementation, would filter object properties + } + + const response = createApiResponse(paginatedServices, { + count: paginatedServices.length, + offset, + limit, + total, + has_more: offset + limit < total + }) + + return HttpResponse.json(response, { status: 200 }) + }), + + // POST /api/v2/system/service - Create new service + http.post(`${baseUrl}/system/service`, async ({ request }) => { + await simulateNetworkConditions(config) + + // Validate authentication + const auth = validateAuthentication(request, config) + if (!auth.isValid) { + return HttpResponse.json(auth.error, { status: auth.error!.status }) + } + + // Check admin permissions + const permission = validateRolePermissions('POST', request.url, auth.isAdmin, auth.role) + if (!permission.hasPermission) { + return HttpResponse.json(permission.error, { status: permission.error!.status }) + } + + try { + const body = await request.json() + + // Validate required fields + const requiredFields = ['name', 'type', 'config'] + const missingFields = requiredFields.filter(field => !body[field]) + + if (missingFields.length > 0) { + return HttpResponse.json( + createErrorResponse({ + code: 'VALIDATION_ERROR', + message: 'Validation failed', + status: 422, + details: { + validation_errors: missingFields.map(field => ({ + field, + message: `${field} is required` + })) + } + }, 422), + { status: 422 } + ) + } + + // Create service + const service = apiDocsTestDataFactory.service.create({ + id: Math.floor(Math.random() * 10000) + 1000, + name: body.name, + type: body.type, + label: body.label || body.name, + description: body.description || '', + config: body.config, + createdById: auth.userId, + lastModifiedById: auth.userId + }) + + const response = createApiResponse(service) + return HttpResponse.json(response, { status: 201 }) + + } catch (error) { + return HttpResponse.json( + createErrorResponse({ + code: 'INVALID_REQUEST_BODY', + message: 'Invalid JSON in request body', + status: 400 + }, 400), + { status: 400 } + ) + } + }), + + // GET /api/v2/system/service/{id} - Get specific service + http.get(`${baseUrl}/system/service/:id`, async ({ request, params }) => { + await simulateNetworkConditions(config) + + // Validate authentication + const auth = validateAuthentication(request, config) + if (!auth.isValid) { + return HttpResponse.json(auth.error, { status: auth.error!.status }) + } + + const serviceId = parseInt(params.id as string, 10) + + if (isNaN(serviceId)) { + return HttpResponse.json( + createErrorResponse({ + code: 'INVALID_SERVICE_ID', + message: 'Service ID must be a valid integer', + status: 400 + }, 400), + { status: 400 } + ) + } + + // Check if service exists (simulate some services don't exist) + if (serviceId > 100) { + return HttpResponse.json( + createErrorResponse({ + code: 'SERVICE_NOT_FOUND', + message: `Service with ID ${serviceId} not found`, + status: 404 + }, 404), + { status: 404 } + ) + } + + const service = apiDocsTestDataFactory.service.create({ id: serviceId }) + const response = createApiResponse(service) + + return HttpResponse.json(response, { status: 200 }) + }), + + // PUT /api/v2/system/service/{id} - Update service + http.put(`${baseUrl}/system/service/:id`, async ({ request, params }) => { + await simulateNetworkConditions(config) + + // Validate authentication + const auth = validateAuthentication(request, config) + if (!auth.isValid) { + return HttpResponse.json(auth.error, { status: auth.error!.status }) + } + + // Check admin permissions + const permission = validateRolePermissions('PUT', request.url, auth.isAdmin, auth.role) + if (!permission.hasPermission) { + return HttpResponse.json(permission.error, { status: permission.error!.status }) + } + + const serviceId = parseInt(params.id as string, 10) + + if (isNaN(serviceId)) { + return HttpResponse.json( + createErrorResponse({ + code: 'INVALID_SERVICE_ID', + message: 'Service ID must be a valid integer', + status: 400 + }, 400), + { status: 400 } + ) + } + + try { + const body = await request.json() + + const service = apiDocsTestDataFactory.service.create({ + id: serviceId, + ...body, + lastModifiedById: auth.userId, + lastModifiedDate: new Date().toISOString() + }) + + const response = createApiResponse(service) + return HttpResponse.json(response, { status: 200 }) + + } catch (error) { + return HttpResponse.json( + createErrorResponse({ + code: 'INVALID_REQUEST_BODY', + message: 'Invalid JSON in request body', + status: 400 + }, 400), + { status: 400 } + ) + } + }), + + // DELETE /api/v2/system/service/{id} - Delete service + http.delete(`${baseUrl}/system/service/:id`, async ({ request, params }) => { + await simulateNetworkConditions(config) + + // Validate authentication + const auth = validateAuthentication(request, config) + if (!auth.isValid) { + return HttpResponse.json(auth.error, { status: auth.error!.status }) + } + + // Check admin permissions + const permission = validateRolePermissions('DELETE', request.url, auth.isAdmin, auth.role) + if (!permission.hasPermission) { + return HttpResponse.json(permission.error, { status: permission.error!.status }) + } + + const serviceId = parseInt(params.id as string, 10) + + if (isNaN(serviceId)) { + return HttpResponse.json( + createErrorResponse({ + code: 'INVALID_SERVICE_ID', + message: 'Service ID must be a valid integer', + status: 400 + }, 400), + { status: 400 } + ) + } + + // Simulate deletion + const response = createApiResponse({ + id: serviceId, + success: true, + message: `Service ${serviceId} deleted successfully` + }) + + return HttpResponse.json(response, { status: 200 }) + }), + + // POST /api/v2/system/service/{id}/_test - Test service connection + http.post(`${baseUrl}/system/service/:id/_test`, async ({ request, params }) => { + await simulateNetworkConditions(config, true) // Connection testing is slow + + // Validate authentication + const auth = validateAuthentication(request, config) + if (!auth.isValid) { + return HttpResponse.json(auth.error, { status: auth.error!.status }) + } + + const serviceId = parseInt(params.id as string, 10) + + // Simulate connection test with realistic results + await delay(Math.random() * 2000 + 1000) // 1-3 seconds + + // Simulate occasional connection failures + if (Math.random() < 0.1) { // 10% failure rate + return HttpResponse.json( + createErrorResponse({ + code: 'CONNECTION_FAILED', + message: 'Unable to connect to service', + status: 503, + details: { + service_id: serviceId, + connection_error: 'Network timeout', + suggested_actions: [ + 'Check network connectivity', + 'Verify service configuration', + 'Check firewall settings' + ] + } + }, 503), + { status: 503 } + ) + } + + const response = createApiResponse({ + success: true, + service_id: serviceId, + message: 'Service connection test successful', + test_results: { + connection_status: 'successful', + response_time: Math.floor(Math.random() * 500) + 50, // 50-550ms + ssl_verification: 'passed', + authentication: 'verified', + timestamp: new Date().toISOString() + } + }) + + return HttpResponse.json(response, { status: 200 }) + }) + ] +} + +// ============================================================================= +// UTILITY FUNCTIONS +// ============================================================================= + +/** + * Gets progress message based on current phase and progress percentage + */ +function getProgressMessage(phase: string, progress: number): string { + const messages = { + initializing: [ + 'Initializing API generation process...', + 'Setting up generation environment...', + 'Validating service configuration...' + ], + analyzing: [ + 'Analyzing database schema structure...', + 'Discovering table relationships...', + 'Mapping field types and constraints...', + 'Processing table metadata...' + ], + generating: [ + 'Generating OpenAPI paths and operations...', + 'Creating schema definitions...', + 'Building endpoint configurations...', + 'Optimizing API structure...' + ], + validating: [ + 'Validating OpenAPI specification...', + 'Running quality assessments...', + 'Checking compliance standards...', + 'Finalizing documentation...' + ], + completing: [ + 'Finalizing API documentation...', + 'Generating completion report...', + 'Cleaning up temporary resources...' + ] + } + + const phaseMessages = messages[phase as keyof typeof messages] || ['Processing...'] + const messageIndex = Math.floor((progress / 100) * phaseMessages.length) + return phaseMessages[Math.min(messageIndex, phaseMessages.length - 1)] +} + +// ============================================================================= +// MAIN HANDLER EXPORT +// ============================================================================= + +/** + * Creates comprehensive MSW handlers for API documentation testing + * Combines all handler categories for complete API simulation + * + * @param config - MSW handler configuration options + * @returns Array of MSW request handlers + * + * @example + * ```typescript + * import { setupServer } from 'msw/node' + * import { createApiDocsHandlers } from './msw-handlers' + * + * // Setup MSW server for testing + * const server = setupServer(...createApiDocsHandlers()) + * + * // Custom configuration + * const handlers = createApiDocsHandlers({ + * baseUrl: '/api/v2', + * defaultDelay: 50, + * authentication: { enabled: false } + * }) + * ``` + */ +export function createApiDocsHandlers(config: Partial
+ {row.apiKey}
+
+ Loading applications...
+Failed to load applications
++ {error instanceof Error ? error.message : "An unexpected error occurred"} +
+No applications found
+Create your first application to get started.
+
+ {app.apiKey}
+
+ + We encountered an issue while loading the application management interface. + This may be due to a network connection problem or a temporary server issue. +
+ + {/* Development Error Details */} + {process.env.NODE_ENV === 'development' && error && ( +
+
+ {error.message}
+ {error.stack && (
+ <>
+ {'\n\n'}
+ {error.stack}
+
+ )}
+
+
+ + We encountered an error while loading the email templates configuration. + This might be a temporary issue with the server connection. +
+ + {/* Development Error Details */} + {process.env.NODE_ENV === 'development' && ( +
+ {error.message}
+ {error.stack && (
+ <>
+ {'\n\n'}
+ {error.stack}
+
+ )}
+
+ + This page allows you to manage email templates for your DreamFactory instance. + You can create, edit, and delete email templates, as well as configure their + content and variables for automated notifications and user communications. +
+{'{{username}}'} and {'{{app_name}}'} for dynamic content
+