@aws/nx-plugin 1.0.15 → 1.1.0

package/src/utils/guardrail-constructs/guardrail-wiring.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Iac } from '../iac.js';
+export interface GuardrailWiringOptions {
+    iac: Iac;
+    /** Class name of the guarded agent, eg `MyAgent`. */
+    nameClassName: string;
+    /** Kebab-case name of the guarded agent, eg `my-agent`. */
+    nameKebabCase: string;
+    /** npm scope of the workspace without the `@`, eg `my-scope`. */
+    npmScope: string;
+}
+/** The ts#agent guide section that shows how to deploy the agent's Terraform module. */
+export declare const TS_AGENT_TERRAFORM_DEPLOY_GUIDE_URL = "https://awslabs.github.io/nx-plugin-for-aws/en/guides/ts-agent/#infrastructure-as-code";
+/**
+ * The code a user adds to their CDK stack to guard the agent.
+ * The guide shows the same code for `my-agent` in scope `my-scope`, which
+ * generator.spec.ts checks.
+ */
+export declare const cdkGuardrailWiring: ({ nameClassName, npmScope, }: Pick<GuardrailWiringOptions, "nameClassName" | "npmScope">) => string;
+/**
+ * The code a user adds to their root Terraform module to grant the agent the
+ * guardrail and deploy its runtime-config entry, relative to
+ * `packages/infra/src`. The guide shows the same code for `my-agent`, which
+ * generator.spec.ts checks.
+ */
+export declare const terraformGuardrailWiring: ({ nameKebabCase, }: Pick<GuardrailWiringOptions, "nameKebabCase">) => string;
+/**
+ * The message the generator prints after it adds the guardrail
+ * infrastructure. The generator does not edit the user's stack or root
+ * module, so this tells the user what to add there.
+ */
+export declare const guardrailWiringMessage: (options: GuardrailWiringOptions) => string;

package/src/utils/guardrail-constructs/guardrail-wiring.js

@@ -0,0 +1,61 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */ import { snakeCase } from "../names.js";
+import { SHARED_CONSTRUCTS_NAME } from "../shared-constructs-constants.js";
+/** The ts#agent guide section that shows how to deploy the agent's Terraform module. */ export const TS_AGENT_TERRAFORM_DEPLOY_GUIDE_URL = 'https://awslabs.github.io/nx-plugin-for-aws/en/guides/ts-agent/#infrastructure-as-code';
+/**
+ * The code a user adds to their CDK stack to guard the agent.
+ * The guide shows the same code for `my-agent` in scope `my-scope`, which
+ * generator.spec.ts checks.
+ */ export const cdkGuardrailWiring = ({ nameClassName, npmScope })=>`import { ${nameClassName}, ${nameClassName}Guardrail } from '@${npmScope}/${SHARED_CONSTRUCTS_NAME}';
+
+const agent = new ${nameClassName}(this, '${nameClassName}');
+new ${nameClassName}Guardrail(this, '${nameClassName}Guardrail', { agent });`;
+/**
+ * The code a user adds to their root Terraform module to grant the agent the
+ * guardrail and deploy its runtime-config entry, relative to
+ * `packages/infra/src`. The guide shows the same code for `my-agent`, which
+ * generator.spec.ts checks.
+ */ export const terraformGuardrailWiring = ({ nameKebabCase })=>{
+    const agentModule = snakeCase(nameKebabCase);
+    const guardrailModule = `${agentModule}_guardrail`;
+    return `module "${guardrailModule}" {
+  source = "../../common/terraform/src/app/guardrails/${nameKebabCase}"
+}
+
+module "${agentModule}" {
+  source = "../../common/terraform/src/app/agents/${nameKebabCase}"
+  # ...existing arguments...
+  additional_iam_policy_statements = module.${guardrailModule}.iam_policy_statements
+}
+
+module "runtime_config_appconfig_deployment" {
+  # ...existing arguments...
+  depends_on = [
+    # ...existing modules...
+    module.${guardrailModule},
+  ]
+}`;
+};
+/**
+ * How to add the printed Terraform code. `ts#agent` does not add the agent to
+ * the root module, so its `module` block may not exist yet.
+ */ const terraformSteps = (nameKebabCase)=>{
+    const agentModule = snakeCase(nameKebabCase);
+    return `Add the module "${agentModule}_guardrail" block as printed below. Add its additional_iam_policy_statements line to your existing module "${agentModule}" block, and add module.${agentModule}_guardrail to the depends_on list of your runtime_config_appconfig_deployment module. If your root module does not deploy the agent yet, add the agent's module first, as described in ${TS_AGENT_TERRAFORM_DEPLOY_GUIDE_URL}.`;
+};
+/**
+ * The message the generator prints after it adds the guardrail
+ * infrastructure. The generator does not edit the user's stack or root
+ * module, so this tells the user what to add there.
+ */ export const guardrailWiringMessage = (options)=>{
+    const missing = `Until you add it, the deployed agent fails on its first request, because runtime config has no guardrail at agentcore.guardrails.${options.nameClassName}.`;
+    return options.iac === 'cdk' ? `Add the guardrail to your agent in your stack, for example packages/infra/src/stacks/application-stack.ts. ${missing}
+
+${cdkGuardrailWiring(options)}` : `Add the guardrail to your agent in the root Terraform module where you deploy the agent, for example packages/infra/src/main.tf. ${missing} ${terraformSteps(options.nameKebabCase)}
+
+${terraformGuardrailWiring(options)}`;
+};
+
+//# sourceMappingURL=guardrail-wiring.js.map

package/src/utils/guardrail-constructs/guardrail-wiring.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../packages/nx-plugin/src/utils/guardrail-constructs/guardrail-wiring.ts"],"sourcesContent":["/**\n * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n * SPDX-License-Identifier: Apache-2.0\n */\nimport type { Iac } from '../iac.js';\nimport { snakeCase } from '../names.js';\nimport { SHARED_CONSTRUCTS_NAME } from '../shared-constructs-constants.js';\n\nexport interface GuardrailWiringOptions {\n  iac: Iac;\n  /** Class name of the guarded agent, eg `MyAgent`. */\n  nameClassName: string;\n  /** Kebab-case name of the guarded agent, eg `my-agent`. */\n  nameKebabCase: string;\n  /** npm scope of the workspace without the `@`, eg `my-scope`. */\n  npmScope: string;\n}\n\n/** The ts#agent guide section that shows how to deploy the agent's Terraform module. */\nexport const TS_AGENT_TERRAFORM_DEPLOY_GUIDE_URL =\n  'https://awslabs.github.io/nx-plugin-for-aws/en/guides/ts-agent/#infrastructure-as-code';\n\n/**\n * The code a user adds to their CDK stack to guard the agent.\n * The guide shows the same code for `my-agent` in scope `my-scope`, which\n * generator.spec.ts checks.\n */\nexport const cdkGuardrailWiring = ({\n  nameClassName,\n  npmScope,\n}: Pick<GuardrailWiringOptions, 'nameClassName' | 'npmScope'>): string =>\n  `import { ${nameClassName}, ${nameClassName}Guardrail } from '@${npmScope}/${SHARED_CONSTRUCTS_NAME}';\n\nconst agent = new ${nameClassName}(this, '${nameClassName}');\nnew ${nameClassName}Guardrail(this, '${nameClassName}Guardrail', { agent });`;\n\n/**\n * The code a user adds to their root Terraform module to grant the agent the\n * guardrail and deploy its runtime-config entry, relative to\n * `packages/infra/src`. The guide shows the same code for `my-agent`, which\n * generator.spec.ts checks.\n */\nexport const terraformGuardrailWiring = ({\n  nameKebabCase,\n}: Pick<GuardrailWiringOptions, 'nameKebabCase'>): string => {\n  const agentModule = snakeCase(nameKebabCase);\n  const guardrailModule = `${agentModule}_guardrail`;\n  return `module \"${guardrailModule}\" {\n  source = \"../../common/terraform/src/app/guardrails/${nameKebabCase}\"\n}\n\nmodule \"${agentModule}\" {\n  source = \"../../common/terraform/src/app/agents/${nameKebabCase}\"\n  # ...existing arguments...\n  additional_iam_policy_statements = module.${guardrailModule}.iam_policy_statements\n}\n\nmodule \"runtime_config_appconfig_deployment\" {\n  # ...existing arguments...\n  depends_on = [\n    # ...existing modules...\n    module.${guardrailModule},\n  ]\n}`;\n};\n\n/**\n * How to add the printed Terraform code. `ts#agent` does not add the agent to\n * the root module, so its `module` block may not exist yet.\n */\nconst terraformSteps = (nameKebabCase: string): string => {\n  const agentModule = snakeCase(nameKebabCase);\n  return `Add the module \"${agentModule}_guardrail\" block as printed below. Add its additional_iam_policy_statements line to your existing module \"${agentModule}\" block, and add module.${agentModule}_guardrail to the depends_on list of your runtime_config_appconfig_deployment module. If your root module does not deploy the agent yet, add the agent's module first, as described in ${TS_AGENT_TERRAFORM_DEPLOY_GUIDE_URL}.`;\n};\n\n/**\n * The message the generator prints after it adds the guardrail\n * infrastructure. The generator does not edit the user's stack or root\n * module, so this tells the user what to add there.\n */\nexport const guardrailWiringMessage = (\n  options: GuardrailWiringOptions,\n): string => {\n  const missing = `Until you add it, the deployed agent fails on its first request, because runtime config has no guardrail at agentcore.guardrails.${options.nameClassName}.`;\n  return options.iac === 'cdk'\n    ? `Add the guardrail to your agent in your stack, for example packages/infra/src/stacks/application-stack.ts. ${missing}\n\n${cdkGuardrailWiring(options)}`\n    : `Add the guardrail to your agent in the root Terraform module where you deploy the agent, for example packages/infra/src/main.tf. ${missing} ${terraformSteps(options.nameKebabCase)}\n\n${terraformGuardrailWiring(options)}`;\n};\n"],"names":["snakeCase","SHARED_CONSTRUCTS_NAME","TS_AGENT_TERRAFORM_DEPLOY_GUIDE_URL","cdkGuardrailWiring","nameClassName","npmScope","terraformGuardrailWiring","nameKebabCase","agentModule","guardrailModule","terraformSteps","guardrailWiringMessage","options","missing","iac"],"mappings":"AAAA;;;CAGC,GAED,SAASA,SAAS,QAAQ,cAAc;AACxC,SAASC,sBAAsB,QAAQ,oCAAoC;AAY3E,sFAAsF,GACtF,OAAO,MAAMC,sCACX,yFAAyF;AAE3F;;;;CAIC,GACD,OAAO,MAAMC,qBAAqB,CAAC,EACjCC,aAAa,EACbC,QAAQ,EACmD,GAC3D,CAAC,SAAS,EAAED,cAAc,EAAE,EAAEA,cAAc,mBAAmB,EAAEC,SAAS,CAAC,EAAEJ,uBAAuB;;kBAEpF,EAAEG,cAAc,QAAQ,EAAEA,cAAc;IACtD,EAAEA,cAAc,iBAAiB,EAAEA,cAAc,uBAAuB,CAAC,CAAC;AAE9E;;;;;CAKC,GACD,OAAO,MAAME,2BAA2B,CAAC,EACvCC,aAAa,EACiC;IAC9C,MAAMC,cAAcR,UAAUO;IAC9B,MAAME,kBAAkB,GAAGD,YAAY,UAAU,CAAC;IAClD,OAAO,CAAC,QAAQ,EAAEC,gBAAgB;sDACkB,EAAEF,cAAc;;;QAG9D,EAAEC,YAAY;kDAC4B,EAAED,cAAc;;4CAEtB,EAAEE,gBAAgB;;;;;;;WAOnD,EAAEA,gBAAgB;;CAE5B,CAAC;AACF,EAAE;AAEF;;;CAGC,GACD,MAAMC,iBAAiB,CAACH;IACtB,MAAMC,cAAcR,UAAUO;IAC9B,OAAO,CAAC,gBAAgB,EAAEC,YAAY,2GAA2G,EAAEA,YAAY,wBAAwB,EAAEA,YAAY,uLAAuL,EAAEN,oCAAoC,CAAC,CAAC;AACta;AAEA;;;;CAIC,GACD,OAAO,MAAMS,yBAAyB,CACpCC;IAEA,MAAMC,UAAU,CAAC,iIAAiI,EAAED,QAAQR,aAAa,CAAC,CAAC,CAAC;IAC5K,OAAOQ,QAAQE,GAAG,KAAK,QACnB,CAAC,2GAA2G,EAAED,QAAQ;;AAE5H,EAAEV,mBAAmBS,UAAU,GACzB,CAAC,iIAAiI,EAAEC,QAAQ,CAAC,EAAEH,eAAeE,QAAQL,aAAa,EAAE;;AAE3L,EAAED,yBAAyBM,UAAU;AACrC,EAAE"}