@btst/stack 2.3.0 → 2.5.0

package/src/plugins/kanban/api/plugin.ts

@@ -24,7 +24,13 @@ import {
 	updateTaskSchema,
 } from "../schemas";
 import { getAllBoards, getBoardById } from "./getters";
+import {
+	createKanbanTask,
+	findOrCreateKanbanBoard,
+	getKanbanColumnsByBoardId,
+} from "./mutations";
 import { KANBAN_QUERY_KEYS } from "./query-key-defs";
+import { runHookWithShim } from "../../utils";
 import { serializeBoard } from "./serializers";
 import type { QueryClient } from "@tanstack/react-query";
 
@@ -96,41 +102,41 @@ export interface KanbanApiContext<
 export interface KanbanBackendHooks {
 	// ============ Board Hooks ============
 	/**
-	 * Called before listing boards. Return false to deny access.
+	 * Called before listing boards. Throw an error to deny access.
 	 */
 	onBeforeListBoards?: (
 		filter: z.infer<typeof BoardListQuerySchema>,
 		context: KanbanApiContext,
-	) => Promise<boolean> | boolean;
+	) => Promise<void> | void;
 	/**
-	 * Called before creating a board. Return false to deny access.
+	 * Called before creating a board. Throw an error to deny access.
 	 */
 	onBeforeCreateBoard?: (
 		data: z.infer<typeof createBoardSchema>,
 		context: KanbanApiContext,
-	) => Promise<boolean> | boolean;
+	) => Promise<void> | void;
 	/**
-	 * Called before reading a single board. Return false to deny access.
+	 * Called before reading a single board. Throw an error to deny access.
 	 */
 	onBeforeReadBoard?: (
 		boardId: string,
 		context: KanbanApiContext,
-	) => Promise<boolean> | boolean;
+	) => Promise<void> | void;
 	/**
-	 * Called before updating a board. Return false to deny access.
+	 * Called before updating a board. Throw an error to deny access.
 	 */
 	onBeforeUpdateBoard?: (
 		boardId: string,
 		data: z.infer<typeof updateBoardSchema>,
 		context: KanbanApiContext,
-	) => Promise<boolean> | boolean;
+	) => Promise<void> | void;
 	/**
-	 * Called before deleting a board. Return false to deny access.
+	 * Called before deleting a board. Throw an error to deny access.
 	 */
 	onBeforeDeleteBoard?: (
 		boardId: string,
 		context: KanbanApiContext,
-	) => Promise<boolean> | boolean;
+	) => Promise<void> | void;
 
 	/**
 	 * Called after boards are listed successfully.
@@ -209,27 +215,27 @@ export interface KanbanBackendHooks {
 
 	// ============ Column Hooks ============
 	/**
-	 * Called before creating a column. Return false to deny access.
+	 * Called before creating a column. Throw an error to deny access.
 	 */
 	onBeforeCreateColumn?: (
 		data: z.infer<typeof createColumnSchema>,
 		context: KanbanApiContext,
-	) => Promise<boolean> | boolean;
+	) => Promise<void> | void;
 	/**
-	 * Called before updating a column. Return false to deny access.
+	 * Called before updating a column. Throw an error to deny access.
 	 */
 	onBeforeUpdateColumn?: (
 		columnId: string,
 		data: z.infer<typeof updateColumnSchema>,
 		context: KanbanApiContext,
-	) => Promise<boolean> | boolean;
+	) => Promise<void> | void;
 	/**
-	 * Called before deleting a column. Return false to deny access.
+	 * Called before deleting a column. Throw an error to deny access.
 	 */
 	onBeforeDeleteColumn?: (
 		columnId: string,
 		context: KanbanApiContext,
-	) => Promise<boolean> | boolean;
+	) => Promise<void> | void;
 
 	/**
 	 * Called after a column is created successfully
@@ -255,27 +261,27 @@ export interface KanbanBackendHooks {
 
 	// ============ Task Hooks ============
 	/**
-	 * Called before creating a task. Return false to deny access.
+	 * Called before creating a task. Throw an error to deny access.
 	 */
 	onBeforeCreateTask?: (
 		data: z.infer<typeof createTaskSchema>,
 		context: KanbanApiContext,
-	) => Promise<boolean> | boolean;
+	) => Promise<void> | void;
 	/**
-	 * Called before updating a task. Return false to deny access.
+	 * Called before updating a task. Throw an error to deny access.
 	 */
 	onBeforeUpdateTask?: (
 		taskId: string,
 		data: z.infer<typeof updateTaskSchema>,
 		context: KanbanApiContext,
-	) => Promise<boolean> | boolean;
+	) => Promise<void> | void;
 	/**
-	 * Called before deleting a task. Return false to deny access.
+	 * Called before deleting a task. Throw an error to deny access.
 	 */
 	onBeforeDeleteTask?: (
 		taskId: string,
 		context: KanbanApiContext,
-	) => Promise<boolean> | boolean;
+	) => Promise<void> | void;
 
 	/**
 	 * Called after a task is created successfully
@@ -317,6 +323,13 @@ export const kanbanBackendPlugin = (hooks?: KanbanBackendHooks) =>
 				getAllBoards(adapter, params),
 			getBoardById: (id: string) => getBoardById(adapter, id),
 			prefetchForRoute: createKanbanPrefetchForRoute(adapter),
+			// Mutations
+			createTask: (input: Parameters<typeof createKanbanTask>[1]) =>
+				createKanbanTask(adapter, input),
+			findOrCreateBoard: (slug: string, name: string, columnTitles: string[]) =>
+				findOrCreateKanbanBoard(adapter, slug, name, columnTitles),
+			getColumnsByBoardId: (boardId: string) =>
+				getKanbanColumnsByBoardId(adapter, boardId),
 		}),
 
 		routes: (adapter: Adapter) => {
@@ -334,12 +347,11 @@ export const kanbanBackendPlugin = (hooks?: KanbanBackendHooks) =>
 
 					try {
 						if (hooks?.onBeforeListBoards) {
-							const canList = await hooks.onBeforeListBoards(query, context);
-							if (!canList) {
-								throw ctx.error(403, {
-									message: "Unauthorized: Cannot list boards",
-								});
-							}
+							await runHookWithShim(
+								() => hooks.onBeforeListBoards!(query, context),
+								ctx.error,
+								"Unauthorized: Cannot list boards",
+							);
 						}
 
 						const result = await getAllBoards(adapter, query);
@@ -369,12 +381,11 @@ export const kanbanBackendPlugin = (hooks?: KanbanBackendHooks) =>
 
 					try {
 						if (hooks?.onBeforeReadBoard) {
-							const canRead = await hooks.onBeforeReadBoard(params.id, context);
-							if (!canRead) {
-								throw ctx.error(403, {
-									message: "Unauthorized: Cannot read board",
-								});
-							}
+							await runHookWithShim(
+								() => hooks.onBeforeReadBoard!(params.id, context),
+								ctx.error,
+								"Unauthorized: Cannot read board",
+							);
 						}
 
 						const result = await getBoardById(adapter, params.id);
@@ -411,15 +422,11 @@ export const kanbanBackendPlugin = (hooks?: KanbanBackendHooks) =>
 
 					try {
 						if (hooks?.onBeforeCreateBoard) {
-							const canCreate = await hooks.onBeforeCreateBoard(
-								ctx.body,
-								context,
+							await runHookWithShim(
+								() => hooks.onBeforeCreateBoard!(ctx.body, context),
+								ctx.error,
+								"Unauthorized: Cannot create board",
 							);
-							if (!canCreate) {
-								throw ctx.error(403, {
-									message: "Unauthorized: Cannot create board",
-								});
-							}
 						}
 
 						const { ...boardData } = ctx.body;
@@ -504,16 +511,16 @@ export const kanbanBackendPlugin = (hooks?: KanbanBackendHooks) =>
 
 					try {
 						if (hooks?.onBeforeUpdateBoard) {
-							const canUpdate = await hooks.onBeforeUpdateBoard(
-								ctx.params.id,
-								{ ...ctx.body, id: ctx.params.id },
-								context,
+							await runHookWithShim(
+								() =>
+									hooks.onBeforeUpdateBoard!(
+										ctx.params.id,
+										{ ...ctx.body, id: ctx.params.id },
+										context,
+									),
+								ctx.error,
+								"Unauthorized: Cannot update board",
 							);
-							if (!canUpdate) {
-								throw ctx.error(403, {
-									message: "Unauthorized: Cannot update board",
-								});
-							}
 						}
 
 						const { slug: rawSlug, ...restBoardData } = ctx.body;
@@ -583,15 +590,11 @@ export const kanbanBackendPlugin = (hooks?: KanbanBackendHooks) =>
 						}
 
 						if (hooks?.onBeforeDeleteBoard) {
-							const canDelete = await hooks.onBeforeDeleteBoard(
-								ctx.params.id,
-								context,
+							await runHookWithShim(
+								() => hooks.onBeforeDeleteBoard!(ctx.params.id, context),
+								ctx.error,
+								"Unauthorized: Cannot delete board",
 							);
-							if (!canDelete) {
-								throw ctx.error(403, {
-									message: "Unauthorized: Cannot delete board",
-								});
-							}
 						}
 
 						await adapter.delete<Board>({
@@ -629,15 +632,11 @@ export const kanbanBackendPlugin = (hooks?: KanbanBackendHooks) =>
 
 					try {
 						if (hooks?.onBeforeCreateColumn) {
-							const canCreate = await hooks.onBeforeCreateColumn(
-								ctx.body,
-								context,
+							await runHookWithShim(
+								() => hooks.onBeforeCreateColumn!(ctx.body, context),
+								ctx.error,
+								"Unauthorized: Cannot create column",
 							);
-							if (!canCreate) {
-								throw ctx.error(403, {
-									message: "Unauthorized: Cannot create column",
-								});
-							}
 						}
 
 						// Get existing columns to determine order
@@ -692,16 +691,16 @@ export const kanbanBackendPlugin = (hooks?: KanbanBackendHooks) =>
 
 					try {
 						if (hooks?.onBeforeUpdateColumn) {
-							const canUpdate = await hooks.onBeforeUpdateColumn(
-								ctx.params.id,
-								{ ...ctx.body, id: ctx.params.id },
-								context,
+							await runHookWithShim(
+								() =>
+									hooks.onBeforeUpdateColumn!(
+										ctx.params.id,
+										{ ...ctx.body, id: ctx.params.id },
+										context,
+									),
+								ctx.error,
+								"Unauthorized: Cannot update column",
 							);
-							if (!canUpdate) {
-								throw ctx.error(403, {
-									message: "Unauthorized: Cannot update column",
-								});
-							}
 						}
 
 						const updated = await adapter.update<Column>({
@@ -753,15 +752,11 @@ export const kanbanBackendPlugin = (hooks?: KanbanBackendHooks) =>
 						}
 
 						if (hooks?.onBeforeDeleteColumn) {
-							const canDelete = await hooks.onBeforeDeleteColumn(
-								ctx.params.id,
-								context,
+							await runHookWithShim(
+								() => hooks.onBeforeDeleteColumn!(ctx.params.id, context),
+								ctx.error,
+								"Unauthorized: Cannot delete column",
 							);
-							if (!canDelete) {
-								throw ctx.error(403, {
-									message: "Unauthorized: Cannot delete column",
-								});
-							}
 						}
 
 						await adapter.delete<Column>({
@@ -798,16 +793,16 @@ export const kanbanBackendPlugin = (hooks?: KanbanBackendHooks) =>
 						for (let i = 0; i < columnIds.length; i++) {
 							const columnId = columnIds[i];
 							if (!columnId) continue;
-							const canUpdate = await hooks.onBeforeUpdateColumn(
-								columnId,
-								{ id: columnId, order: i },
-								context,
+							await runHookWithShim(
+								() =>
+									hooks.onBeforeUpdateColumn!(
+										columnId,
+										{ id: columnId, order: i },
+										context,
+									),
+								ctx.error,
+								"Unauthorized: Cannot reorder columns",
 							);
-							if (!canUpdate) {
-								throw ctx.error(403, {
-									message: "Unauthorized: Cannot reorder columns",
-								});
-							}
 						}
 					}
 
@@ -857,15 +852,11 @@ export const kanbanBackendPlugin = (hooks?: KanbanBackendHooks) =>
 
 					try {
 						if (hooks?.onBeforeCreateTask) {
-							const canCreate = await hooks.onBeforeCreateTask(
-								ctx.body,
-								context,
+							await runHookWithShim(
+								() => hooks.onBeforeCreateTask!(ctx.body, context),
+								ctx.error,
+								"Unauthorized: Cannot create task",
 							);
-							if (!canCreate) {
-								throw ctx.error(403, {
-									message: "Unauthorized: Cannot create task",
-								});
-							}
 						}
 
 						// Get existing tasks in column to determine order
@@ -927,16 +918,16 @@ export const kanbanBackendPlugin = (hooks?: KanbanBackendHooks) =>
 
 					try {
 						if (hooks?.onBeforeUpdateTask) {
-							const canUpdate = await hooks.onBeforeUpdateTask(
-								ctx.params.id,
-								{ ...ctx.body, id: ctx.params.id },
-								context,
+							await runHookWithShim(
+								() =>
+									hooks.onBeforeUpdateTask!(
+										ctx.params.id,
+										{ ...ctx.body, id: ctx.params.id },
+										context,
+									),
+								ctx.error,
+								"Unauthorized: Cannot update task",
 							);
-							if (!canUpdate) {
-								throw ctx.error(403, {
-									message: "Unauthorized: Cannot update task",
-								});
-							}
 						}
 
 						const updated = await adapter.update<Task>({
@@ -988,15 +979,11 @@ export const kanbanBackendPlugin = (hooks?: KanbanBackendHooks) =>
 						}
 
 						if (hooks?.onBeforeDeleteTask) {
-							const canDelete = await hooks.onBeforeDeleteTask(
-								ctx.params.id,
-								context,
+							await runHookWithShim(
+								() => hooks.onBeforeDeleteTask!(ctx.params.id, context),
+								ctx.error,
+								"Unauthorized: Cannot delete task",
 							);
-							if (!canDelete) {
-								throw ctx.error(403, {
-									message: "Unauthorized: Cannot delete task",
-								});
-							}
 						}
 
 						await adapter.delete<Task>({
@@ -1040,16 +1027,16 @@ export const kanbanBackendPlugin = (hooks?: KanbanBackendHooks) =>
 
 					// Check authorization before moving task
 					if (hooks?.onBeforeUpdateTask) {
-						const canUpdate = await hooks.onBeforeUpdateTask(
-							taskId,
-							{ id: taskId, columnId: targetColumnId, order: targetOrder },
-							context,
+						await runHookWithShim(
+							() =>
+								hooks.onBeforeUpdateTask!(
+									taskId,
+									{ id: taskId, columnId: targetColumnId, order: targetOrder },
+									context,
+								),
+							ctx.error,
+							"Unauthorized: Cannot move task",
 						);
-						if (!canUpdate) {
-							throw ctx.error(403, {
-								message: "Unauthorized: Cannot move task",
-							});
-						}
 					}
 
 					// Update task with new column and order
@@ -1093,16 +1080,16 @@ export const kanbanBackendPlugin = (hooks?: KanbanBackendHooks) =>
 						for (let i = 0; i < taskIds.length; i++) {
 							const taskId = taskIds[i];
 							if (!taskId) continue;
-							const canUpdate = await hooks.onBeforeUpdateTask(
-								taskId,
-								{ id: taskId, order: i },
-								context,
+							await runHookWithShim(
+								() =>
+									hooks.onBeforeUpdateTask!(
+										taskId,
+										{ id: taskId, order: i },
+										context,
+									),
+								ctx.error,
+								"Unauthorized: Cannot reorder tasks",
 							);
-							if (!canUpdate) {
-								throw ctx.error(403, {
-									message: "Unauthorized: Cannot reorder tasks",
-								});
-							}
 						}
 					}
 

package/src/plugins/kanban/client/hooks/kanban-hooks.tsx

@@ -85,6 +85,7 @@ export function useBoards(params?: {
 	return useQuery({
 		...queries.boards.list(params),
 		staleTime: 30_000,
+		refetchOnWindowFocus: true,
 	});
 }
 
@@ -102,6 +103,7 @@ export function useSuspenseBoards(params?: {
 	const result = useSuspenseQuery({
 		...queries.boards.list(params),
 		staleTime: 30_000,
+		refetchOnWindowFocus: true,
 	});
 
 	if (result.error && !result.isFetching) {
@@ -121,6 +123,7 @@ export function useBoard(boardId: string) {
 	return useQuery({
 		...queries.boards.detail(boardId),
 		staleTime: 30_000,
+		refetchOnWindowFocus: true,
 		enabled: !!boardId,
 	});
 }
@@ -135,6 +138,7 @@ export function useSuspenseBoard(boardId: string) {
 	const result = useSuspenseQuery({
 		...queries.boards.detail(boardId),
 		staleTime: 30_000,
+		refetchOnWindowFocus: true,
 	});
 
 	if (result.error && !result.isFetching) {

package/src/plugins/kanban/client/plugin.tsx

@@ -2,6 +2,7 @@ import {
 	defineClientPlugin,
 	createApiClient,
 	isConnectionError,
+	runClientHookWithShim,
 } from "@btst/stack/plugins/client";
 import { createRoute } from "@btst/yar";
 import type { QueryClient } from "@tanstack/react-query";
@@ -86,39 +87,39 @@ export interface KanbanClientConfig {
  */
 export interface KanbanClientHooks {
 	/**
-	 * Called before loading boards list. Return false to cancel loading.
+	 * Called before loading boards list. Throw an error to cancel loading.
 	 */
-	beforeLoadBoards?: (context: LoaderContext) => Promise<boolean> | boolean;
+	beforeLoadBoards?: (context: LoaderContext) => Promise<void> | void;
 	/**
-	 * Called after boards are loaded. Return false to cancel further processing.
+	 * Called after boards are loaded. Throw an error to cancel further processing.
 	 */
 	afterLoadBoards?: (
 		boards: SerializedBoardWithColumns[] | null,
 		context: LoaderContext,
-	) => Promise<boolean> | boolean;
+	) => Promise<void> | void;
 	/**
-	 * Called before loading a single board. Return false to cancel loading.
+	 * Called before loading a single board. Throw an error to cancel loading.
 	 */
 	beforeLoadBoard?: (
 		boardId: string,
 		context: LoaderContext,
-	) => Promise<boolean> | boolean;
+	) => Promise<void> | void;
 	/**
-	 * Called after a board is loaded. Return false to cancel further processing.
+	 * Called after a board is loaded. Throw an error to cancel further processing.
 	 */
 	afterLoadBoard?: (
 		board: SerializedBoardWithColumns | null,
 		boardId: string,
 		context: LoaderContext,
-	) => Promise<boolean> | boolean;
+	) => Promise<void> | void;
 	/**
-	 * Called before loading the new board page. Return false to cancel.
+	 * Called before loading the new board page. Throw an error to cancel.
 	 */
-	beforeLoadNewBoard?: (context: LoaderContext) => Promise<boolean> | boolean;
+	beforeLoadNewBoard?: (context: LoaderContext) => Promise<void> | void;
 	/**
-	 * Called after the new board page is loaded. Return false to cancel.
+	 * Called after the new board page is loaded. Throw an error to cancel.
 	 */
-	afterLoadNewBoard?: (context: LoaderContext) => Promise<boolean> | boolean;
+	afterLoadNewBoard?: (context: LoaderContext) => Promise<void> | void;
 	/**
 	 * Called when a loading error occurs
 	 */
@@ -141,10 +142,10 @@ function createBoardsLoader(config: KanbanClientConfig) {
 
 			try {
 				if (hooks?.beforeLoadBoards) {
-					const canLoad = await hooks.beforeLoadBoards(context);
-					if (!canLoad) {
-						throw new Error("Load prevented by beforeLoadBoards hook");
-					}
+					await runClientHookWithShim(
+						() => hooks.beforeLoadBoards!(context),
+						"Load prevented by beforeLoadBoards hook",
+					);
 				}
 
 				const client = createApiClient<KanbanApiRouter>({
@@ -161,13 +162,10 @@ function createBoardsLoader(config: KanbanClientConfig) {
 					const boards = queryClient.getQueryData<SerializedBoardWithColumns[]>(
 						listQuery.queryKey,
 					);
-					const canContinue = await hooks.afterLoadBoards(
-						boards || null,
-						context,
+					await runClientHookWithShim(
+						() => hooks.afterLoadBoards!(boards || null, context),
+						"Load prevented by afterLoadBoards hook",
 					);
-					if (canContinue === false) {
-						throw new Error("Load prevented by afterLoadBoards hook");
-					}
 				}
 
 				const queryState = queryClient.getQueryState(listQuery.queryKey);
@@ -210,10 +208,10 @@ function createBoardLoader(boardId: string, config: KanbanClientConfig) {
 
 			try {
 				if (hooks?.beforeLoadBoard) {
-					const canLoad = await hooks.beforeLoadBoard(boardId, context);
-					if (!canLoad) {
-						throw new Error("Load prevented by beforeLoadBoard hook");
-					}
+					await runClientHookWithShim(
+						() => hooks.beforeLoadBoard!(boardId, context),
+						"Load prevented by beforeLoadBoard hook",
+					);
 				}
 
 				const client = createApiClient<KanbanApiRouter>({
@@ -229,14 +227,10 @@ function createBoardLoader(boardId: string, config: KanbanClientConfig) {
 					const board = queryClient.getQueryData<SerializedBoardWithColumns>(
 						boardQuery.queryKey,
 					);
-					const canContinue = await hooks.afterLoadBoard(
-						board || null,
-						boardId,
-						context,
+					await runClientHookWithShim(
+						() => hooks.afterLoadBoard!(board || null, boardId, context),
+						"Load prevented by afterLoadBoard hook",
 					);
-					if (canContinue === false) {
-						throw new Error("Load prevented by afterLoadBoard hook");
-					}
 				}
 
 				const queryState = queryClient.getQueryState(boardQuery.queryKey);
@@ -278,17 +272,17 @@ function createNewBoardLoader(config: KanbanClientConfig) {
 
 			try {
 				if (hooks?.beforeLoadNewBoard) {
-					const canLoad = await hooks.beforeLoadNewBoard(context);
-					if (!canLoad) {
-						throw new Error("Load prevented by beforeLoadNewBoard hook");
-					}
+					await runClientHookWithShim(
+						() => hooks.beforeLoadNewBoard!(context),
+						"Load prevented by beforeLoadNewBoard hook",
+					);
 				}
 
 				if (hooks?.afterLoadNewBoard) {
-					const canContinue = await hooks.afterLoadNewBoard(context);
-					if (canContinue === false) {
-						throw new Error("Load prevented by afterLoadNewBoard hook");
-					}
+					await runClientHookWithShim(
+						() => hooks.afterLoadNewBoard!(context),
+						"Load prevented by afterLoadNewBoard hook",
+					);
 				}
 			} catch (error) {
 				if (hooks?.onLoadError) {