@btst/stack 2.12.2 → 3.0.0-rc.1

package/dist/plugins/comments/client/index.d.cts

@@ -1,9 +1,12 @@
 import * as _btst_stack_plugins_client from '@btst/stack/plugins/client';
-import * as React from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as _btst_yar from '@btst/yar';
+import * as React from 'react';
 import { QueryClient } from '@tanstack/react-query';
-import { C as CommentsLocalization } from '../../../shared/stack.Ldfkr5b2.cjs';
-export { a as COMMENTS_LOCALIZATION } from '../../../shared/stack.Ldfkr5b2.cjs';
+import { M as ModerationPageComponent, C as CommentsLocalization } from '../../../shared/stack.D7bewlgt.cjs';
+export { a as COMMENTS_LOCALIZATION } from '../../../shared/stack.D7bewlgt.cjs';
+
+declare function UserCommentsPageComponent(): react_jsx_runtime.JSX.Element;
 
 /**
  * Context passed to loader hooks
@@ -68,67 +71,51 @@ interface CommentsClientConfig {
 /**
  * Comments client plugin — registers admin moderation routes.
  *
- * The embeddable `CommentThread` and `CommentCount` components are standalone
- * and do not require this plugin to be registered. Register them manually
- * via the layout overrides pattern or use them directly in your pages.
+ * The embeddable `CommentThread` and `CommentCount` components do not require
+ * this plugin to be registered, but they must render under `StackProvider` so
+ * they can use its API and auth configuration.
  */
 declare const commentsClientPlugin: (config: CommentsClientConfig) => _btst_stack_plugins_client.ClientPlugin<Record<string, never>, {
-    moderation: {
-        (inputCtx_0?: _btst_yar.InputContext<"/comments/moderation", _btst_yar.RouteOptions> | undefined): {
-            PageComponent?: React.ComponentType<unknown> | undefined;
-            LoadingComponent?: React.ComponentType<unknown> | undefined;
-            ErrorComponent?: React.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: "/comments/moderation";
-        meta: _btst_yar.RouteMeta | undefined;
-    };
-    userComments: {
-        (inputCtx_0?: _btst_yar.InputContext<"/comments", _btst_yar.RouteOptions> | undefined): {
-            PageComponent?: React.ComponentType<unknown> | undefined;
-            LoadingComponent?: React.ComponentType<unknown> | undefined;
-            ErrorComponent?: React.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: "/comments";
-        meta: _btst_yar.RouteMeta | undefined;
-    };
+    moderation: _btst_yar.DefinedRoute<"/comments/moderation", {
+        readonly page: React.LazyExoticComponent<typeof ModerationPageComponent>;
+        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>;
+    userComments: _btst_yar.DefinedRoute<"/comments", {
+        readonly page: React.LazyExoticComponent<typeof UserCommentsPageComponent>;
+        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>;
 }>;
 
 /**
@@ -148,7 +135,7 @@ interface RouteContext {
 /**
  * Overridable configuration and hooks for the Comments plugin.
  *
- * Provide these in the layout wrapping your pages via `PluginOverridesProvider`.
+ * Provide these in the `comments` block of `StackProvider.overrides`.
  */
 interface CommentsPluginOverrides {
     /**
@@ -156,41 +143,11 @@ interface CommentsPluginOverrides {
      * Defaults to English when not provided.
      */
     localization?: Partial<CommentsLocalization>;
-    /**
-     * Base URL for API calls (e.g., "https://example.com")
-     */
-    apiBaseURL: string;
-    /**
-     * Path where the API is mounted (e.g., "/api/data")
-     */
-    apiBasePath: string;
-    /**
-     * Optional headers for authenticated API calls (e.g., forwarding cookies)
-     */
-    headers?: Record<string, string>;
     /**
      * Whether to show the "Powered by BTST" attribution on plugin pages.
      * Defaults to true.
      */
     showAttribution?: boolean;
-    /**
-     * The ID of the currently authenticated user.
-     *
-     * Used by the User Comments page and the per-resource comments admin view to
-     * scope the comment list to the current user and to enable posting.
-     * Can be a static string or an async function (useful when the user ID must
-     * be resolved from a session cookie at render time).
-     *
-     * When absent both pages show a "Please log in" prompt.
-     */
-    currentUserId?: string | (() => string | undefined | Promise<string | undefined>);
-    /**
-     * URL to redirect unauthenticated users to when they try to post a comment.
-     *
-     * Forwarded to every embedded `CommentThread` (including the one on the
-     * per-resource admin comments view). When absent no login link is shown.
-     */
-    loginHref?: string;
     /**
      * Default number of top-level comments to load per page in `CommentThread`.
      * Can be overridden per-instance via the `pageSize` prop.
@@ -237,26 +194,6 @@ interface CommentsPluginOverrides {
      * When a resource type has no entry the ID is shown as plain text.
      */
     resourceLinks?: Record<string, (id: string) => string>;
-    /**
-     * Called before the moderation dashboard page is rendered.
-     * Return false to block rendering (e.g., redirect to login or show 403).
-     * @param context - Route context
-     */
-    onBeforeModerationPageRendered?: (context: RouteContext) => boolean;
-    /**
-     * Called before the per-resource comments page is rendered.
-     * Return false to block rendering (e.g., for authorization).
-     * @param resourceType - The type of resource (e.g., "blog-post")
-     * @param resourceId - The ID of the resource
-     * @param context - Route context
-     */
-    onBeforeResourceCommentsRendered?: (resourceType: string, resourceId: string, context: RouteContext) => boolean;
-    /**
-     * Called before the User Comments page is rendered.
-     * Throw to block rendering (e.g., when the user is not authenticated).
-     * @param context - Route context
-     */
-    onBeforeUserCommentsPageRendered?: (context: RouteContext) => boolean | void;
     /**
      * Called when a route is rendered.
      * @param routeName - Name of the route (e.g., 'moderation', 'resourceComments')

package/dist/plugins/comments/client/index.d.mts

@@ -1,9 +1,12 @@
 import * as _btst_stack_plugins_client from '@btst/stack/plugins/client';
-import * as React from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as _btst_yar from '@btst/yar';
+import * as React from 'react';
 import { QueryClient } from '@tanstack/react-query';
-import { C as CommentsLocalization } from '../../../shared/stack.Ldfkr5b2.mjs';
-export { a as COMMENTS_LOCALIZATION } from '../../../shared/stack.Ldfkr5b2.mjs';
+import { M as ModerationPageComponent, C as CommentsLocalization } from '../../../shared/stack.D7bewlgt.mjs';
+export { a as COMMENTS_LOCALIZATION } from '../../../shared/stack.D7bewlgt.mjs';
+
+declare function UserCommentsPageComponent(): react_jsx_runtime.JSX.Element;
 
 /**
  * Context passed to loader hooks
@@ -68,67 +71,51 @@ interface CommentsClientConfig {
 /**
  * Comments client plugin — registers admin moderation routes.
  *
- * The embeddable `CommentThread` and `CommentCount` components are standalone
- * and do not require this plugin to be registered. Register them manually
- * via the layout overrides pattern or use them directly in your pages.
+ * The embeddable `CommentThread` and `CommentCount` components do not require
+ * this plugin to be registered, but they must render under `StackProvider` so
+ * they can use its API and auth configuration.
  */
 declare const commentsClientPlugin: (config: CommentsClientConfig) => _btst_stack_plugins_client.ClientPlugin<Record<string, never>, {
-    moderation: {
-        (inputCtx_0?: _btst_yar.InputContext<"/comments/moderation", _btst_yar.RouteOptions> | undefined): {
-            PageComponent?: React.ComponentType<unknown> | undefined;
-            LoadingComponent?: React.ComponentType<unknown> | undefined;
-            ErrorComponent?: React.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: "/comments/moderation";
-        meta: _btst_yar.RouteMeta | undefined;
-    };
-    userComments: {
-        (inputCtx_0?: _btst_yar.InputContext<"/comments", _btst_yar.RouteOptions> | undefined): {
-            PageComponent?: React.ComponentType<unknown> | undefined;
-            LoadingComponent?: React.ComponentType<unknown> | undefined;
-            ErrorComponent?: React.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: "/comments";
-        meta: _btst_yar.RouteMeta | undefined;
-    };
+    moderation: _btst_yar.DefinedRoute<"/comments/moderation", {
+        readonly page: React.LazyExoticComponent<typeof ModerationPageComponent>;
+        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>;
+    userComments: _btst_yar.DefinedRoute<"/comments", {
+        readonly page: React.LazyExoticComponent<typeof UserCommentsPageComponent>;
+        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>;
 }>;
 
 /**
@@ -148,7 +135,7 @@ interface RouteContext {
 /**
  * Overridable configuration and hooks for the Comments plugin.
  *
- * Provide these in the layout wrapping your pages via `PluginOverridesProvider`.
+ * Provide these in the `comments` block of `StackProvider.overrides`.
  */
 interface CommentsPluginOverrides {
     /**
@@ -156,41 +143,11 @@ interface CommentsPluginOverrides {
      * Defaults to English when not provided.
      */
     localization?: Partial<CommentsLocalization>;
-    /**
-     * Base URL for API calls (e.g., "https://example.com")
-     */
-    apiBaseURL: string;
-    /**
-     * Path where the API is mounted (e.g., "/api/data")
-     */
-    apiBasePath: string;
-    /**
-     * Optional headers for authenticated API calls (e.g., forwarding cookies)
-     */
-    headers?: Record<string, string>;
     /**
      * Whether to show the "Powered by BTST" attribution on plugin pages.
      * Defaults to true.
      */
     showAttribution?: boolean;
-    /**
-     * The ID of the currently authenticated user.
-     *
-     * Used by the User Comments page and the per-resource comments admin view to
-     * scope the comment list to the current user and to enable posting.
-     * Can be a static string or an async function (useful when the user ID must
-     * be resolved from a session cookie at render time).
-     *
-     * When absent both pages show a "Please log in" prompt.
-     */
-    currentUserId?: string | (() => string | undefined | Promise<string | undefined>);
-    /**
-     * URL to redirect unauthenticated users to when they try to post a comment.
-     *
-     * Forwarded to every embedded `CommentThread` (including the one on the
-     * per-resource admin comments view). When absent no login link is shown.
-     */
-    loginHref?: string;
     /**
      * Default number of top-level comments to load per page in `CommentThread`.
      * Can be overridden per-instance via the `pageSize` prop.
@@ -237,26 +194,6 @@ interface CommentsPluginOverrides {
      * When a resource type has no entry the ID is shown as plain text.
      */
     resourceLinks?: Record<string, (id: string) => string>;
-    /**
-     * Called before the moderation dashboard page is rendered.
-     * Return false to block rendering (e.g., redirect to login or show 403).
-     * @param context - Route context
-     */
-    onBeforeModerationPageRendered?: (context: RouteContext) => boolean;
-    /**
-     * Called before the per-resource comments page is rendered.
-     * Return false to block rendering (e.g., for authorization).
-     * @param resourceType - The type of resource (e.g., "blog-post")
-     * @param resourceId - The ID of the resource
-     * @param context - Route context
-     */
-    onBeforeResourceCommentsRendered?: (resourceType: string, resourceId: string, context: RouteContext) => boolean;
-    /**
-     * Called before the User Comments page is rendered.
-     * Throw to block rendering (e.g., when the user is not authenticated).
-     * @param context - Route context
-     */
-    onBeforeUserCommentsPageRendered?: (context: RouteContext) => boolean | void;
     /**
      * Called when a route is rendered.
      * @param routeName - Name of the route (e.g., 'moderation', 'resourceComments')

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

@@ -1,9 +1,12 @@
 import * as _btst_stack_plugins_client from '@btst/stack/plugins/client';
-import * as React from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as _btst_yar from '@btst/yar';
+import * as React from 'react';
 import { QueryClient } from '@tanstack/react-query';
-import { C as CommentsLocalization } from '../../../shared/stack.Ldfkr5b2.js';
-export { a as COMMENTS_LOCALIZATION } from '../../../shared/stack.Ldfkr5b2.js';
+import { M as ModerationPageComponent, C as CommentsLocalization } from '../../../shared/stack.D7bewlgt.js';
+export { a as COMMENTS_LOCALIZATION } from '../../../shared/stack.D7bewlgt.js';
+
+declare function UserCommentsPageComponent(): react_jsx_runtime.JSX.Element;
 
 /**
  * Context passed to loader hooks
@@ -68,67 +71,51 @@ interface CommentsClientConfig {
 /**
  * Comments client plugin — registers admin moderation routes.
  *
- * The embeddable `CommentThread` and `CommentCount` components are standalone
- * and do not require this plugin to be registered. Register them manually
- * via the layout overrides pattern or use them directly in your pages.
+ * The embeddable `CommentThread` and `CommentCount` components do not require
+ * this plugin to be registered, but they must render under `StackProvider` so
+ * they can use its API and auth configuration.
  */
 declare const commentsClientPlugin: (config: CommentsClientConfig) => _btst_stack_plugins_client.ClientPlugin<Record<string, never>, {
-    moderation: {
-        (inputCtx_0?: _btst_yar.InputContext<"/comments/moderation", _btst_yar.RouteOptions> | undefined): {
-            PageComponent?: React.ComponentType<unknown> | undefined;
-            LoadingComponent?: React.ComponentType<unknown> | undefined;
-            ErrorComponent?: React.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: "/comments/moderation";
-        meta: _btst_yar.RouteMeta | undefined;
-    };
-    userComments: {
-        (inputCtx_0?: _btst_yar.InputContext<"/comments", _btst_yar.RouteOptions> | undefined): {
-            PageComponent?: React.ComponentType<unknown> | undefined;
-            LoadingComponent?: React.ComponentType<unknown> | undefined;
-            ErrorComponent?: React.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: "/comments";
-        meta: _btst_yar.RouteMeta | undefined;
-    };
+    moderation: _btst_yar.DefinedRoute<"/comments/moderation", {
+        readonly page: React.LazyExoticComponent<typeof ModerationPageComponent>;
+        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>;
+    userComments: _btst_yar.DefinedRoute<"/comments", {
+        readonly page: React.LazyExoticComponent<typeof UserCommentsPageComponent>;
+        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>;
 }>;
 
 /**
@@ -148,7 +135,7 @@ interface RouteContext {
 /**
  * Overridable configuration and hooks for the Comments plugin.
  *
- * Provide these in the layout wrapping your pages via `PluginOverridesProvider`.
+ * Provide these in the `comments` block of `StackProvider.overrides`.
  */
 interface CommentsPluginOverrides {
     /**
@@ -156,41 +143,11 @@ interface CommentsPluginOverrides {
      * Defaults to English when not provided.
      */
     localization?: Partial<CommentsLocalization>;
-    /**
-     * Base URL for API calls (e.g., "https://example.com")
-     */
-    apiBaseURL: string;
-    /**
-     * Path where the API is mounted (e.g., "/api/data")
-     */
-    apiBasePath: string;
-    /**
-     * Optional headers for authenticated API calls (e.g., forwarding cookies)
-     */
-    headers?: Record<string, string>;
     /**
      * Whether to show the "Powered by BTST" attribution on plugin pages.
      * Defaults to true.
      */
     showAttribution?: boolean;
-    /**
-     * The ID of the currently authenticated user.
-     *
-     * Used by the User Comments page and the per-resource comments admin view to
-     * scope the comment list to the current user and to enable posting.
-     * Can be a static string or an async function (useful when the user ID must
-     * be resolved from a session cookie at render time).
-     *
-     * When absent both pages show a "Please log in" prompt.
-     */
-    currentUserId?: string | (() => string | undefined | Promise<string | undefined>);
-    /**
-     * URL to redirect unauthenticated users to when they try to post a comment.
-     *
-     * Forwarded to every embedded `CommentThread` (including the one on the
-     * per-resource admin comments view). When absent no login link is shown.
-     */
-    loginHref?: string;
     /**
      * Default number of top-level comments to load per page in `CommentThread`.
      * Can be overridden per-instance via the `pageSize` prop.
@@ -237,26 +194,6 @@ interface CommentsPluginOverrides {
      * When a resource type has no entry the ID is shown as plain text.
      */
     resourceLinks?: Record<string, (id: string) => string>;
-    /**
-     * Called before the moderation dashboard page is rendered.
-     * Return false to block rendering (e.g., redirect to login or show 403).
-     * @param context - Route context
-     */
-    onBeforeModerationPageRendered?: (context: RouteContext) => boolean;
-    /**
-     * Called before the per-resource comments page is rendered.
-     * Return false to block rendering (e.g., for authorization).
-     * @param resourceType - The type of resource (e.g., "blog-post")
-     * @param resourceId - The ID of the resource
-     * @param context - Route context
-     */
-    onBeforeResourceCommentsRendered?: (resourceType: string, resourceId: string, context: RouteContext) => boolean;
-    /**
-     * Called before the User Comments page is rendered.
-     * Throw to block rendering (e.g., when the user is not authenticated).
-     * @param context - Route context
-     */
-    onBeforeUserCommentsPageRendered?: (context: RouteContext) => boolean | void;
     /**
      * Called when a route is rendered.
      * @param routeName - Name of the route (e.g., 'moderation', 'resourceComments')