@tapi-dev/sdk 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,140 @@
+# TAPI JavaScript SDK
+
+Official JavaScript and TypeScript client for TAPI developer APIs.
+
+## Install
+
+```bash
+npm install @tapi-dev/sdk
+```
+
+This package is ESM-first and works in runtimes with `fetch`, including modern Node.js and browser-like server runtimes.
+
+## Quick Start
+
+Create one TAPI client in your app's server-side code:
+
+```ts
+import { TapiClient } from "@tapi-dev/sdk";
+
+export const tapi = new TapiClient({
+  baseUrl: process.env.TAPI_BASE_URL!,
+  apiKey: process.env.TAPI_API_KEY!,
+  appId: process.env.TAPI_APP_ID,
+});
+```
+
+Then call a TAPI website API:
+
+```ts
+const run = await tapi.websiteApis.run("brokerage.submitTrade", {
+  inputs: {
+    symbol: "AAPL",
+    quantity: 1,
+    side: "buy",
+  },
+});
+
+const completedRun = await tapi.runs.wait(run.id);
+console.log(completedRun.status, completedRun.result);
+```
+
+Do not expose `TAPI_API_KEY` in public browser bundles. Put the SDK behind your own backend route, server action, or job worker when using secret API keys.
+
+## Configuration
+
+```env
+TAPI_BASE_URL=https://your-tapi-api-host
+TAPI_API_KEY=tapi_your_api_key
+TAPI_APP_ID=your-app-id
+```
+
+`appId` is optional. If provided, the SDK sends it as the `X-Tapi-App` header.
+
+## Common Project Setup
+
+A typical application keeps the client in one small module:
+
+```text
+src/
+  lib/
+    tapi.ts
+```
+
+```ts
+// src/lib/tapi.ts
+import { TapiClient } from "@tapi-dev/sdk";
+
+export const tapi = new TapiClient({
+  baseUrl: process.env.TAPI_BASE_URL!,
+  apiKey: process.env.TAPI_API_KEY!,
+  appId: process.env.TAPI_APP_ID,
+});
+```
+
+Application code should import this shared client instead of constructing a new client in every file.
+
+## Available Resources
+
+```ts
+await tapi.catalog.get();
+await tapi.runners.list();
+await tapi.runtime.requirements();
+
+const run = await tapi.websiteApis.run("apiName.requestKey", {
+  inputs: { example: true },
+  priority: 5,
+  runnerId: "runner-id",
+  idempotencyKey: "request-123",
+});
+
+await tapi.runs.get(run.id);
+await tapi.runs.wait(run.id, { intervalMs: 1000, timeoutMs: 300000 });
+await tapi.runs.cancel(run.id);
+```
+
+Website API requests are addressed as `<apiName>.<requestKey>`.
+
+## Errors
+
+Failed HTTP responses throw `TapiError`:
+
+```ts
+import { TapiError } from "@tapi-dev/sdk";
+
+try {
+  await tapi.catalog.get();
+} catch (error) {
+  if (error instanceof TapiError) {
+    console.error(error.status, error.code, error.details);
+  }
+  throw error;
+}
+```
+
+## TypeScript
+
+The package includes generated TypeScript declarations. Common exported types include:
+
+```ts
+import type {
+  RuntimeRequirements,
+  SdkCatalog,
+  TapiRun,
+  TapiRunner,
+  WebsiteApiRunRequest,
+} from "@tapi-dev/sdk";
+```
+
+## Local Development
+
+From this SDK directory:
+
+```bash
+npm ci
+npm test
+npm run build
+npm pack --dry-run
+```
+
+`npm pack --dry-run` shows the exact files that will be published.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tapi-dev/sdk",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",