@vertesia/common 1.5.0-dev.20260725.083715Z → 1.5.0-dev.20260806.125520Z
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/Progress.d.ts.map +1 -1
- package/lib/Progress.js.map +1 -1
- package/lib/access-control-values.d.ts +98 -0
- package/lib/access-control-values.d.ts.map +1 -0
- package/lib/access-control-values.js +101 -0
- package/lib/access-control-values.js.map +1 -0
- package/lib/access-control.d.ts +22 -119
- package/lib/access-control.d.ts.map +1 -1
- package/lib/access-control.js +6 -78
- package/lib/access-control.js.map +1 -1
- package/lib/account-values.d.ts +53 -0
- package/lib/account-values.d.ts.map +1 -0
- package/lib/account-values.js +91 -0
- package/lib/account-values.js.map +1 -0
- package/lib/analytics.d.ts +12 -38
- package/lib/analytics.d.ts.map +1 -1
- package/lib/api-schemas/access-control.d.ts +215 -0
- package/lib/api-schemas/access-control.d.ts.map +1 -0
- package/lib/api-schemas/access-control.js +165 -0
- package/lib/api-schemas/access-control.js.map +1 -0
- package/lib/api-schemas/account.d.ts +101 -0
- package/lib/api-schemas/account.d.ts.map +1 -0
- package/lib/api-schemas/account.js +136 -0
- package/lib/api-schemas/account.js.map +1 -0
- package/lib/api-schemas/adapter.d.ts +80 -0
- package/lib/api-schemas/adapter.d.ts.map +1 -0
- package/lib/api-schemas/adapter.js +726 -0
- package/lib/api-schemas/adapter.js.map +1 -0
- package/lib/api-schemas/agent-runs.d.ts +3786 -0
- package/lib/api-schemas/agent-runs.d.ts.map +1 -0
- package/lib/api-schemas/agent-runs.js +1000 -0
- package/lib/api-schemas/agent-runs.js.map +1 -0
- package/lib/api-schemas/analytics.d.ts +86 -0
- package/lib/api-schemas/analytics.d.ts.map +1 -0
- package/lib/api-schemas/analytics.js +58 -0
- package/lib/api-schemas/analytics.js.map +1 -0
- package/lib/api-schemas/apikey.d.ts +231 -0
- package/lib/api-schemas/apikey.d.ts.map +1 -0
- package/lib/api-schemas/apikey.js +172 -0
- package/lib/api-schemas/apikey.js.map +1 -0
- package/lib/api-schemas/app-lifecycle.d.ts +1148 -0
- package/lib/api-schemas/app-lifecycle.d.ts.map +1 -0
- package/lib/api-schemas/app-lifecycle.js +801 -0
- package/lib/api-schemas/app-lifecycle.js.map +1 -0
- package/lib/api-schemas/app-runtime.d.ts +10951 -0
- package/lib/api-schemas/app-runtime.d.ts.map +1 -0
- package/lib/api-schemas/app-runtime.js +874 -0
- package/lib/api-schemas/app-runtime.js.map +1 -0
- package/lib/api-schemas/apps.d.ts +271 -0
- package/lib/api-schemas/apps.d.ts.map +1 -0
- package/lib/api-schemas/apps.js +426 -0
- package/lib/api-schemas/apps.js.map +1 -0
- package/lib/api-schemas/audit-trail.d.ts +465 -0
- package/lib/api-schemas/audit-trail.d.ts.map +1 -0
- package/lib/api-schemas/audit-trail.js +218 -0
- package/lib/api-schemas/audit-trail.js.map +1 -0
- package/lib/api-schemas/bulk-operation.d.ts +104 -0
- package/lib/api-schemas/bulk-operation.d.ts.map +1 -0
- package/lib/api-schemas/bulk-operation.js +66 -0
- package/lib/api-schemas/bulk-operation.js.map +1 -0
- package/lib/api-schemas/commands.d.ts +50 -0
- package/lib/api-schemas/commands.d.ts.map +1 -0
- package/lib/api-schemas/commands.js +58 -0
- package/lib/api-schemas/commands.js.map +1 -0
- package/lib/api-schemas/content.d.ts +3565 -0
- package/lib/api-schemas/content.d.ts.map +1 -0
- package/lib/api-schemas/content.js +854 -0
- package/lib/api-schemas/content.js.map +1 -0
- package/lib/api-schemas/cost-analytics.d.ts +300 -0
- package/lib/api-schemas/cost-analytics.d.ts.map +1 -0
- package/lib/api-schemas/cost-analytics.js +218 -0
- package/lib/api-schemas/cost-analytics.js.map +1 -0
- package/lib/api-schemas/dashboard.d.ts +408 -0
- package/lib/api-schemas/dashboard.d.ts.map +1 -0
- package/lib/api-schemas/dashboard.js +311 -0
- package/lib/api-schemas/dashboard.js.map +1 -0
- package/lib/api-schemas/data-store.d.ts +1650 -0
- package/lib/api-schemas/data-store.d.ts.map +1 -0
- package/lib/api-schemas/data-store.js +504 -0
- package/lib/api-schemas/data-store.js.map +1 -0
- package/lib/api-schemas/document-processing.d.ts +1501 -0
- package/lib/api-schemas/document-processing.d.ts.map +1 -0
- package/lib/api-schemas/document-processing.js +312 -0
- package/lib/api-schemas/document-processing.js.map +1 -0
- package/lib/api-schemas/embeddings.d.ts +184 -0
- package/lib/api-schemas/embeddings.d.ts.map +1 -0
- package/lib/api-schemas/embeddings.js +102 -0
- package/lib/api-schemas/embeddings.js.map +1 -0
- package/lib/api-schemas/environment.d.ts +412 -0
- package/lib/api-schemas/environment.d.ts.map +1 -0
- package/lib/api-schemas/environment.js +170 -0
- package/lib/api-schemas/environment.js.map +1 -0
- package/lib/api-schemas/events.d.ts +4918 -0
- package/lib/api-schemas/events.d.ts.map +1 -0
- package/lib/api-schemas/events.js +888 -0
- package/lib/api-schemas/events.js.map +1 -0
- package/lib/api-schemas/files.d.ts +107 -0
- package/lib/api-schemas/files.d.ts.map +1 -0
- package/lib/api-schemas/files.js +137 -0
- package/lib/api-schemas/files.js.map +1 -0
- package/lib/api-schemas/group.d.ts +122 -0
- package/lib/api-schemas/group.d.ts.map +1 -0
- package/lib/api-schemas/group.js +142 -0
- package/lib/api-schemas/group.js.map +1 -0
- package/lib/api-schemas/index.d.ts +36 -0
- package/lib/api-schemas/index.d.ts.map +1 -0
- package/lib/api-schemas/index.js +36 -0
- package/lib/api-schemas/index.js.map +1 -0
- package/lib/api-schemas/indexing.d.ts +144 -0
- package/lib/api-schemas/indexing.d.ts.map +1 -0
- package/lib/api-schemas/indexing.js +217 -0
- package/lib/api-schemas/indexing.js.map +1 -0
- package/lib/api-schemas/integrations.d.ts +269 -0
- package/lib/api-schemas/integrations.d.ts.map +1 -0
- package/lib/api-schemas/integrations.js +335 -0
- package/lib/api-schemas/integrations.js.map +1 -0
- package/lib/api-schemas/interaction.d.ts +22456 -0
- package/lib/api-schemas/interaction.d.ts.map +1 -0
- package/lib/api-schemas/interaction.js +2071 -0
- package/lib/api-schemas/interaction.js.map +1 -0
- package/lib/api-schemas/invites.d.ts +162 -0
- package/lib/api-schemas/invites.d.ts.map +1 -0
- package/lib/api-schemas/invites.js +106 -0
- package/lib/api-schemas/invites.js.map +1 -0
- package/lib/api-schemas/oauth-server.d.ts +415 -0
- package/lib/api-schemas/oauth-server.d.ts.map +1 -0
- package/lib/api-schemas/oauth-server.js +193 -0
- package/lib/api-schemas/oauth-server.js.map +1 -0
- package/lib/api-schemas/oauth.d.ts +150 -0
- package/lib/api-schemas/oauth.d.ts.map +1 -0
- package/lib/api-schemas/oauth.js +148 -0
- package/lib/api-schemas/oauth.js.map +1 -0
- package/lib/api-schemas/parameters.d.ts +64 -0
- package/lib/api-schemas/parameters.d.ts.map +1 -0
- package/lib/api-schemas/parameters.js +246 -0
- package/lib/api-schemas/parameters.js.map +1 -0
- package/lib/api-schemas/process.d.ts +499 -0
- package/lib/api-schemas/process.d.ts.map +1 -0
- package/lib/api-schemas/process.js +817 -0
- package/lib/api-schemas/process.js.map +1 -0
- package/lib/api-schemas/project-configuration.d.ts +4900 -0
- package/lib/api-schemas/project-configuration.d.ts.map +1 -0
- package/lib/api-schemas/project-configuration.js +425 -0
- package/lib/api-schemas/project-configuration.js.map +1 -0
- package/lib/api-schemas/project.d.ts +7247 -0
- package/lib/api-schemas/project.d.ts.map +1 -0
- package/lib/api-schemas/project.js +185 -0
- package/lib/api-schemas/project.js.map +1 -0
- package/lib/api-schemas/prompt.d.ts +70 -0
- package/lib/api-schemas/prompt.d.ts.map +1 -0
- package/lib/api-schemas/prompt.js +77 -0
- package/lib/api-schemas/prompt.js.map +1 -0
- package/lib/api-schemas/quota.d.ts +90 -0
- package/lib/api-schemas/quota.d.ts.map +1 -0
- package/lib/api-schemas/quota.js +95 -0
- package/lib/api-schemas/quota.js.map +1 -0
- package/lib/api-schemas/registry.d.ts +98506 -0
- package/lib/api-schemas/registry.d.ts.map +1 -0
- package/lib/api-schemas/registry.js +2606 -0
- package/lib/api-schemas/registry.js.map +1 -0
- package/lib/api-schemas/schema-primitives.d.ts +5 -0
- package/lib/api-schemas/schema-primitives.d.ts.map +1 -0
- package/lib/api-schemas/schema-primitives.js +11 -0
- package/lib/api-schemas/schema-primitives.js.map +1 -0
- package/lib/api-schemas/secrets.d.ts +497 -0
- package/lib/api-schemas/secrets.d.ts.map +1 -0
- package/lib/api-schemas/secrets.js +298 -0
- package/lib/api-schemas/secrets.js.map +1 -0
- package/lib/api-schemas/store.d.ts +22140 -0
- package/lib/api-schemas/store.d.ts.map +1 -0
- package/lib/api-schemas/store.js +557 -0
- package/lib/api-schemas/store.js.map +1 -0
- package/lib/api-schemas/sts.d.ts +166 -0
- package/lib/api-schemas/sts.d.ts.map +1 -0
- package/lib/api-schemas/sts.js +107 -0
- package/lib/api-schemas/sts.js.map +1 -0
- package/lib/api-schemas/task.d.ts +215 -0
- package/lib/api-schemas/task.d.ts.map +1 -0
- package/lib/api-schemas/task.js +95 -0
- package/lib/api-schemas/task.js.map +1 -0
- package/lib/api-schemas/tools.d.ts +111 -0
- package/lib/api-schemas/tools.d.ts.map +1 -0
- package/lib/api-schemas/tools.js +122 -0
- package/lib/api-schemas/tools.js.map +1 -0
- package/lib/api-schemas/user.d.ts +208 -0
- package/lib/api-schemas/user.d.ts.map +1 -0
- package/lib/api-schemas/user.js +180 -0
- package/lib/api-schemas/user.js.map +1 -0
- package/lib/api-schemas/view-execution.d.ts +3163 -0
- package/lib/api-schemas/view-execution.d.ts.map +1 -0
- package/lib/api-schemas/view-execution.js +172 -0
- package/lib/api-schemas/view-execution.js.map +1 -0
- package/lib/api-schemas/views.d.ts +5990 -0
- package/lib/api-schemas/views.d.ts.map +1 -0
- package/lib/api-schemas/views.js +396 -0
- package/lib/api-schemas/views.js.map +1 -0
- package/lib/api-schemas/workflow-runs.d.ts +2210 -0
- package/lib/api-schemas/workflow-runs.d.ts.map +1 -0
- package/lib/api-schemas/workflow-runs.js +589 -0
- package/lib/api-schemas/workflow-runs.js.map +1 -0
- package/lib/apikey-values.d.ts +10 -0
- package/lib/apikey-values.d.ts.map +1 -0
- package/lib/apikey-values.js +11 -0
- package/lib/apikey-values.js.map +1 -0
- package/lib/apikey.d.ts +37 -36
- package/lib/apikey.d.ts.map +1 -1
- package/lib/apikey.js +5 -4
- package/lib/apikey.js.map +1 -1
- package/lib/apps.d.ts +142 -1172
- package/lib/apps.d.ts.map +1 -1
- package/lib/apps.js +4 -0
- package/lib/apps.js.map +1 -1
- package/lib/ask-user.d.ts +8 -1
- package/lib/ask-user.d.ts.map +1 -1
- package/lib/audit-trail.d.ts +20 -131
- package/lib/audit-trail.d.ts.map +1 -1
- package/lib/audit-trail.js.map +1 -1
- package/lib/browser-credentials.d.ts +11 -106
- package/lib/browser-credentials.d.ts.map +1 -1
- package/lib/common.d.ts +59 -81
- package/lib/common.d.ts.map +1 -1
- package/lib/cost-analytics.d.ts +14 -167
- package/lib/cost-analytics.d.ts.map +1 -1
- package/lib/cost-analytics.js.map +1 -1
- package/lib/data-platform.d.ts +122 -786
- package/lib/data-platform.d.ts.map +1 -1
- package/lib/data-platform.js +41 -61
- package/lib/data-platform.js.map +1 -1
- package/lib/email.d.ts +5 -17
- package/lib/email.d.ts.map +1 -1
- package/lib/email.js +0 -3
- package/lib/email.js.map +1 -1
- package/lib/embeddings.d.ts +14 -56
- package/lib/embeddings.d.ts.map +1 -1
- package/lib/environment.d.ts +22 -118
- package/lib/environment.d.ts.map +1 -1
- package/lib/environment.js +3 -0
- package/lib/environment.js.map +1 -1
- package/lib/facets.d.ts +4 -7
- package/lib/facets.d.ts.map +1 -1
- package/lib/group.d.ts +33 -39
- package/lib/group.d.ts.map +1 -1
- package/lib/group.js +0 -1
- package/lib/group.js.map +1 -1
- package/lib/index.d.ts +8 -0
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +1 -0
- package/lib/index.js.map +1 -1
- package/lib/integrations.d.ts +20 -108
- package/lib/integrations.d.ts.map +1 -1
- package/lib/integrations.js.map +1 -1
- package/lib/interaction-values.d.ts +11 -0
- package/lib/interaction-values.d.ts.map +1 -0
- package/lib/interaction-values.js +24 -0
- package/lib/interaction-values.js.map +1 -0
- package/lib/interaction.d.ts +88 -778
- package/lib/interaction.d.ts.map +1 -1
- package/lib/interaction.js +8 -12
- package/lib/interaction.js.map +1 -1
- package/lib/meters.d.ts +11 -7
- package/lib/meters.d.ts.map +1 -1
- package/lib/meters.js.map +1 -1
- package/lib/oauth-server.d.ts +33 -119
- package/lib/oauth-server.d.ts.map +1 -1
- package/lib/oauth.d.ts +14 -96
- package/lib/oauth.d.ts.map +1 -1
- package/lib/oauth.js +0 -4
- package/lib/oauth.js.map +1 -1
- package/lib/payload.d.ts +15 -38
- package/lib/payload.d.ts.map +1 -1
- package/lib/platform-event-validation.d.ts.map +1 -1
- package/lib/platform-event-validation.js +15 -2
- package/lib/platform-event-validation.js.map +1 -1
- package/lib/platform-event.d.ts +79 -464
- package/lib/platform-event.d.ts.map +1 -1
- package/lib/platform-event.js.map +1 -1
- package/lib/principal-context.d.ts +10 -15
- package/lib/principal-context.d.ts.map +1 -1
- package/lib/project-values.d.ts +24 -0
- package/lib/project-values.d.ts.map +1 -0
- package/lib/project-values.js +42 -0
- package/lib/project-values.js.map +1 -0
- package/lib/project.d.ts +56 -504
- package/lib/project.d.ts.map +1 -1
- package/lib/project.js +6 -76
- package/lib/project.js.map +1 -1
- package/lib/prompt.d.ts +20 -51
- package/lib/prompt.d.ts.map +1 -1
- package/lib/prompt.js.map +1 -1
- package/lib/query.d.ts +27 -88
- package/lib/query.d.ts.map +1 -1
- package/lib/rate-limiter.d.ts +19 -70
- package/lib/rate-limiter.d.ts.map +1 -1
- package/lib/rate-limiter.js +0 -3
- package/lib/rate-limiter.js.map +1 -1
- package/lib/refs.d.ts +3 -11
- package/lib/refs.d.ts.map +1 -1
- package/lib/refs.js.map +1 -1
- package/lib/roles/types.d.ts +14 -20
- package/lib/roles/types.d.ts.map +1 -1
- package/lib/roles/types.js +5 -9
- package/lib/roles/types.js.map +1 -1
- package/lib/runs.d.ts +6 -25
- package/lib/runs.d.ts.map +1 -1
- package/lib/schema-for-extraction.js.map +1 -1
- package/lib/secrets.d.ts +20 -105
- package/lib/secrets.d.ts.map +1 -1
- package/lib/store/agent-approval.d.ts +6 -15
- package/lib/store/agent-approval.d.ts.map +1 -1
- package/lib/store/agent-approval.js.map +1 -1
- package/lib/store/agent-run.d.ts +57 -358
- package/lib/store/agent-run.d.ts.map +1 -1
- package/lib/store/collections.d.ts +11 -63
- package/lib/store/collections.d.ts.map +1 -1
- package/lib/store/collections.js.map +1 -1
- package/lib/store/conversation-state.d.ts +61 -61
- package/lib/store/conversation-state.d.ts.map +1 -1
- package/lib/store/conversation-state.js +2 -0
- package/lib/store/conversation-state.js.map +1 -1
- package/lib/store/doc-analyzer.d.ts +9 -32
- package/lib/store/doc-analyzer.d.ts.map +1 -1
- package/lib/store/dsl-workflow.d.ts +37 -151
- package/lib/store/dsl-workflow.d.ts.map +1 -1
- package/lib/store/dsl-workflow.js.map +1 -1
- package/lib/store/editing-policy-schema.generated.d.ts +3 -0
- package/lib/store/editing-policy-schema.generated.d.ts.map +1 -0
- package/lib/store/editing-policy-schema.generated.js +28 -0
- package/lib/store/editing-policy-schema.generated.js.map +1 -0
- package/lib/store/grounded-extraction.d.ts +7 -104
- package/lib/store/grounded-extraction.d.ts.map +1 -1
- package/lib/store/grounded-extraction.js.map +1 -1
- package/lib/store/index.d.ts +2 -0
- package/lib/store/index.d.ts.map +1 -1
- package/lib/store/index.js +3 -0
- package/lib/store/index.js.map +1 -1
- package/lib/store/intake-policy-schema.generated.d.ts +3 -0
- package/lib/store/intake-policy-schema.generated.d.ts.map +1 -0
- package/lib/store/intake-policy-schema.generated.js +1425 -0
- package/lib/store/intake-policy-schema.generated.js.map +1 -0
- package/lib/store/process-schema.d.ts +81 -1
- package/lib/store/process-schema.d.ts.map +1 -1
- package/lib/store/process-schema.js +79 -0
- package/lib/store/process-schema.js.map +1 -1
- package/lib/store/process-validation.d.ts.map +1 -1
- package/lib/store/process-validation.js +70 -2
- package/lib/store/process-validation.js.map +1 -1
- package/lib/store/process.d.ts +36 -125
- package/lib/store/process.d.ts.map +1 -1
- package/lib/store/process.js.map +1 -1
- package/lib/store/rendering.d.ts +9 -64
- package/lib/store/rendering.d.ts.map +1 -1
- package/lib/store/rendering.js.map +1 -1
- package/lib/store/schedule.d.ts +6 -6
- package/lib/store/schedule.d.ts.map +1 -1
- package/lib/store/store.d.ts +99 -701
- package/lib/store/store.d.ts.map +1 -1
- package/lib/store/store.js +4 -456
- package/lib/store/store.js.map +1 -1
- package/lib/store/task.d.ts +15 -59
- package/lib/store/task.d.ts.map +1 -1
- package/lib/store/task.js +0 -3
- package/lib/store/task.js.map +1 -1
- package/lib/store/workflow.d.ts +58 -516
- package/lib/store/workflow.d.ts.map +1 -1
- package/lib/store/workflow.js +31 -11
- package/lib/store/workflow.js.map +1 -1
- package/lib/sts-errors.d.ts +7 -0
- package/lib/sts-errors.d.ts.map +1 -0
- package/lib/sts-errors.js +11 -0
- package/lib/sts-errors.js.map +1 -0
- package/lib/sts-token-types.d.ts +13 -66
- package/lib/sts-token-types.d.ts.map +1 -1
- package/lib/sts-token-types.js.map +1 -1
- package/lib/tools.d.ts +8 -100
- package/lib/tools.d.ts.map +1 -1
- package/lib/transient-tokens-values.d.ts +11 -0
- package/lib/transient-tokens-values.d.ts.map +1 -0
- package/lib/transient-tokens-values.js +12 -0
- package/lib/transient-tokens-values.js.map +1 -0
- package/lib/transient-tokens.d.ts +15 -13
- package/lib/transient-tokens.d.ts.map +1 -1
- package/lib/transient-tokens.js +5 -5
- package/lib/transient-tokens.js.map +1 -1
- package/lib/user.d.ts +55 -156
- package/lib/user.d.ts.map +1 -1
- package/lib/user.js +2 -79
- package/lib/user.js.map +1 -1
- package/lib/versions.d.ts +34 -1
- package/lib/versions.d.ts.map +1 -1
- package/lib/versions.js +33 -0
- package/lib/versions.js.map +1 -1
- package/lib/vertesia-common.js +6 -2
- package/lib/vertesia-common.js.map +1 -1
- package/lib/view-configuration-validation.js.map +1 -1
- package/lib/view-query-validation.js.map +1 -1
- package/lib/view-validation-helpers.d.ts +1 -1
- package/lib/view-validation-helpers.d.ts.map +1 -1
- package/lib/views-schema.d.ts +51 -51
- package/lib/views-schema.d.ts.map +1 -1
- package/lib/views-validation.js.map +1 -1
- package/lib/views.d.ts +58 -314
- package/lib/views.d.ts.map +1 -1
- package/lib/views.js.map +1 -1
- package/lib/workflow-analytics.d.ts +10 -3
- package/lib/workflow-analytics.d.ts.map +1 -1
- package/package.json +14 -5
- package/src/access-control-values.ts +113 -0
- package/src/access-control.ts +33 -138
- package/src/account-values.ts +95 -0
- package/src/analytics.ts +18 -42
- package/src/api-schemas/access-control.contract.test.ts +209 -0
- package/src/api-schemas/access-control.ts +208 -0
- package/src/api-schemas/account.contract.test.ts +318 -0
- package/src/api-schemas/account.ts +150 -0
- package/src/api-schemas/adapter-edge-cases.test.ts +480 -0
- package/src/api-schemas/adapter.ts +778 -0
- package/src/api-schemas/agent-runs.ts +1091 -0
- package/src/api-schemas/analytics.ts +65 -0
- package/src/api-schemas/apikey.contract.test.ts +270 -0
- package/src/api-schemas/apikey.ts +199 -0
- package/src/api-schemas/app-delete-summary.contract.test.ts +67 -0
- package/src/api-schemas/app-lifecycle.ts +900 -0
- package/src/api-schemas/app-runtime.ts +1022 -0
- package/src/api-schemas/apps.ts +484 -0
- package/src/api-schemas/audit-trail.ts +243 -0
- package/src/api-schemas/bulk-operation.contract.test.ts +39 -0
- package/src/api-schemas/bulk-operation.ts +75 -0
- package/src/api-schemas/bundle-isolation.test.ts +80 -0
- package/src/api-schemas/commands.contract.test.ts +51 -0
- package/src/api-schemas/commands.ts +62 -0
- package/src/api-schemas/content.ts +952 -0
- package/src/api-schemas/cost-analytics.contract.test.ts +64 -0
- package/src/api-schemas/cost-analytics.ts +235 -0
- package/src/api-schemas/dashboard.contract.test.ts +127 -0
- package/src/api-schemas/dashboard.ts +351 -0
- package/src/api-schemas/data-store.contract.test.ts +91 -0
- package/src/api-schemas/data-store.ts +571 -0
- package/src/api-schemas/document-processing.contract.test.ts +76 -0
- package/src/api-schemas/document-processing.ts +344 -0
- package/src/api-schemas/embeddings.ts +113 -0
- package/src/api-schemas/environment.contract.test.ts +184 -0
- package/src/api-schemas/environment.ts +190 -0
- package/src/api-schemas/events.ts +981 -0
- package/src/api-schemas/files.ts +159 -0
- package/src/api-schemas/group.contract.test.ts +205 -0
- package/src/api-schemas/group.ts +155 -0
- package/src/api-schemas/index.ts +35 -0
- package/src/api-schemas/indexing.contract.test.ts +83 -0
- package/src/api-schemas/indexing.ts +234 -0
- package/src/api-schemas/integrations.ts +369 -0
- package/src/api-schemas/interaction.contract.test.ts +27 -0
- package/src/api-schemas/interaction.ts +2364 -0
- package/src/api-schemas/invites.contract.test.ts +268 -0
- package/src/api-schemas/invites.ts +127 -0
- package/src/api-schemas/llumiverse.contract.test.ts +108 -0
- package/src/api-schemas/mcp-api-key.contract.test.ts +86 -0
- package/src/api-schemas/oauth-server.ts +219 -0
- package/src/api-schemas/oauth.contract.test.ts +118 -0
- package/src/api-schemas/oauth.ts +166 -0
- package/src/api-schemas/parameters.test.ts +402 -0
- package/src/api-schemas/parameters.ts +310 -0
- package/src/api-schemas/process.ts +929 -0
- package/src/api-schemas/project-configuration.ts +478 -0
- package/src/api-schemas/project.contract.test.ts +365 -0
- package/src/api-schemas/project.ts +214 -0
- package/src/api-schemas/prompt.ts +88 -0
- package/src/api-schemas/pruning-limits.test.ts +189 -0
- package/src/api-schemas/quota.contract.test.ts +147 -0
- package/src/api-schemas/quota.ts +122 -0
- package/src/api-schemas/registry-groups.test.ts +91 -0
- package/src/api-schemas/registry.ts +3512 -0
- package/src/api-schemas/response-pruning.test.ts +260 -0
- package/src/api-schemas/schema-primitives.ts +12 -0
- package/src/api-schemas/secrets.ts +332 -0
- package/src/api-schemas/store.contract.test.ts +471 -0
- package/src/api-schemas/store.ts +604 -0
- package/src/api-schemas/sts.contract.test.ts +112 -0
- package/src/api-schemas/sts.ts +123 -0
- package/src/api-schemas/task.ts +104 -0
- package/src/api-schemas/tools.ts +140 -0
- package/src/api-schemas/user.contract.test.ts +191 -0
- package/src/api-schemas/user.ts +204 -0
- package/src/api-schemas/view-execution.ts +200 -0
- package/src/api-schemas/views.ts +437 -0
- package/src/api-schemas/workflow-runs.ts +653 -0
- package/src/apikey-values.ts +10 -0
- package/src/apikey.ts +49 -40
- package/src/apps.test.ts +82 -0
- package/src/apps.ts +283 -1228
- package/src/ask-user.ts +9 -1
- package/src/audit-trail.ts +45 -137
- package/src/browser-credentials.ts +21 -106
- package/src/common.ts +67 -78
- package/src/cost-analytics.ts +37 -176
- package/src/data-platform.ts +205 -776
- package/src/email.ts +5 -17
- package/src/embeddings.ts +22 -60
- package/src/environment.ts +52 -126
- package/src/facets.ts +4 -7
- package/src/group.ts +38 -42
- package/src/index.ts +12 -0
- package/src/integrations.ts +39 -129
- package/src/interaction-values.ts +23 -0
- package/src/interaction.ts +162 -902
- package/src/meters.ts +11 -7
- package/src/oauth-server.ts +58 -127
- package/src/oauth.ts +24 -108
- package/src/payload.ts +25 -40
- package/src/platform-event-validation.test.ts +26 -0
- package/src/platform-event-validation.ts +15 -2
- package/src/platform-event.ts +141 -484
- package/src/principal-context.ts +11 -15
- package/src/project-values.ts +41 -0
- package/src/project.ts +116 -588
- package/src/prompt.ts +34 -61
- package/src/query.ts +34 -93
- package/src/rate-limiter.ts +27 -75
- package/src/refs.ts +4 -11
- package/src/roles/types.ts +20 -20
- package/src/runs.ts +11 -24
- package/src/secrets.ts +38 -117
- package/src/store/agent-approval.ts +9 -14
- package/src/store/agent-run.ts +93 -450
- package/src/store/collections.ts +21 -63
- package/src/store/content-type-editing.test.ts +1 -1
- package/src/store/conversation-state.ts +75 -64
- package/src/store/doc-analyzer.ts +17 -33
- package/src/store/dsl-workflow.ts +62 -158
- package/src/store/editing-policy-schema.generated.ts +30 -0
- package/src/store/grounded-extraction.ts +13 -104
- package/src/store/index.ts +3 -0
- package/src/store/intake-policy-schema.generated.ts +1442 -0
- package/src/store/process-schema.test.ts +43 -0
- package/src/store/process-schema.ts +79 -0
- package/src/store/process-validation.test.ts +141 -0
- package/src/store/process-validation.ts +82 -2
- package/src/store/process.ts +70 -146
- package/src/store/rendering.ts +15 -64
- package/src/store/store.ts +197 -1204
- package/src/store/task.ts +25 -59
- package/src/store/workflow.ts +103 -554
- package/src/sts-errors.ts +13 -0
- package/src/sts-token-types.ts +26 -75
- package/src/tools.ts +18 -97
- package/src/transient-tokens-values.ts +11 -0
- package/src/transient-tokens.ts +16 -13
- package/src/user.ts +75 -215
- package/src/versions.test.ts +13 -0
- package/src/versions.ts +36 -0
- package/src/views-schema.test.ts +9 -1
- package/src/views.ts +106 -329
- package/src/workflow-analytics.ts +10 -3
package/lib/apps.d.ts
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type {
|
|
3
|
-
import type {
|
|
4
|
-
import type {
|
|
5
|
-
import type {
|
|
1
|
+
import type { z } from 'zod';
|
|
2
|
+
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';
|
|
3
|
+
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';
|
|
4
|
+
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';
|
|
5
|
+
import type { RemoteActivityDefinitionSchema } from './api-schemas/integrations.js';
|
|
6
|
+
import type { ProjectToolInfoSchema, RenderingTemplateDefinitionRefSchema, RenderingTemplateDefinitionSchema } from './api-schemas/project.js';
|
|
6
7
|
/** Allowed values for AppUINavItem.preferredSection */
|
|
7
|
-
export declare const PREFERRED_SECTIONS: readonly [
|
|
8
|
+
export declare const PREFERRED_SECTIONS: readonly ['default', 'footer', 'settings'];
|
|
8
9
|
/**
|
|
9
10
|
* Additional navigation item for an app's UI configuration.
|
|
10
11
|
* Used in AppUIConfig.navigation to define sidebar navigation entries in CompositeApp shell contexts.
|
|
@@ -31,183 +32,20 @@ export interface AppUINavItem {
|
|
|
31
32
|
*/
|
|
32
33
|
preferredSection?: (typeof PREFERRED_SECTIONS)[number];
|
|
33
34
|
}
|
|
34
|
-
export
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
* For example: `/plugins/vertesia-review-center-${buildId}`
|
|
39
|
-
*/
|
|
40
|
-
src: string;
|
|
41
|
-
/**
|
|
42
|
-
* The isolation strategy. If not specified it defaults to shadow.
|
|
43
|
-
* - shadow - use Shadow DOM to fully isolate the plugin from the host.
|
|
44
|
-
* - css - inject the plugin's styles (minus the preflight) into the host document;
|
|
45
|
-
* lighter but styles may conflict with the host.
|
|
46
|
-
*/
|
|
47
|
-
isolation?: 'shadow' | 'css';
|
|
48
|
-
/**
|
|
49
|
-
* When true the host modifies the app's css at load time to attempt to fix broken
|
|
50
|
-
* or missing styles. Only takes effect in css isolation mode. Defaults to false.
|
|
51
|
-
*/
|
|
52
|
-
css_rebuild?: boolean;
|
|
53
|
-
/**
|
|
54
|
-
* Navigation items for the app's sidebar UI.
|
|
55
|
-
* Only applicable for apps with UI capability in shell contexts (ie. CompositeApp shell).
|
|
56
|
-
*/
|
|
57
|
-
navigation?: AppUINavItem[];
|
|
58
|
-
/**
|
|
59
|
-
* Where this app's UI can be displayed.
|
|
60
|
-
* - 'app_portal': Available in the main app portal (standalone)
|
|
61
|
-
* - 'composite_app': Available within a CompositeApp shell
|
|
62
|
-
* Defaults to ['app_portal', 'composite_app'] for new apps.
|
|
63
|
-
*/
|
|
64
|
-
available_in?: AppAvailableIn[];
|
|
65
|
-
}
|
|
66
|
-
export interface AppInstallationProjectsQuery {
|
|
67
|
-
name?: string;
|
|
68
|
-
id?: string;
|
|
69
|
-
}
|
|
70
|
-
export interface AppInstallationsQuery {
|
|
71
|
-
kind?: AppInstallationKind;
|
|
72
|
-
available_in?: AppAvailableIn;
|
|
73
|
-
}
|
|
74
|
-
/**
|
|
75
|
-
* Authentication type for tool collections
|
|
76
|
-
*/
|
|
77
|
-
export type ToolCollectionAuthType = 'oauth' | 'other';
|
|
35
|
+
export type AppUIConfig = z.infer<typeof AppUIConfigSchema>;
|
|
36
|
+
export type AppInstallationProjectsQuery = z.infer<typeof AppInstallationProjectsQuerySchema>;
|
|
37
|
+
export type AppInstallationsQuery = z.infer<typeof AppInstallationsQuerySchema>;
|
|
38
|
+
export type ToolCollectionAuthType = z.infer<typeof ToolCollectionAuthTypeSchema>;
|
|
78
39
|
/**
|
|
79
40
|
* Tool collection type
|
|
80
41
|
*/
|
|
81
42
|
export type ToolCollectionType = 'mcp' | 'vertesia_sdk';
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
*/
|
|
89
|
-
url: string;
|
|
90
|
-
/**
|
|
91
|
-
* Optional authentication type required for this tool collection
|
|
92
|
-
*/
|
|
93
|
-
auth?: ToolCollectionAuthType;
|
|
94
|
-
}
|
|
95
|
-
/**
|
|
96
|
-
* Install-time OAuth provisioning blueprint for an MCP collection.
|
|
97
|
-
* Defines how to auto-create an OAuth provider when the app is installed.
|
|
98
|
-
* Does NOT affect runtime behaviour — the runtime uses oauth_bindings on AppInstallation.
|
|
99
|
-
*/
|
|
100
|
-
export interface MCPOAuthConfig {
|
|
101
|
-
/**
|
|
102
|
-
* Name for the OAuth provider to create at install time.
|
|
103
|
-
* Defaults to the collection id converted to kebab-case if not specified.
|
|
104
|
-
*/
|
|
105
|
-
name?: string;
|
|
106
|
-
/** Human-readable display name for the created OAuth provider. */
|
|
107
|
-
display_name?: string;
|
|
108
|
-
grant_type?: 'authorization_code' | 'client_credentials';
|
|
109
|
-
authorization_endpoint?: string;
|
|
110
|
-
token_endpoint?: string;
|
|
111
|
-
revocation_endpoint?: string;
|
|
112
|
-
/**
|
|
113
|
-
* Pre-configured client_id.
|
|
114
|
-
* Omit if the installer must supply it (include 'client_id' in required_at_install).
|
|
115
|
-
*/
|
|
116
|
-
client_id?: string;
|
|
117
|
-
use_pkce?: boolean;
|
|
118
|
-
default_scopes?: string[];
|
|
119
|
-
/**
|
|
120
|
-
* Parameters the installer must provide at install time.
|
|
121
|
-
* These are shown as form fields in composable-ui before the install completes.
|
|
122
|
-
* - 'client_id': user supplies the OAuth client ID
|
|
123
|
-
* - 'client_secret': user supplies the OAuth client secret
|
|
124
|
-
*/
|
|
125
|
-
required_at_install?: Array<'client_id' | 'client_secret' | 'scopes'>;
|
|
126
|
-
}
|
|
127
|
-
/**
|
|
128
|
-
* MCP tool collection configuration (requires name, description, and namespace)
|
|
129
|
-
*/
|
|
130
|
-
export interface MCPToolCollectionObject extends BaseToolCollectionObject {
|
|
131
|
-
type: 'mcp';
|
|
132
|
-
/**
|
|
133
|
-
* Stable identifier for this collection.
|
|
134
|
-
* Used to key oauth_bindings on AppInstallation — protects against collection renames.
|
|
135
|
-
* Required for new manifests.
|
|
136
|
-
*/
|
|
137
|
-
id: string;
|
|
138
|
-
/**
|
|
139
|
-
* Name for the tool collection.
|
|
140
|
-
* Human-readable label for the collection.
|
|
141
|
-
* Used in UI.
|
|
142
|
-
*/
|
|
143
|
-
name: string;
|
|
144
|
-
/**
|
|
145
|
-
* Description for the tool collection.
|
|
146
|
-
* Helps users understand what tools this collection provides.
|
|
147
|
-
*/
|
|
148
|
-
description: string;
|
|
149
|
-
/**
|
|
150
|
-
* Prefix to use for tool names from this collection.
|
|
151
|
-
* Provides clean, readable tool names (e.g., "jira" instead of "https://mcp.atlassian.com/v1/mcp")
|
|
152
|
-
*/
|
|
153
|
-
namespace: string;
|
|
154
|
-
/**
|
|
155
|
-
* Reference to an OAuth provider name for this collection (legacy / manual path).
|
|
156
|
-
* When set, uses the OAuth provider's config (endpoints, client_id, client_secret)
|
|
157
|
-
* instead of MCP dynamic client registration or random fallback.
|
|
158
|
-
* The referenced OAuth provider must exist in the same project.
|
|
159
|
-
*/
|
|
160
|
-
oauth_app?: string;
|
|
161
|
-
/**
|
|
162
|
-
* Install-time OAuth provisioning blueprint.
|
|
163
|
-
* When present, the platform auto-creates an OAuth provider at install time
|
|
164
|
-
* using these values merged with any user-supplied required_at_install params.
|
|
165
|
-
* The created app is recorded in AppInstallation.oauth_bindings.
|
|
166
|
-
* Mutually exclusive with oauth_provider.
|
|
167
|
-
*/
|
|
168
|
-
oauth_config?: MCPOAuthConfig;
|
|
169
|
-
/**
|
|
170
|
-
* Reference to a key in AppManifestData.oauth_providers.
|
|
171
|
-
* When set, this collection shares the named provider's OAuth provider configuration.
|
|
172
|
-
* Mutually exclusive with oauth_config and oauth_app.
|
|
173
|
-
* Requires auth: "oauth" to be set.
|
|
174
|
-
*/
|
|
175
|
-
oauth_provider?: string;
|
|
176
|
-
/**
|
|
177
|
-
* Additional OAuth scopes for this collection when using a shared oauth_provider.
|
|
178
|
-
* These are merged (union) with the provider's default_scopes at install time.
|
|
179
|
-
* Only valid when oauth_provider is set.
|
|
180
|
-
*/
|
|
181
|
-
oauth_scopes?: string[];
|
|
182
|
-
}
|
|
183
|
-
/**
|
|
184
|
-
* Vertesia SDK tool collection configuration
|
|
185
|
-
*/
|
|
186
|
-
export interface VertesiaSDKToolCollectionObject extends BaseToolCollectionObject {
|
|
187
|
-
type: 'vertesia_sdk';
|
|
188
|
-
/**
|
|
189
|
-
* Optional namespace to use for tool names from this collection.
|
|
190
|
-
* If not provided, the tool server default will be used.
|
|
191
|
-
*/
|
|
192
|
-
namespace?: string;
|
|
193
|
-
/**
|
|
194
|
-
* Optional name for the tool collection.
|
|
195
|
-
* If not provided, the tool server default will be used.
|
|
196
|
-
*/
|
|
197
|
-
name?: string;
|
|
198
|
-
/**
|
|
199
|
-
* Optional description for the tool collection.
|
|
200
|
-
* If not provided, the tool server default will be used.
|
|
201
|
-
*/
|
|
202
|
-
description?: string;
|
|
203
|
-
}
|
|
204
|
-
/**
|
|
205
|
-
* Tool collection configuration (object format)
|
|
206
|
-
*/
|
|
207
|
-
/**
|
|
208
|
-
* @discriminator type
|
|
209
|
-
*/
|
|
210
|
-
export type ToolCollectionObject = MCPToolCollectionObject | VertesiaSDKToolCollectionObject;
|
|
43
|
+
export type MCPOAuthConfig = z.infer<typeof MCPOAuthConfigSchema>;
|
|
44
|
+
/** Install-time provisioning blueprint for an `auth: 'api_key'` MCP collection. Never holds the key. */
|
|
45
|
+
export type MCPApiKeyConfig = z.infer<typeof MCPApiKeyConfigSchema>;
|
|
46
|
+
export type MCPToolCollectionObject = z.infer<typeof MCPToolCollectionObjectSchema>;
|
|
47
|
+
export type VertesiaSDKToolCollectionObject = z.infer<typeof VertesiaSDKToolCollectionObjectSchema>;
|
|
48
|
+
export type ToolCollectionObject = z.infer<typeof ToolCollectionObjectSchema>;
|
|
211
49
|
/**
|
|
212
50
|
* Backward-compatible TypeScript alias. Public API payloads should reference
|
|
213
51
|
* ToolCollectionObject directly so generated clients do not create a wrapper
|
|
@@ -233,18 +71,7 @@ export declare function normalizeToolCollection(collection: ToolCollectionObject
|
|
|
233
71
|
/**
|
|
234
72
|
* Metadata hints from MCP tool annotations (per MCP spec).
|
|
235
73
|
*/
|
|
236
|
-
export
|
|
237
|
-
/** Human-readable display name for the tool */
|
|
238
|
-
title?: string;
|
|
239
|
-
/** If true, the tool does not modify any state */
|
|
240
|
-
readOnlyHint?: boolean;
|
|
241
|
-
/** If true, the tool may perform irreversible destructive operations */
|
|
242
|
-
destructiveHint?: boolean;
|
|
243
|
-
/** If true, calling the tool multiple times with the same args has no additional effect */
|
|
244
|
-
idempotentHint?: boolean;
|
|
245
|
-
/** If true, the tool interacts with external entities outside the local environment */
|
|
246
|
-
openWorldHint?: boolean;
|
|
247
|
-
}
|
|
74
|
+
export type MCPToolAnnotations = z.infer<typeof MCPToolAnnotationsSchema>;
|
|
248
75
|
/**
|
|
249
76
|
* Approval behavior class for a tool exposed to agents.
|
|
250
77
|
*
|
|
@@ -253,75 +80,23 @@ export interface MCPToolAnnotations {
|
|
|
253
80
|
* - `control`: affects agent control flow or tool availability, not user data or external systems.
|
|
254
81
|
* - `requires_confirmation`: high-impact action that must ask the user even in interactive full-control mode.
|
|
255
82
|
*/
|
|
256
|
-
export type AgentToolApprovalClass =
|
|
83
|
+
export type AgentToolApprovalClass = z.infer<typeof AgentToolApprovalClassSchema>;
|
|
257
84
|
/**
|
|
258
85
|
* Tool definition with optional activation control for agent exposure.
|
|
259
86
|
*/
|
|
260
|
-
export
|
|
261
|
-
/**
|
|
262
|
-
* The tool execution URL. It can be an absolute URL or a path in which case the URL is obtained
|
|
263
|
-
* using the base URL of the tool server API. Ex: http://tool-server.com/api/
|
|
264
|
-
* Example of relative URLs: "tools/my-tool-collection" or "/api/tools/my-tool-collection"
|
|
265
|
-
*/
|
|
266
|
-
url?: string;
|
|
267
|
-
/**
|
|
268
|
-
* The tool category if any - for UI purposes.
|
|
269
|
-
*/
|
|
270
|
-
category?: string;
|
|
271
|
-
/**
|
|
272
|
-
* Whether this tool is available by default.
|
|
273
|
-
* - true/undefined: Tool is always available to agents
|
|
274
|
-
* - false: Tool is only available when enabled by a skill via `tools`
|
|
275
|
-
*/
|
|
276
|
-
default?: boolean;
|
|
277
|
-
/**
|
|
278
|
-
* For skill tools (`learn_*`): the tool names this skill enables when called.
|
|
279
|
-
* Matches the `tools:` key used in SKILL.md frontmatter and built-in skill
|
|
280
|
-
* definitions — one name across the whole stack.
|
|
281
|
-
*/
|
|
282
|
-
tools?: string[];
|
|
283
|
-
/**
|
|
284
|
-
* MCP tool annotations providing hints about tool behavior and safety.
|
|
285
|
-
*/
|
|
286
|
-
annotations?: MCPToolAnnotations;
|
|
287
|
-
/**
|
|
288
|
-
* Approval classification used by interactive agent approval modes.
|
|
289
|
-
* Use `requires_confirmation` for actions that must prompt even in full-control mode.
|
|
290
|
-
*/
|
|
291
|
-
approval_class?: AgentToolApprovalClass;
|
|
292
|
-
}
|
|
87
|
+
export type AgentToolDefinition = z.infer<typeof AgentToolDefinitionSchema>;
|
|
293
88
|
/**
|
|
294
89
|
* Definition of a remote activity exposed by a tool server for use in DSL workflows.
|
|
295
90
|
* Remote activities are identified in workflow steps using colon-separated names:
|
|
296
91
|
* `app:<app_name>:<collection>:<activity_name>` (e.g. `app:my-nlp-app:examples:word_count`).
|
|
297
92
|
*/
|
|
298
|
-
export
|
|
299
|
-
/** Activity name (snake_case, unique within the collection) */
|
|
300
|
-
name: string;
|
|
301
|
-
/** Collection name this activity belongs to */
|
|
302
|
-
collection?: string;
|
|
303
|
-
/** Display title */
|
|
304
|
-
title?: string;
|
|
305
|
-
/** Description of what the activity does */
|
|
306
|
-
description?: string;
|
|
307
|
-
/** JSON Schema for the activity input parameters */
|
|
308
|
-
input_schema?: Record<string, unknown>;
|
|
309
|
-
/** JSON Schema for the activity output */
|
|
310
|
-
output_schema?: Record<string, unknown>;
|
|
311
|
-
/**
|
|
312
|
-
* The activity execution URL. Can be absolute or relative to the tool server base URL.
|
|
313
|
-
* If not provided, the collection-specific activities endpoint is used.
|
|
314
|
-
*/
|
|
315
|
-
url?: string;
|
|
316
|
-
/** Suggested timeout and retry configuration */
|
|
317
|
-
options?: DSLActivityOptions;
|
|
318
|
-
}
|
|
93
|
+
export type RemoteActivityDefinition = z.infer<typeof RemoteActivityDefinitionSchema>;
|
|
319
94
|
/**
|
|
320
95
|
* Canonical app capabilities Studio renders/supports. The public type is derived from
|
|
321
96
|
* this list so runtime validation and TypeScript cannot drift.
|
|
322
97
|
*/
|
|
323
|
-
export declare const APP_CAPABILITIES: readonly [
|
|
324
|
-
export type AppCapabilities =
|
|
98
|
+
export declare const APP_CAPABILITIES: readonly ['ui', 'tools', 'interactions', 'types', 'processes', 'views', 'templates', 'dashboards'];
|
|
99
|
+
export type AppCapabilities = z.infer<typeof AppCapabilitiesSchema>;
|
|
325
100
|
/**
|
|
326
101
|
* Header carrying the app version a generated-app UI is running, so studio/zeno resolve app-owned
|
|
327
102
|
* capability refs (`app:<app>:...`) against that exact version instead of the promoted version.
|
|
@@ -335,13 +110,13 @@ export declare const APP_VERSION_HEADER = "x-vertesia-app-version";
|
|
|
335
110
|
* {@link AppCapabilities} folds together. Used by the App Solution Architect manifest and
|
|
336
111
|
* the publish-time capability gate.
|
|
337
112
|
*/
|
|
338
|
-
export declare const APP_ARTIFACT_TYPES: readonly [
|
|
113
|
+
export declare const APP_ARTIFACT_TYPES: readonly ['interaction', 'agent', 'type', 'process', 'view', 'template', 'dashboard', 'activity', 'tool', 'hook', 'subscription'];
|
|
339
114
|
export type AppArtifactType = (typeof APP_ARTIFACT_TYPES)[number];
|
|
340
115
|
/**
|
|
341
116
|
* A single platform artifact the App Solution Architect requires the build to create.
|
|
342
117
|
* `id` is the app-owned in-code id the implementation must register and reference
|
|
343
118
|
* (e.g. `app:<name>:main:extract-item` for interactions/agents, `app:<name>:<type>` for
|
|
344
|
-
* types, `app:<name>:<process>` for processes).
|
|
119
|
+
* types, `app:<name>:<process>` for processes, and `app:<name>:<local-id>` for hooks/subscriptions).
|
|
345
120
|
*/
|
|
346
121
|
/**
|
|
347
122
|
* Build progress for one artifact, maintained by the developer agent as a living checklist:
|
|
@@ -371,10 +146,10 @@ export interface AppPlannedArtifact {
|
|
|
371
146
|
}
|
|
372
147
|
/**
|
|
373
148
|
* Structured result the App Solution Architect emits alongside its prose artifacts — the
|
|
374
|
-
* machine-readable contract for the build. The implementation MUST
|
|
375
|
-
*
|
|
376
|
-
* {@link APP_CAPABILITY_MANIFEST_PATH} so it survives
|
|
377
|
-
*
|
|
149
|
+
* machine-readable contract for the build. The implementation MUST register every required artifact
|
|
150
|
+
* before building a candidate, then successfully exercise it after that candidate is installed and
|
|
151
|
+
* version-pinned. Persisted into the app repo as {@link APP_CAPABILITY_MANIFEST_PATH} so it survives
|
|
152
|
+
* across runs and the package-registration gate can verify it deterministically. If the builder finds the plan
|
|
378
153
|
* wrong or insufficient, the orchestrator relaunches the architect to revise the manifest;
|
|
379
154
|
* the gate always checks against the latest committed copy.
|
|
380
155
|
*/
|
|
@@ -399,156 +174,27 @@ export interface AppCapabilityManifest {
|
|
|
399
174
|
}
|
|
400
175
|
/** Repo-relative path the capability manifest is committed to, read by version-build gates. */
|
|
401
176
|
export declare const APP_CAPABILITY_MANIFEST_PATH = "docs/app-capability-manifest.json";
|
|
402
|
-
export type AppAvailableIn =
|
|
403
|
-
export type AppVersionKind =
|
|
404
|
-
export type AppVersionState =
|
|
405
|
-
export type AppVersionTarget =
|
|
406
|
-
export type AppVersionGitRefType =
|
|
407
|
-
export type AppBuildTrigger =
|
|
408
|
-
export
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
build_prefix?: string;
|
|
415
|
-
manifest_path?: string;
|
|
416
|
-
service_archive?: string;
|
|
417
|
-
live_metadata_path?: string;
|
|
418
|
-
}
|
|
419
|
-
export interface AppVersionGitSource {
|
|
420
|
-
url?: string;
|
|
421
|
-
remote?: string;
|
|
422
|
-
/**
|
|
423
|
-
* The source ref that should be used to reproduce this version. Immutable
|
|
424
|
-
* app versions use the exact commit SHA rather than a mutable branch or tag.
|
|
425
|
-
*/
|
|
426
|
-
ref?: string;
|
|
427
|
-
ref_type?: AppVersionGitRefType;
|
|
428
|
-
branch?: string;
|
|
429
|
-
tag?: string;
|
|
430
|
-
commit?: string;
|
|
431
|
-
dirty?: boolean;
|
|
432
|
-
pushed?: boolean;
|
|
433
|
-
push_warning?: string;
|
|
434
|
-
}
|
|
435
|
-
export interface AppVersionUrls {
|
|
436
|
-
live_url?: string;
|
|
437
|
-
app_url?: string;
|
|
438
|
-
plugin_url?: string;
|
|
439
|
-
package_url?: string;
|
|
440
|
-
internal_preview_url?: string;
|
|
441
|
-
}
|
|
442
|
-
export interface AppVersionRecord {
|
|
443
|
-
id: string;
|
|
444
|
-
account: string;
|
|
445
|
-
project: string;
|
|
446
|
-
app?: string;
|
|
447
|
-
app_id: string;
|
|
448
|
-
app_name: string;
|
|
449
|
-
version_id: string;
|
|
450
|
-
kind: AppVersionKind;
|
|
451
|
-
state: AppVersionState;
|
|
452
|
-
promoted?: boolean;
|
|
453
|
-
target?: AppVersionTarget;
|
|
454
|
-
agent_run_id?: string;
|
|
455
|
-
/** Development task that produced this version, when built by the app assistant. */
|
|
456
|
-
development_task_id?: string;
|
|
457
|
-
/** Temporal workflow that produced this version. */
|
|
458
|
-
build_workflow_id?: string;
|
|
459
|
-
/** Temporal run that produced this version. */
|
|
460
|
-
build_workflow_run_id?: string;
|
|
461
|
-
sandbox_id?: string;
|
|
462
|
-
title?: string;
|
|
463
|
-
description?: string;
|
|
464
|
-
storage?: AppVersionStorage;
|
|
465
|
-
/** Exact Git commit used to build this immutable version. */
|
|
466
|
-
source_commit?: string;
|
|
467
|
-
urls?: AppVersionUrls;
|
|
468
|
-
manifest?: Record<string, unknown>;
|
|
469
|
-
files?: string[];
|
|
470
|
-
file_count?: number;
|
|
471
|
-
source_file_count?: number;
|
|
472
|
-
screenshot_artifact?: string;
|
|
473
|
-
checks?: string[];
|
|
474
|
-
created_by?: string;
|
|
475
|
-
created_at: string;
|
|
476
|
-
updated_at: string;
|
|
477
|
-
built_at?: string;
|
|
478
|
-
checked_at?: string;
|
|
479
|
-
expires_at?: string;
|
|
480
|
-
}
|
|
481
|
-
export interface DeleteAppVersionResponse {
|
|
482
|
-
id: string;
|
|
483
|
-
app_id: string;
|
|
484
|
-
version_id: string;
|
|
485
|
-
storage_prefix?: string;
|
|
486
|
-
deleted: boolean;
|
|
487
|
-
warnings: string[];
|
|
488
|
-
}
|
|
489
|
-
export interface UpsertAppVersionRequest {
|
|
490
|
-
/** Existing version record to update in place, used by reproducible rebuilds. */
|
|
491
|
-
record_id?: string;
|
|
492
|
-
app?: string;
|
|
493
|
-
app_id: string;
|
|
494
|
-
app_name?: string;
|
|
495
|
-
version_id: string;
|
|
496
|
-
kind: AppVersionKind;
|
|
497
|
-
state?: AppVersionState;
|
|
498
|
-
target?: AppVersionTarget;
|
|
499
|
-
agent_run_id?: string;
|
|
500
|
-
/** Development task that produced this version, when built by the app assistant. */
|
|
501
|
-
development_task_id?: string;
|
|
502
|
-
build_workflow_id?: string;
|
|
503
|
-
build_workflow_run_id?: string;
|
|
504
|
-
sandbox_id?: string;
|
|
505
|
-
title?: string;
|
|
506
|
-
description?: string;
|
|
507
|
-
storage?: AppVersionStorage;
|
|
508
|
-
/** Exact Git commit used to build this immutable version. */
|
|
509
|
-
source_commit?: string;
|
|
510
|
-
urls?: AppVersionUrls;
|
|
511
|
-
manifest?: Record<string, unknown>;
|
|
512
|
-
files?: string[];
|
|
513
|
-
file_count?: number;
|
|
514
|
-
source_file_count?: number;
|
|
515
|
-
screenshot_artifact?: string;
|
|
516
|
-
checks?: string[];
|
|
517
|
-
built_at?: string;
|
|
518
|
-
checked_at?: string;
|
|
519
|
-
expires_at?: string;
|
|
520
|
-
}
|
|
177
|
+
export type AppAvailableIn = z.infer<typeof AppAvailableInSchema>;
|
|
178
|
+
export type AppVersionKind = z.infer<typeof AppVersionKindSchema>;
|
|
179
|
+
export type AppVersionState = z.infer<typeof AppVersionStateSchema>;
|
|
180
|
+
export type AppVersionTarget = z.infer<typeof AppVersionTargetSchema>;
|
|
181
|
+
export type AppVersionGitRefType = z.infer<typeof AppVersionGitRefTypeSchema>;
|
|
182
|
+
export type AppBuildTrigger = z.infer<typeof AppBuildTriggerSchema>;
|
|
183
|
+
export type AppVersionStorage = z.infer<typeof AppVersionStorageSchema>;
|
|
184
|
+
export type AppVersionGitSource = z.infer<typeof AppVersionGitSourceSchema>;
|
|
185
|
+
export type AppVersionUrls = z.infer<typeof AppVersionUrlsSchema>;
|
|
186
|
+
export type AppVersionRecord = z.infer<typeof AppVersionRecordSchema>;
|
|
187
|
+
export type DeleteAppVersionResponse = z.infer<typeof DeleteAppVersionResponseSchema>;
|
|
188
|
+
export type UpsertAppVersionRequest = z.infer<typeof UpsertAppVersionRequestSchema>;
|
|
521
189
|
export interface AppVersionListQuery {
|
|
522
190
|
app_id?: string;
|
|
523
191
|
kind?: AppVersionKind;
|
|
524
192
|
include_expired?: boolean;
|
|
525
193
|
limit?: number;
|
|
526
194
|
}
|
|
527
|
-
export
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
}
|
|
531
|
-
export interface StartAppBuildRequest {
|
|
532
|
-
/**
|
|
533
|
-
* Source branch, tag, or commit to build. When omitted, the app source
|
|
534
|
-
* configuration chooses its default branch.
|
|
535
|
-
*/
|
|
536
|
-
source_ref?: string;
|
|
537
|
-
source_ref_type?: Extract<AppVersionGitRefType, 'branch' | 'tag' | 'commit'>;
|
|
538
|
-
trigger?: AppBuildTrigger;
|
|
539
|
-
target?: AppVersionTarget;
|
|
540
|
-
title?: string;
|
|
541
|
-
description?: string;
|
|
542
|
-
}
|
|
543
|
-
export interface StartAppBuildResponse {
|
|
544
|
-
workflow_id: string;
|
|
545
|
-
run_id: string;
|
|
546
|
-
app_id: string;
|
|
547
|
-
version_id?: string;
|
|
548
|
-
rebuild_version_record_id?: string;
|
|
549
|
-
source_ref?: string;
|
|
550
|
-
source_ref_type?: Extract<AppVersionGitRefType, 'branch' | 'tag' | 'commit'>;
|
|
551
|
-
}
|
|
195
|
+
export type PromoteAppVersionResponse = z.infer<typeof PromoteAppVersionResponseSchema>;
|
|
196
|
+
export type StartAppBuildRequest = z.infer<typeof StartAppBuildRequestSchema>;
|
|
197
|
+
export type StartAppBuildResponse = z.infer<typeof StartAppBuildResponseSchema>;
|
|
552
198
|
export interface AppBuildWorkflowInput extends StartAppBuildRequest {
|
|
553
199
|
app_id: string;
|
|
554
200
|
app_record_id?: string;
|
|
@@ -568,44 +214,11 @@ export interface AppBuildWorkflowResult {
|
|
|
568
214
|
urls?: AppVersionUrls;
|
|
569
215
|
file_count?: number;
|
|
570
216
|
}
|
|
571
|
-
export type AppBuildProgressStatus =
|
|
572
|
-
export
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
version_id?: string;
|
|
577
|
-
source_ref?: string;
|
|
578
|
-
source_ref_type?: Extract<AppVersionGitRefType, 'branch' | 'tag' | 'commit'>;
|
|
579
|
-
source_commit?: string;
|
|
580
|
-
file_count?: number;
|
|
581
|
-
app_url?: string;
|
|
582
|
-
error?: string;
|
|
583
|
-
updated_at: string;
|
|
584
|
-
}
|
|
585
|
-
export type AppScaffoldModule = 'service' | 'assistant' | 'content-app' | 'examples';
|
|
586
|
-
export interface StartAppScaffoldRequest {
|
|
587
|
-
/**
|
|
588
|
-
* App id / package name to create. It is normalized to the same slug rules
|
|
589
|
-
* used by @vertesia/create-plugin.
|
|
590
|
-
*/
|
|
591
|
-
app_id: string;
|
|
592
|
-
title?: string;
|
|
593
|
-
description?: string;
|
|
594
|
-
modules?: AppScaffoldModule[];
|
|
595
|
-
/**
|
|
596
|
-
* Start an initial app version build after the source has been pushed.
|
|
597
|
-
* Defaults to true.
|
|
598
|
-
*/
|
|
599
|
-
create_version?: boolean;
|
|
600
|
-
}
|
|
601
|
-
export interface StartAppScaffoldResponse {
|
|
602
|
-
workflow_id: string;
|
|
603
|
-
run_id: string;
|
|
604
|
-
app_id: string;
|
|
605
|
-
app_record_id?: string;
|
|
606
|
-
git_url?: string;
|
|
607
|
-
create_version: boolean;
|
|
608
|
-
}
|
|
217
|
+
export type AppBuildProgressStatus = z.infer<typeof AppBuildProgressStatusSchema>;
|
|
218
|
+
export type AppBuildProgress = z.infer<typeof AppBuildProgressSchema>;
|
|
219
|
+
export type AppScaffoldModule = z.infer<typeof AppScaffoldModuleSchema>;
|
|
220
|
+
export type StartAppScaffoldRequest = z.infer<typeof StartAppScaffoldRequestSchema>;
|
|
221
|
+
export type StartAppScaffoldResponse = z.infer<typeof StartAppScaffoldResponseSchema>;
|
|
609
222
|
export interface AppScaffoldWorkflowInput extends StartAppScaffoldRequest {
|
|
610
223
|
}
|
|
611
224
|
export interface AppScaffoldWorkflowResult {
|
|
@@ -617,20 +230,8 @@ export interface AppScaffoldWorkflowResult {
|
|
|
617
230
|
files?: number;
|
|
618
231
|
initial_version_build?: StartAppBuildResponse;
|
|
619
232
|
}
|
|
620
|
-
export type AppScaffoldProgressStatus =
|
|
621
|
-
export
|
|
622
|
-
status: AppScaffoldProgressStatus;
|
|
623
|
-
step: string;
|
|
624
|
-
app_id?: string;
|
|
625
|
-
app_record_id?: string;
|
|
626
|
-
installation_id?: string;
|
|
627
|
-
git_url?: string;
|
|
628
|
-
files?: number;
|
|
629
|
-
initial_version_build?: StartAppBuildResponse;
|
|
630
|
-
error?: string;
|
|
631
|
-
error_details?: string[];
|
|
632
|
-
updated_at: string;
|
|
633
|
-
}
|
|
233
|
+
export type AppScaffoldProgressStatus = z.infer<typeof AppScaffoldProgressStatusSchema>;
|
|
234
|
+
export type AppScaffoldProgress = z.infer<typeof AppScaffoldProgressSchema>;
|
|
634
235
|
/**
|
|
635
236
|
* Access control policy for an app installation.
|
|
636
237
|
* Declares which access surfaces are gated by per-user ACEs.
|
|
@@ -643,7 +244,7 @@ export interface AppScaffoldProgress {
|
|
|
643
244
|
*
|
|
644
245
|
* Declared on the manifest as the app's default. May be overridden per-installation.
|
|
645
246
|
*/
|
|
646
|
-
export type AppAccessControl =
|
|
247
|
+
export type AppAccessControl = z.infer<typeof AppAccessControlSchema>;
|
|
647
248
|
/**
|
|
648
249
|
* Resolve the effective access_control policy for an installed app:
|
|
649
250
|
* installation override wins, then manifest default, then `'all'`.
|
|
@@ -658,141 +259,9 @@ export declare function effectiveAppAccessControl(installation: {
|
|
|
658
259
|
} | null | undefined, manifest: {
|
|
659
260
|
access_control?: AppAccessControl;
|
|
660
261
|
} | null | undefined): AppAccessControl;
|
|
661
|
-
export
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
* Must be in kebab case (e.g. my-app).
|
|
665
|
-
*/
|
|
666
|
-
name: string;
|
|
667
|
-
/**
|
|
668
|
-
* Visibility level of the app:
|
|
669
|
-
* - "public": visible to all accounts
|
|
670
|
-
* - "private": visible only to the owning account
|
|
671
|
-
* - "vertesia": visible only to Vertesia team members (any project)
|
|
672
|
-
*/
|
|
673
|
-
visibility: 'public' | 'private' | 'vertesia';
|
|
674
|
-
title: string;
|
|
675
|
-
description: string;
|
|
676
|
-
publisher: string;
|
|
677
|
-
/**
|
|
678
|
-
* A svg icon for the app.
|
|
679
|
-
*/
|
|
680
|
-
icon?: string;
|
|
681
|
-
/**
|
|
682
|
-
* A color name to be used as the color of the app card (e.g. blue, red, green, etc.)
|
|
683
|
-
* If not specified a random color will be picked.
|
|
684
|
-
*/
|
|
685
|
-
color?: string;
|
|
686
|
-
/**
|
|
687
|
-
* Optional preview screenshot for the app-management UI, captured by the builder during a
|
|
688
|
-
* build/QA run. Resolved client-side from the owning agent run's artifact storage, so it
|
|
689
|
-
* carries both the run id and the artifact path.
|
|
690
|
-
*/
|
|
691
|
-
preview_screenshot?: {
|
|
692
|
-
/** Agent run id whose artifact storage holds the screenshot. */
|
|
693
|
-
agent_run_id: string;
|
|
694
|
-
/** Artifact path within that storage, e.g. "preview-checks/app-preview-<ts>.png". */
|
|
695
|
-
artifact: string;
|
|
696
|
-
};
|
|
697
|
-
status: 'beta' | 'stable' | 'deprecated';
|
|
698
|
-
/**
|
|
699
|
-
* The UI configuration of the app. If not specified and the app "ui" is in the app capabilities
|
|
700
|
-
* then the ui configuration will be fetched from the endpoint property.
|
|
701
|
-
*/
|
|
702
|
-
ui?: AppUIConfig;
|
|
703
|
-
/**
|
|
704
|
-
* A list of tool collections endpoints to be used by this app.
|
|
705
|
-
* Prefer using endpoint over tool_collections.
|
|
706
|
-
*/
|
|
707
|
-
tool_collections?: ToolCollectionObject[];
|
|
708
|
-
/**
|
|
709
|
-
* Named OAuth providers shared across multiple MCP tool collections.
|
|
710
|
-
* Keys must be kebab-case identifiers. Each value is an MCPOAuthConfig blueprint.
|
|
711
|
-
* Collections reference a provider via MCPToolCollectionObject.oauth_provider.
|
|
712
|
-
* One OAuth provider is created per provider at install time; all referencing
|
|
713
|
-
* collections share that app via AppInstallation.provider_bindings.
|
|
714
|
-
*/
|
|
715
|
-
oauth_providers?: Record<string, MCPOAuthConfig>;
|
|
716
|
-
/**
|
|
717
|
-
* An URL providing interactions definitions in JSON format.
|
|
718
|
-
* The URL must provide 2 endpoints:
|
|
719
|
-
* 1. GET URL - must return a JSON array with the list of interactions (as AppInteractionRef[])
|
|
720
|
-
* 2. GET URL/{interaction_name} - must return the full interaction definition for the specified interaction.
|
|
721
|
-
* This feature is for advanced composition of interactions. Prefer using endpoint.
|
|
722
|
-
*/
|
|
723
|
-
interactions?: string;
|
|
724
|
-
/**
|
|
725
|
-
* A JSON chema for the app installation settings.
|
|
726
|
-
* @deprecated Use endpoint to provide settings_schema instead
|
|
727
|
-
*/
|
|
728
|
-
settings_schema?: JSONSchema;
|
|
729
|
-
/** The following API is part of the second version of the manifest and deprectaes similar properties included directly in the manifest */
|
|
730
|
-
/**
|
|
731
|
-
* Describe the capabiltities of this app - which kind of contributions it provides.
|
|
732
|
-
*/
|
|
733
|
-
capabilities?: AppCapabilities[];
|
|
734
|
-
/**
|
|
735
|
-
* The app endpoint URL
|
|
736
|
-
* This URL should return a JSON object describing the contributions provided by the app.
|
|
737
|
-
* The object shape must satisfies AppPackage interface.
|
|
738
|
-
* The endpoint must support GET method and a `scope` parameter to filter which resources are included in the returned AppPackage:
|
|
739
|
-
* The supported scope values are:
|
|
740
|
-
* - ui
|
|
741
|
-
* - tools
|
|
742
|
-
* - interactions
|
|
743
|
-
* - types
|
|
744
|
-
* - processes
|
|
745
|
-
* - templates
|
|
746
|
-
* - dashboards
|
|
747
|
-
* - settings
|
|
748
|
-
* - all (the default if no scope is provided)
|
|
749
|
-
* You can also use comma-separated values to combine scopes (e.g. "ui,tools").
|
|
750
|
-
*
|
|
751
|
-
* Example:
|
|
752
|
-
* - ?scope=ui,tools - returns only the UI configuration
|
|
753
|
-
*/
|
|
754
|
-
endpoint?: string;
|
|
755
|
-
/**
|
|
756
|
-
* Optional endpoint overrides keyed by environment name.
|
|
757
|
-
* When resolving the app endpoint, if the current environment name matches a key,
|
|
758
|
-
* the corresponding URL is used instead of the main `endpoint`.
|
|
759
|
-
* Only dev environment names are allowed as keys (starting with "desktop-" or "dev-").
|
|
760
|
-
*/
|
|
761
|
-
endpoint_overrides?: Record<string, string>;
|
|
762
|
-
/**
|
|
763
|
-
* Optional app version string (e.g. "1.0.0") — informational.
|
|
764
|
-
*/
|
|
765
|
-
version?: string;
|
|
766
|
-
/**
|
|
767
|
-
* Source repository configuration for apps generated and maintained through
|
|
768
|
-
* AppGen. Branches are mutable development lanes; immutable app versions
|
|
769
|
-
* record their exact source commit in AppVersionRecord.source_commit and
|
|
770
|
-
* AppVersionRecord.storage.source_git.
|
|
771
|
-
*/
|
|
772
|
-
source?: AppSourceConfig;
|
|
773
|
-
/**
|
|
774
|
-
* Free-form tags used for classification and filtering. Platform apps
|
|
775
|
-
* carry `"system"` so UIs can skip install/uninstall/manage-permission
|
|
776
|
-
* controls that don't apply to synthetic installations.
|
|
777
|
-
*/
|
|
778
|
-
tags?: string[];
|
|
779
|
-
/**
|
|
780
|
-
* Access control policy for the app. Defaults to 'all' (ACE-gated everywhere)
|
|
781
|
-
* when undefined. See {@link AppAccessControl} for semantics. May be overridden
|
|
782
|
-
* on the AppInstallation.
|
|
783
|
-
*/
|
|
784
|
-
access_control?: AppAccessControl;
|
|
785
|
-
}
|
|
786
|
-
export interface AppGitSourceConfig {
|
|
787
|
-
url?: string;
|
|
788
|
-
default_branch?: string;
|
|
789
|
-
production_branch?: string;
|
|
790
|
-
development_branch?: string;
|
|
791
|
-
}
|
|
792
|
-
export interface AppSourceConfig {
|
|
793
|
-
kind: 'git';
|
|
794
|
-
git?: AppGitSourceConfig;
|
|
795
|
-
}
|
|
262
|
+
export type AppManifestData = z.infer<typeof AppManifestDataSchema>;
|
|
263
|
+
export type AppGitSourceConfig = z.infer<typeof AppGitSourceConfigSchema>;
|
|
264
|
+
export type AppSourceConfig = z.infer<typeof AppSourceConfigSchema>;
|
|
796
265
|
/**
|
|
797
266
|
* Deployment-time URL endpoints that can be referenced in app manifest URLs
|
|
798
267
|
* via `{{key}}` placeholders. The caller (typically studio-server) supplies
|
|
@@ -814,199 +283,58 @@ export interface Endpoints {
|
|
|
814
283
|
gateway?: string;
|
|
815
284
|
}
|
|
816
285
|
/** One entry in an app git-repo directory listing (see {@link AppRepoTree}). */
|
|
817
|
-
export
|
|
818
|
-
/** File or directory name (last path segment). */
|
|
819
|
-
name: string;
|
|
820
|
-
/** Path relative to the repo root. */
|
|
821
|
-
path: string;
|
|
822
|
-
/** Whether the entry is a file (`blob`) or a directory (`tree`). */
|
|
823
|
-
type: 'blob' | 'tree';
|
|
824
|
-
}
|
|
286
|
+
export type AppRepoTreeEntry = z.infer<typeof AppRepoTreeEntrySchema>;
|
|
825
287
|
/** A non-recursive listing of an app git repo directory at a given ref. */
|
|
826
|
-
export
|
|
827
|
-
/** The ref the listing was read at (empty/undefined = default branch / HEAD). */
|
|
828
|
-
ref?: string;
|
|
829
|
-
/** The directory prefix that was listed (empty = repo root). */
|
|
830
|
-
prefix?: string;
|
|
831
|
-
entries: AppRepoTreeEntry[];
|
|
832
|
-
}
|
|
288
|
+
export type AppRepoTree = z.infer<typeof AppRepoTreeSchema>;
|
|
833
289
|
/** Browser-side limits mirrored by the app Git service document endpoint. */
|
|
834
290
|
export declare const APP_REPO_DOCUMENT_UPLOAD_MAX_FILE_BYTES: number;
|
|
835
291
|
export declare const APP_REPO_DOCUMENT_UPLOAD_MAX_TOTAL_BYTES: number;
|
|
836
292
|
export declare const APP_REPO_DOCUMENT_UPLOAD_MAX_FILES = 20;
|
|
837
293
|
export declare const APP_REPO_DOCUMENT_UPLOAD_PREFIX = "docs/";
|
|
838
294
|
/** Result of committing one or more uploaded documents to an app repository. */
|
|
839
|
-
export
|
|
840
|
-
/** Updated branch name. */
|
|
841
|
-
ref: string;
|
|
842
|
-
/** Branch HEAD before the commit. */
|
|
843
|
-
previous_commit: string;
|
|
844
|
-
/** Newly created commit SHA. */
|
|
845
|
-
commit: string;
|
|
846
|
-
/** Repository paths changed by the commit. */
|
|
847
|
-
paths: string[];
|
|
848
|
-
}
|
|
295
|
+
export type AppRepoDocumentCommit = z.infer<typeof AppRepoDocumentCommitSchema>;
|
|
849
296
|
/** One commit that inserted or changed a file in an app git repository. */
|
|
850
|
-
export
|
|
851
|
-
/** Full commit SHA. */
|
|
852
|
-
commit: string;
|
|
853
|
-
/** Complete commit message. */
|
|
854
|
-
message: string;
|
|
855
|
-
/** Commit author name, when available. */
|
|
856
|
-
author?: string;
|
|
857
|
-
/** Commit author date as an ISO-8601 string, when available. */
|
|
858
|
-
date?: string;
|
|
859
|
-
}
|
|
297
|
+
export type AppRepoCommit = z.infer<typeof AppRepoCommitSchema>;
|
|
860
298
|
/** Commit history in an app git repository, optionally filtered to a file. */
|
|
861
|
-
export
|
|
862
|
-
/** Ref from which history traversal started (empty/undefined = default branch / HEAD). */
|
|
863
|
-
ref?: string;
|
|
864
|
-
/** File path relative to the repository root, when history was filtered to a file. */
|
|
865
|
-
path?: string;
|
|
866
|
-
/** Commits ordered newest first. */
|
|
867
|
-
commits: AppRepoCommit[];
|
|
868
|
-
/** Pass this cursor to retrieve the next page. Absent when history is exhausted. */
|
|
869
|
-
next_cursor?: string;
|
|
870
|
-
}
|
|
299
|
+
export type AppRepoCommits = z.infer<typeof AppRepoCommitsSchema>;
|
|
871
300
|
/** A branch or tag in an app git repo, resolved to its latest commit. */
|
|
872
|
-
export
|
|
873
|
-
/** Short ref name (e.g. `main`, `v1.0.0`). */
|
|
874
|
-
name: string;
|
|
875
|
-
/** Commit hash the ref points at (annotated tags are peeled to their commit). */
|
|
876
|
-
commit: string;
|
|
877
|
-
/** First line of the commit message, when available. */
|
|
878
|
-
commit_subject?: string;
|
|
879
|
-
/** Commit date as an ISO-8601 string, when available. */
|
|
880
|
-
commit_date?: string;
|
|
881
|
-
/** Commit author name, when available. */
|
|
882
|
-
commit_author?: string;
|
|
883
|
-
}
|
|
301
|
+
export type AppRepoRef = z.infer<typeof AppRepoRefSchema>;
|
|
884
302
|
/** The branches and tags of an app git repo (see {@link AppRepoRef}). */
|
|
885
|
-
export
|
|
886
|
-
/** The repository's default branch (HEAD target), when resolvable. */
|
|
887
|
-
default_branch?: string;
|
|
888
|
-
branches: AppRepoRef[];
|
|
889
|
-
tags: AppRepoRef[];
|
|
890
|
-
}
|
|
303
|
+
export type AppRepoRefs = z.infer<typeof AppRepoRefsSchema>;
|
|
891
304
|
/** A mutable app development task represented by an `agent/*` Git branch. */
|
|
892
|
-
export
|
|
893
|
-
/** Task slug derived from the branch name. */
|
|
894
|
-
id: string;
|
|
895
|
-
/** Complete Git branch name. */
|
|
896
|
-
branch: string;
|
|
897
|
-
/** Commit currently at the branch head. */
|
|
898
|
-
source_commit: string;
|
|
899
|
-
/** Branch-head commit date, when available. */
|
|
900
|
-
commit_date?: string;
|
|
901
|
-
}
|
|
305
|
+
export type AppDevelopmentTask = z.infer<typeof AppDevelopmentTaskSchema>;
|
|
902
306
|
/** Git-backed development tasks and the branch used for new tasks by default. */
|
|
903
|
-
export
|
|
904
|
-
/** Repository default branch, when resolvable. */
|
|
905
|
-
default_branch?: string;
|
|
906
|
-
tasks: AppDevelopmentTask[];
|
|
907
|
-
}
|
|
307
|
+
export type AppDevelopmentTaskList = z.infer<typeof AppDevelopmentTaskListSchema>;
|
|
908
308
|
/** Development task details, including the latest parent assistant run when one exists. */
|
|
909
|
-
export
|
|
910
|
-
/** Latest Studio Assistant run started for this task branch. */
|
|
911
|
-
agent_run?: AgentRunSearchHit;
|
|
912
|
-
}
|
|
309
|
+
export type AppDevelopmentTaskDetails = z.infer<typeof AppDevelopmentTaskDetailsSchema>;
|
|
913
310
|
/** Request to create a branch from an existing branch, tag, or commit. */
|
|
914
311
|
export interface CreateAppRepoBranchRequest {
|
|
915
312
|
name: string;
|
|
916
313
|
source_ref: string;
|
|
917
314
|
}
|
|
918
315
|
/** A newly created app repository branch. */
|
|
919
|
-
export
|
|
920
|
-
name: string;
|
|
921
|
-
commit: string;
|
|
922
|
-
source_ref: string;
|
|
923
|
-
}
|
|
316
|
+
export type AppRepoBranch = z.infer<typeof AppRepoBranchSchema>;
|
|
924
317
|
/**
|
|
925
318
|
* Canonical package scopes, including the catch-all `all`. The public type is derived
|
|
926
319
|
* from this list so request parsing and TypeScript cannot drift.
|
|
927
320
|
*/
|
|
928
|
-
export declare const APP_PACKAGE_SCOPES: readonly [
|
|
321
|
+
export declare const APP_PACKAGE_SCOPES: readonly ['ui', 'tools', 'interactions', 'types', 'processes', 'views', 'templates', 'dashboards', 'settings', 'widgets', 'activities', 'hooks', 'subscriptions', 'all'];
|
|
929
322
|
export type AppPackageScope = (typeof APP_PACKAGE_SCOPES)[number];
|
|
930
|
-
export
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
* A list of tools exposed by the app.
|
|
937
|
-
*/
|
|
938
|
-
tools?: AgentToolDefinition[];
|
|
939
|
-
/**
|
|
940
|
-
* A list of skills (`learn_*` tools) exposed by the app. Kept separate from
|
|
941
|
-
* `tools` so clients can render them distinctly — consumers that don't care
|
|
942
|
-
* (e.g. the worker building a combined tool registry) should concatenate
|
|
943
|
-
* the two lists.
|
|
944
|
-
*/
|
|
945
|
-
skills?: AgentToolDefinition[];
|
|
946
|
-
/**
|
|
947
|
-
* A list of interactions exposed by the app
|
|
948
|
-
*/
|
|
949
|
-
interactions?: CatalogInteractionRef[];
|
|
950
|
-
/**
|
|
951
|
-
* A list of types.
|
|
952
|
-
*/
|
|
953
|
-
types?: InCodeTypeDefinition[];
|
|
954
|
-
/**
|
|
955
|
-
* A list of process definitions exposed by the app.
|
|
956
|
-
*/
|
|
957
|
-
processes?: InCodeProcessDefinition[];
|
|
958
|
-
/**
|
|
959
|
-
* View Experiences exposed by the app as in-code definitions.
|
|
960
|
-
*/
|
|
961
|
-
views?: InCodeViewDefinition[];
|
|
962
|
-
/**
|
|
963
|
-
* Templates provided by the app.
|
|
964
|
-
*/
|
|
965
|
-
templates?: RenderingTemplateDefinitionRef[];
|
|
966
|
-
/**
|
|
967
|
-
* Dashboards provided by the app.
|
|
968
|
-
*/
|
|
969
|
-
dashboards?: AppDashboardDefinition[];
|
|
970
|
-
/**
|
|
971
|
-
* Widgets provided by the app.
|
|
972
|
-
*/
|
|
973
|
-
widgets?: Record<string, AppWidgetInfo>;
|
|
974
|
-
/**
|
|
975
|
-
* Remote activities exposed by the app for use in DSL workflows.
|
|
976
|
-
* Activities are discovered via `?scope=activities` and referenced in workflow steps
|
|
977
|
-
* using colon-separated names: `app:<app_name>:<collection>:<activity_name>`.
|
|
978
|
-
*/
|
|
979
|
-
activities?: RemoteActivityDefinition[];
|
|
980
|
-
/**
|
|
981
|
-
* A JSON chema for the app installation settings.
|
|
982
|
-
*/
|
|
983
|
-
settings_schema?: JSONSchema;
|
|
984
|
-
}
|
|
323
|
+
export type AppPackageEventHook = z.infer<typeof AppPackageEventHookSchema>;
|
|
324
|
+
export type AppPackageHooks = z.infer<typeof AppPackageHooksSchema>;
|
|
325
|
+
export type AppEventHookDelivery = z.infer<typeof AppEventHookDeliverySchema>;
|
|
326
|
+
export type AppEventHookPayload = z.infer<typeof AppEventHookPayloadSchema>;
|
|
327
|
+
export type AppEventSubscriptionDefinition = z.infer<typeof AppEventSubscriptionDefinitionSchema>;
|
|
328
|
+
export type AppPackage = z.infer<typeof AppPackageSchema>;
|
|
985
329
|
/**
|
|
986
330
|
* A single diagnostic produced while inspecting an app's registration state.
|
|
987
331
|
*/
|
|
988
|
-
export
|
|
989
|
-
severity: 'error' | 'warning';
|
|
990
|
-
/** The capability this issue relates to, when applicable (e.g. 'types'). */
|
|
991
|
-
capability?: AppPackageScope;
|
|
992
|
-
/** Stable machine code, e.g. 'capability_declared_but_empty', 'endpoint_unreachable', 'not_installed'. */
|
|
993
|
-
code: string;
|
|
994
|
-
/** Human-readable explanation, safe to surface to the model and the UI. */
|
|
995
|
-
message: string;
|
|
996
|
-
}
|
|
332
|
+
export type AppInspectionIssue = z.infer<typeof AppInspectionIssueSchema>;
|
|
997
333
|
/**
|
|
998
334
|
* Per-capability report of what an app's promoted package actually exposes,
|
|
999
335
|
* compared against what its manifest declares.
|
|
1000
336
|
*/
|
|
1001
|
-
export
|
|
1002
|
-
capability: AppPackageScope;
|
|
1003
|
-
/** True when the manifest's `capabilities` array declares this capability. */
|
|
1004
|
-
declared: boolean;
|
|
1005
|
-
/** The local ids the promoted package actually serves for this capability. */
|
|
1006
|
-
exposed_ids: string[];
|
|
1007
|
-
/** Convenience count of `exposed_ids`. */
|
|
1008
|
-
exposed_count: number;
|
|
1009
|
-
}
|
|
337
|
+
export type AppInspectionCapabilityReport = z.infer<typeof AppInspectionCapabilityReportSchema>;
|
|
1010
338
|
/**
|
|
1011
339
|
* Result of inspecting an app's registration: the resolved manifest state, what
|
|
1012
340
|
* the promoted package actually exposes per capability, and diagnostics. This
|
|
@@ -1014,326 +342,95 @@ export interface AppInspectionCapabilityReport {
|
|
|
1014
342
|
* Build › App inspection UI to verify what is registered vs declared, instead of
|
|
1015
343
|
* inferring it from failed object/import calls.
|
|
1016
344
|
*/
|
|
1017
|
-
export
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
/** True when the package endpoint responded to the capability probe. */
|
|
1024
|
-
endpoint_reachable: boolean;
|
|
1025
|
-
/** True when the app is installed in the current project. */
|
|
1026
|
-
installed: boolean;
|
|
1027
|
-
access_control?: string;
|
|
1028
|
-
/** The capabilities declared on the manifest. */
|
|
1029
|
-
capabilities: AppPackageScope[];
|
|
1030
|
-
/** What the promoted package exposes, per capability. */
|
|
1031
|
-
package: AppInspectionCapabilityReport[];
|
|
1032
|
-
/** Diagnostics — errors and warnings about the registration state. */
|
|
1033
|
-
issues: AppInspectionIssue[];
|
|
1034
|
-
/** Populated when the package probe itself failed (endpoint error/unreachable). */
|
|
1035
|
-
probe_error?: string;
|
|
1036
|
-
}
|
|
1037
|
-
export interface AppWidgetInfo {
|
|
1038
|
-
collection: string;
|
|
1039
|
-
skill: string;
|
|
1040
|
-
url: string;
|
|
1041
|
-
}
|
|
1042
|
-
export interface RenderingTemplateDefinition {
|
|
1043
|
-
/** Unique template id: "collection:name" */
|
|
1044
|
-
id: string;
|
|
1045
|
-
/** Unique template name (kebab-case) */
|
|
1046
|
-
name: string;
|
|
1047
|
-
/** Display title */
|
|
1048
|
-
title?: string;
|
|
1049
|
-
/** Short description */
|
|
1050
|
-
description: string;
|
|
1051
|
-
/** Template type */
|
|
1052
|
-
type: 'presentation' | 'document';
|
|
1053
|
-
/** Tags for categorization */
|
|
1054
|
-
tags?: string[];
|
|
1055
|
-
/** Absolute paths to asset files */
|
|
1056
|
-
assets: string[];
|
|
1057
|
-
/** The template instructions (markdown) */
|
|
1058
|
-
instructions: string;
|
|
1059
|
-
}
|
|
1060
|
-
export type RenderingTemplateDefinitionRef = Omit<RenderingTemplateDefinition, 'instructions'> & {
|
|
1061
|
-
/** Absolute API path to fetch the full template definition */
|
|
1062
|
-
path: string;
|
|
1063
|
-
};
|
|
1064
|
-
export interface AppManifest extends AppManifestData {
|
|
1065
|
-
id: string;
|
|
1066
|
-
/** The owning account. Undefined for apps imported from a master region. */
|
|
1067
|
-
account?: string;
|
|
1068
|
-
/** Source metadata for generated or synced app manifests. */
|
|
1069
|
-
source?: AppManifestSource;
|
|
1070
|
-
created_at: string;
|
|
1071
|
-
updated_at: string;
|
|
1072
|
-
}
|
|
1073
|
-
export interface AppManifestSource {
|
|
1074
|
-
kind: 'git';
|
|
1075
|
-
git: {
|
|
1076
|
-
url: string;
|
|
1077
|
-
default_branch?: string;
|
|
1078
|
-
production_branch?: string;
|
|
1079
|
-
development_branch?: string;
|
|
1080
|
-
};
|
|
1081
|
-
}
|
|
345
|
+
export type AppInspectionResult = z.infer<typeof AppInspectionResultSchema>;
|
|
346
|
+
export type AppWidgetInfo = z.infer<typeof AppWidgetInfoSchema>;
|
|
347
|
+
export type RenderingTemplateDefinition = z.infer<typeof RenderingTemplateDefinitionSchema>;
|
|
348
|
+
export type RenderingTemplateDefinitionRef = z.infer<typeof RenderingTemplateDefinitionRefSchema>;
|
|
349
|
+
export type AppManifest = z.infer<typeof AppManifestSchema>;
|
|
350
|
+
export type AppManifestSource = z.infer<typeof AppManifestSourceSchema>;
|
|
1082
351
|
/**
|
|
1083
352
|
* Binding between an MCP collection and an OAuth provider created at install time.
|
|
1084
353
|
* Stored on AppInstallation so the runtime can look up the correct OAuth provider by ID,
|
|
1085
354
|
* independent of manifest oauth_provider references (which may change).
|
|
1086
355
|
*/
|
|
1087
|
-
export
|
|
1088
|
-
/**
|
|
1089
|
-
* Stable collection identifier: MCPToolCollectionObject.id for new manifests.
|
|
1090
|
-
* Legacy installations may still contain a name-based fallback value.
|
|
1091
|
-
*/
|
|
1092
|
-
collection_id: string;
|
|
1093
|
-
/**
|
|
1094
|
-
* MongoDB ObjectId of the OAuth provider in this project.
|
|
1095
|
-
* Used for ID-based lookups (rename-proof).
|
|
1096
|
-
*/
|
|
1097
|
-
oauth_provider_id: string;
|
|
1098
|
-
/**
|
|
1099
|
-
* Name of the OAuth provider at creation time.
|
|
1100
|
-
* Used by the workflow token path (getMCPClient → remoteMcpConnections.getToken) which looks up by name.
|
|
1101
|
-
*/
|
|
1102
|
-
oauth_provider_name: string;
|
|
1103
|
-
}
|
|
356
|
+
export type AppInstallationOAuthBinding = z.infer<typeof AppInstallationOAuthBindingSchema>;
|
|
1104
357
|
/**
|
|
1105
358
|
* Binding between a named OAuth provider and the OAuth provider created for it at install time.
|
|
1106
359
|
* Stored on AppInstallation so the runtime can resolve the correct OAuth provider for collections
|
|
1107
360
|
* that reference a shared provider via MCPToolCollectionObject.oauth_provider.
|
|
1108
361
|
*/
|
|
1109
|
-
export
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
oauth_provider_id: string;
|
|
1114
|
-
/** Name of the OAuth provider at creation time (for audit/display only) */
|
|
1115
|
-
oauth_provider_name: string;
|
|
1116
|
-
}
|
|
1117
|
-
export interface AppInstallation {
|
|
1118
|
-
id: string;
|
|
1119
|
-
project: string;
|
|
1120
|
-
manifest: string;
|
|
1121
|
-
settings?: Record<string, unknown>;
|
|
1122
|
-
/**
|
|
1123
|
-
* Admin-managed allowlist of tool names permitted for this installation.
|
|
1124
|
-
* When undefined, all tools from the app are permitted.
|
|
1125
|
-
* When set, only listed tool names are available for agent configuration and execution.
|
|
1126
|
-
*/
|
|
1127
|
-
tool_allowlist?: string[];
|
|
1128
|
-
/**
|
|
1129
|
-
* OAuth bindings created at install time via oauth_config provisioning.
|
|
1130
|
-
* Maps collection identity (id or name) → OAuth provider ObjectId.
|
|
1131
|
-
* Used by the runtime to resolve the correct OAuth provider without relying on manifest names.
|
|
1132
|
-
*/
|
|
1133
|
-
oauth_bindings?: AppInstallationOAuthBinding[];
|
|
1134
|
-
/**
|
|
1135
|
-
* OAuth bindings created at install time via oauth_providers provisioning.
|
|
1136
|
-
* Maps provider key → OAuth provider ObjectId.
|
|
1137
|
-
* Multiple collections sharing the same provider all resolve to the same OAuth provider.
|
|
1138
|
-
*/
|
|
1139
|
-
provider_bindings?: AppInstallationProviderBinding[];
|
|
1140
|
-
/**
|
|
1141
|
-
* Per-installation override of the manifest's access_control policy.
|
|
1142
|
-
* When set, takes precedence over the manifest value. When undefined, the
|
|
1143
|
-
* manifest value (or 'all' default) applies.
|
|
1144
|
-
*/
|
|
1145
|
-
access_control?: AppAccessControl;
|
|
1146
|
-
created_at: string;
|
|
1147
|
-
updated_at: string;
|
|
1148
|
-
}
|
|
1149
|
-
export interface AppInstallationWithManifest extends Omit<AppInstallation, 'manifest'> {
|
|
1150
|
-
manifest: AppManifest;
|
|
1151
|
-
/**
|
|
1152
|
-
* Computed by the server: ids of MCP tool collections for this installation that require OAuth.
|
|
1153
|
-
* Accounts for all three signals: manifest auth:'oauth', manifest oauth_app, and oauth_bindings.
|
|
1154
|
-
* Populated by the GET /installations/all endpoint.
|
|
1155
|
-
*/
|
|
1156
|
-
oauth_collection_ids?: string[];
|
|
1157
|
-
}
|
|
1158
|
-
export interface AppInstallationListEntry extends Omit<AppInstallation, 'manifest'> {
|
|
1159
|
-
manifest: AppManifest | null;
|
|
1160
|
-
oauth_collection_ids?: string[];
|
|
1161
|
-
}
|
|
362
|
+
export type AppInstallationProviderBinding = z.infer<typeof AppInstallationProviderBindingSchema>;
|
|
363
|
+
export type AppInstallation = z.infer<typeof AppInstallationSchema>;
|
|
364
|
+
export type AppInstallationWithManifest = z.infer<typeof AppInstallationWithManifestSchema>;
|
|
365
|
+
export type AppInstallationListEntry = z.infer<typeof AppInstallationListEntrySchema>;
|
|
1162
366
|
export interface OrphanedAppInstallation extends Omit<AppInstallation, 'manifest'> {
|
|
1163
367
|
manifest: null;
|
|
1164
368
|
}
|
|
1165
|
-
export
|
|
1166
|
-
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
|
|
1170
|
-
export type
|
|
1171
|
-
export type AppOAuthProviderParams =
|
|
1172
|
-
export
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
/**
|
|
1176
|
-
* Per-installation override of the manifest's `access_control` policy. When provided, takes precedence
|
|
1177
|
-
* over the manifest default for every access check. Sibling of `settings` — admin-controlled, not
|
|
1178
|
-
* part of the app's own settings JSON.
|
|
1179
|
-
*
|
|
1180
|
-
* Three send-time semantics on update:
|
|
1181
|
-
* - Field omitted entirely from the payload → leave the existing override unchanged.
|
|
1182
|
-
* - Explicit `null` → clear the override, fall back to the manifest default.
|
|
1183
|
-
* - String enum → set the override to that value.
|
|
1184
|
-
*
|
|
1185
|
-
* (On install, the same shape applies; omit or pass `null` to use the manifest default.)
|
|
1186
|
-
*/
|
|
1187
|
-
access_control?: AppAccessControl | null;
|
|
1188
|
-
/**
|
|
1189
|
-
* OAuth credentials for each collection, keyed by collection.id.
|
|
1190
|
-
* Legacy callers may still use collection.name for older manifests.
|
|
1191
|
-
* Collected from the user at install time for collections with oauth_config.required_at_install.
|
|
1192
|
-
*/
|
|
1193
|
-
oauth_params?: AppOAuthCollectionParams;
|
|
1194
|
-
/**
|
|
1195
|
-
* OAuth credentials for named providers, keyed by the provider key from oauth_providers.
|
|
1196
|
-
* Collected from the user at install time for providers with required_at_install.
|
|
1197
|
-
* Separate from oauth_params to avoid key collisions between provider keys and collection ids.
|
|
1198
|
-
*/
|
|
1199
|
-
oauth_provider_params?: AppOAuthProviderParams;
|
|
1200
|
-
}
|
|
1201
|
-
export interface UpdateAppInstallationToolAllowlistPayload {
|
|
1202
|
-
tool_allowlist: string[] | null;
|
|
1203
|
-
}
|
|
1204
|
-
export type AppInstallationKind = 'ui' | 'tools' | 'all';
|
|
369
|
+
export type OAuthClientCredentials = z.infer<typeof OAuthClientCredentialsSchema>;
|
|
370
|
+
export type AppOAuthCollectionParams = z.infer<typeof AppOAuthCollectionParamsSchema>;
|
|
371
|
+
/** One installer-supplied MCP API key. */
|
|
372
|
+
export type McpApiKeyCredential = z.infer<typeof McpApiKeyCredentialSchema>;
|
|
373
|
+
/** Installer-supplied MCP API keys, keyed by collection id. */
|
|
374
|
+
export type AppApiKeyCollectionParams = z.infer<typeof AppApiKeyCollectionParamsSchema>;
|
|
375
|
+
export type AppOAuthProviderParams = z.infer<typeof AppOAuthProviderParamsSchema>;
|
|
376
|
+
export type AppInstallationPayload = z.infer<typeof AppInstallationPayloadSchema>;
|
|
377
|
+
export type UpdateAppInstallationToolAllowlistPayload = z.infer<typeof UpdateAppInstallationToolAllowlistPayloadSchema>;
|
|
378
|
+
export type AppInstallationKind = z.infer<typeof AppInstallationKindSchema>;
|
|
1205
379
|
/**
|
|
1206
380
|
* A description of the tools provided by an app
|
|
1207
381
|
*/
|
|
1208
|
-
export
|
|
1209
|
-
/**
|
|
1210
|
-
* The collection name
|
|
1211
|
-
*/
|
|
1212
|
-
name: string;
|
|
1213
|
-
/**
|
|
1214
|
-
* Optional collection description
|
|
1215
|
-
*/
|
|
1216
|
-
description?: string;
|
|
1217
|
-
/**
|
|
1218
|
-
* the tools provided by this collection
|
|
1219
|
-
*/
|
|
1220
|
-
tools: AgentToolDefinition[];
|
|
1221
|
-
}
|
|
382
|
+
export type AppToolCollection = z.infer<typeof AppToolCollectionSchema>;
|
|
1222
383
|
/**
|
|
1223
|
-
*
|
|
1224
|
-
*
|
|
384
|
+
* A tool and the app installation that provides it, inferred from `./api-schemas/project.js` — the
|
|
385
|
+
* module that owns it, because it converted with the Projects batch rather than with Apps.
|
|
1225
386
|
*/
|
|
1226
|
-
export
|
|
1227
|
-
/**
|
|
1228
|
-
* The tool name
|
|
1229
|
-
*/
|
|
1230
|
-
tool_name: string;
|
|
1231
|
-
/**
|
|
1232
|
-
* Optional tool description
|
|
1233
|
-
*/
|
|
1234
|
-
tool_description?: string;
|
|
1235
|
-
/**
|
|
1236
|
-
* The app name that provides this tool
|
|
1237
|
-
*/
|
|
1238
|
-
app_name: string;
|
|
1239
|
-
/**
|
|
1240
|
-
* The app installation ID
|
|
1241
|
-
*/
|
|
1242
|
-
app_install_id: string;
|
|
1243
|
-
/**
|
|
1244
|
-
* The app installation settings.
|
|
1245
|
-
* Only included for agent tokens, not user tokens (security: may contain API keys).
|
|
1246
|
-
*/
|
|
1247
|
-
settings?: Record<string, unknown>;
|
|
1248
|
-
}
|
|
387
|
+
export type ProjectToolInfo = z.infer<typeof ProjectToolInfoSchema>;
|
|
1249
388
|
/**
|
|
1250
389
|
* OAuth authentication status for an MCP tool collection
|
|
1251
390
|
*/
|
|
1252
|
-
export
|
|
1253
|
-
collection_id: string;
|
|
1254
|
-
collection_name: string;
|
|
1255
|
-
authenticated: boolean;
|
|
1256
|
-
mcp_server_url: string;
|
|
1257
|
-
expires_at?: string;
|
|
1258
|
-
scope?: string;
|
|
1259
|
-
}
|
|
391
|
+
export type OAuthAuthStatus = z.infer<typeof OAuthAuthStatusSchema>;
|
|
1260
392
|
/**
|
|
1261
393
|
* Response from OAuth authorization endpoint
|
|
1262
394
|
*/
|
|
1263
|
-
export
|
|
1264
|
-
authorization_url?: string;
|
|
1265
|
-
state?: string;
|
|
1266
|
-
connected?: boolean;
|
|
1267
|
-
}
|
|
395
|
+
export type OAuthAuthorizeResponse = z.infer<typeof OAuthAuthorizeResponseSchema>;
|
|
1268
396
|
export interface McpOAuthCollectionRef {
|
|
1269
397
|
app_install_id: string;
|
|
1270
398
|
collection_id: string;
|
|
1271
399
|
}
|
|
1272
|
-
|
|
1273
|
-
|
|
1274
|
-
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
|
|
1278
|
-
|
|
1279
|
-
|
|
1280
|
-
export
|
|
1281
|
-
|
|
1282
|
-
|
|
1283
|
-
export interface McpOAuthDisconnectResponse {
|
|
1284
|
-
success: boolean;
|
|
1285
|
-
message: string;
|
|
1286
|
-
}
|
|
400
|
+
/**
|
|
401
|
+
* Payload for storing the static bearer token of an `auth: 'api_key'` MCP collection.
|
|
402
|
+
* The key is write-only — it is never echoed back by any endpoint.
|
|
403
|
+
*/
|
|
404
|
+
export type SetMcpApiKeyRequest = z.infer<typeof SetMcpApiKeyRequestSchema>;
|
|
405
|
+
/** Whether an `auth: 'api_key'` MCP collection has a key stored, plus a display-only hint. */
|
|
406
|
+
export type McpApiKeyStatus = z.infer<typeof McpApiKeyStatusSchema>;
|
|
407
|
+
export type McpOAuthTokenRequest = z.infer<typeof McpOAuthTokenRequestSchema>;
|
|
408
|
+
export type McpOAuthTokenResponse = z.infer<typeof McpOAuthTokenResponseSchema>;
|
|
409
|
+
export type McpOAuthConnectResponse = z.infer<typeof McpOAuthConnectResponseSchema>;
|
|
410
|
+
export type McpOAuthDisconnectResponse = z.infer<typeof McpOAuthDisconnectResponseSchema>;
|
|
1287
411
|
/**
|
|
1288
412
|
* Response from OAuth metadata endpoint
|
|
1289
413
|
*/
|
|
1290
|
-
export
|
|
1291
|
-
collection_id: string;
|
|
1292
|
-
collection_name: string;
|
|
1293
|
-
mcp_server_url: string;
|
|
1294
|
-
metadata: JSONObject;
|
|
1295
|
-
}
|
|
414
|
+
export type OAuthMetadataResponse = z.infer<typeof OAuthMetadataResponseSchema>;
|
|
1296
415
|
/**
|
|
1297
416
|
* Configuration entry for an individual app in the CompositeApp shell.
|
|
1298
417
|
* References an app installation by name.
|
|
1299
418
|
*/
|
|
1300
|
-
export
|
|
1301
|
-
/** App installation name (must match an installed app) */
|
|
1302
|
-
appName: string;
|
|
1303
|
-
}
|
|
419
|
+
export type CompositeAppEntry = z.infer<typeof CompositeAppEntrySchema>;
|
|
1304
420
|
/**
|
|
1305
421
|
* Logo overrides for the CompositeApp shell header.
|
|
1306
422
|
* When provided, these URLs replace the default Vertesia logo.
|
|
1307
423
|
*/
|
|
1308
|
-
export
|
|
1309
|
-
/** URL for light mode logo (overrides default Vertesia logo) */
|
|
1310
|
-
lightModeUrl?: string;
|
|
1311
|
-
/** URL for dark mode logo (overrides default Vertesia logo) */
|
|
1312
|
-
darkModeUrl?: string;
|
|
1313
|
-
/** Whether to hide the Vertesia footer logo in the sidebar when header logo is overridden (defaults to false) */
|
|
1314
|
-
hideFooterLogo?: boolean;
|
|
1315
|
-
}
|
|
424
|
+
export type CompositeAppLogoOverrides = z.infer<typeof CompositeAppLogoOverridesSchema>;
|
|
1316
425
|
/**
|
|
1317
426
|
* Message banner overrides for the shell header.
|
|
1318
427
|
*/
|
|
1319
|
-
export type CompositeAppMessageStyle =
|
|
1320
|
-
export
|
|
1321
|
-
/** Message text to display */
|
|
1322
|
-
text?: string;
|
|
1323
|
-
/** Whether the message is visible (defaults to true) */
|
|
1324
|
-
visible?: boolean;
|
|
1325
|
-
/** Text color style. Uses semantic colors */
|
|
1326
|
-
style?: CompositeAppMessageStyle;
|
|
1327
|
-
}
|
|
428
|
+
export type CompositeAppMessageStyle = z.infer<typeof CompositeAppMessageStyleSchema>;
|
|
429
|
+
export type CompositeAppMessageOverrides = z.infer<typeof CompositeAppMessageOverridesSchema>;
|
|
1328
430
|
/**
|
|
1329
431
|
* Switcher visibility overrides for the CompositeApp header.
|
|
1330
432
|
*/
|
|
1331
|
-
export
|
|
1332
|
-
/** Whether to hide the organization switcher (defaults to false) */
|
|
1333
|
-
hideOrganization?: boolean;
|
|
1334
|
-
/** Whether to hide the project switcher (defaults to false) */
|
|
1335
|
-
hideProject?: boolean;
|
|
1336
|
-
}
|
|
433
|
+
export type CompositeAppSwitchersOverrides = z.infer<typeof CompositeAppSwitchersOverridesSchema>;
|
|
1337
434
|
/**
|
|
1338
435
|
* Header button visibility overrides for the CompositeApp header.
|
|
1339
436
|
*
|
|
@@ -1341,14 +438,7 @@ export interface CompositeAppSwitchersOverrides {
|
|
|
1341
438
|
* Retained for backward compatibility and to seed the default header menu when no
|
|
1342
439
|
* `headerMenu` has been configured yet.
|
|
1343
440
|
*/
|
|
1344
|
-
export
|
|
1345
|
-
/** Whether to hide the App Portal button (defaults to false) */
|
|
1346
|
-
hideAppPortal?: boolean;
|
|
1347
|
-
/** Whether to hide the Docs button (defaults to false) */
|
|
1348
|
-
hideDocs?: boolean;
|
|
1349
|
-
/** Whether to hide the Help button (defaults to false) */
|
|
1350
|
-
hideHelp?: boolean;
|
|
1351
|
-
}
|
|
441
|
+
export type CompositeAppHeaderOverrides = z.infer<typeof CompositeAppHeaderOverridesSchema>;
|
|
1352
442
|
/**
|
|
1353
443
|
* User menu overrides for the CompositeApp.
|
|
1354
444
|
*
|
|
@@ -1356,48 +446,22 @@ export interface CompositeAppHeaderOverrides {
|
|
|
1356
446
|
* Retained for backward compatibility and to seed the default header menu when no
|
|
1357
447
|
* `headerMenu` has been configured yet.
|
|
1358
448
|
*/
|
|
1359
|
-
export
|
|
1360
|
-
/** Whether to hide the User Menu (defaults to false) */
|
|
1361
|
-
hidden?: boolean;
|
|
1362
|
-
}
|
|
449
|
+
export type CompositeAppUserMenuOverrides = z.infer<typeof CompositeAppUserMenuOverridesSchema>;
|
|
1363
450
|
/**
|
|
1364
451
|
* Theme overrides for the CompositeApp.
|
|
1365
452
|
*/
|
|
1366
|
-
export
|
|
1367
|
-
/** When true, forces light mode and disables dark mode (defaults to false) */
|
|
1368
|
-
disableDarkMode?: boolean;
|
|
1369
|
-
}
|
|
453
|
+
export type CompositeAppThemeOverrides = z.infer<typeof CompositeAppThemeOverridesSchema>;
|
|
1370
454
|
/**
|
|
1371
455
|
* Sidebar display overrides for the CompositeApp.
|
|
1372
456
|
*/
|
|
1373
|
-
export
|
|
1374
|
-
/** Whether to hide section title headers in the sidebar (defaults to false) */
|
|
1375
|
-
hideSectionHeaders?: boolean;
|
|
1376
|
-
/** Whether menu items auto-collapse when navigating (accordion behavior). When false, all items stay expanded. Defaults to true. */
|
|
1377
|
-
autoCollapse?: boolean;
|
|
1378
|
-
/** Whether settings section items auto-collapse when navigating. Independent of autoCollapse which handles all other items. Defaults to true. */
|
|
1379
|
-
autoCollapseSettings?: boolean;
|
|
1380
|
-
/** Whether footer section items auto-collapse when navigating. Independent of autoCollapse which handles all other items. Defaults to true. */
|
|
1381
|
-
autoCollapseFooter?: boolean;
|
|
1382
|
-
}
|
|
457
|
+
export type CompositeAppSidebarOverrides = z.infer<typeof CompositeAppSidebarOverridesSchema>;
|
|
1383
458
|
/**
|
|
1384
459
|
* Card display overrides for the CompositeApp in the App Portal.
|
|
1385
460
|
* Similar to AppManifest display properties, but specific to the CompositeApp card.
|
|
1386
461
|
* Allows customers to customize the app portal card (not otherwise possible if using a
|
|
1387
462
|
* shared, Vertesia-managed manifest across accounts).
|
|
1388
463
|
*/
|
|
1389
|
-
export
|
|
1390
|
-
/** Whether to show the CompositeApp card in App Portal (default: false) */
|
|
1391
|
-
visible?: boolean;
|
|
1392
|
-
/** Override the card label (default: "Composite App") */
|
|
1393
|
-
label?: string;
|
|
1394
|
-
/** Override the card description */
|
|
1395
|
-
description?: string;
|
|
1396
|
-
/** Override the card icon (Lucide icon name or SVG content string) */
|
|
1397
|
-
icon?: string;
|
|
1398
|
-
/** Override the card color (e.g., "blue", "red", "purple") */
|
|
1399
|
-
color?: string;
|
|
1400
|
-
}
|
|
464
|
+
export type CompositeAppCardOverrides = z.infer<typeof CompositeAppCardOverridesSchema>;
|
|
1401
465
|
/**
|
|
1402
466
|
* Access control settings for a composite app nav item.
|
|
1403
467
|
*
|
|
@@ -1405,14 +469,7 @@ export interface CompositeAppCardOverrides {
|
|
|
1405
469
|
* access is granted when the user matches ANY list (OR logic).
|
|
1406
470
|
* All empty/absent means visible to everyone. Admin users bypass all checks.
|
|
1407
471
|
*/
|
|
1408
|
-
export
|
|
1409
|
-
/** Group IDs whose members can see this item. */
|
|
1410
|
-
groupsAllowed?: string[];
|
|
1411
|
-
/** User IDs who can see this item. */
|
|
1412
|
-
usersAllowed?: string[];
|
|
1413
|
-
/** SystemRoles values (e.g. "developer", "manager") whose holders can see this item. */
|
|
1414
|
-
rolesAllowed?: string[];
|
|
1415
|
-
}
|
|
472
|
+
export type CompositeAppNavItemPermissions = z.infer<typeof CompositeAppNavItemPermissionsSchema>;
|
|
1416
473
|
/**
|
|
1417
474
|
* A navigable item in the sidebar menu.
|
|
1418
475
|
* An "app" is just a nav-item with `appName` + `route: "/"` that has children.
|
|
@@ -1448,33 +505,19 @@ export interface CompositeAppMenuNavItem {
|
|
|
1448
505
|
* A top-level section heading in the sidebar menu.
|
|
1449
506
|
* Sections are always at root level and contain nav-items.
|
|
1450
507
|
*/
|
|
1451
|
-
export
|
|
1452
|
-
|
|
1453
|
-
id: string;
|
|
1454
|
-
/** Section heading label */
|
|
1455
|
-
label: string;
|
|
1456
|
-
/** When true, this section and its items are hidden from the sidebar */
|
|
1457
|
-
hidden?: boolean;
|
|
1458
|
-
/** Ordered nav-items within this section */
|
|
1459
|
-
items: CompositeAppMenuNavItem[];
|
|
1460
|
-
}
|
|
1461
|
-
export interface CompositeAppHomePlugin {
|
|
1462
|
-
/** The app name to use as the home page */
|
|
1463
|
-
appName: string;
|
|
1464
|
-
/** Optional route within the app (e.g. "/dashboard"). Defaults to "/" */
|
|
1465
|
-
appRoute?: string;
|
|
1466
|
-
}
|
|
508
|
+
export type CompositeAppMenuSection = z.infer<typeof CompositeAppMenuSectionSchema>;
|
|
509
|
+
export type CompositeAppHomePlugin = z.infer<typeof CompositeAppHomePluginSchema>;
|
|
1467
510
|
/**
|
|
1468
511
|
* Discriminator for a header item.
|
|
1469
512
|
* The four built-ins (`app_portal`, `docs`, `help`, `user_menu`) seed the default
|
|
1470
513
|
* header and cannot be deleted (only hidden/customized); `custom` items are fully
|
|
1471
514
|
* user-defined buttons.
|
|
1472
515
|
*/
|
|
1473
|
-
export type CompositeAppHeaderItemKind =
|
|
516
|
+
export type CompositeAppHeaderItemKind = z.infer<typeof CompositeAppHeaderItemKindSchema>;
|
|
1474
517
|
/** Where a header link opens. */
|
|
1475
|
-
export type CompositeAppHeaderItemTarget =
|
|
518
|
+
export type CompositeAppHeaderItemTarget = z.infer<typeof CompositeAppHeaderItemTargetSchema>;
|
|
1476
519
|
/** Stable identifiers for the built-in header items. */
|
|
1477
|
-
export declare const COMPOSITE_APP_HEADER_BUILTIN_IDS: readonly [
|
|
520
|
+
export declare const COMPOSITE_APP_HEADER_BUILTIN_IDS: readonly ['app_portal', 'docs', 'help', 'user_menu'];
|
|
1478
521
|
/**
|
|
1479
522
|
* A single button in the CompositeApp header bar.
|
|
1480
523
|
*
|
|
@@ -1483,99 +526,26 @@ export declare const COMPOSITE_APP_HEADER_BUILTIN_IDS: readonly ["app_portal", "
|
|
|
1483
526
|
* The `user_menu` item is special — it renders the account dropdown, so its `icon`,
|
|
1484
527
|
* `href`, and `target` are ignored.
|
|
1485
528
|
*/
|
|
1486
|
-
export
|
|
1487
|
-
/** Stable unique identifier. Built-ins use their kind as id (e.g. "app_portal"). */
|
|
1488
|
-
id: string;
|
|
1489
|
-
/** Item kind. `custom` for user-added buttons; otherwise one of the four built-ins. */
|
|
1490
|
-
kind: CompositeAppHeaderItemKind;
|
|
1491
|
-
/** Display label, used as the button tooltip / accessible name. */
|
|
1492
|
-
label: string;
|
|
1493
|
-
/** Lucide icon name or SVG content string. Ignored for `user_menu`. */
|
|
1494
|
-
icon?: string;
|
|
1495
|
-
/** Destination route ("/...") or external URL. Ignored for `user_menu`. */
|
|
1496
|
-
href?: string;
|
|
1497
|
-
/** Where to open the link (defaults to "_self"). Ignored for `user_menu`. */
|
|
1498
|
-
target?: CompositeAppHeaderItemTarget;
|
|
1499
|
-
/** When true, this item is hidden from the header. */
|
|
1500
|
-
hidden?: boolean;
|
|
1501
|
-
/** Optional access control settings for this header item. */
|
|
1502
|
-
permissions?: CompositeAppNavItemPermissions;
|
|
1503
|
-
}
|
|
529
|
+
export type CompositeAppHeaderItem = z.infer<typeof CompositeAppHeaderItemSchema>;
|
|
1504
530
|
/**
|
|
1505
531
|
* CompositeApp shell configuration.
|
|
1506
532
|
* This is the main configuration interface for storing CompositeApp settings.
|
|
1507
533
|
* Used as the MongoDB model for persisting CompositeApp configurations.
|
|
1508
534
|
*/
|
|
1509
|
-
export
|
|
1510
|
-
|
|
1511
|
-
|
|
1512
|
-
|
|
1513
|
-
*/
|
|
1514
|
-
id?: string;
|
|
1515
|
-
/** The project this CompositeApp belongs to */
|
|
1516
|
-
project: string;
|
|
1517
|
-
/** Card display overrides (includes visibility) */
|
|
1518
|
-
card?: CompositeAppCardOverrides;
|
|
1519
|
-
/** Optional logo overrides (replaces default Vertesia logo) */
|
|
1520
|
-
logo?: CompositeAppLogoOverrides;
|
|
1521
|
-
/** Optional message banner overrides */
|
|
1522
|
-
message?: CompositeAppMessageOverrides;
|
|
1523
|
-
/** Optional switcher visibility overrides */
|
|
1524
|
-
switchers?: CompositeAppSwitchersOverrides;
|
|
1525
|
-
/** Optional sidebar display overrides */
|
|
1526
|
-
sidebar?: CompositeAppSidebarOverrides;
|
|
1527
|
-
/**
|
|
1528
|
-
* @deprecated Use `headerMenu` instead. Optional header button visibility overrides.
|
|
1529
|
-
* Still read to seed `headerMenu` defaults for configs saved before the header menu existed.
|
|
1530
|
-
*/
|
|
1531
|
-
header?: CompositeAppHeaderOverrides;
|
|
1532
|
-
/**
|
|
1533
|
-
* @deprecated Use the `user_menu` item in `headerMenu` instead. Optional user menu overrides.
|
|
1534
|
-
* Still read to seed `headerMenu` defaults for configs saved before the header menu existed.
|
|
1535
|
-
*/
|
|
1536
|
-
userMenu?: CompositeAppUserMenuOverrides;
|
|
1537
|
-
/**
|
|
1538
|
-
* Optional free-form header menu. When present, the header renders from this ordered
|
|
1539
|
-
* list instead of the legacy `header`/`userMenu` flags. Built-in items (App Portal,
|
|
1540
|
-
* Docs, Help, User Menu) can be hidden/relabeled/re-icon'd/redirected; custom items
|
|
1541
|
-
* are arbitrary buttons.
|
|
1542
|
-
*/
|
|
1543
|
-
headerMenu?: CompositeAppHeaderItem[];
|
|
1544
|
-
/** Optional theme overrides (e.g. disable dark mode) */
|
|
1545
|
-
theme?: CompositeAppThemeOverrides;
|
|
1546
|
-
/** Optional home page override. When set, redirects "/" to the specified app route instead of the dashboard. Send null to unset. */
|
|
1547
|
-
homePlugin?: CompositeAppHomePlugin | null;
|
|
1548
|
-
/** List of apps to include in the CompositeApp (used for installation tracking and fallback sidebar) */
|
|
1549
|
-
apps: CompositeAppEntry[];
|
|
1550
|
-
/**
|
|
1551
|
-
* Optional sidebar menu. When present, the sidebar renders from this
|
|
1552
|
-
* instead of the apps-based pipeline. Top-level array is sections;
|
|
1553
|
-
* each section contains nav-items.
|
|
1554
|
-
*/
|
|
1555
|
-
menu?: CompositeAppMenuSection[];
|
|
1556
|
-
}
|
|
1557
|
-
export type CompositeAppConfigPayload = Partial<Omit<CompositeAppConfig, 'id' | 'project'>>;
|
|
1558
|
-
export interface ValidateUrlRequest {
|
|
1559
|
-
url: string;
|
|
1560
|
-
}
|
|
1561
|
-
export interface ValidateUrlResponse {
|
|
1562
|
-
valid: true;
|
|
1563
|
-
}
|
|
535
|
+
export type CompositeAppConfig = z.infer<typeof CompositeAppConfigSchema>;
|
|
536
|
+
export type CompositeAppConfigPayload = z.infer<typeof CompositeAppConfigPayloadSchema>;
|
|
537
|
+
export type ValidateUrlRequest = z.infer<typeof ValidateUrlRequestSchema>;
|
|
538
|
+
export type ValidateUrlResponse = z.infer<typeof ValidateUrlResponseSchema>;
|
|
1564
539
|
/**
|
|
1565
540
|
* Result of DELETE /api/v1/apps/:id. With `?confirm=true` the cascade runs and
|
|
1566
541
|
* `deleted: true` is set; without it the endpoint returns a dry-run summary so
|
|
1567
542
|
* the UI can show what would be removed.
|
|
543
|
+
*
|
|
544
|
+
* Inferred from the published component rather than hand-written: the endpoint
|
|
545
|
+
* had been declaring `CountResult`, so response validation reported a missing
|
|
546
|
+
* `count` and every field here as unexpected — and in local development, where
|
|
547
|
+
* the check fails closed, that surfaced as a 500 raised AFTER the app was
|
|
548
|
+
* already deleted. Deriving the type is what keeps the two from drifting again.
|
|
1568
549
|
*/
|
|
1569
|
-
export
|
|
1570
|
-
confirmed: boolean;
|
|
1571
|
-
app_id: string;
|
|
1572
|
-
app_name: string;
|
|
1573
|
-
versions: number;
|
|
1574
|
-
installations: number;
|
|
1575
|
-
storage_prefix: string;
|
|
1576
|
-
git_repo_url?: string;
|
|
1577
|
-
deleted: boolean;
|
|
1578
|
-
warnings: string[];
|
|
1579
|
-
}
|
|
1580
|
-
export {};
|
|
550
|
+
export type AppDeleteSummary = z.infer<typeof AppDeleteSummarySchema>;
|
|
1581
551
|
//# sourceMappingURL=apps.d.ts.map
|