Hi I m importing a library that doesn t have module declarat Pulumi Community #typescript

Hi! I’m importing a library that doesn’t have modu...

melodic-angle-86693

09/20/2023, 9:56 AM

Hi! I’m importing a library that doesn’t have module declarations. I created a

types/index.d.ts

file, and I added it to

tsconfig.json

. Here is the file:

Copy code

{
  "compilerOptions": {
    "strict": true,
    "outDir": "bin",
    "target": "es2016",
    "module": "commonjs",
    "moduleResolution": "node",
    "sourceMap": true,
    "experimentalDecorators": true,
    "pretty": true,
    "noFallthroughCasesInSwitch": true,
    "noImplicitReturns": true,
    "forceConsistentCasingInFileNames": true,
    "esModuleInterop": true
  },
  "include": [
    "infra",
    "types"
  ],
  "exclude": [
    "node_modules",
    "vendor",
    "dist"
  ]
}

I have the impression that Pulumi is ignoring my config. Does anybody see what may be wrong on my setup? VSCode’s TS server finds the

.d.ts

declaration and doesn’t show the error I get when running

pulumi up

clever-sunset-76585

09/21/2023, 12:15 AM

How have you declared the module in

types/index.d.ts

melodic-angle-86693

09/21/2023, 4:32 AM

This is the code:

Copy code

declare module "@bref.sh/layers" {
	function fpmLayerArn(
		region: string,
		version: string,
		architecture?: string,
	): string;
}

melodic-angle-86693

09/21/2023, 6:32 AM

It looks like pulumi only uses the settings inside `compilerOptions`: https://github.com/pulumi/pulumi/blob/79271cf543dc6b02baeb560e90c97d52258c7eba/sdk/nodejs/cmd/run/run.ts#L260-L275

melodic-angle-86693

09/21/2023, 6:45 AM

Nah, I tried

compilerOptions.rootDirs

and

compilerOptions.typeRoots

and still erroring 😕

melodic-angle-86693

09/21/2023, 6:47 AM

Also, forced the env variables using:

PULUMI_NODEJS_TYPESCRIPT=true PULUMI_NODEJS_TSCONFIG_PATH=tsconfig.json pulumi up

and it doesn’t work

melodic-angle-86693

09/21/2023, 6:59 AM

It is strange, it follows some rules though, like

strict

and

noImplicitAny

😕

clever-sunset-76585

09/21/2023, 9:28 AM

I think the issue is with the module you've declared in

types/index.d.ts

and not your TS configuration. Also I see that the original source contains JSDoc for that function which should provide the type hints that your module is trying to provide. Are you simply trying to add type-safety for that function or trying to fix some other problem?

melodic-angle-86693

09/21/2023, 9:29 AM

No, i’m just trying to import it, and TS fails because it doesn’t have a types declaration

melodic-angle-86693

09/21/2023, 9:30 AM

Copy code

import { fpmLayerArn } from "@bref.sh/layers";
// ...
export const wordpressServer = new aws.lambda.Function(
	"wordpress-server",
	{
		role: wordpressServerRole.arn,
		runtime: "provided.al2",
		layers: [fpmLayerArn("us-east-1", "8.2")],
		s3Bucket: wordpressBucket.bucket,
		s3Key: wordpressCode.key,
		handler: "lambda-handler.php",
		memorySize: 1024,
		sourceCodeHash: wordpressCode.sourceHash.toString(),
	},
	{
		dependsOn: [wordpressServerRole, wordpressBucket, wordpressCode],
	},
);

melodic-angle-86693

09/21/2023, 9:30 AM

this is how I’m using it

melodic-angle-86693

09/21/2023, 9:41 AM

I think I’ll go with

noImplicitAny

for now. I’ll try to look into this in the future though. Thanks for helping me out here!

clever-sunset-76585

09/21/2023, 10:14 AM

So I was wrong about it not having to do with your

tsconfig.json

file. Your module declaration is indeed correct. You might try

include: ["***/**.ts"]

in your config.

ripe-gpu-76158

12/08/2023, 10:16 PM

I just ran into this issue. See https://github.com/TypeStrong/ts-node#missing-types for more details. but the TL;DR is to put your types in a structure like

Copy code

<project_root>/
-- tsconfig.json
-- typings/
  -- <module_name>/
    -- index.d.ts

and then in your

tsconfig.json

add the

typings

dir to the

typeRoots

list

Copy code

{
  "compilerOptions": {
    "typeRoots": [
      "./node_modules/@types",
      "./typings"
    ]
  }
}

3 Views

Open in Slack

Previous Next