eywek / oatyp Goto Github PK

🏠 Build Typescript typings from OpenAPI definitions

License: MIT License

JavaScript 2.27% TypeScript 97.73%

codegen openapi swagger typescript typescript-generator

oatyp's Introduction

Hi there 👋

I am a french software engineer currently working at @datadog. I've learn to code in 2013 with a Minecraft free CMS and I've kept working on side projects during my studies, the biggest one is @MineWeb.

📗 Ex-42born2code's student from nov. 2017 to feb. 2018
👨‍💻 Previously doing some Typescript and infrastructure at @keymetrics from feb. 2018 to sep. 2019
👨‍💻 Previously lead core engineer at @reelevant mostly doing Typescript and some Rust from sep. 2019 to dec. 2023
→ Currently Software Engineer II at @datadog doing some Golang since jan. 2024

Skills

✍️ Languages

Golang since 2024 (internal company projects)
Typescript since 2018 (i.e. typoa, tgvmax bot and a lot of internal company projects)
Rust since may 2023 (content engine using rust-skia)
PHP between 2013 and 2017 (i.e. MineWeb, ObsiFight)
C between 2017 and 2018 (i.e. 42 piscine, 42 workspace, 42 project)
Some Java (i.e. PrestoDB pull-request, Pulsar Plugin for Apache Pinot), Golang (i.e. Pinot proxy), Swift (i.e. Reelevant iOS SDK)

💾 Databases / queues

I've used Redis, MongoDB, done some SQL on MariaDB, SQLite and Google BigQuery. And I've deployed and used Apache Pinot, Apache Pulsar and ElasticSearch.

🛠 Tools

I'm currently working with Git, Docker built via Github Actions and deployed on Kubernetes.

I've previously deployed Hashicorp Nomad and Hashicorp Consul via Hashicorp Terraform and used DroneCI as CI/CD.

oatyp's People

Contributors

Stargazers

Watchers

Forkers

florianmartens f-hj

oatyp's Issues

Ensure outDir exists before trying to write files

https://github.com/Eywek/oatyp/blob/main/src/index.ts#L106

Error Output:

Unable to generate: [Error: ENOENT: no such file or directory, open ...

To fix it, simply check to make sure the directory exists using fileSystem and create it if it's missing.

chore: bump axios

Support endpoints with no response content

There are endpoints that don't return any content, for example, some DELETE requests return HTTP 204.

There are few places I had to update to fix it locally, but the first error was triggered here:
https://github.com/Eywek/oatyp/blob/main/src/api.ts#L81

Support responses other than application/json

I've encountered API endpoints that the endpoint responses are simply text/plain and it looks like there are a lot of hard-coded assumptions that the responses will be application/json. Is it possible to support string responses?

It looks like the main problem is the null exception on the following line: https://github.com/Eywek/oatyp/blob/main/src/api.ts#L136

Date format annotations should not convert to Date type

OpenAPI supports format annotations for strings such as ´"cancelledAt": { "format": "date-time", "type": "string" }´. As is, this library converts this to a type like

type Model {
   cancelledAt: Date
}

Since JSON obviously does not support the object based Date type, the actual type of this object would be:

type Model {
   cancelledAt: string
}

feature-request: do not WithoutWriteonly/WithoutReadonly if there a no properties with readonly/writeonly modifier in the schema

Bug Report: Cannot read nullable types for nested references

For this OA definition:

"OrganizationEntity": {
    "type": "object",
    "properties": {
        "id": { "type": "string" },
        "updatedAt": {
            "format": "date-time",
            "type": "string",
            "nullable": true
        },
        "createdAt": { "format": "date-time", "type": "string" },
        "name": { "type": "string" },
        "licenseType": {
            "type": "string",
            "enum": [
                "FREE",
                "ESSENTIAL",
                "BUSINESS",
                "PROFESSIONAL",
                "SPONSORED"
            ]
        },
        "cancelledAt": { "format": "date-time", "type": "string" },
        "stripeCustomerId": { "type": "string" },
        "stripeSubscriptionId": {
            "type": "string",
            "nullable": true
        },
        "currentBillingPeriodEndsAt": {
            "format": "date-time",
            "type": "string",
            "nullable": true
        },
        "paymentStatus": {
            "type": "string",
            "enum": ["EXPIRED", "PAIMENT_FAILED"]
        },
        "licenseOverwrite": {
            "nullable": true,
            "allOf": [
                {
                    "$ref": "#/components/schemas/LicenseOverwriteEntity"
                }
            ]
        },
        "slug": { "type": "string" },
        "licenseId": { "type": "string" }
    },
    "required": [
        "id",
        "updatedAt",
        "createdAt",
        "name",
        "licenseType",
        "cancelledAt",
        "stripeCustomerId",
        "stripeSubscriptionId",
        "currentBillingPeriodEndsAt",
        "paymentStatus",
        "licenseOverwrite",
        "slug"
    ]
}

This library generates the following type:

export type OrganizationEntity = {
    id: string;
    updatedAt: Date | null;
    createdAt: Date;
    name: string;
    licenseType: "FREE" | "ESSENTIAL" | "BUSINESS" | "PROFESSIONAL" | "SPONSORED";
    cancelledAt: Date;
    stripeCustomerId: string;
    stripeSubscriptionId: string | null;
    currentBillingPeriodEndsAt: Date | null;
    paymentStatus: "EXPIRED" | "PAIMENT_FAILED";
    licenseOverwrite: LicenseOverwriteEntity;
    slug: string;
    licenseId?: string;
};

Although the correct type would be:

export type OrganizationEntity = {
    id: string;
    updatedAt: Date | null;
    createdAt: Date;
    name: string;
    licenseType: "FREE" | "ESSENTIAL" | "BUSINESS" | "PROFESSIONAL" | "SPONSORED";
    cancelledAt: Date;
    stripeCustomerId: string;
    stripeSubscriptionId: string | null;
    currentBillingPeriodEndsAt: Date | null;
    paymentStatus: "EXPIRED" | "PAIMENT_FAILED";
    licenseOverwrite: LicenseOverwriteEntity | null; <- WE NEED A NULL HERE
    slug: string;
    licenseId?: string;
};

Sample swagger.json file: https://gist.github.com/florianmartens/ee1623903cb55037d15ef6796e43f720

feature-request: re-export error types

Optional properties are assigned inverse?

This is such a great library that saves me a ton of time. I'm super grateful it exists! I have a small issue as illustrated below:

profile.entitiy.ts

export class ProfileEntity implements Profile {
    @ApiProperty()
    id: string;

    @ApiProperty()
    createdAt: Date;

    @ApiProperty()
    updatedAt: Date;

    @ApiProperty({ required: false })
    address: string;

    @ApiProperty({ required: false })
    city: string;

    @ApiProperty({ required: false })
    countryCode: string;

    @ApiProperty({ required: false })
    phone: string;

    @ApiProperty({ required: false })
    twitterLink: string;

    @ApiProperty({ required: false })
    linkedInLink: string;

    @ApiProperty()
    userId: string;
}

Generated type

export type ProfileEntity = {
    id?: string;
    createdAt?: Date;
    updatedAt?: Date;
    address: string;
    city: string;
    countryCode: string;
    phone: string;
    twitterLink: string;
    linkedInLink: string;
    userId?: string;
};

It seems to be as if the optional ? is appended inverse to the way it should be {required: false} should result in the type being optional and vice versa.

This happens to all my types (the above is just an example).