@inferencesh/sdk 0.7.0 → 0.7.1

package/dist/index.d.ts

@@ -28,7 +28,7 @@ export { ProjectsAPI } from './api/projects';
 export { MCPServersAPI } from './api/mcp-servers';
 export { LiveSession, accessUrl } from './live/session';
 export type { LiveState, LiveEnd, LiveHandlers, LiveSessionOptions, WebSocketLike, WebSocketConstructor } from './live/session';
-export { STREAM_FORMAT, isLiveField, parseMediaType, pcmFormat, splitLiveSchema, binaryLiveField, alternativeLabel, } from './live/schema';
+export { STREAM_FORMAT, CLEAR_KEY, isLiveField, parseMediaType, pcmFormat, splitLiveSchema, binaryLiveField, alternativeLabel, } from './live/schema';
 export type { JsonSchema, MediaType, PCMFormat, LiveField } from './live/schema';
 export { tool, appTool, agentTool, webhookTool, httpTool, callTool, mcpTool, internalTools, string, number, integer, boolean, enumOf, object, array, optional, } from './tool-builder';
 export type { ClientTool, ClientToolHandler } from './tool-builder';

package/dist/index.js

@@ -30,7 +30,7 @@ export { ProjectsAPI } from './api/projects';
 export { MCPServersAPI } from './api/mcp-servers';
 // Live: the socket of a stream task and the live fields of its schemas
 export { LiveSession, accessUrl } from './live/session';
-export { STREAM_FORMAT, isLiveField, parseMediaType, pcmFormat, splitLiveSchema, binaryLiveField, alternativeLabel, } from './live/schema';
+export { STREAM_FORMAT, CLEAR_KEY, isLiveField, parseMediaType, pcmFormat, splitLiveSchema, binaryLiveField, alternativeLabel, } from './live/schema';
 // Tool Builder (fluent API)
 export { tool, appTool, agentTool, webhookTool, httpTool, callTool, mcpTool, internalTools, string, number, integer, boolean, enumOf, object, array, optional, } from './tool-builder';
 // Hook Builder (fluent API)

package/dist/live/schema.d.ts

@@ -17,6 +17,11 @@
  * JSON Schema type keeps it.
  */
 export declare const STREAM_FORMAT = "stream";
+/**
+ * A control frame, `{"$clear": "audio"}`: drop what has been buffered of a
+ * live output field. Reserved keys start with `$`, which no field name can.
+ */
+export declare const CLEAR_KEY = "$clear";
 /** The part of JSON Schema these helpers read. */
 export interface JsonSchema {
     $ref?: string;

package/dist/live/schema.js

@@ -17,6 +17,11 @@
  * JSON Schema type keeps it.
  */
 export const STREAM_FORMAT = 'stream';
+/**
+ * A control frame, `{"$clear": "audio"}`: drop what has been buffered of a
+ * live output field. Reserved keys start with `$`, which no field name can.
+ */
+export const CLEAR_KEY = '$clear';
 export function isLiveField(schema) {
     return !!schema && schema.format === STREAM_FORMAT;
 }

package/dist/live/session.d.ts

@@ -27,6 +27,12 @@ export interface LiveHandlers {
     onBinary?: (data: ArrayBuffer) => void;
     /** A partial output object keyed by field name. */
     onPatch?: (patch: Record<string, unknown>) => void;
+    /**
+     * Drop what you have buffered of this live output field: the app sends it
+     * when an answer is cut short, e.g. the user talked over it. Without this
+     * handler the control frame reaches onPatch as `{"$clear": field}`.
+     */
+    onClear?: (field: string) => void;
 }
 /**
  * Follows the task the socket belongs to. `done` settles when the task ends

package/dist/live/session.js

@@ -1,3 +1,4 @@
+import { CLEAR_KEY } from './schema';
 const WS_OPEN = 1;
 // 1012: the relay is restarting and closed an end that still waited for its
 // peer. 1013: the peer did not come in time. Both mean "dial again" while the
@@ -63,7 +64,15 @@ export class LiveSession {
                     patch = { text: event.data };
                 }
                 if (patch && typeof patch === 'object' && !Array.isArray(patch)) {
-                    this.handlers.onPatch?.(patch);
+                    const record = patch;
+                    const clear = record[CLEAR_KEY];
+                    if (this.handlers.onClear && typeof clear === 'string') {
+                        this.handlers.onClear(clear);
+                        delete record[CLEAR_KEY];
+                        if (Object.keys(record).length === 0)
+                            return;
+                    }
+                    this.handlers.onPatch?.(record);
                 }
             }
             else {

package/dist/types.d.ts

@@ -1093,13 +1093,28 @@ export interface SecretRequirement {
     optional?: boolean;
 }
 /**
- * CredentialRequirement defines a credential that an app requires.
- * Key is the provider slug (e.g. "bytedance", "google").
- * Secrets lists the specific env var names to inject from this credential.
- * Scopes lists OAuth scopes needed (for OAuth credentials).
+ * CredentialRequirement is an entry under credentials: in inf.yml: keys an
+ * app needs that belong to a provider. Provider names whose credential
+ * supplies them; Secrets lists the keys to inject from it (an API key
+ * credential), Scopes what to ask for (an OAuth one).
+ * 	credentials:
+ * 	  - provider: acme
+ * 	    name: Acme CRM
+ * 	    website: acme.com
+ * 	    secrets: [ACME_API_KEY]
+ * Key is a capability of a provider the platform defines ("x.tweet.read",
+ * "google.sheets"): an OAuth grant with the scopes it implies. An entry sets
+ * Provider, Key, or both; with both, Key decides how it is resolved.
  */
 export interface CredentialRequirement {
-    key: string;
+    provider?: string;
+    /**
+     * Name and Website describe a provider the platform does not list: the
+     * name its credential is shown under and the site its logo comes from.
+     */
+    name?: string;
+    website?: string;
+    key?: string;
     description?: string;
     optional?: boolean;
     secrets?: string[];
@@ -3193,6 +3208,16 @@ export interface SetupAction {
     scope_descriptions?: {
         [key: string]: string;
     };
+    /**
+     * Secrets are the keys to supply for an add_secret action on a
+     * provider: saved against Provider, they become its credential.
+     */
+    secrets?: string[];
+    /**
+     * ProviderWebsite is where the logo of a provider the platform does not
+     * list comes from; sent back when the keys are saved.
+     */
+    provider_website?: string;
 }
 /**
  * CheckRequirementsRequest is the request body for checking requirements

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inferencesh/sdk",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "Official JavaScript/TypeScript SDK for inference.sh - Run AI models with a simple API",
   "type": "module",
   "main": "dist/index.js",