fix: Add typescript definitions

[JoaoTMDias]

Because:

• There was an issue opened asking for Typescript definitions for this package.

This commit:

• Adds an index.d.ts file to the src folder, as well as jsdoc documentation.
• Adds a typings entry on the package.json file

[seiry-apt]

👍

[edufarre]

Any updates or intentions to move this forward? Can we iterate this PR or create a new one?

[JoaoTMDias]

Any updates or intentions to move this forward? Can we iterate this PR or create a new one?

I've just pushed a commit with a fix on the types definition file.

[illright]

@bahmutov Is there anything else needed here to merge this?

[bahmutov]

Looks good, merging it, thank you

[github-actions]

🎉 This PR is included in version 2.1.4 🎉

The release is available on:

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

Your semantic-release bot 📦🚀

[ahnpnl]

Hi, I got an error with this change

TypeError: (0 , cypress_esbuild_preprocessor_1.createBundler) is not a function

when I do

import { addCucumberPreprocessorPlugin } from '@badeball/cypress-cucumber-preprocessor';
import createEsbuildPlugin from '@badeball/cypress-cucumber-preprocessor/esbuild';
import { createBundler } from '@bahmutov/cypress-esbuild-preprocessor';

export const cucumberProcessorPlugin: Cypress.PluginConfig = async (on, config) => {
    await addCucumberPreprocessorPlugin(on, config);

    on(
        'file:preprocessor',
        createBundler({
            plugins: [createEsbuildPlugin(config)],
        }),
    );

    // Make sure to return the config object as it might have been modified by the plugin.
    return config;
};

Before this change, I used to use this import

// @ts-expect-error
import createBundler from '@bahmutov/cypress-esbuild-preprocessor';

which always work.

[bahmutov]

Why did you switch from the default import to named one?

[ahnpnl]

It is because type definition is misleading. In the type definition there is a declare export const which shouldn’t be. The 2 const shouldn’t be exported. If using default export, TypeScript will still complain

[bahmutov]

Ok, I will be open to a pull request to fix this

[ahnpnl]

Ok, I will be open to a pull request to fix this

Please check my open PR:)