@vertesia/appgen-docs 1.6.0-dev.20261014.015055Z → 1.6.0-dev.20261022.120426Z
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/symbol-index.json +3098 -2690
- package/lib/docs/vertesia-client.d.ts +92 -15
- package/lib/docs/vertesia-common.d.ts +40 -4
- package/package.json +11 -6
|
@@ -17,6 +17,7 @@ export type { EnableEnvironmentModelPayload, OrphanedAppInstallation } from '@ve
|
|
|
17
17
|
export { getOAuthPermissionScopes, Permission } from '@vertesia/common';
|
|
18
18
|
export * from './client.js';
|
|
19
19
|
export { default as DelegationGrantsApi } from './DelegationGrantsApi.js';
|
|
20
|
+
export type { ExecuteInteractionRequestOptions } from './execute.js';
|
|
20
21
|
export type { GroupsQueryOptions } from './GroupsApi.js';
|
|
21
22
|
export * from './InteractionBase.js';
|
|
22
23
|
export * from './InteractionOutput.js';
|
|
@@ -25,6 +26,7 @@ export { default as OAuthClientsApi } from './OAuthClientsApi.js';
|
|
|
25
26
|
export { default as OAuthGrantsApi } from './OAuthGrantsApi.js';
|
|
26
27
|
export { default as OAuthProvidersApi } from './OAuthProvidersApi.js';
|
|
27
28
|
export { default as OAuthServerApi } from './OAuthServerApi.js';
|
|
29
|
+
export { default as OidcFederationApi } from './OidcFederationApi.js';
|
|
28
30
|
export type { ComputePromptFacetsResponse, ListInteractionsResponse } from './PromptsApi.js';
|
|
29
31
|
export { default as RemoteMcpConnectionsApi } from './RemoteMcpConnectionsApi.js';
|
|
30
32
|
export type { ComputeRunFacetsResponse, FilterOption } from './RunsApi.js';
|
|
@@ -57,6 +59,7 @@ import OAuthClientsApi from './OAuthClientsApi.js';
|
|
|
57
59
|
import OAuthGrantsApi from './OAuthGrantsApi.js';
|
|
58
60
|
import OAuthProvidersApi from './OAuthProvidersApi.js';
|
|
59
61
|
import OAuthServerApi from './OAuthServerApi.js';
|
|
62
|
+
import OidcFederationApi from './OidcFederationApi.js';
|
|
60
63
|
import ProjectsApi from './ProjectsApi.js';
|
|
61
64
|
import PromptsApi from './PromptsApi.js';
|
|
62
65
|
import QuotaApi from './QuotaApi.js';
|
|
@@ -117,6 +120,7 @@ export declare class VertesiaClient extends AbstractFetchClient<VertesiaClient>
|
|
|
117
120
|
* tokenServerUrl
|
|
118
121
|
*/
|
|
119
122
|
tokenServerUrl: string;
|
|
123
|
+
oidcFederation: OidcFederationApi;
|
|
120
124
|
oauthClients: OAuthClientsApi;
|
|
121
125
|
oauthGrants: OAuthGrantsApi;
|
|
122
126
|
oauthServer: OAuthServerApi;
|
|
@@ -232,7 +236,7 @@ export declare function decodeEndpoints(endpoints: string | Record<string, strin
|
|
|
232
236
|
// @vertesia/client: AppsApi.d.ts
|
|
233
237
|
// -----------------------------------------------------------------------------
|
|
234
238
|
import { ApiTopic, type ClientBase } from '@vertesia/api-fetch-client';
|
|
235
|
-
import type { AgentRunResponse, AppApiKeyCollectionParams, AppBuildProgress, AppDeleteSummary, AppDevelopmentTaskDetails, AppDevelopmentTaskList, AppInspectionResult, AppInstallation, AppInstallationKind, AppInstallationListEntry, AppInstallationPayload, AppInstallationWithManifest, AppManifest, AppManifestData, AppPackage, AppPackageScope, AppRepoBranch, AppRepoCommits, AppRepoDocumentCommit, AppRepoRefs, AppRepoTree, AppScaffoldProgress, AppsQuery, AppToolCollection, AppVersionListQuery, AppVersionRecord, CountResult, CreateAppRepoBranchRequest, DeleteAppVersionResponse, McpApiKeyStatus, ProjectRef, PromoteAppVersionResponse, RequireAtLeastOne, StartAppBuildRequest, StartAppBuildResponse, StartAppDevelopmentTaskRequest, StartAppScaffoldRequest, StartAppScaffoldResponse, UpdateAppPayload, UpsertAppVersionRequest, ValidateUrlResponse } from '@vertesia/common';
|
|
239
|
+
import type { AgentRunResponse, AppApiKeyCollectionParams, AppBuildProgress, AppDeleteSummary, AppDevelopmentTaskDetails, AppDevelopmentTaskList, AppGithubConfiguration, AppGithubRepositoryList, AppGithubRepositorySetup, AppInspectionResult, AppInstallation, AppInstallationKind, AppInstallationListEntry, AppInstallationPayload, AppInstallationWithManifest, AppInstanceAvailability, AppManifest, AppManifestData, AppPackage, AppPackageScope, AppRepoBranch, AppRepoCommits, AppRepoDocumentCommit, AppRepoRefs, AppRepoTree, AppScaffoldProgress, AppsQuery, AppToolCollection, AppVersionListQuery, AppVersionRecord, CountResult, CreateAppRepoBranchRequest, DeleteAppVersionResponse, ExchangeAppGithubAuthorizationResponse, McpApiKeyStatus, ProjectRef, PromoteAppVersionResponse, RequireAtLeastOne, StartAppBuildRequest, StartAppBuildResponse, StartAppDevelopmentTaskRequest, StartAppGithubAuthorizationResponse, StartAppScaffoldRequest, StartAppScaffoldResponse, UpdateAppPayload, UpsertAppVersionRequest, ValidateUrlResponse } from '@vertesia/common';
|
|
236
240
|
export type { OrphanedAppInstallation } from '@vertesia/common';
|
|
237
241
|
export default class AppsApi extends ApiTopic {
|
|
238
242
|
constructor(parent: ClientBase);
|
|
@@ -248,6 +252,9 @@ export default class AppsApi extends ApiTopic {
|
|
|
248
252
|
* The key is write-only: it is encrypted server-side and never returned by any endpoint,
|
|
249
253
|
* so the response carries only the configured flag and a masked hint.
|
|
250
254
|
*/
|
|
255
|
+
setInstallationMcpApiKey(installationId: string, collectionId: string, apiKey: string): Promise<McpApiKeyStatus>;
|
|
256
|
+
getInstallationMcpApiKeyStatus(installationId: string, collectionId: string): Promise<McpApiKeyStatus>;
|
|
257
|
+
deleteInstallationMcpApiKey(installationId: string, collectionId: string): Promise<McpApiKeyStatus>;
|
|
251
258
|
setMcpCollectionApiKey(appId: string, collectionId: string, apiKey: string): Promise<McpApiKeyStatus>;
|
|
252
259
|
/** Whether an MCP tool collection has an API key stored, with a masked hint for display. */
|
|
253
260
|
getMcpCollectionApiKeyStatus(appId: string, collectionId: string): Promise<McpApiKeyStatus>;
|
|
@@ -269,6 +276,34 @@ export default class AppsApi extends ApiTopic {
|
|
|
269
276
|
getBuildProgress(appIdOrRecordId: string, workflowId: string, runId: string): Promise<AppBuildProgress>;
|
|
270
277
|
startScaffold(payload: StartAppScaffoldRequest): Promise<StartAppScaffoldResponse>;
|
|
271
278
|
getScaffoldProgress(workflowId: string, runId: string): Promise<AppScaffoldProgress>;
|
|
279
|
+
/**
|
|
280
|
+
* Return whether the global App Builder GitHub App is configured, together with its slug and
|
|
281
|
+
* installation URL when available.
|
|
282
|
+
*/
|
|
283
|
+
getGithubConfiguration(): Promise<AppGithubConfiguration>;
|
|
284
|
+
/**
|
|
285
|
+
* Start GitHub user authorization. The server creates a short-lived, single-use OAuth state
|
|
286
|
+
* bound to the current Vertesia user/account/project and returns the GitHub authorization URL.
|
|
287
|
+
*/
|
|
288
|
+
startGithubAuthorization(): Promise<StartAppGithubAuthorizationResponse>;
|
|
289
|
+
/**
|
|
290
|
+
* Complete GitHub authorization with the callback code and state. The server consumes the state,
|
|
291
|
+
* verifies the current user's writable GitHub App installations, discards the GitHub user token,
|
|
292
|
+
* and returns those installations plus an opaque `connection_id`. That id references a
|
|
293
|
+
* short-lived server-side snapshot of the writable repositories verified for this Vertesia
|
|
294
|
+
* user/account/project; selecting a repository consumes it once.
|
|
295
|
+
*/
|
|
296
|
+
exchangeGithubAuthorization(code: string, state: string): Promise<ExchangeAppGithubAuthorizationResponse>;
|
|
297
|
+
/**
|
|
298
|
+
* List repositories with push access for one installation verified during authorization. The
|
|
299
|
+
* connection id is scoped to the current Vertesia user/account/project and expires shortly.
|
|
300
|
+
*/
|
|
301
|
+
listGithubRepositories(connectionId: string, installationId: string): Promise<AppGithubRepositoryList>;
|
|
302
|
+
/**
|
|
303
|
+
* List branches and verify whether a selected branch can safely receive generated source.
|
|
304
|
+
* The verified connection remains reusable until app creation consumes it.
|
|
305
|
+
*/
|
|
306
|
+
getGithubRepositorySetup(connectionId: string, installationId: string, repository: string, branch: string): Promise<AppGithubRepositorySetup>;
|
|
272
307
|
/**
|
|
273
308
|
* Get the list if tools provided by the given app.
|
|
274
309
|
* @param appId
|
|
@@ -370,7 +405,7 @@ export default class AppsApi extends ApiTopic {
|
|
|
370
405
|
client_id?: string;
|
|
371
406
|
client_secret?: string;
|
|
372
407
|
scopes?: string[];
|
|
373
|
-
}>, apiKeyParams?: AppApiKeyCollectionParams): Promise<AppInstallation>;
|
|
408
|
+
}>, apiKeyParams?: AppApiKeyCollectionParams, mcpParameters?: AppInstallationPayload['mcp_parameters'], mcpSharedParameters?: AppInstallationPayload['mcp_shared_parameters'], instance?: Pick<AppInstallationPayload, 'instance_key' | 'display_name' | 'namespace_overrides'>): Promise<AppInstallation>;
|
|
374
409
|
/**
|
|
375
410
|
* Remove the given app from the current project.
|
|
376
411
|
* @param installationId - the id of the app installation
|
|
@@ -381,6 +416,8 @@ export default class AppsApi extends ApiTopic {
|
|
|
381
416
|
* get an app unstallation given its name or null if the app is not installed
|
|
382
417
|
* @returns
|
|
383
418
|
*/
|
|
419
|
+
getAppInstanceAvailability(): Promise<AppInstanceAvailability>;
|
|
420
|
+
getAppInstallation(installationId: string): Promise<AppInstallationWithManifest>;
|
|
384
421
|
getAppInstallationByName(appName: string): Promise<AppInstallationWithManifest | null>;
|
|
385
422
|
/**
|
|
386
423
|
* Get the project refs where the application is visible by the current user.
|
|
@@ -432,6 +469,7 @@ export default class AppsApi extends ApiTopic {
|
|
|
432
469
|
// -----------------------------------------------------------------------------
|
|
433
470
|
import { ApiTopic, type ClientBase, type IRequestParams } from '@vertesia/api-fetch-client';
|
|
434
471
|
import type { AsyncExecutionPayload, AsyncExecutionResult, ComputedFacetResponse, ComputeInteractionFacetPayload, DeleteByIdResult, GeneratedInteractionDefinition, GeneratedTestDataRecord, GenerateInteractionPayload, GenerateTestDataPayload, ImprovePromptPayload, ImprovePromptPayloadConfig, Interaction, InteractionCreatePayload, InteractionDeletePayload, InteractionEndpoint, InteractionEndpointQuery, InteractionExecutionPayload, InteractionForkPayload, InteractionPublishPayload, InteractionRef, InteractionRefWithSchema, InteractionSearchPayload, InteractionSearchQuery, InteractionsExportPayload, InteractionTags, InteractionUpdatePayload, PromptImprovementResponse, RateLimitRequestPayload, RateLimitRequestResponse, ResolvedInteractionExecutionInfo, ResolveInteractionQuery } from '@vertesia/common';
|
|
472
|
+
import { type ExecuteInteractionRequestOptions } from './execute.js';
|
|
435
473
|
import { InteractionCatalogApi } from './InteractionCatalogApi.js';
|
|
436
474
|
import { type EnhancedInteractionExecutionResult } from './InteractionOutput.js';
|
|
437
475
|
export default class InteractionsApi extends ApiTopic {
|
|
@@ -544,9 +582,10 @@ export default class InteractionsApi extends ApiTopic {
|
|
|
544
582
|
* @param nameWithTag
|
|
545
583
|
* @param payload
|
|
546
584
|
* @param onChunk
|
|
585
|
+
* @param requestOptions request options, e.g. `{ query: { include_prompt: false } }` to omit the rendered prompt
|
|
547
586
|
* @returns
|
|
548
587
|
*/
|
|
549
|
-
executeByName<ResultT = unknown, ParamsT = unknown>(nameWithTag: string, payload?: InteractionExecutionPayload, onChunk?: (chunk: string) => void, requestOptions?:
|
|
588
|
+
executeByName<ResultT = unknown, ParamsT = unknown>(nameWithTag: string, payload?: InteractionExecutionPayload, onChunk?: (chunk: string) => void, requestOptions?: ExecuteInteractionRequestOptions): Promise<EnhancedInteractionExecutionResult<ResultT, ParamsT>>;
|
|
550
589
|
/**
|
|
551
590
|
* Execute an interaction in an workflow
|
|
552
591
|
* @param payload
|
|
@@ -745,7 +784,7 @@ export default class SkillsApi extends ApiTopic {
|
|
|
745
784
|
// -----------------------------------------------------------------------------
|
|
746
785
|
import type { ExecutionResponse } from '@llumiverse/common';
|
|
747
786
|
import { ApiTopic, type ClientBase, type IRequestParams } from '@vertesia/api-fetch-client';
|
|
748
|
-
import type { ComputeRunFacetPayload, ComputeRunFacetsResponse, ExecutionRunDocRef, ExecutionRunRef, FindPayload, FindRunResult, PopulatedExecutionRun, RunClonePayload, RunCreatePayload, RunListingFilters, RunListingQueryOptions, RunSearchPayload, ToolResultsPayload, UserMessagePayload } from '@vertesia/common';
|
|
787
|
+
import type { ComputeRunFacetPayload, ComputeRunFacetsResponse, ExecutionRunDocRef, ExecutionRunRef, FindPayload, FindRunResult, GetRunQuery, PopulatedExecutionRun, RunClonePayload, RunCreatePayload, RunListingFilters, RunListingQueryOptions, RunSearchPayload, ToolResultsPayload, UserMessagePayload } from '@vertesia/common';
|
|
749
788
|
import { type EnhancedExecutionRun, type EnhancedInteractionExecutionResult } from './InteractionOutput.js';
|
|
750
789
|
export interface FilterOption {
|
|
751
790
|
id: string;
|
|
@@ -768,9 +807,10 @@ export declare class RunsApi extends ApiTopic {
|
|
|
768
807
|
* Get a run by id
|
|
769
808
|
*
|
|
770
809
|
* @param id
|
|
810
|
+
* @param query response options, e.g. `{ include_prompt: false }` to omit the rendered prompt
|
|
771
811
|
* @returns InteractionResult
|
|
772
812
|
**/
|
|
773
|
-
retrieve<ResultT = unknown, ParamsT = unknown>(id: string): Promise<EnhancedExecutionRun<ResultT, ParamsT>>;
|
|
813
|
+
retrieve<ResultT = unknown, ParamsT = unknown>(id: string, query?: GetRunQuery): Promise<EnhancedExecutionRun<ResultT, ParamsT>>;
|
|
774
814
|
retrievePopulated<P = unknown>(id: string): Promise<PopulatedExecutionRun<P>>;
|
|
775
815
|
/**
|
|
776
816
|
* Get filter options for a field
|
|
@@ -933,12 +973,6 @@ export declare class ObjectsApi extends ApiTopic {
|
|
|
933
973
|
exportContentObjectShardViaBulk(payload: ZenoBulkContentObjectExportShardRequest, timeoutMs?: number | false | null): Promise<ZenoBulkContentObjectExportShardResult>;
|
|
934
974
|
splitContentObjectExportShardViaBulk(payload: ZenoBulkContentObjectExportSplitShardRequest, timeoutMs?: number | false | null): Promise<ZenoBulkContentObjectExportSplitShardResponse>;
|
|
935
975
|
composeContentObjectExportViaBulk(payload: ZenoBulkContentObjectExportComposeRequest, timeoutMs?: number | false | null): Promise<ContentObjectExportResult>;
|
|
936
|
-
/**
|
|
937
|
-
* Get the zeno-bulk base URL.
|
|
938
|
-
* Dev branches: store URL contains "zeno-server" -> replace with "zeno-bulk".
|
|
939
|
-
* Production/preview: same domain, LB routes /export to zeno-bulk.
|
|
940
|
-
*/
|
|
941
|
-
private get zenoBulkBaseUrl();
|
|
942
976
|
private zenoBulkPost;
|
|
943
977
|
listFolders(_path?: string): void;
|
|
944
978
|
/** Find object based on query */
|
|
@@ -1169,6 +1203,9 @@ export declare class AgentsApi extends ApiTopic {
|
|
|
1169
1203
|
/**
|
|
1170
1204
|
* Create and start a new agent run.
|
|
1171
1205
|
* Returns the created AgentRun with its stable id.
|
|
1206
|
+
*
|
|
1207
|
+
* Set `idempotency_key` on an agent run to make the call safe to retry: the client's retry policy
|
|
1208
|
+
* then applies, and a replayed request returns the run the first one started.
|
|
1172
1209
|
*/
|
|
1173
1210
|
start<TData = Record<string, unknown>>(payload: CreateAgentRunPayload<TData>): Promise<AgentRun<TData>>;
|
|
1174
1211
|
start<TData = Record<string, unknown>>(payload: CreateProcessRunPayload<TData>): Promise<ProcessRun>;
|
|
@@ -2066,6 +2103,10 @@ export declare class ProcessApi extends ApiTopic {
|
|
|
2066
2103
|
create(payload: CreateProcessDefinitionPayload): Promise<ProcessDefinition>;
|
|
2067
2104
|
update(id: string, payload: UpdateProcessDefinitionPayload): Promise<ProcessDefinition>;
|
|
2068
2105
|
listVersions(id: string): Promise<ProcessDefinition[]>;
|
|
2106
|
+
/**
|
|
2107
|
+
* Publish a draft revision. Set `idempotency_key` to make the call safe to retry: without one, a
|
|
2108
|
+
* replay of a publish that already succeeded is rejected, so no client retry applies.
|
|
2109
|
+
*/
|
|
2069
2110
|
publish(id: string, payload: PublishProcessDefinitionPayload): Promise<ProcessDefinition>;
|
|
2070
2111
|
revert(id: string, payload: RevertProcessDefinitionPayload): Promise<ProcessDefinition>;
|
|
2071
2112
|
delete(id: string): Promise<{
|
|
@@ -3907,9 +3948,12 @@ export {};
|
|
|
3907
3948
|
// -----------------------------------------------------------------------------
|
|
3908
3949
|
// @vertesia/common: apps.d.ts
|
|
3909
3950
|
// -----------------------------------------------------------------------------
|
|
3951
|
+
import type { AuthTokenPayload } from './apikey.js';
|
|
3910
3952
|
import type * as Wire from './wire-types.generated.js';
|
|
3911
3953
|
/** Allowed values for AppUINavItem.preferredSection */
|
|
3912
3954
|
export declare const PREFERRED_SECTIONS: readonly ['default', 'footer', 'settings'];
|
|
3955
|
+
/** Convert an app display/package name into the canonical persisted app id. */
|
|
3956
|
+
export declare function slugifyAppId(value: string): string;
|
|
3913
3957
|
/**
|
|
3914
3958
|
* Additional navigation item for an app's UI configuration.
|
|
3915
3959
|
* Used in AppUIConfig.navigation to define sidebar navigation entries in CompositeApp shell contexts.
|
|
@@ -3937,6 +3981,7 @@ export interface AppUINavItem {
|
|
|
3937
3981
|
preferredSection?: (typeof PREFERRED_SECTIONS)[number];
|
|
3938
3982
|
}
|
|
3939
3983
|
export type AppUIConfig = Wire.AppUIConfig;
|
|
3984
|
+
export type AppOAuthClientConfig = Wire.AppOAuthClientConfig;
|
|
3940
3985
|
export type AppInstallationProjectsQuery = Wire.AppInstallationProjectsQuery;
|
|
3941
3986
|
export type AppInstallationsQuery = Wire.AppInstallationsQuery;
|
|
3942
3987
|
export type AppListScope = Wire.AppListScope;
|
|
@@ -3957,7 +4002,7 @@ export type ToolCollectionObject = Wire.ToolCollectionObject;
|
|
|
3957
4002
|
* @param vars - Optional endpoint variables to substitute in URLs
|
|
3958
4003
|
* @returns Normalized ToolCollectionObject
|
|
3959
4004
|
*/
|
|
3960
|
-
export declare function normalizeToolCollection(collection: ToolCollectionObject, vars?: Endpoints): ToolCollectionObject;
|
|
4005
|
+
export declare function normalizeToolCollection(collection: ToolCollectionObject, vars?: Endpoints, sharedParameters?: MCPToolCollectionObject['parameters']): ToolCollectionObject;
|
|
3961
4006
|
/**
|
|
3962
4007
|
* Metadata hints from MCP tool annotations (per MCP spec).
|
|
3963
4008
|
*/
|
|
@@ -4017,8 +4062,22 @@ export type StartAppBuildResponse = Wire.StartAppBuildResponse;
|
|
|
4017
4062
|
export type AppBuildProgressStatus = Wire.AppBuildProgressStatus;
|
|
4018
4063
|
export type AppBuildProgress = Wire.AppBuildProgress;
|
|
4019
4064
|
export type AppScaffoldModule = Wire.AppScaffoldModule;
|
|
4065
|
+
export type AppScaffoldSourceMode = Wire.AppScaffoldSourceMode;
|
|
4020
4066
|
export type StartAppScaffoldRequest = Wire.StartAppScaffoldRequest;
|
|
4021
4067
|
export type StartAppScaffoldResponse = Wire.StartAppScaffoldResponse;
|
|
4068
|
+
export type AppGithubConfiguration = Wire.AppGithubConfiguration;
|
|
4069
|
+
export type StartAppGithubAuthorizationResponse = Wire.StartAppGithubAuthorizationResponse;
|
|
4070
|
+
export type ExchangeAppGithubAuthorizationRequest = Wire.ExchangeAppGithubAuthorizationRequest;
|
|
4071
|
+
export type AppGithubRepositoriesQuery = Wire.AppGithubRepositoriesQuery;
|
|
4072
|
+
export type AppGithubInstallation = Wire.AppGithubInstallation;
|
|
4073
|
+
export type AppGithubAccount = Wire.AppGithubAccount;
|
|
4074
|
+
export type ExchangeAppGithubAuthorizationResponse = Wire.ExchangeAppGithubAuthorizationResponse;
|
|
4075
|
+
export type AppGithubRepository = Wire.AppGithubRepository;
|
|
4076
|
+
export type AppGithubRepositoryCreation = Wire.AppGithubRepositoryCreation;
|
|
4077
|
+
export type AppGithubRepositoryList = Wire.AppGithubRepositoryList;
|
|
4078
|
+
export type AppGithubRepositorySetupQuery = Wire.AppGithubRepositorySetupQuery;
|
|
4079
|
+
export type AppGithubBranchState = Wire.AppGithubBranchState;
|
|
4080
|
+
export type AppGithubRepositorySetup = Wire.AppGithubRepositorySetup;
|
|
4022
4081
|
export type StartAppDevelopmentTaskRequest = Wire.StartAppDevelopmentTaskRequest;
|
|
4023
4082
|
export type AppScaffoldProgressStatus = Wire.AppScaffoldProgressStatus;
|
|
4024
4083
|
export type AppScaffoldProgress = Wire.AppScaffoldProgress;
|
|
@@ -4038,6 +4097,7 @@ export type AppAccessControl = Wire.AppAccessControl;
|
|
|
4038
4097
|
export type AppManifestData = Wire.AppManifestData;
|
|
4039
4098
|
export type UpdateAppPayload = Wire.UpdateAppPayload;
|
|
4040
4099
|
export type AppGitSourceConfig = Wire.AppGitSourceConfig;
|
|
4100
|
+
export type AppGitSourceProvider = Wire.AppGitSourceProvider;
|
|
4041
4101
|
export type AppSourceConfig = Wire.AppSourceConfig;
|
|
4042
4102
|
/**
|
|
4043
4103
|
* Deployment-time URL endpoints that can be referenced in app manifest URLs
|
|
@@ -4316,6 +4376,23 @@ export type ValidateUrlResponse = Wire.ValidateUrlResponse;
|
|
|
4316
4376
|
*/
|
|
4317
4377
|
export type AppDeleteSummary = Wire.AppDeleteSummary;
|
|
4318
4378
|
export type UpdateAppInstallationOAuthApprovalPayload = Wire.UpdateAppInstallationOAuthApprovalPayload;
|
|
4379
|
+
/** Check exact installation grants; legacy app-name grants authorize only the default instance. */
|
|
4380
|
+
export declare function hasAppInstallationAccess(token: AuthTokenPayload, installation: {
|
|
4381
|
+
id: string;
|
|
4382
|
+
project: string;
|
|
4383
|
+
instance_key?: string;
|
|
4384
|
+
manifest: {
|
|
4385
|
+
name: string;
|
|
4386
|
+
};
|
|
4387
|
+
}, ui?: boolean): boolean;
|
|
4388
|
+
/** Persist this effective collection in catalogs so discovery and execution use the same namespace. */
|
|
4389
|
+
export declare function resolveInstallationCollection(collection: ToolCollectionObject, installation: Pick<AppInstallation, 'instance_key' | 'namespace_overrides' | 'namespace_conflicts'>): ToolCollectionObject;
|
|
4390
|
+
export type AppInstanceAvailability = Wire.AppInstanceAvailability;
|
|
4391
|
+
export type McpPublicParameter = Wire.McpPublicParameter;
|
|
4392
|
+
export type McpSecretParameter = Wire.McpSecretParameter;
|
|
4393
|
+
export type McpConnectionParameter = Wire.McpConnectionParameter;
|
|
4394
|
+
/** Whether a manifest can safely back an additional MCP-only installation. */
|
|
4395
|
+
export declare function isMcpOnlyInstanceManifest(manifest: Pick<AppManifestData, 'endpoint' | 'ui' | 'capabilities' | 'tool_collections'>): boolean;
|
|
4319
4396
|
|
|
4320
4397
|
// -----------------------------------------------------------------------------
|
|
4321
4398
|
// @vertesia/common: interaction.d.ts
|
|
@@ -4354,9 +4431,9 @@ export interface StoredCatalogInteractionsQuery extends CatalogTagQuery {
|
|
|
4354
4431
|
status?: string;
|
|
4355
4432
|
published?: boolean;
|
|
4356
4433
|
}
|
|
4357
|
-
export
|
|
4358
|
-
|
|
4359
|
-
|
|
4434
|
+
export type ExecuteNamedInteractionQuery = Wire.ExecuteNamedInteractionQuery;
|
|
4435
|
+
export type GetRunQuery = Wire.GetRunQuery;
|
|
4436
|
+
export type ExecuteInteractionByEndpointQuery = Wire.ExecuteInteractionByEndpointQuery;
|
|
4360
4437
|
export interface ExecuteInteractionByEndpointHeaders {
|
|
4361
4438
|
'x-interaction-tag'?: string;
|
|
4362
4439
|
}
|
|
@@ -82,9 +82,12 @@ export * from './workflow-analytics.js';
|
|
|
82
82
|
// -----------------------------------------------------------------------------
|
|
83
83
|
// @vertesia/common: apps.d.ts
|
|
84
84
|
// -----------------------------------------------------------------------------
|
|
85
|
+
import type { AuthTokenPayload } from './apikey.js';
|
|
85
86
|
import type * as Wire from './wire-types.generated.js';
|
|
86
87
|
/** Allowed values for AppUINavItem.preferredSection */
|
|
87
88
|
export declare const PREFERRED_SECTIONS: readonly ['default', 'footer', 'settings'];
|
|
89
|
+
/** Convert an app display/package name into the canonical persisted app id. */
|
|
90
|
+
export declare function slugifyAppId(value: string): string;
|
|
88
91
|
/**
|
|
89
92
|
* Additional navigation item for an app's UI configuration.
|
|
90
93
|
* Used in AppUIConfig.navigation to define sidebar navigation entries in CompositeApp shell contexts.
|
|
@@ -112,6 +115,7 @@ export interface AppUINavItem {
|
|
|
112
115
|
preferredSection?: (typeof PREFERRED_SECTIONS)[number];
|
|
113
116
|
}
|
|
114
117
|
export type AppUIConfig = Wire.AppUIConfig;
|
|
118
|
+
export type AppOAuthClientConfig = Wire.AppOAuthClientConfig;
|
|
115
119
|
export type AppInstallationProjectsQuery = Wire.AppInstallationProjectsQuery;
|
|
116
120
|
export type AppInstallationsQuery = Wire.AppInstallationsQuery;
|
|
117
121
|
export type AppListScope = Wire.AppListScope;
|
|
@@ -132,7 +136,7 @@ export type ToolCollectionObject = Wire.ToolCollectionObject;
|
|
|
132
136
|
* @param vars - Optional endpoint variables to substitute in URLs
|
|
133
137
|
* @returns Normalized ToolCollectionObject
|
|
134
138
|
*/
|
|
135
|
-
export declare function normalizeToolCollection(collection: ToolCollectionObject, vars?: Endpoints): ToolCollectionObject;
|
|
139
|
+
export declare function normalizeToolCollection(collection: ToolCollectionObject, vars?: Endpoints, sharedParameters?: MCPToolCollectionObject['parameters']): ToolCollectionObject;
|
|
136
140
|
/**
|
|
137
141
|
* Metadata hints from MCP tool annotations (per MCP spec).
|
|
138
142
|
*/
|
|
@@ -192,8 +196,22 @@ export type StartAppBuildResponse = Wire.StartAppBuildResponse;
|
|
|
192
196
|
export type AppBuildProgressStatus = Wire.AppBuildProgressStatus;
|
|
193
197
|
export type AppBuildProgress = Wire.AppBuildProgress;
|
|
194
198
|
export type AppScaffoldModule = Wire.AppScaffoldModule;
|
|
199
|
+
export type AppScaffoldSourceMode = Wire.AppScaffoldSourceMode;
|
|
195
200
|
export type StartAppScaffoldRequest = Wire.StartAppScaffoldRequest;
|
|
196
201
|
export type StartAppScaffoldResponse = Wire.StartAppScaffoldResponse;
|
|
202
|
+
export type AppGithubConfiguration = Wire.AppGithubConfiguration;
|
|
203
|
+
export type StartAppGithubAuthorizationResponse = Wire.StartAppGithubAuthorizationResponse;
|
|
204
|
+
export type ExchangeAppGithubAuthorizationRequest = Wire.ExchangeAppGithubAuthorizationRequest;
|
|
205
|
+
export type AppGithubRepositoriesQuery = Wire.AppGithubRepositoriesQuery;
|
|
206
|
+
export type AppGithubInstallation = Wire.AppGithubInstallation;
|
|
207
|
+
export type AppGithubAccount = Wire.AppGithubAccount;
|
|
208
|
+
export type ExchangeAppGithubAuthorizationResponse = Wire.ExchangeAppGithubAuthorizationResponse;
|
|
209
|
+
export type AppGithubRepository = Wire.AppGithubRepository;
|
|
210
|
+
export type AppGithubRepositoryCreation = Wire.AppGithubRepositoryCreation;
|
|
211
|
+
export type AppGithubRepositoryList = Wire.AppGithubRepositoryList;
|
|
212
|
+
export type AppGithubRepositorySetupQuery = Wire.AppGithubRepositorySetupQuery;
|
|
213
|
+
export type AppGithubBranchState = Wire.AppGithubBranchState;
|
|
214
|
+
export type AppGithubRepositorySetup = Wire.AppGithubRepositorySetup;
|
|
197
215
|
export type StartAppDevelopmentTaskRequest = Wire.StartAppDevelopmentTaskRequest;
|
|
198
216
|
export type AppScaffoldProgressStatus = Wire.AppScaffoldProgressStatus;
|
|
199
217
|
export type AppScaffoldProgress = Wire.AppScaffoldProgress;
|
|
@@ -213,6 +231,7 @@ export type AppAccessControl = Wire.AppAccessControl;
|
|
|
213
231
|
export type AppManifestData = Wire.AppManifestData;
|
|
214
232
|
export type UpdateAppPayload = Wire.UpdateAppPayload;
|
|
215
233
|
export type AppGitSourceConfig = Wire.AppGitSourceConfig;
|
|
234
|
+
export type AppGitSourceProvider = Wire.AppGitSourceProvider;
|
|
216
235
|
export type AppSourceConfig = Wire.AppSourceConfig;
|
|
217
236
|
/**
|
|
218
237
|
* Deployment-time URL endpoints that can be referenced in app manifest URLs
|
|
@@ -491,6 +510,23 @@ export type ValidateUrlResponse = Wire.ValidateUrlResponse;
|
|
|
491
510
|
*/
|
|
492
511
|
export type AppDeleteSummary = Wire.AppDeleteSummary;
|
|
493
512
|
export type UpdateAppInstallationOAuthApprovalPayload = Wire.UpdateAppInstallationOAuthApprovalPayload;
|
|
513
|
+
/** Check exact installation grants; legacy app-name grants authorize only the default instance. */
|
|
514
|
+
export declare function hasAppInstallationAccess(token: AuthTokenPayload, installation: {
|
|
515
|
+
id: string;
|
|
516
|
+
project: string;
|
|
517
|
+
instance_key?: string;
|
|
518
|
+
manifest: {
|
|
519
|
+
name: string;
|
|
520
|
+
};
|
|
521
|
+
}, ui?: boolean): boolean;
|
|
522
|
+
/** Persist this effective collection in catalogs so discovery and execution use the same namespace. */
|
|
523
|
+
export declare function resolveInstallationCollection(collection: ToolCollectionObject, installation: Pick<AppInstallation, 'instance_key' | 'namespace_overrides' | 'namespace_conflicts'>): ToolCollectionObject;
|
|
524
|
+
export type AppInstanceAvailability = Wire.AppInstanceAvailability;
|
|
525
|
+
export type McpPublicParameter = Wire.McpPublicParameter;
|
|
526
|
+
export type McpSecretParameter = Wire.McpSecretParameter;
|
|
527
|
+
export type McpConnectionParameter = Wire.McpConnectionParameter;
|
|
528
|
+
/** Whether a manifest can safely back an additional MCP-only installation. */
|
|
529
|
+
export declare function isMcpOnlyInstanceManifest(manifest: Pick<AppManifestData, 'endpoint' | 'ui' | 'capabilities' | 'tool_collections'>): boolean;
|
|
494
530
|
|
|
495
531
|
// -----------------------------------------------------------------------------
|
|
496
532
|
// @vertesia/common: data-platform.d.ts
|
|
@@ -904,9 +940,9 @@ export interface StoredCatalogInteractionsQuery extends CatalogTagQuery {
|
|
|
904
940
|
status?: string;
|
|
905
941
|
published?: boolean;
|
|
906
942
|
}
|
|
907
|
-
export
|
|
908
|
-
|
|
909
|
-
|
|
943
|
+
export type ExecuteNamedInteractionQuery = Wire.ExecuteNamedInteractionQuery;
|
|
944
|
+
export type GetRunQuery = Wire.GetRunQuery;
|
|
945
|
+
export type ExecuteInteractionByEndpointQuery = Wire.ExecuteInteractionByEndpointQuery;
|
|
910
946
|
export interface ExecuteInteractionByEndpointHeaders {
|
|
911
947
|
'x-interaction-tag'?: string;
|
|
912
948
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vertesia/appgen-docs",
|
|
3
|
-
"version": "1.6.0-dev.
|
|
3
|
+
"version": "1.6.0-dev.20261022.120426Z",
|
|
4
4
|
"description": "Generated SDK references and development guidance for Vertesia app agents",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./lib/index.js",
|
|
@@ -16,11 +16,11 @@
|
|
|
16
16
|
}
|
|
17
17
|
},
|
|
18
18
|
"devDependencies": {
|
|
19
|
-
"@types/node": "^24.19.
|
|
20
|
-
"@vertesia/client": "1.6.0-dev.
|
|
21
|
-
"@vertesia/common": "1.6.0-dev.
|
|
19
|
+
"@types/node": "^24.19.2",
|
|
20
|
+
"@vertesia/client": "1.6.0-dev.20261022.120426Z",
|
|
21
|
+
"@vertesia/common": "1.6.0-dev.20261022.120426Z",
|
|
22
22
|
"@vertesia/tsconfig": "0.1.0",
|
|
23
|
-
"@vertesia/ui": "1.6.0-dev.
|
|
23
|
+
"@vertesia/ui": "1.6.0-dev.20261022.120426Z",
|
|
24
24
|
"typescript": "7.0.2"
|
|
25
25
|
},
|
|
26
26
|
"repository": {
|
|
@@ -34,7 +34,12 @@
|
|
|
34
34
|
"documentation",
|
|
35
35
|
"app-development"
|
|
36
36
|
],
|
|
37
|
-
"gitHead": "
|
|
37
|
+
"gitHead": "bcaa7879b601ce9ccc394bcd3257822da13869cd",
|
|
38
|
+
"releaseIdentity": {
|
|
39
|
+
"source_sha": "bcaa7879b601ce9ccc394bcd3257822da13869cd",
|
|
40
|
+
"dependency_sha": "93466e47b06db23ac3c800e248d170afe65e5006",
|
|
41
|
+
"lock_sha256": "117e1c8068aa07d59117323a51ceccfc96cab543e50c03eb7efc19709d6f5e6b"
|
|
42
|
+
},
|
|
38
43
|
"scripts": {
|
|
39
44
|
"build": "pnpm run clean && tsc --checkers 1 -p tsconfig.json && node ./scripts/generate-docs.mjs",
|
|
40
45
|
"clean": "rimraf ./lib ./docs ./tsconfig.tsbuildinfo",
|