@turnstileai/sdk 0.1.4 → 0.1.6

package/README.md

@@ -1,16 +1,16 @@
 # @turnstileai/sdk
 
-TypeScript SDK for TurnstileAI.
+The official TypeScript/JavaScript SDK for TurnstileAI, a verification-first AI gateway for routed completions, run records, and optional ledger-backed checkpoints.
 
-TurnstileAI is a verification-focused AI gateway SDK for working with routed model requests, run records, provider health, and usage analytics.
-
-## Install
+## Installation
 
 ```bash
 npm install @turnstileai/sdk
 ```
 
-## Quick start
+## Quickstart
+
+Initialize the client and send verification-enabled inference completions:
 
 ```ts
 import { TurnstileAI } from "@turnstileai/sdk";
@@ -18,40 +18,61 @@ import { TurnstileAI } from "@turnstileai/sdk";
 const client = new TurnstileAI({
   apiKey: process.env.TURNSTILEAI_API_KEY!
 });
-```
 
-## Fetch a run record
+const result = await client.chat({
+  model: "openrouter/llama-3.1-70b",
+  messages: [
+    { role: "user", content: "Explain zero-knowledge rollups simply." }
+  ],
+  receipt: true,
+  anchor: "solana",
+  routeMode: "trust-first"
+});
 
-```ts
-const record = await client.records.get("rr_123");
-console.log(record);
+console.log(result.output);
+console.log(JSON.stringify(result.record, null, 2));
+console.log(JSON.stringify(result.verification, null, 2));
 ```
 
-## Verify a run record
+## Sandboxed Local Testing (No Server Needed)
 
-```ts
-const verification = await client.records.verify("rr_123");
-console.log(verification.status);
-```
+If the SDK detects an API key starting with `ts_test_` or the environment variable `TURNSTILEAI_MOCK=true` is set, it can fall back to local mock mode for offline development and integration testing.
 
-## List providers
+## Config Parameters
 
-```ts
-const providers = await client.providers.list();
-console.log(providers);
-```
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `apiKey` | `string` | Your TurnstileAI API key. |
+| `baseURL` | `string` | The TurnstileAI API base URL, defaults to `https://api.turnstileai.com/v1`. |
+| `timeout` | `number` | Request timeout in milliseconds. |
+| `defaultRouteMode` | `RouteMode` | Optional default routing strategy. |
+| `defaultLedgerMode` | `LedgerMode` | Optional default ledger/checkpoint mode. |
+
+## Chat Options
 
-## Usage overview
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `model` | `string` | Required | Model routing path such as `openai/gpt-4o-mini` or `openrouter/llama-3.1-70b`. |
+| `messages` | `Array` | Required | Message array with `role` and `content`. |
+| `receipt` | `boolean` | `true` | Include a verification-oriented run record in the response. |
+| `anchor` | `string` | `"off-chain"` | Checkpoint mode: `"solana"`, `"off-chain"`, or `"none"`. |
+| `routeMode` | `string` | `"trust-first"` | Routing strategy for provider selection. |
+| `provider` | `string` | Optional | Pin inference to a provider. |
+| `maxSpendUsd` | `number` | Optional | Set a maximum spend cap for a request. |
+| `temperature` | `number` | Optional | Sampling temperature for completion generation. |
+| `maxTokens` | `number` | Optional | Output token limit. |
+
+## Record APIs
 
 ```ts
+const record = await client.records.get("rr_123");
+const verification = await client.records.verify("rr_123");
+const providers = await client.providers.list();
 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
@@ -61,39 +82,6 @@ turnstileai providers list --key=ts_live_xxx
 turnstileai usage overview --key=ts_live_xxx
 ```
 
-## Route modes
-
-- `cost-first`
-- `speed-first`
-- `trust-first`
-- `attested-only`
-- `provider-pinned`
-- `budget-guarded`
-
-## Ledger modes
-
-- `none`
-- `solana`
-
-## Development
-
-Build the package:
-
-```bash
-npm run build
-```
-
-Run tests:
-
-```bash
-npm test
-```
-
-## Publish updates
+## License
 
-When you change the SDK or README, publish a new version:
-
-```bash
-npm version patch
-npm publish --access public
-```
+MIT

package/dist/types.d.ts

@@ -73,3 +73,26 @@ export interface TurnstileApiErrorBody {
     message?: string;
     details?: unknown;
 }
+export interface TurnstileChatMessage {
+    role: "system" | "user" | "assistant";
+    content: string;
+}
+export interface TurnstileChatRequest {
+    model: string;
+    messages: TurnstileChatMessage[];
+    receipt?: boolean;
+    anchor?: "solana" | "off-chain" | "none";
+    routeMode?: RouteMode;
+    provider?: string;
+    maxSpendUsd?: number;
+    temperature?: number;
+    maxTokens?: number;
+}
+export interface TurnstileChatResult {
+    id: string;
+    model: string;
+    provider: string;
+    output: string;
+    record: RunRecord | null;
+    verification: VerificationResult | null;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@turnstileai/sdk",
-  "version": "0.1.4",
-  "description": "Original TypeScript SDK for TurnstileAI",
+  "version": "0.1.6",
+  "description": "TypeScript SDK for TurnstileAI, a verification-first AI gateway",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": {
@@ -19,11 +19,25 @@
   "keywords": [
     "ai",
     "sdk",
+    "solana",
+    "verification",
     "llm",
     "typescript",
     "turnstileai"
   ],
+  "author": "TurnstileAI",
   "license": "MIT",
+  "homepage": "https://github.com/turnstileai/TurnstileAI",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/turnstileai/TurnstileAI.git"
+  },
+  "bugs": {
+    "url": "https://github.com/turnstileai/TurnstileAI/issues"
+  },
+  "engines": {
+    "node": ">=18"
+  },
   "dependencies": {
     "openai": "^4.0.0"
   },