@turnstileai/sdk 0.1.3 → 0.1.4

package/README.md

@@ -1,10 +1,8 @@
 # @turnstileai/sdk
 
-TypeScript SDK for TurnstileAI, a verification-first AI gateway.
+TypeScript SDK for TurnstileAI.
 
-TurnstileAI sits between your application and model providers, then returns
-structured run records with routing, latency, usage, cost, digests, signatures,
-and optional ledger checkpoints.
+TurnstileAI is a verification-focused AI gateway SDK for working with routed model requests, run records, provider health, and usage analytics.
 
 ## Install
 
@@ -15,48 +13,48 @@ npm install @turnstileai/sdk
 ## Quick start
 
 ```ts
-import OpenAI from "openai";
+import { TurnstileAI } from "@turnstileai/sdk";
 
-const client = new OpenAI({
-  apiKey: process.env.TURNSTILEAI_API_KEY,
-  baseURL: "https://api.turnstileai.com/v1"
+const client = new TurnstileAI({
+  apiKey: process.env.TURNSTILEAI_API_KEY!
 });
+```
 
-const response = await client.chat.completions.create({
-  model: "openrouter/llama-3.1-70b",
-  messages: [
-    { role: "user", content: "Explain Solana finality simply." }
-  ],
-  extra_body: {
-    checkpoint: true,
-    ledger: "solana",
-    routeMode: "trust-first"
-  }
-});
+## Fetch a run record
 
-console.log(response.choices.message.content);
-console.log(response.run_record);
+```ts
+const record = await client.records.get("rr_123");
+console.log(record);
 ```
 
-## SDK client
+## Verify a run record
 
 ```ts
-import { TurnstileAI } from "@turnstileai/sdk";
+const verification = await client.records.verify("rr_123");
+console.log(verification.status);
+```
 
-const client = new TurnstileAI({
-  apiKey: process.env.TURNSTILEAI_API_KEY!
-});
+## List providers
 
-const record = await client.records.get("rr_123");
-const verification = await client.records.verify("rr_123");
+```ts
 const providers = await client.providers.list();
+console.log(providers);
+```
+
+## Usage overview
+
+```ts
 const usage = await client.usage.overview("month");
+console.log(usage);
 ```
 
 ## CLI
 
+After installing globally or linking locally, you can use:
+
 ```bash
 turnstileai auth check --key=ts_live_xxx
+turnstileai record get rr_123 --key=ts_live_xxx
 turnstileai record list --key=ts_live_xxx
 turnstileai record verify rr_123 --key=ts_live_xxx
 turnstileai providers list --key=ts_live_xxx
@@ -75,4 +73,27 @@ turnstileai usage overview --key=ts_live_xxx
 ## Ledger modes
 
 - `none`
-- `solana`
+- `solana`
+
+## Development
+
+Build the package:
+
+```bash
+npm run build
+```
+
+Run tests:
+
+```bash
+npm test
+```
+
+## Publish updates
+
+When you change the SDK or README, publish a new version:
+
+```bash
+npm version patch
+npm publish --access public
+```

package/dist/test/client.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/client.test.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_test_1 = __importDefault(require("node:test"));
+const strict_1 = __importDefault(require("node:assert/strict"));
+const client_1 = require("../client");
+(0, node_test_1.default)("TurnstileAI throws when apiKey is missing", () => {
+    strict_1.default.throws(() => {
+        new client_1.TurnstileAI({ apiKey: "" });
+    }, /Missing TurnstileAI API key/);
+});
+(0, node_test_1.default)("TurnstileAI creates a client with valid apiKey", () => {
+    const client = new client_1.TurnstileAI({ apiKey: "ts_test_123" });
+    strict_1.default.ok(client);
+    strict_1.default.ok(client.records);
+    strict_1.default.ok(client.providers);
+    strict_1.default.ok(client.usage);
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turnstileai/sdk",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "Original TypeScript SDK for TurnstileAI",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -13,6 +13,7 @@
   ],
   "scripts": {
     "build": "tsc",
+    "test": "npm run build && node --test dist/test/**/*.test.js",
     "prepublishOnly": "npm run build"
   },
   "keywords": [
@@ -24,10 +25,10 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "openai": "^6.44.0"
+    "openai": "^4.0.0"
   },
   "devDependencies": {
-    "@types/node": "^26.0.0",
-    "typescript": "^6.0.3"
+    "@types/node": "^24.0.0",
+    "typescript": "^5.0.0"
   }
 }