improved nextjs/remix adapters and docs, confirmed remix ssr working

app/package.json

@@ -72,6 +72,7 @@
     "@hono/vite-dev-server": "^0.17.0",
     "@tanstack/react-query-devtools": "^5.59.16",
     "@types/diff": "^5.2.3",
+    "@types/node": "^22.10.0",
     "@types/react": "^18.3.12",
     "@types/react-dom": "^18.3.1",
     "@vitejs/plugin-react": "^4.3.3",
@@ -96,7 +97,7 @@
     "metafile": true,
     "platform": "browser",
     "format": ["esm", "cjs"],
-    "splitting": false,
+    "splitting": true,
     "loader": {
       ".svg": "dataurl"
     }

app/src/Api.ts

@@ -5,17 +5,19 @@ import { omit } from "lodash-es";
 import { MediaApi } from "media/api/MediaApi";
 import { SystemApi } from "modules/SystemApi";
 
+export type TApiUser = object;
+
 declare global {
    interface Window {
       __BKND__: {
-         user?: any;
+         user?: TApiUser;
       };
    }
 }
 
 export type ApiOptions = {
    host: string;
-   user?: object;
+   user?: TApiUser;
    token?: string;
    headers?: Headers;
    key?: string;
@@ -24,7 +26,7 @@ export type ApiOptions = {
 
 export class Api {
    private token?: string;
-   private user?: object;
+   private user?: TApiUser;
    private verified = false;
    private token_transport: "header" | "cookie" | "none" = "header";
 
@@ -111,6 +113,10 @@ export class Api {
       };
    }
 
+   getUser(): TApiUser | null {
+      return this.user || null;
+   }
+
    private buildApis() {
       const baseParams = {
          host: this.options.host,

app/src/adapter/cloudflare/cloudflare-workers.adapter.ts

@@ -5,8 +5,6 @@ import { serveStatic } from "hono/cloudflare-workers";
 import type { BkndConfig, CfBkndModeCache } from "../index";
 
 // @ts-ignore
-//import manifest from "__STATIC_CONTENT_MANIFEST";
-
 import _html from "../../static/index.html";
 
 type Context = {

app/src/adapter/index.ts

@@ -1,3 +1,4 @@
+import type { IncomingMessage } from "node:http";
 import type { App, CreateAppConfig } from "bknd";
 
 export type CfBkndModeCache<Env = any> = (env: Env) => {
@@ -35,3 +36,27 @@ export type BkndConfigJson = {
       port?: number;
    };
 };
+
+export function nodeRequestToRequest(req: IncomingMessage): Request {
+   let protocol = "http";
+   try {
+      protocol = req.headers["x-forwarded-proto"] as string;
+   } catch (e) {}
+   const host = req.headers.host;
+   const url = `${protocol}://${host}${req.url}`;
+   const headers = new Headers();
+
+   for (const [key, value] of Object.entries(req.headers)) {
+      if (Array.isArray(value)) {
+         headers.append(key, value.join(", "));
+      } else if (value) {
+         headers.append(key, value);
+      }
+   }
+
+   const method = req.method || "GET";
+   return new Request(url, {
+      method,
+      headers
+   });
+}

app/src/adapter/nextjs/AdminPage.tsx

@@ -0,0 +1,24 @@
+import { withApi } from "bknd/adapter/nextjs";
+import type { InferGetServerSidePropsType } from "next";
+import dynamic from "next/dynamic";
+
+export const getServerSideProps = withApi(async (context) => {
+   return {
+      props: {
+         user: context.api.getUser()
+      }
+   };
+});
+
+export function adminPage() {
+   const Admin = dynamic(() => import("bknd/ui").then((mod) => mod.Admin), { ssr: false });
+   const ClientProvider = dynamic(() => import("bknd/ui").then((mod) => mod.ClientProvider));
+   return (props: InferGetServerSidePropsType<typeof getServerSideProps>) => {
+      if (typeof document === "undefined") return null;
+      return (
+         <ClientProvider user={props.user}>
+            <Admin />
+         </ClientProvider>
+      );
+   };
+}

app/src/adapter/nextjs/index.ts

@@ -1 +1,2 @@
 export * from "./nextjs.adapter";
+export * from "./AdminPage";

app/src/adapter/nextjs/nextjs.adapter.ts

@@ -1,5 +1,36 @@
-import { App, type CreateAppConfig } from "bknd";
+import type { IncomingMessage, ServerResponse } from "node:http";
+import { Api, App, type CreateAppConfig } from "bknd";
 import { isDebug } from "bknd/core";
+import { nodeRequestToRequest } from "../index";
+
+type GetServerSidePropsContext = {
+   req: IncomingMessage;
+   res: ServerResponse;
+   params?: Params;
+   query: any;
+   preview?: boolean;
+   previewData?: any;
+   draftMode?: boolean;
+   resolvedUrl: string;
+   locale?: string;
+   locales?: string[];
+   defaultLocale?: string;
+};
+
+export function createApi({ req }: GetServerSidePropsContext) {
+   const request = nodeRequestToRequest(req);
+   //console.log("createApi:request.headers", request.headers);
+   return new Api({
+      host: new URL(request.url).origin,
+      headers: request.headers
+   });
+}
+
+export function withApi<T>(handler: (ctx: GetServerSidePropsContext & { api: Api }) => T) {
+   return (ctx: GetServerSidePropsContext & { api: Api }) => {
+      return handler({ ...ctx, api: createApi(ctx) });
+   };
+}
 
 function getCleanRequest(req: Request) {
    // clean search params from "route" attribute

app/src/adapter/remix/AdminPage.tsx

@@ -0,0 +1,19 @@
+import { Suspense, lazy, useEffect, useState } from "react";
+
+export function adminPage() {
+   const Admin = lazy(() => import("bknd/ui").then((mod) => ({ default: mod.Admin })));
+   return () => {
+      const [loaded, setLoaded] = useState(false);
+      useEffect(() => {
+         if (typeof window === "undefined") return;
+         setLoaded(true);
+      }, []);
+      if (!loaded) return null;
+
+      return (
+         <Suspense>
+            <Admin />
+         </Suspense>
+      );
+   };
+}

app/src/adapter/remix/index.ts

@@ -1 +1,2 @@
 export * from "./remix.adapter";
+export * from "./AdminPage";

app/src/auth/authenticate/Authenticator.ts

@@ -257,11 +257,15 @@ export class Authenticator<Strategies extends Record<string, Strategy> = Record<
          return c.json(data);
       }
 
-      const referer = new URL(redirect ?? c.req.header("Referer") ?? "/");
+      const successPath = "/";
+      const successUrl = new URL(c.req.url).origin + successPath.replace(/\/+$/, "/");
+      const referer = new URL(redirect ?? c.req.header("Referer") ?? successUrl);
 
       if ("token" in data) {
+         // @todo: add config
          await this.setAuthCookie(c, data.token);
-         return c.redirect("/");
+         // can't navigate to "/" – doesn't work on nextjs
+         return c.redirect(successUrl);
       }
 
       let message = "An error occured";

app/src/modules/server/AdminController.tsx

@@ -117,6 +117,7 @@ export class AdminController implements ClassController {
       let script: string | undefined;
       let css: string[] = [];
 
+      // @todo: check why nextjs imports manifest, it's not required
       if (isProd) {
          const manifest: Manifest = this.options.viteManifest
             ? this.options.viteManifest

app/src/ui/client/ClientProvider.tsx

@@ -1,4 +1,5 @@
 import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
+import type { TApiUser } from "Api";
 import { createContext, useContext, useEffect, useState } from "react";
 import { useBkndWindowContext } from "ui/client/BkndProvider";
 import { AppQueryClient } from "./utils/AppQueryClient";
@@ -20,7 +21,7 @@ export const ClientProvider = ({
    children,
    baseUrl,
    user
-}: { children?: any; baseUrl?: string; user?: object }) => {
+}: { children?: any; baseUrl?: string; user?: TApiUser | null }) => {
    const [actualBaseUrl, setActualBaseUrl] = useState<string | null>(null);
    const winCtx = useBkndWindowContext();
 

app/tsup.adapters.ts

@@ -10,13 +10,20 @@ function baseConfig(adapter: string): Options {
       entry: [`src/adapter/${adapter}`],
       format: ["esm"],
       platform: "neutral",
-      minify,
+      minify: false,
       outDir: `dist/adapter/${adapter}`,
       watch,
       define: {
          __isDev: "0"
       },
-      external: [new RegExp(`^(?!\\.\\/src\\/adapter\\/${adapter}\\/).+$`)],
+      external: [
+         "cloudflare:workers",
+         /^@?hono.*?/,
+         /^bknd.*?/,
+         /.*\.html$/,
+         /^node.*/,
+         /^react.*?/
+      ],
       metafile: true,
       splitting: false,
       treeshake: true
@@ -35,7 +42,8 @@ await build({
 await build({
    ...baseConfig("nextjs"),
    format: ["esm", "cjs"],
-   platform: "node"
+   platform: "node",
+   external: [...baseConfig("nextjs").external!, /^next.*/]
 });
 
 await build({
@@ -44,7 +52,8 @@ await build({
 });
 
 await build({
-   ...baseConfig("bun")
+   ...baseConfig("bun"),
+   external: [/^hono.*?/, /^bknd.*?/, "node:path"]
 });
 
 await build({

docs/integration/nextjs.mdx

@@ -4,11 +4,6 @@ description: 'Run bknd inside Next.js'
 ---
 import InstallBknd from '/snippets/install-bknd.mdx';
 
-<Note>
-   Next.js support is currently experimental, this guide only covers adding bknd using `pages`
-   folder.
-</Note>
-
 ## Installation
 Install bknd as a dependency:
 <InstallBknd />
@@ -39,20 +34,37 @@ For more information about the connection object, refer to the [Setup](/setup) g
 Create a file `[[...admin]].tsx` inside the `pages/admin` folder:
 ```tsx
 // pages/admin/[[...admin]].tsx
-import type { PageConfig } from "next";
-import dynamic from "next/dynamic";
+import { adminPage, getServerSideProps } from "bknd/adapter/nextjs";
 import "bknd/dist/styles.css";
 
-export const config: PageConfig = {
-  runtime: "experimental-edge",
-};
+export { getServerSideProps };
+export default adminPage();
+```
 
-const Admin = dynamic(
-  () => import("bknd/ui").then((mod) => mod.Admin),
-  { ssr: false },
+## Example usage of the API in pages dir
+Using pages dir, you need to wrap the `getServerSideProps` function with `withApi` to get access
+to the API. With the API, you can query the database or retrieve the authentication status:
+```tsx
+import { withApi } from "bknd/adapter/nextjs";
+import type { InferGetServerSidePropsType as InferProps } from "next";
+
+export const getServerSideProps = withApi(async (context) => {
+   const { data = [] } = await context.api.data.readMany("todos");
+   const user = context.api.getUser();
+
+   return { props: { data, user } };
+});
+
+export default function Home(props: InferProps<typeof getServerSideProps>) {
+   const { data, user } = props;
+   return (
+      <div>
+         <h1>Data</h1>
+         <pre>{JSON.stringify(data, null, 2)}</pre>
+
+         <h1>User</h1>
+         <pre>{JSON.stringify(user, null, 2)}</pre>
+      </div>
    );
-
-export default function AdminPage() {
-  return <Admin />;
 }
 ```

docs/integration/remix.mdx

@@ -4,10 +4,6 @@ description: 'Run bknd inside Remix'
 ---
 import InstallBknd from '/snippets/install-bknd.mdx';
 
-<Note>
-   Remix SSR support is currently limited.
-</Note>
-
 ## Installation
 Install bknd as a dependency:
 <InstallBknd />
@@ -32,28 +28,90 @@ export const action = handler;
 ```
 For more information about the connection object, refer to the [Setup](/setup) guide.
 
+Now make sure that you wrap your root layout with the `ClientProvider` so that all components
+share the same context:
+```tsx
+// app/root.tsx
+export function Layout(props) {
+   // nothing to change here, just for orientation
+   return (
+      <html>{/* ... */}</html>
+   );
+}
+
+// add the api to the `AppLoadContext`
+// so you don't have to manually type it again
+declare module "@remix-run/server-runtime" {
+   export interface AppLoadContext {
+      api: Api;
+   }
+}
+
+// export a loader that initiates the API
+// and pass it through the context
+export const loader = async (args: LoaderFunctionArgs) => {
+   const api = new Api({
+      host: new URL(args.request.url).origin,
+      headers: args.request.headers
+   });
+
+   // get the user from the API
+   const user = api.getUser();
+
+   // add api to the context
+   args.context.api = api;
+
+   return { user };
+};
+
+export default function App() {
+   const { user } = useLoaderData<typeof loader>();
+   return (
+      <ClientProvider user={user}>
+         <Outlet />
+      </ClientProvider>
+   );
+}
+```
+
 ## Enabling the Admin UI
 Create a new splat route file at `app/routes/admin.$.tsx`:
 ```tsx
 // app/routes/admin.$.tsx
-import { Suspense, lazy, useEffect, useState } from "react";
+import { adminPage } from "bknd/adapter/remix";
 import "bknd/dist/styles.css";
 
-const Admin = lazy(() => import("bknd/ui")
-   .then((mod) => ({ default: mod.Admin })));
+export default adminPage();
+```
 
-export default function AdminPage() {
-   const [loaded, setLoaded] = useState(false);
-   useEffect(() => {
-      setLoaded(true);
-   }, []);
-   if (!loaded) return null;
+## Example usage of the API
+Since the API has already been constructed in the root layout, you can now use it in any page:
+```tsx
+// app/routes/_index.tsx
+import type { LoaderFunctionArgs } from "@remix-run/server-runtime";
+import { useLoaderData } from "@remix-run/react";
+
+export const loader = async (args: LoaderFunctionArgs) => {
+   const { api } = args.context;
+
+   // get the authenticated user
+   const user = api.getAuthState().user;
+
+   // get the data from the API
+   const { data } = await api.data.readMany("todos");
+   return { data, user };
+};
+
+export default function Index() {
+   const { data, user } = useLoaderData<typeof loader>();
 
    return (
-      <Suspense>
-         <Admin withProvider />
-      </Suspense>
+      <div>
+         <h1>Data</h1>
+         <pre>{JSON.stringify(data, null, 2)}</pre>
+         <h1>User</h1>
+         <pre>{JSON.stringify(user, null, 2)}</pre>
+      </div>
    );
 }
-
 ```

examples/nextjs/src/components/BkndAdmin.tsx

@@ -1,11 +0,0 @@
-import dynamic from "next/dynamic";
-
-const Admin = dynamic(() => import("bknd/ui").then((mod) => mod.Admin), { ssr: false });
-if (typeof window !== "undefined") {
-   // @ts-ignore
-   import("bknd/dist/styles.css");
-}
-
-export function BkndAdmin() {
-   return <Admin />;
-}

examples/nextjs/src/pages/admin/[[...admin]].tsx

@@ -1,14 +1,5 @@
-import type { PageConfig } from "next";
-import dynamic from "next/dynamic";
-
-export const config: PageConfig = {
-   runtime: "experimental-edge"
-};
-
-const Admin = dynamic(() => import("bknd/ui").then((mod) => mod.Admin), { ssr: false });
+import { adminPage, getServerSideProps } from "bknd/adapter/nextjs";
 import "bknd/dist/styles.css";
 
-export default function AdminPage() {
-   if (typeof document === "undefined") return null;
-   return <Admin withProvider />;
-}
+export { getServerSideProps };
+export default adminPage();

examples/nextjs/src/pages/index.tsx

@@ -1,115 +1,24 @@
-import Image from "next/image";
-import localFont from "next/font/local";
+import { withApi } from "bknd/adapter/nextjs";
+import type { InferGetServerSidePropsType } from "next";
 
-const geistSans = localFont({
-  src: "./fonts/GeistVF.woff",
-  variable: "--font-geist-sans",
-  weight: "100 900",
-});
-const geistMono = localFont({
-  src: "./fonts/GeistMonoVF.woff",
-  variable: "--font-geist-mono",
-  weight: "100 900",
+export const getServerSideProps = withApi(async (context) => {
+   const { data = [] } = await context.api.data.readMany("todos");
+   const user = context.api.getUser();
+
+   return { props: { data, user } };
 });
 
-export default function Home() {
+export default function Home({
+   data,
+   user
+}: InferGetServerSidePropsType<typeof getServerSideProps>) {
    return (
-    <div
-      className={`${geistSans.variable} ${geistMono.variable} grid grid-rows-[20px_1fr_20px] items-center justify-items-center min-h-screen p-8 pb-20 gap-16 sm:p-20 font-[family-name:var(--font-geist-sans)]`}
-    >
-      <main className="flex flex-col gap-8 row-start-2 items-center sm:items-start">
-        <Image
-          className="dark:invert"
-          src="/next.svg"
-          alt="Next.js logo"
-          width={180}
-          height={38}
-          priority
-        />
-        <ol className="list-inside list-decimal text-sm text-center sm:text-left font-[family-name:var(--font-geist-mono)]">
-          <li className="mb-2">
-            Get started by editing{" "}
-            <code className="bg-black/[.05] dark:bg-white/[.06] px-1 py-0.5 rounded font-semibold">
-              src/pages/index.tsx
-            </code>
-            .
-          </li>
-          <li>Save and see your changes instantly.</li>
-        </ol>
+      <div>
+         <h1>Data</h1>
+         <pre>{JSON.stringify(data, null, 2)}</pre>
 
-        <div className="flex gap-4 items-center flex-col sm:flex-row">
-          <a
-            className="rounded-full border border-solid border-transparent transition-colors flex items-center justify-center bg-foreground text-background gap-2 hover:bg-[#383838] dark:hover:bg-[#ccc] text-sm sm:text-base h-10 sm:h-12 px-4 sm:px-5"
-            href="https://vercel.com/new?utm_source=create-next-app&utm_medium=default-template-tw&utm_campaign=create-next-app"
-            target="_blank"
-            rel="noopener noreferrer"
-          >
-            <Image
-              className="dark:invert"
-              src="/vercel.svg"
-              alt="Vercel logomark"
-              width={20}
-              height={20}
-            />
-            Deploy now
-          </a>
-          <a
-            className="rounded-full border border-solid border-black/[.08] dark:border-white/[.145] transition-colors flex items-center justify-center hover:bg-[#f2f2f2] dark:hover:bg-[#1a1a1a] hover:border-transparent text-sm sm:text-base h-10 sm:h-12 px-4 sm:px-5 sm:min-w-44"
-            href="https://nextjs.org/docs?utm_source=create-next-app&utm_medium=default-template-tw&utm_campaign=create-next-app"
-            target="_blank"
-            rel="noopener noreferrer"
-          >
-            Read our docs
-          </a>
-        </div>
-      </main>
-      <footer className="row-start-3 flex gap-6 flex-wrap items-center justify-center">
-        <a
-          className="flex items-center gap-2 hover:underline hover:underline-offset-4"
-          href="https://nextjs.org/learn?utm_source=create-next-app&utm_medium=default-template-tw&utm_campaign=create-next-app"
-          target="_blank"
-          rel="noopener noreferrer"
-        >
-          <Image
-            aria-hidden
-            src="/file.svg"
-            alt="File icon"
-            width={16}
-            height={16}
-          />
-          Learn
-        </a>
-        <a
-          className="flex items-center gap-2 hover:underline hover:underline-offset-4"
-          href="https://vercel.com/templates?framework=next.js&utm_source=create-next-app&utm_medium=default-template-tw&utm_campaign=create-next-app"
-          target="_blank"
-          rel="noopener noreferrer"
-        >
-          <Image
-            aria-hidden
-            src="/window.svg"
-            alt="Window icon"
-            width={16}
-            height={16}
-          />
-          Examples
-        </a>
-        <a
-          className="flex items-center gap-2 hover:underline hover:underline-offset-4"
-          href="https://nextjs.org?utm_source=create-next-app&utm_medium=default-template-tw&utm_campaign=create-next-app"
-          target="_blank"
-          rel="noopener noreferrer"
-        >
-          <Image
-            aria-hidden
-            src="/globe.svg"
-            alt="Globe icon"
-            width={16}
-            height={16}
-          />
-          Go to nextjs.org →
-        </a>
-      </footer>
+         <h1>User</h1>
+         <pre>{JSON.stringify(user, null, 2)}</pre>
       </div>
    );
 }

examples/remix/app/root.tsx

@@ -3,6 +3,12 @@ import { Links, Meta, Outlet, Scripts, ScrollRestoration, useLoaderData } from "
 import { Api } from "bknd";
 import { ClientProvider } from "bknd/ui";
 
+declare module "@remix-run/server-runtime" {
+   export interface AppLoadContext {
+      api: Api;
+   }
+}
+
 export function Layout({ children }: { children: React.ReactNode }) {
    return (
       <html lang="en">

examples/remix/app/routes/_index.tsx

@@ -1,31 +1,26 @@
-import type { LoaderFunctionArgs, MetaFunction } from "@remix-run/node";
-import { useLoaderData } from "@remix-run/react";
-import type { Api } from "bknd";
-import { useClient } from "bknd/ui";
+import { type MetaFunction, useLoaderData } from "@remix-run/react";
+import type { LoaderFunctionArgs } from "@remix-run/server-runtime";
 
 export const meta: MetaFunction = () => {
    return [{ title: "Remix & bknd" }, { name: "description", content: "Welcome to Remix & bknd!" }];
 };
 
 export const loader = async (args: LoaderFunctionArgs) => {
-   const api = args.context.api as Api;
+   const api = args.context.api;
    const user = api.getAuthState().user;
    const { data } = await api.data.readMany("todos");
    return { data, user };
 };
 
 export default function Index() {
-   const data = useLoaderData<typeof loader>();
-   const client = useClient();
-
-   const query = client.query().data.entity("todos").readMany();
+   const { data, user } = useLoaderData<typeof loader>();
 
    return (
       <div>
-         hello
-         <pre>{client.baseUrl}</pre>
+         <h1>Data</h1>
          <pre>{JSON.stringify(data, null, 2)}</pre>
-         <pre>{JSON.stringify(query.data, null, 2)}</pre>
+         <h1>User</h1>
+         <pre>{JSON.stringify(user, null, 2)}</pre>
       </div>
    );
 }

examples/remix/app/routes/admin.$.tsx

@@ -1,19 +1,4 @@
-import { Suspense, lazy, useEffect, useState } from "react";
-
-const Admin = lazy(() => import("bknd/ui").then((mod) => ({ default: mod.Admin })));
+import { adminPage } from "bknd/adapter/remix";
 import "bknd/dist/styles.css";
 
-export default function AdminPage() {
-   const [loaded, setLoaded] = useState(false);
-   useEffect(() => {
-      if (typeof window === "undefined") return;
-      setLoaded(true);
-   }, []);
-   if (!loaded) return null;
-
-   return (
-      <Suspense>
-         <Admin />
-      </Suspense>
-   );
-}
+export default adminPage();