breaking-changes.v1.json

[
  {
    "id": "BC-001",
    "title": "Remove @frontmcp/plugins meta-package",
    "package": "@frontmcp/plugins",
    "category": "removal",
    "severity": "high",
    "old": "import { CachePlugin } from '@frontmcp/plugins'",
    "new": "import { CachePlugin } from '@frontmcp/plugin-cache'",
    "migration": "Replace all @frontmcp/plugins imports with direct plugin package imports: @frontmcp/plugin-cache, @frontmcp/plugin-codecall, @frontmcp/plugin-dashboard, @frontmcp/plugin-remember.",
    "codemod": "yes"
  },
  {
    "id": "BC-002",
    "title": "Remove LoadSkillTool alias",
    "package": "@frontmcp/sdk",
    "category": "removal",
    "severity": "low",
    "old": "import { LoadSkillTool } from '@frontmcp/sdk'",
    "new": "import { LoadSkillsTool } from '@frontmcp/sdk'",
    "migration": "Rename LoadSkillTool to LoadSkillsTool (note the plural 's').",
    "codemod": "yes"
  },
  {
    "id": "BC-003",
    "title": "Remove ContextStorage alias",
    "package": "@frontmcp/sdk",
    "category": "removal",
    "severity": "low",
    "old": "import { ContextStorage } from '@frontmcp/sdk'",
    "new": "import { FrontMcpContextStorage } from '@frontmcp/sdk'",
    "migration": "Rename ContextStorage to FrontMcpContextStorage.",
    "codemod": "yes"
  },
  {
    "id": "BC-004",
    "title": "Remove authInfo getter on ExecutionContextBase",
    "package": "@frontmcp/sdk",
    "category": "removal",
    "severity": "medium",
    "old": "this.authInfo",
    "new": "this.getAuthInfo()",
    "migration": "Replace direct property access `this.authInfo` with method call `this.getAuthInfo()` in tool/resource/prompt contexts.",
    "codemod": "yes"
  },
  {
    "id": "BC-005",
    "title": "Remove session token from FrontMcpTokens",
    "package": "@frontmcp/sdk",
    "category": "removal",
    "severity": "low",
    "old": "FrontMcpTokens.session",
    "new": "No replacement - session token was unused.",
    "migration": "Remove any references to FrontMcpTokens.session.",
    "codemod": "no"
  },
  {
    "id": "BC-006",
    "title": "Remove session/request aliases on ProviderViews",
    "package": "@frontmcp/sdk",
    "category": "removal",
    "severity": "medium",
    "old": "views.session or views.request",
    "new": "views.context",
    "migration": "Replace `views.session` and `views.request` with `views.context`.",
    "codemod": "yes"
  },
  {
    "id": "BC-007",
    "title": "Remove deprecated createTemplateHelpersLocal from SDK",
    "package": "@frontmcp/sdk",
    "category": "removal",
    "severity": "low",
    "old": "import { createTemplateHelpersLocal } from '@frontmcp/sdk'",
    "new": "import { createTemplateHelpers } from '@frontmcp/uipack/runtime'",
    "migration": "Use createTemplateHelpers from @frontmcp/uipack/runtime instead of the deprecated local version.",
    "codemod": "yes"
  },
  {
    "id": "BC-008",
    "title": "Remove legacy SSE transport",
    "package": "@frontmcp/sdk",
    "category": "removal",
    "severity": "high",
    "old": "import { SSEServerTransport } from '@frontmcp/sdk'",
    "new": "import { RecreateableSSEServerTransport } from '@frontmcp/sdk'",
    "migration": "Replace SSEServerTransport with RecreateableSSEServerTransport which supports session recreation.",
    "codemod": "yes"
  },
  {
    "id": "BC-009",
    "title": "Remove CimdCache alias",
    "package": "@frontmcp/auth",
    "category": "removal",
    "severity": "low",
    "old": "import { CimdCache } from '@frontmcp/auth'",
    "new": "import { InMemoryCimdCache } from '@frontmcp/auth'",
    "migration": "Rename CimdCache to InMemoryCimdCache, or use the createCimdCache factory function.",
    "codemod": "yes"
  },
  {
    "id": "BC-010",
    "title": "Remove dev-key-persistence module",
    "package": "@frontmcp/auth",
    "category": "removal",
    "severity": "medium",
    "old": "import { loadDevKey, saveDevKey } from '@frontmcp/auth'",
    "new": "import { createKeyPersistence } from '@frontmcp/utils'",
    "migration": "Replace loadDevKey/saveDevKey/deleteDevKey with createKeyPersistence() from @frontmcp/utils.",
    "codemod": "no"
  },
  {
    "id": "BC-011",
    "title": "Remove TransportIdGenerator._mode parameter",
    "package": "@frontmcp/auth",
    "category": "change",
    "severity": "low",
    "old": "TransportIdGenerator.createId('jwt')",
    "new": "TransportIdGenerator.createId()",
    "migration": "Remove the _mode parameter from TransportIdGenerator.createId() calls.",
    "codemod": "yes"
  },
  {
    "id": "BC-012",
    "title": "Remove WidgetServingModeLegacy type alias",
    "package": "@frontmcp/uipack",
    "category": "removal",
    "severity": "low",
    "old": "WidgetServingModeLegacy",
    "new": "WidgetServingMode",
    "migration": "Use WidgetServingMode instead of WidgetServingModeLegacy. Remove 'mcp-resource' value references.",
    "codemod": "yes"
  },
  {
    "id": "BC-013",
    "title": "Remove RuntimePayload interface",
    "package": "@frontmcp/uipack",
    "category": "removal",
    "severity": "medium",
    "old": "import { RuntimePayload } from '@frontmcp/uipack'",
    "new": "Use the specific runtime types instead.",
    "migration": "Replace RuntimePayload with the appropriate specific runtime type.",
    "codemod": "no"
  },
  {
    "id": "BC-014",
    "title": "Remove legacy renderer asset fields",
    "package": "@frontmcp/uipack",
    "category": "removal",
    "severity": "medium",
    "old": "reactRuntime, reactDomRuntime, markdownEngine, handlebarsRuntime",
    "new": "Use the CDN resource system instead.",
    "migration": "Remove legacy asset fields from renderer configuration. Use the CDN resource system for runtime dependencies.",
    "codemod": "no"
  },
  {
    "id": "BC-015",
    "title": "Remove legacy build options",
    "package": "@frontmcp/uipack",
    "category": "removal",
    "severity": "medium",
    "old": "sampleInput, sampleOutput, injectAdapters, minify, platform",
    "new": "Use the updated build API.",
    "migration": "Remove deprecated build options: sampleInput, sampleOutput, injectAdapters, minify, platform.",
    "codemod": "no"
  },
  {
    "id": "BC-016",
    "title": "Remove buildToolUIMulti and legacy build types",
    "package": "@frontmcp/uipack",
    "category": "removal",
    "severity": "medium",
    "old": "import { buildToolUIMulti, BuildTargetPlatform } from '@frontmcp/uipack'",
    "new": "Use buildToolUI with individual targets.",
    "migration": "Replace buildToolUIMulti with individual buildToolUI calls. Remove BuildTargetPlatform, MultiBuildOptions, MultiBuildResult type imports.",
    "codemod": "no"
  },
  {
    "id": "BC-017",
    "title": "Remove frontmcp/* meta keys",
    "package": "@frontmcp/uipack",
    "category": "removal",
    "severity": "low",
    "old": "FrontMCPMetaFields interface",
    "new": "Use ui/* prefixed meta keys.",
    "migration": "Replace frontmcp/* meta keys with ui/* prefixed keys.",
    "codemod": "yes"
  },
  {
    "id": "BC-018",
    "title": "Remove deprecated transpiler functions",
    "package": "@frontmcp/uipack",
    "category": "removal",
    "severity": "low",
    "old": "import { executeTranspiledCode, transpileAndExecute } from '@frontmcp/uipack'",
    "new": "Use the bundler API instead.",
    "migration": "Replace executeTranspiledCode and transpileAndExecute with the bundler API.",
    "codemod": "no"
  },
  {
    "id": "BC-019",
    "title": "Remove DataTransformOptions alias",
    "package": "@frontmcp/adapters",
    "category": "removal",
    "severity": "low",
    "old": "import { DataTransformOptions } from '@frontmcp/adapters'",
    "new": "import { ResponseTransformOptions } from '@frontmcp/adapters'",
    "migration": "Rename DataTransformOptions to ResponseTransformOptions.",
    "codemod": "yes"
  },
  {
    "id": "BC-020",
    "title": "Remove dataTransforms field alias",
    "package": "@frontmcp/adapters",
    "category": "removal",
    "severity": "low",
    "old": "dataTransforms: { ... }",
    "new": "responseTransforms: { ... }",
    "migration": "Rename the dataTransforms field to responseTransforms in OpenAPI adapter configuration.",
    "codemod": "yes"
  },
  {
    "id": "BC-021",
    "title": "Remove deprecated reservePort",
    "package": "@frontmcp/testing",
    "category": "removal",
    "severity": "low",
    "old": "import { reservePort } from '@frontmcp/testing'",
    "new": "import { acquirePort } from '@frontmcp/testing'",
    "migration": "Replace reservePort with acquirePort from the port registry.",
    "codemod": "yes"
  },
  {
    "id": "BC-022",
    "title": "Remove legacy test constants",
    "package": "@frontmcp/testing",
    "category": "removal",
    "severity": "low",
    "old": "EXPECTED_FRONTMCP_TOOLS_LIST_META_KEYS, EXPECTED_FRONTMCP_TOOL_CALL_META_KEYS",
    "new": "No replacement - these constants are no longer needed.",
    "migration": "Remove references to EXPECTED_FRONTMCP_TOOLS_LIST_META_KEYS and EXPECTED_FRONTMCP_TOOL_CALL_META_KEYS.",
    "codemod": "no"
  },
  {
    "id": "BC-023",
    "title": "Remove ProviderScope.SESSION and ProviderScope.REQUEST",
    "package": "@frontmcp/di",
    "category": "removal",
    "severity": "high",
    "old": "scope: ProviderScope.SESSION or scope: ProviderScope.REQUEST",
    "new": "scope: ProviderScope.CONTEXT",
    "migration": "Replace ProviderScope.SESSION and ProviderScope.REQUEST with ProviderScope.CONTEXT. Both mapped to CONTEXT internally.",
    "codemod": "yes"
  },
  {
    "id": "BC-026",
    "title": "Flatten auth modes",
    "package": "@frontmcp/auth",
    "category": "change",
    "severity": "high",
    "old": "auth: { mode: 'orchestrated', type: 'remote', remote: { provider: '...' } }",
    "new": "auth: { mode: 'remote', provider: '...' }",
    "migration": "Replace mode: 'orchestrated' with mode: 'local' or mode: 'remote'. Remove the type sub-discriminator. Flatten remote provider fields to top level.",
    "codemod": "yes"
  },
  {
    "id": "BC-027",
    "title": "Flatten remote provider fields to top level",
    "package": "@frontmcp/auth",
    "category": "change",
    "severity": "high",
    "old": "auth: { mode: 'transparent', remote: { provider: '...', scopes: ['read'] } }",
    "new": "auth: { mode: 'transparent', provider: '...', scopes: ['read'] }",
    "migration": "Hoist remote.provider, remote.clientId, remote.clientSecret, remote.scopes to the top level of the auth config.",
    "codemod": "yes"
  },
  {
    "id": "BC-028",
    "title": "Remove splitByApp auth restriction",
    "package": "@frontmcp/sdk",
    "category": "change",
    "severity": "medium",
    "old": "splitByApp: true with auth?: never",
    "new": "splitByApp: true with server-level auth allowed",
    "migration": "Server-level auth is now allowed in splitByApp mode. Apps inherit server auth by default and can override per-app.",
    "codemod": "no"
  },
  {
    "id": "BC-029",
    "title": "Single source of truth for auth schemas",
    "package": "@frontmcp/sdk",
    "category": "change",
    "severity": "medium",
    "old": "Auth schemas duplicated in libs/sdk/src/common/types/options/auth/ and libs/auth/src/options/",
    "new": "Auth schemas only in libs/auth/src/options/, imported via @frontmcp/auth",
    "migration": "Import auth types from @frontmcp/auth instead of @frontmcp/sdk internal paths.",
    "codemod": "yes"
  },
  {
    "id": "BC-030",
    "title": "Simplify advanced config nesting",
    "package": "@frontmcp/auth",
    "category": "change",
    "severity": "medium",
    "old": "tokenStorage: { type: 'redis', config: { host: '...' } }",
    "new": "tokenStorage: 'memory' | { redis: { host: '...' } }",
    "migration": "Simplify tokenStorage and cimd cache configuration to use flattened format.",
    "codemod": "yes"
  },
  {
    "id": "BC-031",
    "title": "inputSchema accepts ZodRawShape only",
    "package": "@frontmcp/sdk",
    "category": "change",
    "severity": "medium",
    "old": "inputSchema: z.object({ name: z.string() })",
    "new": "inputSchema: { name: z.string() }",
    "migration": "Pass a plain object (ZodRawShape) to inputSchema instead of z.object(). Remove z.object() wrapper.",
    "codemod": "yes"
  },
  {
    "id": "BC-032",
    "title": "Remove rawInputSchema/rawOutputSchema from user-facing API",
    "package": "@frontmcp/sdk",
    "category": "removal",
    "severity": "low",
    "old": "@Tool({ rawInputSchema: {...} })",
    "new": "Use inputSchema with ZodRawShape instead.",
    "migration": "Remove rawInputSchema and rawOutputSchema from @Tool() decorator options. Use inputSchema with ZodRawShape format.",
    "codemod": "yes"
  }
]