package not include the utils/react module mentioned in the README

[VarPDev]

Brief bug description

The “utils/react” react module is not included in the package.

the documentation says to import the components for react this way:

import {
  PortableTextReactResolvers,
  PortableText,
  TableComponent,
  ImageComponent,
} from "@kontent-ai/rich-text-resolver/utils/react";

Repro steps

npm i @kontent-ai/rich-text-resolver
go to node_modules/@kontent-ai/rich-text-resolver folder
see that the modules are missing

Screenshots

[pokornyd]

hello @VarPDev. assuming you installed the package with npm i @kontent-ai/rich-text-resolver, you likely installed the latest stable release (v1.2.2), which didn't specify exports for react utils in package.json.

main branch of the repository is already merged with latest version updates (2.0.0), however, it's only pre-released on NPM as 2.0.0-rc1. this is because I'm waiting on updates in Kontent.ai documentation before actual release, which is likely to happen next week.

I suggest you install the release candidate (npm i @kontent-ai/[email protected]) and follow the readme for guidance. it should not differ from actual 2.0.0 version when it goes live.

if you're interested in the older version, follow its readme: https://github.com/kontent-ai/rich-text-resolver-js/tree/e6f3384cc5a046344042e1b247af95ebd6848285

[VarPDev]

@pokornyd

in the documentation it says to use nodeParse for the SSR. With the old version it worked now instead with version 2.0.0-rc1 I think the library does not export it.

here the example from documentation:

const MyComponent = ({ props }) => {
  // https://github.com/portabletext/react-portabletext#customizing-components

  const parsedTree = browserParse(props.element.value); // or nodeParse for SSR
  const portableText = transformToPortableText(parsedTree);

  return (
    <PortableText value={portableText} components={portableTextComponents} />
  );
};

[pokornyd]

version 2.0.0 got rid of separate nodeParse and browserParse methods for parsing. you can now use parseHTML, which is environment-aware (node.js or browser) and picks the suitable parser for you.

if your goal is to work with portable text, you can (and have to) omit parseHTML altogether and simply use transformToPortableText function, which now accepts a rich text HTML string directly and does the parsing for you.

parseHTML function returns the DomNode array, which is intended primarily for transformation of external HTML/rich text into a Kontent.ai-valid format (in migration purposes). no method for transforming DomNode array into PortableTextObject[] is provided anymore, so it's really either parseHTML or transformToPortableText now.

Readme of the main branch is up-to-date and explains the reworked usage. Update to TS rich text resolution guide in Kontent.ai documentation is under review.