@mrgrain/cdk-esbuild 3.6.0 → 3.7.0

package/.jsii

@@ -2800,7 +2800,7 @@
   },
   "name": "@mrgrain/cdk-esbuild",
   "readme": {
-    "markdown": "# cdk-esbuild\n\n_CDK constructs for [esbuild](https://github.com/evanw/esbuild), an extremely fast JavaScript bundler_\n\n[Getting started](#getting-started) | [Migrating to v3](#migrating-to-v3) |\n[Documentation](#documentation) | [API Reference](#api-reference) | [Versioning](#versioning)\n\n> This version is compatible with AWS CDK v2. For the previous, AWS CDK v1 compatible release, see [cdk-esbuild@v2](https://github.com/mrgrain/cdk-esbuild/tree/v2).\n\n## Why?\n\n_esbuild_ is an extremely fast bundler and minifier for Typescript and JavaScript.\nThis package makes _esbuild_ available to deploy lambda functions, static websites or to publish build artefacts (assets) for further use.\n\nAWS CDK [supports _esbuild_ with Lambda Functions](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-lambda-nodejs-readme.html). However the implementation cannot be used with any other Constructs and doesn't expose all of _esbuild_'s build interface.\n\nThis package is running _esbuild_ directly in Node.js and bypasses Docker which the AWS CDK implementation uses. The approach is quicker and easier to use for Node.js users, but incompatible with other languages.\n\n**Production readiness**\n\nThis package is stable and ready to be used in production, as many do. However _esbuild_ has not yet released a version 1.0.0 and its API is still in active development. Please read the guide on [esbuild's production readiness](https://esbuild.github.io/faq/#production-readiness).\n\nNotably upgrades of the _esbuild_ minimum version requirement will be introduced in **minor versions** of this package and will inherit breaking changes from _esbuild_.\n\n## Getting started\n\nInstall `cdk-esbuild`:\n\n```\nnpm install @mrgrain/cdk-esbuild@3\n```\n\nIf _peer_ or _optional dependencies_ are not installed automatically (e.g. when using npm v4-6), please use this command to install all of them:\n\n```\nnpm install @mrgrain/cdk-esbuild@3 esbuild\n```\n\n### AWS Lambda: Serverless function\n\n> 💡 See [Lambda Function](examples/lambda) for a complete working example of a how to deploy a lambda function.\n\nUse `TypeScriptCode` as the `code` of a [lambda function](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html#code):\n\n```ts\nimport * as lambda from \"aws-cdk-lib/aws-lambda\";\nimport { TypeScriptCode } from \"@mrgrain/cdk-esbuild\";\n\nconst bundledCode = new TypeScriptCode(\"src/index.ts\");\n\nconst fn = new lambda.Function(stack, \"MyFunction\", {\n  runtime: lambda.Runtime.NODEJS_16_X,\n  handler: \"index.handler\",\n  code: bundledCode,\n});\n```\n\n### AWS S3: Static Website\n\n> 💡 See [Static Website with React](examples/website) for a complete working example of a how to deploy a React app to S3.\n\nUse `TypeScriptSource` as one of the `sources` of a [static website deployment](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-s3-deployment-readme.html#roadmap):\n\n```ts\nimport * as s3 from \"aws-cdk-lib/aws-s3\";\nimport * as s3deploy from \"aws-cdk-lib/aws-s3-deployment\";\nimport { TypeScriptSource } from \"@mrgrain/cdk-esbuild\";\n\nconst websiteBundle = new TypeScriptSource(\"src/index.tsx\");\n\nconst websiteBucket = new s3.Bucket(stack, \"WebsiteBucket\", {\n  autoDeleteObjects: true,\n  publicReadAccess: true,\n  removalPolicy: RemovalPolicy.DESTROY,\n  websiteIndexDocument: \"index.html\",\n});\n\nnew s3deploy.BucketDeployment(stack, \"DeployWebsite\", {\n  destinationBucket: websiteBucket,\n  sources: [websiteBundle],\n});\n```\n\n### Amazon CloudWatch Synthetics: Canary monitoring\n\n> 💡 See [Monitored Website](examples/website) for a complete working example of a deployed and monitored website.\n\nSynthetics runs a canary to produce traffic to an application for monitoring purposes. Use `TypeScriptCode` as the `code` of a Canary test:\n\n> ℹ️ This feature depends on the `@aws-cdk/aws-synthetics-alpha` package which is a developer preview. You may need to update your source code when upgrading to a newer version of this package.\n>\n> ```\n> npm i @aws-cdk/aws-synthetics-alpha\n> ```\n\n```ts\nimport * as synthetics from \"@aws-cdk/aws-synthetics-alpha\";\nimport { TypeScriptCode } from \"@mrgrain/cdk-esbuild\";\n\nconst bundledCode = new TypeScriptCode(\"src/index.ts\", {\n  buildOptions: {\n    outdir: \"nodejs/node_modules\", // This is required by Synthetics\n  },\n});\n\nconst canary = new synthetics.Canary(stack, \"MyCanary\", {\n  runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_2,\n  test: synthetics.Test.custom({\n    code: bundledCode,\n    handler: \"index.handler\",\n  });\n});\n```\n\n## Documentation\n\nThe package exports various different constructs for use with existing CDK features. A major guiding design principal for this package is to _extend, don't replace_. Expect constructs that you can provide as props, not complete replacements.\n\nFor use in **Lambda Functions** and **Synthetic Canaries**, the following classes implement `lambda.Code` ([reference](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Code.html)) and `synthetics.Code` ([reference](https://docs.aws.amazon.com/cdk/api/v2/docs/@aws-cdk_aws-synthetics-alpha.Code.html)):\n\n- `TypeScriptCode` & `JavaScriptCode`\n\nInline code is only supported by **Lambda**:\n\n- `InlineTypeScriptCode` & `InlineJavaScriptCode`\n- `InlineTsxCode` & `InlineJsxCode`\n\nFor use with **S3 bucket deployments**, classes implementing `s3deploy.ISource` ([reference](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-s3-deployment-readme.html)):\n\n- `TypeScriptSource` & `JavaScriptSource`\n\n> _Code and Source constructs seamlessly plug-in to other high-level CDK constructs. They share the same set of parameters, props and build options._\n\nThe following classes power the other features. You normally won't have to use them, but they are there if you need them:\n\n- `TypeScriptAsset` & `JavaScriptAsset` implements `s3.Asset` ([reference](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3_assets.Asset.html)) \\\n  creates an asset uploaded to S3 which can be referenced by other constructs\n\n- `EsbuildBundler` implements `core.BundlingOptions` ([reference](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.BundlingOptions.html)) \\\n  provides an interface for a _esbuild_ bundler wherever needed\n\n### [API Reference](API.md)\n\nAuto-generated reference for classes and structs. This information is also available as part of your IDE's code completion.\n\n### Escape hatches\n\nIt's possible that you want to use an implementation of esbuild that's different to the default one. Common reasons are:\n\n- The current version constraints for esbuild are not suitable\n- To use a version of esbuild that is installed by any other means than `npm`, including Docker\n- Plugin support is needed for building\n\nFor these situations, this package offers an escape hatch to bypass regular the implementation and provide a custom build and transform function.\n\n#### Esbuild binary path\n\nIt is possible to override the binary used by esbuild. The usual way to do this is to set the `ESBUILD_BINARY_PATH` environment variable. For convenience this package allows to set the binary path as a prop:\n\n```ts\nnew TypeScriptCode(\"fixtures/handlers/ts-handler.ts\", {\n  esbuildBinaryPath: \"path/to/esbuild/binary\"\n});\n```\n\n#### Custom build function\n\n> 💡 See [Using esbuild with plugins](examples/esbuild-with-plugins) for a complete working example of a custom build function using this escape hatch.\n\nConstructs that result in starting a build, take a `buildFn` as optional prop. While the defined type for this function is `any`, it must implement the same signature as esbuild's `buildSync` function.\n\n```ts\nnew TypeScriptCode(\"fixtures/handlers/ts-handler.ts\", {\n  buildFn: (options: BuildOptions): BuildResult => {\n    try {\n      // custom implementation returning BuildResult\n    } catch (error) {\n      // throw BuildFailure exception here\n    }\n  },\n});\n```\n\nInstead of esbuild, the provided function will be invoked with the calculated build options. The custom build function can amend, change or discard any of these. However integration with CDK relies heavily on the values `outdir`/`outfile` are set to and it's usually required to use them unchanged.\n\nFailures have to cause a `BuildFailure` exception in order to be fully handled.\n\n#### Custom transform function\n\nConstructs that result in starting a transformation, take a `transformFn` as optional prop. While the defined type for this function is `any`, it must implement the same signature as esbuild's `transformSync` function.\n\n```ts\nnew InlineTypeScriptCode(\"let x: number = 1\", {\n  transformFn: (options: TransformOptions): TransformResult => {\n    try {\n      // custom implementation returning TransformResult\n    } catch (error) {\n      // throw TransformFailure exception here\n    }\n  },,\n});\n```\n\nInstead of esbuild, the provided function will be invoked with the calculated transform options. The custom transform function can amend, change or discard any of these.\n\nFailures have to cause a `TransformFailure` exception in order to be fully handled.\n\n### Migrating to v3\n\nThe release of cdk-esbuild v3 brings compatibility with AWS CDK v2. Furthermore all deprecated properties and classes have been removed. In particular `InlineCode` classes now take `TransformerProps` as second parameter instead of transform options.\n\n#### Upgrading\n\n- This version requires AWS CDK v2. Follow the [official migration guide](https://docs.aws.amazon.com/cdk/latest/guide/work-with-cdk-v2.html) to upgrade.\n- Update the package dependency to v3: `npm install --save @mrgrain/cdk-esbuild@^3.0.0`\n- `esbuild` is installed as an optional dependency. If your setup does not automatically install optional dependencies, make sure to add it as an explicit dependency.\n- Any use of `InlineCode` variations has to be updated. Previously the second parameter was either of type `TransformerProps` or `TransformOptions`. Now it must be `TransformerProps`.\\\n  If the passed value is of type `TransformOptions`, turn it into the correct type like this:\n\n  ```ts\n  const oldOptions: TransformOptions = {...}\n\n  new InlineTypeScriptCode('// inline code', {\n    transformOptions: oldOptions\n  });\n  ```\n\n## Versioning\n\nThis package follows [Semantic Versioning](https://semver.org/), with the exception of upgrades to `esbuild`. These will be released as **minor versions** and often include breaking changes from `esbuild`.\n\n### Npm Tags\n\nSome users prefer to use tags over version ranges. The following stable tags are available for use:\n\n- `cdk-v1`, `cdk-v2` are provided for the latest release compatible with each version of the AWS CDK.\n\n- `latest` is the most recent stable release.\n\nThese tags also exist, but usage is strongly not recommended:\n\n- `unstable`, `next` are used for pre-release of the current and next major version respectively.\n\n- ~~`cdk-1.x.x`~~ tags have been deprecated in favour of `cdk-v1`. Use that one instead.\n\n## Roadmap & Contributions\n\n[The project's roadmap is available on GitHub.](https://github.com/mrgrain/cdk-esbuild/projects/1) Please submit any feature requests as issues to the repository.\n\nAll contributions are welcome, no matter if they are for already planned or completely new features.\n\n## Library authors\n\nBuilding a library consumed by other packages that relies on `cdk-esbuild` might require you to set `buildOptions.absWorkingDir`. The easiest way to do this, is to resolve based on the directory name of the calling file, and traverse the tree upwards to the root of your library package (that's where `package.json` and `tsconfig.json` are):\n\n```ts\n// file: project/src/index.ts\nconst props = {\n  buildOptions: {\n    absWorkingDir: path.resolve(__dirname, \"..\"), // now: /user/project\n  },\n};\n```\n\nThis will dynamically resolve to the correct path, wherever the package is installed.\n\nPlease open an issue if you encounter any difficulties.\n"
+    "markdown": "# cdk-esbuild\n\n_CDK constructs for [esbuild](https://github.com/evanw/esbuild), an extremely fast JavaScript bundler_\n\n[Getting started](#getting-started)\n[Documentation](#documentation) | [API Reference](#api-reference) | [Versioning](#versioning) | [Upgrading from AWS CDK v1](#upgrading-from-aws-cdk-v1)\n\n[![View on Construct Hub](https://constructs.dev/badge?package=%40mrgrain%2Fcdk-esbuild)](https://constructs.dev/packages/@mrgrain/cdk-esbuild)\n\n## Why?\n\n_esbuild_ is an extremely fast bundler and minifier for Typescript and JavaScript.\nThis package makes _esbuild_ available to deploy lambda functions, static websites or to publish build artefacts (assets) for further use.\n\nAWS CDK [supports _esbuild_ with Lambda Functions](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-lambda-nodejs-readme.html). However the implementation cannot be used with any other Constructs and doesn't expose all of _esbuild_'s build interface.\n\nThis package is running _esbuild_ directly in Node.js and bypasses Docker which the AWS CDK implementation uses. The approach is quicker and easier to use for Node.js users, but incompatible with other languages.\n\n**Production readiness**\n\nThis package is stable and ready to be used in production, as many do. However _esbuild_ has not yet released a version 1.0.0 and its API is still in active development. Please read the guide on [esbuild's production readiness](https://esbuild.github.io/faq/#production-readiness).\n\nNotably upgrades of the _esbuild_ minimum version requirement will be introduced in **minor versions** of this package and will inherit breaking changes from _esbuild_.\n\n## Getting started\n\nInstall `cdk-esbuild`:\n\n```\nnpm install @mrgrain/cdk-esbuild@3\n```\n\nIf _peer_ or _optional dependencies_ are not installed automatically (e.g. when using npm v4-6), please use this command to install all of them:\n\n```\nnpm install @mrgrain/cdk-esbuild@3 esbuild\n```\n\n### AWS Lambda: Serverless function\n\n> 💡 See [Lambda Function](examples/lambda) for a complete working example of a how to deploy a lambda function.\n\nUse `TypeScriptCode` as the `code` of a [lambda function](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html#code):\n\n```ts\nimport * as lambda from \"aws-cdk-lib/aws-lambda\";\nimport { TypeScriptCode } from \"@mrgrain/cdk-esbuild\";\n\nconst bundledCode = new TypeScriptCode(\"src/index.ts\");\n\nconst fn = new lambda.Function(stack, \"MyFunction\", {\n  runtime: lambda.Runtime.NODEJS_16_X,\n  handler: \"index.handler\",\n  code: bundledCode,\n});\n```\n\n### AWS S3: Static Website\n\n> 💡 See [Static Website with React](examples/website) for a complete working example of a how to deploy a React app to S3.\n\nUse `TypeScriptSource` as one of the `sources` of a [static website deployment](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-s3-deployment-readme.html#roadmap):\n\n```ts\nimport * as s3 from \"aws-cdk-lib/aws-s3\";\nimport * as s3deploy from \"aws-cdk-lib/aws-s3-deployment\";\nimport { TypeScriptSource } from \"@mrgrain/cdk-esbuild\";\n\nconst websiteBundle = new TypeScriptSource(\"src/index.tsx\");\n\nconst websiteBucket = new s3.Bucket(stack, \"WebsiteBucket\", {\n  autoDeleteObjects: true,\n  publicReadAccess: true,\n  removalPolicy: RemovalPolicy.DESTROY,\n  websiteIndexDocument: \"index.html\",\n});\n\nnew s3deploy.BucketDeployment(stack, \"DeployWebsite\", {\n  destinationBucket: websiteBucket,\n  sources: [websiteBundle],\n});\n```\n\n### Amazon CloudWatch Synthetics: Canary monitoring\n\n> 💡 See [Monitored Website](examples/website) for a complete working example of a deployed and monitored website.\n\nSynthetics runs a canary to produce traffic to an application for monitoring purposes. Use `TypeScriptCode` as the `code` of a Canary test:\n\n> ℹ️ This feature depends on the `@aws-cdk/aws-synthetics-alpha` package which is a developer preview. You may need to update your source code when upgrading to a newer version of this package.\n>\n> ```\n> npm i @aws-cdk/aws-synthetics-alpha\n> ```\n\n```ts\nimport * as synthetics from \"@aws-cdk/aws-synthetics-alpha\";\nimport { TypeScriptCode } from \"@mrgrain/cdk-esbuild\";\n\nconst bundledCode = new TypeScriptCode(\"src/index.ts\", {\n  buildOptions: {\n    outdir: \"nodejs/node_modules\", // This is required by Synthetics\n  },\n});\n\nconst canary = new synthetics.Canary(stack, \"MyCanary\", {\n  runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_2,\n  test: synthetics.Test.custom({\n    code: bundledCode,\n    handler: \"index.handler\",\n  });\n});\n```\n\n## Documentation\n\nThe package exports various different constructs for use with existing CDK features. A major guiding design principal for this package is to _extend, don't replace_. Expect constructs that you can provide as props, not complete replacements.\n\nFor use in **Lambda Functions** and **Synthetic Canaries**, the following classes implement `lambda.Code` ([reference](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Code.html)) and `synthetics.Code` ([reference](https://docs.aws.amazon.com/cdk/api/v2/docs/@aws-cdk_aws-synthetics-alpha.Code.html)):\n\n- `TypeScriptCode` & `JavaScriptCode`\n\nInline code is only supported by **Lambda**:\n\n- `InlineTypeScriptCode` & `InlineJavaScriptCode`\n- `InlineTsxCode` & `InlineJsxCode`\n\nFor use with **S3 bucket deployments**, classes implementing `s3deploy.ISource` ([reference](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-s3-deployment-readme.html)):\n\n- `TypeScriptSource` & `JavaScriptSource`\n\n> _Code and Source constructs seamlessly plug-in to other high-level CDK constructs. They share the same set of parameters, props and build options._\n\nThe following classes power the other features. You normally won't have to use them, but they are there if you need them:\n\n- `TypeScriptAsset` & `JavaScriptAsset` implements `s3.Asset` ([reference](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3_assets.Asset.html)) \\\n  creates an asset uploaded to S3 which can be referenced by other constructs\n\n- `EsbuildBundler` implements `core.BundlingOptions` ([reference](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.BundlingOptions.html)) \\\n  provides an interface for a _esbuild_ bundler wherever needed\n\n### [API Reference](API.md)\n\nAuto-generated reference for classes and structs. This information is also available as part of your IDE's code completion.\n\n### Escape hatches\n\nIt's possible that you want to use an implementation of esbuild that's different to the default one. Common reasons are:\n\n- The current version constraints for esbuild are not suitable\n- To use a version of esbuild that is installed by any other means than `npm`, including Docker\n- Plugin support is needed for building\n\nFor these situations, this package offers an escape hatch to bypass regular the implementation and provide a custom build and transform function.\n\n#### Esbuild binary path\n\nIt is possible to override the binary used by esbuild. The usual way to do this is to set the `ESBUILD_BINARY_PATH` environment variable. For convenience this package allows to set the binary path as a prop:\n\n```ts\nnew TypeScriptCode(\"fixtures/handlers/ts-handler.ts\", {\n  esbuildBinaryPath: \"path/to/esbuild/binary\"\n});\n```\n\n#### Custom build function\n\n> 💡 See [Using esbuild with plugins](examples/esbuild-with-plugins) for a complete working example of a custom build function using this escape hatch.\n\nConstructs that result in starting a build, take a `buildFn` as optional prop. While the defined type for this function is `any`, it must implement the same signature as esbuild's `buildSync` function.\n\n```ts\nnew TypeScriptCode(\"fixtures/handlers/ts-handler.ts\", {\n  buildFn: (options: BuildOptions): BuildResult => {\n    try {\n      // custom implementation returning BuildResult\n    } catch (error) {\n      // throw BuildFailure exception here\n    }\n  },\n});\n```\n\nInstead of esbuild, the provided function will be invoked with the calculated build options. The custom build function can amend, change or discard any of these. However integration with CDK relies heavily on the values `outdir`/`outfile` are set to and it's usually required to use them unchanged.\n\nFailures have to cause a `BuildFailure` exception in order to be fully handled.\n\n#### Custom transform function\n\nConstructs that result in starting a transformation, take a `transformFn` as optional prop. While the defined type for this function is `any`, it must implement the same signature as esbuild's `transformSync` function.\n\n```ts\nnew InlineTypeScriptCode(\"let x: number = 1\", {\n  transformFn: (options: TransformOptions): TransformResult => {\n    try {\n      // custom implementation returning TransformResult\n    } catch (error) {\n      // throw TransformFailure exception here\n    }\n  },,\n});\n```\n\nInstead of esbuild, the provided function will be invoked with the calculated transform options. The custom transform function can amend, change or discard any of these.\n\nFailures have to cause a `TransformFailure` exception in order to be fully handled.\n\n### Upgrading from AWS CDK v1\n\nThis version is compatible with AWS CDK v2. For the previous, AWS CDK v1 compatible release, see [cdk-esbuild@v2](https://github.com/mrgrain/cdk-esbuild/tree/v2).\n\nTo upgrade from AWS CDK v1 and cdk-esbuild@v2, please follow these steps:\n\n- This version requires AWS CDK v2. Follow the [official migration guide](https://docs.aws.amazon.com/cdk/latest/guide/work-with-cdk-v2.html) to upgrade.\n- Update the package dependency to v3: `npm install --save @mrgrain/cdk-esbuild@^3.0.0`\n- `esbuild` is installed as an optional dependency. If your setup does not automatically install optional dependencies, make sure to add it as an explicit dependency.\n- Any use of `InlineCode` variations has to be updated. Previously the second parameter was either of type `TransformerProps` or `TransformOptions`. Now it must be `TransformerProps`.\\\n  If the passed value is of type `TransformOptions`, turn it into the correct type like this:\n\n  ```ts\n  const oldOptions: TransformOptions = {...}\n\n  new InlineTypeScriptCode('// inline code', {\n    transformOptions: oldOptions\n  });\n  ```\n\n## Versioning\n\nThis package follows [Semantic Versioning](https://semver.org/), with the exception of upgrades to `esbuild`. These will be released as **minor versions** and often include breaking changes from `esbuild`.\n\n### Npm Tags\n\nSome users prefer to use tags over version ranges. The following stable tags are available for use:\n\n- `cdk-v1`, `cdk-v2` are provided for the latest release compatible with each version of the AWS CDK.\n\n- `latest` is the most recent stable release.\n\nThese tags also exist, but usage is strongly not recommended:\n\n- `unstable`, `next` are used for pre-release of the current and next major version respectively.\n\n- ~~`cdk-1.x.x`~~ tags have been deprecated in favour of `cdk-v1`. Use that one instead.\n\n## Roadmap & Contributions\n\n[The project's roadmap is available on GitHub.](https://github.com/mrgrain/cdk-esbuild/projects/1) Please submit any feature requests as issues to the repository.\n\nAll contributions are welcome, no matter if they are for already planned or completely new features.\n\n## Library authors\n\nBuilding a library consumed by other packages that relies on `cdk-esbuild` might require you to set `buildOptions.absWorkingDir`. The easiest way to do this, is to resolve based on the directory name of the calling file, and traverse the tree upwards to the root of your library package (that's where `package.json` and `tsconfig.json` are):\n\n```ts\n// file: project/src/index.ts\nconst props = {\n  buildOptions: {\n    absWorkingDir: path.resolve(__dirname, \"..\"), // now: /user/project\n  },\n};\n```\n\nThis will dynamically resolve to the correct path, wherever the package is installed.\n\nPlease open an issue if you encounter any difficulties.\n"
   },
   "repository": {
     "type": "git",
@@ -2833,14 +2833,14 @@
         {
           "abstract": true,
           "docs": {
-            "remarks": "E.g. `src/index.ts`.",
+            "remarks": "Relative paths are by default resolved from the current working directory.\nTo change the working directory, see `buildOptions.absWorkingDir`.\n\nAbsolute paths can be used if files are part of the working directory.\n\nExamples:\n  - `'src/index.ts'`\n  - `require.resolve('./lambda')`\n  - `['src/index.ts', 'src/util.ts']`\n  - `{one: 'src/two.ts', two: 'src/one.ts'}`",
             "stability": "stable",
-            "summary": "A relative path or list or map of relative paths to the entry points of your code from the root of the project."
+            "summary": "A path or list or map of paths to the entry points of your code."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/asset.ts",
-            "line": 29
+            "line": 40
           },
           "name": "entryPoints",
           "type": {
@@ -3998,7 +3998,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/bundler.ts",
-        "line": 23
+        "line": 34
       },
       "name": "BundlerProps",
       "properties": [
@@ -4018,7 +4018,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/bundler.ts",
-            "line": 79
+            "line": 90
           },
           "name": "buildFn",
           "optional": true,
@@ -4037,7 +4037,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/bundler.ts",
-            "line": 42
+            "line": 53
           },
           "name": "buildOptions",
           "optional": true,
@@ -4055,7 +4055,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/bundler.ts",
-            "line": 65
+            "line": 76
           },
           "name": "copyDir",
           "optional": true,
@@ -4109,7 +4109,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/bundler.ts",
-            "line": 88
+            "line": 99
           },
           "name": "esbuildBinaryPath",
           "optional": true,
@@ -4196,8 +4196,9 @@
       "assembly": "@mrgrain/cdk-esbuild",
       "base": "aws-cdk-lib.aws_s3_assets.Asset",
       "docs": {
+        "remarks": "You should always use `TypeScriptAsset` or `JavaScriptAsset`.",
         "stability": "experimental",
-        "summary": "Represents the a generic Esbuild Asset."
+        "summary": "Represents a generic esbuild asset."
       },
       "fqn": "@mrgrain/cdk-esbuild.EsbuildAsset",
       "initializer": {
@@ -4206,7 +4207,7 @@
         },
         "locationInModule": {
           "filename": "src/asset.ts",
-          "line": 44
+          "line": 57
         },
         "parameters": [
           {
@@ -4232,7 +4233,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/asset.ts",
-        "line": 40
+        "line": 53
       },
       "name": "EsbuildAsset",
       "symbolId": "src/asset:EsbuildAsset"
@@ -4251,14 +4252,14 @@
         },
         "locationInModule": {
           "filename": "src/bundler.ts",
-          "line": 115
+          "line": 126
         },
         "parameters": [
           {
             "docs": {
-              "remarks": "E.g. `src/index.ts`.",
+              "remarks": "Relative paths are by default resolved from the current working directory.\nTo change the working directory, see `buildOptions.absWorkingDir`.\n\nAbsolute paths can be used if files are part of the working directory.\n\nExamples:\n  - `'src/index.ts'`\n  - `require.resolve('./lambda')`\n  - `['src/index.ts', 'src/util.ts']`\n  - `{one: 'src/two.ts', two: 'src/one.ts'}`",
               "stability": "experimental",
-              "summary": "A relative path or list or map of relative paths to the entry points of your code from the root of the project."
+              "summary": "A path or list or map of paths to the entry points of your code."
             },
             "name": "entryPoints",
             "type": {
@@ -4302,20 +4303,20 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/bundler.ts",
-        "line": 97
+        "line": 108
       },
       "name": "EsbuildBundler",
       "properties": [
         {
           "docs": {
-            "remarks": "E.g. `src/index.ts`.",
+            "remarks": "Relative paths are by default resolved from the current working directory.\nTo change the working directory, see `buildOptions.absWorkingDir`.\n\nAbsolute paths can be used if files are part of the working directory.\n\nExamples:\n  - `'src/index.ts'`\n  - `require.resolve('./lambda')`\n  - `['src/index.ts', 'src/util.ts']`\n  - `{one: 'src/two.ts', two: 'src/one.ts'}`",
             "stability": "experimental",
-            "summary": "A relative path or list or map of relative paths to the entry points of your code from the root of the project."
+            "summary": "A path or list or map of paths to the entry points of your code."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/bundler.ts",
-            "line": 122
+            "line": 143
           },
           "name": "entryPoints",
           "type": {
@@ -4352,7 +4353,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/bundler.ts",
-            "line": 110
+            "line": 121
           },
           "name": "image",
           "type": {
@@ -4367,7 +4368,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/bundler.ts",
-            "line": 103
+            "line": 114
           },
           "name": "local",
           "type": {
@@ -4382,7 +4383,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/bundler.ts",
-            "line": 129
+            "line": 150
           },
           "name": "props",
           "type": {
@@ -4396,8 +4397,9 @@
       "assembly": "@mrgrain/cdk-esbuild",
       "base": "aws-cdk-lib.aws_lambda.Code",
       "docs": {
+        "remarks": "You should always use `TypeScriptCode` or `JavaScriptCode`.",
         "stability": "experimental",
-        "summary": "Represents the a generic Esbuild Code bundle."
+        "summary": "Represents a generic esbuild code bundle."
       },
       "fqn": "@mrgrain/cdk-esbuild.EsbuildCode",
       "initializer": {
@@ -4406,14 +4408,14 @@
         },
         "locationInModule": {
           "filename": "src/code.ts",
-          "line": 49
+          "line": 51
         },
         "parameters": [
           {
             "docs": {
-              "remarks": "E.g. `src/index.ts`.",
+              "remarks": "Relative paths are by default resolved from the current working directory.\nTo change the working directory, see `buildOptions.absWorkingDir`.\n\nAbsolute paths can be used if files are part of the working directory.\n\nExamples:\n  - `'src/index.ts'`\n  - `require.resolve('./lambda')`\n  - `['src/index.ts', 'src/util.ts']`\n  - `{one: 'src/two.ts', two: 'src/one.ts'}`",
               "stability": "stable",
-              "summary": "A relative path or list or map of relative paths to the entry points of your code from the root of the project."
+              "summary": "A path or list or map of paths to the entry points of your code."
             },
             "name": "entryPoints",
             "type": {
@@ -4467,7 +4469,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/code.ts",
-        "line": 27
+        "line": 29
       },
       "methods": [
         {
@@ -4477,7 +4479,7 @@
           },
           "locationInModule": {
             "filename": "src/code.ts",
-            "line": 89
+            "line": 101
           },
           "name": "bind",
           "overrides": "aws-cdk-lib.aws_lambda.Code",
@@ -4503,7 +4505,7 @@
           },
           "locationInModule": {
             "filename": "src/code.ts",
-            "line": 117
+            "line": 129
           },
           "name": "bindToResource",
           "overrides": "aws-cdk-lib.aws_lambda.Code",
@@ -4529,7 +4531,7 @@
           },
           "locationInModule": {
             "filename": "src/code.ts",
-            "line": 30
+            "line": 32
           },
           "name": "getAsset",
           "parameters": [
@@ -4552,14 +4554,14 @@
       "properties": [
         {
           "docs": {
-            "remarks": "E.g. `src/index.ts`.",
+            "remarks": "Relative paths are by default resolved from the current working directory.\nTo change the working directory, see `buildOptions.absWorkingDir`.\n\nAbsolute paths can be used if files are part of the working directory.\n\nExamples:\n  - `'src/index.ts'`\n  - `require.resolve('./lambda')`\n  - `['src/index.ts', 'src/util.ts']`\n  - `{one: 'src/two.ts', two: 'src/one.ts'}`",
             "stability": "stable",
-            "summary": "A relative path or list or map of relative paths to the entry points of your code from the root of the project."
+            "summary": "A path or list or map of paths to the entry points of your code."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/code.ts",
-            "line": 56
+            "line": 68
           },
           "name": "entryPoints",
           "type": {
@@ -4594,7 +4596,7 @@
           },
           "locationInModule": {
             "filename": "src/code.ts",
-            "line": 40
+            "line": 42
           },
           "name": "asset",
           "protected": true,
@@ -4610,7 +4612,7 @@
           },
           "locationInModule": {
             "filename": "src/code.ts",
-            "line": 47
+            "line": 49
           },
           "name": "isInline",
           "type": {
@@ -4623,7 +4625,7 @@
           },
           "locationInModule": {
             "filename": "src/code.ts",
-            "line": 38
+            "line": 40
           },
           "name": "props",
           "protected": true,
@@ -4885,7 +4887,7 @@
         },
         "locationInModule": {
           "filename": "src/asset.ts",
-          "line": 44
+          "line": 57
         },
         "parameters": [
           {
@@ -4911,7 +4913,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/asset.ts",
-        "line": 99
+        "line": 129
       },
       "name": "JavaScriptAsset",
       "symbolId": "src/asset:JavaScriptAsset"
@@ -4930,14 +4932,14 @@
         },
         "locationInModule": {
           "filename": "src/code.ts",
-          "line": 141
+          "line": 153
         },
         "parameters": [
           {
             "docs": {
-              "remarks": "E.g. `src/index.ts`.",
+              "remarks": "Relative paths are by default resolved from the current working directory.\nTo change the working directory, see `buildOptions.absWorkingDir`.\n\nAbsolute paths can be used if files are part of the working directory.\n\nExamples:\n  - `'src/index.ts'`\n  - `require.resolve('./lambda')`\n  - `['src/index.ts', 'src/util.ts']`\n  - `{one: 'src/two.ts', two: 'src/one.ts'}`",
               "stability": "stable",
-              "summary": "A relative path or list or map of relative paths to the entry points of your code from the root of the project."
+              "summary": "A path or list or map of paths to the entry points of your code."
             },
             "name": "entryPoints",
             "type": {
@@ -4983,7 +4985,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/code.ts",
-        "line": 132
+        "line": 144
       },
       "methods": [
         {
@@ -4992,7 +4994,7 @@
           },
           "locationInModule": {
             "filename": "src/code.ts",
-            "line": 133
+            "line": 145
           },
           "name": "getAsset",
           "overrides": "@mrgrain/cdk-esbuild.EsbuildCode",
@@ -5065,10 +5067,15 @@
         },
         "locationInModule": {
           "filename": "src/source.ts",
-          "line": 89
+          "line": 113
         },
         "parameters": [
           {
+            "docs": {
+              "remarks": "Relative paths are by default resolved from the current working directory.\nTo change the working directory, see `buildOptions.absWorkingDir`.\n\nAbsolute paths can be used if files are part of the working directory.\n\nExamples:\n  - `'src/index.ts'`\n  - `require.resolve('./lambda')`\n  - `['src/index.ts', 'src/util.ts']`\n  - `{one: 'src/two.ts', two: 'src/one.ts'}`",
+              "stability": "stable",
+              "summary": "A path or list or map of paths to the entry points of your code."
+            },
             "name": "entryPoints",
             "type": {
               "union": {
@@ -5097,6 +5104,11 @@
             }
           },
           {
+            "docs": {
+              "remarks": "Default values for `props.buildOptions`:\n- `bundle=true`\n- `platform=browser`",
+              "stability": "stable",
+              "summary": "Props to change the behavior of the bundler."
+            },
             "name": "props",
             "optional": true,
             "type": {
@@ -5111,7 +5123,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/source.ts",
-        "line": 83
+        "line": 107
       },
       "methods": [
         {
@@ -5121,7 +5133,7 @@
           },
           "locationInModule": {
             "filename": "src/source.ts",
-            "line": 49
+            "line": 73
           },
           "name": "bind",
           "overrides": "aws-cdk-lib.aws_s3_deployment.ISource",
@@ -5178,7 +5190,7 @@
           },
           "locationInModule": {
             "filename": "src/source.ts",
-            "line": 87
+            "line": 111
           },
           "name": "assetClass",
           "type": {
@@ -5984,7 +5996,7 @@
         },
         "locationInModule": {
           "filename": "src/asset.ts",
-          "line": 44
+          "line": 57
         },
         "parameters": [
           {
@@ -6010,7 +6022,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/asset.ts",
-        "line": 108
+        "line": 138
       },
       "name": "TypeScriptAsset",
       "symbolId": "src/asset:TypeScriptAsset"
@@ -6029,14 +6041,14 @@
         },
         "locationInModule": {
           "filename": "src/code.ts",
-          "line": 179
+          "line": 202
         },
         "parameters": [
           {
             "docs": {
-              "remarks": "E.g. `src/index.ts`.",
+              "remarks": "Relative paths are by default resolved from the current working directory.\nTo change the working directory, see `buildOptions.absWorkingDir`.\n\nAbsolute paths can be used if files are part of the working directory.\n\nExamples:\n  - `'src/index.ts'`\n  - `require.resolve('./lambda')`\n  - `['src/index.ts', 'src/util.ts']`\n  - `{one: 'src/two.ts', two: 'src/one.ts'}`",
               "stability": "stable",
-              "summary": "A relative path or list or map of relative paths to the entry points of your code from the root of the project."
+              "summary": "A path or list or map of paths to the entry points of your code."
             },
             "name": "entryPoints",
             "type": {
@@ -6082,7 +6094,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/code.ts",
-        "line": 170
+        "line": 193
       },
       "methods": [
         {
@@ -6091,7 +6103,7 @@
           },
           "locationInModule": {
             "filename": "src/code.ts",
-            "line": 171
+            "line": 194
           },
           "name": "getAsset",
           "overrides": "@mrgrain/cdk-esbuild.EsbuildCode",
@@ -6164,10 +6176,15 @@
         },
         "locationInModule": {
           "filename": "src/source.ts",
-          "line": 103
+          "line": 154
         },
         "parameters": [
           {
+            "docs": {
+              "remarks": "Relative paths are by default resolved from the current working directory.\nTo change the working directory, see `buildOptions.absWorkingDir`.\n\nAbsolute paths can be used if files are part of the working directory.\n\nExamples:\n  - `'src/index.ts'`\n  - `require.resolve('./lambda')`\n  - `['src/index.ts', 'src/util.ts']`\n  - `{one: 'src/two.ts', two: 'src/one.ts'}`",
+              "stability": "stable",
+              "summary": "A path or list or map of paths to the entry points of your code."
+            },
             "name": "entryPoints",
             "type": {
               "union": {
@@ -6196,6 +6213,11 @@
             }
           },
           {
+            "docs": {
+              "remarks": "Default values for `props.buildOptions`:\n- `bundle=true`\n- `platform=browser`",
+              "stability": "stable",
+              "summary": "Props to change the behavior of the bundler."
+            },
             "name": "props",
             "optional": true,
             "type": {
@@ -6210,7 +6232,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/source.ts",
-        "line": 97
+        "line": 148
       },
       "methods": [
         {
@@ -6220,7 +6242,7 @@
           },
           "locationInModule": {
             "filename": "src/source.ts",
-            "line": 49
+            "line": 73
           },
           "name": "bind",
           "overrides": "aws-cdk-lib.aws_s3_deployment.ISource",
@@ -6277,7 +6299,7 @@
           },
           "locationInModule": {
             "filename": "src/source.ts",
-            "line": 101
+            "line": 152
           },
           "name": "assetClass",
           "type": {
@@ -6340,6 +6362,6 @@
       "symbolId": "src/source:TypeScriptSourceProps"
     }
   },
-  "version": "3.6.0",
-  "fingerprint": "OAsSCJMukUlupNUvkv/c82z3BzZsVDNL0B3lXQqr6EE="
+  "version": "3.7.0",
+  "fingerprint": "ueoh5zvfDjmtYia2303pLrEDhzdxb/gouLZBYlY14CE="
 }

package/.projenrc.ts

@@ -111,6 +111,22 @@ const project = new awscdk.AwsCdkConstructLibrary({
 });
 
 // release only via manual trigger
+project.release?.publisher?.publishToGit({
+  changelogFile: 'dist/dist/changelog.md',
+  versionFile: 'dist/dist/version.txt',
+  releaseTagFile: 'dist/dist/releasetag.txt',
+  projectChangelogFile: 'CHANGELOG.md',
+  gitBranch: 'main',
+});
+project.tryFindObjectFile('.github/workflows/release.yml')?.addToArray(
+  'jobs.release.steps',
+  {
+    name: 'Publish tag',
+    run: 'npx projen publish:git',
+  },
+);
+
+// add additional tags on npm
 project.tryFindObjectFile('.github/workflows/release.yml')?.addToArray(
   'jobs.release_npm.steps',
   tagOnNpm(project.package.packageName, ['cdk-v2', 'unstable', 'next']),