@inferencesh/sdk 0.10.1 → 0.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/agent/actions.js +23 -7
- package/dist/agent/index.d.ts +1 -0
- package/dist/agent/index.js +2 -0
- package/dist/agent/mcp-input.d.ts +57 -0
- package/dist/agent/mcp-input.js +58 -0
- package/dist/agent/reducer.js +4 -3
- package/dist/agent/types.d.ts +3 -1
- package/dist/api/agents.js +17 -22
- package/dist/index.d.ts +3 -2
- package/dist/index.js +3 -2
- package/dist/live/protocol.d.ts +19 -0
- package/dist/live/protocol.js +21 -0
- package/dist/live/schema.d.ts +0 -8
- package/dist/live/schema.js +1 -10
- package/dist/live/session.js +2 -5
- package/dist/types.d.ts +266 -101
- package/dist/types.js +95 -7
- package/dist/utils.d.ts +12 -1
- package/dist/utils.js +30 -2
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -103,7 +103,7 @@ export interface ClientToolConfig {
|
|
|
103
103
|
/**
|
|
104
104
|
* ToolAuthType says how an HTTP tool authenticates.
|
|
105
105
|
*/
|
|
106
|
-
export type ToolAuthType =
|
|
106
|
+
export type ToolAuthType = "none" | "credential" | "api_key" | "bearer";
|
|
107
107
|
/**
|
|
108
108
|
* ToolAuthTypeNone sends no credentials (same as leaving type empty).
|
|
109
109
|
*/
|
|
@@ -316,7 +316,7 @@ export interface APIResponse<T extends any> {
|
|
|
316
316
|
error?: APIError;
|
|
317
317
|
}
|
|
318
318
|
export interface APIError {
|
|
319
|
-
code:
|
|
319
|
+
code: ErrorCode;
|
|
320
320
|
message: string;
|
|
321
321
|
suggestions?: string[];
|
|
322
322
|
meta?: {
|
|
@@ -369,6 +369,10 @@ export interface ApiAgentRunRequest {
|
|
|
369
369
|
[key: string]: string;
|
|
370
370
|
};
|
|
371
371
|
stream?: boolean;
|
|
372
|
+
/**
|
|
373
|
+
* ChannelContext is recorded on the chat the first time it is seen.
|
|
374
|
+
*/
|
|
375
|
+
channel_context?: ChannelContext;
|
|
372
376
|
}
|
|
373
377
|
/**
|
|
374
378
|
* CreateAgentMessageRequest is the request for creating agent messages.
|
|
@@ -675,7 +679,7 @@ export interface EstimateCostResponse {
|
|
|
675
679
|
/**
|
|
676
680
|
* Scope represents an API key permission scope string.
|
|
677
681
|
*/
|
|
678
|
-
export type Scope =
|
|
682
|
+
export type Scope = "*" | "agents" | "apps" | "conversations" | "files" | "datastores" | "templates" | "flows" | "projects" | "teams" | "billing" | "artifacts" | "agents:read" | "agents:write" | "agents:execute" | "apps:read" | "apps:write" | "apps:execute" | "conversations:read" | "conversations:write" | "files:read" | "files:write" | "datastores:read" | "datastores:write" | "flows:read" | "flows:write" | "flows:execute" | "projects:read" | "projects:write" | "teams:read" | "teams:write" | "billing:read" | "billing:write" | "secrets:read" | "secrets:write" | "credentials:read" | "credentials:write" | "engines:read" | "engines:write" | "remotes:read" | "remotes:write" | "apikeys:read" | "apikeys:write" | "knowledge:read" | "knowledge:write" | "artifacts:read" | "artifacts:write" | "user:read" | "user:write" | "settings:read" | "settings:write";
|
|
679
683
|
/**
|
|
680
684
|
* API Key Scopes - hierarchical permission system.
|
|
681
685
|
* Resource-level scopes (e.g., "agents") imply all action-level scopes (e.g., "agents:read").
|
|
@@ -740,6 +744,12 @@ export declare const ScopeTeams: Scope;
|
|
|
740
744
|
* Empty scopes = full access (for backwards compatibility with existing keys).
|
|
741
745
|
*/
|
|
742
746
|
export declare const ScopeBilling: Scope;
|
|
747
|
+
/**
|
|
748
|
+
* API Key Scopes - hierarchical permission system.
|
|
749
|
+
* Resource-level scopes (e.g., "agents") imply all action-level scopes (e.g., "agents:read").
|
|
750
|
+
* Empty scopes = full access (for backwards compatibility with existing keys).
|
|
751
|
+
*/
|
|
752
|
+
export declare const ScopeArtifacts: Scope;
|
|
743
753
|
/**
|
|
744
754
|
* Action-level scopes for Agents
|
|
745
755
|
*/
|
|
@@ -879,6 +889,16 @@ export declare const ScopeEnginesRead: Scope;
|
|
|
879
889
|
* Empty scopes = full access (for backwards compatibility with existing keys).
|
|
880
890
|
*/
|
|
881
891
|
export declare const ScopeEnginesWrite: Scope;
|
|
892
|
+
/**
|
|
893
|
+
* Action-level scopes for Remotes
|
|
894
|
+
*/
|
|
895
|
+
export declare const ScopeRemotesRead: Scope;
|
|
896
|
+
/**
|
|
897
|
+
* API Key Scopes - hierarchical permission system.
|
|
898
|
+
* Resource-level scopes (e.g., "agents") imply all action-level scopes (e.g., "agents:read").
|
|
899
|
+
* Empty scopes = full access (for backwards compatibility with existing keys).
|
|
900
|
+
*/
|
|
901
|
+
export declare const ScopeRemotesWrite: Scope;
|
|
882
902
|
/**
|
|
883
903
|
* Action-level scopes for API Keys
|
|
884
904
|
*/
|
|
@@ -902,12 +922,6 @@ export declare const ScopeKnowledgeWrite: Scope;
|
|
|
902
922
|
/**
|
|
903
923
|
* Action-level scopes for Artifacts (published HTML/Markdown pages)
|
|
904
924
|
*/
|
|
905
|
-
export declare const ScopeArtifacts: Scope;
|
|
906
|
-
/**
|
|
907
|
-
* API Key Scopes - hierarchical permission system.
|
|
908
|
-
* Resource-level scopes (e.g., "agents") imply all action-level scopes (e.g., "agents:read").
|
|
909
|
-
* Empty scopes = full access (for backwards compatibility with existing keys).
|
|
910
|
-
*/
|
|
911
925
|
export declare const ScopeArtifactsRead: Scope;
|
|
912
926
|
/**
|
|
913
927
|
* API Key Scopes - hierarchical permission system.
|
|
@@ -938,7 +952,7 @@ export declare const ScopeSettingsWrite: Scope;
|
|
|
938
952
|
/**
|
|
939
953
|
* ScopeGroup identifies a category of scopes for UI grouping
|
|
940
954
|
*/
|
|
941
|
-
export type ScopeGroup =
|
|
955
|
+
export type ScopeGroup = "agents" | "apps" | "conversations" | "files" | "datastores" | "flows" | "projects" | "teams" | "billing" | "secrets" | "credentials" | "engines" | "remotes" | "apikeys" | "knowledge" | "artifacts" | "user" | "settings";
|
|
942
956
|
export declare const ScopeGroupAgents: ScopeGroup;
|
|
943
957
|
export declare const ScopeGroupApps: ScopeGroup;
|
|
944
958
|
export declare const ScopeGroupConversations: ScopeGroup;
|
|
@@ -951,6 +965,7 @@ export declare const ScopeGroupBilling: ScopeGroup;
|
|
|
951
965
|
export declare const ScopeGroupSecrets: ScopeGroup;
|
|
952
966
|
export declare const ScopeGroupCredentials: ScopeGroup;
|
|
953
967
|
export declare const ScopeGroupEngines: ScopeGroup;
|
|
968
|
+
export declare const ScopeGroupRemotes: ScopeGroup;
|
|
954
969
|
export declare const ScopeGroupApiKeys: ScopeGroup;
|
|
955
970
|
export declare const ScopeGroupKnowledge: ScopeGroup;
|
|
956
971
|
export declare const ScopeGroupArtifacts: ScopeGroup;
|
|
@@ -2019,6 +2034,80 @@ export interface EntitlementErrorMeta {
|
|
|
2019
2034
|
addon_plan_name?: string;
|
|
2020
2035
|
addon_plan_price?: number;
|
|
2021
2036
|
}
|
|
2037
|
+
/**
|
|
2038
|
+
* ErrorCode is the machine-readable error code of an API error: the last
|
|
2039
|
+
* segment of the problem+json type URI (https://api.inference.sh/errors/<code>)
|
|
2040
|
+
* and APIError.Code on the legacy envelope. Clients branch on these, so a
|
|
2041
|
+
* code is a named const here, where it generates into models and the SDKs.
|
|
2042
|
+
*/
|
|
2043
|
+
export type ErrorCode = "invalid_request" | "validation_error" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "name_conflict" | "already_exists" | "not_configured" | "method_not_allowed" | "rate_limited" | "internal_error" | "team_role_required" | "blocked_by_usage_policy" | "otp_required" | "mcp_auth_expired" | "limit_exceeded" | "feature_not_available" | "entitlement_unavailable" | "payment_required" | "payment_method_required" | "agents_disabled" | "remote_offline" | "remote_timeout" | "harness_not_drivable" | "harness_too_old";
|
|
2044
|
+
export declare const ErrorCodeInvalidRequest: ErrorCode;
|
|
2045
|
+
export declare const ErrorCodeValidationError: ErrorCode;
|
|
2046
|
+
export declare const ErrorCodeUnauthorized: ErrorCode;
|
|
2047
|
+
export declare const ErrorCodeForbidden: ErrorCode;
|
|
2048
|
+
export declare const ErrorCodeNotFound: ErrorCode;
|
|
2049
|
+
export declare const ErrorCodeConflict: ErrorCode;
|
|
2050
|
+
export declare const ErrorCodeNameConflict: ErrorCode;
|
|
2051
|
+
export declare const ErrorCodeAlreadyExists: ErrorCode;
|
|
2052
|
+
export declare const ErrorCodeNotConfigured: ErrorCode;
|
|
2053
|
+
export declare const ErrorCodeMethodNotAllowed: ErrorCode;
|
|
2054
|
+
export declare const ErrorCodeRateLimited: ErrorCode;
|
|
2055
|
+
export declare const ErrorCodeInternalError: ErrorCode;
|
|
2056
|
+
/**
|
|
2057
|
+
* ErrorCodeTeamRoleRequired: the caller's team role or org-admin status
|
|
2058
|
+
* does not allow the action. Meta is TeamRoleRequiredMeta when a
|
|
2059
|
+
* capability gate refused it.
|
|
2060
|
+
*/
|
|
2061
|
+
export declare const ErrorCodeTeamRoleRequired: ErrorCode;
|
|
2062
|
+
/**
|
|
2063
|
+
* ErrorCodeBlockedByUsagePolicy: the resource is outside the team or org
|
|
2064
|
+
* usage policy. The message names who to ask.
|
|
2065
|
+
*/
|
|
2066
|
+
export declare const ErrorCodeBlockedByUsagePolicy: ErrorCode;
|
|
2067
|
+
export declare const ErrorCodeOTPRequired: ErrorCode;
|
|
2068
|
+
export declare const ErrorCodeMCPAuthExpired: ErrorCode;
|
|
2069
|
+
/**
|
|
2070
|
+
* Entitlements. LimitExceeded (402) and FeatureNotAvailable (403) carry
|
|
2071
|
+
* EntitlementErrorMeta. EntitlementUnavailable (500) means the plan could
|
|
2072
|
+
* not be checked and the request is retriable.
|
|
2073
|
+
*/
|
|
2074
|
+
export declare const ErrorCodeLimitExceeded: ErrorCode;
|
|
2075
|
+
export declare const ErrorCodeFeatureNotAvailable: ErrorCode;
|
|
2076
|
+
export declare const ErrorCodeEntitlementUnavailable: ErrorCode;
|
|
2077
|
+
export declare const ErrorCodePaymentRequired: ErrorCode;
|
|
2078
|
+
/**
|
|
2079
|
+
* ErrorCodePaymentMethodRequired (402): a bounty program requires a saved
|
|
2080
|
+
* payment method and the caller's team has none. Meta is
|
|
2081
|
+
* PaymentMethodRequiredMeta; clients send the user to BillingPage.
|
|
2082
|
+
*/
|
|
2083
|
+
export declare const ErrorCodePaymentMethodRequired: ErrorCode;
|
|
2084
|
+
/**
|
|
2085
|
+
* Remote harness refusals.
|
|
2086
|
+
*/
|
|
2087
|
+
export declare const ErrorCodeAgentsDisabled: ErrorCode;
|
|
2088
|
+
export declare const ErrorCodeRemoteOffline: ErrorCode;
|
|
2089
|
+
export declare const ErrorCodeRemoteTimeout: ErrorCode;
|
|
2090
|
+
export declare const ErrorCodeHarnessNotDrivable: ErrorCode;
|
|
2091
|
+
export declare const ErrorCodeHarnessTooOld: ErrorCode;
|
|
2092
|
+
/**
|
|
2093
|
+
* TeamRoleRequiredMeta is the meta of a team_role_required error from a
|
|
2094
|
+
* capability gate. Only Capability is always set: a team that does not
|
|
2095
|
+
* resolve answers with the capability alone, so clients must not assume
|
|
2096
|
+
* RequiredRole is present.
|
|
2097
|
+
*/
|
|
2098
|
+
export interface TeamRoleRequiredMeta {
|
|
2099
|
+
capability: TeamCapability;
|
|
2100
|
+
actual_role?: TeamRole;
|
|
2101
|
+
required_role?: TeamRole;
|
|
2102
|
+
requires_org_admin?: boolean;
|
|
2103
|
+
}
|
|
2104
|
+
/**
|
|
2105
|
+
* PaymentMethodRequiredMeta is the meta of a payment_method_required error.
|
|
2106
|
+
*/
|
|
2107
|
+
export interface PaymentMethodRequiredMeta {
|
|
2108
|
+
bounty_id: string;
|
|
2109
|
+
billing_page: string;
|
|
2110
|
+
}
|
|
2022
2111
|
/**
|
|
2023
2112
|
* FileMetadata holds probed media metadata cached on File records.
|
|
2024
2113
|
*/
|
|
@@ -2152,7 +2241,7 @@ export interface FlowRunDTO extends BaseModelDTO, PermissionModelDTO {
|
|
|
2152
2241
|
/**
|
|
2153
2242
|
* FlowActionType is the string type for action constants.
|
|
2154
2243
|
*/
|
|
2155
|
-
export type FlowActionType =
|
|
2244
|
+
export type FlowActionType = "node.add" | "node.remove" | "node.move" | "node.move_many" | "node.duplicate" | "node.rename" | "node.set_app" | "node.update" | "node.set_input" | "node.clear_input" | "edge.add" | "edge.remove" | "flow.set_input_schema" | "flow.set_output_schema" | "flow.set_output_mapping" | "flow.remove_output_mapping" | "flow.rename_output_field" | "undo" | "redo";
|
|
2156
2245
|
/**
|
|
2157
2246
|
* Flow graph action type constants.
|
|
2158
2247
|
*/
|
|
@@ -2603,9 +2692,14 @@ export interface ElicitationCapability {
|
|
|
2603
2692
|
}
|
|
2604
2693
|
/**
|
|
2605
2694
|
* ClientCapabilities advertises what a client can do.
|
|
2695
|
+
* Extensions carries the extensions the client supports, keyed by identifier
|
|
2696
|
+
* (e.g. ExtensionTasks), each with its extension-defined settings object.
|
|
2606
2697
|
*/
|
|
2607
2698
|
export interface ClientCapabilities {
|
|
2608
2699
|
elicitation?: ElicitationCapability;
|
|
2700
|
+
extensions?: {
|
|
2701
|
+
[key: string]: any;
|
|
2702
|
+
};
|
|
2609
2703
|
}
|
|
2610
2704
|
/**
|
|
2611
2705
|
* InputRequest is a single server-to-client request inside an InputRequiredResult.
|
|
@@ -2617,7 +2711,7 @@ export interface InputRequest {
|
|
|
2617
2711
|
/**
|
|
2618
2712
|
* ElicitAction is the user's response to an elicitation request.
|
|
2619
2713
|
*/
|
|
2620
|
-
export type ElicitAction =
|
|
2714
|
+
export type ElicitAction = "accept" | "decline" | "cancel";
|
|
2621
2715
|
export declare const ElicitActionAccept: ElicitAction;
|
|
2622
2716
|
export declare const ElicitActionDecline: ElicitAction;
|
|
2623
2717
|
export declare const ElicitActionCancel: ElicitAction;
|
|
@@ -2634,7 +2728,7 @@ export interface ElicitResult {
|
|
|
2634
2728
|
* ResultType is the kind of result a response carries, required on every result
|
|
2635
2729
|
* from 2026-07-28 onward.
|
|
2636
2730
|
*/
|
|
2637
|
-
export type ResultType =
|
|
2731
|
+
export type ResultType = "complete" | "input_required" | "task";
|
|
2638
2732
|
/**
|
|
2639
2733
|
* ResultTypeComplete marks an ordinary, finished result.
|
|
2640
2734
|
*/
|
|
@@ -2644,11 +2738,16 @@ export declare const ResultTypeComplete: ResultType;
|
|
|
2644
2738
|
* Recognised so the outbound client never mistakes one for tool output.
|
|
2645
2739
|
*/
|
|
2646
2740
|
export declare const ResultTypeInputRequired: ResultType;
|
|
2741
|
+
/**
|
|
2742
|
+
* ResultTypeTask marks a CreateTaskResult: the server accepted the request
|
|
2743
|
+
* as a task under the tasks extension and the result arrives via tasks/get.
|
|
2744
|
+
*/
|
|
2745
|
+
export declare const ResultTypeTask: ResultType;
|
|
2647
2746
|
/**
|
|
2648
2747
|
* CacheScope says who may reuse a cached result, per MCP 2026-07-28 (SEP-2549).
|
|
2649
2748
|
* Analogous to HTTP Cache-Control public/private; the spec defines exactly these.
|
|
2650
2749
|
*/
|
|
2651
|
-
export type CacheScope =
|
|
2750
|
+
export type CacheScope = "public" | "private";
|
|
2652
2751
|
/**
|
|
2653
2752
|
* CacheScopePublic marks a response as free of user-specific data, so any
|
|
2654
2753
|
* client or shared intermediary may cache it across authorization contexts.
|
|
@@ -2733,7 +2832,7 @@ export interface ToolCallResponse {
|
|
|
2733
2832
|
/**
|
|
2734
2833
|
* ToolContentType is the kind of a content block. The spec defines exactly these.
|
|
2735
2834
|
*/
|
|
2736
|
-
export type ToolContentType =
|
|
2835
|
+
export type ToolContentType = "text" | "image" | "audio" | "resource_link" | "resource";
|
|
2737
2836
|
export declare const ToolContentTypeText: ToolContentType;
|
|
2738
2837
|
export declare const ToolContentTypeImage: ToolContentType;
|
|
2739
2838
|
export declare const ToolContentTypeAudio: ToolContentType;
|
|
@@ -2777,6 +2876,11 @@ export interface MCPServerDTO {
|
|
|
2777
2876
|
default_scopes: StringSlice;
|
|
2778
2877
|
documentation_url: string;
|
|
2779
2878
|
connection_status?: string;
|
|
2879
|
+
/**
|
|
2880
|
+
* ConnectionScope is who the caller's connection to this server belongs
|
|
2881
|
+
* to (user, team, org, platform); empty when not connected.
|
|
2882
|
+
*/
|
|
2883
|
+
connection_scope?: CredentialScope;
|
|
2780
2884
|
}
|
|
2781
2885
|
/**
|
|
2782
2886
|
* NotificationDTO is the data transfer object
|
|
@@ -2967,7 +3071,7 @@ export interface PlanLimit {
|
|
|
2967
3071
|
* PlanLimits maps entitlement resources to their limits
|
|
2968
3072
|
*/
|
|
2969
3073
|
export type PlanLimits = {
|
|
2970
|
-
[key
|
|
3074
|
+
[key in EntitlementResource]?: PlanLimit;
|
|
2971
3075
|
};
|
|
2972
3076
|
/**
|
|
2973
3077
|
* PlanDTO for API responses
|
|
@@ -3188,7 +3292,7 @@ export interface SuggestResult {
|
|
|
3188
3292
|
/**
|
|
3189
3293
|
* RequirementType identifies the kind of missing requirement.
|
|
3190
3294
|
*/
|
|
3191
|
-
export type RequirementType =
|
|
3295
|
+
export type RequirementType = "secret" | "credential" | "scope";
|
|
3192
3296
|
/**
|
|
3193
3297
|
* Requirement error types
|
|
3194
3298
|
*/
|
|
@@ -3213,7 +3317,7 @@ export interface RequirementError {
|
|
|
3213
3317
|
/**
|
|
3214
3318
|
* SetupActionType identifies the kind of action needed to resolve a requirement.
|
|
3215
3319
|
*/
|
|
3216
|
-
export type SetupActionType =
|
|
3320
|
+
export type SetupActionType = "add_secret" | "connect" | "add_scopes";
|
|
3217
3321
|
export declare const SetupActionAddSecret: SetupActionType;
|
|
3218
3322
|
export declare const SetupActionConnect: SetupActionType;
|
|
3219
3323
|
export declare const SetupActionAddScopes: SetupActionType;
|
|
@@ -3793,7 +3897,7 @@ export interface UserMetadataDTO {
|
|
|
3793
3897
|
* Alias of shared.A2UISurface so the type generation pipeline picks it up.
|
|
3794
3898
|
*/
|
|
3795
3899
|
export type Widget = A2UISurface;
|
|
3796
|
-
export type A2UIComponentType =
|
|
3900
|
+
export type A2UIComponentType = "Row" | "Column" | "List" | "Text" | "Image" | "Icon" | "Divider" | "Button" | "TextField" | "CheckBox" | "Slider" | "DateTimeInput" | "ChoicePicker" | "Card" | "Modal" | "Tabs" | "Badge" | "Spacer" | "Chart" | "Form" | "Artifact";
|
|
3797
3901
|
export declare const A2UIRow: A2UIComponentType;
|
|
3798
3902
|
export declare const A2UIColumn: A2UIComponentType;
|
|
3799
3903
|
export declare const A2UIList: A2UIComponentType;
|
|
@@ -3966,7 +4070,7 @@ export interface A2UISurface {
|
|
|
3966
4070
|
components: A2UIComponent[];
|
|
3967
4071
|
dataModel?: any;
|
|
3968
4072
|
}
|
|
3969
|
-
export type AppCategory =
|
|
4073
|
+
export type AppCategory = "image" | "video" | "audio" | "text" | "chat" | "3d" | "other" | "flow";
|
|
3970
4074
|
export declare const AppCategoryImage: AppCategory;
|
|
3971
4075
|
export declare const AppCategoryVideo: AppCategory;
|
|
3972
4076
|
export declare const AppCategoryAudio: AppCategory;
|
|
@@ -3975,12 +4079,12 @@ export declare const AppCategoryChat: AppCategory;
|
|
|
3975
4079
|
export declare const AppCategory3D: AppCategory;
|
|
3976
4080
|
export declare const AppCategoryOther: AppCategory;
|
|
3977
4081
|
export declare const AppCategoryFlow: AppCategory;
|
|
3978
|
-
export type AppStatus =
|
|
4082
|
+
export type AppStatus = "active" | "maintenance" | "deprecated" | "retired";
|
|
3979
4083
|
export declare const AppStatusActive: AppStatus;
|
|
3980
4084
|
export declare const AppStatusMaintenance: AppStatus;
|
|
3981
4085
|
export declare const AppStatusDeprecated: AppStatus;
|
|
3982
4086
|
export declare const AppStatusRetired: AppStatus;
|
|
3983
|
-
export type GPUType =
|
|
4087
|
+
export type GPUType = "any" | "none" | "intel" | "nvidia" | "amd" | "apple";
|
|
3984
4088
|
export declare const GPUTypeAny: GPUType;
|
|
3985
4089
|
export declare const GPUTypeNone: GPUType;
|
|
3986
4090
|
export declare const GPUTypeIntel: GPUType;
|
|
@@ -3990,7 +4094,7 @@ export declare const GPUTypeApple: GPUType;
|
|
|
3990
4094
|
/**
|
|
3991
4095
|
* Visibility represents the visibility level of a resource
|
|
3992
4096
|
*/
|
|
3993
|
-
export type Visibility =
|
|
4097
|
+
export type Visibility = "private" | "team" | "org" | "public" | "unlisted";
|
|
3994
4098
|
export declare const VisibilityPrivate: Visibility;
|
|
3995
4099
|
export declare const VisibilityTeam: Visibility;
|
|
3996
4100
|
/**
|
|
@@ -4003,7 +4107,7 @@ export declare const VisibilityUnlisted: Visibility;
|
|
|
4003
4107
|
/**
|
|
4004
4108
|
* Permission represents a permission level for access checks.
|
|
4005
4109
|
*/
|
|
4006
|
-
export type Permission =
|
|
4110
|
+
export type Permission = "read" | "write" | "use";
|
|
4007
4111
|
export declare const PermRead: Permission;
|
|
4008
4112
|
export declare const PermWrite: Permission;
|
|
4009
4113
|
/**
|
|
@@ -4013,25 +4117,25 @@ export declare const PermWrite: Permission;
|
|
|
4013
4117
|
* governed by their team/org usage policy (reach, INF-808).
|
|
4014
4118
|
*/
|
|
4015
4119
|
export declare const PermUse: Permission;
|
|
4016
|
-
export type SubscriptionStatus =
|
|
4120
|
+
export type SubscriptionStatus = "trialing" | "active" | "past_due" | "canceled" | "paused";
|
|
4017
4121
|
export declare const SubscriptionStatusTrialing: SubscriptionStatus;
|
|
4018
4122
|
export declare const SubscriptionStatusActive: SubscriptionStatus;
|
|
4019
4123
|
export declare const SubscriptionStatusPastDue: SubscriptionStatus;
|
|
4020
4124
|
export declare const SubscriptionStatusCanceled: SubscriptionStatus;
|
|
4021
4125
|
export declare const SubscriptionStatusPaused: SubscriptionStatus;
|
|
4022
|
-
export type SubscriptionInterval =
|
|
4126
|
+
export type SubscriptionInterval = "monthly" | "yearly";
|
|
4023
4127
|
export declare const SubscriptionIntervalMonthly: SubscriptionInterval;
|
|
4024
4128
|
export declare const SubscriptionIntervalYearly: SubscriptionInterval;
|
|
4025
|
-
export type PlanType =
|
|
4129
|
+
export type PlanType = "base" | "addon";
|
|
4026
4130
|
export declare const PlanTypeBase: PlanType;
|
|
4027
4131
|
export declare const PlanTypeAddon: PlanType;
|
|
4028
|
-
export type EntitlementSource =
|
|
4132
|
+
export type EntitlementSource = "tier" | "override" | "whitelist" | "trial" | "addon";
|
|
4029
4133
|
export declare const EntitlementSourceTier: EntitlementSource;
|
|
4030
4134
|
export declare const EntitlementSourceOverride: EntitlementSource;
|
|
4031
4135
|
export declare const EntitlementSourceWhitelist: EntitlementSource;
|
|
4032
4136
|
export declare const EntitlementSourceTrial: EntitlementSource;
|
|
4033
4137
|
export declare const EntitlementSourceAddon: EntitlementSource;
|
|
4034
|
-
export type EntitlementType =
|
|
4138
|
+
export type EntitlementType = "boolean" | "limit";
|
|
4035
4139
|
export declare const EntitlementTypeBoolean: EntitlementType;
|
|
4036
4140
|
export declare const EntitlementTypeLimit: EntitlementType;
|
|
4037
4141
|
/**
|
|
@@ -4040,24 +4144,24 @@ export declare const EntitlementTypeLimit: EntitlementType;
|
|
|
4040
4144
|
* ownership pattern used across the codebase; resolution matches all scopes
|
|
4041
4145
|
* visible from an AuthContext in one query and mergeEntitlements arbitrates.
|
|
4042
4146
|
*/
|
|
4043
|
-
export type EntitlementScope =
|
|
4147
|
+
export type EntitlementScope = "org" | "team" | "member";
|
|
4044
4148
|
export declare const EntitlementScopeOrg: EntitlementScope;
|
|
4045
4149
|
export declare const EntitlementScopeTeam: EntitlementScope;
|
|
4046
4150
|
export declare const EntitlementScopeMember: EntitlementScope;
|
|
4047
|
-
export type EnforcementMode =
|
|
4151
|
+
export type EnforcementMode = "block" | "warn";
|
|
4048
4152
|
export declare const EnforcementBlock: EnforcementMode;
|
|
4049
4153
|
export declare const EnforcementWarn: EnforcementMode;
|
|
4050
|
-
export type ChatStatus =
|
|
4154
|
+
export type ChatStatus = "busy" | "idle" | "awaiting_input" | "completed";
|
|
4051
4155
|
export declare const ChatStatusBusy: ChatStatus;
|
|
4052
4156
|
export declare const ChatStatusIdle: ChatStatus;
|
|
4053
4157
|
export declare const ChatStatusAwaitingInput: ChatStatus;
|
|
4054
4158
|
export declare const ChatStatusCompleted: ChatStatus;
|
|
4055
|
-
export type PlanStepStatus =
|
|
4159
|
+
export type PlanStepStatus = "pending" | "in_progress" | "completed" | "cancelled";
|
|
4056
4160
|
export declare const PlanStepStatusPending: PlanStepStatus;
|
|
4057
4161
|
export declare const PlanStepStatusInProgress: PlanStepStatus;
|
|
4058
4162
|
export declare const PlanStepStatusCompleted: PlanStepStatus;
|
|
4059
4163
|
export declare const PlanStepStatusCancelled: PlanStepStatus;
|
|
4060
|
-
export type ChatMessageRole =
|
|
4164
|
+
export type ChatMessageRole = "system" | "user" | "assistant" | "tool" | "injection" | "compaction";
|
|
4061
4165
|
/**
|
|
4062
4166
|
* LLM wire-protocol roles
|
|
4063
4167
|
*/
|
|
@@ -4067,23 +4171,24 @@ export declare const ChatMessageRoleAssistant: ChatMessageRole;
|
|
|
4067
4171
|
export declare const ChatMessageRoleTool: ChatMessageRole;
|
|
4068
4172
|
/**
|
|
4069
4173
|
* Internal bookkeeping roles — never sent to the LLM provider.
|
|
4070
|
-
* BuildContext
|
|
4174
|
+
* BuildContext folds injections into the user turn and replaces
|
|
4175
|
+
* compaction markers with their summary.
|
|
4071
4176
|
*/
|
|
4072
4177
|
export declare const ChatMessageRoleInjection: ChatMessageRole;
|
|
4073
4178
|
export declare const ChatMessageRoleCompaction: ChatMessageRole;
|
|
4074
|
-
export type ChatMessageStatus =
|
|
4179
|
+
export type ChatMessageStatus = "pending" | "queued" | "ready" | "failed" | "cancelled";
|
|
4075
4180
|
export declare const ChatMessageStatusPending: ChatMessageStatus;
|
|
4076
4181
|
export declare const ChatMessageStatusQueued: ChatMessageStatus;
|
|
4077
4182
|
export declare const ChatMessageStatusReady: ChatMessageStatus;
|
|
4078
4183
|
export declare const ChatMessageStatusFailed: ChatMessageStatus;
|
|
4079
4184
|
export declare const ChatMessageStatusCancelled: ChatMessageStatus;
|
|
4080
|
-
export type ChatMessageContentType =
|
|
4185
|
+
export type ChatMessageContentType = "text" | "reasoning" | "image" | "file" | "tool";
|
|
4081
4186
|
export declare const ChatMessageContentTypeText: ChatMessageContentType;
|
|
4082
4187
|
export declare const ChatMessageContentTypeReasoning: ChatMessageContentType;
|
|
4083
4188
|
export declare const ChatMessageContentTypeImage: ChatMessageContentType;
|
|
4084
4189
|
export declare const ChatMessageContentTypeFile: ChatMessageContentType;
|
|
4085
4190
|
export declare const ChatMessageContentTypeTool: ChatMessageContentType;
|
|
4086
|
-
export type ChannelType =
|
|
4191
|
+
export type ChannelType = "slack" | "discord" | "teams" | "telegram";
|
|
4087
4192
|
export declare const ChannelTypeSlack: ChannelType;
|
|
4088
4193
|
export declare const ChannelTypeDiscord: ChannelType;
|
|
4089
4194
|
export declare const ChannelTypeTeams: ChannelType;
|
|
@@ -4129,7 +4234,7 @@ export interface ChannelContext {
|
|
|
4129
4234
|
/**
|
|
4130
4235
|
* EngineStatus represents the status of an engine.
|
|
4131
4236
|
*/
|
|
4132
|
-
export type EngineStatus =
|
|
4237
|
+
export type EngineStatus = "running" | "pending" | "draining" | "disconnected" | "restarting" | "stopping" | "stopped";
|
|
4133
4238
|
export declare const EngineStatusRunning: EngineStatus;
|
|
4134
4239
|
export declare const EngineStatusPending: EngineStatus;
|
|
4135
4240
|
export declare const EngineStatusDraining: EngineStatus;
|
|
@@ -4140,7 +4245,7 @@ export declare const EngineStatusStopped: EngineStatus;
|
|
|
4140
4245
|
/**
|
|
4141
4246
|
* WorkerStatus represents the status of a worker.
|
|
4142
4247
|
*/
|
|
4143
|
-
export type WorkerStatus =
|
|
4248
|
+
export type WorkerStatus = "reserved" | "busy" | "idle" | "inactive";
|
|
4144
4249
|
export declare const WorkerStatusReserved: WorkerStatus;
|
|
4145
4250
|
export declare const WorkerStatusBusy: WorkerStatus;
|
|
4146
4251
|
export declare const WorkerStatusIdle: WorkerStatus;
|
|
@@ -4242,7 +4347,7 @@ export interface SelectorConfig {
|
|
|
4242
4347
|
mode: string;
|
|
4243
4348
|
index?: number;
|
|
4244
4349
|
}
|
|
4245
|
-
export type GraphNodeType =
|
|
4350
|
+
export type GraphNodeType = "unknown" | "join" | "split" | "execution" | "resource" | "approval" | "conditional" | "flow_node" | "trigger" | "credential_requirement";
|
|
4246
4351
|
export declare const GraphNodeTypeUnknown: GraphNodeType;
|
|
4247
4352
|
export declare const GraphNodeTypeJoin: GraphNodeType;
|
|
4248
4353
|
export declare const GraphNodeTypeSplit: GraphNodeType;
|
|
@@ -4256,7 +4361,7 @@ export declare const GraphNodeTypeCredentialRequirement: GraphNodeType;
|
|
|
4256
4361
|
/**
|
|
4257
4362
|
* GraphNodeStatus represents the status of a node
|
|
4258
4363
|
*/
|
|
4259
|
-
export type GraphNodeStatus =
|
|
4364
|
+
export type GraphNodeStatus = "pending" | "ready" | "running" | "completed" | "failed" | "cancelled" | "skipped" | "blocked";
|
|
4260
4365
|
export declare const GraphNodeStatusPending: GraphNodeStatus;
|
|
4261
4366
|
export declare const GraphNodeStatusReady: GraphNodeStatus;
|
|
4262
4367
|
export declare const GraphNodeStatusRunning: GraphNodeStatus;
|
|
@@ -4268,14 +4373,14 @@ export declare const GraphNodeStatusBlocked: GraphNodeStatus;
|
|
|
4268
4373
|
/**
|
|
4269
4374
|
* ResourceType identifies what kind of resource a graph node represents.
|
|
4270
4375
|
*/
|
|
4271
|
-
export type ResourceType =
|
|
4376
|
+
export type ResourceType = "knowledge" | "app" | "agent";
|
|
4272
4377
|
export declare const ResourceTypeKnowledge: ResourceType;
|
|
4273
4378
|
export declare const ResourceTypeApp: ResourceType;
|
|
4274
4379
|
export declare const ResourceTypeAgent: ResourceType;
|
|
4275
4380
|
/**
|
|
4276
4381
|
* GraphEdgeType defines the type of edge relationship
|
|
4277
4382
|
*/
|
|
4278
|
-
export type GraphEdgeType =
|
|
4383
|
+
export type GraphEdgeType = "dependency" | "flow" | "conditional" | "execution" | "parent" | "ancestor" | "duplicate" | "references" | "supersedes" | "input" | "output";
|
|
4279
4384
|
export declare const GraphEdgeTypeDependency: GraphEdgeType;
|
|
4280
4385
|
export declare const GraphEdgeTypeFlow: GraphEdgeType;
|
|
4281
4386
|
export declare const GraphEdgeTypeConditional: GraphEdgeType;
|
|
@@ -4290,7 +4395,7 @@ export declare const GraphEdgeTypeOutput: GraphEdgeType;
|
|
|
4290
4395
|
/**
|
|
4291
4396
|
* MergeStrategy defines how a delta field should be merged by consumers.
|
|
4292
4397
|
*/
|
|
4293
|
-
export type MergeStrategy =
|
|
4398
|
+
export type MergeStrategy = "concat" | "replace" | "indexed" | "nested";
|
|
4294
4399
|
export declare const MergeStrategyConcat: MergeStrategy;
|
|
4295
4400
|
export declare const MergeStrategyReplace: MergeStrategy;
|
|
4296
4401
|
export declare const MergeStrategyIndexed: MergeStrategy;
|
|
@@ -4375,7 +4480,7 @@ export declare const ToolCallFunctionDelta_fieldTags: {
|
|
|
4375
4480
|
/**
|
|
4376
4481
|
* ToolChoiceMode controls whether the model must call a tool this turn.
|
|
4377
4482
|
*/
|
|
4378
|
-
export type ToolChoiceMode =
|
|
4483
|
+
export type ToolChoiceMode = "none" | "auto" | "required" | "function";
|
|
4379
4484
|
export declare const ToolChoiceModeNone: ToolChoiceMode;
|
|
4380
4485
|
export declare const ToolChoiceModeAuto: ToolChoiceMode;
|
|
4381
4486
|
export declare const ToolChoiceModeRequired: ToolChoiceMode;
|
|
@@ -4392,7 +4497,7 @@ export interface ToolChoice {
|
|
|
4392
4497
|
/**
|
|
4393
4498
|
* ResponseFormatType selects how the model's output is constrained.
|
|
4394
4499
|
*/
|
|
4395
|
-
export type ResponseFormatType =
|
|
4500
|
+
export type ResponseFormatType = "text" | "json_object" | "json_schema";
|
|
4396
4501
|
export declare const ResponseFormatTypeText: ResponseFormatType;
|
|
4397
4502
|
export declare const ResponseFormatTypeJSONObject: ResponseFormatType;
|
|
4398
4503
|
export declare const ResponseFormatTypeJSONSchema: ResponseFormatType;
|
|
@@ -4465,7 +4570,7 @@ export interface LLMContextMessage {
|
|
|
4465
4570
|
/**
|
|
4466
4571
|
* SecretScope defines the visibility/purpose of a secret
|
|
4467
4572
|
*/
|
|
4468
|
-
export type SecretScope =
|
|
4573
|
+
export type SecretScope = "team" | "internal" | "system";
|
|
4469
4574
|
/**
|
|
4470
4575
|
* SecretScopeTeam is a normal user secret, visible in team secret lists
|
|
4471
4576
|
*/
|
|
@@ -4487,7 +4592,7 @@ export declare const PageStatusScheduled: PageStatus;
|
|
|
4487
4592
|
/**
|
|
4488
4593
|
* PageType represents the type of page content
|
|
4489
4594
|
*/
|
|
4490
|
-
export type PageType =
|
|
4595
|
+
export type PageType = "doc" | "blog" | "page" | "announcement";
|
|
4491
4596
|
export declare const PageTypeDoc: PageType;
|
|
4492
4597
|
export declare const PageTypeBlog: PageType;
|
|
4493
4598
|
export declare const PageTypePage: PageType;
|
|
@@ -4497,7 +4602,7 @@ export declare const CommentStatusUnknown: CommentStatus;
|
|
|
4497
4602
|
export declare const CommentStatusDraft: CommentStatus;
|
|
4498
4603
|
export declare const CommentStatusPublished: CommentStatus;
|
|
4499
4604
|
export declare const CommentStatusArchived: CommentStatus;
|
|
4500
|
-
export type InstanceCloudProvider =
|
|
4605
|
+
export type InstanceCloudProvider = "aws" | "amaya" | "azure" | "boostrun" | "crusoe" | "datacrunch" | "denvr" | "digitalocean" | "excesssupply" | "horizon" | "hyperstack" | "imwt" | "jarvislabs" | "lambdalabs" | "latitude" | "massedcompute" | "nebius" | "oblivus" | "paperspace" | "phyntec" | "runpod" | "scaleway" | "shade" | "tensordock" | "verda" | "voltagepark" | "vultr";
|
|
4501
4606
|
export declare const CloudAWS: InstanceCloudProvider;
|
|
4502
4607
|
export declare const CloudAmaya: InstanceCloudProvider;
|
|
4503
4608
|
export declare const CloudAzure: InstanceCloudProvider;
|
|
@@ -4525,7 +4630,7 @@ export declare const CloudTensorDock: InstanceCloudProvider;
|
|
|
4525
4630
|
export declare const CloudVerda: InstanceCloudProvider;
|
|
4526
4631
|
export declare const CloudVoltagePark: InstanceCloudProvider;
|
|
4527
4632
|
export declare const CloudVultr: InstanceCloudProvider;
|
|
4528
|
-
export type InstanceStatus =
|
|
4633
|
+
export type InstanceStatus = "creating" | "pending_provider" | "pending" | "active" | "error" | "deleting" | "deleted";
|
|
4529
4634
|
export declare const InstanceStatusCreating: InstanceStatus;
|
|
4530
4635
|
export declare const InstanceStatusPendingProvider: InstanceStatus;
|
|
4531
4636
|
export declare const InstanceStatusPending: InstanceStatus;
|
|
@@ -4533,29 +4638,29 @@ export declare const InstanceStatusActive: InstanceStatus;
|
|
|
4533
4638
|
export declare const InstanceStatusError: InstanceStatus;
|
|
4534
4639
|
export declare const InstanceStatusDeleting: InstanceStatus;
|
|
4535
4640
|
export declare const InstanceStatusDeleted: InstanceStatus;
|
|
4536
|
-
export type InstanceTypeDeploymentType =
|
|
4641
|
+
export type InstanceTypeDeploymentType = "vm" | "container" | "baremetal";
|
|
4537
4642
|
export declare const InstanceTypeDeploymentTypeVM: InstanceTypeDeploymentType;
|
|
4538
4643
|
export declare const InstanceTypeDeploymentTypeContainer: InstanceTypeDeploymentType;
|
|
4539
4644
|
export declare const InstanceTypeDeploymentTypeBaremetal: InstanceTypeDeploymentType;
|
|
4540
|
-
export type AppSessionStatus =
|
|
4645
|
+
export type AppSessionStatus = "active" | "ended" | "expired";
|
|
4541
4646
|
export declare const AppSessionStatusActive: AppSessionStatus;
|
|
4542
4647
|
export declare const AppSessionStatusEnded: AppSessionStatus;
|
|
4543
4648
|
export declare const AppSessionStatusExpired: AppSessionStatus;
|
|
4544
4649
|
/**
|
|
4545
4650
|
* ProjectType represents different types of projects
|
|
4546
4651
|
*/
|
|
4547
|
-
export type ProjectType =
|
|
4652
|
+
export type ProjectType = "agent" | "app" | "flow" | "other";
|
|
4548
4653
|
export declare const ProjectTypeAgent: ProjectType;
|
|
4549
4654
|
export declare const ProjectTypeApp: ProjectType;
|
|
4550
4655
|
export declare const ProjectTypeFlow: ProjectType;
|
|
4551
4656
|
export declare const ProjectTypeOther: ProjectType;
|
|
4552
|
-
export type UsageEventResourceTier =
|
|
4657
|
+
export type UsageEventResourceTier = "private" | "cloud";
|
|
4553
4658
|
export declare const UsageEventResourceTierPrivate: UsageEventResourceTier;
|
|
4554
4659
|
export declare const UsageEventResourceTierCloud: UsageEventResourceTier;
|
|
4555
4660
|
/**
|
|
4556
4661
|
* MetaItemType is the type discriminator for MetaItem
|
|
4557
4662
|
*/
|
|
4558
|
-
export type MetaItemType =
|
|
4663
|
+
export type MetaItemType = "text" | "image" | "video" | "audio" | "raw";
|
|
4559
4664
|
export declare const MetaItemTypeText: MetaItemType;
|
|
4560
4665
|
export declare const MetaItemTypeImage: MetaItemType;
|
|
4561
4666
|
export declare const MetaItemTypeVideo: MetaItemType;
|
|
@@ -4564,7 +4669,7 @@ export declare const MetaItemTypeRaw: MetaItemType;
|
|
|
4564
4669
|
/**
|
|
4565
4670
|
* VideoResolution represents standard video resolution presets
|
|
4566
4671
|
*/
|
|
4567
|
-
export type VideoResolution =
|
|
4672
|
+
export type VideoResolution = "480p" | "720p" | "1080p" | "1440p" | "4k";
|
|
4568
4673
|
export declare const VideoRes480P: VideoResolution;
|
|
4569
4674
|
export declare const VideoRes720P: VideoResolution;
|
|
4570
4675
|
export declare const VideoRes1080P: VideoResolution;
|
|
@@ -4573,20 +4678,20 @@ export declare const VideoRes4K: VideoResolution;
|
|
|
4573
4678
|
/**
|
|
4574
4679
|
* MCPServerAuthType describes how a server authenticates clients.
|
|
4575
4680
|
*/
|
|
4576
|
-
export type MCPServerAuthType =
|
|
4681
|
+
export type MCPServerAuthType = "oauth" | "api_key" | "none";
|
|
4577
4682
|
export declare const MCPServerAuthOAuth: MCPServerAuthType;
|
|
4578
4683
|
export declare const MCPServerAuthAPIKey: MCPServerAuthType;
|
|
4579
4684
|
export declare const MCPServerAuthNone: MCPServerAuthType;
|
|
4580
4685
|
/**
|
|
4581
4686
|
* TeamInviteStatus represents the status of a team invitation
|
|
4582
4687
|
*/
|
|
4583
|
-
export type TeamInviteStatus =
|
|
4688
|
+
export type TeamInviteStatus = "pending" | "accepted" | "declined" | "expired" | "revoked";
|
|
4584
4689
|
export declare const TeamInviteStatusPending: TeamInviteStatus;
|
|
4585
4690
|
export declare const TeamInviteStatusAccepted: TeamInviteStatus;
|
|
4586
4691
|
export declare const TeamInviteStatusDeclined: TeamInviteStatus;
|
|
4587
4692
|
export declare const TeamInviteStatusExpired: TeamInviteStatus;
|
|
4588
4693
|
export declare const TeamInviteStatusRevoked: TeamInviteStatus;
|
|
4589
|
-
export type RefRouteType =
|
|
4694
|
+
export type RefRouteType = "app" | "agent" | "skill" | "url";
|
|
4590
4695
|
export declare const RefRouteTypeApp: RefRouteType;
|
|
4591
4696
|
export declare const RefRouteTypeAgent: RefRouteType;
|
|
4592
4697
|
export declare const RefRouteTypeSkill: RefRouteType;
|
|
@@ -4595,10 +4700,10 @@ export declare const RefRouteTypeSkill: RefRouteType;
|
|
|
4595
4700
|
* /docs/api/sdk/files). Alias and target are literal paths, not refs.
|
|
4596
4701
|
*/
|
|
4597
4702
|
export declare const RefRouteTypeURL: RefRouteType;
|
|
4598
|
-
export type RefRouteMode =
|
|
4703
|
+
export type RefRouteMode = "rewrite" | "redirect";
|
|
4599
4704
|
export declare const RefRouteModeRewrite: RefRouteMode;
|
|
4600
4705
|
export declare const RefRouteModeRedirect: RefRouteMode;
|
|
4601
|
-
export type KnowledgeType =
|
|
4706
|
+
export type KnowledgeType = "concept" | "skill" | "observation" | "preference" | "reference" | "person" | "project" | "agent-config";
|
|
4602
4707
|
export declare const KnowledgeTypeConcept: KnowledgeType;
|
|
4603
4708
|
export declare const KnowledgeTypeSkill: KnowledgeType;
|
|
4604
4709
|
export declare const KnowledgeTypeObservation: KnowledgeType;
|
|
@@ -4607,7 +4712,7 @@ export declare const KnowledgeTypeReference: KnowledgeType;
|
|
|
4607
4712
|
export declare const KnowledgeTypePerson: KnowledgeType;
|
|
4608
4713
|
export declare const KnowledgeTypeProject: KnowledgeType;
|
|
4609
4714
|
export declare const KnowledgeTypeAgentConfig: KnowledgeType;
|
|
4610
|
-
export type KnowledgeLifecycle =
|
|
4715
|
+
export type KnowledgeLifecycle = "permanent" | "decay" | "draft" | "deprecated";
|
|
4611
4716
|
export declare const KnowledgeLifecyclePermanent: KnowledgeLifecycle;
|
|
4612
4717
|
export declare const KnowledgeLifecycleDecay: KnowledgeLifecycle;
|
|
4613
4718
|
export declare const KnowledgeLifecycleDraft: KnowledgeLifecycle;
|
|
@@ -4615,10 +4720,10 @@ export declare const KnowledgeLifecycleDeprecated: KnowledgeLifecycle;
|
|
|
4615
4720
|
/**
|
|
4616
4721
|
* ArtifactType is the source format of an artifact page.
|
|
4617
4722
|
*/
|
|
4618
|
-
export type ArtifactType =
|
|
4723
|
+
export type ArtifactType = "html" | "markdown";
|
|
4619
4724
|
export declare const ArtifactTypeHTML: ArtifactType;
|
|
4620
4725
|
export declare const ArtifactTypeMarkdown: ArtifactType;
|
|
4621
|
-
export type FilterOperator =
|
|
4726
|
+
export type FilterOperator = "eq" | "neq" | "in" | "not_in" | "gt" | "gte" | "lt" | "lte" | "like" | "ilike" | "contains" | "not_contains" | "is_null" | "is_not_null" | "is_empty" | "is_not_empty";
|
|
4622
4727
|
export declare const OpEqual: FilterOperator;
|
|
4623
4728
|
export declare const OpNotEqual: FilterOperator;
|
|
4624
4729
|
export declare const OpIn: FilterOperator;
|
|
@@ -4635,7 +4740,7 @@ export declare const OpIsNull: FilterOperator;
|
|
|
4635
4740
|
export declare const OpIsNotNull: FilterOperator;
|
|
4636
4741
|
export declare const OpIsEmpty: FilterOperator;
|
|
4637
4742
|
export declare const OpIsNotEmpty: FilterOperator;
|
|
4638
|
-
export type DeviceAuthStatus =
|
|
4743
|
+
export type DeviceAuthStatus = "pending" | "approved" | "expired" | "denied" | "valid" | "invalid" | "loading";
|
|
4639
4744
|
export declare const DeviceAuthStatusPending: DeviceAuthStatus;
|
|
4640
4745
|
export declare const DeviceAuthStatusApproved: DeviceAuthStatus;
|
|
4641
4746
|
export declare const DeviceAuthStatusExpired: DeviceAuthStatus;
|
|
@@ -4646,7 +4751,7 @@ export declare const DeviceAuthStatusLoading: DeviceAuthStatus;
|
|
|
4646
4751
|
/**
|
|
4647
4752
|
* DeviceTokenKind selects the credential minted when a device auth flow is approved.
|
|
4648
4753
|
*/
|
|
4649
|
-
export type DeviceTokenKind =
|
|
4754
|
+
export type DeviceTokenKind = "session" | "api_key";
|
|
4650
4755
|
/**
|
|
4651
4756
|
* DeviceTokenKindSession mints a revocable CLI session (acts as the user,
|
|
4652
4757
|
* supports team switching via X-Team-ID).
|
|
@@ -4657,7 +4762,7 @@ export declare const DeviceTokenKindSession: DeviceTokenKind;
|
|
|
4657
4762
|
* TODO: retire once CLIs older than the session-token release are gone.
|
|
4658
4763
|
*/
|
|
4659
4764
|
export declare const DeviceTokenKindAPIKey: DeviceTokenKind;
|
|
4660
|
-
export type EntitlementResource =
|
|
4765
|
+
export type EntitlementResource = "api_keys" | "connectors" | "knowledge_bases" | "storage_mb" | "concurrency" | "rate_per_min" | "seats" | "triggers" | "retention_days" | "private_apps" | "task_executions" | "feature:byok" | "feature:seedance" | "feature:scopes" | "feature:webhooks" | "feature:team_billing" | "feature:auto_recharge" | "feature:invoices" | "feature:publish_apps";
|
|
4661
4766
|
/**
|
|
4662
4767
|
* Capacity limits — scale with tier
|
|
4663
4768
|
*/
|
|
@@ -4689,7 +4794,7 @@ export declare const ResourceFeatureTeamBilling: EntitlementResource;
|
|
|
4689
4794
|
export declare const ResourceFeatureAutoRecharge: EntitlementResource;
|
|
4690
4795
|
export declare const ResourceFeatureInvoices: EntitlementResource;
|
|
4691
4796
|
export declare const ResourceFeaturePublishApps: EntitlementResource;
|
|
4692
|
-
export type ContentRating =
|
|
4797
|
+
export type ContentRating = "safe" | "sexual_suggestive" | "sexual_explicit" | "violence_non_graphic" | "violence_graphic" | "gore" | "unrated";
|
|
4693
4798
|
export declare const ContentSafe: ContentRating;
|
|
4694
4799
|
export declare const ContentSexualSuggestive: ContentRating;
|
|
4695
4800
|
export declare const ContentSexualExplicit: ContentRating;
|
|
@@ -4700,7 +4805,7 @@ export declare const ContentUnrated: ContentRating;
|
|
|
4700
4805
|
/**
|
|
4701
4806
|
* CredentialProvider names the external service a credential is for.
|
|
4702
4807
|
*/
|
|
4703
|
-
export type CredentialProvider =
|
|
4808
|
+
export type CredentialProvider = "google" | "google-sa" | "slack" | "notion" | "github" | "x" | "microsoft" | "salesforce" | "discord" | "gcp" | "mcp" | "reddit";
|
|
4704
4809
|
/**
|
|
4705
4810
|
* Credential.Provider is a plain string; cast with string(...) when assigning.
|
|
4706
4811
|
*/
|
|
@@ -4752,7 +4857,7 @@ export declare const CredentialProviderReddit: CredentialProvider;
|
|
|
4752
4857
|
/**
|
|
4753
4858
|
* CredentialType describes the credential category.
|
|
4754
4859
|
*/
|
|
4755
|
-
export type CredentialType =
|
|
4860
|
+
export type CredentialType = "oauth" | "api_key" | "mcp" | "service_account" | "wif";
|
|
4756
4861
|
export declare const CredentialTypeOAuth: CredentialType;
|
|
4757
4862
|
export declare const CredentialTypeAPIKey: CredentialType;
|
|
4758
4863
|
export declare const CredentialTypeMCP: CredentialType;
|
|
@@ -4761,7 +4866,7 @@ export declare const CredentialTypeWIF: CredentialType;
|
|
|
4761
4866
|
/**
|
|
4762
4867
|
* CredentialStatus represents the lifecycle state of a credential.
|
|
4763
4868
|
*/
|
|
4764
|
-
export type CredentialStatus =
|
|
4869
|
+
export type CredentialStatus = "pending" | "connected" | "disconnected" | "expired" | "error";
|
|
4765
4870
|
export declare const CredentialStatusPending: CredentialStatus;
|
|
4766
4871
|
export declare const CredentialStatusConnected: CredentialStatus;
|
|
4767
4872
|
export declare const CredentialStatusDisconnected: CredentialStatus;
|
|
@@ -4770,7 +4875,7 @@ export declare const CredentialStatusError: CredentialStatus;
|
|
|
4770
4875
|
/**
|
|
4771
4876
|
* CredentialScope controls resolution priority and ownership.
|
|
4772
4877
|
*/
|
|
4773
|
-
export type CredentialScope =
|
|
4878
|
+
export type CredentialScope = "platform" | "org" | "team" | "user" | "agent";
|
|
4774
4879
|
export declare const CredentialScopePlatform: CredentialScope;
|
|
4775
4880
|
/**
|
|
4776
4881
|
* CredentialScopeOrg: shared across all teams of an org. In the enum for
|
|
@@ -4788,7 +4893,7 @@ export declare const CredentialScopeAgent: CredentialScope;
|
|
|
4788
4893
|
* the logins made through it (owned by a team or a user). Every other
|
|
4789
4894
|
* credential type is a token row.
|
|
4790
4895
|
*/
|
|
4791
|
-
export type CredentialGrant =
|
|
4896
|
+
export type CredentialGrant = "credentials" | "token";
|
|
4792
4897
|
/**
|
|
4793
4898
|
* CredentialGrantCredentials: an OAuth app. Never a connection.
|
|
4794
4899
|
*/
|
|
@@ -4801,7 +4906,7 @@ export declare const CredentialGrantToken: CredentialGrant;
|
|
|
4801
4906
|
/**
|
|
4802
4907
|
* NotificationChannel represents a delivery channel
|
|
4803
4908
|
*/
|
|
4804
|
-
export type NotificationChannel =
|
|
4909
|
+
export type NotificationChannel = "email" | "sms" | "push" | "slack";
|
|
4805
4910
|
export declare const NotificationChannelEmail: NotificationChannel;
|
|
4806
4911
|
export declare const NotificationChannelSMS: NotificationChannel;
|
|
4807
4912
|
export declare const NotificationChannelPush: NotificationChannel;
|
|
@@ -4809,7 +4914,7 @@ export declare const NotificationChannelSlack: NotificationChannel;
|
|
|
4809
4914
|
/**
|
|
4810
4915
|
* NotificationPriority represents notification priority
|
|
4811
4916
|
*/
|
|
4812
|
-
export type NotificationPriority =
|
|
4917
|
+
export type NotificationPriority = "low" | "normal" | "high" | "critical";
|
|
4813
4918
|
export declare const NotificationPriorityLow: NotificationPriority;
|
|
4814
4919
|
export declare const NotificationPriorityNormal: NotificationPriority;
|
|
4815
4920
|
export declare const NotificationPriorityHigh: NotificationPriority;
|
|
@@ -4817,7 +4922,7 @@ export declare const NotificationPriorityCritical: NotificationPriority;
|
|
|
4817
4922
|
/**
|
|
4818
4923
|
* NotificationType represents the type/category of notification
|
|
4819
4924
|
*/
|
|
4820
|
-
export type NotificationType =
|
|
4925
|
+
export type NotificationType = "low_balance" | "auto_recharge" | "payment_success" | "payment_failed" | "usage_summary" | "spending_limit" | "invoice" | "credit_note" | "subscription_created" | "subscription_credit" | "subscription_canceled" | "subscription_payment_failed" | "subscription_trial_ending" | "welcome" | "welcome_agents" | "welcome_apps" | "welcome_flows" | "welcome_sdk" | "password_reset" | "email_verify" | "security_alert" | "task_complete" | "task_failed" | "data_export" | "system_alert" | "maintenance" | "tos_update" | "service_notice" | "team_invite";
|
|
4821
4926
|
/**
|
|
4822
4927
|
* Billing notifications
|
|
4823
4928
|
*/
|
|
@@ -4868,7 +4973,7 @@ export declare const NotificationTypeTeamInvite: NotificationType;
|
|
|
4868
4973
|
/**
|
|
4869
4974
|
* NotificationStatus represents the status of a notification
|
|
4870
4975
|
*/
|
|
4871
|
-
export type NotificationStatus =
|
|
4976
|
+
export type NotificationStatus = "pending" | "processing" | "sent" | "delivered" | "failed" | "bounced" | "cancelled";
|
|
4872
4977
|
export declare const NotificationStatusPending: NotificationStatus;
|
|
4873
4978
|
export declare const NotificationStatusProcessing: NotificationStatus;
|
|
4874
4979
|
export declare const NotificationStatusSent: NotificationStatus;
|
|
@@ -4879,7 +4984,7 @@ export declare const NotificationStatusCancelled: NotificationStatus;
|
|
|
4879
4984
|
/**
|
|
4880
4985
|
* FunctionKind is how an app function talks to its caller.
|
|
4881
4986
|
*/
|
|
4882
|
-
export type FunctionKind =
|
|
4987
|
+
export type FunctionKind = "run" | "stream";
|
|
4883
4988
|
/**
|
|
4884
4989
|
* FunctionKindRun takes an input and returns an output (optionally
|
|
4885
4990
|
* yielding progress on the way). The zero value means this.
|
|
@@ -4893,7 +4998,7 @@ export declare const FunctionKindStream: FunctionKind;
|
|
|
4893
4998
|
/**
|
|
4894
4999
|
* SocketStatus is where a socket is in its life.
|
|
4895
5000
|
*/
|
|
4896
|
-
export type SocketStatus =
|
|
5001
|
+
export type SocketStatus = "pending" | "open" | "closed";
|
|
4897
5002
|
/**
|
|
4898
5003
|
* SocketStatusPending: opened, and the two ends have not met yet. An end
|
|
4899
5004
|
* that gave up waiting may dial again, so an unpaired end does not close
|
|
@@ -4911,7 +5016,7 @@ export declare const SocketStatusClosed: SocketStatus;
|
|
|
4911
5016
|
/**
|
|
4912
5017
|
* SocketOutcome is why a socket closed.
|
|
4913
5018
|
*/
|
|
4914
|
-
export type SocketOutcome =
|
|
5019
|
+
export type SocketOutcome = "client_closed" | "worker_closed" | "drained" | "never_paired" | "task_ended";
|
|
4915
5020
|
export declare const SocketOutcomeClientClosed: SocketOutcome;
|
|
4916
5021
|
export declare const SocketOutcomeWorkerClosed: SocketOutcome;
|
|
4917
5022
|
/**
|
|
@@ -4982,7 +5087,7 @@ export declare const TaskStatusCancelled: TaskStatus;
|
|
|
4982
5087
|
/**
|
|
4983
5088
|
* Infra defines where a task should run.
|
|
4984
5089
|
*/
|
|
4985
|
-
export type Infra =
|
|
5090
|
+
export type Infra = "private" | "cloud" | "private_first";
|
|
4986
5091
|
export declare const InfraPrivate: Infra;
|
|
4987
5092
|
export declare const InfraCloud: Infra;
|
|
4988
5093
|
export declare const InfraPrivateFirst: Infra;
|
|
@@ -5009,7 +5114,7 @@ export interface TaskAction {
|
|
|
5009
5114
|
export interface TaskMetadata {
|
|
5010
5115
|
action?: TaskAction;
|
|
5011
5116
|
}
|
|
5012
|
-
export type TeamType =
|
|
5117
|
+
export type TeamType = "personal" | "team" | "system" | "org";
|
|
5013
5118
|
export declare const TeamTypePersonal: TeamType;
|
|
5014
5119
|
export declare const TeamTypeTeam: TeamType;
|
|
5015
5120
|
export declare const TeamTypeSystem: TeamType;
|
|
@@ -5021,20 +5126,45 @@ export declare const TeamTypeSystem: TeamType;
|
|
|
5021
5126
|
* teams exist.
|
|
5022
5127
|
*/
|
|
5023
5128
|
export declare const TeamTypeOrg: TeamType;
|
|
5024
|
-
export type TeamStatus =
|
|
5129
|
+
export type TeamStatus = "active" | "suspended" | "terminated";
|
|
5025
5130
|
export declare const TeamStatusActive: TeamStatus;
|
|
5026
5131
|
export declare const TeamStatusSuspended: TeamStatus;
|
|
5027
5132
|
export declare const TeamStatusTerminated: TeamStatus;
|
|
5028
|
-
export type TeamRole =
|
|
5133
|
+
export type TeamRole = "owner" | "admin" | "member";
|
|
5029
5134
|
export declare const TeamRoleOwner: TeamRole;
|
|
5030
5135
|
export declare const TeamRoleAdmin: TeamRole;
|
|
5031
5136
|
export declare const TeamRoleMember: TeamRole;
|
|
5032
|
-
|
|
5137
|
+
/**
|
|
5138
|
+
* TeamCapability is one thing a caller may do to a team's settings. The set is
|
|
5139
|
+
* closed; team.Subject.Can is the only place that grants them.
|
|
5140
|
+
*/
|
|
5141
|
+
export type TeamCapability = "edit_profile" | "manage_members" | "view_members" | "manage_keys" | "manage_vault" | "view_billing" | "manage_billing" | "view_policy" | "manage_policy" | "manage_org" | "manage_sso" | "archive" | "create_team" | "create_org" | "connect_org_credential" | "connect_platform_credential";
|
|
5142
|
+
export declare const TeamCapabilityEditProfile: TeamCapability;
|
|
5143
|
+
export declare const TeamCapabilityManageMembers: TeamCapability;
|
|
5144
|
+
export declare const TeamCapabilityViewMembers: TeamCapability;
|
|
5145
|
+
export declare const TeamCapabilityManageKeys: TeamCapability;
|
|
5146
|
+
export declare const TeamCapabilityManageVault: TeamCapability;
|
|
5147
|
+
export declare const TeamCapabilityViewBilling: TeamCapability;
|
|
5148
|
+
export declare const TeamCapabilityManageBilling: TeamCapability;
|
|
5149
|
+
export declare const TeamCapabilityViewPolicy: TeamCapability;
|
|
5150
|
+
export declare const TeamCapabilityManagePolicy: TeamCapability;
|
|
5151
|
+
export declare const TeamCapabilityManageOrg: TeamCapability;
|
|
5152
|
+
export declare const TeamCapabilityManageSSO: TeamCapability;
|
|
5153
|
+
export declare const TeamCapabilityArchive: TeamCapability;
|
|
5154
|
+
export declare const TeamCapabilityCreateTeam: TeamCapability;
|
|
5155
|
+
export declare const TeamCapabilityCreateOrg: TeamCapability;
|
|
5156
|
+
/**
|
|
5157
|
+
* Connecting a credential the whole org, or the whole platform, resolves.
|
|
5158
|
+
* The workspace level is manage_vault.
|
|
5159
|
+
*/
|
|
5160
|
+
export declare const TeamCapabilityConnectOrgCredential: TeamCapability;
|
|
5161
|
+
export declare const TeamCapabilityConnectPlatformCredential: TeamCapability;
|
|
5162
|
+
export type Role = "guest" | "user" | "admin" | "system";
|
|
5033
5163
|
export declare const RoleGuest: Role;
|
|
5034
5164
|
export declare const RoleUser: Role;
|
|
5035
5165
|
export declare const RoleAdmin: Role;
|
|
5036
5166
|
export declare const RoleSystem: Role;
|
|
5037
|
-
export type UtilityPreset =
|
|
5167
|
+
export type UtilityPreset = "gate" | "selector" | "merge" | "constant";
|
|
5038
5168
|
export declare const UtilityPresetGate: UtilityPreset;
|
|
5039
5169
|
export declare const UtilityPresetSelector: UtilityPreset;
|
|
5040
5170
|
export declare const UtilityPresetMerge: UtilityPreset;
|
|
@@ -5057,7 +5187,7 @@ export interface UtilityConfig {
|
|
|
5057
5187
|
* These are the backbone protocol events — every consumer (A2A, SDK, frontend)
|
|
5058
5188
|
* projects from this set.
|
|
5059
5189
|
*/
|
|
5060
|
-
export type AgentEventType =
|
|
5190
|
+
export type AgentEventType = "run.started" | "run.state_changed" | "turn.started" | "turn.completed" | "content.delta" | "tool.started" | "tool.completed" | "approval.required" | "approval.resolved" | "hook.executed" | "usage.updated" | "context.compacted" | "error";
|
|
5061
5191
|
/**
|
|
5062
5192
|
* Run lifecycle
|
|
5063
5193
|
*/
|
|
@@ -5136,7 +5266,7 @@ export interface ContentDeltaPayload {
|
|
|
5136
5266
|
kind: ContentDeltaKind;
|
|
5137
5267
|
delta: string;
|
|
5138
5268
|
}
|
|
5139
|
-
export type ContentDeltaKind =
|
|
5269
|
+
export type ContentDeltaKind = "text" | "reasoning";
|
|
5140
5270
|
export declare const ContentDeltaText: ContentDeltaKind;
|
|
5141
5271
|
export declare const ContentDeltaReasoning: ContentDeltaKind;
|
|
5142
5272
|
export interface ToolStartedPayload {
|
|
@@ -5190,7 +5320,7 @@ export interface ErrorPayload {
|
|
|
5190
5320
|
* AgentRunState tracks the lifecycle of an agent run (one user→agent turn).
|
|
5191
5321
|
* Maps to A2A TaskState and AG-UI Run outcome for protocol compliance.
|
|
5192
5322
|
*/
|
|
5193
|
-
export type AgentRunState =
|
|
5323
|
+
export type AgentRunState = "submitted" | "working" | "input_required" | "auth_required" | "completed" | "failed" | "canceled" | "rejected";
|
|
5194
5324
|
export declare const AgentRunStateSubmitted: AgentRunState;
|
|
5195
5325
|
export declare const AgentRunStateWorking: AgentRunState;
|
|
5196
5326
|
export declare const AgentRunStateInputRequired: AgentRunState;
|
|
@@ -5203,7 +5333,7 @@ export declare const AgentRunStateRejected: AgentRunState;
|
|
|
5203
5333
|
* InterruptReason describes why an agent run is in an interrupted state.
|
|
5204
5334
|
* Aligns with AG-UI interrupt outcome reasons.
|
|
5205
5335
|
*/
|
|
5206
|
-
export type InterruptReason =
|
|
5336
|
+
export type InterruptReason = "tool_approval" | "client_tool" | "widget" | "auth" | "confirmation" | "hook_gate";
|
|
5207
5337
|
export declare const InterruptReasonToolApproval: InterruptReason;
|
|
5208
5338
|
export declare const InterruptReasonClientTool: InterruptReason;
|
|
5209
5339
|
export declare const InterruptReasonWidget: InterruptReason;
|
|
@@ -5216,7 +5346,7 @@ export type StringEncodedMap = {
|
|
|
5216
5346
|
/**
|
|
5217
5347
|
* InterruptStatus tracks the lifecycle of an interrupt gate.
|
|
5218
5348
|
*/
|
|
5219
|
-
export type InterruptStatus =
|
|
5349
|
+
export type InterruptStatus = "pending" | "resolved" | "expired" | "cancelled";
|
|
5220
5350
|
export declare const InterruptStatusPending: InterruptStatus;
|
|
5221
5351
|
export declare const InterruptStatusResolved: InterruptStatus;
|
|
5222
5352
|
export declare const InterruptStatusExpired: InterruptStatus;
|
|
@@ -5224,13 +5354,13 @@ export declare const InterruptStatusCancelled: InterruptStatus;
|
|
|
5224
5354
|
/**
|
|
5225
5355
|
* InterruptResolution records how a pending interrupt was resolved.
|
|
5226
5356
|
*/
|
|
5227
|
-
export type InterruptResolution =
|
|
5357
|
+
export type InterruptResolution = "allow" | "deny";
|
|
5228
5358
|
export declare const InterruptResolutionAllow: InterruptResolution;
|
|
5229
5359
|
export declare const InterruptResolutionDeny: InterruptResolution;
|
|
5230
5360
|
/**
|
|
5231
5361
|
* InterruptResourceType identifies the kind of resource an interrupt gates.
|
|
5232
5362
|
*/
|
|
5233
|
-
export type InterruptResourceType =
|
|
5363
|
+
export type InterruptResourceType = "tool_invocation" | "hook_event";
|
|
5234
5364
|
export declare const InterruptResourceToolInvocation: InterruptResourceType;
|
|
5235
5365
|
export declare const InterruptResourceHookEvent: InterruptResourceType;
|
|
5236
5366
|
/**
|
|
@@ -5238,7 +5368,7 @@ export declare const InterruptResourceHookEvent: InterruptResourceType;
|
|
|
5238
5368
|
* Events fire at well-defined points in the turn cycle, giving external
|
|
5239
5369
|
* handlers the ability to observe, inject context, or halt execution.
|
|
5240
5370
|
*/
|
|
5241
|
-
export type HookEvent =
|
|
5371
|
+
export type HookEvent = "agent.start" | "agent.turn_start" | "agent.tool_call" | "agent.tool_result" | "agent.turn_complete" | "agent.error" | "agent.complete" | "agent.idle" | "agent.pre_compact" | "agent.post_compact";
|
|
5242
5372
|
export declare const HookEventAgentStart: HookEvent;
|
|
5243
5373
|
export declare const HookEventTurnStart: HookEvent;
|
|
5244
5374
|
export declare const HookEventToolCall: HookEvent;
|
|
@@ -5260,7 +5390,7 @@ export interface HookEventDefinition {
|
|
|
5260
5390
|
/**
|
|
5261
5391
|
* HookDecision is the handler's verdict on whether execution should continue.
|
|
5262
5392
|
*/
|
|
5263
|
-
export type HookDecision =
|
|
5393
|
+
export type HookDecision = "allow" | "deny" | "stop" | "suspend";
|
|
5264
5394
|
export declare const HookDecisionAllow: HookDecision;
|
|
5265
5395
|
export declare const HookDecisionDeny: HookDecision;
|
|
5266
5396
|
export declare const HookDecisionStop: HookDecision;
|
|
@@ -5268,10 +5398,36 @@ export declare const HookDecisionSuspend: HookDecision;
|
|
|
5268
5398
|
/**
|
|
5269
5399
|
* HookHandlerType distinguishes how a lifecycle hook is executed.
|
|
5270
5400
|
*/
|
|
5271
|
-
export type HookHandlerType =
|
|
5401
|
+
export type HookHandlerType = "webhook" | "task" | "gate" | "builtin";
|
|
5272
5402
|
export declare const HookHandlerWebhook: HookHandlerType;
|
|
5273
5403
|
export declare const HookHandlerTask: HookHandlerType;
|
|
5274
5404
|
export declare const HookHandlerGate: HookHandlerType;
|
|
5405
|
+
export declare const HookHandlerBuiltin: HookHandlerType;
|
|
5406
|
+
/**
|
|
5407
|
+
* BuiltinHook names a hook handler the platform implements itself. A builtin
|
|
5408
|
+
* runs in-process on the turn that fired it: no URL to host, no round trip, no
|
|
5409
|
+
* agent spawn. That is what lets it return an injection at all — a task hook
|
|
5410
|
+
* spawns an agent and discards its answer, so only webhook, gate and builtin
|
|
5411
|
+
* can put anything into context.
|
|
5412
|
+
* This registry is the single source of truth. The runtime dispatches from it,
|
|
5413
|
+
* agent config is validated against it, and clients enumerate it to show what
|
|
5414
|
+
* an agent can switch on without hosting anything.
|
|
5415
|
+
*/
|
|
5416
|
+
export type BuiltinHook = "belt:suggest";
|
|
5417
|
+
export declare const BuiltinHookBeltSuggest: BuiltinHook;
|
|
5418
|
+
/**
|
|
5419
|
+
* BuiltinHookDefinition describes a builtin hook and where it may be used.
|
|
5420
|
+
*/
|
|
5421
|
+
export interface BuiltinHookDefinition {
|
|
5422
|
+
name: BuiltinHook;
|
|
5423
|
+
description: string;
|
|
5424
|
+
/**
|
|
5425
|
+
* Events the builtin may be attached to. A builtin that reads the turn's
|
|
5426
|
+
* prompt is meaningless on agent.complete, so the set is part of its
|
|
5427
|
+
* definition rather than a convention.
|
|
5428
|
+
*/
|
|
5429
|
+
events: HookEvent[];
|
|
5430
|
+
}
|
|
5275
5431
|
/**
|
|
5276
5432
|
* LifecycleHookConfig registers a handler for an agent lifecycle event.
|
|
5277
5433
|
* Stored on AgentVersion alongside Tools and Skills.
|
|
@@ -5319,6 +5475,14 @@ export interface ContextInjection {
|
|
|
5319
5475
|
role?: string;
|
|
5320
5476
|
ttl_turns?: number;
|
|
5321
5477
|
dedup_key?: string;
|
|
5478
|
+
/**
|
|
5479
|
+
* Items names what this injection put in front of the model — resource
|
|
5480
|
+
* refs, file paths, whatever the producer deals in. A hook that offers the
|
|
5481
|
+
* same things every turn reads its own past Items back to see what it has
|
|
5482
|
+
* already offered, instead of keeping a ledger somewhere else and hoping
|
|
5483
|
+
* the two stay in step.
|
|
5484
|
+
*/
|
|
5485
|
+
items?: string[];
|
|
5322
5486
|
}
|
|
5323
5487
|
/**
|
|
5324
5488
|
* ToolCallEventData is the typed payload for agent.tool_call events.
|
|
@@ -5346,7 +5510,7 @@ export interface ErrorEventData {
|
|
|
5346
5510
|
/**
|
|
5347
5511
|
* ToolInvocationStatus represents the execution status of a tool invocation
|
|
5348
5512
|
*/
|
|
5349
|
-
export type ToolInvocationStatus =
|
|
5513
|
+
export type ToolInvocationStatus = "pending" | "in_progress" | "awaiting_input" | "awaiting_approval" | "completed" | "failed" | "cancelled";
|
|
5350
5514
|
export declare const ToolInvocationStatusPending: ToolInvocationStatus;
|
|
5351
5515
|
export declare const ToolInvocationStatusInProgress: ToolInvocationStatus;
|
|
5352
5516
|
export declare const ToolInvocationStatusAwaitingInput: ToolInvocationStatus;
|
|
@@ -5357,7 +5521,7 @@ export declare const ToolInvocationStatusCancelled: ToolInvocationStatus;
|
|
|
5357
5521
|
/**
|
|
5358
5522
|
* ToolType represents the type of tool (used in both AgentTool definition and ToolInvocation)
|
|
5359
5523
|
*/
|
|
5360
|
-
export type ToolType =
|
|
5524
|
+
export type ToolType = "app" | "agent" | "hook" | "http" | "call" | "mcp" | "client" | "internal" | "harness";
|
|
5361
5525
|
export declare const ToolTypeApp: ToolType;
|
|
5362
5526
|
export declare const ToolTypeAgent: ToolType;
|
|
5363
5527
|
export declare const ToolTypeHook: ToolType;
|
|
@@ -5366,14 +5530,15 @@ export declare const ToolTypeCall: ToolType;
|
|
|
5366
5530
|
export declare const ToolTypeMCP: ToolType;
|
|
5367
5531
|
export declare const ToolTypeClient: ToolType;
|
|
5368
5532
|
export declare const ToolTypeInternal: ToolType;
|
|
5533
|
+
export declare const ToolTypeHarness: ToolType;
|
|
5369
5534
|
/**
|
|
5370
5535
|
* ToolCallType represents the type field on a tool call (wire format).
|
|
5371
5536
|
*/
|
|
5372
|
-
export type ToolCallType =
|
|
5537
|
+
export type ToolCallType = "function";
|
|
5373
5538
|
/**
|
|
5374
5539
|
* ToolParamType represents a JSON Schema parameter type for tool definitions.
|
|
5375
5540
|
*/
|
|
5376
|
-
export type ToolParamType = string;
|
|
5541
|
+
export type ToolParamType = "object" | "string" | "integer" | "number" | "boolean" | "array" | "null";
|
|
5377
5542
|
/**
|
|
5378
5543
|
* Tool call types
|
|
5379
5544
|
*/
|