@inferencesh/sdk 0.4.26 → 0.5.1

package/dist/types.d.ts

@@ -6,6 +6,7 @@ export interface InternalToolsConfig {
     memory?: boolean;
     widget?: boolean;
     finish?: boolean;
+    skills?: boolean;
 }
 /**
  * ToolType represents the type of tool (used in both AgentTool definition and ToolInvocation)
@@ -34,6 +35,15 @@ export interface AppToolConfig {
      * Resolved app object (populated at runtime)
      */
     app?: App;
+    /**
+     * Function to call on multi-function apps (empty = app's default function)
+     */
+    function?: string;
+    /**
+     * SessionEnabled allows the agent to control sessions for this tool
+     * When true, agent can pass session parameter and sees session_id in output
+     */
+    session_enabled?: boolean;
     /**
      * Pre-configured values
      */
@@ -125,6 +135,14 @@ export interface AppToolConfigDTO {
     id?: string;
     version_id?: string;
     app?: AppDTO;
+    /**
+     * Function to call on multi-function apps
+     */
+    function?: string;
+    /**
+     * SessionEnabled allows the agent to control sessions for this tool
+     */
+    session_enabled?: boolean;
     /**
      * Pre-configured values
      */
@@ -174,9 +192,7 @@ export interface AgentImages {
     thumbnail: string;
     banner: string;
 }
-export interface Agent {
-    BaseModel: BaseModel;
-    PermissionModel: PermissionModel;
+export interface Agent extends BaseModel, PermissionModel {
     ProjectModel: ProjectModel;
     /**
      * Basic info
@@ -203,6 +219,16 @@ export interface AgentDTO extends BaseModel, PermissionModelDTO, ProjectModelDTO
     version_id: string;
     version?: AgentVersionDTO;
 }
+/**
+ * SkillConfig defines a skill available to the agent.
+ * Skills are loaded on-demand via the skill_get internal tool.
+ */
+export interface SkillConfig {
+    name: string;
+    description: string;
+    url?: string;
+    content?: string;
+}
 /**
  * AgentConfig contains the shared configuration fields for agent execution.
  * This is embedded by both AgentVersion (DB model) and API request structs.
@@ -221,7 +247,11 @@ export interface AgentConfig {
      */
     tools?: (AgentTool | undefined)[];
     /**
-     * Internal tools configuration (plan, memory, widget, finish)
+     * Skills available to this agent (loaded on-demand via skill_get tool)
+     */
+    skills?: SkillConfig[];
+    /**
+     * Internal tools configuration (plan, memory, widget, finish, skills)
      */
     internal_tools?: InternalToolsConfig;
     /**
@@ -229,14 +259,8 @@ export interface AgentConfig {
      */
     output_schema?: any;
 }
-export interface AgentVersion {
-    BaseModel: BaseModel;
-    PermissionModel: PermissionModel;
+export interface AgentVersion extends BaseModel, PermissionModel {
     agent_id: string;
-    /**
-     * Short ID for human-readable version references (e.g., "abc123")
-     */
-    short_id: string;
     /**
      * ConfigHash for deduplication - SHA256 of config content
      */
@@ -266,7 +290,11 @@ export interface AgentVersionDTO extends BaseModel, PermissionModelDTO {
      */
     tools: (AgentToolDTO | undefined)[];
     /**
-     * Internal tools configuration (plan, memory, widget, finish)
+     * Skills available to this agent (loaded on-demand via skill_get tool)
+     */
+    skills: SkillConfig[];
+    /**
+     * Internal tools configuration (plan, memory, widget, finish, skills)
      */
     internal_tools?: InternalToolsConfig;
     /**
@@ -315,6 +343,19 @@ export interface ApiAppRunRequest {
      * If true, returns SSE stream instead of JSON response
      */
     stream?: boolean;
+    /**
+     * Function to call on multi-function apps (defaults to "run" or app's default_function)
+     */
+    function?: string;
+    /**
+     * Session control: "new" to start a new session, "sess_xxx" to continue existing session
+     * When using sessions, the worker is leased and state persists across calls
+     */
+    session?: string;
+    /**
+     * Session timeout in seconds (1-3600). Only valid when session="new"
+     */
+    session_timeout?: number;
 }
 /**
  * ApiAgentRunRequest is the request body for /agents/run endpoint.
@@ -665,9 +706,7 @@ export interface AppImages {
     thumbnail: string;
     banner: string;
 }
-export interface App {
-    BaseModel: BaseModel;
-    PermissionModel: PermissionModel;
+export interface App extends BaseModel, PermissionModel {
     /**
      * Namespace is copied from team.username at creation time and is IMMUTABLE.
      * This ensures stable references like "namespace/name" even if team username changes.
@@ -722,13 +761,7 @@ export interface AppFunction {
     input_schema: any;
     output_schema: any;
 }
-export interface AppVersion {
-    BaseModel: BaseModel;
-    /**
-     * ShortID is a human-friendly version identifier (e.g., "abc123")
-     * Unique within the app, used in references like "namespace/app@abc123"
-     */
-    short_id: string;
+export interface AppVersion extends BaseModel {
     app_id: string;
     metadata: {
         [key: string]: any;
@@ -766,6 +799,11 @@ export interface AppVersion {
      */
     checksum?: string;
 }
+export interface LicenseRecord extends BaseModel {
+    user_id: string;
+    app_id: string;
+    license: string;
+}
 export interface AppDTO extends BaseModel, PermissionModelDTO {
     namespace: string;
     name: string;
@@ -777,7 +815,6 @@ export interface AppDTO extends BaseModel, PermissionModelDTO {
     version?: AppVersionDTO;
 }
 export interface AppVersionDTO extends BaseModel {
-    short_id: string;
     metadata: {
         [key: string]: any;
     };
@@ -809,8 +846,45 @@ export interface AppVersionDTO extends BaseModel {
      */
     checksum?: string;
 }
+export type AppSessionStatus = string;
+export declare const AppSessionStatusActive: AppSessionStatus;
+export declare const AppSessionStatusEnded: AppSessionStatus;
+export declare const AppSessionStatusExpired: AppSessionStatus;
+export interface AppSession extends BaseModel, PermissionModel {
+    /**
+     * Affinity binding
+     */
+    worker_id: string;
+    app_id: string;
+    app_version_id: string;
+    /**
+     * Lifecycle
+     */
+    status: AppSessionStatus;
+    expires_at: string;
+    ended_at?: string;
+    /**
+     * Billing link
+     */
+    task_id?: string;
+    /**
+     * Stats
+     */
+    call_count: number;
+    last_call_at?: string;
+    /**
+     * Custom idle timeout in seconds (nil = use default)
+     */
+    idle_timeout?: number;
+    /**
+     * Relations
+     */
+    worker?: WorkerState;
+    task?: Task;
+}
 export interface BaseModel {
     id: string;
+    short_id: string;
     created_at: string;
     updated_at: string;
     deleted_at?: string;
@@ -1071,6 +1145,17 @@ export declare const EngineStatusRunning: EngineStatus;
 export declare const EngineStatusPending: EngineStatus;
 export declare const EngineStatusStopping: EngineStatus;
 export declare const EngineStatusStopped: EngineStatus;
+export interface EngineState extends BaseModel, PermissionModel {
+    instance?: Instance;
+    transaction_id: string;
+    config: EngineConfig;
+    public_key: string;
+    name: string;
+    api_url: string;
+    status: EngineStatus;
+    system_info?: SystemInfo;
+    workers: (WorkerState | undefined)[];
+}
 export interface EngineStateDTO extends BaseModel, PermissionModelDTO {
     instance?: Instance;
     config: EngineConfig;
@@ -1090,6 +1175,30 @@ export interface EngineStateSummary extends BaseModel, PermissionModelDTO {
  * Worker-related types
  */
 export type WorkerStatus = string;
+export interface WorkerState extends BaseModel, PermissionModel {
+    index: number;
+    status: WorkerStatus;
+    status_updated_at?: string;
+    engine_id: string;
+    engine?: EngineState;
+    task_id?: string;
+    app_id: string;
+    app_version_id: string;
+    /**
+     * App session lease
+     */
+    active_session_id?: string;
+    active_session?: AppSession;
+    gpus: WorkerGPU[];
+    cpus: WorkerCPU[];
+    rams: WorkerRAM[];
+    /**
+     * WarmApps tracks app+version combos with warm containers for scheduling optimization.
+     * Format: "appID:versionID@setupHash" - managed by Engine, synced via heartbeat.
+     * Not persisted to DB - this is ephemeral runtime state.
+     */
+    warm_apps?: string[];
+}
 export interface WorkerGPU {
     id: string;
     worker_id: string;
@@ -1122,10 +1231,12 @@ export interface WorkerStateDTO extends BaseModel {
     task_id?: string;
     app_id: string;
     app_version_id: string;
+    active_session_id?: string;
     gpus: WorkerGPU[];
     cpus: WorkerCPU[];
     rams: WorkerRAM[];
     system_info: SystemInfo;
+    warm_apps?: string[];
 }
 export interface WorkerStateSummary {
     id: string;
@@ -1137,13 +1248,12 @@ export interface WorkerStateSummary {
     task_id?: string;
     app_id: string;
     app_version_id: string;
+    active_session_id?: string;
     gpus: WorkerGPU[];
     cpus: WorkerCPU[];
     rams: WorkerRAM[];
 }
-export interface File {
-    BaseModel: BaseModel;
-    PermissionModel: PermissionModel;
+export interface File extends BaseModel, PermissionModel {
     path: string;
     remote_path: string;
     upload_url: string;
@@ -1163,8 +1273,7 @@ export interface FileDTO extends BaseModel, PermissionModelDTO {
     filename: string;
     rating: ContentRating;
 }
-export interface FlowVersion {
-    BaseModel: BaseModel;
+export interface FlowVersion extends BaseModel {
     /**
      * Permission fields - nullable for migration from existing data
      * After migration these will be populated from parent Flow
@@ -1174,10 +1283,6 @@ export interface FlowVersion {
     team_id: string;
     team?: Team;
     flow_id: string;
-    /**
-     * Short ID for human-readable version references (e.g., "abc123")
-     */
-    short_id: string;
     /**
      * ConfigHash for deduplication - SHA256 of config content
      */
@@ -1274,7 +1379,6 @@ export interface FlowDTO extends BaseModel, PermissionModelDTO {
     viewport?: FlowViewport;
 }
 export interface FlowVersionDTO extends BaseModel {
-    short_id: string;
     input_schema: any;
     input: FlowRunInputs;
     output_schema: any;
@@ -1443,9 +1547,7 @@ export interface ProjectModelDTO {
 /**
  * Project represents a container for organizing related resources
  */
-export interface Project {
-    BaseModel: BaseModel;
-    PermissionModel: PermissionModel;
+export interface Project extends BaseModel, PermissionModel {
     name: string;
     description: string;
     type: ProjectType;
@@ -1526,6 +1628,14 @@ export interface SetupAction {
     provider?: string;
     scopes?: string[];
 }
+/**
+ * SecretRef tracks which Secret record provided a value for a task (for billing)
+ */
+export interface SecretRef {
+    key: string;
+    id: string;
+    team_id: string;
+}
 export type InstanceCloudProvider = string;
 export declare const CloudAWS: InstanceCloudProvider;
 export declare const CloudAzure: InstanceCloudProvider;
@@ -1544,9 +1654,7 @@ export type InstanceStatus = string;
 export declare const InstanceStatusPending: InstanceStatus;
 export declare const InstanceStatusActive: InstanceStatus;
 export declare const InstanceStatusDeleted: InstanceStatus;
-export interface Instance {
-    BaseModel: BaseModel;
-    PermissionModel: PermissionModel;
+export interface Instance extends BaseModel, PermissionModel {
     cloud: InstanceCloudProvider;
     name: string;
     region: string;
@@ -1762,6 +1870,71 @@ export type Infra = string;
 export declare const InfraPrivate: Infra;
 export declare const InfraCloud: Infra;
 export declare const InfraPrivateFirst: Infra;
+export interface Task extends BaseModel, PermissionModel {
+    is_featured: boolean;
+    status: TaskStatus;
+    /**
+     * Foreign keys
+     */
+    app_id: string;
+    app?: App;
+    version_id: string;
+    app_version?: AppVersion;
+    /**
+     * Deprecated: Will be removed in favor of Setup
+     */
+    variant: string;
+    /**
+     * Function is the specific function to call on multi-function apps.
+     * DEPRECATED: Standardizing on explicit function name.
+     * Defaults to "run" for legacy tasks (backfilled via migration).
+     */
+    function: string;
+    infra: Infra;
+    workers: string[];
+    engine_id?: string;
+    engine?: EngineState;
+    worker_id?: string;
+    worker?: WorkerState;
+    /**
+     * Belongs to:
+     */
+    flow_run_id?: string;
+    chat_id?: string;
+    /**
+     * Owns: (Can be replaced with graph execution edge/node)
+     */
+    sub_flow_run_id?: string;
+    webhook?: string;
+    setup?: any;
+    input: any;
+    output: any;
+    error: string;
+    rating: ContentRating;
+    /**
+     * Relationships
+     */
+    events: TaskEvent[];
+    logs: TaskLog[];
+    telemetry: TimescaleTask[];
+    usage_events: (UsageEvent | undefined)[];
+    transaction_id?: string;
+    transaction?: Transaction;
+    /**
+     * Secret refs for billing (tracks ownership to determine partner fee)
+     */
+    secrets?: SecretRef[];
+    /**
+     * App session reference (for session calls)
+     * Special value "new" means scheduler should create session when dispatching.
+     */
+    session_id?: string;
+    session?: AppSession;
+    /**
+     * Session timeout in seconds (only used when session="new")
+     */
+    session_timeout?: number;
+}
 export interface TaskEvent {
     id: string;
     created_at: string;
@@ -1819,6 +1992,8 @@ export interface TaskDTO extends BaseModel, PermissionModelDTO {
     usage_events: (UsageEvent | undefined)[];
     transaction_id?: string;
     transaction?: Transaction;
+    session_id?: string;
+    session_timeout?: number;
 }
 export interface TimescaleTask {
     id: string;
@@ -1836,8 +2011,7 @@ export type TeamType = string;
 export declare const TeamTypePersonal: TeamType;
 export declare const TeamTypeTeam: TeamType;
 export declare const TeamTypeSystem: TeamType;
-export interface Team {
-    BaseModel: BaseModel;
+export interface Team extends BaseModel {
     type: TeamType;
     username: string;
     email: string;
@@ -1944,8 +2118,7 @@ export declare const TransactionTypeDebit: TransactionType;
 /**
  * Transaction represents a single credit transaction
  */
-export interface Transaction {
-    BaseModel: BaseModel;
+export interface Transaction extends BaseModel {
     PermissionModel: PermissionModel;
     type: TransactionType;
     amount: number;
@@ -1975,9 +2148,7 @@ export declare const PaymentRecordTypeAutoRecharge: PaymentRecordType;
 /**
  * PaymentRecord stores Stripe payment details for both checkout sessions and direct charges
  */
-export interface PaymentRecord {
-    BaseModel: BaseModel;
-    PermissionModel: PermissionModel;
+export interface PaymentRecord extends BaseModel, PermissionModel {
     type: PaymentRecordType;
     status: PaymentRecordStatus;
     amount: number;
@@ -2055,9 +2226,7 @@ export interface OutputMeta {
     inputs: MetaItem[];
     outputs: MetaItem[];
 }
-export interface UsageEvent {
-    BaseModel: BaseModel;
-    PermissionModel: PermissionModel;
+export interface UsageEvent extends BaseModel, PermissionModel {
     usage_billing_record_id: string;
     reference_id: string;
     resource_id: string;
@@ -2070,9 +2239,7 @@ export interface UsageEvent {
     quantity: number;
     unit: string;
 }
-export interface UsageBillingRecord {
-    BaseModel: BaseModel;
-    PermissionModel: PermissionModel;
+export interface UsageBillingRecord extends BaseModel, PermissionModel {
     /**
      * Fee breakdown (all in microcents)
      */
@@ -2104,9 +2271,7 @@ export interface UsageBillingRecord {
     partner_credit_transaction_id: string;
     partner_credit_transaction?: Transaction;
 }
-export interface UsageBillingRefund {
-    BaseModel: BaseModel;
-    PermissionModel: PermissionModel;
+export interface UsageBillingRefund extends BaseModel, PermissionModel {
     usage_billing_record_id: string;
     usage_billing_record?: UsageBillingRecord;
     /**

package/dist/types.js

@@ -18,6 +18,9 @@ export const GPUTypeIntel = "intel";
 export const GPUTypeNvidia = "nvidia";
 export const GPUTypeAMD = "amd";
 export const GPUTypeApple = "apple";
+export const AppSessionStatusActive = "active";
+export const AppSessionStatusEnded = "ended";
+export const AppSessionStatusExpired = "expired";
 export const VisibilityPrivate = "private";
 export const VisibilityPublic = "public";
 export const VisibilityUnlisted = "unlisted";

package/package.json

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