@mastra/client-js 1.20.0-alpha.1 → 1.20.0-alpha.10

package/dist/types.d.ts

@@ -1,7 +1,8 @@
 import type { AgentExecutionOptions, MultiPrimitiveExecutionOptions, AgentGenerateOptions, AgentStreamOptions, SerializableStructuredOutputOptions, ToolsInput, UIMessageWithMetadata, AgentInstructions } from '@mastra/core/agent';
 import type { MessageListInput } from '@mastra/core/agent/message-list';
+import type { BuilderModelPolicy, DefaultModelEntry, ProviderModelEntry } from '@mastra/core/agent-builder/ee';
 import type { MastraScorerEntry, ScoreRowData } from '@mastra/core/evals';
-import type { CoreMessage } from '@mastra/core/llm';
+import type { CoreMessage, Provider as ModelProviderId } from '@mastra/core/llm';
 import type { LogLevel } from '@mastra/core/logger';
 import type { MCPToolType, ServerInfo } from '@mastra/core/mcp';
 import type { AiMessageType, MastraMessageV1, MastraDBMessage, MemoryConfig, StorageThreadType } from '@mastra/core/memory';
@@ -370,6 +371,19 @@ export interface GetAgentResponse {
     activeVersionId?: string;
     hasDraft?: boolean;
 }
+/**
+ * Response from the browser session probe endpoint.
+ *
+ * Use this to decide whether to open a screencast WebSocket for an agent/thread:
+ * - `screencastAvailable`: server has the `ws` / `@hono/node-ws` packages installed.
+ *   When false, opening a WS will fail and trigger a reconnect loop — skip it.
+ * - `hasSession`: the agent has an active browser session for this thread. When
+ *   false, the WS would just sit idle waiting for the agent to invoke a tool.
+ */
+export interface GetAgentBrowserSessionResponse {
+    hasSession: boolean;
+    screencastAvailable: boolean;
+}
 export type GenerateLegacyParams<T extends JSONSchema7 | ZodSchema | undefined = undefined> = {
     messages: string | string[] | CoreMessage[] | AiMessageType[] | UIMessageWithMetadata[];
     output?: T;
@@ -400,15 +414,23 @@ export type StreamParams<OUTPUT = undefined> = StreamParamsBase<OUTPUT> & {
 } : {
     structuredOutput: StructuredOutputOptions<OUTPUT>;
 });
+/**
+ * Provider id widened to accept admin-configured custom gateway providers.
+ * Closed unions over the five hard-coded providers are removed in favor of the
+ * generated `ModelProviderId` union plus a `(string & {})` escape hatch — this
+ * preserves IDE autocomplete on known providers while letting custom gateway
+ * ids flow through (see Phase 1 of the admin model configuration plan).
+ */
+export type AdminProviderId = ModelProviderId | (string & {});
 export type UpdateModelParams = {
     modelId: string;
-    provider: 'openai' | 'anthropic' | 'groq' | 'xai' | 'google';
+    provider: AdminProviderId;
 };
 export type UpdateModelInModelListParams = {
     modelConfigId: string;
     model?: {
         modelId: string;
-        provider: 'openai' | 'anthropic' | 'groq' | 'xai' | 'google';
+        provider: AdminProviderId;
     };
     maxRetries?: number;
     enabled?: boolean;
@@ -935,6 +957,26 @@ export type StoredWorkspaceRef = {
     type: 'inline';
     config: Record<string, unknown>;
 };
+export interface StoredBrowserConfig {
+    provider: string;
+    headless?: boolean;
+    viewport?: {
+        width: number;
+        height: number;
+    };
+    timeout?: number;
+    screencast?: {
+        format?: 'jpeg' | 'png';
+        quality?: number;
+        maxWidth?: number;
+        maxHeight?: number;
+        everyNthFrame?: number;
+    };
+}
+export type StoredBrowserRef = {
+    type: 'inline';
+    config: StoredBrowserConfig;
+};
 export type StoredAgentRule = Rule;
 export type StoredAgentRuleGroup = RuleGroup;
 export type ConditionalVariant<T> = StorageConditionalVariant<T>;
@@ -947,6 +989,7 @@ export interface StoredAgentResponse {
     status: string;
     activeVersionId?: string;
     authorId?: string;
+    visibility?: 'private' | 'public';
     metadata?: Record<string, unknown>;
     createdAt: string;
     updatedAt: string;
@@ -970,7 +1013,10 @@ export interface StoredAgentResponse {
     scorers?: ConditionalField<Record<string, StoredAgentScorerConfig>>;
     skills?: ConditionalField<Record<string, StoredAgentSkillConfig>>;
     workspace?: ConditionalField<StoredWorkspaceRef>;
+    browser?: ConditionalField<StoredBrowserRef> | boolean | null;
     requestContextSchema?: Record<string, unknown>;
+    isFavorited?: boolean;
+    favoriteCount?: number;
 }
 /**
  * Parameters for listing stored agents
@@ -982,8 +1028,26 @@ export interface ListStoredAgentsParams {
         field?: 'createdAt' | 'updatedAt';
         direction?: 'ASC' | 'DESC';
     };
+    status?: 'draft' | 'published' | 'archived';
     authorId?: string;
+    /**
+     * Restrict the list to public records. Only `'public'` is accepted by the
+     * server filter; private records are surfaced via the default scope-aware
+     * filter (caller's own rows + legacy unowned).
+     */
+    visibility?: 'public';
     metadata?: Record<string, unknown>;
+    /** When true, only return agents favorited by the caller (or by `pinFavoritedFor`). */
+    favoritedOnly?: boolean;
+    /** When set, sort favorited-first for this user id. Required for `favoritedOnly`. */
+    pinFavoritedFor?: string;
+}
+/**
+ * Response from favorite / unfavorite mutations.
+ */
+export interface FavoriteToggleResponse {
+    favorited: boolean;
+    favoriteCount: number;
 }
 /**
  * Response for listing stored agents
@@ -1007,6 +1071,8 @@ export interface CloneAgentParams {
     metadata?: Record<string, unknown>;
     /** Author identifier for the cloned agent. */
     authorId?: string;
+    /** Visibility of the cloned agent. Defaults to 'private'. */
+    visibility?: 'private' | 'public';
     /** Request context for resolving dynamic agent configuration (instructions, model, tools, etc.) */
     requestContext?: RequestContext | Record<string, any>;
 }
@@ -1018,6 +1084,8 @@ export interface CreateStoredAgentParams {
     /** Unique identifier for the agent. If not provided, derived from name via slugify. */
     id?: string;
     authorId?: string;
+    /** Visibility of the agent. Defaults to 'private'. */
+    visibility?: 'private' | 'public';
     metadata?: Record<string, unknown>;
     name: string;
     description?: string;
@@ -1039,6 +1107,8 @@ export interface CreateStoredAgentParams {
     scorers?: ConditionalField<Record<string, StoredAgentScorerConfig>>;
     skills?: ConditionalField<Record<string, StoredAgentSkillConfig>>;
     workspace?: ConditionalField<StoredWorkspaceRef>;
+    /** Browser config. `true` = use admin default, `false` = no browser. */
+    browser?: ConditionalField<StoredBrowserRef> | boolean | null;
     requestContextSchema?: Record<string, unknown>;
 }
 /**
@@ -1046,6 +1116,8 @@ export interface CreateStoredAgentParams {
  */
 export interface UpdateStoredAgentParams {
     authorId?: string;
+    /** Visibility of the agent. */
+    visibility?: 'private' | 'public';
     metadata?: Record<string, unknown>;
     name?: string;
     description?: string;
@@ -1067,6 +1139,8 @@ export interface UpdateStoredAgentParams {
     scorers?: ConditionalField<Record<string, StoredAgentScorerConfig>>;
     skills?: ConditionalField<Record<string, StoredAgentSkillConfig>>;
     workspace?: ConditionalField<StoredWorkspaceRef>;
+    /** Browser config. `true` = use admin default, `false` = no browser. */
+    browser?: ConditionalField<StoredBrowserRef> | boolean | null;
     requestContextSchema?: Record<string, unknown>;
     /** Optional message describing the changes for the auto-created version */
     changeMessage?: string;
@@ -1408,7 +1482,7 @@ export type ListAgentsModelProvidersResponse = GeneratedResponse<'GET /agents/pr
 export interface Provider {
     id: string;
     name: string;
-    envVar: string;
+    envVar: string | string[];
     connected: boolean;
     docUrl?: string;
     models: string[];
@@ -1610,6 +1684,7 @@ export interface StoredSkillResponse {
     id: string;
     status: string;
     authorId?: string;
+    visibility?: 'private' | 'public';
     metadata?: Record<string, unknown>;
     createdAt: string;
     updatedAt: string;
@@ -1618,6 +1693,8 @@ export interface StoredSkillResponse {
     instructions: string;
     license?: string;
     files?: StoredSkillFileNode[];
+    isFavorited?: boolean;
+    favoriteCount?: number;
 }
 /**
  * Parameters for listing stored skills
@@ -1630,7 +1707,17 @@ export interface ListStoredSkillsParams {
         direction?: 'ASC' | 'DESC';
     };
     authorId?: string;
+    /**
+     * Restrict the list to public records. Only `'public'` is accepted by the
+     * server filter; private records are surfaced via the default scope-aware
+     * filter (caller's own rows + legacy unowned).
+     */
+    visibility?: 'public';
     metadata?: Record<string, unknown>;
+    /** When true, only return skills favorited by the caller (or by `pinFavoritedFor`). */
+    favoritedOnly?: boolean;
+    /** When set, sort favorited-first for this user id. Required for `favoritedOnly`. */
+    pinFavoritedFor?: string;
 }
 /**
  * Response for listing stored skills
@@ -1648,6 +1735,8 @@ export interface ListStoredSkillsResponse {
 export interface CreateStoredSkillParams {
     id?: string;
     authorId?: string;
+    /** Visibility of the skill. Defaults to 'private'. */
+    visibility?: 'private' | 'public';
     metadata?: Record<string, unknown>;
     name: string;
     /** Required by the server: description of what the skill does and when to use it. */
@@ -1661,6 +1750,8 @@ export interface CreateStoredSkillParams {
  */
 export interface UpdateStoredSkillParams {
     authorId?: string;
+    /** Visibility of the skill. */
+    visibility?: 'private' | 'public';
     metadata?: Record<string, unknown>;
     name?: string;
     description?: string;
@@ -1675,6 +1766,74 @@ export interface DeleteStoredSkillResponse {
     success: boolean;
     message: string;
 }
+/**
+ * Filesystem configuration in a stored workspace
+ */
+export interface StoredFilesystemConfig {
+    provider: string;
+    config: Record<string, unknown>;
+    readOnly?: boolean;
+}
+/**
+ * Sandbox configuration in a stored workspace
+ */
+export interface StoredSandboxConfig {
+    provider: string;
+    config: Record<string, unknown>;
+}
+/**
+ * Stored workspace data returned from API
+ */
+export interface StoredWorkspaceResponse {
+    id: string;
+    status: string;
+    activeVersionId?: string;
+    authorId?: string;
+    metadata?: Record<string, unknown>;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    description?: string;
+    filesystem?: StoredFilesystemConfig;
+    sandbox?: StoredSandboxConfig;
+    mounts?: Record<string, StoredFilesystemConfig>;
+    skills?: string[];
+    tools?: {
+        enabled?: boolean;
+        requireApproval?: boolean;
+        tools?: Record<string, {
+            enabled?: boolean;
+            requireApproval?: boolean;
+        }>;
+    };
+    autoSync?: boolean;
+    operationTimeout?: number;
+    /** Whether this workspace is registered at runtime (only present in list responses) */
+    runtimeRegistered?: boolean;
+}
+/**
+ * Parameters for listing stored workspaces
+ */
+export interface ListStoredWorkspacesParams {
+    page?: number;
+    perPage?: number;
+    orderBy?: {
+        field?: 'createdAt' | 'updatedAt';
+        direction?: 'ASC' | 'DESC';
+    };
+    authorId?: string;
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Response for listing stored workspaces
+ */
+export interface ListStoredWorkspacesResponse {
+    workspaces: StoredWorkspaceResponse[];
+    total: number;
+    page: number;
+    perPage: number | false;
+    hasMore: boolean;
+}
 /**
  * Processor phase types
  */
@@ -2026,6 +2185,7 @@ export interface DatasetItemVersionResponse {
     datasetVersion: number;
     input: unknown;
     groundTruth?: unknown;
+    expectedTrajectory?: unknown;
     metadata?: Record<string, unknown>;
     validTo: number | null;
     isDeleted: boolean;
@@ -2244,5 +2404,193 @@ export interface ExperimentReviewCounts {
     reviewed: number;
     complete: number;
 }
-export {};
+/**
+ * Agent feature flags for the builder.
+ *
+ * The `GET /editor/builder/settings` response always carries a fully-resolved
+ * object. On admin input, omitted keys default to `true` (default-on / allowlist
+ * model — admins opt out by setting a key to `false`). Special case: `browser`
+ * is only `true` when `configuration.agent.browser` is provided.
+ *
+ * Clients should still use strict `=== true` checks.
+ */
+export interface BuilderAgentFeatures {
+    tools?: boolean;
+    agents?: boolean;
+    workflows?: boolean;
+    scorers?: boolean;
+    skills?: boolean;
+    memory?: boolean;
+    variables?: boolean;
+    favorites?: boolean;
+    avatarUpload?: boolean;
+    browser?: boolean;
+    /**
+     * Whether the model picker is visible in the Agent Builder.
+     * Omitted/`false` ⇒ picker hidden (locked mode); admin's `models.default` is applied.
+     */
+    model?: boolean;
+}
+/**
+ * Re-exported from `@mastra/core/agent-builder/ee` so SDK consumers don't need
+ * a second import for admin model configuration types. Owned by core.
+ */
+export type { BuilderModelPolicy, DefaultModelEntry, ProviderModelEntry, ModelProviderId };
+/**
+ * Response from GET /editor/builder/settings
+ */
+export interface BuilderSettingsResponse {
+    enabled: boolean;
+    features?: {
+        agent?: BuilderAgentFeatures;
+    };
+    configuration?: {
+        agent?: Record<string, unknown>;
+    };
+    /**
+     * Server-derived model policy. Always present; `{ active: false }` when no
+     * builder is configured. UI consumers should read this directly rather than
+     * re-deriving from `features` / `configuration`.
+     */
+    modelPolicy?: BuilderModelPolicy;
+    /**
+     * Resolved picker visibility for tools, agents, and workflows. Present when
+     * the builder is enabled. Each `visible*` field is `null` when unrestricted
+     * (show all registered entries) and `string[]` otherwise — making the
+     * empty-vs-unrestricted distinction explicit so the UI never has to
+     * disambiguate.
+     */
+    picker?: BuilderPickerResponse;
+    /**
+     * Non-fatal warnings produced by builder config validation (e.g. allowlist
+     * entries with unknown providers that aren't tagged `kind: 'custom'`, or
+     * picker allowlist entries that don't match a registered ID).
+     * Only present when there is at least one warning.
+     */
+    modelPolicyWarnings?: string[];
+}
+/**
+ * Resolved picker visibility section returned in {@link BuilderSettingsResponse}.
+ *
+ * Per kind:
+ * - `null` ⇒ unrestricted (show all registered entries).
+ * - `string[]` ⇒ explicit allowlist (may be empty to show none).
+ */
+export interface BuilderPickerResponse {
+    visibleTools: string[] | null;
+    visibleAgents: string[] | null;
+    visibleWorkflows: string[] | null;
+}
+/**
+ * Response from GET /editor/builder/infrastructure
+ *
+ * Agent Builder infrastructure configuration plus lightweight runtime resolution state.
+ */
+export interface InfrastructureStatusResponse {
+    channels: {
+        providers: Array<{
+            id: string;
+            name: string;
+            isConfigured: boolean;
+            routeCount: number;
+        }>;
+    };
+    browser: {
+        type: string | null;
+        provider: string | null;
+        env: string | null;
+        registered: boolean;
+        availableProviders: string[];
+        config: Array<{
+            key: string;
+            value: string;
+        }>;
+    };
+    workspace: {
+        type: string | null;
+        workspaceId: string | null;
+        name: string | null;
+        source: string | null;
+        registered: boolean;
+        hasFilesystem: boolean;
+        hasSandbox: boolean;
+        filesystemProvider: string | null;
+        sandboxProvider: string | null;
+        config: Array<{
+            key: string;
+            value: string;
+        }>;
+    };
+    registries: {
+        skillsSh: {
+            enabled: boolean;
+        };
+    };
+}
+/**
+ * One known skill registry surfaced from the Agent Builder config.
+ */
+export interface BuilderRegistryDescriptor {
+    id: string;
+    enabled: boolean;
+    label: string;
+}
+/**
+ * Response from `GET /editor/builder/registries`.
+ */
+export interface ListBuilderRegistriesResponse {
+    registries: BuilderRegistryDescriptor[];
+}
+/**
+ * Single skill summary returned from a registry search/popular endpoint.
+ * Wire shape matches the upstream skills.sh proxy.
+ */
+export interface BuilderRegistrySkillSummary {
+    id: string;
+    name: string;
+    installs: number;
+    /** Repository identifier in `owner/repo` or `owner/repo/path` form. */
+    topSource: string;
+}
+/**
+ * Response from `GET /editor/builder/registries/:registryId/search`.
+ */
+export interface BuilderRegistrySearchResponse {
+    query: string;
+    searchType: string;
+    skills: BuilderRegistrySkillSummary[];
+    count: number;
+}
+/**
+ * Response from `GET /editor/builder/registries/:registryId/popular`.
+ */
+export interface BuilderRegistryPopularResponse {
+    skills: BuilderRegistrySkillSummary[];
+    count: number;
+    limit: number;
+    offset: number;
+}
+/**
+ * Response from `GET /editor/builder/registries/:registryId/preview`.
+ */
+export interface BuilderRegistryPreviewResponse {
+    content: string;
+}
+/**
+ * Body for `POST /editor/builder/registries/:registryId/install`.
+ */
+export interface BuilderRegistryInstallBody {
+    owner: string;
+    repo: string;
+    skillName: string;
+    visibility?: 'private' | 'public';
+}
+/**
+ * Response from `POST /editor/builder/registries/:registryId/install`.
+ */
+export interface BuilderRegistryInstallResponse {
+    storedSkillId: string;
+    name: string;
+    filesWritten: number;
+}
 //# sourceMappingURL=types.d.ts.map