llm-cost-monitor-sdk 1.0.0 → 1.1.0

package/README.md

@@ -1,139 +1,171 @@
-# @llmcost/sdk@v1.0.0
+# LLM Cost Monitor - TypeScript SDK
 
-A TypeScript SDK client for the localhost API.
+Official TypeScript/JavaScript SDK for [LLM Cost Monitor](https://github.com/check-ai/llm-cost-monitor).
 
-## Usage
-
-First, install the SDK from npm.
+## Installation
 
 ```bash
-npm install @llmcost/sdk --save
+npm install llm-cost-monitor-sdk
+# or
+pnpm add llm-cost-monitor-sdk
+# or
+bun add llm-cost-monitor-sdk
 ```
 
-Next, try it out.
-
-
-```ts
-import {
-  Configuration,
-  AlertsApi,
-} from '@llmcost/sdk';
-import type { CreateAlertOperationRequest } from '@llmcost/sdk';
-
-async function example() {
-  console.log("🚀 Testing @llmcost/sdk SDK...");
-  const config = new Configuration({ 
-    // To configure API key authorization: ApiKeyAuth
-    apiKey: "YOUR API KEY",
-  });
-  const api = new AlertsApi(config);
-
-  const body = {
-    // CreateAlertRequest
-    createAlertRequest: {"threshold":100.0,"window_interval":"24h"},
-  } satisfies CreateAlertOperationRequest;
-
-  try {
-    const data = await api.createAlert(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
+## Quick Start
+
+```typescript
+import { Configuration, EventsApi } from "llm-cost-monitor-sdk";
+
+const config = new Configuration({
+  basePath: "http://localhost:8080",
+  headers: {
+    Authorization: "Bearer YOUR_API_KEY",
+  },
+});
+
+const events = new EventsApi(config);
+
+// Track an LLM usage event
+const response = await events.createEvent({
+  createEventRequest: {
+    traceId: "unique-request-id",
+    provider: "openai",
+    model: "gpt-4o",
+    inputTokens: 1200,
+    outputTokens: 350,
+    feature: "chat",
+    userId: "user_123",
+  },
+});
+
+console.log(`Cost: $${response.costUsd}`);
 ```
 
+## Authentication
+
+All API requests require an API key passed in the `Authorization` header:
+
+```typescript
+const config = new Configuration({
+  basePath: process.env.LLM_COST_MONITOR_URL,
+  headers: {
+    Authorization: `Bearer ${process.env.LLM_COST_MONITOR_API_KEY}`,
+  },
+});
+```
 
-## Documentation
+## API Reference
 
-### API Endpoints
+### Events API
 
-All URIs are relative to *http://localhost:8080*
+```typescript
+import { EventsApi } from "llm-cost-monitor-sdk";
 
-| Class | Method | HTTP request | Description
-| ----- | ------ | ------------ | -------------
-*AlertsApi* | [**createAlert**](docs/AlertsApi.md#createalertoperation) | **POST** /v1/alerts | Create budget alert
-*AlertsApi* | [**deleteAlert**](docs/AlertsApi.md#deletealert) | **DELETE** /v1/alerts/{id} | Delete alert
-*AlertsApi* | [**listAlerts**](docs/AlertsApi.md#listalerts) | **GET** /v1/alerts | List budget alerts
-*EventsApi* | [**createEvent**](docs/EventsApi.md#createeventoperation) | **POST** /v1/events | Track LLM usage event
-*EventsApi* | [**listEvents**](docs/EventsApi.md#listevents) | **GET** /v1/events | List LLM usage events
-*MetricsApi* | [**getMetrics**](docs/MetricsApi.md#getmetrics) | **GET** /v1/metrics | Get aggregated metrics
-*PricingApi* | [**listPricing**](docs/PricingApi.md#listpricing) | **GET** /v1/pricing | List model pricing
+const events = new EventsApi(config);
 
+// Create event
+const result = await events.createEvent({
+  createEventRequest: {
+    traceId: "req_abc123",
+    provider: "openai",
+    model: "gpt-4o",
+    inputTokens: 1200,
+    outputTokens: 350,
+  },
+});
 
-### Models
+// List events
+const eventList = await events.listEvents({
+  limit: 50,
+  from: new Date("2026-01-01"),
+});
+```
 
-- [Alert](docs/Alert.md)
-- [CreateAlertRequest](docs/CreateAlertRequest.md)
-- [CreateEventRequest](docs/CreateEventRequest.md)
-- [ErrorResponse](docs/ErrorResponse.md)
-- [ErrorResponseError](docs/ErrorResponseError.md)
-- [Event](docs/Event.md)
-- [EventListResponse](docs/EventListResponse.md)
-- [EventResponse](docs/EventResponse.md)
-- [MetricPoint](docs/MetricPoint.md)
-- [MetricsResponse](docs/MetricsResponse.md)
-- [ModelPricing](docs/ModelPricing.md)
+### Metrics API
 
-### Authorization
+```typescript
+import { MetricsApi } from "llm-cost-monitor-sdk";
 
+const metrics = new MetricsApi(config);
 
-Authentication schemes defined for the API:
-<a id="ApiKeyAuth"></a>
-#### ApiKeyAuth
+// Get aggregated metrics
+const data = await metrics.getMetrics({
+  period: "hour",
+  from: new Date("2026-01-01"),
+});
 
+// Get usage summary
+const usage = await metrics.getUsage({
+  period: "month",
+});
+```
 
-- **Type**: API key
-- **API key parameter name**: `Authorization`
-- **Location**: HTTP header
+### Alerts API
 
-## About
+```typescript
+import { AlertsApi } from "llm-cost-monitor-sdk";
 
-This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
-and is automatically generated by the
-[OpenAPI Generator](https://openapi-generator.tech) project:
+const alerts = new AlertsApi(config);
 
-- API version: `v1.0.0`
-- Package version: `v1.0.0`
-- Generator version: `7.18.0`
-- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
+// Create alert
+await alerts.createAlert({
+  createAlertRequest: {
+    threshold: 100.0,
+    windowInterval: "24h",
+  },
+});
 
-The generated npm module supports the following:
+// List alerts
+const alertList = await alerts.listAlerts();
 
-- Environments
-  * Node.js
-  * Webpack
-  * Browserify
-- Language levels
-  * ES5 - you must have a Promises/A+ library installed
-  * ES6
-- Module systems
-  * CommonJS
-  * ES6 module system
+// Delete alert
+await alerts.deleteAlert({ id: "alert-uuid" });
+```
 
+### Pricing API
 
-## Development
+```typescript
+import { PricingApi } from "llm-cost-monitor-sdk";
 
-### Building
+const pricing = new PricingApi(config);
 
-To build the TypeScript source code, you need to have Node.js and npm installed.
-After cloning the repository, navigate to the project directory and run:
+// List all pricing
+const prices = await pricing.listPricing({});
 
-```bash
-npm install
-npm run build
+// Filter by provider
+const openaiPrices = await pricing.listPricing({
+  provider: "openai",
+});
 ```
 
-### Publishing
+## Error Handling
+
+```typescript
+import { ResponseError } from "llm-cost-monitor-sdk";
+
+try {
+  await events.createEvent({ ... });
+} catch (error) {
+  if (error instanceof ResponseError) {
+    const body = await error.response.json();
+    console.error(`Error ${body.error.code}: ${body.error.message}`);
+    
+    // Handle specific errors
+    if (error.response.status === 402) {
+      console.error("Budget limit exceeded!");
+    }
+  }
+}
+```
 
-Once you've built the package, you can publish it to npm:
+## Environment Variables
 
 ```bash
-npm publish
+LLM_COST_MONITOR_URL=http://localhost:8080
+LLM_COST_MONITOR_API_KEY=your-api-key
 ```
 
 ## License
 
-[MIT](https://opensource.org/licenses/MIT)
+MIT

package/dist/apis/AlertsApi.d.ts

@@ -2,7 +2,7 @@
  * LLM Cost Monitor API
  * Open-source LLM cost observability platform API. Track, aggregate, and analyze LLM usage costs across your applications.
  *
- * The version of the OpenAPI document: v1.0.0
+ * The version of the OpenAPI document: 1.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/AlertsApi.js

@@ -5,7 +5,7 @@
  * LLM Cost Monitor API
  * Open-source LLM cost observability platform API. Track, aggregate, and analyze LLM usage costs across your applications.
  *
- * The version of the OpenAPI document: v1.0.0
+ * The version of the OpenAPI document: 1.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/EventsApi.d.ts

@@ -2,7 +2,7 @@
  * LLM Cost Monitor API
  * Open-source LLM cost observability platform API. Track, aggregate, and analyze LLM usage costs across your applications.
  *
- * The version of the OpenAPI document: v1.0.0
+ * The version of the OpenAPI document: 1.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/EventsApi.js

@@ -5,7 +5,7 @@
  * LLM Cost Monitor API
  * Open-source LLM cost observability platform API. Track, aggregate, and analyze LLM usage costs across your applications.
  *
- * The version of the OpenAPI document: v1.0.0
+ * The version of the OpenAPI document: 1.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/MetricsApi.d.ts

@@ -2,7 +2,7 @@
  * LLM Cost Monitor API
  * Open-source LLM cost observability platform API. Track, aggregate, and analyze LLM usage costs across your applications.
  *
- * The version of the OpenAPI document: v1.0.0
+ * The version of the OpenAPI document: 1.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,13 +10,16 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { MetricsResponse } from '../models/index';
+import type { MetricsResponse, UsageSummary } from '../models/index';
 export interface GetMetricsRequest {
     period: GetMetricsPeriodEnum;
     from?: Date;
     to?: Date;
     groupBy?: GetMetricsGroupByEnum;
 }
+export interface GetUsageRequest {
+    period?: GetUsagePeriodEnum;
+}
 /**
  *
  */
@@ -31,6 +34,16 @@ export declare class MetricsApi extends runtime.BaseAPI {
      * Get aggregated metrics
      */
     getMetrics(requestParameters: GetMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MetricsResponse>;
+    /**
+     * Returns usage summary with cost breakdown for the current period.
+     * Get usage summary
+     */
+    getUsageRaw(requestParameters: GetUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UsageSummary>>;
+    /**
+     * Returns usage summary with cost breakdown for the current period.
+     * Get usage summary
+     */
+    getUsage(requestParameters?: GetUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UsageSummary>;
 }
 /**
  * @export
@@ -50,3 +63,12 @@ export declare const GetMetricsGroupByEnum: {
     readonly UserId: "user_id";
 };
 export type GetMetricsGroupByEnum = typeof GetMetricsGroupByEnum[keyof typeof GetMetricsGroupByEnum];
+/**
+ * @export
+ */
+export declare const GetUsagePeriodEnum: {
+    readonly Day: "day";
+    readonly Week: "week";
+    readonly Month: "month";
+};
+export type GetUsagePeriodEnum = typeof GetUsagePeriodEnum[keyof typeof GetUsagePeriodEnum];

package/dist/apis/MetricsApi.js

@@ -5,7 +5,7 @@
  * LLM Cost Monitor API
  * Open-source LLM cost observability platform API. Track, aggregate, and analyze LLM usage costs across your applications.
  *
- * The version of the OpenAPI document: v1.0.0
+ * The version of the OpenAPI document: 1.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetMetricsGroupByEnum = exports.GetMetricsPeriodEnum = exports.MetricsApi = void 0;
+exports.GetUsagePeriodEnum = exports.GetMetricsGroupByEnum = exports.GetMetricsPeriodEnum = exports.MetricsApi = void 0;
 const runtime = require("../runtime");
 const index_1 = require("../models/index");
 /**
@@ -75,6 +75,40 @@ class MetricsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns usage summary with cost breakdown for the current period.
+     * Get usage summary
+     */
+    getUsageRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['period'] != null) {
+                queryParameters['period'] = requestParameters['period'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Authorization"] = yield this.configuration.apiKey("Authorization"); // ApiKeyAuth authentication
+            }
+            let urlPath = `/v1/usage`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UsageSummaryFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns usage summary with cost breakdown for the current period.
+     * Get usage summary
+     */
+    getUsage() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getUsageRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
 }
 exports.MetricsApi = MetricsApi;
 /**
@@ -93,3 +127,11 @@ exports.GetMetricsGroupByEnum = {
     Feature: 'feature',
     UserId: 'user_id'
 };
+/**
+ * @export
+ */
+exports.GetUsagePeriodEnum = {
+    Day: 'day',
+    Week: 'week',
+    Month: 'month'
+};

package/dist/apis/PricingApi.d.ts

@@ -2,7 +2,7 @@
  * LLM Cost Monitor API
  * Open-source LLM cost observability platform API. Track, aggregate, and analyze LLM usage costs across your applications.
  *
- * The version of the OpenAPI document: v1.0.0
+ * The version of the OpenAPI document: 1.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/apis/PricingApi.js

@@ -5,7 +5,7 @@
  * LLM Cost Monitor API
  * Open-source LLM cost observability platform API. Track, aggregate, and analyze LLM usage costs across your applications.
  *
- * The version of the OpenAPI document: v1.0.0
+ * The version of the OpenAPI document: 1.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/apis/AlertsApi.d.ts

@@ -2,7 +2,7 @@
  * LLM Cost Monitor API
  * Open-source LLM cost observability platform API. Track, aggregate, and analyze LLM usage costs across your applications.
  *
- * The version of the OpenAPI document: v1.0.0
+ * The version of the OpenAPI document: 1.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/apis/AlertsApi.js

@@ -4,7 +4,7 @@
  * LLM Cost Monitor API
  * Open-source LLM cost observability platform API. Track, aggregate, and analyze LLM usage costs across your applications.
  *
- * The version of the OpenAPI document: v1.0.0
+ * The version of the OpenAPI document: 1.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/apis/EventsApi.d.ts

@@ -2,7 +2,7 @@
  * LLM Cost Monitor API
  * Open-source LLM cost observability platform API. Track, aggregate, and analyze LLM usage costs across your applications.
  *
- * The version of the OpenAPI document: v1.0.0
+ * The version of the OpenAPI document: 1.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/apis/EventsApi.js

@@ -4,7 +4,7 @@
  * LLM Cost Monitor API
  * Open-source LLM cost observability platform API. Track, aggregate, and analyze LLM usage costs across your applications.
  *
- * The version of the OpenAPI document: v1.0.0
+ * The version of the OpenAPI document: 1.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/apis/MetricsApi.d.ts

@@ -2,7 +2,7 @@
  * LLM Cost Monitor API
  * Open-source LLM cost observability platform API. Track, aggregate, and analyze LLM usage costs across your applications.
  *
- * The version of the OpenAPI document: v1.0.0
+ * The version of the OpenAPI document: 1.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,13 +10,16 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { MetricsResponse } from '../models/index';
+import type { MetricsResponse, UsageSummary } from '../models/index';
 export interface GetMetricsRequest {
     period: GetMetricsPeriodEnum;
     from?: Date;
     to?: Date;
     groupBy?: GetMetricsGroupByEnum;
 }
+export interface GetUsageRequest {
+    period?: GetUsagePeriodEnum;
+}
 /**
  *
  */
@@ -31,6 +34,16 @@ export declare class MetricsApi extends runtime.BaseAPI {
      * Get aggregated metrics
      */
     getMetrics(requestParameters: GetMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MetricsResponse>;
+    /**
+     * Returns usage summary with cost breakdown for the current period.
+     * Get usage summary
+     */
+    getUsageRaw(requestParameters: GetUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UsageSummary>>;
+    /**
+     * Returns usage summary with cost breakdown for the current period.
+     * Get usage summary
+     */
+    getUsage(requestParameters?: GetUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UsageSummary>;
 }
 /**
  * @export
@@ -50,3 +63,12 @@ export declare const GetMetricsGroupByEnum: {
     readonly UserId: "user_id";
 };
 export type GetMetricsGroupByEnum = typeof GetMetricsGroupByEnum[keyof typeof GetMetricsGroupByEnum];
+/**
+ * @export
+ */
+export declare const GetUsagePeriodEnum: {
+    readonly Day: "day";
+    readonly Week: "week";
+    readonly Month: "month";
+};
+export type GetUsagePeriodEnum = typeof GetUsagePeriodEnum[keyof typeof GetUsagePeriodEnum];

package/dist/esm/apis/MetricsApi.js

@@ -4,7 +4,7 @@
  * LLM Cost Monitor API
  * Open-source LLM cost observability platform API. Track, aggregate, and analyze LLM usage costs across your applications.
  *
- * The version of the OpenAPI document: v1.0.0
+ * The version of the OpenAPI document: 1.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { MetricsResponseFromJSON, } from '../models/index';
+import { MetricsResponseFromJSON, UsageSummaryFromJSON, } from '../models/index';
 /**
  *
  */
@@ -72,6 +72,40 @@ export class MetricsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns usage summary with cost breakdown for the current period.
+     * Get usage summary
+     */
+    getUsageRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['period'] != null) {
+                queryParameters['period'] = requestParameters['period'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Authorization"] = yield this.configuration.apiKey("Authorization"); // ApiKeyAuth authentication
+            }
+            let urlPath = `/v1/usage`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => UsageSummaryFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns usage summary with cost breakdown for the current period.
+     * Get usage summary
+     */
+    getUsage() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getUsageRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
 }
 /**
  * @export
@@ -89,3 +123,11 @@ export const GetMetricsGroupByEnum = {
     Feature: 'feature',
     UserId: 'user_id'
 };
+/**
+ * @export
+ */
+export const GetUsagePeriodEnum = {
+    Day: 'day',
+    Week: 'week',
+    Month: 'month'
+};

package/dist/esm/apis/PricingApi.d.ts

@@ -2,7 +2,7 @@
  * LLM Cost Monitor API
  * Open-source LLM cost observability platform API. Track, aggregate, and analyze LLM usage costs across your applications.
  *
- * The version of the OpenAPI document: v1.0.0
+ * The version of the OpenAPI document: 1.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/apis/PricingApi.js

@@ -4,7 +4,7 @@
  * LLM Cost Monitor API
  * Open-source LLM cost observability platform API. Track, aggregate, and analyze LLM usage costs across your applications.
  *
- * The version of the OpenAPI document: v1.0.0
+ * The version of the OpenAPI document: 1.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/models/Alert.d.ts

@@ -2,7 +2,7 @@
  * LLM Cost Monitor API
  * Open-source LLM cost observability platform API. Track, aggregate, and analyze LLM usage costs across your applications.
  *
- * The version of the OpenAPI document: v1.0.0
+ * The version of the OpenAPI document: 1.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/models/Alert.js

@@ -4,7 +4,7 @@
  * LLM Cost Monitor API
  * Open-source LLM cost observability platform API. Track, aggregate, and analyze LLM usage costs across your applications.
  *
- * The version of the OpenAPI document: v1.0.0
+ * The version of the OpenAPI document: 1.0.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).