@vertesia/appgen-docs 1.6.0-dev.20261009.095813Z → 1.6.0-dev.20261019.172735Z
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 +3188 -2768
- package/lib/docs/vertesia-client.d.ts +92 -4
- package/lib/docs/vertesia-common.d.ts +38 -1
- package/package.json +6 -6
|
@@ -25,6 +25,7 @@ export { default as OAuthClientsApi } from './OAuthClientsApi.js';
|
|
|
25
25
|
export { default as OAuthGrantsApi } from './OAuthGrantsApi.js';
|
|
26
26
|
export { default as OAuthProvidersApi } from './OAuthProvidersApi.js';
|
|
27
27
|
export { default as OAuthServerApi } from './OAuthServerApi.js';
|
|
28
|
+
export { default as OidcFederationApi } from './OidcFederationApi.js';
|
|
28
29
|
export type { ComputePromptFacetsResponse, ListInteractionsResponse } from './PromptsApi.js';
|
|
29
30
|
export { default as RemoteMcpConnectionsApi } from './RemoteMcpConnectionsApi.js';
|
|
30
31
|
export type { ComputeRunFacetsResponse, FilterOption } from './RunsApi.js';
|
|
@@ -57,6 +58,7 @@ import OAuthClientsApi from './OAuthClientsApi.js';
|
|
|
57
58
|
import OAuthGrantsApi from './OAuthGrantsApi.js';
|
|
58
59
|
import OAuthProvidersApi from './OAuthProvidersApi.js';
|
|
59
60
|
import OAuthServerApi from './OAuthServerApi.js';
|
|
61
|
+
import OidcFederationApi from './OidcFederationApi.js';
|
|
60
62
|
import ProjectsApi from './ProjectsApi.js';
|
|
61
63
|
import PromptsApi from './PromptsApi.js';
|
|
62
64
|
import QuotaApi from './QuotaApi.js';
|
|
@@ -117,6 +119,7 @@ export declare class VertesiaClient extends AbstractFetchClient<VertesiaClient>
|
|
|
117
119
|
* tokenServerUrl
|
|
118
120
|
*/
|
|
119
121
|
tokenServerUrl: string;
|
|
122
|
+
oidcFederation: OidcFederationApi;
|
|
120
123
|
oauthClients: OAuthClientsApi;
|
|
121
124
|
oauthGrants: OAuthGrantsApi;
|
|
122
125
|
oauthServer: OAuthServerApi;
|
|
@@ -232,7 +235,7 @@ export declare function decodeEndpoints(endpoints: string | Record<string, strin
|
|
|
232
235
|
// @vertesia/client: AppsApi.d.ts
|
|
233
236
|
// -----------------------------------------------------------------------------
|
|
234
237
|
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';
|
|
238
|
+
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
239
|
export type { OrphanedAppInstallation } from '@vertesia/common';
|
|
237
240
|
export default class AppsApi extends ApiTopic {
|
|
238
241
|
constructor(parent: ClientBase);
|
|
@@ -248,6 +251,9 @@ export default class AppsApi extends ApiTopic {
|
|
|
248
251
|
* The key is write-only: it is encrypted server-side and never returned by any endpoint,
|
|
249
252
|
* so the response carries only the configured flag and a masked hint.
|
|
250
253
|
*/
|
|
254
|
+
setInstallationMcpApiKey(installationId: string, collectionId: string, apiKey: string): Promise<McpApiKeyStatus>;
|
|
255
|
+
getInstallationMcpApiKeyStatus(installationId: string, collectionId: string): Promise<McpApiKeyStatus>;
|
|
256
|
+
deleteInstallationMcpApiKey(installationId: string, collectionId: string): Promise<McpApiKeyStatus>;
|
|
251
257
|
setMcpCollectionApiKey(appId: string, collectionId: string, apiKey: string): Promise<McpApiKeyStatus>;
|
|
252
258
|
/** Whether an MCP tool collection has an API key stored, with a masked hint for display. */
|
|
253
259
|
getMcpCollectionApiKeyStatus(appId: string, collectionId: string): Promise<McpApiKeyStatus>;
|
|
@@ -269,6 +275,34 @@ export default class AppsApi extends ApiTopic {
|
|
|
269
275
|
getBuildProgress(appIdOrRecordId: string, workflowId: string, runId: string): Promise<AppBuildProgress>;
|
|
270
276
|
startScaffold(payload: StartAppScaffoldRequest): Promise<StartAppScaffoldResponse>;
|
|
271
277
|
getScaffoldProgress(workflowId: string, runId: string): Promise<AppScaffoldProgress>;
|
|
278
|
+
/**
|
|
279
|
+
* Return whether the global App Builder GitHub App is configured, together with its slug and
|
|
280
|
+
* installation URL when available.
|
|
281
|
+
*/
|
|
282
|
+
getGithubConfiguration(): Promise<AppGithubConfiguration>;
|
|
283
|
+
/**
|
|
284
|
+
* Start GitHub user authorization. The server creates a short-lived, single-use OAuth state
|
|
285
|
+
* bound to the current Vertesia user/account/project and returns the GitHub authorization URL.
|
|
286
|
+
*/
|
|
287
|
+
startGithubAuthorization(): Promise<StartAppGithubAuthorizationResponse>;
|
|
288
|
+
/**
|
|
289
|
+
* Complete GitHub authorization with the callback code and state. The server consumes the state,
|
|
290
|
+
* verifies the current user's writable GitHub App installations, discards the GitHub user token,
|
|
291
|
+
* and returns those installations plus an opaque `connection_id`. That id references a
|
|
292
|
+
* short-lived server-side snapshot of the writable repositories verified for this Vertesia
|
|
293
|
+
* user/account/project; selecting a repository consumes it once.
|
|
294
|
+
*/
|
|
295
|
+
exchangeGithubAuthorization(code: string, state: string): Promise<ExchangeAppGithubAuthorizationResponse>;
|
|
296
|
+
/**
|
|
297
|
+
* List repositories with push access for one installation verified during authorization. The
|
|
298
|
+
* connection id is scoped to the current Vertesia user/account/project and expires shortly.
|
|
299
|
+
*/
|
|
300
|
+
listGithubRepositories(connectionId: string, installationId: string): Promise<AppGithubRepositoryList>;
|
|
301
|
+
/**
|
|
302
|
+
* List branches and verify whether a selected branch can safely receive generated source.
|
|
303
|
+
* The verified connection remains reusable until app creation consumes it.
|
|
304
|
+
*/
|
|
305
|
+
getGithubRepositorySetup(connectionId: string, installationId: string, repository: string, branch: string): Promise<AppGithubRepositorySetup>;
|
|
272
306
|
/**
|
|
273
307
|
* Get the list if tools provided by the given app.
|
|
274
308
|
* @param appId
|
|
@@ -370,7 +404,7 @@ export default class AppsApi extends ApiTopic {
|
|
|
370
404
|
client_id?: string;
|
|
371
405
|
client_secret?: string;
|
|
372
406
|
scopes?: string[];
|
|
373
|
-
}>, apiKeyParams?: AppApiKeyCollectionParams): Promise<AppInstallation>;
|
|
407
|
+
}>, apiKeyParams?: AppApiKeyCollectionParams, mcpParameters?: AppInstallationPayload['mcp_parameters'], mcpSharedParameters?: AppInstallationPayload['mcp_shared_parameters'], instance?: Pick<AppInstallationPayload, 'instance_key' | 'display_name' | 'namespace_overrides'>): Promise<AppInstallation>;
|
|
374
408
|
/**
|
|
375
409
|
* Remove the given app from the current project.
|
|
376
410
|
* @param installationId - the id of the app installation
|
|
@@ -381,6 +415,8 @@ export default class AppsApi extends ApiTopic {
|
|
|
381
415
|
* get an app unstallation given its name or null if the app is not installed
|
|
382
416
|
* @returns
|
|
383
417
|
*/
|
|
418
|
+
getAppInstanceAvailability(): Promise<AppInstanceAvailability>;
|
|
419
|
+
getAppInstallation(installationId: string): Promise<AppInstallationWithManifest>;
|
|
384
420
|
getAppInstallationByName(appName: string): Promise<AppInstallationWithManifest | null>;
|
|
385
421
|
/**
|
|
386
422
|
* Get the project refs where the application is visible by the current user.
|
|
@@ -882,7 +918,7 @@ export declare class ZenoClient extends AbstractFetchClient<ZenoClient> {
|
|
|
882
918
|
// @vertesia/client: store/ObjectsApi.d.ts
|
|
883
919
|
// -----------------------------------------------------------------------------
|
|
884
920
|
import { ApiTopic } from '@vertesia/api-fetch-client';
|
|
885
|
-
import { type BulkObjectCreateOptions, type BulkObjectCreateResult, type BulkObjectDeleteResult, type BulkObjectUpdateOptions, type BulkObjectUpdateResult, type Collection, type ComplexSearchPayload, type ComputedFacetResponse, type ComputeObjectFacetPayload, type ContentObject, type ContentObjectExportArtifactFile, type ContentObjectExportResult, type ContentObjectExportStatusResponse, type ContentObjectItem, type ContentObjectProcessingPriority, type ContentObjectTextResponse, type ContentSource, type CreateContentObjectPayload, canGenerateRendition, type DeleteContentObjectExportResponse, type DeleteContentObjectResult, type Embedding, type ExportPropertiesPayload, type ExportPropertiesResponse, type FindPayload, type FullObjectSearchResponse, type GetFileUrlPayload, type GetFileUrlResponse, type GetRenditionParams, type GetRenditionResponse, type GetUploadUrlPayload, type ListContentObjectExportsResponse, type ListWorkflowRunsResponse, type ObjectSearchPayload, type ObjectSearchResponse, type ProjectedContentObjectApiResponse, type SetObjectEmbeddingsResponse, type StartContentObjectExportRequest, type StartContentObjectExportResponse, type SupportedEmbeddingTypes, type UpdateContentObjectPayload, type ZenoBulkContentObjectExportComposeRequest, type ZenoBulkContentObjectExportPlanRequest, type ZenoBulkContentObjectExportPlanResponse, type ZenoBulkContentObjectExportRequest, type ZenoBulkContentObjectExportShardRequest, type ZenoBulkContentObjectExportShardResult, type ZenoBulkContentObjectExportSplitShardRequest, type ZenoBulkContentObjectExportSplitShardResponse } from '@vertesia/common';
|
|
921
|
+
import { type BulkObjectCreateOptions, type BulkObjectCreateResult, type BulkObjectDeleteResult, type BulkObjectUpdateOptions, type BulkObjectUpdateResult, type Collection, type ComplexSearchPayload, type ComputedFacetResponse, type ComputeObjectFacetPayload, type ContentObject, type ContentObjectExportArtifactFile, type ContentObjectExportResult, type ContentObjectExportStatusResponse, type ContentObjectItem, type ContentObjectProcessingPriority, type ContentObjectTextResponse, type ContentSource, type CreateContentObjectPayload, canGenerateRendition, type DeleteContentObjectExportResponse, type DeleteContentObjectResult, type Embedding, type ExportPropertiesPayload, type ExportPropertiesResponse, type FindPayload, type FullObjectSearchResponse, type GetFileUrlPayload, type GetFileUrlResponse, type GetRenditionParams, type GetRenditionResponse, type GetUploadUrlPayload, type ListContentObjectExportsResponse, type ListWorkflowRunsResponse, type ObjectSearchPayload, type ObjectSearchResponse, type ProjectedContentObjectApiResponse, type SetObjectEmbeddingsResponse, type SetObjectTextPayload, type StartContentObjectExportRequest, type StartContentObjectExportResponse, type SupportedEmbeddingTypes, type UpdateContentObjectPayload, type ZenoBulkContentObjectExportComposeRequest, type ZenoBulkContentObjectExportPlanRequest, type ZenoBulkContentObjectExportPlanResponse, type ZenoBulkContentObjectExportRequest, type ZenoBulkContentObjectExportShardRequest, type ZenoBulkContentObjectExportShardResult, type ZenoBulkContentObjectExportSplitShardRequest, type ZenoBulkContentObjectExportSplitShardResponse } from '@vertesia/common';
|
|
886
922
|
export { getSupportedRenditionFormats, supportsVisualRendition } from '@vertesia/common';
|
|
887
923
|
export { canGenerateRendition };
|
|
888
924
|
import { StreamSource } from '../StreamSource.js';
|
|
@@ -965,6 +1001,13 @@ export declare class ObjectsApi extends ApiTopic {
|
|
|
965
1001
|
retrieve(id: string, select: `+${string}` | undefined): Promise<ContentObject>;
|
|
966
1002
|
retrieve(id: string, select: string): Promise<ProjectedContentObjectApiResponse>;
|
|
967
1003
|
getObjectText(id: string): Promise<ContentObjectTextResponse>;
|
|
1004
|
+
/**
|
|
1005
|
+
* Store the extracted text of an object as a text artifact.
|
|
1006
|
+
*
|
|
1007
|
+
* Pass the content etag the text was extracted from so the server records it as the
|
|
1008
|
+
* object `text_etag`, allowing extraction to be skipped while the content is unchanged.
|
|
1009
|
+
*/
|
|
1010
|
+
setObjectText(id: string, payload: SetObjectTextPayload): Promise<ContentObjectTextResponse>;
|
|
968
1011
|
upload(source: StreamSource | File): Promise<{
|
|
969
1012
|
source: string;
|
|
970
1013
|
name: string;
|
|
@@ -2059,6 +2102,10 @@ export declare class ProcessApi extends ApiTopic {
|
|
|
2059
2102
|
create(payload: CreateProcessDefinitionPayload): Promise<ProcessDefinition>;
|
|
2060
2103
|
update(id: string, payload: UpdateProcessDefinitionPayload): Promise<ProcessDefinition>;
|
|
2061
2104
|
listVersions(id: string): Promise<ProcessDefinition[]>;
|
|
2105
|
+
/**
|
|
2106
|
+
* Publish a draft revision. Set `idempotency_key` to make the call safe to retry: without one, a
|
|
2107
|
+
* replay of a publish that already succeeded is rejected, so no client retry applies.
|
|
2108
|
+
*/
|
|
2062
2109
|
publish(id: string, payload: PublishProcessDefinitionPayload): Promise<ProcessDefinition>;
|
|
2063
2110
|
revert(id: string, payload: RevertProcessDefinitionPayload): Promise<ProcessDefinition>;
|
|
2064
2111
|
delete(id: string): Promise<{
|
|
@@ -2072,6 +2119,10 @@ export declare class ProcessApi extends ApiTopic {
|
|
|
2072
2119
|
id: string;
|
|
2073
2120
|
count: number;
|
|
2074
2121
|
}>;
|
|
2122
|
+
/**
|
|
2123
|
+
* Start a test run against a stored process revision. Set `idempotency_key` to make the call
|
|
2124
|
+
* safe to retry: without one, a replay would start a second run, so no client retry applies.
|
|
2125
|
+
*/
|
|
2075
2126
|
startTestRun(processId: string, payload: StartProcessTestRunPayload): Promise<ProcessTestRun>;
|
|
2076
2127
|
listTestRuns(processId: string, query?: ListProcessTestRunsQuery): Promise<ProcessTestRun[]>;
|
|
2077
2128
|
retrieveTestRun(processId: string, runId: string): Promise<ProcessTestRun>;
|
|
@@ -2187,6 +2238,7 @@ export type DeleteContentObjectExportResponse = Wire.DeleteContentObjectExportRe
|
|
|
2187
2238
|
export type InheritedPropertyMetadata = Wire.InheritedPropertyMetadata;
|
|
2188
2239
|
export type ContentObjectUserPermissions = Wire.ContentObjectUserPermissions;
|
|
2189
2240
|
export type ContentObjectTextResponse = Wire.ContentObjectTextResponse;
|
|
2241
|
+
export type SetObjectTextPayload = Wire.SetObjectTextPayload;
|
|
2190
2242
|
export type DeleteContentObjectResult = Wire.DeleteContentObjectResult;
|
|
2191
2243
|
export type SetObjectEmbeddingsResponse = Wire.SetObjectEmbeddingsResponse;
|
|
2192
2244
|
export type ContentObjectApiTypeRef = Wire.ContentObjectApiTypeRef;
|
|
@@ -3895,9 +3947,12 @@ export {};
|
|
|
3895
3947
|
// -----------------------------------------------------------------------------
|
|
3896
3948
|
// @vertesia/common: apps.d.ts
|
|
3897
3949
|
// -----------------------------------------------------------------------------
|
|
3950
|
+
import type { AuthTokenPayload } from './apikey.js';
|
|
3898
3951
|
import type * as Wire from './wire-types.generated.js';
|
|
3899
3952
|
/** Allowed values for AppUINavItem.preferredSection */
|
|
3900
3953
|
export declare const PREFERRED_SECTIONS: readonly ['default', 'footer', 'settings'];
|
|
3954
|
+
/** Convert an app display/package name into the canonical persisted app id. */
|
|
3955
|
+
export declare function slugifyAppId(value: string): string;
|
|
3901
3956
|
/**
|
|
3902
3957
|
* Additional navigation item for an app's UI configuration.
|
|
3903
3958
|
* Used in AppUIConfig.navigation to define sidebar navigation entries in CompositeApp shell contexts.
|
|
@@ -3925,6 +3980,7 @@ export interface AppUINavItem {
|
|
|
3925
3980
|
preferredSection?: (typeof PREFERRED_SECTIONS)[number];
|
|
3926
3981
|
}
|
|
3927
3982
|
export type AppUIConfig = Wire.AppUIConfig;
|
|
3983
|
+
export type AppOAuthClientConfig = Wire.AppOAuthClientConfig;
|
|
3928
3984
|
export type AppInstallationProjectsQuery = Wire.AppInstallationProjectsQuery;
|
|
3929
3985
|
export type AppInstallationsQuery = Wire.AppInstallationsQuery;
|
|
3930
3986
|
export type AppListScope = Wire.AppListScope;
|
|
@@ -3945,7 +4001,7 @@ export type ToolCollectionObject = Wire.ToolCollectionObject;
|
|
|
3945
4001
|
* @param vars - Optional endpoint variables to substitute in URLs
|
|
3946
4002
|
* @returns Normalized ToolCollectionObject
|
|
3947
4003
|
*/
|
|
3948
|
-
export declare function normalizeToolCollection(collection: ToolCollectionObject, vars?: Endpoints): ToolCollectionObject;
|
|
4004
|
+
export declare function normalizeToolCollection(collection: ToolCollectionObject, vars?: Endpoints, sharedParameters?: MCPToolCollectionObject['parameters']): ToolCollectionObject;
|
|
3949
4005
|
/**
|
|
3950
4006
|
* Metadata hints from MCP tool annotations (per MCP spec).
|
|
3951
4007
|
*/
|
|
@@ -4005,8 +4061,22 @@ export type StartAppBuildResponse = Wire.StartAppBuildResponse;
|
|
|
4005
4061
|
export type AppBuildProgressStatus = Wire.AppBuildProgressStatus;
|
|
4006
4062
|
export type AppBuildProgress = Wire.AppBuildProgress;
|
|
4007
4063
|
export type AppScaffoldModule = Wire.AppScaffoldModule;
|
|
4064
|
+
export type AppScaffoldSourceMode = Wire.AppScaffoldSourceMode;
|
|
4008
4065
|
export type StartAppScaffoldRequest = Wire.StartAppScaffoldRequest;
|
|
4009
4066
|
export type StartAppScaffoldResponse = Wire.StartAppScaffoldResponse;
|
|
4067
|
+
export type AppGithubConfiguration = Wire.AppGithubConfiguration;
|
|
4068
|
+
export type StartAppGithubAuthorizationResponse = Wire.StartAppGithubAuthorizationResponse;
|
|
4069
|
+
export type ExchangeAppGithubAuthorizationRequest = Wire.ExchangeAppGithubAuthorizationRequest;
|
|
4070
|
+
export type AppGithubRepositoriesQuery = Wire.AppGithubRepositoriesQuery;
|
|
4071
|
+
export type AppGithubInstallation = Wire.AppGithubInstallation;
|
|
4072
|
+
export type AppGithubAccount = Wire.AppGithubAccount;
|
|
4073
|
+
export type ExchangeAppGithubAuthorizationResponse = Wire.ExchangeAppGithubAuthorizationResponse;
|
|
4074
|
+
export type AppGithubRepository = Wire.AppGithubRepository;
|
|
4075
|
+
export type AppGithubRepositoryCreation = Wire.AppGithubRepositoryCreation;
|
|
4076
|
+
export type AppGithubRepositoryList = Wire.AppGithubRepositoryList;
|
|
4077
|
+
export type AppGithubRepositorySetupQuery = Wire.AppGithubRepositorySetupQuery;
|
|
4078
|
+
export type AppGithubBranchState = Wire.AppGithubBranchState;
|
|
4079
|
+
export type AppGithubRepositorySetup = Wire.AppGithubRepositorySetup;
|
|
4010
4080
|
export type StartAppDevelopmentTaskRequest = Wire.StartAppDevelopmentTaskRequest;
|
|
4011
4081
|
export type AppScaffoldProgressStatus = Wire.AppScaffoldProgressStatus;
|
|
4012
4082
|
export type AppScaffoldProgress = Wire.AppScaffoldProgress;
|
|
@@ -4026,6 +4096,7 @@ export type AppAccessControl = Wire.AppAccessControl;
|
|
|
4026
4096
|
export type AppManifestData = Wire.AppManifestData;
|
|
4027
4097
|
export type UpdateAppPayload = Wire.UpdateAppPayload;
|
|
4028
4098
|
export type AppGitSourceConfig = Wire.AppGitSourceConfig;
|
|
4099
|
+
export type AppGitSourceProvider = Wire.AppGitSourceProvider;
|
|
4029
4100
|
export type AppSourceConfig = Wire.AppSourceConfig;
|
|
4030
4101
|
/**
|
|
4031
4102
|
* Deployment-time URL endpoints that can be referenced in app manifest URLs
|
|
@@ -4304,6 +4375,23 @@ export type ValidateUrlResponse = Wire.ValidateUrlResponse;
|
|
|
4304
4375
|
*/
|
|
4305
4376
|
export type AppDeleteSummary = Wire.AppDeleteSummary;
|
|
4306
4377
|
export type UpdateAppInstallationOAuthApprovalPayload = Wire.UpdateAppInstallationOAuthApprovalPayload;
|
|
4378
|
+
/** Check exact installation grants; legacy app-name grants authorize only the default instance. */
|
|
4379
|
+
export declare function hasAppInstallationAccess(token: AuthTokenPayload, installation: {
|
|
4380
|
+
id: string;
|
|
4381
|
+
project: string;
|
|
4382
|
+
instance_key?: string;
|
|
4383
|
+
manifest: {
|
|
4384
|
+
name: string;
|
|
4385
|
+
};
|
|
4386
|
+
}, ui?: boolean): boolean;
|
|
4387
|
+
/** Persist this effective collection in catalogs so discovery and execution use the same namespace. */
|
|
4388
|
+
export declare function resolveInstallationCollection(collection: ToolCollectionObject, installation: Pick<AppInstallation, 'instance_key' | 'namespace_overrides' | 'namespace_conflicts'>): ToolCollectionObject;
|
|
4389
|
+
export type AppInstanceAvailability = Wire.AppInstanceAvailability;
|
|
4390
|
+
export type McpPublicParameter = Wire.McpPublicParameter;
|
|
4391
|
+
export type McpSecretParameter = Wire.McpSecretParameter;
|
|
4392
|
+
export type McpConnectionParameter = Wire.McpConnectionParameter;
|
|
4393
|
+
/** Whether a manifest can safely back an additional MCP-only installation. */
|
|
4394
|
+
export declare function isMcpOnlyInstanceManifest(manifest: Pick<AppManifestData, 'endpoint' | 'ui' | 'capabilities' | 'tool_collections'>): boolean;
|
|
4307
4395
|
|
|
4308
4396
|
// -----------------------------------------------------------------------------
|
|
4309
4397
|
// @vertesia/common: interaction.d.ts
|
|
@@ -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
|
|
@@ -1936,6 +1972,7 @@ export type DeleteContentObjectExportResponse = Wire.DeleteContentObjectExportRe
|
|
|
1936
1972
|
export type InheritedPropertyMetadata = Wire.InheritedPropertyMetadata;
|
|
1937
1973
|
export type ContentObjectUserPermissions = Wire.ContentObjectUserPermissions;
|
|
1938
1974
|
export type ContentObjectTextResponse = Wire.ContentObjectTextResponse;
|
|
1975
|
+
export type SetObjectTextPayload = Wire.SetObjectTextPayload;
|
|
1939
1976
|
export type DeleteContentObjectResult = Wire.DeleteContentObjectResult;
|
|
1940
1977
|
export type SetObjectEmbeddingsResponse = Wire.SetObjectEmbeddingsResponse;
|
|
1941
1978
|
export type ContentObjectApiTypeRef = Wire.ContentObjectApiTypeRef;
|
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.20261019.172735Z",
|
|
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.1",
|
|
20
|
+
"@vertesia/client": "1.6.0-dev.20261019.172735Z",
|
|
21
|
+
"@vertesia/common": "1.6.0-dev.20261019.172735Z",
|
|
22
22
|
"@vertesia/tsconfig": "0.1.0",
|
|
23
|
-
"@vertesia/ui": "1.6.0-dev.
|
|
23
|
+
"@vertesia/ui": "1.6.0-dev.20261019.172735Z",
|
|
24
24
|
"typescript": "7.0.2"
|
|
25
25
|
},
|
|
26
26
|
"repository": {
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
"documentation",
|
|
35
35
|
"app-development"
|
|
36
36
|
],
|
|
37
|
-
"gitHead": "
|
|
37
|
+
"gitHead": "85a3010750ab97192d236928b1fca55015a18000",
|
|
38
38
|
"scripts": {
|
|
39
39
|
"build": "pnpm run clean && tsc --checkers 1 -p tsconfig.json && node ./scripts/generate-docs.mjs",
|
|
40
40
|
"clean": "rimraf ./lib ./docs ./tsconfig.tsbuildinfo",
|