Release 0.16 (#196)

* initial refactor

* fixes

* test secrets extraction

* updated lock

* fix secret schema

* updated schemas, fixed tests, skipping flow tests for now

* added validator for rjsf, hook form via standard schema

* removed @sinclair/typebox

* remove unneeded vite dep

* fix jsonv literal on Field.tsx

* fix schema import path

* fix schema modals

* fix schema modals

* fix json field form, replaced auth form

* initial waku

* finalize waku example

* fix jsonv-ts version

* fix schema updates with falsy values

* fix media api to respect options' init, improve types

* checking media controller test

* checking media controller test

* checking media controller test

* clean up mediacontroller test

* added cookie option `partitioned`, as well as cors `origin` to be array, option to enable `credentials` (#214)

* added cookie option `partitioned`, as well as cors `origin` to be array, option to enable `credentials`

* fix server test

* fix data api (updated jsonv-ts)

* enhance cloudflare image optimization plugin with new options and explain endpoint (#215)

* feat: add ability to serve static by using dynamic imports (#197)

* feat: add ability to serve static by using dynamic imports

* serveStaticViaImport: make manifest optional

* serveStaticViaImport: add error log

* refactor/imports (#217)

* refactored core and core/utils imports

* refactored core and core/utils imports

* refactored media imports

* refactored auth imports

* refactored data imports

* updated package json exports, fixed mm config

* fix tests

* feat/deno (#219)

* update bun version

* fix module manager's em reference

* add basic deno example

* finalize

* docs: fumadocs migration (#185)

* feat(docs): initialize documentation structure with Fumadocs

* feat(docs): remove home route and move /docs route to /route

* feat(docs): add redirect to /start page

* feat(docs): migrate Getting Started chapters

* feat(docs): migrate Usage and Extending chapters

* feat(callout): add CalloutCaution, CalloutDanger, CalloutInfo, and CalloutPositive

* feat(layout): add Discord and GitHub links to documentation layout

* feat(docs): add integration chapters draft

* feat(docs): add modules chapters draft

* refactor(mdx-components): remove unused Icon import

* refactor(StackBlitz): enhance type safety by using unknown instead of any

* refactor(layout): update navigation mode to 'top' in layout configuration

* feat(docs): add @iconify/react package

* docs(mdx-components): add Icon component to MDX components list

* feat(docs): update Next.js integration guide

* feat(docs): update React Router integration guide

* feat(docs): update Astro integration guide

* feat(docs): update Vite integration guide

* fix(docs): update package manager initialization commands

* feat(docs): migrate Modules chapters

* chore(docs): update package.json with new devDependencies

* feat(docs): migrate Integration Runtimes chapters

* feat(docs): update Database usage chapter

* feat(docs): restructure documentation paths

* chore(docs): clean up unused imports and files in documentation

* style(layout): revert navigation mode to previous state

* fix(docs): routing for documentation structure

* feat(openapi): add API documentation generation from OpenAPI schema

* feat(docs): add icons to documentation pages

* chore(dependencies): remove unused content-collections packages

* fix(types): fix type error for attachFile in source.ts

* feat(redirects): update root redirect destination to '/start'

* feat(search): add static search functionality

* chore(dependencies): update fumadocs-core and fumadocs-ui to latest versions

* feat(search): add Powered by Orama link

* feat(generate-openapi): add error handling for missing OpenAPI schema

* feat(scripts): add OpenAPI generation to build process

* feat(config): enable dynamic redirects and rewrites in development mode

* feat(layout): add GitHub token support for improved API rate limits

* feat(redirects): add 301 redirects for cloudflare pages

* feat(docs): add Vercel redirects configuration

* feat(config): enable standalone output for development environment

* chore(layout): adjust layout settings

* refactor(package): clean up ajv dependency versions

* feat(docs): add twoslash support

* refactor(layout): update DocsLayout import and navigation configuration

* chore(layout): clean up layout.tsx by commenting out GithubInfo

* fix(Search): add locale to search initialization

* chore(package): update fumadocs and orama to latest versions

* docs: add menu items descriptions

* feat(layout): add GitHub URL to the layout component

* feat(docs): add AutoTypeTable component to MDX components

* feat(app): implement AutoTypeTable rendering for AppEvents type

* docs(layout): switch callouts back to default components

* fix(config): use __filename and __dirname for module paths

* docs: add note about node.js 22 requirement

* feat(styles): add custom color variables for light and dark themes

* docs: add S3 setup instructions for media module

* docs: fix typos and indentation in media module docs

* docs: add local media adapter example for Node.js

* docs(media): add S3/R2 URL format examples and fix typo

* docs: add cross-links to initial config and seeding sections

* indent numbered lists content, clarified media serve locations

* fix mediacontroller tests

* feat(layout): add AnimatedGridPattern component for dynamic background

* style(layout): configure fancy ToC style ('clerk')

* fix(AnimatedGridPattern): correct strokeDasharray type

* docs: actualize docs

* feat: add favicon

* style(cloudflare): format code examples

* feat(layout): add Github and Discord footer icons

* feat(footer): add SVG social media icons for GitHub and Discord

* docs: adjusted auto type table, added llm functions

* added static deployment to cloudflare workers

* docs: change cf redirects to proxy *.mdx instead of redirecting

---------

Co-authored-by: dswbx <dennis.senn@gmx.ch>
Co-authored-by: cameronapak <cameronandrewpak@gmail.com>

* build: improve build script

* add missing exports, fix EntityTypescript imports

* media: Dropzone: add programmatic upload, additional events, loading state

* schema object: disable extended defaults to allow empty config values

* Feat/new docs deploy (#224)

* test

* try fixing pm

* try fixing pm

* fix docs on imports, export events correctly

---------

Co-authored-by: Tim Seriakov <59409712+timseriakov@users.noreply.github.com>
Co-authored-by: cameronapak <cameronandrewpak@gmail.com>

examples/deno/main.ts

@@ -0,0 +1,14 @@
+import { createRuntimeApp } from "bknd/adapter";
+
+const app = await createRuntimeApp({
+   connection: {
+      url: "file:./data.db",
+   },
+   adminOptions: {
+      // currently needs a hosted version of the static assets
+      assetsPath: "https://cdn.bknd.io/bknd/static/0.15.0-rc.9/",
+   },
+});
+
+// @ts-ignore
+Deno.serve(app.fetch);

examples/deno/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "bknd-deno-example",
+  "private": true,
+  "dependencies": {
+    "bknd": "file:../../app"
+  }
+}

examples/waku/.gitignore

@@ -0,0 +1,7 @@
+node_modules
+dist
+.env*
+*.tsbuildinfo
+.cache
+.DS_Store
+*.pem

examples/waku/bknd.config.ts

@@ -0,0 +1,62 @@
+import { registerLocalMediaAdapter } from "bknd/adapter/node";
+import type { BkndConfig } from "bknd/adapter";
+import { boolean, em, entity, text } from "bknd/data";
+import { secureRandomString } from "bknd/utils";
+
+// since we're running in node, we can register the local media adapter
+const local = registerLocalMediaAdapter();
+
+const schema = em({
+   todos: entity("todos", {
+      title: text(),
+      done: boolean(),
+   }),
+});
+
+// register your schema to get automatic type completion
+type Database = (typeof schema)["DB"];
+declare module "bknd/core" {
+   interface DB extends Database {}
+}
+
+export default {
+   // we can use any libsql config, and if omitted, uses in-memory
+   connection: {
+      url: process.env.DB_URL ?? "file:data.db",
+   },
+   // an initial config is only applied if the database is empty
+   initialConfig: {
+      data: schema.toJSON(),
+      // we're enabling auth ...
+      auth: {
+         enabled: true,
+         jwt: {
+            issuer: "bknd-waku-example",
+            secret: secureRandomString(64),
+         },
+      },
+      // ... and media
+      media: {
+         enabled: true,
+         adapter: local({
+            path: "./public/uploads",
+         }),
+      },
+   },
+   options: {
+      // the seed option is only executed if the database was empty
+      seed: async (ctx) => {
+         // create some entries
+         await ctx.em.mutator("todos").insertMany([
+            { title: "Learn bknd", done: true },
+            { title: "Build something cool", done: false },
+         ]);
+
+         // and create a user
+         await ctx.app.module.auth.createUser({
+            email: "test@bknd.io",
+            password: "12345678",
+         });
+      },
+   },
+} as const satisfies BkndConfig<{ DB_URL?: string }>;

examples/waku/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "waku",
+  "version": "0.0.0",
+  "type": "module",
+  "private": true,
+  "scripts": {
+    "dev": "waku dev",
+    "build": "waku build",
+    "start": "waku start"
+  },
+  "dependencies": {
+    "react": "19.0.0",
+    "react-dom": "19.0.0",
+    "react-server-dom-webpack": "19.0.0",
+    "waku": "0.23.3",
+    "bknd": "file:../../app"
+  },
+  "devDependencies": {
+    "@tailwindcss/postcss": "4.1.10",
+    "@types/react": "19.1.8",
+    "@types/react-dom": "19.1.6",
+    "postcss": "8.5.6",
+    "tailwindcss": "4.1.10",
+    "typescript": "5.8.3"
+  }
+}

examples/waku/postcss.config.js

@@ -0,0 +1,5 @@
+export default {
+  plugins: {
+    '@tailwindcss/postcss': {},
+  },
+};

examples/waku/public/robots.txt

@@ -0,0 +1,2 @@
+User-agent: *
+Disallow: /RSC/

examples/waku/src/bknd.ts

@@ -0,0 +1,22 @@
+import { createFrameworkApp } from "bknd/adapter";
+import config from "../bknd.config";
+
+export async function getApp() {
+   return await createFrameworkApp(config, process.env, {
+      force: import.meta.env && !import.meta.env.PROD,
+   });
+}
+
+export async function getApi(opts?: {
+   headers?: Headers | any;
+   verify?: boolean;
+}) {
+   const app = await getApp();
+   if (opts?.verify && opts.headers) {
+      const api = app.getApi({ headers: opts.headers });
+      await api.verifyAuth();
+      return api;
+   }
+
+   return app.getApi();
+}

examples/waku/src/components/counter.tsx

@@ -0,0 +1,21 @@
+'use client';
+
+import { useState } from 'react';
+
+export const Counter = () => {
+  const [count, setCount] = useState(0);
+
+  const handleIncrement = () => setCount((c) => c + 1);
+
+  return (
+    <section className="border-blue-400 -mx-4 mt-4 rounded-sm border border-dashed p-4">
+      <div>Count: {count}</div>
+      <button
+        onClick={handleIncrement}
+        className="rounded-xs bg-black px-2 py-0.5 text-sm text-white"
+      >
+        Increment
+      </button>
+    </section>
+  );
+};

examples/waku/src/components/footer.tsx

@@ -0,0 +1,18 @@
+export const Footer = () => {
+  return (
+    <footer className="p-6 lg:fixed lg:bottom-0 lg:left-0">
+      <div>
+        visit{' '}
+        <a
+          href="https://waku.gg/"
+          target="_blank"
+          rel="noreferrer"
+          className="mt-4 inline-block underline"
+        >
+          waku.gg
+        </a>{' '}
+        to learn more
+      </div>
+    </footer>
+  );
+};

examples/waku/src/components/header.tsx

@@ -0,0 +1,11 @@
+import { Link } from 'waku';
+
+export const Header = () => {
+  return (
+    <header className="flex items-center gap-4 p-6 lg:fixed lg:left-0 lg:top-0">
+      <h2 className="text-lg font-bold tracking-tight">
+        <Link to="/">Waku starter</Link>
+      </h2>
+    </header>
+  );
+};

examples/waku/src/lib/waku/client.tsx

@@ -0,0 +1,20 @@
+"use client";
+
+import * as React from "react";
+
+export function BrowserOnly(props: React.SuspenseProps) {
+   const hydrated = useHydrated();
+   if (!hydrated) {
+      return props.fallback;
+   }
+   return <React.Suspense {...props} />;
+}
+
+const noopStore = () => () => {};
+
+const useHydrated = () =>
+   React.useSyncExternalStore(
+      noopStore,
+      () => true,
+      () => false
+   );

examples/waku/src/lib/waku/server.ts

@@ -0,0 +1,26 @@
+"use server";
+
+import { getContext } from "waku/middleware/context";
+import { getApi } from "../../bknd";
+
+export { unstable_rerenderRoute as rerender } from "waku/router/server";
+
+export function context() {
+   return getContext();
+}
+
+export function handlerReq() {
+   return getContext().req;
+}
+
+export function headers() {
+   const context = getContext();
+   return new Headers(context.req.headers);
+}
+
+export async function getUserApi(opts?: { verify?: boolean }) {
+   return await getApi({
+      headers: headers(),
+      verify: !!opts?.verify,
+   });
+}

examples/waku/src/pages.gen.ts

@@ -0,0 +1,30 @@
+// deno-fmt-ignore-file
+// biome-ignore format: generated types do not need formatting
+// prettier-ignore
+import type { PathsForPages, GetConfigResponse } from 'waku/router';
+
+// prettier-ignore
+import type { getConfig as File_About_getConfig } from './pages/about';
+// prettier-ignore
+import type { getConfig as File_AdminAdmin_getConfig } from './pages/admin/[...admin]';
+// prettier-ignore
+import type { getConfig as File_Index_getConfig } from './pages/index';
+
+// prettier-ignore
+type Page =
+| ({ path: '/about' } & GetConfigResponse<typeof File_About_getConfig>)
+| ({ path: '/admin/[...admin]' } & GetConfigResponse<typeof File_AdminAdmin_getConfig>)
+| { path: '/admin'; render: 'dynamic' }
+| ({ path: '/' } & GetConfigResponse<typeof File_Index_getConfig>)
+| { path: '/login'; render: 'dynamic' }
+| { path: '/test'; render: 'dynamic' };
+
+// prettier-ignore
+declare module 'waku/router' {
+  interface RouteConfig {
+    paths: PathsForPages<Page>;
+  }
+  interface CreatePagesConfig {
+    pages: Page;
+  }
+}

examples/waku/src/pages/_layout.tsx

@@ -0,0 +1,28 @@
+import "../styles.css";
+
+import type { ReactNode } from "react";
+
+import { ClientProvider } from "bknd/client";
+
+type RootLayoutProps = { children: ReactNode };
+
+export default async function RootLayout({ children }: RootLayoutProps) {
+   const data = await getData();
+
+   return children;
+}
+
+const getData = async () => {
+   const data = {
+      description: "An internet website!",
+      icon: "/images/favicon.png",
+   };
+
+   return data;
+};
+
+export const getConfig = async () => {
+   return {
+      render: "static",
+   } as const;
+};

examples/waku/src/pages/about.tsx

@@ -0,0 +1,32 @@
+import { Link } from 'waku';
+
+export default async function AboutPage() {
+  const data = await getData();
+
+  return (
+    <div>
+      <title>{data.title}</title>
+      <h1 className="text-4xl font-bold tracking-tight">{data.headline}</h1>
+      <p>{data.body}</p>
+      <Link to="/" className="mt-4 inline-block underline">
+        Return home
+      </Link>
+    </div>
+  );
+}
+
+const getData = async () => {
+  const data = {
+    title: 'About',
+    headline: 'About Waku',
+    body: 'The minimal React framework',
+  };
+
+  return data;
+};
+
+export const getConfig = async () => {
+  return {
+    render: 'static',
+  } as const;
+};

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

@@ -0,0 +1,32 @@
+/**
+ * See https://github.com/wakujs/waku/issues/1499
+ */
+
+import { Suspense, lazy } from "react";
+import { getUserApi } from "../../lib/waku/server";
+
+const AdminComponent = lazy(() => import("./_components/AdminLoader"));
+
+export default async function HomePage() {
+   const api = await getUserApi({ verify: true });
+
+   // @ts-ignore
+   const styles = await import("bknd/dist/styles.css?inline").then((m) => m.default);
+   return (
+      <>
+         <style>{styles}</style>
+         <Suspense fallback={null}>
+            <AdminComponent withProvider={{ user: api.getUser()! }} />
+         </Suspense>
+      </>
+   );
+}
+
+// Enable dynamic server rendering.
+// Static rendering is possible if you want to render at build time.
+// The Hono context will not be available.
+export const getConfig = async () => {
+   return {
+      render: "dynamic",
+   } as const;
+};

examples/waku/src/pages/admin/_components/AdminImpl.tsx

@@ -0,0 +1,23 @@
+"use client";
+
+import { Admin, type BkndAdminProps } from "bknd/ui";
+
+export const AdminImpl = (props: BkndAdminProps) => {
+   if (typeof window === "undefined") {
+      return null;
+   }
+
+   return (
+      <Admin
+         withProvider
+         config={{
+            basepath: "/admin",
+            logo_return_path: "/../",
+            ...props.config,
+         }}
+         {...props}
+      />
+   );
+};
+
+export default AdminImpl;

examples/waku/src/pages/admin/_components/AdminLoader.tsx

@@ -0,0 +1,18 @@
+"use client";
+
+import type { BkndAdminProps } from "bknd/ui";
+import { lazy } from "react";
+import { BrowserOnly } from "../../../lib/waku/client";
+
+const AdminImpl = import.meta.env.SSR ? undefined : lazy(() => import("./AdminImpl"));
+
+export const AdminLoader = (props: BkndAdminProps) => {
+   return (
+      <BrowserOnly fallback={null}>
+         {/* @ts-expect-error */}
+         <AdminImpl {...props} />
+      </BrowserOnly>
+   );
+};
+
+export default AdminLoader;

examples/waku/src/pages/admin/index.tsx

@@ -0,0 +1,6 @@
+import { unstable_redirect as redirect } from "waku/router/server";
+
+export default async function AdminIndex() {
+   await new Promise((resolve) => setTimeout(resolve, 100));
+   redirect("/admin/data");
+}

examples/waku/src/pages/api/[...api].ts

@@ -0,0 +1,5 @@
+import { getApp } from "../../bknd";
+
+export default async function handler(request: Request) {
+   return (await getApp()).fetch(request);
+}

examples/waku/src/pages/index.tsx

@@ -0,0 +1,70 @@
+import { Link } from "waku";
+
+import { Counter } from "../components/counter";
+import { rerender, getUserApi } from "../lib/waku/server";
+
+async function toggleTodo(todo: any, path: string) {
+   "use server";
+   const api = await getUserApi();
+   await api.data.updateOne("todos", todo.id, {
+      done: !todo.done,
+   });
+   rerender(path);
+}
+
+export default async function HomePage({ path }: any) {
+   const api = await getUserApi({ verify: true });
+   const todos = await api.data.readMany("todos");
+   const user = api.getUser();
+   const data = await getData();
+
+   return (
+      <div>
+         <title>{data.title}</title>
+         <h1 className="text-4xl font-bold tracking-tight">{data.headline}</h1>
+         <p>{data.body}</p>
+         <ul>
+            {todos?.map((todo) => (
+               <li key={todo.id} className="flex items-center gap-2">
+                  {todo.title} {todo.done ? "✅" : "❌"}
+                  <form action={toggleTodo.bind(null, todo, path)}>
+                     <button type="submit">Toggle</button>
+                  </form>
+               </li>
+            ))}
+         </ul>
+         <Counter />
+         <Link to="/about" className="mt-4 inline-block underline">
+            About page
+         </Link>
+         {user ? (
+            <a href="/api/auth/logout" className="mt-4 inline-block underline">
+               Logout ({user.email})
+            </a>
+         ) : (
+            <Link to="/login" className="mt-4 inline-block underline">
+               Login
+            </Link>
+         )}
+         <Link to="/admin" className="mt-4 inline-block underline">
+            Admin
+         </Link>
+      </div>
+   );
+}
+
+const getData = async () => {
+   const data = {
+      title: "Waku",
+      headline: "Waku",
+      body: "Hello world!",
+   };
+
+   return data;
+};
+
+export const getConfig = async () => {
+   return {
+      render: "dynamic",
+   } as const;
+};

examples/waku/src/pages/login.tsx

@@ -0,0 +1,9 @@
+export default function LoginPage() {
+   return (
+      <form method="POST" action="/api/auth/password/login">
+         <input type="email" name="email" placeholder="Email" />
+         <input type="password" name="password" placeholder="Password" />
+         <button type="submit">Login</button>
+      </form>
+   );
+}

examples/waku/src/pages/test.tsx

@@ -0,0 +1,58 @@
+"use client";
+
+import { useEffect } from "react";
+
+export default function Test() {
+   useEffect(() => {
+      bridge();
+   }, []);
+   return null;
+}
+
+async function bridge() {
+   const aud = new URLSearchParams(location.search).get("aud") || "";
+   // 1. Verify the user still has an auth cookie
+   const me = await fetch("/api/auth/me", { credentials: "include" });
+   console.log("sso-bridge:me", me);
+   if (!me.ok) {
+      console.log("sso-bridge:no session");
+      parent.postMessage({ type: "NOSESSION" }, aud);
+   } else {
+      console.log("sso-bridge:session");
+
+      // 2. Get short-lived JWT (internal endpoint, same origin)
+      const res = await fetch("/api/issue-jwt", {
+         credentials: "include",
+         headers: { "Content-Type": "application/json" },
+         method: "POST",
+         body: JSON.stringify({
+            aud,
+         }),
+      });
+      console.log("sso-bridge:res", res);
+      const { jwt, exp } = (await res.json()) as any; // exp = unix timestamp seconds
+      console.log("sso-bridge:jwt", { jwt, exp });
+
+      // 3. Send token up
+      parent.postMessage({ type: "JWT", jwt, exp }, aud);
+
+      // 4. Listen for refresh requests
+      window.addEventListener("message", async (ev) => {
+         console.log("sso-bridge:message", ev);
+         if (ev.origin !== aud) return;
+         if (ev.data !== "REFRESH") return;
+         console.log("sso-bridge:message:refresh");
+
+         const r = await fetch("/api/issue-jwt", {
+            credentials: "include",
+            method: "POST",
+            headers: { "content-type": "application/json" },
+            body: JSON.stringify({ aud: ev.origin }),
+         });
+         console.log("sso-bridge:message:r", r);
+         const { jwt, exp } = (await r.json()) as any;
+         console.log("sso-bridge:message:jwt", { jwt, exp });
+         parent.postMessage({ type: "JWT", jwt, exp }, ev.origin);
+      });
+   }
+}

examples/waku/src/styles.css

@@ -0,0 +1,3 @@
+@import url('https://fonts.googleapis.com/css2?family=Nunito:ital,wght@0,400;0,700;1,400;1,700&display=swap')
+layer(base);
+@import 'tailwindcss';

examples/waku/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "include": ["**/*.ts", "**/*.tsx"],
+  "compilerOptions": {
+    "strict": true,
+    "target": "esnext",
+    "noEmit": true,
+    "isolatedModules": true,
+    "moduleDetection": "force",
+    "downlevelIteration": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "skipLibCheck": true,
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+    "jsx": "react-jsx"
+  }
+}