@bodhiapp/ts-client 0.1.7 → 0.1.8

package/dist/openapi-typescript/openapi-schema.d.ts

@@ -885,6 +885,18 @@ export interface components {
         ApiFormatsResponse: {
             data: components["schemas"]["ApiFormat"][];
         };
+        /** @description Validated API key wrapper - validates length when Some, allows None for public APIs */
+        ApiKey: string | null;
+        /** @description Represents an API key update action for API model updates */
+        ApiKeyUpdateAction: {
+            /** @enum {string} */
+            action: "keep";
+        } | {
+            /** @description Set a new API key (or add one if none exists) - can be None for public APIs */
+            value: components["schemas"]["ApiKey"];
+            /** @enum {string} */
+            action: "set";
+        };
         /**
          * @description Response containing API model configuration
          * @example {
@@ -905,7 +917,7 @@ export interface components {
             id: string;
             api_format: components["schemas"]["ApiFormat"];
             base_url: string;
-            api_key_masked: string;
+            api_key_masked?: string | null;
             models: string[];
             prefix?: string | null;
             /** Format: date-time */
@@ -951,6 +963,7 @@ export interface components {
         /**
          * @description Application information and status
          * @example {
+         *       "commit_sha": "abc1234",
          *       "status": "ready",
          *       "version": "0.1.0"
          *     }
@@ -961,6 +974,11 @@ export interface components {
              * @example 0.1.0
              */
             version: string;
+            /**
+             * @description Git commit SHA of the build
+             * @example abc1234
+             */
+            commit_sha: string;
             /** @description Current application setup and operational status */
             status: components["schemas"]["AppStatus"];
         };
@@ -1355,8 +1373,8 @@ export interface components {
             api_format: components["schemas"]["ApiFormat"];
             /** @description API base URL */
             base_url: string;
-            /** @description API key for authentication */
-            api_key: string;
+            /** @description API key for authentication (null for public APIs) */
+            api_key?: components["schemas"]["ApiKey"];
             /** @description List of available models */
             models: string[];
             /** @description Optional prefix for model namespacing (e.g., "azure/" for "azure/gpt-4", "openai:" for "openai:gpt-4") */
@@ -1650,16 +1668,17 @@ export interface components {
         /**
          * @description Request to fetch available models from provider
          * @example {
-         *       "api_key": "sk-...",
-         *       "base_url": "https://api.openai.com/v1"
+         *       "base_url": "http://localhost:8080/v1",
+         *       "creds": {
+         *         "type": "api_key",
+         *         "value": null
+         *       }
          *     }
          */
         FetchModelsRequest: {
-            /** @description API key for authentication (provide either api_key OR id, api_key takes preference if both provided) */
-            api_key?: string;
-            /** @description API model ID to look up stored credentials (provide either api_key OR id, api_key takes preference if both provided) */
-            id?: string;
-            /** @description API base URL (optional when using id) */
+            /** @description Credentials to use for fetching models */
+            creds?: components["schemas"]["TestCreds"];
+            /** @description API base URL (required - always needed to know where to fetch models from) */
             base_url: string;
         };
         /**
@@ -2147,21 +2166,34 @@ export interface components {
             template: string;
         };
         Stop: string | string[];
+        /** @description Credentials for test/fetch operations */
+        TestCreds: {
+            /** @description Look up credentials from stored API model */
+            value: string;
+            /** @enum {string} */
+            type: "id";
+        } | {
+            /** @description Use direct API key (null for no authentication) */
+            value: components["schemas"]["ApiKey"];
+            /** @enum {string} */
+            type: "api_key";
+        };
         /**
          * @description Request to test API connectivity with a prompt
          * @example {
-         *       "api_key": "sk-...",
          *       "base_url": "https://api.openai.com/v1",
+         *       "creds": {
+         *         "type": "api_key",
+         *         "value": "sk-..."
+         *       },
          *       "model": "gpt-4",
          *       "prompt": "Hello, how are you?"
          *     }
          */
         TestPromptRequest: {
-            /** @description API key for authentication (provide either api_key OR id, api_key takes preference if both provided) */
-            api_key?: string;
-            /** @description API model ID to look up stored credentials (provide either api_key OR id, api_key takes preference if both provided) */
-            id?: string;
-            /** @description API base URL (optional when using id) */
+            /** @description Credentials to use for testing */
+            creds?: components["schemas"]["TestCreds"];
+            /** @description API base URL */
             base_url: string;
             /** @description Model to use for testing */
             model: string;
@@ -2211,7 +2243,9 @@ export interface components {
          * @description Request to update an existing API model configuration
          * @example {
          *       "api_format": "openai",
-         *       "api_key": "sk-new-key",
+         *       "api_key": {
+         *         "action": "keep"
+         *       },
          *       "base_url": "https://api.openai.com/v1",
          *       "models": [
          *         "gpt-4-turbo",
@@ -2225,8 +2259,8 @@ export interface components {
             api_format: components["schemas"]["ApiFormat"];
             /** @description API base URL (required) */
             base_url: string;
-            /** @description API key for authentication (optional, only update if provided for security) */
-            api_key?: string | null;
+            /** @description API key update action (Keep/Set with Some or None) */
+            api_key?: components["schemas"]["ApiKeyUpdateAction"];
             /** @description List of available models (required) */
             models: string[];
             /** @description Optional prefix for model namespacing */
@@ -3759,6 +3793,7 @@ export interface operations {
                 };
                 content: {
                     /** @example {
+                     *       "commit_sha": "abc1234",
                      *       "status": "ready",
                      *       "version": "0.1.0"
                      *     } */

package/dist/openapi-typescript/openapi-schema.ts

@@ -886,6 +886,18 @@ export interface components {
         ApiFormatsResponse: {
             data: components["schemas"]["ApiFormat"][];
         };
+        /** @description Validated API key wrapper - validates length when Some, allows None for public APIs */
+        ApiKey: string | null;
+        /** @description Represents an API key update action for API model updates */
+        ApiKeyUpdateAction: {
+            /** @enum {string} */
+            action: "keep";
+        } | {
+            /** @description Set a new API key (or add one if none exists) - can be None for public APIs */
+            value: components["schemas"]["ApiKey"];
+            /** @enum {string} */
+            action: "set";
+        };
         /**
          * @description Response containing API model configuration
          * @example {
@@ -906,7 +918,7 @@ export interface components {
             id: string;
             api_format: components["schemas"]["ApiFormat"];
             base_url: string;
-            api_key_masked: string;
+            api_key_masked?: string | null;
             models: string[];
             prefix?: string | null;
             /** Format: date-time */
@@ -952,6 +964,7 @@ export interface components {
         /**
          * @description Application information and status
          * @example {
+         *       "commit_sha": "abc1234",
          *       "status": "ready",
          *       "version": "0.1.0"
          *     }
@@ -962,6 +975,11 @@ export interface components {
              * @example 0.1.0
              */
             version: string;
+            /**
+             * @description Git commit SHA of the build
+             * @example abc1234
+             */
+            commit_sha: string;
             /** @description Current application setup and operational status */
             status: components["schemas"]["AppStatus"];
         };
@@ -1356,8 +1374,8 @@ export interface components {
             api_format: components["schemas"]["ApiFormat"];
             /** @description API base URL */
             base_url: string;
-            /** @description API key for authentication */
-            api_key: string;
+            /** @description API key for authentication (null for public APIs) */
+            api_key?: components["schemas"]["ApiKey"];
             /** @description List of available models */
             models: string[];
             /** @description Optional prefix for model namespacing (e.g., "azure/" for "azure/gpt-4", "openai:" for "openai:gpt-4") */
@@ -1651,16 +1669,17 @@ export interface components {
         /**
          * @description Request to fetch available models from provider
          * @example {
-         *       "api_key": "sk-...",
-         *       "base_url": "https://api.openai.com/v1"
+         *       "base_url": "http://localhost:8080/v1",
+         *       "creds": {
+         *         "type": "api_key",
+         *         "value": null
+         *       }
          *     }
          */
         FetchModelsRequest: {
-            /** @description API key for authentication (provide either api_key OR id, api_key takes preference if both provided) */
-            api_key?: string;
-            /** @description API model ID to look up stored credentials (provide either api_key OR id, api_key takes preference if both provided) */
-            id?: string;
-            /** @description API base URL (optional when using id) */
+            /** @description Credentials to use for fetching models */
+            creds?: components["schemas"]["TestCreds"];
+            /** @description API base URL (required - always needed to know where to fetch models from) */
             base_url: string;
         };
         /**
@@ -2148,21 +2167,34 @@ export interface components {
             template: string;
         };
         Stop: string | string[];
+        /** @description Credentials for test/fetch operations */
+        TestCreds: {
+            /** @description Look up credentials from stored API model */
+            value: string;
+            /** @enum {string} */
+            type: "id";
+        } | {
+            /** @description Use direct API key (null for no authentication) */
+            value: components["schemas"]["ApiKey"];
+            /** @enum {string} */
+            type: "api_key";
+        };
         /**
          * @description Request to test API connectivity with a prompt
          * @example {
-         *       "api_key": "sk-...",
          *       "base_url": "https://api.openai.com/v1",
+         *       "creds": {
+         *         "type": "api_key",
+         *         "value": "sk-..."
+         *       },
          *       "model": "gpt-4",
          *       "prompt": "Hello, how are you?"
          *     }
          */
         TestPromptRequest: {
-            /** @description API key for authentication (provide either api_key OR id, api_key takes preference if both provided) */
-            api_key?: string;
-            /** @description API model ID to look up stored credentials (provide either api_key OR id, api_key takes preference if both provided) */
-            id?: string;
-            /** @description API base URL (optional when using id) */
+            /** @description Credentials to use for testing */
+            creds?: components["schemas"]["TestCreds"];
+            /** @description API base URL */
             base_url: string;
             /** @description Model to use for testing */
             model: string;
@@ -2212,7 +2244,9 @@ export interface components {
          * @description Request to update an existing API model configuration
          * @example {
          *       "api_format": "openai",
-         *       "api_key": "sk-new-key",
+         *       "api_key": {
+         *         "action": "keep"
+         *       },
          *       "base_url": "https://api.openai.com/v1",
          *       "models": [
          *         "gpt-4-turbo",
@@ -2226,8 +2260,8 @@ export interface components {
             api_format: components["schemas"]["ApiFormat"];
             /** @description API base URL (required) */
             base_url: string;
-            /** @description API key for authentication (optional, only update if provided for security) */
-            api_key?: string | null;
+            /** @description API key update action (Keep/Set with Some or None) */
+            api_key?: components["schemas"]["ApiKeyUpdateAction"];
             /** @description List of available models (required) */
             models: string[];
             /** @description Optional prefix for model namespacing */
@@ -3760,6 +3794,7 @@ export interface operations {
                 };
                 content: {
                     /** @example {
+                     *       "commit_sha": "abc1234",
                      *       "status": "ready",
                      *       "version": "0.1.0"
                      *     } */

package/dist/types/types.gen.d.ts

@@ -28,6 +28,22 @@ export type ApiFormat = 'openai' | 'placeholder';
 export type ApiFormatsResponse = {
     data: Array<ApiFormat>;
 };
+/**
+ * Validated API key wrapper - validates length when Some, allows None for public APIs
+ */
+export type ApiKey = string | null;
+/**
+ * Represents an API key update action for API model updates
+ */
+export type ApiKeyUpdateAction = {
+    action: 'keep';
+} | {
+    /**
+     * Set a new API key (or add one if none exists) - can be None for public APIs
+     */
+    value: ApiKey;
+    action: 'set';
+};
 /**
  * Response containing API model configuration
  */
@@ -35,7 +51,7 @@ export type ApiModelResponse = {
     id: string;
     api_format: ApiFormat;
     base_url: string;
-    api_key_masked: string;
+    api_key_masked?: string | null;
     models: Array<string>;
     prefix?: string | null;
     created_at: string;
@@ -72,6 +88,10 @@ export type AppInfo = {
      * Application version number (semantic versioning)
      */
     version: string;
+    /**
+     * Git commit SHA of the build
+     */
+    commit_sha: string;
     /**
      * Current application setup and operational status
      */
@@ -517,9 +537,9 @@ export type CreateApiModelRequest = {
      */
     base_url: string;
     /**
-     * API key for authentication
+     * API key for authentication (null for public APIs)
      */
-    api_key: string;
+    api_key?: ApiKey;
     /**
      * List of available models
      */
@@ -835,15 +855,11 @@ export type ErrorBody = {
  */
 export type FetchModelsRequest = {
     /**
-     * API key for authentication (provide either api_key OR id, api_key takes preference if both provided)
-     */
-    api_key?: string;
-    /**
-     * API model ID to look up stored credentials (provide either api_key OR id, api_key takes preference if both provided)
+     * Credentials to use for fetching models
      */
-    id?: string;
+    creds?: TestCreds;
     /**
-     * API base URL (optional when using id)
+     * API base URL (required - always needed to know where to fetch models from)
      */
     base_url: string;
 };
@@ -1285,19 +1301,31 @@ export type ShowResponse = {
 };
 export type Stop = string | Array<string>;
 /**
- * Request to test API connectivity with a prompt
+ * Credentials for test/fetch operations
  */
-export type TestPromptRequest = {
+export type TestCreds = {
     /**
-     * API key for authentication (provide either api_key OR id, api_key takes preference if both provided)
+     * Look up credentials from stored API model
      */
-    api_key?: string;
+    value: string;
+    type: 'id';
+} | {
     /**
-     * API model ID to look up stored credentials (provide either api_key OR id, api_key takes preference if both provided)
+     * Use direct API key (null for no authentication)
      */
-    id?: string;
+    value: ApiKey;
+    type: 'api_key';
+};
+/**
+ * Request to test API connectivity with a prompt
+ */
+export type TestPromptRequest = {
     /**
-     * API base URL (optional when using id)
+     * Credentials to use for testing
+     */
+    creds?: TestCreds;
+    /**
+     * API base URL
      */
     base_url: string;
     /**
@@ -1359,9 +1387,9 @@ export type UpdateApiModelRequest = {
      */
     base_url: string;
     /**
-     * API key for authentication (optional, only update if provided for security)
+     * API key update action (Keep/Set with Some or None)
      */
-    api_key?: string | null;
+    api_key?: ApiKeyUpdateAction;
     /**
      * List of available models (required)
      */

package/dist/types/types.gen.ts

@@ -34,6 +34,24 @@ export type ApiFormatsResponse = {
     data: Array<ApiFormat>;
 };
 
+/**
+ * Validated API key wrapper - validates length when Some, allows None for public APIs
+ */
+export type ApiKey = string | null;
+
+/**
+ * Represents an API key update action for API model updates
+ */
+export type ApiKeyUpdateAction = {
+    action: 'keep';
+} | {
+    /**
+     * Set a new API key (or add one if none exists) - can be None for public APIs
+     */
+    value: ApiKey;
+    action: 'set';
+};
+
 /**
  * Response containing API model configuration
  */
@@ -41,7 +59,7 @@ export type ApiModelResponse = {
     id: string;
     api_format: ApiFormat;
     base_url: string;
-    api_key_masked: string;
+    api_key_masked?: string | null;
     models: Array<string>;
     prefix?: string | null;
     created_at: string;
@@ -83,6 +101,10 @@ export type AppInfo = {
      * Application version number (semantic versioning)
      */
     version: string;
+    /**
+     * Git commit SHA of the build
+     */
+    commit_sha: string;
     /**
      * Current application setup and operational status
      */
@@ -579,9 +601,9 @@ export type CreateApiModelRequest = {
      */
     base_url: string;
     /**
-     * API key for authentication
+     * API key for authentication (null for public APIs)
      */
-    api_key: string;
+    api_key?: ApiKey;
     /**
      * List of available models
      */
@@ -912,15 +934,11 @@ export type ErrorBody = {
  */
 export type FetchModelsRequest = {
     /**
-     * API key for authentication (provide either api_key OR id, api_key takes preference if both provided)
-     */
-    api_key?: string;
-    /**
-     * API model ID to look up stored credentials (provide either api_key OR id, api_key takes preference if both provided)
+     * Credentials to use for fetching models
      */
-    id?: string;
+    creds?: TestCreds;
     /**
-     * API base URL (optional when using id)
+     * API base URL (required - always needed to know where to fetch models from)
      */
     base_url: string;
 };
@@ -1415,19 +1433,32 @@ export type ShowResponse = {
 export type Stop = string | Array<string>;
 
 /**
- * Request to test API connectivity with a prompt
+ * Credentials for test/fetch operations
  */
-export type TestPromptRequest = {
+export type TestCreds = {
     /**
-     * API key for authentication (provide either api_key OR id, api_key takes preference if both provided)
+     * Look up credentials from stored API model
      */
-    api_key?: string;
+    value: string;
+    type: 'id';
+} | {
     /**
-     * API model ID to look up stored credentials (provide either api_key OR id, api_key takes preference if both provided)
+     * Use direct API key (null for no authentication)
      */
-    id?: string;
+    value: ApiKey;
+    type: 'api_key';
+};
+
+/**
+ * Request to test API connectivity with a prompt
+ */
+export type TestPromptRequest = {
     /**
-     * API base URL (optional when using id)
+     * Credentials to use for testing
+     */
+    creds?: TestCreds;
+    /**
+     * API base URL
      */
     base_url: string;
     /**
@@ -1496,9 +1527,9 @@ export type UpdateApiModelRequest = {
      */
     base_url: string;
     /**
-     * API key for authentication (optional, only update if provided for security)
+     * API key update action (Keep/Set with Some or None)
      */
-    api_key?: string | null;
+    api_key?: ApiKeyUpdateAction;
     /**
      * List of available models (required)
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bodhiapp/ts-client",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "TypeScript types for Bodhi API",
   "main": "dist/index.js",
   "module": "dist/index.mjs",