@macedon-technologies/batman 1.28.0 → 1.30.0

package/.jsii

@@ -97,7 +97,7 @@
   },
   "name": "@macedon-technologies/batman",
   "readme": {
-    "markdown": "# Platform Common Projen\n\nA baseline architecture template for new projects using Projen. This project provides a standardized foundation that includes both frontend and backend components with authentication.\n\n## Project Intention\n\nThis template serves as a starting point for new projects, providing:\n- Consistent project structure and configuration\n- Pre-configured development tooling\n- Integrated authentication system\n- Full-stack application foundation\n\n## Components Created\n\nThe BatmanProject generates:\n\n### Frontend\n- **React Application** - Modern React app with TypeScript\n- **Clerk Authentication** - Integrated user authentication and management\n- **Playwright e2e Testing** - `@playwright/test` + `@clerk/testing` devDeps, a `test:e2e` task, and a scaffolded `playwright.config.ts` + `e2e/` starter suite (see the generated `web/e2e/README.md`); disable with `e2eTesting: false`. The generated `pr-deploy.yml` workflow also runs this suite against each PR's deployed URL unless `e2eTesting: false` is set.\n\n### Backend/Infrastructure\n- **AWS Infrastructure** - CDK-based cloud resources\n- **API Gateway** - RESTful API endpoints\n- **Lambda Functions** - Serverless compute\n- **Database** - Persistent data storage\n\n## Usage Examples\n\n### Basic Project Creation\n\nCreate a `.projenrc.ts` file in your project root:\n\n```typescript\nimport { BatmanProject } from '@macedon-technologies/batman';\n\nconst project = new BatmanProject({\n  name: 'my-new-app',\n  defaultReleaseBranch: 'main',\n});\n\nproject.synth();\n```\n\nThen run:\n```bash\nnpx projen\n```\n\n### With Custom Configuration\n\nCreate a `.projenrc.ts` file with additional options:\n\n```typescript\nimport { BatmanProject } from '@macedon-technologies/batman';\n\nconst project = new BatmanProject({\n  name: 'my-enterprise-app',\n  defaultReleaseBranch: 'main',\n  description: 'Enterprise application with authentication',\n  authorName: 'Your Name',\n  authorEmail: 'your.email@company.com',\n});\n\nproject.synth();\n```\n\nThen run:\n```bash\nnpx projen\n```\n\n### Development Workflow\n\n```bash\n# Install dependencies\nyarn install\n\n# Start development server\nyarn dev\n\n# Deploy infrastructure\nyarn deploy\n\n# Run tests\nyarn test\n```\n\n## SoftwareFactoryFiles (standalone, non-Batman projects)\n\n`SoftwareFactoryFiles` is independently exported and can be attached to any\n`projen` `NodeProject` — it does not require `BatmanProject` or\n`BootcampProject`. It generates the `@swamp/software-factory` state machine,\nthe architecture rule registry, the pre-PR attestation gate, the OpenSpec\ntask-completion gate, and the swamp workflows that wire them together.\n\n```typescript\nimport { javascript } from 'projen';\nimport { SoftwareFactoryFiles } from '@macedon-technologies/batman';\n\nconst project = new javascript.NodeProject({\n  name: 'my-other-project',\n  defaultReleaseBranch: 'main',\n});\n\nnew SoftwareFactoryFiles(project, {\n  repoName: 'my-other-project',\n  githubOwner: 'my-github-org', // defaults to 'macedon-technologies' if omitted\n  baseBranch: 'main', // defaults to 'main'\n});\n\nproject.synth();\n```\n\nAfter running `npx projen`, follow the printed `swamp:bootstrap` task to pull\nthe required swamp extensions and create the project's secrets vault."
+    "markdown": "# Platform Common Projen\n\nA baseline architecture template for new projects using Projen. This project provides a standardized foundation that includes both frontend and backend components with authentication.\n\n## Project Intention\n\nThis template serves as a starting point for new projects, providing:\n- Consistent project structure and configuration\n- Pre-configured development tooling\n- Integrated authentication system\n- Full-stack application foundation\n\n## Components Created\n\nThe BatmanProject generates:\n\n### Frontend\n- **React Application** - Modern React app with TypeScript\n- **Clerk Authentication** - Integrated user authentication and management\n- **Playwright e2e Testing** - `@playwright/test` + `@clerk/testing` devDeps, a `test:e2e` task, and a scaffolded `playwright.config.ts` + `e2e/` starter suite (see the generated `web/e2e/README.md`); disable with `e2eTesting: false`. The generated `pr-deploy.yml` workflow also runs this suite against each PR's deployed URL unless `e2eTesting: false` is set.\n\n### Backend/Infrastructure\n- **AWS Infrastructure** - CDK-based cloud resources\n- **API Gateway** - RESTful API endpoints\n- **Lambda Functions** - Serverless compute\n- **Database** - Persistent data storage\n\n## Usage Examples\n\n### Basic Project Creation\n\nCreate a `.projenrc.ts` file in your project root:\n\n```typescript\nimport { BatmanProject } from '@macedon-technologies/batman';\n\nconst project = new BatmanProject({\n  name: 'my-new-app',\n  defaultReleaseBranch: 'main',\n});\n\nproject.synth();\n```\n\nThen run:\n```bash\nnpx projen\n```\n\n### With Custom Configuration\n\nCreate a `.projenrc.ts` file with additional options:\n\n```typescript\nimport { BatmanProject } from '@macedon-technologies/batman';\n\nconst project = new BatmanProject({\n  name: 'my-enterprise-app',\n  defaultReleaseBranch: 'main',\n  description: 'Enterprise application with authentication',\n  authorName: 'Your Name',\n  authorEmail: 'your.email@company.com',\n});\n\nproject.synth();\n```\n\nThen run:\n```bash\nnpx projen\n```\n\n### Development Workflow\n\n```bash\n# Install dependencies\nyarn install\n\n# Start development server\nyarn dev\n\n# Deploy infrastructure\nyarn deploy\n\n# Run tests\nyarn test\n```\n\n## Upgrading\n\n### The base stack no longer creates a VPC\n\n`BaseApplicationStack` used to create a VPC with a NAT gateway and attach the API Lambda to it.\nIt now creates neither unless the stack props set `enableVpc: true`. A stack that upgrades\nwithout it deletes its VPC and NAT gateway on the next deploy.\n\nAdd `enableVpc: true` to every `ApplicationStack` in `src/main.ts` and `src/LocalDevApp.ts` (new projects: `additionalStackProps: { enableVpc: true }` on each environment) if any of these apply:\n\n- your `ApplicationStack` uses `this.vpc` or overrides `createVpc()`; the override is not called otherwise;\n- the Lambda reaches anything private, such as RDS or a VPC endpoint;\n- another stack imports this stack's VPC outputs; CloudFormation refuses to delete them.\n\n`this.vpc` is now typed `IVpc | undefined`, even with `enableVpc: true`, so code that passes it where an `IVpc` is required (such as `new SecurityGroup(this, 'Sg', { vpc: this.vpc })`) stops compiling. With `enableVpc: true` the VPC is created before your `ApplicationStack` constructor runs, so use `this.vpc!` there, or check it and throw if it's missing.\n\nOtherwise, make `vpc` optional in `src/constructs/Api.ts` (`readonly vpc?: IVpc;`) so the project compiles. Deleting the VPC can take a while as Lambda releases its network interfaces.\n\nWith `enableVpc: true`, the Lambda is attached only if your `Api.ts` still accepts a `vpc` prop and your stack doesn't override `createApi()` without passing it.\n\n### n8n support is removed\n\n`BatmanProject` and `BootcampProject` no longer generate any n8n wiring. The base stacks have no `n8nEndpoint` prop, `src/constructs/WorkflowProvider.ts` and a construct per `src/workflows/*.json` are no longer generated, and new projects get an `Api.ts`, `main.ts` and `LocalDevApp.ts` without n8n. The `n8nWorkflows` option, the `n8nEndpoint` environment config field and the exported `WorkflowAutoDiscover` class are gone, so every project removes `n8nWorkflows` and `n8nEndpoint` from its `.projenrc.ts`.\n\nA project that doesn't use n8n stops compiling until it also removes:\n\n- `n8nEndpoint` from every `ApplicationStack` in `src/main.ts` and `src/LocalDevApp.ts`;\n- the `n8nEndpoint` prop, the n8n JWT key secret and its `grantRead` from `src/constructs/Api.ts`;\n- any `n8nEndpoint: this.props.n8nEndpoint` in a `createApi()` override;\n- any generated `src/constructs/*Workflow.ts` files and `src/workflows/`, which import the now-deleted `WorkflowProvider`.\n\nA project that uses n8n takes ownership of it:\n\n1. Upgrading makes projen delete `src/constructs/WorkflowProvider.ts`. Restore it from the last commit that had it, which works whether or not the deletion is already committed:\n\n   ```bash\n   git checkout \"$(git log -n1 --format=%H --diff-filter=AM -- src/constructs/WorkflowProvider.ts)\" -- src/constructs/WorkflowProvider.ts\n   ```\n\n   Then delete the `~~ Generated by projen` header line from it and from your per-workflow constructs (such as `AlfredWorkflow.ts`). They're yours from now on, and a new workflow needs its construct written by hand.\n2. Move `n8nEndpoint` from `Api` to your `ApplicationStack`. Remove the `n8nEndpoint` prop and its `N8N_ENDPOINT` environment entry from `src/constructs/Api.ts`, add `readonly n8nEndpoint: string;` to `ApplicationStackProps` (your `main.ts` and `LocalDevApp.ts` already pass it), and set the variable after `super()`:\n\n   ```typescript\n   this.api.lambdaFunction.addEnvironment('N8N_ENDPOINT', props.n8nEndpoint);\n   ```\n\n## SoftwareFactoryFiles (standalone, non-Batman projects)\n\n`SoftwareFactoryFiles` is independently exported and can be attached to any\n`projen` `NodeProject` — it does not require `BatmanProject` or\n`BootcampProject`. It generates the `@swamp/software-factory` state machine,\nthe architecture rule registry, the pre-PR attestation gate, the OpenSpec\ntask-completion gate, and the swamp workflows that wire them together.\n\n```typescript\nimport { javascript } from 'projen';\nimport { SoftwareFactoryFiles } from '@macedon-technologies/batman';\n\nconst project = new javascript.NodeProject({\n  name: 'my-other-project',\n  defaultReleaseBranch: 'main',\n});\n\nnew SoftwareFactoryFiles(project, {\n  repoName: 'my-other-project',\n  githubOwner: 'my-github-org', // defaults to 'macedon-technologies' if omitted\n  baseBranch: 'main', // defaults to 'main'\n});\n\nproject.synth();\n```\n\nAfter running `npx projen`, follow the printed `swamp:bootstrap` task to pull\nthe required swamp extensions and create the project's secrets vault."
   },
   "repository": {
     "type": "git",
@@ -123,7 +123,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/Application.ts",
-        "line": 24
+        "line": 22
       },
       "name": "ApplicationEnvironmentConfig",
       "properties": [
@@ -135,7 +135,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/Application.ts",
-            "line": 25
+            "line": 23
           },
           "name": "githubActionRoleArn",
           "type": {
@@ -158,7 +158,7 @@
         },
         "locationInModule": {
           "filename": "src/BatmanProject.ts",
-          "line": 71
+          "line": 77
         },
         "parameters": [
           {
@@ -172,7 +172,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/BatmanProject.ts",
-        "line": 70
+        "line": 76
       },
       "name": "BatmanProject",
       "symbolId": "src/BatmanProject:BatmanProject"
@@ -251,7 +251,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/BatmanProject.ts",
-            "line": 52
+            "line": 47
           },
           "name": "actionVersions",
           "optional": true,
@@ -268,7 +268,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/BatmanProject.ts",
-            "line": 42
+            "line": 37
           },
           "name": "additionalCodeOwners",
           "optional": true,
@@ -306,51 +306,58 @@
         {
           "abstract": true,
           "docs": {
-            "default": "- the default pinned in ApiConstructFile",
+            "default": "- only the default files",
+            "remarks": "Each entry is an exact file path\nrelative to the project root, in normalized POSIX form, using only\nletters, digits and `._@+-`, with no `.` or `..` segment; synth fails\non any other entry.",
             "stability": "stable",
-            "summary": "Overrides the pinned S3 object version of the clerk-authorizer Lambda deployment package."
+            "summary": "Extra files that the PR attestation manifest also hashes, such as the project's own verification checks."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/BatmanProject.ts",
-            "line": 59
+            "line": 72
           },
-          "name": "authorizerObjectVersion",
+          "name": "attestationFiles",
           "optional": true,
           "type": {
-            "primitive": "string"
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
           }
         },
         {
           "abstract": true,
           "docs": {
-            "default": "true",
+            "default": "- the default pinned in ApiConstructFile",
             "stability": "stable",
-            "summary": "Whether the generated `web` app and its `PrDeployWorkflow` CI step include Playwright e2e testing support."
+            "summary": "Overrides the pinned S3 object version of the clerk-authorizer Lambda deployment package."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/BatmanProject.ts",
-            "line": 66
+            "line": 54
           },
-          "name": "e2eTesting",
+          "name": "authorizerObjectVersion",
           "optional": true,
           "type": {
-            "primitive": "boolean"
+            "primitive": "string"
           }
         },
         {
           "abstract": true,
           "docs": {
+            "default": "true",
             "stability": "stable",
-            "summary": "Enable n8n workflow auto-discovery and WorkflowProvider generation."
+            "summary": "Whether the generated `web` app and its `PrDeployWorkflow` CI step include Playwright e2e testing support."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/BatmanProject.ts",
-            "line": 37
+            "line": 61
           },
-          "name": "n8nWorkflows",
+          "name": "e2eTesting",
           "optional": true,
           "type": {
             "primitive": "boolean"
@@ -365,7 +372,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/BatmanProject.ts",
-            "line": 47
+            "line": 42
           },
           "name": "websiteDeps",
           "optional": true,
@@ -530,7 +537,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/MainFile.ts",
-            "line": 11
+            "line": 10
           },
           "name": "account",
           "type": {
@@ -560,7 +567,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/MainFile.ts",
-            "line": 13
+            "line": 12
           },
           "name": "clerkPublishableKey",
           "type": {
@@ -620,22 +627,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/MainFile.ts",
-            "line": 10
-          },
-          "name": "n8nEndpoint",
-          "type": {
-            "primitive": "string"
-          }
-        },
-        {
-          "abstract": true,
-          "docs": {
-            "stability": "stable"
-          },
-          "immutable": true,
-          "locationInModule": {
-            "filename": "src/MainFile.ts",
-            "line": 12
+            "line": 11
           },
           "name": "region",
           "type": {
@@ -650,7 +642,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/MainFile.ts",
-            "line": 14
+            "line": 13
           },
           "name": "additionalStackProps",
           "optional": true,
@@ -812,7 +804,7 @@
         },
         "locationInModule": {
           "filename": "src/SoftwareFactoryFiles.ts",
-          "line": 65
+          "line": 76
         },
         "parameters": [
           {
@@ -832,7 +824,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/SoftwareFactoryFiles.ts",
-        "line": 64
+        "line": 75
       },
       "name": "SoftwareFactoryFiles",
       "symbolId": "src/SoftwareFactoryFiles:SoftwareFactoryFiles"
@@ -884,6 +876,30 @@
             "fqn": "@macedon-technologies/batman.WorkflowActionVersions"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- only the default files",
+            "remarks": "Each entry is an exact file path\nrelative to the project root, in normalized POSIX form, using only\nletters, digits and `._@+-`, with no `.` or `..` segment; synth fails\non any other entry.",
+            "stability": "stable",
+            "summary": "Extra files that the PR attestation manifest also hashes, such as the project's own verification checks."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/SoftwareFactoryFiles.ts",
+            "line": 48
+          },
+          "name": "attestationFiles",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -1235,54 +1251,8 @@
         }
       ],
       "symbolId": "src/WorkflowActionVersions:WorkflowActionVersions"
-    },
-    "@macedon-technologies/batman.WorkflowAutoDiscover": {
-      "assembly": "@macedon-technologies/batman",
-      "base": "projen.Component",
-      "docs": {
-        "stability": "stable"
-      },
-      "fqn": "@macedon-technologies/batman.WorkflowAutoDiscover",
-      "initializer": {
-        "docs": {
-          "stability": "stable"
-        },
-        "locationInModule": {
-          "filename": "src/WorkflowAutoDiscover.ts",
-          "line": 7
-        },
-        "parameters": [
-          {
-            "name": "project",
-            "type": {
-              "fqn": "projen.awscdk.AwsCdkTypeScriptApp"
-            }
-          }
-        ]
-      },
-      "kind": "class",
-      "locationInModule": {
-        "filename": "src/WorkflowAutoDiscover.ts",
-        "line": 6
-      },
-      "methods": [
-        {
-          "docs": {
-            "stability": "stable",
-            "summary": "Synthesizes files to the project output directory."
-          },
-          "locationInModule": {
-            "filename": "src/WorkflowAutoDiscover.ts",
-            "line": 11
-          },
-          "name": "synthesize",
-          "overrides": "projen.Component"
-        }
-      ],
-      "name": "WorkflowAutoDiscover",
-      "symbolId": "src/WorkflowAutoDiscover:WorkflowAutoDiscover"
     }
   },
-  "version": "1.28.0",
-  "fingerprint": "sIMdBmmJuZSfzcTh916j9IilxaSosKqanFdLlX/ej/A="
+  "version": "1.30.0",
+  "fingerprint": "s/dl5clBZVfFrvF5mFAr7Cpl0D4/kwpHw19oB3oz3hI="
 }