feat(appkit): introduce Lakebase plugin (#126)

* feat(appkit): introduce Lakebase plugin

* docs: describe how to connect an AppKit app with Lakebase

* chore: regenerate types

* chore: use biome-ignore comments

* chore: fix docs build

* chore: add a note about having the plugin experimental

* chore: bring back the "onSetupMessage"

* chore: address comments

* chore: regenerate docs

Author: pkosiec

apps/dev-playground/server/lakebase-examples-plugin.ts

@@ -1,4 +1,4 @@
-import { Plugin, toPlugin } from "@databricks/appkit";
+import { getUsernameWithApiLookup, Plugin, toPlugin } from "@databricks/appkit";
 import type { IAppRouter } from "shared";
 import * as drizzleExample from "./lakebase-examples/drizzle-example";
 import * as rawExample from "./lakebase-examples/raw-driver-example";
@@ -42,12 +42,14 @@ export class LakebaseExamplesPlugin extends Plugin {
     }
 
     try {
+      const user = await getUsernameWithApiLookup();
+
       // Initialize all four examples in parallel
       await Promise.all([
-        rawExample.setup(),
-        drizzleExample.setup(),
-        typeormExample.setup(),
-        sequelizeExample.setup(),
+        rawExample.setup(user),
+        drizzleExample.setup(user),
+        typeormExample.setup(user),
+        sequelizeExample.setup(user),
       ]);
     } catch (error) {
       console.error("Failed to initialize Lakebase examples:", error);

apps/dev-playground/server/lakebase-examples/drizzle-example.ts

@@ -45,8 +45,8 @@ type NewActivityLog = typeof activityLogs.$inferInsert;
 let db: ReturnType<typeof drizzle>;
 let pool: Pool;
 
-export async function setup() {
-  pool = createLakebasePool();
+export async function setup(user?: string) {
+  pool = createLakebasePool({ user });
   db = drizzle(pool);
 
   // For production apps, use: npx drizzle-kit push or drizzle-kit generate + migrate

apps/dev-playground/server/lakebase-examples/raw-driver-example.ts

@@ -25,9 +25,9 @@ interface Product {
   created_at: Date;
 }
 
-export async function setup() {
+export async function setup(user?: string) {
   // Create pool with automatic OAuth token refresh
-  pool = createLakebasePool();
+  pool = createLakebasePool({ user });
 
   // Create schema and table (idempotent)
   await pool.query(`

apps/dev-playground/server/lakebase-examples/sequelize-example.ts

@@ -43,11 +43,11 @@ class Order
 
 let sequelize: Sequelize;
 
-export async function setup() {
+export async function setup(user?: string) {
   // @ts-expect-error password property supports a function for Lakehouse OAuth tokens
   sequelize = new Sequelize({
     dialect: "postgres",
-    ...getLakebaseOrmConfig(),
+    ...getLakebaseOrmConfig({ user }),
     logging: false,
   });
 

apps/dev-playground/server/lakebase-examples/typeorm-example.ts

@@ -43,16 +43,16 @@ class Task {
 
 let dataSource: DataSource;
 
-export async function setup() {
+export async function setup(user?: string) {
   // Create schema if not exists (TypeORM's synchronize doesn't create schemas)
   // See https://github.com/typeorm/typeorm/issues/3192
-  const pool = createLakebasePool();
+  const pool = createLakebasePool({ user });
   await pool.query("CREATE SCHEMA IF NOT EXISTS typeorm_example");
   await pool.end();
 
   dataSource = new DataSource({
     type: "postgres",
-    ...getLakebaseOrmConfig(),
+    ...getLakebaseOrmConfig({ user }),
     entities: [Task],
     synchronize: true,
     logging: false,

docs/docs/architecture.md

@@ -47,7 +47,7 @@ The backend SDK that provides the plugin architecture and core functionality. It
 - Cache management and streaming capabilities
 - Type generation for SQL queries
 
-See the [Plugins](./plugins.md) and [API reference](./api/appkit/) documentation for detailed information.
+See the [Plugins](./plugins/index.md) and [API reference](./api/appkit/) documentation for detailed information.
 
 ### @databricks/appkit-ui
 
@@ -87,7 +87,7 @@ Integration with Databricks services:
 
 ## See also
 
-- [Plugins](./plugins.md): Deep dive into the plugin system
+- [Plugins](./plugins/index.md): Deep dive into the plugin system
 - [API reference](./api/): Complete API documentation
 - [Development](./development/): Explore development workflows
 - [Core Principles](./core-principles.md): Learn about AppKit's design philosophy

docs/docs/configuration.mdx

@@ -142,4 +142,4 @@ For advanced Databricks Apps configuration (authorization, networking, resource
 ## See also
 
 - [App management](./app-management.mdx) - Deploying and managing apps
-- [Plugins](./plugins.md) - Plugin configuration options
+- [Plugins](./plugins/index.md) - Plugin configuration options

docs/docs/development/project-setup.md

@@ -232,4 +232,4 @@ Then create `config/queries/` and add your `.sql` files.
 
 - [Local development](./local-development.mdx) - Running the dev server
 - [Configuration](../configuration.mdx) - Environment variables
-- [Plugins](../plugins.md) - Plugin configuration
+- [Plugins](../plugins/index.md) - Plugin configuration

docs/docs/development/type-generation.md

@@ -104,5 +104,5 @@ data?.forEach(row => {
 
 ## See also
 
-- [Plugins](../plugins.md) - Analytics plugin configuration
+- [Plugins](../plugins/index.md) - Analytics plugin configuration
 - [API Reference](/docs/api/appkit-ui) - Complete UI components API documentation