@taimos/projen 0.1.94 → 0.1.96

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.
package/API.md CHANGED
@@ -13238,8 +13238,11 @@ const monorepoProjectOptions: MonorepoProjectOptions = { ... }
13238
13238
  | <code><a href="#@taimos/projen.MonorepoProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
13239
13239
  | <code><a href="#@taimos/projen.MonorepoProjectOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
13240
13240
  | <code><a href="#@taimos/projen.MonorepoProjectOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
13241
+ | <code><a href="#@taimos/projen.MonorepoProjectOptions.property.npmVerifyPublished">npmVerifyPublished</a></code> | <code>boolean</code> | Wait until the published package version is available from the npm registry before the publish job completes. |
13242
+ | <code><a href="#@taimos/projen.MonorepoProjectOptions.property.npmVerifyPublishedTimeoutSeconds">npmVerifyPublishedTimeoutSeconds</a></code> | <code>number</code> | How long to wait, in seconds, for the published package version to be available. |
13241
13243
  | <code><a href="#@taimos/projen.MonorepoProjectOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
13242
13244
  | <code><a href="#@taimos/projen.MonorepoProjectOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
13245
+ | <code><a href="#@taimos/projen.MonorepoProjectOptions.property.peerDependenciesMeta">peerDependenciesMeta</a></code> | <code>{[ key: string ]: projen.javascript.PeerDependencyMeta}</code> | Additional information about how peer dependencies are used, rendered as `peerDependenciesMeta` in `package.json`. For example, this can mark peer dependencies as optional. |
13243
13246
  | <code><a href="#@taimos/projen.MonorepoProjectOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
13244
13247
  | <code><a href="#@taimos/projen.MonorepoProjectOptions.property.peerDeps">peerDeps</a></code> | <code>string[]</code> | Peer dependencies for this module. |
13245
13248
  | <code><a href="#@taimos/projen.MonorepoProjectOptions.property.pnpmOptions">pnpmOptions</a></code> | <code>projen.javascript.PnpmOptions</code> | Options for pnpm. |
@@ -13313,6 +13316,7 @@ const monorepoProjectOptions: MonorepoProjectOptions = { ... }
13313
13316
  | <code><a href="#@taimos/projen.MonorepoProjectOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
13314
13317
  | <code><a href="#@taimos/projen.MonorepoProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
13315
13318
  | <code><a href="#@taimos/projen.MonorepoProjectOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
13319
+ | <code><a href="#@taimos/projen.MonorepoProjectOptions.property.workflowPermissions">workflowPermissions</a></code> | <code>projen.github.workflows.JobPermissions</code> | Permissions for the main build, release and dependency upgrade jobs. |
13316
13320
  | <code><a href="#@taimos/projen.MonorepoProjectOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
13317
13321
  | <code><a href="#@taimos/projen.MonorepoProjectOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a development tsconfig file. |
13318
13322
  | <code><a href="#@taimos/projen.MonorepoProjectOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
@@ -14246,7 +14250,8 @@ public readonly npmRegistryUrl: string;
14246
14250
 
14247
14251
  The base URL of the npm package registry.
14248
14252
 
14249
- Must be a URL (e.g. start with "https://" or "http://")
14253
+ Must be a URL (e.g. start with "https://" or "http://").
14254
+ A trailing slash is added if missing.
14250
14255
 
14251
14256
  ---
14252
14257
 
@@ -14276,6 +14281,36 @@ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on
14276
14281
 
14277
14282
  ---
14278
14283
 
14284
+ ##### `npmVerifyPublished`<sup>Optional</sup> <a name="npmVerifyPublished" id="@taimos/projen.MonorepoProjectOptions.property.npmVerifyPublished"></a>
14285
+
14286
+ ```typescript
14287
+ public readonly npmVerifyPublished: boolean;
14288
+ ```
14289
+
14290
+ - *Type:* boolean
14291
+ - *Default:* false
14292
+
14293
+ Wait until the published package version is available from the npm registry before the publish job completes.
14294
+
14295
+ Enable this when packages that depend on the published package are released right after.
14296
+
14297
+ ---
14298
+
14299
+ ##### `npmVerifyPublishedTimeoutSeconds`<sup>Optional</sup> <a name="npmVerifyPublishedTimeoutSeconds" id="@taimos/projen.MonorepoProjectOptions.property.npmVerifyPublishedTimeoutSeconds"></a>
14300
+
14301
+ ```typescript
14302
+ public readonly npmVerifyPublishedTimeoutSeconds: number;
14303
+ ```
14304
+
14305
+ - *Type:* number
14306
+ - *Default:* 3600
14307
+
14308
+ How long to wait, in seconds, for the published package version to be available.
14309
+
14310
+ Requires `npmVerifyPublished` to be enabled.
14311
+
14312
+ ---
14313
+
14279
14314
  ##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="@taimos/projen.MonorepoProjectOptions.property.packageManager"></a>
14280
14315
 
14281
14316
  ```typescript
@@ -14302,6 +14337,30 @@ The "name" in package.json.
14302
14337
 
14303
14338
  ---
14304
14339
 
14340
+ ##### `peerDependenciesMeta`<sup>Optional</sup> <a name="peerDependenciesMeta" id="@taimos/projen.MonorepoProjectOptions.property.peerDependenciesMeta"></a>
14341
+
14342
+ ```typescript
14343
+ public readonly peerDependenciesMeta: {[ key: string ]: PeerDependencyMeta};
14344
+ ```
14345
+
14346
+ - *Type:* {[ key: string ]: projen.javascript.PeerDependencyMeta}
14347
+ - *Default:* no `peerDependenciesMeta`
14348
+
14349
+ Additional information about how peer dependencies are used, rendered as `peerDependenciesMeta` in `package.json`. For example, this can mark peer dependencies as optional.
14350
+
14351
+ Each key must also be declared as a peer dependency.
14352
+
14353
+ > [https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerdependenciesmeta](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerdependenciesmeta)
14354
+
14355
+ ---
14356
+
14357
+ *Example*
14358
+
14359
+ ```typescript
14360
+ { "aws-cdk-lib": { optional: true } }
14361
+ ```
14362
+
14363
+
14305
14364
  ##### `peerDependencyOptions`<sup>Optional</sup> <a name="peerDependencyOptions" id="@taimos/projen.MonorepoProjectOptions.property.peerDependencyOptions"></a>
14306
14365
 
14307
14366
  ```typescript
@@ -15346,6 +15405,28 @@ Enable Node.js package cache in GitHub workflows.
15346
15405
 
15347
15406
  ---
15348
15407
 
15408
+ ##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="@taimos/projen.MonorepoProjectOptions.property.workflowPermissions"></a>
15409
+
15410
+ ```typescript
15411
+ public readonly workflowPermissions: JobPermissions;
15412
+ ```
15413
+
15414
+ - *Type:* projen.github.workflows.JobPermissions
15415
+ - *Default:* Use the job defaults and automatically inferred permissions.
15416
+
15417
+ Permissions for the main build, release and dependency upgrade jobs.
15418
+
15419
+ Defined scopes override the job defaults and automatically inferred permissions,
15420
+ including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
15421
+ Use `JobPermission.NONE` to explicitly remove a permission.
15422
+
15423
+ `buildWorkflowOptions.permissions` replaces this entire set, including automatic
15424
+ permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
15425
+ scopes. Applies to all release branches, but not to separate package, publishing,
15426
+ self-mutation or pull request creation jobs, or unrelated workflows.
15427
+
15428
+ ---
15429
+
15349
15430
  ##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="@taimos/projen.MonorepoProjectOptions.property.disableTsconfig"></a>
15350
15431
 
15351
15432
  ```typescript
@@ -16006,8 +16087,11 @@ const privateTaimosCdkAppOptions: PrivateTaimosCdkAppOptions = { ... }
16006
16087
  | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
16007
16088
  | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
16008
16089
  | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
16090
+ | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.npmVerifyPublished">npmVerifyPublished</a></code> | <code>boolean</code> | Wait until the published package version is available from the npm registry before the publish job completes. |
16091
+ | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.npmVerifyPublishedTimeoutSeconds">npmVerifyPublishedTimeoutSeconds</a></code> | <code>number</code> | How long to wait, in seconds, for the published package version to be available. |
16009
16092
  | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
16010
16093
  | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
16094
+ | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.peerDependenciesMeta">peerDependenciesMeta</a></code> | <code>{[ key: string ]: projen.javascript.PeerDependencyMeta}</code> | Additional information about how peer dependencies are used, rendered as `peerDependenciesMeta` in `package.json`. For example, this can mark peer dependencies as optional. |
16011
16095
  | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
16012
16096
  | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.peerDeps">peerDeps</a></code> | <code>string[]</code> | Peer dependencies for this module. |
16013
16097
  | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.pnpmOptions">pnpmOptions</a></code> | <code>projen.javascript.PnpmOptions</code> | Options for pnpm. |
@@ -16081,6 +16165,7 @@ const privateTaimosCdkAppOptions: PrivateTaimosCdkAppOptions = { ... }
16081
16165
  | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
16082
16166
  | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
16083
16167
  | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
16168
+ | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.workflowPermissions">workflowPermissions</a></code> | <code>projen.github.workflows.JobPermissions</code> | Permissions for the main build, release and dependency upgrade jobs. |
16084
16169
  | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
16085
16170
  | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a development tsconfig file. |
16086
16171
  | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
@@ -16106,6 +16191,7 @@ const privateTaimosCdkAppOptions: PrivateTaimosCdkAppOptions = { ... }
16106
16191
  | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.context">context</a></code> | <code>{[ key: string ]: any}</code> | Additional context to include in `cdk.json`. |
16107
16192
  | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.featureFlags">featureFlags</a></code> | <code>projen.awscdk.ICdkFeatureFlags</code> | Feature flags that should be enabled in `cdk.json`. |
16108
16193
  | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.requireApproval">requireApproval</a></code> | <code>projen.awscdk.ApprovalLevel</code> | To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. |
16194
+ | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.versionReporting">versionReporting</a></code> | <code>boolean</code> | Enable AWS CDK library version reporting. |
16109
16195
  | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.watchExcludes">watchExcludes</a></code> | <code>string[]</code> | Glob patterns to exclude from `cdk watch`. |
16110
16196
  | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.watchIncludes">watchIncludes</a></code> | <code>string[]</code> | Glob patterns to include in `cdk watch`. |
16111
16197
  | <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.cdkVersion">cdkVersion</a></code> | <code>string</code> | Minimum version of the AWS CDK to depend on. |
@@ -17022,7 +17108,8 @@ public readonly npmRegistryUrl: string;
17022
17108
 
17023
17109
  The base URL of the npm package registry.
17024
17110
 
17025
- Must be a URL (e.g. start with "https://" or "http://")
17111
+ Must be a URL (e.g. start with "https://" or "http://").
17112
+ A trailing slash is added if missing.
17026
17113
 
17027
17114
  ---
17028
17115
 
@@ -17052,6 +17139,36 @@ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on
17052
17139
 
17053
17140
  ---
17054
17141
 
17142
+ ##### `npmVerifyPublished`<sup>Optional</sup> <a name="npmVerifyPublished" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.npmVerifyPublished"></a>
17143
+
17144
+ ```typescript
17145
+ public readonly npmVerifyPublished: boolean;
17146
+ ```
17147
+
17148
+ - *Type:* boolean
17149
+ - *Default:* false
17150
+
17151
+ Wait until the published package version is available from the npm registry before the publish job completes.
17152
+
17153
+ Enable this when packages that depend on the published package are released right after.
17154
+
17155
+ ---
17156
+
17157
+ ##### `npmVerifyPublishedTimeoutSeconds`<sup>Optional</sup> <a name="npmVerifyPublishedTimeoutSeconds" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.npmVerifyPublishedTimeoutSeconds"></a>
17158
+
17159
+ ```typescript
17160
+ public readonly npmVerifyPublishedTimeoutSeconds: number;
17161
+ ```
17162
+
17163
+ - *Type:* number
17164
+ - *Default:* 3600
17165
+
17166
+ How long to wait, in seconds, for the published package version to be available.
17167
+
17168
+ Requires `npmVerifyPublished` to be enabled.
17169
+
17170
+ ---
17171
+
17055
17172
  ##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.packageManager"></a>
17056
17173
 
17057
17174
  ```typescript
@@ -17078,6 +17195,30 @@ The "name" in package.json.
17078
17195
 
17079
17196
  ---
17080
17197
 
17198
+ ##### `peerDependenciesMeta`<sup>Optional</sup> <a name="peerDependenciesMeta" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.peerDependenciesMeta"></a>
17199
+
17200
+ ```typescript
17201
+ public readonly peerDependenciesMeta: {[ key: string ]: PeerDependencyMeta};
17202
+ ```
17203
+
17204
+ - *Type:* {[ key: string ]: projen.javascript.PeerDependencyMeta}
17205
+ - *Default:* no `peerDependenciesMeta`
17206
+
17207
+ Additional information about how peer dependencies are used, rendered as `peerDependenciesMeta` in `package.json`. For example, this can mark peer dependencies as optional.
17208
+
17209
+ Each key must also be declared as a peer dependency.
17210
+
17211
+ > [https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerdependenciesmeta](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerdependenciesmeta)
17212
+
17213
+ ---
17214
+
17215
+ *Example*
17216
+
17217
+ ```typescript
17218
+ { "aws-cdk-lib": { optional: true } }
17219
+ ```
17220
+
17221
+
17081
17222
  ##### `peerDependencyOptions`<sup>Optional</sup> <a name="peerDependencyOptions" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.peerDependencyOptions"></a>
17082
17223
 
17083
17224
  ```typescript
@@ -18122,6 +18263,28 @@ Enable Node.js package cache in GitHub workflows.
18122
18263
 
18123
18264
  ---
18124
18265
 
18266
+ ##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.workflowPermissions"></a>
18267
+
18268
+ ```typescript
18269
+ public readonly workflowPermissions: JobPermissions;
18270
+ ```
18271
+
18272
+ - *Type:* projen.github.workflows.JobPermissions
18273
+ - *Default:* Use the job defaults and automatically inferred permissions.
18274
+
18275
+ Permissions for the main build, release and dependency upgrade jobs.
18276
+
18277
+ Defined scopes override the job defaults and automatically inferred permissions,
18278
+ including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
18279
+ Use `JobPermission.NONE` to explicitly remove a permission.
18280
+
18281
+ `buildWorkflowOptions.permissions` replaces this entire set, including automatic
18282
+ permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
18283
+ scopes. Applies to all release branches, but not to separate package, publishing,
18284
+ self-mutation or pull request creation jobs, or unrelated workflows.
18285
+
18286
+ ---
18287
+
18125
18288
  ##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.disableTsconfig"></a>
18126
18289
 
18127
18290
  ```typescript
@@ -18479,6 +18642,21 @@ To protect you against unintended changes that affect your security posture, the
18479
18642
 
18480
18643
  ---
18481
18644
 
18645
+ ##### `versionReporting`<sup>Optional</sup> <a name="versionReporting" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.versionReporting"></a>
18646
+
18647
+ ```typescript
18648
+ public readonly versionReporting: boolean;
18649
+ ```
18650
+
18651
+ - *Type:* boolean
18652
+ - *Default:* use the AWS CDK default
18653
+
18654
+ Enable AWS CDK library version reporting.
18655
+
18656
+ > [https://docs.aws.amazon.com/cdk/v2/guide/usage-data.html](https://docs.aws.amazon.com/cdk/v2/guide/usage-data.html)
18657
+
18658
+ ---
18659
+
18482
18660
  ##### `watchExcludes`<sup>Optional</sup> <a name="watchExcludes" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.watchExcludes"></a>
18483
18661
 
18484
18662
  ```typescript
@@ -18779,8 +18957,11 @@ const productionTaimosCdkAppOptions: ProductionTaimosCdkAppOptions = { ... }
18779
18957
  | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
18780
18958
  | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
18781
18959
  | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
18960
+ | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.npmVerifyPublished">npmVerifyPublished</a></code> | <code>boolean</code> | Wait until the published package version is available from the npm registry before the publish job completes. |
18961
+ | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.npmVerifyPublishedTimeoutSeconds">npmVerifyPublishedTimeoutSeconds</a></code> | <code>number</code> | How long to wait, in seconds, for the published package version to be available. |
18782
18962
  | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
18783
18963
  | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
18964
+ | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.peerDependenciesMeta">peerDependenciesMeta</a></code> | <code>{[ key: string ]: projen.javascript.PeerDependencyMeta}</code> | Additional information about how peer dependencies are used, rendered as `peerDependenciesMeta` in `package.json`. For example, this can mark peer dependencies as optional. |
18784
18965
  | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
18785
18966
  | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.peerDeps">peerDeps</a></code> | <code>string[]</code> | Peer dependencies for this module. |
18786
18967
  | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.pnpmOptions">pnpmOptions</a></code> | <code>projen.javascript.PnpmOptions</code> | Options for pnpm. |
@@ -18854,6 +19035,7 @@ const productionTaimosCdkAppOptions: ProductionTaimosCdkAppOptions = { ... }
18854
19035
  | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
18855
19036
  | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
18856
19037
  | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
19038
+ | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.workflowPermissions">workflowPermissions</a></code> | <code>projen.github.workflows.JobPermissions</code> | Permissions for the main build, release and dependency upgrade jobs. |
18857
19039
  | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
18858
19040
  | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a development tsconfig file. |
18859
19041
  | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
@@ -18879,6 +19061,7 @@ const productionTaimosCdkAppOptions: ProductionTaimosCdkAppOptions = { ... }
18879
19061
  | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.context">context</a></code> | <code>{[ key: string ]: any}</code> | Additional context to include in `cdk.json`. |
18880
19062
  | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.featureFlags">featureFlags</a></code> | <code>projen.awscdk.ICdkFeatureFlags</code> | Feature flags that should be enabled in `cdk.json`. |
18881
19063
  | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.requireApproval">requireApproval</a></code> | <code>projen.awscdk.ApprovalLevel</code> | To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. |
19064
+ | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.versionReporting">versionReporting</a></code> | <code>boolean</code> | Enable AWS CDK library version reporting. |
18882
19065
  | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.watchExcludes">watchExcludes</a></code> | <code>string[]</code> | Glob patterns to exclude from `cdk watch`. |
18883
19066
  | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.watchIncludes">watchIncludes</a></code> | <code>string[]</code> | Glob patterns to include in `cdk watch`. |
18884
19067
  | <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.cdkVersion">cdkVersion</a></code> | <code>string</code> | Minimum version of the AWS CDK to depend on. |
@@ -19799,7 +19982,8 @@ public readonly npmRegistryUrl: string;
19799
19982
 
19800
19983
  The base URL of the npm package registry.
19801
19984
 
19802
- Must be a URL (e.g. start with "https://" or "http://")
19985
+ Must be a URL (e.g. start with "https://" or "http://").
19986
+ A trailing slash is added if missing.
19803
19987
 
19804
19988
  ---
19805
19989
 
@@ -19829,6 +20013,36 @@ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on
19829
20013
 
19830
20014
  ---
19831
20015
 
20016
+ ##### `npmVerifyPublished`<sup>Optional</sup> <a name="npmVerifyPublished" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.npmVerifyPublished"></a>
20017
+
20018
+ ```typescript
20019
+ public readonly npmVerifyPublished: boolean;
20020
+ ```
20021
+
20022
+ - *Type:* boolean
20023
+ - *Default:* false
20024
+
20025
+ Wait until the published package version is available from the npm registry before the publish job completes.
20026
+
20027
+ Enable this when packages that depend on the published package are released right after.
20028
+
20029
+ ---
20030
+
20031
+ ##### `npmVerifyPublishedTimeoutSeconds`<sup>Optional</sup> <a name="npmVerifyPublishedTimeoutSeconds" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.npmVerifyPublishedTimeoutSeconds"></a>
20032
+
20033
+ ```typescript
20034
+ public readonly npmVerifyPublishedTimeoutSeconds: number;
20035
+ ```
20036
+
20037
+ - *Type:* number
20038
+ - *Default:* 3600
20039
+
20040
+ How long to wait, in seconds, for the published package version to be available.
20041
+
20042
+ Requires `npmVerifyPublished` to be enabled.
20043
+
20044
+ ---
20045
+
19832
20046
  ##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.packageManager"></a>
19833
20047
 
19834
20048
  ```typescript
@@ -19855,6 +20069,30 @@ The "name" in package.json.
19855
20069
 
19856
20070
  ---
19857
20071
 
20072
+ ##### `peerDependenciesMeta`<sup>Optional</sup> <a name="peerDependenciesMeta" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.peerDependenciesMeta"></a>
20073
+
20074
+ ```typescript
20075
+ public readonly peerDependenciesMeta: {[ key: string ]: PeerDependencyMeta};
20076
+ ```
20077
+
20078
+ - *Type:* {[ key: string ]: projen.javascript.PeerDependencyMeta}
20079
+ - *Default:* no `peerDependenciesMeta`
20080
+
20081
+ Additional information about how peer dependencies are used, rendered as `peerDependenciesMeta` in `package.json`. For example, this can mark peer dependencies as optional.
20082
+
20083
+ Each key must also be declared as a peer dependency.
20084
+
20085
+ > [https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerdependenciesmeta](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerdependenciesmeta)
20086
+
20087
+ ---
20088
+
20089
+ *Example*
20090
+
20091
+ ```typescript
20092
+ { "aws-cdk-lib": { optional: true } }
20093
+ ```
20094
+
20095
+
19858
20096
  ##### `peerDependencyOptions`<sup>Optional</sup> <a name="peerDependencyOptions" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.peerDependencyOptions"></a>
19859
20097
 
19860
20098
  ```typescript
@@ -20899,6 +21137,28 @@ Enable Node.js package cache in GitHub workflows.
20899
21137
 
20900
21138
  ---
20901
21139
 
21140
+ ##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.workflowPermissions"></a>
21141
+
21142
+ ```typescript
21143
+ public readonly workflowPermissions: JobPermissions;
21144
+ ```
21145
+
21146
+ - *Type:* projen.github.workflows.JobPermissions
21147
+ - *Default:* Use the job defaults and automatically inferred permissions.
21148
+
21149
+ Permissions for the main build, release and dependency upgrade jobs.
21150
+
21151
+ Defined scopes override the job defaults and automatically inferred permissions,
21152
+ including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
21153
+ Use `JobPermission.NONE` to explicitly remove a permission.
21154
+
21155
+ `buildWorkflowOptions.permissions` replaces this entire set, including automatic
21156
+ permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
21157
+ scopes. Applies to all release branches, but not to separate package, publishing,
21158
+ self-mutation or pull request creation jobs, or unrelated workflows.
21159
+
21160
+ ---
21161
+
20902
21162
  ##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.disableTsconfig"></a>
20903
21163
 
20904
21164
  ```typescript
@@ -21256,6 +21516,21 @@ To protect you against unintended changes that affect your security posture, the
21256
21516
 
21257
21517
  ---
21258
21518
 
21519
+ ##### `versionReporting`<sup>Optional</sup> <a name="versionReporting" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.versionReporting"></a>
21520
+
21521
+ ```typescript
21522
+ public readonly versionReporting: boolean;
21523
+ ```
21524
+
21525
+ - *Type:* boolean
21526
+ - *Default:* use the AWS CDK default
21527
+
21528
+ Enable AWS CDK library version reporting.
21529
+
21530
+ > [https://docs.aws.amazon.com/cdk/v2/guide/usage-data.html](https://docs.aws.amazon.com/cdk/v2/guide/usage-data.html)
21531
+
21532
+ ---
21533
+
21259
21534
  ##### `watchExcludes`<sup>Optional</sup> <a name="watchExcludes" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.watchExcludes"></a>
21260
21535
 
21261
21536
  ```typescript
@@ -21650,8 +21925,11 @@ const taimosApiLibraryOptions: TaimosApiLibraryOptions = { ... }
21650
21925
  | <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
21651
21926
  | <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
21652
21927
  | <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
21928
+ | <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.npmVerifyPublished">npmVerifyPublished</a></code> | <code>boolean</code> | Wait until the published package version is available from the npm registry before the publish job completes. |
21929
+ | <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.npmVerifyPublishedTimeoutSeconds">npmVerifyPublishedTimeoutSeconds</a></code> | <code>number</code> | How long to wait, in seconds, for the published package version to be available. |
21653
21930
  | <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
21654
21931
  | <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
21932
+ | <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.peerDependenciesMeta">peerDependenciesMeta</a></code> | <code>{[ key: string ]: projen.javascript.PeerDependencyMeta}</code> | Additional information about how peer dependencies are used, rendered as `peerDependenciesMeta` in `package.json`. For example, this can mark peer dependencies as optional. |
21655
21933
  | <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
21656
21934
  | <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.peerDeps">peerDeps</a></code> | <code>string[]</code> | Peer dependencies for this module. |
21657
21935
  | <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.pnpmOptions">pnpmOptions</a></code> | <code>projen.javascript.PnpmOptions</code> | Options for pnpm. |
@@ -21725,6 +22003,7 @@ const taimosApiLibraryOptions: TaimosApiLibraryOptions = { ... }
21725
22003
  | <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
21726
22004
  | <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
21727
22005
  | <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
22006
+ | <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.workflowPermissions">workflowPermissions</a></code> | <code>projen.github.workflows.JobPermissions</code> | Permissions for the main build, release and dependency upgrade jobs. |
21728
22007
  | <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
21729
22008
  | <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a development tsconfig file. |
21730
22009
  | <code><a href="#@taimos/projen.TaimosApiLibraryOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
@@ -22648,7 +22927,8 @@ public readonly npmRegistryUrl: string;
22648
22927
 
22649
22928
  The base URL of the npm package registry.
22650
22929
 
22651
- Must be a URL (e.g. start with "https://" or "http://")
22930
+ Must be a URL (e.g. start with "https://" or "http://").
22931
+ A trailing slash is added if missing.
22652
22932
 
22653
22933
  ---
22654
22934
 
@@ -22678,6 +22958,36 @@ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on
22678
22958
 
22679
22959
  ---
22680
22960
 
22961
+ ##### `npmVerifyPublished`<sup>Optional</sup> <a name="npmVerifyPublished" id="@taimos/projen.TaimosApiLibraryOptions.property.npmVerifyPublished"></a>
22962
+
22963
+ ```typescript
22964
+ public readonly npmVerifyPublished: boolean;
22965
+ ```
22966
+
22967
+ - *Type:* boolean
22968
+ - *Default:* false
22969
+
22970
+ Wait until the published package version is available from the npm registry before the publish job completes.
22971
+
22972
+ Enable this when packages that depend on the published package are released right after.
22973
+
22974
+ ---
22975
+
22976
+ ##### `npmVerifyPublishedTimeoutSeconds`<sup>Optional</sup> <a name="npmVerifyPublishedTimeoutSeconds" id="@taimos/projen.TaimosApiLibraryOptions.property.npmVerifyPublishedTimeoutSeconds"></a>
22977
+
22978
+ ```typescript
22979
+ public readonly npmVerifyPublishedTimeoutSeconds: number;
22980
+ ```
22981
+
22982
+ - *Type:* number
22983
+ - *Default:* 3600
22984
+
22985
+ How long to wait, in seconds, for the published package version to be available.
22986
+
22987
+ Requires `npmVerifyPublished` to be enabled.
22988
+
22989
+ ---
22990
+
22681
22991
  ##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="@taimos/projen.TaimosApiLibraryOptions.property.packageManager"></a>
22682
22992
 
22683
22993
  ```typescript
@@ -22704,6 +23014,30 @@ The "name" in package.json.
22704
23014
 
22705
23015
  ---
22706
23016
 
23017
+ ##### `peerDependenciesMeta`<sup>Optional</sup> <a name="peerDependenciesMeta" id="@taimos/projen.TaimosApiLibraryOptions.property.peerDependenciesMeta"></a>
23018
+
23019
+ ```typescript
23020
+ public readonly peerDependenciesMeta: {[ key: string ]: PeerDependencyMeta};
23021
+ ```
23022
+
23023
+ - *Type:* {[ key: string ]: projen.javascript.PeerDependencyMeta}
23024
+ - *Default:* no `peerDependenciesMeta`
23025
+
23026
+ Additional information about how peer dependencies are used, rendered as `peerDependenciesMeta` in `package.json`. For example, this can mark peer dependencies as optional.
23027
+
23028
+ Each key must also be declared as a peer dependency.
23029
+
23030
+ > [https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerdependenciesmeta](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerdependenciesmeta)
23031
+
23032
+ ---
23033
+
23034
+ *Example*
23035
+
23036
+ ```typescript
23037
+ { "aws-cdk-lib": { optional: true } }
23038
+ ```
23039
+
23040
+
22707
23041
  ##### `peerDependencyOptions`<sup>Optional</sup> <a name="peerDependencyOptions" id="@taimos/projen.TaimosApiLibraryOptions.property.peerDependencyOptions"></a>
22708
23042
 
22709
23043
  ```typescript
@@ -23748,6 +24082,28 @@ Enable Node.js package cache in GitHub workflows.
23748
24082
 
23749
24083
  ---
23750
24084
 
24085
+ ##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="@taimos/projen.TaimosApiLibraryOptions.property.workflowPermissions"></a>
24086
+
24087
+ ```typescript
24088
+ public readonly workflowPermissions: JobPermissions;
24089
+ ```
24090
+
24091
+ - *Type:* projen.github.workflows.JobPermissions
24092
+ - *Default:* Use the job defaults and automatically inferred permissions.
24093
+
24094
+ Permissions for the main build, release and dependency upgrade jobs.
24095
+
24096
+ Defined scopes override the job defaults and automatically inferred permissions,
24097
+ including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
24098
+ Use `JobPermission.NONE` to explicitly remove a permission.
24099
+
24100
+ `buildWorkflowOptions.permissions` replaces this entire set, including automatic
24101
+ permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
24102
+ scopes. Applies to all release branches, but not to separate package, publishing,
24103
+ self-mutation or pull request creation jobs, or unrelated workflows.
24104
+
24105
+ ---
24106
+
23751
24107
  ##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="@taimos/projen.TaimosApiLibraryOptions.property.disableTsconfig"></a>
23752
24108
 
23753
24109
  ```typescript
@@ -24159,8 +24515,11 @@ const taimosCdkAppOptions: TaimosCdkAppOptions = { ... }
24159
24515
  | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
24160
24516
  | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
24161
24517
  | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
24518
+ | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.npmVerifyPublished">npmVerifyPublished</a></code> | <code>boolean</code> | Wait until the published package version is available from the npm registry before the publish job completes. |
24519
+ | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.npmVerifyPublishedTimeoutSeconds">npmVerifyPublishedTimeoutSeconds</a></code> | <code>number</code> | How long to wait, in seconds, for the published package version to be available. |
24162
24520
  | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
24163
24521
  | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
24522
+ | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.peerDependenciesMeta">peerDependenciesMeta</a></code> | <code>{[ key: string ]: projen.javascript.PeerDependencyMeta}</code> | Additional information about how peer dependencies are used, rendered as `peerDependenciesMeta` in `package.json`. For example, this can mark peer dependencies as optional. |
24164
24523
  | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
24165
24524
  | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.peerDeps">peerDeps</a></code> | <code>string[]</code> | Peer dependencies for this module. |
24166
24525
  | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.pnpmOptions">pnpmOptions</a></code> | <code>projen.javascript.PnpmOptions</code> | Options for pnpm. |
@@ -24234,6 +24593,7 @@ const taimosCdkAppOptions: TaimosCdkAppOptions = { ... }
24234
24593
  | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
24235
24594
  | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
24236
24595
  | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
24596
+ | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.workflowPermissions">workflowPermissions</a></code> | <code>projen.github.workflows.JobPermissions</code> | Permissions for the main build, release and dependency upgrade jobs. |
24237
24597
  | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
24238
24598
  | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a development tsconfig file. |
24239
24599
  | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
@@ -24259,6 +24619,7 @@ const taimosCdkAppOptions: TaimosCdkAppOptions = { ... }
24259
24619
  | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.context">context</a></code> | <code>{[ key: string ]: any}</code> | Additional context to include in `cdk.json`. |
24260
24620
  | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.featureFlags">featureFlags</a></code> | <code>projen.awscdk.ICdkFeatureFlags</code> | Feature flags that should be enabled in `cdk.json`. |
24261
24621
  | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.requireApproval">requireApproval</a></code> | <code>projen.awscdk.ApprovalLevel</code> | To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. |
24622
+ | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.versionReporting">versionReporting</a></code> | <code>boolean</code> | Enable AWS CDK library version reporting. |
24262
24623
  | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.watchExcludes">watchExcludes</a></code> | <code>string[]</code> | Glob patterns to exclude from `cdk watch`. |
24263
24624
  | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.watchIncludes">watchIncludes</a></code> | <code>string[]</code> | Glob patterns to include in `cdk watch`. |
24264
24625
  | <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.cdkVersion">cdkVersion</a></code> | <code>string</code> | Minimum version of the AWS CDK to depend on. |
@@ -25175,7 +25536,8 @@ public readonly npmRegistryUrl: string;
25175
25536
 
25176
25537
  The base URL of the npm package registry.
25177
25538
 
25178
- Must be a URL (e.g. start with "https://" or "http://")
25539
+ Must be a URL (e.g. start with "https://" or "http://").
25540
+ A trailing slash is added if missing.
25179
25541
 
25180
25542
  ---
25181
25543
 
@@ -25205,6 +25567,36 @@ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on
25205
25567
 
25206
25568
  ---
25207
25569
 
25570
+ ##### `npmVerifyPublished`<sup>Optional</sup> <a name="npmVerifyPublished" id="@taimos/projen.TaimosCdkAppOptions.property.npmVerifyPublished"></a>
25571
+
25572
+ ```typescript
25573
+ public readonly npmVerifyPublished: boolean;
25574
+ ```
25575
+
25576
+ - *Type:* boolean
25577
+ - *Default:* false
25578
+
25579
+ Wait until the published package version is available from the npm registry before the publish job completes.
25580
+
25581
+ Enable this when packages that depend on the published package are released right after.
25582
+
25583
+ ---
25584
+
25585
+ ##### `npmVerifyPublishedTimeoutSeconds`<sup>Optional</sup> <a name="npmVerifyPublishedTimeoutSeconds" id="@taimos/projen.TaimosCdkAppOptions.property.npmVerifyPublishedTimeoutSeconds"></a>
25586
+
25587
+ ```typescript
25588
+ public readonly npmVerifyPublishedTimeoutSeconds: number;
25589
+ ```
25590
+
25591
+ - *Type:* number
25592
+ - *Default:* 3600
25593
+
25594
+ How long to wait, in seconds, for the published package version to be available.
25595
+
25596
+ Requires `npmVerifyPublished` to be enabled.
25597
+
25598
+ ---
25599
+
25208
25600
  ##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="@taimos/projen.TaimosCdkAppOptions.property.packageManager"></a>
25209
25601
 
25210
25602
  ```typescript
@@ -25231,6 +25623,30 @@ The "name" in package.json.
25231
25623
 
25232
25624
  ---
25233
25625
 
25626
+ ##### `peerDependenciesMeta`<sup>Optional</sup> <a name="peerDependenciesMeta" id="@taimos/projen.TaimosCdkAppOptions.property.peerDependenciesMeta"></a>
25627
+
25628
+ ```typescript
25629
+ public readonly peerDependenciesMeta: {[ key: string ]: PeerDependencyMeta};
25630
+ ```
25631
+
25632
+ - *Type:* {[ key: string ]: projen.javascript.PeerDependencyMeta}
25633
+ - *Default:* no `peerDependenciesMeta`
25634
+
25635
+ Additional information about how peer dependencies are used, rendered as `peerDependenciesMeta` in `package.json`. For example, this can mark peer dependencies as optional.
25636
+
25637
+ Each key must also be declared as a peer dependency.
25638
+
25639
+ > [https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerdependenciesmeta](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerdependenciesmeta)
25640
+
25641
+ ---
25642
+
25643
+ *Example*
25644
+
25645
+ ```typescript
25646
+ { "aws-cdk-lib": { optional: true } }
25647
+ ```
25648
+
25649
+
25234
25650
  ##### `peerDependencyOptions`<sup>Optional</sup> <a name="peerDependencyOptions" id="@taimos/projen.TaimosCdkAppOptions.property.peerDependencyOptions"></a>
25235
25651
 
25236
25652
  ```typescript
@@ -26275,6 +26691,28 @@ Enable Node.js package cache in GitHub workflows.
26275
26691
 
26276
26692
  ---
26277
26693
 
26694
+ ##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="@taimos/projen.TaimosCdkAppOptions.property.workflowPermissions"></a>
26695
+
26696
+ ```typescript
26697
+ public readonly workflowPermissions: JobPermissions;
26698
+ ```
26699
+
26700
+ - *Type:* projen.github.workflows.JobPermissions
26701
+ - *Default:* Use the job defaults and automatically inferred permissions.
26702
+
26703
+ Permissions for the main build, release and dependency upgrade jobs.
26704
+
26705
+ Defined scopes override the job defaults and automatically inferred permissions,
26706
+ including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
26707
+ Use `JobPermission.NONE` to explicitly remove a permission.
26708
+
26709
+ `buildWorkflowOptions.permissions` replaces this entire set, including automatic
26710
+ permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
26711
+ scopes. Applies to all release branches, but not to separate package, publishing,
26712
+ self-mutation or pull request creation jobs, or unrelated workflows.
26713
+
26714
+ ---
26715
+
26278
26716
  ##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="@taimos/projen.TaimosCdkAppOptions.property.disableTsconfig"></a>
26279
26717
 
26280
26718
  ```typescript
@@ -26632,6 +27070,21 @@ To protect you against unintended changes that affect your security posture, the
26632
27070
 
26633
27071
  ---
26634
27072
 
27073
+ ##### `versionReporting`<sup>Optional</sup> <a name="versionReporting" id="@taimos/projen.TaimosCdkAppOptions.property.versionReporting"></a>
27074
+
27075
+ ```typescript
27076
+ public readonly versionReporting: boolean;
27077
+ ```
27078
+
27079
+ - *Type:* boolean
27080
+ - *Default:* use the AWS CDK default
27081
+
27082
+ Enable AWS CDK library version reporting.
27083
+
27084
+ > [https://docs.aws.amazon.com/cdk/v2/guide/usage-data.html](https://docs.aws.amazon.com/cdk/v2/guide/usage-data.html)
27085
+
27086
+ ---
27087
+
26635
27088
  ##### `watchExcludes`<sup>Optional</sup> <a name="watchExcludes" id="@taimos/projen.TaimosCdkAppOptions.property.watchExcludes"></a>
26636
27089
 
26637
27090
  ```typescript
@@ -26932,8 +27385,11 @@ const taimosCdkConstructLibraryOptions: TaimosCdkConstructLibraryOptions = { ...
26932
27385
  | <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
26933
27386
  | <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
26934
27387
  | <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
27388
+ | <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.npmVerifyPublished">npmVerifyPublished</a></code> | <code>boolean</code> | Wait until the published package version is available from the npm registry before the publish job completes. |
27389
+ | <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.npmVerifyPublishedTimeoutSeconds">npmVerifyPublishedTimeoutSeconds</a></code> | <code>number</code> | How long to wait, in seconds, for the published package version to be available. |
26935
27390
  | <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
26936
27391
  | <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
27392
+ | <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.peerDependenciesMeta">peerDependenciesMeta</a></code> | <code>{[ key: string ]: projen.javascript.PeerDependencyMeta}</code> | Additional information about how peer dependencies are used, rendered as `peerDependenciesMeta` in `package.json`. For example, this can mark peer dependencies as optional. |
26937
27393
  | <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
26938
27394
  | <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.peerDeps">peerDeps</a></code> | <code>string[]</code> | Peer dependencies for this module. |
26939
27395
  | <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.pnpmOptions">pnpmOptions</a></code> | <code>projen.javascript.PnpmOptions</code> | Options for pnpm. |
@@ -27007,6 +27463,7 @@ const taimosCdkConstructLibraryOptions: TaimosCdkConstructLibraryOptions = { ...
27007
27463
  | <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
27008
27464
  | <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
27009
27465
  | <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
27466
+ | <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.workflowPermissions">workflowPermissions</a></code> | <code>projen.github.workflows.JobPermissions</code> | Permissions for the main build, release and dependency upgrade jobs. |
27010
27467
  | <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
27011
27468
  | <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a development tsconfig file. |
27012
27469
  | <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
@@ -27955,7 +28412,8 @@ public readonly npmRegistryUrl: string;
27955
28412
 
27956
28413
  The base URL of the npm package registry.
27957
28414
 
27958
- Must be a URL (e.g. start with "https://" or "http://")
28415
+ Must be a URL (e.g. start with "https://" or "http://").
28416
+ A trailing slash is added if missing.
27959
28417
 
27960
28418
  ---
27961
28419
 
@@ -27985,6 +28443,36 @@ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on
27985
28443
 
27986
28444
  ---
27987
28445
 
28446
+ ##### `npmVerifyPublished`<sup>Optional</sup> <a name="npmVerifyPublished" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.npmVerifyPublished"></a>
28447
+
28448
+ ```typescript
28449
+ public readonly npmVerifyPublished: boolean;
28450
+ ```
28451
+
28452
+ - *Type:* boolean
28453
+ - *Default:* false
28454
+
28455
+ Wait until the published package version is available from the npm registry before the publish job completes.
28456
+
28457
+ Enable this when packages that depend on the published package are released right after.
28458
+
28459
+ ---
28460
+
28461
+ ##### `npmVerifyPublishedTimeoutSeconds`<sup>Optional</sup> <a name="npmVerifyPublishedTimeoutSeconds" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.npmVerifyPublishedTimeoutSeconds"></a>
28462
+
28463
+ ```typescript
28464
+ public readonly npmVerifyPublishedTimeoutSeconds: number;
28465
+ ```
28466
+
28467
+ - *Type:* number
28468
+ - *Default:* 3600
28469
+
28470
+ How long to wait, in seconds, for the published package version to be available.
28471
+
28472
+ Requires `npmVerifyPublished` to be enabled.
28473
+
28474
+ ---
28475
+
27988
28476
  ##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.packageManager"></a>
27989
28477
 
27990
28478
  ```typescript
@@ -28011,6 +28499,30 @@ The "name" in package.json.
28011
28499
 
28012
28500
  ---
28013
28501
 
28502
+ ##### `peerDependenciesMeta`<sup>Optional</sup> <a name="peerDependenciesMeta" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.peerDependenciesMeta"></a>
28503
+
28504
+ ```typescript
28505
+ public readonly peerDependenciesMeta: {[ key: string ]: PeerDependencyMeta};
28506
+ ```
28507
+
28508
+ - *Type:* {[ key: string ]: projen.javascript.PeerDependencyMeta}
28509
+ - *Default:* no `peerDependenciesMeta`
28510
+
28511
+ Additional information about how peer dependencies are used, rendered as `peerDependenciesMeta` in `package.json`. For example, this can mark peer dependencies as optional.
28512
+
28513
+ Each key must also be declared as a peer dependency.
28514
+
28515
+ > [https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerdependenciesmeta](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerdependenciesmeta)
28516
+
28517
+ ---
28518
+
28519
+ *Example*
28520
+
28521
+ ```typescript
28522
+ { "aws-cdk-lib": { optional: true } }
28523
+ ```
28524
+
28525
+
28014
28526
  ##### `peerDependencyOptions`<sup>Optional</sup> <a name="peerDependencyOptions" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.peerDependencyOptions"></a>
28015
28527
 
28016
28528
  ```typescript
@@ -29055,6 +29567,28 @@ Enable Node.js package cache in GitHub workflows.
29055
29567
 
29056
29568
  ---
29057
29569
 
29570
+ ##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.workflowPermissions"></a>
29571
+
29572
+ ```typescript
29573
+ public readonly workflowPermissions: JobPermissions;
29574
+ ```
29575
+
29576
+ - *Type:* projen.github.workflows.JobPermissions
29577
+ - *Default:* Use the job defaults and automatically inferred permissions.
29578
+
29579
+ Permissions for the main build, release and dependency upgrade jobs.
29580
+
29581
+ Defined scopes override the job defaults and automatically inferred permissions,
29582
+ including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
29583
+ Use `JobPermission.NONE` to explicitly remove a permission.
29584
+
29585
+ `buildWorkflowOptions.permissions` replaces this entire set, including automatic
29586
+ permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
29587
+ scopes. Applies to all release branches, but not to separate package, publishing,
29588
+ self-mutation or pull request creation jobs, or unrelated workflows.
29589
+
29590
+ ---
29591
+
29058
29592
  ##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.disableTsconfig"></a>
29059
29593
 
29060
29594
  ```typescript
@@ -29445,6 +29979,8 @@ By default, jsii will include all *.ts files (except .d.ts files) in the TypeScr
29445
29979
  This can be problematic for example when the package's build or test procedure generates .ts files
29446
29980
  that cannot be compiled with jsii's compiler settings.
29447
29981
 
29982
+ When ESLint is enabled, these patterns are also added to its ignore patterns.
29983
+
29448
29984
  ---
29449
29985
 
29450
29986
  ##### `jsiiVersion`<sup>Optional</sup> <a name="jsiiVersion" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.jsiiVersion"></a>
@@ -29478,6 +30014,9 @@ public readonly publishToGo: JsiiGoTarget;
29478
30014
 
29479
30015
  Publish Go bindings to a git repository.
29480
30016
 
30017
+ A separate repository is recommended. If `moduleName` refers to the source
30018
+ repository, set `publishToSourceRepository` to `true`.
30019
+
29481
30020
  ---
29482
30021
 
29483
30022
  ##### `publishToMaven`<sup>Optional</sup> <a name="publishToMaven" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.publishToMaven"></a>
@@ -29821,8 +30360,11 @@ const taimosPrivateTypescriptLibraryOptions: TaimosPrivateTypescriptLibraryOptio
29821
30360
  | <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
29822
30361
  | <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
29823
30362
  | <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
30363
+ | <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.npmVerifyPublished">npmVerifyPublished</a></code> | <code>boolean</code> | Wait until the published package version is available from the npm registry before the publish job completes. |
30364
+ | <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.npmVerifyPublishedTimeoutSeconds">npmVerifyPublishedTimeoutSeconds</a></code> | <code>number</code> | How long to wait, in seconds, for the published package version to be available. |
29824
30365
  | <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
29825
30366
  | <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
30367
+ | <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.peerDependenciesMeta">peerDependenciesMeta</a></code> | <code>{[ key: string ]: projen.javascript.PeerDependencyMeta}</code> | Additional information about how peer dependencies are used, rendered as `peerDependenciesMeta` in `package.json`. For example, this can mark peer dependencies as optional. |
29826
30368
  | <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
29827
30369
  | <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.peerDeps">peerDeps</a></code> | <code>string[]</code> | Peer dependencies for this module. |
29828
30370
  | <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.pnpmOptions">pnpmOptions</a></code> | <code>projen.javascript.PnpmOptions</code> | Options for pnpm. |
@@ -29896,6 +30438,7 @@ const taimosPrivateTypescriptLibraryOptions: TaimosPrivateTypescriptLibraryOptio
29896
30438
  | <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
29897
30439
  | <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
29898
30440
  | <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
30441
+ | <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.workflowPermissions">workflowPermissions</a></code> | <code>projen.github.workflows.JobPermissions</code> | Permissions for the main build, release and dependency upgrade jobs. |
29899
30442
  | <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
29900
30443
  | <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a development tsconfig file. |
29901
30444
  | <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
@@ -30817,7 +31360,8 @@ public readonly npmRegistryUrl: string;
30817
31360
 
30818
31361
  The base URL of the npm package registry.
30819
31362
 
30820
- Must be a URL (e.g. start with "https://" or "http://")
31363
+ Must be a URL (e.g. start with "https://" or "http://").
31364
+ A trailing slash is added if missing.
30821
31365
 
30822
31366
  ---
30823
31367
 
@@ -30847,6 +31391,36 @@ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on
30847
31391
 
30848
31392
  ---
30849
31393
 
31394
+ ##### `npmVerifyPublished`<sup>Optional</sup> <a name="npmVerifyPublished" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.npmVerifyPublished"></a>
31395
+
31396
+ ```typescript
31397
+ public readonly npmVerifyPublished: boolean;
31398
+ ```
31399
+
31400
+ - *Type:* boolean
31401
+ - *Default:* false
31402
+
31403
+ Wait until the published package version is available from the npm registry before the publish job completes.
31404
+
31405
+ Enable this when packages that depend on the published package are released right after.
31406
+
31407
+ ---
31408
+
31409
+ ##### `npmVerifyPublishedTimeoutSeconds`<sup>Optional</sup> <a name="npmVerifyPublishedTimeoutSeconds" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.npmVerifyPublishedTimeoutSeconds"></a>
31410
+
31411
+ ```typescript
31412
+ public readonly npmVerifyPublishedTimeoutSeconds: number;
31413
+ ```
31414
+
31415
+ - *Type:* number
31416
+ - *Default:* 3600
31417
+
31418
+ How long to wait, in seconds, for the published package version to be available.
31419
+
31420
+ Requires `npmVerifyPublished` to be enabled.
31421
+
31422
+ ---
31423
+
30850
31424
  ##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.packageManager"></a>
30851
31425
 
30852
31426
  ```typescript
@@ -30873,6 +31447,30 @@ The "name" in package.json.
30873
31447
 
30874
31448
  ---
30875
31449
 
31450
+ ##### `peerDependenciesMeta`<sup>Optional</sup> <a name="peerDependenciesMeta" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.peerDependenciesMeta"></a>
31451
+
31452
+ ```typescript
31453
+ public readonly peerDependenciesMeta: {[ key: string ]: PeerDependencyMeta};
31454
+ ```
31455
+
31456
+ - *Type:* {[ key: string ]: projen.javascript.PeerDependencyMeta}
31457
+ - *Default:* no `peerDependenciesMeta`
31458
+
31459
+ Additional information about how peer dependencies are used, rendered as `peerDependenciesMeta` in `package.json`. For example, this can mark peer dependencies as optional.
31460
+
31461
+ Each key must also be declared as a peer dependency.
31462
+
31463
+ > [https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerdependenciesmeta](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerdependenciesmeta)
31464
+
31465
+ ---
31466
+
31467
+ *Example*
31468
+
31469
+ ```typescript
31470
+ { "aws-cdk-lib": { optional: true } }
31471
+ ```
31472
+
31473
+
30876
31474
  ##### `peerDependencyOptions`<sup>Optional</sup> <a name="peerDependencyOptions" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.peerDependencyOptions"></a>
30877
31475
 
30878
31476
  ```typescript
@@ -31917,6 +32515,28 @@ Enable Node.js package cache in GitHub workflows.
31917
32515
 
31918
32516
  ---
31919
32517
 
32518
+ ##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.workflowPermissions"></a>
32519
+
32520
+ ```typescript
32521
+ public readonly workflowPermissions: JobPermissions;
32522
+ ```
32523
+
32524
+ - *Type:* projen.github.workflows.JobPermissions
32525
+ - *Default:* Use the job defaults and automatically inferred permissions.
32526
+
32527
+ Permissions for the main build, release and dependency upgrade jobs.
32528
+
32529
+ Defined scopes override the job defaults and automatically inferred permissions,
32530
+ including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
32531
+ Use `JobPermission.NONE` to explicitly remove a permission.
32532
+
32533
+ `buildWorkflowOptions.permissions` replaces this entire set, including automatic
32534
+ permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
32535
+ scopes. Applies to all release branches, but not to separate package, publishing,
32536
+ self-mutation or pull request creation jobs, or unrelated workflows.
32537
+
32538
+ ---
32539
+
31920
32540
  ##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.disableTsconfig"></a>
31921
32541
 
31922
32542
  ```typescript
@@ -32296,8 +32916,11 @@ const taimosTypescriptLibraryOptions: TaimosTypescriptLibraryOptions = { ... }
32296
32916
  | <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
32297
32917
  | <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
32298
32918
  | <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
32919
+ | <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.npmVerifyPublished">npmVerifyPublished</a></code> | <code>boolean</code> | Wait until the published package version is available from the npm registry before the publish job completes. |
32920
+ | <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.npmVerifyPublishedTimeoutSeconds">npmVerifyPublishedTimeoutSeconds</a></code> | <code>number</code> | How long to wait, in seconds, for the published package version to be available. |
32299
32921
  | <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
32300
32922
  | <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
32923
+ | <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.peerDependenciesMeta">peerDependenciesMeta</a></code> | <code>{[ key: string ]: projen.javascript.PeerDependencyMeta}</code> | Additional information about how peer dependencies are used, rendered as `peerDependenciesMeta` in `package.json`. For example, this can mark peer dependencies as optional. |
32301
32924
  | <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
32302
32925
  | <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.peerDeps">peerDeps</a></code> | <code>string[]</code> | Peer dependencies for this module. |
32303
32926
  | <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.pnpmOptions">pnpmOptions</a></code> | <code>projen.javascript.PnpmOptions</code> | Options for pnpm. |
@@ -32371,6 +32994,7 @@ const taimosTypescriptLibraryOptions: TaimosTypescriptLibraryOptions = { ... }
32371
32994
  | <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
32372
32995
  | <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
32373
32996
  | <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
32997
+ | <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.workflowPermissions">workflowPermissions</a></code> | <code>projen.github.workflows.JobPermissions</code> | Permissions for the main build, release and dependency upgrade jobs. |
32374
32998
  | <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
32375
32999
  | <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a development tsconfig file. |
32376
33000
  | <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
@@ -33292,7 +33916,8 @@ public readonly npmRegistryUrl: string;
33292
33916
 
33293
33917
  The base URL of the npm package registry.
33294
33918
 
33295
- Must be a URL (e.g. start with "https://" or "http://")
33919
+ Must be a URL (e.g. start with "https://" or "http://").
33920
+ A trailing slash is added if missing.
33296
33921
 
33297
33922
  ---
33298
33923
 
@@ -33322,6 +33947,36 @@ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on
33322
33947
 
33323
33948
  ---
33324
33949
 
33950
+ ##### `npmVerifyPublished`<sup>Optional</sup> <a name="npmVerifyPublished" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.npmVerifyPublished"></a>
33951
+
33952
+ ```typescript
33953
+ public readonly npmVerifyPublished: boolean;
33954
+ ```
33955
+
33956
+ - *Type:* boolean
33957
+ - *Default:* false
33958
+
33959
+ Wait until the published package version is available from the npm registry before the publish job completes.
33960
+
33961
+ Enable this when packages that depend on the published package are released right after.
33962
+
33963
+ ---
33964
+
33965
+ ##### `npmVerifyPublishedTimeoutSeconds`<sup>Optional</sup> <a name="npmVerifyPublishedTimeoutSeconds" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.npmVerifyPublishedTimeoutSeconds"></a>
33966
+
33967
+ ```typescript
33968
+ public readonly npmVerifyPublishedTimeoutSeconds: number;
33969
+ ```
33970
+
33971
+ - *Type:* number
33972
+ - *Default:* 3600
33973
+
33974
+ How long to wait, in seconds, for the published package version to be available.
33975
+
33976
+ Requires `npmVerifyPublished` to be enabled.
33977
+
33978
+ ---
33979
+
33325
33980
  ##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.packageManager"></a>
33326
33981
 
33327
33982
  ```typescript
@@ -33348,6 +34003,30 @@ The "name" in package.json.
33348
34003
 
33349
34004
  ---
33350
34005
 
34006
+ ##### `peerDependenciesMeta`<sup>Optional</sup> <a name="peerDependenciesMeta" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.peerDependenciesMeta"></a>
34007
+
34008
+ ```typescript
34009
+ public readonly peerDependenciesMeta: {[ key: string ]: PeerDependencyMeta};
34010
+ ```
34011
+
34012
+ - *Type:* {[ key: string ]: projen.javascript.PeerDependencyMeta}
34013
+ - *Default:* no `peerDependenciesMeta`
34014
+
34015
+ Additional information about how peer dependencies are used, rendered as `peerDependenciesMeta` in `package.json`. For example, this can mark peer dependencies as optional.
34016
+
34017
+ Each key must also be declared as a peer dependency.
34018
+
34019
+ > [https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerdependenciesmeta](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerdependenciesmeta)
34020
+
34021
+ ---
34022
+
34023
+ *Example*
34024
+
34025
+ ```typescript
34026
+ { "aws-cdk-lib": { optional: true } }
34027
+ ```
34028
+
34029
+
33351
34030
  ##### `peerDependencyOptions`<sup>Optional</sup> <a name="peerDependencyOptions" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.peerDependencyOptions"></a>
33352
34031
 
33353
34032
  ```typescript
@@ -34392,6 +35071,28 @@ Enable Node.js package cache in GitHub workflows.
34392
35071
 
34393
35072
  ---
34394
35073
 
35074
+ ##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.workflowPermissions"></a>
35075
+
35076
+ ```typescript
35077
+ public readonly workflowPermissions: JobPermissions;
35078
+ ```
35079
+
35080
+ - *Type:* projen.github.workflows.JobPermissions
35081
+ - *Default:* Use the job defaults and automatically inferred permissions.
35082
+
35083
+ Permissions for the main build, release and dependency upgrade jobs.
35084
+
35085
+ Defined scopes override the job defaults and automatically inferred permissions,
35086
+ including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
35087
+ Use `JobPermission.NONE` to explicitly remove a permission.
35088
+
35089
+ `buildWorkflowOptions.permissions` replaces this entire set, including automatic
35090
+ permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
35091
+ scopes. Applies to all release branches, but not to separate package, publishing,
35092
+ self-mutation or pull request creation jobs, or unrelated workflows.
35093
+
35094
+ ---
35095
+
34395
35096
  ##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.disableTsconfig"></a>
34396
35097
 
34397
35098
  ```typescript