refactored adapters to run test suites (#126)

* refactored adapters to run test suites

* fix bun version for tests

* added missing adapter tests and refactored examples to use `bknd.config.ts` where applicable

examples/astro/bknd.config.ts

@@ -0,0 +1,65 @@
+import type { AstroBkndConfig } from "bknd/adapter/astro";
+import { registerLocalMediaAdapter } from "bknd/adapter/node";
+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();
+
+// the em() function makes it easy to create an initial schema
+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
+   app: (env) => ({
+      connection: {
+         url: 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-astro-example",
+            secret: secureRandomString(64),
+         },
+      },
+      // ... and media
+      media: {
+         enabled: true,
+         adapter: local({
+            path: "./public",
+         }),
+      },
+   },
+   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 AstroBkndConfig;

examples/astro/src/bknd.ts

@@ -0,0 +1,23 @@
+import type { AstroGlobal } from "astro";
+import { getApp as getBkndApp } from "bknd/adapter/astro";
+import config from "../bknd.config";
+
+export { config };
+
+export async function getApp() {
+   return await getBkndApp(config);
+}
+
+export async function getApi(
+   astro: AstroGlobal,
+   opts?: { mode: "static" } | { mode?: "dynamic"; verify?: boolean },
+) {
+   const app = await getApp();
+   if (opts?.mode !== "static" && opts?.verify) {
+      const api = app.getApi({ headers: astro.request.headers });
+      await api.verifyAuth();
+      return api;
+   }
+
+   return app.getApi();
+}

examples/astro/src/pages/admin/[...admin].astro

@@ -2,9 +2,9 @@
 import { Admin } from "bknd/ui";
 import "bknd/dist/styles.css";
 
-import { getApi } from "bknd/adapter/astro";
+import { getApi } from "../../bknd";
 
-const api = await getApi(Astro, { mode: "dynamic" });
+const api = await getApi(Astro, { verify: true });
 const user = api.getUser();
 
 export const prerender = false;

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

@@ -1,77 +1,6 @@
 import type { APIContext } from "astro";
-import { App } from "bknd";
 import { serve } from "bknd/adapter/astro";
-import { registerLocalMediaAdapter } from "bknd/adapter/node";
-import { boolean, em, entity, text } from "bknd/data";
-import { secureRandomString } from "bknd/utils";
+import { config } from "../../bknd";
 
 export const prerender = false;
-
-// since we're running in node, we can register the local media adapter
-registerLocalMediaAdapter();
-
-// the em() function makes it easy to create an initial schema
-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 const ALL = serve<APIContext>({
-   // we can use any libsql config, and if omitted, uses in-memory
-   connection: {
-      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-astro-example",
-            secret: secureRandomString(64),
-         },
-      },
-      // ... and media
-      media: {
-         enabled: true,
-         adapter: {
-            type: "local",
-            config: {
-               path: "./public",
-            },
-         },
-      },
-   },
-   options: {
-      // the seed option is only executed if the database was empty
-      seed: async (ctx) => {
-         await ctx.em.mutator("todos").insertMany([
-            { title: "Learn bknd", done: true },
-            { title: "Build something cool", done: false },
-         ]);
-      },
-   },
-   // here we can hook into the app lifecycle events ...
-   beforeBuild: async (app) => {
-      app.emgr.onEvent(
-         App.Events.AppFirstBoot,
-         async () => {
-            // ... to create an initial user
-            await app.module.auth.createUser({
-               email: "test@bknd.io",
-               password: "12345678",
-            });
-         },
-         "sync",
-      );
-   },
-});
+export const ALL = serve<APIContext>(config);

examples/astro/src/pages/index.astro

@@ -1,5 +1,5 @@
 ---
-import { getApi } from "bknd/adapter/astro";
+import { getApi } from "../bknd";
 import Card from "../components/Card.astro";
 import Layout from "../layouts/Layout.astro";
 

examples/astro/src/pages/ssr.astro

@@ -1,8 +1,8 @@
 ---
-import { getApi } from "bknd/adapter/astro";
+import { getApi } from "../bknd";
 import Card from "../components/Card.astro";
 import Layout from "../layouts/Layout.astro";
-const api = await getApi(Astro, { mode: "dynamic" });
+const api = await getApi(Astro, { verify: true });
 
 const { data } = await api.data.readMany("todos");
 const user = api.getUser();

examples/aws-lambda/index.mjs

@@ -1,6 +1,6 @@
-import { serveLambda } from "bknd/adapter/aws";
+import { serve } from "bknd/adapter/aws";
 
-export const handler = serveLambda({
+export const handler = serve({
    // to get local assets, run `npx bknd copy-assets`
    // this is automatically done in `deploy.sh`
    assets: {

examples/aws-lambda/package.json

@@ -1,21 +1,21 @@
 {
-   "name": "aws-lambda",
-   "version": "1.0.0",
-   "main": "index.mjs",
-   "scripts": {
-      "test": "esbuild index.mjs --bundle --format=cjs --platform=node --external:fs --outfile=dist/index.js && node test.js",
-      "deploy": "./deploy.sh",
-      "clean": "./clean.sh"
-   },
-   "keywords": [],
-   "author": "",
-   "license": "ISC",
-   "description": "",
-   "dependencies": {
-      "bknd": "file:../../app/bknd-0.9.0-rc.1-11.tgz"
-   },
-   "devDependencies": {
-      "esbuild": "^0.25.0",
-      "dotenv": "^16.4.7"
-   }
+  "name": "aws-lambda",
+  "version": "1.0.0",
+  "main": "index.mjs",
+  "scripts": {
+    "test": "esbuild index.mjs --bundle --format=cjs --platform=node --external:fs --outfile=dist/index.js && node test.js",
+    "deploy": "./deploy.sh",
+    "clean": "./clean.sh"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "dependencies": {
+    "bknd": "file:../../app"
+  },
+  "devDependencies": {
+    "esbuild": "^0.25.0",
+    "dotenv": "^16.4.7"
+  }
 }

examples/aws-lambda/test.js

@@ -3,11 +3,11 @@ const handler = require("./dist/index.js").handler;
 
 const event = {
    httpMethod: "GET",
-   path: "/",
-   //path: "/api/system/config",
+   //path: "/",
+   path: "/api/system/config",
    //path: "/assets/main-B6sEDlfs.js",
    headers: {
-      //"Content-Type": "application/json",
+      "Content-Type": "application/json",
       "User-Agent": "curl/7.64.1",
       Accept: "*/*",
    },

examples/bun/bun.lock

@@ -0,0 +1,32 @@
+{
+  "lockfileVersion": 1,
+  "workspaces": {
+    "": {
+      "name": "bun",
+      "dependencies": {
+        "bknd": "file:../../app",
+      },
+      "devDependencies": {
+        "@types/bun": "latest",
+      },
+      "peerDependencies": {
+        "typescript": "^5.0.0",
+      },
+    },
+  },
+  "packages": {
+    "@types/bun": ["@types/bun@1.2.2", "", { "dependencies": { "bun-types": "1.2.2" } }, "sha512-tr74gdku+AEDN5ergNiBnplr7hpDp3V1h7fqI2GcR/rsUaM39jpSeKH0TFibRvU0KwniRx5POgaYnaXbk0hU+w=="],
+
+    "@types/node": ["@types/node@22.13.4", "", { "dependencies": { "undici-types": "~6.20.0" } }, "sha512-ywP2X0DYtX3y08eFVx5fNIw7/uIv8hYUKgXoK8oayJlLnKcRfEYCxWMVE1XagUdVtCJlZT1AU4LXEABW+L1Peg=="],
+
+    "@types/ws": ["@types/ws@8.5.14", "", { "dependencies": { "@types/node": "*" } }, "sha512-bd/YFLW+URhBzMXurx7lWByOu+xzU9+kb3RboOteXYDfW+tr+JZa99OyNmPINEGB/ahzKrEuc8rcv4gnpJmxTw=="],
+
+    "bknd": ["/app@file:../../app", { "devDependencies": { "@types/node": "^22.10.0" }, "bin": { "bknd": "dist/cli/index.js" } }],
+
+    "bun-types": ["bun-types@1.2.2", "", { "dependencies": { "@types/node": "*", "@types/ws": "~8.5.10" } }, "sha512-RCbMH5elr9gjgDGDhkTTugA21XtJAy/9jkKe/G3WR2q17VPGhcquf9Sir6uay9iW+7P/BV0CAHA1XlHXMAVKHg=="],
+
+    "typescript": ["typescript@5.7.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-84MVSjMEHP+FQRPy3pX9sTVV/INIex71s9TL2Gm5FG/WG1SqXeKyZ0k7/blY/4FdOzI12CBy1vGc4og/eus0fw=="],
+
+    "undici-types": ["undici-types@6.20.0", "", {}, "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg=="],
+  }
+}

examples/bun/index.ts

@@ -1,4 +1,3 @@
-// @ts-ignore somehow causes types:build issues on app
 import { type BunBkndConfig, serve } from "bknd/adapter/bun";
 
 // Actually, all it takes is the following line:
@@ -7,8 +6,8 @@ import { type BunBkndConfig, serve } from "bknd/adapter/bun";
 // this is optional, if omitted, it uses an in-memory database
 const config: BunBkndConfig = {
    connection: {
-      url: "file:data.db"
-   }
+      url: "file:data.db",
+   },
 };
 
 serve(config);

examples/bun/minimal.ts

@@ -1,6 +0,0 @@
-import { createApp } from "bknd";
-
-const app = createApp();
-await app.build();
-
-export default app;

examples/cloudflare-worker/src/index.ts

@@ -6,5 +6,5 @@ export default serve({
    mode: "warm",
    onBuilt: async (app) => {
       app.modules.server.get("/custom", (c) => c.json({ hello: "world" }));
-   }
+   },
 });

examples/nextjs/bknd.config.ts

@@ -0,0 +1,74 @@
+import type { NextjsBkndConfig } from "bknd/adapter/nextjs";
+import { boolean, em, entity, text } from "bknd/data";
+import { registerLocalMediaAdapter } from "bknd/adapter/node";
+import { secureRandomString } from "bknd/utils";
+
+// The local media adapter works well in development, and server based
+// deployments. However, on vercel or any other serverless deployments,
+// you shouldn't use a filesystem based media adapter.
+//
+// Additionally, if you run the bknd api on the "edge" runtime,
+// this would not work as well.
+//
+// For production, it is recommended to uncomment the line below.
+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 {
+   app: (env) => ({
+      connection: {
+         url: 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-nextjs-example",
+            secret: secureRandomString(64),
+         },
+         cookie: {
+            pathSuccess: "/ssr",
+            pathLoggedOut: "/ssr",
+         },
+      },
+      // ... and media
+      media: {
+         enabled: true,
+         adapter: local({
+            path: "./public",
+         }),
+      },
+   },
+   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 NextjsBkndConfig;

examples/nextjs/src/bknd.ts

@@ -1,90 +1,11 @@
-import { type NextjsBkndConfig, getApp as getBkndApp } from "bknd/adapter/nextjs";
-import { App } from "bknd";
-import { boolean, em, entity, text } from "bknd/data";
-import { registerLocalMediaAdapter } from "bknd/adapter/node";
-import { secureRandomString } from "bknd/utils";
+import { getApp as getBkndApp } from "bknd/adapter/nextjs";
 import { headers } from "next/headers";
+import config from "../bknd.config";
 
-// The local media adapter works well in development, and server based
-// deployments. However, on vercel or any other serverless deployments,
-// you shouldn't use a filesystem based media adapter.
-//
-// Additionally, if you run the bknd api on the "edge" runtime,
-// this would not work as well.
-//
-// For production, it is recommended to uncomment the line below.
-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 const config = {
-   connection: {
-      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-nextjs-example",
-            secret: secureRandomString(64),
-         },
-         cookie: {
-            pathSuccess: "/ssr",
-            pathLoggedOut: "/ssr",
-         },
-      },
-      // ... and media
-      media: {
-         enabled: true,
-         adapter: {
-            type: "local",
-            config: {
-               path: "./public",
-            },
-         },
-      },
-   },
-   options: {
-      // the seed option is only executed if the database was empty
-      seed: async (ctx) => {
-         await ctx.em.mutator("todos").insertMany([
-            { title: "Learn bknd", done: true },
-            { title: "Build something cool", done: false },
-         ]);
-      },
-   },
-   // here we can hook into the app lifecycle events ...
-   beforeBuild: async (app) => {
-      app.emgr.onEvent(
-         App.Events.AppFirstBoot,
-         async () => {
-            // ... to create an initial user
-            await app.module.auth.createUser({
-               email: "test@bknd.io",
-               password: "12345678",
-            });
-         },
-         "sync",
-      );
-   },
-} as const satisfies NextjsBkndConfig;
+export { config };
 
 export async function getApp() {
-   return await getBkndApp(config);
+   return await getBkndApp(config, process.env);
 }
 
 export async function getApi(opts?: { verify?: boolean }) {

examples/react-router/app/bknd.ts

@@ -1,79 +1,8 @@
-import { App } from "bknd";
-import { registerLocalMediaAdapter } from "bknd/adapter/node";
-import { type ReactRouterBkndConfig, getApp as getBkndApp } from "bknd/adapter/react-router";
-import { boolean, em, entity, text } from "bknd/data";
-import { secureRandomString } from "bknd/utils";
+import { getApp as getBkndApp } from "bknd/adapter/react-router";
+import config from "../bknd.config";
 
-// since we're running in node, we can register the local media adapter
-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 {}
-}
-
-const config = {
-   // we can use any libsql config, and if omitted, uses in-memory
-   connection: {
-      url: "file:test.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-remix-example",
-            secret: secureRandomString(64),
-         },
-      },
-      // ... and media
-      media: {
-         enabled: true,
-         adapter: {
-            type: "local",
-            config: {
-               path: "./public",
-            },
-         },
-      },
-   },
-   options: {
-      // the seed option is only executed if the database was empty
-      seed: async (ctx) => {
-         await ctx.em.mutator("todos").insertMany([
-            { title: "Learn bknd", done: true },
-            { title: "Build something cool", done: false },
-         ]);
-      },
-   },
-   // here we can hook into the app lifecycle events ...
-   beforeBuild: async (app) => {
-      app.emgr.onEvent(
-         App.Events.AppFirstBoot,
-         async () => {
-            // ... to create an initial user
-            await app.module.auth.createUser({
-               email: "test@bknd.io",
-               password: "12345678",
-            });
-         },
-         "sync",
-      );
-   },
-} as const satisfies ReactRouterBkndConfig;
-
-export async function getApp(args?: { request: Request }) {
-   return await getBkndApp(config, args);
+export async function getApp() {
+   return await getBkndApp(config, process.env as any);
 }
 
 export async function getApi(args?: { request: Request }, opts?: { verify?: boolean }) {

examples/react-router/app/routes/api.$.ts

@@ -1,7 +1,7 @@
 import { getApp } from "~/bknd";
 
 const handler = async (args: { request: Request }) => {
-   const app = await getApp(args);
+   const app = await getApp();
    return app.fetch(args.request);
 };
 

examples/react-router/bknd.config.ts

@@ -0,0 +1,64 @@
+import { registerLocalMediaAdapter } from "bknd/adapter/node";
+import type { ReactRouterBkndConfig } from "bknd/adapter/react-router";
+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
+   app: (env) => ({
+      connection: {
+         url: 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-remix-example",
+            secret: secureRandomString(64),
+         },
+      },
+      // ... and media
+      media: {
+         enabled: true,
+         adapter: local({
+            path: "./public",
+         }),
+      },
+   },
+   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 ReactRouterBkndConfig<{ DB_URL?: string }>;