@proteos/sdk 0.32.0 → 0.33.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/{chunk-Y5RY27JB.js → chunk-JWLTUYS7.js} +4 -3
- package/dist/chunk-JWLTUYS7.js.map +1 -0
- package/dist/{chunk-3SWQRVZX.cjs → chunk-NZI4N4SK.cjs} +4 -3
- package/dist/chunk-NZI4N4SK.cjs.map +1 -0
- package/dist/index.cjs +140 -84
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +141 -41
- package/dist/index.d.ts +141 -41
- package/dist/index.js +58 -2
- package/dist/index.js.map +1 -1
- package/dist/meta/index.cjs +53 -53
- package/dist/meta/index.d.cts +1 -1
- package/dist/meta/index.d.ts +1 -1
- package/dist/meta/index.js +1 -1
- package/dist/{types-BguERkVI.d.cts → types-v9RkMuKf.d.cts} +6 -0
- package/dist/{types-BguERkVI.d.ts → types-v9RkMuKf.d.ts} +6 -0
- package/package.json +1 -1
- package/src/agent/index.ts +2 -0
- package/src/agent/mcp-servers.ts +28 -0
- package/src/agent/prompts.ts +28 -0
- package/src/agent/skills.ts +33 -1
- package/src/agent/tools.ts +34 -1
- package/src/agent/types.ts +20 -0
- package/src/connector/types.ts +23 -1
- package/src/conversation/index.ts +11 -4
- package/src/conversation/types.ts +20 -0
- package/src/index.ts +3 -5
- package/src/meta/layout/elements.ts +7 -0
- package/src/workflow/index.ts +0 -5
- package/src/workflow/types.ts +24 -36
- package/dist/chunk-3SWQRVZX.cjs.map +0 -1
- package/dist/chunk-Y5RY27JB.js.map +0 -1
package/dist/index.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { A as AuditFields, L as ListOptions, a as Attribute, U as UserRef$2, P as PageIterator, b as ListResult, c as ProteosClient, F as FileRef, d as PublicAccessOperation } from './types-
|
|
2
|
-
export { e as App, f as AppSchema, g as AppService, h as AttributeSchema, i as AttributeType, j as AuditFieldsSchema, C as ClientOptions, k as Column, l as ColumnSchema, m as ComparisonOperator, n as Component, o as ComponentSchema, p as ComponentService, q as CreateAppRequest, r as CreateComponentRequest, s as CreateDesignReferenceRequest, t as CreateEntityRequest, u as CreateListRequest, v as CreateListViewRequest, w as CreateMenuConfigurationRequest, x as CreatePageRequest, y as CreateVariableRequest, z as CurrencyAttributeMeta, B as CurrencyAttributeMetaSchema, D as CurrencySymbolSide, E as CurrencyValue, G as DEFAULT_OPTIONS, H as DEFAULT_PAGE_SIZE, I as DONE, J as DeployModuleRequest, K as DesignReference, M as DesignReferenceContent, N as DesignReferenceSchema, O as DesignReferenceService, Q as Done, R as Entity, S as EntitySchema, T as EntityService, V as EntityWithSchema, W as EntityWithSchemaSchema, X as FileAttributeMeta, Y as FileRefSchema, Z as FilterElement, _ as FilterElementSchema, $ as FilterGroup, a0 as FilterGroupSchema, a1 as List, a2 as ListAppsOptions, a3 as ListComponentsOptions, a4 as ListDesignReferencesOptions, a5 as ListEntitiesOptions, a6 as ListFn, a7 as ListListViewsOptions, a8 as ListListsOptions, a9 as ListMenuConfigurationsOptions, aa as ListModulesOptions, ab as ListPagesOptions, ac as ListSchema, ad as ListService, ae as ListVariablesOptions, af as ListView, ag as ListViewSchema, ah as ListViewService, ai as LogicalOperator, aj as MenuConfiguration, ak as MenuConfigurationSchema, al as MenuConfigurationService, am as MenuItem, an as MenuItemSchema, ao as MenuItemType, ap as MetaClient, aq as MetaListOptions, ar as Module, as as ModuleSchema, at as ModuleService, au as ModuleStatus, av as OnDeleteAction, aw as OnDeleteActionSchema, ax as PLATFORM_ATTRIBUTE_NAMES, ay as PLATFORM_USER_ID, az as Page, aA as PageAction, aB as PageActionSchema, aC as PageLayout, aD as PageLayoutSchema, aE as PageSchema, aF as PageService, aG as PageType, aH as PublicPageComponent, aI as PublicPageResponse, aJ as RelationAttributeMeta, aK as RelationAttributeMetaSchema, aL as RequestOptions, aM as ResolvedClientOptions, aN as ResponseMeta, aO as ResponseMetaSchema, aP as SortConfig, aQ as SortConfigSchema, aR as SortDirection, aS as Timestamps, aT as TokenProvider, aU as UpdateAppRequest, aV as UpdateComponentRequest, aW as UpdateDesignReferenceRequest, aX as UpdateEntityRequest, aY as UpdateListRequest, aZ as UpdateListViewRequest, a_ as UpdateMenuConfigurationRequest, a$ as UpdatePageRequest, b0 as UpdateVariableRequest, b1 as UserRefSchema, b2 as UserType, b3 as Variable, b4 as VariableSchema, b5 as VariableService, b6 as allCurrencyCodes, b7 as createIterator, b8 as createListResultSchema, b9 as currencyLabel, ba as currencySymbol, bb as currencySymbolSide, bc as formatAmount, bd as formatMoney, be as isPlatformAttributeName, bf as localeNumberSeparators, bg as parseAmount, bh as parseCurrencyMeta, bi as parseFileMeta, bj as parseRelationMeta, bk as platformAttributes, bl as resolveOptions } from './types-
|
|
1
|
+
import { A as AuditFields, L as ListOptions, a as Attribute, U as UserRef$2, P as PageIterator, b as ListResult, c as ProteosClient, F as FileRef, d as PublicAccessOperation } from './types-v9RkMuKf.cjs';
|
|
2
|
+
export { e as App, f as AppSchema, g as AppService, h as AttributeSchema, i as AttributeType, j as AuditFieldsSchema, C as ClientOptions, k as Column, l as ColumnSchema, m as ComparisonOperator, n as Component, o as ComponentSchema, p as ComponentService, q as CreateAppRequest, r as CreateComponentRequest, s as CreateDesignReferenceRequest, t as CreateEntityRequest, u as CreateListRequest, v as CreateListViewRequest, w as CreateMenuConfigurationRequest, x as CreatePageRequest, y as CreateVariableRequest, z as CurrencyAttributeMeta, B as CurrencyAttributeMetaSchema, D as CurrencySymbolSide, E as CurrencyValue, G as DEFAULT_OPTIONS, H as DEFAULT_PAGE_SIZE, I as DONE, J as DeployModuleRequest, K as DesignReference, M as DesignReferenceContent, N as DesignReferenceSchema, O as DesignReferenceService, Q as Done, R as Entity, S as EntitySchema, T as EntityService, V as EntityWithSchema, W as EntityWithSchemaSchema, X as FileAttributeMeta, Y as FileRefSchema, Z as FilterElement, _ as FilterElementSchema, $ as FilterGroup, a0 as FilterGroupSchema, a1 as List, a2 as ListAppsOptions, a3 as ListComponentsOptions, a4 as ListDesignReferencesOptions, a5 as ListEntitiesOptions, a6 as ListFn, a7 as ListListViewsOptions, a8 as ListListsOptions, a9 as ListMenuConfigurationsOptions, aa as ListModulesOptions, ab as ListPagesOptions, ac as ListSchema, ad as ListService, ae as ListVariablesOptions, af as ListView, ag as ListViewSchema, ah as ListViewService, ai as LogicalOperator, aj as MenuConfiguration, ak as MenuConfigurationSchema, al as MenuConfigurationService, am as MenuItem, an as MenuItemSchema, ao as MenuItemType, ap as MetaClient, aq as MetaListOptions, ar as Module, as as ModuleSchema, at as ModuleService, au as ModuleStatus, av as OnDeleteAction, aw as OnDeleteActionSchema, ax as PLATFORM_ATTRIBUTE_NAMES, ay as PLATFORM_USER_ID, az as Page, aA as PageAction, aB as PageActionSchema, aC as PageLayout, aD as PageLayoutSchema, aE as PageSchema, aF as PageService, aG as PageType, aH as PublicPageComponent, aI as PublicPageResponse, aJ as RelationAttributeMeta, aK as RelationAttributeMetaSchema, aL as RequestOptions, aM as ResolvedClientOptions, aN as ResponseMeta, aO as ResponseMetaSchema, aP as SortConfig, aQ as SortConfigSchema, aR as SortDirection, aS as Timestamps, aT as TokenProvider, aU as UpdateAppRequest, aV as UpdateComponentRequest, aW as UpdateDesignReferenceRequest, aX as UpdateEntityRequest, aY as UpdateListRequest, aZ as UpdateListViewRequest, a_ as UpdateMenuConfigurationRequest, a$ as UpdatePageRequest, b0 as UpdateVariableRequest, b1 as UserRefSchema, b2 as UserType, b3 as Variable, b4 as VariableSchema, b5 as VariableService, b6 as allCurrencyCodes, b7 as createIterator, b8 as createListResultSchema, b9 as currencyLabel, ba as currencySymbol, bb as currencySymbolSide, bc as formatAmount, bd as formatMoney, be as isPlatformAttributeName, bf as localeNumberSeparators, bg as parseAmount, bh as parseCurrencyMeta, bi as parseFileMeta, bj as parseRelationMeta, bk as platformAttributes, bl as resolveOptions } from './types-v9RkMuKf.cjs';
|
|
3
3
|
import { z } from 'zod';
|
|
4
4
|
|
|
5
5
|
/**
|
|
@@ -304,6 +304,24 @@ interface UpdateMcpServerRequest {
|
|
|
304
304
|
auth?: McpServerAuth;
|
|
305
305
|
}
|
|
306
306
|
type ListMcpServersOptions = AgentResourceListOptions;
|
|
307
|
+
/**
|
|
308
|
+
* One agent referencing a resource (MCP server / prompt / tool / skill), with its
|
|
309
|
+
* provider-sync staleness: `is_stale` means the resource changed after the agent's
|
|
310
|
+
* last successful sync (or the agent was never synced), so the runtime still runs
|
|
311
|
+
* the agent against the resource's previous configuration.
|
|
312
|
+
*/
|
|
313
|
+
interface DependentAgent {
|
|
314
|
+
agent_key: string;
|
|
315
|
+
name: string;
|
|
316
|
+
is_stale: boolean;
|
|
317
|
+
last_synced_at: string | null;
|
|
318
|
+
}
|
|
319
|
+
/** Outcome of re-syncing one stale dependent agent. */
|
|
320
|
+
interface DependentSyncResult {
|
|
321
|
+
agent_key: string;
|
|
322
|
+
status: 'synced' | 'failed';
|
|
323
|
+
error?: string;
|
|
324
|
+
}
|
|
307
325
|
|
|
308
326
|
/**
|
|
309
327
|
* Service for managing Agents — configured personas (system prompt + model
|
|
@@ -351,6 +369,16 @@ interface McpServerService {
|
|
|
351
369
|
startOAuth(key: string): Promise<StartMcpOAuthResponse>;
|
|
352
370
|
/** Drops a server's stored OAuth tokens. @throws {ProteosError} 400/404. */
|
|
353
371
|
disconnectOAuth(key: string): Promise<void>;
|
|
372
|
+
/**
|
|
373
|
+
* Lists the agents referencing this MCP server, each stamped stale when the MCP server
|
|
374
|
+
* changed after the agent's last successful runtime sync. @throws {ProteosError} 404.
|
|
375
|
+
*/
|
|
376
|
+
listDependents(key: string): Promise<DependentAgent[]>;
|
|
377
|
+
/**
|
|
378
|
+
* Re-syncs every STALE dependent agent onto the runtime (the one-click "update
|
|
379
|
+
* dependent agents" action). Returns a per-agent result. @throws {ProteosError} 404.
|
|
380
|
+
*/
|
|
381
|
+
syncDependents(key: string): Promise<DependentSyncResult[]>;
|
|
354
382
|
}
|
|
355
383
|
|
|
356
384
|
/**
|
|
@@ -375,6 +403,16 @@ interface PromptService {
|
|
|
375
403
|
listVersions(key: string): Promise<PromptVersion[]>;
|
|
376
404
|
/** Gets a specific immutable version by number. @throws {ProteosError} 404. */
|
|
377
405
|
getVersion(key: string, number: number): Promise<PromptVersion>;
|
|
406
|
+
/**
|
|
407
|
+
* Lists the agents referencing this prompt, each stamped stale when the prompt
|
|
408
|
+
* changed after the agent's last successful runtime sync. @throws {ProteosError} 404.
|
|
409
|
+
*/
|
|
410
|
+
listDependents(key: string): Promise<DependentAgent[]>;
|
|
411
|
+
/**
|
|
412
|
+
* Re-syncs every STALE dependent agent onto the runtime (the one-click "update
|
|
413
|
+
* dependent agents" action). Returns a per-agent result. @throws {ProteosError} 404.
|
|
414
|
+
*/
|
|
415
|
+
syncDependents(key: string): Promise<DependentSyncResult[]>;
|
|
378
416
|
}
|
|
379
417
|
|
|
380
418
|
/**
|
|
@@ -814,6 +852,16 @@ interface SkillService {
|
|
|
814
852
|
listVersions(key: string): Promise<SkillVersion[]>;
|
|
815
853
|
/** Gets a specific immutable version by number. @throws {ProteosError} 404. */
|
|
816
854
|
getVersion(key: string, number: number): Promise<SkillVersion>;
|
|
855
|
+
/**
|
|
856
|
+
* Lists the agents referencing this skill, each stamped stale when the skill
|
|
857
|
+
* changed after the agent's last successful runtime sync. @throws {ProteosError} 404.
|
|
858
|
+
*/
|
|
859
|
+
listDependents(key: string): Promise<DependentAgent[]>;
|
|
860
|
+
/**
|
|
861
|
+
* Re-syncs every STALE dependent agent onto the runtime (the one-click "update
|
|
862
|
+
* dependent agents" action). Returns a per-agent result. @throws {ProteosError} 404.
|
|
863
|
+
*/
|
|
864
|
+
syncDependents(key: string): Promise<DependentSyncResult[]>;
|
|
817
865
|
}
|
|
818
866
|
|
|
819
867
|
/**
|
|
@@ -833,6 +881,16 @@ interface ToolService {
|
|
|
833
881
|
update(key: string, request: UpdateToolRequest): Promise<Tool>;
|
|
834
882
|
/** Deletes a tool. @throws {ProteosError} 404. */
|
|
835
883
|
delete(key: string): Promise<void>;
|
|
884
|
+
/**
|
|
885
|
+
* Lists the agents referencing this tool, each stamped stale when the tool
|
|
886
|
+
* changed after the agent's last successful runtime sync. @throws {ProteosError} 404.
|
|
887
|
+
*/
|
|
888
|
+
listDependents(key: string): Promise<DependentAgent[]>;
|
|
889
|
+
/**
|
|
890
|
+
* Re-syncs every STALE dependent agent onto the runtime (the one-click "update
|
|
891
|
+
* dependent agents" action). Returns a per-agent result. @throws {ProteosError} 404.
|
|
892
|
+
*/
|
|
893
|
+
syncDependents(key: string): Promise<DependentSyncResult[]>;
|
|
836
894
|
}
|
|
837
895
|
|
|
838
896
|
/**
|
|
@@ -1768,7 +1826,7 @@ type ConnectionStatus$1 = 'pending' | 'active' | 'error' | 'revoked';
|
|
|
1768
1826
|
/** org-wide integration vs a single user's grant. */
|
|
1769
1827
|
type ConnectionScope$1 = 'org' | 'user';
|
|
1770
1828
|
/** How a connector authenticates. */
|
|
1771
|
-
type CredentialKind = 'oauth' | 'api_key' | 'basic' | 'bot_token';
|
|
1829
|
+
type CredentialKind = 'oauth' | 'api_key' | 'basic' | 'bot_token' | 'service_account';
|
|
1772
1830
|
interface UserRef$1 {
|
|
1773
1831
|
type: string;
|
|
1774
1832
|
id: string;
|
|
@@ -1802,6 +1860,16 @@ interface ConnectorOAuthConfig {
|
|
|
1802
1860
|
client_id_variable_key: string;
|
|
1803
1861
|
client_secret_variable_key: string;
|
|
1804
1862
|
}
|
|
1863
|
+
/**
|
|
1864
|
+
* The service-account wiring of a connector supporting the service_account
|
|
1865
|
+
* kind. Like the OAuth app credentials, the SA key is an org VARIABLE —
|
|
1866
|
+
* key_variable_key names the default; a connection may reference its own via
|
|
1867
|
+
* settings.service_account_key_variable.
|
|
1868
|
+
*/
|
|
1869
|
+
interface ConnectorServiceAccountConfig {
|
|
1870
|
+
key_variable_key: string;
|
|
1871
|
+
scopes: string[];
|
|
1872
|
+
}
|
|
1805
1873
|
/** A connector TYPE (google-calendar, a customer's vertex-tax, …). */
|
|
1806
1874
|
interface Connector {
|
|
1807
1875
|
key: string;
|
|
@@ -1810,12 +1878,21 @@ interface Connector {
|
|
|
1810
1878
|
description?: string;
|
|
1811
1879
|
icon?: string;
|
|
1812
1880
|
credential_kind: CredentialKind;
|
|
1881
|
+
/** Every kind a connection may use; absent/empty = exactly [credential_kind]. */
|
|
1882
|
+
supported_credential_kinds?: CredentialKind[];
|
|
1813
1883
|
oauth?: ConnectorOAuthConfig;
|
|
1884
|
+
service_account?: ConnectorServiceAccountConfig;
|
|
1814
1885
|
/**
|
|
1815
1886
|
* COMPUTED: the broker's per-environment OAuth callback — register it as an
|
|
1816
1887
|
* authorized redirect URI on the provider app.
|
|
1817
1888
|
*/
|
|
1818
1889
|
oauth_redirect_uri?: string;
|
|
1890
|
+
/**
|
|
1891
|
+
* COMPUTED: the environment ships platform-default OAuth app credentials
|
|
1892
|
+
* for this connector, so the connect wizard can skip collecting them.
|
|
1893
|
+
* Org variables always override the default.
|
|
1894
|
+
*/
|
|
1895
|
+
has_default_app_credentials?: boolean;
|
|
1819
1896
|
config_schema?: Attribute[];
|
|
1820
1897
|
methods: ConnectorMethod[];
|
|
1821
1898
|
origin: 'pre_built' | 'custom';
|
|
@@ -1835,6 +1912,11 @@ interface ConnectorConnection {
|
|
|
1835
1912
|
scope: ConnectionScope$1;
|
|
1836
1913
|
owner?: UserRef$1;
|
|
1837
1914
|
external_account_id: string;
|
|
1915
|
+
/** Redacted {kind, data} credential envelope — secrets are masked; use kind to tell how the connection authenticates. */
|
|
1916
|
+
credentials?: {
|
|
1917
|
+
kind: CredentialKind;
|
|
1918
|
+
data?: Record<string, unknown>;
|
|
1919
|
+
};
|
|
1838
1920
|
settings: Record<string, unknown>;
|
|
1839
1921
|
status: ConnectionStatus$1;
|
|
1840
1922
|
status_detail?: string;
|
|
@@ -1955,7 +2037,7 @@ type Channel = 'slack' | 'email' | 'linkedin' | 'sms' | 'teams-chat' | 'telegram
|
|
|
1955
2037
|
* meeting-bot family: adhoc-meeting dispatches by meeting URL; the calendar
|
|
1956
2038
|
* keys auto-join through a user's connected calendar.
|
|
1957
2039
|
*/
|
|
1958
|
-
type ConnectorKey = 'slack' | 'gmail' | 'echo' | 'unipile-whatsapp' | 'unipile-linkedin' | 'unipile-telegram' | 'unipile-instagram' | 'unipile-messenger' | 'unipile-x' | 'adhoc-meeting' | 'google-calendar-meeting' | 'microsoft-calendar-meeting';
|
|
2040
|
+
type ConnectorKey = 'slack' | 'gmail' | 'outlook' | 'echo' | 'unipile-whatsapp' | 'unipile-linkedin' | 'unipile-telegram' | 'unipile-instagram' | 'unipile-messenger' | 'unipile-x' | 'adhoc-meeting' | 'google-calendar-meeting' | 'microsoft-calendar-meeting';
|
|
1959
2041
|
/**
|
|
1960
2042
|
* Who operates the integration mechanics behind a connector: Proteos' own
|
|
1961
2043
|
* integration (native), an account aggregated through Unipile (unipile), or
|
|
@@ -1976,6 +2058,15 @@ type ConnectionStatus = 'pending' | 'active' | 'error' | 'revoked';
|
|
|
1976
2058
|
* drafting) — hidden from the default list until the first successful send.
|
|
1977
2059
|
*/
|
|
1978
2060
|
type ConversationStatus = 'active' | 'ended' | 'archived' | 'draft';
|
|
2061
|
+
/**
|
|
2062
|
+
* Generation lifecycle of a conversation's `summary`. `none` is the resting
|
|
2063
|
+
* default — no summary exists and none is being produced, the state of every
|
|
2064
|
+
* conversation that is not a transcript-backed meeting. `processing` is claimed
|
|
2065
|
+
* for the duration of one generation run (automatic at transcript attach, or a
|
|
2066
|
+
* manual `meetings.summarize()`), so any client can render "Summarizing…"
|
|
2067
|
+
* without having started the run itself.
|
|
2068
|
+
*/
|
|
2069
|
+
type ConversationSummaryStatus = 'none' | 'processing' | 'completed' | 'failed';
|
|
1979
2070
|
type AgentListenerTriggerType = 'always' | 'mention' | 'channel' | 'keyword';
|
|
1980
2071
|
interface UserRef {
|
|
1981
2072
|
type: string;
|
|
@@ -2098,6 +2189,16 @@ interface Conversation {
|
|
|
2098
2189
|
* conversations, editable via update(). Absent when no summary exists.
|
|
2099
2190
|
*/
|
|
2100
2191
|
summary?: string;
|
|
2192
|
+
/**
|
|
2193
|
+
* Generation lifecycle of `summary`. Poll `conversations.get(id)` while this
|
|
2194
|
+
* reads `processing` to pick up the finished summary.
|
|
2195
|
+
*/
|
|
2196
|
+
summary_status: ConversationSummaryStatus;
|
|
2197
|
+
/**
|
|
2198
|
+
* When the current `processing` run was claimed; absent otherwise. Bounds the
|
|
2199
|
+
* claim server-side and gives clients an elapsed time to show.
|
|
2200
|
+
*/
|
|
2201
|
+
summary_started_at?: string;
|
|
2101
2202
|
status: ConversationStatus;
|
|
2102
2203
|
/**
|
|
2103
2204
|
* Room directory row a room-borne thread (Slack channel conversation) lives
|
|
@@ -2920,10 +3021,17 @@ interface MeetingService {
|
|
|
2920
3021
|
/** Make the bot leave the meeting and end the conversation (by conversation id). */
|
|
2921
3022
|
remove(conversationId: string): Promise<Conversation>;
|
|
2922
3023
|
/**
|
|
2923
|
-
*
|
|
2924
|
-
* transcript, overwriting any existing one
|
|
2925
|
-
*
|
|
2926
|
-
* conversation
|
|
3024
|
+
* START regenerating this meeting conversation's markdown summary from its
|
|
3025
|
+
* stored transcript, overwriting any existing one when it lands. Generation
|
|
3026
|
+
* runs server-side beyond this request, so the promise resolves as soon as the
|
|
3027
|
+
* conversation is CLAIMED — with `summary_status: 'processing'` and the OLD
|
|
3028
|
+
* `summary` still attached. Poll `conversations.get(id)` until
|
|
3029
|
+
* `summary_status` is `completed` (or `failed`) to read the new one.
|
|
3030
|
+
*
|
|
3031
|
+
* Rejects with `no_transcript` when the conversation has no completed
|
|
3032
|
+
* transcript to summarize, `summarization_unavailable` when the environment
|
|
3033
|
+
* has no generator configured, and `summary_in_progress` when a generation is
|
|
3034
|
+
* already running for this conversation.
|
|
2927
3035
|
*/
|
|
2928
3036
|
summarize(conversationId: string): Promise<Conversation>;
|
|
2929
3037
|
}
|
|
@@ -5223,7 +5331,9 @@ type NodeRuntime = 'go' | 'wasm' | 'intrinsic';
|
|
|
5223
5331
|
/** Coarse catalog grouping of a node type. */
|
|
5224
5332
|
type NodeGroup = 'trigger' | 'action' | 'transform' | 'flow';
|
|
5225
5333
|
/** Control type of one descriptor property (n8n INodeProperties paradigm). */
|
|
5226
|
-
type PropertyType = 'string' | 'number' | 'boolean' | 'options' | 'multi_options' | 'json' | 'date_time' | 'color' | 'notice' | 'hidden' | 'collection' | 'fixed_collection' | 'credentials_select' | 'button'
|
|
5334
|
+
type PropertyType = 'string' | 'number' | 'boolean' | 'options' | 'multi_options' | 'json' | 'date_time' | 'color' | 'notice' | 'hidden' | 'collection' | 'fixed_collection' | 'credentials_select' | 'button'
|
|
5335
|
+
/** Edits a platform attribute list (`Attribute[]`) via the shared attribute schema builder. */
|
|
5336
|
+
| 'attribute_schema' | 'resource_locator' | 'resource_mapper' | 'filter' | 'assignment_collection';
|
|
5227
5337
|
/**
|
|
5228
5338
|
* One named input or output port. Port keys are stable identifiers referenced
|
|
5229
5339
|
* by connections (never indexes).
|
|
@@ -5384,45 +5494,35 @@ interface MessageTriggerParams {
|
|
|
5384
5494
|
}
|
|
5385
5495
|
type KickoffType = 'message' | 'outcome';
|
|
5386
5496
|
/**
|
|
5387
|
-
* Where a kickoff draws its instruction text from: typed inline
|
|
5388
|
-
* resolved from a reusable agent-service Prompt by key
|
|
5497
|
+
* Where a kickoff slot draws its instruction text from: typed inline
|
|
5498
|
+
* (`manual`) or resolved from a reusable agent-service Prompt by key
|
|
5499
|
+
* (`prompt`) at run time.
|
|
5389
5500
|
*/
|
|
5390
5501
|
type KickoffSource = 'manual' | 'prompt';
|
|
5391
|
-
|
|
5392
|
-
|
|
5393
|
-
|
|
5394
|
-
|
|
5395
|
-
|
|
5396
|
-
|
|
5397
|
-
|
|
5398
|
-
|
|
5399
|
-
|
|
5400
|
-
|
|
5401
|
-
|
|
5402
|
-
|
|
5403
|
-
|
|
5404
|
-
type: 'text' | 'file';
|
|
5405
|
-
content?: string;
|
|
5406
|
-
file_id?: string;
|
|
5407
|
-
}
|
|
5408
|
-
interface OutcomeKickoff {
|
|
5409
|
-
/** Description and rubric are independently sourced (manual vs prompt). */
|
|
5502
|
+
/**
|
|
5503
|
+
* Flat, descriptor-driven parameters of the `action.agent` node (gated by
|
|
5504
|
+
* display_options on `kickoff_type` / `*_source`). `output_schema` declares
|
|
5505
|
+
* the node's structured output as platform attributes — the agent records it
|
|
5506
|
+
* via the session-scoped `set_output` tool; `is_output_required` fails the
|
|
5507
|
+
* node when the agent finishes without setting it.
|
|
5508
|
+
*/
|
|
5509
|
+
interface AgentActionParams {
|
|
5510
|
+
agent_key: string;
|
|
5511
|
+
kickoff_type: KickoffType;
|
|
5512
|
+
message_source?: KickoffSource;
|
|
5513
|
+
message_text?: string;
|
|
5514
|
+
message_prompt_key?: string;
|
|
5410
5515
|
description_source?: KickoffSource;
|
|
5411
5516
|
description?: string;
|
|
5412
5517
|
description_prompt_key?: string;
|
|
5413
5518
|
rubric_source?: KickoffSource;
|
|
5414
|
-
|
|
5519
|
+
rubric_type?: 'text' | 'file';
|
|
5520
|
+
rubric_content?: string;
|
|
5521
|
+
rubric_file_id?: string;
|
|
5415
5522
|
rubric_prompt_key?: string;
|
|
5416
5523
|
max_iterations?: number;
|
|
5417
|
-
|
|
5418
|
-
|
|
5419
|
-
type: KickoffType;
|
|
5420
|
-
message?: MessageKickoff;
|
|
5421
|
-
outcome?: OutcomeKickoff;
|
|
5422
|
-
}
|
|
5423
|
-
interface AgentActionParams {
|
|
5424
|
-
agent_key: string;
|
|
5425
|
-
kickoff: AgentKickoff;
|
|
5524
|
+
output_schema?: Attribute[];
|
|
5525
|
+
is_output_required?: boolean;
|
|
5426
5526
|
}
|
|
5427
5527
|
interface Workflow extends AuditFields {
|
|
5428
5528
|
org_id: string;
|
|
@@ -5747,4 +5847,4 @@ declare class WorkflowClient {
|
|
|
5747
5847
|
constructor(client: ProteosClient);
|
|
5748
5848
|
}
|
|
5749
5849
|
|
|
5750
|
-
export { AccountClient, type Action, type ActionBinding, ActionSchema, type ActionScope, ActionScopeSchema, type ActionService, type AddressFilterConfig, type Agent, type AgentActionParams, type AgentArtifactsPayload, AgentClient, type
|
|
5850
|
+
export { AccountClient, type Action, type ActionBinding, ActionSchema, type ActionScope, ActionScopeSchema, type ActionService, type AddressFilterConfig, type Agent, type AgentActionParams, type AgentArtifactsPayload, AgentClient, type AgentListener, type AgentListenerService, type AgentListenerTriggerType, type AgentMessagePayload, type AgentResourceListOptions, type AgentService, type AllFilterConfig, type ApiErrorResponse, type AppendEventRequest, type AssignPermissionRequest, type AssignRoleRequest, type AttachContactAddressRequest, type Attachment, Attribute, AuditFields, type AuthListOptions, type AutomatedFilterConfig, type AutomatedSignal, type BatchTransactionError, BatchTransactionErrorSchema, type BatchTransactionStatus, type BatchUpsertRecordsResponse, BatchUpsertRecordsResponseSchema, type BatchUpsertTransaction, type BatchUpsertTransactionResult, BatchUpsertTransactionResultSchema, BatchUpsertTransactionSchema, type BinaryRef, type BlockContactRequest, type Channel, type ClientEventType, type ClientToolSchema, type Connection, type ConnectionCredentials, type ConnectionEndpoint, type ConnectionScope, type ConnectionService, type ConnectionStatus, type Connector, ConnectorClient, type ConnectorConnection, type ConnectionScope$1 as ConnectorConnectionScope, type ConnectionStatus$1 as ConnectorConnectionStatus, type ConnectionTokenResponse as ConnectorConnectionTokenResponse, type CredentialKind as ConnectorCredentialKind, type ConnectorKey, type ConnectorMethod, type ConnectorProvider, type ConsentStatus, type ConsumerGroup, type Contact, type ContactAddress, type ContactAddressKind, type ContactAddressSource, type ContactErasureRequest, type ContactMergeProposal, type ContactRef, type ContactService, type ContactSource, type ContactStatus, type ContentBlock$1 as ContentBlock, type ContentMatch, type ContentResponse, type ContextCompactedPayload, type Conversation, ConversationClient, type ConversationFilter, type ConversationFilterAction, type ConversationFilterConfig, type ConversationFilterEvent, type ConversationFilterService, type ConversationFilterType, type ConversationParticipant, type ConversationService, type ConversationStatus, type ConversationSummaryStatus, type CreateAgentListenerRequest, type CreateAgentRequest, type CreateConnectionRequest, type CreateConnectorConnectionRequest, type CreateConversationFilterRequest, type CreateFileMetadata, type CreateGlossaryTermRequest, type CreateLabelRequest, type CreateLinkRequest, type CreateMcpServerRequest, type CreateNodeRequest, type CreateOrganizationRequest, type CreatePromptRequest, type CreateRecordLinkRequest, type CreateRoleRequest, type CreateSessionRequest, type CreateToolRequest, type CreateUserRequest, type CreateWorkflowRequest, type CredentialSpec, type CronTriggerParams, DEFAULT_PORT, DataClient, type DependentAgent, type DependentSyncResult, type DispatchMeetingBotRequest, type DisplayOptions, type DomainFilterConfig, ERROR_PORT, type EditContentRequest, type EditContentResponse, type EmptyPayload, type ErasureRequestStatus, ErrorCode, type ErrorCodeType, type ErrorPayload, type EventTriggerParams, type EventType, type EventVerb, EventsClient, type ExecutionError, type ExecutionStatus, type ExecutionTriggerContext, type FileBlock, FileRef, type FileService, type FileVersionContent, type FilterMatchOn, FunctionsClient, type GetExecutionDetailResponse, type GetGraphOptions, type GetNodeExecutionItemsOptions, type GetNodeExecutionItemsResponse, type GetNodeTypesResponse, type GlossaryTerm, type GlossaryTermService, type GraphService, type InlineLinkRequest, type InstallConnectionResponse, type InstallConnectorConnectionResponse, type InternalConversationsFilterConfig, type InvokeActionResponse, type InvokeNodeMethodRequest, type InvokeNodeMethodResponse, type Item, type KickoffSource, type KickoffType, KnowledgeClient, type KnowledgeGraph, type KnowledgeGraphLink, type KnowledgeGraphNode, type KnowledgeLabel, KnowledgeLabelSchema, type KnowledgeLink, KnowledgeLinkSchema, type KnowledgeNode, type KnowledgeNodeLabel, KnowledgeNodeLabelSchema, type KnowledgeNodeMetadata, KnowledgeNodeMetadataSchema, KnowledgeNodeSchema, type KnowledgeNodeSearchResult, KnowledgeNodeSearchResultSchema, type KnowledgeRecordLink, KnowledgeRecordLinkSchema, type LabelService, type LinkService, type LinkType, type ListActionsOptions, type ListAgentListenersQuery, type ListAgentsOptions, type ListConnectionsQuery, type ListConnectorConnectionsQuery, type ListConnectorsQuery, type ListContactAddressesQuery, type ListContactMergeProposalsQuery, type ListContactsQuery, type ListConversationFilterEventsQuery, type ListConversationFiltersQuery, type ListConversationsQuery, type ListEventsOptions, type ListExecutionsOptions, type ListGlossaryTermsQuery, type ListLabelsOptions, type ListLinksOptions, type ListMcpServersOptions, type ListMessagesQuery, type ListNodesOptions, ListOptions, type ListOrganizationsOptions, type ListPromptsOptions, type ListRecordLinksOptions, type ListRecordsOptions, type ListResponse, ListResult, type ListRolePermissionsOptions, type ListRolesOptions, type ListRoomsQuery, type ListSessionsOptions, type ListSkillsOptions, type ListToolsOptions, type ListUserRoleAssignmentsOptions, type ListUsersOptions, type ListWorkflowsOptions, type ManualTriggerParams, type MatchMode, type McpBinding, type McpConnectionState, type McpConnectionStatus, type McpServer, type McpServerAuth, type McpServerOAuth, type McpServerService, type McpToolSummary, type MeService, type MeetingService, type MergeContactsRequest, type MergeProposalStatus, type Message, type ContentBlock as MessageContentBlock, type MessageDirection, type MessagePreview, type MessageRecipient, type MessageService, type MessageStatus, type MessageTriggerParams, type ModelConfig, type ModelRequestEndPayload, type ModelRequestStartPayload, type ModelUsage, type NeighborDirection, type NeighborEdge, type NeighborNode, type NeighborsOptions, type NodeContentMatches, type NodeDescriptor, type NodeExecution, type NodeGroup, type NodeMethodOption, type NodeNeighborhood, NodeNeighborhoodSchema, type NodeOutline, type NodePosition, type NodeProperty, type NodeRetryPolicy, type NodeRuntime, type NodeService, type NodeStatus, type NodeType, type NodeTypeKey, type NodeTypeService, type NodeTypeStatus, type OnErrorPolicy, type Organization, OrganizationSchema, type OrganizationService, type OutlineHeading, type OutlineRequest, type OutlineResponse, PLATFORM_ENTITIES, PLATFORM_ENTITY_SLUGS, PageIterator, type PairedItem, type ParseStatus, type Permission, type PermissionEventSource, type PermissionEventType, type PlatformEntity, type PlatformEvent, type PortSpec, type Prompt, type PromptService, type PromptVersion, type PropertyOption, type PropertyType, ProteosClient, ProteosError, PublicAccessOperation, type PublishEventRequest, type QueryExecuteMeta, type QueryExecuteResponse, type QueryObject, type QueryRow, type QueryService, type QueryValidateMeta, type QueryValidateResponse, type QueryValue, type Reaction, type ReactionCapability, type ReactionOption, type ReactionSetKind, type ReasoningPayload, type RecipientKind, type RecipientRole, type RecordData, type RecordLinkService, type RecordPermissionEventRequest, type RecordService, type RedriveResult, type ResultBlock, type Role, type RoleBasedFilterConfig, type RoleEntityPermission, RoleEntityPermissionSchema, RoleSchema, type RoleService, type Room, type RunWorkflowRequest, type SearchContentRequest, type SearchContentResponse, type SearchNodesRequest, type SendMessageRequest, type SendRecipient, type Session, type SessionEvent, type SessionEventEnvelope, type SessionEventsOptions, type SessionIdlePayload, type SessionService, type SessionStatus, type SessionStreamOptions, type SessionUpdatedPayload, type Skill, type SkillBundle, type SkillService, type SkillVersion, type StartMcpOAuthResponse, type StopReason, StorageClient, type StorageFile, type StorageFileVersion, type TailOptions, type TestNodeCandidate, type TestNodeInputSource, type TestNodeRequest, type TestNodeResponse, type TextBlock, type Tool, type ToolBinding, type ToolConfirmationPayload, type ToolKind, type ToolResultPayload, type ToolService, type ToolUsePayload, type Topic, type TopicKind, type TopicService, type TranscribeStreamOptions, type TranscriptResult, type TriggerKind, type Turn, type UnreadCounts, type UpdateAgentListenerRequest, type UpdateAgentRequest, type UpdateConnectionRequest, type UpdateConnectorConnectionRequest, type UpdateContactRequest, type UpdateConversationFilterRequest, type UpdateDraftRequest, type UpdateFileMetadata, type UpdateGlossaryTermRequest, type UpdateLabelRequest, type UpdateLinkRequest, type UpdateMcpServerRequest, type UpdateNodeRequest, type UpdateOrganizationRequest, type UpdatePromptRequest, type UpdateRoleRequest, type UpdateToolRequest, type UpdateUserRequest, type UpdateWorkflowRequest, type User, type UserMessagePayload, UserRef$2 as UserRef, type UserRoleAssignment, UserRoleAssignmentSchema, UserSchema, type UserService, type VoiceService, type VoiceTranscriptionStream, type WebhookTriggerParams, type Workflow, WorkflowClient, type WorkflowConnection, type WorkflowExecution, type WorkflowGraph, type WorkflowNode, type WorkflowNodeType, type WorkflowStatus, type WorkflowVersion, type WorkflowVersionAuthor, type WorkflowVersionSummary, type WriteContentResponse, type WriteCredentialsRequest, buildUrl, getDefaultErrorCode, isBadRequest, isConflict, isForbidden, isNotFound, isPlatformEntity, isProteosError, isUnauthorized, parseErrorResponse, toQueryParams, toQueryString };
|