Property names with at sign throw parsing error in declaration file

[corydeppen]

Description

After generating the types, there are errors (e.g. Parsing error: Property or signature expected) in the .d.ts file that appear to be caused by unquoted property names that include an at sign. The following is a snippet taken from a StackPath OpenAPI doc.

"apiStatusDetail": {
  "type": "object",
  "properties": { "@type": { "type": "string" } },
  "required": ["@type"],
  "discriminator": { "propertyName": "@type" }
}

The generated file includes the following:

"stackpath.rpc.Help": {
  @type: "stackpath.rpc.Help";
} & Omit<components["schemas"]["apiStatusDetail"], "@type"> & {
  links?: (components["schemas"]["stackpath.rpc.Help.Link"])[];
};

Name	Version
openapi-typescript	6.2.6
Node.js	18.16.0
OS + version	macOS 12.6.6

Expected result

Property names that include an at sign should be quoted (e.g. "@type": "stackpath.rpc.Help";).

Checklist

• My OpenAPI schema passes the Redocly validator (npx @redocly/cli@latest lint)
• I’m willing to open a PR (see CONTRIBUTING.md)

[drwpow]

This is a bug in the RegEx that detects when object keys in JS need to be escaped or not (while also escaping / and ~ needed for $refs). Should be a simple fix.

I’ve added the help wanted and good first issue labels as this would be a great PR for someone that wants to contribute. The fix would be:

1. Changing this RegEx
2. Adding a test in utils.test.ts to test (ideally before the fix, so it can be recreated & verified)
3. (optional) Adding a test in schema-object.test.ts to test the wrapping transformation works as intended

[pvanagtmaal]

@drwpow I'm looking into this now and I don't think it's the regex, rather this line seems to be missing an escObjKey call for the property name.