@xpertss/projen-types 0.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. package/.jsii +1742 -0
  2. package/API.md +11718 -0
  3. package/LICENSE +202 -0
  4. package/README.md +263 -0
  5. package/lib/cdk/app-runtime-scaffold.d.ts +8 -0
  6. package/lib/cdk/app-runtime-scaffold.js +31 -0
  7. package/lib/cdk/cdk-app-project.d.ts +10 -0
  8. package/lib/cdk/cdk-app-project.js +35 -0
  9. package/lib/cdk/cdk-infra-project.d.ts +10 -0
  10. package/lib/cdk/cdk-infra-project.js +26 -0
  11. package/lib/cdk/cdk-typescript-base.d.ts +16 -0
  12. package/lib/cdk/cdk-typescript-base.js +53 -0
  13. package/lib/cdk/components/ecr-ecs-constructs.d.ts +12 -0
  14. package/lib/cdk/components/ecr-ecs-constructs.js +46 -0
  15. package/lib/cdk/components/edge-networking-constructs.d.ts +10 -0
  16. package/lib/cdk/components/edge-networking-constructs.js +66 -0
  17. package/lib/cdk/database-component.d.ts +11 -0
  18. package/lib/cdk/database-component.js +44 -0
  19. package/lib/cdk/options.d.ts +39 -0
  20. package/lib/cdk/options.js +3 -0
  21. package/lib/common/constants.d.ts +7 -0
  22. package/lib/common/constants.js +11 -0
  23. package/lib/common/drift-check.d.ts +8 -0
  24. package/lib/common/drift-check.js +18 -0
  25. package/lib/common/environment-options.d.ts +19 -0
  26. package/lib/common/environment-options.js +7 -0
  27. package/lib/common/manual-deploy-workflow.d.ts +34 -0
  28. package/lib/common/manual-deploy-workflow.js +78 -0
  29. package/lib/common/upgrade-workflow.d.ts +18 -0
  30. package/lib/common/upgrade-workflow.js +39 -0
  31. package/lib/index.d.ts +20 -0
  32. package/lib/index.js +37 -0
  33. package/lib/java/components/cdk-deploy-hook.d.ts +13 -0
  34. package/lib/java/components/cdk-deploy-hook.js +45 -0
  35. package/lib/java/components/code-index-workflow.d.ts +6 -0
  36. package/lib/java/components/code-index-workflow.js +35 -0
  37. package/lib/java/components/docker-publish.d.ts +10 -0
  38. package/lib/java/components/docker-publish.js +41 -0
  39. package/lib/java/components/flyway-migration.d.ts +6 -0
  40. package/lib/java/components/flyway-migration.js +19 -0
  41. package/lib/java/components/github-packages-publish.d.ts +10 -0
  42. package/lib/java/components/github-packages-publish.js +34 -0
  43. package/lib/java/components/maven-central-publish.d.ts +13 -0
  44. package/lib/java/components/maven-central-publish.js +44 -0
  45. package/lib/java/java-app-project.d.ts +9 -0
  46. package/lib/java/java-app-project.js +21 -0
  47. package/lib/java/java-library-project.d.ts +6 -0
  48. package/lib/java/java-library-project.js +20 -0
  49. package/lib/java/java-maven-base.d.ts +15 -0
  50. package/lib/java/java-maven-base.js +56 -0
  51. package/lib/java/java-service-project.d.ts +9 -0
  52. package/lib/java/java-service-project.js +29 -0
  53. package/lib/java/options.d.ts +43 -0
  54. package/lib/java/options.js +3 -0
  55. package/package.json +139 -0
  56. package/spec/npm-publishing-setup.md +150 -0
  57. package/spec/projen-cdk-spec.md +80 -0
  58. package/spec/projen-java-spec.md +96 -0
package/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,263 @@
1
+ # @xpertss/projen-types
2
+
3
+ Projen project types for CDK/TypeScript and Java/Maven projects.
4
+
5
+ Instead of hand-maintaining `pom.xml`, `cdk.json`, and GitHub workflows, you declare a project type in a `.projenrc.ts` file and let [projen](https://github.com/projen/projen) generate (and keep up to date) the whole scaffold: build files, source skeletons, CI workflows, and deploy pipelines.
6
+
7
+ ## Project types at a glance
8
+
9
+ | Type | What it is | Publishes to | Generated workflows |
10
+ | --- | --- | --- | --- |
11
+ | `CdkInfraProject` | Pure-infrastructure CDK stacks (CloudFront, Route53, SQS, API Gateway, Cognito, ECR/ECS for externally-built images) | - | `build` (PR checks), `deploy` (manual dispatch) |
12
+ | `CdkAppProject` | Full TypeScript service behind API Gateway: infra + app source + database | - | `build`, `deploy`, `app-build` (PR checks) |
13
+ | `JavaLibraryProject` | Reusable Java library | Maven Central | `build`, `upgrade` (nightly), `publish-maven-central`, `codeindex` |
14
+ | `JavaServiceProject` | Spring Boot service | Docker Hub | `build`, `upgrade` (nightly), `publish-docker`, `deploy-cdk` |
15
+ | `JavaAppProject` | GUI/TUI/CLI Java application | GitHub Packages | `build`, `upgrade` (nightly), `publish-ghpackages` |
16
+
17
+ Two foundation classes are also exported for advanced use: `CdkTypescriptProject` (shared CDK + TypeScript base for the CDK types) and `JavaMavenProject` (shared Maven base for the Java types).
18
+
19
+ All project types:
20
+
21
+ - run a **drift check** in PR builds - a job that re-runs projen and fails if generated files were hand-edited. Edit `.projenrc.ts`, then run `npx projen`; never edit generated files directly.
22
+ - use the GitHub secret `PROJEN_GITHUB_TOKEN` (a fine-grained PAT) for projen's automation. Override with `gheTokenSecret`.
23
+ - make all publishing/deploying **manual** (workflow_dispatch) rather than on every merge.
24
+
25
+ ## Getting started
26
+
27
+ Create a new git repository and install the dependencies:
28
+
29
+ ```bash
30
+ mkdir my-project && cd my-project
31
+ git init
32
+ npm install -D projen constructs @xpertss/projen-types
33
+ ```
34
+
35
+ Write a `.projenrc.ts` (see examples below), then generate the project:
36
+
37
+ ```bash
38
+ npx projen
39
+ ```
40
+
41
+ Commit the result. From then on, every change to the scaffold goes through `.projenrc.ts` followed by `npx projen`.
42
+
43
+ The `name` option must match the `name` field in the project's `package.json` (for the CDK types) or the project name used by projen's `java.JavaProject` (for the Java types).
44
+
45
+ ## Examples
46
+
47
+ ### CdkInfraProject
48
+
49
+ Pure infrastructure stacks with optional ECR/ECS and edge-networking constructs.
50
+
51
+ ```typescript
52
+ // .projenrc.ts
53
+ import { CdkInfraProject } from '@xpertss/projen-types';
54
+
55
+ const project = new CdkInfraProject({
56
+ name: 'media-edge-infra',
57
+ environments: [
58
+ 'dev',
59
+ { name: 'stage', accountId: '111111111111', region: 'eu-central-1' },
60
+ { name: 'prod', accountId: '222222222222', region: 'eu-central-1', requiresApproval: true },
61
+ ],
62
+ edgeResources: ['cloudfront', 'route53', 'sqs'],
63
+ ecrEcs: { enabled: true, externalImageSource: true },
64
+ slackWebhookSecret: 'SLACK_DEPLOY_WEBHOOK',
65
+ });
66
+
67
+ project.synth();
68
+ ```
69
+
70
+ You get:
71
+
72
+ - `cdk.json`, `cdk synth` / `cdk diff` / `cdk deploy` tasks, and the standard `AwsCdkTypeScriptApp` layout (CDK 2.189.1 by default).
73
+ - `.github/workflows/build.yml` - PR build that hard-fails on projen drift.
74
+ - `.github/workflows/deploy.yml` - manual dispatch with one `deploy-<env>` job per environment (runs `cdk deploy --all` with `--context environment=<env>`); `requiresApproval` environments get a GitHub Environment approval gate; a Slack notification step is added when `slackWebhookSecret` is set.
75
+ - `src/constructs/edge-networking.ts` - helper constructs only for the requested `edgeResources` (`cloudfront`, `route53`, `apigateway`, `cognito`, `sqs`).
76
+ - `src/constructs/ecr-ecs.ts` when `ecrEcs.enabled` - ECR repo + Fargate service; `externalImageSource: true` (default) means the service pulls an image built outside this repo.
77
+
78
+ ### CdkAppProject
79
+
80
+ `CdkInfraProject` plus application source, a database construct, and an app-level build workflow.
81
+
82
+ ```typescript
83
+ // .projenrc.ts
84
+ import { CdkAppProject } from '@xpertss/projen-types';
85
+
86
+ const project = new CdkAppProject({
87
+ name: 'video-api',
88
+ environments: ['dev', 'prod'],
89
+ edgeResources: ['apigateway'],
90
+ database: { engine: 'postgres', migrationTool: 'flyway' },
91
+ appEntryPoint: 'src/app.ts',
92
+ });
93
+
94
+ project.synth();
95
+ ```
96
+
97
+ Everything from `CdkInfraProject`, plus:
98
+
99
+ - `src/app.ts` - application entrypoint stub (`export function handler()`).
100
+ - `src/handlers/example.ts` - API Gateway proxy handler stub, with `@types/aws-lambda` added as a dev dependency.
101
+ - `src/constructs/database.ts` - a `Database` construct stub for the chosen engine (`postgres`/`mysql` -> RDS, `dynamodb` -> DynamoDB). `migrationTool` (no default, intentionally) is added as a dev dependency and referenced in the stub - wiring it up is left to you.
102
+ - `.github/workflows/app-build.yml` - runs the project's test task on every PR, then checks for projen drift.
103
+
104
+ ### JavaLibraryProject
105
+
106
+ A reusable Java library published to Maven Central.
107
+
108
+ ```typescript
109
+ // .projenrc.ts
110
+ import { JavaLibraryProject } from '@xpertss/projen-types';
111
+
112
+ const project = new JavaLibraryProject({
113
+ name: 'common-utils',
114
+ groupId: 'org.xpertss',
115
+ artifactId: 'common-utils',
116
+ version: '1.0.0',
117
+ sonarProjectKey: 'org.xpertss:common-utils',
118
+ mavenCentralOidc: true,
119
+ });
120
+
121
+ project.synth();
122
+ ```
123
+
124
+ You get:
125
+
126
+ - `pom.xml` (via projen's `java.JavaProject`) with the given GAV coordinates.
127
+ - `.github/workflows/build.yml` - PR build + projen drift check, plus a SonarQube scan step when `sonarProjectKey` is set (needs a `SONAR_TOKEN` secret).
128
+ - `.github/workflows/upgrade.yml` - nightly (03:00 UTC) PR running `mvn versions:use-latest-releases versions:update-properties`.
129
+ - `.github/workflows/publish-maven-central.yml` - manual dispatch running `mvn -B deploy -P release`. With `mavenCentralOidc: true` it uses Maven Central's OIDC trusted publishing (no GPG secrets needed); otherwise it expects the secrets `MAVEN_GPG_PRIVATE_KEY`, `MAVEN_GPG_PASSPHRASE`, `MAVEN_CENTRAL_USERNAME`, `MAVEN_CENTRAL_PASSWORD`.
130
+ - `.github/workflows/codeindex.yml` - on push to `main`, generates a Java source index under `.cai/` (disable with `publishCodeIndex: false`).
131
+
132
+ ### JavaServiceProject
133
+
134
+ A Spring Boot service that publishes a Docker image and can trigger deploys in a companion CDK repo.
135
+
136
+ ```typescript
137
+ // .projenrc.ts
138
+ import { JavaServiceProject } from '@xpertss/projen-types';
139
+
140
+ const project = new JavaServiceProject({
141
+ name: 'stream-processor',
142
+ groupId: 'org.xpertss',
143
+ artifactId: 'stream-processor',
144
+ dockerRegistry: 'docker.io/xpertss',
145
+ cdkDeployHook: { targetRepo: 'xpertss/stream-infra' },
146
+ environments: ['dev', { name: 'prod', requiresApproval: true }],
147
+ });
148
+
149
+ project.synth();
150
+ ```
151
+
152
+ You get (everything from `JavaMavenProject` - `pom.xml`, `build` + drift check, nightly `upgrade` - plus):
153
+
154
+ - `spring-boot-starter-web` added to the pom.
155
+ - `.github/workflows/publish-docker.yml` - manual dispatch: `mvn -B package && docker build -t <registry>/<name>:<sha>`, logged in with the `DOCKER_USERNAME` / `DOCKER_PASSWORD` secrets. `dockerRegistry` defaults to `docker.io`.
156
+ - Flyway wiring when `useFlyway` (default `true`): `flyway-maven-plugin` ^10 + `flyway-core` ^10 in the pom, and `src/main/resources/db/migration/V1__init.sql`.
157
+ - `.github/workflows/deploy-cdk.yml` (the `CdkDeployHook`, enabled by default) - manual dispatch with an environment selector; each job sends a `workflow_dispatch` to `deploy.yml` in the companion `targetRepo` (a `CdkInfraProject`/`CdkAppProject` repo). `targetRepo` is required when the hook is enabled; disable it with `cdkDeployHook: { enabled: false }`. `environments` defaults to `['prod']`.
158
+
159
+ ### JavaAppProject
160
+
161
+ A GUI/TUI/CLI Java application published to GitHub Packages only - no Maven Central, no Docker, no CDK deploy hook.
162
+
163
+ ```typescript
164
+ // .projenrc.ts
165
+ import { JavaAppProject } from '@xpertss/projen-types';
166
+
167
+ const project = new JavaAppProject({
168
+ name: 'studio-cli',
169
+ groupId: 'org.xpertss',
170
+ artifactId: 'studio-cli',
171
+ ghPackagesRegistry: 'https://maven.pkg.github.com/xpertss/studio-cli',
172
+ });
173
+
174
+ project.synth();
175
+ ```
176
+
177
+ You get everything from `JavaMavenProject`, plus `.github/workflows/publish-ghpackages.yml` - manual dispatch running `mvn -B deploy -DaltDeploymentRepository=github::<registry>`, authenticated with `GITHUB_TOKEN`. `ghPackagesRegistry` defaults to `https://maven.pkg.github.com/<repo>` derived from the repository URL.
178
+
179
+ ## Common options
180
+
181
+ CDK project types (`CdkInfraProjectOptions` / `CdkAppProjectOptions`):
182
+
183
+ | Option | Default | Description |
184
+ | --- | --- | --- |
185
+ | `name` | - (required) | Project name; must match `package.json` |
186
+ | `cdkVersion` | `2.189.1` | AWS CDK version |
187
+ | `gheTokenSecret` | `PROJEN_GITHUB_TOKEN` | GitHub secret holding projen's PAT |
188
+ | `slackWebhookSecret` | - | GitHub secret with a Slack webhook URL for deploy notifications |
189
+ | `environments` | - (required) | Deploy targets for the `deploy` workflow; strings or `EnvironmentOptions` |
190
+ | `ecrEcs` | - | `EcrEcsOptions` - `enabled`, `externalImageSource` (default `true`) |
191
+ | `edgeResources` | - | Subset of `cloudfront`, `route53`, `apigateway`, `cognito`, `sqs` |
192
+ | `database` | - (app only) | `DatabaseOptions` - `engine` (`postgres`/`mysql`/`dynamodb`, default `postgres`), `migrationTool` |
193
+ | `appEntryPoint` | `src/app.ts` (app only) | Path of the generated application entrypoint |
194
+
195
+ Java project types (`JavaLibraryProjectOptions` / `JavaServiceProjectOptions` / `JavaAppProjectOptions`):
196
+
197
+ | Option | Default | Description |
198
+ | --- | --- | --- |
199
+ | `name` | - (required) | Project name |
200
+ | `groupId` | - (required) | Maven group id |
201
+ | `artifactId` | - (required) | Maven artifact id |
202
+ | `version` | `0.1.0` | Maven version |
203
+ | `sonarProjectKey` | - | SonarQube project key; the sonar step is skipped when unset |
204
+ | `gheTokenSecret` | `PROJEN_GITHUB_TOKEN` | GitHub secret holding projen's PAT |
205
+
206
+ `EnvironmentOptions` for deploy targets:
207
+
208
+ ```typescript
209
+ interface EnvironmentOptions {
210
+ readonly name: string; // e.g. "dev", "stage", "prod"
211
+ readonly accountId?: string; // AWS account id (CDK deploys)
212
+ readonly region?: string; // AWS region (CDK deploys)
213
+ readonly requiresApproval?: boolean; // GitHub Environment approval gate (default false)
214
+ }
215
+ ```
216
+
217
+ Plain strings (`'dev'`) are shorthand for `{ name: 'dev' }`.
218
+
219
+ ## Required GitHub secrets
220
+
221
+ | Secret | Used by | Notes |
222
+ | --- | --- | --- |
223
+ | `PROJEN_GITHUB_TOKEN` | all types | PAT for projen's self-mutation/automation; override via `gheTokenSecret` |
224
+ | `SONAR_TOKEN` | Java types with `sonarProjectKey` | SonarQube scan step in `build.yml` |
225
+ | `DOCKER_USERNAME` / `DOCKER_PASSWORD` | `JavaServiceProject` | Docker image push |
226
+ | `MAVEN_GPG_PRIVATE_KEY`, `MAVEN_GPG_PASSPHRASE`, `MAVEN_CENTRAL_USERNAME`, `MAVEN_CENTRAL_PASSWORD` | `JavaLibraryProject` without `mavenCentralOidc` | Not needed with OIDC trusted publishing |
227
+ | (your Slack webhook secret) | CDK types with `slackWebhookSecret` | Deploy notifications |
228
+
229
+ ## Going further
230
+
231
+ The project types are composed from smaller components you can also attach to your own projects:
232
+
233
+ | Component | Applies to | Purpose |
234
+ | --- | --- | --- |
235
+ | `AppRuntimeScaffold` | `NodeProject` | App source skeleton (`app.ts` + handlers) |
236
+ | `DatabaseComponent` | `NodeProject` | Database construct stub + migration tool wiring |
237
+ | `EcrEcsConstructs` | `Project` | ECR + Fargate ECS construct helper |
238
+ | `EdgeNetworkingConstructs` | `Project` | Per-resource edge networking construct helpers |
239
+ | `MavenCentralPublish` | `JavaProject` | Manual-dispatch Maven Central publish workflow |
240
+ | `DockerPublish` | `JavaProject` | Manual-dispatch Docker build+push workflow |
241
+ | `GitHubPackagesPublish` | `JavaProject` | Manual-dispatch GitHub Packages publish workflow |
242
+ | `FlywayMigration` | `JavaProject` | Flyway plugin/dependency + migrations directory |
243
+ | `CdkDeployHook` | `JavaProject` | Manual-dispatch workflow that triggers `deploy.yml` in a companion CDK repo |
244
+ | `CodeIndexWorkflow` | `JavaProject` | Code index generation on push to `main` |
245
+
246
+ Example - adding a Docker publish to a plain projen `JavaProject`:
247
+
248
+ ```typescript
249
+ import { java } from 'projen';
250
+ import { DockerPublish } from '@xpertss/projen-types';
251
+
252
+ const project = new java.JavaProject({
253
+ name: 'my-service',
254
+ groupId: 'org.xpertss',
255
+ artifactId: 'my-service',
256
+ });
257
+
258
+ new DockerPublish(project, { dockerRegistry: 'ghcr.io' });
259
+
260
+ project.synth();
261
+ ```
262
+
263
+ The full API reference, including every option and property, is in [API.md](./API.md).
@@ -0,0 +1,8 @@
1
+ import { Component, javascript } from 'projen';
2
+ /**
3
+ * Full TypeScript application source structure (handlers/business logic),
4
+ * layered on top of `CdkTypescriptProject`'s pure-infra scaffold.
5
+ */
6
+ export declare class AppRuntimeScaffold extends Component {
7
+ constructor(project: javascript.NodeProject, appEntryPoint?: string);
8
+ }
@@ -0,0 +1,31 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.AppRuntimeScaffold = void 0;
4
+ const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
5
+ const projen_1 = require("projen");
6
+ /**
7
+ * Full TypeScript application source structure (handlers/business logic),
8
+ * layered on top of `CdkTypescriptProject`'s pure-infra scaffold.
9
+ */
10
+ class AppRuntimeScaffold extends projen_1.Component {
11
+ static [JSII_RTTI_SYMBOL_1] = { fqn: "@xpertss/projen-types.AppRuntimeScaffold", version: "0.0.0" };
12
+ constructor(project, appEntryPoint = 'src/app.ts') {
13
+ super(project, 'AppRuntimeScaffold');
14
+ const app = new projen_1.SourceCode(project, appEntryPoint);
15
+ app.line('export function handler() {');
16
+ app.line(' // TODO: implement application entrypoint');
17
+ app.line('}');
18
+ const handler = new projen_1.SourceCode(project, 'src/handlers/example.ts');
19
+ handler.line('import type { APIGatewayProxyHandler } from "aws-lambda";');
20
+ handler.line();
21
+ handler.open('export const exampleHandler: APIGatewayProxyHandler = async (event) => {');
22
+ handler.line('return {');
23
+ handler.line(' statusCode: 200,');
24
+ handler.line(' body: JSON.stringify({ message: "ok" }),');
25
+ handler.line('};');
26
+ handler.close('};');
27
+ project.addDevDeps('@types/aws-lambda');
28
+ }
29
+ }
30
+ exports.AppRuntimeScaffold = AppRuntimeScaffold;
31
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBwLXJ1bnRpbWUtc2NhZmZvbGQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY2RrL2FwcC1ydW50aW1lLXNjYWZmb2xkLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7QUFBQSxtQ0FBMkQ7QUFFM0Q7OztHQUdHO0FBQ0gsTUFBYSxrQkFBbUIsU0FBUSxrQkFBUzs7SUFDL0MsWUFBWSxPQUErQixFQUFFLGFBQWEsR0FBRyxZQUFZO1FBQ3ZFLEtBQUssQ0FBQyxPQUFPLEVBQUUsb0JBQW9CLENBQUMsQ0FBQztRQUVyQyxNQUFNLEdBQUcsR0FBRyxJQUFJLG1CQUFVLENBQUMsT0FBTyxFQUFFLGFBQWEsQ0FBQyxDQUFDO1FBQ25ELEdBQUcsQ0FBQyxJQUFJLENBQUMsNkJBQTZCLENBQUMsQ0FBQztRQUN4QyxHQUFHLENBQUMsSUFBSSxDQUFDLDZDQUE2QyxDQUFDLENBQUM7UUFDeEQsR0FBRyxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUVkLE1BQU0sT0FBTyxHQUFHLElBQUksbUJBQVUsQ0FBQyxPQUFPLEVBQUUseUJBQXlCLENBQUMsQ0FBQztRQUNuRSxPQUFPLENBQUMsSUFBSSxDQUNWLDJEQUEyRCxDQUM1RCxDQUFDO1FBQ0YsT0FBTyxDQUFDLElBQUksRUFBRSxDQUFDO1FBQ2YsT0FBTyxDQUFDLElBQUksQ0FBQywwRUFBMEUsQ0FBQyxDQUFDO1FBQ3pGLE9BQU8sQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUM7UUFDekIsT0FBTyxDQUFDLElBQUksQ0FBQyxvQkFBb0IsQ0FBQyxDQUFDO1FBQ25DLE9BQU8sQ0FBQyxJQUFJLENBQUMsNENBQTRDLENBQUMsQ0FBQztRQUMzRCxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQ25CLE9BQU8sQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUM7UUFFcEIsT0FBTyxDQUFDLFVBQVUsQ0FBQyxtQkFBbUIsQ0FBQyxDQUFDO0lBQzFDLENBQUM7O0FBdEJILGdEQXVCQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IENvbXBvbmVudCwgU291cmNlQ29kZSwgamF2YXNjcmlwdCB9IGZyb20gJ3Byb2plbic7XG5cbi8qKlxuICogRnVsbCBUeXBlU2NyaXB0IGFwcGxpY2F0aW9uIHNvdXJjZSBzdHJ1Y3R1cmUgKGhhbmRsZXJzL2J1c2luZXNzIGxvZ2ljKSxcbiAqIGxheWVyZWQgb24gdG9wIG9mIGBDZGtUeXBlc2NyaXB0UHJvamVjdGAncyBwdXJlLWluZnJhIHNjYWZmb2xkLlxuICovXG5leHBvcnQgY2xhc3MgQXBwUnVudGltZVNjYWZmb2xkIGV4dGVuZHMgQ29tcG9uZW50IHtcbiAgY29uc3RydWN0b3IocHJvamVjdDogamF2YXNjcmlwdC5Ob2RlUHJvamVjdCwgYXBwRW50cnlQb2ludCA9ICdzcmMvYXBwLnRzJykge1xuICAgIHN1cGVyKHByb2plY3QsICdBcHBSdW50aW1lU2NhZmZvbGQnKTtcblxuICAgIGNvbnN0IGFwcCA9IG5ldyBTb3VyY2VDb2RlKHByb2plY3QsIGFwcEVudHJ5UG9pbnQpO1xuICAgIGFwcC5saW5lKCdleHBvcnQgZnVuY3Rpb24gaGFuZGxlcigpIHsnKTtcbiAgICBhcHAubGluZSgnICAvLyBUT0RPOiBpbXBsZW1lbnQgYXBwbGljYXRpb24gZW50cnlwb2ludCcpO1xuICAgIGFwcC5saW5lKCd9Jyk7XG5cbiAgICBjb25zdCBoYW5kbGVyID0gbmV3IFNvdXJjZUNvZGUocHJvamVjdCwgJ3NyYy9oYW5kbGVycy9leGFtcGxlLnRzJyk7XG4gICAgaGFuZGxlci5saW5lKFxuICAgICAgJ2ltcG9ydCB0eXBlIHsgQVBJR2F0ZXdheVByb3h5SGFuZGxlciB9IGZyb20gXCJhd3MtbGFtYmRhXCI7JyxcbiAgICApO1xuICAgIGhhbmRsZXIubGluZSgpO1xuICAgIGhhbmRsZXIub3BlbignZXhwb3J0IGNvbnN0IGV4YW1wbGVIYW5kbGVyOiBBUElHYXRld2F5UHJveHlIYW5kbGVyID0gYXN5bmMgKGV2ZW50KSA9PiB7Jyk7XG4gICAgaGFuZGxlci5saW5lKCdyZXR1cm4geycpO1xuICAgIGhhbmRsZXIubGluZSgnICBzdGF0dXNDb2RlOiAyMDAsJyk7XG4gICAgaGFuZGxlci5saW5lKCcgIGJvZHk6IEpTT04uc3RyaW5naWZ5KHsgbWVzc2FnZTogXCJva1wiIH0pLCcpO1xuICAgIGhhbmRsZXIubGluZSgnfTsnKTtcbiAgICBoYW5kbGVyLmNsb3NlKCd9OycpO1xuXG4gICAgcHJvamVjdC5hZGREZXZEZXBzKCdAdHlwZXMvYXdzLWxhbWJkYScpO1xuICB9XG59XG4iXX0=
@@ -0,0 +1,10 @@
1
+ import { CdkInfraProject } from './cdk-infra-project';
2
+ import { CdkAppProjectOptions } from './options';
3
+ /**
4
+ * Full TypeScript service application running behind API Gateway (or
5
+ * similar), with the infra to support it - `CdkInfraProject` plus
6
+ * application source, a database, and an app-level build/test workflow.
7
+ */
8
+ export declare class CdkAppProject extends CdkInfraProject {
9
+ constructor(options: CdkAppProjectOptions);
10
+ }
@@ -0,0 +1,35 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.CdkAppProject = void 0;
4
+ const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
5
+ const projen_1 = require("projen");
6
+ const app_runtime_scaffold_1 = require("./app-runtime-scaffold");
7
+ const cdk_infra_project_1 = require("./cdk-infra-project");
8
+ const database_component_1 = require("./database-component");
9
+ const drift_check_1 = require("../common/drift-check");
10
+ /**
11
+ * Full TypeScript service application running behind API Gateway (or
12
+ * similar), with the infra to support it - `CdkInfraProject` plus
13
+ * application source, a database, and an app-level build/test workflow.
14
+ */
15
+ class CdkAppProject extends cdk_infra_project_1.CdkInfraProject {
16
+ static [JSII_RTTI_SYMBOL_1] = { fqn: "@xpertss/projen-types.CdkAppProject", version: "0.0.0" };
17
+ constructor(options) {
18
+ super(options);
19
+ new app_runtime_scaffold_1.AppRuntimeScaffold(this, options.appEntryPoint ?? 'src/app.ts');
20
+ new database_component_1.DatabaseComponent(this, options.database);
21
+ const gh = this.github;
22
+ if (gh) {
23
+ new projen_1.github.TaskWorkflow(gh, {
24
+ name: 'app-build',
25
+ jobId: 'app-build',
26
+ task: this.testTask,
27
+ triggers: { pullRequest: {}, workflowDispatch: {} },
28
+ permissions: { contents: projen_1.github.workflows.JobPermission.READ },
29
+ postBuildSteps: (0, drift_check_1.driftCheckSteps)(),
30
+ });
31
+ }
32
+ }
33
+ }
34
+ exports.CdkAppProject = CdkAppProject;
35
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2RrLWFwcC1wcm9qZWN0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2Nkay9jZGstYXBwLXByb2plY3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7OztBQUFBLG1DQUFnQztBQUNoQyxpRUFBNEQ7QUFDNUQsMkRBQXNEO0FBQ3RELDZEQUF5RDtBQUV6RCx1REFBd0Q7QUFFeEQ7Ozs7R0FJRztBQUNILE1BQWEsYUFBYyxTQUFRLG1DQUFlOztJQUNoRCxZQUFZLE9BQTZCO1FBQ3ZDLEtBQUssQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUVmLElBQUkseUNBQWtCLENBQUMsSUFBSSxFQUFFLE9BQU8sQ0FBQyxhQUFhLElBQUksWUFBWSxDQUFDLENBQUM7UUFDcEUsSUFBSSxzQ0FBaUIsQ0FBQyxJQUFJLEVBQUUsT0FBTyxDQUFDLFFBQVEsQ0FBQyxDQUFDO1FBRTlDLE1BQU0sRUFBRSxHQUFHLElBQUksQ0FBQyxNQUFNLENBQUM7UUFDdkIsSUFBSSxFQUFFLEVBQUUsQ0FBQztZQUNQLElBQUksZUFBTSxDQUFDLFlBQVksQ0FBQyxFQUFFLEVBQUU7Z0JBQzFCLElBQUksRUFBRSxXQUFXO2dCQUNqQixLQUFLLEVBQUUsV0FBVztnQkFDbEIsSUFBSSxFQUFFLElBQUksQ0FBQyxRQUFRO2dCQUNuQixRQUFRLEVBQUUsRUFBRSxXQUFXLEVBQUUsRUFBRSxFQUFFLGdCQUFnQixFQUFFLEVBQUUsRUFBRTtnQkFDbkQsV0FBVyxFQUFFLEVBQUUsUUFBUSxFQUFFLGVBQU0sQ0FBQyxTQUFTLENBQUMsYUFBYSxDQUFDLElBQUksRUFBRTtnQkFDOUQsY0FBYyxFQUFFLElBQUEsNkJBQWUsR0FBRTthQUNsQyxDQUFDLENBQUM7UUFDTCxDQUFDO0lBQ0gsQ0FBQzs7QUFsQkgsc0NBbUJDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgZ2l0aHViIH0gZnJvbSAncHJvamVuJztcbmltcG9ydCB7IEFwcFJ1bnRpbWVTY2FmZm9sZCB9IGZyb20gJy4vYXBwLXJ1bnRpbWUtc2NhZmZvbGQnO1xuaW1wb3J0IHsgQ2RrSW5mcmFQcm9qZWN0IH0gZnJvbSAnLi9jZGstaW5mcmEtcHJvamVjdCc7XG5pbXBvcnQgeyBEYXRhYmFzZUNvbXBvbmVudCB9IGZyb20gJy4vZGF0YWJhc2UtY29tcG9uZW50JztcbmltcG9ydCB7IENka0FwcFByb2plY3RPcHRpb25zIH0gZnJvbSAnLi9vcHRpb25zJztcbmltcG9ydCB7IGRyaWZ0Q2hlY2tTdGVwcyB9IGZyb20gJy4uL2NvbW1vbi9kcmlmdC1jaGVjayc7XG5cbi8qKlxuICogRnVsbCBUeXBlU2NyaXB0IHNlcnZpY2UgYXBwbGljYXRpb24gcnVubmluZyBiZWhpbmQgQVBJIEdhdGV3YXkgKG9yXG4gKiBzaW1pbGFyKSwgd2l0aCB0aGUgaW5mcmEgdG8gc3VwcG9ydCBpdCAtIGBDZGtJbmZyYVByb2plY3RgIHBsdXNcbiAqIGFwcGxpY2F0aW9uIHNvdXJjZSwgYSBkYXRhYmFzZSwgYW5kIGFuIGFwcC1sZXZlbCBidWlsZC90ZXN0IHdvcmtmbG93LlxuICovXG5leHBvcnQgY2xhc3MgQ2RrQXBwUHJvamVjdCBleHRlbmRzIENka0luZnJhUHJvamVjdCB7XG4gIGNvbnN0cnVjdG9yKG9wdGlvbnM6IENka0FwcFByb2plY3RPcHRpb25zKSB7XG4gICAgc3VwZXIob3B0aW9ucyk7XG5cbiAgICBuZXcgQXBwUnVudGltZVNjYWZmb2xkKHRoaXMsIG9wdGlvbnMuYXBwRW50cnlQb2ludCA/PyAnc3JjL2FwcC50cycpO1xuICAgIG5ldyBEYXRhYmFzZUNvbXBvbmVudCh0aGlzLCBvcHRpb25zLmRhdGFiYXNlKTtcblxuICAgIGNvbnN0IGdoID0gdGhpcy5naXRodWI7XG4gICAgaWYgKGdoKSB7XG4gICAgICBuZXcgZ2l0aHViLlRhc2tXb3JrZmxvdyhnaCwge1xuICAgICAgICBuYW1lOiAnYXBwLWJ1aWxkJyxcbiAgICAgICAgam9iSWQ6ICdhcHAtYnVpbGQnLFxuICAgICAgICB0YXNrOiB0aGlzLnRlc3RUYXNrLFxuICAgICAgICB0cmlnZ2VyczogeyBwdWxsUmVxdWVzdDoge30sIHdvcmtmbG93RGlzcGF0Y2g6IHt9IH0sXG4gICAgICAgIHBlcm1pc3Npb25zOiB7IGNvbnRlbnRzOiBnaXRodWIud29ya2Zsb3dzLkpvYlBlcm1pc3Npb24uUkVBRCB9LFxuICAgICAgICBwb3N0QnVpbGRTdGVwczogZHJpZnRDaGVja1N0ZXBzKCksXG4gICAgICB9KTtcbiAgICB9XG4gIH1cbn1cbiJdfQ==
@@ -0,0 +1,10 @@
1
+ import { CdkTypescriptProject } from './cdk-typescript-base';
2
+ import { CdkInfraProjectOptions } from './options';
3
+ /**
4
+ * Pure infrastructure CDK stacks - little or no application code
5
+ * (CloudFront, Route53, SQS, API Gateway, Cognito, ECR/ECS standing up
6
+ * externally-built images). Reference example: SimulcastAVDelivery.
7
+ */
8
+ export declare class CdkInfraProject extends CdkTypescriptProject {
9
+ constructor(options: CdkInfraProjectOptions);
10
+ }
@@ -0,0 +1,26 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.CdkInfraProject = void 0;
4
+ const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
5
+ const cdk_typescript_base_1 = require("./cdk-typescript-base");
6
+ const ecr_ecs_constructs_1 = require("./components/ecr-ecs-constructs");
7
+ const edge_networking_constructs_1 = require("./components/edge-networking-constructs");
8
+ /**
9
+ * Pure infrastructure CDK stacks - little or no application code
10
+ * (CloudFront, Route53, SQS, API Gateway, Cognito, ECR/ECS standing up
11
+ * externally-built images). Reference example: SimulcastAVDelivery.
12
+ */
13
+ class CdkInfraProject extends cdk_typescript_base_1.CdkTypescriptProject {
14
+ static [JSII_RTTI_SYMBOL_1] = { fqn: "@xpertss/projen-types.CdkInfraProject", version: "0.0.0" };
15
+ constructor(options) {
16
+ super(options);
17
+ if (options.ecrEcs?.enabled) {
18
+ new ecr_ecs_constructs_1.EcrEcsConstructs(this, options.ecrEcs);
19
+ }
20
+ if (options.edgeResources && options.edgeResources.length > 0) {
21
+ new edge_networking_constructs_1.EdgeNetworkingConstructs(this, options.edgeResources);
22
+ }
23
+ }
24
+ }
25
+ exports.CdkInfraProject = CdkInfraProject;
26
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2RrLWluZnJhLXByb2plY3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY2RrL2Nkay1pbmZyYS1wcm9qZWN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7QUFBQSwrREFBNkQ7QUFDN0Qsd0VBQW1FO0FBQ25FLHdGQUFtRjtBQUduRjs7OztHQUlHO0FBQ0gsTUFBYSxlQUFnQixTQUFRLDBDQUFvQjs7SUFDdkQsWUFBWSxPQUErQjtRQUN6QyxLQUFLLENBQUMsT0FBTyxDQUFDLENBQUM7UUFFZixJQUFJLE9BQU8sQ0FBQyxNQUFNLEVBQUUsT0FBTyxFQUFFLENBQUM7WUFDNUIsSUFBSSxxQ0FBZ0IsQ0FBQyxJQUFJLEVBQUUsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFDO1FBQzdDLENBQUM7UUFFRCxJQUFJLE9BQU8sQ0FBQyxhQUFhLElBQUksT0FBTyxDQUFDLGFBQWEsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxFQUFFLENBQUM7WUFDOUQsSUFBSSxxREFBd0IsQ0FBQyxJQUFJLEVBQUUsT0FBTyxDQUFDLGFBQWEsQ0FBQyxDQUFDO1FBQzVELENBQUM7SUFDSCxDQUFDOztBQVhILDBDQVlDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgQ2RrVHlwZXNjcmlwdFByb2plY3QgfSBmcm9tICcuL2Nkay10eXBlc2NyaXB0LWJhc2UnO1xuaW1wb3J0IHsgRWNyRWNzQ29uc3RydWN0cyB9IGZyb20gJy4vY29tcG9uZW50cy9lY3ItZWNzLWNvbnN0cnVjdHMnO1xuaW1wb3J0IHsgRWRnZU5ldHdvcmtpbmdDb25zdHJ1Y3RzIH0gZnJvbSAnLi9jb21wb25lbnRzL2VkZ2UtbmV0d29ya2luZy1jb25zdHJ1Y3RzJztcbmltcG9ydCB7IENka0luZnJhUHJvamVjdE9wdGlvbnMgfSBmcm9tICcuL29wdGlvbnMnO1xuXG4vKipcbiAqIFB1cmUgaW5mcmFzdHJ1Y3R1cmUgQ0RLIHN0YWNrcyAtIGxpdHRsZSBvciBubyBhcHBsaWNhdGlvbiBjb2RlXG4gKiAoQ2xvdWRGcm9udCwgUm91dGU1MywgU1FTLCBBUEkgR2F0ZXdheSwgQ29nbml0bywgRUNSL0VDUyBzdGFuZGluZyB1cFxuICogZXh0ZXJuYWxseS1idWlsdCBpbWFnZXMpLiBSZWZlcmVuY2UgZXhhbXBsZTogU2ltdWxjYXN0QVZEZWxpdmVyeS5cbiAqL1xuZXhwb3J0IGNsYXNzIENka0luZnJhUHJvamVjdCBleHRlbmRzIENka1R5cGVzY3JpcHRQcm9qZWN0IHtcbiAgY29uc3RydWN0b3Iob3B0aW9uczogQ2RrSW5mcmFQcm9qZWN0T3B0aW9ucykge1xuICAgIHN1cGVyKG9wdGlvbnMpO1xuXG4gICAgaWYgKG9wdGlvbnMuZWNyRWNzPy5lbmFibGVkKSB7XG4gICAgICBuZXcgRWNyRWNzQ29uc3RydWN0cyh0aGlzLCBvcHRpb25zLmVjckVjcyk7XG4gICAgfVxuXG4gICAgaWYgKG9wdGlvbnMuZWRnZVJlc291cmNlcyAmJiBvcHRpb25zLmVkZ2VSZXNvdXJjZXMubGVuZ3RoID4gMCkge1xuICAgICAgbmV3IEVkZ2VOZXR3b3JraW5nQ29uc3RydWN0cyh0aGlzLCBvcHRpb25zLmVkZ2VSZXNvdXJjZXMpO1xuICAgIH1cbiAgfVxufVxuIl19
@@ -0,0 +1,16 @@
1
+ import { awscdk } from 'projen';
2
+ import { CommonCdkOptions } from './options';
3
+ import { EnvironmentOptions } from '../common/environment-options';
4
+ export interface CdkTypescriptProjectOptions extends CommonCdkOptions {
5
+ readonly environments?: (string | EnvironmentOptions)[];
6
+ }
7
+ /**
8
+ * Shared CDK + TypeScript foundation for `CdkInfraProject` and
9
+ * `CdkAppProject`: standard app structure (via `AwsCdkTypeScriptApp`,
10
+ * `cdk.json`, `cdk synth`/`cdk diff` tasks), a PR-check build that hard-fails
11
+ * on projen drift (rather than self-mutating), and an optional
12
+ * `ManualDeployWorkflow` when `environments` is provided.
13
+ */
14
+ export declare class CdkTypescriptProject extends awscdk.AwsCdkTypeScriptApp {
15
+ constructor(options: CdkTypescriptProjectOptions);
16
+ }