musement / types-generator Goto Github PK

I'm using this library against https://api.musement.com/swagger_3.4.0.json and heavily relying on --patchSource option to patch the original swagger definition and manually set the required props.

I found out that a few entities don't receive the required attributes specified in the patch file:

Patch file

"CartItemMusementGiftbox": {
  "required": ["type", "product"]
},

Output

export type CartItemMusementGiftbox = CartItem & {
  type?: "musement-giftbox",
  product?: Giftbox
} & {};

It seems to happen with types declared as union of other types.
I noticed that the declaration shows and extra & {} appended at the and of it. Could it be that the patch gets applied to this empty object type?

eg: if enum contain single quote in it's body => when pass to prettier => it should be error

From openApi:
eg: enum : [
"this is normal",
"but this's why cause error" # => this will cause error on parser
]

In an OpenAPI document, when an object has some dynamic keys, it's declared like so:

someObject:
  type: object
  additionalProperties:
    type: string

Currently, the additionalProperties keyword is ignored, and the Typescript type is generated in this way:

someObject: {}

If you are using typescript-eslint > v5.0.0, this will raise an error, because the empty object literal syntax is banned, as it is considered unsafe. Instead we should use:

someObject: Record<string, string>

In addition to the example shown above, there are other use cases for additionalProperties:

someObject:
  type: object
  additionalProperties: true

If the dictionary values can be of any type (aka free-form object) --> Record<string, unknown>

someObject:
  type: object
  additionalProperties:
    $ref: '#/components/schemas/Message'

Instead of using an inline schema, additionalProperties can $ref another schema

someObject:
  type: object
  properties:
    default:
      type: string
  required:
    - default
  additionalProperties:
    type: string

When a dictionary has some fixed properties, and some dynamic ones.