Better typescript support for dependencies

I’m going through the tutorial online and I’m not sure if this is a typescript thing or a gluegun thing. What I would like is to be able to define an extension:

// src/extensions/imdb-extension.ts

import { prompt } from 'gluegun/prompt'
import * as imdb from 'imdb-api'
import { GluegunToolbox } from 'gluegun'

export interface ImdbExtension {
  imdb: {
    getMovie: (movieName: string) => Promise<imdb.Movie>
  }
}

export default (toolbox: GluegunToolbox) => {
  // memoize the API key once we retrieve it
  // let imdbKey: string | false = false

  // get a movie
  async function getMovie(movieName: string): Promise<imdb.Movie> {
    const result = await prompt.ask({ type: 'input', name: 'key', message: 'API Key>' })
    if (!result.key) return

    return imdb.get({ name: movieName }, { apiKey: result.key, timeout: 30000 })
  }

  // attach our tools to the toolbox
  toolbox.imdb = { getMovie }
}

AND I would like this object to show up in my typescript autocompletions. The closest thing I could think of was creating the interface above and doing some gymnastics but I feel that the typesystem could support this natively somehow.

import { GluegunCommand, GluegunToolbox } from 'gluegun'
import { ImdbExtension } from '../extensions/imdb-extension'

const movieCommand: GluegunCommand = {
  name: 'movie',
  run: async (toolbox: GluegunToolbox) => {
    // ** Fails - Type 'GluegunToolbox' is not assignable to type 'ImdbExtension'.   Property 'imdb' is missing in type 'GluegunToolbox'. [2322]
    // const { imdb }: ImdbExtension = toolbox 

    // works
    const { imdb }: ImdbExtension = toolbox as any
    const movie = await imdb.getMovie('The Room')
    if (movie.name) toolbox.print.info(movie.name)
  }
}

export default movieCommand

What would be ideal

const movie = toolbox.imdb.getMovie("The Room")   <- just autocompletes because TS knows the type
if (movie.name) toolbox.print.info(movie.name)

[ductiletoaster]

I’ve been build out a workflow CLI for my company and ran into an issue with some of the typings. In retrospect I probably should have created a new ticket but I created this PR to help solve my issue. https://github.com/infinitered/gluegun/pull/564

I apologies again for hijacking this thread. Please let me know if you’d like me to create a new ticket.

[infinitered-circleci]

🎉 This issue has been resolved in version 3.3.3 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀