@frontmcp/sdk 0.4.0 → 0.5.0
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/README.md +30 -18
- package/package.json +20 -5
- package/src/app/app.registry.d.ts +3 -2
- package/src/app/app.registry.js +3 -1
- package/src/app/app.registry.js.map +1 -1
- package/src/app/instances/app.local.instance.js +2 -2
- package/src/app/instances/app.local.instance.js.map +1 -1
- package/src/auth/auth.registry.d.ts +34 -2
- package/src/auth/auth.registry.js +162 -24
- package/src/auth/auth.registry.js.map +1 -1
- package/src/auth/auth.utils.js +8 -9
- package/src/auth/auth.utils.js.map +1 -1
- package/src/auth/authorization/authorization.class.d.ts +125 -0
- package/src/auth/authorization/authorization.class.js +224 -0
- package/src/auth/authorization/authorization.class.js.map +1 -0
- package/src/auth/authorization/authorization.types.d.ts +300 -0
- package/src/auth/authorization/authorization.types.js +79 -0
- package/src/auth/authorization/authorization.types.js.map +1 -0
- package/src/auth/authorization/index.d.ts +5 -0
- package/src/auth/authorization/index.js +19 -0
- package/src/auth/authorization/index.js.map +1 -0
- package/src/auth/authorization/orchestrated.authorization.d.ts +242 -0
- package/src/auth/authorization/orchestrated.authorization.js +306 -0
- package/src/auth/authorization/orchestrated.authorization.js.map +1 -0
- package/src/auth/authorization/public.authorization.d.ts +91 -0
- package/src/auth/authorization/public.authorization.js +132 -0
- package/src/auth/authorization/public.authorization.js.map +1 -0
- package/src/auth/authorization/transparent.authorization.d.ts +130 -0
- package/src/auth/authorization/transparent.authorization.js +147 -0
- package/src/auth/authorization/transparent.authorization.js.map +1 -0
- package/src/auth/consent/consent.types.d.ts +111 -0
- package/src/auth/consent/consent.types.js +119 -0
- package/src/auth/consent/consent.types.js.map +1 -0
- package/src/auth/consent/index.d.ts +1 -0
- package/src/auth/consent/index.js +13 -0
- package/src/auth/consent/index.js.map +1 -0
- package/src/auth/detection/auth-provider-detection.d.ts +84 -0
- package/src/auth/detection/auth-provider-detection.js +230 -0
- package/src/auth/detection/auth-provider-detection.js.map +1 -0
- package/src/auth/detection/index.d.ts +1 -0
- package/src/auth/detection/index.js +15 -0
- package/src/auth/detection/index.js.map +1 -0
- package/src/auth/flows/auth.verify.flow.d.ts +110 -0
- package/src/auth/flows/auth.verify.flow.js +379 -0
- package/src/auth/flows/auth.verify.flow.js.map +1 -0
- package/src/auth/flows/oauth.authorize.flow.d.ts +118 -164
- package/src/auth/flows/oauth.authorize.flow.js +701 -33
- package/src/auth/flows/oauth.authorize.flow.js.map +1 -1
- package/src/auth/flows/oauth.callback.flow.d.ts +117 -0
- package/src/auth/flows/oauth.callback.flow.js +357 -0
- package/src/auth/flows/oauth.callback.flow.js.map +1 -0
- package/src/auth/flows/oauth.register.flow.d.ts +32 -125
- package/src/auth/flows/oauth.token.flow.d.ts +52 -154
- package/src/auth/flows/oauth.token.flow.js +193 -55
- package/src/auth/flows/oauth.token.flow.js.map +1 -1
- package/src/auth/flows/session.verify.flow.d.ts +66 -321
- package/src/auth/flows/session.verify.flow.js +107 -18
- package/src/auth/flows/session.verify.flow.js.map +1 -1
- package/src/auth/flows/well-known.jwks.flow.d.ts +34 -205
- package/src/auth/flows/well-known.jwks.flow.js +15 -8
- package/src/auth/flows/well-known.jwks.flow.js.map +1 -1
- package/src/auth/flows/well-known.oauth-authorization-server.flow.d.ts +48 -223
- package/src/auth/flows/well-known.oauth-authorization-server.flow.js +2 -3
- package/src/auth/flows/well-known.oauth-authorization-server.flow.js.map +1 -1
- package/src/auth/flows/well-known.prm.flow.d.ts +19 -120
- package/src/auth/flows/well-known.prm.flow.js +3 -4
- package/src/auth/flows/well-known.prm.flow.js.map +1 -1
- package/src/auth/instances/instance.local-primary-auth.d.ts +91 -4
- package/src/auth/instances/instance.local-primary-auth.js +236 -6
- package/src/auth/instances/instance.local-primary-auth.js.map +1 -1
- package/src/auth/instances/instance.remote-primary-auth.d.ts +4 -3
- package/src/auth/instances/instance.remote-primary-auth.js +2 -2
- package/src/auth/instances/instance.remote-primary-auth.js.map +1 -1
- package/src/auth/session/authorization-vault.d.ts +611 -0
- package/src/auth/session/authorization-vault.js +817 -0
- package/src/auth/session/authorization-vault.js.map +1 -0
- package/src/auth/session/authorization.store.d.ts +301 -0
- package/src/auth/session/authorization.store.js +323 -0
- package/src/auth/session/authorization.store.js.map +1 -0
- package/src/auth/session/encrypted-authorization-vault.d.ts +181 -0
- package/src/auth/session/encrypted-authorization-vault.js +493 -0
- package/src/auth/session/encrypted-authorization-vault.js.map +1 -0
- package/src/auth/session/index.d.ts +4 -4
- package/src/auth/session/index.js +11 -7
- package/src/auth/session/index.js.map +1 -1
- package/src/auth/session/session.schema.d.ts +1 -1
- package/src/auth/session/session.service.d.ts +1 -1
- package/src/auth/session/transport-session.manager.d.ts +101 -0
- package/src/auth/session/transport-session.manager.js +300 -0
- package/src/auth/session/transport-session.manager.js.map +1 -0
- package/src/auth/session/transport-session.types.d.ts +457 -0
- package/src/auth/session/transport-session.types.js +110 -0
- package/src/auth/session/transport-session.types.js.map +1 -0
- package/src/auth/session/utils/session-id.utils.d.ts +14 -2
- package/src/auth/session/utils/session-id.utils.js +68 -19
- package/src/auth/session/utils/session-id.utils.js.map +1 -1
- package/src/auth/session/vault-encryption.d.ts +189 -0
- package/src/auth/session/vault-encryption.js +263 -0
- package/src/auth/session/vault-encryption.js.map +1 -0
- package/src/auth/ui/base-layout.d.ts +188 -0
- package/src/auth/ui/base-layout.js +292 -0
- package/src/auth/ui/base-layout.js.map +1 -0
- package/src/auth/ui/htmx-templates.d.ts +135 -0
- package/src/auth/ui/htmx-templates.js +433 -0
- package/src/auth/ui/htmx-templates.js.map +1 -0
- package/src/auth/ui/index.d.ts +11 -0
- package/src/auth/ui/index.js +35 -0
- package/src/auth/ui/index.js.map +1 -0
- package/src/auth/utils/audience.validator.d.ts +129 -0
- package/src/auth/utils/audience.validator.js +196 -0
- package/src/auth/utils/audience.validator.js.map +1 -0
- package/src/auth/utils/index.d.ts +2 -0
- package/src/auth/utils/index.js +7 -0
- package/src/auth/utils/index.js.map +1 -0
- package/src/auth/utils/www-authenticate.utils.d.ts +97 -0
- package/src/auth/utils/www-authenticate.utils.js +183 -0
- package/src/auth/utils/www-authenticate.utils.js.map +1 -0
- package/src/common/common.schema.d.ts +2 -16
- package/src/common/constants.d.ts +3 -0
- package/src/common/constants.js +6 -1
- package/src/common/constants.js.map +1 -1
- package/src/common/decorators/decorator-utils.d.ts +131 -0
- package/src/common/decorators/decorator-utils.js +195 -0
- package/src/common/decorators/decorator-utils.js.map +1 -0
- package/src/common/decorators/front-mcp.decorator.js +3 -2
- package/src/common/decorators/front-mcp.decorator.js.map +1 -1
- package/src/common/decorators/hook.decorator.d.ts +58 -2
- package/src/common/decorators/hook.decorator.js +127 -17
- package/src/common/decorators/hook.decorator.js.map +1 -1
- package/src/common/decorators/plugin.decorator.d.ts +1 -1
- package/src/common/decorators/plugin.decorator.js +11 -10
- package/src/common/decorators/plugin.decorator.js.map +1 -1
- package/src/common/decorators/resource.decorator.d.ts +32 -3
- package/src/common/decorators/resource.decorator.js +46 -4
- package/src/common/decorators/resource.decorator.js.map +1 -1
- package/src/common/decorators/tool.decorator.d.ts +54 -5
- package/src/common/decorators/tool.decorator.js.map +1 -1
- package/src/common/dynamic/dynamic.plugin.d.ts +22 -11
- package/src/common/dynamic/dynamic.plugin.js +7 -1
- package/src/common/dynamic/dynamic.plugin.js.map +1 -1
- package/src/common/entries/prompt.entry.d.ts +46 -2
- package/src/common/entries/prompt.entry.js +10 -0
- package/src/common/entries/prompt.entry.js.map +1 -1
- package/src/common/entries/resource.entry.d.ts +69 -6
- package/src/common/entries/resource.entry.js +27 -3
- package/src/common/entries/resource.entry.js.map +1 -1
- package/src/common/entries/scope.entry.d.ts +5 -1
- package/src/common/entries/scope.entry.js +3 -3
- package/src/common/entries/scope.entry.js.map +1 -1
- package/src/common/flow/flow.utils.d.ts +56 -0
- package/src/common/flow/flow.utils.js +96 -0
- package/src/common/flow/flow.utils.js.map +1 -0
- package/src/common/index.d.ts +2 -2
- package/src/common/index.js +2 -2
- package/src/common/index.js.map +1 -1
- package/src/common/interfaces/execution-context.interface.d.ts +59 -0
- package/src/common/interfaces/execution-context.interface.js +81 -0
- package/src/common/interfaces/execution-context.interface.js.map +1 -0
- package/src/common/interfaces/flow.interface.d.ts +1 -1
- package/src/common/interfaces/flow.interface.js.map +1 -1
- package/src/common/interfaces/index.d.ts +1 -0
- package/src/common/interfaces/index.js +1 -0
- package/src/common/interfaces/index.js.map +1 -1
- package/src/common/interfaces/internal/primary-auth-provider.interface.d.ts +17 -2
- package/src/common/interfaces/internal/primary-auth-provider.interface.js +52 -4
- package/src/common/interfaces/internal/primary-auth-provider.interface.js.map +1 -1
- package/src/common/interfaces/internal/registry.interface.d.ts +16 -2
- package/src/common/interfaces/internal/registry.interface.js.map +1 -1
- package/src/common/interfaces/plugin.interface.js.map +1 -1
- package/src/common/interfaces/prompt.interface.d.ts +53 -4
- package/src/common/interfaces/prompt.interface.js +78 -0
- package/src/common/interfaces/prompt.interface.js.map +1 -1
- package/src/common/interfaces/resource.interface.d.ts +47 -17
- package/src/common/interfaces/resource.interface.js +53 -0
- package/src/common/interfaces/resource.interface.js.map +1 -1
- package/src/common/interfaces/tool.interface.d.ts +39 -22
- package/src/common/interfaces/tool.interface.js +61 -34
- package/src/common/interfaces/tool.interface.js.map +1 -1
- package/src/common/metadata/adapter.metadata.d.ts +1 -9
- package/src/common/metadata/app.metadata.d.ts +425 -730
- package/src/common/metadata/auth-provider.metadata.d.ts +2 -12
- package/src/common/metadata/flow.metadata.d.ts +10 -25
- package/src/common/metadata/front-mcp.metadata.d.ts +602 -1023
- package/src/common/metadata/front-mcp.metadata.js +6 -4
- package/src/common/metadata/front-mcp.metadata.js.map +1 -1
- package/src/common/metadata/hook.metadata.d.ts +1 -1
- package/src/common/metadata/hook.metadata.js.map +1 -1
- package/src/common/metadata/index.d.ts +1 -0
- package/src/common/metadata/index.js +1 -0
- package/src/common/metadata/index.js.map +1 -1
- package/src/common/metadata/logger.metadata.d.ts +1 -9
- package/src/common/metadata/plugin.metadata.d.ts +8 -30
- package/src/common/metadata/prompt.metadata.d.ts +4 -161
- package/src/common/metadata/provider.metadata.d.ts +2 -12
- package/src/common/metadata/resource.metadata.d.ts +6 -98
- package/src/common/metadata/resource.metadata.js +15 -6
- package/src/common/metadata/resource.metadata.js.map +1 -1
- package/src/common/metadata/tool-ui.metadata.d.ts +10 -0
- package/src/common/metadata/tool-ui.metadata.js +12 -0
- package/src/common/metadata/tool-ui.metadata.js.map +1 -0
- package/src/common/metadata/tool.metadata.d.ts +78 -199
- package/src/common/metadata/tool.metadata.js +11 -14
- package/src/common/metadata/tool.metadata.js.map +1 -1
- package/src/common/providers/base-config.provider.d.ts +84 -0
- package/src/common/providers/base-config.provider.js +128 -0
- package/src/common/providers/base-config.provider.js.map +1 -0
- package/src/common/records/plugin.record.d.ts +5 -6
- package/src/common/records/plugin.record.js.map +1 -1
- package/src/common/records/prompt.record.js.map +1 -1
- package/src/common/records/resource.record.d.ts +17 -1
- package/src/common/records/resource.record.js +12 -6
- package/src/common/records/resource.record.js.map +1 -1
- package/src/common/records/tool.record.js.map +1 -1
- package/src/common/schemas/annotated-class.schema.d.ts +9 -9
- package/src/common/schemas/annotated-class.schema.js +92 -27
- package/src/common/schemas/annotated-class.schema.js.map +1 -1
- package/src/common/schemas/http-input.schema.d.ts +6 -30
- package/src/common/schemas/http-output.schema.d.ts +326 -1630
- package/src/common/schemas/http-output.schema.js +39 -1
- package/src/common/schemas/http-output.schema.js.map +1 -1
- package/src/common/tokens/front-mcp.tokens.js +4 -1
- package/src/common/tokens/front-mcp.tokens.js.map +1 -1
- package/src/common/tokens/resource.tokens.d.ts +2 -0
- package/src/common/tokens/resource.tokens.js +4 -1
- package/src/common/tokens/resource.tokens.js.map +1 -1
- package/src/common/tokens/tool.tokens.d.ts +2 -0
- package/src/common/tokens/tool.tokens.js +2 -0
- package/src/common/tokens/tool.tokens.js.map +1 -1
- package/src/common/types/auth/jwt.types.d.ts +5 -31
- package/src/common/types/auth/session.types.d.ts +97 -192
- package/src/common/types/auth/session.types.js +24 -11
- package/src/common/types/auth/session.types.js.map +1 -1
- package/src/common/types/options/auth.options.d.ts +1013 -490
- package/src/common/types/options/auth.options.js +554 -36
- package/src/common/types/options/auth.options.js.map +1 -1
- package/src/common/types/options/http.options.d.ts +1 -9
- package/src/common/types/options/logging.options.d.ts +7 -13
- package/src/common/types/options/logging.options.js +4 -0
- package/src/common/types/options/logging.options.js.map +1 -1
- package/src/common/types/options/server-info.options.d.ts +3 -31
- package/src/common/types/options/session.options.d.ts +90 -10
- package/src/common/types/options/session.options.js +26 -3
- package/src/common/types/options/session.options.js.map +1 -1
- package/src/common/utils/decide-request-intent.utils.d.ts +8 -46
- package/src/common/utils/decide-request-intent.utils.js +88 -23
- package/src/common/utils/decide-request-intent.utils.js.map +1 -1
- package/src/completion/flows/complete.flow.d.ts +74 -0
- package/src/completion/flows/complete.flow.js +199 -0
- package/src/completion/flows/complete.flow.js.map +1 -0
- package/src/errors/authorization-required.error.d.ts +189 -0
- package/src/errors/authorization-required.error.js +274 -0
- package/src/errors/authorization-required.error.js.map +1 -0
- package/src/errors/index.d.ts +2 -1
- package/src/errors/index.js +17 -1
- package/src/errors/index.js.map +1 -1
- package/src/errors/mcp.error.d.ts +101 -1
- package/src/errors/mcp.error.js +147 -2
- package/src/errors/mcp.error.js.map +1 -1
- package/src/flows/flow.instance.js +4 -3
- package/src/flows/flow.instance.js.map +1 -1
- package/src/flows/flow.registry.js.map +1 -1
- package/src/flows/flow.stages.js +14 -11
- package/src/flows/flow.stages.js.map +1 -1
- package/src/front-mcp/front-mcp.providers.d.ts +464 -102
- package/src/front-mcp/front-mcp.providers.js +3 -5
- package/src/front-mcp/front-mcp.providers.js.map +1 -1
- package/src/hooks/hook.instance.d.ts +1 -1
- package/src/hooks/hook.instance.js +5 -2
- package/src/hooks/hook.instance.js.map +1 -1
- package/src/hooks/hook.registry.js +7 -5
- package/src/hooks/hook.registry.js.map +1 -1
- package/src/index.d.ts +28 -9
- package/src/index.js +5 -1
- package/src/index.js.map +1 -1
- package/src/logger/instances/instance.logger.js +3 -2
- package/src/logger/instances/instance.logger.js.map +1 -1
- package/src/logger/logger.registry.js +7 -2
- package/src/logger/logger.registry.js.map +1 -1
- package/src/logging/flows/set-level.flow.d.ts +62 -0
- package/src/logging/flows/set-level.flow.js +108 -0
- package/src/logging/flows/set-level.flow.js.map +1 -0
- package/src/mcp-apps/csp.d.ts +111 -0
- package/src/mcp-apps/csp.js +267 -0
- package/src/mcp-apps/csp.js.map +1 -0
- package/src/mcp-apps/index.d.ts +23 -0
- package/src/mcp-apps/index.js +91 -0
- package/src/mcp-apps/index.js.map +1 -0
- package/src/mcp-apps/schemas.d.ts +403 -0
- package/src/mcp-apps/schemas.js +345 -0
- package/src/mcp-apps/schemas.js.map +1 -0
- package/src/mcp-apps/template.d.ts +94 -0
- package/src/mcp-apps/template.js +419 -0
- package/src/mcp-apps/template.js.map +1 -0
- package/src/mcp-apps/types.d.ts +323 -0
- package/src/mcp-apps/types.js +59 -0
- package/src/mcp-apps/types.js.map +1 -0
- package/src/notification/index.d.ts +1 -0
- package/src/notification/index.js +13 -0
- package/src/notification/index.js.map +1 -0
- package/src/notification/notification.service.d.ts +378 -0
- package/src/notification/notification.service.js +727 -0
- package/src/notification/notification.service.js.map +1 -0
- package/src/plugin/plugin.registry.js +12 -9
- package/src/plugin/plugin.registry.js.map +1 -1
- package/src/prompt/flows/get-prompt.flow.d.ts +153 -0
- package/src/prompt/flows/get-prompt.flow.js +214 -0
- package/src/prompt/flows/get-prompt.flow.js.map +1 -0
- package/src/prompt/flows/prompts-list.flow.d.ts +67 -0
- package/src/prompt/flows/prompts-list.flow.js +176 -0
- package/src/prompt/flows/prompts-list.flow.js.map +1 -0
- package/src/prompt/index.d.ts +7 -0
- package/src/prompt/index.js +17 -0
- package/src/prompt/index.js.map +1 -0
- package/src/prompt/prompt.events.d.ts +17 -0
- package/src/prompt/prompt.events.js +25 -0
- package/src/prompt/prompt.events.js.map +1 -0
- package/src/prompt/prompt.instance.d.ts +30 -0
- package/src/prompt/prompt.instance.js +120 -0
- package/src/prompt/prompt.instance.js.map +1 -0
- package/src/prompt/prompt.registry.d.ts +79 -12
- package/src/prompt/prompt.registry.js +360 -15
- package/src/prompt/prompt.registry.js.map +1 -1
- package/src/prompt/prompt.types.d.ts +26 -0
- package/src/prompt/prompt.types.js +11 -0
- package/src/prompt/prompt.types.js.map +1 -0
- package/src/prompt/prompt.utils.d.ts +26 -0
- package/src/prompt/prompt.utils.js +136 -0
- package/src/prompt/prompt.utils.js.map +1 -0
- package/src/provider/provider.registry.d.ts +12 -5
- package/src/provider/provider.registry.js +30 -138
- package/src/provider/provider.registry.js.map +1 -1
- package/src/regsitry/registry.base.d.ts +1 -1
- package/src/regsitry/registry.base.js.map +1 -1
- package/src/resource/flows/read-resource.flow.d.ts +91 -0
- package/src/resource/flows/read-resource.flow.js +270 -0
- package/src/resource/flows/read-resource.flow.js.map +1 -0
- package/src/resource/flows/resource-templates-list.flow.d.ts +64 -0
- package/src/resource/flows/resource-templates-list.flow.js +191 -0
- package/src/resource/flows/resource-templates-list.flow.js.map +1 -0
- package/src/resource/flows/resources-list.flow.d.ts +64 -0
- package/src/resource/flows/resources-list.flow.js +196 -0
- package/src/resource/flows/resources-list.flow.js.map +1 -0
- package/src/resource/flows/subscribe-resource.flow.d.ts +45 -0
- package/src/resource/flows/subscribe-resource.flow.js +123 -0
- package/src/resource/flows/subscribe-resource.flow.js.map +1 -0
- package/src/resource/flows/unsubscribe-resource.flow.d.ts +44 -0
- package/src/resource/flows/unsubscribe-resource.flow.js +107 -0
- package/src/resource/flows/unsubscribe-resource.flow.js.map +1 -0
- package/src/resource/index.d.ts +8 -0
- package/src/resource/index.js +20 -0
- package/src/resource/index.js.map +1 -0
- package/src/resource/resource.events.d.ts +24 -0
- package/src/resource/resource.events.js +17 -0
- package/src/resource/resource.events.js.map +1 -0
- package/src/resource/resource.instance.d.ts +35 -0
- package/src/resource/resource.instance.js +163 -0
- package/src/resource/resource.instance.js.map +1 -0
- package/src/resource/resource.registry.d.ts +106 -12
- package/src/resource/resource.registry.js +449 -13
- package/src/resource/resource.registry.js.map +1 -1
- package/src/resource/resource.types.d.ts +35 -0
- package/src/resource/resource.types.js +11 -0
- package/src/resource/resource.types.js.map +1 -0
- package/src/resource/resource.utils.d.ts +30 -0
- package/src/resource/resource.utils.js +151 -0
- package/src/resource/resource.utils.js.map +1 -0
- package/src/scope/flows/http.request.flow.d.ts +48 -330
- package/src/scope/flows/http.request.flow.js +306 -78
- package/src/scope/flows/http.request.flow.js.map +1 -1
- package/src/scope/scope.instance.d.ts +12 -0
- package/src/scope/scope.instance.js +145 -15
- package/src/scope/scope.instance.js.map +1 -1
- package/src/tool/flows/call-tool.flow.d.ts +64 -1110
- package/src/tool/flows/call-tool.flow.js +303 -15
- package/src/tool/flows/call-tool.flow.js.map +1 -1
- package/src/tool/flows/tools-list.flow.d.ts +32 -473
- package/src/tool/flows/tools-list.flow.js +111 -10
- package/src/tool/flows/tools-list.flow.js.map +1 -1
- package/src/tool/tool.events.d.ts +8 -1
- package/src/tool/tool.events.js.map +1 -1
- package/src/tool/tool.instance.d.ts +3 -1
- package/src/tool/tool.instance.js +17 -3
- package/src/tool/tool.instance.js.map +1 -1
- package/src/tool/tool.registry.d.ts +7 -1
- package/src/tool/tool.registry.js +26 -10
- package/src/tool/tool.registry.js.map +1 -1
- package/src/tool/tool.types.d.ts +4 -4
- package/src/tool/tool.types.js.map +1 -1
- package/src/tool/tool.utils.d.ts +3 -12
- package/src/tool/tool.utils.js +39 -193
- package/src/tool/tool.utils.js.map +1 -1
- package/src/tool/ui/index.d.ts +22 -0
- package/src/tool/ui/index.js +63 -0
- package/src/tool/ui/index.js.map +1 -0
- package/src/tool/ui/platform-adapters.d.ts +10 -0
- package/src/tool/ui/platform-adapters.js +18 -0
- package/src/tool/ui/platform-adapters.js.map +1 -0
- package/src/tool/ui/template-helpers.d.ts +46 -0
- package/src/tool/ui/template-helpers.js +112 -0
- package/src/tool/ui/template-helpers.js.map +1 -0
- package/src/tool/ui/ui-resource-template.d.ts +34 -0
- package/src/tool/ui/ui-resource-template.js +64 -0
- package/src/tool/ui/ui-resource-template.js.map +1 -0
- package/src/tool/ui/ui-resource.handler.d.ts +74 -0
- package/src/tool/ui/ui-resource.handler.js +129 -0
- package/src/tool/ui/ui-resource.handler.js.map +1 -0
- package/src/transport/adapters/transport.local.adapter.d.ts +2 -2
- package/src/transport/adapters/transport.local.adapter.js +28 -7
- package/src/transport/adapters/transport.local.adapter.js.map +1 -1
- package/src/transport/adapters/transport.sse.adapter.d.ts +2 -2
- package/src/transport/adapters/transport.sse.adapter.js +4 -3
- package/src/transport/adapters/transport.sse.adapter.js.map +1 -1
- package/src/transport/adapters/transport.streamable-http.adapter.d.ts +10 -3
- package/src/transport/adapters/transport.streamable-http.adapter.js +54 -8
- package/src/transport/adapters/transport.streamable-http.adapter.js.map +1 -1
- package/src/transport/flows/handle.sse.flow.d.ts +29 -63
- package/src/transport/flows/handle.sse.flow.js +78 -10
- package/src/transport/flows/handle.sse.flow.js.map +1 -1
- package/src/transport/flows/handle.stateless-http.flow.d.ts +29 -0
- package/src/transport/flows/handle.stateless-http.flow.js +102 -0
- package/src/transport/flows/handle.stateless-http.flow.js.map +1 -0
- package/src/transport/flows/handle.streamable-http.flow.d.ts +32 -64
- package/src/transport/flows/handle.streamable-http.flow.js +158 -26
- package/src/transport/flows/handle.streamable-http.flow.js.map +1 -1
- package/src/transport/legacy/legacy.sse.tranporter.d.ts +9 -0
- package/src/transport/legacy/legacy.sse.tranporter.js +17 -2
- package/src/transport/legacy/legacy.sse.tranporter.js.map +1 -1
- package/src/transport/mcp-handlers/call-tool-request.handler.js +27 -1
- package/src/transport/mcp-handlers/call-tool-request.handler.js.map +1 -1
- package/src/transport/mcp-handlers/complete-request.handler.d.ts +69 -0
- package/src/transport/mcp-handlers/complete-request.handler.js +11 -0
- package/src/transport/mcp-handlers/complete-request.handler.js.map +1 -0
- package/src/transport/mcp-handlers/get-prompt-request.handler.d.ts +87 -0
- package/src/transport/mcp-handlers/get-prompt-request.handler.js +11 -0
- package/src/transport/mcp-handlers/get-prompt-request.handler.js.map +1 -0
- package/src/transport/mcp-handlers/index.d.ts +517 -208
- package/src/transport/mcp-handlers/index.js +39 -2
- package/src/transport/mcp-handlers/index.js.map +1 -1
- package/src/transport/mcp-handlers/initialize-request.handler.d.ts +1 -1
- package/src/transport/mcp-handlers/initialize-request.handler.js +73 -7
- package/src/transport/mcp-handlers/initialize-request.handler.js.map +1 -1
- package/src/transport/mcp-handlers/list-prompts-request.handler.d.ts +54 -0
- package/src/transport/mcp-handlers/list-prompts-request.handler.js +11 -0
- package/src/transport/mcp-handlers/list-prompts-request.handler.js.map +1 -0
- package/src/transport/mcp-handlers/list-resource-templates-request.handler.d.ts +51 -0
- package/src/transport/mcp-handlers/list-resource-templates-request.handler.js +12 -0
- package/src/transport/mcp-handlers/list-resource-templates-request.handler.js.map +1 -0
- package/src/transport/mcp-handlers/list-resources-request.handler.d.ts +51 -0
- package/src/transport/mcp-handlers/list-resources-request.handler.js +12 -0
- package/src/transport/mcp-handlers/list-resources-request.handler.js.map +1 -0
- package/src/transport/mcp-handlers/list-tools-request.handler.d.ts +19 -146
- package/src/transport/mcp-handlers/logging-set-level-request.handler.d.ts +46 -0
- package/src/transport/mcp-handlers/logging-set-level-request.handler.js +34 -0
- package/src/transport/mcp-handlers/logging-set-level-request.handler.js.map +1 -0
- package/src/transport/mcp-handlers/mcp-handlers.types.d.ts +3 -7
- package/src/transport/mcp-handlers/mcp-handlers.types.js.map +1 -1
- package/src/transport/mcp-handlers/read-resource-request.handler.d.ts +46 -0
- package/src/transport/mcp-handlers/read-resource-request.handler.js +12 -0
- package/src/transport/mcp-handlers/read-resource-request.handler.js.map +1 -0
- package/src/transport/mcp-handlers/roots-list-changed-notification.handler.d.ts +11 -0
- package/src/transport/mcp-handlers/roots-list-changed-notification.handler.js +26 -0
- package/src/transport/mcp-handlers/roots-list-changed-notification.handler.js.map +1 -0
- package/src/transport/mcp-handlers/subscribe-request.handler.d.ts +37 -0
- package/src/transport/mcp-handlers/subscribe-request.handler.js +34 -0
- package/src/transport/mcp-handlers/subscribe-request.handler.js.map +1 -0
- package/src/transport/mcp-handlers/unsubscribe-request.handler.d.ts +37 -0
- package/src/transport/mcp-handlers/unsubscribe-request.handler.js +34 -0
- package/src/transport/mcp-handlers/unsubscribe-request.handler.js.map +1 -0
- package/src/transport/transport.local.js +7 -2
- package/src/transport/transport.local.js.map +1 -1
- package/src/transport/transport.registry.d.ts +30 -0
- package/src/transport/transport.registry.js +84 -1
- package/src/transport/transport.registry.js.map +1 -1
- package/src/transport/transport.types.d.ts +3 -3
- package/src/transport/transport.types.js.map +1 -1
- package/src/utils/content.utils.d.ts +48 -0
- package/src/utils/content.utils.js +194 -0
- package/src/utils/content.utils.js.map +1 -0
- package/src/utils/index.d.ts +8 -0
- package/src/utils/index.js +55 -0
- package/src/utils/index.js.map +1 -0
- package/src/utils/lineage.utils.d.ts +40 -0
- package/src/utils/lineage.utils.js +82 -0
- package/src/utils/lineage.utils.js.map +1 -0
- package/src/utils/naming.utils.d.ts +46 -0
- package/src/utils/naming.utils.js +136 -0
- package/src/utils/naming.utils.js.map +1 -0
- package/src/utils/types.utils.d.ts +2 -2
- package/src/utils/types.utils.js.map +1 -1
- package/src/utils/uri-template.utils.d.ts +57 -0
- package/src/utils/uri-template.utils.js +113 -0
- package/src/utils/uri-template.utils.js.map +1 -0
- package/src/utils/uri-validation.utils.d.ts +40 -0
- package/src/utils/uri-validation.utils.js +76 -0
- package/src/utils/uri-validation.utils.js.map +1 -0
- package/src/__test-utils__/fixtures/hook.fixtures.d.ts +0 -46
- package/src/__test-utils__/fixtures/hook.fixtures.js +0 -114
- package/src/__test-utils__/fixtures/hook.fixtures.js.map +0 -1
- package/src/__test-utils__/fixtures/index.d.ts +0 -7
- package/src/__test-utils__/fixtures/index.js +0 -11
- package/src/__test-utils__/fixtures/index.js.map +0 -1
- package/src/__test-utils__/fixtures/plugin.fixtures.d.ts +0 -46
- package/src/__test-utils__/fixtures/plugin.fixtures.js +0 -127
- package/src/__test-utils__/fixtures/plugin.fixtures.js.map +0 -1
- package/src/__test-utils__/fixtures/provider.fixtures.d.ts +0 -69
- package/src/__test-utils__/fixtures/provider.fixtures.js +0 -131
- package/src/__test-utils__/fixtures/provider.fixtures.js.map +0 -1
- package/src/__test-utils__/fixtures/scope.fixtures.d.ts +0 -14
- package/src/__test-utils__/fixtures/scope.fixtures.js +0 -59
- package/src/__test-utils__/fixtures/scope.fixtures.js.map +0 -1
- package/src/__test-utils__/fixtures/tool.fixtures.d.ts +0 -36
- package/src/__test-utils__/fixtures/tool.fixtures.js +0 -91
- package/src/__test-utils__/fixtures/tool.fixtures.js.map +0 -1
- package/src/__test-utils__/helpers/assertion.helpers.d.ts +0 -45
- package/src/__test-utils__/helpers/assertion.helpers.js +0 -153
- package/src/__test-utils__/helpers/assertion.helpers.js.map +0 -1
- package/src/__test-utils__/helpers/async.helpers.d.ts +0 -48
- package/src/__test-utils__/helpers/async.helpers.js +0 -112
- package/src/__test-utils__/helpers/async.helpers.js.map +0 -1
- package/src/__test-utils__/helpers/index.d.ts +0 -6
- package/src/__test-utils__/helpers/index.js +0 -10
- package/src/__test-utils__/helpers/index.js.map +0 -1
- package/src/__test-utils__/helpers/setup.helpers.d.ts +0 -54
- package/src/__test-utils__/helpers/setup.helpers.js +0 -106
- package/src/__test-utils__/helpers/setup.helpers.js.map +0 -1
- package/src/__test-utils__/index.d.ts +0 -9
- package/src/__test-utils__/index.js +0 -14
- package/src/__test-utils__/index.js.map +0 -1
- package/src/__test-utils__/mocks/flow-instance.mock.d.ts +0 -50
- package/src/__test-utils__/mocks/flow-instance.mock.js +0 -72
- package/src/__test-utils__/mocks/flow-instance.mock.js.map +0 -1
- package/src/__test-utils__/mocks/hook-registry.mock.d.ts +0 -25
- package/src/__test-utils__/mocks/hook-registry.mock.js +0 -65
- package/src/__test-utils__/mocks/hook-registry.mock.js.map +0 -1
- package/src/__test-utils__/mocks/index.d.ts +0 -8
- package/src/__test-utils__/mocks/index.js +0 -12
- package/src/__test-utils__/mocks/index.js.map +0 -1
- package/src/__test-utils__/mocks/plugin-registry.mock.d.ts +0 -43
- package/src/__test-utils__/mocks/plugin-registry.mock.js +0 -70
- package/src/__test-utils__/mocks/plugin-registry.mock.js.map +0 -1
- package/src/__test-utils__/mocks/provider-registry.mock.d.ts +0 -39
- package/src/__test-utils__/mocks/provider-registry.mock.js +0 -72
- package/src/__test-utils__/mocks/provider-registry.mock.js.map +0 -1
- package/src/__test-utils__/mocks/tool-registry.mock.d.ts +0 -43
- package/src/__test-utils__/mocks/tool-registry.mock.js +0 -79
- package/src/__test-utils__/mocks/tool-registry.mock.js.map +0 -1
- package/src/auth/path.utils.d.ts +0 -20
- package/src/auth/path.utils.js +0 -71
- package/src/auth/path.utils.js.map +0 -1
- package/src/common/decorators-old/async-with.decorator.d.ts +0 -10
- package/src/common/decorators-old/async-with.decorator.js +0 -24
- package/src/common/decorators-old/async-with.decorator.js.map +0 -1
- package/src/common/decorators-old/auth-hook.decorator.d.ts +0 -14
- package/src/common/decorators-old/auth-hook.decorator.js +0 -27
- package/src/common/decorators-old/auth-hook.decorator.js.map +0 -1
- package/src/common/decorators-old/session-hook.decorator.d.ts +0 -14
- package/src/common/decorators-old/session-hook.decorator.js +0 -27
- package/src/common/decorators-old/session-hook.decorator.js.map +0 -1
|
@@ -0,0 +1,345 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* @file schemas.ts
|
|
4
|
+
* @description Zod schemas for MCP Apps specification validation.
|
|
5
|
+
*
|
|
6
|
+
* @module @frontmcp/sdk/mcp-apps/schemas
|
|
7
|
+
*/
|
|
8
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
+
exports.DEFAULT_PROTOCOL_VERSION = exports.ToolUIMetaSchema = exports.McpAppsExtensionCapabilitySchema = exports.McpUiMessageParamsSchema = exports.McpUiOpenLinkParamsSchema = exports.McpUiHostContextChangeParamsSchema = exports.McpUiSizeChangeParamsSchema = exports.McpUiToolCancelledParamsSchema = exports.McpUiToolResultParamsSchema = exports.ToolResultContentItemSchema = exports.McpUiToolInputPartialParamsSchema = exports.McpUiToolInputParamsSchema = exports.McpUiInitializeResultSchema = exports.McpUiInitializeParamsSchema = exports.JsonRpcNotificationSchema = exports.JsonRpcResponseSchema = exports.JsonRpcRequestSchema = exports.JsonRpcErrorSchema = exports.McpAppsHostContextSchema = exports.ToolInfoSchema = exports.ViewportInfoSchema = exports.SafeAreaInsetsSchema = exports.DeviceCapabilitiesSchema = exports.UIResourceSchema = exports.UIResourceMetaSchema = exports.McpAppsCSPSchema = exports.ThemeSchema = exports.McpAppsPlatformSchema = exports.McpAppsDisplayModeSchema = exports.McpAppsMimeTypeSchema = void 0;
|
|
10
|
+
exports.isValidUIResourceUri = isValidUIResourceUri;
|
|
11
|
+
exports.isValidProtocolVersion = isValidProtocolVersion;
|
|
12
|
+
exports.parseUIResource = parseUIResource;
|
|
13
|
+
exports.parseHostContext = parseHostContext;
|
|
14
|
+
const zod_1 = require("zod");
|
|
15
|
+
const types_1 = require("./types");
|
|
16
|
+
// ============================================
|
|
17
|
+
// Basic Schemas
|
|
18
|
+
// ============================================
|
|
19
|
+
/**
|
|
20
|
+
* MCP Apps MIME type schema.
|
|
21
|
+
*/
|
|
22
|
+
exports.McpAppsMimeTypeSchema = zod_1.z.literal(types_1.MCP_APPS_MIME_TYPE);
|
|
23
|
+
/**
|
|
24
|
+
* Display mode schema.
|
|
25
|
+
*/
|
|
26
|
+
exports.McpAppsDisplayModeSchema = zod_1.z.enum(['inline', 'fullscreen', 'pip']);
|
|
27
|
+
/**
|
|
28
|
+
* Platform type schema.
|
|
29
|
+
*/
|
|
30
|
+
exports.McpAppsPlatformSchema = zod_1.z.enum(['web', 'desktop', 'mobile']);
|
|
31
|
+
/**
|
|
32
|
+
* Theme schema.
|
|
33
|
+
*/
|
|
34
|
+
exports.ThemeSchema = zod_1.z.enum(['light', 'dark']);
|
|
35
|
+
// ============================================
|
|
36
|
+
// CSP Schema
|
|
37
|
+
// ============================================
|
|
38
|
+
/**
|
|
39
|
+
* Content Security Policy schema.
|
|
40
|
+
*/
|
|
41
|
+
exports.McpAppsCSPSchema = zod_1.z
|
|
42
|
+
.object({
|
|
43
|
+
connectDomains: zod_1.z.array(zod_1.z.string().url()).optional(),
|
|
44
|
+
resourceDomains: zod_1.z.array(zod_1.z.string().url()).optional(),
|
|
45
|
+
})
|
|
46
|
+
.strict();
|
|
47
|
+
// ============================================
|
|
48
|
+
// UI Resource Schemas
|
|
49
|
+
// ============================================
|
|
50
|
+
/**
|
|
51
|
+
* UI Resource metadata schema.
|
|
52
|
+
*/
|
|
53
|
+
exports.UIResourceMetaSchema = zod_1.z
|
|
54
|
+
.object({
|
|
55
|
+
csp: exports.McpAppsCSPSchema.optional(),
|
|
56
|
+
domain: zod_1.z.string().optional(),
|
|
57
|
+
prefersBorder: zod_1.z.boolean().optional(),
|
|
58
|
+
})
|
|
59
|
+
.strict();
|
|
60
|
+
/**
|
|
61
|
+
* UI Resource schema.
|
|
62
|
+
*/
|
|
63
|
+
exports.UIResourceSchema = zod_1.z
|
|
64
|
+
.object({
|
|
65
|
+
uri: zod_1.z.string().startsWith('ui://'),
|
|
66
|
+
name: zod_1.z.string().min(1),
|
|
67
|
+
description: zod_1.z.string().optional(),
|
|
68
|
+
mimeType: exports.McpAppsMimeTypeSchema,
|
|
69
|
+
_meta: zod_1.z
|
|
70
|
+
.object({
|
|
71
|
+
ui: exports.UIResourceMetaSchema.optional(),
|
|
72
|
+
})
|
|
73
|
+
.optional(),
|
|
74
|
+
})
|
|
75
|
+
.strict();
|
|
76
|
+
// ============================================
|
|
77
|
+
// Host Context Schemas
|
|
78
|
+
// ============================================
|
|
79
|
+
/**
|
|
80
|
+
* Device capabilities schema.
|
|
81
|
+
*/
|
|
82
|
+
exports.DeviceCapabilitiesSchema = zod_1.z
|
|
83
|
+
.object({
|
|
84
|
+
touch: zod_1.z.boolean().optional(),
|
|
85
|
+
hover: zod_1.z.boolean().optional(),
|
|
86
|
+
})
|
|
87
|
+
.strict();
|
|
88
|
+
/**
|
|
89
|
+
* Safe area insets schema.
|
|
90
|
+
*/
|
|
91
|
+
exports.SafeAreaInsetsSchema = zod_1.z
|
|
92
|
+
.object({
|
|
93
|
+
top: zod_1.z.number(),
|
|
94
|
+
right: zod_1.z.number(),
|
|
95
|
+
bottom: zod_1.z.number(),
|
|
96
|
+
left: zod_1.z.number(),
|
|
97
|
+
})
|
|
98
|
+
.strict();
|
|
99
|
+
/**
|
|
100
|
+
* Viewport info schema.
|
|
101
|
+
*/
|
|
102
|
+
exports.ViewportInfoSchema = zod_1.z
|
|
103
|
+
.object({
|
|
104
|
+
width: zod_1.z.number().positive(),
|
|
105
|
+
height: zod_1.z.number().positive(),
|
|
106
|
+
maxHeight: zod_1.z.number().positive().optional(),
|
|
107
|
+
maxWidth: zod_1.z.number().positive().optional(),
|
|
108
|
+
})
|
|
109
|
+
.strict();
|
|
110
|
+
/**
|
|
111
|
+
* Tool info schema.
|
|
112
|
+
*/
|
|
113
|
+
exports.ToolInfoSchema = zod_1.z
|
|
114
|
+
.object({
|
|
115
|
+
id: zod_1.z.union([zod_1.z.string(), zod_1.z.number()]).optional(),
|
|
116
|
+
tool: zod_1.z.object({
|
|
117
|
+
name: zod_1.z.string().min(1),
|
|
118
|
+
description: zod_1.z.string().optional(),
|
|
119
|
+
inputSchema: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).optional(),
|
|
120
|
+
}),
|
|
121
|
+
})
|
|
122
|
+
.strict();
|
|
123
|
+
/**
|
|
124
|
+
* Host context schema.
|
|
125
|
+
*/
|
|
126
|
+
exports.McpAppsHostContextSchema = zod_1.z
|
|
127
|
+
.object({
|
|
128
|
+
toolInfo: exports.ToolInfoSchema.optional(),
|
|
129
|
+
theme: exports.ThemeSchema.optional(),
|
|
130
|
+
displayMode: exports.McpAppsDisplayModeSchema.optional(),
|
|
131
|
+
viewport: exports.ViewportInfoSchema.optional(),
|
|
132
|
+
locale: zod_1.z.string().optional(),
|
|
133
|
+
timeZone: zod_1.z.string().optional(),
|
|
134
|
+
platform: exports.McpAppsPlatformSchema.optional(),
|
|
135
|
+
deviceCapabilities: exports.DeviceCapabilitiesSchema.optional(),
|
|
136
|
+
safeAreaInsets: exports.SafeAreaInsetsSchema.optional(),
|
|
137
|
+
})
|
|
138
|
+
.strict();
|
|
139
|
+
// ============================================
|
|
140
|
+
// JSON-RPC Schemas
|
|
141
|
+
// ============================================
|
|
142
|
+
/**
|
|
143
|
+
* JSON-RPC error schema.
|
|
144
|
+
*/
|
|
145
|
+
exports.JsonRpcErrorSchema = zod_1.z
|
|
146
|
+
.object({
|
|
147
|
+
code: zod_1.z.number().int(),
|
|
148
|
+
message: zod_1.z.string(),
|
|
149
|
+
data: zod_1.z.unknown().optional(),
|
|
150
|
+
})
|
|
151
|
+
.strict();
|
|
152
|
+
/**
|
|
153
|
+
* JSON-RPC request schema.
|
|
154
|
+
*/
|
|
155
|
+
exports.JsonRpcRequestSchema = zod_1.z
|
|
156
|
+
.object({
|
|
157
|
+
jsonrpc: zod_1.z.literal('2.0'),
|
|
158
|
+
id: zod_1.z.union([zod_1.z.string(), zod_1.z.number()]),
|
|
159
|
+
method: zod_1.z.string().min(1),
|
|
160
|
+
params: zod_1.z.unknown().optional(),
|
|
161
|
+
})
|
|
162
|
+
.strict();
|
|
163
|
+
/**
|
|
164
|
+
* JSON-RPC response schema.
|
|
165
|
+
*/
|
|
166
|
+
exports.JsonRpcResponseSchema = zod_1.z
|
|
167
|
+
.object({
|
|
168
|
+
jsonrpc: zod_1.z.literal('2.0'),
|
|
169
|
+
id: zod_1.z.union([zod_1.z.string(), zod_1.z.number()]),
|
|
170
|
+
result: zod_1.z.unknown().optional(),
|
|
171
|
+
error: exports.JsonRpcErrorSchema.optional(),
|
|
172
|
+
})
|
|
173
|
+
.strict();
|
|
174
|
+
/**
|
|
175
|
+
* JSON-RPC notification schema.
|
|
176
|
+
*/
|
|
177
|
+
exports.JsonRpcNotificationSchema = zod_1.z
|
|
178
|
+
.object({
|
|
179
|
+
jsonrpc: zod_1.z.literal('2.0'),
|
|
180
|
+
method: zod_1.z.string().min(1),
|
|
181
|
+
params: zod_1.z.unknown().optional(),
|
|
182
|
+
})
|
|
183
|
+
.strict();
|
|
184
|
+
// ============================================
|
|
185
|
+
// MCP Apps Protocol Message Schemas
|
|
186
|
+
// ============================================
|
|
187
|
+
/**
|
|
188
|
+
* UI Initialize params schema.
|
|
189
|
+
*/
|
|
190
|
+
exports.McpUiInitializeParamsSchema = zod_1.z
|
|
191
|
+
.object({
|
|
192
|
+
protocolVersion: zod_1.z.string(),
|
|
193
|
+
capabilities: zod_1.z
|
|
194
|
+
.object({
|
|
195
|
+
messages: zod_1.z.array(zod_1.z.string()).optional(),
|
|
196
|
+
})
|
|
197
|
+
.optional(),
|
|
198
|
+
})
|
|
199
|
+
.strict();
|
|
200
|
+
/**
|
|
201
|
+
* UI Initialize result schema.
|
|
202
|
+
*/
|
|
203
|
+
exports.McpUiInitializeResultSchema = zod_1.z
|
|
204
|
+
.object({
|
|
205
|
+
protocolVersion: zod_1.z.string(),
|
|
206
|
+
capabilities: zod_1.z.object({
|
|
207
|
+
extensions: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).optional(),
|
|
208
|
+
}),
|
|
209
|
+
hostContext: exports.McpAppsHostContextSchema,
|
|
210
|
+
})
|
|
211
|
+
.strict();
|
|
212
|
+
/**
|
|
213
|
+
* Tool input params schema.
|
|
214
|
+
*/
|
|
215
|
+
exports.McpUiToolInputParamsSchema = zod_1.z
|
|
216
|
+
.object({
|
|
217
|
+
arguments: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()),
|
|
218
|
+
})
|
|
219
|
+
.strict();
|
|
220
|
+
/**
|
|
221
|
+
* Tool input partial params schema.
|
|
222
|
+
*/
|
|
223
|
+
exports.McpUiToolInputPartialParamsSchema = zod_1.z
|
|
224
|
+
.object({
|
|
225
|
+
argumentsDelta: zod_1.z.string(),
|
|
226
|
+
})
|
|
227
|
+
.strict();
|
|
228
|
+
/**
|
|
229
|
+
* Tool result content item schema.
|
|
230
|
+
*/
|
|
231
|
+
exports.ToolResultContentItemSchema = zod_1.z.object({
|
|
232
|
+
type: zod_1.z.enum(['text', 'image', 'resource']),
|
|
233
|
+
text: zod_1.z.string().optional(),
|
|
234
|
+
data: zod_1.z.string().optional(),
|
|
235
|
+
mimeType: zod_1.z.string().optional(),
|
|
236
|
+
uri: zod_1.z.string().optional(),
|
|
237
|
+
});
|
|
238
|
+
/**
|
|
239
|
+
* Tool result params schema.
|
|
240
|
+
*/
|
|
241
|
+
exports.McpUiToolResultParamsSchema = zod_1.z
|
|
242
|
+
.object({
|
|
243
|
+
content: zod_1.z.array(exports.ToolResultContentItemSchema),
|
|
244
|
+
structuredContent: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).optional(),
|
|
245
|
+
_meta: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).optional(),
|
|
246
|
+
})
|
|
247
|
+
.strict();
|
|
248
|
+
/**
|
|
249
|
+
* Tool cancelled params schema.
|
|
250
|
+
*/
|
|
251
|
+
exports.McpUiToolCancelledParamsSchema = zod_1.z
|
|
252
|
+
.object({
|
|
253
|
+
reason: zod_1.z.string().optional(),
|
|
254
|
+
})
|
|
255
|
+
.strict();
|
|
256
|
+
/**
|
|
257
|
+
* Size change params schema.
|
|
258
|
+
*/
|
|
259
|
+
exports.McpUiSizeChangeParamsSchema = zod_1.z
|
|
260
|
+
.object({
|
|
261
|
+
viewport: exports.ViewportInfoSchema,
|
|
262
|
+
})
|
|
263
|
+
.strict();
|
|
264
|
+
/**
|
|
265
|
+
* Host context change params schema.
|
|
266
|
+
*/
|
|
267
|
+
exports.McpUiHostContextChangeParamsSchema = zod_1.z
|
|
268
|
+
.object({
|
|
269
|
+
changes: exports.McpAppsHostContextSchema.partial(),
|
|
270
|
+
})
|
|
271
|
+
.strict();
|
|
272
|
+
/**
|
|
273
|
+
* Open link params schema.
|
|
274
|
+
*/
|
|
275
|
+
exports.McpUiOpenLinkParamsSchema = zod_1.z
|
|
276
|
+
.object({
|
|
277
|
+
url: zod_1.z.string().url(),
|
|
278
|
+
})
|
|
279
|
+
.strict();
|
|
280
|
+
/**
|
|
281
|
+
* Message params schema.
|
|
282
|
+
*/
|
|
283
|
+
exports.McpUiMessageParamsSchema = zod_1.z
|
|
284
|
+
.object({
|
|
285
|
+
content: zod_1.z.string().min(1),
|
|
286
|
+
})
|
|
287
|
+
.strict();
|
|
288
|
+
// ============================================
|
|
289
|
+
// Extension Capability Schema
|
|
290
|
+
// ============================================
|
|
291
|
+
/**
|
|
292
|
+
* MCP Apps extension capability schema.
|
|
293
|
+
*/
|
|
294
|
+
exports.McpAppsExtensionCapabilitySchema = zod_1.z
|
|
295
|
+
.object({
|
|
296
|
+
mimeTypes: zod_1.z.array(exports.McpAppsMimeTypeSchema),
|
|
297
|
+
})
|
|
298
|
+
.strict();
|
|
299
|
+
// ============================================
|
|
300
|
+
// Tool Metadata Extension Schema
|
|
301
|
+
// ============================================
|
|
302
|
+
/**
|
|
303
|
+
* Tool UI metadata schema.
|
|
304
|
+
*/
|
|
305
|
+
exports.ToolUIMetaSchema = zod_1.z
|
|
306
|
+
.object({
|
|
307
|
+
'ui/resourceUri': zod_1.z.string().startsWith('ui://').optional(),
|
|
308
|
+
'ui/mimeType': exports.McpAppsMimeTypeSchema.optional(),
|
|
309
|
+
})
|
|
310
|
+
.passthrough(); // Allow additional platform-specific fields
|
|
311
|
+
// ============================================
|
|
312
|
+
// Validation Helpers
|
|
313
|
+
// ============================================
|
|
314
|
+
/**
|
|
315
|
+
* Validate a UI resource URI.
|
|
316
|
+
*/
|
|
317
|
+
function isValidUIResourceUri(uri) {
|
|
318
|
+
return uri.startsWith('ui://') && uri.length > 5;
|
|
319
|
+
}
|
|
320
|
+
/**
|
|
321
|
+
* Validate MCP Apps protocol version.
|
|
322
|
+
*/
|
|
323
|
+
function isValidProtocolVersion(version) {
|
|
324
|
+
// Accept current version or future versions
|
|
325
|
+
return /^\d{4}-\d{2}-\d{2}$/.test(version);
|
|
326
|
+
}
|
|
327
|
+
/**
|
|
328
|
+
* Parse and validate UI resource.
|
|
329
|
+
*/
|
|
330
|
+
function parseUIResource(data) {
|
|
331
|
+
const result = exports.UIResourceSchema.safeParse(data);
|
|
332
|
+
return result.success ? result.data : null;
|
|
333
|
+
}
|
|
334
|
+
/**
|
|
335
|
+
* Parse and validate host context.
|
|
336
|
+
*/
|
|
337
|
+
function parseHostContext(data) {
|
|
338
|
+
const result = exports.McpAppsHostContextSchema.safeParse(data);
|
|
339
|
+
return result.success ? result.data : null;
|
|
340
|
+
}
|
|
341
|
+
/**
|
|
342
|
+
* Default protocol version.
|
|
343
|
+
*/
|
|
344
|
+
exports.DEFAULT_PROTOCOL_VERSION = types_1.MCP_APPS_PROTOCOL_VERSION;
|
|
345
|
+
//# sourceMappingURL=schemas.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/mcp-apps/schemas.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAwVH,oDAEC;AAKD,wDAGC;AAKD,0CAGC;AAKD,4CAGC;AAhXD,6BAAwB;AACxB,mCAAwE;AAExE,+CAA+C;AAC/C,gBAAgB;AAChB,+CAA+C;AAE/C;;GAEG;AACU,QAAA,qBAAqB,GAAG,OAAC,CAAC,OAAO,CAAC,0BAAkB,CAAC,CAAC;AAEnE;;GAEG;AACU,QAAA,wBAAwB,GAAG,OAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC,CAAC;AAEhF;;GAEG;AACU,QAAA,qBAAqB,GAAG,OAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;AAE1E;;GAEG;AACU,QAAA,WAAW,GAAG,OAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;AAErD,+CAA+C;AAC/C,aAAa;AACb,+CAA+C;AAE/C;;GAEG;AACU,QAAA,gBAAgB,GAAG,OAAC;KAC9B,MAAM,CAAC;IACN,cAAc,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;IACpD,eAAe,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;CACtD,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,+CAA+C;AAC/C,sBAAsB;AACtB,+CAA+C;AAE/C;;GAEG;AACU,QAAA,oBAAoB,GAAG,OAAC;KAClC,MAAM,CAAC;IACN,GAAG,EAAE,wBAAgB,CAAC,QAAQ,EAAE;IAChC,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,aAAa,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CACtC,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;GAEG;AACU,QAAA,gBAAgB,GAAG,OAAC;KAC9B,MAAM,CAAC;IACN,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC;IACnC,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,QAAQ,EAAE,6BAAqB;IAC/B,KAAK,EAAE,OAAC;SACL,MAAM,CAAC;QACN,EAAE,EAAE,4BAAoB,CAAC,QAAQ,EAAE;KACpC,CAAC;SACD,QAAQ,EAAE;CACd,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,+CAA+C;AAC/C,uBAAuB;AACvB,+CAA+C;AAE/C;;GAEG;AACU,QAAA,wBAAwB,GAAG,OAAC;KACtC,MAAM,CAAC;IACN,KAAK,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC7B,KAAK,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;GAEG;AACU,QAAA,oBAAoB,GAAG,OAAC;KAClC,MAAM,CAAC;IACN,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;IACf,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;IACjB,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE;IAClB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;CACjB,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;GAEG;AACU,QAAA,kBAAkB,GAAG,OAAC;KAChC,MAAM,CAAC;IACN,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC3C,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC3C,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;GAEG;AACU,QAAA,cAAc,GAAG,OAAC;KAC5B,MAAM,CAAC;IACN,EAAE,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;IAChD,IAAI,EAAE,OAAC,CAAC,MAAM,CAAC;QACb,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QACvB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAClC,WAAW,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;KAC1D,CAAC;CACH,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;GAEG;AACU,QAAA,wBAAwB,GAAG,OAAC;KACtC,MAAM,CAAC;IACN,QAAQ,EAAE,sBAAc,CAAC,QAAQ,EAAE;IACnC,KAAK,EAAE,mBAAW,CAAC,QAAQ,EAAE;IAC7B,WAAW,EAAE,gCAAwB,CAAC,QAAQ,EAAE;IAChD,QAAQ,EAAE,0BAAkB,CAAC,QAAQ,EAAE;IACvC,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,QAAQ,EAAE,6BAAqB,CAAC,QAAQ,EAAE;IAC1C,kBAAkB,EAAE,gCAAwB,CAAC,QAAQ,EAAE;IACvD,cAAc,EAAE,4BAAoB,CAAC,QAAQ,EAAE;CAChD,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,+CAA+C;AAC/C,mBAAmB;AACnB,+CAA+C;AAE/C;;GAEG;AACU,QAAA,kBAAkB,GAAG,OAAC;KAChC,MAAM,CAAC;IACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACtB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;IACnB,IAAI,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAC7B,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;GAEG;AACU,QAAA,oBAAoB,GAAG,OAAC;KAClC,MAAM,CAAC;IACN,OAAO,EAAE,OAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IACzB,EAAE,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACrC,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACzB,MAAM,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;GAEG;AACU,QAAA,qBAAqB,GAAG,OAAC;KACnC,MAAM,CAAC;IACN,OAAO,EAAE,OAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IACzB,EAAE,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACrC,MAAM,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,KAAK,EAAE,0BAAkB,CAAC,QAAQ,EAAE;CACrC,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;GAEG;AACU,QAAA,yBAAyB,GAAG,OAAC;KACvC,MAAM,CAAC;IACN,OAAO,EAAE,OAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IACzB,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACzB,MAAM,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,+CAA+C;AAC/C,oCAAoC;AACpC,+CAA+C;AAE/C;;GAEG;AACU,QAAA,2BAA2B,GAAG,OAAC;KACzC,MAAM,CAAC;IACN,eAAe,EAAE,OAAC,CAAC,MAAM,EAAE;IAC3B,YAAY,EAAE,OAAC;SACZ,MAAM,CAAC;QACN,QAAQ,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;KACzC,CAAC;SACD,QAAQ,EAAE;CACd,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;GAEG;AACU,QAAA,2BAA2B,GAAG,OAAC;KACzC,MAAM,CAAC;IACN,eAAe,EAAE,OAAC,CAAC,MAAM,EAAE;IAC3B,YAAY,EAAE,OAAC,CAAC,MAAM,CAAC;QACrB,UAAU,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;KACzD,CAAC;IACF,WAAW,EAAE,gCAAwB;CACtC,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;GAEG;AACU,QAAA,0BAA0B,GAAG,OAAC;KACxC,MAAM,CAAC;IACN,SAAS,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC;CAC7C,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;GAEG;AACU,QAAA,iCAAiC,GAAG,OAAC;KAC/C,MAAM,CAAC;IACN,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE;CAC3B,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;GAEG;AACU,QAAA,2BAA2B,GAAG,OAAC,CAAC,MAAM,CAAC;IAClD,IAAI,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;IAC3C,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC3B,CAAC,CAAC;AAEH;;GAEG;AACU,QAAA,2BAA2B,GAAG,OAAC;KACzC,MAAM,CAAC;IACN,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,mCAA2B,CAAC;IAC7C,iBAAiB,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC/D,KAAK,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;CACpD,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;GAEG;AACU,QAAA,8BAA8B,GAAG,OAAC;KAC5C,MAAM,CAAC;IACN,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;GAEG;AACU,QAAA,2BAA2B,GAAG,OAAC;KACzC,MAAM,CAAC;IACN,QAAQ,EAAE,0BAAkB;CAC7B,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;GAEG;AACU,QAAA,kCAAkC,GAAG,OAAC;KAChD,MAAM,CAAC;IACN,OAAO,EAAE,gCAAwB,CAAC,OAAO,EAAE;CAC5C,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;GAEG;AACU,QAAA,yBAAyB,GAAG,OAAC;KACvC,MAAM,CAAC;IACN,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CACtB,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;GAEG;AACU,QAAA,wBAAwB,GAAG,OAAC;KACtC,MAAM,CAAC;IACN,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CAC3B,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,+CAA+C;AAC/C,8BAA8B;AAC9B,+CAA+C;AAE/C;;GAEG;AACU,QAAA,gCAAgC,GAAG,OAAC;KAC9C,MAAM,CAAC;IACN,SAAS,EAAE,OAAC,CAAC,KAAK,CAAC,6BAAqB,CAAC;CAC1C,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,+CAA+C;AAC/C,iCAAiC;AACjC,+CAA+C;AAE/C;;GAEG;AACU,QAAA,gBAAgB,GAAG,OAAC;KAC9B,MAAM,CAAC;IACN,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE;IAC3D,aAAa,EAAE,6BAAqB,CAAC,QAAQ,EAAE;CAChD,CAAC;KACD,WAAW,EAAE,CAAC,CAAC,4CAA4C;AAE9D,+CAA+C;AAC/C,qBAAqB;AACrB,+CAA+C;AAE/C;;GAEG;AACH,SAAgB,oBAAoB,CAAC,GAAW;IAC9C,OAAO,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;AACnD,CAAC;AAED;;GAEG;AACH,SAAgB,sBAAsB,CAAC,OAAe;IACpD,4CAA4C;IAC5C,OAAO,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAC7C,CAAC;AAED;;GAEG;AACH,SAAgB,eAAe,CAAC,IAAa;IAC3C,MAAM,MAAM,GAAG,wBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAChD,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;AAC7C,CAAC;AAED;;GAEG;AACH,SAAgB,gBAAgB,CAAC,IAAa;IAC5C,MAAM,MAAM,GAAG,gCAAwB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxD,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;AAC7C,CAAC;AAED;;GAEG;AACU,QAAA,wBAAwB,GAAG,iCAAyB,CAAC","sourcesContent":["/**\n * @file schemas.ts\n * @description Zod schemas for MCP Apps specification validation.\n *\n * @module @frontmcp/sdk/mcp-apps/schemas\n */\n\nimport { z } from 'zod';\nimport { MCP_APPS_MIME_TYPE, MCP_APPS_PROTOCOL_VERSION } from './types';\n\n// ============================================\n// Basic Schemas\n// ============================================\n\n/**\n * MCP Apps MIME type schema.\n */\nexport const McpAppsMimeTypeSchema = z.literal(MCP_APPS_MIME_TYPE);\n\n/**\n * Display mode schema.\n */\nexport const McpAppsDisplayModeSchema = z.enum(['inline', 'fullscreen', 'pip']);\n\n/**\n * Platform type schema.\n */\nexport const McpAppsPlatformSchema = z.enum(['web', 'desktop', 'mobile']);\n\n/**\n * Theme schema.\n */\nexport const ThemeSchema = z.enum(['light', 'dark']);\n\n// ============================================\n// CSP Schema\n// ============================================\n\n/**\n * Content Security Policy schema.\n */\nexport const McpAppsCSPSchema = z\n .object({\n connectDomains: z.array(z.string().url()).optional(),\n resourceDomains: z.array(z.string().url()).optional(),\n })\n .strict();\n\n// ============================================\n// UI Resource Schemas\n// ============================================\n\n/**\n * UI Resource metadata schema.\n */\nexport const UIResourceMetaSchema = z\n .object({\n csp: McpAppsCSPSchema.optional(),\n domain: z.string().optional(),\n prefersBorder: z.boolean().optional(),\n })\n .strict();\n\n/**\n * UI Resource schema.\n */\nexport const UIResourceSchema = z\n .object({\n uri: z.string().startsWith('ui://'),\n name: z.string().min(1),\n description: z.string().optional(),\n mimeType: McpAppsMimeTypeSchema,\n _meta: z\n .object({\n ui: UIResourceMetaSchema.optional(),\n })\n .optional(),\n })\n .strict();\n\n// ============================================\n// Host Context Schemas\n// ============================================\n\n/**\n * Device capabilities schema.\n */\nexport const DeviceCapabilitiesSchema = z\n .object({\n touch: z.boolean().optional(),\n hover: z.boolean().optional(),\n })\n .strict();\n\n/**\n * Safe area insets schema.\n */\nexport const SafeAreaInsetsSchema = z\n .object({\n top: z.number(),\n right: z.number(),\n bottom: z.number(),\n left: z.number(),\n })\n .strict();\n\n/**\n * Viewport info schema.\n */\nexport const ViewportInfoSchema = z\n .object({\n width: z.number().positive(),\n height: z.number().positive(),\n maxHeight: z.number().positive().optional(),\n maxWidth: z.number().positive().optional(),\n })\n .strict();\n\n/**\n * Tool info schema.\n */\nexport const ToolInfoSchema = z\n .object({\n id: z.union([z.string(), z.number()]).optional(),\n tool: z.object({\n name: z.string().min(1),\n description: z.string().optional(),\n inputSchema: z.record(z.string(), z.unknown()).optional(),\n }),\n })\n .strict();\n\n/**\n * Host context schema.\n */\nexport const McpAppsHostContextSchema = z\n .object({\n toolInfo: ToolInfoSchema.optional(),\n theme: ThemeSchema.optional(),\n displayMode: McpAppsDisplayModeSchema.optional(),\n viewport: ViewportInfoSchema.optional(),\n locale: z.string().optional(),\n timeZone: z.string().optional(),\n platform: McpAppsPlatformSchema.optional(),\n deviceCapabilities: DeviceCapabilitiesSchema.optional(),\n safeAreaInsets: SafeAreaInsetsSchema.optional(),\n })\n .strict();\n\n// ============================================\n// JSON-RPC Schemas\n// ============================================\n\n/**\n * JSON-RPC error schema.\n */\nexport const JsonRpcErrorSchema = z\n .object({\n code: z.number().int(),\n message: z.string(),\n data: z.unknown().optional(),\n })\n .strict();\n\n/**\n * JSON-RPC request schema.\n */\nexport const JsonRpcRequestSchema = z\n .object({\n jsonrpc: z.literal('2.0'),\n id: z.union([z.string(), z.number()]),\n method: z.string().min(1),\n params: z.unknown().optional(),\n })\n .strict();\n\n/**\n * JSON-RPC response schema.\n */\nexport const JsonRpcResponseSchema = z\n .object({\n jsonrpc: z.literal('2.0'),\n id: z.union([z.string(), z.number()]),\n result: z.unknown().optional(),\n error: JsonRpcErrorSchema.optional(),\n })\n .strict();\n\n/**\n * JSON-RPC notification schema.\n */\nexport const JsonRpcNotificationSchema = z\n .object({\n jsonrpc: z.literal('2.0'),\n method: z.string().min(1),\n params: z.unknown().optional(),\n })\n .strict();\n\n// ============================================\n// MCP Apps Protocol Message Schemas\n// ============================================\n\n/**\n * UI Initialize params schema.\n */\nexport const McpUiInitializeParamsSchema = z\n .object({\n protocolVersion: z.string(),\n capabilities: z\n .object({\n messages: z.array(z.string()).optional(),\n })\n .optional(),\n })\n .strict();\n\n/**\n * UI Initialize result schema.\n */\nexport const McpUiInitializeResultSchema = z\n .object({\n protocolVersion: z.string(),\n capabilities: z.object({\n extensions: z.record(z.string(), z.unknown()).optional(),\n }),\n hostContext: McpAppsHostContextSchema,\n })\n .strict();\n\n/**\n * Tool input params schema.\n */\nexport const McpUiToolInputParamsSchema = z\n .object({\n arguments: z.record(z.string(), z.unknown()),\n })\n .strict();\n\n/**\n * Tool input partial params schema.\n */\nexport const McpUiToolInputPartialParamsSchema = z\n .object({\n argumentsDelta: z.string(),\n })\n .strict();\n\n/**\n * Tool result content item schema.\n */\nexport const ToolResultContentItemSchema = z.object({\n type: z.enum(['text', 'image', 'resource']),\n text: z.string().optional(),\n data: z.string().optional(),\n mimeType: z.string().optional(),\n uri: z.string().optional(),\n});\n\n/**\n * Tool result params schema.\n */\nexport const McpUiToolResultParamsSchema = z\n .object({\n content: z.array(ToolResultContentItemSchema),\n structuredContent: z.record(z.string(), z.unknown()).optional(),\n _meta: z.record(z.string(), z.unknown()).optional(),\n })\n .strict();\n\n/**\n * Tool cancelled params schema.\n */\nexport const McpUiToolCancelledParamsSchema = z\n .object({\n reason: z.string().optional(),\n })\n .strict();\n\n/**\n * Size change params schema.\n */\nexport const McpUiSizeChangeParamsSchema = z\n .object({\n viewport: ViewportInfoSchema,\n })\n .strict();\n\n/**\n * Host context change params schema.\n */\nexport const McpUiHostContextChangeParamsSchema = z\n .object({\n changes: McpAppsHostContextSchema.partial(),\n })\n .strict();\n\n/**\n * Open link params schema.\n */\nexport const McpUiOpenLinkParamsSchema = z\n .object({\n url: z.string().url(),\n })\n .strict();\n\n/**\n * Message params schema.\n */\nexport const McpUiMessageParamsSchema = z\n .object({\n content: z.string().min(1),\n })\n .strict();\n\n// ============================================\n// Extension Capability Schema\n// ============================================\n\n/**\n * MCP Apps extension capability schema.\n */\nexport const McpAppsExtensionCapabilitySchema = z\n .object({\n mimeTypes: z.array(McpAppsMimeTypeSchema),\n })\n .strict();\n\n// ============================================\n// Tool Metadata Extension Schema\n// ============================================\n\n/**\n * Tool UI metadata schema.\n */\nexport const ToolUIMetaSchema = z\n .object({\n 'ui/resourceUri': z.string().startsWith('ui://').optional(),\n 'ui/mimeType': McpAppsMimeTypeSchema.optional(),\n })\n .passthrough(); // Allow additional platform-specific fields\n\n// ============================================\n// Validation Helpers\n// ============================================\n\n/**\n * Validate a UI resource URI.\n */\nexport function isValidUIResourceUri(uri: string): boolean {\n return uri.startsWith('ui://') && uri.length > 5;\n}\n\n/**\n * Validate MCP Apps protocol version.\n */\nexport function isValidProtocolVersion(version: string): boolean {\n // Accept current version or future versions\n return /^\\d{4}-\\d{2}-\\d{2}$/.test(version);\n}\n\n/**\n * Parse and validate UI resource.\n */\nexport function parseUIResource(data: unknown): z.infer<typeof UIResourceSchema> | null {\n const result = UIResourceSchema.safeParse(data);\n return result.success ? result.data : null;\n}\n\n/**\n * Parse and validate host context.\n */\nexport function parseHostContext(data: unknown): z.infer<typeof McpAppsHostContextSchema> | null {\n const result = McpAppsHostContextSchema.safeParse(data);\n return result.success ? result.data : null;\n}\n\n/**\n * Default protocol version.\n */\nexport const DEFAULT_PROTOCOL_VERSION = MCP_APPS_PROTOCOL_VERSION;\n"]}
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @file template.ts
|
|
3
|
+
* @description MCP Apps HTML template generator.
|
|
4
|
+
*
|
|
5
|
+
* Generates standard HTML5 documents with embedded MCP bridge for MCP Apps spec compliance.
|
|
6
|
+
*
|
|
7
|
+
* @module @frontmcp/sdk/mcp-apps/template
|
|
8
|
+
*/
|
|
9
|
+
import type { McpAppsCSP, ToolInfo } from './types';
|
|
10
|
+
/**
|
|
11
|
+
* Options for generating MCP Apps HTML template.
|
|
12
|
+
*/
|
|
13
|
+
export interface McpAppsTemplateOptions {
|
|
14
|
+
/** Tool information */
|
|
15
|
+
toolInfo?: ToolInfo;
|
|
16
|
+
/** Tool input arguments */
|
|
17
|
+
input?: Record<string, unknown>;
|
|
18
|
+
/** Tool output/result */
|
|
19
|
+
output?: unknown;
|
|
20
|
+
/** Structured content for UI rendering */
|
|
21
|
+
structuredContent?: unknown;
|
|
22
|
+
/** Content Security Policy */
|
|
23
|
+
csp?: McpAppsCSP;
|
|
24
|
+
/** Page title */
|
|
25
|
+
title?: string;
|
|
26
|
+
/** Additional head content (styles, meta tags) */
|
|
27
|
+
headContent?: string;
|
|
28
|
+
/** Main body content (HTML) */
|
|
29
|
+
bodyContent: string;
|
|
30
|
+
/** Additional scripts to include */
|
|
31
|
+
scripts?: string[];
|
|
32
|
+
/** Whether to include the MCP bridge runtime */
|
|
33
|
+
includeBridge?: boolean;
|
|
34
|
+
/** Custom bridge configuration */
|
|
35
|
+
bridgeConfig?: McpAppsBridgeConfig;
|
|
36
|
+
/** Initial theme */
|
|
37
|
+
theme?: 'light' | 'dark';
|
|
38
|
+
/** Debug mode - adds console logging */
|
|
39
|
+
debug?: boolean;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* MCP Apps bridge configuration.
|
|
43
|
+
*/
|
|
44
|
+
export interface McpAppsBridgeConfig {
|
|
45
|
+
/** Protocol version */
|
|
46
|
+
protocolVersion?: string;
|
|
47
|
+
/** Trusted origin for postMessage */
|
|
48
|
+
trustedOrigin?: string;
|
|
49
|
+
/** Request timeout in milliseconds */
|
|
50
|
+
requestTimeout?: number;
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Generate MCP Apps compliant HTML5 document.
|
|
54
|
+
*
|
|
55
|
+
* @param options - Template options
|
|
56
|
+
* @returns Complete HTML5 document string
|
|
57
|
+
*
|
|
58
|
+
* @example
|
|
59
|
+
* ```typescript
|
|
60
|
+
* const html = generateMcpAppsTemplate({
|
|
61
|
+
* title: 'Weather Dashboard',
|
|
62
|
+
* bodyContent: '<div id="weather">Loading...</div>',
|
|
63
|
+
* toolInfo: { tool: { name: 'get_weather' } },
|
|
64
|
+
* input: { city: 'San Francisco' },
|
|
65
|
+
* output: { temperature: 72, condition: 'sunny' },
|
|
66
|
+
* csp: { connectDomains: ['https://api.weather.com'] },
|
|
67
|
+
* });
|
|
68
|
+
* ```
|
|
69
|
+
*/
|
|
70
|
+
export declare function generateMcpAppsTemplate(options: McpAppsTemplateOptions): string;
|
|
71
|
+
/**
|
|
72
|
+
* Wrap existing HTML content in MCP Apps template.
|
|
73
|
+
*
|
|
74
|
+
* @param html - Existing HTML content
|
|
75
|
+
* @param options - Template options (without bodyContent)
|
|
76
|
+
* @returns Complete MCP Apps HTML document
|
|
77
|
+
*/
|
|
78
|
+
export declare function wrapInMcpAppsTemplate(html: string, options: Omit<McpAppsTemplateOptions, 'bodyContent'>): string;
|
|
79
|
+
/**
|
|
80
|
+
* Create a minimal MCP Apps template for simple content.
|
|
81
|
+
*
|
|
82
|
+
* @param content - Simple text or HTML content
|
|
83
|
+
* @param title - Page title
|
|
84
|
+
* @returns Complete MCP Apps HTML document
|
|
85
|
+
*/
|
|
86
|
+
export declare function createSimpleMcpAppsTemplate(content: string, title?: string): string;
|
|
87
|
+
/**
|
|
88
|
+
* Extract body content from MCP Apps template.
|
|
89
|
+
* Useful for testing.
|
|
90
|
+
*
|
|
91
|
+
* @param html - Complete HTML document
|
|
92
|
+
* @returns Body content string or null
|
|
93
|
+
*/
|
|
94
|
+
export declare function extractBodyContent(html: string): string | null;
|