the-token-company 0.1.0 → 0.2.0

package/README.md

@@ -1,7 +1,17 @@
+<div align="center">
+
 # The Token Company Node.js SDK
 
 Compress LLM prompts to reduce costs and latency. 100K tokens compressed in ~85ms.
 
+[![CI](https://github.com/TheTokenCompany/the-token-company-node/actions/workflows/ci.yml/badge.svg)](https://github.com/TheTokenCompany/the-token-company-node/actions/workflows/ci.yml)
+[![npm version](https://img.shields.io/npm/v/the-token-company)](https://www.npmjs.com/package/the-token-company)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/TheTokenCompany/the-token-company-node/blob/main/LICENSE)
+
+[Docs](https://thetokencompany.com/docs) · [Website](https://thetokencompany.com) · [Dashboard](https://app.thetokencompany.com) · [Python SDK](https://github.com/TheTokenCompany/the-token-company-python)
+
+</div>
+
 ## Install
 
 ```bash
@@ -131,6 +141,24 @@ withCompression(client, {
 | `system`   | `role: "system"` messages       | `system` parameter             | System messages     |
 | `tool`     | `tool` + `function` messages    | `tool_result` content blocks   | Tool result parts   |
 
+## App ID
+
+Tag compression requests with an application identifier for usage tracking:
+
+```ts
+// Set on the client — applies to all requests
+const client = new TheTokenCompany({ apiKey: "ttc-...", appId: "my-chatbot" });
+
+// Or per-request (overrides the client-level value)
+const result = await client.compress(text, { model: "bear-2", appId: "my-chatbot" });
+```
+
+Also supported in wrappers:
+
+```ts
+const client = withCompression(new OpenAI(), { compressionApiKey: "ttc-...", appId: "my-chatbot" });
+```
+
 ## Gzip
 
 Gzip compression of request payloads is on by default. Disable with:

package/dist/ai-sdk.d.ts

@@ -5,20 +5,17 @@ import { CompressionStats } from "./types.js";
 /**
  * Create a Vercel AI SDK middleware that auto-compresses non-assistant messages.
  *
- * Use when composing with other middleware:
- *
  * ```ts
  * import { wrapLanguageModel } from "ai";
  * import { openai } from "@ai-sdk/openai";
  * import { compressionMiddleware } from "the-token-company/ai-sdk";
  *
- * const { middleware, compression } = compressionMiddleware({ compressionApiKey: "ttc-..." });
+ * const middleware = compressionMiddleware({ compressionApiKey: "ttc-..." });
  * const model = wrapLanguageModel({ model: openai("gpt-4o"), middleware });
- * // After calls: compression.totalTokensSaved
+ * // After calls: middleware.compression.totalTokensSaved
  * ```
  */
-export declare function compressionMiddleware(options: WithCompressionOptions): {
-    middleware: LanguageModelMiddleware;
+export declare function compressionMiddleware(options: WithCompressionOptions): LanguageModelMiddleware & {
     compression: CompressionStats;
 };
 /**
@@ -29,18 +26,17 @@ export declare function compressionMiddleware(options: WithCompressionOptions):
  * import { generateText } from "ai";
  * import { withCompression } from "the-token-company/ai-sdk";
  *
- * const { model, compression } = withCompression(openai("gpt-4o"), { compressionApiKey: "ttc-..." });
+ * const model = withCompression(openai("gpt-4o"), { compressionApiKey: "ttc-..." });
  *
  * const { text } = await generateText({
  *   model,
  *   messages: [{ role: "user", content: "Summarize these results..." }],
  * });
- * console.log(compression.totalTokensSaved);
+ * console.log(model.compression.totalTokensSaved);
  * ```
  *
  * Works with any provider (`@ai-sdk/openai`, `@ai-sdk/anthropic`, `@ai-sdk/google`, etc.).
  */
-export declare function withCompression(model: LanguageModelV3, options: WithCompressionOptions): {
-    model: LanguageModelV3;
+export declare function withCompression(model: LanguageModelV3, options: WithCompressionOptions): LanguageModelV3 & {
     compression: CompressionStats;
 };

package/dist/ai-sdk.js

@@ -5,25 +5,24 @@ import { CompressionStats } from "./types.js";
 /**
  * Create a Vercel AI SDK middleware that auto-compresses non-assistant messages.
  *
- * Use when composing with other middleware:
- *
  * ```ts
  * import { wrapLanguageModel } from "ai";
  * import { openai } from "@ai-sdk/openai";
  * import { compressionMiddleware } from "the-token-company/ai-sdk";
  *
- * const { middleware, compression } = compressionMiddleware({ compressionApiKey: "ttc-..." });
+ * const middleware = compressionMiddleware({ compressionApiKey: "ttc-..." });
  * const model = wrapLanguageModel({ model: openai("gpt-4o"), middleware });
- * // After calls: compression.totalTokensSaved
+ * // After calls: middleware.compression.totalTokensSaved
  * ```
  */
 export function compressionMiddleware(options) {
     const stats = new CompressionStats();
-    const analytics = new AnalyticsTTC(new TheTokenCompany({ apiKey: options.compressionApiKey }), stats);
+    const analytics = new AnalyticsTTC(new TheTokenCompany({ apiKey: options.compressionApiKey, appId: options.appId }), stats);
     const compressionModel = options.model ?? "bear-2";
     const roleAggr = resolveAggressiveness(options.aggressiveness ?? 0.2);
     const middleware = {
         specificationVersion: "v3",
+        compression: stats,
         transformParams: async ({ params }) => {
             if (params.prompt) {
                 stats._startTurn();
@@ -34,7 +33,7 @@ export function compressionMiddleware(options) {
             return params;
         },
     };
-    return { middleware, compression: stats };
+    return middleware;
 }
 /**
  * Wrap any Vercel AI SDK language model with automatic compression.
@@ -44,21 +43,20 @@ export function compressionMiddleware(options) {
  * import { generateText } from "ai";
  * import { withCompression } from "the-token-company/ai-sdk";
  *
- * const { model, compression } = withCompression(openai("gpt-4o"), { compressionApiKey: "ttc-..." });
+ * const model = withCompression(openai("gpt-4o"), { compressionApiKey: "ttc-..." });
  *
  * const { text } = await generateText({
  *   model,
  *   messages: [{ role: "user", content: "Summarize these results..." }],
  * });
- * console.log(compression.totalTokensSaved);
+ * console.log(model.compression.totalTokensSaved);
  * ```
  *
  * Works with any provider (`@ai-sdk/openai`, `@ai-sdk/anthropic`, `@ai-sdk/google`, etc.).
  */
 export function withCompression(model, options) {
-    const { middleware, compression } = compressionMiddleware(options);
-    return {
-        model: wrapLanguageModel({ model, middleware }),
-        compression,
-    };
+    const mw = compressionMiddleware(options);
+    const wrapped = wrapLanguageModel({ model, middleware: mw });
+    wrapped.compression = mw.compression;
+    return wrapped;
 }

package/dist/anthropic.js

@@ -24,7 +24,7 @@ import { CompressionStats } from "./types.js";
  */
 export function withCompression(client, options) {
     const stats = new CompressionStats();
-    const analytics = new AnalyticsTTC(new TheTokenCompany({ apiKey: options.compressionApiKey }), stats);
+    const analytics = new AnalyticsTTC(new TheTokenCompany({ apiKey: options.compressionApiKey, appId: options.appId }), stats);
     const model = options.model ?? "bear-2";
     const roleAggr = resolveAggressiveness(options.aggressiveness ?? 0.2);
     const systemAggr = roleAggr["system"];

package/dist/client.d.ts

@@ -8,10 +8,12 @@ export declare class TheTokenCompany {
     private readonly apiKey;
     private readonly timeout;
     private readonly gzip;
+    private readonly appId?;
     constructor(options: TheTokenCompanyOptions);
     compress(text: string, options?: {
         model?: string;
         aggressiveness?: number;
+        appId?: string;
     }): Promise<CompressResult>;
     private parseError;
 }

package/dist/client.js

@@ -13,11 +13,13 @@ export class TheTokenCompany {
     apiKey;
     timeout;
     gzip;
+    appId;
     constructor(options) {
         this.apiKey = options.apiKey;
         this.baseUrl = (options.baseUrl ?? BASE_URL).replace(/\/$/, "");
         this.timeout = options.timeout ?? DEFAULT_TIMEOUT;
         this.gzip = options.gzip ?? true;
+        this.appId = options.appId;
     }
     async compress(text, options = {}) {
         const { model = "bear-2", aggressiveness = 0.2 } = options;
@@ -27,10 +29,12 @@ export class TheTokenCompany {
         if (aggressiveness < 0 || aggressiveness > 1) {
             throw new InvalidRequestError("aggressiveness must be between 0.0 and 1.0");
         }
+        const resolvedAppId = options.appId ?? this.appId;
         const payload = {
             model,
             input: text,
             compression_settings: { aggressiveness },
+            ...(resolvedAppId !== undefined && { app_id: resolvedAppId }),
         };
         const jsonBody = JSON.stringify(payload);
         const headers = {

package/dist/index.d.ts

@@ -2,3 +2,7 @@ export { TheTokenCompany, BEAR_1, BEAR_1_1, BEAR_1_2, BEAR_2 } from "./client.js
 export { TheTokenCompanyError, AuthenticationError, InvalidRequestError, PaymentRequiredError, RequestTooLargeError, RateLimitError, APIError, } from "./errors.js";
 export { CompressionStats } from "./types.js";
 export type { CompressResult, TheTokenCompanyOptions, Aggressiveness, WithCompressionOptions, TurnStats, } from "./types.js";
+/**
+ * Wrap text in `<ttc_safe>` tags to protect it from compression.
+ */
+export declare function protect(text: string): string;

package/dist/index.js

@@ -1,3 +1,9 @@
 export { TheTokenCompany, BEAR_1, BEAR_1_1, BEAR_1_2, BEAR_2 } from "./client.js";
 export { TheTokenCompanyError, AuthenticationError, InvalidRequestError, PaymentRequiredError, RequestTooLargeError, RateLimitError, APIError, } from "./errors.js";
 export { CompressionStats } from "./types.js";
+/**
+ * Wrap text in `<ttc_safe>` tags to protect it from compression.
+ */
+export function protect(text) {
+    return `<ttc_safe>${text}</ttc_safe>`;
+}

package/dist/openai.js

@@ -22,7 +22,7 @@ import { CompressionStats } from "./types.js";
  */
 export function withCompression(client, options) {
     const stats = new CompressionStats();
-    const analytics = new AnalyticsTTC(new TheTokenCompany({ apiKey: options.compressionApiKey }), stats);
+    const analytics = new AnalyticsTTC(new TheTokenCompany({ apiKey: options.compressionApiKey, appId: options.appId }), stats);
     const model = options.model ?? "bear-2";
     const roleAggr = resolveAggressiveness(options.aggressiveness ?? 0.2);
     const originalCreate = client.chat.completions.create.bind(client.chat.completions);

package/dist/types.d.ts

@@ -4,6 +4,7 @@ export interface CompressRequest {
     compression_settings: {
         aggressiveness: number;
     };
+    app_id?: string;
 }
 export interface CompressResponse {
     output: string;
@@ -22,12 +23,14 @@ export interface TheTokenCompanyOptions {
     baseUrl?: string;
     timeout?: number;
     gzip?: boolean;
+    appId?: string;
 }
 export type Aggressiveness = number | Record<string, number>;
 export interface WithCompressionOptions {
     compressionApiKey: string;
     model?: string;
     aggressiveness?: Aggressiveness;
+    appId?: string;
 }
 export interface TurnStats {
     inputTokens: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "the-token-company",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Node.js SDK for The Token Company — compress LLM prompts to reduce costs and latency",
   "type": "module",
   "main": "./dist/index.js",