@inferencesh/sdk 0.7.0 → 0.8.0

package/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.8.0] - 2026-09-24
+
+### Removed
+
+- The integration-named aliases: `IntegrationsAPI`, `client.integrations`, the `Integration*` type aliases, and `httpTool().auth({ integration, integrationId })`. Use `CredentialsAPI`, `client.credentials`, the `Credential*` types and `auth({ credential, credentialId })`.
+
 ## [0.7.0] - 2026-09-23
 
 ### Changed

package/dist/index.d.ts

@@ -21,14 +21,12 @@ export { TeamsAPI, type MeResponse } from './api/teams';
 export { SecretsAPI } from './api/secrets';
 export { ApiKeysAPI } from './api/api-keys';
 export { CredentialsAPI } from './api/credentials';
-/** @deprecated renamed CredentialsAPI */
-export { CredentialsAPI as IntegrationsAPI } from './api/credentials';
 export { SearchAPI } from './api/search';
 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';
@@ -39,7 +37,6 @@ export { parseStatus, isTerminalStatus, isChatBusy, pendingApprovals } from './u
 export type { PendingApproval } from './utils';
 export * from './types';
 export type { TaskDTO as Task } from './types';
-export type { CredentialDTO as IntegrationDTO, CredentialConfigDTO as IntegrationConfigDTO, CredentialConnectRequest as IntegrationConnectRequest, CredentialConnectResponse as IntegrationConnectResponse, CredentialCompleteOAuthRequest as IntegrationCompleteOAuthRequest, CredentialRequirement as IntegrationRequirement, CredentialStatus as IntegrationStatus, CredentialScope as IntegrationScope, CredentialGrant as IntegrationGrant, CredentialType as IntegrationAuthType, CredentialProvider as IntegrationProvider, } from './types';
 import { HttpClient, type HttpClientConfig } from './http/client';
 import { TasksAPI, RunOptions } from './api/tasks';
 import { SocketsAPI } from './api/sockets';
@@ -119,8 +116,6 @@ export declare class Inference {
     readonly projects: ProjectsAPI;
     readonly mcpServers: MCPServersAPI;
     readonly sockets: SocketsAPI;
-    /** @deprecated renamed `credentials` */
-    get integrations(): CredentialsAPI;
     constructor(config: InferenceConfig | HttpClientConfig);
     /** @internal */
     _request<T>(method: 'get' | 'post' | 'put' | 'delete', endpoint: string, options?: {

package/dist/index.js

@@ -23,14 +23,12 @@ export { TeamsAPI } from './api/teams';
 export { SecretsAPI } from './api/secrets';
 export { ApiKeysAPI } from './api/api-keys';
 export { CredentialsAPI } from './api/credentials';
-/** @deprecated renamed CredentialsAPI */
-export { CredentialsAPI as IntegrationsAPI } from './api/credentials';
 export { SearchAPI } from './api/search';
 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)
@@ -74,10 +72,6 @@ import { MCPServersAPI } from './api/mcp-servers';
  * ```
  */
 export class Inference {
-    /** @deprecated renamed `credentials` */
-    get integrations() {
-        return this.credentials;
-    }
     constructor(config) {
         // Handle both simple config and full HttpClientConfig
         this.http = new HttpClient({

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/tool-builder.d.ts

@@ -94,8 +94,6 @@ declare class HTTPToolBuilder extends ToolBuilder {
     auth(config: {
         credential?: string;
         credentialId?: string;
-        /** @deprecated renamed `credential` */ integration?: string;
-        /** @deprecated renamed `credentialId` */ integrationId?: string;
         apiKey?: string;
         bearer?: string;
         header?: string;

package/dist/tool-builder.js

@@ -189,9 +189,8 @@ class HTTPToolBuilder extends ToolBuilder {
      * send a vault secret.
      */
     auth(config) {
-        const provider = config.credential ?? config.integration;
-        if (provider) {
-            this.authConfig = { type: ToolAuthTypeCredential, provider, credential_id: config.credentialId ?? config.integrationId };
+        if (config.credential) {
+            this.authConfig = { type: ToolAuthTypeCredential, provider: config.credential, credential_id: config.credentialId };
         }
         else if (config.apiKey) {
             this.authConfig = { type: ToolAuthTypeAPIKey, secret: config.apiKey, header: config.header || 'X-API-Key' };

package/dist/types.d.ts

@@ -127,11 +127,6 @@ export interface ToolAuthConfig {
     type: ToolAuthType;
     provider?: string;
     credential_id?: string;
-    /**
-     * Deprecated: the credential id used to be called integration_id. Read
-     * through CredentialRef(); never written.
-     */
-    integration_id?: string;
     secret?: string;
     header?: string;
 }
@@ -147,11 +142,6 @@ export interface HTTPToolConfig {
 }
 export interface MCPToolConfig {
     credential_id?: string;
-    /**
-     * Deprecated: the credential id used to be called integration_id. Read
-     * through CredentialRef(); never written.
-     */
-    integration_id?: string;
     tool_name: string;
 }
 export interface AppToolConfigDTO {
@@ -855,7 +845,7 @@ export declare const ScopeSecretsRead: Scope;
 export declare const ScopeSecretsWrite: Scope;
 /**
  * Action-level scopes for credentials (connected accounts, vaults,
- * custom providers, MCP servers). Formerly integrations:read|write.
+ * custom providers, MCP servers).
  */
 export declare const ScopeCredentialsRead: Scope;
 /**
@@ -1093,13 +1083,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 +3198,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
@@ -4418,7 +4433,7 @@ export type SecretScope = string;
  */
 export declare const SecretScopeTeam: SecretScope;
 /**
- * SecretScopeInternal is an integration-managed secret, hidden from user lists
+ * SecretScopeInternal is a credential-managed secret, hidden from user lists
  */
 export declare const SecretScopeInternal: SecretScope;
 /**

package/dist/types.js

@@ -199,7 +199,7 @@ export const ScopeSecretsRead = "secrets:read";
 export const ScopeSecretsWrite = "secrets:write";
 /**
  * Action-level scopes for credentials (connected accounts, vaults,
- * custom providers, MCP servers). Formerly integrations:read|write.
+ * custom providers, MCP servers).
  */
 export const ScopeCredentialsRead = "credentials:read";
 /**
@@ -608,7 +608,7 @@ export const ResponseFormatTypeJSONSchema = "json_schema";
  */
 export const SecretScopeTeam = "team";
 /**
- * SecretScopeInternal is an integration-managed secret, hidden from user lists
+ * SecretScopeInternal is a credential-managed secret, hidden from user lists
  */
 export const SecretScopeInternal = "internal";
 /**

package/package.json

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