@storyblok/astro 5.1.2 → 6.0.0-next.1

package/dist/index.d.ts

@@ -1,60 +1,7 @@
-import { AstroGlobal, AstroIntegration } from 'astro';
-import { ISbConfig, ISbRichtext, ISbStoriesParams, ISbStoryData, SbRichTextOptions, StoryblokBridgeConfigV2, StoryblokClient } from './types';
+import { default as storyblokIntegration } from './lib/storyblok-integration';
+export { getLiveStory, renderRichText, useStoryblokApi } from './lib/helpers';
 export { handleStoryblokMessage } from './live-preview/handleStoryblokMessage';
 export * from './types';
 export { toCamelCase } from './utils/toCamelCase';
 export { loadStoryblokBridge, RichTextResolver, RichTextSchema, storyblokEditable, } from '@storyblok/js';
-export declare function useStoryblokApi(): StoryblokClient;
-export declare function useStoryblok(slug: string, apiOptions: ISbStoriesParams | undefined, _: StoryblokBridgeConfigV2 | undefined, Astro: AstroGlobal): Promise<ISbStoryData<import('@storyblok/js').StoryblokComponentType<string> & {
-    [index: string]: any;
-}> | null>;
-export declare function renderRichText(data?: ISbRichtext, options?: SbRichTextOptions): string;
-export interface IntegrationOptions {
-    /**
-     * The access token from your space.
-     */
-    accessToken: string;
-    /**
-     *  If you want to use your own method to fetch data from Storyblok, you can disable this behavior by setting `useCustomApi` to `true`, resulting in an optimized final bundle.
-     */
-    useCustomApi?: boolean;
-    /**
-     * Set custom API options here (cache, region, and more). All options are documented [here](https://github.com/storyblok/storyblok-js-client#class-storyblok).
-     */
-    apiOptions?: ISbConfig;
-    /**
-     * A boolean to enable/disable the Storyblok JavaScript Bridge or provide a StoryblokBridgeConfigV2 configuration object. Enabled by default.
-     */
-    bridge?: boolean | StoryblokBridgeConfigV2;
-    /**
-     * An object containing your Astro components to their Storyblok equivalents.
-     * Example:
-     * ```js
-     * components: {
-     *   page: "storyblok/Page",
-     *   feature: "storyblok/Feature",
-     *   grid: "storyblok/Grid",
-     *   teaser: "storyblok/Teaser",
-     * },
-     * ```
-     */
-    components?: Record<string, string>;
-    /**
-     * The directory containing your Astro components are. Defaults to "src".
-     */
-    componentsDir?: string;
-    /**
-     * Show a fallback component in your frontend if a component is not registered properly.
-     */
-    enableFallbackComponent?: boolean;
-    /**
-     * Provide a path to a custom fallback component, e.g. "storyblok/customFallback".
-     * Please note: the path takes into account the `componentsDir` option.
-     */
-    customFallbackComponent?: string;
-    /**
-     * A boolean to enable/disable the Experimental Live Preview feature. Disabled by default.
-     */
-    livePreview?: boolean;
-}
-export default function storyblokIntegration(options: IntegrationOptions): AstroIntegration;
+export { storyblokIntegration as storyblok };

package/dist/lib/helpers.d.ts

@@ -0,0 +1,8 @@
+import { ISbRichtext, ISbStoryData, SbRichTextOptions, StoryblokBridgeConfigV2, StoryblokClient } from '../types';
+import { AstroGlobal } from 'astro';
+export declare function useStoryblokApi(): StoryblokClient;
+export declare function getLiveStory(Astro: AstroGlobal): Promise<ISbStoryData<import('@storyblok/js').StoryblokComponentType<string> & {
+    [index: string]: any;
+}> | null>;
+export declare function renderRichText(data?: ISbRichtext, options?: SbRichTextOptions): string;
+export declare function initStoryblokBridge(config: boolean | StoryblokBridgeConfigV2): string;

package/dist/lib/storyblok-integration.d.ts

@@ -0,0 +1,51 @@
+import { ISbConfig, StoryblokBridgeConfigV2 } from '@storyblok/js';
+import { AstroIntegration } from 'astro';
+export interface IntegrationOptions {
+    /**
+     * The access token from your space.
+     */
+    accessToken: string;
+    /**
+     *  If you want to use your own method to fetch data from Storyblok, you can disable this behavior by setting `useCustomApi` to `true`, resulting in an optimized final bundle.
+     */
+    useCustomApi?: boolean;
+    /**
+     * Set custom API options here (cache, region, and more). All options are documented [here](https://github.com/storyblok/storyblok-js-client#class-storyblok).
+     */
+    apiOptions?: ISbConfig;
+    /**
+     * A boolean to enable/disable the Storyblok JavaScript Bridge or provide a StoryblokBridgeConfigV2 configuration object. Enabled by default.
+     */
+    bridge?: boolean | StoryblokBridgeConfigV2;
+    /**
+     * An object containing your Astro components to their Storyblok equivalents.
+     * Example:
+     * ```js
+     * components: {
+     *   page: "storyblok/Page",
+     *   feature: "storyblok/Feature",
+     *   grid: "storyblok/Grid",
+     *   teaser: "storyblok/Teaser",
+     * },
+     * ```
+     */
+    components?: Record<string, string>;
+    /**
+     * The directory containing your Astro components are. Defaults to "src".
+     */
+    componentsDir?: string;
+    /**
+     * Show a fallback component in your frontend if a component is not registered properly.
+     */
+    enableFallbackComponent?: boolean;
+    /**
+     * Provide a path to a custom fallback component, e.g. "storyblok/customFallback".
+     * Please note: the path takes into account the `componentsDir` option.
+     */
+    customFallbackComponent?: string;
+    /**
+     * A boolean to enable/disable the Experimental Live Preview feature. Disabled by default.
+     */
+    livePreview?: boolean;
+}
+export default function storyblokIntegration(options: IntegrationOptions): AstroIntegration;