@vertesia/appgen-docs 1.5.0-dev.20260807.073259Z → 1.5.0-dev.20260901.005903Z
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/lib/docs/interaction-runtime.md +47 -0
- package/lib/docs/package-types.md +1 -0
- package/lib/docs/store-objects.md +4 -0
- package/lib/docs/ui-interfaces.d.ts +16 -1
- package/lib/docs/vertesia-client.d.ts +306 -822
- package/lib/docs/vertesia-common.d.ts +200 -1267
- package/package.json +6 -6
|
@@ -10,8 +10,8 @@
|
|
|
10
10
|
// -----------------------------------------------------------------------------
|
|
11
11
|
// @vertesia/common: index.d.ts
|
|
12
12
|
// -----------------------------------------------------------------------------
|
|
13
|
+
export type { VertexAIGeminiOmniVideoOptions, VideoResult } from '@llumiverse/common';
|
|
13
14
|
export * from './access-control.js';
|
|
14
|
-
export * from './agent-request-template.js';
|
|
15
15
|
export * from './analytics.js';
|
|
16
16
|
/**
|
|
17
17
|
* Schema-derived API types. MUST stay `export type` — tsc erases it, so `lib/index.js` never
|
|
@@ -25,15 +25,15 @@ export * from './apps.js';
|
|
|
25
25
|
export * from './ask-user.js';
|
|
26
26
|
export * from './audit-trail.js';
|
|
27
27
|
export * from './browser-credentials.js';
|
|
28
|
-
export * from './channels.js';
|
|
29
28
|
export * from './common.js';
|
|
29
|
+
export * from './content-query.js';
|
|
30
30
|
export * from './cost-analytics.js';
|
|
31
31
|
export * from './data-platform.js';
|
|
32
|
+
export * from './email.js';
|
|
32
33
|
export * from './embeddings.js';
|
|
33
34
|
export * from './environment.js';
|
|
34
35
|
export * from './facets.js';
|
|
35
36
|
export * from './group.js';
|
|
36
|
-
export * from './host-utils.js';
|
|
37
37
|
export * from './integrations.js';
|
|
38
38
|
export * from './interaction.js';
|
|
39
39
|
export * from './json.js';
|
|
@@ -43,11 +43,9 @@ export * from './model_utility.js';
|
|
|
43
43
|
export * from './oauth.js';
|
|
44
44
|
export * from './oauth-scopes.js';
|
|
45
45
|
export * from './oauth-server.js';
|
|
46
|
-
export * from './Progress.js';
|
|
47
46
|
export * from './payload.js';
|
|
48
47
|
export * from './pending-asks.js';
|
|
49
48
|
export * from './platform-event.js';
|
|
50
|
-
export * from './platform-event-validation.js';
|
|
51
49
|
export * from './principal-context.js';
|
|
52
50
|
export * from './project.js';
|
|
53
51
|
export * from './prompt.js';
|
|
@@ -73,20 +71,15 @@ export * from './utils/auth.js';
|
|
|
73
71
|
export * from './utils/schemas.js';
|
|
74
72
|
export type * from './utils/type-helpers.js';
|
|
75
73
|
export * from './versions.js';
|
|
76
|
-
export * from './view-configuration-validation.js';
|
|
77
|
-
export * from './view-query-validation.js';
|
|
78
|
-
export * from './view-validation-helpers.js';
|
|
79
74
|
export * from './views.js';
|
|
80
|
-
export * from './views-schema.js';
|
|
81
|
-
export { type AppViewExperienceId, parseAppViewExperienceId, type ViewValidationIssue, validateViewExperienceId, } from './views-validation.js';
|
|
82
75
|
export * from './workflow-analytics.js';
|
|
83
76
|
|
|
84
77
|
// -----------------------------------------------------------------------------
|
|
85
78
|
// @vertesia/common: apps.d.ts
|
|
86
79
|
// -----------------------------------------------------------------------------
|
|
87
80
|
import type { z } from 'zod';
|
|
88
|
-
import type { AgentToolApprovalClassSchema, AgentToolDefinitionSchema, AppApiKeyCollectionParamsSchema, AppBuildProgressSchema, AppBuildProgressStatusSchema, AppBuildTriggerSchema, AppDeleteSummarySchema, AppDevelopmentTaskDetailsSchema, AppDevelopmentTaskListSchema, AppDevelopmentTaskSchema, AppInspectionCapabilityReportSchema, AppInspectionIssueSchema, AppInspectionResultSchema, AppInstallationKindSchema, AppInstallationOAuthBindingSchema, AppInstallationPayloadSchema, AppInstallationProjectsQuerySchema, AppInstallationProviderBindingSchema, AppInstallationsQuerySchema, AppOAuthCollectionParamsSchema, AppOAuthProviderParamsSchema, AppRepoBranchSchema, AppRepoCommitSchema, AppRepoCommitsSchema, AppRepoDocumentCommitSchema, AppRepoRefSchema, AppRepoRefsSchema, AppRepoTreeEntrySchema, AppRepoTreeSchema, AppScaffoldModuleSchema, AppScaffoldProgressSchema, AppScaffoldProgressStatusSchema, AppToolCollectionSchema, AppVersionGitRefTypeSchema, AppVersionGitSourceSchema, AppVersionKindSchema, AppVersionRecordSchema, AppVersionStateSchema, AppVersionStorageSchema, AppVersionTargetSchema, AppVersionUrlsSchema, DeleteAppVersionResponseSchema, McpApiKeyCredentialSchema, OAuthClientCredentialsSchema, StartAppBuildRequestSchema, StartAppBuildResponseSchema, StartAppScaffoldRequestSchema, StartAppScaffoldResponseSchema, UpdateAppInstallationToolAllowlistPayloadSchema, UpsertAppVersionRequestSchema, ValidateUrlRequestSchema, ValidateUrlResponseSchema } from './api-schemas/app-lifecycle.js';
|
|
89
|
-
import type { AppEventHookDeliverySchema, AppEventHookPayloadSchema, AppEventSubscriptionDefinitionSchema, AppInstallationListEntrySchema, AppInstallationSchema, AppInstallationWithManifestSchema, AppManifestDataSchema, AppManifestSchema, AppPackageEventHookSchema, AppPackageHooksSchema, AppPackageSchema, AppWidgetInfoSchema, CompositeAppCardOverridesSchema, CompositeAppConfigPayloadSchema, CompositeAppConfigSchema, CompositeAppEntrySchema, CompositeAppHeaderItemKindSchema, CompositeAppHeaderItemSchema, CompositeAppHeaderItemTargetSchema, CompositeAppHeaderOverridesSchema, CompositeAppHomePluginSchema, CompositeAppLogoOverridesSchema, CompositeAppMenuSectionSchema, CompositeAppMessageOverridesSchema, CompositeAppMessageStyleSchema, CompositeAppNavItemPermissionsSchema, CompositeAppSidebarOverridesSchema, CompositeAppSwitchersOverridesSchema, CompositeAppThemeOverridesSchema, CompositeAppUserMenuOverridesSchema, PromoteAppVersionResponseSchema } from './api-schemas/app-runtime.js';
|
|
81
|
+
import type { AgentToolApprovalClassSchema, AgentToolDefinitionSchema, AppApiKeyCollectionParamsSchema, AppBuildProgressSchema, AppBuildProgressStatusSchema, AppBuildTriggerSchema, AppDeleteSummarySchema, AppDevelopmentTaskDetailsSchema, AppDevelopmentTaskListSchema, AppDevelopmentTaskSchema, AppInspectionCapabilityReportSchema, AppInspectionIssueSchema, AppInspectionResultSchema, AppInstallationKindSchema, AppInstallationOAuthBindingSchema, AppInstallationPayloadSchema, AppInstallationProjectsQuerySchema, AppInstallationProviderBindingSchema, AppInstallationsQuerySchema, AppListScopeSchema, AppOAuthCollectionParamsSchema, AppOAuthProviderParamsSchema, AppRepoBranchSchema, AppRepoCommitSchema, AppRepoCommitsSchema, AppRepoDocumentCommitSchema, AppRepoRefSchema, AppRepoRefsSchema, AppRepoTreeEntrySchema, AppRepoTreeSchema, AppScaffoldModuleSchema, AppScaffoldProgressSchema, AppScaffoldProgressStatusSchema, AppsQuerySchema, AppToolCollectionSchema, AppVersionGitRefTypeSchema, AppVersionGitSourceSchema, AppVersionKindSchema, AppVersionRecordSchema, AppVersionStateSchema, AppVersionStorageSchema, AppVersionTargetSchema, AppVersionUrlsSchema, DeleteAppVersionResponseSchema, McpApiKeyCredentialSchema, OAuthClientCredentialsSchema, StartAppBuildRequestSchema, StartAppBuildResponseSchema, StartAppDevelopmentTaskRequestSchema, StartAppScaffoldRequestSchema, StartAppScaffoldResponseSchema, UpdateAppInstallationToolAllowlistPayloadSchema, UpsertAppVersionRequestSchema, ValidateUrlRequestSchema, ValidateUrlResponseSchema } from './api-schemas/app-lifecycle.js';
|
|
82
|
+
import type { AppEventHookDeliverySchema, AppEventHookPayloadSchema, AppEventSubscriptionDefinitionSchema, AppInstallationListEntrySchema, AppInstallationSchema, AppInstallationWithManifestSchema, AppManifestDataSchema, AppManifestSchema, AppPackageEventHookSchema, AppPackageHooksSchema, AppPackageSchema, AppWidgetInfoSchema, CompositeAppCardOverridesSchema, CompositeAppConfigPayloadSchema, CompositeAppConfigSchema, CompositeAppEntrySchema, CompositeAppHeaderItemKindSchema, CompositeAppHeaderItemSchema, CompositeAppHeaderItemTargetSchema, CompositeAppHeaderOverridesSchema, CompositeAppHomePluginSchema, CompositeAppLogoOverridesSchema, CompositeAppMenuSectionSchema, CompositeAppMessageOverridesSchema, CompositeAppMessageStyleSchema, CompositeAppNavItemPermissionsSchema, CompositeAppSidebarOverridesSchema, CompositeAppSwitchersOverridesSchema, CompositeAppThemeOverridesSchema, CompositeAppUserMenuOverridesSchema, PromoteAppVersionResponseSchema, UpdateAppPayloadSchema } from './api-schemas/app-runtime.js';
|
|
90
83
|
import type { AppAccessControlSchema, AppAvailableInSchema, AppCapabilitiesSchema, AppGitSourceConfigSchema, AppManifestSourceSchema, AppSourceConfigSchema, AppUIConfigSchema, MCPApiKeyConfigSchema, MCPOAuthConfigSchema, MCPToolAnnotationsSchema, MCPToolCollectionObjectSchema, McpApiKeyStatusSchema, McpOAuthConnectResponseSchema, McpOAuthDisconnectResponseSchema, McpOAuthTokenRequestSchema, McpOAuthTokenResponseSchema, OAuthAuthorizeResponseSchema, OAuthAuthStatusSchema, OAuthMetadataResponseSchema, SetMcpApiKeyRequestSchema, ToolCollectionAuthTypeSchema, ToolCollectionObjectSchema, VertesiaSDKToolCollectionObjectSchema } from './api-schemas/apps.js';
|
|
91
84
|
import type { RemoteActivityDefinitionSchema } from './api-schemas/integrations.js';
|
|
92
85
|
import type { ProjectToolInfoSchema, RenderingTemplateDefinitionRefSchema, RenderingTemplateDefinitionSchema } from './api-schemas/project.js';
|
|
@@ -121,29 +114,15 @@ export interface AppUINavItem {
|
|
|
121
114
|
export type AppUIConfig = z.infer<typeof AppUIConfigSchema>;
|
|
122
115
|
export type AppInstallationProjectsQuery = z.infer<typeof AppInstallationProjectsQuerySchema>;
|
|
123
116
|
export type AppInstallationsQuery = z.infer<typeof AppInstallationsQuerySchema>;
|
|
117
|
+
export type AppListScope = z.infer<typeof AppListScopeSchema>;
|
|
118
|
+
export type AppsQuery = z.infer<typeof AppsQuerySchema>;
|
|
124
119
|
export type ToolCollectionAuthType = z.infer<typeof ToolCollectionAuthTypeSchema>;
|
|
125
|
-
/**
|
|
126
|
-
* Tool collection type
|
|
127
|
-
*/
|
|
128
|
-
export type ToolCollectionType = 'mcp' | 'vertesia_sdk';
|
|
129
120
|
export type MCPOAuthConfig = z.infer<typeof MCPOAuthConfigSchema>;
|
|
130
121
|
/** Install-time provisioning blueprint for an `auth: 'api_key'` MCP collection. Never holds the key. */
|
|
131
122
|
export type MCPApiKeyConfig = z.infer<typeof MCPApiKeyConfigSchema>;
|
|
132
123
|
export type MCPToolCollectionObject = z.infer<typeof MCPToolCollectionObjectSchema>;
|
|
133
124
|
export type VertesiaSDKToolCollectionObject = z.infer<typeof VertesiaSDKToolCollectionObjectSchema>;
|
|
134
125
|
export type ToolCollectionObject = z.infer<typeof ToolCollectionObjectSchema>;
|
|
135
|
-
/**
|
|
136
|
-
* Backward-compatible TypeScript alias. Public API payloads should reference
|
|
137
|
-
* ToolCollectionObject directly so generated clients do not create a wrapper
|
|
138
|
-
* model around the discriminated union.
|
|
139
|
-
*/
|
|
140
|
-
export type ToolCollection = ToolCollectionObject;
|
|
141
|
-
export declare const MCP_COLLECTION_ID_PATTERN: RegExp;
|
|
142
|
-
export declare const MCP_COLLECTION_NAMESPACE_PATTERN: RegExp;
|
|
143
|
-
export declare function isValidMCPCollectionId(id: string): boolean;
|
|
144
|
-
export declare function isValidMCPCollectionNamespace(namespace: string): boolean;
|
|
145
|
-
export declare function deriveMCPCollectionId(input: string): string;
|
|
146
|
-
export declare function getDefaultOAuthAppNameForCollectionId(collectionId: string): string;
|
|
147
126
|
/**
|
|
148
127
|
* Normalizes a tool collection to the object format.
|
|
149
128
|
* Applies optional `{{var}}` substitution to the URL so manifests can reference
|
|
@@ -189,77 +168,6 @@ export type AppCapabilities = z.infer<typeof AppCapabilitiesSchema>;
|
|
|
189
168
|
* Resolution-time only; never persisted. Set by the generated app template via client.withAppVersion.
|
|
190
169
|
*/
|
|
191
170
|
export declare const APP_VERSION_HEADER = "x-vertesia-app-version";
|
|
192
|
-
/**
|
|
193
|
-
* The platform-artifact types an app build can be required to create. A finer-grained
|
|
194
|
-
* counterpart to {@link AppCapabilities}: a single `interactions` capability may comprise
|
|
195
|
-
* several `interaction` artifacts plus `agent`, `activity`, and `tool` artifacts that
|
|
196
|
-
* {@link AppCapabilities} folds together. Used by the App Solution Architect manifest and
|
|
197
|
-
* the publish-time capability gate.
|
|
198
|
-
*/
|
|
199
|
-
export declare const APP_ARTIFACT_TYPES: readonly ['interaction', 'agent', 'type', 'process', 'view', 'template', 'dashboard', 'activity', 'tool', 'hook', 'subscription'];
|
|
200
|
-
export type AppArtifactType = (typeof APP_ARTIFACT_TYPES)[number];
|
|
201
|
-
/**
|
|
202
|
-
* A single platform artifact the App Solution Architect requires the build to create.
|
|
203
|
-
* `id` is the app-owned in-code id the implementation must register and reference
|
|
204
|
-
* (e.g. `app:<name>:main:extract-item` for interactions/agents, `app:<name>:<type>` for
|
|
205
|
-
* types, `app:<name>:<process>` for processes, and `app:<name>:<local-id>` for hooks/subscriptions).
|
|
206
|
-
*/
|
|
207
|
-
/**
|
|
208
|
-
* Build progress for one artifact, maintained by the developer agent as a living checklist:
|
|
209
|
-
* - `pending` — defined by the architect, not yet built.
|
|
210
|
-
* - `built` — registered in the package, not yet successfully exercised.
|
|
211
|
-
* - `done` — built AND successfully exercised against real data.
|
|
212
|
-
* This is the agent's self-reported claim for tracking/handoff; the capability gate verifies
|
|
213
|
-
* the truth independently via package registration + run/data telemetry and does not trust it.
|
|
214
|
-
*/
|
|
215
|
-
export type AppArtifactStatus = 'pending' | 'built' | 'done';
|
|
216
|
-
export declare const APP_ARTIFACT_STATUSES: readonly AppArtifactStatus[];
|
|
217
|
-
export interface AppPlannedArtifact {
|
|
218
|
-
/** App-owned in-code id the build must register and reference. */
|
|
219
|
-
id: string;
|
|
220
|
-
type: AppArtifactType;
|
|
221
|
-
/** Short human label. */
|
|
222
|
-
name?: string;
|
|
223
|
-
/** Why this artifact exists / what it does — carried into the build checklist. */
|
|
224
|
-
purpose?: string;
|
|
225
|
-
/**
|
|
226
|
-
* When false, the artifact is planned but optional: the capability gate warns rather
|
|
227
|
-
* than blocks if it is missing or never exercised. Defaults to required (true).
|
|
228
|
-
*/
|
|
229
|
-
required?: boolean;
|
|
230
|
-
/** Build progress, updated by the developer agent. Defaults to `pending`. */
|
|
231
|
-
status?: AppArtifactStatus;
|
|
232
|
-
}
|
|
233
|
-
/**
|
|
234
|
-
* Structured result the App Solution Architect emits alongside its prose artifacts — the
|
|
235
|
-
* machine-readable contract for the build. The implementation MUST register every required artifact
|
|
236
|
-
* before building a candidate, then successfully exercise it after that candidate is installed and
|
|
237
|
-
* version-pinned. Persisted into the app repo as {@link APP_CAPABILITY_MANIFEST_PATH} so it survives
|
|
238
|
-
* across runs and the package-registration gate can verify it deterministically. If the builder finds the plan
|
|
239
|
-
* wrong or insufficient, the orchestrator relaunches the architect to revise the manifest;
|
|
240
|
-
* the gate always checks against the latest committed copy.
|
|
241
|
-
*/
|
|
242
|
-
export interface AppCapabilityManifest {
|
|
243
|
-
/** Artifact-storage ref to the prose architecture spec (e.g. the architecture `.md`). */
|
|
244
|
-
spec_artifact: string;
|
|
245
|
-
/** Platform artifacts the build must create. */
|
|
246
|
-
artifacts: AppPlannedArtifact[];
|
|
247
|
-
/**
|
|
248
|
-
* Monotonic revision, starting at 1, bumped each time the architect evolves the manifest for
|
|
249
|
-
* the SAME app on a later iteration (read the committed manifest, preserve untouched artifacts,
|
|
250
|
-
* add/modify/remove, then bump). Lets downstream agents tell which contract they are building to.
|
|
251
|
-
*/
|
|
252
|
-
revision?: number;
|
|
253
|
-
/**
|
|
254
|
-
* Newest-first change notes, one entry per revision (what was added/modified/removed and why).
|
|
255
|
-
* How manifest changes are communicated to downstream agents across iterations.
|
|
256
|
-
*/
|
|
257
|
-
changelog?: string[];
|
|
258
|
-
/** Optional free-form notes the architect wants the builder to honor. */
|
|
259
|
-
notes?: string;
|
|
260
|
-
}
|
|
261
|
-
/** Repo-relative path the capability manifest is committed to, read by version-build gates. */
|
|
262
|
-
export declare const APP_CAPABILITY_MANIFEST_PATH = "docs/app-capability-manifest.json";
|
|
263
171
|
export type AppAvailableIn = z.infer<typeof AppAvailableInSchema>;
|
|
264
172
|
export type AppVersionKind = z.infer<typeof AppVersionKindSchema>;
|
|
265
173
|
export type AppVersionState = z.infer<typeof AppVersionStateSchema>;
|
|
@@ -281,41 +189,12 @@ export interface AppVersionListQuery {
|
|
|
281
189
|
export type PromoteAppVersionResponse = z.infer<typeof PromoteAppVersionResponseSchema>;
|
|
282
190
|
export type StartAppBuildRequest = z.infer<typeof StartAppBuildRequestSchema>;
|
|
283
191
|
export type StartAppBuildResponse = z.infer<typeof StartAppBuildResponseSchema>;
|
|
284
|
-
export interface AppBuildWorkflowInput extends StartAppBuildRequest {
|
|
285
|
-
app_id: string;
|
|
286
|
-
app_record_id?: string;
|
|
287
|
-
/** Rebuild this persisted version record at its original commit and target. */
|
|
288
|
-
rebuild_version_record_id?: string;
|
|
289
|
-
app_title?: string;
|
|
290
|
-
app_description?: string;
|
|
291
|
-
source_git_url?: string;
|
|
292
|
-
}
|
|
293
|
-
export interface AppBuildWorkflowResult {
|
|
294
|
-
app_id: string;
|
|
295
|
-
version_id: string;
|
|
296
|
-
kind: Extract<AppVersionKind, 'version'>;
|
|
297
|
-
state: AppVersionState;
|
|
298
|
-
source_commit: string;
|
|
299
|
-
source_git?: AppVersionGitSource;
|
|
300
|
-
urls?: AppVersionUrls;
|
|
301
|
-
file_count?: number;
|
|
302
|
-
}
|
|
303
192
|
export type AppBuildProgressStatus = z.infer<typeof AppBuildProgressStatusSchema>;
|
|
304
193
|
export type AppBuildProgress = z.infer<typeof AppBuildProgressSchema>;
|
|
305
194
|
export type AppScaffoldModule = z.infer<typeof AppScaffoldModuleSchema>;
|
|
306
195
|
export type StartAppScaffoldRequest = z.infer<typeof StartAppScaffoldRequestSchema>;
|
|
307
196
|
export type StartAppScaffoldResponse = z.infer<typeof StartAppScaffoldResponseSchema>;
|
|
308
|
-
export
|
|
309
|
-
}
|
|
310
|
-
export interface AppScaffoldWorkflowResult {
|
|
311
|
-
app_id: string;
|
|
312
|
-
app_record_id?: string;
|
|
313
|
-
installation_id?: string;
|
|
314
|
-
git_url?: string;
|
|
315
|
-
source_git?: AppVersionGitSource;
|
|
316
|
-
files?: number;
|
|
317
|
-
initial_version_build?: StartAppBuildResponse;
|
|
318
|
-
}
|
|
197
|
+
export type StartAppDevelopmentTaskRequest = z.infer<typeof StartAppDevelopmentTaskRequestSchema>;
|
|
319
198
|
export type AppScaffoldProgressStatus = z.infer<typeof AppScaffoldProgressStatusSchema>;
|
|
320
199
|
export type AppScaffoldProgress = z.infer<typeof AppScaffoldProgressSchema>;
|
|
321
200
|
/**
|
|
@@ -331,21 +210,8 @@ export type AppScaffoldProgress = z.infer<typeof AppScaffoldProgressSchema>;
|
|
|
331
210
|
* Declared on the manifest as the app's default. May be overridden per-installation.
|
|
332
211
|
*/
|
|
333
212
|
export type AppAccessControl = z.infer<typeof AppAccessControlSchema>;
|
|
334
|
-
/**
|
|
335
|
-
* Resolve the effective access_control policy for an installed app:
|
|
336
|
-
* installation override wins, then manifest default, then `'all'`.
|
|
337
|
-
*
|
|
338
|
-
* Shared by the STS (JWT generation), the studio-server (validation), and the UI (badge display)
|
|
339
|
-
* so the resolution rule lives in exactly one place. Named `effectiveAppAccessControl` (not just
|
|
340
|
-
* `effectiveAccessControl`) because exports from `@vertesia/common` are flattened — the broader
|
|
341
|
-
* name would risk colliding with other access-control families added later.
|
|
342
|
-
*/
|
|
343
|
-
export declare function effectiveAppAccessControl(installation: {
|
|
344
|
-
access_control?: AppAccessControl;
|
|
345
|
-
} | null | undefined, manifest: {
|
|
346
|
-
access_control?: AppAccessControl;
|
|
347
|
-
} | null | undefined): AppAccessControl;
|
|
348
213
|
export type AppManifestData = z.infer<typeof AppManifestDataSchema>;
|
|
214
|
+
export type UpdateAppPayload = z.infer<typeof UpdateAppPayloadSchema>;
|
|
349
215
|
export type AppGitSourceConfig = z.infer<typeof AppGitSourceConfigSchema>;
|
|
350
216
|
export type AppSourceConfig = z.infer<typeof AppSourceConfigSchema>;
|
|
351
217
|
/**
|
|
@@ -372,11 +238,6 @@ export interface Endpoints {
|
|
|
372
238
|
export type AppRepoTreeEntry = z.infer<typeof AppRepoTreeEntrySchema>;
|
|
373
239
|
/** A non-recursive listing of an app git repo directory at a given ref. */
|
|
374
240
|
export type AppRepoTree = z.infer<typeof AppRepoTreeSchema>;
|
|
375
|
-
/** Browser-side limits mirrored by the app Git service document endpoint. */
|
|
376
|
-
export declare const APP_REPO_DOCUMENT_UPLOAD_MAX_FILE_BYTES: number;
|
|
377
|
-
export declare const APP_REPO_DOCUMENT_UPLOAD_MAX_TOTAL_BYTES: number;
|
|
378
|
-
export declare const APP_REPO_DOCUMENT_UPLOAD_MAX_FILES = 20;
|
|
379
|
-
export declare const APP_REPO_DOCUMENT_UPLOAD_PREFIX = "docs/";
|
|
380
241
|
/** Result of committing one or more uploaded documents to an app repository. */
|
|
381
242
|
export type AppRepoDocumentCommit = z.infer<typeof AppRepoDocumentCommitSchema>;
|
|
382
243
|
/** One commit that inserted or changed a file in an app git repository. */
|
|
@@ -448,10 +309,11 @@ export type AppInstallationOAuthBinding = z.infer<typeof AppInstallationOAuthBin
|
|
|
448
309
|
export type AppInstallationProviderBinding = z.infer<typeof AppInstallationProviderBindingSchema>;
|
|
449
310
|
export type AppInstallation = z.infer<typeof AppInstallationSchema>;
|
|
450
311
|
export type AppInstallationWithManifest = z.infer<typeof AppInstallationWithManifestSchema>;
|
|
451
|
-
|
|
312
|
+
/** An installation whose app manifest could not be resolved (the app was deleted or is unpublished). */
|
|
452
313
|
export interface OrphanedAppInstallation extends Omit<AppInstallation, 'manifest'> {
|
|
453
314
|
manifest: null;
|
|
454
315
|
}
|
|
316
|
+
export type AppInstallationListEntry = z.infer<typeof AppInstallationListEntrySchema>;
|
|
455
317
|
export type OAuthClientCredentials = z.infer<typeof OAuthClientCredentialsSchema>;
|
|
456
318
|
export type AppOAuthCollectionParams = z.infer<typeof AppOAuthCollectionParamsSchema>;
|
|
457
319
|
/** One installer-supplied MCP API key. */
|
|
@@ -479,10 +341,6 @@ export type OAuthAuthStatus = z.infer<typeof OAuthAuthStatusSchema>;
|
|
|
479
341
|
* Response from OAuth authorization endpoint
|
|
480
342
|
*/
|
|
481
343
|
export type OAuthAuthorizeResponse = z.infer<typeof OAuthAuthorizeResponseSchema>;
|
|
482
|
-
export interface McpOAuthCollectionRef {
|
|
483
|
-
app_install_id: string;
|
|
484
|
-
collection_id: string;
|
|
485
|
-
}
|
|
486
344
|
/**
|
|
487
345
|
* Payload for storing the static bearer token of an `auth: 'api_key'` MCP collection.
|
|
488
346
|
* The key is write-only — it is never echoed back by any endpoint.
|
|
@@ -602,8 +460,6 @@ export type CompositeAppHomePlugin = z.infer<typeof CompositeAppHomePluginSchema
|
|
|
602
460
|
export type CompositeAppHeaderItemKind = z.infer<typeof CompositeAppHeaderItemKindSchema>;
|
|
603
461
|
/** Where a header link opens. */
|
|
604
462
|
export type CompositeAppHeaderItemTarget = z.infer<typeof CompositeAppHeaderItemTargetSchema>;
|
|
605
|
-
/** Stable identifiers for the built-in header items. */
|
|
606
|
-
export declare const COMPOSITE_APP_HEADER_BUILTIN_IDS: readonly ['app_portal', 'docs', 'help', 'user_menu'];
|
|
607
463
|
/**
|
|
608
464
|
* A single button in the CompositeApp header bar.
|
|
609
465
|
*
|
|
@@ -647,7 +503,7 @@ import type { AppDashboardDefinitionSchema } from './api-schemas/app-runtime.js'
|
|
|
647
503
|
*/
|
|
648
504
|
import type { z } from 'zod';
|
|
649
505
|
import type { CreateDashboardPayloadSchema, CreateDashboardSnapshotPayloadSchema, DashboardArchiveResultSchema, DashboardBulkArchiveResultSchema, DashboardBulkDeleteResultSchema, DashboardDataSourceSchema, DashboardElasticsearchDslSchema, DashboardElasticsearchResultMappingSchema, DashboardItemSchema, DashboardLayoutSchema, DashboardPanelPositionSchema, DashboardPanelSchema, DashboardQuerySchema, DashboardSchema, DashboardSqlDataSourceSchema, DashboardStatusSchema, DashboardStoreElasticsearchDataSourceSchema, DashboardVersionItemSchema, DashboardVersioningPayloadSchema, DashboardVersioningStatusResponseSchema, DashboardVersionSchema, PromoteDashboardVersionPayloadSchema, UpdateDashboardPayloadSchema } from './api-schemas/dashboard.js';
|
|
650
|
-
import type { AlterTableOperationSchema, AlterTablePayloadSchema, BatchQueryPayloadSchema, BatchQueryResultItemSchema, BatchQueryResultSchema, CreateDataStorePayloadSchema, CreateSnapshotPayloadSchema, CreateTablePayloadSchema, CreateTablesPayloadSchema, DataColumnForAISchema, DataColumnSchema, DataColumnTypeSchema, DataForeignKeyForAISchema, DataForeignKeySchema, DataIndexSchema, DataRelationshipForAISchema, DataRelationshipSchema, DataRelationshipTypeSchema, DataSchemaForAISchema, DataSchemaSchema, DataStoreArchiveResultSchema, DataStoreDownloadInfoSchema, DataStoreFullSchemaResponseSchema, DataStoreItemSchema, DataStoreMutateRowsPayloadSchema, DataStoreMutateRowsResultSchema, DataStoreSchema, DataStoreSchemaResponseSchema, DataStoreStatusSchema, DataStoreTableDetailSchema, DataStoreTableDropResultSchema, DataStoreVersionSchema, DataStoreVersionTableStateSchema, DataTableForAISchema, DataTableSchema, DataTableSemanticTypeSchema, DataTableSummarySchema, GetDataStoreTableQuerySchema, ImportDataFormatSchema, ImportDataPayloadSchema, ImportDataSourceSchema, ImportJobSchema, ImportStatusSchema, ImportTableDataSchema, ListDataStoreVersionsQuerySchema, QueryPayloadSchema, QueryResultColumnSchema, QueryResultSchema, QueryValidationErrorSchema, QueryValidationPayloadSchema, QueryValidationResultSchema, SemanticColumnTypeSchema, UpdateSchemaPayloadSchema } from './api-schemas/data-store.js';
|
|
506
|
+
import type { AlterTableOperationSchema, AlterTablePayloadSchema, BatchQueryPayloadSchema, BatchQueryResultItemSchema, BatchQueryResultSchema, CreateDataStorePayloadSchema, CreateSnapshotPayloadSchema, CreateTablePayloadSchema, CreateTablesPayloadSchema, DataColumnForAISchema, DataColumnSchema, DataColumnTypeSchema, DataColumnUpdateSchema, DataForeignKeyForAISchema, DataForeignKeySchema, DataIndexSchema, DataRelationshipForAISchema, DataRelationshipSchema, DataRelationshipTypeSchema, DataSchemaForAISchema, DataSchemaSchema, DataStoreArchiveResultSchema, DataStoreDownloadInfoSchema, DataStoreFullSchemaResponseSchema, DataStoreItemSchema, DataStoreMutateRowsPayloadSchema, DataStoreMutateRowsResultSchema, DataStoreSchema, DataStoreSchemaResponseSchema, DataStoreStatusSchema, DataStoreTableDetailSchema, DataStoreTableDropResultSchema, DataStoreVersionSchema, DataStoreVersionTableStateSchema, DataTableForAISchema, DataTableSchema, DataTableSemanticTypeSchema, DataTableSummarySchema, GetDataStoreTableQuerySchema, ImportDataFormatSchema, ImportDataPayloadSchema, ImportDataSourceSchema, ImportJobSchema, ImportStatusSchema, ImportTableDataSchema, ListDataStoreVersionsQuerySchema, QueryPayloadSchema, QueryResultColumnSchema, QueryResultSchema, QueryValidationErrorSchema, QueryValidationPayloadSchema, QueryValidationResultSchema, SemanticColumnTypeSchema, UpdateSchemaPayloadSchema } from './api-schemas/data-store.js';
|
|
651
507
|
/**
|
|
652
508
|
* Supported column data types for DuckDB tables.
|
|
653
509
|
*/
|
|
@@ -878,7 +734,7 @@ export type DataSchemaForAI = z.infer<typeof DataSchemaForAISchema>;
|
|
|
878
734
|
/**
|
|
879
735
|
* Version retention configuration.
|
|
880
736
|
*/
|
|
881
|
-
|
|
737
|
+
interface DataStoreRetentionConfig {
|
|
882
738
|
/** Keep versions for this many days */
|
|
883
739
|
retention_days: number;
|
|
884
740
|
/** Named snapshots are exempt from retention */
|
|
@@ -931,14 +787,6 @@ export type DashboardLayout = z.infer<typeof DashboardLayoutSchema>;
|
|
|
931
787
|
* @deprecated Use combined Vega-Lite spec with vconcat/hconcat instead.
|
|
932
788
|
*/
|
|
933
789
|
export declare const DEFAULT_DASHBOARD_LAYOUT: DashboardLayout;
|
|
934
|
-
/**
|
|
935
|
-
* SQL query parameters with default values.
|
|
936
|
-
* Supports {{param_name}} placeholders in SQL that get substituted at runtime.
|
|
937
|
-
*/
|
|
938
|
-
export interface DashboardQueryParameters {
|
|
939
|
-
/** Default values for SQL parameters. Keys are parameter names (without braces). */
|
|
940
|
-
defaults: Record<string, string>;
|
|
941
|
-
}
|
|
942
790
|
/**
|
|
943
791
|
* Elasticsearch DSL supported by dashboard data sources.
|
|
944
792
|
* Queries execute through Vertesia Store, so project/security filtering remains server-side.
|
|
@@ -996,27 +844,6 @@ export type CreateDashboardPayload = z.infer<typeof CreateDashboardPayloadSchema
|
|
|
996
844
|
* Payload for updating a dashboard.
|
|
997
845
|
*/
|
|
998
846
|
export type UpdateDashboardPayload = z.infer<typeof UpdateDashboardPayloadSchema>;
|
|
999
|
-
/**
|
|
1000
|
-
* Payload for previewing a dashboard (render without saving).
|
|
1001
|
-
*/
|
|
1002
|
-
export interface PreviewDashboardPayload {
|
|
1003
|
-
/** Data source used to populate Vega `data.values`. */
|
|
1004
|
-
dataSource?: DashboardDataSource;
|
|
1005
|
-
/** SQL query that returns all data for the dashboard */
|
|
1006
|
-
query?: string;
|
|
1007
|
-
/** Maximum rows to return from the query (default: 10000) */
|
|
1008
|
-
queryLimit?: number;
|
|
1009
|
-
/** Default values for SQL parameters */
|
|
1010
|
-
queryParameters?: Record<string, string>;
|
|
1011
|
-
/** Complete Vega-Lite specification for the entire dashboard */
|
|
1012
|
-
spec?: Record<string, unknown>;
|
|
1013
|
-
/** @deprecated Use single `query` field instead */
|
|
1014
|
-
queries?: DashboardQuery[];
|
|
1015
|
-
/** @deprecated Use single `spec` field with vconcat/hconcat instead */
|
|
1016
|
-
panels?: DashboardPanel[];
|
|
1017
|
-
/** @deprecated Layout is now handled within the Vega-Lite spec */
|
|
1018
|
-
layout?: Partial<DashboardLayout>;
|
|
1019
|
-
}
|
|
1020
847
|
/**
|
|
1021
848
|
* Options for rendering a dashboard.
|
|
1022
849
|
*/
|
|
@@ -1028,21 +855,6 @@ export interface RenderDashboardOptions {
|
|
|
1028
855
|
/** Background color (default: white) */
|
|
1029
856
|
backgroundColor?: string;
|
|
1030
857
|
}
|
|
1031
|
-
/**
|
|
1032
|
-
* Result of rendering a dashboard.
|
|
1033
|
-
*/
|
|
1034
|
-
export interface RenderDashboardResult {
|
|
1035
|
-
/** URL to the rendered PNG image */
|
|
1036
|
-
url: string;
|
|
1037
|
-
/** When the URL expires (seconds from now) */
|
|
1038
|
-
expires_in: number;
|
|
1039
|
-
/** When the dashboard was rendered */
|
|
1040
|
-
rendered_at: string;
|
|
1041
|
-
/** Image width in pixels */
|
|
1042
|
-
width: number;
|
|
1043
|
-
/** Image height in pixels */
|
|
1044
|
-
height: number;
|
|
1045
|
-
}
|
|
1046
858
|
/**
|
|
1047
859
|
* A point-in-time version of a dashboard.
|
|
1048
860
|
* Stores full snapshot inline (no external storage needed for small JSON documents).
|
|
@@ -1060,18 +872,19 @@ export type CreateDashboardSnapshotPayload = z.infer<typeof CreateDashboardSnaps
|
|
|
1060
872
|
* Payload for promoting a version to current.
|
|
1061
873
|
*/
|
|
1062
874
|
export type PromoteDashboardVersionPayload = z.infer<typeof PromoteDashboardVersionPayloadSchema>;
|
|
875
|
+
export type DataColumnUpdate = z.infer<typeof DataColumnUpdateSchema>;
|
|
876
|
+
export {};
|
|
1063
877
|
|
|
1064
878
|
// -----------------------------------------------------------------------------
|
|
1065
879
|
// @vertesia/common: interaction.d.ts
|
|
1066
880
|
// -----------------------------------------------------------------------------
|
|
1067
|
-
import type { CompletionResult, ExecutionTokenUsage,
|
|
881
|
+
import type { CompletionResult, ExecutionTokenUsage, JSONSchema, Modalities, PromptCacheDiagnostic, StatelessExecutionOptions, ToolUse } from '@llumiverse/common';
|
|
1068
882
|
import type { z } from 'zod';
|
|
1069
|
-
import type { AgentResourceActionSchema, AgentResourceReferenceSchema, AgentResourceTypeSchema, AgentRunnerOptionsSchema, AsyncCompletionModeSchema, AsyncCompletionOptionsSchema, AsyncConversationExecutionPayloadSchema, AsyncExecutionPayloadSchema, AsyncExecutionResultSchema, AsyncInteractionExecutionPayloadSchema, CachePolicySchema, CatalogInteractionRefSchema, ConversationStripOptionsSchema, ConversationVisibilitySchema, ExecutionRunInteractionSchema, ExecutionRunRefSchema, ExecutionRunWorkflowSchema, GeneratedInteractionDefinitionSchema, GeneratedInteractionPromptSegmentSchema, GeneratedInteractionPromptTemplateSchema, GeneratedTestDataRecordSchema, GenerateInteractionPayloadSchema, GenerateTestDataPayloadSchema, ImprovePromptPayloadConfigSchema, ImprovePromptPayloadSchema, InCodePromptSchema, InitialToolCallSchema, InteractionCreatePayloadSchema, InteractionEndpointQuerySchema, InteractionEndpointSchema, InteractionExecutionErrorSchema, InteractionExecutionPayloadSchema, InteractionForkPayloadSchema, InteractionNameSchema, InteractionPublishPayloadSchema, InteractionRefSchema, InteractionRefWithSchemaSchema, InteractionSchema, InteractionsExportPayloadSchema, InteractionTagsSchema, InteractionUpdatePayloadSchema, InteractionVisibilitySchema, NamedInteractionExecutionPayloadSchema, PromptImprovementResponseSchema, PromptModalitiesSchema, RateLimitRequestPayloadSchema, RateLimitRequestResponseSchema, ResolvedEnvironmentInfoSchema, ResolvedInteractionExecutionInfoSchema, ResolvedRuntimeConfigSchema, ResultStorageOptionsSchema, RunSourceSchema, SchemaRefSchema, SkillContextTriggersSchema, StreamingOptionsSchema, StreamingTelemetryContextSchema, ToolResultMetaSchema, ToolResultSchema, ToolResultsPayloadSchema, UserMessagePayloadSchema } from './api-schemas/interaction.js';
|
|
883
|
+
import type { AgentResourceActionSchema, AgentResourceReferenceSchema, AgentResourceTypeSchema, AgentRunnerOptionsSchema, AsyncCompletionModeSchema, AsyncCompletionOptionsSchema, AsyncConversationExecutionPayloadSchema, AsyncExecutionPayloadSchema, AsyncExecutionResultSchema, AsyncInteractionExecutionPayloadSchema, CachePolicySchema, CatalogInteractionRefSchema, ConversationStripOptionsSchema, ConversationVisibilitySchema, ExecutionRunInteractionSchema, ExecutionRunRefSchema, ExecutionRunWorkflowSchema, GeneratedInteractionDefinitionSchema, GeneratedInteractionPromptSegmentSchema, GeneratedInteractionPromptTemplateSchema, GeneratedTestDataRecordSchema, GenerateInteractionPayloadSchema, GenerateTestDataPayloadSchema, ImprovePromptPayloadConfigSchema, ImprovePromptPayloadSchema, InCodeInteractionSchema, InCodePromptSchema, InitialToolCallSchema, InteractionCreatePayloadSchema, InteractionEndpointQuerySchema, InteractionEndpointSchema, InteractionExecutionErrorSchema, InteractionExecutionPayloadSchema, InteractionForkPayloadSchema, InteractionNameSchema, InteractionPublishPayloadSchema, InteractionRefSchema, InteractionRefWithSchemaSchema, InteractionSchema, InteractionsExportPayloadSchema, InteractionTagsSchema, InteractionUpdatePayloadSchema, InteractionVisibilitySchema, NamedInteractionExecutionPayloadSchema, PromptImprovementResponseSchema, PromptModalitiesSchema, RateLimitRequestPayloadSchema, RateLimitRequestResponseSchema, ResolvedCatalogInteractionSchema, ResolvedEnvironmentInfoSchema, ResolvedInteractionExecutionInfoSchema, ResolvedRuntimeConfigSchema, ResultStorageOptionsSchema, RunSourceSchema, SchemaRefSchema, SkillContextTriggersSchema, StreamingOptionsSchema, StreamingTelemetryContextSchema, ToolResultMetaSchema, ToolResultSchema, ToolResultsPayloadSchema, UpdateExecutionRunPayloadSchema, UserMessagePayloadSchema } from './api-schemas/interaction.js';
|
|
1070
884
|
import type { InteractionExecutionConfigurationSchema } from './api-schemas/store.js';
|
|
1071
|
-
import type { MCPToolAnnotations } from './apps.js';
|
|
1072
885
|
import type { ExecutionEnvironmentRef } from './environment.js';
|
|
1073
886
|
import type { ProjectRef } from './project.js';
|
|
1074
|
-
import type {
|
|
887
|
+
import type { PopulatedPromptSegmentDef } from './prompt.js';
|
|
1075
888
|
import type { TextArtifactReference } from './store/conversation-state.js';
|
|
1076
889
|
import type { AccountRef } from './user.js';
|
|
1077
890
|
/**
|
|
@@ -1080,7 +893,6 @@ import type { AccountRef } from './user.js';
|
|
|
1080
893
|
* working.
|
|
1081
894
|
*/
|
|
1082
895
|
export * from './interaction-values.js';
|
|
1083
|
-
import { ConfigModes, RunDataStorageLevel } from './interaction-values.js';
|
|
1084
896
|
export type InteractionExecutionError = z.infer<typeof InteractionExecutionErrorSchema>;
|
|
1085
897
|
/**
|
|
1086
898
|
* Configuration for stripping large data from conversation history
|
|
@@ -1114,102 +926,9 @@ export interface ResolveInteractionQuery {
|
|
|
1114
926
|
hasVideo?: boolean;
|
|
1115
927
|
}
|
|
1116
928
|
export type InCodePrompt = z.infer<typeof InCodePromptSchema>;
|
|
1117
|
-
export
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
*/
|
|
1121
|
-
type: 'sys' | 'app' | 'stored' | 'draft';
|
|
1122
|
-
/**
|
|
1123
|
-
* The id of the interaction. Required.
|
|
1124
|
-
* The id is a unique identifier for the interaction.
|
|
1125
|
-
* It is recommended to use a URL safe string and not include spaces.
|
|
1126
|
-
* The id is composed of some namespace or prefix and the interaction name.
|
|
1127
|
-
* Example: sys:generic_question, app:review_contract, tmp:my_temp_interaction
|
|
1128
|
-
*/
|
|
1129
|
-
id: string;
|
|
1130
|
-
/**
|
|
1131
|
-
* The interaction code name. Required.
|
|
1132
|
-
* Should be a URL safe string and not include spaces. It is recommended to use kebab-case or camel-case.
|
|
1133
|
-
* The endpoints must satisfy the following regexp: /^[a-zA-Z0-9-_]+$/. No whitespaces or special characters are allowed.
|
|
1134
|
-
*/
|
|
1135
|
-
name: string;
|
|
1136
|
-
/**
|
|
1137
|
-
* Only applies for stored interactions. The version of the interaction.
|
|
1138
|
-
* Undefined for non stored interactions
|
|
1139
|
-
*/
|
|
1140
|
-
version?: number;
|
|
1141
|
-
/**
|
|
1142
|
-
* Only applies for stored interactions. Whether the interaction is published or not.
|
|
1143
|
-
*/
|
|
1144
|
-
published?: boolean;
|
|
1145
|
-
/**
|
|
1146
|
-
* A title for the interaction. If not provided, the endpoint will be used.
|
|
1147
|
-
*/
|
|
1148
|
-
title?: string;
|
|
1149
|
-
/**
|
|
1150
|
-
* An optional description of the interaction.
|
|
1151
|
-
*/
|
|
1152
|
-
description?: string;
|
|
1153
|
-
/**
|
|
1154
|
-
* The JSON schema to be used for the result if any.
|
|
1155
|
-
*/
|
|
1156
|
-
result_schema?: JSONSchema | SchemaRef;
|
|
1157
|
-
/**
|
|
1158
|
-
* The modality of the interaction output.
|
|
1159
|
-
* If not specified Modalities.Text is assumed.
|
|
1160
|
-
*/
|
|
1161
|
-
output_modality?: Modalities;
|
|
1162
|
-
/**
|
|
1163
|
-
* How to store the run data for executions of this interaction.
|
|
1164
|
-
* Defaults to STANDARD.
|
|
1165
|
-
*/
|
|
1166
|
-
storage?: RunDataStorageLevel;
|
|
1167
|
-
/**
|
|
1168
|
-
* Optional tags for the interaction.
|
|
1169
|
-
*/
|
|
1170
|
-
tags?: string[];
|
|
1171
|
-
/**
|
|
1172
|
-
* Agent Runner configuration options.
|
|
1173
|
-
*/
|
|
1174
|
-
agent_runner_options?: AgentRunnerOptions;
|
|
1175
|
-
/**
|
|
1176
|
-
* Default options for the model to be used when executing this interaction.
|
|
1177
|
-
* (like temperature etc)
|
|
1178
|
-
*/
|
|
1179
|
-
model_options?: ModelOptions;
|
|
1180
|
-
/**
|
|
1181
|
-
* The prompts composing the interaction. Required.
|
|
1182
|
-
*/
|
|
1183
|
-
prompts: InCodePrompt[];
|
|
1184
|
-
/**
|
|
1185
|
-
* Optional reference to an external resource if any.
|
|
1186
|
-
* Used internally by the system to synchronize stored interactions with in-code interactions.
|
|
1187
|
-
*/
|
|
1188
|
-
externalId?: string;
|
|
1189
|
-
/**
|
|
1190
|
-
* Runtime configuration (system use only)
|
|
1191
|
-
*
|
|
1192
|
-
* This field is populated by the system when converting stored interactions
|
|
1193
|
-
* and contains runtime-specific defaults like target model/environment IDs.
|
|
1194
|
-
*
|
|
1195
|
-
* DO NOT set this field manually when writing interaction definitions.
|
|
1196
|
-
* These values are environment-specific and not portable.
|
|
1197
|
-
*
|
|
1198
|
-
* @internal
|
|
1199
|
-
*/
|
|
1200
|
-
runtime?: {
|
|
1201
|
-
/**
|
|
1202
|
-
* Default target environment for the interaction execution
|
|
1203
|
-
*/
|
|
1204
|
-
environment?: string;
|
|
1205
|
-
/**
|
|
1206
|
-
* Default (recommended) target model for the interaction execution
|
|
1207
|
-
*/
|
|
1208
|
-
model?: string;
|
|
1209
|
-
};
|
|
1210
|
-
}
|
|
1211
|
-
export interface InteractionSpec extends Omit<InCodeInteraction, 'id' | 'runtime' | 'type' | 'published' | 'version'> {
|
|
1212
|
-
}
|
|
929
|
+
export type InCodeInteraction = z.infer<typeof InCodeInteractionSchema>;
|
|
930
|
+
export type ResolvedCatalogInteraction = z.infer<typeof ResolvedCatalogInteractionSchema>;
|
|
931
|
+
export type InteractionSpec = Omit<InCodeInteraction, 'id' | 'runtime' | 'type' | 'published' | 'version'>;
|
|
1213
932
|
/**
|
|
1214
933
|
* The payload to query the interaction endpoints
|
|
1215
934
|
*/
|
|
@@ -1222,9 +941,6 @@ export type InteractionTags = z.infer<typeof InteractionTagsSchema>;
|
|
|
1222
941
|
export type InteractionRef = z.infer<typeof InteractionRefSchema>;
|
|
1223
942
|
/** An interaction reduced to the fields a name picker needs. */
|
|
1224
943
|
export type InteractionName = z.infer<typeof InteractionNameSchema>;
|
|
1225
|
-
export declare const InteractionNamePopulate = "id name";
|
|
1226
|
-
export declare const InteractionRefPopulate = "id name endpoint parent description status version visibility tags agent_runner_options updated_at prompts";
|
|
1227
|
-
export declare const InteractionRefWithSchemaPopulate = "id name endpoint parent description status version visibility tags agent_runner_options updated_at prompts result_schema";
|
|
1228
944
|
/**
|
|
1229
945
|
* An interaction reference carrying the schemas an export needs to reconstruct it.
|
|
1230
946
|
*
|
|
@@ -1248,12 +964,6 @@ export declare enum ExecutionRunStatus {
|
|
|
1248
964
|
completed = "completed",
|
|
1249
965
|
failed = "failed"
|
|
1250
966
|
}
|
|
1251
|
-
export declare enum RunDataStorageDescription {
|
|
1252
|
-
STANDARD = "Run data is stored for both the model inputs and output.",
|
|
1253
|
-
RESTRICTED = "No run data is stored for the model inputs \u2014 only the model output.",
|
|
1254
|
-
DEBUG = "Run data is stored for the model inputs and output, schema, and final prompt."
|
|
1255
|
-
}
|
|
1256
|
-
export declare const RunDataStorageOptions: Record<RunDataStorageLevel, RunDataStorageDescription>;
|
|
1257
967
|
/**
|
|
1258
968
|
* Schema can be stored or specified as a reference to an external schema.
|
|
1259
969
|
* We only support "store:" references for now
|
|
@@ -1261,35 +971,7 @@ export declare const RunDataStorageOptions: Record<RunDataStorageLevel, RunDataS
|
|
|
1261
971
|
export type SchemaRef = z.infer<typeof SchemaRefSchema>;
|
|
1262
972
|
export type CachePolicy = z.infer<typeof CachePolicySchema>;
|
|
1263
973
|
export type InteractionVisibility = z.infer<typeof InteractionVisibilitySchema>;
|
|
1264
|
-
export interface InteractionData {
|
|
1265
|
-
readonly id: string;
|
|
1266
|
-
name: string;
|
|
1267
|
-
endpoint: string;
|
|
1268
|
-
description?: string;
|
|
1269
|
-
project: string | ProjectRef;
|
|
1270
|
-
tags: string[];
|
|
1271
|
-
agent_runner_options?: AgentRunnerOptions;
|
|
1272
|
-
result_schema?: JSONSchema | SchemaRef;
|
|
1273
|
-
environment?: string | ExecutionEnvironmentRef;
|
|
1274
|
-
model?: string;
|
|
1275
|
-
model_options?: ModelOptions;
|
|
1276
|
-
restriction?: RunDataStorageLevel;
|
|
1277
|
-
/**
|
|
1278
|
-
* @deprecated This is deprecated. Use CompletionResult.type information instead.
|
|
1279
|
-
*/
|
|
1280
|
-
output_modality?: Modalities;
|
|
1281
|
-
}
|
|
1282
974
|
export type Interaction = z.infer<typeof InteractionSchema>;
|
|
1283
|
-
export interface PopulatedInteraction extends Omit<Interaction, 'prompts'> {
|
|
1284
|
-
prompts: PopulatedPromptSegmentDef[];
|
|
1285
|
-
}
|
|
1286
|
-
/**
|
|
1287
|
-
* Used to describe an interaction that can be executed. Contains only the interaction data useful
|
|
1288
|
-
* to execute the interaction plus the prompt templates
|
|
1289
|
-
*/
|
|
1290
|
-
export interface ExecutableInteraction extends InteractionData {
|
|
1291
|
-
prompts: ExecutablePromptSegmentDef[];
|
|
1292
|
-
}
|
|
1293
975
|
export type InteractionCreatePayload = z.infer<typeof InteractionCreatePayloadSchema>;
|
|
1294
976
|
export type InteractionUpdatePayload = z.infer<typeof InteractionUpdatePayloadSchema>;
|
|
1295
977
|
export type InteractionPublishPayload = z.infer<typeof InteractionPublishPayloadSchema>;
|
|
@@ -1305,10 +987,6 @@ export interface InteractionDeletePayload {
|
|
|
1305
987
|
export type InteractionForkPayload = z.infer<typeof InteractionForkPayloadSchema>;
|
|
1306
988
|
export type InteractionExecutionPayload = z.infer<typeof InteractionExecutionPayloadSchema>;
|
|
1307
989
|
export type NamedInteractionExecutionPayload = z.infer<typeof NamedInteractionExecutionPayloadSchema>;
|
|
1308
|
-
export type ToolRef = string | {
|
|
1309
|
-
name: string;
|
|
1310
|
-
description: string;
|
|
1311
|
-
};
|
|
1312
990
|
export type ConversationVisibility = z.infer<typeof ConversationVisibilitySchema>;
|
|
1313
991
|
/**
|
|
1314
992
|
* Defines the scope for agent search operations.
|
|
@@ -1407,15 +1085,12 @@ export interface ToolResultContent {
|
|
|
1407
1085
|
* rather than throwing, and an empty/absent label falls back to the id.
|
|
1408
1086
|
*/
|
|
1409
1087
|
export declare function normalizeAgentResources(value: unknown): AgentResourceReference[];
|
|
1410
|
-
/** Extract the normalized resource references a tool declared in its result metadata. */
|
|
1411
|
-
export declare function getResourcesFromToolResult(result: Pick<ToolResultContent, 'meta'>): AgentResourceReference[];
|
|
1412
1088
|
export type ToolResult = z.infer<typeof ToolResultSchema>;
|
|
1413
1089
|
/**
|
|
1414
1090
|
* The payload to sent the tool responses back to the target LLM
|
|
1415
1091
|
*/
|
|
1416
1092
|
export type ToolResultsPayload = z.infer<typeof ToolResultsPayloadSchema>;
|
|
1417
1093
|
export type UserMessagePayload = z.infer<typeof UserMessagePayloadSchema>;
|
|
1418
|
-
export type CheckpointConversationPayload = Omit<ToolResultsPayload, 'results' | 'tools'>;
|
|
1419
1094
|
export declare enum RunSourceTypes {
|
|
1420
1095
|
api = "api",
|
|
1421
1096
|
cli = "cli",
|
|
@@ -1456,6 +1131,7 @@ export interface BaseExecutionRun<P = unknown> {
|
|
|
1456
1131
|
finish_reason?: string;
|
|
1457
1132
|
prompt?: unknown;
|
|
1458
1133
|
token_use?: ExecutionTokenUsage;
|
|
1134
|
+
prompt_cache_diagnostics?: PromptCacheDiagnostic[];
|
|
1459
1135
|
chunks?: number;
|
|
1460
1136
|
execution_time?: number;
|
|
1461
1137
|
/** @format date-time */
|
|
@@ -1498,19 +1174,7 @@ export interface InteractionExecutionResult<P = unknown> extends Omit<ExecutionR
|
|
|
1498
1174
|
conversation?: unknown;
|
|
1499
1175
|
options?: StatelessExecutionOptions;
|
|
1500
1176
|
}
|
|
1501
|
-
export interface LegacyInteractionExecutionResult<P = unknown> extends Omit<InteractionExecutionResult<P>, 'result' | 'account' | 'project'> {
|
|
1502
|
-
account: string | AccountRef;
|
|
1503
|
-
project: string | ProjectRef;
|
|
1504
|
-
result?: JSONObject | string | null;
|
|
1505
|
-
}
|
|
1506
1177
|
export type ExecutionRunRef = z.infer<typeof ExecutionRunRefSchema>;
|
|
1507
|
-
export declare const ExecutionRunRefSelect = "-result -parameters -result_schema -prompt";
|
|
1508
|
-
export declare enum ConfigModesDescription {
|
|
1509
|
-
RUN_AND_INTERACTION_CONFIG = "This run configuration is used. Undefined options are filled with interaction configuration.",
|
|
1510
|
-
RUN_CONFIG_ONLY = "Only this run configuration is used. Undefined options remain undefined.",
|
|
1511
|
-
INTERACTION_CONFIG_ONLY = "Only interaction configuration is used."
|
|
1512
|
-
}
|
|
1513
|
-
export declare const ConfigModesOptions: Record<ConfigModes, ConfigModesDescription>;
|
|
1514
1178
|
export type InteractionExecutionConfiguration = z.infer<typeof InteractionExecutionConfigurationSchema>;
|
|
1515
1179
|
export type GenerateInteractionPayload = z.infer<typeof GenerateInteractionPayloadSchema>;
|
|
1516
1180
|
export type GenerateTestDataPayload = z.infer<typeof GenerateTestDataPayloadSchema>;
|
|
@@ -1556,79 +1220,17 @@ export type ResolvedRuntimeConfig = z.infer<typeof ResolvedRuntimeConfigSchema>;
|
|
|
1556
1220
|
* (environment, model) that would be used at execution time.
|
|
1557
1221
|
*/
|
|
1558
1222
|
export type ResolvedInteractionExecutionInfo = z.infer<typeof ResolvedInteractionExecutionInfoSchema>;
|
|
1559
|
-
|
|
1560
|
-
|
|
1561
|
-
*/
|
|
1562
|
-
export interface BuiltinToolDefinition {
|
|
1563
|
-
/**
|
|
1564
|
-
* The unique tool name
|
|
1565
|
-
*/
|
|
1566
|
-
name: string;
|
|
1567
|
-
/**
|
|
1568
|
-
* One-line summary shown in the tool selector UI
|
|
1569
|
-
*/
|
|
1570
|
-
summary?: string;
|
|
1571
|
-
/**
|
|
1572
|
-
* JSON schema for the tool's parameters
|
|
1573
|
-
*/
|
|
1574
|
-
params: JSONSchema;
|
|
1575
|
-
/**
|
|
1576
|
-
* Whether this tool is active by default when no explicit tool list is provided.
|
|
1577
|
-
* Tools with default: false are only activated by skills.
|
|
1578
|
-
*/
|
|
1579
|
-
default: boolean;
|
|
1580
|
-
/**
|
|
1581
|
-
* Behavioral hints following the MCP ToolAnnotations spec.
|
|
1582
|
-
* Used for display purposes only — not sent to LLMs.
|
|
1583
|
-
*/
|
|
1584
|
-
annotations?: MCPToolAnnotations;
|
|
1585
|
-
}
|
|
1586
|
-
/**
|
|
1587
|
-
* A system skill entry in the tools catalog.
|
|
1588
|
-
* System skills are built into the platform and unlock hidden tools.
|
|
1589
|
-
*/
|
|
1590
|
-
export interface SystemSkillCatalogEntry {
|
|
1591
|
-
/** Skill name without the learn_ prefix, e.g. "document_search" */
|
|
1592
|
-
name: string;
|
|
1593
|
-
/** Tool name used in agent selection, i.e. "learn_document_search" */
|
|
1594
|
-
tool_name: string;
|
|
1595
|
-
/** Human-readable display title */
|
|
1596
|
-
title: string;
|
|
1597
|
-
/** Description of what the skill unlocks */
|
|
1598
|
-
description: string;
|
|
1599
|
-
/** Tool names this skill enables (unlocks) when called */
|
|
1600
|
-
tools: string[];
|
|
1601
|
-
/** Whether this skill is part of the default agent toolkit */
|
|
1602
|
-
default?: boolean;
|
|
1603
|
-
}
|
|
1604
|
-
/**
|
|
1605
|
-
* Response from the builtin tools catalog endpoint
|
|
1606
|
-
*/
|
|
1607
|
-
export interface BuiltinToolsCatalogResponse {
|
|
1608
|
-
/**
|
|
1609
|
-
* List of available builtin tools
|
|
1610
|
-
*/
|
|
1611
|
-
tools: BuiltinToolDefinition[];
|
|
1612
|
-
/**
|
|
1613
|
-
* When the catalog was generated
|
|
1614
|
-
*/
|
|
1615
|
-
generated_at: string;
|
|
1616
|
-
/**
|
|
1617
|
-
* Total number of tools in the catalog
|
|
1618
|
-
*/
|
|
1619
|
-
total_tools: number;
|
|
1620
|
-
/**
|
|
1621
|
-
* System skills bundled in the platform, available without app installation
|
|
1622
|
-
*/
|
|
1623
|
-
skills?: SystemSkillCatalogEntry[];
|
|
1223
|
+
export interface PopulatedInteraction extends Omit<Interaction, 'prompts'> {
|
|
1224
|
+
prompts: PopulatedPromptSegmentDef[];
|
|
1624
1225
|
}
|
|
1226
|
+
export type UpdateExecutionRunPayload = z.infer<typeof UpdateExecutionRunPayloadSchema>;
|
|
1625
1227
|
|
|
1626
1228
|
// -----------------------------------------------------------------------------
|
|
1627
1229
|
// @vertesia/common: prompt.d.ts
|
|
1628
1230
|
// -----------------------------------------------------------------------------
|
|
1629
1231
|
import type { JSONSchema, PromptRole } from '@llumiverse/common';
|
|
1630
1232
|
import type { z } from 'zod';
|
|
1631
|
-
import type { PromptTemplateCreatePayloadSchema, PromptTemplateRefSchema, PromptTemplateSchema, PromptTemplateUpdatePayloadSchema } from './api-schemas/interaction.js';
|
|
1233
|
+
import type { ExportedPromptTemplateRefSchema, InteractionPromptSegmentInputSchema, InteractionPromptTemplateInputSchema, PromptTemplateCreatePayloadSchema, PromptTemplateRefSchema, PromptTemplateSchema, PromptTemplateUpdatePayloadSchema } from './api-schemas/interaction.js';
|
|
1632
1234
|
import type { PromptTemplateForkPayloadSchema, PromptTemplateInteractionsResponseSchema, PromptTemplateInteractionUsageSchema, PromptTemplateInteractionVersionSchema, RenderPromptPayloadSchema, RenderPromptResponseSchema } from './api-schemas/prompt.js';
|
|
1633
1235
|
export interface ChatPromptSchema {
|
|
1634
1236
|
role: PromptRole.user | PromptRole.assistant;
|
|
@@ -1649,9 +1251,6 @@ export interface PromptSegmentDef<T = string | PromptTemplate | PromptTemplateRe
|
|
|
1649
1251
|
template?: T;
|
|
1650
1252
|
configuration?: unknown;
|
|
1651
1253
|
}
|
|
1652
|
-
export interface PromptSegmentRef<T = string | PromptTemplate | PromptTemplateRef> extends PromptSegmentDef<T> {
|
|
1653
|
-
id: string;
|
|
1654
|
-
}
|
|
1655
1254
|
export interface PopulatedPromptSegmentDef extends Omit<PromptSegmentDef, 'template'> {
|
|
1656
1255
|
template?: PromptTemplate;
|
|
1657
1256
|
}
|
|
@@ -1662,9 +1261,6 @@ export interface ExecutablePromptSegmentDef extends Omit<PromptSegmentDef, 'temp
|
|
|
1662
1261
|
template?: ExecutablePromptTemplate;
|
|
1663
1262
|
}
|
|
1664
1263
|
export type PromptTemplateRef = z.infer<typeof PromptTemplateRefSchema>;
|
|
1665
|
-
export interface PromptTemplateRefWithSchema extends PromptTemplateRef {
|
|
1666
|
-
inputSchema?: JSONSchema;
|
|
1667
|
-
}
|
|
1668
1264
|
export declare enum TemplateType {
|
|
1669
1265
|
jst = "jst",
|
|
1670
1266
|
handlebars = "handlebars",
|
|
@@ -1677,6 +1273,8 @@ export interface ExecutablePromptTemplate {
|
|
|
1677
1273
|
inputSchema?: JSONSchema;
|
|
1678
1274
|
}
|
|
1679
1275
|
export type PromptTemplate = z.infer<typeof PromptTemplateSchema>;
|
|
1276
|
+
export type InteractionPromptTemplateInput = z.infer<typeof InteractionPromptTemplateInputSchema>;
|
|
1277
|
+
export type InteractionPromptSegmentInput = z.infer<typeof InteractionPromptSegmentInputSchema>;
|
|
1680
1278
|
export type PromptTemplateForkPayload = z.infer<typeof PromptTemplateForkPayloadSchema>;
|
|
1681
1279
|
export type PromptTemplateCreatePayload = z.infer<typeof PromptTemplateCreatePayloadSchema>;
|
|
1682
1280
|
export type PromptTemplateUpdatePayload = z.infer<typeof PromptTemplateUpdatePayloadSchema>;
|
|
@@ -1691,6 +1289,7 @@ export type RenderPromptPayload = z.infer<typeof RenderPromptPayloadSchema>;
|
|
|
1691
1289
|
* been a name for it on either side of the wire.
|
|
1692
1290
|
*/
|
|
1693
1291
|
export type RenderPromptResponse = z.infer<typeof RenderPromptResponseSchema>;
|
|
1292
|
+
export type ExportedPromptTemplateRef = z.infer<typeof ExportedPromptTemplateRefSchema>;
|
|
1694
1293
|
|
|
1695
1294
|
// -----------------------------------------------------------------------------
|
|
1696
1295
|
// @vertesia/common: project.d.ts
|
|
@@ -1699,8 +1298,8 @@ import type { z } from 'zod';
|
|
|
1699
1298
|
import type { ProjectRefSchema } from './api-schemas/apikey.js';
|
|
1700
1299
|
import type { EmbeddingsStatusResponseSchema, ProjectConfigurationEmbeddingEnablePayloadSchema } from './api-schemas/embeddings.js';
|
|
1701
1300
|
import type { DriftAnalysisProgressSchema, DriftAnalysisResultSchema, DriftAnalysisStatusResponseSchema, IndexingStatusResponseSchema, ReindexAgentRunsPayloadSchema, ReindexAgentRunsResponseSchema, StartProjectReindexPayloadSchema } from './api-schemas/indexing.js';
|
|
1702
|
-
import type { CreateProjectPayloadFromSchema, ListProjectsQuerySchema, ProjectIntegrationListEntrySchema, ProjectIntegrationListResponseSchema, ProjectPluginsUpdatePayloadSchema, ProjectSchema, ProjectTagQuerySchema } from './api-schemas/project.js';
|
|
1703
|
-
import type { AgentCheckpointConfigurationSchema, AgentProjectConfigurationSchema, BrowserUseProjectConfigurationSchema, BrowserUseRiskPolicySchema, BrowserUseScreenshotCaptureSchema, ElasticsearchBackendSchema, ModalityDefaultsSchema, ModelDefaultSchema, ProjectConfigurationEmbeddingSchema, ProjectConfigurationSchema, ProjectIndexingConfigurationSchema, ProjectIntakeConfigurationSchema, ProjectIntakeSniffConfigurationSchema, ProjectModelDefaultsSchema, ProjectSearchPropertyMappingSchema, ProjectSearchPropertyTypeSchema, ProjectSearchTierSchema, SystemDefaultsSchema } from './api-schemas/project-configuration.js';
|
|
1301
|
+
import type { CreateProjectPayloadFromSchema, ListProjectsQuerySchema, ProjectIntegrationListEntrySchema, ProjectIntegrationListResponseSchema, ProjectPluginsUpdatePayloadSchema, ProjectSchema, ProjectTagQuerySchema, UpdateProjectConfigurationPayloadSchema, UpdateProjectPayloadSchema } from './api-schemas/project.js';
|
|
1302
|
+
import type { AgentCheckpointConfigurationSchema, AgentProjectConfigurationSchema, BrowserUseProjectConfigurationSchema, BrowserUseRiskPolicySchema, BrowserUseScreenshotCaptureSchema, ElasticsearchBackendSchema, IntakeVisionProfileSettingsUpdateSchema, ModalityDefaultsSchema, ModelDefaultSchema, ProjectConfigurationEmbeddingSchema, ProjectConfigurationSchema, ProjectIndexingConfigurationSchema, ProjectIntakeConfigurationSchema, ProjectIntakeSniffConfigurationSchema, ProjectModelDefaultsSchema, ProjectSearchPropertyMappingSchema, ProjectSearchPropertyTypeSchema, ProjectSearchTierSchema, SystemDefaultsSchema } from './api-schemas/project-configuration.js';
|
|
1704
1303
|
import type { AccountRef } from './user.js';
|
|
1705
1304
|
/**
|
|
1706
1305
|
* `SystemRoles` lives in `./project-values.js` so the API schemas can read it without importing this
|
|
@@ -1708,7 +1307,6 @@ import type { AccountRef } from './user.js';
|
|
|
1708
1307
|
*/
|
|
1709
1308
|
export * from './project-values.js';
|
|
1710
1309
|
export type ICreateProjectPayload = CreateProjectPayloadFromSchema;
|
|
1711
|
-
export declare function isRoleIncludedIn(role: string, includingRole: string): boolean;
|
|
1712
1310
|
export interface PopulatedProjectRef {
|
|
1713
1311
|
id: string;
|
|
1714
1312
|
name: string;
|
|
@@ -1734,13 +1332,6 @@ export declare enum SystemInteractionCategory {
|
|
|
1734
1332
|
* Map system interaction endpoints to categories.
|
|
1735
1333
|
*/
|
|
1736
1334
|
export declare const SYSTEM_INTERACTION_CATEGORIES: Record<string, SystemInteractionCategory>;
|
|
1737
|
-
/**
|
|
1738
|
-
* Get category for a system interaction endpoint.
|
|
1739
|
-
* Returns undefined if category is non-applicable or endpoint is not recognized.
|
|
1740
|
-
* Note: Caller is responsible for determining if the interaction is a system interaction.
|
|
1741
|
-
* @param endpoint - The interaction endpoint name
|
|
1742
|
-
*/
|
|
1743
|
-
export declare function getSystemInteractionCategory(endpoint: string): SystemInteractionCategory | undefined;
|
|
1744
1335
|
/**
|
|
1745
1336
|
* One optional default per {@link SystemInteractionCategory}.
|
|
1746
1337
|
*
|
|
@@ -1769,21 +1360,13 @@ export type AgentProjectConfiguration = z.infer<typeof AgentProjectConfiguration
|
|
|
1769
1360
|
export type AgentCheckpointConfiguration = z.infer<typeof AgentCheckpointConfigurationSchema>;
|
|
1770
1361
|
export type ProjectSearchPropertyType = z.infer<typeof ProjectSearchPropertyTypeSchema>;
|
|
1771
1362
|
export type ProjectSearchPropertyMapping = z.infer<typeof ProjectSearchPropertyMappingSchema>;
|
|
1772
|
-
export declare const PROJECT_SEARCH_PROPERTY_TYPES: readonly ProjectSearchPropertyType[];
|
|
1773
|
-
/**
|
|
1774
|
-
* Validate property mappings at API and index-creation boundaries.
|
|
1775
|
-
*
|
|
1776
|
-
* Returns user-facing issue strings instead of throwing so callers can map the
|
|
1777
|
-
* result to the error type appropriate for their boundary.
|
|
1778
|
-
*/
|
|
1779
|
-
export declare function validateProjectSearchPropertyMappings(value: unknown): string[];
|
|
1780
1363
|
export type ProjectIndexingConfiguration = z.infer<typeof ProjectIndexingConfigurationSchema>;
|
|
1781
1364
|
export declare enum SupportedEmbeddingTypes {
|
|
1782
1365
|
text = "text",
|
|
1783
1366
|
image = "image",
|
|
1784
1367
|
properties = "properties"
|
|
1785
1368
|
}
|
|
1786
|
-
|
|
1369
|
+
declare enum FullTextType {
|
|
1787
1370
|
full_text = "full_text"
|
|
1788
1371
|
}
|
|
1789
1372
|
export type SearchTypes = SupportedEmbeddingTypes | FullTextType;
|
|
@@ -1796,12 +1379,6 @@ export declare const SearchTypes: {
|
|
|
1796
1379
|
export type ProjectConfigurationEmbedding = z.infer<typeof ProjectConfigurationEmbeddingSchema>;
|
|
1797
1380
|
export type ProjectConfigurationEmbeddingEnablePayload = z.infer<typeof ProjectConfigurationEmbeddingEnablePayloadSchema>;
|
|
1798
1381
|
export type Project = z.infer<typeof ProjectSchema>;
|
|
1799
|
-
export interface ProjectCreatePayload {
|
|
1800
|
-
name: string;
|
|
1801
|
-
description?: string;
|
|
1802
|
-
}
|
|
1803
|
-
export interface ProjectUpdatePayload extends Partial<Project> {
|
|
1804
|
-
}
|
|
1805
1382
|
export type ProjectPluginsUpdatePayload = z.infer<typeof ProjectPluginsUpdatePayloadSchema>;
|
|
1806
1383
|
export declare const ProjectRefPopulate = "id name account";
|
|
1807
1384
|
export type EmbeddingsStatusResponse = z.infer<typeof EmbeddingsStatusResponseSchema>;
|
|
@@ -1810,26 +1387,6 @@ export type EmbeddingsStatusResponse = z.infer<typeof EmbeddingsStatusResponseSc
|
|
|
1810
1387
|
*/
|
|
1811
1388
|
export type IndexingStatusResponse = z.infer<typeof IndexingStatusResponseSchema>;
|
|
1812
1389
|
export type StartProjectReindexPayload = z.infer<typeof StartProjectReindexPayloadSchema>;
|
|
1813
|
-
/**
|
|
1814
|
-
* Auto-tunes shard sizing based on project doc count.
|
|
1815
|
-
*
|
|
1816
|
-
* Returns:
|
|
1817
|
-
* - shard_size: target docs per shard (workflow path uses this; zeno-bulk
|
|
1818
|
-
* computes shard count from total/shard_size).
|
|
1819
|
-
* - parallel_shard_count: max in-flight shard activities (workflow path only).
|
|
1820
|
-
* - max_shards: hard cap on shard count for the direct path. Direct path
|
|
1821
|
-
* passes this as `shards` to zeno-bulk so all shards run as cursors in
|
|
1822
|
-
* ONE process; without this cap, an under-estimated shard_size (e.g.
|
|
1823
|
-
* from stale estimatedDocumentCount) can spawn 10+ in-flight cursors
|
|
1824
|
-
* and exceed Cloud Run memory.
|
|
1825
|
-
*
|
|
1826
|
-
* Explicit overrides should bypass this function and use user-provided values.
|
|
1827
|
-
*/
|
|
1828
|
-
export declare function autoTuneReindexParams(docCount: number): {
|
|
1829
|
-
shard_size: number;
|
|
1830
|
-
parallel_shard_count: number;
|
|
1831
|
-
max_shards: number;
|
|
1832
|
-
};
|
|
1833
1390
|
export type ReindexAgentRunsPayload = z.infer<typeof ReindexAgentRunsPayloadSchema>;
|
|
1834
1391
|
export type ReindexAgentRunsResponse = z.infer<typeof ReindexAgentRunsResponseSchema>;
|
|
1835
1392
|
/**
|
|
@@ -2092,7 +1649,7 @@ export interface ElasticsearchIndexStats {
|
|
|
2092
1649
|
/**
|
|
2093
1650
|
* Embedding configuration for a single type
|
|
2094
1651
|
*/
|
|
2095
|
-
|
|
1652
|
+
interface EmbeddingTypeConfig {
|
|
2096
1653
|
environment?: string;
|
|
2097
1654
|
dimensions?: number;
|
|
2098
1655
|
model?: string;
|
|
@@ -2179,16 +1736,22 @@ export type DriftAnalysisResult = z.infer<typeof DriftAnalysisResultSchema>;
|
|
|
2179
1736
|
export type DriftAnalysisStatusResponse = z.infer<typeof DriftAnalysisStatusResponseSchema>;
|
|
2180
1737
|
export type ProjectIntegrationListEntry = z.infer<typeof ProjectIntegrationListEntrySchema>;
|
|
2181
1738
|
export type ProjectIntegrationListResponse = z.infer<typeof ProjectIntegrationListResponseSchema>;
|
|
1739
|
+
export type UpdateProjectPayload = z.infer<typeof UpdateProjectPayloadSchema>;
|
|
1740
|
+
export type UpdateProjectConfigurationPayload = z.infer<typeof UpdateProjectConfigurationPayloadSchema>;
|
|
1741
|
+
export type IntakeVisionProfileSettingsUpdate = z.infer<typeof IntakeVisionProfileSettingsUpdateSchema>;
|
|
2182
1742
|
|
|
2183
1743
|
// -----------------------------------------------------------------------------
|
|
2184
1744
|
// @vertesia/common: runs.d.ts
|
|
2185
1745
|
// -----------------------------------------------------------------------------
|
|
2186
1746
|
import type { z } from 'zod';
|
|
2187
|
-
import type { ExecutionRunDocRefSchema, RunClonePayloadSchema, RunCreatePayloadSchema, RunSearchMetaResponseSchema } from './api-schemas/interaction.js';
|
|
1747
|
+
import type { ComputeRunFacetsResponseSchema, ExecutionRunDocRefSchema, FindRunResultArraySchema, FindRunResultSchema, PopulatedExecutionRunResultSchema, RunClonePayloadSchema, RunCreatePayloadSchema, RunSearchMetaResponseSchema } from './api-schemas/interaction.js';
|
|
2188
1748
|
/**
|
|
2189
1749
|
* The run ref is used to identify a run document in the storage
|
|
2190
1750
|
*/
|
|
2191
1751
|
export type ExecutionRunDocRef = z.infer<typeof ExecutionRunDocRefSchema>;
|
|
1752
|
+
export type FindRunResult = z.infer<typeof FindRunResultSchema>;
|
|
1753
|
+
export type FindRunResultArray = z.infer<typeof FindRunResultArraySchema>;
|
|
1754
|
+
export type PopulatedExecutionRunResult = z.infer<typeof PopulatedExecutionRunResultSchema>;
|
|
2192
1755
|
/**
|
|
2193
1756
|
* Interaction execution payload for creating a new run
|
|
2194
1757
|
* It uses interaction field (from NamedInteractionExecutionPayload) to pass the interaction ID to run
|
|
@@ -2210,6 +1773,7 @@ export interface RangeValue {
|
|
|
2210
1773
|
lte?: number | string;
|
|
2211
1774
|
}
|
|
2212
1775
|
export type RunSearchMetaResponse = z.infer<typeof RunSearchMetaResponseSchema>;
|
|
1776
|
+
export type ComputeRunFacetsResponse = z.infer<typeof ComputeRunFacetsResponseSchema>;
|
|
2213
1777
|
|
|
2214
1778
|
// -----------------------------------------------------------------------------
|
|
2215
1779
|
// @vertesia/common: skill.d.ts
|
|
@@ -2279,29 +1843,16 @@ export interface InjectedSkill {
|
|
|
2279
1843
|
*/
|
|
2280
1844
|
match_score?: number;
|
|
2281
1845
|
}
|
|
2282
|
-
/**
|
|
2283
|
-
* Result from generateTools activity with skills
|
|
2284
|
-
*/
|
|
2285
|
-
export interface ToolsWithSkills {
|
|
2286
|
-
/**
|
|
2287
|
-
* Array of tool definitions
|
|
2288
|
-
*/
|
|
2289
|
-
tools: unknown[];
|
|
2290
|
-
/**
|
|
2291
|
-
* Skills injected based on context
|
|
2292
|
-
*/
|
|
2293
|
-
injected_skills: InjectedSkill[];
|
|
2294
|
-
}
|
|
2295
1846
|
|
|
2296
1847
|
// -----------------------------------------------------------------------------
|
|
2297
1848
|
// @vertesia/common: store/store.d.ts
|
|
2298
1849
|
// -----------------------------------------------------------------------------
|
|
2299
1850
|
import type { z } from 'zod';
|
|
2300
|
-
import type { ContentObjectTypeRefSchema } from '../api-schemas/app-lifecycle.js';
|
|
2301
|
-
import type { ComplexSearchPayloadSchema, ContentObjectApiResponseSchema, ContentObjectApiRevisionSchema, ContentObjectApiTypeRefSchema, ContentObjectExportArtifactFileSchema, ContentObjectExportArtifactSchema, ContentObjectExportProgressSchema, ContentObjectExportResultSchema, ContentObjectExportStatusResponseSchema, ContentObjectItemApiResponseSchema, ContentObjectTextResponseSchema, ContentObjectUserPermissionsSchema, ContentSourceSchema, CreateContentObjectHeadersSchema, CreateContentObjectPayloadSchema, CreateContentObjectQuerySchema, DeleteContentObjectExportResponseSchema, DeleteContentObjectResultSchema, EmbeddingSchema, ExportContentObjectsFilterSchema, ExportContentObjectsIncludeOptionsSchema, GenerationRunMetadataSchema, GetObjectRenditionQuerySchema, GetRenditionResponseSchema, InheritedPropertyMetadataSchema, ListContentObjectExportsResponseSchema, ObjectSearchResponseSchema, RevisionInfoSchema, SetObjectEmbeddingsResponseSchema, StartContentObjectExportRequestSchema, StartContentObjectExportResponseSchema, TranscriptSchema, TranscriptSegmentSchema, UpdateContentObjectHeadersSchema, UpdateContentObjectQuerySchema } from '../api-schemas/content.js';
|
|
1851
|
+
import type { ContentObjectTypeRefSchema, InCodeTypeRefSchema, StoredTypeRefSchema } from '../api-schemas/app-lifecycle.js';
|
|
1852
|
+
import type { ComplexSearchPayloadSchema, ContentObjectApiResponseSchema, ContentObjectApiRevisionSchema, ContentObjectApiTypeRefSchema, ContentObjectExportArtifactFileSchema, ContentObjectExportArtifactSchema, ContentObjectExportProgressSchema, ContentObjectExportResultSchema, ContentObjectExportStatusResponseSchema, ContentObjectItemApiResponseSchema, ContentObjectTextResponseSchema, ContentObjectUserPermissionsSchema, ContentSourceSchema, CreateContentObjectHeadersSchema, CreateContentObjectPayloadSchema, CreateContentObjectQuerySchema, DeleteContentObjectExportResponseSchema, DeleteContentObjectResultSchema, EmbeddingSchema, ExportContentObjectsFilterSchema, ExportContentObjectsIncludeOptionsSchema, GenerationRunMetadataSchema, GetObjectRenditionQuerySchema, GetRenditionResponseSchema, InheritedPropertyMetadataSchema, ListContentObjectExportsResponseSchema, ObjectSearchResponseSchema, ProjectedContentObjectApiResponseSchema, RevisionInfoSchema, SetObjectEmbeddingsResponseSchema, StartContentObjectExportRequestSchema, StartContentObjectExportResponseSchema, TranscriptSchema, TranscriptSegmentSchema, UpdateContentObjectHeadersSchema, UpdateContentObjectPayloadSchema, UpdateContentObjectQuerySchema } from '../api-schemas/content.js';
|
|
2302
1853
|
import type { MarkdownRenditionFormatSchema } from '../api-schemas/document-processing.js';
|
|
2303
|
-
import type { CreateWorkflowRulePayloadSchema, WorkflowRuleItemSchema, WorkflowRuleSchema } from '../api-schemas/events.js';
|
|
2304
|
-
import type { BucketReadAccessStatusResponseSchema, BulkUploadUrlsPayloadSchema, BulkUploadUrlsResponseSchema, CopyFilePayloadSchema, CopyFileResponseSchema, DeleteFileResultSchema, EnsureBucketReadAccessPayloadSchema, EnsureBucketReadAccessResponseSchema, FileBucketResponseSchema, FileDeleteQuerySchema, FileListQuerySchema, FileListResponseSchema, FileMetadataQuerySchema, FileMetadataResponseSchema, FileMetadataUpdateResultSchema, GetFileUrlPayloadSchema, GetFileUrlResponseSchema, GetUploadUrlPayloadSchema, SetFileMetadataPayloadSchema } from '../api-schemas/files.js';
|
|
1854
|
+
import type { CreateWorkflowRulePayloadSchema, UpdateWorkflowRulePayloadSchema, WorkflowRuleItemSchema, WorkflowRuleSchema } from '../api-schemas/events.js';
|
|
1855
|
+
import type { BucketCreateAccessStatusResponseSchema, BucketReadAccessStatusResponseSchema, BulkUploadUrlsPayloadSchema, BulkUploadUrlsResponseSchema, CopyFilePayloadSchema, CopyFileResponseSchema, DeleteFileResultSchema, EnsureBucketCreateAccessPayloadSchema, EnsureBucketCreateAccessResponseSchema, EnsureBucketReadAccessPayloadSchema, EnsureBucketReadAccessResponseSchema, FileBucketResponseSchema, FileDeleteQuerySchema, FileListQuerySchema, FileListResponseSchema, FileMetadataQuerySchema, FileMetadataResponseSchema, FileMetadataUpdateResultSchema, GetFileUrlPayloadSchema, GetFileUrlResponseSchema, GetUploadUrlPayloadSchema, SetFileMetadataPayloadSchema } from '../api-schemas/files.js';
|
|
2305
1856
|
import type { ColumnLayoutSchema, ContentObjectTypeCatalogEntrySchema, ContentObjectTypeCatalogQuerySchema, ContentObjectTypeItemSchema, ContentObjectTypeListQuerySchema, ContentObjectTypeSchema, ContentObjectTypeStatusSchema, ContentTypeEditingPolicySchema, ContentTypeExtractionGroundingPolicySchema, ContentTypeExtractionGroundingReviewPolicySchema, ContentTypeIntakePolicySchema, CreateContentObjectTypePayloadSchema, InCodeTypeDefinitionSchema, IntakePageRangesSchema, IntakePageScopeSchema, IntakeVisionDetailSchema, UpdateContentObjectTypePayloadSchema } from '../api-schemas/store.js';
|
|
2306
1857
|
import type { JSONObject } from '../json.js';
|
|
2307
1858
|
import type { SupportedEmbeddingTypes } from '../project.js';
|
|
@@ -2340,34 +1891,6 @@ export declare enum ContentObjectStatus {
|
|
|
2340
1891
|
export type Embedding = z.infer<typeof EmbeddingSchema>;
|
|
2341
1892
|
export type ExportContentObjectsIncludeOptions = z.infer<typeof ExportContentObjectsIncludeOptionsSchema>;
|
|
2342
1893
|
export type ExportContentObjectsFilter = z.infer<typeof ExportContentObjectsFilterSchema>;
|
|
2343
|
-
/**
|
|
2344
|
-
* Exported object identity and context for a single content object row.
|
|
2345
|
-
*/
|
|
2346
|
-
export interface ExportedContentObjectRecord {
|
|
2347
|
-
id: string;
|
|
2348
|
-
name: string;
|
|
2349
|
-
location: string;
|
|
2350
|
-
external_id?: string;
|
|
2351
|
-
type?: {
|
|
2352
|
-
ref_type?: 'stored' | 'incode' | 'untyped';
|
|
2353
|
-
id?: string;
|
|
2354
|
-
code?: string;
|
|
2355
|
-
name?: string;
|
|
2356
|
-
};
|
|
2357
|
-
status?: ContentObjectStatus;
|
|
2358
|
-
content?: {
|
|
2359
|
-
source?: string;
|
|
2360
|
-
type?: string;
|
|
2361
|
-
name?: string;
|
|
2362
|
-
etag?: string;
|
|
2363
|
-
};
|
|
2364
|
-
created_at: string;
|
|
2365
|
-
updated_at: string;
|
|
2366
|
-
revision?: RevisionInfo;
|
|
2367
|
-
properties?: Record<string, unknown>;
|
|
2368
|
-
metadata?: Record<string, unknown>;
|
|
2369
|
-
embeddings?: Partial<Record<SupportedEmbeddingTypes, Embedding>>;
|
|
2370
|
-
}
|
|
2371
1894
|
export type StartContentObjectExportRequest = z.infer<typeof StartContentObjectExportRequestSchema>;
|
|
2372
1895
|
export type StartContentObjectExportResponse = z.infer<typeof StartContentObjectExportResponseSchema>;
|
|
2373
1896
|
export interface ZenoBulkContentObjectExportRequest extends Omit<StartContentObjectExportRequest, 'compression'> {
|
|
@@ -2442,6 +1965,10 @@ export type ContentObjectApiTypeRef = z.infer<typeof ContentObjectApiTypeRefSche
|
|
|
2442
1965
|
export type ContentObjectApiRevision = z.infer<typeof ContentObjectApiRevisionSchema>;
|
|
2443
1966
|
export type ContentObjectItemApiResponse = z.infer<typeof ContentObjectItemApiResponseSchema>;
|
|
2444
1967
|
export type ContentObjectApiResponse = z.infer<typeof ContentObjectApiResponseSchema>;
|
|
1968
|
+
export type ProjectedContentObjectApiResponse = z.infer<typeof ProjectedContentObjectApiResponseSchema>;
|
|
1969
|
+
export type FullObjectSearchResponse = Omit<ObjectSearchResponse, 'results'> & {
|
|
1970
|
+
results: ContentObjectItemApiResponse[];
|
|
1971
|
+
};
|
|
2445
1972
|
export interface ContentObject<T = JSONObject> extends ContentObjectItem<T> {
|
|
2446
1973
|
text?: string;
|
|
2447
1974
|
text_etag?: string;
|
|
@@ -2576,7 +2103,7 @@ export interface TypeDetectionMetadata {
|
|
|
2576
2103
|
min_pages?: number;
|
|
2577
2104
|
detected_at: string;
|
|
2578
2105
|
}
|
|
2579
|
-
|
|
2106
|
+
interface TemporalMediaMetadata extends ContentMetadata {
|
|
2580
2107
|
duration?: number;
|
|
2581
2108
|
transcript?: Transcript;
|
|
2582
2109
|
}
|
|
@@ -2623,7 +2150,7 @@ export interface DocumentMetadata extends ContentMetadata {
|
|
|
2623
2150
|
sections?: TextSection[];
|
|
2624
2151
|
}
|
|
2625
2152
|
/** Grounded-extraction summary stored on document metadata. Additional keys allowed. */
|
|
2626
|
-
|
|
2153
|
+
interface GroundedMetadata {
|
|
2627
2154
|
verdict?: string;
|
|
2628
2155
|
confidence?: number;
|
|
2629
2156
|
citation_count?: number;
|
|
@@ -2637,15 +2164,6 @@ export interface GroundedMetadata {
|
|
|
2637
2164
|
[key: string]: unknown;
|
|
2638
2165
|
}
|
|
2639
2166
|
export type Transcript = z.infer<typeof TranscriptSchema>;
|
|
2640
|
-
export declare const TextExtractionStatus: {
|
|
2641
|
-
readonly success: 'success';
|
|
2642
|
-
};
|
|
2643
|
-
export interface TranscriptMediaResult {
|
|
2644
|
-
hasText: boolean;
|
|
2645
|
-
status: typeof TextExtractionStatus.success;
|
|
2646
|
-
message?: string;
|
|
2647
|
-
gladiaTranscriptionId?: string;
|
|
2648
|
-
}
|
|
2649
2167
|
export type TranscriptSegment = z.infer<typeof TranscriptSegmentSchema>;
|
|
2650
2168
|
export type ContentSource = z.infer<typeof ContentSourceSchema>;
|
|
2651
2169
|
export type RevisionInfo = z.infer<typeof RevisionInfoSchema>;
|
|
@@ -2716,14 +2234,7 @@ export type CreateContentObjectPayload<T = JSONObject> = Omit<CreateContentObjec
|
|
|
2716
2234
|
/** Known metadata interfaces remain assignable; the runtime contract deliberately accepts any object keys. */
|
|
2717
2235
|
metadata?: ContentObjectItem['metadata'];
|
|
2718
2236
|
};
|
|
2719
|
-
type LegacyContentObjectTypeRef = Partial<ContentObjectTypeRef> & {
|
|
2720
|
-
ref_type?: 'stored' | 'incode';
|
|
2721
|
-
id?: string;
|
|
2722
|
-
code?: string;
|
|
2723
|
-
name?: string;
|
|
2724
|
-
};
|
|
2725
2237
|
export declare function getContentTypeRefId(type: ContentObjectTypeRef): string;
|
|
2726
|
-
export declare function withContentObjectTypeRefDiscriminator(type: ContentObjectTypeRef | LegacyContentObjectTypeRef): ContentObjectTypeRef;
|
|
2727
2238
|
export type ContentObjectTypeRef = z.infer<typeof ContentObjectTypeRefSchema>;
|
|
2728
2239
|
export type ComplexSearchPayload = z.infer<typeof ComplexSearchPayloadSchema>;
|
|
2729
2240
|
export type ColumnLayout = z.infer<typeof ColumnLayoutSchema>;
|
|
@@ -2739,18 +2250,6 @@ export type IntakePageScope = z.infer<typeof IntakePageScopeSchema>;
|
|
|
2739
2250
|
* enforced at runtime.
|
|
2740
2251
|
*/
|
|
2741
2252
|
export type IntakePageRanges = z.infer<typeof IntakePageRangesSchema>;
|
|
2742
|
-
/** Rendering settings behind a vision detail name (platform defaults, project-overridable
|
|
2743
|
-
* via `configuration.intake.vision_profiles`). */
|
|
2744
|
-
export interface IntakeVisionProfileSettings {
|
|
2745
|
-
/** Render resolution in dots per inch. */
|
|
2746
|
-
dpi: number;
|
|
2747
|
-
/** Maximum height/width of the rendered page image in pixels. */
|
|
2748
|
-
max_hw: number;
|
|
2749
|
-
/** JPEG quality (0-100). */
|
|
2750
|
-
quality: number;
|
|
2751
|
-
/** grayscale renders gray always; auto keeps color when the plan asks for it. */
|
|
2752
|
-
color_mode: 'grayscale' | 'auto';
|
|
2753
|
-
}
|
|
2754
2253
|
export type ContentTypeExtractionGroundingReviewPolicy = z.infer<typeof ContentTypeExtractionGroundingReviewPolicySchema>;
|
|
2755
2254
|
export type ContentTypeExtractionGroundingPolicy = z.infer<typeof ContentTypeExtractionGroundingPolicySchema>;
|
|
2756
2255
|
export type ContentTypeIntakePolicy = z.infer<typeof ContentTypeIntakePolicySchema>;
|
|
@@ -2763,12 +2262,6 @@ export type ContentObjectTypeCatalogEntry = z.infer<typeof ContentObjectTypeCata
|
|
|
2763
2262
|
* The itnerface to be used whend efining types in a plugin app.
|
|
2764
2263
|
*/
|
|
2765
2264
|
export type InCodeTypeSpec = Omit<InCodeTypeDefinition, 'id'>;
|
|
2766
|
-
/**
|
|
2767
|
-
* Returns true if the type id represents an in-code type (system or app-contributed).
|
|
2768
|
-
* In-code types use colon-separated ids like "sys:Invoice" or "app:myapp:Article".
|
|
2769
|
-
* These types are read-only and cannot be edited through the UI.
|
|
2770
|
-
*/
|
|
2771
|
-
export declare function isInCodeType(typeId: string): boolean;
|
|
2772
2265
|
export type CreateContentObjectTypePayload = z.infer<typeof CreateContentObjectTypePayloadSchema>;
|
|
2773
2266
|
export type UpdateContentObjectTypePayload = z.infer<typeof UpdateContentObjectTypePayloadSchema>;
|
|
2774
2267
|
export declare enum WorkflowRuleInputType {
|
|
@@ -2800,7 +2293,7 @@ export interface GetRenditionParams {
|
|
|
2800
2293
|
}
|
|
2801
2294
|
export type GetRenditionResponse = z.infer<typeof GetRenditionResponseSchema>;
|
|
2802
2295
|
export type ObjectSearchResponse = z.infer<typeof ObjectSearchResponseSchema>;
|
|
2803
|
-
|
|
2296
|
+
type RenditionFormat = ImageRenditionFormat | MarkdownRenditionFormat;
|
|
2804
2297
|
/**
|
|
2805
2298
|
* Check if a specific rendition format can be generated from a content type.
|
|
2806
2299
|
*
|
|
@@ -2814,37 +2307,15 @@ export type RenditionFormat = ImageRenditionFormat | MarkdownRenditionFormat;
|
|
|
2814
2307
|
* canGenerateRendition('text/markdown', MarkdownRenditionFormat.pdf) // true
|
|
2815
2308
|
*/
|
|
2816
2309
|
export declare function canGenerateRendition(contentType: string | undefined, format: RenditionFormat | string): boolean;
|
|
2817
|
-
/**
|
|
2818
|
-
* Get the list of rendition formats supported for a given content type.
|
|
2819
|
-
*
|
|
2820
|
-
* @param contentType - The MIME type of the source content
|
|
2821
|
-
* @returns Array of supported rendition formats, or empty array if none
|
|
2822
|
-
*
|
|
2823
|
-
* @example
|
|
2824
|
-
* getSupportedRenditionFormats('image/png') // [jpeg, png, webp]
|
|
2825
|
-
* getSupportedRenditionFormats('text/markdown') // [pdf, docx]
|
|
2826
|
-
* getSupportedRenditionFormats('text/html') // []
|
|
2827
|
-
*/
|
|
2828
|
-
export declare function getSupportedRenditionFormats(contentType: string | undefined): RenditionFormat[];
|
|
2829
|
-
/**
|
|
2830
|
-
* Check if a content type supports visual (image) renditions.
|
|
2831
|
-
* This is useful for determining if a document can have thumbnails/previews.
|
|
2832
|
-
*
|
|
2833
|
-
* @param contentType - The MIME type of the source content
|
|
2834
|
-
* @returns true if the content type can generate JPEG renditions
|
|
2835
|
-
*
|
|
2836
|
-
* @example
|
|
2837
|
-
* supportsVisualRendition('image/png') // true
|
|
2838
|
-
* supportsVisualRendition('application/pdf') // true
|
|
2839
|
-
* supportsVisualRendition('text/markdown') // false
|
|
2840
|
-
*/
|
|
2841
|
-
export declare function supportsVisualRendition(contentType: string | undefined): boolean;
|
|
2842
2310
|
export type GetUploadUrlPayload = z.infer<typeof GetUploadUrlPayloadSchema>;
|
|
2843
2311
|
export type GetFileUrlPayload = z.infer<typeof GetFileUrlPayloadSchema>;
|
|
2844
2312
|
export type GetFileUrlResponse = z.infer<typeof GetFileUrlResponseSchema>;
|
|
2845
2313
|
export type EnsureBucketReadAccessPayload = z.infer<typeof EnsureBucketReadAccessPayloadSchema>;
|
|
2846
2314
|
export type EnsureBucketReadAccessResponse = z.infer<typeof EnsureBucketReadAccessResponseSchema>;
|
|
2847
2315
|
export type BucketReadAccessStatusResponse = z.infer<typeof BucketReadAccessStatusResponseSchema>;
|
|
2316
|
+
export type EnsureBucketCreateAccessPayload = z.infer<typeof EnsureBucketCreateAccessPayloadSchema>;
|
|
2317
|
+
export type EnsureBucketCreateAccessResponse = z.infer<typeof EnsureBucketCreateAccessResponseSchema>;
|
|
2318
|
+
export type BucketCreateAccessStatusResponse = z.infer<typeof BucketCreateAccessStatusResponseSchema>;
|
|
2848
2319
|
export type FileMetadataResponse = z.infer<typeof FileMetadataResponseSchema>;
|
|
2849
2320
|
export type SetFileMetadataPayload = z.infer<typeof SetFileMetadataPayloadSchema>;
|
|
2850
2321
|
export type FileMetadataUpdateResult = z.infer<typeof FileMetadataUpdateResultSchema>;
|
|
@@ -2864,40 +2335,79 @@ export declare enum ContentObjectProcessingPriority {
|
|
|
2864
2335
|
normal = "normal",
|
|
2865
2336
|
low = "low"
|
|
2866
2337
|
}
|
|
2867
|
-
|
|
2868
|
-
|
|
2869
|
-
|
|
2870
|
-
|
|
2871
|
-
|
|
2872
|
-
|
|
2873
|
-
|
|
2874
|
-
|
|
2875
|
-
|
|
2876
|
-
|
|
2877
|
-
|
|
2878
|
-
|
|
2879
|
-
|
|
2880
|
-
}
|
|
2881
|
-
|
|
2882
|
-
|
|
2883
|
-
|
|
2884
|
-
|
|
2885
|
-
|
|
2886
|
-
|
|
2887
|
-
|
|
2888
|
-
|
|
2889
|
-
|
|
2890
|
-
|
|
2891
|
-
|
|
2892
|
-
|
|
2338
|
+
/**
|
|
2339
|
+
* Exported object identity and context for a single content object row.
|
|
2340
|
+
*/
|
|
2341
|
+
export interface ExportedContentObjectRecord {
|
|
2342
|
+
id: string;
|
|
2343
|
+
name: string;
|
|
2344
|
+
location: string;
|
|
2345
|
+
external_id?: string;
|
|
2346
|
+
type?: {
|
|
2347
|
+
ref_type?: 'stored' | 'incode' | 'untyped';
|
|
2348
|
+
id?: string;
|
|
2349
|
+
code?: string;
|
|
2350
|
+
name?: string;
|
|
2351
|
+
};
|
|
2352
|
+
status?: ContentObjectStatus;
|
|
2353
|
+
content?: {
|
|
2354
|
+
source?: string;
|
|
2355
|
+
type?: string;
|
|
2356
|
+
name?: string;
|
|
2357
|
+
etag?: string;
|
|
2358
|
+
};
|
|
2359
|
+
created_at: string;
|
|
2360
|
+
updated_at: string;
|
|
2361
|
+
revision?: RevisionInfo;
|
|
2362
|
+
properties?: Record<string, unknown>;
|
|
2363
|
+
metadata?: Record<string, unknown>;
|
|
2364
|
+
embeddings?: Partial<Record<SupportedEmbeddingTypes, Embedding>>;
|
|
2893
2365
|
}
|
|
2894
|
-
|
|
2366
|
+
/**
|
|
2367
|
+
* Get the list of rendition formats supported for a given content type.
|
|
2368
|
+
*
|
|
2369
|
+
* @param contentType - The MIME type of the source content
|
|
2370
|
+
* @returns Array of supported rendition formats, or empty array if none
|
|
2371
|
+
*
|
|
2372
|
+
* @example
|
|
2373
|
+
* getSupportedRenditionFormats('image/png') // [jpeg, png, webp]
|
|
2374
|
+
* getSupportedRenditionFormats('text/markdown') // [pdf, docx]
|
|
2375
|
+
* getSupportedRenditionFormats('text/html') // []
|
|
2376
|
+
*/
|
|
2377
|
+
export declare function getSupportedRenditionFormats(contentType: string | undefined): RenditionFormat[];
|
|
2378
|
+
/**
|
|
2379
|
+
* Check if a content type supports visual (image) renditions.
|
|
2380
|
+
* This is useful for determining if a document can have thumbnails/previews.
|
|
2381
|
+
*
|
|
2382
|
+
* @param contentType - The MIME type of the source content
|
|
2383
|
+
* @returns true if the content type can generate JPEG renditions
|
|
2384
|
+
*
|
|
2385
|
+
* @example
|
|
2386
|
+
* supportsVisualRendition('image/png') // true
|
|
2387
|
+
* supportsVisualRendition('application/pdf') // true
|
|
2388
|
+
* supportsVisualRendition('text/markdown') // false
|
|
2389
|
+
*/
|
|
2390
|
+
export declare function supportsVisualRendition(contentType: string | undefined): boolean;
|
|
2391
|
+
export type InCodeTypeRef = z.infer<typeof InCodeTypeRefSchema>;
|
|
2392
|
+
export type StoredTypeRef = z.infer<typeof StoredTypeRefSchema>;
|
|
2393
|
+
type UpdateContentObjectPayloadWire = z.infer<typeof UpdateContentObjectPayloadSchema>;
|
|
2394
|
+
/**
|
|
2395
|
+
* Mirrors {@link CreateContentObjectPayload}: `properties` and `metadata` are reopened over the wire
|
|
2396
|
+
* type so the known metadata interfaces stay assignable and callers can name their property shape.
|
|
2397
|
+
* The runtime contract accepts any object keys for both.
|
|
2398
|
+
*/
|
|
2399
|
+
export type UpdateContentObjectPayload<T = JSONObject> = Omit<UpdateContentObjectPayloadWire, 'properties' | 'metadata'> & {
|
|
2400
|
+
properties?: T;
|
|
2401
|
+
metadata?: ContentObjectItem['metadata'];
|
|
2402
|
+
};
|
|
2403
|
+
export type UpdateWorkflowRulePayload = z.infer<typeof UpdateWorkflowRulePayloadSchema>;
|
|
2404
|
+
export {};
|
|
2895
2405
|
|
|
2896
2406
|
// -----------------------------------------------------------------------------
|
|
2897
2407
|
// @vertesia/common: store/collections.d.ts
|
|
2898
2408
|
// -----------------------------------------------------------------------------
|
|
2899
2409
|
import type { z } from 'zod';
|
|
2900
|
-
import type { CollectionChildrenUpdatePayloadSchema, CollectionChildrenUpdateResultSchema, CollectionMembersQuerySchema, CollectionMembersUpdatePayloadSchema, CollectionMembersUpdateResultSchema, CollectionPropagationResponseSchema, CollectionSchema, CollectionSecuritySettingsResponseSchema, CreateCollectionPayloadSchema } from '../api-schemas/content.js';
|
|
2410
|
+
import type { CollectionChildrenUpdatePayloadSchema, CollectionChildrenUpdateResultSchema, CollectionMembersQuerySchema, CollectionMembersUpdatePayloadSchema, CollectionMembersUpdateResultSchema, CollectionPropagationResponseSchema, CollectionSchema, CollectionSecuritySettingsResponseSchema, CreateCollectionPayloadSchema, UpdateCollectionPayloadSchema } from '../api-schemas/content.js';
|
|
2901
2411
|
import type { BaseObject } from './common.js';
|
|
2902
2412
|
import type { ColumnLayout, ContentObjectTypeRef } from './store.js';
|
|
2903
2413
|
export declare enum CollectionStatus {
|
|
@@ -2935,11 +2445,6 @@ export interface CollectionItem extends BaseObject {
|
|
|
2935
2445
|
allowed_types?: string[];
|
|
2936
2446
|
}
|
|
2937
2447
|
export type Collection = z.infer<typeof CollectionSchema>;
|
|
2938
|
-
export interface StaticCollection extends Collection {
|
|
2939
|
-
dynamic: false;
|
|
2940
|
-
members: string[];
|
|
2941
|
-
query: never;
|
|
2942
|
-
}
|
|
2943
2448
|
export interface DynamicCollection extends Collection {
|
|
2944
2449
|
dynamic: true;
|
|
2945
2450
|
}
|
|
@@ -2960,16 +2465,18 @@ export type CollectionChildrenUpdateResult = z.infer<typeof CollectionChildrenUp
|
|
|
2960
2465
|
export type CollectionMembersUpdatePayload = z.infer<typeof CollectionMembersUpdatePayloadSchema>;
|
|
2961
2466
|
export type CollectionChildrenUpdatePayload = z.infer<typeof CollectionChildrenUpdatePayloadSchema>;
|
|
2962
2467
|
export type CollectionMembersQuery = z.infer<typeof CollectionMembersQuerySchema>;
|
|
2468
|
+
export type UpdateCollectionPayload = z.infer<typeof UpdateCollectionPayloadSchema>;
|
|
2963
2469
|
|
|
2964
2470
|
// -----------------------------------------------------------------------------
|
|
2965
2471
|
// @vertesia/common: store/process.d.ts
|
|
2966
2472
|
// -----------------------------------------------------------------------------
|
|
2967
2473
|
import type { z } from 'zod';
|
|
2968
|
-
import type { BranchDefinitionSchema, BranchJoinPolicySchema, HumanTaskDefinitionSchema, JsonLogicRuleSchema, ListProcessDefinitionsQuerySchema, NodeHistoryEntrySchema, ParallelCollectDefinitionSchema, ParallelCollectFieldSchema, ParallelCollectModeSchema, ParallelFailurePolicySchema, ProcessContextDefinitionSchema, ProcessDefinitionFormatVersionSchema, ProcessDefinitionMetadataSchema, ProcessDefinitionRevisionInfoSchema, ProcessDefinitionStatusSchema, ProcessHistoryRefSchema, ProcessNodeReturnsDefinitionSchema, ProcessNodeRunTypeSchema, ProcessNodeTypeSchema, ProcessResourcesDefinitionSchema, ProcessScriptInlineSourceSchema, ProcessScriptLanguageSchema, ProcessScriptResourceSchema, ProcessScriptSourceSchema, ProcessStateSchema, PublishProcessDefinitionPayloadSchema, RevertProcessDefinitionPayloadSchema, TransitionDefinitionSchema, TransitionTriggerSchema } from '../api-schemas/process.js';
|
|
2474
|
+
import type { AdvanceProcessPayloadSchema, AnswerProcessTaskPayloadSchema, BranchDefinitionSchema, BranchJoinPolicySchema, CreateProcessTestSuitePayloadSchema, HumanTaskDefinitionSchema, JsonLogicRuleSchema, ListProcessDefinitionsQuerySchema, ListProcessTestRunsQuerySchema, NodeHistoryEntrySchema, ParallelCollectDefinitionSchema, ParallelCollectFieldSchema, ParallelCollectModeSchema, ParallelFailurePolicySchema, ProcessContextDefinitionSchema, ProcessContextResponseSchema, ProcessDefinitionFormatVersionSchema, ProcessDefinitionMetadataSchema, ProcessDefinitionRevisionInfoSchema, ProcessDefinitionStatusSchema, ProcessHistoryRefSchema, ProcessHistoryResponseSchema, ProcessNodeReturnsDefinitionSchema, ProcessNodeRunTypeSchema, ProcessNodeTypeSchema, ProcessResourcesDefinitionSchema, ProcessScriptInlineSourceSchema, ProcessScriptLanguageSchema, ProcessScriptResourceSchema, ProcessScriptSourceSchema, ProcessStateSchema, ProcessTestActorDecisionSchema, ProcessTestAssertionResultSchema, ProcessTestAssertionsSchema, ProcessTestChildTraceSchema, ProcessTestCoverageSchema, ProcessTestFixtureErrorSchema, ProcessTestFixtureResponseSchema, ProcessTestFixtureResultSchema, ProcessTestHumanActionSchema, ProcessTestInlineSubjectSchema, ProcessTestNodeFixtureSchema, ProcessTestResolvedSubjectSchema, ProcessTestRunSchema, ProcessTestRunStatusSchema, ProcessTestScenarioResultSchema, ProcessTestScenarioSchema, ProcessTestStoredSubjectSchema, ProcessTestSubjectSchema, ProcessTestSuiteSchema, ProcessTestTargetByIdSchema, ProcessTestTargetWithDefinitionSchema, ProcessTestVirtualActorSchema, PublishProcessDefinitionPayloadSchema, RetryProcessNodePayloadSchema, RevertProcessDefinitionPayloadSchema, StartProcessTestRunPayloadSchema, SubmitProcessTestRunPayloadSchema, TransitionDefinitionSchema, TransitionTriggerSchema, UpdateProcessTestScenarioPayloadSchema, UpdateProcessTestSuitePayloadSchema } from '../api-schemas/process.js';
|
|
2969
2475
|
import type { JSONSchema } from '../json-schema.js';
|
|
2970
2476
|
export type JsonLogicRule = z.infer<typeof JsonLogicRuleSchema>;
|
|
2971
2477
|
export type ProcessDefinitionStatus = z.infer<typeof ProcessDefinitionStatusSchema>;
|
|
2972
2478
|
export type ListProcessDefinitionsQuery = z.infer<typeof ListProcessDefinitionsQuerySchema>;
|
|
2479
|
+
export type ListProcessTestRunsQuery = z.infer<typeof ListProcessTestRunsQuerySchema>;
|
|
2973
2480
|
export declare const PROCESS_DEFINITION_FORMAT_VERSION: 1;
|
|
2974
2481
|
export type ProcessDefinitionFormatVersion = z.infer<typeof ProcessDefinitionFormatVersionSchema>;
|
|
2975
2482
|
export type ProcessNodeType = z.infer<typeof ProcessNodeTypeSchema>;
|
|
@@ -3081,6 +2588,7 @@ export interface InCodeProcessDefinition {
|
|
|
3081
2588
|
export type ProcessDefinitionRevisionInfo = z.infer<typeof ProcessDefinitionRevisionInfoSchema>;
|
|
3082
2589
|
export interface ProcessDefinition {
|
|
3083
2590
|
id: string;
|
|
2591
|
+
edit_revision: number;
|
|
3084
2592
|
account: string;
|
|
3085
2593
|
project: string;
|
|
3086
2594
|
name: string;
|
|
@@ -3120,6 +2628,7 @@ export interface CreateProcessDefinitionPayload {
|
|
|
3120
2628
|
definition: ProcessDefinitionBody;
|
|
3121
2629
|
}
|
|
3122
2630
|
export interface UpdateProcessDefinitionPayload {
|
|
2631
|
+
expected_edit_revision?: number;
|
|
3123
2632
|
name?: string;
|
|
3124
2633
|
description?: string;
|
|
3125
2634
|
/**
|
|
@@ -3135,570 +2644,45 @@ export interface UpdateProcessDefinitionPayload {
|
|
|
3135
2644
|
}
|
|
3136
2645
|
export type PublishProcessDefinitionPayload = z.infer<typeof PublishProcessDefinitionPayloadSchema>;
|
|
3137
2646
|
export type RevertProcessDefinitionPayload = z.infer<typeof RevertProcessDefinitionPayloadSchema>;
|
|
3138
|
-
|
|
3139
|
-
|
|
3140
|
-
|
|
3141
|
-
|
|
3142
|
-
export
|
|
3143
|
-
export
|
|
3144
|
-
|
|
3145
|
-
|
|
3146
|
-
|
|
3147
|
-
|
|
3148
|
-
|
|
3149
|
-
|
|
3150
|
-
|
|
3151
|
-
|
|
3152
|
-
|
|
3153
|
-
|
|
3154
|
-
|
|
3155
|
-
|
|
3156
|
-
|
|
3157
|
-
|
|
3158
|
-
|
|
3159
|
-
|
|
3160
|
-
|
|
3161
|
-
|
|
3162
|
-
|
|
3163
|
-
|
|
3164
|
-
|
|
3165
|
-
|
|
3166
|
-
|
|
3167
|
-
|
|
3168
|
-
|
|
3169
|
-
|
|
3170
|
-
|
|
3171
|
-
|
|
3172
|
-
|
|
3173
|
-
|
|
3174
|
-
|
|
3175
|
-
};
|
|
3176
|
-
context: {
|
|
3177
|
-
$ref: string;
|
|
3178
|
-
};
|
|
3179
|
-
nodes: {
|
|
3180
|
-
type: string;
|
|
3181
|
-
description: string;
|
|
3182
|
-
minProperties: number;
|
|
3183
|
-
required: never[];
|
|
3184
|
-
additionalProperties: {
|
|
3185
|
-
$ref: string;
|
|
3186
|
-
};
|
|
3187
|
-
};
|
|
3188
|
-
metadata: {
|
|
3189
|
-
$ref: string;
|
|
3190
|
-
};
|
|
3191
|
-
};
|
|
3192
|
-
required: string[];
|
|
3193
|
-
additionalProperties: false;
|
|
3194
|
-
$defs: {
|
|
3195
|
-
metadataDefinition: {
|
|
3196
|
-
type: string;
|
|
3197
|
-
nullable: true;
|
|
3198
|
-
description: string;
|
|
3199
|
-
required: never[];
|
|
3200
|
-
additionalProperties: true;
|
|
3201
|
-
};
|
|
3202
|
-
processContextDefinition: {
|
|
3203
|
-
type: string;
|
|
3204
|
-
properties: {
|
|
3205
|
-
schema: {
|
|
3206
|
-
description: string;
|
|
3207
|
-
anyOf: ({
|
|
3208
|
-
type: string;
|
|
3209
|
-
additionalProperties?: undefined;
|
|
3210
|
-
} | {
|
|
3211
|
-
type: string;
|
|
3212
|
-
additionalProperties: true;
|
|
3213
|
-
})[];
|
|
3214
|
-
};
|
|
3215
|
-
initial: {
|
|
3216
|
-
type: string;
|
|
3217
|
-
description: string;
|
|
3218
|
-
required: never[];
|
|
3219
|
-
additionalProperties: true;
|
|
3220
|
-
};
|
|
3221
|
-
};
|
|
3222
|
-
required: string[];
|
|
3223
|
-
additionalProperties: false;
|
|
3224
|
-
};
|
|
3225
|
-
nodeDefinition: {
|
|
3226
|
-
type: string;
|
|
3227
|
-
description: string;
|
|
3228
|
-
properties: {
|
|
3229
|
-
type: {
|
|
3230
|
-
type: string;
|
|
3231
|
-
enum: string[];
|
|
3232
|
-
description: string;
|
|
3233
|
-
};
|
|
3234
|
-
tool: {
|
|
3235
|
-
type: string;
|
|
3236
|
-
nullable: true;
|
|
3237
|
-
description: string;
|
|
3238
|
-
};
|
|
3239
|
-
script: {
|
|
3240
|
-
type: string;
|
|
3241
|
-
nullable: true;
|
|
3242
|
-
description: string;
|
|
3243
|
-
};
|
|
3244
|
-
timeout: {
|
|
3245
|
-
type: string;
|
|
3246
|
-
minimum: number;
|
|
3247
|
-
maximum: number;
|
|
3248
|
-
nullable: true;
|
|
3249
|
-
description: string;
|
|
3250
|
-
};
|
|
3251
|
-
interaction: {
|
|
3252
|
-
type: string;
|
|
3253
|
-
nullable: true;
|
|
3254
|
-
description: string;
|
|
3255
|
-
};
|
|
3256
|
-
process: {
|
|
3257
|
-
type: string;
|
|
3258
|
-
nullable: true;
|
|
3259
|
-
description: string;
|
|
3260
|
-
};
|
|
3261
|
-
process_definition: {
|
|
3262
|
-
$ref: string;
|
|
3263
|
-
description: string;
|
|
3264
|
-
};
|
|
3265
|
-
process_version: {
|
|
3266
|
-
type: string;
|
|
3267
|
-
nullable: true;
|
|
3268
|
-
description: string;
|
|
3269
|
-
};
|
|
3270
|
-
run_type: {
|
|
3271
|
-
type: string;
|
|
3272
|
-
enum: string[];
|
|
3273
|
-
nullable: true;
|
|
3274
|
-
description: string;
|
|
3275
|
-
};
|
|
3276
|
-
returns: {
|
|
3277
|
-
$ref: string;
|
|
3278
|
-
};
|
|
3279
|
-
result_schema: {
|
|
3280
|
-
$ref: string;
|
|
3281
|
-
description: string;
|
|
3282
|
-
};
|
|
3283
|
-
prompt: {
|
|
3284
|
-
type: string;
|
|
3285
|
-
nullable: true;
|
|
3286
|
-
description: string;
|
|
3287
|
-
};
|
|
3288
|
-
input: {
|
|
3289
|
-
type: string;
|
|
3290
|
-
nullable: true;
|
|
3291
|
-
description: string;
|
|
3292
|
-
required: never[];
|
|
3293
|
-
additionalProperties: true;
|
|
3294
|
-
};
|
|
3295
|
-
config: {
|
|
3296
|
-
type: string;
|
|
3297
|
-
nullable: true;
|
|
3298
|
-
description: string;
|
|
3299
|
-
required: never[];
|
|
3300
|
-
additionalProperties: true;
|
|
3301
|
-
};
|
|
3302
|
-
title: {
|
|
3303
|
-
type: string;
|
|
3304
|
-
nullable: true;
|
|
3305
|
-
description: string;
|
|
3306
|
-
};
|
|
3307
|
-
description: {
|
|
3308
|
-
type: string;
|
|
3309
|
-
nullable: true;
|
|
3310
|
-
description: string;
|
|
3311
|
-
};
|
|
3312
|
-
human_description: {
|
|
3313
|
-
type: string;
|
|
3314
|
-
nullable: true;
|
|
3315
|
-
description: string;
|
|
3316
|
-
};
|
|
3317
|
-
writes: {
|
|
3318
|
-
type: string;
|
|
3319
|
-
nullable: true;
|
|
3320
|
-
description: string;
|
|
3321
|
-
items: {
|
|
3322
|
-
type: string;
|
|
3323
|
-
};
|
|
3324
|
-
};
|
|
3325
|
-
skippable: {
|
|
3326
|
-
type: string;
|
|
3327
|
-
nullable: true;
|
|
3328
|
-
description: string;
|
|
3329
|
-
};
|
|
3330
|
-
max_retries: {
|
|
3331
|
-
type: string;
|
|
3332
|
-
nullable: true;
|
|
3333
|
-
description: string;
|
|
3334
|
-
};
|
|
3335
|
-
transitions: {
|
|
3336
|
-
type: string;
|
|
3337
|
-
nullable: true;
|
|
3338
|
-
description: string;
|
|
3339
|
-
items: {
|
|
3340
|
-
$ref: string;
|
|
3341
|
-
};
|
|
3342
|
-
};
|
|
3343
|
-
tools: {
|
|
3344
|
-
type: string;
|
|
3345
|
-
nullable: true;
|
|
3346
|
-
description: string;
|
|
3347
|
-
items: {
|
|
3348
|
-
type: string;
|
|
3349
|
-
};
|
|
3350
|
-
};
|
|
3351
|
-
model: {
|
|
3352
|
-
type: string;
|
|
3353
|
-
nullable: true;
|
|
3354
|
-
description: string;
|
|
3355
|
-
};
|
|
3356
|
-
task: {
|
|
3357
|
-
$ref: string;
|
|
3358
|
-
};
|
|
3359
|
-
foreach: {
|
|
3360
|
-
type: string;
|
|
3361
|
-
nullable: true;
|
|
3362
|
-
description: string;
|
|
3363
|
-
};
|
|
3364
|
-
as: {
|
|
3365
|
-
type: string;
|
|
3366
|
-
nullable: true;
|
|
3367
|
-
description: string;
|
|
3368
|
-
};
|
|
3369
|
-
item_id: {
|
|
3370
|
-
type: string;
|
|
3371
|
-
nullable: true;
|
|
3372
|
-
description: string;
|
|
3373
|
-
};
|
|
3374
|
-
node: {
|
|
3375
|
-
$ref: string;
|
|
3376
|
-
description: string;
|
|
3377
|
-
};
|
|
3378
|
-
max_concurrency: {
|
|
3379
|
-
type: string;
|
|
3380
|
-
minimum: number;
|
|
3381
|
-
nullable: true;
|
|
3382
|
-
description: string;
|
|
3383
|
-
};
|
|
3384
|
-
collect: {
|
|
3385
|
-
description: string;
|
|
3386
|
-
oneOf: ({
|
|
3387
|
-
type: string;
|
|
3388
|
-
minLength: number;
|
|
3389
|
-
$ref?: undefined;
|
|
3390
|
-
} | {
|
|
3391
|
-
type?: undefined;
|
|
3392
|
-
minLength?: undefined;
|
|
3393
|
-
$ref: string;
|
|
3394
|
-
})[];
|
|
3395
|
-
};
|
|
3396
|
-
failure_policy: {
|
|
3397
|
-
type: string;
|
|
3398
|
-
enum: string[];
|
|
3399
|
-
nullable: true;
|
|
3400
|
-
description: string;
|
|
3401
|
-
};
|
|
3402
|
-
join: {
|
|
3403
|
-
type: string;
|
|
3404
|
-
enum: string[];
|
|
3405
|
-
nullable: true;
|
|
3406
|
-
description: string;
|
|
3407
|
-
};
|
|
3408
|
-
branches: {
|
|
3409
|
-
type: string;
|
|
3410
|
-
nullable: true;
|
|
3411
|
-
description: string;
|
|
3412
|
-
items: {
|
|
3413
|
-
oneOf: {
|
|
3414
|
-
$ref: string;
|
|
3415
|
-
}[];
|
|
3416
|
-
};
|
|
3417
|
-
};
|
|
3418
|
-
metadata: {
|
|
3419
|
-
$ref: string;
|
|
3420
|
-
};
|
|
3421
|
-
};
|
|
3422
|
-
required: string[];
|
|
3423
|
-
additionalProperties: false;
|
|
3424
|
-
};
|
|
3425
|
-
transitionDefinition: {
|
|
3426
|
-
type: string;
|
|
3427
|
-
properties: {
|
|
3428
|
-
to: {
|
|
3429
|
-
type: string;
|
|
3430
|
-
minLength: number;
|
|
3431
|
-
description: string;
|
|
3432
|
-
};
|
|
3433
|
-
guard: {
|
|
3434
|
-
$ref: string;
|
|
3435
|
-
description: string;
|
|
3436
|
-
};
|
|
3437
|
-
trigger: {
|
|
3438
|
-
type: string;
|
|
3439
|
-
enum: string[];
|
|
3440
|
-
nullable: true;
|
|
3441
|
-
description: string;
|
|
3442
|
-
};
|
|
3443
|
-
label: {
|
|
3444
|
-
type: string;
|
|
3445
|
-
nullable: true;
|
|
3446
|
-
description: string;
|
|
3447
|
-
};
|
|
3448
|
-
metadata: {
|
|
3449
|
-
$ref: string;
|
|
3450
|
-
};
|
|
3451
|
-
};
|
|
3452
|
-
required: string[];
|
|
3453
|
-
additionalProperties: false;
|
|
3454
|
-
};
|
|
3455
|
-
processResourcesDefinition: {
|
|
3456
|
-
type: string;
|
|
3457
|
-
nullable: true;
|
|
3458
|
-
properties: {
|
|
3459
|
-
scripts: {
|
|
3460
|
-
type: string;
|
|
3461
|
-
nullable: true;
|
|
3462
|
-
description: string;
|
|
3463
|
-
required: never[];
|
|
3464
|
-
additionalProperties: {
|
|
3465
|
-
$ref: string;
|
|
3466
|
-
};
|
|
3467
|
-
};
|
|
3468
|
-
};
|
|
3469
|
-
required: never[];
|
|
3470
|
-
additionalProperties: false;
|
|
3471
|
-
};
|
|
3472
|
-
processScriptResource: {
|
|
3473
|
-
type: string;
|
|
3474
|
-
properties: {
|
|
3475
|
-
language: {
|
|
3476
|
-
type: string;
|
|
3477
|
-
enum: string[];
|
|
3478
|
-
};
|
|
3479
|
-
entrypoint: {
|
|
3480
|
-
type: string;
|
|
3481
|
-
minLength: number;
|
|
3482
|
-
};
|
|
3483
|
-
source: {
|
|
3484
|
-
$ref: string;
|
|
3485
|
-
};
|
|
3486
|
-
packages: {
|
|
3487
|
-
type: string;
|
|
3488
|
-
nullable: true;
|
|
3489
|
-
items: {
|
|
3490
|
-
type: string;
|
|
3491
|
-
};
|
|
3492
|
-
};
|
|
3493
|
-
};
|
|
3494
|
-
required: string[];
|
|
3495
|
-
additionalProperties: false;
|
|
3496
|
-
};
|
|
3497
|
-
processScriptSource: {
|
|
3498
|
-
$ref: string;
|
|
3499
|
-
};
|
|
3500
|
-
processScriptInlineSource: {
|
|
3501
|
-
type: string;
|
|
3502
|
-
properties: {
|
|
3503
|
-
type: {
|
|
3504
|
-
type: string;
|
|
3505
|
-
const: string;
|
|
3506
|
-
description: string;
|
|
3507
|
-
};
|
|
3508
|
-
files: {
|
|
3509
|
-
type: string;
|
|
3510
|
-
minProperties: number;
|
|
3511
|
-
required: never[];
|
|
3512
|
-
additionalProperties: {
|
|
3513
|
-
type: string;
|
|
3514
|
-
};
|
|
3515
|
-
};
|
|
3516
|
-
};
|
|
3517
|
-
required: string[];
|
|
3518
|
-
additionalProperties: false;
|
|
3519
|
-
};
|
|
3520
|
-
branchDefinition: {
|
|
3521
|
-
type: string;
|
|
3522
|
-
properties: {
|
|
3523
|
-
to: {
|
|
3524
|
-
type: string;
|
|
3525
|
-
minLength: number;
|
|
3526
|
-
description: string;
|
|
3527
|
-
};
|
|
3528
|
-
when: {
|
|
3529
|
-
$ref: string;
|
|
3530
|
-
description: string;
|
|
3531
|
-
};
|
|
3532
|
-
default: {
|
|
3533
|
-
type: string;
|
|
3534
|
-
nullable: true;
|
|
3535
|
-
description: string;
|
|
3536
|
-
};
|
|
3537
|
-
metadata: {
|
|
3538
|
-
$ref: string;
|
|
3539
|
-
};
|
|
3540
|
-
};
|
|
3541
|
-
required: string[];
|
|
3542
|
-
additionalProperties: false;
|
|
3543
|
-
};
|
|
3544
|
-
branchNodeBranchDefinition: {
|
|
3545
|
-
type: string;
|
|
3546
|
-
properties: {
|
|
3547
|
-
id: {
|
|
3548
|
-
type: string;
|
|
3549
|
-
minLength: number;
|
|
3550
|
-
description: string;
|
|
3551
|
-
};
|
|
3552
|
-
title: {
|
|
3553
|
-
type: string;
|
|
3554
|
-
nullable: true;
|
|
3555
|
-
description: string;
|
|
3556
|
-
};
|
|
3557
|
-
description: {
|
|
3558
|
-
type: string;
|
|
3559
|
-
nullable: true;
|
|
3560
|
-
description: string;
|
|
3561
|
-
};
|
|
3562
|
-
node: {
|
|
3563
|
-
$ref: string;
|
|
3564
|
-
description: string;
|
|
3565
|
-
};
|
|
3566
|
-
metadata: {
|
|
3567
|
-
$ref: string;
|
|
3568
|
-
};
|
|
3569
|
-
};
|
|
3570
|
-
required: string[];
|
|
3571
|
-
additionalProperties: false;
|
|
3572
|
-
};
|
|
3573
|
-
humanTaskDefinition: {
|
|
3574
|
-
type: string;
|
|
3575
|
-
properties: {
|
|
3576
|
-
title: {
|
|
3577
|
-
type: string;
|
|
3578
|
-
minLength: number;
|
|
3579
|
-
description: string;
|
|
3580
|
-
};
|
|
3581
|
-
description: {
|
|
3582
|
-
type: string;
|
|
3583
|
-
nullable: true;
|
|
3584
|
-
description: string;
|
|
3585
|
-
};
|
|
3586
|
-
assignee: {
|
|
3587
|
-
type: string;
|
|
3588
|
-
nullable: true;
|
|
3589
|
-
description: string;
|
|
3590
|
-
};
|
|
3591
|
-
fields: {
|
|
3592
|
-
type: string;
|
|
3593
|
-
description: string;
|
|
3594
|
-
items: {
|
|
3595
|
-
$ref: string;
|
|
3596
|
-
};
|
|
3597
|
-
};
|
|
3598
|
-
};
|
|
3599
|
-
required: string[];
|
|
3600
|
-
additionalProperties: false;
|
|
3601
|
-
};
|
|
3602
|
-
taskField: {
|
|
3603
|
-
type: string;
|
|
3604
|
-
properties: {
|
|
3605
|
-
name: {
|
|
3606
|
-
type: string;
|
|
3607
|
-
minLength: number;
|
|
3608
|
-
description: string;
|
|
3609
|
-
};
|
|
3610
|
-
type: {
|
|
3611
|
-
type: string;
|
|
3612
|
-
enum: string[];
|
|
3613
|
-
description: string;
|
|
3614
|
-
};
|
|
3615
|
-
required: {
|
|
3616
|
-
type: string;
|
|
3617
|
-
nullable: true;
|
|
3618
|
-
description: string;
|
|
3619
|
-
};
|
|
3620
|
-
label: {
|
|
3621
|
-
type: string;
|
|
3622
|
-
nullable: true;
|
|
3623
|
-
description: string;
|
|
3624
|
-
};
|
|
3625
|
-
options: {
|
|
3626
|
-
type: string;
|
|
3627
|
-
nullable: true;
|
|
3628
|
-
description: string;
|
|
3629
|
-
items: {
|
|
3630
|
-
type: string;
|
|
3631
|
-
};
|
|
3632
|
-
};
|
|
3633
|
-
default: {
|
|
3634
|
-
description: string;
|
|
3635
|
-
};
|
|
3636
|
-
};
|
|
3637
|
-
required: string[];
|
|
3638
|
-
additionalProperties: false;
|
|
3639
|
-
};
|
|
3640
|
-
processNodeReturnsDefinition: {
|
|
3641
|
-
type: string;
|
|
3642
|
-
properties: {
|
|
3643
|
-
from: {
|
|
3644
|
-
type: string;
|
|
3645
|
-
nullable: true;
|
|
3646
|
-
description: string;
|
|
3647
|
-
};
|
|
3648
|
-
context: {
|
|
3649
|
-
type: string;
|
|
3650
|
-
nullable: true;
|
|
3651
|
-
description: string;
|
|
3652
|
-
items: {
|
|
3653
|
-
type: string;
|
|
3654
|
-
};
|
|
3655
|
-
};
|
|
3656
|
-
};
|
|
3657
|
-
required: never[];
|
|
3658
|
-
additionalProperties: false;
|
|
3659
|
-
};
|
|
3660
|
-
parallelCollectDefinition: {
|
|
3661
|
-
type: string;
|
|
3662
|
-
properties: {
|
|
3663
|
-
into: {
|
|
3664
|
-
type: string;
|
|
3665
|
-
minLength: number;
|
|
3666
|
-
description: string;
|
|
3667
|
-
};
|
|
3668
|
-
mode: {
|
|
3669
|
-
type: string;
|
|
3670
|
-
enum: string[];
|
|
3671
|
-
nullable: true;
|
|
3672
|
-
description: string;
|
|
3673
|
-
};
|
|
3674
|
-
include: {
|
|
3675
|
-
type: string;
|
|
3676
|
-
nullable: true;
|
|
3677
|
-
description: string;
|
|
3678
|
-
items: {
|
|
3679
|
-
type: string;
|
|
3680
|
-
enum: string[];
|
|
3681
|
-
};
|
|
3682
|
-
};
|
|
3683
|
-
};
|
|
3684
|
-
required: string[];
|
|
3685
|
-
additionalProperties: false;
|
|
3686
|
-
};
|
|
3687
|
-
jsonLogicRule: {
|
|
3688
|
-
type: string;
|
|
3689
|
-
description: string;
|
|
3690
|
-
required: never[];
|
|
3691
|
-
additionalProperties: true;
|
|
3692
|
-
};
|
|
3693
|
-
jsonSchemaDefinition: {
|
|
3694
|
-
type: string;
|
|
3695
|
-
nullable: true;
|
|
3696
|
-
description: string;
|
|
3697
|
-
required: never[];
|
|
3698
|
-
additionalProperties: true;
|
|
3699
|
-
};
|
|
3700
|
-
};
|
|
2647
|
+
export type AdvanceProcessPayload = z.infer<typeof AdvanceProcessPayloadSchema>;
|
|
2648
|
+
export type AnswerProcessTaskPayload = z.infer<typeof AnswerProcessTaskPayloadSchema>;
|
|
2649
|
+
export type RetryProcessNodePayload = z.infer<typeof RetryProcessNodePayloadSchema>;
|
|
2650
|
+
export type ProcessContextResponse = z.infer<typeof ProcessContextResponseSchema>;
|
|
2651
|
+
export type ProcessHistoryResponse = z.infer<typeof ProcessHistoryResponseSchema>;
|
|
2652
|
+
export type ProcessTestRunStatus = z.infer<typeof ProcessTestRunStatusSchema>;
|
|
2653
|
+
export type ProcessTestVirtualActor = z.infer<typeof ProcessTestVirtualActorSchema>;
|
|
2654
|
+
export type ProcessTestFixtureResult = z.infer<typeof ProcessTestFixtureResultSchema>;
|
|
2655
|
+
export type ProcessTestFixtureError = z.infer<typeof ProcessTestFixtureErrorSchema>;
|
|
2656
|
+
export type ProcessTestFixtureResponse = z.infer<typeof ProcessTestFixtureResponseSchema>;
|
|
2657
|
+
export type ProcessTestNodeFixture = z.infer<typeof ProcessTestNodeFixtureSchema>;
|
|
2658
|
+
export type ProcessTestHumanAction = z.infer<typeof ProcessTestHumanActionSchema>;
|
|
2659
|
+
export type ProcessTestAssertions = z.infer<typeof ProcessTestAssertionsSchema>;
|
|
2660
|
+
export type ProcessTestScenario = z.infer<typeof ProcessTestScenarioSchema>;
|
|
2661
|
+
export type ProcessTestSuite = z.infer<typeof ProcessTestSuiteSchema>;
|
|
2662
|
+
export type CreateProcessTestSuitePayload = z.infer<typeof CreateProcessTestSuitePayloadSchema>;
|
|
2663
|
+
export type UpdateProcessTestSuitePayload = z.infer<typeof UpdateProcessTestSuitePayloadSchema>;
|
|
2664
|
+
export type StartProcessTestRunPayload = z.infer<typeof StartProcessTestRunPayloadSchema>;
|
|
2665
|
+
export type ProcessTestAssertionResult = z.infer<typeof ProcessTestAssertionResultSchema>;
|
|
2666
|
+
export type ProcessTestActorDecision = z.infer<typeof ProcessTestActorDecisionSchema>;
|
|
2667
|
+
export type ProcessTestCoverage = z.infer<typeof ProcessTestCoverageSchema>;
|
|
2668
|
+
export type ProcessTestChildTrace = z.infer<typeof ProcessTestChildTraceSchema>;
|
|
2669
|
+
export type ProcessTestScenarioResult = z.infer<typeof ProcessTestScenarioResultSchema>;
|
|
2670
|
+
export type ProcessTestRun = Omit<z.infer<typeof ProcessTestRunSchema>, 'process_definition_snapshot'> & {
|
|
2671
|
+
process_definition_snapshot: ProcessDefinitionBody;
|
|
2672
|
+
};
|
|
2673
|
+
export type ProcessTestStoredSubject = z.infer<typeof ProcessTestStoredSubjectSchema>;
|
|
2674
|
+
export type ProcessTestResolvedSubject = z.infer<typeof ProcessTestResolvedSubjectSchema>;
|
|
2675
|
+
export type ProcessTestInlineSubject = z.infer<typeof ProcessTestInlineSubjectSchema>;
|
|
2676
|
+
export type ProcessTestSubject = z.infer<typeof ProcessTestSubjectSchema>;
|
|
2677
|
+
export type ProcessTestTargetById = z.infer<typeof ProcessTestTargetByIdSchema>;
|
|
2678
|
+
export type ProcessTestTargetWithDefinition = Omit<z.infer<typeof ProcessTestTargetWithDefinitionSchema>, 'definition'> & {
|
|
2679
|
+
definition: ProcessDefinitionBody;
|
|
2680
|
+
};
|
|
2681
|
+
export type ProcessTestTarget = ProcessTestTargetById | ProcessTestTargetWithDefinition;
|
|
2682
|
+
export type SubmitProcessTestRunPayload = Omit<z.infer<typeof SubmitProcessTestRunPayloadSchema>, 'process'> & {
|
|
2683
|
+
process: ProcessTestTarget;
|
|
3701
2684
|
};
|
|
2685
|
+
export type UpdateProcessTestScenarioPayload = z.infer<typeof UpdateProcessTestScenarioPayloadSchema>;
|
|
3702
2686
|
|
|
3703
2687
|
// -----------------------------------------------------------------------------
|
|
3704
2688
|
// @vertesia/common: store/workflow.d.ts
|
|
@@ -3872,7 +2856,6 @@ export type SignalTask = z.infer<typeof SignalTaskSchema>;
|
|
|
3872
2856
|
export type TimerTask = z.infer<typeof TimerTaskSchema>;
|
|
3873
2857
|
export type WorkflowTask = z.infer<typeof WorkflowTaskSchema>;
|
|
3874
2858
|
export type WorkflowHistory = z.infer<typeof WorkflowHistorySchema>;
|
|
3875
|
-
export type HistoryFormat = 'events' | 'tasks' | 'agent';
|
|
3876
2859
|
export type AgentTask = z.infer<typeof AgentTaskSchema>;
|
|
3877
2860
|
export type WorkflowRun = z.infer<typeof WorkflowRunSchema>;
|
|
3878
2861
|
export type PendingActivity = z.infer<typeof PendingActivitySchema>;
|
|
@@ -3888,22 +2871,6 @@ export type WorkflowUpdatePublishResponse = z.infer<typeof WorkflowUpdatePublish
|
|
|
3888
2871
|
export type WorkflowActionResponse = z.infer<typeof WorkflowActionResponseSchema>;
|
|
3889
2872
|
export type WorkflowQueryResult = z.infer<typeof WorkflowQueryResultSchema>;
|
|
3890
2873
|
export type WorkflowInteractionVars = z.infer<typeof WorkflowInteractionVarsSchema>;
|
|
3891
|
-
export interface MultiDocumentsInteractionParams extends Omit<WorkflowExecutionPayload, 'config'> {
|
|
3892
|
-
config: {
|
|
3893
|
-
interactionName: string;
|
|
3894
|
-
action: DocumentActionConfig;
|
|
3895
|
-
data: Record<string, unknown>;
|
|
3896
|
-
};
|
|
3897
|
-
}
|
|
3898
|
-
export interface DocumentActionConfig {
|
|
3899
|
-
contentTypeName?: string;
|
|
3900
|
-
setAsProperties: boolean;
|
|
3901
|
-
setAsText: string;
|
|
3902
|
-
setNameFrom: string;
|
|
3903
|
-
upsert: boolean;
|
|
3904
|
-
documentId?: string;
|
|
3905
|
-
parentId?: string;
|
|
3906
|
-
}
|
|
3907
2874
|
export declare const WorkflowExecutionStatusValues: {
|
|
3908
2875
|
readonly UNKNOWN: 0;
|
|
3909
2876
|
readonly RUNNING: 1;
|
|
@@ -3956,7 +2923,7 @@ export type AgentMessageDetails = z.infer<typeof AgentMessageDetailsSchema>;
|
|
|
3956
2923
|
/**
|
|
3957
2924
|
* Details for THOUGHT messages representing tool calls (event_class: 'activity').
|
|
3958
2925
|
*/
|
|
3959
|
-
|
|
2926
|
+
interface ToolCallDetails {
|
|
3960
2927
|
event_class: 'activity';
|
|
3961
2928
|
tool: string;
|
|
3962
2929
|
tool_event?: 'started' | 'progress' | 'completed' | 'failed';
|
|
@@ -3972,54 +2939,11 @@ export interface ToolCallDetails {
|
|
|
3972
2939
|
outputFiles?: string[];
|
|
3973
2940
|
[key: string]: unknown;
|
|
3974
2941
|
}
|
|
3975
|
-
/**
|
|
3976
|
-
* Details for UPDATE messages signaling document creation or update.
|
|
3977
|
-
*/
|
|
3978
|
-
export interface DocumentEventDetails {
|
|
3979
|
-
event_class: 'document_created' | 'document_updated';
|
|
3980
|
-
document_id: string;
|
|
3981
|
-
title?: string;
|
|
3982
|
-
[key: string]: unknown;
|
|
3983
|
-
}
|
|
3984
|
-
/**
|
|
3985
|
-
* Details for REQUEST_INPUT messages with UX configuration.
|
|
3986
|
-
*/
|
|
3987
|
-
export interface RequestInputDetails {
|
|
3988
|
-
ux?: {
|
|
3989
|
-
options?: Array<{
|
|
3990
|
-
id: string;
|
|
3991
|
-
label: string;
|
|
3992
|
-
}>;
|
|
3993
|
-
variant?: string;
|
|
3994
|
-
multiSelect?: boolean;
|
|
3995
|
-
};
|
|
3996
|
-
[key: string]: unknown;
|
|
3997
|
-
}
|
|
3998
|
-
/**
|
|
3999
|
-
* Details for PLAN messages containing the plan structure.
|
|
4000
|
-
*/
|
|
4001
|
-
export interface PlanMessageDetails {
|
|
4002
|
-
plan: PlanTask[];
|
|
4003
|
-
comment?: string;
|
|
4004
|
-
[key: string]: unknown;
|
|
4005
|
-
}
|
|
4006
2942
|
export declare function isToolCallMessage(msg: AgentMessage): msg is AgentMessage & {
|
|
4007
2943
|
details: ToolCallDetails;
|
|
4008
2944
|
};
|
|
4009
2945
|
/** Extract the normalized resource references carried on a message's details, if any. */
|
|
4010
2946
|
export declare function getResourcesFromMessage(msg: AgentMessage): AgentResourceReference[];
|
|
4011
|
-
export declare function isDocumentEventMessage(msg: AgentMessage): msg is AgentMessage & {
|
|
4012
|
-
details: DocumentEventDetails;
|
|
4013
|
-
};
|
|
4014
|
-
export declare function isFileProcessingMessage(msg: AgentMessage): msg is AgentMessage & {
|
|
4015
|
-
details: FileProcessingDetails;
|
|
4016
|
-
};
|
|
4017
|
-
export declare function isPlanMessage(msg: AgentMessage): msg is AgentMessage & {
|
|
4018
|
-
details: PlanMessageDetails;
|
|
4019
|
-
};
|
|
4020
|
-
export declare function isRequestInputMessage(msg: AgentMessage): msg is AgentMessage & {
|
|
4021
|
-
details: RequestInputDetails;
|
|
4022
|
-
};
|
|
4023
2947
|
/**
|
|
4024
2948
|
* Details for STREAMING_CHUNK messages used for real-time LLM response streaming
|
|
4025
2949
|
* @deprecated Use CompactMessage with f field for streaming chunks
|
|
@@ -4044,7 +2968,7 @@ export type CompactMessage = z.infer<typeof CompactMessageSchema>;
|
|
|
4044
2968
|
* Legacy message format for backward compatibility.
|
|
4045
2969
|
* @deprecated Use CompactMessage instead
|
|
4046
2970
|
*/
|
|
4047
|
-
|
|
2971
|
+
type LegacyAgentMessage = AgentMessage;
|
|
4048
2972
|
/**
|
|
4049
2973
|
* Check if a message is in compact format
|
|
4050
2974
|
*/
|
|
@@ -4133,12 +3057,6 @@ export declare enum FileProcessingStatus {
|
|
|
4133
3057
|
ERROR = "error"
|
|
4134
3058
|
}
|
|
4135
3059
|
export type ConversationFile = z.infer<typeof ConversationFileSchema>;
|
|
4136
|
-
/**
|
|
4137
|
-
* A file is deliverable when it is ready and has not yet been delivered to the agent as part
|
|
4138
|
-
* of a user message. Deliverable files get attached to the next message; consumed ones stay
|
|
4139
|
-
* reachable to tools via artifact_path/md_path but are not re-attached.
|
|
4140
|
-
*/
|
|
4141
|
-
export declare function isDeliverableFile(file: ConversationFile): boolean;
|
|
4142
3060
|
/**
|
|
4143
3061
|
* Details for file processing SYSTEM messages.
|
|
4144
3062
|
* Used when type is AgentMessageType.SYSTEM with system_type: 'file_processing'.
|
|
@@ -4172,6 +3090,32 @@ export interface ConversationFileRef {
|
|
|
4172
3090
|
/** Artifact path without prefix (e.g., "files/document.pdf") */
|
|
4173
3091
|
artifact_path: string;
|
|
4174
3092
|
}
|
|
3093
|
+
/**
|
|
3094
|
+
* Manifest closing a staged-upload batch (the FileBatchClosed signal). Sent by clients that
|
|
3095
|
+
* stage files before the run exists (the agent start screen) after every upload attempt has
|
|
3096
|
+
* finished: those clients cannot wait for text extraction themselves, so the workflow owns the
|
|
3097
|
+
* "[Files Ready]" user turn. The manifest is the batch's authoritative membership — the
|
|
3098
|
+
* workflow delivers once, and only once, every listed file has settled, so a fast first file
|
|
3099
|
+
* can never trigger delivery while later files are still uploading.
|
|
3100
|
+
*/
|
|
3101
|
+
export interface ConversationFileBatchRef {
|
|
3102
|
+
/** Client-generated batch id. Stable across retries so redelivering the manifest is a no-op. */
|
|
3103
|
+
batch_id: string;
|
|
3104
|
+
/**
|
|
3105
|
+
* Ids (ConversationFileRef.id) of the files successfully uploaded and signaled for this
|
|
3106
|
+
* batch. Files whose upload failed client-side are listed in `failed_uploads` instead;
|
|
3107
|
+
* empty when every upload failed.
|
|
3108
|
+
*/
|
|
3109
|
+
file_ids: string[];
|
|
3110
|
+
/**
|
|
3111
|
+
* Files the client could not upload or signal. Without them a 1-of-2 batch would look
|
|
3112
|
+
* complete to the workflow, so the agent would never learn a file is missing.
|
|
3113
|
+
*/
|
|
3114
|
+
failed_uploads?: {
|
|
3115
|
+
name: string;
|
|
3116
|
+
error?: string;
|
|
3117
|
+
}[];
|
|
3118
|
+
}
|
|
4175
3119
|
/**
|
|
4176
3120
|
* Reference to a file removed from the conversation attachment set.
|
|
4177
3121
|
*/
|
|
@@ -4179,41 +3123,29 @@ export interface ConversationFileRemovedRef {
|
|
|
4179
3123
|
/** Client-generated unique ID */
|
|
4180
3124
|
id: string;
|
|
4181
3125
|
}
|
|
4182
|
-
/**
|
|
4183
|
-
* Get the Redis pub/sub channel name for workflow messages.
|
|
4184
|
-
* Used by both publishers (workflow activities, studio-server) and subscribers (zeno-server, clients).
|
|
4185
|
-
* @param workflowRunId - The Temporal workflow run ID (NOT the interaction execution run ID)
|
|
4186
|
-
*/
|
|
4187
|
-
export declare function getWorkflowChannel(workflowRunId: string): string;
|
|
4188
|
-
/**
|
|
4189
|
-
* Get the Redis list key for storing workflow message history.
|
|
4190
|
-
* Messages are stored here for retrieval by reconnecting clients.
|
|
4191
|
-
* @param workflowRunId - The Temporal workflow run ID (NOT the interaction execution run ID)
|
|
4192
|
-
*/
|
|
4193
|
-
export declare function getWorkflowUpdatesKey(workflowRunId: string): string;
|
|
4194
3126
|
export type PlanTask = z.infer<typeof PlanTaskSchema>;
|
|
4195
3127
|
export type Plan = z.infer<typeof PlanSchema>;
|
|
4196
3128
|
export declare const LOW_PRIORITY_TASK_QUEUE = "low_priority";
|
|
4197
3129
|
/**
|
|
4198
3130
|
* WebSocket message types for bidirectional communication
|
|
4199
3131
|
*/
|
|
4200
|
-
|
|
3132
|
+
interface WebSocketSignalMessage {
|
|
4201
3133
|
type: 'signal';
|
|
4202
3134
|
signalName: string;
|
|
4203
3135
|
data: unknown;
|
|
4204
3136
|
requestId?: string | number;
|
|
4205
3137
|
}
|
|
4206
|
-
|
|
3138
|
+
interface WebSocketPingMessage {
|
|
4207
3139
|
type: 'ping';
|
|
4208
3140
|
}
|
|
4209
|
-
|
|
3141
|
+
interface WebSocketPongMessage {
|
|
4210
3142
|
type: 'pong';
|
|
4211
3143
|
}
|
|
4212
|
-
|
|
3144
|
+
interface WebSocketAckMessage {
|
|
4213
3145
|
type: 'ack';
|
|
4214
3146
|
requestId: string | number;
|
|
4215
3147
|
}
|
|
4216
|
-
|
|
3148
|
+
interface WebSocketErrorMessage {
|
|
4217
3149
|
type: 'error';
|
|
4218
3150
|
requestId?: string | number;
|
|
4219
3151
|
error: string;
|
|
@@ -4315,7 +3247,7 @@ export interface AgentIntakeWorkflowResult {
|
|
|
4315
3247
|
generatedEmbeddings?: SupportedEmbeddingTypes[];
|
|
4316
3248
|
}
|
|
4317
3249
|
/** Progress reported by a child workstream */
|
|
4318
|
-
|
|
3250
|
+
interface WorkstreamProgressInfo {
|
|
4319
3251
|
launch_id: string;
|
|
4320
3252
|
workstream_id: string;
|
|
4321
3253
|
phase: 'planning' | 'executing_tool' | 'synthesizing' | 'blocked' | 'done';
|
|
@@ -4369,6 +3301,7 @@ export interface ActiveWorkstreamsQueryResult {
|
|
|
4369
3301
|
/** True when the workflow could not answer this optional query. */
|
|
4370
3302
|
unavailable?: boolean;
|
|
4371
3303
|
}
|
|
3304
|
+
export {};
|
|
4372
3305
|
|
|
4373
3306
|
// -----------------------------------------------------------------------------
|
|
4374
3307
|
// @vertesia/common: tool-execution.d.ts
|