@btst/stack 1.11.0 → 2.0.0

package/dist/shared/stack.FeaWkglm.d.mts

@@ -0,0 +1,190 @@
+import { ComponentType } from 'react';
+
+interface KanbanCommonLocalization {
+    backToBoards: string;
+    actions: string;
+    create: string;
+    edit: string;
+    delete: string;
+    cancel: string;
+    save: string;
+    loading: string;
+    saving: string;
+    deleting: string;
+    board: string;
+    boards: string;
+    column: string;
+    columns: string;
+    task: string;
+    tasks: string;
+    priorityLow: string;
+    priorityMedium: string;
+    priorityHigh: string;
+    priorityUrgent: string;
+    noBoards: string;
+    noColumns: string;
+    noTasks: string;
+    errorGeneric: string;
+    errorNotFound: string;
+}
+
+interface KanbanFormsLocalization {
+    boardName: string;
+    boardNamePlaceholder: string;
+    boardDescription: string;
+    boardDescriptionPlaceholder: string;
+    createBoard: string;
+    updateBoard: string;
+    deleteBoard: string;
+    deleteBoardConfirm: string;
+    columnTitle: string;
+    columnTitlePlaceholder: string;
+    createColumn: string;
+    updateColumn: string;
+    deleteColumn: string;
+    deleteColumnConfirm: string;
+    taskTitle: string;
+    taskTitlePlaceholder: string;
+    taskDescription: string;
+    taskDescriptionPlaceholder: string;
+    taskPriority: string;
+    taskColumn: string;
+    taskAssignee: string;
+    createTask: string;
+    updateTask: string;
+    deleteTask: string;
+    deleteTaskConfirm: string;
+    nameRequired: string;
+    titleRequired: string;
+}
+
+interface KanbanListLocalization {
+    kanbanBoards: string;
+    manageProjects: string;
+    createNewBoard: string;
+    boardDetails: string;
+    newBoard: string;
+    addColumn: string;
+    addTask: string;
+    columnsCount: string;
+    noBoardsDescription: string;
+    noColumnsDescription: string;
+    noTasksDescription: string;
+}
+
+type KanbanLocalization = Partial<KanbanCommonLocalization & KanbanFormsLocalization & KanbanListLocalization>;
+
+/**
+ * User information for assignee display/selection
+ * Framework-agnostic - consumers map their auth system to this shape
+ */
+interface KanbanUser {
+    id: string;
+    name: string;
+    avatarUrl?: string;
+    email?: string;
+}
+/**
+ * Context passed to lifecycle hooks
+ */
+interface RouteContext {
+    /** Current route path */
+    path: string;
+    /** Route parameters (e.g., { boardId: "abc123" }) */
+    params?: Record<string, string>;
+    /** Whether rendering on server (true) or client (false) */
+    isSSR: boolean;
+    /** Additional context properties */
+    [key: string]: unknown;
+}
+/**
+ * Overridable components and functions for the Kanban plugin
+ *
+ * External consumers can provide their own implementations of these
+ * to customize the behavior for their framework (Next.js, React Router, etc.)
+ */
+interface KanbanPluginOverrides {
+    /**
+     * Link component for navigation
+     */
+    Link?: ComponentType<React.ComponentProps<"a"> & Record<string, unknown>>;
+    /**
+     * 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, unknown>>;
+    /**
+     * Localization object for the kanban plugin
+     */
+    localization?: KanbanLocalization;
+    /**
+     * API base URL
+     */
+    apiBaseURL: string;
+    /**
+     * API base path
+     */
+    apiBasePath: string;
+    /**
+     * Whether to show the attribution
+     */
+    showAttribution?: boolean;
+    /**
+     * Optional headers to pass with API requests (e.g., for SSR auth)
+     */
+    headers?: HeadersInit;
+    /**
+     * Resolve user info from an assigneeId
+     * Called when rendering task cards/forms that have an assignee
+     * Return null for unknown users (will show fallback UI)
+     */
+    resolveUser: (userId: string) => Promise<KanbanUser | null> | KanbanUser | null;
+    /**
+     * Search/list users available for assignment
+     * Called when user opens the assignee picker
+     * @param query - Search query (empty string for initial load)
+     * @param boardId - Optional board context for scoped user lists
+     */
+    searchUsers: (query: string, boardId?: string) => Promise<KanbanUser[]> | KanbanUser[];
+    /**
+     * Called when a route is rendered
+     * @param routeName - Name of the route (e.g., 'boards', 'board', 'newBoard')
+     * @param context - Route context with path, params, etc.
+     */
+    onRouteRender?: (routeName: string, context: RouteContext) => void | Promise<void>;
+    /**
+     * Called when a route encounters an error
+     * @param routeName - Name of the route
+     * @param error - The error that occurred
+     * @param context - Route context
+     */
+    onRouteError?: (routeName: string, error: Error, context: RouteContext) => void | Promise<void>;
+    /**
+     * Called before the boards list page is rendered
+     * Return false to prevent rendering (e.g., for authorization)
+     * @param context - Route context
+     */
+    onBeforeBoardsPageRendered?: (context: RouteContext) => boolean;
+    /**
+     * Called before a single board page is rendered
+     * Return false to prevent rendering (e.g., for authorization)
+     * @param boardId - The board ID
+     * @param context - Route context
+     */
+    onBeforeBoardPageRendered?: (boardId: string, context: RouteContext) => boolean;
+    /**
+     * Called before the new board page is rendered
+     * Return false to prevent rendering (e.g., for authorization)
+     * @param context - Route context
+     */
+    onBeforeNewBoardPageRendered?: (context: RouteContext) => boolean;
+}
+
+export type { KanbanPluginOverrides as K, KanbanUser as a };

package/dist/shared/stack.FeaWkglm.d.ts

@@ -0,0 +1,190 @@
+import { ComponentType } from 'react';
+
+interface KanbanCommonLocalization {
+    backToBoards: string;
+    actions: string;
+    create: string;
+    edit: string;
+    delete: string;
+    cancel: string;
+    save: string;
+    loading: string;
+    saving: string;
+    deleting: string;
+    board: string;
+    boards: string;
+    column: string;
+    columns: string;
+    task: string;
+    tasks: string;
+    priorityLow: string;
+    priorityMedium: string;
+    priorityHigh: string;
+    priorityUrgent: string;
+    noBoards: string;
+    noColumns: string;
+    noTasks: string;
+    errorGeneric: string;
+    errorNotFound: string;
+}
+
+interface KanbanFormsLocalization {
+    boardName: string;
+    boardNamePlaceholder: string;
+    boardDescription: string;
+    boardDescriptionPlaceholder: string;
+    createBoard: string;
+    updateBoard: string;
+    deleteBoard: string;
+    deleteBoardConfirm: string;
+    columnTitle: string;
+    columnTitlePlaceholder: string;
+    createColumn: string;
+    updateColumn: string;
+    deleteColumn: string;
+    deleteColumnConfirm: string;
+    taskTitle: string;
+    taskTitlePlaceholder: string;
+    taskDescription: string;
+    taskDescriptionPlaceholder: string;
+    taskPriority: string;
+    taskColumn: string;
+    taskAssignee: string;
+    createTask: string;
+    updateTask: string;
+    deleteTask: string;
+    deleteTaskConfirm: string;
+    nameRequired: string;
+    titleRequired: string;
+}
+
+interface KanbanListLocalization {
+    kanbanBoards: string;
+    manageProjects: string;
+    createNewBoard: string;
+    boardDetails: string;
+    newBoard: string;
+    addColumn: string;
+    addTask: string;
+    columnsCount: string;
+    noBoardsDescription: string;
+    noColumnsDescription: string;
+    noTasksDescription: string;
+}
+
+type KanbanLocalization = Partial<KanbanCommonLocalization & KanbanFormsLocalization & KanbanListLocalization>;
+
+/**
+ * User information for assignee display/selection
+ * Framework-agnostic - consumers map their auth system to this shape
+ */
+interface KanbanUser {
+    id: string;
+    name: string;
+    avatarUrl?: string;
+    email?: string;
+}
+/**
+ * Context passed to lifecycle hooks
+ */
+interface RouteContext {
+    /** Current route path */
+    path: string;
+    /** Route parameters (e.g., { boardId: "abc123" }) */
+    params?: Record<string, string>;
+    /** Whether rendering on server (true) or client (false) */
+    isSSR: boolean;
+    /** Additional context properties */
+    [key: string]: unknown;
+}
+/**
+ * Overridable components and functions for the Kanban plugin
+ *
+ * External consumers can provide their own implementations of these
+ * to customize the behavior for their framework (Next.js, React Router, etc.)
+ */
+interface KanbanPluginOverrides {
+    /**
+     * Link component for navigation
+     */
+    Link?: ComponentType<React.ComponentProps<"a"> & Record<string, unknown>>;
+    /**
+     * 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, unknown>>;
+    /**
+     * Localization object for the kanban plugin
+     */
+    localization?: KanbanLocalization;
+    /**
+     * API base URL
+     */
+    apiBaseURL: string;
+    /**
+     * API base path
+     */
+    apiBasePath: string;
+    /**
+     * Whether to show the attribution
+     */
+    showAttribution?: boolean;
+    /**
+     * Optional headers to pass with API requests (e.g., for SSR auth)
+     */
+    headers?: HeadersInit;
+    /**
+     * Resolve user info from an assigneeId
+     * Called when rendering task cards/forms that have an assignee
+     * Return null for unknown users (will show fallback UI)
+     */
+    resolveUser: (userId: string) => Promise<KanbanUser | null> | KanbanUser | null;
+    /**
+     * Search/list users available for assignment
+     * Called when user opens the assignee picker
+     * @param query - Search query (empty string for initial load)
+     * @param boardId - Optional board context for scoped user lists
+     */
+    searchUsers: (query: string, boardId?: string) => Promise<KanbanUser[]> | KanbanUser[];
+    /**
+     * Called when a route is rendered
+     * @param routeName - Name of the route (e.g., 'boards', 'board', 'newBoard')
+     * @param context - Route context with path, params, etc.
+     */
+    onRouteRender?: (routeName: string, context: RouteContext) => void | Promise<void>;
+    /**
+     * Called when a route encounters an error
+     * @param routeName - Name of the route
+     * @param error - The error that occurred
+     * @param context - Route context
+     */
+    onRouteError?: (routeName: string, error: Error, context: RouteContext) => void | Promise<void>;
+    /**
+     * Called before the boards list page is rendered
+     * Return false to prevent rendering (e.g., for authorization)
+     * @param context - Route context
+     */
+    onBeforeBoardsPageRendered?: (context: RouteContext) => boolean;
+    /**
+     * Called before a single board page is rendered
+     * Return false to prevent rendering (e.g., for authorization)
+     * @param boardId - The board ID
+     * @param context - Route context
+     */
+    onBeforeBoardPageRendered?: (boardId: string, context: RouteContext) => boolean;
+    /**
+     * Called before the new board page is rendered
+     * Return false to prevent rendering (e.g., for authorization)
+     * @param context - Route context
+     */
+    onBeforeNewBoardPageRendered?: (context: RouteContext) => boolean;
+}
+
+export type { KanbanPluginOverrides as K, KanbanUser as a };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@btst/stack",
-  "version": "1.11.0",
+  "version": "2.0.0",
   "description": "A composable, plugin-based library for building full-stack applications.",
   "repository": {
     "type": "git",
@@ -298,6 +298,47 @@
         "default": "./dist/plugins/open-api/api/index.cjs"
       }
     },
+    "./plugins/kanban/api": {
+      "import": {
+        "types": "./dist/plugins/kanban/api/index.d.ts",
+        "default": "./dist/plugins/kanban/api/index.mjs"
+      },
+      "require": {
+        "types": "./dist/plugins/kanban/api/index.d.cts",
+        "default": "./dist/plugins/kanban/api/index.cjs"
+      }
+    },
+    "./plugins/kanban/client": {
+      "import": {
+        "types": "./dist/plugins/kanban/client/index.d.ts",
+        "default": "./dist/plugins/kanban/client/index.mjs"
+      },
+      "require": {
+        "types": "./dist/plugins/kanban/client/index.d.cts",
+        "default": "./dist/plugins/kanban/client/index.cjs"
+      }
+    },
+    "./plugins/kanban/client/components": {
+      "import": {
+        "types": "./dist/plugins/kanban/client/components/index.d.ts",
+        "default": "./dist/plugins/kanban/client/components/index.mjs"
+      },
+      "require": {
+        "types": "./dist/plugins/kanban/client/components/index.d.cts",
+        "default": "./dist/plugins/kanban/client/components/index.cjs"
+      }
+    },
+    "./plugins/kanban/client/hooks": {
+      "import": {
+        "types": "./dist/plugins/kanban/client/hooks/index.d.ts",
+        "default": "./dist/plugins/kanban/client/hooks/index.mjs"
+      },
+      "require": {
+        "types": "./dist/plugins/kanban/client/hooks/index.d.cts",
+        "default": "./dist/plugins/kanban/client/hooks/index.cjs"
+      }
+    },
+    "./plugins/kanban/css": "./dist/plugins/kanban/style.css",
     "./plugins/route-docs/client": {
       "import": {
         "types": "./dist/plugins/route-docs/client/index.d.ts",
@@ -390,6 +431,18 @@
       "plugins/open-api/api": [
         "./dist/plugins/open-api/api/index.d.ts"
       ],
+      "plugins/kanban/api": [
+        "./dist/plugins/kanban/api/index.d.ts"
+      ],
+      "plugins/kanban/client": [
+        "./dist/plugins/kanban/client/index.d.ts"
+      ],
+      "plugins/kanban/client/components": [
+        "./dist/plugins/kanban/client/components/index.d.ts"
+      ],
+      "plugins/kanban/client/hooks": [
+        "./dist/plugins/kanban/client/hooks/index.d.ts"
+      ],
       "plugins/route-docs/client": [
         "./dist/plugins/route-docs/client/index.d.ts"
       ]
@@ -426,7 +479,7 @@
     "react-error-boundary": ">=4.0.0",
     "react-hook-form": ">=7.55.0",
     "react-intersection-observer": ">=9.0.0",
-    "react-markdown": ">=10.1.0",
+    "react-markdown": ">=9.1.0",
     "rehype-highlight": ">=7.0.0",
     "rehype-katex": ">=7.0.0",
     "rehype-raw": ">=7.0.0",
@@ -435,6 +488,7 @@
     "sonner": ">=2.0.0",
     "tailwind-merge": ">=2.6.0",
     "tailwindcss": ">=3.0.0",
+    "@tailwindcss/typography": ">=0.5.0",
     "zod": ">=4.2.0"
   },
   "devDependencies": {

package/src/__tests__/plugins.test.tsx

@@ -1,5 +1,5 @@
 import { describe, it, expect } from "vitest";
-import { betterStack } from "../api";
+import { stack } from "../api";
 import { createStackClient } from "../client";
 import { defineBackendPlugin } from "../plugins/api";
 import { defineClientPlugin } from "../plugins/client";
@@ -50,7 +50,7 @@ const messagesSchema: BetterAuthDBSchema = {
 
 /**
  * Test backend plugin - Messages
- * Demonstrates how to build a 3rd party plugin using Better Stack
+ * Demonstrates how to build a 3rd party plugin using BTST
  * Now using defineBackendPlugin for full type inference - no casts needed!
  */
 const messagesBackendPlugin = defineBackendPlugin({
@@ -164,7 +164,7 @@ const messagesClientPlugin = defineClientPlugin({
 describe("3rd Party Plugin Support", () => {
 	describe("Backend Plugin", () => {
 		it("should create backend with custom plugin", () => {
-			const backend = betterStack({
+			const backend = stack({
 				basePath: "/api",
 				plugins: {
 					messages: messagesBackendPlugin,
@@ -219,7 +219,7 @@ describe("3rd Party Plugin Support", () => {
 				}),
 			});
 
-			const backend = betterStack({
+			const backend = stack({
 				basePath: "/api",
 				plugins: {
 					messages: messagesBackendPlugin,
@@ -233,7 +233,7 @@ describe("3rd Party Plugin Support", () => {
 		});
 
 		it("should generate routes for custom plugin", () => {
-			const backend = betterStack({
+			const backend = stack({
 				basePath: "/api",
 				plugins: {
 					messages: messagesBackendPlugin,
@@ -248,7 +248,7 @@ describe("3rd Party Plugin Support", () => {
 		});
 
 		it("should include plugin schema in database", () => {
-			const backend = betterStack({
+			const backend = stack({
 				basePath: "/api",
 				plugins: {
 					messages: messagesBackendPlugin,
@@ -421,7 +421,7 @@ describe("3rd Party Plugin Support", () => {
 		it("should use backend and client plugins independently", () => {
 			// Backend and client plugins are completely separate
 			// This prevents SSR issues and enables better code splitting
-			const backend = betterStack({
+			const backend = stack({
 				basePath: "/api",
 				plugins: {
 					messages: messagesBackendPlugin,

package/src/api/index.ts

@@ -3,7 +3,7 @@ import type {
 	BackendLibConfig,
 	BackendLib,
 	PrefixedPluginRoutes,
-	BetterStackContext,
+	StackContext,
 } from "../types";
 import { defineDb } from "@btst/db";
 
@@ -14,7 +14,7 @@ export { toNodeHandler } from "better-call/node";
  *
  * @example
  * ```ts
- * const api = betterStack({
+ * const api = stack({
  *   plugins: {
  *     messages: messagesPlugin.backend
  *   },
@@ -29,7 +29,7 @@ export { toNodeHandler } from "better-call/node";
  * @template TPlugins - The exact plugins map (inferred from config)
  * @template TRoutes - All routes with prefixed keys like "pluginName_routeName" (computed automatically)
  */
-export function betterStack<
+export function stack<
 	TPlugins extends Record<string, any>,
 	TRoutes extends
 		PrefixedPluginRoutes<TPlugins> = PrefixedPluginRoutes<TPlugins>,
@@ -50,7 +50,7 @@ export function betterStack<
 	const adapterInstance = adapter(betterDbSchema);
 
 	// Create context for plugins that need access to all plugins (e.g., openAPI)
-	const context: BetterStackContext = {
+	const context: StackContext = {
 		plugins,
 		basePath,
 		adapter: adapterInstance,
@@ -83,5 +83,5 @@ export type {
 	BackendPlugin,
 	BackendLibConfig,
 	BackendLib,
-	BetterStackContext,
+	StackContext,
 } from "../types";