tako-sdk 0.1.0

package/README.md

@@ -0,0 +1,129 @@
+# Tako SDK
+
+A lightweight TypeScript SDK for the [Tako API](https://trytako.com).
+
+## Installation
+
+```bash
+npm install tako-sdk
+# or
+yarn add tako-sdk
+# or
+pnpm add tako-sdk
+```
+
+## Quick Start
+
+```typescript
+import { createTakoClient } from 'tako-sdk';
+
+// Initialize the client
+const tako = createTakoClient(process.env.TAKO_API_KEY!);
+
+// Search Tako Knowledge
+const results = await tako.knowledgeSearch('AMD vs. Nvidia headcount since 2015');
+console.log(results.outputs.knowledge_cards);
+```
+
+## Usage Examples
+
+### Next.js API Route (App Router)
+
+```typescript
+// app/api/tako-search/route.ts
+import { createTakoClient } from 'tako-sdk';
+import { NextResponse } from 'next/server';
+
+export async function POST(request: Request) {
+  const { query, sourceIndexes } = await request.json();
+  const tako = createTakoClient(process.env.TAKO_API_KEY!);
+  
+  try {
+    const results = await tako.knowledgeSearch(query, sourceIndexes);
+    return NextResponse.json(results);
+  } catch (error: any) {
+    return NextResponse.json(
+      { error: error.message || 'An error occurred' },
+      { status: error.status || 500 }
+    );
+  }
+}
+```
+
+### Edge API Route
+
+```typescript
+// app/api/tako-edge/route.ts
+import { createTakoClient } from 'tako-sdk';
+import { NextResponse } from 'next/server';
+
+export const runtime = 'edge';
+
+export async function POST(request: Request) {
+  const { query, sourceIndexes } = await request.json();
+  const tako = createTakoClient(process.env.TAKO_API_KEY!);
+  
+  try {
+    const results = await tako.knowledgeSearch(query, sourceIndexes);
+    return NextResponse.json(results);
+  } catch (error: any) {
+    return NextResponse.json(
+      { error: error.message || 'An error occurred' },
+      { status: error.status || 500 }
+    );
+  }
+}
+```
+
+## API Reference
+
+### `createTakoClient(apiKey, baseUrl?)`
+
+Creates a new Tako API client.
+
+```typescript
+const tako = createTakoClient('your-api-key');
+```
+
+Parameters:
+- `apiKey` (string): Your Tako API key
+- `baseUrl` (string, optional): Override the default API base URL
+
+### `takoClient.knowledgeSearch(text, sourceIndexes?)`
+
+Search Tako Knowledge using natural language.
+
+```typescript
+const results = await tako.knowledgeSearch('AMD vs. Nvidia headcount since 2015');
+```
+
+Parameters:
+- `text` (string): The natural language query text
+- `sourceIndexes` (string[], optional): Array of source indexes to search within
+
+Returns: `Promise<KnowledgeSearchResponse>`
+
+## Examples
+
+The SDK includes several examples in the `examples/` directory:
+
+- `edge-api-route.ts` - Edge Runtime API route example
+- `next-api-route.ts` - Standard Next.js API route example
+
+## Error Handling
+
+The SDK throws typed errors with status codes and messages:
+
+```typescript
+try {
+  const results = await tako.knowledgeSearch(query);
+} catch (error: any) {
+  if (error.status === 401) {
+    console.error('Authentication error:', error.message);
+  } else if (error.status === 429) {
+    console.error('Rate limit exceeded:', error.message);
+  } else {
+    console.error('Unexpected error:', error);
+  }
+}
+```

package/dist/index.cjs

@@ -0,0 +1,116 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  SourceIndex: () => SourceIndex,
+  createTakoClient: () => createTakoClient
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/types.ts
+var SourceIndex = /* @__PURE__ */ ((SourceIndex2) => {
+  SourceIndex2["TAKO"] = "tako";
+  SourceIndex2["WEB"] = "web";
+  return SourceIndex2;
+})(SourceIndex || {});
+
+// src/client.ts
+var TakoClient = class {
+  /**
+   * Create a new Tako API client
+   * @param config Configuration for the Tako API client
+   */
+  constructor(config) {
+    if (!config.apiKey?.trim()) {
+      throw new Error("API key is required");
+    }
+    this.apiKey = config.apiKey;
+    this.baseUrl = config.baseUrl || "https://trytako.com/api/v1";
+  }
+  /**
+   * Make a request to the Tako API
+   * @param path API endpoint path
+   * @param method HTTP method
+   * @param body Request body
+   * @returns Response data
+   */
+  async request(path, method, body) {
+    const url = `${this.baseUrl}${path}`;
+    const headers = {
+      Authorization: `Bearer ${this.apiKey}`,
+      "Content-Type": "application/json"
+    };
+    const options = {
+      method,
+      headers,
+      body: body ? JSON.stringify(body) : void 0
+    };
+    try {
+      const response = await fetch(url, options);
+      if (!response.ok) {
+        const errorData = await response.json();
+        throw {
+          status: response.status,
+          message: errorData.message || response.statusText,
+          details: errorData
+        };
+      }
+      return await response.json();
+    } catch (error) {
+      if (error.status) {
+        throw error;
+      }
+      throw {
+        status: 500,
+        message: "Network error",
+        details: error
+      };
+    }
+  }
+  /**
+   * Search Tako Knowledge using natural language
+   * @param text The natural language query text
+   * @param sourceIndexes Optional array of source indexes to search within
+   * @returns Knowledge search results
+   */
+  async knowledgeSearch(text, sourceIndexes) {
+    if (!text?.trim()) {
+      throw new Error("Search text is required");
+    }
+    const requestBody = {
+      inputs: {
+        text,
+        ...sourceIndexes && sourceIndexes.length > 0 ? { source_indexes: sourceIndexes } : {}
+      }
+    };
+    return this.request("/knowledge_search", "POST", requestBody);
+  }
+};
+
+// src/index.ts
+function createTakoClient(apiKey, baseUrl) {
+  return new TakoClient({ apiKey, baseUrl });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  SourceIndex,
+  createTakoClient
+});

package/dist/index.d.cts

@@ -0,0 +1,86 @@
+/**
+ * Tako API Types
+ */
+declare enum SourceIndex {
+    TAKO = "tako",
+    WEB = "web"
+}
+interface TakoConfig {
+    apiKey: string;
+    baseUrl?: string;
+}
+interface KnowledgeSearchInput {
+    text: string;
+    source_indexes?: SourceIndex[];
+}
+interface KnowledgeSearchRequest {
+    inputs: KnowledgeSearchInput;
+}
+interface Source {
+    source_name: string;
+    source_description: string;
+    source_index: string;
+    url: string;
+}
+interface Methodology {
+    methodology_name: string;
+    methodology_description?: string;
+}
+interface KnowledgeCard {
+    card_id: string;
+    title: string;
+    description: string;
+    webpage_url: string;
+    image_url: string;
+    embed_url: string;
+    sources: Source[];
+    methodologies?: Methodology[];
+}
+interface KnowledgeSearchResponse {
+    outputs: {
+        knowledge_cards: KnowledgeCard[];
+    };
+}
+interface TakoError {
+    status: number;
+    message: string;
+    details?: any;
+}
+
+/**
+ * Tako API Client
+ */
+declare class TakoClient {
+    private apiKey;
+    private baseUrl;
+    /**
+     * Create a new Tako API client
+     * @param config Configuration for the Tako API client
+     */
+    constructor(config: TakoConfig);
+    /**
+     * Make a request to the Tako API
+     * @param path API endpoint path
+     * @param method HTTP method
+     * @param body Request body
+     * @returns Response data
+     */
+    private request;
+    /**
+     * Search Tako Knowledge using natural language
+     * @param text The natural language query text
+     * @param sourceIndexes Optional array of source indexes to search within
+     * @returns Knowledge search results
+     */
+    knowledgeSearch(text: string, sourceIndexes?: SourceIndex[]): Promise<KnowledgeSearchResponse>;
+}
+
+/**
+ * Create a new Tako API client
+ * @param apiKey Your Tako API key
+ * @param baseUrl Optional base URL for the Tako API
+ * @returns A configured Tako client
+ */
+declare function createTakoClient(apiKey: string, baseUrl?: string): TakoClient;
+
+export { KnowledgeCard, KnowledgeSearchInput, KnowledgeSearchRequest, KnowledgeSearchResponse, Methodology, Source, SourceIndex, TakoConfig, TakoError, createTakoClient };

package/dist/index.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Tako API Types
+ */
+declare enum SourceIndex {
+    TAKO = "tako",
+    WEB = "web"
+}
+interface TakoConfig {
+    apiKey: string;
+    baseUrl?: string;
+}
+interface KnowledgeSearchInput {
+    text: string;
+    source_indexes?: SourceIndex[];
+}
+interface KnowledgeSearchRequest {
+    inputs: KnowledgeSearchInput;
+}
+interface Source {
+    source_name: string;
+    source_description: string;
+    source_index: string;
+    url: string;
+}
+interface Methodology {
+    methodology_name: string;
+    methodology_description?: string;
+}
+interface KnowledgeCard {
+    card_id: string;
+    title: string;
+    description: string;
+    webpage_url: string;
+    image_url: string;
+    embed_url: string;
+    sources: Source[];
+    methodologies?: Methodology[];
+}
+interface KnowledgeSearchResponse {
+    outputs: {
+        knowledge_cards: KnowledgeCard[];
+    };
+}
+interface TakoError {
+    status: number;
+    message: string;
+    details?: any;
+}
+
+/**
+ * Tako API Client
+ */
+declare class TakoClient {
+    private apiKey;
+    private baseUrl;
+    /**
+     * Create a new Tako API client
+     * @param config Configuration for the Tako API client
+     */
+    constructor(config: TakoConfig);
+    /**
+     * Make a request to the Tako API
+     * @param path API endpoint path
+     * @param method HTTP method
+     * @param body Request body
+     * @returns Response data
+     */
+    private request;
+    /**
+     * Search Tako Knowledge using natural language
+     * @param text The natural language query text
+     * @param sourceIndexes Optional array of source indexes to search within
+     * @returns Knowledge search results
+     */
+    knowledgeSearch(text: string, sourceIndexes?: SourceIndex[]): Promise<KnowledgeSearchResponse>;
+}
+
+/**
+ * Create a new Tako API client
+ * @param apiKey Your Tako API key
+ * @param baseUrl Optional base URL for the Tako API
+ * @returns A configured Tako client
+ */
+declare function createTakoClient(apiKey: string, baseUrl?: string): TakoClient;
+
+export { KnowledgeCard, KnowledgeSearchInput, KnowledgeSearchRequest, KnowledgeSearchResponse, Methodology, Source, SourceIndex, TakoConfig, TakoError, createTakoClient };

package/dist/index.js

@@ -0,0 +1,88 @@
+// src/types.ts
+var SourceIndex = /* @__PURE__ */ ((SourceIndex2) => {
+  SourceIndex2["TAKO"] = "tako";
+  SourceIndex2["WEB"] = "web";
+  return SourceIndex2;
+})(SourceIndex || {});
+
+// src/client.ts
+var TakoClient = class {
+  /**
+   * Create a new Tako API client
+   * @param config Configuration for the Tako API client
+   */
+  constructor(config) {
+    if (!config.apiKey?.trim()) {
+      throw new Error("API key is required");
+    }
+    this.apiKey = config.apiKey;
+    this.baseUrl = config.baseUrl || "https://trytako.com/api/v1";
+  }
+  /**
+   * Make a request to the Tako API
+   * @param path API endpoint path
+   * @param method HTTP method
+   * @param body Request body
+   * @returns Response data
+   */
+  async request(path, method, body) {
+    const url = `${this.baseUrl}${path}`;
+    const headers = {
+      Authorization: `Bearer ${this.apiKey}`,
+      "Content-Type": "application/json"
+    };
+    const options = {
+      method,
+      headers,
+      body: body ? JSON.stringify(body) : void 0
+    };
+    try {
+      const response = await fetch(url, options);
+      if (!response.ok) {
+        const errorData = await response.json();
+        throw {
+          status: response.status,
+          message: errorData.message || response.statusText,
+          details: errorData
+        };
+      }
+      return await response.json();
+    } catch (error) {
+      if (error.status) {
+        throw error;
+      }
+      throw {
+        status: 500,
+        message: "Network error",
+        details: error
+      };
+    }
+  }
+  /**
+   * Search Tako Knowledge using natural language
+   * @param text The natural language query text
+   * @param sourceIndexes Optional array of source indexes to search within
+   * @returns Knowledge search results
+   */
+  async knowledgeSearch(text, sourceIndexes) {
+    if (!text?.trim()) {
+      throw new Error("Search text is required");
+    }
+    const requestBody = {
+      inputs: {
+        text,
+        ...sourceIndexes && sourceIndexes.length > 0 ? { source_indexes: sourceIndexes } : {}
+      }
+    };
+    return this.request("/knowledge_search", "POST", requestBody);
+  }
+};
+
+// src/index.ts
+function createTakoClient(apiKey, baseUrl) {
+  return new TakoClient({ apiKey, baseUrl });
+}
+export {
+  SourceIndex,
+  createTakoClient
+};

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "tako-sdk",
+  "version": "0.1.0",
+  "description": "JavaScript/TypeScript SDK for the Tako API",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "lint": "eslint src/**/*.ts",
+    "test": "jest",
+    "prepublishOnly": "npm run build",
+    "test:js": "node test.js",
+    "test:ts": "node --loader ts-node/esm test.ts"
+  },
+  "keywords": [
+    "tako",
+    "api",
+    "sdk",
+    "typescript",
+    "javascript",
+    "nextjs"
+  ],
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/jest": "^29.5.3",
+    "@types/node": "^20.4.5",
+    "@typescript-eslint/eslint-plugin": "^6.2.0",
+    "@typescript-eslint/parser": "^6.2.0",
+    "eslint": "^8.46.0",
+    "jest": "^29.6.2",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.2",
+    "tsup": "^7.1.0",
+    "typescript": "^5.1.6"
+  },
+  "peerDependencies": {
+    "typescript": ">=4.7.0"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  }
+}