generateJSON imported from @tiptap/html/server does not work on the server

[Kasheftin]

Affected Packages

@tiptap/html

Version(s)

3.4.2

Bug Description

I'm trying to generate JSON from HTML on the server following the docs: https://tiptap.dev/docs/editor/api/utilities/html
It says:

/* ON SERVER OR BROWSER - See above for browser only compatible package (ships less JS) */
import { generateHTML } from '@tiptap/html'

So, I installed @tiptap/html package using pnpm i --save @tiptap/html and I'm trying to use it in my Nest.js application. However, it says

generateJSON can only be used in a browser environment\nIf you want to use this in a Node environment, use the `@tiptap/html/server` import instead.

I'm reporting this as an issue. Well, at least the issue is about the documentation (the very first screen, the first example).

Browser Used

Other

Code Example URL

No response

Expected Behavior

The docs should be fixed. The package @tiptap/html should be available for server-side usage.

Additional Context (Optional)

No response

Dependency Updates

• Yes, I've updated all my dependencies.

[nperez0111]

I think you are misunderstanding how this all works, it needs to use the window object, because it needs a document to be able to serialize to html.

It uses happy-dom by default to handle stubbing this on the server, which is why it is only in the server package

[timheerwagen]

I'm facing a similar issue in a Node.js test environment with jsdom.

import { generateJSON } from "@tiptap/html";

Error:

generateJSON can only be used in a Node environment
If you want to use this in a browser environment, use the `@tiptap/html` import instead.

Importing from @tiptap/core works for my test setup, but I want the function to work on the browser and server sides.

[Kasheftin]

I figured this out. There is @tiptap/html/server folder with server-side code that uses happy-dom under the hood. It works.
There is an issue about using import { generateJSON } from '@tiptap/html/server' in my Nest.js application because the last uses module: "commonjs" with moduleResolution: "node", but it's easily solvable by

declare module '@tiptap/html/server' {
  export * from '@tiptap/html/dist/server/index.d.ts'
}

[timheerwagen]

Switching to @tiptap/html/server doesn't do anything in my case.

Opened a new issue for my case: #6951