@aws/nx-plugin 0.49.1 → 0.51.0

package/src/utils/agent-core-constructs/files/cdk/core/agent-core/runtime.ts.template

@@ -8,15 +8,9 @@ import {
   Grant,
   IPrincipal,
 } from 'aws-cdk-lib/aws-iam';
-import {
-  AwsCustomResource,
-  AwsCustomResourcePolicy,
-  PhysicalResourceId,
-  PhysicalResourceIdReference,
-} from 'aws-cdk-lib/custom-resources';
 import { Construct } from 'constructs';
-import type { AuthorizerConfiguration } from '@aws-sdk/client-bedrock-agentcore-control';
 import { Stack } from 'aws-cdk-lib';
+import { CfnRuntime } from 'aws-cdk-lib/aws-bedrockagentcore';
 
 /**
  * Options for the AgentCoreRuntime construct
@@ -27,7 +21,7 @@ export interface AgentCoreRuntimeProps {
   containerUri: string;
   serverProtocol: 'MCP' | 'HTTP';
   environment?: Record<string, string>;
-  authorizerConfiguration?: AuthorizerConfiguration;
+  authorizerConfiguration?: CfnRuntime.AuthorizerConfigurationProperty;
 }
 
 /**
@@ -132,75 +126,24 @@ export class AgentCoreRuntime extends Construct implements IGrantable {
     });
     this.grantPrincipal = this.role.grantPrincipal;
 
-    const agentRuntime = new AwsCustomResource(this, 'MCPSeverRuntime', {
-      onCreate: {
-        service: 'bedrock-agentcore-control',
-        action: 'CreateAgentRuntime',
-        parameters: {
-          agentRuntimeName: props.runtimeName,
-          agentRuntimeArtifact: {
-            containerConfiguration: {
-              containerUri: props.containerUri,
-            },
-          },
-          description: props.description,
-          environmentVariables: props.environment,
-          networkConfiguration: {
-            networkMode: 'PUBLIC',
-          },
-          protocolConfiguration: {
-            serverProtocol: props.serverProtocol,
-          },
-          roleArn: this.role.roleArn,
-          authorizerConfiguration: props.authorizerConfiguration,
-        },
-        physicalResourceId: PhysicalResourceId.fromResponse('agentRuntimeId'),
-      },
-      onUpdate: {
-        service: 'bedrock-agentcore-control',
-        action: 'UpdateAgentRuntime',
-        parameters: {
-          agentRuntimeId: new PhysicalResourceIdReference(),
-          agentRuntimeName: props.runtimeName,
-          agentRuntimeArtifact: {
-            containerConfiguration: {
-              containerUri: props.containerUri,
-            },
-          },
-          description: props.description,
-          environmentVariables: props.environment,
-          networkConfiguration: {
-            networkMode: 'PUBLIC',
-          },
-          protocolConfiguration: {
-            serverProtocol: props.serverProtocol,
-          },
-          roleArn: this.role.roleArn,
-          authorizerConfiguration: props.authorizerConfiguration,
+    const agentRuntime = new CfnRuntime(this, 'MCPServerRuntime', {
+      agentRuntimeName: props.runtimeName,
+      agentRuntimeArtifact: {
+        containerConfiguration: {
+          containerUri: props.containerUri,
         },
-        physicalResourceId: PhysicalResourceId.fromResponse('agentRuntimeId'),
       },
-      onDelete: {
-        service: 'bedrock-agentcore-control',
-        action: 'DeleteAgentRuntime',
-        parameters: {
-          agentRuntimeId: new PhysicalResourceIdReference(),
-        },
+      description: props.description,
+      environmentVariables: props.environment,
+      networkConfiguration: {
+        networkMode: 'PUBLIC',
       },
-      policy: AwsCustomResourcePolicy.fromStatements([
-        new PolicyStatement({
-          actions: ['bedrock-agentcore:*'],
-          resources: ['*'],
-        }),
-        new PolicyStatement({
-          actions: ['iam:PassRole'],
-          resources: [this.role.roleArn],
-        }),
-      ]),
-      installLatestAwsSdk: true,
+      protocolConfiguration: props.serverProtocol,
+      roleArn: this.role.roleArn,
+      authorizerConfiguration: props.authorizerConfiguration,
     });
 
-    this.arn = agentRuntime.getResponseField('agentRuntimeArn');
+    this.arn = agentRuntime.attrAgentRuntimeArn;
   }
 
   /**

package/src/utils/agent-core-constructs/files/terraform/core/agent-core/runtime.tf.template

@@ -278,7 +278,7 @@ resource "aws_iam_role_policy_attachment" "agent_core_policy" {
 }
 
 data "external" "docker_digest" {
-  program = ["sh", "-c", "echo '{\"digest\":\"'$(docker inspect ${var.docker_image_tag} --format '{{.Descriptor.digest}}')'\"}' "]
+  program = ["sh", "-c", "echo '{\"digest\":\"'$(docker inspect ${var.docker_image_tag} --format '{{.Id}}')'\"}' "]
 }
 
 # Null resource for Docker publish

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

@@ -0,0 +1,43 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ProjectConfiguration, Tree } from '@nx/devkit';
+export interface AddOpenApiReactClientOptions {
+    /**
+     * The react project to add the openapi client and build targets to
+     */
+    frontendProjectConfig: ProjectConfiguration;
+    /**
+     * The backend project which serves the api
+     */
+    backendProjectConfig: ProjectConfiguration;
+    /**
+     * The project which builds/generates the openapi spec
+     */
+    specBuildProject: ProjectConfiguration;
+    /**
+     * Name of the api
+     */
+    apiName: string;
+    /**
+     * Path to the openapi spec from the workspace root
+     */
+    specPath: string;
+    /**
+     * Fully qualified target name for the target that builds/generates the openapi spec
+     */
+    specBuildTargetName: string;
+    /**
+     * Authentication method
+     */
+    auth: 'IAM' | 'Cognito' | 'None';
+    /**
+     * Port on which the backend project's local server listens
+     */
+    port: number;
+}
+/**
+ * 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, }: AddOpenApiReactClientOptions) => Promise<void>;

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

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addOpenApiReactClient = void 0;
+const tslib_1 = require("tslib");
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+const devkit_1 = require("@nx/devkit");
+const names_1 = require("../../names");
+const object_1 = require("../../object");
+const git_1 = require("../../git");
+const generator_1 = tslib_1.__importDefault(require("../../../ts/react-website/runtime-config/generator"));
+const ast_1 = require("../../ast");
+const serve_local_1 = require("../../../api-connection/serve-local");
+const ast_2 = require("../../ast");
+const versions_1 = require("../../versions");
+/**
+ * Adds an OpenAPI React client to the frontend project along with supporting build targets
+ */
+const addOpenApiReactClient = (tree_1, _a) => tslib_1.__awaiter(void 0, [tree_1, _a], void 0, function* (tree, { apiName, frontendProjectConfig, backendProjectConfig, specBuildProject, specPath, specBuildTargetName, auth, port, }) {
+    const clientGenTarget = `generate:${(0, names_1.kebabCase)(apiName)}-client`;
+    const clientGenWatchTarget = `watch-${clientGenTarget}`;
+    const generatedClientDir = (0, devkit_1.joinPathFragments)('generated', (0, names_1.kebabCase)(apiName));
+    const generatedClientDirFromRoot = (0, devkit_1.joinPathFragments)(frontendProjectConfig.sourceRoot, generatedClientDir);
+    // Add TypeScript client generation to Frontend project.json
+    (0, devkit_1.updateProjectConfiguration)(tree, frontendProjectConfig.name, Object.assign(Object.assign({}, frontendProjectConfig), { targets: (0, object_1.sortObjectKeys)(Object.assign(Object.assign(Object.assign({}, frontendProjectConfig.targets), Object.fromEntries(['compile', 'bundle'].map((target) => {
+            var _a, _b, _c, _d;
+            return [
+                target,
+                Object.assign(Object.assign({}, (_a = frontendProjectConfig.targets) === null || _a === void 0 ? void 0 : _a[target]), { dependsOn: [
+                        ...((_d = (_c = (_b = frontendProjectConfig.targets) === null || _b === void 0 ? void 0 : _b[target]) === null || _c === void 0 ? void 0 : _c.dependsOn) !== null && _d !== void 0 ? _d : []).filter((t) => t !== clientGenTarget),
+                        clientGenTarget,
+                    ] }),
+            ];
+        }))), { [clientGenTarget]: {
+                cache: true,
+                executor: 'nx:run-commands',
+                inputs: [
+                    {
+                        dependentTasksOutputFiles: '**/*.json',
+                    },
+                ],
+                outputs: [
+                    (0, devkit_1.joinPathFragments)('{workspaceRoot}', generatedClientDirFromRoot),
+                ],
+                options: {
+                    commands: [
+                        `nx g @aws/nx-plugin:open-api#ts-hooks --openApiSpecPath="${specPath}" --outputPath="${generatedClientDirFromRoot}" --no-interactive`,
+                    ],
+                },
+                dependsOn: [specBuildTargetName],
+            }, 
+            // Watch target for regenerating the client
+            [clientGenWatchTarget]: {
+                executor: 'nx:run-commands',
+                options: {
+                    commands: [
+                        `nx watch --projects=${specBuildProject.name} --includeDependentProjects -- nx run ${frontendProjectConfig.name}:"${clientGenTarget}"`,
+                    ],
+                },
+                continuous: true,
+            } })) }));
+    const relativeSrcDir = frontendProjectConfig.sourceRoot.slice(frontendProjectConfig.root.length + 1);
+    // Ignore the generated client by default
+    // Users can safely remove the entry from the .gitignore if they prefer to check it in
+    (0, git_1.updateGitIgnore)(tree, frontendProjectConfig.root, (patterns) => [
+        ...patterns,
+        (0, devkit_1.joinPathFragments)(relativeSrcDir, generatedClientDir),
+    ]);
+    // Ensure that the frontend has runtime config as we'll use the url for creating the client
+    yield (0, generator_1.default)(tree, {
+        project: frontendProjectConfig.name,
+    });
+    // Add sigv4 fetch
+    if (auth === 'IAM') {
+        (0, devkit_1.generateFiles)(tree, (0, devkit_1.joinPathFragments)(__dirname, '../../files/website/hooks/sigv4'), (0, devkit_1.joinPathFragments)(frontendProjectConfig.sourceRoot, 'hooks'), {});
+    }
+    // Generate the tanstack query provider if it does not exist already
+    if (!tree.exists((0, devkit_1.joinPathFragments)(frontendProjectConfig.sourceRoot, 'components', 'QueryClientProvider.tsx'))) {
+        (0, devkit_1.generateFiles)(tree, (0, devkit_1.joinPathFragments)(__dirname, '../../files/website/components/tanstack-query'), (0, devkit_1.joinPathFragments)(frontendProjectConfig.sourceRoot, 'components'), {});
+    }
+    const apiNameClassName = (0, names_1.toClassName)(apiName);
+    // Add a hook to instantiate the client
+    (0, devkit_1.generateFiles)(tree, (0, devkit_1.joinPathFragments)(__dirname, 'files'), frontendProjectConfig.sourceRoot, {
+        auth,
+        apiName,
+        apiNameClassName,
+        generatedClientDir,
+    });
+    // Update main.tsx to add required providers
+    const mainTsxPath = (0, devkit_1.joinPathFragments)(frontendProjectConfig.sourceRoot, 'main.tsx');
+    // Add the query client provider if it doesn't exist already
+    const hasQueryClientProvider = (0, ast_1.query)(tree, mainTsxPath, 'JsxOpeningElement[tagName.name="QueryClientProvider"]').length > 0;
+    if (!hasQueryClientProvider) {
+        (0, ast_2.addSingleImport)(tree, mainTsxPath, 'QueryClientProvider', './components/QueryClientProvider');
+        (0, ast_1.replace)(tree, mainTsxPath, 'JsxSelfClosingElement[tagName.name="App"]', (node) => (0, ast_2.createJsxElementFromIdentifier)('QueryClientProvider', [node]));
+    }
+    // Add the api provider if it does not exist
+    const providerName = `${apiNameClassName}Provider`;
+    const hasProvider = (0, ast_1.query)(tree, mainTsxPath, `JsxOpeningElement[tagName.name="${providerName}"]`).length > 0;
+    if (!hasProvider) {
+        (0, ast_2.addSingleImport)(tree, mainTsxPath, providerName, `./components/${providerName}`);
+        (0, ast_1.replace)(tree, mainTsxPath, 'JsxSelfClosingElement[tagName.name="App"]', (node) => (0, ast_2.createJsxElementFromIdentifier)(providerName, [node]));
+    }
+    // Update serve-local on the website to use our local server
+    (0, serve_local_1.addTargetToServeLocal)(tree, frontendProjectConfig.name, backendProjectConfig.name, {
+        url: `http://localhost:${port}/`,
+        apiName,
+        // Additionally add a dependency on the generate watch command to ensure that local
+        // API changes that affect the client are also reloaded.
+        // We include a dependency on the generate target as watch ONLY triggers on a change,
+        // and we need to ensure the client is generated the first time if not already present.
+        additionalDependencyTargets: [clientGenTarget, clientGenWatchTarget],
+    });
+    (0, devkit_1.addDependenciesToPackageJson)(tree, (0, versions_1.withVersions)([
+        ...(auth === 'IAM'
+            ? [
+                'oidc-client-ts',
+                'react-oidc-context',
+                '@aws-sdk/client-cognito-identity',
+                '@aws-sdk/credential-provider-cognito-identity',
+                'aws4fetch',
+            ]
+            : []),
+        ...(auth === 'Cognito' ? ['react-oidc-context'] : []),
+        '@tanstack/react-query',
+        '@tanstack/react-query-devtools',
+    ]), (0, versions_1.withVersions)(['@smithy/types']));
+});
+exports.addOpenApiReactClient = addOpenApiReactClient;
+//# sourceMappingURL=react.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"react.js","sourceRoot":"","sources":["../../../../../../../packages/nx-plugin/src/utils/api-connection/open-api/react.ts"],"names":[],"mappings":";;;;AAAA;;;GAGG;AACH,uCAOoB;AACpB,uCAAqD;AACrD,yCAA8C;AAC9C,mCAA4C;AAC5C,2GAAwF;AACxF,mCAA2C;AAC3C,qEAA4E;AAE5E,mCAA4E;AAC5E,6CAA8C;AAqC9C;;GAEG;AACI,MAAM,qBAAqB,GAAG,aAYnC,EAAE,4DAXF,IAAU,EACV,EACE,OAAO,EACP,qBAAqB,EACrB,oBAAoB,EACpB,gBAAgB,EAChB,QAAQ,EACR,mBAAmB,EACnB,IAAI,EACJ,IAAI,GACyB;IAE/B,MAAM,eAAe,GAAG,YAAY,IAAA,iBAAS,EAAC,OAAO,CAAC,SAAS,CAAC;IAChE,MAAM,oBAAoB,GAAG,SAAS,eAAe,EAAE,CAAC;IAExD,MAAM,kBAAkB,GAAG,IAAA,0BAAiB,EAAC,WAAW,EAAE,IAAA,iBAAS,EAAC,OAAO,CAAC,CAAC,CAAC;IAC9E,MAAM,0BAA0B,GAAG,IAAA,0BAAiB,EAClD,qBAAqB,CAAC,UAAU,EAChC,kBAAkB,CACnB,CAAC;IAEF,4DAA4D;IAC5D,IAAA,mCAA0B,EAAC,IAAI,EAAE,qBAAqB,CAAC,IAAI,kCACtD,qBAAqB,KACxB,OAAO,EAAE,IAAA,uBAAc,gDAClB,qBAAqB,CAAC,OAAO,GAE7B,MAAM,CAAC,WAAW,CACnB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;;YAAC,OAAA;gBACpC,MAAM;gDAED,MAAA,qBAAqB,CAAC,OAAO,0CAAG,MAAM,CAAC,KAC1C,SAAS,EAAE;wBACT,GAAG,CACD,MAAA,MAAA,MAAA,qBAAqB,CAAC,OAAO,0CAAG,MAAM,CAAC,0CAAE,SAAS,mCAAI,EAAE,CACzD,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,eAAe,CAAC;wBACtC,eAAe;qBAChB;aAEJ,CAAA;SAAA,CAAC,CACH,KACD,CAAC,eAAe,CAAC,EAAE;gBACjB,KAAK,EAAE,IAAI;gBACX,QAAQ,EAAE,iBAAiB;gBAC3B,MAAM,EAAE;oBACN;wBACE,yBAAyB,EAAE,WAAW;qBACvC;iBACF;gBACD,OAAO,EAAE;oBACP,IAAA,0BAAiB,EAAC,iBAAiB,EAAE,0BAA0B,CAAC;iBACjE;gBACD,OAAO,EAAE;oBACP,QAAQ,EAAE;wBACR,4DAA4D,QAAQ,mBAAmB,0BAA0B,oBAAoB;qBACtI;iBACF;gBACD,SAAS,EAAE,CAAC,mBAAmB,CAAC;aACjC;YACD,2CAA2C;YAC3C,CAAC,oBAAoB,CAAC,EAAE;gBACtB,QAAQ,EAAE,iBAAiB;gBAC3B,OAAO,EAAE;oBACP,QAAQ,EAAE;wBACR,uBAAuB,gBAAgB,CAAC,IAAI,yCAAyC,qBAAqB,CAAC,IAAI,KAAK,eAAe,GAAG;qBACvI;iBACF;gBACD,UAAU,EAAE,IAAI;aACjB,IACD,IACF,CAAC;IAEH,MAAM,cAAc,GAAG,qBAAqB,CAAC,UAAU,CAAC,KAAK,CAC3D,qBAAqB,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CACtC,CAAC;IAEF,yCAAyC;IACzC,sFAAsF;IACtF,IAAA,qBAAe,EAAC,IAAI,EAAE,qBAAqB,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC;QAC9D,GAAG,QAAQ;QACX,IAAA,0BAAiB,EAAC,cAAc,EAAE,kBAAkB,CAAC;KACtD,CAAC,CAAC;IAEH,2FAA2F;IAC3F,MAAM,IAAA,mBAAsB,EAAC,IAAI,EAAE;QACjC,OAAO,EAAE,qBAAqB,CAAC,IAAI;KACpC,CAAC,CAAC;IAEH,kBAAkB;IAClB,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;QACnB,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,iCAAiC,CAAC,EAC/D,IAAA,0BAAiB,EAAC,qBAAqB,CAAC,UAAU,EAAE,OAAO,CAAC,EAC5D,EAAE,CACH,CAAC;IACJ,CAAC;IAED,oEAAoE;IACpE,IACE,CAAC,IAAI,CAAC,MAAM,CACV,IAAA,0BAAiB,EACf,qBAAqB,CAAC,UAAU,EAChC,YAAY,EACZ,yBAAyB,CAC1B,CACF,EACD,CAAC;QACD,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EACf,SAAS,EACT,+CAA+C,CAChD,EACD,IAAA,0BAAiB,EAAC,qBAAqB,CAAC,UAAU,EAAE,YAAY,CAAC,EACjE,EAAE,CACH,CAAC;IACJ,CAAC;IAED,MAAM,gBAAgB,GAAG,IAAA,mBAAW,EAAC,OAAO,CAAC,CAAC;IAE9C,uCAAuC;IACvC,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,OAAO,CAAC,EACrC,qBAAqB,CAAC,UAAU,EAChC;QACE,IAAI;QACJ,OAAO;QACP,gBAAgB;QAChB,kBAAkB;KACnB,CACF,CAAC;IAEF,4CAA4C;IAC5C,MAAM,WAAW,GAAG,IAAA,0BAAiB,EACnC,qBAAqB,CAAC,UAAU,EAChC,UAAU,CACX,CAAC;IAEF,4DAA4D;IAC5D,MAAM,sBAAsB,GAC1B,IAAA,WAAK,EACH,IAAI,EACJ,WAAW,EACX,uDAAuD,CACxD,CAAC,MAAM,GAAG,CAAC,CAAC;IAEf,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC5B,IAAA,qBAAe,EACb,IAAI,EACJ,WAAW,EACX,qBAAqB,EACrB,kCAAkC,CACnC,CAAC;QACF,IAAA,aAAO,EACL,IAAI,EACJ,WAAW,EACX,2CAA2C,EAC3C,CAAC,IAA2B,EAAE,EAAE,CAC9B,IAAA,oCAA8B,EAAC,qBAAqB,EAAE,CAAC,IAAI,CAAC,CAAC,CAChE,CAAC;IACJ,CAAC;IAED,4CAA4C;IAC5C,MAAM,YAAY,GAAG,GAAG,gBAAgB,UAAU,CAAC;IACnD,MAAM,WAAW,GACf,IAAA,WAAK,EACH,IAAI,EACJ,WAAW,EACX,mCAAmC,YAAY,IAAI,CACpD,CAAC,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,IAAA,qBAAe,EACb,IAAI,EACJ,WAAW,EACX,YAAY,EACZ,gBAAgB,YAAY,EAAE,CAC/B,CAAC;QACF,IAAA,aAAO,EACL,IAAI,EACJ,WAAW,EACX,2CAA2C,EAC3C,CAAC,IAA2B,EAAE,EAAE,CAC9B,IAAA,oCAA8B,EAAC,YAAY,EAAE,CAAC,IAAI,CAAC,CAAC,CACvD,CAAC;IACJ,CAAC;IAED,4DAA4D;IAC5D,IAAA,mCAAqB,EACnB,IAAI,EACJ,qBAAqB,CAAC,IAAI,EAC1B,oBAAoB,CAAC,IAAI,EACzB;QACE,GAAG,EAAE,oBAAoB,IAAI,GAAG;QAChC,OAAO;QACP,mFAAmF;QACnF,wDAAwD;QACxD,qFAAqF;QACrF,uFAAuF;QACvF,2BAA2B,EAAE,CAAC,eAAe,EAAE,oBAAoB,CAAC;KACrE,CACF,CAAC;IAEF,IAAA,qCAA4B,EAC1B,IAAI,EACJ,IAAA,uBAAY,EAAC;QACX,GAAI,CAAC,IAAI,KAAK,KAAK;YACjB,CAAC,CAAC;gBACE,gBAAgB;gBAChB,oBAAoB;gBACpB,kCAAkC;gBAClC,+CAA+C;gBAC/C,WAAW;aACZ;YACH,CAAC,CAAC,EAAE,CAAS;QACf,GAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAS;QAC9D,uBAAuB;QACvB,gCAAgC;KACjC,CAAC,EACF,IAAA,uBAAY,EAAC,CAAC,eAAe,CAAC,CAAC,CAChC,CAAC;AACJ,CAAC,CAAA,CAAC;AA/NW,QAAA,qBAAqB,yBA+NhC"}

package/src/utils/api-constructs/api-constructs.d.ts

@@ -5,7 +5,7 @@
 import { Tree } from '@nx/devkit';
 import { IacProvider } from '../iac';
 interface BackendOptions {
-    type: 'trpc' | 'fastapi';
+    type: 'trpc' | 'fastapi' | 'smithy';
 }
 export interface TrpcBackendOptions extends BackendOptions {
     type: 'trpc';
@@ -17,12 +17,16 @@ export interface FastApiBackendOptions extends BackendOptions {
     moduleName: string;
     dir: string;
 }
+export interface SmithyBackendOptions extends BackendOptions {
+    type: 'smithy';
+    dir: string;
+}
 export interface AddApiGatewayConstructOptions {
     apiProjectName: string;
     apiNameClassName: string;
     apiNameKebabCase: string;
     constructType: 'http' | 'rest';
-    backend: TrpcBackendOptions | FastApiBackendOptions;
+    backend: TrpcBackendOptions | FastApiBackendOptions | SmithyBackendOptions;
     auth: 'IAM' | 'Cognito' | 'None';
 }
 export declare const addApiGatewayInfra: (tree: Tree, options: AddApiGatewayConstructOptions & {

package/src/utils/api-constructs/api-constructs.js.map

@@ -1 +1 @@
-{"version":3,"file":"api-constructs.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/utils/api-constructs/api-constructs.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,uCAOoB;AACpB,gFAIwC;AACxC,gCAAuC;AA4BhC,MAAM,kBAAkB,GAAG,CAChC,IAAU,EACV,OAAqE,EACrE,EAAE;IACF,IAAI,OAAO,CAAC,WAAW,KAAK,KAAK,EAAE,CAAC;QAClC,0BAA0B,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;SAAM,IAAI,OAAO,CAAC,WAAW,KAAK,WAAW,EAAE,CAAC;QAC/C,6BAA6B,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,2BAA2B,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,IAAA,mBAAU,EACR,IAAI,EACJ,IAAA,0BAAiB,EACf,0CAAY,EACZ,OAAO,CAAC,WAAW,KAAK,KAAK;QAC3B,CAAC,CAAC,mDAAqB;QACvB,CAAC,CAAC,kDAAoB,EACxB,cAAc,CACf,EACD,CAAC,MAA4B,EAAE,EAAE;;QAC/B,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;QACtB,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YAC1B,MAAM,CAAC,OAAO,CAAC,KAAK,GAAG,EAAE,CAAC;QAC5B,CAAC;QACD,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,GAAG;YAC/B,GAAG,CAAC,MAAA,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,mCAAI,EAAE,CAAC;YACzC,GAAG,OAAO,CAAC,cAAc,QAAQ;SAClC,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;AAnCW,QAAA,kBAAkB,sBAmC7B;AAEF;;GAEG;AACH,MAAM,0BAA0B,GAAG,CACjC,IAAU,EACV,OAAsC,EACtC,EAAE;IACF,MAAM,mBAAmB,GAAG,CAAC,IAAY,EAAE,EAAE;QAC3C,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,EACjE,IAAA,0BAAiB,EACf,0CAAY,EACZ,mDAAqB,EACrB,KAAK,EACL,MAAM,EACN,KAAK,CACN,EACD,EAAE,EACF;YACE,iBAAiB,EAAE,0BAAiB,CAAC,YAAY;SAClD,CACF,CAAC;IACJ,CAAC,CAAC;IAEF,qDAAqD;IACrD,mBAAmB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IAC3C,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAC7B,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QACpC,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;IAED,sCAAsC;IACtC,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EACf,SAAS,EACT,OAAO,EACP,KAAK,EACL,KAAK,EACL,MAAM,EACN,OAAO,CAAC,aAAa,CACtB,EACD,IAAA,0BAAiB,EACf,0CAAY,EACZ,mDAAqB,EACrB,KAAK,EACL,KAAK,EACL,MAAM,CACP,EACD,OAAO,EACP;QACE,iBAAiB,EAAE,0BAAiB,CAAC,YAAY;KAClD,CACF,CAAC;IAEF,oCAAoC;IACpC,IAAA,mBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EACf,0CAAY,EACZ,mDAAqB,EACrB,KAAK,EACL,KAAK,EACL,MAAM,EACN,UAAU,CACX,EACD,KAAK,OAAO,CAAC,gBAAgB,KAAK,CACnC,CAAC;IACF,IAAA,mBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EACf,0CAAY,EACZ,mDAAqB,EACrB,KAAK,EACL,KAAK,EACL,UAAU,CACX,EACD,iBAAiB,CAClB,CAAC;AACJ,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,6BAA6B,GAAG,CACpC,IAAU,EACV,OAAsC,EACtC,EAAE;IACF,iCAAiC;IACjC,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EACf,SAAS,EACT,OAAO,EACP,WAAW,EACX,MAAM,EACN,KAAK,EACL,OAAO,CAAC,aAAa,CACtB,EACD,IAAA,0BAAiB,EAAC,0CAAY,EAAE,kDAAoB,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAC3E,EAAE,EACF;QACE,iBAAiB,EAAE,0BAAiB,CAAC,YAAY;KAClD,CACF,CAAC;IAEF,yCAAyC;IACzC,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EACf,SAAS,EACT,OAAO,EACP,WAAW,EACX,KAAK,EACL,MAAM,EACN,OAAO,CAAC,aAAa,CACtB,EACD,IAAA,0BAAiB,EAAC,0CAAY,EAAE,kDAAoB,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,EAC3E,OAAO,EACP;QACE,iBAAiB,EAAE,0BAAiB,CAAC,YAAY;KAClD,CACF,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"api-constructs.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/utils/api-constructs/api-constructs.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,uCAOoB;AACpB,gFAIwC;AACxC,gCAAuC;AAiChC,MAAM,kBAAkB,GAAG,CAChC,IAAU,EACV,OAAqE,EACrE,EAAE;IACF,IAAI,OAAO,CAAC,WAAW,KAAK,KAAK,EAAE,CAAC;QAClC,0BAA0B,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;SAAM,IAAI,OAAO,CAAC,WAAW,KAAK,WAAW,EAAE,CAAC;QAC/C,6BAA6B,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,2BAA2B,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,IAAA,mBAAU,EACR,IAAI,EACJ,IAAA,0BAAiB,EACf,0CAAY,EACZ,OAAO,CAAC,WAAW,KAAK,KAAK;QAC3B,CAAC,CAAC,mDAAqB;QACvB,CAAC,CAAC,kDAAoB,EACxB,cAAc,CACf,EACD,CAAC,MAA4B,EAAE,EAAE;;QAC/B,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;QACtB,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YAC1B,MAAM,CAAC,OAAO,CAAC,KAAK,GAAG,EAAE,CAAC;QAC5B,CAAC;QACD,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,GAAG;YAC/B,GAAG,CAAC,MAAA,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,mCAAI,EAAE,CAAC;YACzC,GAAG,OAAO,CAAC,cAAc,QAAQ;SAClC,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;AAnCW,QAAA,kBAAkB,sBAmC7B;AAEF;;GAEG;AACH,MAAM,0BAA0B,GAAG,CACjC,IAAU,EACV,OAAsC,EACtC,EAAE;IACF,MAAM,mBAAmB,GAAG,CAAC,IAAY,EAAE,EAAE;QAC3C,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,EACjE,IAAA,0BAAiB,EACf,0CAAY,EACZ,mDAAqB,EACrB,KAAK,EACL,MAAM,EACN,KAAK,CACN,EACD,EAAE,EACF;YACE,iBAAiB,EAAE,0BAAiB,CAAC,YAAY;SAClD,CACF,CAAC;IACJ,CAAC,CAAC;IAEF,qDAAqD;IACrD,mBAAmB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IAC3C,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAC7B,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QACpC,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;IAED,sCAAsC;IACtC,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EACf,SAAS,EACT,OAAO,EACP,KAAK,EACL,KAAK,EACL,MAAM,EACN,OAAO,CAAC,aAAa,CACtB,EACD,IAAA,0BAAiB,EACf,0CAAY,EACZ,mDAAqB,EACrB,KAAK,EACL,KAAK,EACL,MAAM,CACP,EACD,OAAO,EACP;QACE,iBAAiB,EAAE,0BAAiB,CAAC,YAAY;KAClD,CACF,CAAC;IAEF,oCAAoC;IACpC,IAAA,mBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EACf,0CAAY,EACZ,mDAAqB,EACrB,KAAK,EACL,KAAK,EACL,MAAM,EACN,UAAU,CACX,EACD,KAAK,OAAO,CAAC,gBAAgB,KAAK,CACnC,CAAC;IACF,IAAA,mBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EACf,0CAAY,EACZ,mDAAqB,EACrB,KAAK,EACL,KAAK,EACL,UAAU,CACX,EACD,iBAAiB,CAClB,CAAC;AACJ,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,6BAA6B,GAAG,CACpC,IAAU,EACV,OAAsC,EACtC,EAAE;IACF,iCAAiC;IACjC,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EACf,SAAS,EACT,OAAO,EACP,WAAW,EACX,MAAM,EACN,KAAK,EACL,OAAO,CAAC,aAAa,CACtB,EACD,IAAA,0BAAiB,EAAC,0CAAY,EAAE,kDAAoB,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAC3E,EAAE,EACF;QACE,iBAAiB,EAAE,0BAAiB,CAAC,YAAY;KAClD,CACF,CAAC;IAEF,yCAAyC;IACzC,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EACf,SAAS,EACT,OAAO,EACP,WAAW,EACX,KAAK,EACL,MAAM,EACN,OAAO,CAAC,aAAa,CACtB,EACD,IAAA,0BAAiB,EAAC,0CAAY,EAAE,kDAAoB,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,EAC3E,OAAO,EACP;QACE,iBAAiB,EAAE,0BAAiB,CAAC,YAAY;KAClD,CACF,CAAC;AACJ,CAAC,CAAC"}

package/src/utils/api-constructs/files/cdk/app/apis/http/__apiNameKebabCase__.ts.template

@@ -41,7 +41,7 @@ import { AppRouter, appRouter } from '<%= backend.projectAlias %>';
 
 // String union type for all API operation names
 type Operations = Procedures<AppRouter>;
-<%_ } else if (backend.type === 'fastapi') { _%>
+<%_ } else { _%>
 import {
   OPERATION_DETAILS,
   Operations,
@@ -90,11 +90,11 @@ export class <%= apiNameClassName %><
     return IntegrationBuilder.http({
       <%_ if (backend.type === 'trpc') { _%>
       operations: routerToOperations(appRouter),
-      <%_ } else if (backend.type === 'fastapi') { _%>
+      <%_ } else { _%>
       operations: OPERATION_DETAILS,
       <%_ } _%>
       defaultIntegrationOptions: {
-        <%_ if (backend.type === 'trpc') { _%>
+        <%_ if (['trpc', 'smithy'].includes(backend.type)) { _%>
         runtime: Runtime.NODEJS_LATEST,
         handler: 'index.handler',
         code: Code.fromAsset(
@@ -162,7 +162,7 @@ export class <%= apiNameClassName %><
       <%_ } _%>
       <%_ if (backend.type === 'trpc') { _%>
       operations: routerToOperations(appRouter),
-      <%_ } else if (backend.type === 'fastapi') { _%>
+      <%_ } else { _%>
       operations: OPERATION_DETAILS,
       <%_ } _%>
       ...props,

package/src/utils/api-constructs/files/cdk/app/apis/rest/__apiNameKebabCase__.ts.template

@@ -46,7 +46,7 @@ import { AppRouter, appRouter } from '<%= backend.projectAlias %>';
 
 // String union type for all API operation names
 type Operations = Procedures<AppRouter>;
-<%_ } else if (backend.type === 'fastapi') { _%>
+<%_ } else { _%>
 import {
   OPERATION_DETAILS,
   Operations,
@@ -94,11 +94,11 @@ export class <%= apiNameClassName %><
     return IntegrationBuilder.rest({
       <%_ if (backend.type === 'trpc') { _%>
       operations: routerToOperations(appRouter),
-      <%_ } else if (backend.type === 'fastapi') { _%>
+      <%_ } else { _%>
       operations: OPERATION_DETAILS,
       <%_ } _%>
       defaultIntegrationOptions: {
-        <%_ if (backend.type === 'trpc') { _%>
+        <%_ if (['trpc', 'smithy'].includes(backend.type)) { _%>
         runtime: Runtime.NODEJS_LATEST,
         handler: 'index.handler',
         code: Code.fromAsset(
@@ -157,6 +157,9 @@ export class <%= apiNameClassName %><
         allowOrigins: Cors.ALL_ORIGINS,
         allowMethods: Cors.ALL_METHODS,
       },
+      deployOptions: {
+        tracingEnabled: true,
+      },
       policy: new PolicyDocument({
         statements: [
           <%_ if (auth === 'IAM') { _%>
@@ -189,7 +192,7 @@ export class <%= apiNameClassName %><
       }),
       <%_ if (backend.type === 'trpc') { _%>
       operations: routerToOperations(appRouter),
-      <%_ } else if (backend.type === 'fastapi') { _%>
+      <%_ } else { _%>
       operations: OPERATION_DETAILS,
       <%_ } _%>
       ...props,

package/src/utils/api-constructs/files/cdk/core/api/http/http-api.ts.template

@@ -6,7 +6,11 @@ import {
   HttpApi as _HttpApi,
   HttpApiProps as _HttpApiProps,
   HttpMethod,
+  HttpStage,
+  LogGroupLogDestination,
 } from 'aws-cdk-lib/aws-apigatewayv2';
+import { LogGroup } from 'aws-cdk-lib/aws-logs';
+import { suppressRules } from '../checkov.js';
 
 /**
  * Properties for creating an HttpApi construct.
@@ -50,6 +54,9 @@ export class HttpApi<
   /** The underlying CDK HttpApi instance */
   public readonly api: _HttpApi;
 
+  /** Default auto-deployed stage */
+  public readonly defaultStage: HttpStage;
+
   /** Map of operation names to their API Gateway integrations */
   public readonly integrations: TIntegrations;
 
@@ -68,9 +75,30 @@ export class HttpApi<
 
     // Create the API Gateway REST API
     this.api = new _HttpApi(this, 'Api', {
+      createDefaultStage: false,
       ...props,
     });
 
+    const accessLogGroup = new LogGroup(this, 'AccessLogs');
+    suppressRules(
+      accessLogGroup,
+      ['CKV_AWS_158'],
+      'Using default CloudWatch log encryption',
+    );
+    suppressRules(
+      accessLogGroup,
+      ['CKV_AWS_66', 'CKV_AWS_338'],
+      'Logs are retained forever',
+    );
+
+    this.defaultStage = new HttpStage(this, 'DefaultStage', {
+      httpApi: this.api,
+      autoDeploy: true,
+      accessLogSettings: {
+        destination: new LogGroupLogDestination(accessLogGroup),
+      },
+    });
+
     // Create API resources and methods for each operation
     (Object.entries(operations) as [TOperation, OperationDetails][]).map(
       ([op, details]) => {
@@ -86,13 +114,20 @@ export class HttpApi<
     );
 
     new CfnOutput(this, `${apiName}Url`, {
-      value: this.api.url!,
+      value: this.defaultStage.url!,
     });
 
     // Register the API URL in runtime configuration for client discovery
     RuntimeConfig.ensure(this).config.apis = {
       ...RuntimeConfig.ensure(this).config.apis!,
-      [apiName]: this.api.url!,
+      [apiName]: this.defaultStage.url!,
     };
   }
+
+  /**
+   * Return the API url
+   */
+  public get url() {
+    return this.defaultStage.url;
+  }
 }

package/src/utils/api-constructs/files/cdk/core/api/rest/rest-api.ts.template

@@ -3,9 +3,11 @@ import {
   RestApi as _RestApi,
   RestApiProps as _RestApiProps,
   IResource,
+  Stage,
 } from 'aws-cdk-lib/aws-apigateway';
 import { RuntimeConfig } from '../runtime-config.js';
 import { OperationDetails, RestApiIntegration } from './utils.js';
+import { suppressRules } from '../checkov.js';
 
 /**
  * Properties for creating a RestApi construct.
@@ -68,6 +70,19 @@ export class RestApi<
     // Create the API Gateway REST API
     this.api = new _RestApi(this, 'Api', props);
 
+    suppressRules(
+      this.api,
+      ['CKV_AWS_120'],
+      'Caching not required for this use case',
+      (c) => c instanceof Stage,
+    );
+    suppressRules(
+      this.api,
+      ['CKV_AWS_76'],
+      'API Gateway access logging disabled due to account-level CloudWatch Logs role ARN requirement',
+      (c) => c instanceof Stage,
+    );
+
     // Create API resources and methods for each operation
     (Object.entries(operations) as [TOperation, OperationDetails][]).map(
       ([op, details]) => {

package/src/utils/api-constructs/files/terraform/app/apis/http/__apiNameKebabCase__/__apiNameKebabCase__.tf.template

@@ -128,7 +128,7 @@ resource "aws_lambda_function" "api_lambda" {
   filename         = data.archive_file.lambda_zip.output_path
   function_name    = "<%- apiNameClassName %>Handler"
   role            = aws_iam_role.lambda_execution_role.arn
-  <%_ if (backend.type === 'trpc') { _%>
+  <%_ if (['trpc', 'smithy'].includes(backend.type)) { _%>
   handler         = "index.handler"
   runtime         = "nodejs22.x"
   <%_ } else if (backend.type === 'fastapi') { _%>

package/src/utils/api-constructs/files/terraform/app/apis/rest/__apiNameKebabCase__/__apiNameKebabCase__.tf.template

@@ -106,7 +106,7 @@ resource "aws_lambda_function" "api_lambda" {
   filename         = data.archive_file.lambda_zip.output_path
   function_name    = "<%- apiNameClassName %>Handler"
   role            = aws_iam_role.lambda_execution_role.arn
-  <%_ if (backend.type === 'trpc') { _%>
+  <%_ if (['trpc', 'smithy'].includes(backend.type)) { _%>
   handler         = "index.handler"
   runtime         = "nodejs22.x"
   <%_ } else if (backend.type === 'fastapi') { _%>

package/src/utils/api-constructs/open-api-metadata.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Tree } from '@nx/devkit';
+import { IacProvider } from '../iac';
+export interface AddOpenApiMetadataGenerateTargetOptions {
+    iacProvider: IacProvider;
+    apiNameKebabCase: string;
+    specPath: string;
+    specBuildTargetName: string;
+}
+/**
+ * Adds a generate:<api-name>-metadata target to shared constructs (CDK only)
+ * This allows for API CDK constructs to have type-safety for integrations based on an OpenAPI Specification
+ */
+export declare const addSharedConstructsOpenApiMetadataGenerateTarget: (tree: Tree, { iacProvider, apiNameKebabCase, specPath, specBuildTargetName, }: AddOpenApiMetadataGenerateTargetOptions) => void;

package/src/utils/api-constructs/open-api-metadata.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addSharedConstructsOpenApiMetadataGenerateTarget = void 0;
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+const devkit_1 = require("@nx/devkit");
+const git_1 = require("../git");
+const shared_constructs_constants_1 = require("../shared-constructs-constants");
+/**
+ * Adds a generate:<api-name>-metadata target to shared constructs (CDK only)
+ * This allows for API CDK constructs to have type-safety for integrations based on an OpenAPI Specification
+ */
+const addSharedConstructsOpenApiMetadataGenerateTarget = (tree, { iacProvider, apiNameKebabCase, specPath, specBuildTargetName, }) => {
+    if (iacProvider !== 'CDK') {
+        // For Terraform, we do not support type-safe integration builders, rather only the single lambda
+        // router pattern, and therefore do not need to add depenencies on metadata generation.
+        return;
+    }
+    const generatedMetadataDir = (0, devkit_1.joinPathFragments)('generated', apiNameKebabCase);
+    const generatedMetadataDirFromRoot = (0, devkit_1.joinPathFragments)((0, devkit_1.joinPathFragments)(shared_constructs_constants_1.PACKAGES_DIR, shared_constructs_constants_1.SHARED_CONSTRUCTS_DIR), 'src', generatedMetadataDir);
+    (0, devkit_1.updateJson)(tree, (0, devkit_1.joinPathFragments)(shared_constructs_constants_1.PACKAGES_DIR, shared_constructs_constants_1.SHARED_CONSTRUCTS_DIR, 'project.json'), (config) => {
+        var _a;
+        if (!config.targets) {
+            config.targets = {};
+        }
+        if (!config.targets.build) {
+            config.targets.build = {};
+        }
+        // If not already defined, add a target to generate metadata from the OpenAPI spec, used
+        // for providing a type-safe CDK construct
+        const metadataTargetName = `generate:${apiNameKebabCase}-metadata`;
+        if (!config.targets[metadataTargetName]) {
+            config.targets[metadataTargetName] = {
+                cache: true,
+                executor: 'nx:run-commands',
+                inputs: [
+                    {
+                        dependentTasksOutputFiles: '**/*.json',
+                    },
+                ],
+                outputs: [
+                    (0, devkit_1.joinPathFragments)('{workspaceRoot}', generatedMetadataDirFromRoot),
+                ],
+                options: {
+                    commands: [
+                        `nx g @aws/nx-plugin:open-api#ts-metadata --openApiSpecPath="${specPath}" --outputPath="${generatedMetadataDirFromRoot}" --no-interactive`,
+                    ],
+                },
+                dependsOn: [specBuildTargetName],
+            };
+        }
+        if (!config.targets.compile) {
+            config.targets.compile = {};
+        }
+        config.targets.compile.dependsOn = [
+            ...((_a = config.targets.compile.dependsOn) !== null && _a !== void 0 ? _a : []),
+            metadataTargetName,
+        ];
+        return config;
+    });
+    // Ignore the generated metadata by default
+    // Users can safely remove the entry from the .gitignore if they prefer to check it in
+    (0, git_1.updateGitIgnore)(tree, (0, devkit_1.joinPathFragments)(shared_constructs_constants_1.PACKAGES_DIR, shared_constructs_constants_1.SHARED_CONSTRUCTS_DIR), (patterns) => [...patterns, (0, devkit_1.joinPathFragments)('src', generatedMetadataDir)]);
+};
+exports.addSharedConstructsOpenApiMetadataGenerateTarget = addSharedConstructsOpenApiMetadataGenerateTarget;
+//# sourceMappingURL=open-api-metadata.js.map

package/src/utils/api-constructs/open-api-metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"open-api-metadata.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/utils/api-constructs/open-api-metadata.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,uCAKoB;AAEpB,gCAAyC;AACzC,gFAGwC;AASxC;;;GAGG;AACI,MAAM,gDAAgD,GAAG,CAC9D,IAAU,EACV,EACE,WAAW,EACX,gBAAgB,EAChB,QAAQ,EACR,mBAAmB,GACqB,EAC1C,EAAE;IACF,IAAI,WAAW,KAAK,KAAK,EAAE,CAAC;QAC1B,iGAAiG;QACjG,uFAAuF;QACvF,OAAO;IACT,CAAC;IAED,MAAM,oBAAoB,GAAG,IAAA,0BAAiB,EAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC;IAC9E,MAAM,4BAA4B,GAAG,IAAA,0BAAiB,EACpD,IAAA,0BAAiB,EAAC,0CAAY,EAAE,mDAAqB,CAAC,EACtD,KAAK,EACL,oBAAoB,CACrB,CAAC;IAEF,IAAA,mBAAU,EACR,IAAI,EACJ,IAAA,0BAAiB,EAAC,0CAAY,EAAE,mDAAqB,EAAE,cAAc,CAAC,EACtE,CAAC,MAA4B,EAAE,EAAE;;QAC/B,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;QACtB,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YAC1B,MAAM,CAAC,OAAO,CAAC,KAAK,GAAG,EAAE,CAAC;QAC5B,CAAC;QACD,wFAAwF;QACxF,0CAA0C;QAC1C,MAAM,kBAAkB,GAAG,YAAY,gBAAgB,WAAW,CAAC;QACnE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACxC,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,GAAG;gBACnC,KAAK,EAAE,IAAI;gBACX,QAAQ,EAAE,iBAAiB;gBAC3B,MAAM,EAAE;oBACN;wBACE,yBAAyB,EAAE,WAAW;qBACvC;iBACF;gBACD,OAAO,EAAE;oBACP,IAAA,0BAAiB,EAAC,iBAAiB,EAAE,4BAA4B,CAAC;iBACnE;gBACD,OAAO,EAAE;oBACP,QAAQ,EAAE;wBACR,+DAA+D,QAAQ,mBAAmB,4BAA4B,oBAAoB;qBAC3I;iBACF;gBACD,SAAS,EAAE,CAAC,mBAAmB,CAAC;aACjC,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YAC5B,MAAM,CAAC,OAAO,CAAC,OAAO,GAAG,EAAE,CAAC;QAC9B,CAAC;QACD,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,GAAG;YACjC,GAAG,CAAC,MAAA,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,mCAAI,EAAE,CAAC;YAC3C,kBAAkB;SACnB,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC,CACF,CAAC;IAEF,2CAA2C;IAC3C,sFAAsF;IACtF,IAAA,qBAAe,EACb,IAAI,EACJ,IAAA,0BAAiB,EAAC,0CAAY,EAAE,mDAAqB,CAAC,EACtD,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,GAAG,QAAQ,EAAE,IAAA,0BAAiB,EAAC,KAAK,EAAE,oBAAoB,CAAC,CAAC,CAC5E,CAAC;AACJ,CAAC,CAAC;AAzEW,QAAA,gDAAgD,oDAyE3D"}