@vertesia/common 1.5.0-dev.20260725.083715Z → 1.5.0-dev.20260804.124748Z
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/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 +3781 -0
- package/lib/api-schemas/agent-runs.d.ts.map +1 -0
- package/lib/api-schemas/agent-runs.js +991 -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 +1114 -0
- package/lib/api-schemas/app-lifecycle.d.ts.map +1 -0
- package/lib/api-schemas/app-lifecycle.js +750 -0
- package/lib/api-schemas/app-lifecycle.js.map +1 -0
- package/lib/api-schemas/app-runtime.d.ts +9056 -0
- package/lib/api-schemas/app-runtime.d.ts.map +1 -0
- package/lib/api-schemas/app-runtime.js +782 -0
- package/lib/api-schemas/app-runtime.js.map +1 -0
- package/lib/api-schemas/apps.d.ts +247 -0
- package/lib/api-schemas/apps.d.ts.map +1 -0
- package/lib/api-schemas/apps.js +366 -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 +3561 -0
- package/lib/api-schemas/content.d.ts.map +1 -0
- package/lib/api-schemas/content.js +842 -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 +4880 -0
- package/lib/api-schemas/events.d.ts.map +1 -0
- package/lib/api-schemas/events.js +832 -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 +22454 -0
- package/lib/api-schemas/interaction.d.ts.map +1 -0
- package/lib/api-schemas/interaction.js +2065 -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 +97458 -0
- package/lib/api-schemas/registry.d.ts.map +1 -0
- package/lib/api-schemas/registry.js +2586 -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 +156 -0
- package/lib/api-schemas/sts.d.ts.map +1 -0
- package/lib/api-schemas/sts.js +96 -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 +2209 -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 +107 -1151
- package/lib/apps.d.ts.map +1 -1
- 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 +17 -128
- 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 +19 -115
- 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 +7 -0
- package/lib/index.d.ts.map +1 -1
- 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.d.ts +49 -462
- 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 +55 -503
- 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/secrets.d.ts +20 -105
- package/lib/secrets.d.ts.map +1 -1
- package/lib/store/agent-approval.d.ts +5 -14
- 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 +80 -0
- 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/store.d.ts +98 -700
- 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 +54 -518
- package/lib/store/workflow.d.ts.map +1 -1
- package/lib/store/workflow.js +23 -11
- package/lib/store/workflow.js.map +1 -1
- package/lib/sts-token-types.d.ts +12 -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 +54 -155
- package/lib/user.d.ts.map +1 -1
- package/lib/user.js +1 -78
- package/lib/user.js.map +1 -1
- package/lib/versions.d.ts +24 -1
- package/lib/versions.d.ts.map +1 -1
- package/lib/versions.js +23 -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/views-schema.d.ts +4 -4
- package/lib/views.d.ts +56 -312
- package/lib/views.d.ts.map +1 -1
- package/lib/views.js.map +1 -1
- package/package.json +13 -4
- 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 +1081 -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-lifecycle.ts +841 -0
- package/src/api-schemas/app-runtime.ts +919 -0
- package/src/api-schemas/apps.ts +415 -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 +939 -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 +921 -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.ts +2357 -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/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 +3487 -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 +450 -0
- package/src/api-schemas/store.ts +604 -0
- package/src/api-schemas/sts.contract.test.ts +80 -0
- package/src/api-schemas/sts.ts +110 -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.ts +234 -1213
- 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 +11 -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.ts +98 -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 +97 -557
- package/src/sts-token-types.ts +24 -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 +74 -214
- package/src/versions.ts +24 -0
- package/src/views-schema.test.ts +9 -1
- package/src/views.ts +106 -329
package/src/apps.ts
CHANGED
|
@@ -1,17 +1,125 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type { AppDashboardDefinition } from './data-platform.js';
|
|
3
|
-
import type { CatalogInteractionRef } from './interaction.js';
|
|
1
|
+
import type { z } from 'zod';
|
|
4
2
|
import type {
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
3
|
+
AgentToolApprovalClassSchema,
|
|
4
|
+
AgentToolDefinitionSchema,
|
|
5
|
+
AppBuildProgressSchema,
|
|
6
|
+
AppBuildProgressStatusSchema,
|
|
7
|
+
AppBuildTriggerSchema,
|
|
8
|
+
AppDevelopmentTaskDetailsSchema,
|
|
9
|
+
AppDevelopmentTaskListSchema,
|
|
10
|
+
AppDevelopmentTaskSchema,
|
|
11
|
+
AppInspectionCapabilityReportSchema,
|
|
12
|
+
AppInspectionIssueSchema,
|
|
13
|
+
AppInspectionResultSchema,
|
|
14
|
+
AppInstallationKindSchema,
|
|
15
|
+
AppInstallationOAuthBindingSchema,
|
|
16
|
+
AppInstallationPayloadSchema,
|
|
17
|
+
AppInstallationProjectsQuerySchema,
|
|
18
|
+
AppInstallationProviderBindingSchema,
|
|
19
|
+
AppInstallationsQuerySchema,
|
|
20
|
+
AppOAuthCollectionParamsSchema,
|
|
21
|
+
AppOAuthProviderParamsSchema,
|
|
22
|
+
AppRepoBranchSchema,
|
|
23
|
+
AppRepoCommitSchema,
|
|
24
|
+
AppRepoCommitsSchema,
|
|
25
|
+
AppRepoDocumentCommitSchema,
|
|
26
|
+
AppRepoRefSchema,
|
|
27
|
+
AppRepoRefsSchema,
|
|
28
|
+
AppRepoTreeEntrySchema,
|
|
29
|
+
AppRepoTreeSchema,
|
|
30
|
+
AppScaffoldModuleSchema,
|
|
31
|
+
AppScaffoldProgressSchema,
|
|
32
|
+
AppScaffoldProgressStatusSchema,
|
|
33
|
+
AppToolCollectionSchema,
|
|
34
|
+
AppVersionGitRefTypeSchema,
|
|
35
|
+
AppVersionGitSourceSchema,
|
|
36
|
+
AppVersionKindSchema,
|
|
37
|
+
AppVersionRecordSchema,
|
|
38
|
+
AppVersionStateSchema,
|
|
39
|
+
AppVersionStorageSchema,
|
|
40
|
+
AppVersionTargetSchema,
|
|
41
|
+
AppVersionUrlsSchema,
|
|
42
|
+
DeleteAppVersionResponseSchema,
|
|
43
|
+
OAuthClientCredentialsSchema,
|
|
44
|
+
StartAppBuildRequestSchema,
|
|
45
|
+
StartAppBuildResponseSchema,
|
|
46
|
+
StartAppScaffoldRequestSchema,
|
|
47
|
+
StartAppScaffoldResponseSchema,
|
|
48
|
+
UpdateAppInstallationToolAllowlistPayloadSchema,
|
|
49
|
+
UpsertAppVersionRequestSchema,
|
|
50
|
+
ValidateUrlRequestSchema,
|
|
51
|
+
ValidateUrlResponseSchema,
|
|
52
|
+
} from './api-schemas/app-lifecycle.js';
|
|
53
|
+
import type {
|
|
54
|
+
AppInstallationListEntrySchema,
|
|
55
|
+
AppInstallationSchema,
|
|
56
|
+
AppInstallationWithManifestSchema,
|
|
57
|
+
AppManifestDataSchema,
|
|
58
|
+
AppManifestSchema,
|
|
59
|
+
AppPackageSchema,
|
|
60
|
+
AppWidgetInfoSchema,
|
|
61
|
+
CompositeAppCardOverridesSchema,
|
|
62
|
+
CompositeAppConfigPayloadSchema,
|
|
63
|
+
CompositeAppConfigSchema,
|
|
64
|
+
CompositeAppEntrySchema,
|
|
65
|
+
CompositeAppHeaderItemKindSchema,
|
|
66
|
+
CompositeAppHeaderItemSchema,
|
|
67
|
+
CompositeAppHeaderItemTargetSchema,
|
|
68
|
+
CompositeAppHeaderOverridesSchema,
|
|
69
|
+
CompositeAppHomePluginSchema,
|
|
70
|
+
CompositeAppLogoOverridesSchema,
|
|
71
|
+
CompositeAppMenuSectionSchema,
|
|
72
|
+
CompositeAppMessageOverridesSchema,
|
|
73
|
+
CompositeAppMessageStyleSchema,
|
|
74
|
+
CompositeAppNavItemPermissionsSchema,
|
|
75
|
+
CompositeAppSidebarOverridesSchema,
|
|
76
|
+
CompositeAppSwitchersOverridesSchema,
|
|
77
|
+
CompositeAppThemeOverridesSchema,
|
|
78
|
+
CompositeAppUserMenuOverridesSchema,
|
|
79
|
+
PromoteAppVersionResponseSchema,
|
|
80
|
+
} from './api-schemas/app-runtime.js';
|
|
81
|
+
import type {
|
|
82
|
+
AppAccessControlSchema,
|
|
83
|
+
AppAvailableInSchema,
|
|
84
|
+
AppCapabilitiesSchema,
|
|
85
|
+
AppGitSourceConfigSchema,
|
|
86
|
+
AppManifestSourceSchema,
|
|
87
|
+
AppSourceConfigSchema,
|
|
88
|
+
AppUIConfigSchema,
|
|
89
|
+
MCPOAuthConfigSchema,
|
|
90
|
+
MCPToolAnnotationsSchema,
|
|
91
|
+
MCPToolCollectionObjectSchema,
|
|
92
|
+
McpOAuthConnectResponseSchema,
|
|
93
|
+
McpOAuthDisconnectResponseSchema,
|
|
94
|
+
McpOAuthTokenRequestSchema,
|
|
95
|
+
McpOAuthTokenResponseSchema,
|
|
96
|
+
OAuthAuthorizeResponseSchema,
|
|
97
|
+
OAuthAuthStatusSchema,
|
|
98
|
+
OAuthMetadataResponseSchema,
|
|
99
|
+
ToolCollectionAuthTypeSchema,
|
|
100
|
+
ToolCollectionObjectSchema,
|
|
101
|
+
VertesiaSDKToolCollectionObjectSchema,
|
|
102
|
+
} from './api-schemas/apps.js';
|
|
103
|
+
import type { RemoteActivityDefinitionSchema } from './api-schemas/integrations.js';
|
|
104
|
+
import type {
|
|
105
|
+
ProjectToolInfoSchema,
|
|
106
|
+
RenderingTemplateDefinitionRefSchema,
|
|
107
|
+
RenderingTemplateDefinitionSchema,
|
|
108
|
+
} from './api-schemas/project.js';
|
|
11
109
|
|
|
12
110
|
/** Allowed values for AppUINavItem.preferredSection */
|
|
13
111
|
export const PREFERRED_SECTIONS = ['default', 'footer', 'settings'] as const;
|
|
14
112
|
|
|
113
|
+
// The app-manifest closure is declared once, as the Zod schemas in `./api-schemas/apps.ts`, and
|
|
114
|
+
// inferred below. The documentation moved with it: what a published component says about a field now
|
|
115
|
+
// comes from the schema's own `.meta({ description })` rather than from a TSDoc comment a generator
|
|
116
|
+
// had to interpret.
|
|
117
|
+
//
|
|
118
|
+
// This one type is the exception, and for the same reason `JSONSchema` is: it RECURSES. Zod 4 infers
|
|
119
|
+
// a recursive type from a getter, but the inference bottoms out at depth — `children` degrades to
|
|
120
|
+
// `Record<string, unknown>[]`, and the composite-app menu code that walks nested items stops
|
|
121
|
+
// compiling. So the named type stays hand-written and `z.ZodType<AppUINavItem>` on the schema is what
|
|
122
|
+
// keeps the two checked against each other. The runtime schema remains the OpenAPI and AJV authority.
|
|
15
123
|
/**
|
|
16
124
|
* Additional navigation item for an app's UI configuration.
|
|
17
125
|
* Used in AppUIConfig.navigation to define sidebar navigation entries in CompositeApp shell contexts.
|
|
@@ -39,204 +147,26 @@ export interface AppUINavItem {
|
|
|
39
147
|
preferredSection?: (typeof PREFERRED_SECTIONS)[number];
|
|
40
148
|
}
|
|
41
149
|
|
|
42
|
-
export
|
|
43
|
-
/**
|
|
44
|
-
* The source URL of the app. The src can be a template which contain
|
|
45
|
-
* a variable named `buildId` which will be replaced with the current build id.
|
|
46
|
-
* For example: `/plugins/vertesia-review-center-${buildId}`
|
|
47
|
-
*/
|
|
48
|
-
src: string;
|
|
49
|
-
/**
|
|
50
|
-
* The isolation strategy. If not specified it defaults to shadow.
|
|
51
|
-
* - shadow - use Shadow DOM to fully isolate the plugin from the host.
|
|
52
|
-
* - css - inject the plugin's styles (minus the preflight) into the host document;
|
|
53
|
-
* lighter but styles may conflict with the host.
|
|
54
|
-
*/
|
|
55
|
-
isolation?: 'shadow' | 'css';
|
|
56
|
-
/**
|
|
57
|
-
* When true the host modifies the app's css at load time to attempt to fix broken
|
|
58
|
-
* or missing styles. Only takes effect in css isolation mode. Defaults to false.
|
|
59
|
-
*/
|
|
60
|
-
css_rebuild?: boolean;
|
|
61
|
-
/**
|
|
62
|
-
* Navigation items for the app's sidebar UI.
|
|
63
|
-
* Only applicable for apps with UI capability in shell contexts (ie. CompositeApp shell).
|
|
64
|
-
*/
|
|
65
|
-
navigation?: AppUINavItem[];
|
|
66
|
-
/**
|
|
67
|
-
* Where this app's UI can be displayed.
|
|
68
|
-
* - 'app_portal': Available in the main app portal (standalone)
|
|
69
|
-
* - 'composite_app': Available within a CompositeApp shell
|
|
70
|
-
* Defaults to ['app_portal', 'composite_app'] for new apps.
|
|
71
|
-
*/
|
|
72
|
-
available_in?: AppAvailableIn[];
|
|
73
|
-
}
|
|
150
|
+
export type AppUIConfig = z.infer<typeof AppUIConfigSchema>;
|
|
74
151
|
|
|
75
|
-
export
|
|
76
|
-
name?: string;
|
|
77
|
-
id?: string;
|
|
78
|
-
}
|
|
152
|
+
export type AppInstallationProjectsQuery = z.infer<typeof AppInstallationProjectsQuerySchema>;
|
|
79
153
|
|
|
80
|
-
export
|
|
81
|
-
kind?: AppInstallationKind;
|
|
82
|
-
available_in?: AppAvailableIn;
|
|
83
|
-
}
|
|
154
|
+
export type AppInstallationsQuery = z.infer<typeof AppInstallationsQuerySchema>;
|
|
84
155
|
|
|
85
|
-
|
|
86
|
-
* Authentication type for tool collections
|
|
87
|
-
*/
|
|
88
|
-
export type ToolCollectionAuthType = 'oauth' | 'other';
|
|
156
|
+
export type ToolCollectionAuthType = z.infer<typeof ToolCollectionAuthTypeSchema>;
|
|
89
157
|
|
|
90
158
|
/**
|
|
91
159
|
* Tool collection type
|
|
92
160
|
*/
|
|
93
161
|
export type ToolCollectionType = 'mcp' | 'vertesia_sdk';
|
|
94
162
|
|
|
95
|
-
|
|
96
|
-
* Base tool collection configuration
|
|
97
|
-
*/
|
|
98
|
-
interface BaseToolCollectionObject {
|
|
99
|
-
/**
|
|
100
|
-
* The URL endpoint for the tool collection
|
|
101
|
-
*/
|
|
102
|
-
url: string;
|
|
103
|
-
|
|
104
|
-
/**
|
|
105
|
-
* Optional authentication type required for this tool collection
|
|
106
|
-
*/
|
|
107
|
-
auth?: ToolCollectionAuthType;
|
|
108
|
-
}
|
|
109
|
-
|
|
110
|
-
/**
|
|
111
|
-
* Install-time OAuth provisioning blueprint for an MCP collection.
|
|
112
|
-
* Defines how to auto-create an OAuth provider when the app is installed.
|
|
113
|
-
* Does NOT affect runtime behaviour — the runtime uses oauth_bindings on AppInstallation.
|
|
114
|
-
*/
|
|
115
|
-
export interface MCPOAuthConfig {
|
|
116
|
-
/**
|
|
117
|
-
* Name for the OAuth provider to create at install time.
|
|
118
|
-
* Defaults to the collection id converted to kebab-case if not specified.
|
|
119
|
-
*/
|
|
120
|
-
name?: string;
|
|
121
|
-
/** Human-readable display name for the created OAuth provider. */
|
|
122
|
-
display_name?: string;
|
|
123
|
-
grant_type?: 'authorization_code' | 'client_credentials';
|
|
124
|
-
authorization_endpoint?: string;
|
|
125
|
-
token_endpoint?: string;
|
|
126
|
-
revocation_endpoint?: string;
|
|
127
|
-
/**
|
|
128
|
-
* Pre-configured client_id.
|
|
129
|
-
* Omit if the installer must supply it (include 'client_id' in required_at_install).
|
|
130
|
-
*/
|
|
131
|
-
client_id?: string;
|
|
132
|
-
use_pkce?: boolean;
|
|
133
|
-
default_scopes?: string[];
|
|
134
|
-
/**
|
|
135
|
-
* Parameters the installer must provide at install time.
|
|
136
|
-
* These are shown as form fields in composable-ui before the install completes.
|
|
137
|
-
* - 'client_id': user supplies the OAuth client ID
|
|
138
|
-
* - 'client_secret': user supplies the OAuth client secret
|
|
139
|
-
*/
|
|
140
|
-
required_at_install?: Array<'client_id' | 'client_secret' | 'scopes'>;
|
|
141
|
-
}
|
|
163
|
+
export type MCPOAuthConfig = z.infer<typeof MCPOAuthConfigSchema>;
|
|
142
164
|
|
|
143
|
-
|
|
144
|
-
* MCP tool collection configuration (requires name, description, and namespace)
|
|
145
|
-
*/
|
|
146
|
-
export interface MCPToolCollectionObject extends BaseToolCollectionObject {
|
|
147
|
-
type: 'mcp';
|
|
148
|
-
|
|
149
|
-
/**
|
|
150
|
-
* Stable identifier for this collection.
|
|
151
|
-
* Used to key oauth_bindings on AppInstallation — protects against collection renames.
|
|
152
|
-
* Required for new manifests.
|
|
153
|
-
*/
|
|
154
|
-
id: string;
|
|
165
|
+
export type MCPToolCollectionObject = z.infer<typeof MCPToolCollectionObjectSchema>;
|
|
155
166
|
|
|
156
|
-
|
|
157
|
-
* Name for the tool collection.
|
|
158
|
-
* Human-readable label for the collection.
|
|
159
|
-
* Used in UI.
|
|
160
|
-
*/
|
|
161
|
-
name: string;
|
|
167
|
+
export type VertesiaSDKToolCollectionObject = z.infer<typeof VertesiaSDKToolCollectionObjectSchema>;
|
|
162
168
|
|
|
163
|
-
|
|
164
|
-
* Description for the tool collection.
|
|
165
|
-
* Helps users understand what tools this collection provides.
|
|
166
|
-
*/
|
|
167
|
-
description: string;
|
|
168
|
-
|
|
169
|
-
/**
|
|
170
|
-
* Prefix to use for tool names from this collection.
|
|
171
|
-
* Provides clean, readable tool names (e.g., "jira" instead of "https://mcp.atlassian.com/v1/mcp")
|
|
172
|
-
*/
|
|
173
|
-
namespace: string;
|
|
174
|
-
|
|
175
|
-
/**
|
|
176
|
-
* Reference to an OAuth provider name for this collection (legacy / manual path).
|
|
177
|
-
* When set, uses the OAuth provider's config (endpoints, client_id, client_secret)
|
|
178
|
-
* instead of MCP dynamic client registration or random fallback.
|
|
179
|
-
* The referenced OAuth provider must exist in the same project.
|
|
180
|
-
*/
|
|
181
|
-
oauth_app?: string;
|
|
182
|
-
|
|
183
|
-
/**
|
|
184
|
-
* Install-time OAuth provisioning blueprint.
|
|
185
|
-
* When present, the platform auto-creates an OAuth provider at install time
|
|
186
|
-
* using these values merged with any user-supplied required_at_install params.
|
|
187
|
-
* The created app is recorded in AppInstallation.oauth_bindings.
|
|
188
|
-
* Mutually exclusive with oauth_provider.
|
|
189
|
-
*/
|
|
190
|
-
oauth_config?: MCPOAuthConfig;
|
|
191
|
-
|
|
192
|
-
/**
|
|
193
|
-
* Reference to a key in AppManifestData.oauth_providers.
|
|
194
|
-
* When set, this collection shares the named provider's OAuth provider configuration.
|
|
195
|
-
* Mutually exclusive with oauth_config and oauth_app.
|
|
196
|
-
* Requires auth: "oauth" to be set.
|
|
197
|
-
*/
|
|
198
|
-
oauth_provider?: string;
|
|
199
|
-
|
|
200
|
-
/**
|
|
201
|
-
* Additional OAuth scopes for this collection when using a shared oauth_provider.
|
|
202
|
-
* These are merged (union) with the provider's default_scopes at install time.
|
|
203
|
-
* Only valid when oauth_provider is set.
|
|
204
|
-
*/
|
|
205
|
-
oauth_scopes?: string[];
|
|
206
|
-
}
|
|
207
|
-
|
|
208
|
-
/**
|
|
209
|
-
* Vertesia SDK tool collection configuration
|
|
210
|
-
*/
|
|
211
|
-
export interface VertesiaSDKToolCollectionObject extends BaseToolCollectionObject {
|
|
212
|
-
type: 'vertesia_sdk';
|
|
213
|
-
|
|
214
|
-
/**
|
|
215
|
-
* Optional namespace to use for tool names from this collection.
|
|
216
|
-
* If not provided, the tool server default will be used.
|
|
217
|
-
*/
|
|
218
|
-
namespace?: string;
|
|
219
|
-
|
|
220
|
-
/**
|
|
221
|
-
* Optional name for the tool collection.
|
|
222
|
-
* If not provided, the tool server default will be used.
|
|
223
|
-
*/
|
|
224
|
-
name?: string;
|
|
225
|
-
|
|
226
|
-
/**
|
|
227
|
-
* Optional description for the tool collection.
|
|
228
|
-
* If not provided, the tool server default will be used.
|
|
229
|
-
*/
|
|
230
|
-
description?: string;
|
|
231
|
-
}
|
|
232
|
-
|
|
233
|
-
/**
|
|
234
|
-
* Tool collection configuration (object format)
|
|
235
|
-
*/
|
|
236
|
-
/**
|
|
237
|
-
* @discriminator type
|
|
238
|
-
*/
|
|
239
|
-
export type ToolCollectionObject = MCPToolCollectionObject | VertesiaSDKToolCollectionObject;
|
|
169
|
+
export type ToolCollectionObject = z.infer<typeof ToolCollectionObjectSchema>;
|
|
240
170
|
|
|
241
171
|
/**
|
|
242
172
|
* Backward-compatible TypeScript alias. Public API payloads should reference
|
|
@@ -302,18 +232,7 @@ export function normalizeToolCollection(collection: ToolCollectionObject, vars?:
|
|
|
302
232
|
/**
|
|
303
233
|
* Metadata hints from MCP tool annotations (per MCP spec).
|
|
304
234
|
*/
|
|
305
|
-
export
|
|
306
|
-
/** Human-readable display name for the tool */
|
|
307
|
-
title?: string;
|
|
308
|
-
/** If true, the tool does not modify any state */
|
|
309
|
-
readOnlyHint?: boolean;
|
|
310
|
-
/** If true, the tool may perform irreversible destructive operations */
|
|
311
|
-
destructiveHint?: boolean;
|
|
312
|
-
/** If true, calling the tool multiple times with the same args has no additional effect */
|
|
313
|
-
idempotentHint?: boolean;
|
|
314
|
-
/** If true, the tool interacts with external entities outside the local environment */
|
|
315
|
-
openWorldHint?: boolean;
|
|
316
|
-
}
|
|
235
|
+
export type MCPToolAnnotations = z.infer<typeof MCPToolAnnotationsSchema>;
|
|
317
236
|
|
|
318
237
|
/**
|
|
319
238
|
* Approval behavior class for a tool exposed to agents.
|
|
@@ -323,71 +242,19 @@ export interface MCPToolAnnotations {
|
|
|
323
242
|
* - `control`: affects agent control flow or tool availability, not user data or external systems.
|
|
324
243
|
* - `requires_confirmation`: high-impact action that must ask the user even in interactive full-control mode.
|
|
325
244
|
*/
|
|
326
|
-
export type AgentToolApprovalClass =
|
|
245
|
+
export type AgentToolApprovalClass = z.infer<typeof AgentToolApprovalClassSchema>;
|
|
327
246
|
|
|
328
247
|
/**
|
|
329
248
|
* Tool definition with optional activation control for agent exposure.
|
|
330
249
|
*/
|
|
331
|
-
export
|
|
332
|
-
/**
|
|
333
|
-
* The tool execution URL. It can be an absolute URL or a path in which case the URL is obtained
|
|
334
|
-
* using the base URL of the tool server API. Ex: http://tool-server.com/api/
|
|
335
|
-
* Example of relative URLs: "tools/my-tool-collection" or "/api/tools/my-tool-collection"
|
|
336
|
-
*/
|
|
337
|
-
url?: string;
|
|
338
|
-
/**
|
|
339
|
-
* The tool category if any - for UI purposes.
|
|
340
|
-
*/
|
|
341
|
-
category?: string;
|
|
342
|
-
/**
|
|
343
|
-
* Whether this tool is available by default.
|
|
344
|
-
* - true/undefined: Tool is always available to agents
|
|
345
|
-
* - false: Tool is only available when enabled by a skill via `tools`
|
|
346
|
-
*/
|
|
347
|
-
default?: boolean;
|
|
348
|
-
/**
|
|
349
|
-
* For skill tools (`learn_*`): the tool names this skill enables when called.
|
|
350
|
-
* Matches the `tools:` key used in SKILL.md frontmatter and built-in skill
|
|
351
|
-
* definitions — one name across the whole stack.
|
|
352
|
-
*/
|
|
353
|
-
tools?: string[];
|
|
354
|
-
/**
|
|
355
|
-
* MCP tool annotations providing hints about tool behavior and safety.
|
|
356
|
-
*/
|
|
357
|
-
annotations?: MCPToolAnnotations;
|
|
358
|
-
/**
|
|
359
|
-
* Approval classification used by interactive agent approval modes.
|
|
360
|
-
* Use `requires_confirmation` for actions that must prompt even in full-control mode.
|
|
361
|
-
*/
|
|
362
|
-
approval_class?: AgentToolApprovalClass;
|
|
363
|
-
}
|
|
250
|
+
export type AgentToolDefinition = z.infer<typeof AgentToolDefinitionSchema>;
|
|
364
251
|
|
|
365
252
|
/**
|
|
366
253
|
* Definition of a remote activity exposed by a tool server for use in DSL workflows.
|
|
367
254
|
* Remote activities are identified in workflow steps using colon-separated names:
|
|
368
255
|
* `app:<app_name>:<collection>:<activity_name>` (e.g. `app:my-nlp-app:examples:word_count`).
|
|
369
256
|
*/
|
|
370
|
-
export
|
|
371
|
-
/** Activity name (snake_case, unique within the collection) */
|
|
372
|
-
name: string;
|
|
373
|
-
/** Collection name this activity belongs to */
|
|
374
|
-
collection?: string;
|
|
375
|
-
/** Display title */
|
|
376
|
-
title?: string;
|
|
377
|
-
/** Description of what the activity does */
|
|
378
|
-
description?: string;
|
|
379
|
-
/** JSON Schema for the activity input parameters */
|
|
380
|
-
input_schema?: Record<string, unknown>;
|
|
381
|
-
/** JSON Schema for the activity output */
|
|
382
|
-
output_schema?: Record<string, unknown>;
|
|
383
|
-
/**
|
|
384
|
-
* The activity execution URL. Can be absolute or relative to the tool server base URL.
|
|
385
|
-
* If not provided, the collection-specific activities endpoint is used.
|
|
386
|
-
*/
|
|
387
|
-
url?: string;
|
|
388
|
-
/** Suggested timeout and retry configuration */
|
|
389
|
-
options?: DSLActivityOptions;
|
|
390
|
-
}
|
|
257
|
+
export type RemoteActivityDefinition = z.infer<typeof RemoteActivityDefinitionSchema>;
|
|
391
258
|
|
|
392
259
|
/**
|
|
393
260
|
* Canonical app capabilities Studio renders/supports. The public type is derived from
|
|
@@ -404,7 +271,7 @@ export const APP_CAPABILITIES = [
|
|
|
404
271
|
'dashboards',
|
|
405
272
|
] as const;
|
|
406
273
|
|
|
407
|
-
export type AppCapabilities =
|
|
274
|
+
export type AppCapabilities = z.infer<typeof AppCapabilitiesSchema>;
|
|
408
275
|
|
|
409
276
|
/**
|
|
410
277
|
* Header carrying the app version a generated-app UI is running, so studio/zeno resolve app-owned
|
|
@@ -499,132 +366,25 @@ export interface AppCapabilityManifest {
|
|
|
499
366
|
|
|
500
367
|
/** Repo-relative path the capability manifest is committed to, read by version-build gates. */
|
|
501
368
|
export const APP_CAPABILITY_MANIFEST_PATH = 'docs/app-capability-manifest.json';
|
|
502
|
-
export type AppAvailableIn =
|
|
503
|
-
|
|
504
|
-
export type AppVersionKind = 'design' | 'version';
|
|
505
|
-
export type AppVersionState = 'ready' | 'failed' | 'expired';
|
|
506
|
-
export type AppVersionTarget = 'static' | 'service';
|
|
507
|
-
export type AppVersionGitRefType = 'branch' | 'tag' | 'commit' | 'detached';
|
|
508
|
-
export type AppBuildTrigger = 'ui' | 'git_push' | 'agent' | 'api';
|
|
509
|
-
|
|
510
|
-
export interface AppVersionStorage {
|
|
511
|
-
tenant_id?: string;
|
|
512
|
-
app_prefix?: string;
|
|
513
|
-
artifacts_prefix?: string;
|
|
514
|
-
source_archive?: string;
|
|
515
|
-
source_git?: AppVersionGitSource;
|
|
516
|
-
build_prefix?: string;
|
|
517
|
-
manifest_path?: string;
|
|
518
|
-
service_archive?: string;
|
|
519
|
-
live_metadata_path?: string;
|
|
520
|
-
}
|
|
369
|
+
export type AppAvailableIn = z.infer<typeof AppAvailableInSchema>;
|
|
521
370
|
|
|
522
|
-
export
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
* app versions use the exact commit SHA rather than a mutable branch or tag.
|
|
528
|
-
*/
|
|
529
|
-
ref?: string;
|
|
530
|
-
ref_type?: AppVersionGitRefType;
|
|
531
|
-
branch?: string;
|
|
532
|
-
tag?: string;
|
|
533
|
-
commit?: string;
|
|
534
|
-
dirty?: boolean;
|
|
535
|
-
pushed?: boolean;
|
|
536
|
-
push_warning?: string;
|
|
537
|
-
}
|
|
371
|
+
export type AppVersionKind = z.infer<typeof AppVersionKindSchema>;
|
|
372
|
+
export type AppVersionState = z.infer<typeof AppVersionStateSchema>;
|
|
373
|
+
export type AppVersionTarget = z.infer<typeof AppVersionTargetSchema>;
|
|
374
|
+
export type AppVersionGitRefType = z.infer<typeof AppVersionGitRefTypeSchema>;
|
|
375
|
+
export type AppBuildTrigger = z.infer<typeof AppBuildTriggerSchema>;
|
|
538
376
|
|
|
539
|
-
export
|
|
540
|
-
live_url?: string;
|
|
541
|
-
app_url?: string;
|
|
542
|
-
plugin_url?: string;
|
|
543
|
-
package_url?: string;
|
|
544
|
-
internal_preview_url?: string;
|
|
545
|
-
}
|
|
377
|
+
export type AppVersionStorage = z.infer<typeof AppVersionStorageSchema>;
|
|
546
378
|
|
|
547
|
-
export
|
|
548
|
-
id: string;
|
|
549
|
-
account: string;
|
|
550
|
-
project: string;
|
|
551
|
-
app?: string;
|
|
552
|
-
app_id: string;
|
|
553
|
-
app_name: string;
|
|
554
|
-
version_id: string;
|
|
555
|
-
kind: AppVersionKind;
|
|
556
|
-
state: AppVersionState;
|
|
557
|
-
promoted?: boolean;
|
|
558
|
-
target?: AppVersionTarget;
|
|
559
|
-
agent_run_id?: string;
|
|
560
|
-
/** Development task that produced this version, when built by the app assistant. */
|
|
561
|
-
development_task_id?: string;
|
|
562
|
-
/** Temporal workflow that produced this version. */
|
|
563
|
-
build_workflow_id?: string;
|
|
564
|
-
/** Temporal run that produced this version. */
|
|
565
|
-
build_workflow_run_id?: string;
|
|
566
|
-
sandbox_id?: string;
|
|
567
|
-
title?: string;
|
|
568
|
-
description?: string;
|
|
569
|
-
storage?: AppVersionStorage;
|
|
570
|
-
/** Exact Git commit used to build this immutable version. */
|
|
571
|
-
source_commit?: string;
|
|
572
|
-
urls?: AppVersionUrls;
|
|
573
|
-
manifest?: Record<string, unknown>;
|
|
574
|
-
files?: string[];
|
|
575
|
-
file_count?: number;
|
|
576
|
-
source_file_count?: number;
|
|
577
|
-
screenshot_artifact?: string;
|
|
578
|
-
checks?: string[];
|
|
579
|
-
created_by?: string;
|
|
580
|
-
created_at: string;
|
|
581
|
-
updated_at: string;
|
|
582
|
-
built_at?: string;
|
|
583
|
-
checked_at?: string;
|
|
584
|
-
expires_at?: string;
|
|
585
|
-
}
|
|
379
|
+
export type AppVersionGitSource = z.infer<typeof AppVersionGitSourceSchema>;
|
|
586
380
|
|
|
587
|
-
export
|
|
588
|
-
id: string;
|
|
589
|
-
app_id: string;
|
|
590
|
-
version_id: string;
|
|
591
|
-
storage_prefix?: string;
|
|
592
|
-
deleted: boolean;
|
|
593
|
-
warnings: string[];
|
|
594
|
-
}
|
|
381
|
+
export type AppVersionUrls = z.infer<typeof AppVersionUrlsSchema>;
|
|
595
382
|
|
|
596
|
-
export
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
app_name?: string;
|
|
602
|
-
version_id: string;
|
|
603
|
-
kind: AppVersionKind;
|
|
604
|
-
state?: AppVersionState;
|
|
605
|
-
target?: AppVersionTarget;
|
|
606
|
-
agent_run_id?: string;
|
|
607
|
-
/** Development task that produced this version, when built by the app assistant. */
|
|
608
|
-
development_task_id?: string;
|
|
609
|
-
build_workflow_id?: string;
|
|
610
|
-
build_workflow_run_id?: string;
|
|
611
|
-
sandbox_id?: string;
|
|
612
|
-
title?: string;
|
|
613
|
-
description?: string;
|
|
614
|
-
storage?: AppVersionStorage;
|
|
615
|
-
/** Exact Git commit used to build this immutable version. */
|
|
616
|
-
source_commit?: string;
|
|
617
|
-
urls?: AppVersionUrls;
|
|
618
|
-
manifest?: Record<string, unknown>;
|
|
619
|
-
files?: string[];
|
|
620
|
-
file_count?: number;
|
|
621
|
-
source_file_count?: number;
|
|
622
|
-
screenshot_artifact?: string;
|
|
623
|
-
checks?: string[];
|
|
624
|
-
built_at?: string;
|
|
625
|
-
checked_at?: string;
|
|
626
|
-
expires_at?: string;
|
|
627
|
-
}
|
|
383
|
+
export type AppVersionRecord = z.infer<typeof AppVersionRecordSchema>;
|
|
384
|
+
|
|
385
|
+
export type DeleteAppVersionResponse = z.infer<typeof DeleteAppVersionResponseSchema>;
|
|
386
|
+
|
|
387
|
+
export type UpsertAppVersionRequest = z.infer<typeof UpsertAppVersionRequestSchema>;
|
|
628
388
|
|
|
629
389
|
export interface AppVersionListQuery {
|
|
630
390
|
app_id?: string;
|
|
@@ -633,33 +393,11 @@ export interface AppVersionListQuery {
|
|
|
633
393
|
limit?: number;
|
|
634
394
|
}
|
|
635
395
|
|
|
636
|
-
export
|
|
637
|
-
version: AppVersionRecord;
|
|
638
|
-
app?: AppManifest;
|
|
639
|
-
}
|
|
396
|
+
export type PromoteAppVersionResponse = z.infer<typeof PromoteAppVersionResponseSchema>;
|
|
640
397
|
|
|
641
|
-
export
|
|
642
|
-
/**
|
|
643
|
-
* Source branch, tag, or commit to build. When omitted, the app source
|
|
644
|
-
* configuration chooses its default branch.
|
|
645
|
-
*/
|
|
646
|
-
source_ref?: string;
|
|
647
|
-
source_ref_type?: Extract<AppVersionGitRefType, 'branch' | 'tag' | 'commit'>;
|
|
648
|
-
trigger?: AppBuildTrigger;
|
|
649
|
-
target?: AppVersionTarget;
|
|
650
|
-
title?: string;
|
|
651
|
-
description?: string;
|
|
652
|
-
}
|
|
398
|
+
export type StartAppBuildRequest = z.infer<typeof StartAppBuildRequestSchema>;
|
|
653
399
|
|
|
654
|
-
export
|
|
655
|
-
workflow_id: string;
|
|
656
|
-
run_id: string;
|
|
657
|
-
app_id: string;
|
|
658
|
-
version_id?: string;
|
|
659
|
-
rebuild_version_record_id?: string;
|
|
660
|
-
source_ref?: string;
|
|
661
|
-
source_ref_type?: Extract<AppVersionGitRefType, 'branch' | 'tag' | 'commit'>;
|
|
662
|
-
}
|
|
400
|
+
export type StartAppBuildResponse = z.infer<typeof StartAppBuildResponseSchema>;
|
|
663
401
|
|
|
664
402
|
export interface AppBuildWorkflowInput extends StartAppBuildRequest {
|
|
665
403
|
app_id: string;
|
|
@@ -682,48 +420,15 @@ export interface AppBuildWorkflowResult {
|
|
|
682
420
|
file_count?: number;
|
|
683
421
|
}
|
|
684
422
|
|
|
685
|
-
export type AppBuildProgressStatus =
|
|
423
|
+
export type AppBuildProgressStatus = z.infer<typeof AppBuildProgressStatusSchema>;
|
|
686
424
|
|
|
687
|
-
export
|
|
688
|
-
status: AppBuildProgressStatus;
|
|
689
|
-
step: string;
|
|
690
|
-
app_id?: string;
|
|
691
|
-
version_id?: string;
|
|
692
|
-
source_ref?: string;
|
|
693
|
-
source_ref_type?: Extract<AppVersionGitRefType, 'branch' | 'tag' | 'commit'>;
|
|
694
|
-
source_commit?: string;
|
|
695
|
-
file_count?: number;
|
|
696
|
-
app_url?: string;
|
|
697
|
-
error?: string;
|
|
698
|
-
updated_at: string;
|
|
699
|
-
}
|
|
425
|
+
export type AppBuildProgress = z.infer<typeof AppBuildProgressSchema>;
|
|
700
426
|
|
|
701
|
-
export type AppScaffoldModule =
|
|
427
|
+
export type AppScaffoldModule = z.infer<typeof AppScaffoldModuleSchema>;
|
|
702
428
|
|
|
703
|
-
export
|
|
704
|
-
/**
|
|
705
|
-
* App id / package name to create. It is normalized to the same slug rules
|
|
706
|
-
* used by @vertesia/create-plugin.
|
|
707
|
-
*/
|
|
708
|
-
app_id: string;
|
|
709
|
-
title?: string;
|
|
710
|
-
description?: string;
|
|
711
|
-
modules?: AppScaffoldModule[];
|
|
712
|
-
/**
|
|
713
|
-
* Start an initial app version build after the source has been pushed.
|
|
714
|
-
* Defaults to true.
|
|
715
|
-
*/
|
|
716
|
-
create_version?: boolean;
|
|
717
|
-
}
|
|
429
|
+
export type StartAppScaffoldRequest = z.infer<typeof StartAppScaffoldRequestSchema>;
|
|
718
430
|
|
|
719
|
-
export
|
|
720
|
-
workflow_id: string;
|
|
721
|
-
run_id: string;
|
|
722
|
-
app_id: string;
|
|
723
|
-
app_record_id?: string;
|
|
724
|
-
git_url?: string;
|
|
725
|
-
create_version: boolean;
|
|
726
|
-
}
|
|
431
|
+
export type StartAppScaffoldResponse = z.infer<typeof StartAppScaffoldResponseSchema>;
|
|
727
432
|
|
|
728
433
|
export interface AppScaffoldWorkflowInput extends StartAppScaffoldRequest {}
|
|
729
434
|
|
|
@@ -737,28 +442,9 @@ export interface AppScaffoldWorkflowResult {
|
|
|
737
442
|
initial_version_build?: StartAppBuildResponse;
|
|
738
443
|
}
|
|
739
444
|
|
|
740
|
-
export type AppScaffoldProgressStatus =
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
| 'scaffolding'
|
|
744
|
-
| 'pushing'
|
|
745
|
-
| 'building'
|
|
746
|
-
| 'completed'
|
|
747
|
-
| 'failed';
|
|
748
|
-
|
|
749
|
-
export interface AppScaffoldProgress {
|
|
750
|
-
status: AppScaffoldProgressStatus;
|
|
751
|
-
step: string;
|
|
752
|
-
app_id?: string;
|
|
753
|
-
app_record_id?: string;
|
|
754
|
-
installation_id?: string;
|
|
755
|
-
git_url?: string;
|
|
756
|
-
files?: number;
|
|
757
|
-
initial_version_build?: StartAppBuildResponse;
|
|
758
|
-
error?: string;
|
|
759
|
-
error_details?: string[];
|
|
760
|
-
updated_at: string;
|
|
761
|
-
}
|
|
445
|
+
export type AppScaffoldProgressStatus = z.infer<typeof AppScaffoldProgressStatusSchema>;
|
|
446
|
+
|
|
447
|
+
export type AppScaffoldProgress = z.infer<typeof AppScaffoldProgressSchema>;
|
|
762
448
|
|
|
763
449
|
/**
|
|
764
450
|
* Access control policy for an app installation.
|
|
@@ -772,7 +458,7 @@ export interface AppScaffoldProgress {
|
|
|
772
458
|
*
|
|
773
459
|
* Declared on the manifest as the app's default. May be overridden per-installation.
|
|
774
460
|
*/
|
|
775
|
-
export type AppAccessControl =
|
|
461
|
+
export type AppAccessControl = z.infer<typeof AppAccessControlSchema>;
|
|
776
462
|
|
|
777
463
|
/**
|
|
778
464
|
* Resolve the effective access_control policy for an installed app:
|
|
@@ -790,162 +476,24 @@ export function effectiveAppAccessControl(
|
|
|
790
476
|
return installation?.access_control ?? manifest?.access_control ?? 'all';
|
|
791
477
|
}
|
|
792
478
|
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
title: string;
|
|
809
|
-
description: string;
|
|
810
|
-
publisher: string;
|
|
811
|
-
|
|
812
|
-
/**
|
|
813
|
-
* A svg icon for the app.
|
|
814
|
-
*/
|
|
815
|
-
icon?: string;
|
|
816
|
-
|
|
817
|
-
/**
|
|
818
|
-
* A color name to be used as the color of the app card (e.g. blue, red, green, etc.)
|
|
819
|
-
* If not specified a random color will be picked.
|
|
820
|
-
*/
|
|
821
|
-
color?: string;
|
|
822
|
-
|
|
823
|
-
/**
|
|
824
|
-
* Optional preview screenshot for the app-management UI, captured by the builder during a
|
|
825
|
-
* build/QA run. Resolved client-side from the owning agent run's artifact storage, so it
|
|
826
|
-
* carries both the run id and the artifact path.
|
|
827
|
-
*/
|
|
828
|
-
preview_screenshot?: {
|
|
829
|
-
/** Agent run id whose artifact storage holds the screenshot. */
|
|
830
|
-
agent_run_id: string;
|
|
831
|
-
/** Artifact path within that storage, e.g. "preview-checks/app-preview-<ts>.png". */
|
|
832
|
-
artifact: string;
|
|
833
|
-
};
|
|
834
|
-
|
|
835
|
-
status: 'beta' | 'stable' | 'deprecated';
|
|
836
|
-
|
|
837
|
-
/**
|
|
838
|
-
* The UI configuration of the app. If not specified and the app "ui" is in the app capabilities
|
|
839
|
-
* then the ui configuration will be fetched from the endpoint property.
|
|
840
|
-
*/
|
|
841
|
-
ui?: AppUIConfig;
|
|
842
|
-
|
|
843
|
-
/**
|
|
844
|
-
* A list of tool collections endpoints to be used by this app.
|
|
845
|
-
* Prefer using endpoint over tool_collections.
|
|
846
|
-
*/
|
|
847
|
-
tool_collections?: ToolCollectionObject[];
|
|
848
|
-
|
|
849
|
-
/**
|
|
850
|
-
* Named OAuth providers shared across multiple MCP tool collections.
|
|
851
|
-
* Keys must be kebab-case identifiers. Each value is an MCPOAuthConfig blueprint.
|
|
852
|
-
* Collections reference a provider via MCPToolCollectionObject.oauth_provider.
|
|
853
|
-
* One OAuth provider is created per provider at install time; all referencing
|
|
854
|
-
* collections share that app via AppInstallation.provider_bindings.
|
|
855
|
-
*/
|
|
856
|
-
oauth_providers?: Record<string, MCPOAuthConfig>;
|
|
857
|
-
|
|
858
|
-
/**
|
|
859
|
-
* An URL providing interactions definitions in JSON format.
|
|
860
|
-
* The URL must provide 2 endpoints:
|
|
861
|
-
* 1. GET URL - must return a JSON array with the list of interactions (as AppInteractionRef[])
|
|
862
|
-
* 2. GET URL/{interaction_name} - must return the full interaction definition for the specified interaction.
|
|
863
|
-
* This feature is for advanced composition of interactions. Prefer using endpoint.
|
|
864
|
-
*/
|
|
865
|
-
interactions?: string;
|
|
866
|
-
|
|
867
|
-
/**
|
|
868
|
-
* A JSON chema for the app installation settings.
|
|
869
|
-
* @deprecated Use endpoint to provide settings_schema instead
|
|
870
|
-
*/
|
|
871
|
-
settings_schema?: JSONSchema;
|
|
872
|
-
|
|
873
|
-
/** The following API is part of the second version of the manifest and deprectaes similar properties included directly in the manifest */
|
|
479
|
+
// QUARANTINED from the tenth batch, and the blocker is not in this file. A `//` comment rather than
|
|
480
|
+
// TSDoc on purpose: this component is still DERIVED, so a doc comment here would be published as its
|
|
481
|
+
// OpenAPI description.
|
|
482
|
+
//
|
|
483
|
+
// `settings_schema` is a `JSONSchema`, so making this component canonical pulls the registry's
|
|
484
|
+
// `JSONSchema` into the studio service — where the TypeScript-derived one publishes `type` as
|
|
485
|
+
// `JSONSchemaTypeName | JSONSchemaTypeName[]` while the canonical publishes `type: {}`. The
|
|
486
|
+
// generator refuses to publish a name that is both derived and canonical unless the two agree, and
|
|
487
|
+
// it is right to. The combined document already ships the canonical spelling (zeno reaches it
|
|
488
|
+
// through `ContentTypeIntakePolicy` and wins the merge), so what is left is a disagreement to settle
|
|
489
|
+
// in `@llumiverse/common`, not one to work around here.
|
|
490
|
+
//
|
|
491
|
+
// Everything this interface REFERENCES converted: the fields below now carry canonical components.
|
|
492
|
+
export type AppManifestData = z.infer<typeof AppManifestDataSchema>;
|
|
874
493
|
|
|
875
|
-
|
|
876
|
-
* Describe the capabiltities of this app - which kind of contributions it provides.
|
|
877
|
-
*/
|
|
878
|
-
capabilities?: AppCapabilities[];
|
|
494
|
+
export type AppGitSourceConfig = z.infer<typeof AppGitSourceConfigSchema>;
|
|
879
495
|
|
|
880
|
-
|
|
881
|
-
* The app endpoint URL
|
|
882
|
-
* This URL should return a JSON object describing the contributions provided by the app.
|
|
883
|
-
* The object shape must satisfies AppPackage interface.
|
|
884
|
-
* The endpoint must support GET method and a `scope` parameter to filter which resources are included in the returned AppPackage:
|
|
885
|
-
* The supported scope values are:
|
|
886
|
-
* - ui
|
|
887
|
-
* - tools
|
|
888
|
-
* - interactions
|
|
889
|
-
* - types
|
|
890
|
-
* - processes
|
|
891
|
-
* - templates
|
|
892
|
-
* - dashboards
|
|
893
|
-
* - settings
|
|
894
|
-
* - all (the default if no scope is provided)
|
|
895
|
-
* You can also use comma-separated values to combine scopes (e.g. "ui,tools").
|
|
896
|
-
*
|
|
897
|
-
* Example:
|
|
898
|
-
* - ?scope=ui,tools - returns only the UI configuration
|
|
899
|
-
*/
|
|
900
|
-
endpoint?: string;
|
|
901
|
-
|
|
902
|
-
/**
|
|
903
|
-
* Optional endpoint overrides keyed by environment name.
|
|
904
|
-
* When resolving the app endpoint, if the current environment name matches a key,
|
|
905
|
-
* the corresponding URL is used instead of the main `endpoint`.
|
|
906
|
-
* Only dev environment names are allowed as keys (starting with "desktop-" or "dev-").
|
|
907
|
-
*/
|
|
908
|
-
endpoint_overrides?: Record<string, string>;
|
|
909
|
-
|
|
910
|
-
/**
|
|
911
|
-
* Optional app version string (e.g. "1.0.0") — informational.
|
|
912
|
-
*/
|
|
913
|
-
version?: string;
|
|
914
|
-
|
|
915
|
-
/**
|
|
916
|
-
* Source repository configuration for apps generated and maintained through
|
|
917
|
-
* AppGen. Branches are mutable development lanes; immutable app versions
|
|
918
|
-
* record their exact source commit in AppVersionRecord.source_commit and
|
|
919
|
-
* AppVersionRecord.storage.source_git.
|
|
920
|
-
*/
|
|
921
|
-
source?: AppSourceConfig;
|
|
922
|
-
|
|
923
|
-
/**
|
|
924
|
-
* Free-form tags used for classification and filtering. Platform apps
|
|
925
|
-
* carry `"system"` so UIs can skip install/uninstall/manage-permission
|
|
926
|
-
* controls that don't apply to synthetic installations.
|
|
927
|
-
*/
|
|
928
|
-
tags?: string[];
|
|
929
|
-
|
|
930
|
-
/**
|
|
931
|
-
* Access control policy for the app. Defaults to 'all' (ACE-gated everywhere)
|
|
932
|
-
* when undefined. See {@link AppAccessControl} for semantics. May be overridden
|
|
933
|
-
* on the AppInstallation.
|
|
934
|
-
*/
|
|
935
|
-
access_control?: AppAccessControl;
|
|
936
|
-
}
|
|
937
|
-
|
|
938
|
-
export interface AppGitSourceConfig {
|
|
939
|
-
url?: string;
|
|
940
|
-
default_branch?: string;
|
|
941
|
-
production_branch?: string;
|
|
942
|
-
development_branch?: string;
|
|
943
|
-
}
|
|
944
|
-
|
|
945
|
-
export interface AppSourceConfig {
|
|
946
|
-
kind: 'git';
|
|
947
|
-
git?: AppGitSourceConfig;
|
|
948
|
-
}
|
|
496
|
+
export type AppSourceConfig = z.infer<typeof AppSourceConfigSchema>;
|
|
949
497
|
|
|
950
498
|
/**
|
|
951
499
|
* Deployment-time URL endpoints that can be referenced in app manifest URLs
|
|
@@ -992,23 +540,10 @@ function trimTrailingSlashes(value: string): string {
|
|
|
992
540
|
}
|
|
993
541
|
|
|
994
542
|
/** One entry in an app git-repo directory listing (see {@link AppRepoTree}). */
|
|
995
|
-
export
|
|
996
|
-
/** File or directory name (last path segment). */
|
|
997
|
-
name: string;
|
|
998
|
-
/** Path relative to the repo root. */
|
|
999
|
-
path: string;
|
|
1000
|
-
/** Whether the entry is a file (`blob`) or a directory (`tree`). */
|
|
1001
|
-
type: 'blob' | 'tree';
|
|
1002
|
-
}
|
|
543
|
+
export type AppRepoTreeEntry = z.infer<typeof AppRepoTreeEntrySchema>;
|
|
1003
544
|
|
|
1004
545
|
/** A non-recursive listing of an app git repo directory at a given ref. */
|
|
1005
|
-
export
|
|
1006
|
-
/** The ref the listing was read at (empty/undefined = default branch / HEAD). */
|
|
1007
|
-
ref?: string;
|
|
1008
|
-
/** The directory prefix that was listed (empty = repo root). */
|
|
1009
|
-
prefix?: string;
|
|
1010
|
-
entries: AppRepoTreeEntry[];
|
|
1011
|
-
}
|
|
546
|
+
export type AppRepoTree = z.infer<typeof AppRepoTreeSchema>;
|
|
1012
547
|
|
|
1013
548
|
/** Browser-side limits mirrored by the app Git service document endpoint. */
|
|
1014
549
|
export const APP_REPO_DOCUMENT_UPLOAD_MAX_FILE_BYTES = 20 * 1024 * 1024;
|
|
@@ -1017,87 +552,28 @@ export const APP_REPO_DOCUMENT_UPLOAD_MAX_FILES = 20;
|
|
|
1017
552
|
export const APP_REPO_DOCUMENT_UPLOAD_PREFIX = 'docs/';
|
|
1018
553
|
|
|
1019
554
|
/** Result of committing one or more uploaded documents to an app repository. */
|
|
1020
|
-
export
|
|
1021
|
-
/** Updated branch name. */
|
|
1022
|
-
ref: string;
|
|
1023
|
-
/** Branch HEAD before the commit. */
|
|
1024
|
-
previous_commit: string;
|
|
1025
|
-
/** Newly created commit SHA. */
|
|
1026
|
-
commit: string;
|
|
1027
|
-
/** Repository paths changed by the commit. */
|
|
1028
|
-
paths: string[];
|
|
1029
|
-
}
|
|
555
|
+
export type AppRepoDocumentCommit = z.infer<typeof AppRepoDocumentCommitSchema>;
|
|
1030
556
|
|
|
1031
557
|
/** One commit that inserted or changed a file in an app git repository. */
|
|
1032
|
-
export
|
|
1033
|
-
/** Full commit SHA. */
|
|
1034
|
-
commit: string;
|
|
1035
|
-
/** Complete commit message. */
|
|
1036
|
-
message: string;
|
|
1037
|
-
/** Commit author name, when available. */
|
|
1038
|
-
author?: string;
|
|
1039
|
-
/** Commit author date as an ISO-8601 string, when available. */
|
|
1040
|
-
date?: string;
|
|
1041
|
-
}
|
|
558
|
+
export type AppRepoCommit = z.infer<typeof AppRepoCommitSchema>;
|
|
1042
559
|
|
|
1043
560
|
/** Commit history in an app git repository, optionally filtered to a file. */
|
|
1044
|
-
export
|
|
1045
|
-
/** Ref from which history traversal started (empty/undefined = default branch / HEAD). */
|
|
1046
|
-
ref?: string;
|
|
1047
|
-
/** File path relative to the repository root, when history was filtered to a file. */
|
|
1048
|
-
path?: string;
|
|
1049
|
-
/** Commits ordered newest first. */
|
|
1050
|
-
commits: AppRepoCommit[];
|
|
1051
|
-
/** Pass this cursor to retrieve the next page. Absent when history is exhausted. */
|
|
1052
|
-
next_cursor?: string;
|
|
1053
|
-
}
|
|
561
|
+
export type AppRepoCommits = z.infer<typeof AppRepoCommitsSchema>;
|
|
1054
562
|
|
|
1055
563
|
/** A branch or tag in an app git repo, resolved to its latest commit. */
|
|
1056
|
-
export
|
|
1057
|
-
/** Short ref name (e.g. `main`, `v1.0.0`). */
|
|
1058
|
-
name: string;
|
|
1059
|
-
/** Commit hash the ref points at (annotated tags are peeled to their commit). */
|
|
1060
|
-
commit: string;
|
|
1061
|
-
/** First line of the commit message, when available. */
|
|
1062
|
-
commit_subject?: string;
|
|
1063
|
-
/** Commit date as an ISO-8601 string, when available. */
|
|
1064
|
-
commit_date?: string;
|
|
1065
|
-
/** Commit author name, when available. */
|
|
1066
|
-
commit_author?: string;
|
|
1067
|
-
}
|
|
564
|
+
export type AppRepoRef = z.infer<typeof AppRepoRefSchema>;
|
|
1068
565
|
|
|
1069
566
|
/** The branches and tags of an app git repo (see {@link AppRepoRef}). */
|
|
1070
|
-
export
|
|
1071
|
-
/** The repository's default branch (HEAD target), when resolvable. */
|
|
1072
|
-
default_branch?: string;
|
|
1073
|
-
branches: AppRepoRef[];
|
|
1074
|
-
tags: AppRepoRef[];
|
|
1075
|
-
}
|
|
567
|
+
export type AppRepoRefs = z.infer<typeof AppRepoRefsSchema>;
|
|
1076
568
|
|
|
1077
569
|
/** A mutable app development task represented by an `agent/*` Git branch. */
|
|
1078
|
-
export
|
|
1079
|
-
/** Task slug derived from the branch name. */
|
|
1080
|
-
id: string;
|
|
1081
|
-
/** Complete Git branch name. */
|
|
1082
|
-
branch: string;
|
|
1083
|
-
/** Commit currently at the branch head. */
|
|
1084
|
-
source_commit: string;
|
|
1085
|
-
/** Branch-head commit date, when available. */
|
|
1086
|
-
commit_date?: string;
|
|
1087
|
-
}
|
|
570
|
+
export type AppDevelopmentTask = z.infer<typeof AppDevelopmentTaskSchema>;
|
|
1088
571
|
|
|
1089
572
|
/** Git-backed development tasks and the branch used for new tasks by default. */
|
|
1090
|
-
export
|
|
1091
|
-
/** Repository default branch, when resolvable. */
|
|
1092
|
-
default_branch?: string;
|
|
1093
|
-
tasks: AppDevelopmentTask[];
|
|
1094
|
-
}
|
|
573
|
+
export type AppDevelopmentTaskList = z.infer<typeof AppDevelopmentTaskListSchema>;
|
|
1095
574
|
|
|
1096
575
|
/** Development task details, including the latest parent assistant run when one exists. */
|
|
1097
|
-
export
|
|
1098
|
-
/** Latest Studio Assistant run started for this task branch. */
|
|
1099
|
-
agent_run?: AgentRunSearchHit;
|
|
1100
|
-
}
|
|
576
|
+
export type AppDevelopmentTaskDetails = z.infer<typeof AppDevelopmentTaskDetailsSchema>;
|
|
1101
577
|
|
|
1102
578
|
/** Request to create a branch from an existing branch, tag, or commit. */
|
|
1103
579
|
export interface CreateAppRepoBranchRequest {
|
|
@@ -1106,11 +582,7 @@ export interface CreateAppRepoBranchRequest {
|
|
|
1106
582
|
}
|
|
1107
583
|
|
|
1108
584
|
/** A newly created app repository branch. */
|
|
1109
|
-
export
|
|
1110
|
-
name: string;
|
|
1111
|
-
commit: string;
|
|
1112
|
-
source_ref: string;
|
|
1113
|
-
}
|
|
585
|
+
export type AppRepoBranch = z.infer<typeof AppRepoBranchSchema>;
|
|
1114
586
|
|
|
1115
587
|
/**
|
|
1116
588
|
* Canonical package scopes, including the catch-all `all`. The public type is derived
|
|
@@ -1132,99 +604,18 @@ export const APP_PACKAGE_SCOPES = [
|
|
|
1132
604
|
] as const;
|
|
1133
605
|
|
|
1134
606
|
export type AppPackageScope = (typeof APP_PACKAGE_SCOPES)[number];
|
|
1135
|
-
export
|
|
1136
|
-
/**
|
|
1137
|
-
* The UI configuration of the app
|
|
1138
|
-
*/
|
|
1139
|
-
ui?: AppUIConfig;
|
|
1140
|
-
|
|
1141
|
-
/**
|
|
1142
|
-
* A list of tools exposed by the app.
|
|
1143
|
-
*/
|
|
1144
|
-
tools?: AgentToolDefinition[];
|
|
1145
|
-
|
|
1146
|
-
/**
|
|
1147
|
-
* A list of skills (`learn_*` tools) exposed by the app. Kept separate from
|
|
1148
|
-
* `tools` so clients can render them distinctly — consumers that don't care
|
|
1149
|
-
* (e.g. the worker building a combined tool registry) should concatenate
|
|
1150
|
-
* the two lists.
|
|
1151
|
-
*/
|
|
1152
|
-
skills?: AgentToolDefinition[];
|
|
1153
|
-
|
|
1154
|
-
/**
|
|
1155
|
-
* A list of interactions exposed by the app
|
|
1156
|
-
*/
|
|
1157
|
-
interactions?: CatalogInteractionRef[];
|
|
1158
|
-
|
|
1159
|
-
/**
|
|
1160
|
-
* A list of types.
|
|
1161
|
-
*/
|
|
1162
|
-
types?: InCodeTypeDefinition[];
|
|
1163
|
-
|
|
1164
|
-
/**
|
|
1165
|
-
* A list of process definitions exposed by the app.
|
|
1166
|
-
*/
|
|
1167
|
-
processes?: InCodeProcessDefinition[];
|
|
1168
|
-
|
|
1169
|
-
/**
|
|
1170
|
-
* View Experiences exposed by the app as in-code definitions.
|
|
1171
|
-
*/
|
|
1172
|
-
views?: InCodeViewDefinition[];
|
|
1173
|
-
|
|
1174
|
-
/**
|
|
1175
|
-
* Templates provided by the app.
|
|
1176
|
-
*/
|
|
1177
|
-
templates?: RenderingTemplateDefinitionRef[];
|
|
1178
|
-
|
|
1179
|
-
/**
|
|
1180
|
-
* Dashboards provided by the app.
|
|
1181
|
-
*/
|
|
1182
|
-
dashboards?: AppDashboardDefinition[];
|
|
1183
|
-
|
|
1184
|
-
/**
|
|
1185
|
-
* Widgets provided by the app.
|
|
1186
|
-
*/
|
|
1187
|
-
widgets?: Record<string, AppWidgetInfo>;
|
|
1188
|
-
|
|
1189
|
-
/**
|
|
1190
|
-
* Remote activities exposed by the app for use in DSL workflows.
|
|
1191
|
-
* Activities are discovered via `?scope=activities` and referenced in workflow steps
|
|
1192
|
-
* using colon-separated names: `app:<app_name>:<collection>:<activity_name>`.
|
|
1193
|
-
*/
|
|
1194
|
-
activities?: RemoteActivityDefinition[];
|
|
1195
|
-
|
|
1196
|
-
/**
|
|
1197
|
-
* A JSON chema for the app installation settings.
|
|
1198
|
-
*/
|
|
1199
|
-
settings_schema?: JSONSchema;
|
|
1200
|
-
}
|
|
607
|
+
export type AppPackage = z.infer<typeof AppPackageSchema>;
|
|
1201
608
|
|
|
1202
609
|
/**
|
|
1203
610
|
* A single diagnostic produced while inspecting an app's registration state.
|
|
1204
611
|
*/
|
|
1205
|
-
export
|
|
1206
|
-
severity: 'error' | 'warning';
|
|
1207
|
-
/** The capability this issue relates to, when applicable (e.g. 'types'). */
|
|
1208
|
-
capability?: AppPackageScope;
|
|
1209
|
-
/** Stable machine code, e.g. 'capability_declared_but_empty', 'endpoint_unreachable', 'not_installed'. */
|
|
1210
|
-
code: string;
|
|
1211
|
-
/** Human-readable explanation, safe to surface to the model and the UI. */
|
|
1212
|
-
message: string;
|
|
1213
|
-
}
|
|
612
|
+
export type AppInspectionIssue = z.infer<typeof AppInspectionIssueSchema>;
|
|
1214
613
|
|
|
1215
614
|
/**
|
|
1216
615
|
* Per-capability report of what an app's promoted package actually exposes,
|
|
1217
616
|
* compared against what its manifest declares.
|
|
1218
617
|
*/
|
|
1219
|
-
export
|
|
1220
|
-
capability: AppPackageScope;
|
|
1221
|
-
/** True when the manifest's `capabilities` array declares this capability. */
|
|
1222
|
-
declared: boolean;
|
|
1223
|
-
/** The local ids the promoted package actually serves for this capability. */
|
|
1224
|
-
exposed_ids: string[];
|
|
1225
|
-
/** Convenience count of `exposed_ids`. */
|
|
1226
|
-
exposed_count: number;
|
|
1227
|
-
}
|
|
618
|
+
export type AppInspectionCapabilityReport = z.infer<typeof AppInspectionCapabilityReportSchema>;
|
|
1228
619
|
|
|
1229
620
|
/**
|
|
1230
621
|
* Result of inspecting an app's registration: the resolved manifest state, what
|
|
@@ -1233,317 +624,91 @@ export interface AppInspectionCapabilityReport {
|
|
|
1233
624
|
* Build › App inspection UI to verify what is registered vs declared, instead of
|
|
1234
625
|
* inferring it from failed object/import calls.
|
|
1235
626
|
*/
|
|
1236
|
-
export
|
|
1237
|
-
app_id: string;
|
|
1238
|
-
name: string;
|
|
1239
|
-
version?: string;
|
|
1240
|
-
/** The resolved package endpoint for the current environment, if any. */
|
|
1241
|
-
endpoint?: string;
|
|
1242
|
-
/** True when the package endpoint responded to the capability probe. */
|
|
1243
|
-
endpoint_reachable: boolean;
|
|
1244
|
-
/** True when the app is installed in the current project. */
|
|
1245
|
-
installed: boolean;
|
|
1246
|
-
access_control?: string;
|
|
1247
|
-
/** The capabilities declared on the manifest. */
|
|
1248
|
-
capabilities: AppPackageScope[];
|
|
1249
|
-
/** What the promoted package exposes, per capability. */
|
|
1250
|
-
package: AppInspectionCapabilityReport[];
|
|
1251
|
-
/** Diagnostics — errors and warnings about the registration state. */
|
|
1252
|
-
issues: AppInspectionIssue[];
|
|
1253
|
-
/** Populated when the package probe itself failed (endpoint error/unreachable). */
|
|
1254
|
-
probe_error?: string;
|
|
1255
|
-
}
|
|
627
|
+
export type AppInspectionResult = z.infer<typeof AppInspectionResultSchema>;
|
|
1256
628
|
|
|
1257
|
-
export
|
|
1258
|
-
collection: string;
|
|
1259
|
-
skill: string;
|
|
1260
|
-
url: string;
|
|
1261
|
-
}
|
|
629
|
+
export type AppWidgetInfo = z.infer<typeof AppWidgetInfoSchema>;
|
|
1262
630
|
|
|
1263
|
-
export
|
|
1264
|
-
/** Unique template id: "collection:name" */
|
|
1265
|
-
id: string;
|
|
1266
|
-
/** Unique template name (kebab-case) */
|
|
1267
|
-
name: string;
|
|
1268
|
-
/** Display title */
|
|
1269
|
-
title?: string;
|
|
1270
|
-
/** Short description */
|
|
1271
|
-
description: string;
|
|
1272
|
-
/** Template type */
|
|
1273
|
-
type: 'presentation' | 'document';
|
|
1274
|
-
/** Tags for categorization */
|
|
1275
|
-
tags?: string[];
|
|
1276
|
-
/** Absolute paths to asset files */
|
|
1277
|
-
assets: string[];
|
|
1278
|
-
/** The template instructions (markdown) */
|
|
1279
|
-
instructions: string;
|
|
1280
|
-
}
|
|
631
|
+
export type RenderingTemplateDefinition = z.infer<typeof RenderingTemplateDefinitionSchema>;
|
|
1281
632
|
|
|
1282
|
-
export type RenderingTemplateDefinitionRef =
|
|
1283
|
-
/** Absolute API path to fetch the full template definition */
|
|
1284
|
-
path: string;
|
|
1285
|
-
};
|
|
633
|
+
export type RenderingTemplateDefinitionRef = z.infer<typeof RenderingTemplateDefinitionRefSchema>;
|
|
1286
634
|
|
|
1287
|
-
export
|
|
1288
|
-
id: string;
|
|
1289
|
-
/** The owning account. Undefined for apps imported from a master region. */
|
|
1290
|
-
account?: string;
|
|
1291
|
-
/** Source metadata for generated or synced app manifests. */
|
|
1292
|
-
source?: AppManifestSource;
|
|
1293
|
-
created_at: string;
|
|
1294
|
-
updated_at: string;
|
|
1295
|
-
}
|
|
635
|
+
export type AppManifest = z.infer<typeof AppManifestSchema>;
|
|
1296
636
|
|
|
1297
|
-
export
|
|
1298
|
-
kind: 'git';
|
|
1299
|
-
git: {
|
|
1300
|
-
url: string;
|
|
1301
|
-
default_branch?: string;
|
|
1302
|
-
production_branch?: string;
|
|
1303
|
-
development_branch?: string;
|
|
1304
|
-
};
|
|
1305
|
-
}
|
|
637
|
+
export type AppManifestSource = z.infer<typeof AppManifestSourceSchema>;
|
|
1306
638
|
|
|
1307
639
|
/**
|
|
1308
640
|
* Binding between an MCP collection and an OAuth provider created at install time.
|
|
1309
641
|
* Stored on AppInstallation so the runtime can look up the correct OAuth provider by ID,
|
|
1310
642
|
* independent of manifest oauth_provider references (which may change).
|
|
1311
643
|
*/
|
|
1312
|
-
export
|
|
1313
|
-
/**
|
|
1314
|
-
* Stable collection identifier: MCPToolCollectionObject.id for new manifests.
|
|
1315
|
-
* Legacy installations may still contain a name-based fallback value.
|
|
1316
|
-
*/
|
|
1317
|
-
collection_id: string;
|
|
1318
|
-
/**
|
|
1319
|
-
* MongoDB ObjectId of the OAuth provider in this project.
|
|
1320
|
-
* Used for ID-based lookups (rename-proof).
|
|
1321
|
-
*/
|
|
1322
|
-
oauth_provider_id: string;
|
|
1323
|
-
/**
|
|
1324
|
-
* Name of the OAuth provider at creation time.
|
|
1325
|
-
* Used by the workflow token path (getMCPClient → remoteMcpConnections.getToken) which looks up by name.
|
|
1326
|
-
*/
|
|
1327
|
-
oauth_provider_name: string;
|
|
1328
|
-
}
|
|
644
|
+
export type AppInstallationOAuthBinding = z.infer<typeof AppInstallationOAuthBindingSchema>;
|
|
1329
645
|
|
|
1330
646
|
/**
|
|
1331
647
|
* Binding between a named OAuth provider and the OAuth provider created for it at install time.
|
|
1332
648
|
* Stored on AppInstallation so the runtime can resolve the correct OAuth provider for collections
|
|
1333
649
|
* that reference a shared provider via MCPToolCollectionObject.oauth_provider.
|
|
1334
650
|
*/
|
|
1335
|
-
export
|
|
1336
|
-
/** Key from AppManifestData.oauth_providers */
|
|
1337
|
-
provider_key: string;
|
|
1338
|
-
/** MongoDB ObjectId of the created OAuth provider */
|
|
1339
|
-
oauth_provider_id: string;
|
|
1340
|
-
/** Name of the OAuth provider at creation time (for audit/display only) */
|
|
1341
|
-
oauth_provider_name: string;
|
|
1342
|
-
}
|
|
651
|
+
export type AppInstallationProviderBinding = z.infer<typeof AppInstallationProviderBindingSchema>;
|
|
1343
652
|
|
|
1344
|
-
export
|
|
1345
|
-
id: string;
|
|
1346
|
-
project: string; // the project where the app is installed
|
|
1347
|
-
manifest: string; // the app manifest
|
|
1348
|
-
settings?: Record<string, unknown>; // settings for the app installation
|
|
1349
|
-
/**
|
|
1350
|
-
* Admin-managed allowlist of tool names permitted for this installation.
|
|
1351
|
-
* When undefined, all tools from the app are permitted.
|
|
1352
|
-
* When set, only listed tool names are available for agent configuration and execution.
|
|
1353
|
-
*/
|
|
1354
|
-
tool_allowlist?: string[];
|
|
1355
|
-
/**
|
|
1356
|
-
* OAuth bindings created at install time via oauth_config provisioning.
|
|
1357
|
-
* Maps collection identity (id or name) → OAuth provider ObjectId.
|
|
1358
|
-
* Used by the runtime to resolve the correct OAuth provider without relying on manifest names.
|
|
1359
|
-
*/
|
|
1360
|
-
oauth_bindings?: AppInstallationOAuthBinding[];
|
|
1361
|
-
/**
|
|
1362
|
-
* OAuth bindings created at install time via oauth_providers provisioning.
|
|
1363
|
-
* Maps provider key → OAuth provider ObjectId.
|
|
1364
|
-
* Multiple collections sharing the same provider all resolve to the same OAuth provider.
|
|
1365
|
-
*/
|
|
1366
|
-
provider_bindings?: AppInstallationProviderBinding[];
|
|
1367
|
-
/**
|
|
1368
|
-
* Per-installation override of the manifest's access_control policy.
|
|
1369
|
-
* When set, takes precedence over the manifest value. When undefined, the
|
|
1370
|
-
* manifest value (or 'all' default) applies.
|
|
1371
|
-
*/
|
|
1372
|
-
access_control?: AppAccessControl;
|
|
1373
|
-
created_at: string;
|
|
1374
|
-
updated_at: string;
|
|
1375
|
-
}
|
|
653
|
+
export type AppInstallation = z.infer<typeof AppInstallationSchema>;
|
|
1376
654
|
|
|
1377
|
-
export
|
|
1378
|
-
manifest: AppManifest; // the app manifest data
|
|
1379
|
-
/**
|
|
1380
|
-
* Computed by the server: ids of MCP tool collections for this installation that require OAuth.
|
|
1381
|
-
* Accounts for all three signals: manifest auth:'oauth', manifest oauth_app, and oauth_bindings.
|
|
1382
|
-
* Populated by the GET /installations/all endpoint.
|
|
1383
|
-
*/
|
|
1384
|
-
oauth_collection_ids?: string[];
|
|
1385
|
-
}
|
|
655
|
+
export type AppInstallationWithManifest = z.infer<typeof AppInstallationWithManifestSchema>;
|
|
1386
656
|
|
|
1387
|
-
export
|
|
1388
|
-
manifest: AppManifest | null;
|
|
1389
|
-
oauth_collection_ids?: string[];
|
|
1390
|
-
}
|
|
657
|
+
export type AppInstallationListEntry = z.infer<typeof AppInstallationListEntrySchema>;
|
|
1391
658
|
|
|
1392
659
|
export interface OrphanedAppInstallation extends Omit<AppInstallation, 'manifest'> {
|
|
1393
660
|
manifest: null;
|
|
1394
661
|
}
|
|
1395
662
|
|
|
1396
|
-
export
|
|
1397
|
-
client_id?: string;
|
|
1398
|
-
client_secret?: string;
|
|
1399
|
-
scopes?: string[];
|
|
1400
|
-
}
|
|
663
|
+
export type OAuthClientCredentials = z.infer<typeof OAuthClientCredentialsSchema>;
|
|
1401
664
|
|
|
1402
|
-
export type AppOAuthCollectionParams =
|
|
1403
|
-
export type AppOAuthProviderParams =
|
|
665
|
+
export type AppOAuthCollectionParams = z.infer<typeof AppOAuthCollectionParamsSchema>;
|
|
666
|
+
export type AppOAuthProviderParams = z.infer<typeof AppOAuthProviderParamsSchema>;
|
|
1404
667
|
|
|
1405
|
-
export
|
|
1406
|
-
app_id: string;
|
|
1407
|
-
settings?: Record<string, unknown>;
|
|
1408
|
-
/**
|
|
1409
|
-
* Per-installation override of the manifest's `access_control` policy. When provided, takes precedence
|
|
1410
|
-
* over the manifest default for every access check. Sibling of `settings` — admin-controlled, not
|
|
1411
|
-
* part of the app's own settings JSON.
|
|
1412
|
-
*
|
|
1413
|
-
* Three send-time semantics on update:
|
|
1414
|
-
* - Field omitted entirely from the payload → leave the existing override unchanged.
|
|
1415
|
-
* - Explicit `null` → clear the override, fall back to the manifest default.
|
|
1416
|
-
* - String enum → set the override to that value.
|
|
1417
|
-
*
|
|
1418
|
-
* (On install, the same shape applies; omit or pass `null` to use the manifest default.)
|
|
1419
|
-
*/
|
|
1420
|
-
access_control?: AppAccessControl | null;
|
|
1421
|
-
/**
|
|
1422
|
-
* OAuth credentials for each collection, keyed by collection.id.
|
|
1423
|
-
* Legacy callers may still use collection.name for older manifests.
|
|
1424
|
-
* Collected from the user at install time for collections with oauth_config.required_at_install.
|
|
1425
|
-
*/
|
|
1426
|
-
oauth_params?: AppOAuthCollectionParams;
|
|
1427
|
-
/**
|
|
1428
|
-
* OAuth credentials for named providers, keyed by the provider key from oauth_providers.
|
|
1429
|
-
* Collected from the user at install time for providers with required_at_install.
|
|
1430
|
-
* Separate from oauth_params to avoid key collisions between provider keys and collection ids.
|
|
1431
|
-
*/
|
|
1432
|
-
oauth_provider_params?: AppOAuthProviderParams;
|
|
1433
|
-
}
|
|
668
|
+
export type AppInstallationPayload = z.infer<typeof AppInstallationPayloadSchema>;
|
|
1434
669
|
|
|
1435
|
-
export
|
|
1436
|
-
tool_allowlist: string[] | null;
|
|
1437
|
-
}
|
|
670
|
+
export type UpdateAppInstallationToolAllowlistPayload = z.infer<typeof UpdateAppInstallationToolAllowlistPayloadSchema>;
|
|
1438
671
|
|
|
1439
|
-
export type AppInstallationKind =
|
|
672
|
+
export type AppInstallationKind = z.infer<typeof AppInstallationKindSchema>;
|
|
1440
673
|
|
|
1441
674
|
/**
|
|
1442
675
|
* A description of the tools provided by an app
|
|
1443
676
|
*/
|
|
1444
|
-
export
|
|
1445
|
-
/**
|
|
1446
|
-
* The collection name
|
|
1447
|
-
*/
|
|
1448
|
-
name: string;
|
|
1449
|
-
|
|
1450
|
-
/**
|
|
1451
|
-
* Optional collection description
|
|
1452
|
-
*/
|
|
1453
|
-
description?: string;
|
|
1454
|
-
|
|
1455
|
-
/**
|
|
1456
|
-
* the tools provided by this collection
|
|
1457
|
-
*/
|
|
1458
|
-
tools: AgentToolDefinition[];
|
|
1459
|
-
}
|
|
677
|
+
export type AppToolCollection = z.infer<typeof AppToolCollectionSchema>;
|
|
1460
678
|
|
|
1461
679
|
/**
|
|
1462
|
-
*
|
|
1463
|
-
*
|
|
680
|
+
* A tool and the app installation that provides it, inferred from `./api-schemas/project.js` — the
|
|
681
|
+
* module that owns it, because it converted with the Projects batch rather than with Apps.
|
|
1464
682
|
*/
|
|
1465
|
-
export
|
|
1466
|
-
/**
|
|
1467
|
-
* The tool name
|
|
1468
|
-
*/
|
|
1469
|
-
tool_name: string;
|
|
1470
|
-
|
|
1471
|
-
/**
|
|
1472
|
-
* Optional tool description
|
|
1473
|
-
*/
|
|
1474
|
-
tool_description?: string;
|
|
1475
|
-
|
|
1476
|
-
/**
|
|
1477
|
-
* The app name that provides this tool
|
|
1478
|
-
*/
|
|
1479
|
-
app_name: string;
|
|
1480
|
-
|
|
1481
|
-
/**
|
|
1482
|
-
* The app installation ID
|
|
1483
|
-
*/
|
|
1484
|
-
app_install_id: string;
|
|
1485
|
-
|
|
1486
|
-
/**
|
|
1487
|
-
* The app installation settings.
|
|
1488
|
-
* Only included for agent tokens, not user tokens (security: may contain API keys).
|
|
1489
|
-
*/
|
|
1490
|
-
settings?: Record<string, unknown>;
|
|
1491
|
-
}
|
|
683
|
+
export type ProjectToolInfo = z.infer<typeof ProjectToolInfoSchema>;
|
|
1492
684
|
|
|
1493
685
|
/**
|
|
1494
686
|
* OAuth authentication status for an MCP tool collection
|
|
1495
687
|
*/
|
|
1496
|
-
export
|
|
1497
|
-
collection_id: string;
|
|
1498
|
-
collection_name: string;
|
|
1499
|
-
authenticated: boolean;
|
|
1500
|
-
mcp_server_url: string;
|
|
1501
|
-
expires_at?: string;
|
|
1502
|
-
scope?: string;
|
|
1503
|
-
}
|
|
688
|
+
export type OAuthAuthStatus = z.infer<typeof OAuthAuthStatusSchema>;
|
|
1504
689
|
|
|
1505
690
|
/**
|
|
1506
691
|
* Response from OAuth authorization endpoint
|
|
1507
692
|
*/
|
|
1508
|
-
export
|
|
1509
|
-
authorization_url?: string;
|
|
1510
|
-
state?: string;
|
|
1511
|
-
connected?: boolean;
|
|
1512
|
-
}
|
|
693
|
+
export type OAuthAuthorizeResponse = z.infer<typeof OAuthAuthorizeResponseSchema>;
|
|
1513
694
|
|
|
1514
695
|
export interface McpOAuthCollectionRef {
|
|
1515
696
|
app_install_id: string;
|
|
1516
697
|
collection_id: string;
|
|
1517
698
|
}
|
|
1518
699
|
|
|
1519
|
-
export
|
|
1520
|
-
app_install_id?: string;
|
|
1521
|
-
collection_id?: string;
|
|
1522
|
-
mcp_server_url?: string;
|
|
1523
|
-
}
|
|
700
|
+
export type McpOAuthTokenRequest = z.infer<typeof McpOAuthTokenRequestSchema>;
|
|
1524
701
|
|
|
1525
|
-
export
|
|
1526
|
-
access_token: string;
|
|
1527
|
-
}
|
|
702
|
+
export type McpOAuthTokenResponse = z.infer<typeof McpOAuthTokenResponseSchema>;
|
|
1528
703
|
|
|
1529
|
-
export
|
|
1530
|
-
success: boolean;
|
|
1531
|
-
}
|
|
704
|
+
export type McpOAuthConnectResponse = z.infer<typeof McpOAuthConnectResponseSchema>;
|
|
1532
705
|
|
|
1533
|
-
export
|
|
1534
|
-
success: boolean;
|
|
1535
|
-
message: string;
|
|
1536
|
-
}
|
|
706
|
+
export type McpOAuthDisconnectResponse = z.infer<typeof McpOAuthDisconnectResponseSchema>;
|
|
1537
707
|
|
|
1538
708
|
/**
|
|
1539
709
|
* Response from OAuth metadata endpoint
|
|
1540
710
|
*/
|
|
1541
|
-
export
|
|
1542
|
-
collection_id: string;
|
|
1543
|
-
collection_name: string;
|
|
1544
|
-
mcp_server_url: string;
|
|
1545
|
-
metadata: JSONObject;
|
|
1546
|
-
}
|
|
711
|
+
export type OAuthMetadataResponse = z.infer<typeof OAuthMetadataResponseSchema>;
|
|
1547
712
|
|
|
1548
713
|
// ============================================================================
|
|
1549
714
|
// CompositeApp Shell Configuration Types
|
|
@@ -1555,46 +720,24 @@ export interface OAuthMetadataResponse {
|
|
|
1555
720
|
* Configuration entry for an individual app in the CompositeApp shell.
|
|
1556
721
|
* References an app installation by name.
|
|
1557
722
|
*/
|
|
1558
|
-
export
|
|
1559
|
-
/** App installation name (must match an installed app) */
|
|
1560
|
-
appName: string;
|
|
1561
|
-
}
|
|
723
|
+
export type CompositeAppEntry = z.infer<typeof CompositeAppEntrySchema>;
|
|
1562
724
|
|
|
1563
725
|
/**
|
|
1564
726
|
* Logo overrides for the CompositeApp shell header.
|
|
1565
727
|
* When provided, these URLs replace the default Vertesia logo.
|
|
1566
728
|
*/
|
|
1567
|
-
export
|
|
1568
|
-
/** URL for light mode logo (overrides default Vertesia logo) */
|
|
1569
|
-
lightModeUrl?: string;
|
|
1570
|
-
/** URL for dark mode logo (overrides default Vertesia logo) */
|
|
1571
|
-
darkModeUrl?: string;
|
|
1572
|
-
/** Whether to hide the Vertesia footer logo in the sidebar when header logo is overridden (defaults to false) */
|
|
1573
|
-
hideFooterLogo?: boolean;
|
|
1574
|
-
}
|
|
729
|
+
export type CompositeAppLogoOverrides = z.infer<typeof CompositeAppLogoOverridesSchema>;
|
|
1575
730
|
|
|
1576
731
|
/**
|
|
1577
732
|
* Message banner overrides for the shell header.
|
|
1578
733
|
*/
|
|
1579
|
-
export type CompositeAppMessageStyle =
|
|
1580
|
-
export
|
|
1581
|
-
/** Message text to display */
|
|
1582
|
-
text?: string;
|
|
1583
|
-
/** Whether the message is visible (defaults to true) */
|
|
1584
|
-
visible?: boolean;
|
|
1585
|
-
/** Text color style. Uses semantic colors */
|
|
1586
|
-
style?: CompositeAppMessageStyle;
|
|
1587
|
-
}
|
|
734
|
+
export type CompositeAppMessageStyle = z.infer<typeof CompositeAppMessageStyleSchema>;
|
|
735
|
+
export type CompositeAppMessageOverrides = z.infer<typeof CompositeAppMessageOverridesSchema>;
|
|
1588
736
|
|
|
1589
737
|
/**
|
|
1590
738
|
* Switcher visibility overrides for the CompositeApp header.
|
|
1591
739
|
*/
|
|
1592
|
-
export
|
|
1593
|
-
/** Whether to hide the organization switcher (defaults to false) */
|
|
1594
|
-
hideOrganization?: boolean;
|
|
1595
|
-
/** Whether to hide the project switcher (defaults to false) */
|
|
1596
|
-
hideProject?: boolean;
|
|
1597
|
-
}
|
|
740
|
+
export type CompositeAppSwitchersOverrides = z.infer<typeof CompositeAppSwitchersOverridesSchema>;
|
|
1598
741
|
|
|
1599
742
|
/**
|
|
1600
743
|
* Header button visibility overrides for the CompositeApp header.
|
|
@@ -1603,14 +746,7 @@ export interface CompositeAppSwitchersOverrides {
|
|
|
1603
746
|
* Retained for backward compatibility and to seed the default header menu when no
|
|
1604
747
|
* `headerMenu` has been configured yet.
|
|
1605
748
|
*/
|
|
1606
|
-
export
|
|
1607
|
-
/** Whether to hide the App Portal button (defaults to false) */
|
|
1608
|
-
hideAppPortal?: boolean;
|
|
1609
|
-
/** Whether to hide the Docs button (defaults to false) */
|
|
1610
|
-
hideDocs?: boolean;
|
|
1611
|
-
/** Whether to hide the Help button (defaults to false) */
|
|
1612
|
-
hideHelp?: boolean;
|
|
1613
|
-
}
|
|
749
|
+
export type CompositeAppHeaderOverrides = z.infer<typeof CompositeAppHeaderOverridesSchema>;
|
|
1614
750
|
|
|
1615
751
|
/**
|
|
1616
752
|
* User menu overrides for the CompositeApp.
|
|
@@ -1619,32 +755,17 @@ export interface CompositeAppHeaderOverrides {
|
|
|
1619
755
|
* Retained for backward compatibility and to seed the default header menu when no
|
|
1620
756
|
* `headerMenu` has been configured yet.
|
|
1621
757
|
*/
|
|
1622
|
-
export
|
|
1623
|
-
/** Whether to hide the User Menu (defaults to false) */
|
|
1624
|
-
hidden?: boolean;
|
|
1625
|
-
}
|
|
758
|
+
export type CompositeAppUserMenuOverrides = z.infer<typeof CompositeAppUserMenuOverridesSchema>;
|
|
1626
759
|
|
|
1627
760
|
/**
|
|
1628
761
|
* Theme overrides for the CompositeApp.
|
|
1629
762
|
*/
|
|
1630
|
-
export
|
|
1631
|
-
/** When true, forces light mode and disables dark mode (defaults to false) */
|
|
1632
|
-
disableDarkMode?: boolean;
|
|
1633
|
-
}
|
|
763
|
+
export type CompositeAppThemeOverrides = z.infer<typeof CompositeAppThemeOverridesSchema>;
|
|
1634
764
|
|
|
1635
765
|
/**
|
|
1636
766
|
* Sidebar display overrides for the CompositeApp.
|
|
1637
767
|
*/
|
|
1638
|
-
export
|
|
1639
|
-
/** Whether to hide section title headers in the sidebar (defaults to false) */
|
|
1640
|
-
hideSectionHeaders?: boolean;
|
|
1641
|
-
/** Whether menu items auto-collapse when navigating (accordion behavior). When false, all items stay expanded. Defaults to true. */
|
|
1642
|
-
autoCollapse?: boolean;
|
|
1643
|
-
/** Whether settings section items auto-collapse when navigating. Independent of autoCollapse which handles all other items. Defaults to true. */
|
|
1644
|
-
autoCollapseSettings?: boolean;
|
|
1645
|
-
/** Whether footer section items auto-collapse when navigating. Independent of autoCollapse which handles all other items. Defaults to true. */
|
|
1646
|
-
autoCollapseFooter?: boolean;
|
|
1647
|
-
}
|
|
768
|
+
export type CompositeAppSidebarOverrides = z.infer<typeof CompositeAppSidebarOverridesSchema>;
|
|
1648
769
|
|
|
1649
770
|
/**
|
|
1650
771
|
* Card display overrides for the CompositeApp in the App Portal.
|
|
@@ -1652,18 +773,7 @@ export interface CompositeAppSidebarOverrides {
|
|
|
1652
773
|
* Allows customers to customize the app portal card (not otherwise possible if using a
|
|
1653
774
|
* shared, Vertesia-managed manifest across accounts).
|
|
1654
775
|
*/
|
|
1655
|
-
export
|
|
1656
|
-
/** Whether to show the CompositeApp card in App Portal (default: false) */
|
|
1657
|
-
visible?: boolean;
|
|
1658
|
-
/** Override the card label (default: "Composite App") */
|
|
1659
|
-
label?: string;
|
|
1660
|
-
/** Override the card description */
|
|
1661
|
-
description?: string;
|
|
1662
|
-
/** Override the card icon (Lucide icon name or SVG content string) */
|
|
1663
|
-
icon?: string;
|
|
1664
|
-
/** Override the card color (e.g., "blue", "red", "purple") */
|
|
1665
|
-
color?: string;
|
|
1666
|
-
}
|
|
776
|
+
export type CompositeAppCardOverrides = z.infer<typeof CompositeAppCardOverridesSchema>;
|
|
1667
777
|
|
|
1668
778
|
// ============================================================================
|
|
1669
779
|
// Sidebar Menu Types
|
|
@@ -1676,14 +786,7 @@ export interface CompositeAppCardOverrides {
|
|
|
1676
786
|
* access is granted when the user matches ANY list (OR logic).
|
|
1677
787
|
* All empty/absent means visible to everyone. Admin users bypass all checks.
|
|
1678
788
|
*/
|
|
1679
|
-
export
|
|
1680
|
-
/** Group IDs whose members can see this item. */
|
|
1681
|
-
groupsAllowed?: string[];
|
|
1682
|
-
/** User IDs who can see this item. */
|
|
1683
|
-
usersAllowed?: string[];
|
|
1684
|
-
/** SystemRoles values (e.g. "developer", "manager") whose holders can see this item. */
|
|
1685
|
-
rolesAllowed?: string[];
|
|
1686
|
-
}
|
|
789
|
+
export type CompositeAppNavItemPermissions = z.infer<typeof CompositeAppNavItemPermissionsSchema>;
|
|
1687
790
|
|
|
1688
791
|
/**
|
|
1689
792
|
* A navigable item in the sidebar menu.
|
|
@@ -1721,23 +824,9 @@ export interface CompositeAppMenuNavItem {
|
|
|
1721
824
|
* A top-level section heading in the sidebar menu.
|
|
1722
825
|
* Sections are always at root level and contain nav-items.
|
|
1723
826
|
*/
|
|
1724
|
-
export
|
|
1725
|
-
/** Stable unique identifier */
|
|
1726
|
-
id: string;
|
|
1727
|
-
/** Section heading label */
|
|
1728
|
-
label: string;
|
|
1729
|
-
/** When true, this section and its items are hidden from the sidebar */
|
|
1730
|
-
hidden?: boolean;
|
|
1731
|
-
/** Ordered nav-items within this section */
|
|
1732
|
-
items: CompositeAppMenuNavItem[];
|
|
1733
|
-
}
|
|
827
|
+
export type CompositeAppMenuSection = z.infer<typeof CompositeAppMenuSectionSchema>;
|
|
1734
828
|
|
|
1735
|
-
export
|
|
1736
|
-
/** The app name to use as the home page */
|
|
1737
|
-
appName: string;
|
|
1738
|
-
/** Optional route within the app (e.g. "/dashboard"). Defaults to "/" */
|
|
1739
|
-
appRoute?: string;
|
|
1740
|
-
}
|
|
829
|
+
export type CompositeAppHomePlugin = z.infer<typeof CompositeAppHomePluginSchema>;
|
|
1741
830
|
|
|
1742
831
|
// ============================================================================
|
|
1743
832
|
// Header Menu Types
|
|
@@ -1749,10 +838,10 @@ export interface CompositeAppHomePlugin {
|
|
|
1749
838
|
* header and cannot be deleted (only hidden/customized); `custom` items are fully
|
|
1750
839
|
* user-defined buttons.
|
|
1751
840
|
*/
|
|
1752
|
-
export type CompositeAppHeaderItemKind =
|
|
841
|
+
export type CompositeAppHeaderItemKind = z.infer<typeof CompositeAppHeaderItemKindSchema>;
|
|
1753
842
|
|
|
1754
843
|
/** Where a header link opens. */
|
|
1755
|
-
export type CompositeAppHeaderItemTarget =
|
|
844
|
+
export type CompositeAppHeaderItemTarget = z.infer<typeof CompositeAppHeaderItemTargetSchema>;
|
|
1756
845
|
|
|
1757
846
|
/** Stable identifiers for the built-in header items. */
|
|
1758
847
|
export const COMPOSITE_APP_HEADER_BUILTIN_IDS = ['app_portal', 'docs', 'help', 'user_menu'] as const;
|
|
@@ -1765,88 +854,20 @@ export const COMPOSITE_APP_HEADER_BUILTIN_IDS = ['app_portal', 'docs', 'help', '
|
|
|
1765
854
|
* The `user_menu` item is special — it renders the account dropdown, so its `icon`,
|
|
1766
855
|
* `href`, and `target` are ignored.
|
|
1767
856
|
*/
|
|
1768
|
-
export
|
|
1769
|
-
/** Stable unique identifier. Built-ins use their kind as id (e.g. "app_portal"). */
|
|
1770
|
-
id: string;
|
|
1771
|
-
/** Item kind. `custom` for user-added buttons; otherwise one of the four built-ins. */
|
|
1772
|
-
kind: CompositeAppHeaderItemKind;
|
|
1773
|
-
/** Display label, used as the button tooltip / accessible name. */
|
|
1774
|
-
label: string;
|
|
1775
|
-
/** Lucide icon name or SVG content string. Ignored for `user_menu`. */
|
|
1776
|
-
icon?: string;
|
|
1777
|
-
/** Destination route ("/...") or external URL. Ignored for `user_menu`. */
|
|
1778
|
-
href?: string;
|
|
1779
|
-
/** Where to open the link (defaults to "_self"). Ignored for `user_menu`. */
|
|
1780
|
-
target?: CompositeAppHeaderItemTarget;
|
|
1781
|
-
/** When true, this item is hidden from the header. */
|
|
1782
|
-
hidden?: boolean;
|
|
1783
|
-
/** Optional access control settings for this header item. */
|
|
1784
|
-
permissions?: CompositeAppNavItemPermissions;
|
|
1785
|
-
}
|
|
857
|
+
export type CompositeAppHeaderItem = z.infer<typeof CompositeAppHeaderItemSchema>;
|
|
1786
858
|
|
|
1787
859
|
/**
|
|
1788
860
|
* CompositeApp shell configuration.
|
|
1789
861
|
* This is the main configuration interface for storing CompositeApp settings.
|
|
1790
862
|
* Used as the MongoDB model for persisting CompositeApp configurations.
|
|
1791
863
|
*/
|
|
1792
|
-
export
|
|
1793
|
-
/**
|
|
1794
|
-
* The unique identifier for this CompositeApp configuration
|
|
1795
|
-
* Undefined if the configuration doesn't exists yet.
|
|
1796
|
-
*/
|
|
1797
|
-
id?: string;
|
|
1798
|
-
/** The project this CompositeApp belongs to */
|
|
1799
|
-
project: string;
|
|
1800
|
-
/** Card display overrides (includes visibility) */
|
|
1801
|
-
card?: CompositeAppCardOverrides;
|
|
1802
|
-
/** Optional logo overrides (replaces default Vertesia logo) */
|
|
1803
|
-
logo?: CompositeAppLogoOverrides;
|
|
1804
|
-
/** Optional message banner overrides */
|
|
1805
|
-
message?: CompositeAppMessageOverrides;
|
|
1806
|
-
/** Optional switcher visibility overrides */
|
|
1807
|
-
switchers?: CompositeAppSwitchersOverrides;
|
|
1808
|
-
/** Optional sidebar display overrides */
|
|
1809
|
-
sidebar?: CompositeAppSidebarOverrides;
|
|
1810
|
-
/**
|
|
1811
|
-
* @deprecated Use `headerMenu` instead. Optional header button visibility overrides.
|
|
1812
|
-
* Still read to seed `headerMenu` defaults for configs saved before the header menu existed.
|
|
1813
|
-
*/
|
|
1814
|
-
header?: CompositeAppHeaderOverrides;
|
|
1815
|
-
/**
|
|
1816
|
-
* @deprecated Use the `user_menu` item in `headerMenu` instead. Optional user menu overrides.
|
|
1817
|
-
* Still read to seed `headerMenu` defaults for configs saved before the header menu existed.
|
|
1818
|
-
*/
|
|
1819
|
-
userMenu?: CompositeAppUserMenuOverrides;
|
|
1820
|
-
/**
|
|
1821
|
-
* Optional free-form header menu. When present, the header renders from this ordered
|
|
1822
|
-
* list instead of the legacy `header`/`userMenu` flags. Built-in items (App Portal,
|
|
1823
|
-
* Docs, Help, User Menu) can be hidden/relabeled/re-icon'd/redirected; custom items
|
|
1824
|
-
* are arbitrary buttons.
|
|
1825
|
-
*/
|
|
1826
|
-
headerMenu?: CompositeAppHeaderItem[];
|
|
1827
|
-
/** Optional theme overrides (e.g. disable dark mode) */
|
|
1828
|
-
theme?: CompositeAppThemeOverrides;
|
|
1829
|
-
/** Optional home page override. When set, redirects "/" to the specified app route instead of the dashboard. Send null to unset. */
|
|
1830
|
-
homePlugin?: CompositeAppHomePlugin | null;
|
|
1831
|
-
/** List of apps to include in the CompositeApp (used for installation tracking and fallback sidebar) */
|
|
1832
|
-
apps: CompositeAppEntry[];
|
|
1833
|
-
/**
|
|
1834
|
-
* Optional sidebar menu. When present, the sidebar renders from this
|
|
1835
|
-
* instead of the apps-based pipeline. Top-level array is sections;
|
|
1836
|
-
* each section contains nav-items.
|
|
1837
|
-
*/
|
|
1838
|
-
menu?: CompositeAppMenuSection[];
|
|
1839
|
-
}
|
|
864
|
+
export type CompositeAppConfig = z.infer<typeof CompositeAppConfigSchema>;
|
|
1840
865
|
|
|
1841
|
-
export type CompositeAppConfigPayload =
|
|
866
|
+
export type CompositeAppConfigPayload = z.infer<typeof CompositeAppConfigPayloadSchema>;
|
|
1842
867
|
|
|
1843
|
-
export
|
|
1844
|
-
url: string;
|
|
1845
|
-
}
|
|
868
|
+
export type ValidateUrlRequest = z.infer<typeof ValidateUrlRequestSchema>;
|
|
1846
869
|
|
|
1847
|
-
export
|
|
1848
|
-
valid: true;
|
|
1849
|
-
}
|
|
870
|
+
export type ValidateUrlResponse = z.infer<typeof ValidateUrlResponseSchema>;
|
|
1850
871
|
|
|
1851
872
|
/**
|
|
1852
873
|
* Result of DELETE /api/v1/apps/:id. With `?confirm=true` the cascade runs and
|