@aws/nx-plugin 1.0.0-rc.54 → 1.0.0-rc.55

package/src/utils/bundle/bundle.js

@@ -3,10 +3,16 @@
  * SPDX-License-Identifier: Apache-2.0
  */ import { generateFiles, joinPathFragments, OverwriteStrategy } from "@nx/devkit";
 import { applyGritQL } from "../ast.js";
+import { forDependencies } from "../declared-dependencies.js";
 import { addDependenciesToPackageJson } from "../dependencies.js";
 import { addDependencyToTargetIfNotPresent, normalizeTargetKeyOrder } from "../nx.js";
 import { getRelativePathToRoot } from "../paths.js";
 import { withVersions } from "../versions.js";
+/** Dependencies a caller must declare to add a TypeScript bundle target. */ export const BUNDLE_DEPENDENCIES = [
+    {
+        name: 'rolldown'
+    }
+];
 /**
  * Create a target for bundling a python project
  */ const createPythonBundleTarget = ({ packageName, pythonPlatform, bundleTargetName })=>{
@@ -59,7 +65,7 @@ import { withVersions } from "../versions.js";
 };
 /**
  * Add a TypeScript bundle target using rolldown
- */ export const addTypeScriptBundleTarget = async (tree, project, opts)=>{
+ */ export const addTypeScriptBundleTarget = async (tree, project, opts, declaration)=>{
     project.targets ??= {};
     // Generate empty rolldown config if it doesn't exist
     generateFiles(tree, joinPathFragments(import.meta.dirname, 'files', 'ts'), project.root, {}, {
@@ -108,7 +114,7 @@ import { withVersions } from "../versions.js";
             await applyGritQL(tree, rolldownConfigPath, `\`defineConfig([$items])\` where { $items <: \`__PLACEHOLDER__\` => ., $items += "${entry}" }`);
         }
     }
-    addDependenciesToPackageJson(tree, {}, withVersions([
+    addDependenciesToPackageJson(tree, {}, withVersions(forDependencies(declaration), [
         'rolldown'
     ]));
 };

package/src/utils/bundle/bundle.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../../packages/nx-plugin/src/utils/bundle/bundle.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\n\nimport {\n  generateFiles,\n  joinPathFragments,\n  OverwriteStrategy,\n  type ProjectConfiguration,\n  type TargetConfiguration,\n  type Tree,\n} from '@nx/devkit';\nimport { applyGritQL } from '../ast';\nimport { addDependenciesToPackageJson } from '../dependencies';\nimport {\n  addDependencyToTargetIfNotPresent,\n  normalizeTargetKeyOrder,\n} from '../nx';\nimport { getRelativePathToRoot } from '../paths';\nimport { withVersions } from '../versions';\n\nexport interface AddPythonBundleTargetOptions {\n  /**\n   * Python platform\n   * @default x86_64-manylinux_2_28\n   */\n  pythonPlatform?: 'x86_64-manylinux_2_28' | 'aarch64-manylinux_2_28';\n}\n\ninterface CreatePythonBundleTargetOptions\n  extends Required<AddPythonBundleTargetOptions> {\n  /**\n   * Python package name\n   */\n  packageName: string;\n\n  /**\n   * Name of the bundle target, used for the outdir for the bundle\n   */\n  bundleTargetName: string;\n}\n\n/**\n * Create a target for bundling a python project\n */\nconst createPythonBundleTarget = ({\n  packageName,\n  pythonPlatform,\n  bundleTargetName,\n}: CreatePythonBundleTargetOptions): TargetConfiguration => {\n  return {\n    cache: true,\n    inputs: ['default', '^production'],\n    executor: 'nx:run-commands',\n    outputs: [`{workspaceRoot}/dist/{projectRoot}/${bundleTargetName}`],\n    options: {\n      commands: [\n        `uv export --frozen --no-dev --no-editable --project {projectRoot} --package ${packageName} -o dist/{projectRoot}/${bundleTargetName}/requirements.txt`,\n        `uv pip install -n --no-deps --no-installer-metadata --no-compile-bytecode --python-platform ${pythonPlatform} --target dist/{projectRoot}/${bundleTargetName} -r dist/{projectRoot}/${bundleTargetName}/requirements.txt`,\n      ],\n      parallel: false,\n    },\n  };\n};\n\n/**\n * Adds a bundle target to the given project if it does not exist, and updates the build target to depend on it\n */\nexport const addPythonBundleTarget = (\n  project: ProjectConfiguration,\n  opts?: AddPythonBundleTargetOptions,\n) => {\n  if (!project.targets) {\n    project.targets = {};\n  }\n\n  const pythonPlatform = opts?.pythonPlatform ?? 'x86_64-manylinux_2_28';\n  const bundleTargetName =\n    pythonPlatform === 'aarch64-manylinux_2_28' ? 'bundle-arm' : 'bundle-x86';\n\n  if (!project.targets?.[bundleTargetName]) {\n    project.targets[bundleTargetName] = normalizeTargetKeyOrder({\n      ...createPythonBundleTarget({\n        packageName: project.name,\n        pythonPlatform,\n        bundleTargetName,\n      }),\n      dependsOn: ['compile'],\n    });\n  }\n\n  // Add a \"bundle\" target which depends on either bundle-arm or bundle-x86 (or both)\n  addDependencyToTargetIfNotPresent(project, 'bundle', bundleTargetName);\n  addDependencyToTargetIfNotPresent(project, 'build', 'bundle');\n\n  return {\n    bundleTargetName,\n    bundleOutputDir: joinPathFragments('dist', project.root, bundleTargetName),\n  };\n};\n\nexport interface AddTypeScriptBundleTargetOptions {\n  /**\n   * Path to the target file relative to the project dir\n   */\n  targetFilePath: string;\n\n  /**\n   * Sub directory to write bundled index.js file to (if any)\n   * Outputs to dist/{projectRoot}/bundle/{bundleOutputDir}/index.js\n   */\n  bundleOutputDir?: string;\n\n  /**\n   * Modules to omit from the bundle and treat as external\n   */\n  external?: (string | RegExp)[];\n\n  /**\n   * Target platform for the bundle\n   * @default 'node'\n   */\n  platform?: 'node' | 'browser' | 'neutral';\n}\n\n/**\n * Add a TypeScript bundle target using rolldown\n */\nexport const addTypeScriptBundleTarget = async (\n  tree: Tree,\n  project: ProjectConfiguration,\n  opts: AddTypeScriptBundleTargetOptions,\n) => {\n  project.targets ??= {};\n\n  // Generate empty rolldown config if it doesn't exist\n  generateFiles(\n    tree,\n    joinPathFragments(import.meta.dirname, 'files', 'ts'),\n    project.root,\n    {},\n    { overwriteStrategy: OverwriteStrategy.KeepExisting },\n  );\n\n  // Add the bundle target\n  if (!project.targets.bundle) {\n    project.targets.bundle = normalizeTargetKeyOrder({\n      cache: true,\n      outputs: [`{workspaceRoot}/dist/{projectRoot}/bundle`],\n      executor: 'nx:run-commands',\n      options: {\n        command: 'rolldown -c rolldown.config.ts',\n        cwd: '{projectRoot}',\n      },\n      dependsOn: ['compile'],\n    });\n  }\n\n  // Add bundle to the build target\n  addDependencyToTargetIfNotPresent(project, 'build', 'bundle');\n\n  const rolldownConfigPath = joinPathFragments(\n    project.root,\n    'rolldown.config.ts',\n  );\n\n  const outputFile = joinPathFragments(\n    getRelativePathToRoot(tree, project.name),\n    'dist',\n    project.root,\n    'bundle',\n    opts.bundleOutputDir ?? '.',\n    'index.js',\n  );\n\n  const external = opts.external?.length\n    ? opts.external\n        .map((ext) =>\n          typeof ext === 'string' ? `'${ext}'` : `/${ext.source}/`,\n        )\n        .join(', ')\n    : '';\n\n  const entry = `{\n    tsconfig: 'tsconfig.lib.json',\n    input: '${opts.targetFilePath}',\n    output: { file: '${outputFile}', format: 'cjs', inlineDynamicImports: true },\n    platform: '${opts.platform ?? 'node'}',\n    ${external ? `external: [${external}],` : ''}\n  }`;\n\n  // Use GritQL to append the config entry to the defineConfig array.\n  // First try the non-empty array case using the accumulate (+=) operator,\n  // with an idempotency guard that checks the input path is not already present.\n  const appended = await applyGritQL(\n    tree,\n    rolldownConfigPath,\n    `\\`defineConfig([$items])\\` where { $items <: not contains \\`'${opts.targetFilePath}'\\`, $items += \", ${entry}\" }`,\n  );\n\n  if (!appended) {\n    // Empty array — GritQL's += cannot accumulate into an empty list, so we\n    // first insert a placeholder to make the array non-empty, then replace\n    // the placeholder with the real entry via += (which handles regex\n    // literals that are invalid inside GritQL backtick snippets).\n    const inserted = await applyGritQL(\n      tree,\n      rolldownConfigPath,\n      `\\`defineConfig([])\\` => \\`defineConfig([__PLACEHOLDER__])\\``,\n    );\n    if (inserted) {\n      await applyGritQL(\n        tree,\n        rolldownConfigPath,\n        `\\`defineConfig([$items])\\` where { $items <: \\`__PLACEHOLDER__\\` => ., $items += \"${entry}\" }`,\n      );\n    }\n  }\n\n  addDependenciesToPackageJson(tree, {}, withVersions(['rolldown']));\n};\n"],"names":["generateFiles","joinPathFragments","OverwriteStrategy","applyGritQL","addDependenciesToPackageJson","addDependencyToTargetIfNotPresent","normalizeTargetKeyOrder","getRelativePathToRoot","withVersions","createPythonBundleTarget","packageName","pythonPlatform","bundleTargetName","cache","inputs","executor","outputs","options","commands","parallel","addPythonBundleTarget","project","opts","targets","name","dependsOn","bundleOutputDir","root","addTypeScriptBundleTarget","tree","dirname","overwriteStrategy","KeepExisting","bundle","command","cwd","rolldownConfigPath","outputFile","external","length","map","ext","source","join","entry","targetFilePath","platform","appended","inserted"],"mappings":"AAAA;;;CAGC,GAED,SACEA,aAAa,EACbC,iBAAiB,EACjBC,iBAAiB,QAIZ,aAAa;AACpB,SAASC,WAAW,QAAQ,YAAS;AACrC,SAASC,4BAA4B,QAAQ,qBAAkB;AAC/D,SACEC,iCAAiC,EACjCC,uBAAuB,QAClB,WAAQ;AACf,SAASC,qBAAqB,QAAQ,cAAW;AACjD,SAASC,YAAY,QAAQ,iBAAc;AAuB3C;;CAEC,GACD,MAAMC,2BAA2B,CAAC,EAChCC,WAAW,EACXC,cAAc,EACdC,gBAAgB,EACgB;IAChC,OAAO;QACLC,OAAO;QACPC,QAAQ;YAAC;YAAW;SAAc;QAClCC,UAAU;QACVC,SAAS;YAAC,CAAC,mCAAmC,EAAEJ,kBAAkB;SAAC;QACnEK,SAAS;YACPC,UAAU;gBACR,CAAC,4EAA4E,EAAER,YAAY,uBAAuB,EAAEE,iBAAiB,iBAAiB,CAAC;gBACvJ,CAAC,4FAA4F,EAAED,eAAe,6BAA6B,EAAEC,iBAAiB,uBAAuB,EAAEA,iBAAiB,iBAAiB,CAAC;aAC3N;YACDO,UAAU;QACZ;IACF;AACF;AAEA;;CAEC,GACD,OAAO,MAAMC,wBAAwB,CACnCC,SACAC;IAEA,IAAI,CAACD,QAAQE,OAAO,EAAE;QACpBF,QAAQE,OAAO,GAAG,CAAC;IACrB;IAEA,MAAMZ,iBAAiBW,MAAMX,kBAAkB;IAC/C,MAAMC,mBACJD,mBAAmB,2BAA2B,eAAe;IAE/D,IAAI,CAACU,QAAQE,OAAO,EAAE,CAACX,iBAAiB,EAAE;QACxCS,QAAQE,OAAO,CAACX,iBAAiB,GAAGN,wBAAwB;YAC1D,GAAGG,yBAAyB;gBAC1BC,aAAaW,QAAQG,IAAI;gBACzBb;gBACAC;YACF,EAAE;YACFa,WAAW;gBAAC;aAAU;QACxB;IACF;IAEA,mFAAmF;IACnFpB,kCAAkCgB,SAAS,UAAUT;IACrDP,kCAAkCgB,SAAS,SAAS;IAEpD,OAAO;QACLT;QACAc,iBAAiBzB,kBAAkB,QAAQoB,QAAQM,IAAI,EAAEf;IAC3D;AACF,EAAE;AA0BF;;CAEC,GACD,OAAO,MAAMgB,4BAA4B,OACvCC,MACAR,SACAC;IAEAD,QAAQE,OAAO,KAAK,CAAC;IAErB,qDAAqD;IACrDvB,cACE6B,MACA5B,kBAAkB,YAAY6B,OAAO,EAAE,SAAS,OAChDT,QAAQM,IAAI,EACZ,CAAC,GACD;QAAEI,mBAAmB7B,kBAAkB8B,YAAY;IAAC;IAGtD,wBAAwB;IACxB,IAAI,CAACX,QAAQE,OAAO,CAACU,MAAM,EAAE;QAC3BZ,QAAQE,OAAO,CAACU,MAAM,GAAG3B,wBAAwB;YAC/CO,OAAO;YACPG,SAAS;gBAAC,CAAC,yCAAyC,CAAC;aAAC;YACtDD,UAAU;YACVE,SAAS;gBACPiB,SAAS;gBACTC,KAAK;YACP;YACAV,WAAW;gBAAC;aAAU;QACxB;IACF;IAEA,iCAAiC;IACjCpB,kCAAkCgB,SAAS,SAAS;IAEpD,MAAMe,qBAAqBnC,kBACzBoB,QAAQM,IAAI,EACZ;IAGF,MAAMU,aAAapC,kBACjBM,sBAAsBsB,MAAMR,QAAQG,IAAI,GACxC,QACAH,QAAQM,IAAI,EACZ,UACAL,KAAKI,eAAe,IAAI,KACxB;IAGF,MAAMY,WAAWhB,KAAKgB,QAAQ,EAAEC,SAC5BjB,KAAKgB,QAAQ,CACVE,GAAG,CAAC,CAACC,MACJ,OAAOA,QAAQ,WAAW,CAAC,CAAC,EAAEA,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,EAAEA,IAAIC,MAAM,CAAC,CAAC,CAAC,EAEzDC,IAAI,CAAC,QACR;IAEJ,MAAMC,QAAQ,CAAC;;YAEL,EAAEtB,KAAKuB,cAAc,CAAC;qBACb,EAAER,WAAW;eACnB,EAAEf,KAAKwB,QAAQ,IAAI,OAAO;IACrC,EAAER,WAAW,CAAC,WAAW,EAAEA,SAAS,EAAE,CAAC,GAAG,GAAG;GAC9C,CAAC;IAEF,mEAAmE;IACnE,yEAAyE;IACzE,+EAA+E;IAC/E,MAAMS,WAAW,MAAM5C,YACrB0B,MACAO,oBACA,CAAC,6DAA6D,EAAEd,KAAKuB,cAAc,CAAC,kBAAkB,EAAED,MAAM,GAAG,CAAC;IAGpH,IAAI,CAACG,UAAU;QACb,wEAAwE;QACxE,uEAAuE;QACvE,kEAAkE;QAClE,8DAA8D;QAC9D,MAAMC,WAAW,MAAM7C,YACrB0B,MACAO,oBACA,CAAC,2DAA2D,CAAC;QAE/D,IAAIY,UAAU;YACZ,MAAM7C,YACJ0B,MACAO,oBACA,CAAC,kFAAkF,EAAEQ,MAAM,GAAG,CAAC;QAEnG;IACF;IAEAxC,6BAA6ByB,MAAM,CAAC,GAAGrB,aAAa;QAAC;KAAW;AAClE,EAAE"}
+{"version":3,"sources":["../../../../../../packages/nx-plugin/src/utils/bundle/bundle.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\n\nimport {\n  generateFiles,\n  joinPathFragments,\n  OverwriteStrategy,\n  type ProjectConfiguration,\n  type TargetConfiguration,\n  type Tree,\n} from '@nx/devkit';\nimport { applyGritQL } from '../ast';\nimport {\n  type DependencyDeclaration,\n  forDependencies,\n  type MustDeclare,\n} from '../declared-dependencies';\nimport { addDependenciesToPackageJson } from '../dependencies';\nimport {\n  addDependencyToTargetIfNotPresent,\n  normalizeTargetKeyOrder,\n} from '../nx';\nimport { getRelativePathToRoot } from '../paths';\nimport { type ITsDepVersion, withVersions } from '../versions';\n\n/** Dependencies a caller must declare to add a TypeScript bundle target. */\nexport const BUNDLE_DEPENDENCIES = [\n  { name: 'rolldown' },\n] as const satisfies readonly { name: ITsDepVersion }[];\n\nexport interface AddPythonBundleTargetOptions {\n  /**\n   * Python platform\n   * @default x86_64-manylinux_2_28\n   */\n  pythonPlatform?: 'x86_64-manylinux_2_28' | 'aarch64-manylinux_2_28';\n}\n\ninterface CreatePythonBundleTargetOptions\n  extends Required<AddPythonBundleTargetOptions> {\n  /**\n   * Python package name\n   */\n  packageName: string;\n\n  /**\n   * Name of the bundle target, used for the outdir for the bundle\n   */\n  bundleTargetName: string;\n}\n\n/**\n * Create a target for bundling a python project\n */\nconst createPythonBundleTarget = ({\n  packageName,\n  pythonPlatform,\n  bundleTargetName,\n}: CreatePythonBundleTargetOptions): TargetConfiguration => {\n  return {\n    cache: true,\n    inputs: ['default', '^production'],\n    executor: 'nx:run-commands',\n    outputs: [`{workspaceRoot}/dist/{projectRoot}/${bundleTargetName}`],\n    options: {\n      commands: [\n        `uv export --frozen --no-dev --no-editable --project {projectRoot} --package ${packageName} -o dist/{projectRoot}/${bundleTargetName}/requirements.txt`,\n        `uv pip install -n --no-deps --no-installer-metadata --no-compile-bytecode --python-platform ${pythonPlatform} --target dist/{projectRoot}/${bundleTargetName} -r dist/{projectRoot}/${bundleTargetName}/requirements.txt`,\n      ],\n      parallel: false,\n    },\n  };\n};\n\n/**\n * Adds a bundle target to the given project if it does not exist, and updates the build target to depend on it\n */\nexport const addPythonBundleTarget = (\n  project: ProjectConfiguration,\n  opts?: AddPythonBundleTargetOptions,\n) => {\n  if (!project.targets) {\n    project.targets = {};\n  }\n\n  const pythonPlatform = opts?.pythonPlatform ?? 'x86_64-manylinux_2_28';\n  const bundleTargetName =\n    pythonPlatform === 'aarch64-manylinux_2_28' ? 'bundle-arm' : 'bundle-x86';\n\n  if (!project.targets?.[bundleTargetName]) {\n    project.targets[bundleTargetName] = normalizeTargetKeyOrder({\n      ...createPythonBundleTarget({\n        packageName: project.name,\n        pythonPlatform,\n        bundleTargetName,\n      }),\n      dependsOn: ['compile'],\n    });\n  }\n\n  // Add a \"bundle\" target which depends on either bundle-arm or bundle-x86 (or both)\n  addDependencyToTargetIfNotPresent(project, 'bundle', bundleTargetName);\n  addDependencyToTargetIfNotPresent(project, 'build', 'bundle');\n\n  return {\n    bundleTargetName,\n    bundleOutputDir: joinPathFragments('dist', project.root, bundleTargetName),\n  };\n};\n\nexport interface AddTypeScriptBundleTargetOptions {\n  /**\n   * Path to the target file relative to the project dir\n   */\n  targetFilePath: string;\n\n  /**\n   * Sub directory to write bundled index.js file to (if any)\n   * Outputs to dist/{projectRoot}/bundle/{bundleOutputDir}/index.js\n   */\n  bundleOutputDir?: string;\n\n  /**\n   * Modules to omit from the bundle and treat as external\n   */\n  external?: (string | RegExp)[];\n\n  /**\n   * Target platform for the bundle\n   * @default 'node'\n   */\n  platform?: 'node' | 'browser' | 'neutral';\n}\n\n/**\n * Add a TypeScript bundle target using rolldown\n */\nexport const addTypeScriptBundleTarget = async <\n  const D extends DependencyDeclaration,\n>(\n  tree: Tree,\n  project: ProjectConfiguration,\n  opts: AddTypeScriptBundleTargetOptions,\n  declaration: D & MustDeclare<typeof BUNDLE_DEPENDENCIES, D>,\n) => {\n  project.targets ??= {};\n\n  // Generate empty rolldown config if it doesn't exist\n  generateFiles(\n    tree,\n    joinPathFragments(import.meta.dirname, 'files', 'ts'),\n    project.root,\n    {},\n    { overwriteStrategy: OverwriteStrategy.KeepExisting },\n  );\n\n  // Add the bundle target\n  if (!project.targets.bundle) {\n    project.targets.bundle = normalizeTargetKeyOrder({\n      cache: true,\n      outputs: [`{workspaceRoot}/dist/{projectRoot}/bundle`],\n      executor: 'nx:run-commands',\n      options: {\n        command: 'rolldown -c rolldown.config.ts',\n        cwd: '{projectRoot}',\n      },\n      dependsOn: ['compile'],\n    });\n  }\n\n  // Add bundle to the build target\n  addDependencyToTargetIfNotPresent(project, 'build', 'bundle');\n\n  const rolldownConfigPath = joinPathFragments(\n    project.root,\n    'rolldown.config.ts',\n  );\n\n  const outputFile = joinPathFragments(\n    getRelativePathToRoot(tree, project.name),\n    'dist',\n    project.root,\n    'bundle',\n    opts.bundleOutputDir ?? '.',\n    'index.js',\n  );\n\n  const external = opts.external?.length\n    ? opts.external\n        .map((ext) =>\n          typeof ext === 'string' ? `'${ext}'` : `/${ext.source}/`,\n        )\n        .join(', ')\n    : '';\n\n  const entry = `{\n    tsconfig: 'tsconfig.lib.json',\n    input: '${opts.targetFilePath}',\n    output: { file: '${outputFile}', format: 'cjs', inlineDynamicImports: true },\n    platform: '${opts.platform ?? 'node'}',\n    ${external ? `external: [${external}],` : ''}\n  }`;\n\n  // Use GritQL to append the config entry to the defineConfig array.\n  // First try the non-empty array case using the accumulate (+=) operator,\n  // with an idempotency guard that checks the input path is not already present.\n  const appended = await applyGritQL(\n    tree,\n    rolldownConfigPath,\n    `\\`defineConfig([$items])\\` where { $items <: not contains \\`'${opts.targetFilePath}'\\`, $items += \", ${entry}\" }`,\n  );\n\n  if (!appended) {\n    // Empty array — GritQL's += cannot accumulate into an empty list, so we\n    // first insert a placeholder to make the array non-empty, then replace\n    // the placeholder with the real entry via += (which handles regex\n    // literals that are invalid inside GritQL backtick snippets).\n    const inserted = await applyGritQL(\n      tree,\n      rolldownConfigPath,\n      `\\`defineConfig([])\\` => \\`defineConfig([__PLACEHOLDER__])\\``,\n    );\n    if (inserted) {\n      await applyGritQL(\n        tree,\n        rolldownConfigPath,\n        `\\`defineConfig([$items])\\` where { $items <: \\`__PLACEHOLDER__\\` => ., $items += \"${entry}\" }`,\n      );\n    }\n  }\n\n  addDependenciesToPackageJson(\n    tree,\n    {},\n    withVersions(forDependencies<typeof BUNDLE_DEPENDENCIES>(declaration), [\n      'rolldown',\n    ]),\n  );\n};\n"],"names":["generateFiles","joinPathFragments","OverwriteStrategy","applyGritQL","forDependencies","addDependenciesToPackageJson","addDependencyToTargetIfNotPresent","normalizeTargetKeyOrder","getRelativePathToRoot","withVersions","BUNDLE_DEPENDENCIES","name","createPythonBundleTarget","packageName","pythonPlatform","bundleTargetName","cache","inputs","executor","outputs","options","commands","parallel","addPythonBundleTarget","project","opts","targets","dependsOn","bundleOutputDir","root","addTypeScriptBundleTarget","tree","declaration","dirname","overwriteStrategy","KeepExisting","bundle","command","cwd","rolldownConfigPath","outputFile","external","length","map","ext","source","join","entry","targetFilePath","platform","appended","inserted"],"mappings":"AAAA;;;CAGC,GAED,SACEA,aAAa,EACbC,iBAAiB,EACjBC,iBAAiB,QAIZ,aAAa;AACpB,SAASC,WAAW,QAAQ,YAAS;AACrC,SAEEC,eAAe,QAEV,8BAA2B;AAClC,SAASC,4BAA4B,QAAQ,qBAAkB;AAC/D,SACEC,iCAAiC,EACjCC,uBAAuB,QAClB,WAAQ;AACf,SAASC,qBAAqB,QAAQ,cAAW;AACjD,SAA6BC,YAAY,QAAQ,iBAAc;AAE/D,0EAA0E,GAC1E,OAAO,MAAMC,sBAAsB;IACjC;QAAEC,MAAM;IAAW;CACpB,CAAuD;AAuBxD;;CAEC,GACD,MAAMC,2BAA2B,CAAC,EAChCC,WAAW,EACXC,cAAc,EACdC,gBAAgB,EACgB;IAChC,OAAO;QACLC,OAAO;QACPC,QAAQ;YAAC;YAAW;SAAc;QAClCC,UAAU;QACVC,SAAS;YAAC,CAAC,mCAAmC,EAAEJ,kBAAkB;SAAC;QACnEK,SAAS;YACPC,UAAU;gBACR,CAAC,4EAA4E,EAAER,YAAY,uBAAuB,EAAEE,iBAAiB,iBAAiB,CAAC;gBACvJ,CAAC,4FAA4F,EAAED,eAAe,6BAA6B,EAAEC,iBAAiB,uBAAuB,EAAEA,iBAAiB,iBAAiB,CAAC;aAC3N;YACDO,UAAU;QACZ;IACF;AACF;AAEA;;CAEC,GACD,OAAO,MAAMC,wBAAwB,CACnCC,SACAC;IAEA,IAAI,CAACD,QAAQE,OAAO,EAAE;QACpBF,QAAQE,OAAO,GAAG,CAAC;IACrB;IAEA,MAAMZ,iBAAiBW,MAAMX,kBAAkB;IAC/C,MAAMC,mBACJD,mBAAmB,2BAA2B,eAAe;IAE/D,IAAI,CAACU,QAAQE,OAAO,EAAE,CAACX,iBAAiB,EAAE;QACxCS,QAAQE,OAAO,CAACX,iBAAiB,GAAGR,wBAAwB;YAC1D,GAAGK,yBAAyB;gBAC1BC,aAAaW,QAAQb,IAAI;gBACzBG;gBACAC;YACF,EAAE;YACFY,WAAW;gBAAC;aAAU;QACxB;IACF;IAEA,mFAAmF;IACnFrB,kCAAkCkB,SAAS,UAAUT;IACrDT,kCAAkCkB,SAAS,SAAS;IAEpD,OAAO;QACLT;QACAa,iBAAiB3B,kBAAkB,QAAQuB,QAAQK,IAAI,EAAEd;IAC3D;AACF,EAAE;AA0BF;;CAEC,GACD,OAAO,MAAMe,4BAA4B,OAGvCC,MACAP,SACAC,MACAO;IAEAR,QAAQE,OAAO,KAAK,CAAC;IAErB,qDAAqD;IACrD1B,cACE+B,MACA9B,kBAAkB,YAAYgC,OAAO,EAAE,SAAS,OAChDT,QAAQK,IAAI,EACZ,CAAC,GACD;QAAEK,mBAAmBhC,kBAAkBiC,YAAY;IAAC;IAGtD,wBAAwB;IACxB,IAAI,CAACX,QAAQE,OAAO,CAACU,MAAM,EAAE;QAC3BZ,QAAQE,OAAO,CAACU,MAAM,GAAG7B,wBAAwB;YAC/CS,OAAO;YACPG,SAAS;gBAAC,CAAC,yCAAyC,CAAC;aAAC;YACtDD,UAAU;YACVE,SAAS;gBACPiB,SAAS;gBACTC,KAAK;YACP;YACAX,WAAW;gBAAC;aAAU;QACxB;IACF;IAEA,iCAAiC;IACjCrB,kCAAkCkB,SAAS,SAAS;IAEpD,MAAMe,qBAAqBtC,kBACzBuB,QAAQK,IAAI,EACZ;IAGF,MAAMW,aAAavC,kBACjBO,sBAAsBuB,MAAMP,QAAQb,IAAI,GACxC,QACAa,QAAQK,IAAI,EACZ,UACAJ,KAAKG,eAAe,IAAI,KACxB;IAGF,MAAMa,WAAWhB,KAAKgB,QAAQ,EAAEC,SAC5BjB,KAAKgB,QAAQ,CACVE,GAAG,CAAC,CAACC,MACJ,OAAOA,QAAQ,WAAW,CAAC,CAAC,EAAEA,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,EAAEA,IAAIC,MAAM,CAAC,CAAC,CAAC,EAEzDC,IAAI,CAAC,QACR;IAEJ,MAAMC,QAAQ,CAAC;;YAEL,EAAEtB,KAAKuB,cAAc,CAAC;qBACb,EAAER,WAAW;eACnB,EAAEf,KAAKwB,QAAQ,IAAI,OAAO;IACrC,EAAER,WAAW,CAAC,WAAW,EAAEA,SAAS,EAAE,CAAC,GAAG,GAAG;GAC9C,CAAC;IAEF,mEAAmE;IACnE,yEAAyE;IACzE,+EAA+E;IAC/E,MAAMS,WAAW,MAAM/C,YACrB4B,MACAQ,oBACA,CAAC,6DAA6D,EAAEd,KAAKuB,cAAc,CAAC,kBAAkB,EAAED,MAAM,GAAG,CAAC;IAGpH,IAAI,CAACG,UAAU;QACb,wEAAwE;QACxE,uEAAuE;QACvE,kEAAkE;QAClE,8DAA8D;QAC9D,MAAMC,WAAW,MAAMhD,YACrB4B,MACAQ,oBACA,CAAC,2DAA2D,CAAC;QAE/D,IAAIY,UAAU;YACZ,MAAMhD,YACJ4B,MACAQ,oBACA,CAAC,kFAAkF,EAAEQ,MAAM,GAAG,CAAC;QAEnG;IACF;IAEA1C,6BACE0B,MACA,CAAC,GACDtB,aAAaL,gBAA4C4B,cAAc;QACrE;KACD;AAEL,EAAE"}

package/src/utils/commands.d.ts

@@ -1,9 +1,10 @@
 /**
- * The nx version the plugin is built against. Commands that download nx
- * (e.g. `nx init`) pin to this version so the workspace's nx matches the
- * plugin's `@nx/*` packages — a mismatch deadlocks `nx sync`.
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
  */
-export declare const NX_VERSION: "23.1.0";
+import { NX_VERSION } from './versions';
+/** Re-exported for callers that already import it from here. */
+export { NX_VERSION };
 /**
  * Display-friendly command prefixes for each package manager.
  *

package/src/utils/commands.js

@@ -1,12 +1,8 @@
 /**
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
- */ import { TS_VERSIONS } from "./versions.js";
-/**
- * The nx version the plugin is built against. Commands that download nx
- * (e.g. `nx init`) pin to this version so the workspace's nx matches the
- * plugin's `@nx/*` packages — a mismatch deadlocks `nx sync`.
- */ export const NX_VERSION = TS_VERSIONS['@nx/devkit'];
+ */ import { NX_VERSION } from "./versions.js";
+/** Re-exported for callers that already import it from here. */ export { NX_VERSION };
 export const PACKAGE_MANAGER_COMMANDS = {
     npm: {
         exec: 'npx',

package/src/utils/commands.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../packages/nx-plugin/src/utils/commands.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\nimport { TS_VERSIONS } from './versions';\n\n/**\n * The nx version the plugin is built against. Commands that download nx\n * (e.g. `nx init`) pin to this version so the workspace's nx matches the\n * plugin's `@nx/*` packages — a mismatch deadlocks `nx sync`.\n */\nexport const NX_VERSION = TS_VERSIONS['@nx/devkit'];\n\n/**\n * Display-friendly command prefixes for each package manager.\n *\n * - `exec`: prefix for running local binaries (e.g. `npx nx`, `pnpm nx`, `bunx nx`)\n * - `run`: prefix for running package.json scripts (e.g. `npm run build`, `pnpm build`)\n *\n * @see docs/src/components/package-manager-exec-command.astro\n * @see docs/src/components/package-manager-short-command.astro\n */\nexport interface PackageManagerDisplayCommands {\n  /** Prefix for running local binaries: npx, pnpm, yarn, bunx */\n  exec: string;\n  /** Prefix for running package.json scripts: `npm run`, pnpm, yarn, bun */\n  run: string;\n  /** Prefix for `create` commands: `npm create`, `pnpm create`, etc. */\n  create: string;\n}\n\nexport const PACKAGE_MANAGER_COMMANDS: Record<\n  string,\n  PackageManagerDisplayCommands\n> = {\n  npm: { exec: 'npx', run: 'npm run', create: 'npm create' },\n  pnpm: { exec: 'pnpm', run: 'pnpm', create: 'pnpm create' },\n  yarn: { exec: 'yarn', run: 'yarn', create: 'yarn create' },\n  bun: { exec: 'bunx', run: 'bun', create: 'bun create' },\n};\n\n/**\n * Build a package manager exec command (e.g. pnpm cmd, npx cmd, bunx cmd)\n */\nexport const buildPackageManagerExecCommand = (pm: string, command: string) => {\n  const prefix = PACKAGE_MANAGER_COMMANDS[pm]?.exec ?? pm;\n  return `${prefix} ${command}`;\n};\n\n/**\n * Build a short package manager command (e.g. pnpm build, npm run build)\n */\nexport const buildPackageManagerShortCommand = (\n  pm: string,\n  command: string,\n) => {\n  const prefix = PACKAGE_MANAGER_COMMANDS[pm]?.run ?? pm;\n  return `${prefix} ${command}`;\n};\n\n/**\n * Build an install command. Without `pkg`, installs the workspace's existing\n * dependencies. With `project`, targets that project's manifest (pnpm\n * `--filter` by unscoped name, npm/bun by `projectDir` defaulting to\n * `packages/<name>`, yarn by fully-qualified name); otherwise the root.\n */\nexport const buildInstallCommand = (\n  pm: string,\n  pkg?: string,\n  dev?: boolean,\n  project?: string,\n  projectDir?: string,\n) => {\n  if (!pkg) {\n    return pm === 'yarn' ? 'yarn' : `${pm} install`;\n  }\n  if (project) {\n    const shortName = project.split('/').pop();\n    const dir = projectDir ?? `packages/${shortName}`;\n    switch (pm) {\n      case 'pnpm':\n        return `pnpm add ${dev ? '-D ' : ''}${pkg} --filter ${shortName}`;\n      case 'yarn':\n        return `yarn workspace ${project} add ${dev ? '-D ' : ''}${pkg}`;\n      case 'npm':\n        return `npm install --legacy-peer-deps ${dev ? '-D ' : ''}${pkg} -w ${dir}`;\n      case 'bun':\n        return `bun add ${dev ? '-D ' : ''}${pkg} --cwd ${dir}`;\n      default:\n        return `${pm} install ${dev ? '-D ' : ''}${pkg}`;\n    }\n  }\n  switch (pm) {\n    case 'pnpm':\n      return `pnpm add ${dev ? '-D' : '-'}w ${pkg}`;\n    case 'yarn':\n      return `yarn add ${dev ? '-D ' : ''}${pkg}`;\n    case 'npm':\n      return `npm install --legacy-peer-deps ${dev ? '-D ' : ''}${pkg}`;\n    case 'bun':\n      return `bun add ${dev ? '-D ' : ''}${pkg}`;\n    default:\n      return `${pm} install ${dev ? '-D ' : ''}${pkg}`;\n  }\n};\n\n/**\n * Build the command that adds Nx to a non-Nx project, pinned to the nx\n * version the plugin is built against.\n */\nexport const buildNxInitCommand = (pm: string) => {\n  const dlxPrefix =\n    { npm: 'npx', pnpm: 'pnpm dlx', yarn: 'yarn dlx', bun: 'bunx' }[pm] ??\n    'npx';\n  return `${dlxPrefix} nx@${NX_VERSION} init`;\n};\n\n/**\n * Build a command to create a new workspace using @aws/create-nx-workspace.\n *\n * Uses the `create` shorthand for each package manager:\n *   npm create @aws/nx-workspace my-project\n *   pnpm create @aws/nx-workspace my-project\n *   yarn create @aws/nx-workspace my-project\n *   bun create @aws/nx-workspace my-project\n *\n * The package manager is auto-detected by @aws/create-nx-workspace from the\n * invoking command, so --pm is not needed.\n */\nexport const buildCreateNxWorkspaceCommand = (\n  pm: string,\n  workspace: string,\n  iac?: 'cdk' | 'terraform',\n  tag?: string,\n  module?: 'esm' | 'cjs',\n  extraArgs?: string,\n) => {\n  const createPrefix = PACKAGE_MANAGER_COMMANDS[pm]?.create ?? `${pm} create`;\n  const pkgName = tag ? `@aws/nx-workspace@${tag}` : '@aws/nx-workspace';\n  const parts = [\n    createPrefix,\n    pkgName,\n    // npm requires '--' to stop interpreting subsequent flags as npm config\n    ...(pm === 'npm' ? ['--'] : []),\n    workspace,\n    ...(iac ? [`--iac=${iac}`] : []),\n    ...(module ? [`--module=${module}`] : []),\n    ...(extraArgs ? [extraArgs] : []),\n  ];\n  return parts.join(' ');\n};\n"],"names":["TS_VERSIONS","NX_VERSION","PACKAGE_MANAGER_COMMANDS","npm","exec","run","create","pnpm","yarn","bun","buildPackageManagerExecCommand","pm","command","prefix","buildPackageManagerShortCommand","buildInstallCommand","pkg","dev","project","projectDir","shortName","split","pop","dir","buildNxInitCommand","dlxPrefix","buildCreateNxWorkspaceCommand","workspace","iac","tag","module","extraArgs","createPrefix","pkgName","parts","join"],"mappings":"AAAA;;;CAGC,GACD,SAASA,WAAW,QAAQ,gBAAa;AAEzC;;;;CAIC,GACD,OAAO,MAAMC,aAAaD,WAAW,CAAC,aAAa,CAAC;AAoBpD,OAAO,MAAME,2BAGT;IACFC,KAAK;QAAEC,MAAM;QAAOC,KAAK;QAAWC,QAAQ;IAAa;IACzDC,MAAM;QAAEH,MAAM;QAAQC,KAAK;QAAQC,QAAQ;IAAc;IACzDE,MAAM;QAAEJ,MAAM;QAAQC,KAAK;QAAQC,QAAQ;IAAc;IACzDG,KAAK;QAAEL,MAAM;QAAQC,KAAK;QAAOC,QAAQ;IAAa;AACxD,EAAE;AAEF;;CAEC,GACD,OAAO,MAAMI,iCAAiC,CAACC,IAAYC;IACzD,MAAMC,SAASX,wBAAwB,CAACS,GAAG,EAAEP,QAAQO;IACrD,OAAO,GAAGE,OAAO,CAAC,EAAED,SAAS;AAC/B,EAAE;AAEF;;CAEC,GACD,OAAO,MAAME,kCAAkC,CAC7CH,IACAC;IAEA,MAAMC,SAASX,wBAAwB,CAACS,GAAG,EAAEN,OAAOM;IACpD,OAAO,GAAGE,OAAO,CAAC,EAAED,SAAS;AAC/B,EAAE;AAEF;;;;;CAKC,GACD,OAAO,MAAMG,sBAAsB,CACjCJ,IACAK,KACAC,KACAC,SACAC;IAEA,IAAI,CAACH,KAAK;QACR,OAAOL,OAAO,SAAS,SAAS,GAAGA,GAAG,QAAQ,CAAC;IACjD;IACA,IAAIO,SAAS;QACX,MAAME,YAAYF,QAAQG,KAAK,CAAC,KAAKC,GAAG;QACxC,MAAMC,MAAMJ,cAAc,CAAC,SAAS,EAAEC,WAAW;QACjD,OAAQT;YACN,KAAK;gBACH,OAAO,CAAC,SAAS,EAAEM,MAAM,QAAQ,KAAKD,IAAI,UAAU,EAAEI,WAAW;YACnE,KAAK;gBACH,OAAO,CAAC,eAAe,EAAEF,QAAQ,KAAK,EAAED,MAAM,QAAQ,KAAKD,KAAK;YAClE,KAAK;gBACH,OAAO,CAAC,+BAA+B,EAAEC,MAAM,QAAQ,KAAKD,IAAI,IAAI,EAAEO,KAAK;YAC7E,KAAK;gBACH,OAAO,CAAC,QAAQ,EAAEN,MAAM,QAAQ,KAAKD,IAAI,OAAO,EAAEO,KAAK;YACzD;gBACE,OAAO,GAAGZ,GAAG,SAAS,EAAEM,MAAM,QAAQ,KAAKD,KAAK;QACpD;IACF;IACA,OAAQL;QACN,KAAK;YACH,OAAO,CAAC,SAAS,EAAEM,MAAM,OAAO,IAAI,EAAE,EAAED,KAAK;QAC/C,KAAK;YACH,OAAO,CAAC,SAAS,EAAEC,MAAM,QAAQ,KAAKD,KAAK;QAC7C,KAAK;YACH,OAAO,CAAC,+BAA+B,EAAEC,MAAM,QAAQ,KAAKD,KAAK;QACnE,KAAK;YACH,OAAO,CAAC,QAAQ,EAAEC,MAAM,QAAQ,KAAKD,KAAK;QAC5C;YACE,OAAO,GAAGL,GAAG,SAAS,EAAEM,MAAM,QAAQ,KAAKD,KAAK;IACpD;AACF,EAAE;AAEF;;;CAGC,GACD,OAAO,MAAMQ,qBAAqB,CAACb;IACjC,MAAMc,YACJ;QAAEtB,KAAK;QAAOI,MAAM;QAAYC,MAAM;QAAYC,KAAK;IAAO,CAAC,CAACE,GAAG,IACnE;IACF,OAAO,GAAGc,UAAU,IAAI,EAAExB,WAAW,KAAK,CAAC;AAC7C,EAAE;AAEF;;;;;;;;;;;CAWC,GACD,OAAO,MAAMyB,gCAAgC,CAC3Cf,IACAgB,WACAC,KACAC,KACAC,QACAC;IAEA,MAAMC,eAAe9B,wBAAwB,CAACS,GAAG,EAAEL,UAAU,GAAGK,GAAG,OAAO,CAAC;IAC3E,MAAMsB,UAAUJ,MAAM,CAAC,kBAAkB,EAAEA,KAAK,GAAG;IACnD,MAAMK,QAAQ;QACZF;QACAC;QACA,wEAAwE;WACpEtB,OAAO,QAAQ;YAAC;SAAK,GAAG,EAAE;QAC9BgB;WACIC,MAAM;YAAC,CAAC,MAAM,EAAEA,KAAK;SAAC,GAAG,EAAE;WAC3BE,SAAS;YAAC,CAAC,SAAS,EAAEA,QAAQ;SAAC,GAAG,EAAE;WACpCC,YAAY;YAACA;SAAU,GAAG,EAAE;KACjC;IACD,OAAOG,MAAMC,IAAI,CAAC;AACpB,EAAE"}
+{"version":3,"sources":["../../../../../packages/nx-plugin/src/utils/commands.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\nimport { NX_VERSION } from './versions';\n\n/** Re-exported for callers that already import it from here. */\nexport { NX_VERSION };\n\n/**\n * Display-friendly command prefixes for each package manager.\n *\n * - `exec`: prefix for running local binaries (e.g. `npx nx`, `pnpm nx`, `bunx nx`)\n * - `run`: prefix for running package.json scripts (e.g. `npm run build`, `pnpm build`)\n *\n * @see docs/src/components/package-manager-exec-command.astro\n * @see docs/src/components/package-manager-short-command.astro\n */\nexport interface PackageManagerDisplayCommands {\n  /** Prefix for running local binaries: npx, pnpm, yarn, bunx */\n  exec: string;\n  /** Prefix for running package.json scripts: `npm run`, pnpm, yarn, bun */\n  run: string;\n  /** Prefix for `create` commands: `npm create`, `pnpm create`, etc. */\n  create: string;\n}\n\nexport const PACKAGE_MANAGER_COMMANDS: Record<\n  string,\n  PackageManagerDisplayCommands\n> = {\n  npm: { exec: 'npx', run: 'npm run', create: 'npm create' },\n  pnpm: { exec: 'pnpm', run: 'pnpm', create: 'pnpm create' },\n  yarn: { exec: 'yarn', run: 'yarn', create: 'yarn create' },\n  bun: { exec: 'bunx', run: 'bun', create: 'bun create' },\n};\n\n/**\n * Build a package manager exec command (e.g. pnpm cmd, npx cmd, bunx cmd)\n */\nexport const buildPackageManagerExecCommand = (pm: string, command: string) => {\n  const prefix = PACKAGE_MANAGER_COMMANDS[pm]?.exec ?? pm;\n  return `${prefix} ${command}`;\n};\n\n/**\n * Build a short package manager command (e.g. pnpm build, npm run build)\n */\nexport const buildPackageManagerShortCommand = (\n  pm: string,\n  command: string,\n) => {\n  const prefix = PACKAGE_MANAGER_COMMANDS[pm]?.run ?? pm;\n  return `${prefix} ${command}`;\n};\n\n/**\n * Build an install command. Without `pkg`, installs the workspace's existing\n * dependencies. With `project`, targets that project's manifest (pnpm\n * `--filter` by unscoped name, npm/bun by `projectDir` defaulting to\n * `packages/<name>`, yarn by fully-qualified name); otherwise the root.\n */\nexport const buildInstallCommand = (\n  pm: string,\n  pkg?: string,\n  dev?: boolean,\n  project?: string,\n  projectDir?: string,\n) => {\n  if (!pkg) {\n    return pm === 'yarn' ? 'yarn' : `${pm} install`;\n  }\n  if (project) {\n    const shortName = project.split('/').pop();\n    const dir = projectDir ?? `packages/${shortName}`;\n    switch (pm) {\n      case 'pnpm':\n        return `pnpm add ${dev ? '-D ' : ''}${pkg} --filter ${shortName}`;\n      case 'yarn':\n        return `yarn workspace ${project} add ${dev ? '-D ' : ''}${pkg}`;\n      case 'npm':\n        return `npm install --legacy-peer-deps ${dev ? '-D ' : ''}${pkg} -w ${dir}`;\n      case 'bun':\n        return `bun add ${dev ? '-D ' : ''}${pkg} --cwd ${dir}`;\n      default:\n        return `${pm} install ${dev ? '-D ' : ''}${pkg}`;\n    }\n  }\n  switch (pm) {\n    case 'pnpm':\n      return `pnpm add ${dev ? '-D' : '-'}w ${pkg}`;\n    case 'yarn':\n      return `yarn add ${dev ? '-D ' : ''}${pkg}`;\n    case 'npm':\n      return `npm install --legacy-peer-deps ${dev ? '-D ' : ''}${pkg}`;\n    case 'bun':\n      return `bun add ${dev ? '-D ' : ''}${pkg}`;\n    default:\n      return `${pm} install ${dev ? '-D ' : ''}${pkg}`;\n  }\n};\n\n/**\n * Build the command that adds Nx to a non-Nx project, pinned to the nx\n * version the plugin is built against.\n */\nexport const buildNxInitCommand = (pm: string) => {\n  const dlxPrefix =\n    { npm: 'npx', pnpm: 'pnpm dlx', yarn: 'yarn dlx', bun: 'bunx' }[pm] ??\n    'npx';\n  return `${dlxPrefix} nx@${NX_VERSION} init`;\n};\n\n/**\n * Build a command to create a new workspace using @aws/create-nx-workspace.\n *\n * Uses the `create` shorthand for each package manager:\n *   npm create @aws/nx-workspace my-project\n *   pnpm create @aws/nx-workspace my-project\n *   yarn create @aws/nx-workspace my-project\n *   bun create @aws/nx-workspace my-project\n *\n * The package manager is auto-detected by @aws/create-nx-workspace from the\n * invoking command, so --pm is not needed.\n */\nexport const buildCreateNxWorkspaceCommand = (\n  pm: string,\n  workspace: string,\n  iac?: 'cdk' | 'terraform',\n  tag?: string,\n  module?: 'esm' | 'cjs',\n  extraArgs?: string,\n) => {\n  const createPrefix = PACKAGE_MANAGER_COMMANDS[pm]?.create ?? `${pm} create`;\n  const pkgName = tag ? `@aws/nx-workspace@${tag}` : '@aws/nx-workspace';\n  const parts = [\n    createPrefix,\n    pkgName,\n    // npm requires '--' to stop interpreting subsequent flags as npm config\n    ...(pm === 'npm' ? ['--'] : []),\n    workspace,\n    ...(iac ? [`--iac=${iac}`] : []),\n    ...(module ? [`--module=${module}`] : []),\n    ...(extraArgs ? [extraArgs] : []),\n  ];\n  return parts.join(' ');\n};\n"],"names":["NX_VERSION","PACKAGE_MANAGER_COMMANDS","npm","exec","run","create","pnpm","yarn","bun","buildPackageManagerExecCommand","pm","command","prefix","buildPackageManagerShortCommand","buildInstallCommand","pkg","dev","project","projectDir","shortName","split","pop","dir","buildNxInitCommand","dlxPrefix","buildCreateNxWorkspaceCommand","workspace","iac","tag","module","extraArgs","createPrefix","pkgName","parts","join"],"mappings":"AAAA;;;CAGC,GACD,SAASA,UAAU,QAAQ,gBAAa;AAExC,8DAA8D,GAC9D,SAASA,UAAU,GAAG;AAoBtB,OAAO,MAAMC,2BAGT;IACFC,KAAK;QAAEC,MAAM;QAAOC,KAAK;QAAWC,QAAQ;IAAa;IACzDC,MAAM;QAAEH,MAAM;QAAQC,KAAK;QAAQC,QAAQ;IAAc;IACzDE,MAAM;QAAEJ,MAAM;QAAQC,KAAK;QAAQC,QAAQ;IAAc;IACzDG,KAAK;QAAEL,MAAM;QAAQC,KAAK;QAAOC,QAAQ;IAAa;AACxD,EAAE;AAEF;;CAEC,GACD,OAAO,MAAMI,iCAAiC,CAACC,IAAYC;IACzD,MAAMC,SAASX,wBAAwB,CAACS,GAAG,EAAEP,QAAQO;IACrD,OAAO,GAAGE,OAAO,CAAC,EAAED,SAAS;AAC/B,EAAE;AAEF;;CAEC,GACD,OAAO,MAAME,kCAAkC,CAC7CH,IACAC;IAEA,MAAMC,SAASX,wBAAwB,CAACS,GAAG,EAAEN,OAAOM;IACpD,OAAO,GAAGE,OAAO,CAAC,EAAED,SAAS;AAC/B,EAAE;AAEF;;;;;CAKC,GACD,OAAO,MAAMG,sBAAsB,CACjCJ,IACAK,KACAC,KACAC,SACAC;IAEA,IAAI,CAACH,KAAK;QACR,OAAOL,OAAO,SAAS,SAAS,GAAGA,GAAG,QAAQ,CAAC;IACjD;IACA,IAAIO,SAAS;QACX,MAAME,YAAYF,QAAQG,KAAK,CAAC,KAAKC,GAAG;QACxC,MAAMC,MAAMJ,cAAc,CAAC,SAAS,EAAEC,WAAW;QACjD,OAAQT;YACN,KAAK;gBACH,OAAO,CAAC,SAAS,EAAEM,MAAM,QAAQ,KAAKD,IAAI,UAAU,EAAEI,WAAW;YACnE,KAAK;gBACH,OAAO,CAAC,eAAe,EAAEF,QAAQ,KAAK,EAAED,MAAM,QAAQ,KAAKD,KAAK;YAClE,KAAK;gBACH,OAAO,CAAC,+BAA+B,EAAEC,MAAM,QAAQ,KAAKD,IAAI,IAAI,EAAEO,KAAK;YAC7E,KAAK;gBACH,OAAO,CAAC,QAAQ,EAAEN,MAAM,QAAQ,KAAKD,IAAI,OAAO,EAAEO,KAAK;YACzD;gBACE,OAAO,GAAGZ,GAAG,SAAS,EAAEM,MAAM,QAAQ,KAAKD,KAAK;QACpD;IACF;IACA,OAAQL;QACN,KAAK;YACH,OAAO,CAAC,SAAS,EAAEM,MAAM,OAAO,IAAI,EAAE,EAAED,KAAK;QAC/C,KAAK;YACH,OAAO,CAAC,SAAS,EAAEC,MAAM,QAAQ,KAAKD,KAAK;QAC7C,KAAK;YACH,OAAO,CAAC,+BAA+B,EAAEC,MAAM,QAAQ,KAAKD,KAAK;QACnE,KAAK;YACH,OAAO,CAAC,QAAQ,EAAEC,MAAM,QAAQ,KAAKD,KAAK;QAC5C;YACE,OAAO,GAAGL,GAAG,SAAS,EAAEM,MAAM,QAAQ,KAAKD,KAAK;IACpD;AACF,EAAE;AAEF;;;CAGC,GACD,OAAO,MAAMQ,qBAAqB,CAACb;IACjC,MAAMc,YACJ;QAAEtB,KAAK;QAAOI,MAAM;QAAYC,MAAM;QAAYC,KAAK;IAAO,CAAC,CAACE,GAAG,IACnE;IACF,OAAO,GAAGc,UAAU,IAAI,EAAExB,WAAW,KAAK,CAAC;AAC7C,EAAE;AAEF;;;;;;;;;;;CAWC,GACD,OAAO,MAAMyB,gCAAgC,CAC3Cf,IACAgB,WACAC,KACAC,KACAC,QACAC;IAEA,MAAMC,eAAe9B,wBAAwB,CAACS,GAAG,EAAEL,UAAU,GAAGK,GAAG,OAAO,CAAC;IAC3E,MAAMsB,UAAUJ,MAAM,CAAC,kBAAkB,EAAEA,KAAK,GAAG;IACnD,MAAMK,QAAQ;QACZF;QACAC;QACA,wEAAwE;WACpEtB,OAAO,QAAQ;YAAC;SAAK,GAAG,EAAE;QAC9BgB;WACIC,MAAM;YAAC,CAAC,MAAM,EAAEA,KAAK;SAAC,GAAG,EAAE;WAC3BE,SAAS;YAAC,CAAC,SAAS,EAAEA,QAAQ;SAAC,GAAG,EAAE;WACpCC,YAAY;YAACA;SAAU,GAAG,EAAE;KACjC;IACD,OAAOG,MAAMC,IAAI,CAAC;AACpB,EAAE"}

package/src/utils/connection/open-api/react.d.ts

@@ -3,6 +3,23 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { type ProjectConfiguration, type Tree } from '@nx/devkit';
+import { type DependencyDeclaration, type MustDeclare } from '../../declared-dependencies';
+/** Dependencies a caller must declare to add an OpenAPI React client. */
+export declare const OPEN_API_REACT_DEPENDENCIES: readonly [{
+    readonly name: "oidc-client-ts";
+}, {
+    readonly name: "react-oidc-context";
+}, {
+    readonly name: "@aws-sdk/credential-provider-cognito-identity";
+}, {
+    readonly name: "aws4fetch";
+}, {
+    readonly name: "@tanstack/react-query";
+}, {
+    readonly name: "@tanstack/react-query-devtools";
+}, {
+    readonly name: "@smithy/types";
+}];
 export interface AddOpenApiReactClientOptions {
     /**
      * The react project to add the openapi client and build targets to
@@ -52,4 +69,4 @@ export interface AddOpenApiReactClientOptions {
 /**
  * Adds an OpenAPI React client to the frontend project along with supporting build targets
  */
-export declare const addOpenApiReactClient: (tree: Tree, { apiName, frontendProjectConfig, backendProjectConfig, specBuildProject, specPath, specBuildTargetName, auth, port, isAgentRuntime, skipLocalDev, }: AddOpenApiReactClientOptions) => Promise<void>;
+export declare const addOpenApiReactClient: <const D extends DependencyDeclaration>(tree: Tree, { apiName, frontendProjectConfig, backendProjectConfig, specBuildProject, specPath, specBuildTargetName, auth, port, isAgentRuntime, skipLocalDev, }: AddOpenApiReactClientOptions, declaration: D & MustDeclare<typeof OPEN_API_REACT_DEPENDENCIES, D>) => Promise<void>;

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

@@ -5,14 +5,38 @@
 import { addTargetToLocalDev } from "../../../connection/local-dev.js";
 import runtimeConfigGenerator from "../../../ts/react-website/runtime-config/generator.js";
 import { addSingleImport, applyGritQL } from "../../ast.js";
+import { forDependencies } from "../../declared-dependencies.js";
 import { addDependenciesToPackageJson } from "../../dependencies.js";
 import { updateGitIgnore } from "../../git.js";
 import { kebabCase, toClassName } from "../../names.js";
 import { sortObjectKeys } from "../../object.js";
 import { withVersions } from "../../versions.js";
+/** Dependencies a caller must declare to add an OpenAPI React client. */ export const OPEN_API_REACT_DEPENDENCIES = [
+    {
+        name: 'oidc-client-ts'
+    },
+    {
+        name: 'react-oidc-context'
+    },
+    {
+        name: '@aws-sdk/credential-provider-cognito-identity'
+    },
+    {
+        name: 'aws4fetch'
+    },
+    {
+        name: '@tanstack/react-query'
+    },
+    {
+        name: '@tanstack/react-query-devtools'
+    },
+    {
+        name: '@smithy/types'
+    }
+];
 /**
  * Adds an OpenAPI React client to the frontend project along with supporting build targets
- */ export const addOpenApiReactClient = async (tree, { apiName, frontendProjectConfig, backendProjectConfig, specBuildProject, specPath, specBuildTargetName, auth, port, isAgentRuntime = false, skipLocalDev = false })=>{
+ */ export const addOpenApiReactClient = async (tree, { apiName, frontendProjectConfig, backendProjectConfig, specBuildProject, specPath, specBuildTargetName, auth, port, isAgentRuntime = false, skipLocalDev = false }, declaration)=>{
     const clientGenTarget = `generate:${kebabCase(apiName)}-client`;
     const clientGenWatchTarget = `watch-${clientGenTarget}`;
     const generatedClientDir = joinPathFragments('generated', kebabCase(apiName));
@@ -123,7 +147,7 @@ import { withVersions } from "../../versions.js";
             ]
         });
     }
-    addDependenciesToPackageJson(tree, withVersions([
+    addDependenciesToPackageJson(tree, withVersions(forDependencies(declaration), [
         ...auth === 'iam' ? [
             'oidc-client-ts',
             'react-oidc-context',
@@ -135,7 +159,7 @@ import { withVersions } from "../../versions.js";
         ] : [],
         '@tanstack/react-query',
         '@tanstack/react-query-devtools'
-    ]), withVersions([
+    ]), withVersions(forDependencies(declaration), [
         '@smithy/types'
     ]), joinPathFragments(frontendProjectConfig.root, 'package.json'));
 };

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 { addDependenciesToPackageJson } from '../../dependencies';\nimport { updateGitIgnore } from '../../git';\nimport { kebabCase, toClassName } from '../../names';\nimport { sortObjectKeys } from '../../object';\nimport { withVersions } from '../../versions';\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  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) => {\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      ...((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    withVersions(['@smithy/types']),\n    joinPathFragments(frontendProjectConfig.root, 'package.json'),\n  );\n};\n"],"names":["generateFiles","joinPathFragments","OverwriteStrategy","updateProjectConfiguration","addTargetToLocalDev","runtimeConfigGenerator","addSingleImport","applyGritQL","addDependenciesToPackageJson","updateGitIgnore","kebabCase","toClassName","sortObjectKeys","withVersions","addOpenApiReactClient","tree","apiName","frontendProjectConfig","backendProjectConfig","specBuildProject","specPath","specBuildTargetName","auth","port","isAgentRuntime","skipLocalDev","clientGenTarget","clientGenWatchTarget","generatedClientDir","generatedClientDirFromRoot","sourceRoot","name","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,SAASC,4BAA4B,QAAQ,wBAAqB;AAClE,SAASC,eAAe,QAAQ,eAAY;AAC5C,SAASC,SAAS,EAAEC,WAAW,QAAQ,iBAAc;AACrD,SAASC,cAAc,QAAQ,kBAAe;AAC9C,SAASC,YAAY,QAAQ,oBAAiB;AAiD9C;;CAEC,GACD,OAAO,MAAMC,wBAAwB,OACnCC,MACA,EACEC,OAAO,EACPC,qBAAqB,EACrBC,oBAAoB,EACpBC,gBAAgB,EAChBC,QAAQ,EACRC,mBAAmB,EACnBC,IAAI,EACJC,IAAI,EACJC,iBAAiB,KAAK,EACtBC,eAAe,KAAK,EACS;IAE/B,MAAMC,kBAAkB,CAAC,SAAS,EAAEhB,UAAUM,SAAS,OAAO,CAAC;IAC/D,MAAMW,uBAAuB,CAAC,MAAM,EAAED,iBAAiB;IAEvD,MAAME,qBAAqB3B,kBAAkB,aAAaS,UAAUM;IACpE,MAAMa,6BAA6B5B,kBACjCgB,sBAAsBa,UAAU,EAChCF;IAGF,4DAA4D;IAC5DzB,2BAA2BY,MAAME,sBAAsBc,IAAI,EAAE;QAC3D,GAAGd,qBAAqB;QACxBe,SAASpB,eAAe;YACtB,GAAGK,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,MAAMb;4BACtBA;yBACD;oBACH;iBACD,EACF;YACD,CAACA,gBAAgB,EAAE;gBACjBc,OAAO;gBACPC,UAAU;gBACVC,QAAQ;oBACN;wBACEC,2BAA2B;oBAC7B;iBACD;gBACDC,SAAS;oBACP3C,kBAAkB,mBAAmB4B;iBACtC;gBACDgB,SAAS;oBACPC,UAAU;wBACR,CAAC,yDAAyD,EAAE1B,SAAS,gBAAgB,EAAES,2BAA2B,kBAAkB,CAAC;qBACtI;gBACH;gBACAQ,WAAW;oBAAChB;iBAAoB;YAClC;YACA,2CAA2C;YAC3C,CAACM,qBAAqB,EAAE;gBACtBc,UAAU;gBACVI,SAAS;oBACPC,UAAU;wBACR,CAAC,oBAAoB,EAAE3B,iBAAiBY,IAAI,CAAC,iCAAiC,EAAEd,sBAAsBc,IAAI,CAAC,EAAE,EAAEL,gBAAgB,CAAC,CAAC;qBAClI;gBACH;gBACAqB,YAAY;YACd;QACF;IACF;IAEA,MAAMC,iBAAiB/B,sBAAsBa,UAAU,CAACmB,KAAK,CAC3DhC,sBAAsBiC,IAAI,CAACC,MAAM,GAAG;IAGtC,yCAAyC;IACzC,sFAAsF;IACtF1C,gBAAgBM,MAAME,sBAAsBiC,IAAI,EAAE,CAACE,WAAa;eAC3DA;YACHnD,kBAAkB+C,gBAAgBpB;SACnC;IAED,2FAA2F;IAC3F,MAAMvB,uBAAuBU,MAAM;QACjCsC,SAASpC,sBAAsBc,IAAI;IACrC;IAEA,kBAAkB;IAClB,IAAIT,SAAS,OAAO;QAClBtB,cACEe,MACAd,kBAAkB,YAAYqD,OAAO,EAAE,oCACvCrD,kBAAkBgB,sBAAsBa,UAAU,EAAE,UACpD,CAAC,GACD;YACEyB,mBAAmBrD,kBAAkBsD,YAAY;QACnD;IAEJ;IAEA,oEAAoE;IACpExD,cACEe,MACAd,kBACE,YAAYqD,OAAO,EACnB,kDAEFrD,kBAAkBgB,sBAAsBa,UAAU,EAAE,eACpD,CAAC,GACD;QACEyB,mBAAmBrD,kBAAkBsD,YAAY;IACnD;IAGF,MAAMC,mBAAmB9C,YAAYK;IAErC,uCAAuC;IACvChB,cACEe,MACAd,kBAAkB,YAAYqD,OAAO,EAAE,UACvCrC,sBAAsBa,UAAU,EAChC;QACER;QACAN;QACAyC;QACA7B;QACAJ;IACF;IAGF,4CAA4C;IAC5C,MAAMkC,cAAczD,kBAClBgB,sBAAsBa,UAAU,EAChC;IAGF,4DAA4D;IAC5D,MAAMxB,gBACJS,MACA2C,aACA,uBACA;IAEF,MAAMnD,YACJQ,MACA2C,aACA;IAGF,4CAA4C;IAC5C,MAAMC,eAAe,GAAGF,iBAAiB,QAAQ,CAAC;IAClD,MAAMnD,gBACJS,MACA2C,aACAC,cACA,CAAC,aAAa,EAAEA,cAAc;IAEhC,MAAMpD,YACJQ,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,MAAMrB,oBACJW,MACAE,sBAAsBc,IAAI,EAC1Bb,qBAAqBa,IAAI,EACzB;YACE6B,KAAK,CAAC,iBAAiB,EAAErC,KAAK,CAAC,CAAC;YAChCP;YACA,mFAAmF;YACnF,wDAAwD;YACxD,qFAAqF;YACrF,uFAAuF;YACvF6C,6BAA6B;gBAACnC;gBAAiBC;aAAqB;QACtE;IAEJ;IAEAnB,6BACEO,MACAF,aAAa;WACNS,SAAS,QACV;YACE;YACA;YACA;YACA;SACD,GACD,EAAE;WACDA,SAAS,YAAY;YAAC;SAAqB,GAAG,EAAE;QACrD;QACA;KACD,GACDT,aAAa;QAAC;KAAgB,GAC9BZ,kBAAkBgB,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 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"}

package/src/utils/declared-dependencies.d.ts

@@ -0,0 +1,140 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { IPyDepVersion, ITsDepVersion } from './versions';
+/**
+ * Which vended dependencies each generator is responsible for, and when each
+ * applies.
+ *
+ * A generator declares every dependency it may add — including those added on
+ * its behalf by helpers it calls — once, and `addTsDependencies` /
+ * `addPyDependencies` add the subset whose `when` predicate the generator's
+ * metadata satisfies. The declaration is the only place packages are listed.
+ *
+ * The same declaration drives the version sync migration, which replays the
+ * predicates against the metadata recorded on each project. Pass the very object
+ * you record as metadata, so what a generator added and what the migration owns
+ * cannot drift.
+ */
+/**
+ * The metadata a generator records, which its predicates read. Deliberately
+ * `object` rather than an index signature, so a generator can type its
+ * declaration against a plain interface.
+ */
+export type DependencyMetadata = object;
+/** What every declared dependency carries, whichever language it belongs to. */
+export interface DeclaredDependency<Name, M extends DependencyMetadata> {
+    readonly name: Name;
+    /**
+     * Whether this dependency applies. Reads the metadata the generator records,
+     * so the migration can evaluate the same predicate later. Any truthy return
+     * counts, so a predicate can hand back the value it read.
+     */
+    readonly when?: (metadata: M) => unknown;
+    /** Added to the workspace root manifest rather than the project's. */
+    readonly root?: boolean;
+    /**
+     * Declared only so the version sync keeps its pinned version current — an
+     * `overrides` entry, say. Never installed as a dependency.
+     */
+    readonly versionOnly?: boolean;
+}
+/**
+ * A TypeScript dependency, which may be a dev dependency.
+ *
+ * `group` is typed as never-present rather than left off, so putting a Python
+ * flag on a TypeScript entry is a type error instead of an ignored property.
+ */
+export interface DeclaredTsDependency<Name, M extends DependencyMetadata> extends DeclaredDependency<Name, M> {
+    /** Added as a dev dependency rather than a runtime one. */
+    readonly dev?: boolean;
+    readonly group?: never;
+}
+/** A Python dependency, which may belong to a pyproject dependency group. */
+export interface DeclaredPyDependency<Name, M extends DependencyMetadata> extends DeclaredDependency<Name, M> {
+    /** Added to this pyproject dependency group rather than the main list. */
+    readonly group?: string;
+    readonly dev?: never;
+}
+export interface DependencyDeclaration<Ts extends readonly DeclaredTsDependency<ITsDepVersion, never>[] = readonly DeclaredTsDependency<ITsDepVersion, never>[], Py extends readonly DeclaredPyDependency<IPyDepVersion, never>[] = readonly DeclaredPyDependency<IPyDepVersion, never>[]> {
+    readonly ts: Ts;
+    readonly py: Py;
+}
+/**
+ * Declare the dependencies a generator owns, typed against the metadata it
+ * records. Spread the `*_DEPENDENCIES` of any helper called, so the declaration
+ * covers what those helpers add too.
+ */
+export declare const declareDependencies: <M extends DependencyMetadata = Record<string, never>>() => <const Ts extends readonly DeclaredTsDependency<ITsDepVersion, M>[], const Py extends readonly DeclaredPyDependency<IPyDepVersion, M>[]>(declaration: {
+    ts?: Ts;
+    py?: Py;
+}) => DependencyDeclaration<Ts, Py>;
+/**
+ * Narrow entries to a further condition, keeping the one each already carries.
+ *
+ * For a helper's constant spread into a generator that calls it down one branch:
+ * the branch gates the whole set, and each entry's own predicate still gates it
+ * within that branch. Replacing `when` outright would widen ownership to the
+ * helper's every branch.
+ */
+export declare const onlyWhen: <M extends DependencyMetadata, const Entries extends readonly {
+    readonly name: unknown;
+}[]>(entries: Entries, condition: (metadata: M) => unknown) => { readonly [K in keyof Entries]: Omit<Entries[K], "when"> & {
+    when: (m: M) => boolean;
+}; };
+/**
+ * Mark entries as declared for ownership but never installed here — a helper's
+ * constant spread into a generator that doesn't own the project the helper adds
+ * them to.
+ */
+export declare const ownedElsewhere: <const Entries extends readonly unknown[]>(entries: Entries) => { readonly [K in keyof Entries]: Entries[K] & {
+    versionOnly: true;
+}; };
+/** Every package a declaration names, whatever its predicate. */
+export declare const declaredNames: <Name>(entries: readonly {
+    readonly name: Name;
+}[]) => Name[];
+/**
+ * The entries of a declaration whose condition the given metadata satisfies —
+ * everything this occurrence is responsible for, installed here or not.
+ *
+ * A predicate that throws — reading a field the metadata doesn't carry, say —
+ * counts as not applying. The migration evaluates these against whatever a
+ * project happened to record, and must not claim a branch it cannot confirm.
+ */
+export declare const ownedDependencyEntries: <Name, M extends DependencyMetadata, Entry extends DeclaredDependency<Name, M>>(entries: readonly Entry[], metadata: M) => Entry[];
+/**
+ * The entries to install for the given metadata: those it owns, less the ones
+ * declared for their version alone. A `versionOnly` entry is still owned — the
+ * sync keeps its pin current wherever it already sits.
+ */
+export declare const applicableDependencies: <Name, M extends DependencyMetadata, Entry extends DeclaredDependency<Name, M>>(entries: readonly Entry[], metadata: M) => Entry[];
+/**
+ * Requires a caller's declaration to cover `Needed`, naming whatever is missing
+ * in the type error. Helpers that add dependencies take this alongside the
+ * declaration so a forgotten spread can't compile.
+ */
+export type MustDeclare<Needed extends readonly {
+    readonly name: ITsDepVersion;
+}[], D extends DependencyDeclaration> = [Exclude<Needed[number]['name'], D['ts'][number]['name']>] extends [never] ? unknown : {
+    __missingDeclaredDependencies: Exclude<Needed[number]['name'], D['ts'][number]['name']>;
+};
+/** `MustDeclare` for Python dependencies. */
+export type MustDeclarePy<Needed extends readonly {
+    readonly name: IPyDepVersion;
+}[], D extends DependencyDeclaration> = [Exclude<Needed[number]['name'], D['py'][number]['name']>] extends [never] ? unknown : {
+    __missingDeclaredPyDependencies: Exclude<Needed[number]['name'], D['py'][number]['name']>;
+};
+/**
+ * The dependencies a declaration covers, for typing a conditional list without
+ * widening it to every vended package.
+ */
+export type DeclaredTs<D extends DependencyDeclaration> = D['ts'][number]['name'];
+/** `DeclaredTs` for Python dependencies. */
+export type DeclaredPy<D extends DependencyDeclaration> = D['py'][number]['name'];
+/**
+ * Narrows a caller's declaration to the subset a helper adds, which
+ * `MustDeclare` has already proven the caller covers.
+ */
+export declare const forDependencies: <const Ts extends readonly DeclaredDependency<ITsDepVersion, never>[] = [], const Py extends readonly DeclaredDependency<IPyDepVersion, never>[] = []>(declaration: DependencyDeclaration) => DependencyDeclaration<Ts, Py>;

package/src/utils/declared-dependencies.js

@@ -0,0 +1,64 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */ /**
+ * Declare the dependencies a generator owns, typed against the metadata it
+ * records. Spread the `*_DEPENDENCIES` of any helper called, so the declaration
+ * covers what those helpers add too.
+ */ export const declareDependencies = ()=>(declaration)=>({
+            ts: declaration.ts ?? [],
+            py: declaration.py ?? []
+        });
+/**
+ * Narrow entries to a further condition, keeping the one each already carries.
+ *
+ * For a helper's constant spread into a generator that calls it down one branch:
+ * the branch gates the whole set, and each entry's own predicate still gates it
+ * within that branch. Replacing `when` outright would widen ownership to the
+ * helper's every branch.
+ */ export const onlyWhen = (entries, condition)=>entries.map((entry)=>{
+        // A declaration erases the metadata its predicates read, so calling one back
+        // requires naming the type the caller narrows to.
+        const own = entry.when;
+        return {
+            ...entry,
+            when: (metadata)=>Boolean(condition(metadata)) && Boolean(own?.(metadata) ?? true)
+        };
+    });
+/**
+ * Mark entries as declared for ownership but never installed here — a helper's
+ * constant spread into a generator that doesn't own the project the helper adds
+ * them to.
+ */ export const ownedElsewhere = (entries)=>entries.map((entry)=>({
+            ...entry,
+            versionOnly: true
+        }));
+/** Every package a declaration names, whatever its predicate. */ export const declaredNames = (entries)=>entries.map((entry)=>entry.name);
+/**
+ * The entries of a declaration whose condition the given metadata satisfies —
+ * everything this occurrence is responsible for, installed here or not.
+ *
+ * A predicate that throws — reading a field the metadata doesn't carry, say —
+ * counts as not applying. The migration evaluates these against whatever a
+ * project happened to record, and must not claim a branch it cannot confirm.
+ */ export const ownedDependencyEntries = (entries, metadata)=>entries.filter((entry)=>{
+        if (!entry.when) {
+            return true;
+        }
+        try {
+            return Boolean(entry.when(metadata));
+        } catch  {
+            return false;
+        }
+    });
+/**
+ * The entries to install for the given metadata: those it owns, less the ones
+ * declared for their version alone. A `versionOnly` entry is still owned — the
+ * sync keeps its pin current wherever it already sits.
+ */ export const applicableDependencies = (entries, metadata)=>ownedDependencyEntries(entries, metadata).filter((entry)=>!entry.versionOnly);
+/**
+ * Narrows a caller's declaration to the subset a helper adds, which
+ * `MustDeclare` has already proven the caller covers.
+ */ export const forDependencies = (declaration)=>declaration;
+
+//# sourceMappingURL=declared-dependencies.js.map

package/src/utils/declared-dependencies.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/nx-plugin/src/utils/declared-dependencies.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\nimport type { IPyDepVersion, ITsDepVersion } from './versions';\n\n/**\n * Which vended dependencies each generator is responsible for, and when each\n * applies.\n *\n * A generator declares every dependency it may add — including those added on\n * its behalf by helpers it calls — once, and `addTsDependencies` /\n * `addPyDependencies` add the subset whose `when` predicate the generator's\n * metadata satisfies. The declaration is the only place packages are listed.\n *\n * The same declaration drives the version sync migration, which replays the\n * predicates against the metadata recorded on each project. Pass the very object\n * you record as metadata, so what a generator added and what the migration owns\n * cannot drift.\n */\n\n/**\n * The metadata a generator records, which its predicates read. Deliberately\n * `object` rather than an index signature, so a generator can type its\n * declaration against a plain interface.\n */\nexport type DependencyMetadata = object;\n\n/** What every declared dependency carries, whichever language it belongs to. */\nexport interface DeclaredDependency<Name, M extends DependencyMetadata> {\n  readonly name: Name;\n  /**\n   * Whether this dependency applies. Reads the metadata the generator records,\n   * so the migration can evaluate the same predicate later. Any truthy return\n   * counts, so a predicate can hand back the value it read.\n   */\n  readonly when?: (metadata: M) => unknown;\n  /** Added to the workspace root manifest rather than the project's. */\n  readonly root?: boolean;\n  /**\n   * Declared only so the version sync keeps its pinned version current — an\n   * `overrides` entry, say. Never installed as a dependency.\n   */\n  readonly versionOnly?: boolean;\n}\n\n/**\n * A TypeScript dependency, which may be a dev dependency.\n *\n * `group` is typed as never-present rather than left off, so putting a Python\n * flag on a TypeScript entry is a type error instead of an ignored property.\n */\nexport interface DeclaredTsDependency<Name, M extends DependencyMetadata>\n  extends DeclaredDependency<Name, M> {\n  /** Added as a dev dependency rather than a runtime one. */\n  readonly dev?: boolean;\n  readonly group?: never;\n}\n\n/** A Python dependency, which may belong to a pyproject dependency group. */\nexport interface DeclaredPyDependency<Name, M extends DependencyMetadata>\n  extends DeclaredDependency<Name, M> {\n  /** Added to this pyproject dependency group rather than the main list. */\n  readonly group?: string;\n  readonly dev?: never;\n}\n\nexport interface DependencyDeclaration<\n  Ts extends readonly DeclaredTsDependency<\n    ITsDepVersion,\n    never\n  >[] = readonly DeclaredTsDependency<ITsDepVersion, never>[],\n  Py extends readonly DeclaredPyDependency<\n    IPyDepVersion,\n    never\n  >[] = readonly DeclaredPyDependency<IPyDepVersion, never>[],\n> {\n  readonly ts: Ts;\n  readonly py: Py;\n}\n\n/**\n * Declare the dependencies a generator owns, typed against the metadata it\n * records. Spread the `*_DEPENDENCIES` of any helper called, so the declaration\n * covers what those helpers add too.\n */\nexport const declareDependencies =\n  <M extends DependencyMetadata = Record<string, never>>() =>\n  <\n    const Ts extends readonly DeclaredTsDependency<ITsDepVersion, M>[],\n    const Py extends readonly DeclaredPyDependency<IPyDepVersion, M>[],\n  >(declaration: {\n    ts?: Ts;\n    py?: Py;\n  }): DependencyDeclaration<Ts, Py> =>\n    ({\n      ts: declaration.ts ?? [],\n      py: declaration.py ?? [],\n    }) as unknown as DependencyDeclaration<Ts, Py>;\n\n/**\n * Narrow entries to a further condition, keeping the one each already carries.\n *\n * For a helper's constant spread into a generator that calls it down one branch:\n * the branch gates the whole set, and each entry's own predicate still gates it\n * within that branch. Replacing `when` outright would widen ownership to the\n * helper's every branch.\n */\nexport const onlyWhen = <\n  M extends DependencyMetadata,\n  const Entries extends readonly { readonly name: unknown }[],\n>(\n  entries: Entries,\n  condition: (metadata: M) => unknown,\n): {\n  readonly [K in keyof Entries]: Omit<Entries[K], 'when'> & {\n    when: (m: M) => boolean;\n  };\n} =>\n  entries.map((entry) => {\n    // A declaration erases the metadata its predicates read, so calling one back\n    // requires naming the type the caller narrows to.\n    const own = (entry as { when?: (m: M) => unknown }).when;\n    return {\n      ...entry,\n      when: (metadata: M) =>\n        Boolean(condition(metadata)) && Boolean(own?.(metadata) ?? true),\n    };\n  }) as never;\n\n/**\n * Mark entries as declared for ownership but never installed here — a helper's\n * constant spread into a generator that doesn't own the project the helper adds\n * them to.\n */\nexport const ownedElsewhere = <const Entries extends readonly unknown[]>(\n  entries: Entries,\n): { readonly [K in keyof Entries]: Entries[K] & { versionOnly: true } } =>\n  entries.map((entry) => ({\n    ...(entry as object),\n    versionOnly: true,\n  })) as never;\n\n/** Every package a declaration names, whatever its predicate. */\nexport const declaredNames = <Name>(\n  entries: readonly { readonly name: Name }[],\n): Name[] => entries.map((entry) => entry.name);\n\n/**\n * The entries of a declaration whose condition the given metadata satisfies —\n * everything this occurrence is responsible for, installed here or not.\n *\n * A predicate that throws — reading a field the metadata doesn't carry, say —\n * counts as not applying. The migration evaluates these against whatever a\n * project happened to record, and must not claim a branch it cannot confirm.\n */\nexport const ownedDependencyEntries = <\n  Name,\n  M extends DependencyMetadata,\n  Entry extends DeclaredDependency<Name, M>,\n>(\n  entries: readonly Entry[],\n  metadata: M,\n): Entry[] =>\n  entries.filter((entry) => {\n    if (!entry.when) {\n      return true;\n    }\n    try {\n      return Boolean(entry.when(metadata));\n    } catch {\n      return false;\n    }\n  });\n\n/**\n * The entries to install for the given metadata: those it owns, less the ones\n * declared for their version alone. A `versionOnly` entry is still owned — the\n * sync keeps its pin current wherever it already sits.\n */\nexport const applicableDependencies = <\n  Name,\n  M extends DependencyMetadata,\n  Entry extends DeclaredDependency<Name, M>,\n>(\n  entries: readonly Entry[],\n  metadata: M,\n): Entry[] =>\n  ownedDependencyEntries(entries, metadata).filter(\n    (entry) => !entry.versionOnly,\n  );\n\n/**\n * Requires a caller's declaration to cover `Needed`, naming whatever is missing\n * in the type error. Helpers that add dependencies take this alongside the\n * declaration so a forgotten spread can't compile.\n */\nexport type MustDeclare<\n  Needed extends readonly { readonly name: ITsDepVersion }[],\n  D extends DependencyDeclaration,\n> = [Exclude<Needed[number]['name'], D['ts'][number]['name']>] extends [never]\n  ? unknown\n  : {\n      __missingDeclaredDependencies: Exclude<\n        Needed[number]['name'],\n        D['ts'][number]['name']\n      >;\n    };\n\n/** `MustDeclare` for Python dependencies. */\nexport type MustDeclarePy<\n  Needed extends readonly { readonly name: IPyDepVersion }[],\n  D extends DependencyDeclaration,\n> = [Exclude<Needed[number]['name'], D['py'][number]['name']>] extends [never]\n  ? unknown\n  : {\n      __missingDeclaredPyDependencies: Exclude<\n        Needed[number]['name'],\n        D['py'][number]['name']\n      >;\n    };\n\n/**\n * The dependencies a declaration covers, for typing a conditional list without\n * widening it to every vended package.\n */\nexport type DeclaredTs<D extends DependencyDeclaration> =\n  D['ts'][number]['name'];\n\n/** `DeclaredTs` for Python dependencies. */\nexport type DeclaredPy<D extends DependencyDeclaration> =\n  D['py'][number]['name'];\n\n/**\n * Narrows a caller's declaration to the subset a helper adds, which\n * `MustDeclare` has already proven the caller covers.\n */\nexport const forDependencies = <\n  const Ts extends readonly DeclaredDependency<ITsDepVersion, never>[] = [],\n  const Py extends readonly DeclaredDependency<IPyDepVersion, never>[] = [],\n>(\n  declaration: DependencyDeclaration,\n): DependencyDeclaration<Ts, Py> =>\n  declaration as unknown as DependencyDeclaration<Ts, Py>;\n"],"names":["declareDependencies","declaration","ts","py","onlyWhen","entries","condition","map","entry","own","when","metadata","Boolean","ownedElsewhere","versionOnly","declaredNames","name","ownedDependencyEntries","filter","applicableDependencies","forDependencies"],"mappings":"AAAA;;;CAGC,GA8ED;;;;CAIC,GACD,OAAO,MAAMA,sBACX,IACA,CAGEC,cAIC,CAAA;YACCC,IAAID,YAAYC,EAAE,IAAI,EAAE;YACxBC,IAAIF,YAAYE,EAAE,IAAI,EAAE;QAC1B,CAAA,EAA+C;AAEnD;;;;;;;CAOC,GACD,OAAO,MAAMC,WAAW,CAItBC,SACAC,YAMAD,QAAQE,GAAG,CAAC,CAACC;QACX,6EAA6E;QAC7E,kDAAkD;QAClD,MAAMC,MAAM,AAACD,MAAuCE,IAAI;QACxD,OAAO;YACL,GAAGF,KAAK;YACRE,MAAM,CAACC,WACLC,QAAQN,UAAUK,cAAcC,QAAQH,MAAME,aAAa;QAC/D;IACF,GAAY;AAEd;;;;CAIC,GACD,OAAO,MAAME,iBAAiB,CAC5BR,UAEAA,QAAQE,GAAG,CAAC,CAACC,QAAW,CAAA;YACtB,GAAIA,KAAK;YACTM,aAAa;QACf,CAAA,GAAa;AAEf,+DAA+D,GAC/D,OAAO,MAAMC,gBAAgB,CAC3BV,UACWA,QAAQE,GAAG,CAAC,CAACC,QAAUA,MAAMQ,IAAI,EAAE;AAEhD;;;;;;;CAOC,GACD,OAAO,MAAMC,yBAAyB,CAKpCZ,SACAM,WAEAN,QAAQa,MAAM,CAAC,CAACV;QACd,IAAI,CAACA,MAAME,IAAI,EAAE;YACf,OAAO;QACT;QACA,IAAI;YACF,OAAOE,QAAQJ,MAAME,IAAI,CAACC;QAC5B,EAAE,OAAM;YACN,OAAO;QACT;IACF,GAAG;AAEL;;;;CAIC,GACD,OAAO,MAAMQ,yBAAyB,CAKpCd,SACAM,WAEAM,uBAAuBZ,SAASM,UAAUO,MAAM,CAC9C,CAACV,QAAU,CAACA,MAAMM,WAAW,EAC7B;AA2CJ;;;CAGC,GACD,OAAO,MAAMM,kBAAkB,CAI7BnB,cAEAA,YAAwD"}

package/src/utils/docker.d.ts

@@ -3,6 +3,15 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { type ProjectConfiguration, type Tree } from '@nx/devkit';
+import { type DependencyDeclaration, type MustDeclare } from './declared-dependencies';
+/** Dependencies a caller must declare to add a Docker scan target. */
+export declare const DOCKER_DEPENDENCIES: readonly [{
+    readonly name: "ncp";
+}, {
+    readonly name: "rimraf";
+}, {
+    readonly name: "make-dir-cli";
+}];
 /**
  * Substitution variables for the vended Node `Dockerfile` templates: the npm
  * version to install globally, and the versions its dependency overrides pin.
@@ -50,4 +59,4 @@ export interface DockerScanTargetOptions {
  * A \`.trivyignore\` is vended at the project root (kept if it already exists)
  * for suppressing findings.
  */
-export declare const addDockerScanTarget: (tree: Tree, options: DockerScanTargetOptions) => void;
+export declare const addDockerScanTarget: <const D extends DependencyDeclaration>(tree: Tree, options: DockerScanTargetOptions, declaration: D & MustDeclare<typeof DOCKER_DEPENDENCIES, D>) => void;

package/src/utils/docker.js

@@ -2,9 +2,13 @@
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */ import { joinPathFragments } from "@nx/devkit";
-import { FsCommands } from "./fs.js";
+import { forDependencies } from "./declared-dependencies.js";
+import { FS_DEPENDENCIES, FsCommands } from "./fs.js";
 import { addDependencyToTargetIfNotPresent } from "./nx.js";
 import { CONTAINER_VERSIONS, TS_VERSIONS } from "./versions.js";
+/** Dependencies a caller must declare to add a Docker scan target. */ export const DOCKER_DEPENDENCIES = [
+    ...FS_DEPENDENCIES
+];
 const TRIVY_IGNORE_FILE = '.trivyignore';
 const TRIVY_IGNORE_CONTENTS = `# Trivy ignore file. Add one vulnerability ID (e.g. CVE-2021-12345) per line to
 # suppress it during the image scan (\`nx run-many --target trivy\`).
@@ -32,7 +36,7 @@ const TRIVY_IGNORE_CONTENTS = `# Trivy ignore file. Add one vulnerability ID (e.
  *
  * A \`.trivyignore\` is vended at the project root (kept if it already exists)
  * for suppressing findings.
- */ export const addDockerScanTarget = (tree, options)=>{
+ */ export const addDockerScanTarget = (tree, options, declaration)=>{
     const { project, containerEngine, trivyTargetName, dockerTargetName } = options;
     const { imageTags } = options;
     const projectRoot = project.root;
@@ -47,7 +51,7 @@ const TRIVY_IGNORE_CONTENTS = `# Trivy ignore file. Add one vulnerability ID (e.
     const scanKey = imageTags[0].replace(/[^a-zA-Z0-9-]/g, '-');
     const scanDir = joinPathFragments('dist', projectRoot, 'trivy', scanKey);
     const trivyImage = `public.ecr.aws/aquasecurity/trivy:${CONTAINER_VERSIONS.trivy}`;
-    const fs = new FsCommands(tree);
+    const fs = new FsCommands(tree, forDependencies(declaration));
     const commands = [
         fs.rm(scanDir),
         fs.mkdir(scanDir),