@viaalink/caddy-api-client 0.0.0-stage → 0.10.0

package/dist/generated/extension-assets.d.ts

@@ -0,0 +1,92 @@
+/**
+ * Extension assets for VSCode extension and tooling
+ *
+ * AUTO-GENERATED FILE - DO NOT EDIT
+ * Generated from source files by scripts/extract-metadata.ts
+ * Run: npm run generate:extension
+ *
+ * @generated
+ * @version 0.5.2
+ * @generatedAt 2026-04-01T16:38:14.519Z
+ */
+interface ParamMetadata {
+    name: string;
+    type: string;
+    required: boolean;
+    description: string;
+    default?: string;
+    example?: string;
+}
+interface SnippetDefinition {
+    prefix: string;
+    body: string[];
+    description: string;
+}
+interface BuilderMetadata {
+    name: string;
+    description: string;
+    params: ParamMetadata[];
+    returnType: string;
+    example?: string;
+    snippet: SnippetDefinition;
+}
+interface HandlerMetadata {
+    name: string;
+    displayName: string;
+    description: string;
+    discriminator: string;
+    commonFields: string[];
+    caddyDocsPath: string;
+}
+/**
+ * Library version this metadata was generated from
+ */
+declare const METADATA_VERSION = "0.5.2";
+/**
+ * Timestamp when this metadata was generated
+ */
+declare const GENERATED_AT = "2026-04-01T16:38:14.519Z";
+/**
+ * Builder function metadata extracted from JSDoc and type definitions
+ *
+ * Use this for:
+ * - Generating VSCode snippets
+ * - Powering wizard step generation
+ * - Providing hover documentation
+ */
+declare const BUILDER_METADATA: Record<string, BuilderMetadata>;
+/**
+ * Handler type metadata for Caddy route handlers
+ *
+ * Use this for:
+ * - Autocomplete for handler discriminator
+ * - Hover documentation with Caddy docs links
+ * - Handler-specific field suggestions
+ */
+declare const HANDLER_METADATA: Record<string, HandlerMetadata>;
+/**
+ * All handler discriminator values for autocomplete
+ */
+declare const HANDLER_NAMES: readonly string[];
+/**
+ * All builder function names for autocomplete
+ */
+declare const BUILDER_NAMES: readonly string[];
+/**
+ * Get snippets in VSCode snippet format
+ */
+declare function getVSCodeSnippets(): Record<string, {
+    prefix: string;
+    body: string[];
+    description: string;
+}>;
+/**
+ * Get handler completion items for VSCode
+ */
+declare function getHandlerCompletions(): Array<{
+    label: string;
+    detail: string;
+    documentation: string;
+}>;
+
+export { BUILDER_METADATA, BUILDER_NAMES, type BuilderMetadata, GENERATED_AT, HANDLER_METADATA, HANDLER_NAMES, type HandlerMetadata, METADATA_VERSION, type ParamMetadata, type SnippetDefinition, getHandlerCompletions, getVSCodeSnippets };

package/dist/generated/extension-assets.js

@@ -0,0 +1,302 @@
+var a="0.5.2",o="2026-04-01T16:38:14.519Z",t={buildLocalIdentityStore:{name:"buildLocalIdentityStore",description:`Build a local identity store configuration
+
+Creates a local JSON file-based identity store for user credentials.
+Uses the authcrunch wrapper structure: name, kind, params`,params:[{name:"name",type:"string",required:false,description:"Name of the identity store (used to reference it in portals)",default:"local"},{name:"path",type:"string",required:true,description:"Path to the JSON file containing user credentials"},{name:"realm",type:"string",required:false,description:"Realm name for this identity store",default:"local"}],returnType:"LocalIdentityStore",example:`import { buildLocalIdentityStore } from "@.../caddy-api-client/plugins/caddy-security";
+
+const store = buildLocalIdentityStore({
+  name: "localdb",
+  path: "/etc/caddy/users.json",
+  realm: "local",
+});`,snippet:{prefix:"caddy-local-identity-store",body:["buildLocalIdentityStore({","  // name: ${1:local},","  path: ${2:/etc/caddy/config.json},","  // realm: ${3:local}","})"],description:"Build Local Identity Store"}},buildLdapIdentityStore:{name:"buildLdapIdentityStore",description:`Build an LDAP identity store configuration
+
+Creates an LDAP-based identity store for user authentication.
+Uses the authcrunch wrapper structure: name, kind, params`,params:[{name:"name",type:"string",required:false,description:"Name of the identity store (used to reference it in portals)",default:"ldapdb"},{name:"realm",type:"string",required:false,description:"Realm name for this identity store",default:"ldap"},{name:"servers",type:"LdapServerConfig[]",required:true,description:"LDAP server(s) to connect to"},{name:"bindUsername",type:"string",required:true,description:"Bind username for LDAP queries (full DN)",example:"cn=admin,dc=example,dc=com"},{name:"bindPassword",type:"string",required:true,description:"Bind password for LDAP authentication"},{name:"searchBaseDn",type:"string",required:true,description:"Base DN for user searches",example:"ou=users,dc=example,dc=com"},{name:"searchUserFilter",type:"string",required:false,description:"LDAP search filter template for users",default:"(uid={username})"},{name:"groups",type:"LdapGroupConfig[]",required:false,description:"Group to role mappings",default:"[]"}],returnType:"LdapIdentityStore",example:`import { buildLdapIdentityStore } from "@.../caddy-api-client/plugins/caddy-security";
+
+const store = buildLdapIdentityStore({
+  name: "ldapdb",
+  servers: [{ address: "ldap.example.com", port: 389 }],
+  bindUsername: "cn=admin,dc=example,dc=com",
+  bindPassword: "secret",
+  searchBaseDn: "ou=users,dc=example,dc=com",
+  searchUserFilter: "(uid={username})",
+});`,snippet:{prefix:"caddy-ldap-identity-store",body:["buildLdapIdentityStore({","  // name: ${1:ldapdb},","  // realm: ${2:ldap},",'  servers: ${3:""},',"  bindUsername: ${4:my-name},",'  bindPassword: ${5:""},','  searchBaseDn: ${6:""},',"  // searchUserFilter: ${7:(uid={username})},","  // groups: ${8:[]}","})"],description:"Build LDAP Identity Store"}},buildOAuth2Provider:{name:"buildOAuth2Provider",description:`Build an OAuth2 identity provider configuration
+
+Uses the authcrunch wrapper structure: name, kind, params`,params:[{name:"name",type:"string",required:false,description:"Name of the identity provider (used to reference it in portals)"},{name:"realm",type:"string",required:false,description:"Realm name for this provider"},{name:"provider",type:"string",required:true,description:"Provider name/driver (github, google, facebook, etc.)"},{name:"clientId",type:"string",required:true,description:"OAuth client ID"},{name:"clientSecret",type:"string",required:true,description:"OAuth client secret"},{name:"scopes",type:"string[]",required:false,description:"OAuth scopes to request",default:'["openid", "email", "profile"]'},{name:"authorizationUrl",type:"string",required:false,description:"Authorization URL (for non-standard providers)"},{name:"tokenUrl",type:"string",required:false,description:"Token URL (for non-standard providers)"}],returnType:"OAuth2IdentityProvider",example:`import { buildOAuth2Provider } from "@.../caddy-api-client/plugins/caddy-security";
+
+const provider = buildOAuth2Provider({
+  name: "github",
+  provider: "github",
+  clientId: "your-client-id",
+  clientSecret: "your-client-secret",
+  scopes: ["user:email", "read:user"],
+});`,snippet:{prefix:"caddy-oauth2-provider",body:["buildOAuth2Provider({",'  provider: ${1:""},',"  clientId: ${2:your-client-id},","  clientSecret: ${3:your-client-secret},",'  // scopes: ${4:["openid", "email", "profile"]},',"})"],description:"Build OAuth2 Provider"}},buildOidcProvider:{name:"buildOidcProvider",description:`Build an OIDC identity provider configuration
+
+Uses the authcrunch wrapper structure: name, kind, params`,params:[{name:"name",type:"string",required:false,description:"Name of the identity provider (used to reference it in portals)"},{name:"realm",type:"string",required:false,description:"Realm name for this provider"},{name:"provider",type:"string",required:true,description:"OIDC provider name (keycloak, okta, auth0, etc.)"},{name:"clientId",type:"string",required:true,description:"Client ID"},{name:"clientSecret",type:"string",required:true,description:"Client secret"},{name:"metadataUrl",type:"string",required:true,description:"OIDC metadata/discovery URL (.well-known/openid-configuration)",example:"https://keycloak.example.com/realms/myrealm/.well-known/openid-configuration"},{name:"scopes",type:"string[]",required:false,description:"Scopes to request",default:'["openid", "email", "profile"]'}],returnType:"OidcIdentityProvider",example:`import { buildOidcProvider } from "@.../caddy-api-client/plugins/caddy-security";
+
+const provider = buildOidcProvider({
+  name: "keycloak",
+  provider: "keycloak",
+  clientId: "my-app",
+  clientSecret: "secret",
+  metadataUrl: "https://keycloak.example.com/realms/myrealm/.well-known/openid-configuration",
+});`,snippet:{prefix:"caddy-oidc-provider",body:["buildOidcProvider({",'  provider: ${1:""},',"  clientId: ${2:your-client-id},","  clientSecret: ${3:your-client-secret},",'  metadataUrl: ${4:""},','  // scopes: ${5:["openid", "email", "profile"]},',"})"],description:"Build OIDC Provider"}},buildAuthenticationPortal:{name:"buildAuthenticationPortal",description:"Build an authentication portal configuration",params:[{name:"name",type:"string",required:true,description:"Portal name (referenced by portal_name in handlers)"},{name:"ui",type:"PortalUiOptions",required:false,description:"UI customization settings"},{name:"cookie",type:"CookieOptions",required:false,description:"Cookie settings"},{name:"identityStores",type:"string[]",required:false,description:"Identity store names enabled for this portal"},{name:"identityProviders",type:"string[]",required:false,description:"Identity provider names enabled for this portal"},{name:"transformUser",type:"Record<string, unknown>",required:false,description:"Transform rules for user claims"}],returnType:"AuthenticationPortal",example:`import { buildAuthenticationPortal } from "@.../caddy-api-client/plugins/caddy-security";
+
+const portal = buildAuthenticationPortal({
+  name: "myportal",
+  identityStores: ["localdb"],
+  identityProviders: ["keycloak"],
+  cookie: { domain: ".example.com", lifetime: "24h" },
+});`,snippet:{prefix:"caddy-authentication-portal",body:["buildAuthenticationPortal({","  name: ${1:my-name},","})"],description:"Build Authentication Portal"}},buildAuthorizationPolicy:{name:"buildAuthorizationPolicy",description:"Build an authorization policy (gatekeeper) configuration",params:[{name:"name",type:"string",required:true,description:"Policy name (referenced by gatekeeper_name in handlers)"},{name:"accessLists",type:"AccessListEntry[]",required:false,description:"Access control lists"},{name:"cryptoKey",type:"CryptoKeyConfig",required:false,description:"Crypto key configuration for JWT validation"},{name:"bypass",type:"string[]",required:false,description:"Bypass paths (no auth required)"}],returnType:"AuthorizationPolicy",example:`import { buildAuthorizationPolicy } from "@.../caddy-api-client/plugins/caddy-security";
+
+const policy = buildAuthorizationPolicy({
+  name: "admin-policy",
+  accessLists: [
+    { claim: "roles", values: ["admin", "editor"], action: "allow" },
+  ],
+  bypass: ["/health", "/metrics"],
+});`,snippet:{prefix:"caddy-authorization-policy",body:["buildAuthorizationPolicy({","  name: ${1:my-name},","})"],description:"Build Authorization Policy"}},buildSecurityConfig:{name:"buildSecurityConfig",description:"Build a security configuration",params:[{name:"portals",type:"AuthenticationPortal[]",required:false,description:"Authentication portals"},{name:"policies",type:"AuthorizationPolicy[]",required:false,description:"Authorization policies (gatekeepers)"},{name:"identityStores",type:"(LocalIdentityStore | LdapIdentityStore)[]",required:false,description:"Identity stores"},{name:"identityProviders",type:"(OAuth2IdentityProvider | OidcIdentityProvider)[]",required:false,description:"Identity providers"}],returnType:"SecurityConfig",example:`import {
+  buildSecurityConfig,
+  buildLocalIdentityStore,
+  buildAuthenticationPortal,
+  buildAuthorizationPolicy,
+} from "@.../caddy-api-client/plugins/caddy-security";
+
+const config = buildSecurityConfig({
+  identityStores: [
+    buildLocalIdentityStore({ path: "/etc/caddy/users.json" }),
+  ],
+  portals: [
+    buildAuthenticationPortal({
+      name: "myportal",
+      identityStores: ["local"],
+    }),
+  ],
+  policies: [
+    buildAuthorizationPolicy({
+      name: "mypolicy",
+      accessLists: [{ claim: "roles", values: ["user"] }],
+    }),
+  ],
+});`,snippet:{prefix:"caddy-security-config",body:["buildSecurityConfig({","})"],description:"Build Security Config"}},buildSecurityApp:{name:"buildSecurityApp",description:"Build a complete security app configuration\n\nCreates the full security app configuration for `/config/apps/security`.",params:[{name:"config",type:"SecurityConfig",required:true,description:"Security configuration"}],returnType:"SecurityApp",example:`import { buildSecurityApp, buildSecurityConfig } from "@.../caddy-api-client/plugins/caddy-security";
+
+const app = buildSecurityApp({
+  config: buildSecurityConfig({
+    // ... config options
+  }),
+});
+
+// Apply to Caddy
+await client.request("/config/apps/security", {
+  method: "PUT",
+  body: JSON.stringify(app),
+});`,snippet:{prefix:"caddy-security-app",body:["buildSecurityApp({",'  config: ${1:""}',"})"],description:"Build Security App"}},buildAuthenticatorHandler:{name:"buildAuthenticatorHandler",description:`Build an authenticator portal handler
+
+Creates a caddy-security authenticator handler that serves the login portal
+and handles credential validation.`,params:[{name:"portalName",type:"string",required:true,description:"Name of the authentication portal defined in security app config"},{name:"routeMatcher",type:"string",required:false,description:"Optional route matcher pattern"}],returnType:"SecurityAuthenticatorHandler",example:`import { buildAuthenticatorHandler } from "@.../caddy-api-client/plugins/caddy-security";
+
+const handler = buildAuthenticatorHandler({
+  portalName: "myportal",
+});
+
+// Use in a route
+const route: CaddyRoute = {
+  match: [{ host: ["auth.example.com"] }],
+  handle: [handler],
+  terminal: true,
+};`,snippet:{prefix:"caddy-authenticator-handler",body:["buildAuthenticatorHandler({",'  portalName: ${1:""},',"})"],description:"Build Authenticator Handler"}},buildAuthorizationHandler:{name:"buildAuthorizationHandler",description:`Build an authorization handler
+
+Creates a caddy-security authorization handler that validates JWT/PASETO
+tokens and enforces access control policies.
+
+This uses Caddy's built-in \`authentication\` handler with the caddy-security
+\`authorizer\` provider.`,params:[{name:"gatekeeperName",type:"string",required:true,description:"Name of the gatekeeper/policy defined in security app config"},{name:"routeMatcher",type:"string",required:false,description:"Optional route matcher pattern"}],returnType:"SecurityAuthorizationHandler",example:`import { buildAuthorizationHandler } from "@.../caddy-api-client/plugins/caddy-security";
+
+const handler = buildAuthorizationHandler({
+  gatekeeperName: "mygatekeeper",
+});
+
+// Protect a route
+const route: CaddyRoute = {
+  match: [{ host: ["api.example.com"] }],
+  handle: [
+    handler,  // Check auth first
+    { handler: "reverse_proxy", upstreams: [{ dial: "localhost:3000" }] },
+  ],
+  terminal: true,
+};`,snippet:{prefix:"caddy-authorization-handler",body:["buildAuthorizationHandler({",'  gatekeeperName: ${1:""},',"})"],description:"Build Authorization Handler"}},buildAuthenticatorRoute:{name:"buildAuthenticatorRoute",description:`Build a complete authentication portal route
+
+Creates a Caddy route that serves the authentication portal on specified hosts.`,params:[{name:"hosts",type:"string[]",required:true,description:"Host(s) to match for the authentication portal"},{name:"portalName",type:"string",required:true,description:"Name of the authentication portal"},{name:"routeId",type:"string",required:false,description:"Route ID for tracking"}],returnType:"CaddyRoute",example:`import { buildAuthenticatorRoute } from "@.../caddy-api-client/plugins/caddy-security";
+
+const route = buildAuthenticatorRoute({
+  hosts: ["auth.example.com"],
+  portalName: "myportal",
+  routeId: "auth-portal",
+});
+
+await client.addRoute("https_server", route);`,snippet:{prefix:"caddy-authenticator-route",body:["buildAuthenticatorRoute({","  hosts: ${1:example.com},",'  portalName: ${2:""},',"})"],description:"Build Authenticator Route"}},buildProtectedRoute:{name:"buildProtectedRoute",description:`Build a protected route with authorization
+
+Creates a Caddy route that requires valid JWT/PASETO tokens before
+proxying to the upstream service.`,params:[{name:"hosts",type:"string[]",required:true,description:"Host(s) to match"},{name:"paths",type:"string[]",required:false,description:"Path(s) to match (optional)"},{name:"gatekeeperName",type:"string",required:true,description:"Name of the gatekeeper/policy for authorization"},{name:"dial",type:"string",required:true,description:"Upstream dial address (host:port)"},{name:"routeId",type:"string",required:false,description:"Route ID for tracking"}],returnType:"CaddyRoute",example:`import { buildProtectedRoute } from "@.../caddy-api-client/plugins/caddy-security";
+
+const route = buildProtectedRoute({
+  hosts: ["api.example.com"],
+  paths: ["/admin/*"],
+  gatekeeperName: "admin-policy",
+  dial: "localhost:3000",
+  routeId: "protected-admin-api",
+});
+
+await client.addRoute("https_server", route);`,snippet:{prefix:"caddy-protected-route",body:["buildProtectedRoute({","  hosts: ${1:example.com},",'  gatekeeperName: ${2:""},',"  dial: ${3:localhost:3000},","})"],description:"Build Protected Route"}},buildServiceRoutes:{name:"buildServiceRoutes",description:"Build routes for a service (host-based and/or path-based)",params:[],returnType:"CaddyRoute[]",snippet:{prefix:"caddy-service-routes",body:["buildServiceRoutes({","})"],description:"Build Service Routes"}},buildHealthCheckRoute:{name:"buildHealthCheckRoute",description:"Build a health check route",params:[],returnType:"CaddyRoute",snippet:{prefix:"caddy-health-check-route",body:["buildHealthCheckRoute({","})"],description:"Build Health Check Route"}},buildHostRoute:{name:"buildHostRoute",description:"Build a host-based route",params:[],returnType:"CaddyRoute",snippet:{prefix:"caddy-host-route",body:["buildHostRoute({","})"],description:"Build Host Route"}},buildPathRoute:{name:"buildPathRoute",description:"Build a path-based route",params:[],returnType:"CaddyRoute",snippet:{prefix:"caddy-path-route",body:["buildPathRoute({","})"],description:"Build Path Route"}},buildLoadBalancerRoute:{name:"buildLoadBalancerRoute",description:"Build a load balancer route",params:[],returnType:"CaddyRoute",snippet:{prefix:"caddy-load-balancer-route",body:["buildLoadBalancerRoute({","})"],description:"Build Load Balancer Route"}},buildReverseProxyHandler:{name:"buildReverseProxyHandler",description:"Build a reverse proxy handler",params:[],returnType:"CaddyRouteHandler",example:`// HTTP backend (default)
+buildReverseProxyHandler("nginx:80")`,snippet:{prefix:"caddy-reverse-proxy-handler",body:["buildReverseProxyHandler({","})"],description:"Build Reverse Proxy Handler"}},buildSecurityHeadersHandler:{name:"buildSecurityHeadersHandler",description:"Build a security headers handler",params:[],returnType:"CaddyRouteHandler",snippet:{prefix:"caddy-security-headers-handler",body:["buildSecurityHeadersHandler({","})"],description:"Build Security Headers Handler"}},buildBasicAuthHandler:{name:"buildBasicAuthHandler",description:`Build a basic auth handler
+Supports both single account (legacy) and multiple accounts`,params:[],returnType:"CaddyRouteHandler",example:`// Single account (legacy)
+buildBasicAuthHandler({
+  enabled: true,
+  username: "admin",
+  passwordHash: "$2a$10$...",
+  realm: "Admin Area"
+})`,snippet:{prefix:"caddy-basic-auth-handler",body:["buildBasicAuthHandler({","})"],description:"Build Basic Auth Handler"}},buildRewriteHandler:{name:"buildRewriteHandler",description:"Build a rewrite handler (strip path prefix)",params:[],returnType:"CaddyRouteHandler",snippet:{prefix:"caddy-rewrite-handler",body:["buildRewriteHandler({","})"],description:"Build Rewrite Handler"}},buildServiceMetadataHeadersHandler:{name:"buildServiceMetadataHeadersHandler",description:`Build a service metadata headers handler
+Sets X-ASD-Service-ID and X-ASD-Service-Type headers`,params:[],returnType:"CaddyRouteHandler | null",snippet:{prefix:"caddy-service-metadata-headers-handler",body:["buildServiceMetadataHeadersHandler({","})"],description:"Build Service Metadata Headers Handler"}},buildIngressTagHeadersHandler:{name:"buildIngressTagHeadersHandler",description:"Build an ingress tag header handler",params:[],returnType:"CaddyRouteHandler",snippet:{prefix:"caddy-ingress-tag-headers-handler",body:["buildIngressTagHeadersHandler({","})"],description:"Build Ingress Tag Headers Handler"}},buildProjectIdHeadersHandler:{name:"buildProjectIdHeadersHandler",description:"Build a project identity header handler",params:[],returnType:"CaddyRouteHandler",snippet:{prefix:"caddy-project-id-headers-handler",body:["buildProjectIdHeadersHandler({","})"],description:"Build Project Id Headers Handler"}},buildIframeHeadersHandler:{name:"buildIframeHeadersHandler",description:"Build CORS/CSP headers for iframe embedding",params:[],returnType:"CaddyRouteHandler",snippet:{prefix:"caddy-iframe-headers-handler",body:["buildIframeHeadersHandler({","})"],description:"Build Iframe Headers Handler"}},buildRedirectRoute:{name:"buildRedirectRoute",description:"Build a redirect route for domain redirects (www <-> non-www)",params:[],returnType:"CaddyRoute",snippet:{prefix:"caddy-redirect-route",body:["buildRedirectRoute({","})"],description:"Build Redirect Route"}},buildCompressionHandler:{name:"buildCompressionHandler",description:`Build a compression (encode) handler
+Supports gzip, zstd, and brotli compression`,params:[],returnType:"CaddyRouteHandler",snippet:{prefix:"caddy-compression-handler",body:["buildCompressionHandler({","})"],description:"Build Compression Handler"}},buildWwwRedirect:{name:"buildWwwRedirect",description:`Build a WWW redirect route (www.example.com \u2194 example.com)
+
+Common patterns:
+- "www-to-domain": www.example.com \u2192 example.com
+- "domain-to-www": example.com \u2192 www.example.com`,params:[],returnType:"CaddyRoute",example:`// Redirect www.example.com \u2192 example.com
+const route = buildWwwRedirect({
+  domain: "example.com",
+  mode: "www-to-domain",
+  permanent: true
+});`,snippet:{prefix:"caddy-www-redirect",body:["buildWwwRedirect({","})"],description:"Build Www Redirect"}},buildMitmproxyRoute:{name:"buildMitmproxyRoute",description:`Build a route that forwards traffic through MITMproxy for inspection
+
+This is a convenience function that creates a route pointing to a MITMproxy
+instance running in reverse proxy mode. Use this to transparently intercept
+and inspect HTTP traffic for debugging without modifying client or backend code.`,params:[],returnType:"CaddyRoute",example:`// Route traffic for api.example.com through MITMproxy
+const route = buildMitmproxyRoute({
+  host: "api.example.com",
+  mitmproxyHost: "localhost",
+  mitmproxyPort: 8080,
+});
+await client.addRoute("https_server", route, "api_debug");`,snippet:{prefix:"caddy-mitmproxy-route",body:["buildMitmproxyRoute({","})"],description:"Build Mitmproxy Route"}},buildMitmproxyRoutePair:{name:"buildMitmproxyRoutePair",description:`Create a hot-swappable route pair for enabling/disabling MITMproxy interception
+
+Returns both a direct route and a MITMproxy-intercepted route with the same ID.
+Use this to easily toggle between direct and intercepted traffic at runtime.`,params:[],returnType:`{
+  /** Direct route (Client \u2192 Caddy \u2192 Backend) */
+  direct: CaddyRoute;
+  /** Proxied route (Client \u2192 Caddy \u2192 MITMproxy \u2192 Backend) */
+  proxied: CaddyRoute;
+}`,example:`const routes = buildMitmproxyRoutePair({
+  host: "api.example.com",
+  backendHost: "backend-service",
+  backendPort: 3000,
+  mitmproxyHost: "mitmproxy",
+  routeId: "api_route",
+});
+
+// Start with direct routing
+await client.addRoute("https_server", routes.direct, routes.direct["@id"]);
+
+// Hot-swap to enable interception (no downtime)
+await client.removeRouteById("https_server", routes.direct["@id"]);
+await client.addRoute("https_server", routes.proxied, routes.proxied["@id"]);
+
+// Hot-swap back to direct (disable interception)
+await client.removeRouteById("https_server", routes.proxied["@id"]);
+await client.addRoute("https_server", routes.direct, routes.direct["@id"]);`,snippet:{prefix:"caddy-mitmproxy-route-pair",body:["buildMitmproxyRoutePair({","})"],description:"Build Mitmproxy Route Pair"}},buildIframeProxyRoute:{name:"buildIframeProxyRoute",description:`Build a route for proxying a web UI with iframe embedding support
+
+This creates a route that proxies a web interface and optionally adds
+headers to allow embedding in iframes. Can also override Host/Origin
+headers for services with DNS rebinding protection.`,params:[{name:"pathPrefix",type:"string",required:true,description:'Path prefix for the route (e.g., "/panel")'},{name:"upstreamHost",type:"string",required:true,description:"Upstream host to proxy to"},{name:"upstreamPort",type:"number",required:true,description:"Upstream port to proxy to"},{name:"routeId",type:"string",required:false,description:"Route ID (optional, auto-generated from pathPrefix if not provided)"},{name:"iframeEmbed",type:"boolean",required:false,description:"Whether to enable iframe embedding headers (default: true)"},{name:"overrideHost",type:"string",required:false,description:"Custom Host header to send to upstream (for DNS rebinding bypass)"}],returnType:"CaddyRoute",example:`// Proxy a web panel at /panel/* to panel-service:8080
+const route = buildIframeProxyRoute({
+  pathPrefix: "/panel",
+  upstreamHost: "panel-service",
+  upstreamPort: 8080,
+  iframeEmbed: true,
+});
+
+// Proxy with DNS rebinding bypass (e.g., for mitmweb)
+const mitmRoute = buildIframeProxyRoute({
+  pathPrefix: "/mitmproxy",
+  upstreamHost: "mitmproxy",
+  upstreamPort: 8081,
+  overrideHost: "127.0.0.1:8081",
+});`,snippet:{prefix:"caddy-iframe-proxy-route",body:["buildIframeProxyRoute({",'  pathPrefix: ${1:""},','  upstreamHost: ${2:""},',"  upstreamPort: ${3:0},","})"],description:"Build Iframe Proxy Route"}},buildMitmproxyWebUiRoute:{name:"buildMitmproxyWebUiRoute",description:"",params:[],returnType:"CaddyRoute",snippet:{prefix:"caddy-mitmproxy-web-ui-route",body:["buildMitmproxyWebUiRoute({","})"],description:"Build Mitmproxy Web Ui Route"}},buildWebSocketProxyRoute:{name:"buildWebSocketProxyRoute",description:`Build a route for WebSocket proxy
+
+This creates a route that proxies WebSocket connections to an upstream
+service. Can optionally override Host/Origin headers for services
+with DNS rebinding protection.`,params:[{name:"path",type:"string",required:true,description:'WebSocket path to match (e.g., "/ws", "/updates")'},{name:"upstreamHost",type:"string",required:true,description:"Upstream host to proxy to"},{name:"upstreamPort",type:"number",required:true,description:"Upstream port to proxy to"},{name:"routeId",type:"string",required:false,description:"Route ID (optional)"},{name:"overrideHost",type:"string",required:false,description:"Custom Host header to send to upstream (for DNS rebinding bypass)"}],returnType:"CaddyRoute",example:`// Simple WebSocket proxy
+const route = buildWebSocketProxyRoute({
+  path: "/ws",
+  upstreamHost: "ws-server",
+  upstreamPort: 8080,
+});
+
+// WebSocket with DNS rebinding bypass
+const mitmRoute = buildWebSocketProxyRoute({
+  path: "/updates",
+  upstreamHost: "mitmproxy",
+  upstreamPort: 8081,
+  overrideHost: "127.0.0.1:8081",
+});`,snippet:{prefix:"caddy-web-socket-proxy-route",body:["buildWebSocketProxyRoute({","  path: ${1:/etc/caddy/config.json},",'  upstreamHost: ${2:""},',"  upstreamPort: ${3:0},","})"],description:"Build Web Socket Proxy Route"}},buildMitmproxyWebSocketRoute:{name:"buildMitmproxyWebSocketRoute",description:"",params:[],returnType:"CaddyRoute",snippet:{prefix:"caddy-mitmproxy-web-socket-route",body:["buildMitmproxyWebSocketRoute({","})"],description:"Build Mitmproxy Web Socket Route"}},buildIframePermissiveHandler:{name:"buildIframePermissiveHandler",description:`Build a header handler that removes restrictive headers for iframe embedding
+
+Removes X-Frame-Options, Content-Security-Policy, and X-Xss-Protection
+headers while adding permissive CORS and frame-ancestors headers.`,params:[],returnType:"CaddyRouteHandler",example:`const handler = buildIframePermissiveHandler();
+// Use in a route's handle array`,snippet:{prefix:"caddy-iframe-permissive-handler",body:["buildIframePermissiveHandler({","})"],description:"Build Iframe Permissive Handler"}},buildDnsRebindingBypassHandler:{name:"buildDnsRebindingBypassHandler",description:`Build a header handler for DNS rebinding bypass
+
+Sets Host and Origin headers to bypass MITMproxy's DNS rebinding protection.
+Use this when proxying to MITMproxy from a different hostname.`,params:[],returnType:"CaddyRouteHandler",example:`const handler = buildDnsRebindingBypassHandler({
+  targetHost: "127.0.0.1:8081",
+});`,snippet:{prefix:"caddy-dns-rebinding-bypass-handler",body:["buildDnsRebindingBypassHandler({","})"],description:"Build Dns Rebinding Bypass Handler"}},buildFileServerRoute:{name:"buildFileServerRoute",description:"Build a file server route for serving static files",params:[{name:"path",type:"string",required:true,description:'Path prefix to match (e.g., "/static/*")'},{name:"root",type:"string",required:true,description:"Root directory to serve files from"},{name:"browse",type:"boolean",required:false,description:"Enable directory browsing"},{name:"browseTemplate",type:"string",required:false,description:"Custom browse template file path"},{name:"hidePatterns",type:"string[]",required:false,description:'File patterns to hide (e.g., [".git", ".env"])'},{name:"indexNames",type:"string[]",required:false,description:'Index file names (default: ["index.html"])'},{name:"precompressed",type:"boolean",required:false,description:"Enable precompressed file support (gzip, brotli)"},{name:"id",type:"string",required:false,description:"Route ID"},{name:"priority",type:"number",required:false,description:"Route priority"}],returnType:"CaddyRoute",example:`// Basic static file serving
+const route = buildFileServerRoute({
+  path: "/static/*",
+  root: "/var/www/static",
+});
+
+// With directory browsing and hidden files
+const route = buildFileServerRoute({
+  path: "/files/*",
+  root: "/var/www/files",
+  browse: true,
+  hidePatterns: [".git", ".env", "*.secret"],
+  precompressed: true,
+});`,snippet:{prefix:"caddy-file-server-route",body:["buildFileServerRoute({","  path: ${1:/etc/caddy/config.json},",'  root: ${2:""},',"})"],description:"Build File Server Route"}},buildTemplatesRoute:{name:"buildTemplatesRoute",description:"Build a templates route for server-side template rendering",params:[{name:"path",type:"string",required:true,description:'Path prefix to match (e.g., "/*.html")'},{name:"fileRoot",type:"string",required:true,description:"Root directory for template files"},{name:"mimeTypes",type:"string[]",required:false,description:"MIME types to process as templates"},{name:"delimiters",type:"[string, string]",required:false,description:'Custom delimiters (default: ["{{", "}}"])'},{name:"id",type:"string",required:false,description:"Route ID"},{name:"priority",type:"number",required:false,description:"Route priority"}],returnType:"CaddyRoute",example:`// Process HTML files as templates
+const route = buildTemplatesRoute({
+  path: "/*.html",
+  fileRoot: "/var/www/templates",
+  mimeTypes: ["text/html"],
+});
+
+// With custom delimiters
+const route = buildTemplatesRoute({
+  path: "/*.tmpl",
+  fileRoot: "/templates",
+  delimiters: ["<%", "%>"],
+});`,snippet:{prefix:"caddy-templates-route",body:["buildTemplatesRoute({","  path: ${1:/etc/caddy/config.json},",'  fileRoot: ${2:""},',"})"],description:"Build Templates Route"}},buildErrorRoute:{name:"buildErrorRoute",description:"Build an error route that returns a static error response",params:[{name:"match",type:"{ path?: string[]; host?: string[] }",required:false,description:"Route matchers (optional, applies to all requests if not specified)"},{name:"statusCode",type:"number",required:true,description:"HTTP status code"},{name:"message",type:"string",required:false,description:"Error message body"},{name:"headers",type:"Record<string, string[]>",required:false,description:"Custom headers to include"},{name:"id",type:"string",required:false,description:"Route ID"},{name:"priority",type:"number",required:false,description:"Route priority"}],returnType:"CaddyRoute",example:`// Simple 404 handler
+const route = buildErrorRoute({
+  statusCode: 404,
+  message: "Page not found",
+});
+
+// JSON error response for API
+const route = buildErrorRoute({
+  match: { path: ["/api/*"] },
+  statusCode: 500,
+  message: '{"error":"Internal server error"}',
+  headers: { "Content-Type": ["application/json"] },
+});`,snippet:{prefix:"caddy-error-route",body:["buildErrorRoute({","  statusCode: ${1:0},","})"],description:"Build Error Route"}},buildRequestBodyHandler:{name:"buildRequestBodyHandler",description:"Build a request body handler for limiting request body size",params:[{name:"maxSize",type:"number",required:true,description:"Maximum request body size in bytes"}],returnType:"CaddyRouteHandler",example:`// Limit request body to 10MB
+const handler = buildRequestBodyHandler({ maxSize: 10 * 1024 * 1024 });`,snippet:{prefix:"caddy-request-body-handler",body:["buildRequestBodyHandler({","  maxSize: ${1:0}","})"],description:"Build Request Body Handler"}},buildVarsHandler:{name:"buildVarsHandler",description:"Build a vars handler for setting request variables",params:[{name:"vars",type:"Record<string, string>",required:true,description:"Variables to set (key-value pairs)"}],returnType:"CaddyRouteHandler",example:`// Set custom variables for downstream handlers
+const handler = buildVarsHandler({
+  vars: {
+    root: "/var/www",
+    backend: "api-server",
+    environment: "production",
+  }
+});`,snippet:{prefix:"caddy-vars-handler",body:["buildVarsHandler({",'  vars: ${1:""}',"})"],description:"Build Vars Handler"}},buildTracingHandler:{name:"buildTracingHandler",description:"Build a tracing handler for distributed tracing",params:[{name:"span",type:"string",required:false,description:"Span name for tracing"}],returnType:"CaddyRouteHandler",example:'const handler = buildTracingHandler({ span: "http.request" });',snippet:{prefix:"caddy-tracing-handler",body:["buildTracingHandler({","})"],description:"Build Tracing Handler"}},buildMapHandler:{name:"buildMapHandler",description:"Build a map handler for variable mapping",params:[{name:"source",type:"string",required:true,description:'Source placeholder (e.g., "{http.request.uri.path}")'},{name:"destinations",type:"string[]",required:true,description:'Destination placeholder names (e.g., ["{my_var}"])'},{name:"mappings",type:"{ input: string; outputs: string[] }[]",required:true,description:"Mappings from input patterns to outputs"},{name:"defaults",type:"string[]",required:false,description:"Default outputs if no mappings match"}],returnType:"CaddyRouteHandler",example:`// Map request paths to backend names
+const handler = buildMapHandler({
+  source: "{http.request.uri.path}",
+  destinations: ["{backend}"],
+  mappings: [
+    { input: "/api/*", outputs: ["api-server"] },
+    { input: "/admin/*", outputs: ["admin-server"] },
+  ],
+  defaults: ["default-server"],
+});`,snippet:{prefix:"caddy-map-handler",body:["buildMapHandler({",'  source: ${1:""},','  destinations: ${2:["value"]},','  mappings: ${3:["value"]},',"})"],description:"Build Map Handler"}}},i={authenticator:{name:"authenticator",displayName:"Authenticator (caddy-security)",description:"Serve authentication portal for caddy-security plugin",discriminator:"authenticator",commonFields:["portal_name","route_matcher"],caddyDocsPath:"https://github.com/greenpau/caddy-security"},authentication:{name:"authentication",displayName:"Authentication",description:"HTTP Basic authentication or custom auth providers",discriminator:"authentication",commonFields:["providers"],caddyDocsPath:"/docs/json/apps/http/servers/routes/handle/authentication/"},reverse_proxy:{name:"reverse_proxy",displayName:"Reverse Proxy",description:"Proxy requests to upstream backend servers with load balancing",discriminator:"reverse_proxy",commonFields:["upstreams","transport","load_balancing","health_checks","headers"],caddyDocsPath:"/docs/json/apps/http/servers/routes/handle/reverse_proxy/"},headers:{name:"headers",displayName:"Headers",description:"Modify request and response headers",discriminator:"headers",commonFields:["request","response"],caddyDocsPath:"/docs/json/apps/http/servers/routes/handle/headers/"},static_response:{name:"static_response",displayName:"Static Response",description:"Return a static response without proxying",discriminator:"static_response",commonFields:["status_code","body","headers","close","abort"],caddyDocsPath:"/docs/json/apps/http/servers/routes/handle/static_response/"},rewrite:{name:"rewrite",displayName:"Rewrite",description:"Rewrite the request URI before processing",discriminator:"rewrite",commonFields:["uri","strip_path_prefix","strip_path_suffix","uri_substring"],caddyDocsPath:"/docs/json/apps/http/servers/routes/handle/rewrite/"},encode:{name:"encode",displayName:"Encode",description:"Compress responses with gzip, zstd, or brotli",discriminator:"encode",commonFields:["encodings","prefer","minimum_length"],caddyDocsPath:"/docs/json/apps/http/servers/routes/handle/encode/"},subroute:{name:"subroute",displayName:"Subroute",description:"Process requests through nested routes",discriminator:"subroute",commonFields:["routes"],caddyDocsPath:"/docs/json/apps/http/servers/routes/handle/subroute/"},file_server:{name:"file_server",displayName:"File Server",description:"Serve static files from disk",discriminator:"file_server",commonFields:["root","index_names","browse","hide"],caddyDocsPath:"/docs/json/apps/http/servers/routes/handle/file_server/"},templates:{name:"templates",displayName:"Templates",description:"Render Go templates in responses",discriminator:"templates",commonFields:["file_root","mime_types","delimiters"],caddyDocsPath:"/docs/json/apps/http/servers/routes/handle/templates/"},map:{name:"map",displayName:"Map",description:"Map input to output values for use in other handlers",discriminator:"map",commonFields:["source","destinations","mappings","defaults"],caddyDocsPath:"/docs/json/apps/http/servers/routes/handle/map/"},push:{name:"push",displayName:"HTTP/2 Push",description:"Push resources to clients over HTTP/2",discriminator:"push",commonFields:["resources","headers"],caddyDocsPath:"/docs/json/apps/http/servers/routes/handle/push/"},request_body:{name:"request_body",displayName:"Request Body",description:"Configure request body size limits",discriminator:"request_body",commonFields:["max_size"],caddyDocsPath:"/docs/json/apps/http/servers/routes/handle/request_body/"},vars:{name:"vars",displayName:"Variables",description:"Set variables for use in other handlers",discriminator:"vars",commonFields:[],caddyDocsPath:"/docs/json/apps/http/servers/routes/handle/vars/"},intercept:{name:"intercept",displayName:"Intercept",description:"Intercept and modify responses from upstreams",discriminator:"intercept",commonFields:["handle_response"],caddyDocsPath:"/docs/json/apps/http/servers/routes/handle/intercept/"},invoke:{name:"invoke",displayName:"Invoke",description:"Invoke a named route by reference",discriminator:"invoke",commonFields:["name"],caddyDocsPath:"/docs/json/apps/http/servers/routes/handle/invoke/"},tracing:{name:"tracing",displayName:"Tracing",description:"Add distributed tracing spans",discriminator:"tracing",commonFields:["span"],caddyDocsPath:"/docs/json/apps/http/servers/routes/handle/tracing/"},log_append:{name:"log_append",displayName:"Log Append",description:"Append custom fields to access logs",discriminator:"log_append",commonFields:["key","value"],caddyDocsPath:"/docs/json/apps/http/servers/routes/handle/log_append/"},error:{name:"error",displayName:"Error",description:"Trigger an error response",discriminator:"error",commonFields:["error","status_code"],caddyDocsPath:"/docs/json/apps/http/servers/routes/handle/error/"},copy_response:{name:"copy_response",displayName:"Copy Response",description:"Copy response from another handler",discriminator:"copy_response",commonFields:["status_code"],caddyDocsPath:"/docs/json/apps/http/servers/routes/handle/copy_response/"},copy_response_headers:{name:"copy_response_headers",displayName:"Copy Response Headers",description:"Copy specific headers from another response",discriminator:"copy_response_headers",commonFields:["include","exclude"],caddyDocsPath:"/docs/json/apps/http/servers/routes/handle/copy_response_headers/"}},d=Object.keys(i),s=Object.keys(t);function p(){let e={};for(let[n,r]of Object.entries(t))e[n]={prefix:r.snippet.prefix,body:r.snippet.body,description:r.snippet.description};return e}function u(){return Object.values(i).map(e=>({label:e.name,detail:e.displayName,documentation:e.description}))}
+export{t as BUILDER_METADATA,s as BUILDER_NAMES,o as GENERATED_AT,i as HANDLER_METADATA,d as HANDLER_NAMES,a as METADATA_VERSION,u as getHandlerCompletions,p as getVSCodeSnippets};