@btst/stack 3.0.0-rc.2 → 3.0.0-rc.4

package/src/__tests__/stack-constructors.test.ts

@@ -0,0 +1,96 @@
+import { createMemoryAdapter } from "@btst/adapter-memory";
+import { createDbPlugin, type DatabaseDefinition } from "@btst/db";
+import { QueryClient } from "@tanstack/react-query";
+import { createRoute } from "@btst/yar";
+import { describe, expect, it } from "vitest";
+import { z } from "zod";
+import { createBackendStack } from "../api";
+import { definePermissions, permission } from "../authorization";
+import { createClientStack } from "../client";
+import {
+	createEndpoint,
+	defineBackendPlugin,
+	defineOperation,
+} from "../plugins/api";
+import { defineClientPlugin } from "../plugins/client";
+
+const adapter = (db: DatabaseDefinition) => createMemoryAdapter(db)({});
+const probePermissions = definePermissions("probe", {
+	echo: permission(z.object({ value: z.string() })),
+});
+const probeOperation = defineOperation({
+	access: "public",
+	input: z.object({ value: z.string() }),
+	permission: probePermissions.echo,
+	facts: ({ input }) => ({ value: input.value }),
+	execute: ({ input }) => ({ value: input.value }),
+});
+const backendPlugin = defineBackendPlugin({
+	id: "probe",
+	dbPlugin: createDbPlugin("probe", {}),
+	operations: () => ({ echo: probeOperation }),
+	routes: (_adapter, _context, operations) => ({
+		echo: createEndpoint(
+			"/echo/:value",
+			{ method: "GET", requireRequest: true },
+			operations.echo.route((context) => ({ value: context.params.value })),
+		),
+	}),
+});
+const clientPlugin = defineClientPlugin({
+	id: "probe",
+	resolve: () => ({
+		routes: () => ({
+			probe: createRoute("/probe", () => ({
+				PageComponent: () => null,
+			})),
+		}),
+		sitemap: () => [{ url: "https://example.com/probe" }],
+	}),
+});
+
+describe("canonical stack constructors", () => {
+	it("preserves backend routes and operation surfaces", async () => {
+		const backend = createBackendStack({
+			basePath: "/api",
+			plugins: { probe: backendPlugin },
+			adapter,
+		});
+
+		const endpointNames = Object.keys(
+			(backend.router as unknown as { endpoints: Record<string, unknown> })
+				.endpoints,
+		);
+		expect(endpointNames).toContain("probe_echo");
+		await expect(
+			backend.trusted.probe.echo({ value: "trusted" }),
+		).resolves.toEqual({ value: "trusted" });
+		await expect(
+			backend
+				.forRequest(new Request("https://example.com/api"))
+				.operations.probe.echo({ value: "request" }),
+		).resolves.toEqual({ value: "request" });
+
+		const response = await backend.handler(
+			new Request("https://example.com/api/echo/handler"),
+		);
+		expect(response.status).toBe(200);
+		expect(await response.json()).toEqual({ value: "handler" });
+	});
+
+	it("preserves client routes and sitemap behavior", async () => {
+		const client = createClientStack({
+			api: { baseURL: "https://example.com", basePath: "/api" },
+			site: { baseURL: "https://example.com", basePath: "/pages" },
+			queryClient: new QueryClient(),
+			plugins: { probe: clientPlugin },
+		});
+
+		expect(typeof client.router.getRoute("/probe")?.PageComponent).toBe(
+			"function",
+		);
+		await expect(client.generateSitemap()).resolves.toEqual([
+			{ url: "https://example.com/probe" },
+		]);
+	});
+});

package/src/__tests__/stack-constructors.typecheck.ts

@@ -0,0 +1,115 @@
+import {
+	createDbPlugin,
+	type DatabaseDefinition,
+	type DBAdapter,
+} from "@btst/db";
+import { QueryClient } from "@tanstack/react-query";
+import { createRoute } from "@btst/yar";
+import { z } from "zod";
+import { createBackendStack, type BackendStackConfig } from "../api";
+import {
+	defineAuthorization,
+	definePermissions,
+	permission,
+} from "../authorization";
+import { createServerAuth } from "../authorization/server";
+import { createClientStack, type ClientStackConfig } from "../client";
+import {
+	createEndpoint,
+	defineBackendPlugin,
+	defineOperation,
+} from "../plugins/api";
+import { defineClientPlugin } from "../plugins/client";
+
+type Equal<TLeft, TRight> = (<T>() => T extends TLeft ? 1 : 2) extends <
+	T,
+>() => T extends TRight ? 1 : 2
+	? true
+	: false;
+type Expect<T extends true> = T;
+
+const permissions = definePermissions("constructorProbe", {
+	read: permission(z.object({ id: z.string() })),
+});
+const authorization = defineAuthorization({
+	identity: z.object({ id: z.string() }),
+	permissions: [permissions] as const,
+	rules: ({ constructorProbe }) => [constructorProbe.read.allow()],
+});
+const serverAuth = createServerAuth({
+	authorization,
+	getIdentity: () => ({ id: "user-1" }),
+});
+const read = defineOperation({
+	input: z.object({ id: z.string() }),
+	permission: permissions.read,
+	facts: ({ input }) => ({ id: input.id }),
+	execute: ({ input }) => ({ id: input.id }),
+});
+const backendPlugin = defineBackendPlugin({
+	id: "constructorProbe",
+	dbPlugin: createDbPlugin("constructorProbe", {}),
+	operations: () => ({ read }),
+	routes: (_adapter, _context, operations) => ({
+		read: createEndpoint(
+			"/constructor-probe/:id",
+			{ method: "GET", requireRequest: true },
+			operations.read.route((context) => ({ id: context.params.id })),
+		),
+	}),
+});
+const backendConfig = {
+	basePath: "/api",
+	plugins: { constructorProbe: backendPlugin },
+	adapter: (_db: DatabaseDefinition) => null as unknown as DBAdapter,
+	auth: serverAuth,
+} satisfies BackendStackConfig<
+	{ constructorProbe: typeof backendPlugin },
+	typeof serverAuth
+>;
+
+const backend = createBackendStack(backendConfig);
+type _BackendRouteKeys = Expect<
+	Equal<keyof typeof backend.router.endpoints, "constructorProbe_read">
+>;
+backend.trusted.constructorProbe.read({ id: "record-1" });
+backend
+	.forRequest(new Request("https://example.com/api"))
+	.operations.constructorProbe.read({ id: "record-1" });
+
+const unrelatedPermissions = definePermissions("unrelated", {
+	read: permission(),
+});
+const incompatibleAuth = createServerAuth({
+	authorization: defineAuthorization({
+		identity: z.object({ id: z.string() }),
+		permissions: [unrelatedPermissions] as const,
+		rules: ({ unrelated }) => [unrelated.read.allow()],
+	}),
+	getIdentity: () => ({ id: "user-1" }),
+});
+createBackendStack({
+	...backendConfig,
+	// @ts-expect-error canonical constructor rejects incompatible authorization catalogs
+	auth: incompatibleAuth,
+});
+
+const clientPlugin = defineClientPlugin({
+	id: "constructorProbe",
+	resolve: () => ({
+		routes: () => ({
+			read: createRoute("/constructor-probe/:id", ({ params }) => ({
+				PageComponent: () => null,
+				loader: async () => ({ recordId: params.id }),
+			})),
+		}),
+	}),
+});
+const clientConfig = {
+	api: { baseURL: "https://example.com", basePath: "/api" },
+	site: { baseURL: "https://example.com", basePath: "/pages" },
+	queryClient: new QueryClient(),
+	plugins: { constructorProbe: clientPlugin },
+} satisfies ClientStackConfig<{ constructorProbe: typeof clientPlugin }>;
+const client = createClientStack(clientConfig);
+client.router.getRoute("/constructor-probe/record-1")?.loader?.();

package/src/__tests__/use-list-state.test.tsx

@@ -4,6 +4,7 @@ import { createRoot, type Root } from "react-dom/client";
 import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
 import { useListState } from "../client/hooks/use-list-state";
 import { StackProvider } from "../context";
+import { createEmptyTestClientStack } from "./client-stack-test-utils";
 
 (globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
 
@@ -54,7 +55,7 @@ describe("useListState", () => {
 		}
 		await act(async () => {
 			root.render(
-				<StackProvider basePath="/pages" router={router}>
+				<StackProvider stack={createEmptyTestClientStack()} router={router}>
 					<Probe />
 				</StackProvider>,
 			);
@@ -167,7 +168,7 @@ describe("useListState", () => {
 
 		await act(async () => {
 			root.render(
-				<StackProvider basePath="/pages" router={router}>
+				<StackProvider stack={createEmptyTestClientStack()} router={router}>
 					<ProbeA />
 					<ProbeB />
 				</StackProvider>,
@@ -206,7 +207,7 @@ describe("useListState", () => {
 
 		await act(async () => {
 			root.render(
-				<StackProvider basePath="/pages" router={router}>
+				<StackProvider stack={createEmptyTestClientStack()} router={router}>
 					<ProbeA />
 					<ProbeB />
 				</StackProvider>,
@@ -235,7 +236,7 @@ describe("useListState", () => {
 		}
 		await act(async () => {
 			root.render(
-				<StackProvider basePath="/pages" router={router}>
+				<StackProvider stack={createEmptyTestClientStack()} router={router}>
 					<Probe />
 				</StackProvider>,
 			);
@@ -273,7 +274,7 @@ describe("useListState", () => {
 		// StackProvider without getSearchParams/setSearchParams on the router.
 		await act(async () => {
 			root.render(
-				<StackProvider basePath="/pages" router={{}}>
+				<StackProvider stack={createEmptyTestClientStack()} router={{}}>
 					<Probe />
 				</StackProvider>,
 			);
@@ -307,7 +308,7 @@ describe("useListState", () => {
 		}
 		await act(async () => {
 			root.render(
-				<StackProvider basePath="/pages" router={router}>
+				<StackProvider stack={createEmptyTestClientStack()} router={router}>
 					<Probe />
 				</StackProvider>,
 			);

package/src/__tests__/workflow-lifecycle-migrations.typecheck.ts

@@ -0,0 +1,150 @@
+import type { FormBuilderBackendHooks } from "../plugins/form-builder/api";
+import type { KanbanBackendHooks } from "../plugins/kanban/api";
+import type { MediaBackendHooks } from "../plugins/media/api";
+
+const formBuilderHooks = {
+	onBeforeListForms: async () => undefined,
+	onBeforeGetForm: async () => undefined,
+	onBeforeGetFormForUpdate: async () => undefined,
+	onBeforeCreateForm: async () => undefined,
+	onAfterCreateForm: async () => undefined,
+	onBeforeUpdateForm: async () => undefined,
+	onAfterUpdateForm: async () => undefined,
+	onBeforeDeleteForm: async () => undefined,
+	onAfterDeleteForm: async () => undefined,
+	onBeforeSubmission: async () => undefined,
+	onAfterSubmission: async () => undefined,
+	onErrorSubmission: async () => undefined,
+	onBeforeListSubmissions: async () => undefined,
+	onBeforeGetSubmission: async () => undefined,
+	onBeforeDeleteSubmission: async () => undefined,
+	onAfterDeleteSubmission: async () => undefined,
+	onError: async () => undefined,
+} satisfies FormBuilderBackendHooks;
+
+const kanbanHooks = {
+	onBeforeListBoards: async () => undefined,
+	onAfterListBoards: async () => undefined,
+	onErrorListBoards: async () => undefined,
+	onBeforeGetBoard: async () => undefined,
+	onAfterGetBoard: async () => undefined,
+	onErrorGetBoard: async () => undefined,
+	onBeforeCreateBoard: async () => undefined,
+	onAfterCreateBoard: async () => undefined,
+	onErrorCreateBoard: async () => undefined,
+	onBeforeUpdateBoard: async () => undefined,
+	onAfterUpdateBoard: async () => undefined,
+	onErrorUpdateBoard: async () => undefined,
+	onBeforeDeleteBoard: async () => undefined,
+	onAfterDeleteBoard: async () => undefined,
+	onErrorDeleteBoard: async () => undefined,
+	onBeforeCreateColumn: async () => undefined,
+	onAfterCreateColumn: async () => undefined,
+	onBeforeUpdateColumn: async () => undefined,
+	onAfterUpdateColumn: async () => undefined,
+	onBeforeDeleteColumn: async () => undefined,
+	onAfterDeleteColumn: async () => undefined,
+	onBeforeCreateTask: async () => undefined,
+	onAfterCreateTask: async () => undefined,
+	onBeforeUpdateTask: async () => undefined,
+	onAfterUpdateTask: async () => undefined,
+	onBeforeDeleteTask: async () => undefined,
+	onAfterDeleteTask: async () => undefined,
+} satisfies KanbanBackendHooks;
+
+const mediaHooks = {
+	onBeforeUpload: async () => undefined,
+	onAfterUpload: async () => undefined,
+	onBeforeDeleteAsset: async () => undefined,
+	onAfterDeleteAsset: async () => undefined,
+	onBeforeListAssets: async () => undefined,
+	onBeforeUpdateAsset: async () => undefined,
+	onBeforeListFolders: async () => undefined,
+	onBeforeCreateFolder: async () => undefined,
+	onBeforeDeleteFolder: async () => undefined,
+	onError: async () => undefined,
+} satisfies MediaBackendHooks;
+
+void formBuilderHooks;
+void kanbanHooks;
+void mediaHooks;
+
+// Explicit migration fixtures: every removed spelling must stay rejected.
+({
+	// @ts-expect-error Use onBeforeCreateForm.
+	onBeforeFormCreated: async () => undefined,
+}) satisfies FormBuilderBackendHooks;
+({
+	// @ts-expect-error Use onAfterCreateForm.
+	onAfterFormCreated: async () => undefined,
+}) satisfies FormBuilderBackendHooks;
+({
+	// @ts-expect-error Use onBeforeUpdateForm.
+	onBeforeFormUpdated: async () => undefined,
+}) satisfies FormBuilderBackendHooks;
+({
+	// @ts-expect-error Use onAfterUpdateForm.
+	onAfterFormUpdated: async () => undefined,
+}) satisfies FormBuilderBackendHooks;
+({
+	// @ts-expect-error Use onBeforeDeleteForm.
+	onBeforeFormDeleted: async () => undefined,
+}) satisfies FormBuilderBackendHooks;
+({
+	// @ts-expect-error Use onAfterDeleteForm.
+	onAfterFormDeleted: async () => undefined,
+}) satisfies FormBuilderBackendHooks;
+({
+	// @ts-expect-error Use onErrorSubmission.
+	onSubmissionError: async () => undefined,
+}) satisfies FormBuilderBackendHooks;
+({
+	// @ts-expect-error Use onBeforeDeleteSubmission.
+	onBeforeSubmissionDeleted: async () => undefined,
+}) satisfies FormBuilderBackendHooks;
+({
+	// @ts-expect-error Use onAfterDeleteSubmission.
+	onAfterSubmissionDeleted: async () => undefined,
+}) satisfies FormBuilderBackendHooks;
+
+// @ts-expect-error Use onBeforeGetBoard.
+({ onBeforeReadBoard: async () => undefined }) satisfies KanbanBackendHooks;
+// @ts-expect-error Use onAfterListBoards.
+({ onBoardsRead: async () => undefined }) satisfies KanbanBackendHooks;
+// @ts-expect-error Use onAfterGetBoard.
+({ onBoardRead: async () => undefined }) satisfies KanbanBackendHooks;
+// @ts-expect-error Use onAfterCreateBoard.
+({ onBoardCreated: async () => undefined }) satisfies KanbanBackendHooks;
+// @ts-expect-error Use onAfterUpdateBoard.
+({ onBoardUpdated: async () => undefined }) satisfies KanbanBackendHooks;
+// @ts-expect-error Use onAfterDeleteBoard.
+({ onBoardDeleted: async () => undefined }) satisfies KanbanBackendHooks;
+// @ts-expect-error Use onErrorListBoards.
+({ onListBoardsError: async () => undefined }) satisfies KanbanBackendHooks;
+// @ts-expect-error Use onErrorGetBoard.
+({ onReadBoardError: async () => undefined }) satisfies KanbanBackendHooks;
+// @ts-expect-error Use onErrorCreateBoard.
+({ onCreateBoardError: async () => undefined }) satisfies KanbanBackendHooks;
+// @ts-expect-error Use onErrorUpdateBoard.
+({ onUpdateBoardError: async () => undefined }) satisfies KanbanBackendHooks;
+// @ts-expect-error Use onErrorDeleteBoard.
+({ onDeleteBoardError: async () => undefined }) satisfies KanbanBackendHooks;
+// @ts-expect-error Use onAfterCreateColumn.
+({ onColumnCreated: async () => undefined }) satisfies KanbanBackendHooks;
+// @ts-expect-error Use onAfterUpdateColumn.
+({ onColumnUpdated: async () => undefined }) satisfies KanbanBackendHooks;
+// @ts-expect-error Use onAfterDeleteColumn.
+({ onColumnDeleted: async () => undefined }) satisfies KanbanBackendHooks;
+// @ts-expect-error Use onAfterCreateTask.
+({ onTaskCreated: async () => undefined }) satisfies KanbanBackendHooks;
+// @ts-expect-error Use onAfterUpdateTask.
+({ onTaskUpdated: async () => undefined }) satisfies KanbanBackendHooks;
+// @ts-expect-error Use onAfterDeleteTask.
+({ onTaskDeleted: async () => undefined }) satisfies KanbanBackendHooks;
+
+// @ts-expect-error Use onBeforeDeleteAsset.
+({ onBeforeDelete: async () => undefined }) satisfies MediaBackendHooks;
+// @ts-expect-error Use onAfterDeleteAsset.
+({ onAfterDelete: async () => undefined }) satisfies MediaBackendHooks;
+// @ts-expect-error Use onError.
+({ onOperationError: async () => undefined }) satisfies MediaBackendHooks;