bios-sdk 0.1.0-dev.1 → 0.1.0-dev.3

package/README.md

@@ -14,7 +14,7 @@ npm install bios-sdk
 import { BiOS } from 'bios-sdk';
 
 const client = new BiOS({
-  apiKey: 'usf-...',
+  apiKey: 'bios-...',
 });
 
 // Search for models
@@ -40,12 +40,28 @@ console.log(`Job ${job.id} created`);
 
 ### API Key (recommended)
 
+API keys start with `bios-` (legacy `usf-` keys stay valid).
+
 ```typescript
 const client = new BiOS({
-  apiKey: 'usf-...',
+  apiKey: 'bios-...',
 });
 ```
 
+### Environment Variables
+
+When `apiKey` or `baseUrl` is omitted from the config, the SDK reads them
+from the environment:
+
+```bash
+export BIOS_API_KEY=bios-...
+export BIOS_BASE_URL=https://api.usbios.ai   # optional; this is the default
+```
+
+```typescript
+const client = new BiOS({}); // uses BIOS_API_KEY / BIOS_BASE_URL
+```
+
 ### JWT Access Token
 
 ```typescript
@@ -68,8 +84,8 @@ without an explicit replay acknowledgement from the endpoint.
 
 ```typescript
 const client = new BiOS({
-  apiKey: 'usf-control-plane-key',
-  inferenceKey: 'sk-usf-deployment-key',
+  apiKey: 'bios-control-plane-key',
+  inferenceKey: 'sk-bios-deployment-key',
   // inferenceBaseUrl: 'https://api-dev.usbios.ai', // explicit in dev
 });
 
@@ -275,11 +291,11 @@ try {
 
 | Option | Default | Description |
 |--------|---------|-------------|
-| `apiKey` | — | API key (`usf-...`) |
+| `apiKey` | `BIOS_API_KEY` env var | API key (`bios-...`; legacy `usf-...` keys stay valid) |
 | `accessToken` | — | JWT access token |
 | `orgId` | — | Organization ID (auto-resolved with API keys) |
 | `workspaceId` | — | Workspace ID (auto-resolved with API keys) |
-| `baseUrl` | `https://api.usbios.ai` | Canonical production hostname (release-gated; this documentation does not assert current availability). During prelaunch/dev, pass `https://api-dev.usbios.ai` explicitly. |
+| `baseUrl` | `BIOS_BASE_URL` env var, then `https://api.usbios.ai` | Canonical production hostname (release-gated; this documentation does not assert current availability). During prelaunch/dev, pass `https://api-dev.usbios.ai` explicitly. |
 | `timeout` | `30000` | Request timeout in ms |
 
 ## Requirements

package/dist/client.d.ts

@@ -22,6 +22,10 @@ export declare class ApiError extends Error {
     readonly requestId: string | undefined;
     constructor(status: number, body: ApiErrorBody);
 }
+/** Default API key from `BIOS_API_KEY` when the config omits one. @internal */
+export declare function envApiKey(): string | undefined;
+/** Default base URL from `BIOS_BASE_URL` when the config omits one. @internal */
+export declare function envBaseUrl(): string | undefined;
 export declare class HttpClient {
     private readonly baseUrl;
     private readonly apiKey;

package/dist/client.js

@@ -39,6 +39,27 @@ export class ApiError extends Error {
     }
 }
 // ============================================================================
+// Environment defaults
+// ============================================================================
+/**
+ * Read an environment variable, tolerating browser bundles where `process`
+ * does not exist. Returns undefined for missing or empty values.
+ */
+function envVar(name) {
+    if (typeof process === 'undefined' || !process.env)
+        return undefined;
+    const value = process.env[name];
+    return value && value.trim() !== '' ? value.trim() : undefined;
+}
+/** Default API key from `BIOS_API_KEY` when the config omits one. @internal */
+export function envApiKey() {
+    return envVar('BIOS_API_KEY');
+}
+/** Default base URL from `BIOS_BASE_URL` when the config omits one. @internal */
+export function envBaseUrl() {
+    return envVar('BIOS_BASE_URL');
+}
+// ============================================================================
 // HttpClient — shared HTTP transport used by resource modules via composition
 // ============================================================================
 export class HttpClient {
@@ -49,14 +70,14 @@ export class HttpClient {
     workspaceIdValue;
     timeout;
     constructor(config) {
-        this.baseUrl = (config.baseUrl || 'https://api-dev.usbios.ai').replace(/\/+$/, '');
-        this.apiKey = config.apiKey;
+        this.baseUrl = (config.baseUrl || envBaseUrl() || 'https://api-dev.usbios.ai').replace(/\/+$/, '');
+        this.apiKey = config.apiKey ?? envApiKey();
         this.accessToken = config.accessToken;
         this.orgId = config.orgId;
         this.workspaceIdValue = config.workspaceId;
         this.timeout = config.timeout ?? 30_000;
         if (!this.apiKey && !this.accessToken) {
-            throw new Error('BiOS: either apiKey or accessToken is required');
+            throw new Error('BiOS: either apiKey or accessToken is required (or set the BIOS_API_KEY environment variable)');
         }
     }
     /** Workspace configured on the client, used by multipart/control-plane helpers. */

package/dist/index.d.ts

@@ -6,7 +6,7 @@
  * import { BiOS } from 'bios-sdk';
  *
  * const client = new BiOS({
- *   apiKey: 'usf-...',
+ *   apiKey: 'bios-...',
  * });
  *
  * // Search for models

package/dist/index.js

@@ -6,7 +6,7 @@
  * import { BiOS } from 'bios-sdk';
  *
  * const client = new BiOS({
- *   apiKey: 'usf-...',
+ *   apiKey: 'bios-...',
  * });
  *
  * // Search for models

package/dist/resources/inference.js

@@ -1,4 +1,4 @@
-import { ApiError } from '../client.js';
+import { ApiError, envBaseUrl } from '../client.js';
 import { normalizeGPUPlacement } from './gpu-priorities.js';
 const FUNCTION_NAME = /^[A-Za-z0-9_-]{1,64}$/;
 const ROLES = new Set(['system', 'developer', 'user', 'assistant', 'tool', 'function']);
@@ -280,7 +280,7 @@ export class Inference {
     _http;
     constructor(config = {}, http) {
         this.key = config.inferenceKey;
-        this.baseUrl = (config.baseUrl || 'https://api-dev.usbios.ai').replace(/\/+$/, '');
+        this.baseUrl = (config.baseUrl || envBaseUrl() || 'https://api-dev.usbios.ai').replace(/\/+$/, '');
         this.timeout = config.timeout ?? 900_000;
         this._http = http;
     }

package/dist/types.d.ts

@@ -1,6 +1,6 @@
 /** Configuration for initializing the BIOS SDK client. */
 export interface BiOSConfig {
-    /** API key for authentication (prefix: usf-). Mutually exclusive with accessToken. */
+    /** API key for authentication (prefix: bios-; legacy usf- keys stay valid). Falls back to the BIOS_API_KEY environment variable. Mutually exclusive with accessToken. */
     apiKey?: string;
     /** JWT access token for authentication. Mutually exclusive with apiKey. */
     accessToken?: string;
@@ -8,7 +8,7 @@ export interface BiOSConfig {
     orgId?: string;
     /** Workspace ID. Optional when using API keys (resolved from the key). Can override for multi-workspace keys. */
     workspaceId?: string;
-    /** Base URL for the API. Defaults to the canonical https://api-dev.usbios.ai hostname. */
+    /** Base URL for the API. Falls back to the BIOS_BASE_URL environment variable, then the canonical https://api-dev.usbios.ai hostname. */
     baseUrl?: string;
     /** Request timeout in milliseconds. Defaults to 30000. */
     timeout?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bios-sdk",
-  "version": "0.1.0-dev.1",
+  "version": "0.1.0-dev.3",
   "description": "Official TypeScript SDK for the BIOS training and deployment platform API",
   "type": "module",
   "main": "./dist/index.js",