@btst/stack 2.12.2 → 3.0.0-rc.1

package/dist/plugins/blog/client/index.d.ts

@@ -1,11 +1,14 @@
 import * as _btst_stack_plugins_client from '@btst/stack/plugins/client';
 import * as _btst_yar from '@btst/yar';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ComponentType, ReactNode } from 'react';
 import { QueryClient } from '@tanstack/react-query';
 import { P as Post, S as SerializedPost } from '../../../shared/stack.Dsatjh0B.js';
-export { U as UsePostsOptions, a as UsePostsResult } from '../../../shared/stack.BnSAhKJi.js';
+import { N as NewPostPageComponent } from '../../../shared/stack.Bz-YPsuX.js';
+export { U as UsePostsOptions, a as UsePostsResult } from '../../../shared/stack.CRelKJfH.js';
 import 'zod';
-import '../../../shared/stack.CuhcFsAx.js';
+import '@btst/stack/plugins/client/hooks';
+import '../../../shared/stack.B0muOwUF.js';
 
 /**
  * Context passed to route hooks
@@ -75,6 +78,7 @@ interface BlogClientConfig {
      * Optional page component overrides.
      * Replace any plugin page with a custom React component.
      * The built-in component is used as the fallback when not provided.
+     * Every override receives the route context (`params`, `query`) as props.
      */
     pageComponents?: {
         /** Replaces the published posts list page */
@@ -85,15 +89,21 @@ interface BlogClientConfig {
         newPost?: ComponentType;
         /** Replaces the single post page */
         post?: ComponentType<{
-            slug: string;
+            params: {
+                slug: string;
+            };
         }>;
         /** Replaces the edit post page */
         editPost?: ComponentType<{
-            slug: string;
+            params: {
+                slug: string;
+            };
         }>;
         /** Replaces the tag posts page */
         tag?: ComponentType<{
-            tagSlug: string;
+            params: {
+                tagSlug: string;
+            };
         }>;
     };
 }
@@ -156,174 +166,126 @@ interface BlogClientHooks {
  * @param config - Configuration including queryClient, baseURL, and optional hooks
  */
 declare const blogClientPlugin: (config: BlogClientConfig) => _btst_stack_plugins_client.ClientPlugin<Record<string, never>, {
-    posts: {
-        (inputCtx_0?: _btst_yar.InputContext<"/blog", _btst_yar.RouteOptions> | undefined): {
-            PageComponent?: ComponentType<{}> | undefined;
-            LoadingComponent?: ComponentType<{}> | undefined;
-            ErrorComponent?: ComponentType<{}> | undefined;
-            loader?: (() => Promise<void>) | undefined;
-            meta?: (() => ({
-                title: string;
-                name?: undefined;
-                content?: undefined;
-                property?: undefined;
-            } | {
-                name: string;
-                content: string;
-                title?: undefined;
-                property?: undefined;
-            } | {
-                property: string;
-                content: string;
-                title?: undefined;
-                name?: undefined;
-            })[]) | undefined;
-            extra?: (() => any) | undefined;
-        };
-        options: _btst_yar.RouteOptions | undefined;
-        path: "/blog";
-        meta: _btst_yar.RouteMeta | undefined;
-    };
-    drafts: {
-        (inputCtx_0?: _btst_yar.InputContext<"/blog/drafts", _btst_yar.RouteOptions> | undefined): {
-            PageComponent?: ComponentType<{}> | undefined;
-            LoadingComponent?: ComponentType<{}> | undefined;
-            ErrorComponent?: ComponentType<{}> | undefined;
-            loader?: (() => Promise<void>) | undefined;
-            meta?: (() => ({
-                title: string;
-                name?: undefined;
-                content?: undefined;
-                property?: undefined;
-            } | {
-                name: string;
-                content: string;
-                title?: undefined;
-                property?: undefined;
-            } | {
-                property: string;
-                content: string;
-                title?: undefined;
-                name?: undefined;
-            })[]) | undefined;
-            extra?: (() => any) | undefined;
-        };
-        options: _btst_yar.RouteOptions | undefined;
-        path: "/blog/drafts";
-        meta: _btst_yar.RouteMeta | undefined;
-    };
-    newPost: {
-        (inputCtx_0?: _btst_yar.InputContext<"/blog/new", _btst_yar.RouteOptions> | undefined): {
-            PageComponent?: ComponentType<{}> | undefined;
-            LoadingComponent?: ComponentType<{}> | undefined;
-            ErrorComponent?: ComponentType<{}> | undefined;
-            loader?: (() => Promise<void>) | undefined;
-            meta?: (() => ({
-                title: string;
-                name?: undefined;
-                content?: undefined;
-                property?: undefined;
-            } | {
-                name: string;
-                content: string;
-                title?: undefined;
-                property?: undefined;
-            } | {
-                property: string;
-                content: string;
-                title?: undefined;
-                name?: undefined;
-            })[]) | undefined;
-            extra?: (() => any) | undefined;
-        };
-        options: _btst_yar.RouteOptions | undefined;
-        path: "/blog/new";
-        meta: _btst_yar.RouteMeta | undefined;
-    };
-    editPost: {
-        (inputCtx_0: _btst_yar.InputContext<"/blog/:slug/edit", _btst_yar.RouteOptions>): {
-            PageComponent?: ComponentType<unknown> | undefined;
-            LoadingComponent?: ComponentType<unknown> | undefined;
-            ErrorComponent?: ComponentType<unknown> | undefined;
-            loader?: (() => Promise<void>) | undefined;
-            meta?: (() => ({
-                title: string;
-                name?: undefined;
-                content?: undefined;
-                property?: undefined;
-            } | {
-                name: string;
-                content: string;
-                title?: undefined;
-                property?: undefined;
-            } | {
-                property: string;
-                content: string;
-                title?: undefined;
-                name?: undefined;
-            })[]) | undefined;
-            extra?: (() => any) | undefined;
-        };
-        options: _btst_yar.RouteOptions | undefined;
-        path: "/blog/:slug/edit";
-        meta: _btst_yar.RouteMeta | undefined;
-    };
-    tag: {
-        (inputCtx_0: _btst_yar.InputContext<"/blog/tag/:tagSlug", _btst_yar.RouteOptions>): {
-            PageComponent?: ComponentType<unknown> | undefined;
-            LoadingComponent?: ComponentType<unknown> | undefined;
-            ErrorComponent?: ComponentType<unknown> | undefined;
-            loader?: (() => Promise<void>) | undefined;
-            meta?: (() => ({
-                title: string;
-                name?: undefined;
-                content?: undefined;
-                property?: undefined;
-            } | {
-                name: string;
-                content: string;
-                title?: undefined;
-                property?: undefined;
-            } | {
-                property: string;
-                content: string;
-                title?: undefined;
-                name?: undefined;
-            })[]) | undefined;
-            extra?: (() => any) | undefined;
-        };
-        options: _btst_yar.RouteOptions | undefined;
-        path: "/blog/tag/:tagSlug";
-        meta: _btst_yar.RouteMeta | undefined;
-    };
-    post: {
-        (inputCtx_0: _btst_yar.InputContext<"/blog/:slug", _btst_yar.RouteOptions>): {
-            PageComponent?: ComponentType<unknown> | undefined;
-            LoadingComponent?: ComponentType<unknown> | undefined;
-            ErrorComponent?: ComponentType<unknown> | undefined;
-            loader?: (() => Promise<void>) | undefined;
-            meta?: (() => ({
-                title: string;
-                name?: undefined;
-                content?: undefined;
-                property?: undefined;
-            } | {
-                name: string;
-                content: string | undefined;
-                title?: undefined;
-                property?: undefined;
-            } | {
-                property: string;
-                content: string;
-                title?: undefined;
-                name?: undefined;
-            })[]) | undefined;
-            extra?: (() => any) | undefined;
-        };
-        options: _btst_yar.RouteOptions | undefined;
-        path: "/blog/:slug";
-        meta: _btst_yar.RouteMeta | undefined;
-    };
+    posts: _btst_yar.DefinedRoute<"/blog", {
+        readonly page: () => react_jsx_runtime.JSX.Element;
+        readonly loader: () => Promise<void>;
+        readonly meta: () => ({
+            title: string;
+            name?: undefined;
+            content?: undefined;
+            property?: undefined;
+        } | {
+            name: string;
+            content: string;
+            title?: undefined;
+            property?: undefined;
+        } | {
+            property: string;
+            content: string;
+            title?: undefined;
+            name?: undefined;
+        })[];
+    }, _btst_yar.RouteMeta>;
+    drafts: _btst_yar.DefinedRoute<"/blog/drafts", {
+        readonly page: () => react_jsx_runtime.JSX.Element;
+        readonly loader: () => Promise<void>;
+        readonly meta: () => ({
+            title: string;
+            name?: undefined;
+            content?: undefined;
+            property?: undefined;
+        } | {
+            name: string;
+            content: string;
+            title?: undefined;
+            property?: undefined;
+        } | {
+            property: string;
+            content: string;
+            title?: undefined;
+            name?: undefined;
+        })[];
+    }, _btst_yar.RouteMeta>;
+    newPost: _btst_yar.DefinedRoute<"/blog/new", {
+        readonly page: typeof NewPostPageComponent;
+        readonly loader: () => Promise<void>;
+        readonly meta: () => ({
+            title: string;
+            name?: undefined;
+            content?: undefined;
+            property?: undefined;
+        } | {
+            name: string;
+            content: string;
+            title?: undefined;
+            property?: undefined;
+        } | {
+            property: string;
+            content: string;
+            title?: undefined;
+            name?: undefined;
+        })[];
+    }, _btst_yar.RouteMeta>;
+    editPost: _btst_yar.DefinedRoute<"/blog/:slug/edit", {
+        readonly page: ({ params }: _btst_yar.RouteContext<"/blog/:slug/edit", _btst_yar.RouteOptions>) => react_jsx_runtime.JSX.Element;
+        readonly loader: ({ params }: _btst_yar.RouteContext<"/blog/:slug/edit", _btst_yar.RouteOptions>) => Promise<void>;
+        readonly meta: ({ params }: _btst_yar.RouteContext<"/blog/:slug/edit", _btst_yar.RouteOptions>) => ({
+            title: string;
+            name?: undefined;
+            content?: undefined;
+            property?: undefined;
+        } | {
+            name: string;
+            content: string;
+            title?: undefined;
+            property?: undefined;
+        } | {
+            property: string;
+            content: string;
+            title?: undefined;
+            name?: undefined;
+        })[];
+    }, _btst_yar.RouteMeta>;
+    tag: _btst_yar.DefinedRoute<"/blog/tag/:tagSlug", {
+        readonly page: ({ params }: _btst_yar.RouteContext<"/blog/tag/:tagSlug", _btst_yar.RouteOptions>) => react_jsx_runtime.JSX.Element;
+        readonly loader: ({ params }: _btst_yar.RouteContext<"/blog/tag/:tagSlug", _btst_yar.RouteOptions>) => Promise<void>;
+        readonly meta: ({ params }: _btst_yar.RouteContext<"/blog/tag/:tagSlug", _btst_yar.RouteOptions>) => ({
+            title: string;
+            name?: undefined;
+            content?: undefined;
+            property?: undefined;
+        } | {
+            name: string;
+            content: string;
+            title?: undefined;
+            property?: undefined;
+        } | {
+            property: string;
+            content: string;
+            title?: undefined;
+            name?: undefined;
+        })[];
+    }, _btst_yar.RouteMeta>;
+    post: _btst_yar.DefinedRoute<"/blog/:slug", {
+        readonly page: ({ params }: _btst_yar.RouteContext<"/blog/:slug", _btst_yar.RouteOptions>) => react_jsx_runtime.JSX.Element;
+        readonly loader: ({ params }: _btst_yar.RouteContext<"/blog/:slug", _btst_yar.RouteOptions>) => Promise<void>;
+        readonly meta: ({ params }: _btst_yar.RouteContext<"/blog/:slug", _btst_yar.RouteOptions>) => ({
+            title: string;
+            name?: undefined;
+            content?: undefined;
+            property?: undefined;
+        } | {
+            name: string;
+            content: string | undefined;
+            title?: undefined;
+            property?: undefined;
+        } | {
+            property: string;
+            content: string;
+            title?: undefined;
+            name?: undefined;
+        })[];
+    }, _btst_yar.RouteMeta>;
 }>;
 
 declare const BLOG_LOCALIZATION: {
@@ -347,6 +309,7 @@ declare const BLOG_LOCALIZATION: {
     BLOG_FORMS_TOAST_CREATE_SUCCESS: string;
     BLOG_FORMS_TOAST_UPDATE_SUCCESS: string;
     BLOG_FORMS_TOAST_DELETE_SUCCESS: string;
+    BLOG_FORMS_TOAST_DELETE_FAILURE: string;
     BLOG_FORMS_LOADING_POST: string;
     BLOG_FORMS_DELETE_BUTTON: string;
     BLOG_FORMS_DELETE_DIALOG_TITLE: string;
@@ -422,32 +385,16 @@ interface RouteContext {
 /**
  * Overridable components and functions for the Blog plugin
  *
- * External consumers can provide their own implementations of these
- * to customize the behavior for their framework (Next.js, React Router, etc.)
+ * External consumers can provide their own implementations to customize
+ * plugin-specific components and behavior.
  */
 interface BlogPluginOverrides {
-    /**
-     * Link component for navigation
-     */
-    Link?: ComponentType<React.ComponentProps<"a"> & Record<string, any>>;
     /**
      * Post card component for displaying a post
      */
     PostCard?: ComponentType<{
         post: SerializedPost;
     }>;
-    /**
-     * Navigation function for programmatic navigation
-     */
-    navigate: (path: string) => void | Promise<void>;
-    /**
-     * Refresh function to invalidate server-side cache (e.g., Next.js router.refresh())
-     */
-    refresh?: () => void | Promise<void>;
-    /**
-     * Image component for displaying images
-     */
-    Image?: ComponentType<React.ImgHTMLAttributes<HTMLImageElement> & Record<string, any>>;
     /**
      * Function used to upload a new image file and return its URL.
      * This is separate from `imagePicker`, which selects an existing asset URL.
@@ -502,14 +449,6 @@ interface BlogPluginOverrides {
      * Localization object for the blog plugin
      */
     localization?: BlogLocalization;
-    /**
-     * API base URL
-     */
-    apiBaseURL: string;
-    /**
-     * API base path
-     */
-    apiBasePath: string;
     /**
      * Whether to show the attribution
      */
@@ -531,38 +470,6 @@ interface BlogPluginOverrides {
      * @param context - Route context
      */
     onRouteError?: (routeName: string, error: Error, context: RouteContext) => void | Promise<void>;
-    /**
-     * Called before the posts list page is rendered
-     * Return false to prevent rendering (e.g., for authorization)
-     * @param context - Route context
-     */
-    onBeforePostsPageRendered?: (context: RouteContext) => boolean;
-    /**
-     * Called before a single post page is rendered
-     * Return false to prevent rendering (e.g., for authorization)
-     * @param slug - The post slug
-     * @param context - Route context
-     */
-    onBeforePostPageRendered?: (slug: string, context: RouteContext) => boolean;
-    /**
-     * Called before the new post page is rendered
-     * Return false to prevent rendering (e.g., for authorization)
-     * @param context - Route context
-     */
-    onBeforeNewPostPageRendered?: (context: RouteContext) => boolean;
-    /**
-     * Called before the edit post page is rendered
-     * Return false to prevent rendering (e.g., for authorization)
-     * @param slug - The post slug being edited
-     * @param context - Route context
-     */
-    onBeforeEditPostPageRendered?: (slug: string, context: RouteContext) => boolean;
-    /**
-     * Called before the drafts page is rendered
-     * Return false to prevent rendering (e.g., for authorization)
-     * @param context - Route context
-     */
-    onBeforeDraftsPageRendered?: (context: RouteContext) => boolean;
     /**
      * Optional slot rendered below the blog post body.
      * Use this to inject a comment thread or any custom content without
@@ -575,10 +482,6 @@ interface BlogPluginOverrides {
      *     <CommentThread
      *       resourceId={post.slug}
      *       resourceType="blog-post"
-     *       apiBaseURL={apiBaseURL}
-     *       apiBasePath="/api/data"
-     *       currentUserId={session?.userId}
-     *       loginHref="/login"
      *     />
      *   ),
      * }