[bug]: typescript errors when building with pnpm

[innerdvations]

What version of @strapi/sdk-plugin are you using?

@strapi/sdk-plugin 5.1.0
pnpm 9.1.0

What's Wrong?

Building a plugin with pnpm doesn't work

➜  myplugin5 pnpm run build

> myplugin5@0.0.0 build /Users/ben/dev/strapi/myplugin5
> strapi-plugin build

✔ Verified package.json
✔ Created build context
Building type files:
   entries:
    – myplugin5/admin/src/index.ts ./admin/src/index.ts -> ./dist/admin/src/index.d.ts
    – myplugin5/server/src/index.ts ./server/src/index.ts -> ./dist/server/src/index.d.ts
[ERROR]  server/src/controllers/index.ts:3:1 - TS2742: The inferred type of 'default' cannot be named without a reference to '.pnpm/@strapi+types@5.0.0-rc.10_@types+node@22.3.0_typescript@5.2.2/node_modules/@strapi/types/dist/core'. This is likely not portable. A type annotation is necessary.
[ERROR]  server/src/index.ts:19:1 - TS2742: The inferred type of 'default' cannot be named without a reference to '.pnpm/@strapi+types@5.0.0-rc.10_@types+node@22.3.0_typescript@5.2.2/node_modules/@strapi/types/dist/core'. This is likely not portable. A type annotation is necessary.
[ERROR]  server/src/services/index.ts:3:1 - TS2742: The inferred type of 'default' cannot be named without a reference to '.pnpm/@strapi+types@5.0.0-rc.10_@types+node@22.3.0_typescript@5.2.2/node_modules/@strapi/types/dist/core'. This is likely not portable. A type annotation is necessary.
[ERROR]  server/src/controllers/index.ts:3:1 - TS2742: The inferred type of 'default' cannot be named without a reference to '.pnpm/@strapi+types@5.0.0-rc.10_@types+node@22.3.0_typescript@5.2.2/node_modules/@strapi/types/dist/core'. This is likely not portable. A type annotation is necessary.
[ERROR]  server/src/services/index.ts:3:1 - TS2742: The inferred type of 'default' cannot be named without a reference to '.pnpm/@strapi+types@5.0.0-rc.10_@types+node@22.3.0_typescript@5.2.2/node_modules/@strapi/types/dist/core'. This is likely not portable. A type annotation is necessary.
[ERROR]  server/src/index.ts:19:1 - TS2742: The inferred type of 'default' cannot be named without a reference to '.pnpm/@strapi+types@5.0.0-rc.10_@types+node@22.3.0_typescript@5.2.2/node_modules/@strapi/types/dist/core'. This is likely not portable. A type annotation is necessary.
[ERROR]  server/src/index.ts:19:1 - TS2742: The inferred type of 'default' cannot be named without a reference to '.pnpm/@strapi+types@5.0.0-rc.10_@types+node@22.3.0_typescript@5.2.2/node_modules/@strapi/types/dist/core'. This is likely not portable. A type annotation is necessary.
[ERROR]  server/src/index.ts:19:1 - TS2742: The inferred type of 'default' cannot be named without a reference to '.pnpm/@strapi+types@5.0.0-rc.10_@types+node@22.3.0_typescript@5.2.2/node_modules/@strapi/types/dist/core'. This is likely not portable. A type annotation is necessary.
[ERROR]  server/src/index.ts:19:1 - TS2742: The inferred type of 'default' cannot be named without a reference to '.pnpm/@strapi+types@5.0.0-rc.10_@types+node@22.3.0_typescript@5.2.2/node_modules/@strapi/types/dist/core'. This is likely not portable. A type annotation is necessary.
[ERROR]  server/src/index.ts:19:1 - TS2742: The inferred type of 'default' cannot be named without a reference to '.pnpm/@strapi+types@5.0.0-rc.10_@types+node@22.3.0_typescript@5.2.2/node_modules/@strapi/types/dist/core'. This is likely not portable. A type annotation is necessary.
[ERROR]  Failed to compile TypeScript definitions
[ERROR] There seems to be an unexpected error, try again with --debug for more information 

 ┌────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│                                                                                                                                                                                                                            │
│   Error: Failed to compile TypeScript definitions                                                                                                                                                                          │
│       at /Users/ben/dev/strapi/myplugin5/node_modules/.pnpm/@strapi+pack-up@5.0.1-alpha.1_@swc+helpers@0.5.12_@types+node@22.3.0_terser@5.31.6/node_modules/@strapi/pack-up/dist/index.js:835:19                           │
│       at Array.map (<anonymous>)                                                                                                                                                                                           │
│       at Observable._subscribe (/Users/ben/dev/strapi/myplugin5/node_modules/.pnpm/@strapi+pack-up@5.0.1-alpha.1_@swc+helpers@0.5.12_@types+node@22.3.0_terser@5.31.6/node_modules/@strapi/pack-up/dist/index.js:813:22)   │
│       at Observable._trySubscribe (/Users/ben/dev/strapi/myplugin5/node_modules/.pnpm/rxjs@7.8.1/node_modules/rxjs/dist/cjs/internal/Observable.js:41:25)                                                                  │
│       at /Users/ben/dev/strapi/myplugin5/node_modules/.pnpm/rxjs@7.8.1/node_modules/rxjs/dist/cjs/internal/Observable.js:35:31                                                                                             │
│       at Object.errorContext (/Users/ben/dev/strapi/myplugin5/node_modules/.pnpm/rxjs@7.8.1/node_modules/rxjs/dist/cjs/internal/util/errorContext.js:22:9)                                                                 │
│       at Observable.subscribe (/Users/ben/dev/strapi/myplugin5/node_modules/.pnpm/rxjs@7.8.1/node_modules/rxjs/dist/cjs/internal/Observable.js:26:24)                                                                      │
│       at /Users/ben/dev/strapi/myplugin5/node_modules/.pnpm/rxjs@7.8.1/node_modules/rxjs/dist/cjs/internal/Observable.js:86:19                                                                                             │
│       at new Promise (<anonymous>)                                                                                                                                                                                         │
│       at Observable.toPromise (/Users/ben/dev/strapi/myplugin5/node_modules/.pnpm/rxjs@7.8.1/node_modules/rxjs/dist/cjs/internal/Observable.js:84:16)                                                                      │
│                                                                                                                                                                                                                            │
└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

To Reproduce

create a new plugin with init

then run pnpm run build

Expected Behaviour

plugin should build

[alexandrebodin]

Saw that too. it is easily fixable in the template but feels very ugly

import type { Core } from @strapi/strapi;

type Strapi = Core.strapi;


export default ....

Will work

[gvillenave]

@alexandrebodin I'm not able to use the workaround, still getting the same failure even after adding the import and type definition in server/src/index.ts etc.

[ERROR] server/src/index.ts:23:1 - TS2742: The inferred type of 'default' cannot be named without a reference to '.pnpm/@strapi+types@5.6.0_@types+node@22.10.2_typescript@5.3.2/node_modules/@strapi/types/dist/modules/documents'. This is likely not portable. A type annotation is necessary.

[gvillenave]

Strangely enough this works fine with Yarn.

[hebersolano]

As @alexandrebodin explains the solution, you have to import the Strapi type wherever it is needed.

import type { Core } from '@strapi/strapi';

type Strapi = Core.Strapi;

Error console example, import in server/src/index.ts, server/src/services/index.ts and server/src/controllers/index.ts

[ERROR]  server/src/index.ts:1:27 - TS1141: String literal expected.
[ERROR]  server/src/index.ts:1:34 - TS1109: Expression expected.
[ERROR]  server/src/index.ts:24:1 - TS2742: The inferred type of 'default' cannot be named without a reference to '.pnpm/@strapi+types@5.8.1_@types+node@22.10.10_typescript@5.3.2/node_modules/@strapi/types/dist/core'. This is likely not portable. A type annotation is necessary.
[ERROR]  server/src/services/index.ts:3:1 - TS2742: The inferred type of 'default' cannot be named without a reference to '.pnpm/@strapi+types@5.8.1_@types+node@22.10.10_typescript@5.3.2/node_modules/@strapi/types/dist/core'. This is likely not portable. A type annotation is necessary.
[ERROR]  server/src/controllers/index.ts:3:1 - TS2742: The inferred type of 'default' cannot be named without a reference to '.pnpm/@strapi+types@5.8.1_@types+node@22.10.10_typescript@5.3.2/node_modules/@strapi/types/dist/core'. This is likely not portable. A type annotation is necessary.
[ERROR]  server/src/index.ts:1:34 - TS1109: Expression expected.
[ERROR]  server/src/index.ts:1:27 - TS1141: String literal expected.
[ERROR]  Failed to compile TypeScript definitions

[gvillenave]

@alexandrebodin any updates here? This is still reproducing with (as far as I can tell) anything other than yarn 1.22.22 + the workaround.

[hanpaine]

Hi @gvillenave we have not had capacity to look at this yet I'm afraid. In future please do not directly tag team members 🙏 thanks

[Xaz16]

It will sound a bit strange, but I created 6 internal strapi plugins and see that issue first time. Above workaround working, but it is not something I would like to add in each file...

I just init my plugin once again and don't see such error. So, I recommend to regenerate plugin once again (npx @strapi/sdk-plugin init <plugin-name>), maybe it will help you