refactor: toPlugin api

chore: fixup

Author: MarioCadenas

.cursor/worktrees.json

@@ -1,3 +1,8 @@
 {
-  "setup-worktree": ["pnpm install", "pnpm run build"]
+  "setup-worktree": [
+    "pnpm install",
+    "pnpm run build",
+    "cp $ROOT_WORKTREE_PATH/apps/dev-playground/.env apps/dev-playground/.env",
+    "cp $ROOT_WORKTREE_PATH/apps/clean-app/.env apps/clean-app/.env"
+  ]
 }

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

@@ -19,6 +19,7 @@ import * as typeormExample from "./lakebase-examples/typeorm-example";
  */
 
 export class LakebaseExamplesPlugin extends Plugin {
+  static override readonly name = "lakebase-examples";
   public name = "lakebase-examples";
   protected envVars: string[] = [];
 
@@ -80,8 +81,4 @@ export class LakebaseExamplesPlugin extends Plugin {
   }
 }
 
-export const lakebaseExamples = toPlugin<
-  typeof LakebaseExamplesPlugin,
-  Record<string, never>,
-  "lakebase-examples"
->(LakebaseExamplesPlugin, "lakebase-examples");
+export const lakebaseExamples = toPlugin(LakebaseExamplesPlugin);

apps/dev-playground/server/reconnect-plugin.ts

@@ -14,6 +14,7 @@ interface ReconnectStreamResponse {
 }
 
 export class ReconnectPlugin extends Plugin {
+  static override readonly name = "reconnect";
   public name = "reconnect";
 
   static manifest = {
@@ -84,8 +85,4 @@ export class ReconnectPlugin extends Plugin {
   }
 }
 
-export const reconnect = toPlugin<
-  typeof ReconnectPlugin,
-  Record<string, never>,
-  "reconnect"
->(ReconnectPlugin, "reconnect");
+export const reconnect = toPlugin(ReconnectPlugin);

apps/dev-playground/server/telemetry-example-plugin.ts

@@ -16,6 +16,7 @@ import {
 import type { Request, Response, Router } from "express";
 
 class TelemetryExamples extends Plugin {
+  static override readonly name = "telemetry-examples";
   public name = "telemetry-examples" as const;
 
   static manifest = {
@@ -522,8 +523,4 @@ class TelemetryExamples extends Plugin {
   }
 }
 
-export const telemetryExamples = toPlugin<
-  typeof TelemetryExamples,
-  BasePluginConfig,
-  "telemetryExamples"
->(TelemetryExamples, "telemetryExamples");
+export const telemetryExamples = toPlugin(TelemetryExamples);

docs/docs/plugins/custom-plugins.md

@@ -21,9 +21,9 @@ import { Plugin, toPlugin } from "@databricks/appkit";
 import type express from "express";
 
 class MyPlugin extends Plugin {
+  static override readonly name = "myPlugin";
   name = "myPlugin";
 
-  // Define resource requirements in the static manifest
   static manifest = {
     name: "myPlugin",
     displayName: "My Plugin",
@@ -59,17 +59,13 @@ class MyPlugin extends Plugin {
   }
 
   exports() {
-    // an object with the methods from this plugin to expose
     return {
       myCustomMethod: this.myCustomMethod
     }
   }
 }
 
-export const myPlugin = toPlugin<typeof MyPlugin, Record<string, never>, "myPlugin">(
-  MyPlugin,
-  "myPlugin",
-);
+export const myPlugin = toPlugin(MyPlugin);
 ```
 
 ## Config-dependent resources
@@ -84,6 +80,7 @@ interface MyPluginConfig extends BasePluginConfig {
 }
 
 class MyPlugin extends Plugin<MyPluginConfig> {
+  static override readonly name = "myPlugin";
   name = "myPlugin";
 
   static manifest = {

packages/appkit/src/plugin/to-plugin.ts

@@ -1,15 +1,19 @@
-import type { PluginData, ToPlugin } from "shared";
+import type { PluginConstructor, PluginData, ToPlugin } from "shared";
 
 /**
+ * Wraps a plugin class so it can be passed to createApp with optional config.
+ * Infers config type from the constructor and plugin name from the static `name` property.
+ *
  * @internal
  */
-export function toPlugin<T, U, N extends string>(
+export function toPlugin<T extends PluginConstructor & { name: string }>(
   plugin: T,
-  name: N,
-): ToPlugin<T, U, N> {
-  return (config: U = {} as U): PluginData<T, U, N> => ({
+): ToPlugin<T, ConstructorParameters<T>[0], T["name"]> {
+  type Config = ConstructorParameters<T>[0];
+  type Name = T["name"];
+  return (config: Config = {} as Config): PluginData<T, Config, Name> => ({
     plugin: plugin as T,
-    config: config as U,
-    name,
+    config: config as Config,
+    name: plugin.name as Name,
   });
 }

packages/appkit/src/plugins/analytics/analytics.ts

@@ -26,6 +26,7 @@ import type {
 const logger = createLogger("analytics");
 
 export class AnalyticsPlugin extends Plugin {
+  static override readonly name = "analytics";
   name = "analytics";
 
   /** Plugin manifest declaring metadata and resource requirements */
@@ -285,8 +286,4 @@ export class AnalyticsPlugin extends Plugin {
 /**
  * @internal
  */
-export const analytics = toPlugin<
-  typeof AnalyticsPlugin,
-  IAnalyticsConfig,
-  "analytics"
->(AnalyticsPlugin, "analytics");
+export const analytics = toPlugin(AnalyticsPlugin);

packages/appkit/src/plugins/genie/genie.ts

@@ -17,6 +17,7 @@ import type {
 const logger = createLogger("genie");
 
 export class GeniePlugin extends Plugin {
+  static override readonly name = "genie";
   name = "genie";
 
   static manifest = genieManifest;
@@ -230,7 +231,4 @@ export class GeniePlugin extends Plugin {
 /**
  * @internal
  */
-export const genie = toPlugin<typeof GeniePlugin, IGenieConfig, "genie">(
-  GeniePlugin,
-  "genie",
-);
+export const genie = toPlugin(GeniePlugin);

packages/appkit/src/plugins/lakebase/lakebase.ts

@@ -30,6 +30,7 @@ const logger = createLogger("lakebase");
  * ```
  */
 export class LakebasePlugin extends Plugin {
+  static override readonly name = "lakebase";
   name = "lakebase";
 
   /** Plugin manifest declaring metadata and resource requirements */
@@ -117,8 +118,4 @@ export class LakebasePlugin extends Plugin {
 /**
  * @internal
  */
-export const lakebase = toPlugin<
-  typeof LakebasePlugin,
-  ILakebaseConfig,
-  "lakebase"
->(LakebasePlugin, "lakebase");
+export const lakebase = toPlugin(LakebasePlugin);

packages/appkit/src/plugins/server/index.ts

@@ -43,6 +43,7 @@ export class ServerPlugin extends Plugin {
   /** Plugin manifest declaring metadata and resource requirements */
   static manifest = serverManifest;
 
+  static override readonly name = "server";
   public name = "server" as const;
   private serverApplication: express.Application;
   private server: HTTPServer | null;
@@ -354,10 +355,7 @@ const EXCLUDED_PLUGINS = [ServerPlugin.name];
 /**
  * @internal
  */
-export const server = toPlugin<typeof ServerPlugin, ServerConfig, "server">(
-  ServerPlugin,
-  "server",
-);
+export const server = toPlugin(ServerPlugin);
 
 // Export manifest and types
 export { serverManifest } from "./manifest";