@runappsai/sdk 0.4.0 → 0.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@runappsai/sdk",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "JavaScript / TypeScript client for the RunApps AI Gateway",
   "license": "MIT",
   "author": "RunApps",

package/src/client.ts

@@ -32,8 +32,8 @@ const DEFAULT_BASE_URL = "https://www.runapps.ai";
 export type AuthProvider = "static" | "runapps" | "runjobs";
 
 export interface ClientOptions {
-  /** Static gateway API key (typically prefixed `gw-` / `rj_` / `rrt_`).
-   *  Required unless `apiKeyResolver` or `authProvider: "runapps"` is supplied. */
+  /** A personal API key (`rk_…`) or another static key. Leave it out in an
+   *  app published on RunApps: the browser client then signs the user in. */
   apiKey?: string;
   /**
    * Dynamic API key resolver.  See `AuthProvider` for the typical
@@ -43,9 +43,9 @@ export interface ClientOptions {
    */
   apiKeyResolver?: () => string | Promise<string>;
   /**
-   * Auth strategy — defaults to `"static"`.  Pass `"runapps"` to
-   * activate the built-in browser auth flow against runapps.ai;
-   * baseURL defaults to `https://www.runapps.ai` in that mode.
+   * Auth strategy. Rarely needed: in a browser with no `apiKey` /
+   * `apiKeyResolver` the client uses `"runapps"` (the platform sign-in),
+   * otherwise `"static"` (the key you pass).
    */
   authProvider?: AuthProvider;
   /**
@@ -104,7 +104,7 @@ export interface ClientOptions {
  * ```html
  * <script src="https://cdn.jsdelivr.net/npm/@runappsai/sdk/dist/sdk.umd.js"></script>
  * <script>
- *   const client = new RunApps.Client({ authProvider: "runapps" });
+ *   const client = new RunApps();
  *   const res = await client.chat.create({
  *     model: "gpt-4o-mini",
  *     messages: [{ role: "user", content: "hello" }],
@@ -152,7 +152,14 @@ export class RunApps {
   readonly events: SDKEvents = new SDKEvents();
 
   constructor(options: ClientOptions = {}) {
-    const provider = options.authProvider ?? "static";
+    // With no key and no explicit authProvider, a browser client uses the
+    // platform sign-in: `new RunApps()` is all an app needs. Elsewhere
+    // (Node, workers without a window) there is no one to sign in.
+    const provider =
+      options.authProvider ??
+      (!options.apiKey && !options.apiKeyResolver && typeof window !== "undefined"
+        ? "runapps"
+        : "static");
     let apiKeyResolver = options.apiKeyResolver;
     let baseURL = options.baseURL;
     let onUnauthorized: (() => void) | undefined;
@@ -197,7 +204,7 @@ export class RunApps {
 
     if (!options.apiKey && !apiKeyResolver) {
       throw new Error(
-        "runapps: pass either `apiKey`, `apiKeyResolver`, or `authProvider: \"runapps\"`",
+        "runapps: pass `apiKey` (or `apiKeyResolver`); outside a browser there is no sign-in to fall back to",
       );
     }
     const transport = new Transport({