Runtime

typescript

Runtime version

5

Module version

21

Last module version without issue

n/a

Used with

Other plugins or tools

Any other relevant information

Currently, the typing for Hapi is

export type Plugin<T, D = void> = PluginBase<T, D> & (PluginNameVersion | PluginPackage);

Which suggests to plugin creators to export their package as Plugin<Opts>.

The problem lies in that, when make tooling around Hapi, if I want to signal a dependency on another plugin in Typescript, I can't depend on MyPlugin.name because it is an intersection between PluginNameVersion | PluginPackage.. One doesn't contain name. The following will throw a TS error:

import HapiSwagger from 'hapi-swagger';

export const myThing = (server: Hapi.Server) => {

    // This package exports as `PluginNameVersion`
    server.depedency(HapiSwagger.name); // Property 'name' does not exist on type 'PluginBase<RegisterOptions, void> & PluginPackage'
}

We should have the option to export both:

// Allows proper typing of the specific package use-case
export type NamedPlugin<T, D = void> = PluginBase<T, D> & PluginNameVersion;
export type PackagedPlugin<T, D = void> = PluginBase<T, D> & PluginPackage;

// won't break existing functionality
export type Plugin<T, D = void> = NamedPlugin<T, D> | PackagedPlugin<T, D>;

What are you trying to achieve or the steps to reproduce?

Specificity in the type of plugin exported

What was the result you got?

Property 'name' does not exist on type 'Plugin<RegisterOptions>'.
Property 'name' does not exist on type 'PluginBase<RegisterOptions, void> & PluginPackage'.ts(2339)

What result did you expect?

I expect to be able to use MyPlugin.name with a utility from Hapi itself