feat: add textResolver

[alexander-lozovsky]

#67

Add textResolver to control the rendering of the plain text, to handle cases when you need to preprocess the text before rendering (translation, sanitization, etc)

[edvinasjurele]

Also do not forget DCO, thus all commits has to be signed-off. Read the details and follow instructions.

[edvinasjurele]

Lets also update README with the information about the usage, and maybe some use cases.

Optionally, we should extend DEMO app with the example of such resolver too. We can do some simple text replacement example or similar simple case just to illustrate that it is possible to hook into text node and affect it.

[edvinasjurele]

Hm, this does look weird honestly, and I am sure it clashes with the existing API. The problem is that conceptually the textResolver should be meant for text resolving only, and should not return ComponentNode at all. This function is not about the node logic at all, but rather about manipulating the content property in whatever the node is.

to get same result you have described with solution we should better have the following API:

     schema: {
        nodes: {
          text: () => ({
            component: "p",
            props: { class: "class-1" },
          }),
        },
      },
      textResolver: (text) => text.replace("{name}", "World")

(the textResolver extends the capability of the node, but does not override it)

Alternatively, we can expect the shape of textResolver?: (str: string) => Pick<ComponentNode, 'content'>;
and the usage:

 textResolver: (text) => ({
    content: text.replace("{name}", "World"),
 }),

but again, this may misslead users that it is not the whole component node but rather just a content, so might be bad alternative.

What do you think?

[alexander-lozovsky]

it should return ComponentNode for cases when you example you want to support ICU syntax. So in this case all the texts need to be rendered inside some .astro component

I can suggest to support both outputs:
textResolver?: (str: string) => ComponentNode | string;