@storyblok/astro 7.4.0-alpha.0 → 8.1.0

package/README.md

@@ -50,7 +50,7 @@ If you'd like to contribute, please refer to the [contributing guidelines](CONTR
 
 For help, discussion about best practices, or any other conversation that would benefit from being searchable:
 
-- [Discuss Storyblok on Github Discussions](https://github.com/storyblok/monoblok/discussions)
+- [Discuss Storyblok on GitHub Discussions](https://github.com/storyblok/monoblok/discussions)
 
 For community support, chatting with other users, please visit:
 
@@ -65,7 +65,7 @@ For bugs or feature requests, please [submit an issue](https://github.com/storyb
 
 ### I can't share my company project code
 
-We understand that you might not be able to share your company's project code. Please provide a minimal reproducible example that demonstrates the issue by using tools like [Stackblitz](https://stackblitz.com) or a link to a Github Repo lease make sure you include a README file with the instructions to build and run the project, important not to include any access token, password or personal information of any kind.
+We understand that you might not be able to share your company's project code. Please provide a minimal reproducible example that demonstrates the issue by using tools like [Stackblitz](https://stackblitz.com) or a link to a GitHub repo. Please make sure you include a README file with the instructions to build and run the project, important not to include any access token, password or personal information of any kind.
 
 ### Feedback
 

package/dist/index.d.ts

@@ -1,12 +1,10 @@
 /// <reference path="./public.d.ts" />
 import { default as storyblokIntegration } from './lib/storyblok-integration';
-export { getLiveStory, getPayload, useStoryblokApi } from './lib/helpers';
-export { sanitizeJSON } from './lib/sanitizeJSON';
+export { getLiveStory, useStoryblokApi } from './lib/helpers';
 export type { IntegrationOptions } from './lib/storyblok-integration';
 export { handleStoryblokMessage } from './live-preview/handleStoryblokMessage';
 export * from './types';
-export { isEditorRequest } from './utils/isEditorRequest';
 export { toCamelCase } from './utils/toCamelCase';
-export { loadStoryblokBridge, renderRichText, richTextResolver, storyblokEditable, } from '@storyblok/js';
+export { loadStoryblokBridge, renderRichText, richTextResolver, segmentStoryblokRichText, storyblokEditable, } from '@storyblok/js';
 export { storyblokIntegration as storyblok };
 export { apiPlugin, storyblokInit } from '@storyblok/js';

package/dist/lib/client.d.ts

@@ -1,2 +1 @@
-export { richTextToHTML } from './richTextToHTML';
 export { storyblokApiInstance as storyblokApi } from 'virtual:storyblok-init';

package/dist/lib/client.ts

@@ -1,3 +1 @@
-export { richTextToHTML } from './richTextToHTML';
-
 export { storyblokApiInstance as storyblokApi } from 'virtual:storyblok-init';

package/dist/lib/helpers.d.ts

@@ -23,9 +23,6 @@ export declare function useStoryblokApi(): StoryblokClient;
  * This function is primarily useful when working with the Storyblok Visual Editor
  * and live preview updates in an Astro project.
  *
- * @deprecated Use `getPayload()` instead for better type safety and to access both story and serverData.
- * @see {@link getPayload}
- *
  * @param {Readonly<AstroGlobal>} Astro - The Astro global object.
  * @returns {Promise<ISbStoryData | null>} The Storyblok story data if available,
  * otherwise `null`.
@@ -39,47 +36,4 @@ export declare function useStoryblokApi(): StoryblokClient;
  * ```
  */
 export declare function getLiveStory(Astro: Readonly<AstroGlobal>): Promise<ISbStoryData | null>;
-/**
- * Retrieves the live Storyblok story and server data from Astro's `locals` during preview mode.
- *
- * This function is primarily useful when working with the Storyblok Visual Editor
- * and live preview updates in an Astro project.
- *
- * @template ServerData - The type of server data, constrained to StoryblokServerData
- * @template Story - The type of story data, constrained to ISbStoryData
- * @param {object} params - The function parameters
- * @param {object} params.locals - The Astro locals object
- * @returns {Promise<{ story?: Story; serverData?: ServerData }>} An object containing the story and serverData if available
- *
- * @example
- * ```ts
- * // Basic usage:
- * const payload = await getPayload({ locals: Astro.locals });
- * const story = payload.story ?? null;
- *
- * // With typed server data:
- * interface ServerData {
- *   users?: User[];
- * }
- *
- * interface MyStory extends ISbStoryData {
- *   content: { myField: string };
- * }
- *
- * const payload = await getPayload<ServerData, MyStory>({ locals: Astro.locals });
- * const story = payload.story ?? null;
- * const users = payload.serverData?.users ?? [];
- * ```
- */
-export declare function getPayload<ServerData extends object = object, Story extends ISbStoryData = ISbStoryData>({ locals, }: {
-    locals: {
-        _storyblok_preview_data?: {
-            serverData?: ServerData;
-            story?: Story;
-        };
-    };
-}): Promise<{
-    story?: Story;
-    serverData?: ServerData;
-}>;
 export declare function initStoryblokBridge(config: boolean | StoryblokBridgeConfigV2): string;

package/dist/lib/richTextToHTML.d.ts

@@ -1,15 +1,15 @@
-import { StoryblokRichTextNode, StoryblokRichTextResolvers } from '@storyblok/js';
+import { StoryblokRichTextNode, StoryblokRichTextOptions } from '@storyblok/js';
 /**
  * @experimental Converts a Storyblok RichText field into an HTML string.
  *
  * This API is still under development and may change in future releases.
- * It also relies on Astro’s experimental
+ * It also relies on Astro's experimental
  * [experimental_AstroContainer](https://docs.astro.build/en/reference/container-reference/) feature.
  *
  * @async
  * @param {StoryblokRichTextNode} richTextField - The root RichText node to convert.
- * @param {StoryblokRichTextResolvers} [customResolvers] - Optional custom resolvers
- *   for customizing how specific nodes or marks are transformed into HTML.
+ * @param {StoryblokRichTextOptions['tiptapExtensions']} [tiptapExtensions] - Optional custom
+ *   tiptap extensions for customizing how specific nodes or marks are rendered.
  * @returns {Promise<string>} A promise that resolves to the HTML string representation
  *   of the provided RichText content.
  *
@@ -24,4 +24,4 @@ import { StoryblokRichTextNode, StoryblokRichTextResolvers } from '@storyblok/js
  * <div set:html={renderedRichText} />
  * ```
  */
-export declare const richTextToHTML: (richTextField: StoryblokRichTextNode, customResolvers?: StoryblokRichTextResolvers) => Promise<string>;
+export declare const richTextToHTML: (richTextField: StoryblokRichTextNode, tiptapExtensions?: StoryblokRichTextOptions["tiptapExtensions"]) => Promise<string>;

package/dist/live-preview/middleware.ts

@@ -1,17 +1,18 @@
 import { defineMiddleware } from 'astro/middleware';
-import { isEditorRequest } from '@storyblok/astro';
 
 export const onRequest = defineMiddleware(async ({ locals, request }, next) => {
   if (request.method === 'POST') {
-    // First do a check if its coming from within storyblok
-    const editorRequest
-      = isEditorRequest(new URL(request.url));
+    const url = new URL(request.url);
+    // First do a basic check if its coming from within storyblok
+    const isStoryblokRequest
+      = url.searchParams.has('_storyblok')
+        && url.searchParams.has('_storyblok_c');
 
-    if (editorRequest) {
+    if (isStoryblokRequest) {
       try {
         // Create a copy of the request
         const requestBody = await request.clone().json();
-        if (requestBody?.story?.is_storyblok_preview) {
+        if (requestBody && requestBody.is_storyblok_preview) {
           locals._storyblok_preview_data = requestBody;
         }
       }

package/dist/public.d.ts

@@ -16,49 +16,8 @@ declare module '@storyblok/astro/StoryblokComponent.astro' {
   /** Renders a dynamic Storyblok component */
   export default StoryblokComponent;
 }
-declare module '@storyblok/astro/StoryblokServerData.astro' {
-  function StoryblokServerData(
-    _props: Record<string, unknown>
-  ): any;
-
-  /** Renders a dynamic Storyblok component */
-  export default StoryblokServerData;
-}
 declare module '@storyblok/astro/client' {
-  import type {
-    StoryblokClient,
-    StoryblokRichTextNode,
-    StoryblokRichTextResolvers,
-  } from '@storyblok/astro';
-  /**
-   * @experimental Converts a Storyblok RichText field into an HTML string.
-   *
-   * This API is still under development and may change in future releases.
-   * It also relies on Astro’s experimental
-   * [experimental_AstroContainer](https://docs.astro.build/en/reference/container-reference/) feature.
-   *
-   * @async
-   * @param {StoryblokRichTextNode} richTextField - The root RichText node to convert.
-   * @param {StoryblokRichTextResolvers} [customResolvers] - Optional custom resolvers
-   *   for customizing how specific nodes or marks are transformed into HTML.
-   * @returns {Promise<string>} A promise that resolves to the HTML string representation
-   *   of the provided RichText content.
-   *
-   * @example
-   * ```astro
-   * ---
-   * import { richTextToHTML } from '@storyblok/astro/client';
-   * const { blok } = Astro.props;
-   * const renderedRichText = await richTextToHTML(blok.text);
-   * ---
-   *
-   * <div set:html={renderedRichText} />
-   * ```
-   */
-  export function richTextToHTML(
-    richTextField: StoryblokRichTextNode,
-    customResolvers?: StoryblokRichTextResolvers
-  ): Promise<string>;
+  import type { StoryblokClient } from '@storyblok/astro';
 
   /**
    * Provides direct access to the initialized Storyblok API client instance.