Issue with NestJS

[bennettl]

Trying to use this for my NestJS project, and when running got the following compilation error

import type * as types from './types';
^^^^^^

SyntaxError: Cannot use import statement outside a module

It seems like this sits outside the src folder, not sure if it can be an issue. Any help is appreciated!!!

[erunion]

I'm not at all familiar with NestJS but I have some questions about your install.

1. How did you install your API SDK?
2. Did you install it as JS or TypeScript?
3. CJS or ESM?
4. How are you loading your API SDK?

[murtinha]

edited: The problem seems to be that nest dist output main.js file is trying to access the ts file com the .app folder... So since js is trying to access a ts file it doesnt work. I could get it partially fixed using ts-node to run the main.js file

Im also having this problem after adding resolveJsonModule to my ts.config to fix the json import from the generated .api folder.

Answering @erunion

1. npx api install @open-api-docs/MYAPI
2. Typescript
3. When running on typescript it doesnt ask that actually but on tsconfig is commonjs
4. importing it directly from the generated .api folder

[erunion]

I don't use NestJS so I'm not sure how to solve this. Do you know why it's trying to use the TS file directly instead of compiling it into your app when you build your main output main.js file?

[linzera]

Probably because the .api directory is not being included in the build phase.

[murtinha]

Im not 100% sure but it seems to have to do with nest dependency injection

[Cmoen11]

This is the same issue in next.js

[erunion]

For what it's worth, if you're generating a JS SDK api will still generate TS types for you to use in local development. You don't need to generate a TS SDK to get TS types.

As for why Nest and Next aren't factoring these non-d.ts .ts files into your compilation processes I'm not sure.

[Cmoen11]

An update, if i run yarn install after i have generated the .api folder, I get these errors locally as well. It works again if I delete the folder and generate them once more.. @erunion

[Cmoen11]

Alright, @erunion I think I've found out what's causing this. And it is neither next.js nor nuxt.js, it is for the project which uses yarn instead of npm.

It seems like the lib is forcing on npm, and it's creating conflicting package-lock.json with the yarn.lock file. switching over to npm instead seems to solve my problem.

[Cmoen11]

I think i've located the problem.

https://github.com/readmeio/api/blob/ebb90af3605cb522f4aafaba75b9c9fe581b6534/packages/api/src/cli/codegen/languages/typescript.ts#LL156C21-L156C21

So if you're using a different package manager you may stumble on some problems caused by this.

[erunion]

Besides @Cmoen11, is everyone else in this thread using Yarn?

[afreemanio]

Alright, so, I ran into this one today.
Can confirm, not using Yarn, not using Nest or Next or anything, just plain node.

Got around this issue by copy-pasting the generated code from the .api folder to a new api folder in my src directory, and importing it directly (so, import x from '../api/apis/example' rather than import x from '@api/example')
Interested to see how this could be avoided in future.

Pretty sure it has to do with tsconfig and module resolution