Merge pull request #849 from storyblok/next

feat: deprecation warning for Richtext

playground/vanilla/src/main.ts

@@ -1,4 +1,5 @@
 import StoryblokClient from 'storyblok-js-client'
+import RichTextResolver from 'storyblok-js-client/richTextResolver'
 import './style.css'
 
 const headers = new Headers()
@@ -16,6 +17,20 @@ try {
     version: 'draft',
     resolve_relations: 'root.author',
   })
+  const resolver = new RichTextResolver()
+
+  const paragraph = {
+    type: 'paragraph',
+    content: [
+      {
+        text: 'Bold and italic',
+        type: 'text',
+        marks: [{ type: 'bold' }, { type: 'italic' }],
+      },
+    ],
+  }
+
+  const html = resolver.render(paragraph)
 
   console.log(Storyblok.cacheVersions())
 
@@ -30,4 +45,4 @@ try {
   console.error(error)
 }
 
-console.log(Storyblok)
+

playground/vanilla/vite.config.ts

@@ -1,6 +1,6 @@
 import { defineConfig } from 'vite'
 
-import { resolve } from 'pathe'
+/* import { resolve } from 'pathe' */
 
 import { qrcode } from 'vite-plugin-qrcode'
 
@@ -9,9 +9,9 @@ export default defineConfig({
   plugins: [
     qrcode(), // only applies in dev mode
   ],
-  resolve: {
+  /* resolve: {
     alias: {
       'storyblok-js-client': resolve(__dirname, '../../src/index.ts'),
     },
-  },
+  }, */
 })

src/index.ts

@@ -75,6 +75,7 @@ class Storyblok {
   private resolveCounter: number
   public relations: RelationsType
   public links: LinksType
+  // TODO: Remove on v7.x.x
   public richTextResolver: RichTextResolver
   public resolveNestedRelations: boolean
   private stringifiedStoriesCache: Record<string, string>

src/richTextResolver.ts

@@ -83,6 +83,9 @@ class RichTextResolver {
     data?: ISbRichtext,
     options: RenderOptions = { optimizeImages: false }
   ) {
+    console.warn(
+      "Warning ⚠️: The RichTextResolver class is deprecated and will be removed in the next major release. Please use the `@storyblok/richtext` package instead. https://github.com/storyblok/richtext/"
+    );
     if (data && data.content && Array.isArray(data.content)) {
       let html = ''