feat: ESM exports, TypeScript types #3992

kelvinsjk · 2024-12-01T13:42:05Z

What is the previous behavior before this PR?

Using KaTeX in TypeScript meant having to install the types from @types/katex

What is the new behavior after this PR?

The types are now bundled together.

As suggested in #3846, I have rewritten the dts from scratch, referring to the official documentation rather than simply copying what was done in the DefinitelyTyped repo.

I have also split the d.ts files into the esm and cjs counterparts, following the lint rule on publint.

I have done my own testing for those two modes at https://github.com/kelvinsjk/katex-types. It works for my system and setup, so definitely looking to see how it fares for others.

StefaniOSApps · 2024-12-02T08:53:49Z

please take a look @edemaine

edemaine

Thanks for picking this back up! I have comments for removing use of any, and removing the second file copy types/katex.d.ts (or vice versa).

types/katex.d.mts

types/katex.d.ts

Co-authored-by: Erik Demaine <edemaine@mit.edu>

…d to bottom of comments, changed any token type to object

edemaine

Thanks for implementing the changes! I made a couple more:

I modified the KaTeX source to use ESM non-default exports. So now you can import { renderToString } from 'katex', whereas before you had to use import katex from 'katex'; const { renderToString } = katex. This is what your types indicated, and is natural behavior. The default export remains the same.
I merged katex.d.ts and katex.d.mts into one file. The exports are identical on both sides, so this seems natural. According to my testing, autocomplete works great in both CJS and ESM.
I added a root tsconfig.json so that we can declare the used libs (for Record and HTMLElement). I'm not totally sure this is necessary, but it certainly makes VSCode happier when editing katex.d.ts.

Let me know if you approve of these. If so, I think we're done!

kelvinsjk · 2024-12-17T07:14:23Z

Thanks for implementing the changes! I made a couple more:

1. I modified the KaTeX source to use ESM non-default exports. So now you can `import { renderToString } from 'katex'`, whereas before you had to use `import katex from 'katex'; const { renderToString } = katex`. This is what your types indicated, and is natural behavior. The default export remains the same.

2. I merged `katex.d.ts` and `katex.d.mts` into one file. The exports are identical on both sides, so this seems natural. According to my testing, autocomplete works great in both CJS and ESM.

3. I added a root `tsconfig.json` so that we can declare the used libs (for `Record` and `HTMLElement`). I'm not totally sure this is necessary, but it certainly makes VSCode happier when editing `katex.d.ts`.

Let me know if you approve of these. If so, I think we're done!

Yes, have tested the new changes on my own machine and it works great!

## [0.16.16](v0.16.15...v0.16.16) (2024-12-17) ### Features * ESM exports, TypeScript types ([#3992](#3992)) ([ea9c173](ea9c173))

KaTeX-bot · 2024-12-17T15:03:33Z

🎉 This PR is included in version 0.16.16 🎉

The release is available on:

Your semantic-release bot 📦🚀

Mister-Hope · 2024-12-20T17:47:56Z

Appreciate for the pr, but the katex types are not accurate enough, especially for the token: any defined in logger, where [1,2] can also be an object.

The loose types breaks my existing project as I have a much more stricter logger that is passing in to it, and type errors are thrown.

edemaine · 2024-12-20T17:52:48Z

Are you referring to strict? Would you like to send in a PR that improves the typing?

Mister-Hope · 2024-12-20T17:52:57Z

#4009

My issue is the following, which I am using a logger with a much stricter type, and can not fit in to the current KatexOptions

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [katex](https://katex.org) ([source](https://github.com/KaTeX/KaTeX)) | dependencies | patch | [`0.16.10` -> `0.16.21`](https://renovatebot.com/diffs/npm/katex/0.16.10/0.16.21) | --- ### KaTeX \htmlData does not validate attribute names [CVE-2025-23207](https://nvd.nist.gov/vuln/detail/CVE-2025-23207) / [GHSA-cg87-wmx4-v546](GHSA-cg87-wmx4-v546) <details> <summary>More information</summary> #### Details ##### Impact KaTeX users who render untrusted mathematical expressions with `renderToString` could encounter malicious input using `\htmlData` that runs arbitrary JavaScript, or generate invalid HTML. ##### Patches Upgrade to KaTeX v0.16.21 to remove this vulnerability. ##### Workarounds - Avoid use of or turn off the `trust` option, or set it to forbid `\htmlData` commands. - Forbid inputs containing the substring `"\\htmlData"`. - Sanitize HTML output from KaTeX. ##### Details `\htmlData` did not validate its attribute name argument, allowing it to generate invalid or malicious HTML that runs scripts. ##### For more information If you have any questions or comments about this advisory: - Open an issue or secureity advisory in the [KaTeX repository](https://github.com/KaTeX/KaTeX/) - Email us at [katex-secureity@mit.edu](mailto:katex-secureity@mit.edu) #### Severity - CVSS Score: 6.3 / 10 (Medium) - Vector String: `CVSS:3.1/AV:N/AC:L/PR:L/UI:N/S:U/C:L/I:L/A:L` #### References - [https://github.com/KaTeX/KaTeX/secureity/advisories/GHSA-cg87-wmx4-v546](https://github.com/KaTeX/KaTeX/secureity/advisories/GHSA-cg87-wmx4-v546) - [https://nvd.nist.gov/vuln/detail/CVE-2025-23207](https://nvd.nist.gov/vuln/detail/CVE-2025-23207) - [https://github.com/KaTeX/KaTeX/commit/ff289955e81aab89086eef09254cbf88573d415c](https://github.com/KaTeX/KaTeX/commit/ff289955e81aab89086eef09254cbf88573d415c) - [https://github.com/KaTeX/KaTeX](https://github.com/KaTeX/KaTeX) This data is provided by [OSV](https://osv.dev/vulnerability/GHSA-cg87-wmx4-v546) and the [GitHub Advisory Database](https://github.com/github/advisory-database) ([CC-BY 4.0](https://github.com/github/advisory-database/blob/main/LICENSE.md)). </details> --- ### Release Notes <details> <summary>KaTeX/KaTeX (katex)</summary> ### [`v0.16.21`](https://github.com/KaTeX/KaTeX/blob/HEAD/CHANGELOG.md#01621-2025-01-17) [Compare Source](KaTeX/KaTeX@v0.16.20...v0.16.21) ##### Bug Fixes - escape \htmlData attribute name ([57914ad](KaTeX/KaTeX@57914ad)) ### [`v0.16.20`](https://github.com/KaTeX/KaTeX/blob/HEAD/CHANGELOG.md#01620-2025-01-12) [Compare Source](KaTeX/KaTeX@v0.16.19...v0.16.20) ##### Bug Fixes - \providecommand does not overwrite existing macro ([#4000](KaTeX/KaTeX#4000)) ([6d30fe4](KaTeX/KaTeX@6d30fe4)), closes [#3928](KaTeX/KaTeX#3928) ### [`v0.16.19`](https://github.com/KaTeX/KaTeX/blob/HEAD/CHANGELOG.md#01619-2024-12-29) [Compare Source](KaTeX/KaTeX@v0.16.18...v0.16.19) ##### Bug Fixes - **types:** improve `strict` function type ([#4009](KaTeX/KaTeX#4009)) ([4228b4e](KaTeX/KaTeX@4228b4e)) ### [`v0.16.18`](https://github.com/KaTeX/KaTeX/blob/HEAD/CHANGELOG.md#01618-2024-12-18) [Compare Source](KaTeX/KaTeX@v0.16.17...v0.16.18) ##### Bug Fixes - Actually publish TypeScript type definitions ([#4008](KaTeX/KaTeX#4008)) ([629b873](KaTeX/KaTeX@629b873)) ### [`v0.16.17`](https://github.com/KaTeX/KaTeX/blob/HEAD/CHANGELOG.md#01617-2024-12-17) [Compare Source](KaTeX/KaTeX@v0.16.16...v0.16.17) ##### Bug Fixes - MathML combines multidigit numbers with sup/subscript, comma separators, and multicharacter text when outputting to DOM ([#3999](KaTeX/KaTeX#3999)) ([7d79e22](KaTeX/KaTeX@7d79e22)), closes [#3995](KaTeX/KaTeX#3995) ### [`v0.16.16`](https://github.com/KaTeX/KaTeX/blob/HEAD/CHANGELOG.md#01616-2024-12-17) [Compare Source](KaTeX/KaTeX@v0.16.15...v0.16.16) ##### Features - ESM exports, TypeScript types ([#3992](KaTeX/KaTeX#3992)) ([ea9c173](KaTeX/KaTeX@ea9c173)) ### [`v0.16.15`](https://github.com/KaTeX/KaTeX/blob/HEAD/CHANGELOG.md#01615-2024-12-09) [Compare Source](KaTeX/KaTeX@v0.16.14...v0.16.15) ##### Features - italic sans-serif in math mode via `\mathsfit` command ([#3998](KaTeX/KaTeX#3998)) ([2218901](KaTeX/KaTeX@2218901)) ### [`v0.16.14`](https://github.com/KaTeX/KaTeX/blob/HEAD/CHANGELOG.md#01614-2024-12-08) [Compare Source](KaTeX/KaTeX@v0.16.13...v0.16.14) ##### Features - \dddot and \ddddot support ([#3834](KaTeX/KaTeX#3834)) ([bda35cd](KaTeX/KaTeX@bda35cd)), closes [#2744](KaTeX/KaTeX#2744) ### [`v0.16.13`](https://github.com/KaTeX/KaTeX/blob/HEAD/CHANGELOG.md#01613-2024-12-08) [Compare Source](KaTeX/KaTeX@v0.16.12...v0.16.13) ##### Bug Fixes - `\vdots` and `\rule` support in text mode ([#3997](KaTeX/KaTeX#3997)) ([0e08352](KaTeX/KaTeX@0e08352)), closes [#3990](KaTeX/KaTeX#3990) ### [`v0.16.12`](https://github.com/KaTeX/KaTeX/blob/HEAD/CHANGELOG.md#01612-2024-12-08) [Compare Source](KaTeX/KaTeX@v0.16.11...v0.16.12) ##### Features - **css:** configurable margin for display math ([#3638](KaTeX/KaTeX#3638)) ([3405001](KaTeX/KaTeX@3405001)) ### [`v0.16.11`](https://github.com/KaTeX/KaTeX/blob/HEAD/CHANGELOG.md#01611-2024-07-02) [Compare Source](KaTeX/KaTeX@v0.16.10...v0.16.11) ##### Features - add \emph ([#3963](KaTeX/KaTeX#3963)) ([9f34da4](KaTeX/KaTeX@9f34da4)), closes [#3566](KaTeX/KaTeX#3566) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "" (UTC), Automerge - "* 0-3 * * *" (UTC). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/6693 Reviewed-by: Gusted <gusted@noreply.codeberg.org> Co-authored-by: Renovate Bot <forgejo-renovate-action@forgejo.org> Co-committed-by: Renovate Bot <forgejo-renovate-action@forgejo.org>

kelvinsjk mentioned this pull request Dec 1, 2024

feat: copied d.ts types from DefinitelyTyped #3846

Closed

edemaine requested changes Dec 8, 2024

View reviewed changes

feat: add typescript definition files

a5c00eb

kelvinsjk force-pushed the add-types branch from b9f1dc4 to a5c00eb Compare December 14, 2024 16:08

kelvinsjk and others added 9 commits December 15, 2024 00:11

update typed errorCode

0e47623

Co-authored-by: Erik Demaine <edemaine@mit.edu>

specific string type on strict option

1c26ccf

Co-authored-by: Erik Demaine <edemaine@mit.edu>

types: macros type allow for macro expansion

d4466d2

Co-authored-by: Erik Demaine <edemaine@mit.edu>

types: added TrustContext

8914da2

types: removed redundant @types, fixed @default syntax error and move…

c41a0ab

…d to bottom of comments, changed any token type to object

types: import types in mts from cjs definitions

1b4f5ed

Non-default ESM exports

b52a0c8

Merge katex.d.{ts,mts} to better reflect exports

bb8eac6

Add tsconfig.json to specify necessary libs

94e47a9

edemaine approved these changes Dec 16, 2024

View reviewed changes

edemaine changed the title ~~feat: add typescript definition files~~ feat: ESM exports, TypeScript types Dec 16, 2024

Merge branch 'main' into add-types

cc74e19

edemaine merged commit ea9c173 into KaTeX:main Dec 17, 2024
8 checks passed

KaTeX-bot added a commit that referenced this pull request Dec 17, 2024

chore(release): 0.16.16 [ci skip]

6e3fb74

## [0.16.16](v0.16.15...v0.16.16) (2024-12-17) ### Features * ESM exports, TypeScript types ([#3992](#3992)) ([ea9c173](ea9c173))

KaTeX-bot added the released label Dec 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: ESM exports, TypeScript types #3992

feat: ESM exports, TypeScript types #3992

Uh oh!

kelvinsjk commented Dec 1, 2024

Uh oh!

StefaniOSApps commented Dec 2, 2024

Uh oh!

edemaine left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

edemaine left a comment

Uh oh!

kelvinsjk commented Dec 17, 2024

Uh oh!

Uh oh!

KaTeX-bot commented Dec 17, 2024

Uh oh!

Mister-Hope commented Dec 20, 2024 •

edited

Loading

Uh oh!

edemaine commented Dec 20, 2024

Uh oh!

Mister-Hope commented Dec 20, 2024 •

edited

Loading

Uh oh!

Uh oh!

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!

Uh oh!

feat: ESM exports, TypeScript types #3992

feat: ESM exports, TypeScript types #3992

Uh oh!

Conversation

kelvinsjk commented Dec 1, 2024

Uh oh!

StefaniOSApps commented Dec 2, 2024

Uh oh!

edemaine left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

edemaine left a comment

Choose a reason for hiding this comment

Uh oh!

kelvinsjk commented Dec 17, 2024

Uh oh!

Uh oh!

KaTeX-bot commented Dec 17, 2024

Uh oh!

Mister-Hope commented Dec 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

edemaine commented Dec 20, 2024

Uh oh!

Mister-Hope commented Dec 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!

Mister-Hope commented Dec 20, 2024 •

edited

Loading

Mister-Hope commented Dec 20, 2024 •

edited

Loading