lonestone / nest-sdk-generator Goto Github PK

Hey, great generator! As a frontend dev it is very convenient to simply import all route typesafe from the backend without having to write all types twice!

However, when trying it out, I noticed a problem with Date: With a controller that has a Date object as type, the generator copies it as such. But Nest.js automatically transforms this to an ISO string, whereby the client type is no longer correct (Date instead of string).

// demo.controller.ts

@Controller("demo")
export class DemoController {

    @Get("/route")
    demo() {
        return {
            id: 3,
            date: new Date()
        }
    }

}

// GET /demo/route
{
  "id": 3,
  "date": "2023-09-24T15:14:48.940Z"
}

export default {

    // GET @ /demo/route
    demo(
        params: {} = {},
        body: {} = {},
        query: {} = {},
    ): Promise<{ id: number; date: Date }> {
        return request("GET", `/demo/route`, body, query)
    },
}

const { date } = await demoController.demo();

// throws Uncaught TypeError: date.toLocaleDateString is not a function
console.log(date.toLocaleDateString())

Would it be possible (and if so how) to transform these Date objects automatically on the client side? Either change all Date types to strings, or ideally recursively parse them directly with new Date(value).

https://github.com/samchon/nestia

Your project seems almost same with my project, nestia.

How about participating in that project or reviewing and advising each other?

Nest Docu

Server-Sent Events (SSE) (since v7.5.0) are used as follows:

Nest controller

@Sse('sse')
sse(): Observable<MessageEvent> {
  return interval(1000).pipe(map((_) => ({ data: { hello: 'world' } })));
}

Client

const eventSource = new EventSource('/sse');
eventSource.onmessage = ({ data }) => {
  console.log('New message', JSON.parse(data));
};

Full Example from Nest: nestjs/nest/sample/28-sse

Parameters of request function are shuffled.

Maybe, body and query are reversed.

Tried to use controller, which returns some data directly from stripe library but nest-sdk-generator fails with:

ERROR: File stripe was not found (was expected to contain dependency type Stripe)

Error:

Generated imports:

Prisma index.d.ts

FYI magicTypes will not resolve the issue :(

If a parameter path of Controler decorator comes from a variable, nest-sdk-generator failed to build the SDK controller class.

All of paths written in the controller files are omitting the path separator.

For referece, my device is using the Windows.

Use case

In my application.controller.ts there is such action:

import { Response } from "express";
...
async index(@Res() res: Response) {
...
}

When I run generate command ./node_modules/.bin/nest-sdk-generator ./frontend/sdk-generator.json I get this error:

-> Extracting type Response from file ../node_modules/@types/express/index.d.ts...
ERROR: Type Response was not found in file ../node_modules/@types/express/index.d.ts

When we open @type/express L127 we can see that there is a namespace.

Config

sdk-generator.json

{
    "verbose": true,
    "apiInputPath": "../backend",
    "sdkOutput": "src/sdk",
    "sdkInterfacePath": "src/sdk/sdk-interface.ts"
}

Cause

I think that is because of one of limitation of nest-sdk-generator:

Types belonging to namespaces are currently not supported and will result in error in the generated code

Would it be possible to add support for adding a pipe to a Param decorator?

Currently getting:
Multiple (2) arguments were provided to the decorator
with this code:
@Param('cartId', CartIdPipe) cartId: string,