@storyblok/astro 6.1.0-alpha.2 → 6.1.1

package/README.md

@@ -351,7 +351,33 @@ document.addEventListener('storyblok-live-preview-updated', () => {
 });
 </script>
 ```
-## Rendering Rich Text
+
+## Rendering Rich Text 
+
+> [!NOTE]
+> The `@storyblok/astro` now provides the exports for the new `richTextResolver` API from `@storyblok/js`. Until a dedicated `StoryblokRichText.astro` is developed, we recommend using the vanilla solution below.
+
+```jsx
+---
+import { richTextResolver } from "@storyblok/astro";
+
+const renderedRichText = richTextResolver({
+  // options like custom resolvers
+}).render(doc);
+---
+
+<div set:html={renderedRichText}></div>
+```
+
+To learn more about the new `richTextResolver` API, please refer to the [storyblok-richtext docs](https://github.com/storyblok/richtext).
+
+Similar to the legacy `renderRichText` function, this vanilla approach only supports parsing and returning native HTML tags, if you are not embedding `bloks` in your rich text. Then you can use the [`set:html` directive](https://docs.astro.build/en/reference/directives-reference/#sethtml):
+
+## Legacy Rendering Rich Text
+
+> [!WARNING]  
+> The legacy `richTextResolver` is soon to be deprecated. We recommend migrating to the new approach described above instead.
+
 
 > [!NOTE]  
 > While @storyblok/astro provides basic richtext rendering capabilities, for advanced use cases, it is highly recommended to use [storyblok-rich-text-astro-renderer](https://github.com/NordSecurity/storyblok-rich-text-astro-renderer).

package/dist/components/StoryblokComponent.astro

@@ -1,14 +1,15 @@
 ---
-import components from 'virtual:storyblok-components';
-import options from 'virtual:storyblok-options';
-import { toCamelCase } from '@storyblok/astro';
-import type { SbBlokData } from '@storyblok/js';
-import type { AstroComponentFactory } from 'astro/runtime/server/index.js';
+import components from "virtual:storyblok-components";
+import options from "virtual:storyblok-options";
+import { toCamelCase } from "@storyblok/astro";
+import type { SbBlokData } from "@storyblok/js";
+import type { AstroComponentFactory } from "astro/runtime/server/index.js";
 
 export interface Props {
   blok: SbBlokData;
   [prop: string]: unknown;
 }
+
 const { blok, ...props } = Astro.props;
 
 if (!blok) {
@@ -23,14 +24,16 @@ if (!blok) {
 let key = toCamelCase(blok.component as string);
 
 const componentFound: boolean = key in components;
+
 let Component: AstroComponentFactory;
+
 if (!componentFound) {
   if (!options.enableFallbackComponent)
     throw new Error(
       `Component could not be found for blok "${blok.component}"! Is it defined in astro.config.mjs?`
     );
   else {
-    Component = components['FallbackComponent'];
+    Component = components["FallbackComponent"];
   }
 } else {
   Component = components[key];

package/dist/index.d.ts

@@ -1,9 +1,7 @@
 import { default as storyblokIntegration } from './lib/storyblok-integration';
-export { storyblokLoader } from './content-loader/storyblokLoader';
 export { getLiveStory, renderRichText, useStoryblokApi } from './lib/helpers';
-export type { IntegrationOptions } from './lib/storyblok-integration';
 export { handleStoryblokMessage } from './live-preview/handleStoryblokMessage';
 export * from './types';
 export { toCamelCase } from './utils/toCamelCase';
+export { loadStoryblokBridge, RichTextResolver, richTextResolver, RichTextSchema, storyblokEditable, type StoryblokRichTextDocumentNode, type StoryblokRichTextImageOptimizationOptions, type StoryblokRichTextNode, type StoryblokRichTextNodeResolver, type StoryblokRichTextNodeTypes, type StoryblokRichTextOptions, type StoryblokRichTextResolvers, TextTypes, } from '@storyblok/js';
 export { storyblokIntegration as storyblok };
-export { loadStoryblokBridge, RichTextResolver, RichTextSchema, storyblokEditable, } from '@storyblok/js';