embraser01 / typoas Goto Github PK

when a param name (in this case query param) contains square brackets, it ends up generating types like this:

 {
    page[number]?: number;
    page[size]?: number;
    filter[search]?: string;
}

which is invalid TS. they need to be quoted. this style of query param is standard for JSONAPI

I tried to run the CLI with npx @typoas/cli generate but it looks like it's trying to run the CLI as a shell script.

.npm/bin/cli: line 1: use strict: command not found
.npm/bin/cli: line 2: syntax error near unexpected token `exports,'
.npm/bin/cli: line 2: `Object.defineProperty(exports, "__esModule", { value: true });'

After manually adding a shebang like this it works:

#!/usr/bin/env node

Is this not the expected usage? Or maybe this is a yarn vs npm difference?

Hi there great tool, but the documentation and examples for variableConfiguration are a bit limited:

Can you add Documentation about Auth, Headers etc?

Thanks.

ESM Target
CJS Target

For bundling, let's go with esbuild

• Only keep needed data in schemas
• Store schemas as plain JS (benchmark read performance)

I ran the following command : npx @typoas/cli generate -i http://localhost:3232/api-json -o dist/client/client.ts

Then, the bin.js script is executed in the windows script host interpreter instead of NodeJS

It would replace move to schemas components that are equivalent

Client should handle timeout (number in ms) to override default browser timeout behavior.
Doing it with axios is quite easy :

resp = await axiosClient.request({
        url: request.getUrl(),
        method: request.getHttpMethod() as Method,
        headers: request.getHeaders(),
        data: request.getBody(),
        timeout: 3000 // will abort promise if it takes more than 3 sec 
});

I don't know how to do it so far in generated client. I guess a good place would be to put it in RequestContext. The tricky part is to be able to override it in the generated api functions.

The idea would be to generate the x-codeSamples field for operations directly from typoas

Ref: https://redocly.com/docs/api-reference-docs/specification-extensions/x-code-samples/

Based on my understanding of how browsers handle FormData, we want to make sure that this is NOT set so that the correct header can be added automatically right?

See MDN FormData: https://developer.mozilla.org/en-US/docs/Web/API/FormData/Using_FormData_Objects#sect4

Currently $ref only support relative schemas (schemas declared in the same file).
It should support local and http files

Existing work: https://www.npmjs.com/package/@openapi-generator-plus/json-schema-ref-parser