@aws/nx-plugin 1.0.0-rc.58 → 1.0.0-rc.59

package/src/utils/connection/open-api/react.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../../../packages/nx-plugin/src/utils/connection/open-api/react.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\nimport {\n  generateFiles,\n  joinPathFragments,\n  OverwriteStrategy,\n  type ProjectConfiguration,\n  type Tree,\n  updateProjectConfiguration,\n} from '@nx/devkit';\nimport { addTargetToLocalDev } from '../../../connection/local-dev';\nimport runtimeConfigGenerator from '../../../ts/react-website/runtime-config/generator';\nimport { addSingleImport, applyGritQL } from '../../ast';\nimport {\n  type DependencyDeclaration,\n  forDependencies,\n  type MustDeclare,\n} from '../../declared-dependencies';\nimport { addDependenciesToPackageJson } from '../../dependencies';\nimport { updateGitIgnore } from '../../git';\nimport { kebabCase, toClassName } from '../../names';\nimport { sortObjectKeys } from '../../object';\nimport { type ITsDepVersion, withVersions } from '../../versions';\n\n/** Dependencies a caller must declare to add an OpenAPI React client. */\nexport const OPEN_API_REACT_DEPENDENCIES = [\n  { name: 'oidc-client-ts' },\n  { name: 'react-oidc-context' },\n  { name: '@aws-sdk/credential-provider-cognito-identity' },\n  { name: 'aws4fetch' },\n  { name: '@tanstack/react-query' },\n  { name: '@tanstack/react-query-devtools' },\n  { name: '@smithy/types' },\n] as const satisfies readonly { name: ITsDepVersion }[];\n\nexport interface AddOpenApiReactClientOptions {\n  /**\n   * The react project to add the openapi client and build targets to\n   */\n  frontendProjectConfig: ProjectConfiguration;\n  /**\n   * The backend project which serves the api\n   */\n  backendProjectConfig: ProjectConfiguration;\n  /**\n   * The project which builds/generates the openapi spec\n   */\n  specBuildProject: ProjectConfiguration;\n  /**\n   * Name of the api\n   */\n  apiName: string;\n  /**\n   * Path to the openapi spec from the workspace root\n   */\n  specPath: string;\n  /**\n   * Fully qualified target name for the target that builds/generates the openapi spec\n   */\n  specBuildTargetName: string;\n  /**\n   * Authentication method\n   */\n  auth: 'iam' | 'cognito' | 'custom';\n  /**\n   * Port on which the backend project's local server listens\n   */\n  port: number;\n  /**\n   * When true, the generated provider reads from runtimeConfig.agentRuntimes\n   * and converts Bedrock AgentCore Runtime ARNs to HTTP URLs.\n   * When false (default), reads from runtimeConfig.apis directly.\n   */\n  isAgentRuntime?: boolean;\n  /**\n   * When true, skips the dev target setup. Use this when the caller\n   * handles dev target configuration separately (e.g. agent connections\n   * that use a component-specific dev target instead of 'serve').\n   */\n  skipLocalDev?: boolean;\n}\n\n/**\n * Adds an OpenAPI React client to the frontend project along with supporting build targets\n */\nexport const addOpenApiReactClient = async <\n  const D extends DependencyDeclaration,\n>(\n  tree: Tree,\n  {\n    apiName,\n    frontendProjectConfig,\n    backendProjectConfig,\n    specBuildProject,\n    specPath,\n    specBuildTargetName,\n    auth,\n    port,\n    isAgentRuntime = false,\n    skipLocalDev = false,\n  }: AddOpenApiReactClientOptions,\n  declaration: D & MustDeclare<typeof OPEN_API_REACT_DEPENDENCIES, D>,\n) => {\n  const clientGenTarget = `generate:${kebabCase(apiName)}-client`;\n  const clientGenWatchTarget = `watch-${clientGenTarget}`;\n\n  const generatedClientDir = joinPathFragments('generated', kebabCase(apiName));\n  const generatedClientDirFromRoot = joinPathFragments(\n    frontendProjectConfig.sourceRoot,\n    generatedClientDir,\n  );\n\n  // Add TypeScript client generation to Frontend project.json\n  updateProjectConfiguration(tree, frontendProjectConfig.name, {\n    ...frontendProjectConfig,\n    targets: sortObjectKeys({\n      ...frontendProjectConfig.targets,\n      // Generate should run before compile and bundle as the client is created as part of the website src\n      ...Object.fromEntries(\n        ['compile', 'bundle'].map((target) => [\n          target,\n          {\n            ...frontendProjectConfig.targets?.[target],\n            dependsOn: [\n              ...(\n                frontendProjectConfig.targets?.[target]?.dependsOn ?? []\n              ).filter((t) => t !== clientGenTarget),\n              clientGenTarget,\n            ],\n          },\n        ]),\n      ),\n      [clientGenTarget]: {\n        cache: true,\n        executor: 'nx:run-commands',\n        inputs: [\n          {\n            dependentTasksOutputFiles: '**/*.json',\n          },\n        ],\n        outputs: [\n          joinPathFragments('{workspaceRoot}', generatedClientDirFromRoot),\n        ],\n        options: {\n          commands: [\n            `nx g @aws/nx-plugin:open-api#ts-hooks --openApiSpecPath=\"${specPath}\" --outputPath=\"${generatedClientDirFromRoot}\" --no-interactive`,\n          ],\n        },\n        dependsOn: [specBuildTargetName],\n      },\n      // Watch target for regenerating the client\n      [clientGenWatchTarget]: {\n        executor: 'nx:run-commands',\n        options: {\n          commands: [\n            `nx watch --projects=${specBuildProject.name} --includeDependencies -- nx run ${frontendProjectConfig.name}:\"${clientGenTarget}\"`,\n          ],\n        },\n        continuous: true,\n      },\n    }),\n  });\n\n  const relativeSrcDir = frontendProjectConfig.sourceRoot.slice(\n    frontendProjectConfig.root.length + 1,\n  );\n\n  // Ignore the generated client by default\n  // Users can safely remove the entry from the .gitignore if they prefer to check it in\n  updateGitIgnore(tree, frontendProjectConfig.root, (patterns) => [\n    ...patterns,\n    joinPathFragments(relativeSrcDir, generatedClientDir),\n  ]);\n\n  // Ensure that the frontend has runtime config as we'll use the url for creating the client\n  await runtimeConfigGenerator(tree, {\n    project: frontendProjectConfig.name,\n  });\n\n  // Add sigv4 fetch\n  if (auth === 'iam') {\n    generateFiles(\n      tree,\n      joinPathFragments(import.meta.dirname, '../../files/website/hooks/sigv4'),\n      joinPathFragments(frontendProjectConfig.sourceRoot, 'hooks'),\n      {},\n      {\n        overwriteStrategy: OverwriteStrategy.KeepExisting,\n      },\n    );\n  }\n\n  // Generate the tanstack query provider if it does not exist already\n  generateFiles(\n    tree,\n    joinPathFragments(\n      import.meta.dirname,\n      '../../files/website/components/tanstack-query',\n    ),\n    joinPathFragments(frontendProjectConfig.sourceRoot, 'components'),\n    {},\n    {\n      overwriteStrategy: OverwriteStrategy.KeepExisting,\n    },\n  );\n\n  const apiNameClassName = toClassName(apiName);\n\n  // Add a hook to instantiate the client\n  generateFiles(\n    tree,\n    joinPathFragments(import.meta.dirname, 'files'),\n    frontendProjectConfig.sourceRoot,\n    {\n      auth,\n      apiName,\n      apiNameClassName,\n      generatedClientDir,\n      isAgentRuntime,\n    },\n  );\n\n  // Update main.tsx to add required providers\n  const mainTsxPath = joinPathFragments(\n    frontendProjectConfig.sourceRoot,\n    'main.tsx',\n  );\n\n  // Add the query client provider if it doesn't exist already\n  await addSingleImport(\n    tree,\n    mainTsxPath,\n    'QueryClientProvider',\n    './components/QueryClientProvider',\n  );\n  await applyGritQL(\n    tree,\n    mainTsxPath,\n    '`<App />` => `<QueryClientProvider><App /></QueryClientProvider>` where { $program <: not contains `<QueryClientProvider>$_</QueryClientProvider>` }',\n  );\n\n  // Add the api provider if it does not exist\n  const providerName = `${apiNameClassName}Provider`;\n  await addSingleImport(\n    tree,\n    mainTsxPath,\n    providerName,\n    `./components/${providerName}`,\n  );\n  await applyGritQL(\n    tree,\n    mainTsxPath,\n    `\\`<App />\\` => \\`<${providerName}><App /></${providerName}>\\` where { $program <: not contains \\`<${providerName}>$_</${providerName}>\\` }`,\n  );\n\n  // Update the dev target on the website to use our local server.\n  // Callers that handle the dev target separately (e.g. agent connections) set skipLocalDev.\n  if (!skipLocalDev) {\n    await addTargetToLocalDev(\n      tree,\n      frontendProjectConfig.name,\n      backendProjectConfig.name,\n      {\n        url: `http://localhost:${port}/`,\n        apiName,\n        // Additionally add a dependency on the generate watch command to ensure that local\n        // API changes that affect the client are also reloaded.\n        // We include a dependency on the generate target as watch ONLY triggers on a change,\n        // and we need to ensure the client is generated the first time if not already present.\n        additionalDependencyTargets: [clientGenTarget, clientGenWatchTarget],\n      },\n    );\n  }\n\n  addDependenciesToPackageJson(\n    tree,\n    withVersions(\n      forDependencies<typeof OPEN_API_REACT_DEPENDENCIES>(declaration),\n      [\n        ...((auth === 'iam'\n          ? [\n              'oidc-client-ts',\n              'react-oidc-context',\n              '@aws-sdk/credential-provider-cognito-identity',\n              'aws4fetch',\n            ]\n          : []) as any),\n        ...((auth === 'cognito' ? ['react-oidc-context'] : []) as any),\n        '@tanstack/react-query',\n        '@tanstack/react-query-devtools',\n      ],\n    ),\n    withVersions(\n      forDependencies<typeof OPEN_API_REACT_DEPENDENCIES>(declaration),\n      ['@smithy/types'],\n    ),\n    joinPathFragments(frontendProjectConfig.root, 'package.json'),\n  );\n};\n"],"names":["generateFiles","joinPathFragments","OverwriteStrategy","updateProjectConfiguration","addTargetToLocalDev","runtimeConfigGenerator","addSingleImport","applyGritQL","forDependencies","addDependenciesToPackageJson","updateGitIgnore","kebabCase","toClassName","sortObjectKeys","withVersions","OPEN_API_REACT_DEPENDENCIES","name","addOpenApiReactClient","tree","apiName","frontendProjectConfig","backendProjectConfig","specBuildProject","specPath","specBuildTargetName","auth","port","isAgentRuntime","skipLocalDev","declaration","clientGenTarget","clientGenWatchTarget","generatedClientDir","generatedClientDirFromRoot","sourceRoot","targets","Object","fromEntries","map","target","dependsOn","filter","t","cache","executor","inputs","dependentTasksOutputFiles","outputs","options","commands","continuous","relativeSrcDir","slice","root","length","patterns","project","dirname","overwriteStrategy","KeepExisting","apiNameClassName","mainTsxPath","providerName","url","additionalDependencyTargets"],"mappings":"AAAA;;;CAGC,GACD,SACEA,aAAa,EACbC,iBAAiB,EACjBC,iBAAiB,EAGjBC,0BAA0B,QACrB,aAAa;AACpB,SAASC,mBAAmB,QAAQ,mCAAgC;AACpE,OAAOC,4BAA4B,wDAAqD;AACxF,SAASC,eAAe,EAAEC,WAAW,QAAQ,eAAY;AACzD,SAEEC,eAAe,QAEV,iCAA8B;AACrC,SAASC,4BAA4B,QAAQ,wBAAqB;AAClE,SAASC,eAAe,QAAQ,eAAY;AAC5C,SAASC,SAAS,EAAEC,WAAW,QAAQ,iBAAc;AACrD,SAASC,cAAc,QAAQ,kBAAe;AAC9C,SAA6BC,YAAY,QAAQ,oBAAiB;AAElE,uEAAuE,GACvE,OAAO,MAAMC,8BAA8B;IACzC;QAAEC,MAAM;IAAiB;IACzB;QAAEA,MAAM;IAAqB;IAC7B;QAAEA,MAAM;IAAgD;IACxD;QAAEA,MAAM;IAAY;IACpB;QAAEA,MAAM;IAAwB;IAChC;QAAEA,MAAM;IAAiC;IACzC;QAAEA,MAAM;IAAgB;CACzB,CAAuD;AAiDxD;;CAEC,GACD,OAAO,MAAMC,wBAAwB,OAGnCC,MACA,EACEC,OAAO,EACPC,qBAAqB,EACrBC,oBAAoB,EACpBC,gBAAgB,EAChBC,QAAQ,EACRC,mBAAmB,EACnBC,IAAI,EACJC,IAAI,EACJC,iBAAiB,KAAK,EACtBC,eAAe,KAAK,EACS,EAC/BC;IAEA,MAAMC,kBAAkB,CAAC,SAAS,EAAEnB,UAAUQ,SAAS,OAAO,CAAC;IAC/D,MAAMY,uBAAuB,CAAC,MAAM,EAAED,iBAAiB;IAEvD,MAAME,qBAAqB/B,kBAAkB,aAAaU,UAAUQ;IACpE,MAAMc,6BAA6BhC,kBACjCmB,sBAAsBc,UAAU,EAChCF;IAGF,4DAA4D;IAC5D7B,2BAA2Be,MAAME,sBAAsBJ,IAAI,EAAE;QAC3D,GAAGI,qBAAqB;QACxBe,SAAStB,eAAe;YACtB,GAAGO,sBAAsBe,OAAO;YAChC,oGAAoG;YACpG,GAAGC,OAAOC,WAAW,CACnB;gBAAC;gBAAW;aAAS,CAACC,GAAG,CAAC,CAACC,SAAW;oBACpCA;oBACA;wBACE,GAAGnB,sBAAsBe,OAAO,EAAE,CAACI,OAAO;wBAC1CC,WAAW;+BACN,AACDpB,CAAAA,sBAAsBe,OAAO,EAAE,CAACI,OAAO,EAAEC,aAAa,EAAE,AAAD,EACvDC,MAAM,CAAC,CAACC,IAAMA,MAAMZ;4BACtBA;yBACD;oBACH;iBACD,EACF;YACD,CAACA,gBAAgB,EAAE;gBACjBa,OAAO;gBACPC,UAAU;gBACVC,QAAQ;oBACN;wBACEC,2BAA2B;oBAC7B;iBACD;gBACDC,SAAS;oBACP9C,kBAAkB,mBAAmBgC;iBACtC;gBACDe,SAAS;oBACPC,UAAU;wBACR,CAAC,yDAAyD,EAAE1B,SAAS,gBAAgB,EAAEU,2BAA2B,kBAAkB,CAAC;qBACtI;gBACH;gBACAO,WAAW;oBAAChB;iBAAoB;YAClC;YACA,2CAA2C;YAC3C,CAACO,qBAAqB,EAAE;gBACtBa,UAAU;gBACVI,SAAS;oBACPC,UAAU;wBACR,CAAC,oBAAoB,EAAE3B,iBAAiBN,IAAI,CAAC,iCAAiC,EAAEI,sBAAsBJ,IAAI,CAAC,EAAE,EAAEc,gBAAgB,CAAC,CAAC;qBAClI;gBACH;gBACAoB,YAAY;YACd;QACF;IACF;IAEA,MAAMC,iBAAiB/B,sBAAsBc,UAAU,CAACkB,KAAK,CAC3DhC,sBAAsBiC,IAAI,CAACC,MAAM,GAAG;IAGtC,yCAAyC;IACzC,sFAAsF;IACtF5C,gBAAgBQ,MAAME,sBAAsBiC,IAAI,EAAE,CAACE,WAAa;eAC3DA;YACHtD,kBAAkBkD,gBAAgBnB;SACnC;IAED,2FAA2F;IAC3F,MAAM3B,uBAAuBa,MAAM;QACjCsC,SAASpC,sBAAsBJ,IAAI;IACrC;IAEA,kBAAkB;IAClB,IAAIS,SAAS,OAAO;QAClBzB,cACEkB,MACAjB,kBAAkB,YAAYwD,OAAO,EAAE,oCACvCxD,kBAAkBmB,sBAAsBc,UAAU,EAAE,UACpD,CAAC,GACD;YACEwB,mBAAmBxD,kBAAkByD,YAAY;QACnD;IAEJ;IAEA,oEAAoE;IACpE3D,cACEkB,MACAjB,kBACE,YAAYwD,OAAO,EACnB,kDAEFxD,kBAAkBmB,sBAAsBc,UAAU,EAAE,eACpD,CAAC,GACD;QACEwB,mBAAmBxD,kBAAkByD,YAAY;IACnD;IAGF,MAAMC,mBAAmBhD,YAAYO;IAErC,uCAAuC;IACvCnB,cACEkB,MACAjB,kBAAkB,YAAYwD,OAAO,EAAE,UACvCrC,sBAAsBc,UAAU,EAChC;QACET;QACAN;QACAyC;QACA5B;QACAL;IACF;IAGF,4CAA4C;IAC5C,MAAMkC,cAAc5D,kBAClBmB,sBAAsBc,UAAU,EAChC;IAGF,4DAA4D;IAC5D,MAAM5B,gBACJY,MACA2C,aACA,uBACA;IAEF,MAAMtD,YACJW,MACA2C,aACA;IAGF,4CAA4C;IAC5C,MAAMC,eAAe,GAAGF,iBAAiB,QAAQ,CAAC;IAClD,MAAMtD,gBACJY,MACA2C,aACAC,cACA,CAAC,aAAa,EAAEA,cAAc;IAEhC,MAAMvD,YACJW,MACA2C,aACA,CAAC,kBAAkB,EAAEC,aAAa,UAAU,EAAEA,aAAa,wCAAwC,EAAEA,aAAa,KAAK,EAAEA,aAAa,KAAK,CAAC;IAG9I,gEAAgE;IAChE,2FAA2F;IAC3F,IAAI,CAAClC,cAAc;QACjB,MAAMxB,oBACJc,MACAE,sBAAsBJ,IAAI,EAC1BK,qBAAqBL,IAAI,EACzB;YACE+C,KAAK,CAAC,iBAAiB,EAAErC,KAAK,CAAC,CAAC;YAChCP;YACA,mFAAmF;YACnF,wDAAwD;YACxD,qFAAqF;YACrF,uFAAuF;YACvF6C,6BAA6B;gBAAClC;gBAAiBC;aAAqB;QACtE;IAEJ;IAEAtB,6BACES,MACAJ,aACEN,gBAAoDqB,cACpD;WACOJ,SAAS,QACV;YACE;YACA;YACA;YACA;SACD,GACD,EAAE;WACDA,SAAS,YAAY;YAAC;SAAqB,GAAG,EAAE;QACrD;QACA;KACD,GAEHX,aACEN,gBAAoDqB,cACpD;QAAC;KAAgB,GAEnB5B,kBAAkBmB,sBAAsBiC,IAAI,EAAE;AAElD,EAAE"}
+{"version":3,"sources":["../../../../../../../packages/nx-plugin/src/utils/connection/open-api/react.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\nimport {\n  generateFiles,\n  joinPathFragments,\n  OverwriteStrategy,\n  type ProjectConfiguration,\n  type Tree,\n  updateProjectConfiguration,\n} from '@nx/devkit';\nimport { addTargetToLocalDev } from '../../../connection/local-dev';\nimport runtimeConfigGenerator from '../../../ts/react-website/runtime-config/generator';\nimport { addSingleImport, applyGritQL } from '../../ast';\nimport {\n  type DependencyDeclaration,\n  forDependencies,\n  type MustDeclare,\n} from '../../declared-dependencies';\nimport { addDependenciesToPackageJson } from '../../dependencies';\nimport { updateGitIgnore } from '../../git';\nimport { kebabCase, toClassName } from '../../names';\nimport { sortObjectKeys } from '../../object';\nimport { type ITsDepVersion, withVersions } from '../../versions';\n\n/** Dependencies a caller must declare to add an OpenAPI React client. */\nexport const OPEN_API_REACT_DEPENDENCIES = [\n  { name: 'oidc-client-ts' },\n  { name: 'react-oidc-context' },\n  { name: '@aws-sdk/credential-provider-cognito-identity' },\n  { name: 'aws4fetch' },\n  { name: '@tanstack/react-query' },\n  { name: '@tanstack/react-query-devtools' },\n  { name: '@smithy/types' },\n] as const satisfies readonly { name: ITsDepVersion }[];\n\nexport interface AddOpenApiReactClientOptions {\n  /**\n   * The react project to add the openapi client and build targets to\n   */\n  frontendProjectConfig: ProjectConfiguration;\n  /**\n   * The backend project which serves the api\n   */\n  backendProjectConfig: ProjectConfiguration;\n  /**\n   * The project which builds/generates the openapi spec\n   */\n  specBuildProject: ProjectConfiguration;\n  /**\n   * Name of the api\n   */\n  apiName: string;\n  /**\n   * Path to the openapi spec from the workspace root\n   */\n  specPath: string;\n  /**\n   * Fully qualified target name for the target that builds/generates the openapi spec\n   */\n  specBuildTargetName: string;\n  /**\n   * Authentication method\n   */\n  auth: 'iam' | 'cognito' | 'custom';\n  /**\n   * Port on which the backend project's local server listens\n   */\n  port: number;\n  /**\n   * When true, the generated provider reads from runtimeConfig.agentRuntimes\n   * and converts Bedrock AgentCore Runtime ARNs to HTTP URLs.\n   * When false (default), reads from runtimeConfig.apis directly.\n   */\n  isAgentRuntime?: boolean;\n  /**\n   * When set, the generated provider reads the gateway's URL from\n   * runtimeConfig.gateways and routes to the agent via the gateway's\n   * path-based `/<targetName>` route instead of invoking the runtime directly.\n   */\n  gatewayRoute?: {\n    gatewayClassName: string;\n    targetName: string;\n  };\n  /**\n   * When true, skips the dev target setup. Use this when the caller\n   * handles dev target configuration separately (e.g. agent connections\n   * that use a component-specific dev target instead of 'serve').\n   */\n  skipLocalDev?: boolean;\n}\n\n/**\n * Adds an OpenAPI React client to the frontend project along with supporting build targets\n */\nexport const addOpenApiReactClient = async <\n  const D extends DependencyDeclaration,\n>(\n  tree: Tree,\n  {\n    apiName,\n    frontendProjectConfig,\n    backendProjectConfig,\n    specBuildProject,\n    specPath,\n    specBuildTargetName,\n    auth,\n    port,\n    isAgentRuntime = false,\n    gatewayRoute,\n    skipLocalDev = false,\n  }: AddOpenApiReactClientOptions,\n  declaration: D & MustDeclare<typeof OPEN_API_REACT_DEPENDENCIES, D>,\n) => {\n  const clientGenTarget = `generate:${kebabCase(apiName)}-client`;\n  const clientGenWatchTarget = `watch-${clientGenTarget}`;\n\n  const generatedClientDir = joinPathFragments('generated', kebabCase(apiName));\n  const generatedClientDirFromRoot = joinPathFragments(\n    frontendProjectConfig.sourceRoot,\n    generatedClientDir,\n  );\n\n  // Add TypeScript client generation to Frontend project.json\n  updateProjectConfiguration(tree, frontendProjectConfig.name, {\n    ...frontendProjectConfig,\n    targets: sortObjectKeys({\n      ...frontendProjectConfig.targets,\n      // Generate should run before compile and bundle as the client is created as part of the website src\n      ...Object.fromEntries(\n        ['compile', 'bundle'].map((target) => [\n          target,\n          {\n            ...frontendProjectConfig.targets?.[target],\n            dependsOn: [\n              ...(\n                frontendProjectConfig.targets?.[target]?.dependsOn ?? []\n              ).filter((t) => t !== clientGenTarget),\n              clientGenTarget,\n            ],\n          },\n        ]),\n      ),\n      [clientGenTarget]: {\n        cache: true,\n        executor: 'nx:run-commands',\n        inputs: [\n          {\n            dependentTasksOutputFiles: '**/*.json',\n          },\n        ],\n        outputs: [\n          joinPathFragments('{workspaceRoot}', generatedClientDirFromRoot),\n        ],\n        options: {\n          commands: [\n            `nx g @aws/nx-plugin:open-api#ts-hooks --openApiSpecPath=\"${specPath}\" --outputPath=\"${generatedClientDirFromRoot}\" --no-interactive`,\n          ],\n        },\n        dependsOn: [specBuildTargetName],\n      },\n      // Watch target for regenerating the client\n      [clientGenWatchTarget]: {\n        executor: 'nx:run-commands',\n        options: {\n          commands: [\n            `nx watch --projects=${specBuildProject.name} --includeDependencies -- nx run ${frontendProjectConfig.name}:\"${clientGenTarget}\"`,\n          ],\n        },\n        continuous: true,\n      },\n    }),\n  });\n\n  const relativeSrcDir = frontendProjectConfig.sourceRoot.slice(\n    frontendProjectConfig.root.length + 1,\n  );\n\n  // Ignore the generated client by default\n  // Users can safely remove the entry from the .gitignore if they prefer to check it in\n  updateGitIgnore(tree, frontendProjectConfig.root, (patterns) => [\n    ...patterns,\n    joinPathFragments(relativeSrcDir, generatedClientDir),\n  ]);\n\n  // Ensure that the frontend has runtime config as we'll use the url for creating the client\n  await runtimeConfigGenerator(tree, {\n    project: frontendProjectConfig.name,\n  });\n\n  // Add sigv4 fetch\n  if (auth === 'iam') {\n    generateFiles(\n      tree,\n      joinPathFragments(import.meta.dirname, '../../files/website/hooks/sigv4'),\n      joinPathFragments(frontendProjectConfig.sourceRoot, 'hooks'),\n      {},\n      {\n        overwriteStrategy: OverwriteStrategy.KeepExisting,\n      },\n    );\n  }\n\n  // Generate the tanstack query provider if it does not exist already\n  generateFiles(\n    tree,\n    joinPathFragments(\n      import.meta.dirname,\n      '../../files/website/components/tanstack-query',\n    ),\n    joinPathFragments(frontendProjectConfig.sourceRoot, 'components'),\n    {},\n    {\n      overwriteStrategy: OverwriteStrategy.KeepExisting,\n    },\n  );\n\n  const apiNameClassName = toClassName(apiName);\n\n  // Add a hook to instantiate the client\n  generateFiles(\n    tree,\n    joinPathFragments(import.meta.dirname, 'files'),\n    frontendProjectConfig.sourceRoot,\n    {\n      auth,\n      apiName,\n      apiNameClassName,\n      generatedClientDir,\n      isAgentRuntime,\n      gatewayRoute,\n    },\n  );\n\n  // Update main.tsx to add required providers\n  const mainTsxPath = joinPathFragments(\n    frontendProjectConfig.sourceRoot,\n    'main.tsx',\n  );\n\n  // Add the query client provider if it doesn't exist already\n  await addSingleImport(\n    tree,\n    mainTsxPath,\n    'QueryClientProvider',\n    './components/QueryClientProvider',\n  );\n  await applyGritQL(\n    tree,\n    mainTsxPath,\n    '`<App />` => `<QueryClientProvider><App /></QueryClientProvider>` where { $program <: not contains `<QueryClientProvider>$_</QueryClientProvider>` }',\n  );\n\n  // Add the api provider if it does not exist\n  const providerName = `${apiNameClassName}Provider`;\n  await addSingleImport(\n    tree,\n    mainTsxPath,\n    providerName,\n    `./components/${providerName}`,\n  );\n  await applyGritQL(\n    tree,\n    mainTsxPath,\n    `\\`<App />\\` => \\`<${providerName}><App /></${providerName}>\\` where { $program <: not contains \\`<${providerName}>$_</${providerName}>\\` }`,\n  );\n\n  // Update the dev target on the website to use our local server.\n  // Callers that handle the dev target separately (e.g. agent connections) set skipLocalDev.\n  if (!skipLocalDev) {\n    await addTargetToLocalDev(\n      tree,\n      frontendProjectConfig.name,\n      backendProjectConfig.name,\n      {\n        url: `http://localhost:${port}/`,\n        apiName,\n        // Additionally add a dependency on the generate watch command to ensure that local\n        // API changes that affect the client are also reloaded.\n        // We include a dependency on the generate target as watch ONLY triggers on a change,\n        // and we need to ensure the client is generated the first time if not already present.\n        additionalDependencyTargets: [clientGenTarget, clientGenWatchTarget],\n      },\n    );\n  }\n\n  addDependenciesToPackageJson(\n    tree,\n    withVersions(\n      forDependencies<typeof OPEN_API_REACT_DEPENDENCIES>(declaration),\n      [\n        ...((auth === 'iam'\n          ? [\n              'oidc-client-ts',\n              'react-oidc-context',\n              '@aws-sdk/credential-provider-cognito-identity',\n              'aws4fetch',\n            ]\n          : []) as any),\n        ...((auth === 'cognito' ? ['react-oidc-context'] : []) as any),\n        '@tanstack/react-query',\n        '@tanstack/react-query-devtools',\n      ],\n    ),\n    withVersions(\n      forDependencies<typeof OPEN_API_REACT_DEPENDENCIES>(declaration),\n      ['@smithy/types'],\n    ),\n    joinPathFragments(frontendProjectConfig.root, 'package.json'),\n  );\n};\n"],"names":["generateFiles","joinPathFragments","OverwriteStrategy","updateProjectConfiguration","addTargetToLocalDev","runtimeConfigGenerator","addSingleImport","applyGritQL","forDependencies","addDependenciesToPackageJson","updateGitIgnore","kebabCase","toClassName","sortObjectKeys","withVersions","OPEN_API_REACT_DEPENDENCIES","name","addOpenApiReactClient","tree","apiName","frontendProjectConfig","backendProjectConfig","specBuildProject","specPath","specBuildTargetName","auth","port","isAgentRuntime","gatewayRoute","skipLocalDev","declaration","clientGenTarget","clientGenWatchTarget","generatedClientDir","generatedClientDirFromRoot","sourceRoot","targets","Object","fromEntries","map","target","dependsOn","filter","t","cache","executor","inputs","dependentTasksOutputFiles","outputs","options","commands","continuous","relativeSrcDir","slice","root","length","patterns","project","dirname","overwriteStrategy","KeepExisting","apiNameClassName","mainTsxPath","providerName","url","additionalDependencyTargets"],"mappings":"AAAA;;;CAGC,GACD,SACEA,aAAa,EACbC,iBAAiB,EACjBC,iBAAiB,EAGjBC,0BAA0B,QACrB,aAAa;AACpB,SAASC,mBAAmB,QAAQ,mCAAgC;AACpE,OAAOC,4BAA4B,wDAAqD;AACxF,SAASC,eAAe,EAAEC,WAAW,QAAQ,eAAY;AACzD,SAEEC,eAAe,QAEV,iCAA8B;AACrC,SAASC,4BAA4B,QAAQ,wBAAqB;AAClE,SAASC,eAAe,QAAQ,eAAY;AAC5C,SAASC,SAAS,EAAEC,WAAW,QAAQ,iBAAc;AACrD,SAASC,cAAc,QAAQ,kBAAe;AAC9C,SAA6BC,YAAY,QAAQ,oBAAiB;AAElE,uEAAuE,GACvE,OAAO,MAAMC,8BAA8B;IACzC;QAAEC,MAAM;IAAiB;IACzB;QAAEA,MAAM;IAAqB;IAC7B;QAAEA,MAAM;IAAgD;IACxD;QAAEA,MAAM;IAAY;IACpB;QAAEA,MAAM;IAAwB;IAChC;QAAEA,MAAM;IAAiC;IACzC;QAAEA,MAAM;IAAgB;CACzB,CAAuD;AA0DxD;;CAEC,GACD,OAAO,MAAMC,wBAAwB,OAGnCC,MACA,EACEC,OAAO,EACPC,qBAAqB,EACrBC,oBAAoB,EACpBC,gBAAgB,EAChBC,QAAQ,EACRC,mBAAmB,EACnBC,IAAI,EACJC,IAAI,EACJC,iBAAiB,KAAK,EACtBC,YAAY,EACZC,eAAe,KAAK,EACS,EAC/BC;IAEA,MAAMC,kBAAkB,CAAC,SAAS,EAAEpB,UAAUQ,SAAS,OAAO,CAAC;IAC/D,MAAMa,uBAAuB,CAAC,MAAM,EAAED,iBAAiB;IAEvD,MAAME,qBAAqBhC,kBAAkB,aAAaU,UAAUQ;IACpE,MAAMe,6BAA6BjC,kBACjCmB,sBAAsBe,UAAU,EAChCF;IAGF,4DAA4D;IAC5D9B,2BAA2Be,MAAME,sBAAsBJ,IAAI,EAAE;QAC3D,GAAGI,qBAAqB;QACxBgB,SAASvB,eAAe;YACtB,GAAGO,sBAAsBgB,OAAO;YAChC,oGAAoG;YACpG,GAAGC,OAAOC,WAAW,CACnB;gBAAC;gBAAW;aAAS,CAACC,GAAG,CAAC,CAACC,SAAW;oBACpCA;oBACA;wBACE,GAAGpB,sBAAsBgB,OAAO,EAAE,CAACI,OAAO;wBAC1CC,WAAW;+BACN,AACDrB,CAAAA,sBAAsBgB,OAAO,EAAE,CAACI,OAAO,EAAEC,aAAa,EAAE,AAAD,EACvDC,MAAM,CAAC,CAACC,IAAMA,MAAMZ;4BACtBA;yBACD;oBACH;iBACD,EACF;YACD,CAACA,gBAAgB,EAAE;gBACjBa,OAAO;gBACPC,UAAU;gBACVC,QAAQ;oBACN;wBACEC,2BAA2B;oBAC7B;iBACD;gBACDC,SAAS;oBACP/C,kBAAkB,mBAAmBiC;iBACtC;gBACDe,SAAS;oBACPC,UAAU;wBACR,CAAC,yDAAyD,EAAE3B,SAAS,gBAAgB,EAAEW,2BAA2B,kBAAkB,CAAC;qBACtI;gBACH;gBACAO,WAAW;oBAACjB;iBAAoB;YAClC;YACA,2CAA2C;YAC3C,CAACQ,qBAAqB,EAAE;gBACtBa,UAAU;gBACVI,SAAS;oBACPC,UAAU;wBACR,CAAC,oBAAoB,EAAE5B,iBAAiBN,IAAI,CAAC,iCAAiC,EAAEI,sBAAsBJ,IAAI,CAAC,EAAE,EAAEe,gBAAgB,CAAC,CAAC;qBAClI;gBACH;gBACAoB,YAAY;YACd;QACF;IACF;IAEA,MAAMC,iBAAiBhC,sBAAsBe,UAAU,CAACkB,KAAK,CAC3DjC,sBAAsBkC,IAAI,CAACC,MAAM,GAAG;IAGtC,yCAAyC;IACzC,sFAAsF;IACtF7C,gBAAgBQ,MAAME,sBAAsBkC,IAAI,EAAE,CAACE,WAAa;eAC3DA;YACHvD,kBAAkBmD,gBAAgBnB;SACnC;IAED,2FAA2F;IAC3F,MAAM5B,uBAAuBa,MAAM;QACjCuC,SAASrC,sBAAsBJ,IAAI;IACrC;IAEA,kBAAkB;IAClB,IAAIS,SAAS,OAAO;QAClBzB,cACEkB,MACAjB,kBAAkB,YAAYyD,OAAO,EAAE,oCACvCzD,kBAAkBmB,sBAAsBe,UAAU,EAAE,UACpD,CAAC,GACD;YACEwB,mBAAmBzD,kBAAkB0D,YAAY;QACnD;IAEJ;IAEA,oEAAoE;IACpE5D,cACEkB,MACAjB,kBACE,YAAYyD,OAAO,EACnB,kDAEFzD,kBAAkBmB,sBAAsBe,UAAU,EAAE,eACpD,CAAC,GACD;QACEwB,mBAAmBzD,kBAAkB0D,YAAY;IACnD;IAGF,MAAMC,mBAAmBjD,YAAYO;IAErC,uCAAuC;IACvCnB,cACEkB,MACAjB,kBAAkB,YAAYyD,OAAO,EAAE,UACvCtC,sBAAsBe,UAAU,EAChC;QACEV;QACAN;QACA0C;QACA5B;QACAN;QACAC;IACF;IAGF,4CAA4C;IAC5C,MAAMkC,cAAc7D,kBAClBmB,sBAAsBe,UAAU,EAChC;IAGF,4DAA4D;IAC5D,MAAM7B,gBACJY,MACA4C,aACA,uBACA;IAEF,MAAMvD,YACJW,MACA4C,aACA;IAGF,4CAA4C;IAC5C,MAAMC,eAAe,GAAGF,iBAAiB,QAAQ,CAAC;IAClD,MAAMvD,gBACJY,MACA4C,aACAC,cACA,CAAC,aAAa,EAAEA,cAAc;IAEhC,MAAMxD,YACJW,MACA4C,aACA,CAAC,kBAAkB,EAAEC,aAAa,UAAU,EAAEA,aAAa,wCAAwC,EAAEA,aAAa,KAAK,EAAEA,aAAa,KAAK,CAAC;IAG9I,gEAAgE;IAChE,2FAA2F;IAC3F,IAAI,CAAClC,cAAc;QACjB,MAAMzB,oBACJc,MACAE,sBAAsBJ,IAAI,EAC1BK,qBAAqBL,IAAI,EACzB;YACEgD,KAAK,CAAC,iBAAiB,EAAEtC,KAAK,CAAC,CAAC;YAChCP;YACA,mFAAmF;YACnF,wDAAwD;YACxD,qFAAqF;YACrF,uFAAuF;YACvF8C,6BAA6B;gBAAClC;gBAAiBC;aAAqB;QACtE;IAEJ;IAEAvB,6BACES,MACAJ,aACEN,gBAAoDsB,cACpD;WACOL,SAAS,QACV;YACE;YACA;YACA;YACA;SACD,GACD,EAAE;WACDA,SAAS,YAAY;YAAC;SAAqB,GAAG,EAAE;QACrD;QACA;KACD,GAEHX,aACEN,gBAAoDsB,cACpD;QAAC;KAAgB,GAEnB7B,kBAAkBmB,sBAAsBkC,IAAI,EAAE;AAElD,EAAE"}

package/src/utils/migration-manifest.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { MigrationsJson } from './migration-versions';
+/**
+ * `migrations.json` is assembled from the plugin's source rather than committed,
+ * so two PRs each adding a migration touch disjoint files and never conflict on
+ * a shared manifest.
+ *
+ * The pieces it is assembled from:
+ * - one folder per migration under `src/migrations/<dir>/<name>/`, where `<dir>`
+ *   is `latest` until a release claims it and `v<version>` after — the folder
+ *   carries a `metadata.json` (its description) beside the code, and its files
+ *   discriminate the kind: a `migration.ts` makes it deterministic, a `prompt.md`
+ *   agentic, both hybrid;
+ * - `packageJsonUpdates.json`, the nx bumps the weekly update maintains, kept in
+ *   its own file so that churn never shares an edit with a migration PR;
+ * - the version sync entry, a fixed `everyMigration` codemod that runs on every
+ *   upgrade and so has no folder.
+ *
+ * The assembled manifest is unversioned — release-time stamping resolves versions
+ * (see `migration-versions.ts`).
+ */
+/** JSON schema the manifest declares, matching what nx expects. */
+export declare const MIGRATIONS_JSON_SCHEMA = "http://json-schema.org/schema";
+/** Key the version sync migration is registered under. */
+export declare const SYNC_VENDED_MIGRATION_KEY = "sync-vended-versions";
+/**
+ * The version sync migration entry. Committed as code rather than a folder: it
+ * carries no release-specific registration and must run on every upgrade, so it
+ * is fixed and can't conflict.
+ */
+export declare const syncVendedMigrationEntry: () => NonNullable<MigrationsJson["generators"]>[string];
+/** A migration folder discovered under `src/migrations`. */
+export interface DiscoveredMigration {
+    /** Folder grouping the migration by release: `latest` or `v<version>`. */
+    dir: string;
+    /** Migration folder name. */
+    name: string;
+    /** Description read from the folder's `metadata.json`. */
+    description: string;
+    /** A `migration.ts` is present, so the migration has a codemod. */
+    hasImplementation: boolean;
+    /** A `prompt.md` is present, so the migration hands off to an agent. */
+    hasPrompt: boolean;
+}
+/**
+ * Assemble the plugin's `migrations.json` from its source pieces: the discovered
+ * migration folders, the version sync entry, and the nx `packageJsonUpdates`.
+ *
+ * Deterministic — keys are sorted — so regenerating always yields the same file.
+ *
+ * @param pluginName the plugin package name the manifest is for
+ * @param migrations migration folders discovered under `src/migrations`
+ * @param packageJsonUpdates parsed `packageJsonUpdates.json`, if present
+ */
+export declare const assembleMigrations: (pluginName: string, migrations: DiscoveredMigration[], packageJsonUpdates?: MigrationsJson["packageJsonUpdates"]) => MigrationsJson;

package/src/utils/migration-manifest.js

@@ -0,0 +1,76 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */ import { isValidVersion, LATEST_MIGRATIONS_DIR, migrationKey } from "./migration-versions.js";
+import { sortObjectKeys } from "./object.js";
+/**
+ * `migrations.json` is assembled from the plugin's source rather than committed,
+ * so two PRs each adding a migration touch disjoint files and never conflict on
+ * a shared manifest.
+ *
+ * The pieces it is assembled from:
+ * - one folder per migration under `src/migrations/<dir>/<name>/`, where `<dir>`
+ *   is `latest` until a release claims it and `v<version>` after — the folder
+ *   carries a `metadata.json` (its description) beside the code, and its files
+ *   discriminate the kind: a `migration.ts` makes it deterministic, a `prompt.md`
+ *   agentic, both hybrid;
+ * - `packageJsonUpdates.json`, the nx bumps the weekly update maintains, kept in
+ *   its own file so that churn never shares an edit with a migration PR;
+ * - the version sync entry, a fixed `everyMigration` codemod that runs on every
+ *   upgrade and so has no folder.
+ *
+ * The assembled manifest is unversioned — release-time stamping resolves versions
+ * (see `migration-versions.ts`).
+ */ /** JSON schema the manifest declares, matching what nx expects. */ export const MIGRATIONS_JSON_SCHEMA = 'http://json-schema.org/schema';
+/** Key the version sync migration is registered under. */ export const SYNC_VENDED_MIGRATION_KEY = 'sync-vended-versions';
+/**
+ * The version sync migration entry. Committed as code rather than a folder: it
+ * carries no release-specific registration and must run on every upgrade, so it
+ * is fixed and can't conflict.
+ */ export const syncVendedMigrationEntry = ()=>({
+        description: 'Sync vended dependency versions and the tracked plugin version to those vended by this release',
+        implementation: './src/utils/version-upgrade-migration/migration',
+        everyMigration: true
+    });
+/** Registration for a single discovered migration folder. */ const migrationEntry = (migration)=>{
+    const path = `./src/migrations/${migration.dir}/${migration.name}`;
+    return {
+        // A migration in a `v<version>` folder has already been claimed by that
+        // release; its version is the folder. One in `latest` is left for stamping.
+        ...migration.dir !== LATEST_MIGRATIONS_DIR && isValidVersion(migration.dir.replace(/^v/, '')) ? {
+            version: migration.dir.replace(/^v/, '')
+        } : {},
+        description: migration.description,
+        ...migration.hasImplementation ? {
+            implementation: `${path}/migration`
+        } : {},
+        ...migration.hasPrompt ? {
+            prompt: `${path}/prompt.md`
+        } : {}
+    };
+};
+/**
+ * Assemble the plugin's `migrations.json` from its source pieces: the discovered
+ * migration folders, the version sync entry, and the nx `packageJsonUpdates`.
+ *
+ * Deterministic — keys are sorted — so regenerating always yields the same file.
+ *
+ * @param pluginName the plugin package name the manifest is for
+ * @param migrations migration folders discovered under `src/migrations`
+ * @param packageJsonUpdates parsed `packageJsonUpdates.json`, if present
+ */ export const assembleMigrations = (pluginName, migrations, packageJsonUpdates)=>({
+        $schema: MIGRATIONS_JSON_SCHEMA,
+        name: pluginName,
+        generators: sortObjectKeys({
+            [SYNC_VENDED_MIGRATION_KEY]: syncVendedMigrationEntry(),
+            ...Object.fromEntries(migrations.map((migration)=>[
+                    migrationKey(migration.dir, migration.name),
+                    migrationEntry(migration)
+                ]))
+        }),
+        ...packageJsonUpdates && Object.keys(packageJsonUpdates).length > 0 ? {
+            packageJsonUpdates
+        } : {}
+    });
+
+//# sourceMappingURL=migration-manifest.js.map

package/src/utils/migration-manifest.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/nx-plugin/src/utils/migration-manifest.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\nimport type { MigrationsJson } from './migration-versions';\nimport {\n  isValidVersion,\n  LATEST_MIGRATIONS_DIR,\n  migrationKey,\n} from './migration-versions';\nimport { sortObjectKeys } from './object';\n\n/**\n * `migrations.json` is assembled from the plugin's source rather than committed,\n * so two PRs each adding a migration touch disjoint files and never conflict on\n * a shared manifest.\n *\n * The pieces it is assembled from:\n * - one folder per migration under `src/migrations/<dir>/<name>/`, where `<dir>`\n *   is `latest` until a release claims it and `v<version>` after — the folder\n *   carries a `metadata.json` (its description) beside the code, and its files\n *   discriminate the kind: a `migration.ts` makes it deterministic, a `prompt.md`\n *   agentic, both hybrid;\n * - `packageJsonUpdates.json`, the nx bumps the weekly update maintains, kept in\n *   its own file so that churn never shares an edit with a migration PR;\n * - the version sync entry, a fixed `everyMigration` codemod that runs on every\n *   upgrade and so has no folder.\n *\n * The assembled manifest is unversioned — release-time stamping resolves versions\n * (see `migration-versions.ts`).\n */\n\n/** JSON schema the manifest declares, matching what nx expects. */\nexport const MIGRATIONS_JSON_SCHEMA = 'http://json-schema.org/schema';\n\n/** Key the version sync migration is registered under. */\nexport const SYNC_VENDED_MIGRATION_KEY = 'sync-vended-versions';\n\n/**\n * The version sync migration entry. Committed as code rather than a folder: it\n * carries no release-specific registration and must run on every upgrade, so it\n * is fixed and can't conflict.\n */\nexport const syncVendedMigrationEntry = (): NonNullable<\n  MigrationsJson['generators']\n>[string] => ({\n  description:\n    'Sync vended dependency versions and the tracked plugin version to those vended by this release',\n  implementation: './src/utils/version-upgrade-migration/migration',\n  everyMigration: true,\n});\n\n/** A migration folder discovered under `src/migrations`. */\nexport interface DiscoveredMigration {\n  /** Folder grouping the migration by release: `latest` or `v<version>`. */\n  dir: string;\n  /** Migration folder name. */\n  name: string;\n  /** Description read from the folder's `metadata.json`. */\n  description: string;\n  /** A `migration.ts` is present, so the migration has a codemod. */\n  hasImplementation: boolean;\n  /** A `prompt.md` is present, so the migration hands off to an agent. */\n  hasPrompt: boolean;\n}\n\n/** Registration for a single discovered migration folder. */\nconst migrationEntry = (\n  migration: DiscoveredMigration,\n): NonNullable<MigrationsJson['generators']>[string] => {\n  const path = `./src/migrations/${migration.dir}/${migration.name}`;\n  return {\n    // A migration in a `v<version>` folder has already been claimed by that\n    // release; its version is the folder. One in `latest` is left for stamping.\n    ...(migration.dir !== LATEST_MIGRATIONS_DIR &&\n    isValidVersion(migration.dir.replace(/^v/, ''))\n      ? { version: migration.dir.replace(/^v/, '') }\n      : {}),\n    description: migration.description,\n    ...(migration.hasImplementation\n      ? { implementation: `${path}/migration` }\n      : {}),\n    ...(migration.hasPrompt ? { prompt: `${path}/prompt.md` } : {}),\n  };\n};\n\n/**\n * Assemble the plugin's `migrations.json` from its source pieces: the discovered\n * migration folders, the version sync entry, and the nx `packageJsonUpdates`.\n *\n * Deterministic — keys are sorted — so regenerating always yields the same file.\n *\n * @param pluginName the plugin package name the manifest is for\n * @param migrations migration folders discovered under `src/migrations`\n * @param packageJsonUpdates parsed `packageJsonUpdates.json`, if present\n */\nexport const assembleMigrations = (\n  pluginName: string,\n  migrations: DiscoveredMigration[],\n  packageJsonUpdates?: MigrationsJson['packageJsonUpdates'],\n): MigrationsJson => ({\n  $schema: MIGRATIONS_JSON_SCHEMA,\n  name: pluginName,\n  generators: sortObjectKeys({\n    [SYNC_VENDED_MIGRATION_KEY]: syncVendedMigrationEntry(),\n    ...Object.fromEntries(\n      migrations.map((migration) => [\n        migrationKey(migration.dir, migration.name),\n        migrationEntry(migration),\n      ]),\n    ),\n  }),\n  ...(packageJsonUpdates && Object.keys(packageJsonUpdates).length > 0\n    ? { packageJsonUpdates }\n    : {}),\n});\n"],"names":["isValidVersion","LATEST_MIGRATIONS_DIR","migrationKey","sortObjectKeys","MIGRATIONS_JSON_SCHEMA","SYNC_VENDED_MIGRATION_KEY","syncVendedMigrationEntry","description","implementation","everyMigration","migrationEntry","migration","path","dir","name","replace","version","hasImplementation","hasPrompt","prompt","assembleMigrations","pluginName","migrations","packageJsonUpdates","$schema","generators","Object","fromEntries","map","keys","length"],"mappings":"AAAA;;;CAGC,GAED,SACEA,cAAc,EACdC,qBAAqB,EACrBC,YAAY,QACP,0BAAuB;AAC9B,SAASC,cAAc,QAAQ,cAAW;AAE1C;;;;;;;;;;;;;;;;;;CAkBC,GAED,iEAAiE,GACjE,OAAO,MAAMC,yBAAyB,gCAAgC;AAEtE,wDAAwD,GACxD,OAAO,MAAMC,4BAA4B,uBAAuB;AAEhE;;;;CAIC,GACD,OAAO,MAAMC,2BAA2B,IAE1B,CAAA;QACZC,aACE;QACFC,gBAAgB;QAChBC,gBAAgB;IAClB,CAAA,EAAG;AAgBH,2DAA2D,GAC3D,MAAMC,iBAAiB,CACrBC;IAEA,MAAMC,OAAO,CAAC,iBAAiB,EAAED,UAAUE,GAAG,CAAC,CAAC,EAAEF,UAAUG,IAAI,EAAE;IAClE,OAAO;QACL,wEAAwE;QACxE,4EAA4E;QAC5E,GAAIH,UAAUE,GAAG,KAAKZ,yBACtBD,eAAeW,UAAUE,GAAG,CAACE,OAAO,CAAC,MAAM,OACvC;YAAEC,SAASL,UAAUE,GAAG,CAACE,OAAO,CAAC,MAAM;QAAI,IAC3C,CAAC,CAAC;QACNR,aAAaI,UAAUJ,WAAW;QAClC,GAAII,UAAUM,iBAAiB,GAC3B;YAAET,gBAAgB,GAAGI,KAAK,UAAU,CAAC;QAAC,IACtC,CAAC,CAAC;QACN,GAAID,UAAUO,SAAS,GAAG;YAAEC,QAAQ,GAAGP,KAAK,UAAU,CAAC;QAAC,IAAI,CAAC,CAAC;IAChE;AACF;AAEA;;;;;;;;;CASC,GACD,OAAO,MAAMQ,qBAAqB,CAChCC,YACAC,YACAC,qBACoB,CAAA;QACpBC,SAASpB;QACTU,MAAMO;QACNI,YAAYtB,eAAe;YACzB,CAACE,0BAA0B,EAAEC;YAC7B,GAAGoB,OAAOC,WAAW,CACnBL,WAAWM,GAAG,CAAC,CAACjB,YAAc;oBAC5BT,aAAaS,UAAUE,GAAG,EAAEF,UAAUG,IAAI;oBAC1CJ,eAAeC;iBAChB,EACF;QACH;QACA,GAAIY,sBAAsBG,OAAOG,IAAI,CAACN,oBAAoBO,MAAM,GAAG,IAC/D;YAAEP;QAAmB,IACrB,CAAC,CAAC;IACR,CAAA,EAAG"}

package/src/utils/migration-versions.d.ts

@@ -27,6 +27,8 @@ import { compare } from 'semver';
  * re-stamped with each pending version, so it runs on every upgrade.
  */
 export interface MigrationsJson {
+    $schema?: string;
+    name?: string;
     generators?: Record<string, {
         version?: string;
         everyMigration?: boolean;

package/src/utils/migration-versions.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../packages/nx-plugin/src/utils/migration-versions.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\nimport { compare, valid } from 'semver';\n\n/**\n * Version stamping for migrations.\n *\n * A new migration is committed with no `version` — releases are calculated from\n * conventional commits and written only to `dist/` and a git tag, so versions\n * reach the published `migrations.json` two ways:\n *\n * - At release time (`scripts/stamp-migrations.ts`) entries still missing a\n *   version are stamped into the compiled `migrations.json`: an already shipped\n *   one gets the earliest release tag registering it, and a net-new one gets the\n *   version the release is about to publish, which the release job passes in\n *   after `nx release version` writes it to the dist manifests.\n * - The weekly `update-versions` PR backfills the version of the release that\n *   shipped each migration, moving and re-keying it accordingly\n *   (`scripts/backfill-migration-versions.ts`), so source converges on the\n *   versions of everything already released. `packageJsonUpdates` entries are\n *   dated in place there too, since their keys never change.\n *\n * A version already in source always wins, so backfilled entries are stable.\n *\n * An entry marked `everyMigration: true` is never backfilled or pinned, and is\n * re-stamped with each pending version, so it runs on every upgrade.\n */\n\nexport interface MigrationsJson {\n  generators?: Record<\n    string,\n    { version?: string; everyMigration?: boolean } & Record<string, unknown>\n  >;\n  /**\n   * Declarative dependency bumps `nx migrate` applies to the root manifest.\n   * Keyed by what the bump targets rather than the release that ships it, so an\n   * entry is unique from the moment it is written and one release's bump can sit\n   * beside the next; nx itself gates on the entry's `version`.\n   */\n  packageJsonUpdates?: Record<\n    string,\n    { version: string } & Record<string, unknown>\n  >;\n}\n\n/** Ascending semver comparator for `Array.prototype.sort`. */\nexport const compareVersions = compare;\n\n/** Whether a string is an exact semver version. */\nexport const isValidVersion = (version: string): boolean =>\n  valid(version) !== null;\n\n/**\n * Map of entry key -> version of the earliest release that registers it, across\n * both `generators` and `packageJsonUpdates`. Resolved only for the entries still\n * missing a version (one already recorded in source wins, so its history doesn't\n * need reading). An entry that hasn't been released is absent.\n *\n * Walks releases newest first and stops as soon as every entry is resolved: an\n * entry that has disappeared from a release's `migrations.json` was first\n * registered by the release after it, which is the one that shipped it.\n *\n * Both sections resolve the same way and share the walk, so the release doesn't\n * read tag history twice. Keys can't collide: a migration is keyed by its own\n * name, an nx bump by the nx version it moves to.\n *\n * @param migrations parsed source migrations.json\n * @param versions released versions in descending semver order\n * @param readReleasedMigrations reads the `migrations.json` published by a given\n *   version, or undefined if it predates the manifest\n */\nexport const readShippedMigrationVersions = (\n  migrations: MigrationsJson,\n  versions: string[],\n  readReleasedMigrations: (version: string) => MigrationsJson | undefined,\n): Record<string, string> => {\n  const shippedVersions: Record<string, string> = {};\n  // A `packageJsonUpdates` entry records `latest` rather than omitting its\n  // version, since nx requires the field.\n  let unresolved = [\n    ...Object.entries(migrations.generators ?? {})\n      .filter(([, entry]) => !entry.version)\n      .map(([key]) => key),\n    ...Object.entries(migrations.packageJsonUpdates ?? {})\n      .filter(([, entry]) => entry.version === LATEST_MIGRATIONS_DIR)\n      .map(([key]) => key),\n  ];\n\n  for (const version of versions) {\n    if (unresolved.length === 0) {\n      break;\n    }\n    const released = readReleasedMigrations(version);\n    const registered = new Set([\n      ...Object.keys(released?.generators ?? {}),\n      ...Object.keys(released?.packageJsonUpdates ?? {}),\n    ]);\n    // Entries gone at this release keep the version recorded from the release\n    // after it (if any) and stop being looked up.\n    unresolved = unresolved.filter((key) => registered.has(key));\n    for (const key of unresolved) {\n      shippedVersions[key] = version;\n    }\n  }\n\n  return shippedVersions;\n};\n\n/**\n * Return a copy of the migrations collection with a `version` stamped onto\n * every generator entry, preserving any already present, and the pending version\n * recorded on any `packageJsonUpdates` entry still holding `latest`.\n *\n * @param migrations parsed migrations.json to stamp\n * @param shippedVersions migration key -> version of the earliest release\n *   tag that registers it (absent for migrations that haven't shipped)\n * @param pendingVersion version the release is about to publish, stamped onto\n *   unshipped migrations so their version is one that really shipped\n */\nexport const stampMigrationVersions = (\n  migrations: MigrationsJson,\n  shippedVersions: Record<string, string>,\n  pendingVersion: string,\n): MigrationsJson => ({\n  ...migrations,\n  generators: Object.fromEntries(\n    // `nx migrate` sorts the run ascending by version and preserves the\n    // manifest's order among equal versions, so emitting the every-migration\n    // entries last is what makes them run after the release's own migrations.\n    Object.entries(migrations.generators ?? {})\n      .sort(\n        ([, a], [, b]) =>\n          Number(a.everyMigration ?? false) - Number(b.everyMigration ?? false),\n      )\n      .map(([name, entry]) => {\n        // Source-only marker, stripped from what nx reads.\n        const { everyMigration, version: sourceVersion, ...published } = entry;\n        // Overrides any source version so it stays ahead of what is installed.\n        const version = everyMigration\n          ? pendingVersion\n          : (sourceVersion ?? shippedVersions[name] ?? pendingVersion);\n        return [name, { version, ...published }];\n      }),\n  ),\n  ...(migrations.packageJsonUpdates && {\n    packageJsonUpdates: stampPackageJsonUpdates(\n      migrations.packageJsonUpdates,\n      pendingVersion,\n    ),\n  }),\n});\n\n/**\n * Version any `packageJsonUpdates` entry still holding `latest` with the release\n * about to publish it, so the nx bump ships under a version `nx migrate` gates on.\n */\nconst stampPackageJsonUpdates = (\n  packageJsonUpdates: NonNullable<MigrationsJson['packageJsonUpdates']>,\n  pendingVersion: string,\n): NonNullable<MigrationsJson['packageJsonUpdates']> =>\n  resolvePackageJsonUpdateVersions(packageJsonUpdates, () => pendingVersion);\n\n/** Directory a newly scaffolded migration lands in, before a release claims it. */\nexport const LATEST_MIGRATIONS_DIR = 'latest';\n\n/** Directory holding the migrations shipped by a given release. */\nexport const versionMigrationsDir = (version: string) => `v${version}`;\n\n/**\n * Key a migration is registered under in `migrations.json`. Prefixed with its\n * directory so reusing a name in a later release can't silently overwrite the\n * one that already shipped.\n */\nexport const migrationKey = (dir: string, name: string) => `${dir}-${name}`;\n\nconst LATEST_KEY_PREFIX = `${LATEST_MIGRATIONS_DIR}-`;\n\n/** A migration directory move the caller needs to make on disk. */\nexport interface MigrationDirMove {\n  name: string;\n  version: string;\n  from: string;\n  to: string;\n}\n\n/**\n * Record the release that shipped each migration on entries without a version,\n * re-keying them and re-pointing their paths at that release's folder, and\n * return the collection alongside the keys that changed and the directory moves\n * to make on disk.\n *\n * Unlike `stampMigrationVersions` this only records already-released versions,\n * leaving the release to decide what a net-new migration gets.\n *\n * @param migrations parsed migrations.json to backfill\n * @param shippedVersions migration key -> version of the earliest release tag\n *   that registers it (absent for migrations that haven't shipped)\n */\nexport const backfillMigrationVersions = (\n  migrations: MigrationsJson,\n  shippedVersions: Record<string, string>,\n): {\n  migrations: MigrationsJson;\n  backfilled: string[];\n  moves: MigrationDirMove[];\n} => {\n  const generators: NonNullable<MigrationsJson['generators']> = {};\n  const backfilled: string[] = [];\n  const moves: MigrationDirMove[] = [];\n  // Reported alongside the migrations so the update's PR says an nx bump was\n  // dated, and so the caller knows there is something to commit.\n  const backfilledUpdates = Object.entries(migrations.packageJsonUpdates ?? {})\n    .filter(\n      ([key, entry]) =>\n        entry.version === LATEST_MIGRATIONS_DIR && shippedVersions[key],\n    )\n    .map(([key]) => key);\n\n  for (const [key, entry] of Object.entries(migrations.generators ?? {})) {\n    const version = shippedVersions[key];\n    // Pinning an every-migration entry would stop it running on later upgrades.\n    if (entry.version || !version || entry.everyMigration) {\n      generators[key] = entry;\n      continue;\n    }\n\n    const name = key.startsWith(LATEST_KEY_PREFIX)\n      ? key.slice(LATEST_KEY_PREFIX.length)\n      : key;\n    const versionDir = versionMigrationsDir(version);\n    const latestSegment = `/${LATEST_MIGRATIONS_DIR}/${name}/`;\n    const versionSegment = `/${versionDir}/${name}/`;\n\n    // Re-point each path field at the version folder, recording the move the\n    // caller needs to make on disk the first time one is found.\n    const repointed: Record<string, unknown> = {};\n    let moved = false;\n    for (const [field, value] of Object.entries(entry)) {\n      if (typeof value !== 'string' || !value.includes(latestSegment)) {\n        repointed[field] = value;\n        continue;\n      }\n      repointed[field] = value.replace(latestSegment, versionSegment);\n      if (!moved) {\n        moved = true;\n        const dir = value.slice(0, value.indexOf(latestSegment));\n        moves.push({\n          name,\n          version,\n          from: `${dir}${latestSegment}`.replace(/^\\.\\/|\\/$/g, ''),\n          to: `${dir}${versionSegment}`.replace(/^\\.\\/|\\/$/g, ''),\n        });\n      }\n    }\n\n    generators[migrationKey(versionDir, name)] = { version, ...repointed };\n    backfilled.push(key);\n  }\n\n  return {\n    migrations: {\n      ...migrations,\n      generators,\n      ...(migrations.packageJsonUpdates && {\n        packageJsonUpdates: resolvePackageJsonUpdateVersions(\n          migrations.packageJsonUpdates,\n          (key) => shippedVersions[key],\n        ),\n      }),\n    },\n    backfilled: [...backfilled, ...backfilledUpdates],\n    moves,\n  };\n};\n\n/**\n * Record the version each `packageJsonUpdates` entry ships under, for those still\n * holding `latest`.\n *\n * The key already identifies the entry — an nx bump is named for the nx version\n * it moves to — so only the `version` field changes. Nothing is re-keyed, which\n * is what lets one release's bump sit alongside the next without either being\n * overwritten before it ships.\n */\nconst resolvePackageJsonUpdateVersions = (\n  packageJsonUpdates: NonNullable<MigrationsJson['packageJsonUpdates']>,\n  resolve: (key: string) => string | undefined,\n): NonNullable<MigrationsJson['packageJsonUpdates']> =>\n  Object.fromEntries(\n    Object.entries(packageJsonUpdates).map(([key, entry]) => {\n      const version =\n        entry.version === LATEST_MIGRATIONS_DIR ? resolve(key) : undefined;\n      return [key, version ? { ...entry, version } : entry];\n    }),\n  );\n"],"names":["compare","valid","compareVersions","isValidVersion","version","readShippedMigrationVersions","migrations","versions","readReleasedMigrations","shippedVersions","unresolved","Object","entries","generators","filter","entry","map","key","packageJsonUpdates","LATEST_MIGRATIONS_DIR","length","released","registered","Set","keys","has","stampMigrationVersions","pendingVersion","fromEntries","sort","a","b","Number","everyMigration","name","sourceVersion","published","stampPackageJsonUpdates","resolvePackageJsonUpdateVersions","versionMigrationsDir","migrationKey","dir","LATEST_KEY_PREFIX","backfillMigrationVersions","backfilled","moves","backfilledUpdates","startsWith","slice","versionDir","latestSegment","versionSegment","repointed","moved","field","value","includes","replace","indexOf","push","from","to","resolve","undefined"],"mappings":"AAAA;;;CAGC,GACD,SAASA,OAAO,EAAEC,KAAK,QAAQ,SAAS;AA2CxC,4DAA4D,GAC5D,OAAO,MAAMC,kBAAkBF,QAAQ;AAEvC,iDAAiD,GACjD,OAAO,MAAMG,iBAAiB,CAACC,UAC7BH,MAAMG,aAAa,KAAK;AAE1B;;;;;;;;;;;;;;;;;;CAkBC,GACD,OAAO,MAAMC,+BAA+B,CAC1CC,YACAC,UACAC;IAEA,MAAMC,kBAA0C,CAAC;IACjD,yEAAyE;IACzE,wCAAwC;IACxC,IAAIC,aAAa;WACZC,OAAOC,OAAO,CAACN,WAAWO,UAAU,IAAI,CAAC,GACzCC,MAAM,CAAC,CAAC,GAAGC,MAAM,GAAK,CAACA,MAAMX,OAAO,EACpCY,GAAG,CAAC,CAAC,CAACC,IAAI,GAAKA;WACfN,OAAOC,OAAO,CAACN,WAAWY,kBAAkB,IAAI,CAAC,GACjDJ,MAAM,CAAC,CAAC,GAAGC,MAAM,GAAKA,MAAMX,OAAO,KAAKe,uBACxCH,GAAG,CAAC,CAAC,CAACC,IAAI,GAAKA;KACnB;IAED,KAAK,MAAMb,WAAWG,SAAU;QAC9B,IAAIG,WAAWU,MAAM,KAAK,GAAG;YAC3B;QACF;QACA,MAAMC,WAAWb,uBAAuBJ;QACxC,MAAMkB,aAAa,IAAIC,IAAI;eACtBZ,OAAOa,IAAI,CAACH,UAAUR,cAAc,CAAC;eACrCF,OAAOa,IAAI,CAACH,UAAUH,sBAAsB,CAAC;SACjD;QACD,0EAA0E;QAC1E,8CAA8C;QAC9CR,aAAaA,WAAWI,MAAM,CAAC,CAACG,MAAQK,WAAWG,GAAG,CAACR;QACvD,KAAK,MAAMA,OAAOP,WAAY;YAC5BD,eAAe,CAACQ,IAAI,GAAGb;QACzB;IACF;IAEA,OAAOK;AACT,EAAE;AAEF;;;;;;;;;;CAUC,GACD,OAAO,MAAMiB,yBAAyB,CACpCpB,YACAG,iBACAkB,iBACoB,CAAA;QACpB,GAAGrB,UAAU;QACbO,YAAYF,OAAOiB,WAAW,CAC5B,oEAAoE;QACpE,yEAAyE;QACzE,0EAA0E;QAC1EjB,OAAOC,OAAO,CAACN,WAAWO,UAAU,IAAI,CAAC,GACtCgB,IAAI,CACH,CAAC,GAAGC,EAAE,EAAE,GAAGC,EAAE,GACXC,OAAOF,EAAEG,cAAc,IAAI,SAASD,OAAOD,EAAEE,cAAc,IAAI,QAElEjB,GAAG,CAAC,CAAC,CAACkB,MAAMnB,MAAM;YACjB,mDAAmD;YACnD,MAAM,EAAEkB,cAAc,EAAE7B,SAAS+B,aAAa,EAAE,GAAGC,WAAW,GAAGrB;YACjE,uEAAuE;YACvE,MAAMX,UAAU6B,iBACZN,iBACCQ,iBAAiB1B,eAAe,CAACyB,KAAK,IAAIP;YAC/C,OAAO;gBAACO;gBAAM;oBAAE9B;oBAAS,GAAGgC,SAAS;gBAAC;aAAE;QAC1C;QAEJ,GAAI9B,WAAWY,kBAAkB,IAAI;YACnCA,oBAAoBmB,wBAClB/B,WAAWY,kBAAkB,EAC7BS;QAEJ,CAAC;IACH,CAAA,EAAG;AAEH;;;CAGC,GACD,MAAMU,0BAA0B,CAC9BnB,oBACAS,iBAEAW,iCAAiCpB,oBAAoB,IAAMS;AAE7D,iFAAiF,GACjF,OAAO,MAAMR,wBAAwB,SAAS;AAE9C,iEAAiE,GACjE,OAAO,MAAMoB,uBAAuB,CAACnC,UAAoB,CAAC,CAAC,EAAEA,SAAS,CAAC;AAEvE;;;;CAIC,GACD,OAAO,MAAMoC,eAAe,CAACC,KAAaP,OAAiB,GAAGO,IAAI,CAAC,EAAEP,MAAM,CAAC;AAE5E,MAAMQ,oBAAoB,GAAGvB,sBAAsB,CAAC,CAAC;AAUrD;;;;;;;;;;;;CAYC,GACD,OAAO,MAAMwB,4BAA4B,CACvCrC,YACAG;IAMA,MAAMI,aAAwD,CAAC;IAC/D,MAAM+B,aAAuB,EAAE;IAC/B,MAAMC,QAA4B,EAAE;IACpC,2EAA2E;IAC3E,+DAA+D;IAC/D,MAAMC,oBAAoBnC,OAAOC,OAAO,CAACN,WAAWY,kBAAkB,IAAI,CAAC,GACxEJ,MAAM,CACL,CAAC,CAACG,KAAKF,MAAM,GACXA,MAAMX,OAAO,KAAKe,yBAAyBV,eAAe,CAACQ,IAAI,EAElED,GAAG,CAAC,CAAC,CAACC,IAAI,GAAKA;IAElB,KAAK,MAAM,CAACA,KAAKF,MAAM,IAAIJ,OAAOC,OAAO,CAACN,WAAWO,UAAU,IAAI,CAAC,GAAI;QACtE,MAAMT,UAAUK,eAAe,CAACQ,IAAI;QACpC,4EAA4E;QAC5E,IAAIF,MAAMX,OAAO,IAAI,CAACA,WAAWW,MAAMkB,cAAc,EAAE;YACrDpB,UAAU,CAACI,IAAI,GAAGF;YAClB;QACF;QAEA,MAAMmB,OAAOjB,IAAI8B,UAAU,CAACL,qBACxBzB,IAAI+B,KAAK,CAACN,kBAAkBtB,MAAM,IAClCH;QACJ,MAAMgC,aAAaV,qBAAqBnC;QACxC,MAAM8C,gBAAgB,CAAC,CAAC,EAAE/B,sBAAsB,CAAC,EAAEe,KAAK,CAAC,CAAC;QAC1D,MAAMiB,iBAAiB,CAAC,CAAC,EAAEF,WAAW,CAAC,EAAEf,KAAK,CAAC,CAAC;QAEhD,yEAAyE;QACzE,4DAA4D;QAC5D,MAAMkB,YAAqC,CAAC;QAC5C,IAAIC,QAAQ;QACZ,KAAK,MAAM,CAACC,OAAOC,MAAM,IAAI5C,OAAOC,OAAO,CAACG,OAAQ;YAClD,IAAI,OAAOwC,UAAU,YAAY,CAACA,MAAMC,QAAQ,CAACN,gBAAgB;gBAC/DE,SAAS,CAACE,MAAM,GAAGC;gBACnB;YACF;YACAH,SAAS,CAACE,MAAM,GAAGC,MAAME,OAAO,CAACP,eAAeC;YAChD,IAAI,CAACE,OAAO;gBACVA,QAAQ;gBACR,MAAMZ,MAAMc,MAAMP,KAAK,CAAC,GAAGO,MAAMG,OAAO,CAACR;gBACzCL,MAAMc,IAAI,CAAC;oBACTzB;oBACA9B;oBACAwD,MAAM,GAAGnB,MAAMS,eAAe,CAACO,OAAO,CAAC,cAAc;oBACrDI,IAAI,GAAGpB,MAAMU,gBAAgB,CAACM,OAAO,CAAC,cAAc;gBACtD;YACF;QACF;QAEA5C,UAAU,CAAC2B,aAAaS,YAAYf,MAAM,GAAG;YAAE9B;YAAS,GAAGgD,SAAS;QAAC;QACrER,WAAWe,IAAI,CAAC1C;IAClB;IAEA,OAAO;QACLX,YAAY;YACV,GAAGA,UAAU;YACbO;YACA,GAAIP,WAAWY,kBAAkB,IAAI;gBACnCA,oBAAoBoB,iCAClBhC,WAAWY,kBAAkB,EAC7B,CAACD,MAAQR,eAAe,CAACQ,IAAI;YAEjC,CAAC;QACH;QACA2B,YAAY;eAAIA;eAAeE;SAAkB;QACjDD;IACF;AACF,EAAE;AAEF;;;;;;;;CAQC,GACD,MAAMP,mCAAmC,CACvCpB,oBACA4C,UAEAnD,OAAOiB,WAAW,CAChBjB,OAAOC,OAAO,CAACM,oBAAoBF,GAAG,CAAC,CAAC,CAACC,KAAKF,MAAM;QAClD,MAAMX,UACJW,MAAMX,OAAO,KAAKe,wBAAwB2C,QAAQ7C,OAAO8C;QAC3D,OAAO;YAAC9C;YAAKb,UAAU;gBAAE,GAAGW,KAAK;gBAAEX;YAAQ,IAAIW;SAAM;IACvD"}
+{"version":3,"sources":["../../../../../packages/nx-plugin/src/utils/migration-versions.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\nimport { compare, valid } from 'semver';\n\n/**\n * Version stamping for migrations.\n *\n * A new migration is committed with no `version` — releases are calculated from\n * conventional commits and written only to `dist/` and a git tag, so versions\n * reach the published `migrations.json` two ways:\n *\n * - At release time (`scripts/stamp-migrations.ts`) entries still missing a\n *   version are stamped into the compiled `migrations.json`: an already shipped\n *   one gets the earliest release tag registering it, and a net-new one gets the\n *   version the release is about to publish, which the release job passes in\n *   after `nx release version` writes it to the dist manifests.\n * - The weekly `update-versions` PR backfills the version of the release that\n *   shipped each migration, moving and re-keying it accordingly\n *   (`scripts/backfill-migration-versions.ts`), so source converges on the\n *   versions of everything already released. `packageJsonUpdates` entries are\n *   dated in place there too, since their keys never change.\n *\n * A version already in source always wins, so backfilled entries are stable.\n *\n * An entry marked `everyMigration: true` is never backfilled or pinned, and is\n * re-stamped with each pending version, so it runs on every upgrade.\n */\n\nexport interface MigrationsJson {\n  $schema?: string;\n  name?: string;\n  generators?: Record<\n    string,\n    { version?: string; everyMigration?: boolean } & Record<string, unknown>\n  >;\n  /**\n   * Declarative dependency bumps `nx migrate` applies to the root manifest.\n   * Keyed by what the bump targets rather than the release that ships it, so an\n   * entry is unique from the moment it is written and one release's bump can sit\n   * beside the next; nx itself gates on the entry's `version`.\n   */\n  packageJsonUpdates?: Record<\n    string,\n    { version: string } & Record<string, unknown>\n  >;\n}\n\n/** Ascending semver comparator for `Array.prototype.sort`. */\nexport const compareVersions = compare;\n\n/** Whether a string is an exact semver version. */\nexport const isValidVersion = (version: string): boolean =>\n  valid(version) !== null;\n\n/**\n * Map of entry key -> version of the earliest release that registers it, across\n * both `generators` and `packageJsonUpdates`. Resolved only for the entries still\n * missing a version (one already recorded in source wins, so its history doesn't\n * need reading). An entry that hasn't been released is absent.\n *\n * Walks releases newest first and stops as soon as every entry is resolved: an\n * entry that has disappeared from a release's `migrations.json` was first\n * registered by the release after it, which is the one that shipped it.\n *\n * Both sections resolve the same way and share the walk, so the release doesn't\n * read tag history twice. Keys can't collide: a migration is keyed by its own\n * name, an nx bump by the nx version it moves to.\n *\n * @param migrations parsed source migrations.json\n * @param versions released versions in descending semver order\n * @param readReleasedMigrations reads the `migrations.json` published by a given\n *   version, or undefined if it predates the manifest\n */\nexport const readShippedMigrationVersions = (\n  migrations: MigrationsJson,\n  versions: string[],\n  readReleasedMigrations: (version: string) => MigrationsJson | undefined,\n): Record<string, string> => {\n  const shippedVersions: Record<string, string> = {};\n  // A `packageJsonUpdates` entry records `latest` rather than omitting its\n  // version, since nx requires the field.\n  let unresolved = [\n    ...Object.entries(migrations.generators ?? {})\n      .filter(([, entry]) => !entry.version)\n      .map(([key]) => key),\n    ...Object.entries(migrations.packageJsonUpdates ?? {})\n      .filter(([, entry]) => entry.version === LATEST_MIGRATIONS_DIR)\n      .map(([key]) => key),\n  ];\n\n  for (const version of versions) {\n    if (unresolved.length === 0) {\n      break;\n    }\n    const released = readReleasedMigrations(version);\n    const registered = new Set([\n      ...Object.keys(released?.generators ?? {}),\n      ...Object.keys(released?.packageJsonUpdates ?? {}),\n    ]);\n    // Entries gone at this release keep the version recorded from the release\n    // after it (if any) and stop being looked up.\n    unresolved = unresolved.filter((key) => registered.has(key));\n    for (const key of unresolved) {\n      shippedVersions[key] = version;\n    }\n  }\n\n  return shippedVersions;\n};\n\n/**\n * Return a copy of the migrations collection with a `version` stamped onto\n * every generator entry, preserving any already present, and the pending version\n * recorded on any `packageJsonUpdates` entry still holding `latest`.\n *\n * @param migrations parsed migrations.json to stamp\n * @param shippedVersions migration key -> version of the earliest release\n *   tag that registers it (absent for migrations that haven't shipped)\n * @param pendingVersion version the release is about to publish, stamped onto\n *   unshipped migrations so their version is one that really shipped\n */\nexport const stampMigrationVersions = (\n  migrations: MigrationsJson,\n  shippedVersions: Record<string, string>,\n  pendingVersion: string,\n): MigrationsJson => ({\n  ...migrations,\n  generators: Object.fromEntries(\n    // `nx migrate` sorts the run ascending by version and preserves the\n    // manifest's order among equal versions, so emitting the every-migration\n    // entries last is what makes them run after the release's own migrations.\n    Object.entries(migrations.generators ?? {})\n      .sort(\n        ([, a], [, b]) =>\n          Number(a.everyMigration ?? false) - Number(b.everyMigration ?? false),\n      )\n      .map(([name, entry]) => {\n        // Source-only marker, stripped from what nx reads.\n        const { everyMigration, version: sourceVersion, ...published } = entry;\n        // Overrides any source version so it stays ahead of what is installed.\n        const version = everyMigration\n          ? pendingVersion\n          : (sourceVersion ?? shippedVersions[name] ?? pendingVersion);\n        return [name, { version, ...published }];\n      }),\n  ),\n  ...(migrations.packageJsonUpdates && {\n    packageJsonUpdates: stampPackageJsonUpdates(\n      migrations.packageJsonUpdates,\n      pendingVersion,\n    ),\n  }),\n});\n\n/**\n * Version any `packageJsonUpdates` entry still holding `latest` with the release\n * about to publish it, so the nx bump ships under a version `nx migrate` gates on.\n */\nconst stampPackageJsonUpdates = (\n  packageJsonUpdates: NonNullable<MigrationsJson['packageJsonUpdates']>,\n  pendingVersion: string,\n): NonNullable<MigrationsJson['packageJsonUpdates']> =>\n  resolvePackageJsonUpdateVersions(packageJsonUpdates, () => pendingVersion);\n\n/** Directory a newly scaffolded migration lands in, before a release claims it. */\nexport const LATEST_MIGRATIONS_DIR = 'latest';\n\n/** Directory holding the migrations shipped by a given release. */\nexport const versionMigrationsDir = (version: string) => `v${version}`;\n\n/**\n * Key a migration is registered under in `migrations.json`. Prefixed with its\n * directory so reusing a name in a later release can't silently overwrite the\n * one that already shipped.\n */\nexport const migrationKey = (dir: string, name: string) => `${dir}-${name}`;\n\nconst LATEST_KEY_PREFIX = `${LATEST_MIGRATIONS_DIR}-`;\n\n/** A migration directory move the caller needs to make on disk. */\nexport interface MigrationDirMove {\n  name: string;\n  version: string;\n  from: string;\n  to: string;\n}\n\n/**\n * Record the release that shipped each migration on entries without a version,\n * re-keying them and re-pointing their paths at that release's folder, and\n * return the collection alongside the keys that changed and the directory moves\n * to make on disk.\n *\n * Unlike `stampMigrationVersions` this only records already-released versions,\n * leaving the release to decide what a net-new migration gets.\n *\n * @param migrations parsed migrations.json to backfill\n * @param shippedVersions migration key -> version of the earliest release tag\n *   that registers it (absent for migrations that haven't shipped)\n */\nexport const backfillMigrationVersions = (\n  migrations: MigrationsJson,\n  shippedVersions: Record<string, string>,\n): {\n  migrations: MigrationsJson;\n  backfilled: string[];\n  moves: MigrationDirMove[];\n} => {\n  const generators: NonNullable<MigrationsJson['generators']> = {};\n  const backfilled: string[] = [];\n  const moves: MigrationDirMove[] = [];\n  // Reported alongside the migrations so the update's PR says an nx bump was\n  // dated, and so the caller knows there is something to commit.\n  const backfilledUpdates = Object.entries(migrations.packageJsonUpdates ?? {})\n    .filter(\n      ([key, entry]) =>\n        entry.version === LATEST_MIGRATIONS_DIR && shippedVersions[key],\n    )\n    .map(([key]) => key);\n\n  for (const [key, entry] of Object.entries(migrations.generators ?? {})) {\n    const version = shippedVersions[key];\n    // Pinning an every-migration entry would stop it running on later upgrades.\n    if (entry.version || !version || entry.everyMigration) {\n      generators[key] = entry;\n      continue;\n    }\n\n    const name = key.startsWith(LATEST_KEY_PREFIX)\n      ? key.slice(LATEST_KEY_PREFIX.length)\n      : key;\n    const versionDir = versionMigrationsDir(version);\n    const latestSegment = `/${LATEST_MIGRATIONS_DIR}/${name}/`;\n    const versionSegment = `/${versionDir}/${name}/`;\n\n    // Re-point each path field at the version folder, recording the move the\n    // caller needs to make on disk the first time one is found.\n    const repointed: Record<string, unknown> = {};\n    let moved = false;\n    for (const [field, value] of Object.entries(entry)) {\n      if (typeof value !== 'string' || !value.includes(latestSegment)) {\n        repointed[field] = value;\n        continue;\n      }\n      repointed[field] = value.replace(latestSegment, versionSegment);\n      if (!moved) {\n        moved = true;\n        const dir = value.slice(0, value.indexOf(latestSegment));\n        moves.push({\n          name,\n          version,\n          from: `${dir}${latestSegment}`.replace(/^\\.\\/|\\/$/g, ''),\n          to: `${dir}${versionSegment}`.replace(/^\\.\\/|\\/$/g, ''),\n        });\n      }\n    }\n\n    generators[migrationKey(versionDir, name)] = { version, ...repointed };\n    backfilled.push(key);\n  }\n\n  return {\n    migrations: {\n      ...migrations,\n      generators,\n      ...(migrations.packageJsonUpdates && {\n        packageJsonUpdates: resolvePackageJsonUpdateVersions(\n          migrations.packageJsonUpdates,\n          (key) => shippedVersions[key],\n        ),\n      }),\n    },\n    backfilled: [...backfilled, ...backfilledUpdates],\n    moves,\n  };\n};\n\n/**\n * Record the version each `packageJsonUpdates` entry ships under, for those still\n * holding `latest`.\n *\n * The key already identifies the entry — an nx bump is named for the nx version\n * it moves to — so only the `version` field changes. Nothing is re-keyed, which\n * is what lets one release's bump sit alongside the next without either being\n * overwritten before it ships.\n */\nconst resolvePackageJsonUpdateVersions = (\n  packageJsonUpdates: NonNullable<MigrationsJson['packageJsonUpdates']>,\n  resolve: (key: string) => string | undefined,\n): NonNullable<MigrationsJson['packageJsonUpdates']> =>\n  Object.fromEntries(\n    Object.entries(packageJsonUpdates).map(([key, entry]) => {\n      const version =\n        entry.version === LATEST_MIGRATIONS_DIR ? resolve(key) : undefined;\n      return [key, version ? { ...entry, version } : entry];\n    }),\n  );\n"],"names":["compare","valid","compareVersions","isValidVersion","version","readShippedMigrationVersions","migrations","versions","readReleasedMigrations","shippedVersions","unresolved","Object","entries","generators","filter","entry","map","key","packageJsonUpdates","LATEST_MIGRATIONS_DIR","length","released","registered","Set","keys","has","stampMigrationVersions","pendingVersion","fromEntries","sort","a","b","Number","everyMigration","name","sourceVersion","published","stampPackageJsonUpdates","resolvePackageJsonUpdateVersions","versionMigrationsDir","migrationKey","dir","LATEST_KEY_PREFIX","backfillMigrationVersions","backfilled","moves","backfilledUpdates","startsWith","slice","versionDir","latestSegment","versionSegment","repointed","moved","field","value","includes","replace","indexOf","push","from","to","resolve","undefined"],"mappings":"AAAA;;;CAGC,GACD,SAASA,OAAO,EAAEC,KAAK,QAAQ,SAAS;AA6CxC,4DAA4D,GAC5D,OAAO,MAAMC,kBAAkBF,QAAQ;AAEvC,iDAAiD,GACjD,OAAO,MAAMG,iBAAiB,CAACC,UAC7BH,MAAMG,aAAa,KAAK;AAE1B;;;;;;;;;;;;;;;;;;CAkBC,GACD,OAAO,MAAMC,+BAA+B,CAC1CC,YACAC,UACAC;IAEA,MAAMC,kBAA0C,CAAC;IACjD,yEAAyE;IACzE,wCAAwC;IACxC,IAAIC,aAAa;WACZC,OAAOC,OAAO,CAACN,WAAWO,UAAU,IAAI,CAAC,GACzCC,MAAM,CAAC,CAAC,GAAGC,MAAM,GAAK,CAACA,MAAMX,OAAO,EACpCY,GAAG,CAAC,CAAC,CAACC,IAAI,GAAKA;WACfN,OAAOC,OAAO,CAACN,WAAWY,kBAAkB,IAAI,CAAC,GACjDJ,MAAM,CAAC,CAAC,GAAGC,MAAM,GAAKA,MAAMX,OAAO,KAAKe,uBACxCH,GAAG,CAAC,CAAC,CAACC,IAAI,GAAKA;KACnB;IAED,KAAK,MAAMb,WAAWG,SAAU;QAC9B,IAAIG,WAAWU,MAAM,KAAK,GAAG;YAC3B;QACF;QACA,MAAMC,WAAWb,uBAAuBJ;QACxC,MAAMkB,aAAa,IAAIC,IAAI;eACtBZ,OAAOa,IAAI,CAACH,UAAUR,cAAc,CAAC;eACrCF,OAAOa,IAAI,CAACH,UAAUH,sBAAsB,CAAC;SACjD;QACD,0EAA0E;QAC1E,8CAA8C;QAC9CR,aAAaA,WAAWI,MAAM,CAAC,CAACG,MAAQK,WAAWG,GAAG,CAACR;QACvD,KAAK,MAAMA,OAAOP,WAAY;YAC5BD,eAAe,CAACQ,IAAI,GAAGb;QACzB;IACF;IAEA,OAAOK;AACT,EAAE;AAEF;;;;;;;;;;CAUC,GACD,OAAO,MAAMiB,yBAAyB,CACpCpB,YACAG,iBACAkB,iBACoB,CAAA;QACpB,GAAGrB,UAAU;QACbO,YAAYF,OAAOiB,WAAW,CAC5B,oEAAoE;QACpE,yEAAyE;QACzE,0EAA0E;QAC1EjB,OAAOC,OAAO,CAACN,WAAWO,UAAU,IAAI,CAAC,GACtCgB,IAAI,CACH,CAAC,GAAGC,EAAE,EAAE,GAAGC,EAAE,GACXC,OAAOF,EAAEG,cAAc,IAAI,SAASD,OAAOD,EAAEE,cAAc,IAAI,QAElEjB,GAAG,CAAC,CAAC,CAACkB,MAAMnB,MAAM;YACjB,mDAAmD;YACnD,MAAM,EAAEkB,cAAc,EAAE7B,SAAS+B,aAAa,EAAE,GAAGC,WAAW,GAAGrB;YACjE,uEAAuE;YACvE,MAAMX,UAAU6B,iBACZN,iBACCQ,iBAAiB1B,eAAe,CAACyB,KAAK,IAAIP;YAC/C,OAAO;gBAACO;gBAAM;oBAAE9B;oBAAS,GAAGgC,SAAS;gBAAC;aAAE;QAC1C;QAEJ,GAAI9B,WAAWY,kBAAkB,IAAI;YACnCA,oBAAoBmB,wBAClB/B,WAAWY,kBAAkB,EAC7BS;QAEJ,CAAC;IACH,CAAA,EAAG;AAEH;;;CAGC,GACD,MAAMU,0BAA0B,CAC9BnB,oBACAS,iBAEAW,iCAAiCpB,oBAAoB,IAAMS;AAE7D,iFAAiF,GACjF,OAAO,MAAMR,wBAAwB,SAAS;AAE9C,iEAAiE,GACjE,OAAO,MAAMoB,uBAAuB,CAACnC,UAAoB,CAAC,CAAC,EAAEA,SAAS,CAAC;AAEvE;;;;CAIC,GACD,OAAO,MAAMoC,eAAe,CAACC,KAAaP,OAAiB,GAAGO,IAAI,CAAC,EAAEP,MAAM,CAAC;AAE5E,MAAMQ,oBAAoB,GAAGvB,sBAAsB,CAAC,CAAC;AAUrD;;;;;;;;;;;;CAYC,GACD,OAAO,MAAMwB,4BAA4B,CACvCrC,YACAG;IAMA,MAAMI,aAAwD,CAAC;IAC/D,MAAM+B,aAAuB,EAAE;IAC/B,MAAMC,QAA4B,EAAE;IACpC,2EAA2E;IAC3E,+DAA+D;IAC/D,MAAMC,oBAAoBnC,OAAOC,OAAO,CAACN,WAAWY,kBAAkB,IAAI,CAAC,GACxEJ,MAAM,CACL,CAAC,CAACG,KAAKF,MAAM,GACXA,MAAMX,OAAO,KAAKe,yBAAyBV,eAAe,CAACQ,IAAI,EAElED,GAAG,CAAC,CAAC,CAACC,IAAI,GAAKA;IAElB,KAAK,MAAM,CAACA,KAAKF,MAAM,IAAIJ,OAAOC,OAAO,CAACN,WAAWO,UAAU,IAAI,CAAC,GAAI;QACtE,MAAMT,UAAUK,eAAe,CAACQ,IAAI;QACpC,4EAA4E;QAC5E,IAAIF,MAAMX,OAAO,IAAI,CAACA,WAAWW,MAAMkB,cAAc,EAAE;YACrDpB,UAAU,CAACI,IAAI,GAAGF;YAClB;QACF;QAEA,MAAMmB,OAAOjB,IAAI8B,UAAU,CAACL,qBACxBzB,IAAI+B,KAAK,CAACN,kBAAkBtB,MAAM,IAClCH;QACJ,MAAMgC,aAAaV,qBAAqBnC;QACxC,MAAM8C,gBAAgB,CAAC,CAAC,EAAE/B,sBAAsB,CAAC,EAAEe,KAAK,CAAC,CAAC;QAC1D,MAAMiB,iBAAiB,CAAC,CAAC,EAAEF,WAAW,CAAC,EAAEf,KAAK,CAAC,CAAC;QAEhD,yEAAyE;QACzE,4DAA4D;QAC5D,MAAMkB,YAAqC,CAAC;QAC5C,IAAIC,QAAQ;QACZ,KAAK,MAAM,CAACC,OAAOC,MAAM,IAAI5C,OAAOC,OAAO,CAACG,OAAQ;YAClD,IAAI,OAAOwC,UAAU,YAAY,CAACA,MAAMC,QAAQ,CAACN,gBAAgB;gBAC/DE,SAAS,CAACE,MAAM,GAAGC;gBACnB;YACF;YACAH,SAAS,CAACE,MAAM,GAAGC,MAAME,OAAO,CAACP,eAAeC;YAChD,IAAI,CAACE,OAAO;gBACVA,QAAQ;gBACR,MAAMZ,MAAMc,MAAMP,KAAK,CAAC,GAAGO,MAAMG,OAAO,CAACR;gBACzCL,MAAMc,IAAI,CAAC;oBACTzB;oBACA9B;oBACAwD,MAAM,GAAGnB,MAAMS,eAAe,CAACO,OAAO,CAAC,cAAc;oBACrDI,IAAI,GAAGpB,MAAMU,gBAAgB,CAACM,OAAO,CAAC,cAAc;gBACtD;YACF;QACF;QAEA5C,UAAU,CAAC2B,aAAaS,YAAYf,MAAM,GAAG;YAAE9B;YAAS,GAAGgD,SAAS;QAAC;QACrER,WAAWe,IAAI,CAAC1C;IAClB;IAEA,OAAO;QACLX,YAAY;YACV,GAAGA,UAAU;YACbO;YACA,GAAIP,WAAWY,kBAAkB,IAAI;gBACnCA,oBAAoBoB,iCAClBhC,WAAWY,kBAAkB,EAC7B,CAACD,MAAQR,eAAe,CAACQ,IAAI;YAEjC,CAAC;QACH;QACA2B,YAAY;eAAIA;eAAeE;SAAkB;QACjDD;IACF;AACF,EAAE;AAEF;;;;;;;;CAQC,GACD,MAAMP,mCAAmC,CACvCpB,oBACA4C,UAEAnD,OAAOiB,WAAW,CAChBjB,OAAOC,OAAO,CAACM,oBAAoBF,GAAG,CAAC,CAAC,CAACC,KAAKF,MAAM;QAClD,MAAMX,UACJW,MAAMX,OAAO,KAAKe,wBAAwB2C,QAAQ7C,OAAO8C;QAC3D,OAAO;YAAC9C;YAAKb,UAAU;gBAAE,GAAGW,KAAK;gBAAEX;YAAQ,IAAIW;SAAM;IACvD"}

package/src/utils/version-upgrade-migration/register.d.ts

@@ -4,9 +4,11 @@
  */
 import { type Tree } from '@nx/devkit';
 /**
- * Register the nx bump a version update needs, in `migrations.json`. Call only
- * when an nx package actually moved.
+ * Register the nx bump a version update needs, in `packageJsonUpdates.json`. Call
+ * only when an nx package actually moved.
  *
+ * The bumps live in their own committed file, assembled into `migrations.json`
+ * at build time, so this weekly-bot edit never conflicts with a migration PR.
  * The version sync migration itself is a committed `everyMigration` entry, so
  * only the nx packages need registering per update: they go through
  * `packageJsonUpdates` rather than a migration (see `nx-package-updates.ts`).

package/src/utils/version-upgrade-migration/register.js

@@ -1,14 +1,16 @@
 /**
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
- */ import { updateJson } from "@nx/devkit";
+ */ import { writeJson } from "@nx/devkit";
 import { LATEST_MIGRATIONS_DIR } from "../migration-versions.js";
 import { nxPackageJsonUpdates } from "./nx-package-updates.js";
-const MIGRATIONS_JSON_PATH = 'packages/nx-plugin/migrations.json';
+const PACKAGE_JSON_UPDATES_PATH = 'packages/nx-plugin/packageJsonUpdates.json';
 /**
- * Register the nx bump a version update needs, in `migrations.json`. Call only
- * when an nx package actually moved.
+ * Register the nx bump a version update needs, in `packageJsonUpdates.json`. Call
+ * only when an nx package actually moved.
  *
+ * The bumps live in their own committed file, assembled into `migrations.json`
+ * at build time, so this weekly-bot edit never conflicts with a migration PR.
  * The version sync migration itself is a committed `everyMigration` entry, so
  * only the nx packages need registering per update: they go through
  * `packageJsonUpdates` rather than a migration (see `nx-package-updates.ts`).
@@ -26,16 +28,14 @@ const MIGRATIONS_JSON_PATH = 'packages/nx-plugin/migrations.json';
  *   entry would record the one being replaced.
  * @returns paths written, for the update report
  */ export const registerNxPackageUpdates = (tree, nxVersion)=>{
-    updateJson(tree, MIGRATIONS_JSON_PATH, (migrations)=>({
-            ...migrations,
-            // Recorded under `latest` until stamping resolves the version it ships with.
-            packageJsonUpdates: {
-                ...Object.fromEntries(Object.entries(migrations.packageJsonUpdates ?? {}).filter(([, entry])=>entry.version !== LATEST_MIGRATIONS_DIR)),
-                ...nxPackageJsonUpdates(LATEST_MIGRATIONS_DIR, nxVersion)
-            }
-        }));
+    const existing = tree.exists(PACKAGE_JSON_UPDATES_PATH) ? JSON.parse(tree.read(PACKAGE_JSON_UPDATES_PATH, 'utf-8')) : {};
+    writeJson(tree, PACKAGE_JSON_UPDATES_PATH, {
+        // Recorded under `latest` until stamping resolves the version it ships with.
+        ...Object.fromEntries(Object.entries(existing).filter(([, entry])=>entry.version !== LATEST_MIGRATIONS_DIR)),
+        ...nxPackageJsonUpdates(LATEST_MIGRATIONS_DIR, nxVersion)
+    });
     return [
-        MIGRATIONS_JSON_PATH
+        PACKAGE_JSON_UPDATES_PATH
     ];
 };
 

package/src/utils/version-upgrade-migration/register.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../../packages/nx-plugin/src/utils/version-upgrade-migration/register.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\nimport { type Tree, updateJson } from '@nx/devkit';\nimport {\n  LATEST_MIGRATIONS_DIR,\n  type MigrationsJson,\n} from '../migration-versions';\nimport { nxPackageJsonUpdates } from './nx-package-updates';\n\nconst MIGRATIONS_JSON_PATH = 'packages/nx-plugin/migrations.json';\n\n/**\n * Register the nx bump a version update needs, in `migrations.json`. Call only\n * when an nx package actually moved.\n *\n * The version sync migration itself is a committed `everyMigration` entry, so\n * only the nx packages need registering per update: they go through\n * `packageJsonUpdates` rather than a migration (see `nx-package-updates.ts`).\n *\n * A bump already dated by a release stays — a workspace several releases behind\n * needs each hop in turn. One still waiting for a release is dropped: this bump\n * supersedes it, and both would otherwise ship under the same version, leaving\n * which nx a workspace lands on down to the order nx happens to apply them in.\n *\n * Idempotent: re-running before a release replaces the pending entry with itself.\n *\n * @param nxVersion nx version being moved to. The update script rewrites\n *   `versions.ts` on the tree, which cannot change the `NX_VERSION` this process\n *   imported at load — so the caller passes the version it just wrote, or the\n *   entry would record the one being replaced.\n * @returns paths written, for the update report\n */\nexport const registerNxPackageUpdates = (\n  tree: Tree,\n  nxVersion?: string,\n): string[] => {\n  updateJson<MigrationsJson>(tree, MIGRATIONS_JSON_PATH, (migrations) => ({\n    ...migrations,\n    // Recorded under `latest` until stamping resolves the version it ships with.\n    packageJsonUpdates: {\n      ...Object.fromEntries(\n        Object.entries(migrations.packageJsonUpdates ?? {}).filter(\n          ([, entry]) => entry.version !== LATEST_MIGRATIONS_DIR,\n        ),\n      ),\n      ...nxPackageJsonUpdates(LATEST_MIGRATIONS_DIR, nxVersion),\n    },\n  }));\n\n  return [MIGRATIONS_JSON_PATH];\n};\n"],"names":["updateJson","LATEST_MIGRATIONS_DIR","nxPackageJsonUpdates","MIGRATIONS_JSON_PATH","registerNxPackageUpdates","tree","nxVersion","migrations","packageJsonUpdates","Object","fromEntries","entries","filter","entry","version"],"mappings":"AAAA;;;CAGC,GACD,SAAoBA,UAAU,QAAQ,aAAa;AACnD,SACEC,qBAAqB,QAEhB,2BAAwB;AAC/B,SAASC,oBAAoB,QAAQ,0BAAuB;AAE5D,MAAMC,uBAAuB;AAE7B;;;;;;;;;;;;;;;;;;;;CAoBC,GACD,OAAO,MAAMC,2BAA2B,CACtCC,MACAC;IAEAN,WAA2BK,MAAMF,sBAAsB,CAACI,aAAgB,CAAA;YACtE,GAAGA,UAAU;YACb,6EAA6E;YAC7EC,oBAAoB;gBAClB,GAAGC,OAAOC,WAAW,CACnBD,OAAOE,OAAO,CAACJ,WAAWC,kBAAkB,IAAI,CAAC,GAAGI,MAAM,CACxD,CAAC,GAAGC,MAAM,GAAKA,MAAMC,OAAO,KAAKb,uBAEpC;gBACD,GAAGC,qBAAqBD,uBAAuBK,UAAU;YAC3D;QACF,CAAA;IAEA,OAAO;QAACH;KAAqB;AAC/B,EAAE"}
+{"version":3,"sources":["../../../../../../packages/nx-plugin/src/utils/version-upgrade-migration/register.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\nimport { type Tree, writeJson } from '@nx/devkit';\nimport { LATEST_MIGRATIONS_DIR } from '../migration-versions';\nimport {\n  nxPackageJsonUpdates,\n  type PackageJsonUpdates,\n} from './nx-package-updates';\n\nconst PACKAGE_JSON_UPDATES_PATH = 'packages/nx-plugin/packageJsonUpdates.json';\n\n/**\n * Register the nx bump a version update needs, in `packageJsonUpdates.json`. Call\n * only when an nx package actually moved.\n *\n * The bumps live in their own committed file, assembled into `migrations.json`\n * at build time, so this weekly-bot edit never conflicts with a migration PR.\n * The version sync migration itself is a committed `everyMigration` entry, so\n * only the nx packages need registering per update: they go through\n * `packageJsonUpdates` rather than a migration (see `nx-package-updates.ts`).\n *\n * A bump already dated by a release stays — a workspace several releases behind\n * needs each hop in turn. One still waiting for a release is dropped: this bump\n * supersedes it, and both would otherwise ship under the same version, leaving\n * which nx a workspace lands on down to the order nx happens to apply them in.\n *\n * Idempotent: re-running before a release replaces the pending entry with itself.\n *\n * @param nxVersion nx version being moved to. The update script rewrites\n *   `versions.ts` on the tree, which cannot change the `NX_VERSION` this process\n *   imported at load — so the caller passes the version it just wrote, or the\n *   entry would record the one being replaced.\n * @returns paths written, for the update report\n */\nexport const registerNxPackageUpdates = (\n  tree: Tree,\n  nxVersion?: string,\n): string[] => {\n  const existing: PackageJsonUpdates = tree.exists(PACKAGE_JSON_UPDATES_PATH)\n    ? JSON.parse(tree.read(PACKAGE_JSON_UPDATES_PATH, 'utf-8'))\n    : {};\n\n  writeJson(tree, PACKAGE_JSON_UPDATES_PATH, {\n    // Recorded under `latest` until stamping resolves the version it ships with.\n    ...Object.fromEntries(\n      Object.entries(existing).filter(\n        ([, entry]) => entry.version !== LATEST_MIGRATIONS_DIR,\n      ),\n    ),\n    ...nxPackageJsonUpdates(LATEST_MIGRATIONS_DIR, nxVersion),\n  });\n\n  return [PACKAGE_JSON_UPDATES_PATH];\n};\n"],"names":["writeJson","LATEST_MIGRATIONS_DIR","nxPackageJsonUpdates","PACKAGE_JSON_UPDATES_PATH","registerNxPackageUpdates","tree","nxVersion","existing","exists","JSON","parse","read","Object","fromEntries","entries","filter","entry","version"],"mappings":"AAAA;;;CAGC,GACD,SAAoBA,SAAS,QAAQ,aAAa;AAClD,SAASC,qBAAqB,QAAQ,2BAAwB;AAC9D,SACEC,oBAAoB,QAEf,0BAAuB;AAE9B,MAAMC,4BAA4B;AAElC;;;;;;;;;;;;;;;;;;;;;;CAsBC,GACD,OAAO,MAAMC,2BAA2B,CACtCC,MACAC;IAEA,MAAMC,WAA+BF,KAAKG,MAAM,CAACL,6BAC7CM,KAAKC,KAAK,CAACL,KAAKM,IAAI,CAACR,2BAA2B,YAChD,CAAC;IAELH,UAAUK,MAAMF,2BAA2B;QACzC,6EAA6E;QAC7E,GAAGS,OAAOC,WAAW,CACnBD,OAAOE,OAAO,CAACP,UAAUQ,MAAM,CAC7B,CAAC,GAAGC,MAAM,GAAKA,MAAMC,OAAO,KAAKhB,uBAEpC;QACD,GAAGC,qBAAqBD,uBAAuBK,UAAU;IAC3D;IAEA,OAAO;QAACH;KAA0B;AACpC,EAAE"}