@aws/nx-plugin-mcp 0.120.0 → 1.0.0-rc.0

package/src/py/api/schema.json

@@ -0,0 +1,100 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "$id": "py#api",
+  "title": "py#api",
+  "description": "Create a Python API",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Name of the API project to generate",
+      "x-priority": "important",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like your API to have? i.e: MyApi"
+    },
+    "framework": {
+      "type": "string",
+      "description": "The API framework to use.",
+      "default": "fastapi",
+      "enum": ["fastapi"],
+      "x-prompt": {
+        "message": "Which API framework would you like to use?",
+        "type": "list",
+        "items": [
+          {
+            "value": "fastapi",
+            "label": "FastAPI (modern Python web framework)"
+          }
+        ],
+        "default": "fastapi"
+      },
+      "x-priority": "important"
+    },
+    "computeType": {
+      "type": "string",
+      "description": "The type of compute to use to deploy this API. Choose between ServerlessApiGatewayRestApi (default) or ServerlessApiGatewayHttpApi.",
+      "default": "ServerlessApiGatewayRestApi",
+      "enum": ["ServerlessApiGatewayRestApi", "ServerlessApiGatewayHttpApi"],
+      "x-prompt": "What compute type would you like to deploy your API with?",
+      "x-priority": "important"
+    },
+    "integrationPattern": {
+      "type": "string",
+      "description": "How API Gateway integrations are generated for the API. Choose between isolated (default) and shared.",
+      "default": "isolated",
+      "enum": ["isolated", "shared"],
+      "x-priority": "important",
+      "x-prompt": {
+        "message": "How would you like to map integrations to your API operations?",
+        "type": "list",
+        "items": [
+          {
+            "value": "isolated",
+            "label": "isolated (one integration per operation)"
+          },
+          {
+            "value": "shared",
+            "label": "shared (single default integration with optional overrides)"
+          }
+        ],
+        "default": "isolated"
+      }
+    },
+    "auth": {
+      "type": "string",
+      "description": "The method used to authenticate with your API. Choose between IAM (default), Cognito or Custom.",
+      "default": "IAM",
+      "enum": ["IAM", "Cognito", "Custom"],
+      "x-prompt": "How would you like users to authenticate with your API?",
+      "x-priority": "important"
+    },
+    "directory": {
+      "type": "string",
+      "description": "The directory to store the application in.",
+      "default": "packages",
+      "x-prompt": "Which directory do you want to create the project in?",
+      "x-priority": "important"
+    },
+    "subDirectory": {
+      "type": "string",
+      "description": "The sub directory the project is placed in. By default this is the project name.",
+      "x-prompt": "Which sub directory do you want to create the project in? (By default this is the project name)"
+    },
+    "iacProvider": {
+      "type": "string",
+      "description": "The preferred IaC provider. By default this is inherited from your initial selection.",
+      "enum": ["Inherit", "CDK", "Terraform"],
+      "x-priority": "important",
+      "default": "Inherit",
+      "x-prompt": "Which provider would you like to manage your infrastructure? (default: Inherit)"
+    },
+    "moduleName": {
+      "type": "string",
+      "description": "Python module name"
+    }
+  },
+  "required": ["name"]
+}

package/src/ts/api/schema.json

@@ -0,0 +1,105 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "$id": "ts#api",
+  "title": "ts#api",
+  "description": "Create a TypeScript API",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the API (required). Used to generate class names and file paths.",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like your API to have? i.e: MyApi"
+    },
+    "framework": {
+      "type": "string",
+      "description": "The API framework to use.",
+      "default": "trpc",
+      "enum": ["trpc", "smithy"],
+      "x-prompt": {
+        "message": "Which API framework would you like to use?",
+        "type": "list",
+        "items": [
+          {
+            "value": "trpc",
+            "label": "tRPC (end-to-end type-safe APIs with TypeScript)"
+          },
+          {
+            "value": "smithy",
+            "label": "Smithy (model-driven API development)"
+          }
+        ],
+        "default": "trpc"
+      },
+      "x-priority": "important"
+    },
+    "namespace": {
+      "type": "string",
+      "description": "The namespace for the Smithy API (only applicable for the smithy framework). Defaults to your monorepo scope",
+      "x-prompt": "What namespace would you like your API to have? i.e: com.example"
+    },
+    "computeType": {
+      "type": "string",
+      "description": "The type of compute to use to deploy this API.",
+      "default": "ServerlessApiGatewayRestApi",
+      "enum": ["ServerlessApiGatewayRestApi", "ServerlessApiGatewayHttpApi"],
+      "x-prompt": "What compute type would you like to deploy your API with?",
+      "x-priority": "important"
+    },
+    "integrationPattern": {
+      "type": "string",
+      "description": "How API Gateway integrations are generated for the API. Choose between isolated (default) and shared.",
+      "default": "isolated",
+      "enum": ["isolated", "shared"],
+      "x-priority": "important",
+      "x-prompt": {
+        "message": "How would you like to map integrations to your API operations?",
+        "type": "list",
+        "items": [
+          {
+            "value": "isolated",
+            "label": "isolated (one integration per operation)"
+          },
+          {
+            "value": "shared",
+            "label": "shared (single default integration with optional overrides)"
+          }
+        ],
+        "default": "isolated"
+      }
+    },
+    "auth": {
+      "type": "string",
+      "description": "The method used to authenticate with your API. Choose between IAM (default), Cognito or Custom.",
+      "default": "IAM",
+      "enum": ["IAM", "Cognito", "Custom"],
+      "x-prompt": "How would you like users to authenticate with your API?",
+      "x-priority": "important"
+    },
+    "directory": {
+      "description": "The directory to store the application in.",
+      "type": "string",
+      "alias": "dir",
+      "x-priority": "important",
+      "default": "packages",
+      "x-prompt": "What directory would you like to store your application in?"
+    },
+    "subDirectory": {
+      "type": "string",
+      "description": "The sub directory the project is placed in. By default this is the project name.",
+      "x-prompt": "Which sub directory do you want to create the project in? (By default this is the project name)"
+    },
+    "iacProvider": {
+      "type": "string",
+      "description": "The preferred IaC provider. By default this is inherited from your initial selection.",
+      "enum": ["Inherit", "CDK", "Terraform"],
+      "x-priority": "important",
+      "default": "Inherit",
+      "x-prompt": "Which provider would you like to manage your infrastructure? (default: Inherit)"
+    }
+  },
+  "required": ["name"]
+}

package/src/ts/docs/schema.json

@@ -0,0 +1,70 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "cli": "nx",
+  "$id": "ts#docs",
+  "title": "Create a documentation site",
+  "description": "Generates a documentation site. Use the `framework` option to select the underlying docs framework.",
+  "examples": [
+    {
+      "command": "nx g ts#docs",
+      "description": "Generate a docs site using Astro (default framework)"
+    },
+    {
+      "command": "nx g ts#docs --framework=astro --noTranslation",
+      "description": "Generate an Astro docs site without the automated translation pipeline"
+    }
+  ],
+  "type": "object",
+  "properties": {
+    "name": {
+      "description": "The name of the docs project.",
+      "type": "string",
+      "default": "docs",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use for the docs project?",
+      "pattern": "^[a-zA-Z][^:]*$"
+    },
+    "directory": {
+      "description": "The parent directory the docs project is placed in.",
+      "type": "string",
+      "alias": "dir",
+      "x-priority": "important",
+      "default": ".",
+      "x-prompt": "Which parent directory would you like to place the docs project in?"
+    },
+    "subDirectory": {
+      "type": "string",
+      "description": "The sub directory the docs project is placed in. Defaults to the kebab-case project name.",
+      "x-prompt": "Which sub directory should the docs project be created in? (default: kebab-case of the name)"
+    },
+    "framework": {
+      "description": "The documentation framework to use.",
+      "type": "string",
+      "enum": ["astro"],
+      "default": "astro",
+      "x-priority": "important",
+      "x-prompt": "Which documentation framework would you like to use?"
+    },
+    "noTranslation": {
+      "description": "Opt out of the automated documentation translation pipeline (Strands Agent on Amazon Bedrock + a `translate` project target).",
+      "type": "boolean",
+      "default": false,
+      "x-prompt": "Would you like to opt out of automated documentation translation?"
+    },
+    "noBlog": {
+      "description": "Opt out of the `starlight-blog` plugin and the sample blog post.",
+      "type": "boolean",
+      "default": false,
+      "x-prompt": "Would you like to opt out of the blog?"
+    },
+    "skipInstall": {
+      "description": "Skip installing dependencies after the generator runs.",
+      "type": "boolean",
+      "default": false
+    }
+  },
+  "required": ["name"]
+}

package/src/ts/website/app/schema.json

@@ -0,0 +1,97 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "cli": "nx",
+  "$id": "Website",
+  "title": "Create a Website",
+  "description": "Create a website application for Nx.",
+  "examples": [
+    {
+      "command": "nx g app myapp --directory=myorg",
+      "description": "Generate `apps/myorg/myapp` and `apps/myorg/myapp-e2e`"
+    }
+  ],
+  "type": "object",
+  "properties": {
+    "name": {
+      "description": "The name of the application.",
+      "type": "string",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use for the application?",
+      "pattern": "^[a-zA-Z][^:]*$"
+    },
+    "framework": {
+      "type": "string",
+      "description": "The frontend framework to use.",
+      "enum": ["react"],
+      "default": "react",
+      "x-priority": "important",
+      "x-prompt": "Which frontend framework would you like to use?"
+    },
+    "directory": {
+      "description": "The directory of the new application.",
+      "type": "string",
+      "alias": "dir",
+      "x-priority": "important",
+      "default": "packages",
+      "x-prompt": "What directory would you like to store your application in?"
+    },
+    "subDirectory": {
+      "type": "string",
+      "description": "The sub directory the project is placed in. By default this is the project name.",
+      "x-prompt": "Which sub directory do you want to create the project in? (By default this is the project name)"
+    },
+    "uxProvider": {
+      "type": "string",
+      "description": "The preferred UX provider.",
+      "enum": ["None", "Cloudscape", "Shadcn"],
+      "x-priority": "important",
+      "default": "Cloudscape",
+      "x-prompt": {
+        "message": "Which UX provider should we scaffold for this app?",
+        "type": "list",
+        "items": [
+          {
+            "value": "None",
+            "label": "None (plain React/Vite without a UI kit)"
+          },
+          {
+            "value": "Cloudscape",
+            "label": "Cloudscape (AWS-first components with ready-made layouts)"
+          },
+          {
+            "value": "Shadcn",
+            "label": "Shadcn (shared UI library under packages/common/shadcn)"
+          }
+        ],
+        "default": "Cloudscape"
+      }
+    },
+    "enableTailwind": {
+      "description": "Enable TailwindCSS for utility-first styling.",
+      "type": "boolean",
+      "default": true,
+      "x-priority": "important",
+      "x-prompt": "Would you like to enable TailwindCSS for additional styling capabilities?"
+    },
+    "enableTanstackRouter": {
+      "description": "Enable Tanstack router for type-safe routing.",
+      "type": "boolean",
+      "default": true,
+      "x-priority": "important",
+      "x-prompt": "Would you like to enable Tanstack Router for type-safe routing?"
+    },
+    "iacProvider": {
+      "type": "string",
+      "description": "The preferred IaC provider. By default this is inherited from your initial selection.",
+      "enum": ["Inherit", "CDK", "Terraform"],
+      "x-priority": "important",
+      "default": "Inherit",
+      "x-prompt": "Which provider would you like to manage your infrastructure? (default: Inherit)"
+    }
+  },
+  "required": ["name"],
+  "examplesFile": "../../../docs/application-examples.md"
+}

package/src/ts/website/auth/schema.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "cli": "nx",
+  "$id": "Website Auth",
+  "title": "Website Auth",
+  "description": "Adds auth to an existing website.",
+  "examples": [
+    {
+      "command": "nx g @aws/nx-plugin:ts#website#auth --project=my-website",
+      "description": "Add Cognito auth to an existing website"
+    }
+  ],
+  "type": "object",
+  "properties": {
+    "project": {
+      "description": "The root directory of the website.",
+      "type": "string",
+      "alias": "dir",
+      "x-priority": "important",
+      "x-prompt": "the root directory for your website.",
+      "x-dropdown": "projects"
+    },
+    "cognitoDomain": {
+      "description": "The cognito domain prefix to use. If omitted, a value is derived from the npm scope and website project name.",
+      "type": "string",
+      "x-priority": "important",
+      "x-prompt": "the cognito domain prefix to use i.e: https://{{cognitoDomain}}-123456789.auth.ap-southeast-2.amazoncognito.com (leave blank to derive from scope and project name)"
+    },
+    "allowSignup": {
+      "description": "Whether to allow self-signup",
+      "type": "boolean",
+      "default": false,
+      "x-prompt": "Enable self signup?",
+      "x-priority": "important"
+    },
+    "iacProvider": {
+      "type": "string",
+      "description": "The preferred IaC provider. By default this is inherited from your initial selection.",
+      "enum": ["Inherit", "CDK", "Terraform"],
+      "x-priority": "important",
+      "default": "Inherit",
+      "x-prompt": "Which provider would you like to manage your infrastructure? (default: Inherit)"
+    }
+  },
+  "required": ["project"]
+}