@tapi-dev/sdk 0.1.2 → 0.1.3

package/README.md

@@ -1,189 +1,189 @@
-# 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.
-
-## Install Tapi Studio
-
-Tapi Studio is the desktop app used to author and test local Tapi integrations. Install the SDK first, then use the bundled CLI:
-
-```bash
-npm install @tapi-dev/sdk
-npx tapi studio install --channel pilot
-npx tapi studio open
-```
-
-You can also run the CLI directly from npm without adding the package first:
-
-```bash
-npx @tapi-dev/sdk studio install --channel pilot
-```
-
-The CLI reads the release manifest from:
-
-```text
-https://downloads.tapi.dev/studio/channels/pilot/latest.json
-```
-
-It downloads the Windows installer, verifies the manifest SHA256, caches the installer locally, and runs it. The installer cache defaults to:
-
-```text
-%LOCALAPPDATA%\Tapi\Studio\downloads
-```
-
-Useful commands:
-
-```bash
-npx tapi studio install --channel pilot
-npx tapi studio install --channel pilot --download-only
-npx tapi studio install --manifest https://downloads.tapi.dev/studio/channels/pilot/latest.json
-npx tapi studio open
-npx tapi studio doctor
-```
-
-Environment overrides:
-
-```env
-TAPI_STUDIO_CHANNEL=pilot
-TAPI_STUDIO_MANIFEST_URL=https://downloads.tapi.dev/studio/channels/pilot/latest.json
-TAPI_DOWNLOADS_BASE_URL=https://downloads.tapi.dev
-TAPI_STUDIO_EXE=C:\Users\you\AppData\Local\Tapi Studio\Tapi Studio.exe
-```
-
-Tapi Studio desktop releases are currently published for Windows x64.
-
-## 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.
+# 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.
+
+## Install Tapi Studio
+
+Tapi Studio is the desktop app used to author and test local Tapi integrations. Install the SDK first, then use the bundled CLI:
+
+```bash
+npm install @tapi-dev/sdk
+npx tapi studio install --channel pilot
+npx tapi studio open
+```
+
+You can also run the CLI directly from npm without adding the package first:
+
+```bash
+npx @tapi-dev/sdk studio install --channel pilot
+```
+
+The CLI reads the release manifest from:
+
+```text
+https://d4xaf52nfwiok.cloudfront.net/studio/channels/pilot/latest.json
+```
+
+It downloads the Windows installer, verifies the manifest SHA256, caches the installer locally, and runs it. The installer cache defaults to:
+
+```text
+%LOCALAPPDATA%\Tapi\Studio\downloads
+```
+
+Useful commands:
+
+```bash
+npx tapi studio install --channel pilot
+npx tapi studio install --channel pilot --download-only
+npx tapi studio install --manifest https://d4xaf52nfwiok.cloudfront.net/studio/channels/pilot/latest.json
+npx tapi studio open
+npx tapi studio doctor
+```
+
+Environment overrides:
+
+```env
+TAPI_STUDIO_CHANNEL=pilot
+TAPI_STUDIO_MANIFEST_URL=https://d4xaf52nfwiok.cloudfront.net/studio/channels/pilot/latest.json
+TAPI_DOWNLOADS_BASE_URL=https://d4xaf52nfwiok.cloudfront.net
+TAPI_STUDIO_EXE=C:\Users\you\AppData\Local\Tapi Studio\Tapi Studio.exe
+```
+
+Tapi Studio desktop releases are currently published for Windows x64.
+
+## 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/dist/cli.js

@@ -8,7 +8,7 @@ import { basename, join, resolve } from "node:path";
 import { Readable } from "node:stream";
 import { pipeline } from "node:stream/promises";
 import { fileURLToPath } from "node:url";
-const DEFAULT_DOWNLOADS_BASE_URL = "https://downloads.tapi.dev";
+const DEFAULT_DOWNLOADS_BASE_URL = "https://d4xaf52nfwiok.cloudfront.net";
 const DEFAULT_CHANNEL = "pilot";
 const SUPPORTED_STUDIO_PLATFORM = "windows-x86_64";
 const sdkVersion = readSdkVersion();
@@ -109,10 +109,11 @@ export function parseStudioOptions(args) {
         throw new Error(`Unknown option: ${arg}`);
     }
     const channel = raw.channel ?? parseChannel(envString("TAPI_STUDIO_CHANNEL") ?? DEFAULT_CHANNEL);
-    const downloadsBaseUrl = envString("TAPI_DOWNLOADS_BASE_URL") ?? DEFAULT_DOWNLOADS_BASE_URL;
-    const manifestUrl = raw.manifestUrl ??
-        envString("TAPI_STUDIO_MANIFEST_URL") ??
-        `${downloadsBaseUrl.replace(/\/+$/, "")}/studio/channels/${channel}/latest.json`;
+    const downloadsBaseUrl = normalizeHttpUrl(envString("TAPI_DOWNLOADS_BASE_URL") ?? DEFAULT_DOWNLOADS_BASE_URL, "TAPI_DOWNLOADS_BASE_URL");
+    const explicitManifestUrl = raw.manifestUrl ?? envString("TAPI_STUDIO_MANIFEST_URL");
+    const manifestUrl = explicitManifestUrl
+        ? normalizeHttpUrl(explicitManifestUrl, "Studio manifest URL")
+        : `${downloadsBaseUrl.replace(/\/+$/, "")}/studio/channels/${channel}/latest.json`;
     return {
         channel,
         manifestUrl,
@@ -152,7 +153,7 @@ export function validateStudioManifest(input) {
         channel: requiredString(record, "channel"),
         platform: requiredString(record, "platform"),
         artifactName: requiredString(record, "artifactName"),
-        url: requiredString(record, "url"),
+        url: normalizeHttpUrl(requiredString(record, "url"), "Studio manifest url"),
         sha256: requiredString(record, "sha256").toLowerCase(),
         sizeBytes: optionalNumber(record, "sizeBytes"),
         minSdkVersion: optionalString(record, "minSdkVersion"),
@@ -162,9 +163,6 @@ export function validateStudioManifest(input) {
         ref: optionalString(record, "ref"),
         installerKind: optionalString(record, "installerKind"),
     };
-    if (!/^https?:\/\//i.test(manifest.url)) {
-        throw new Error("Studio manifest url must be an absolute HTTP(S) URL.");
-    }
     if (!/^[a-f0-9]{64}$/i.test(manifest.sha256)) {
         throw new Error("Studio manifest sha256 must be a 64-character hex digest.");
     }
@@ -363,6 +361,23 @@ function envString(name) {
     const value = process.env[name];
     return value && value.trim() ? value.trim() : undefined;
 }
+function normalizeHttpUrl(value, label) {
+    const trimmed = value.trim();
+    const withScheme = /^[a-z][a-z0-9+.-]*:\/\//i.test(trimmed) ? trimmed : `https://${trimmed}`;
+    try {
+        const url = new URL(withScheme);
+        if (url.protocol !== "https:" && url.protocol !== "http:") {
+            throw new Error(`${label} must use HTTP or HTTPS.`);
+        }
+        return url.toString();
+    }
+    catch (error) {
+        if (error instanceof Error && error.message.includes("must use HTTP or HTTPS")) {
+            throw error;
+        }
+        throw new Error(`${label} must be a valid HTTP(S) URL.`);
+    }
+}
 function hasHelpFlag(args) {
     return args.some((arg) => arg === "--help" || arg === "-h");
 }

package/package.json

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