@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,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Platform Adapters
|
|
4
|
+
*
|
|
5
|
+
* Re-exports platform adapter functions from @frontmcp/ui/adapters for SDK consumers.
|
|
6
|
+
* This provides a single source of truth for platform-specific metadata building
|
|
7
|
+
* while maintaining backwards compatibility.
|
|
8
|
+
*
|
|
9
|
+
* @see {@link https://docs.agentfront.dev/docs/servers/tools#tool-ui | Tool UI Documentation}
|
|
10
|
+
*/
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
exports.buildOpenAICSP = exports.buildToolDiscoveryMeta = exports.buildUIMeta = void 0;
|
|
13
|
+
// Re-export platform adapter types and functions from @frontmcp/ui
|
|
14
|
+
var adapters_1 = require("@frontmcp/ui/adapters");
|
|
15
|
+
Object.defineProperty(exports, "buildUIMeta", { enumerable: true, get: function () { return adapters_1.buildUIMeta; } });
|
|
16
|
+
Object.defineProperty(exports, "buildToolDiscoveryMeta", { enumerable: true, get: function () { return adapters_1.buildToolDiscoveryMeta; } });
|
|
17
|
+
Object.defineProperty(exports, "buildOpenAICSP", { enumerable: true, get: function () { return adapters_1.buildOpenAICSP; } });
|
|
18
|
+
//# sourceMappingURL=platform-adapters.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"platform-adapters.js","sourceRoot":"","sources":["../../../../src/tool/ui/platform-adapters.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;AAEH,mEAAmE;AACnE,kDAQ+B;AAH7B,uGAAA,WAAW,OAAA;AACX,kHAAA,sBAAsB,OAAA;AACtB,0GAAA,cAAc,OAAA","sourcesContent":["/**\n * Platform Adapters\n *\n * Re-exports platform adapter functions from @frontmcp/ui/adapters for SDK consumers.\n * This provides a single source of truth for platform-specific metadata building\n * while maintaining backwards compatibility.\n *\n * @see {@link https://docs.agentfront.dev/docs/servers/tools#tool-ui | Tool UI Documentation}\n */\n\n// Re-export platform adapter types and functions from @frontmcp/ui\nexport {\n type AIPlatformType,\n type UIMetadata,\n type BuildUIMetaOptions,\n type BuildToolDiscoveryMetaOptions,\n buildUIMeta,\n buildToolDiscoveryMeta,\n buildOpenAICSP,\n} from '@frontmcp/ui/adapters';\n"]}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Template Helpers
|
|
3
|
+
*
|
|
4
|
+
* Re-exports template helper utilities from @frontmcp/ui/runtime.
|
|
5
|
+
* Also provides individual helper functions for backwards compatibility.
|
|
6
|
+
*
|
|
7
|
+
* @see {@link https://docs.agentfront.dev/docs/servers/tools#tool-ui | Tool UI Documentation}
|
|
8
|
+
*/
|
|
9
|
+
import type { TemplateHelpers } from '../../common/metadata/tool-ui.metadata';
|
|
10
|
+
export { createTemplateHelpers } from '@frontmcp/ui/runtime';
|
|
11
|
+
/**
|
|
12
|
+
* Escape HTML special characters to prevent XSS.
|
|
13
|
+
*/
|
|
14
|
+
export declare function escapeHtml(str: string): string;
|
|
15
|
+
/**
|
|
16
|
+
* Format a date for display.
|
|
17
|
+
* @param date - Date object or ISO string
|
|
18
|
+
* @param format - Optional format: 'iso', 'time', 'datetime', or default (localized date)
|
|
19
|
+
*/
|
|
20
|
+
export declare function formatDate(date: Date | string, format?: string): string;
|
|
21
|
+
/**
|
|
22
|
+
* Format a number as currency.
|
|
23
|
+
* @param amount - The numeric amount
|
|
24
|
+
* @param currency - ISO 4217 currency code (default: 'USD')
|
|
25
|
+
*/
|
|
26
|
+
export declare function formatCurrency(amount: number, currency?: string): string;
|
|
27
|
+
/**
|
|
28
|
+
* Generate a unique ID for DOM elements.
|
|
29
|
+
* @param prefix - Optional prefix for the ID
|
|
30
|
+
*/
|
|
31
|
+
export declare function uniqueId(prefix?: string): string;
|
|
32
|
+
/**
|
|
33
|
+
* Safely embed JSON data in HTML.
|
|
34
|
+
* Escapes characters that could break out of script tags or HTML.
|
|
35
|
+
*/
|
|
36
|
+
export declare function jsonEmbed(data: unknown): string;
|
|
37
|
+
/**
|
|
38
|
+
* Create a TemplateHelpers object with all helper functions.
|
|
39
|
+
* @deprecated Use createTemplateHelpers from @frontmcp/ui/runtime instead
|
|
40
|
+
*/
|
|
41
|
+
export declare function createTemplateHelpersLocal(): TemplateHelpers;
|
|
42
|
+
/**
|
|
43
|
+
* Reset the ID counter (useful for testing).
|
|
44
|
+
* @internal
|
|
45
|
+
*/
|
|
46
|
+
export declare function resetIdCounter(): void;
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Template Helpers
|
|
4
|
+
*
|
|
5
|
+
* Re-exports template helper utilities from @frontmcp/ui/runtime.
|
|
6
|
+
* Also provides individual helper functions for backwards compatibility.
|
|
7
|
+
*
|
|
8
|
+
* @see {@link https://docs.agentfront.dev/docs/servers/tools#tool-ui | Tool UI Documentation}
|
|
9
|
+
*/
|
|
10
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
11
|
+
exports.createTemplateHelpers = void 0;
|
|
12
|
+
exports.escapeHtml = escapeHtml;
|
|
13
|
+
exports.formatDate = formatDate;
|
|
14
|
+
exports.formatCurrency = formatCurrency;
|
|
15
|
+
exports.uniqueId = uniqueId;
|
|
16
|
+
exports.jsonEmbed = jsonEmbed;
|
|
17
|
+
exports.createTemplateHelpersLocal = createTemplateHelpersLocal;
|
|
18
|
+
exports.resetIdCounter = resetIdCounter;
|
|
19
|
+
// Re-export createTemplateHelpers from @frontmcp/ui
|
|
20
|
+
var runtime_1 = require("@frontmcp/ui/runtime");
|
|
21
|
+
Object.defineProperty(exports, "createTemplateHelpers", { enumerable: true, get: function () { return runtime_1.createTemplateHelpers; } });
|
|
22
|
+
// ============================================
|
|
23
|
+
// Individual Helper Functions (Backwards Compatibility)
|
|
24
|
+
// ============================================
|
|
25
|
+
// These are exported individually for SDK consumers who import them directly.
|
|
26
|
+
// For new code, prefer using createTemplateHelpers() instead.
|
|
27
|
+
let idCounter = 0;
|
|
28
|
+
/**
|
|
29
|
+
* Escape HTML special characters to prevent XSS.
|
|
30
|
+
*/
|
|
31
|
+
function escapeHtml(str) {
|
|
32
|
+
if (typeof str !== 'string') {
|
|
33
|
+
return String(str ?? '');
|
|
34
|
+
}
|
|
35
|
+
return str
|
|
36
|
+
.replace(/&/g, '&')
|
|
37
|
+
.replace(/</g, '<')
|
|
38
|
+
.replace(/>/g, '>')
|
|
39
|
+
.replace(/"/g, '"')
|
|
40
|
+
.replace(/'/g, ''');
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Format a date for display.
|
|
44
|
+
* @param date - Date object or ISO string
|
|
45
|
+
* @param format - Optional format: 'iso', 'time', 'datetime', or default (localized date)
|
|
46
|
+
*/
|
|
47
|
+
function formatDate(date, format) {
|
|
48
|
+
const d = typeof date === 'string' ? new Date(date) : date;
|
|
49
|
+
if (isNaN(d.getTime())) {
|
|
50
|
+
return String(date);
|
|
51
|
+
}
|
|
52
|
+
switch (format) {
|
|
53
|
+
case 'iso':
|
|
54
|
+
return d.toISOString();
|
|
55
|
+
case 'time':
|
|
56
|
+
return d.toLocaleTimeString();
|
|
57
|
+
case 'datetime':
|
|
58
|
+
return d.toLocaleString();
|
|
59
|
+
default:
|
|
60
|
+
return d.toLocaleDateString();
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Format a number as currency.
|
|
65
|
+
* @param amount - The numeric amount
|
|
66
|
+
* @param currency - ISO 4217 currency code (default: 'USD')
|
|
67
|
+
*/
|
|
68
|
+
function formatCurrency(amount, currency = 'USD') {
|
|
69
|
+
return new Intl.NumberFormat('en-US', {
|
|
70
|
+
style: 'currency',
|
|
71
|
+
currency,
|
|
72
|
+
}).format(amount);
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* Generate a unique ID for DOM elements.
|
|
76
|
+
* @param prefix - Optional prefix for the ID
|
|
77
|
+
*/
|
|
78
|
+
function uniqueId(prefix = 'mcp') {
|
|
79
|
+
return `${prefix}-${++idCounter}-${Date.now().toString(36)}`;
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Safely embed JSON data in HTML.
|
|
83
|
+
* Escapes characters that could break out of script tags or HTML.
|
|
84
|
+
*/
|
|
85
|
+
function jsonEmbed(data) {
|
|
86
|
+
return JSON.stringify(data)
|
|
87
|
+
.replace(/</g, '\\u003c')
|
|
88
|
+
.replace(/>/g, '\\u003e')
|
|
89
|
+
.replace(/&/g, '\\u0026')
|
|
90
|
+
.replace(/'/g, '\\u0027');
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* Create a TemplateHelpers object with all helper functions.
|
|
94
|
+
* @deprecated Use createTemplateHelpers from @frontmcp/ui/runtime instead
|
|
95
|
+
*/
|
|
96
|
+
function createTemplateHelpersLocal() {
|
|
97
|
+
return {
|
|
98
|
+
escapeHtml,
|
|
99
|
+
formatDate,
|
|
100
|
+
formatCurrency,
|
|
101
|
+
uniqueId,
|
|
102
|
+
jsonEmbed,
|
|
103
|
+
};
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Reset the ID counter (useful for testing).
|
|
107
|
+
* @internal
|
|
108
|
+
*/
|
|
109
|
+
function resetIdCounter() {
|
|
110
|
+
idCounter = 0;
|
|
111
|
+
}
|
|
112
|
+
//# sourceMappingURL=template-helpers.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"template-helpers.js","sourceRoot":"","sources":["../../../../src/tool/ui/template-helpers.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;AAkBH,gCAUC;AAOD,gCAgBC;AAOD,wCAKC;AAMD,4BAEC;AAMD,8BAMC;AAMD,gEAQC;AAMD,wCAEC;AArGD,oDAAoD;AACpD,gDAA6D;AAApD,gHAAA,qBAAqB,OAAA;AAE9B,+CAA+C;AAC/C,wDAAwD;AACxD,+CAA+C;AAC/C,8EAA8E;AAC9E,8DAA8D;AAE9D,IAAI,SAAS,GAAG,CAAC,CAAC;AAElB;;GAEG;AACH,SAAgB,UAAU,CAAC,GAAW;IACpC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,MAAM,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC;IAC3B,CAAC;IACD,OAAO,GAAG;SACP,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;SACtB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC;SACvB,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC7B,CAAC;AAED;;;;GAIG;AACH,SAAgB,UAAU,CAAC,IAAmB,EAAE,MAAe;IAC7D,MAAM,CAAC,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC3D,IAAI,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;QACvB,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAED,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,KAAK;YACR,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;QACzB,KAAK,MAAM;YACT,OAAO,CAAC,CAAC,kBAAkB,EAAE,CAAC;QAChC,KAAK,UAAU;YACb,OAAO,CAAC,CAAC,cAAc,EAAE,CAAC;QAC5B;YACE,OAAO,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAClC,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAAC,MAAc,EAAE,QAAQ,GAAG,KAAK;IAC7D,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE;QACpC,KAAK,EAAE,UAAU;QACjB,QAAQ;KACT,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AACpB,CAAC;AAED;;;GAGG;AACH,SAAgB,QAAQ,CAAC,MAAM,GAAG,KAAK;IACrC,OAAO,GAAG,MAAM,IAAI,EAAE,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;AAC/D,CAAC;AAED;;;GAGG;AACH,SAAgB,SAAS,CAAC,IAAa;IACrC,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SACxB,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC;SACxB,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC;SACxB,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC;SACxB,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;AAC9B,CAAC;AAED;;;GAGG;AACH,SAAgB,0BAA0B;IACxC,OAAO;QACL,UAAU;QACV,UAAU;QACV,cAAc;QACd,QAAQ;QACR,SAAS;KACV,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAgB,cAAc;IAC5B,SAAS,GAAG,CAAC,CAAC;AAChB,CAAC","sourcesContent":["/**\n * Template Helpers\n *\n * Re-exports template helper utilities from @frontmcp/ui/runtime.\n * Also provides individual helper functions for backwards compatibility.\n *\n * @see {@link https://docs.agentfront.dev/docs/servers/tools#tool-ui | Tool UI Documentation}\n */\n\nimport type { TemplateHelpers } from '../../common/metadata/tool-ui.metadata';\n\n// Re-export createTemplateHelpers from @frontmcp/ui\nexport { createTemplateHelpers } from '@frontmcp/ui/runtime';\n\n// ============================================\n// Individual Helper Functions (Backwards Compatibility)\n// ============================================\n// These are exported individually for SDK consumers who import them directly.\n// For new code, prefer using createTemplateHelpers() instead.\n\nlet idCounter = 0;\n\n/**\n * Escape HTML special characters to prevent XSS.\n */\nexport function escapeHtml(str: string): string {\n if (typeof str !== 'string') {\n return String(str ?? '');\n }\n return str\n .replace(/&/g, '&')\n .replace(/</g, '<')\n .replace(/>/g, '>')\n .replace(/\"/g, '"')\n .replace(/'/g, ''');\n}\n\n/**\n * Format a date for display.\n * @param date - Date object or ISO string\n * @param format - Optional format: 'iso', 'time', 'datetime', or default (localized date)\n */\nexport function formatDate(date: Date | string, format?: string): string {\n const d = typeof date === 'string' ? new Date(date) : date;\n if (isNaN(d.getTime())) {\n return String(date);\n }\n\n switch (format) {\n case 'iso':\n return d.toISOString();\n case 'time':\n return d.toLocaleTimeString();\n case 'datetime':\n return d.toLocaleString();\n default:\n return d.toLocaleDateString();\n }\n}\n\n/**\n * Format a number as currency.\n * @param amount - The numeric amount\n * @param currency - ISO 4217 currency code (default: 'USD')\n */\nexport function formatCurrency(amount: number, currency = 'USD'): string {\n return new Intl.NumberFormat('en-US', {\n style: 'currency',\n currency,\n }).format(amount);\n}\n\n/**\n * Generate a unique ID for DOM elements.\n * @param prefix - Optional prefix for the ID\n */\nexport function uniqueId(prefix = 'mcp'): string {\n return `${prefix}-${++idCounter}-${Date.now().toString(36)}`;\n}\n\n/**\n * Safely embed JSON data in HTML.\n * Escapes characters that could break out of script tags or HTML.\n */\nexport function jsonEmbed(data: unknown): string {\n return JSON.stringify(data)\n .replace(/</g, '\\\\u003c')\n .replace(/>/g, '\\\\u003e')\n .replace(/&/g, '\\\\u0026')\n .replace(/'/g, '\\\\u0027');\n}\n\n/**\n * Create a TemplateHelpers object with all helper functions.\n * @deprecated Use createTemplateHelpers from @frontmcp/ui/runtime instead\n */\nexport function createTemplateHelpersLocal(): TemplateHelpers {\n return {\n escapeHtml,\n formatDate,\n formatCurrency,\n uniqueId,\n jsonEmbed,\n };\n}\n\n/**\n * Reset the ID counter (useful for testing).\n * @internal\n */\nexport function resetIdCounter(): void {\n idCounter = 0;\n}\n"]}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* UI Resource Template for ui:// URIs
|
|
3
|
+
*
|
|
4
|
+
* Single URI pattern for widget resources:
|
|
5
|
+
*
|
|
6
|
+
* Static Widget URI: ui://widget/{toolName}.html
|
|
7
|
+
* - Used by OpenAI at discovery/listing time
|
|
8
|
+
* - Returns the pre-compiled static HTML for the tool
|
|
9
|
+
* - Widget reads tool output from platform context (e.g., window.openai.toolOutput)
|
|
10
|
+
*
|
|
11
|
+
* The actual read logic is handled by ReadResourceFlow's ui:// interception
|
|
12
|
+
* in read-resource.flow.ts.
|
|
13
|
+
*
|
|
14
|
+
* IMPORTANT: Resources MUST be visible in resources/list for OpenAI ChatGPT
|
|
15
|
+
* to discover and render widgets.
|
|
16
|
+
*/
|
|
17
|
+
/**
|
|
18
|
+
* Static Widget Resource Template for OpenAI discovery.
|
|
19
|
+
*
|
|
20
|
+
* URI format: ui://widget/{toolName}.html
|
|
21
|
+
*
|
|
22
|
+
* This is the format OpenAI expects in tools/list _meta.openai/outputTemplate.
|
|
23
|
+
* When OpenAI fetches this resource, we return the pre-compiled static HTML for the tool.
|
|
24
|
+
*
|
|
25
|
+
* The widget includes:
|
|
26
|
+
* - FrontMCP Bridge for reading tool output from platform context
|
|
27
|
+
* - CDN scripts for React/MDX/etc (based on uiType)
|
|
28
|
+
* - Pre-transpiled component embedded in HTML
|
|
29
|
+
*
|
|
30
|
+
* At runtime, the widget reads tool output from:
|
|
31
|
+
* - OpenAI: window.openai.toolOutput
|
|
32
|
+
* - Generic: window.__mcpToolOutput
|
|
33
|
+
*/
|
|
34
|
+
export declare const StaticWidgetResourceTemplate: () => import("../../common/decorators/resource.decorator").FrontMcpResourceTemplateExecuteHandler;
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* UI Resource Template for ui:// URIs
|
|
4
|
+
*
|
|
5
|
+
* Single URI pattern for widget resources:
|
|
6
|
+
*
|
|
7
|
+
* Static Widget URI: ui://widget/{toolName}.html
|
|
8
|
+
* - Used by OpenAI at discovery/listing time
|
|
9
|
+
* - Returns the pre-compiled static HTML for the tool
|
|
10
|
+
* - Widget reads tool output from platform context (e.g., window.openai.toolOutput)
|
|
11
|
+
*
|
|
12
|
+
* The actual read logic is handled by ReadResourceFlow's ui:// interception
|
|
13
|
+
* in read-resource.flow.ts.
|
|
14
|
+
*
|
|
15
|
+
* IMPORTANT: Resources MUST be visible in resources/list for OpenAI ChatGPT
|
|
16
|
+
* to discover and render widgets.
|
|
17
|
+
*/
|
|
18
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
+
exports.StaticWidgetResourceTemplate = void 0;
|
|
20
|
+
const resource_decorator_1 = require("../../common/decorators/resource.decorator");
|
|
21
|
+
const template_helpers_1 = require("./template-helpers");
|
|
22
|
+
/**
|
|
23
|
+
* Static Widget Resource Template for OpenAI discovery.
|
|
24
|
+
*
|
|
25
|
+
* URI format: ui://widget/{toolName}.html
|
|
26
|
+
*
|
|
27
|
+
* This is the format OpenAI expects in tools/list _meta.openai/outputTemplate.
|
|
28
|
+
* When OpenAI fetches this resource, we return the pre-compiled static HTML for the tool.
|
|
29
|
+
*
|
|
30
|
+
* The widget includes:
|
|
31
|
+
* - FrontMCP Bridge for reading tool output from platform context
|
|
32
|
+
* - CDN scripts for React/MDX/etc (based on uiType)
|
|
33
|
+
* - Pre-transpiled component embedded in HTML
|
|
34
|
+
*
|
|
35
|
+
* At runtime, the widget reads tool output from:
|
|
36
|
+
* - OpenAI: window.openai.toolOutput
|
|
37
|
+
* - Generic: window.__mcpToolOutput
|
|
38
|
+
*/
|
|
39
|
+
exports.StaticWidgetResourceTemplate = (0, resource_decorator_1.resourceTemplate)({
|
|
40
|
+
name: 'static-widget',
|
|
41
|
+
description: 'Static widget HTML for tool UI (OpenAI discovery)',
|
|
42
|
+
uriTemplate: 'ui://widget/{toolName}.html',
|
|
43
|
+
mimeType: 'text/html+skybridge',
|
|
44
|
+
})((uri, params) => {
|
|
45
|
+
// This handler should NOT be called because ReadResourceFlow
|
|
46
|
+
// intercepts ui:// URIs before reaching the resource instance.
|
|
47
|
+
return {
|
|
48
|
+
contents: [
|
|
49
|
+
{
|
|
50
|
+
uri,
|
|
51
|
+
mimeType: 'text/html+skybridge',
|
|
52
|
+
text: `<!DOCTYPE html>
|
|
53
|
+
<html>
|
|
54
|
+
<head><title>Widget Placeholder</title></head>
|
|
55
|
+
<body>
|
|
56
|
+
<p>Widget for tool: ${(0, template_helpers_1.escapeHtml)(String(params['toolName'] || 'unknown'))}</p>
|
|
57
|
+
<p>This is a placeholder. The actual widget HTML is served from the ToolUIRegistry cache.</p>
|
|
58
|
+
</body>
|
|
59
|
+
</html>`,
|
|
60
|
+
},
|
|
61
|
+
],
|
|
62
|
+
};
|
|
63
|
+
});
|
|
64
|
+
//# sourceMappingURL=ui-resource-template.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ui-resource-template.js","sourceRoot":"","sources":["../../../../src/tool/ui/ui-resource-template.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,mFAA8E;AAC9E,yDAAgD;AAEhD;;;;;;;;;;;;;;;;GAgBG;AACU,QAAA,4BAA4B,GAAG,IAAA,qCAAgB,EAAC;IAC3D,IAAI,EAAE,eAAe;IACrB,WAAW,EAAE,mDAAmD;IAChE,WAAW,EAAE,6BAA6B;IAC1C,QAAQ,EAAE,qBAAqB;CAChC,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;IACjB,6DAA6D;IAC7D,+DAA+D;IAC/D,OAAO;QACL,QAAQ,EAAE;YACR;gBACE,GAAG;gBACH,QAAQ,EAAE,qBAAqB;gBAC/B,IAAI,EAAE;;;;wBAIU,IAAA,6BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,SAAS,CAAC,CAAC;;;QAGnE;aACD;SACF;KACF,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/**\n * UI Resource Template for ui:// URIs\n *\n * Single URI pattern for widget resources:\n *\n * Static Widget URI: ui://widget/{toolName}.html\n * - Used by OpenAI at discovery/listing time\n * - Returns the pre-compiled static HTML for the tool\n * - Widget reads tool output from platform context (e.g., window.openai.toolOutput)\n *\n * The actual read logic is handled by ReadResourceFlow's ui:// interception\n * in read-resource.flow.ts.\n *\n * IMPORTANT: Resources MUST be visible in resources/list for OpenAI ChatGPT\n * to discover and render widgets.\n */\n\nimport { resourceTemplate } from '../../common/decorators/resource.decorator';\nimport { escapeHtml } from './template-helpers';\n\n/**\n * Static Widget Resource Template for OpenAI discovery.\n *\n * URI format: ui://widget/{toolName}.html\n *\n * This is the format OpenAI expects in tools/list _meta.openai/outputTemplate.\n * When OpenAI fetches this resource, we return the pre-compiled static HTML for the tool.\n *\n * The widget includes:\n * - FrontMCP Bridge for reading tool output from platform context\n * - CDN scripts for React/MDX/etc (based on uiType)\n * - Pre-transpiled component embedded in HTML\n *\n * At runtime, the widget reads tool output from:\n * - OpenAI: window.openai.toolOutput\n * - Generic: window.__mcpToolOutput\n */\nexport const StaticWidgetResourceTemplate = resourceTemplate({\n name: 'static-widget',\n description: 'Static widget HTML for tool UI (OpenAI discovery)',\n uriTemplate: 'ui://widget/{toolName}.html',\n mimeType: 'text/html+skybridge',\n})((uri, params) => {\n // This handler should NOT be called because ReadResourceFlow\n // intercepts ui:// URIs before reaching the resource instance.\n return {\n contents: [\n {\n uri,\n mimeType: 'text/html+skybridge',\n text: `<!DOCTYPE html>\n<html>\n<head><title>Widget Placeholder</title></head>\n<body>\n <p>Widget for tool: ${escapeHtml(String(params['toolName'] || 'unknown'))}</p>\n <p>This is a placeholder. The actual widget HTML is served from the ToolUIRegistry cache.</p>\n</body>\n</html>`,\n },\n ],\n };\n});\n"]}
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* UI Resource Handler
|
|
3
|
+
*
|
|
4
|
+
* Handles resources/read requests for ui:// URIs, serving widget HTML
|
|
5
|
+
* from the ToolUIRegistry.
|
|
6
|
+
*
|
|
7
|
+
* Supported URI format:
|
|
8
|
+
* - ui://widget/{toolName}.html - Static widget HTML (pre-compiled at startup)
|
|
9
|
+
*
|
|
10
|
+
* The static widget is registered at server startup for tools with
|
|
11
|
+
* `servingMode: 'static'`. The widget HTML includes the FrontMCP Bridge
|
|
12
|
+
* which reads tool output from the platform context at runtime.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```typescript
|
|
16
|
+
* // Client requests widget HTML (OpenAI discovery)
|
|
17
|
+
* const result = await client.readResource({
|
|
18
|
+
* uri: 'ui://widget/get_weather.html'
|
|
19
|
+
* });
|
|
20
|
+
*
|
|
21
|
+
* // Returns pre-compiled widget with FrontMCP Bridge
|
|
22
|
+
* // Widget reads tool output from window.openai.toolOutput at runtime
|
|
23
|
+
* ```
|
|
24
|
+
*/
|
|
25
|
+
import type { ReadResourceResult } from '@modelcontextprotocol/sdk/types.js';
|
|
26
|
+
import type { AIPlatformType } from '../../notification/notification.service';
|
|
27
|
+
import { type ToolUIRegistry } from '@frontmcp/ui/registry';
|
|
28
|
+
/**
|
|
29
|
+
* Result of handling a UI resource request
|
|
30
|
+
*/
|
|
31
|
+
export interface UIResourceHandleResult {
|
|
32
|
+
/** Whether the URI was handled */
|
|
33
|
+
handled: boolean;
|
|
34
|
+
/** The resource result if handled successfully */
|
|
35
|
+
result?: ReadResourceResult;
|
|
36
|
+
/** Error message if handling failed */
|
|
37
|
+
error?: string;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Options for handling a UI resource read request
|
|
41
|
+
*/
|
|
42
|
+
export interface HandleUIResourceOptions {
|
|
43
|
+
/** The UI resource URI */
|
|
44
|
+
uri: string;
|
|
45
|
+
/** The ToolUIRegistry containing cached HTML */
|
|
46
|
+
registry: ToolUIRegistry;
|
|
47
|
+
/** Platform type of the connected client */
|
|
48
|
+
platformType?: AIPlatformType;
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Handle a UI resource read request
|
|
52
|
+
*
|
|
53
|
+
* @param uri - The UI resource URI
|
|
54
|
+
* @param registry - The ToolUIRegistry containing cached HTML
|
|
55
|
+
* @param platformType - Optional platform type for dynamic MIME type selection
|
|
56
|
+
* @returns Handle result with content or error
|
|
57
|
+
*/
|
|
58
|
+
export declare function handleUIResourceRead(uri: string, registry: ToolUIRegistry, platformType?: AIPlatformType): UIResourceHandleResult;
|
|
59
|
+
/**
|
|
60
|
+
* Options for creating a UI resource handler
|
|
61
|
+
*/
|
|
62
|
+
export interface UIResourceHandlerOptions {
|
|
63
|
+
/** ToolUIRegistry instance */
|
|
64
|
+
registry: ToolUIRegistry;
|
|
65
|
+
/** Optional custom error handler */
|
|
66
|
+
onError?: (error: string, uri: string) => void;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Create a UI resource handler function
|
|
70
|
+
*
|
|
71
|
+
* @param options - Handler options
|
|
72
|
+
* @returns Handler function that can be used in the read-resource flow
|
|
73
|
+
*/
|
|
74
|
+
export declare function createUIResourceHandler(options: UIResourceHandlerOptions): (uri: string) => UIResourceHandleResult;
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* UI Resource Handler
|
|
4
|
+
*
|
|
5
|
+
* Handles resources/read requests for ui:// URIs, serving widget HTML
|
|
6
|
+
* from the ToolUIRegistry.
|
|
7
|
+
*
|
|
8
|
+
* Supported URI format:
|
|
9
|
+
* - ui://widget/{toolName}.html - Static widget HTML (pre-compiled at startup)
|
|
10
|
+
*
|
|
11
|
+
* The static widget is registered at server startup for tools with
|
|
12
|
+
* `servingMode: 'static'`. The widget HTML includes the FrontMCP Bridge
|
|
13
|
+
* which reads tool output from the platform context at runtime.
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```typescript
|
|
17
|
+
* // Client requests widget HTML (OpenAI discovery)
|
|
18
|
+
* const result = await client.readResource({
|
|
19
|
+
* uri: 'ui://widget/get_weather.html'
|
|
20
|
+
* });
|
|
21
|
+
*
|
|
22
|
+
* // Returns pre-compiled widget with FrontMCP Bridge
|
|
23
|
+
* // Widget reads tool output from window.openai.toolOutput at runtime
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
27
|
+
exports.handleUIResourceRead = handleUIResourceRead;
|
|
28
|
+
exports.createUIResourceHandler = createUIResourceHandler;
|
|
29
|
+
const ui_1 = require("@frontmcp/ui");
|
|
30
|
+
const registry_1 = require("@frontmcp/ui/registry");
|
|
31
|
+
/**
|
|
32
|
+
* Generate a placeholder widget HTML that reads from window.openai.toolOutput.
|
|
33
|
+
*
|
|
34
|
+
* Delegates to @frontmcp/ui's createDefaultBaseTemplate which provides:
|
|
35
|
+
* - Tailwind CSS with @theme configuration
|
|
36
|
+
* - Platform polyfills (callTool, detectMcpSession, getToolOutput)
|
|
37
|
+
* - Polling for toolOutput injection
|
|
38
|
+
* - Default JSON renderer (data-type-specific renderers are in @frontmcp/ui)
|
|
39
|
+
*
|
|
40
|
+
* This is returned when the static widget URI is fetched before the tool is called.
|
|
41
|
+
* OpenAI caches this HTML, so it must be dynamic (read toolOutput at runtime).
|
|
42
|
+
*
|
|
43
|
+
* @param toolName - The name of the tool
|
|
44
|
+
* @returns HTML string with a dynamic widget that renders toolOutput
|
|
45
|
+
*/
|
|
46
|
+
function generatePlaceholderWidget(toolName) {
|
|
47
|
+
return (0, ui_1.createDefaultBaseTemplate)({ toolName });
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Handle a UI resource read request
|
|
51
|
+
*
|
|
52
|
+
* @param uri - The UI resource URI
|
|
53
|
+
* @param registry - The ToolUIRegistry containing cached HTML
|
|
54
|
+
* @param platformType - Optional platform type for dynamic MIME type selection
|
|
55
|
+
* @returns Handle result with content or error
|
|
56
|
+
*/
|
|
57
|
+
function handleUIResourceRead(uri, registry, platformType) {
|
|
58
|
+
// Check if this is a UI resource URI
|
|
59
|
+
if (!(0, registry_1.isUIResourceUri)(uri)) {
|
|
60
|
+
return { handled: false };
|
|
61
|
+
}
|
|
62
|
+
// Get the platform-appropriate MIME type
|
|
63
|
+
const mimeType = (0, registry_1.getUIResourceMimeType)(platformType);
|
|
64
|
+
// Try static widget URI (ui://widget/{toolName}.html)
|
|
65
|
+
// This is used by OpenAI at discovery time
|
|
66
|
+
const widgetParsed = (0, registry_1.parseWidgetUri)(uri);
|
|
67
|
+
if (widgetParsed) {
|
|
68
|
+
// Check for pre-compiled static widget from the developer's template
|
|
69
|
+
// Static widgets are compiled at server startup for tools with servingMode: 'static'
|
|
70
|
+
const cachedWidget = registry.getStaticWidget(widgetParsed.toolName);
|
|
71
|
+
if (cachedWidget) {
|
|
72
|
+
// Return the developer's actual template (SSR'd React/MDX component)
|
|
73
|
+
// This template includes the FrontMCP Bridge for runtime data access
|
|
74
|
+
return {
|
|
75
|
+
handled: true,
|
|
76
|
+
result: {
|
|
77
|
+
contents: [
|
|
78
|
+
{
|
|
79
|
+
uri,
|
|
80
|
+
mimeType,
|
|
81
|
+
text: cachedWidget,
|
|
82
|
+
},
|
|
83
|
+
],
|
|
84
|
+
},
|
|
85
|
+
};
|
|
86
|
+
}
|
|
87
|
+
// Fallback to dynamic placeholder widget if no pre-compiled template.
|
|
88
|
+
// This is returned when the tool doesn't have a UI template configured
|
|
89
|
+
// or uses a different serving mode.
|
|
90
|
+
//
|
|
91
|
+
// OpenAI caches widget HTML from outputTemplate URI, so we must return
|
|
92
|
+
// a template that reads from window.openai.toolOutput at runtime.
|
|
93
|
+
const html = generatePlaceholderWidget(widgetParsed.toolName);
|
|
94
|
+
return {
|
|
95
|
+
handled: true,
|
|
96
|
+
result: {
|
|
97
|
+
contents: [
|
|
98
|
+
{
|
|
99
|
+
uri,
|
|
100
|
+
mimeType,
|
|
101
|
+
text: html,
|
|
102
|
+
},
|
|
103
|
+
],
|
|
104
|
+
},
|
|
105
|
+
};
|
|
106
|
+
}
|
|
107
|
+
// Unknown UI resource URI format
|
|
108
|
+
return {
|
|
109
|
+
handled: true,
|
|
110
|
+
error: `Invalid UI resource URI format: ${uri}. Expected: ui://widget/{toolName}.html`,
|
|
111
|
+
};
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* Create a UI resource handler function
|
|
115
|
+
*
|
|
116
|
+
* @param options - Handler options
|
|
117
|
+
* @returns Handler function that can be used in the read-resource flow
|
|
118
|
+
*/
|
|
119
|
+
function createUIResourceHandler(options) {
|
|
120
|
+
const { registry, onError } = options;
|
|
121
|
+
return function handleUIResource(uri) {
|
|
122
|
+
const result = handleUIResourceRead(uri, registry);
|
|
123
|
+
if (result.handled && result.error && onError) {
|
|
124
|
+
onError(result.error, uri);
|
|
125
|
+
}
|
|
126
|
+
return result;
|
|
127
|
+
};
|
|
128
|
+
}
|
|
129
|
+
//# sourceMappingURL=ui-resource.handler.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ui-resource.handler.js","sourceRoot":"","sources":["../../../../src/tool/ui/ui-resource.handler.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;AAkEH,oDAgEC;AAkBD,0DAYC;AA5JD,qCAAyD;AACzD,oDAQ+B;AA0B/B;;;;;;;;;;;;;;GAcG;AACH,SAAS,yBAAyB,CAAC,QAAgB;IACjD,OAAO,IAAA,8BAAyB,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,oBAAoB,CAClC,GAAW,EACX,QAAwB,EACxB,YAA6B;IAE7B,qCAAqC;IACrC,IAAI,CAAC,IAAA,0BAAe,EAAC,GAAG,CAAC,EAAE,CAAC;QAC1B,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC5B,CAAC;IAED,yCAAyC;IACzC,MAAM,QAAQ,GAAG,IAAA,gCAAqB,EAAC,YAAY,CAAC,CAAC;IAErD,sDAAsD;IACtD,2CAA2C;IAC3C,MAAM,YAAY,GAAG,IAAA,yBAAc,EAAC,GAAG,CAAC,CAAC;IACzC,IAAI,YAAY,EAAE,CAAC;QACjB,qEAAqE;QACrE,qFAAqF;QACrF,MAAM,YAAY,GAAG,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACrE,IAAI,YAAY,EAAE,CAAC;YACjB,qEAAqE;YACrE,qEAAqE;YACrE,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,MAAM,EAAE;oBACN,QAAQ,EAAE;wBACR;4BACE,GAAG;4BACH,QAAQ;4BACR,IAAI,EAAE,YAAY;yBACnB;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAED,sEAAsE;QACtE,uEAAuE;QACvE,oCAAoC;QACpC,EAAE;QACF,uEAAuE;QACvE,kEAAkE;QAClE,MAAM,IAAI,GAAG,yBAAyB,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAE9D,OAAO;YACL,OAAO,EAAE,IAAI;YACb,MAAM,EAAE;gBACN,QAAQ,EAAE;oBACR;wBACE,GAAG;wBACH,QAAQ;wBACR,IAAI,EAAE,IAAI;qBACX;iBACF;aACF;SACF,CAAC;IACJ,CAAC;IAED,iCAAiC;IACjC,OAAO;QACL,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,mCAAmC,GAAG,yCAAyC;KACvF,CAAC;AACJ,CAAC;AAYD;;;;;GAKG;AACH,SAAgB,uBAAuB,CAAC,OAAiC;IACvE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAEtC,OAAO,SAAS,gBAAgB,CAAC,GAAW;QAC1C,MAAM,MAAM,GAAG,oBAAoB,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QAEnD,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,KAAK,IAAI,OAAO,EAAE,CAAC;YAC9C,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAC7B,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC","sourcesContent":["/**\n * UI Resource Handler\n *\n * Handles resources/read requests for ui:// URIs, serving widget HTML\n * from the ToolUIRegistry.\n *\n * Supported URI format:\n * - ui://widget/{toolName}.html - Static widget HTML (pre-compiled at startup)\n *\n * The static widget is registered at server startup for tools with\n * `servingMode: 'static'`. The widget HTML includes the FrontMCP Bridge\n * which reads tool output from the platform context at runtime.\n *\n * @example\n * ```typescript\n * // Client requests widget HTML (OpenAI discovery)\n * const result = await client.readResource({\n * uri: 'ui://widget/get_weather.html'\n * });\n *\n * // Returns pre-compiled widget with FrontMCP Bridge\n * // Widget reads tool output from window.openai.toolOutput at runtime\n * ```\n */\n\nimport type { ReadResourceResult } from '@modelcontextprotocol/sdk/types.js';\nimport type { AIPlatformType } from '../../notification/notification.service';\nimport { createDefaultBaseTemplate } from '@frontmcp/ui';\nimport {\n type ToolUIRegistry,\n UI_RESOURCE_SCHEME,\n isUIResourceUri,\n isStaticWidgetUri,\n parseWidgetUri,\n getUIResourceMimeType,\n type ParsedWidgetUri,\n} from '@frontmcp/ui/registry';\n\n/**\n * Result of handling a UI resource request\n */\nexport interface UIResourceHandleResult {\n /** Whether the URI was handled */\n handled: boolean;\n /** The resource result if handled successfully */\n result?: ReadResourceResult;\n /** Error message if handling failed */\n error?: string;\n}\n\n/**\n * Options for handling a UI resource read request\n */\nexport interface HandleUIResourceOptions {\n /** The UI resource URI */\n uri: string;\n /** The ToolUIRegistry containing cached HTML */\n registry: ToolUIRegistry;\n /** Platform type of the connected client */\n platformType?: AIPlatformType;\n}\n\n/**\n * Generate a placeholder widget HTML that reads from window.openai.toolOutput.\n *\n * Delegates to @frontmcp/ui's createDefaultBaseTemplate which provides:\n * - Tailwind CSS with @theme configuration\n * - Platform polyfills (callTool, detectMcpSession, getToolOutput)\n * - Polling for toolOutput injection\n * - Default JSON renderer (data-type-specific renderers are in @frontmcp/ui)\n *\n * This is returned when the static widget URI is fetched before the tool is called.\n * OpenAI caches this HTML, so it must be dynamic (read toolOutput at runtime).\n *\n * @param toolName - The name of the tool\n * @returns HTML string with a dynamic widget that renders toolOutput\n */\nfunction generatePlaceholderWidget(toolName: string): string {\n return createDefaultBaseTemplate({ toolName });\n}\n\n/**\n * Handle a UI resource read request\n *\n * @param uri - The UI resource URI\n * @param registry - The ToolUIRegistry containing cached HTML\n * @param platformType - Optional platform type for dynamic MIME type selection\n * @returns Handle result with content or error\n */\nexport function handleUIResourceRead(\n uri: string,\n registry: ToolUIRegistry,\n platformType?: AIPlatformType,\n): UIResourceHandleResult {\n // Check if this is a UI resource URI\n if (!isUIResourceUri(uri)) {\n return { handled: false };\n }\n\n // Get the platform-appropriate MIME type\n const mimeType = getUIResourceMimeType(platformType);\n\n // Try static widget URI (ui://widget/{toolName}.html)\n // This is used by OpenAI at discovery time\n const widgetParsed = parseWidgetUri(uri);\n if (widgetParsed) {\n // Check for pre-compiled static widget from the developer's template\n // Static widgets are compiled at server startup for tools with servingMode: 'static'\n const cachedWidget = registry.getStaticWidget(widgetParsed.toolName);\n if (cachedWidget) {\n // Return the developer's actual template (SSR'd React/MDX component)\n // This template includes the FrontMCP Bridge for runtime data access\n return {\n handled: true,\n result: {\n contents: [\n {\n uri,\n mimeType,\n text: cachedWidget,\n },\n ],\n },\n };\n }\n\n // Fallback to dynamic placeholder widget if no pre-compiled template.\n // This is returned when the tool doesn't have a UI template configured\n // or uses a different serving mode.\n //\n // OpenAI caches widget HTML from outputTemplate URI, so we must return\n // a template that reads from window.openai.toolOutput at runtime.\n const html = generatePlaceholderWidget(widgetParsed.toolName);\n\n return {\n handled: true,\n result: {\n contents: [\n {\n uri,\n mimeType,\n text: html,\n },\n ],\n },\n };\n }\n\n // Unknown UI resource URI format\n return {\n handled: true,\n error: `Invalid UI resource URI format: ${uri}. Expected: ui://widget/{toolName}.html`,\n };\n}\n\n/**\n * Options for creating a UI resource handler\n */\nexport interface UIResourceHandlerOptions {\n /** ToolUIRegistry instance */\n registry: ToolUIRegistry;\n /** Optional custom error handler */\n onError?: (error: string, uri: string) => void;\n}\n\n/**\n * Create a UI resource handler function\n *\n * @param options - Handler options\n * @returns Handler function that can be used in the read-resource flow\n */\nexport function createUIResourceHandler(options: UIResourceHandlerOptions) {\n const { registry, onError } = options;\n\n return function handleUIResource(uri: string): UIResourceHandleResult {\n const result = handleUIResourceRead(uri, registry);\n\n if (result.handled && result.error && onError) {\n onError(result.error, uri);\n }\n\n return result;\n };\n}\n"]}
|
|
@@ -6,7 +6,7 @@ import { InMemoryEventStore } from '../transport.event-store';
|
|
|
6
6
|
import { AuthInfo } from '@modelcontextprotocol/sdk/server/auth/types.js';
|
|
7
7
|
import { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js';
|
|
8
8
|
import { SSEServerTransport } from '../legacy/legacy.sse.tranporter';
|
|
9
|
-
import {
|
|
9
|
+
import { ZodType } from 'zod';
|
|
10
10
|
import { FrontMcpLogger, ServerResponse } from '../../common';
|
|
11
11
|
import { Scope } from '../../scope';
|
|
12
12
|
export declare abstract class LocalTransportAdapter<T extends StreamableHTTPServerTransport | SSEServerTransport> {
|
|
@@ -26,7 +26,7 @@ export declare abstract class LocalTransportAdapter<T extends StreamableHTTPServ
|
|
|
26
26
|
constructor(scope: Scope, key: TransportKey, onDispose: () => void, res: ServerResponse);
|
|
27
27
|
abstract createTransport(sessionId: string, response: ServerResponse): T;
|
|
28
28
|
abstract initialize(req: AuthenticatedServerRequest, res: ServerResponse): Promise<void>;
|
|
29
|
-
abstract sendElicitRequest<T extends
|
|
29
|
+
abstract sendElicitRequest<T extends ZodType>(relatedRequestId: RequestId, message: string, requestedSchema: T): Promise<TypedElicitResult<T>>;
|
|
30
30
|
abstract handleRequest(req: AuthenticatedServerRequest, res: ServerResponse): Promise<void>;
|
|
31
31
|
connectServer(): Promise<void>;
|
|
32
32
|
get newRequestId(): RequestId;
|
|
@@ -27,17 +27,30 @@ class LocalTransportAdapter {
|
|
|
27
27
|
}
|
|
28
28
|
connectServer() {
|
|
29
29
|
const { info } = this.scope.metadata;
|
|
30
|
-
//
|
|
30
|
+
// Check if completions capability should be enabled (when prompts or resources are present)
|
|
31
|
+
const hasPrompts = this.scope.prompts.hasAny();
|
|
32
|
+
const hasResources = this.scope.resources.hasAny();
|
|
33
|
+
const hasTools = this.scope.tools.hasAny();
|
|
34
|
+
const completionsCapability = hasPrompts || hasResources ? { completions: {} } : {};
|
|
31
35
|
const serverOptions = {
|
|
32
36
|
instructions: '',
|
|
33
37
|
capabilities: {
|
|
34
|
-
tools
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
+
...this.scope.tools.getCapabilities(),
|
|
39
|
+
...this.scope.resources.getCapabilities(),
|
|
40
|
+
...this.scope.prompts.getCapabilities(),
|
|
41
|
+
...completionsCapability,
|
|
42
|
+
// MCP logging protocol support - allows clients to set log level via logging/setLevel
|
|
43
|
+
logging: {},
|
|
38
44
|
},
|
|
39
45
|
serverInfo: info,
|
|
40
46
|
};
|
|
47
|
+
this.logger.info('connectServer: advertising capabilities', {
|
|
48
|
+
hasTools,
|
|
49
|
+
hasResources,
|
|
50
|
+
hasPrompts,
|
|
51
|
+
capabilities: JSON.stringify(serverOptions.capabilities),
|
|
52
|
+
serverInfo: JSON.stringify(serverOptions.serverInfo),
|
|
53
|
+
});
|
|
41
54
|
this.server = new index_js_1.Server(info, serverOptions);
|
|
42
55
|
const handlers = (0, mcp_handlers_1.createMcpHandlers)({
|
|
43
56
|
scope: this.scope,
|
|
@@ -46,6 +59,8 @@ class LocalTransportAdapter {
|
|
|
46
59
|
for (const handler of handlers) {
|
|
47
60
|
this.server.setRequestHandler(handler.requestSchema, handler.handler);
|
|
48
61
|
}
|
|
62
|
+
// Register server with notification service for server→client notifications
|
|
63
|
+
this.scope.notifications.registerServer(this.key.sessionId, this.server);
|
|
49
64
|
return this.server.connect(this.transport);
|
|
50
65
|
}
|
|
51
66
|
get newRequestId() {
|
|
@@ -53,6 +68,8 @@ class LocalTransportAdapter {
|
|
|
53
68
|
}
|
|
54
69
|
async destroy(reason) {
|
|
55
70
|
console.log('destroying transporter, reason:', reason);
|
|
71
|
+
// Unregister server from notification service
|
|
72
|
+
this.scope.notifications.unregisterServer(this.key.sessionId);
|
|
56
73
|
try {
|
|
57
74
|
// if(!this.transport.closed){
|
|
58
75
|
// this.transport.close();
|
|
@@ -92,11 +109,15 @@ class LocalTransportAdapter {
|
|
|
92
109
|
}
|
|
93
110
|
ensureAuthInfo(req, transport) {
|
|
94
111
|
const { token, user, session } = req[common_1.ServerRequestTokens.auth];
|
|
112
|
+
// Session should always exist now (created in session.verify for public mode)
|
|
113
|
+
// But add defensive fallback for safety in case session is undefined
|
|
114
|
+
const sessionId = session?.id ?? `fallback:${Date.now()}`;
|
|
115
|
+
const sessionPayload = session?.payload ?? { protocol: 'streamable-http' };
|
|
95
116
|
req.auth = {
|
|
96
117
|
token,
|
|
97
118
|
user,
|
|
98
|
-
sessionId
|
|
99
|
-
sessionIdPayload:
|
|
119
|
+
sessionId,
|
|
120
|
+
sessionIdPayload: sessionPayload,
|
|
100
121
|
scopes: [],
|
|
101
122
|
clientId: user.sub ?? '',
|
|
102
123
|
transport,
|