fix: include type definitions when publishing

[achou11]

Mainly:

• Sets up type defs generation
• Updates npm package setup to include generated types
• BREAKING CHANGE: renames the exports to include the .js suffix at the end, which I believe is generally recommended/idiomatic. Not strictly necessary for us to do so open to reverting that change if preferred EDIT: reverted

Should introduce noUncheckedIndexedAccess in the tsconfig as a follow-up but it will lead to errors that will require code changes outside the scope of this PR.

[achou11]

Pinned to v4 since >= v5 removes support for node 18

[gmaclennan]

great, thanks for this! Removing TransformOptions to satisfy typescript bothered me, so I fixed that with 31213d0

I don't agree with the change to add .js to exports. Most modules I have used that define exports do not include an extension, including node modules (e.g. fs/promises), and I think it leads to some confusion because it suggests a file is being imported. The file extension is required by ESM when importing a local file, but that is a different thing.

[achou11]

Removing TransformOptions to satisfy typescript bothered me, so I fixed that with 31213d0

nice! I tried something almost similar to that before and it didn't work. glad you fixed it.

I don't agree with the change to add .js to exports. Most modules I have used that define exports do not include an extension, including node modules (e.g. fs/promises), and I think it leads to some confusion because it suggests a file is being imported. The file extension is required by ESM when importing a local file, but that is a different thing.

Yeah that makes sense. Reverted via 2df05b9

[achou11]

One last thing to potentially resolve: what's the best way to expose the types exported from lib/types.ts? e.g. needing access to SMPStyle

EDIT 1: Hm looks like because of this, I may need to update this PR to emit source files too...

EDIT 2: Seems like I could get around this by adding another export, but not really sure if that's "proper":

    "./types": {
      "types": "./dist/types.d.ts"
    }

[gmaclennan]

what's the best way to expose the types exported from lib/types.ts?

you can add this line to index.js:

/** @typedef {import('./types.js').SMPStyle} SMPStyle */

Then you can do:

import type { SMPStyle } from 'styled-map-package'

You could do the same in any of the other export entry points.

[gmaclennan]

looks good to me!

[achou11]

what's the best way to expose the types exported from lib/types.ts?

you can add this line to index.js:

/** @typedef {import('./types.js').SMPStyle} SMPStyle */

Then you can do:

import type { SMPStyle } from 'styled-map-package'

You could do the same in any of the other export entry points.

Awesome, seems to work! (see 05084f9)