refactor: toPlugin api (#133)

Author: MarioCadenas

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

@@ -1,4 +1,9 @@
-import { getUsernameWithApiLookup, Plugin, toPlugin } from "@databricks/appkit";
+import {
+  getUsernameWithApiLookup,
+  Plugin,
+  type PluginManifest,
+  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";
@@ -19,7 +24,6 @@ import * as typeormExample from "./lakebase-examples/typeorm-example";
  */
 
 export class LakebaseExamplesPlugin extends Plugin {
-  public name = "lakebase-examples";
   protected envVars: string[] = [];
 
   static manifest = {
@@ -30,7 +34,7 @@ export class LakebaseExamplesPlugin extends Plugin {
       required: [],
       optional: [],
     },
-  };
+  } satisfies PluginManifest<"lakebase-examples">;
 
   async setup() {
     // Check if Lakebase is configured
@@ -80,8 +84,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

@@ -1,4 +1,4 @@
-import { Plugin, toPlugin } from "@databricks/appkit";
+import { Plugin, type PluginManifest, toPlugin } from "@databricks/appkit";
 import type { IAppRouter, StreamExecutionSettings } from "shared";
 
 interface ReconnectResponse {
@@ -14,8 +14,6 @@ interface ReconnectStreamResponse {
 }
 
 export class ReconnectPlugin extends Plugin {
-  public name = "reconnect";
-
   static manifest = {
     name: "reconnect",
     displayName: "Reconnect Plugin",
@@ -24,7 +22,7 @@ export class ReconnectPlugin extends Plugin {
       required: [],
       optional: [],
     },
-  };
+  } satisfies PluginManifest<"reconnect">;
 
   injectRoutes(router: IAppRouter): void {
     this.route<ReconnectResponse>(router, {
@@ -84,8 +82,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

@@ -8,6 +8,7 @@ import {
   type Counter,
   type Histogram,
   Plugin,
+  type PluginManifest,
   SeverityNumber,
   type Span,
   SpanStatusCode,
@@ -16,8 +17,6 @@ import {
 import type { Request, Response, Router } from "express";
 
 class TelemetryExamples extends Plugin {
-  public name = "telemetry-examples" as const;
-
   static manifest = {
     name: "telemetry-examples",
     displayName: "Telemetry Examples Plugin",
@@ -26,7 +25,7 @@ class TelemetryExamples extends Plugin {
       required: [],
       optional: [],
     },
-  };
+  } satisfies PluginManifest<"telemetry-examples">;
 
   private requestCounter: Counter;
   private durationHistogram: Histogram;
@@ -522,8 +521,4 @@ class TelemetryExamples extends Plugin {
   }
 }
 
-export const telemetryExamples = toPlugin<
-  typeof TelemetryExamples,
-  BasePluginConfig,
-  "telemetryExamples"
->(TelemetryExamples, "telemetryExamples");
+export const telemetryExamples = toPlugin(TelemetryExamples);

apps/dev-playground/tsconfig.json

@@ -3,6 +3,8 @@
   "compilerOptions": {
     "baseUrl": ".",
     "outDir": "./build",
+    "declaration": false,
+    "declarationMap": false,
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true
   },

docs/docs/api/appkit/Class.Plugin.md

@@ -35,7 +35,6 @@ const myManifest: PluginManifest = {
 
 class MyPlugin extends Plugin<MyConfig> {
   static manifest = myManifest;
-  name = 'myPlugin';
 }
 ```
 
@@ -58,8 +57,7 @@ const myManifest: PluginManifest = {
 };
 
 class MyPlugin extends Plugin<MyConfig> {
-  static manifest = myManifest;
-  name = 'myPlugin';
+  static manifest = myManifest<"myPlugin">;
 
   // Runtime method: converts optional resources to required based on config
   static getResourceRequirements(config: MyConfig) {
@@ -327,7 +325,6 @@ and adds `asUser(req)` for user-scoped execution.
 
 ```ts
 class MyPlugin extends Plugin {
-  name = "myPlugin";
   private getData() { return []; }
 
   exports() {

docs/docs/api/appkit/Class.ResourceRegistry.md

@@ -45,7 +45,7 @@ For each plugin, loads its manifest (required) and runtime resource requirements
 
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
-| `rawPlugins` | `PluginData`\<`PluginConstructor`, `unknown`, `string`\>[] | Array of plugin data entries from createApp configuration |
+| `rawPlugins` | [`PluginData`](TypeAlias.PluginData.md)\<`PluginConstructor`, `unknown`, `string`\>[] | Array of plugin data entries from createApp configuration |
 
 #### Returns
 

docs/docs/api/appkit/Function.createApp.md

@@ -20,7 +20,7 @@ with an `asUser(req)` method for user-scoped execution.
 
 | Type Parameter |
 | ------ |
-| `T` *extends* `PluginData`\<`PluginConstructor`, `unknown`, `string`\>[] |
+| `T` *extends* [`PluginData`](TypeAlias.PluginData.md)\<`PluginConstructor`, `unknown`, `string`\>[] |
 
 ## Parameters
 

docs/docs/api/appkit/Interface.PluginManifest.md

@@ -1,8 +1,14 @@
-# Interface: PluginManifest
+# Interface: PluginManifest\<TName\>
 
 Plugin manifest that declares metadata and resource requirements.
 Attached to plugin classes as a static property.
 
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TName` *extends* `string` | `string` |
+
 ## Properties
 
 ### author?
@@ -83,10 +89,10 @@ optional license: string;
 ### name
 
 ```ts
-name: string;
+name: TName;
 ```
 
-Plugin identifier (matches plugin.name)
+Plugin identifier — the single source of truth for the plugin's name
 
 ***
 

docs/docs/api/appkit/TypeAlias.PluginData.md

@@ -0,0 +1,41 @@
+# Type Alias: PluginData\<T, U, N\>
+
+```ts
+type PluginData<T, U, N> = {
+  config: U;
+  name: N;
+  plugin: T;
+};
+```
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+| `U` |
+| `N` |
+
+## Properties
+
+### config
+
+```ts
+config: U;
+```
+
+***
+
+### name
+
+```ts
+name: N;
+```
+
+***
+
+### plugin
+
+```ts
+plugin: T;
+```

docs/docs/api/appkit/TypeAlias.ToPlugin.md

@@ -20,4 +20,4 @@ type ToPlugin<T, U, N> = (config?: U) => PluginData<T, U, N>;
 
 ## Returns
 
-`PluginData`\<`T`, `U`, `N`\>
+[`PluginData`](TypeAlias.PluginData.md)\<`T`, `U`, `N`\>