@bodhiapp/ts-client 0.1.3 → 0.1.5

package/README.md

@@ -1,6 +1,6 @@
 # @bodhiapp/ts-client
 
-TypeScript client for the Bodhi API, providing type-safe access to the API endpoints.
+TypeScript types for the Bodhi API, providing type-safe access to the API endpoints.
 
 ## Installation
 
@@ -11,44 +11,50 @@ npm install @bodhiapp/ts-client
 ## Usage
 
 ```typescript
-import { BodhiClient } from "@bodhiapp/ts-client";
-
-// Initialize the client
-const client = new BodhiClient({
-  baseUrl: "https://api.yourdomain.com",
-  apiKey: "your-api-key",
-});
-
-// Create a chat completion
+import { ChatRequest } from "@bodhiapp/ts-client";
+
+// Example chat request with type safety
+const request: ChatRequest = {
+  model: "llama2",
+  messages: [
+    { role: "user", content: "Hello, who are you?" }
+  ],
+  options: {
+    temperature: 0.7,
+    num_predict: 100
+  },
+  stream: false
+};
+
+// Make API calls using your preferred HTTP client
 async function chatWithBodhi() {
-  const response = await client.createChatCompletion({
-    model: "gpt-3.5-turbo",
-    messages: [
-      { role: "system", content: "You are a helpful assistant." },
-      { role: "user", content: "Hello, who are you?" },
-    ],
+  const response = await fetch("http://localhost:3000/v1/chat/completions", {
+    method: "POST",
+    headers: {
+      "Content-Type": "application/json"
+    },
+    body: JSON.stringify(request)
   });
 
-  console.log(response.choices[0].message.content);
-}
-
-// List available models
-async function listAvailableModels() {
-  const models = await client.listModels();
-  console.log(models.data);
+  const data = await response.json();
+  console.log(data.choices[0].message.content);
 }
 ```
 
 ## Development
 
-This package is generated from the Bodhi API OpenAPI specification.
+This package provides TypeScript types generated from the Bodhi API OpenAPI specification.
 
-To regenerate the client:
+To regenerate the types:
 
 ```bash
 npm run generate
 ```
 
+This will:
+1. Generate the OpenAPI spec from the Rust backend
+2. Generate TypeScript types using @hey-api/openapi-ts
+
 To build the package:
 
 ```bash
@@ -60,3 +66,16 @@ To run tests:
 ```bash
 npm test
 ```
+
+## Types
+
+The package exports TypeScript interfaces for all Bodhi API requests and responses. The main types include:
+
+- `ChatRequest` - Type for chat completion requests
+- `Message` - Type for chat messages
+- `AppInfo` - Application information and status
+- `Model` - Model information
+- `ApiToken` - API token information
+- And more...
+
+All types are fully documented with JSDoc comments for better IDE integration.

package/dist/index.d.ts

@@ -1 +1 @@
-export * from './types/api';
+export * from './types';

package/dist/index.js

@@ -17,4 +17,4 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 module.exports = __toCommonJS(src_exports);
-__reExport(src_exports, require("./types/api"), module.exports);
+__reExport(src_exports, require("./types"), module.exports);

package/dist/index.mjs

@@ -1,2 +1,2 @@
 // src/index.ts
-export * from "./types/api";
+export * from "./types";

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from './types.gen';

package/dist/types/index.ts

@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen';