Enum values not properly escaped

[akoidan]

openapi-typescript version

7.12.0

Node.js version

20.x.x

OS + version

Archlinux

Description

When generating TypeScript types from OpenAPI specs, enum values containing backslashes (\) are not properly escaped in the generated type unions.

Reproduction

OpenAPI spec:

{
  "enum": ["a", "b", "c", "\\", ...]
}

Generated output:

type Keys = 'a' | 'b' | 'c' | '\' | ...;

Expected result

type Keys = 'a' | 'b' | 'c' | '\\' | ...;

Required

• My OpenAPI schema is valid and passes the Redocly validator (npx @redocly/cli@latest lint)

Extra

• I’m willing to open a PR (see CONTRIBUTING.md)

[akoidan]

I assume this replace is required:

            const escaped = val
              .replace(/\\/g, '\\\\')  // Escape backslashes
              .replace(/'/g, "\\'")    // Escape single quotes
              .replace(/"/g, '\\"')    // Escape double quotes
              .replace(/\n/g, '\\n')   // Escape newlines
              .replace(/\r/g, '\\r')   // Escape carriage returns
              .replace(/\t/g, '\\t'); 

[duncanbeevers]

This library mostly uses an AST builder pattern to create these unions, so your proposed solution likely won't be helpful. Additionally, I'm not able to reproduce the behavior with the tiny example you provided.

Here's a minimal, "complete" schema which uses an enum with the value \. The generated union has the expected escaped value.

The typescript is generated using the flags --export-type true --root-types true

# test-schema.yaml
openapi: 3.1.0
info:
  title: Minimal Test Schema
  version: '1.0'
components:
  schemas:
    MyEnum:
      type: string
      enum:
        - \
paths:
  /:
    get:
      operationId: getRoot
      summary: Get root
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MyEnum'

/**
 * This file was auto-generated by openapi-typescript.
 * Do not make direct changes to the file.
 */

export type paths = {
    "/": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        /** Get root */
        get: operations["getRoot"];
        put?: never;
        post?: never;
        delete?: never;
        options?: never;
        head?: never;
        patch?: never;
        trace?: never;
    };
};
export type webhooks = Record<string, never>;
export type components = {
    schemas: {
        /** @enum {string} */
        MyEnum: "\\";
    };
    responses: never;
    parameters: never;
    requestBodies: never;
    headers: never;
    pathItems: never;
};
export type SchemaMyEnum = components['schemas']['MyEnum'];
export type $defs = Record<string, never>;
export interface operations {
    getRoot: {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": components["schemas"]["MyEnum"];
                };
            };
        };
    };
}

If you could provide a clearer example and some context about the flags you're using, we'll be able to do a better job deciding whether this is a bug, and if so, how best to address it.