Custom Provider: Cannot find module '@ioc:*' or its corresponding type declarations

[LeCoupa]

This is probably something easy to solve but I can't figure out why TypeScript keep saying this when I import my custom provider:

Cannot find module '@IOC:Elastic' or its corresponding type declarations

Here is my custom provider:

// NPM
import { IocContract } from '@adonisjs/fold'
import { Client as ElasticClient } from '@elastic/elasticsearch'

// Contracts
import { ElasticBodyContract, SortObjectContract } from 'contracts/elastic'

export default class ElasticProvider {
  constructor(protected container: IocContract) {}

  public async register() {
    const Env = (await import('@ioc:Adonis/Core/Env')).default

    this.container.singleton('Elastic', () => {
      const elasticClient = new ElasticClient({
        node: Env.get('ES_URL'),
      })

      return elasticClient
    })
  }
}

[steschwa]

Typescript does not know about the IOC-Bindings at compile time (because they are evaluated at runtime). Therefore you have to create a types declaration file for your custom service like so:

contracts/WhateverNameYouWant.d.ts

declare module "@ioc:Elastic" {
    import { Client as ElasticClient } from "@elastic/elasticsearch"
    declare const elasticClient: ElasticClient
    export default elasticClient
}

Under the hood (in their corresponding packages) Adonis does exactly that for built-in providers.

[steschwa]

Theoretically you can rename the declaration file extension from .d.ts to only .ts but i personally prefer to use .d.ts to know that only type declarations are within this file and no other logic

[LeCoupa]

Thank you :) I also updated all my contracts to .d.ts 👍🏻

[hossain45]

in my case,
"@ioc/*": ["./node_modules/@adonisjs/core/build/standalone/ioc/*"]
was missing from my tsconfig file

here's the full config:
{
"extends": "./node_modules/adonis-preset-ts/tsconfig",
"include": ["**/*"],
"exclude": ["node_modules", "build"],
"compilerOptions": {
"outDir": "build",
"rootDir": "./",
"sourceMap": true,
"paths": {
"App/*": ["./app/*"],
"Config/*": ["./config/*"],
"Contracts/*": ["./contracts/*"],
"Database/*": ["./database/*"],
"@ioc/*": ["./node_modules/@adonisjs/core/build/standalone/ioc/*"]
},
"types": [
"@adonisjs/core",
"@adonisjs/repl",
"@adonisjs/lucid",
"@adonisjs/auth",
"@adonisjs/shield",
"@adonisjs/mail"
],
}
}
`

[RomainLanz]

The code you added seems incorrect.

@ioc: imports were part of AdonisJS 5's IoC Container system and aren't needed in AdonisJS 6.

I'm not entirely sure what problem you're trying to solve. If you need further help, consider opening a new discussion.

[hossain45]

you are right

I have not migrated to AdonisJS6 yet.