deepl/deepl-mock

Purpose and principal workflow: DeepL API mock server for client-library testing, with a separate basic proxy listener. The main workflow starts when an external API client or test sends an HTTP request: the Express app in index.js applies middleware, dispatches versioned API routes, and returns simulated DeepL responses. For text translation, route handling delegates language validation and canned translation behavior to the language subsystem; other routes cover account usage, documents, glossaries, translation memories, and writing features.

Components

HTTP entry, routes, and proxy

• API client or test — *(external; no repository path)* Initiates the principal workflow by sending HTTP requests to the mock API, as documented in the README.

• Express API and proxy listeners — index.js Sets up the Express app and API routes, including v2 language, usage, translation, and writing endpoints; the README documents a second port for proxy use. The sampled excerpt does not show listener startup or proxy forwarding details.

Request context and contract checking

• Session middleware and session state — sessions.js Creates in-memory sessions from mock-server-session headers, attaches session settings to requests, and supports simulated no-response and proxy-expectation behavior.

• Authentication and account state — auth.js Extracts an auth key, creates and refreshes in-memory user accounts, and initializes usage limits from session settings.

• OpenAPI validation — response-validator.js Loads the spec from a configured source and provides request/response validation middleware; the README documents opt-in validation and its startup requirements.

• HTTP utilities — util.js Supplies shared request/error and cleanup helpers; the sampled session and domain modules use its cleanup scheduling and HttpError behavior.

Simulated API domains

• Language and text behavior — languages.js Reads language and product configuration, checks language and feature support, and supplies mock translation, correction, and rephrasing results.

• Language feature configuration — config/languages/language-list.json Provides language-list data consumed by languages.js; additional product configuration files are present in the same directory.

• Document translation lifecycle — documents.js Stores uploaded document metadata and files, reports queued/translating/completed status, and invokes languages.translate to produce output.

• v2 glossaries — glossariesV2.js Implements in-memory v2 glossary creation, lookup, entry retrieval, and removal, with language-pair validation.

• v3 glossaries — glossariesV3.js Implements in-memory v3 glossaries and dictionaries, including language-pair checks and entry-format handling.

• Glossary CSV parsing — glossariesCsvParser.js Converts CSV entries into glossary source/target pairs and rejects invalid or empty input.

• Translation memories and jobs — translationMemories.js Keeps in-memory translation memories and import/export jobs, with ownership checks and poll-driven job status.

• Style rules — styleRules.js Manages in-memory style rules and custom instructions, including validation and version updates.

Relationships

• API client or test -> Express API and proxy listeners: sends HTTP requests to the documented mock API or proxy ports; README.

• Express API and proxy listeners -> Session middleware and session state: API requests use session middleware and session-derived fault settings; sessions.js documents middleware behavior, while index.js shows route middleware registration.

• Express API and proxy listeners -> Authentication and account state: protected routes apply auth middleware before handlers; index.js route registrations and auth.js middleware.

• Express API and proxy listeners -> OpenAPI validation: validation middleware is available for app installation when enabled; README and response-validator.js. The sampled excerpts do not establish its exact installation order.

• Authentication and account state -> Session middleware and session state: reads session initialization limits when creating user usage state; auth.js.

• Express API and proxy listeners -> Language and text behavior: translation and writing handlers use language helpers; index.js and languages.js.

• Express API and proxy listeners -> Document translation lifecycle: document API handlers delegate document operations; index.js documents route handlers and documents.js exports lifecycle operations.

• Document translation lifecycle -> Language and text behavior: invokes languages.translate to generate document output; documents.js.

• Express API and proxy listeners -> v2 glossaries: v2 glossary handlers delegate glossary operations; index.js glossary handler excerpts and glossariesV2.js.

• Express API and proxy listeners -> v3 glossaries: v3 glossary handlers delegate glossary operations; index.js shows a v3 handler and glossariesV3.js.

• v3 glossaries -> Glossary CSV parsing: parses CSV dictionary entries during glossary creation; glossariesV3.js.

• Express API and proxy listeners -> Translation memories and jobs: translation-memory handlers call memory and job operations; index.js shows a handler calling getTranslationMemoryInfo, and translationMemories.js.

• Express API and proxy listeners -> Style rules: style-rule handlers call list and mutation operations; index.js shows a list call, and styleRules.js.

Coverage limits: The index.js excerpt omits substantial routing and startup code, so listener construction, proxy forwarding, middleware installation order, and several domain route mappings could not be fully verified. The README documents additional session behavior beyond the sampled session code. No persistence beyond in-memory maps and document files is established by these inputs.