fix: rename DATABRICKS_SERVING_ENDPOINT to DATABRICKS_SERVING_ENDPOINT_NAME in type generator

pkosiec · pkosiec · commit e1068f633549 · 2026-04-10T10:24:55.000+02:00
Signed-off-by: Pawel Kosiec &lt;pawel.kosiec@databricks.com&gt;
diff --git a/apps/dev-playground/client/src/appKitServingTypes.d.ts b/apps/dev-playground/client/src/appKitServingTypes.d.ts
@@ -0,0 +1,114 @@
+// Auto-generated by AppKit - DO NOT EDIT
+// Generated from serving endpoint OpenAPI schemas
+import "@databricks/appkit";
+import "@databricks/appkit-ui/react";
+
+declare module "@databricks/appkit" {
+  interface ServingEndpointRegistry {
+    default: {
+      request: {
+        messages?: {
+          role?: "user" | "assistant";
+          content?: string;
+        }[];
+        /** @openapi integer, nullable */
+        n?: number | null;
+        max_tokens?: number;
+        /** @openapi double, nullable */
+        top_p?: number | null;
+        reasoning_effort?: "low" | "medium" | "high" | null;
+        /** @openapi double, nullable */
+        temperature?: number | null;
+        stop?: string | string[] | null;
+      };
+      response: {
+        model?: string;
+        choices?: {
+          index?: number;
+          message?: {
+            role?: "user" | "assistant";
+            content?: string;
+          };
+          finish_reason?: string;
+        }[];
+        usage?: {
+          prompt_tokens?: number;
+          completion_tokens?: number;
+          total_tokens?: number;
+        } | null;
+        object?: string;
+        id?: string;
+        created?: number;
+      };
+      chunk: {
+        model?: string;
+        choices?: {
+          index?: number;
+          delta?: {
+            role?: "user" | "assistant";
+            content?: string;
+          };
+          finish_reason?: string | null;
+        }[];
+        object?: string;
+        id?: string;
+        created?: number;
+      };
+    };
+  }
+}
+
+declare module "@databricks/appkit-ui/react" {
+  interface ServingEndpointRegistry {
+    default: {
+      request: {
+        messages?: {
+          role?: "user" | "assistant";
+          content?: string;
+        }[];
+        /** @openapi integer, nullable */
+        n?: number | null;
+        max_tokens?: number;
+        /** @openapi double, nullable */
+        top_p?: number | null;
+        reasoning_effort?: "low" | "medium" | "high" | null;
+        /** @openapi double, nullable */
+        temperature?: number | null;
+        stop?: string | string[] | null;
+      };
+      response: {
+        model?: string;
+        choices?: {
+          index?: number;
+          message?: {
+            role?: "user" | "assistant";
+            content?: string;
+          };
+          finish_reason?: string;
+        }[];
+        usage?: {
+          prompt_tokens?: number;
+          completion_tokens?: number;
+          total_tokens?: number;
+        } | null;
+        object?: string;
+        id?: string;
+        created?: number;
+      };
+      chunk: {
+        model?: string;
+        choices?: {
+          index?: number;
+          delta?: {
+            role?: "user" | "assistant";
+            content?: string;
+          };
+          finish_reason?: string | null;
+        }[];
+        object?: string;
+        id?: string;
+        created?: number;
+      };
+    };
+  }
+}
diff --git a/docs/docs/api/appkit/Function.appKitServingTypesPlugin.md b/docs/docs/api/appkit/Function.appKitServingTypesPlugin.md
@@ -11,7 +11,7 @@ ServingEndpointRegistry module augmentation.
 Endpoint discovery order:
 1. Explicit `endpoints` option (override)
 2. AST extraction from server file (server/index.ts or server/server.ts)
-3. DATABRICKS_SERVING_ENDPOINT env var (single default endpoint)
+3. DATABRICKS_SERVING_ENDPOINT_NAME env var (single default endpoint)
 
 ## Parameters
 
diff --git a/packages/appkit/src/type-generator/serving/generator.ts b/packages/appkit/src/type-generator/serving/generator.ts
@@ -226,8 +226,8 @@ export async function generateServingTypes(
 }
 
 function resolveDefaultEndpoints(): Record<string, EndpointConfig> {
-  if (process.env.DATABRICKS_SERVING_ENDPOINT) {
-    return { default: { env: "DATABRICKS_SERVING_ENDPOINT" } };
+  if (process.env.DATABRICKS_SERVING_ENDPOINT_NAME) {
+    return { default: { env: "DATABRICKS_SERVING_ENDPOINT_NAME" } };
   }
   return {};
 }
diff --git a/packages/appkit/src/type-generator/serving/server-file-extractor.ts b/packages/appkit/src/type-generator/serving/server-file-extractor.ts
@@ -175,7 +175,7 @@ function getPropertyValue(pairNode: SgNode): SgNode | null {
 
 /**
  * Extract a single endpoint entry from a pair node like:
- * `demo: { env: "DATABRICKS_SERVING_ENDPOINT", servedModel: "my-model" }`
+ * `demo: { env: "DATABRICKS_SERVING_ENDPOINT_NAME", servedModel: "my-model" }`
  */
 function extractEndpointEntry(
   pair: SgNode,
diff --git a/packages/appkit/src/type-generator/serving/tests/generator.test.ts b/packages/appkit/src/type-generator/serving/tests/generator.test.ts
@@ -97,7 +97,7 @@ describe("generateServingTypes", () => {
 
   afterEach(() => {
     delete process.env.TEST_SERVING_ENDPOINT;
-    delete process.env.DATABRICKS_SERVING_ENDPOINT;
+    delete process.env.DATABRICKS_SERVING_ENDPOINT_NAME;
     vi.restoreAllMocks();
   });
 
@@ -191,8 +191,8 @@ describe("generateServingTypes", () => {
     expect(output).toContain("Record<string, unknown>");
   });
 
-  test("resolves default endpoint from DATABRICKS_SERVING_ENDPOINT", async () => {
-    process.env.DATABRICKS_SERVING_ENDPOINT = "my-default-endpoint";
+  test("resolves default endpoint from DATABRICKS_SERVING_ENDPOINT_NAME", async () => {
+    process.env.DATABRICKS_SERVING_ENDPOINT_NAME = "my-default-endpoint";
     mockFetchOpenApiSchema.mockResolvedValue({
       spec: CHAT_OPENAPI_SPEC,
       pathKey: "/served-models/llm/invocations",
diff --git a/packages/appkit/src/type-generator/serving/tests/server-file-extractor.test.ts b/packages/appkit/src/type-generator/serving/tests/server-file-extractor.test.ts
@@ -52,7 +52,7 @@ createApp({
   plugins: [
     serving({
       endpoints: {
-        demo: { env: "DATABRICKS_SERVING_ENDPOINT" },
+        demo: { env: "DATABRICKS_SERVING_ENDPOINT_NAME" },
         second: { env: "DATABRICKS_SERVING_ENDPOINT_SECOND" },
       }
     }),
@@ -62,7 +62,7 @@ createApp({
 
     const result = extractServingEndpoints("/app/server/index.ts");
     expect(result).toEqual({
-      demo: { env: "DATABRICKS_SERVING_ENDPOINT" },
+      demo: { env: "DATABRICKS_SERVING_ENDPOINT_NAME" },
       second: { env: "DATABRICKS_SERVING_ENDPOINT_SECOND" },
     });
   });
@@ -75,7 +75,7 @@ createApp({
   plugins: [
     serving({
       endpoints: {
-        demo: { env: "DATABRICKS_SERVING_ENDPOINT", servedModel: "my-model" },
+        demo: { env: "DATABRICKS_SERVING_ENDPOINT_NAME", servedModel: "my-model" },
       }
     }),
   ],
@@ -84,7 +84,10 @@ createApp({
 
     const result = extractServingEndpoints("/app/server/index.ts");
     expect(result).toEqual({
-      demo: { env: "DATABRICKS_SERVING_ENDPOINT", servedModel: "my-model" },
+      demo: {
+        env: "DATABRICKS_SERVING_ENDPOINT_NAME",
+        servedModel: "my-model",
+      },
     });
   });
 
@@ -133,7 +136,7 @@ createApp({
     mockServerFile(`
 import { createApp, serving } from '@databricks/appkit';
 
-const myEndpoints = { demo: { env: "DATABRICKS_SERVING_ENDPOINT" } };
+const myEndpoints = { demo: { env: "DATABRICKS_SERVING_ENDPOINT_NAME" } };
 createApp({
   plugins: [
     serving({ endpoints: myEndpoints }),
@@ -175,7 +178,7 @@ createApp({
   plugins: [
     serving({
       endpoints: {
-        demo: { env: 'DATABRICKS_SERVING_ENDPOINT' },
+        demo: { env: 'DATABRICKS_SERVING_ENDPOINT_NAME' },
       }
     }),
   ],
@@ -184,7 +187,7 @@ createApp({
 
     const result = extractServingEndpoints("/app/server/index.ts");
     expect(result).toEqual({
-      demo: { env: "DATABRICKS_SERVING_ENDPOINT" },
+      demo: { env: "DATABRICKS_SERVING_ENDPOINT_NAME" },
     });
   });
 
@@ -196,7 +199,7 @@ createApp({
   plugins: [
     serving({
       endpoints: {
-        demo: { env: "DATABRICKS_SERVING_ENDPOINT" },
+        demo: { env: "DATABRICKS_SERVING_ENDPOINT_NAME" },
         second: { env: "DATABRICKS_SERVING_ENDPOINT_SECOND" },
       },
     }),
@@ -206,7 +209,7 @@ createApp({
 
     const result = extractServingEndpoints("/app/server/index.ts");
     expect(result).toEqual({
-      demo: { env: "DATABRICKS_SERVING_ENDPOINT" },
+      demo: { env: "DATABRICKS_SERVING_ENDPOINT_NAME" },
       second: { env: "DATABRICKS_SERVING_ENDPOINT_SECOND" },
     });
   });
diff --git a/packages/appkit/src/type-generator/serving/tests/vite-plugin.test.ts b/packages/appkit/src/type-generator/serving/tests/vite-plugin.test.ts
@@ -40,8 +40,8 @@ describe("appKitServingTypesPlugin", () => {
       expect((plugin as any).apply()).toBe(true);
     });
 
-    test("returns true when DATABRICKS_SERVING_ENDPOINT is set", () => {
-      process.env.DATABRICKS_SERVING_ENDPOINT = "my-endpoint";
+    test("returns true when DATABRICKS_SERVING_ENDPOINT_NAME is set", () => {
+      process.env.DATABRICKS_SERVING_ENDPOINT_NAME = "my-endpoint";
       const plugin = appKitServingTypesPlugin();
       expect((plugin as any).apply()).toBe(true);
     });
@@ -61,7 +61,7 @@ describe("appKitServingTypesPlugin", () => {
     });
 
     test("returns false when nothing configured", () => {
-      delete process.env.DATABRICKS_SERVING_ENDPOINT;
+      delete process.env.DATABRICKS_SERVING_ENDPOINT_NAME;
       mockFindServerFile.mockReturnValue(null);
       const plugin = appKitServingTypesPlugin();
       expect((plugin as any).apply()).toBe(false);
diff --git a/packages/appkit/src/type-generator/serving/vite-plugin.ts b/packages/appkit/src/type-generator/serving/vite-plugin.ts
@@ -13,7 +13,7 @@ const logger = createLogger("type-generator:serving:vite-plugin");
 interface AppKitServingTypesPluginOptions {
   /** Path to the output .d.ts file (relative to client root). Default: "src/appKitServingTypes.d.ts" */
   outFile?: string;
-  /** Endpoint config override. If omitted, auto-discovers from the server file or falls back to DATABRICKS_SERVING_ENDPOINT env var. */
+  /** Endpoint config override. If omitted, auto-discovers from the server file or falls back to DATABRICKS_SERVING_ENDPOINT_NAME env var. */
   endpoints?: Record<string, EndpointConfig>;
 }
 
@@ -25,7 +25,7 @@ interface AppKitServingTypesPluginOptions {
  * Endpoint discovery order:
  * 1. Explicit `endpoints` option (override)
  * 2. AST extraction from server file (server/index.ts or server/server.ts)
- * 3. DATABRICKS_SERVING_ENDPOINT env var (single default endpoint)
+ * 3. DATABRICKS_SERVING_ENDPOINT_NAME env var (single default endpoint)
  */
 export function appKitServingTypesPlugin(
   options?: AppKitServingTypesPluginOptions,
@@ -66,7 +66,7 @@ export function appKitServingTypesPlugin(
         return true;
       }
 
-      if (process.env.DATABRICKS_SERVING_ENDPOINT) {
+      if (process.env.DATABRICKS_SERVING_ENDPOINT_NAME) {
         return true;
       }
 

Original file line number	Diff line number	Diff line change
`@@ -226,8 +226,8 @@ export async function generateServingTypes(`
`226`	`226`	`}`
`227`	`227`
`228`	`228`	`function resolveDefaultEndpoints(): Record<string, EndpointConfig> {`
`229`		`- if (process.env.DATABRICKS_SERVING_ENDPOINT) {`
`230`		`- return { default: { env: "DATABRICKS_SERVING_ENDPOINT" } };`
	`229`	`+ if (process.env.DATABRICKS_SERVING_ENDPOINT_NAME) {`
	`230`	`+ return { default: { env: "DATABRICKS_SERVING_ENDPOINT_NAME" } };`
`231`	`231`	`}`
`232`	`232`	`return {};`
`233`	`233`	`}`