@mrgrain/cdk-esbuild 2.0.0 → 2.1.0

package/.gitattributes

@@ -1,23 +1,23 @@
 # ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".
 
-*.snap                             	linguist-generated
-/.eslintrc.json                    	linguist-generated
-/.gitattributes                    	linguist-generated
-/.github/pull_request_template.md  	linguist-generated
-/.github/workflows/build.yml       	linguist-generated
-/.github/workflows/stale.yml       	linguist-generated
-/.github/workflows/upgrade-main.yml	linguist-generated
-/.gitignore                        	linguist-generated
-/.mergify.yml                      	linguist-generated
-/.npmignore                        	linguist-generated
-/.projen/**                        	linguist-generated
-/.projen/deps.json                 	linguist-generated
-/.projen/tasks.json                	linguist-generated
-/.vscode/extensions.json           	linguist-generated
-/.vscode/launch.json               	linguist-generated
-/.vscode/settings.json             	linguist-generated
-/LICENSE                           	linguist-generated
-/package-lock.json                 	linguist-generated
-/package.json                      	linguist-generated
-/src/esbuild-types.ts              	linguist-generated
-/tsconfig.dev.json                 	linguist-generated
+*.snap                                  	linguist-generated
+/.eslintrc.json                         	linguist-generated
+/.gitattributes                         	linguist-generated
+/.github/pull_request_template.md       	linguist-generated
+/.github/workflows/build.yml            	linguist-generated
+/.github/workflows/pull-request-lint.yml	linguist-generated
+/.github/workflows/stale.yml            	linguist-generated
+/.gitignore                             	linguist-generated
+/.mergify.yml                           	linguist-generated
+/.npmignore                             	linguist-generated
+/.projen/**                             	linguist-generated
+/.projen/deps.json                      	linguist-generated
+/.projen/tasks.json                     	linguist-generated
+/.vscode/extensions.json                	linguist-generated
+/.vscode/launch.json                    	linguist-generated
+/.vscode/settings.json                  	linguist-generated
+/LICENSE                                	linguist-generated
+/package-lock.json                      	linguist-generated
+/package.json                           	linguist-generated
+/src/esbuild-types.ts                   	linguist-generated
+/tsconfig.dev.json                      	linguist-generated

package/.jsii

@@ -44,6 +44,33 @@
         }
       }
     },
+    "@aws-cdk/aws-acmpca": {
+      "targets": {
+        "dotnet": {
+          "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
+          "namespace": "Amazon.CDK.AWS.ACMPCA",
+          "packageId": "Amazon.CDK.AWS.ACMPCA"
+        },
+        "java": {
+          "maven": {
+            "artifactId": "acmpca",
+            "groupId": "software.amazon.awscdk"
+          },
+          "package": "software.amazon.awscdk.services.acmpca"
+        },
+        "js": {
+          "npm": "@aws-cdk/aws-acmpca"
+        },
+        "python": {
+          "classifiers": [
+            "Framework :: AWS CDK",
+            "Framework :: AWS CDK :: 1"
+          ],
+          "distName": "aws-cdk.aws-acmpca",
+          "module": "aws_cdk.aws_acmpca"
+        }
+      }
+    },
     "@aws-cdk/aws-applicationautoscaling": {
       "targets": {
         "dotnet": {
@@ -154,12 +181,7 @@
     },
     "@aws-cdk/aws-cloudfront": {
       "submodules": {
-        "@aws-cdk/aws-cloudfront.experimental": {
-          "locationInModule": {
-            "filename": "lib/index.ts",
-            "line": 12
-          }
-        }
+        "@aws-cdk/aws-cloudfront.experimental": {}
       },
       "targets": {
         "dotnet": {
@@ -947,7 +969,7 @@
     "stability": "stable"
   },
   "homepage": "https://github.com/mrgrain/cdk-esbuild",
-  "jsiiVersion": "1.41.0 (build a274beb)",
+  "jsiiVersion": "1.45.0 (build 61747b6)",
   "keywords": [
     "aws-cdk",
     "bundler",
@@ -969,7 +991,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 v2](#migrating-to-v2) |\n[Documentation](#documentation) | [API Reference](#api-reference) | [Versioning](#versioning)\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**⚠️ A note on stability**\n\nThis package is generally stable and ready to be used in production as many do. However _esbuild_ is still on major version zero, which you should consider. Please check their guide on [production readiness](https://esbuild.github.io/faq/#production-readiness).\n\nNotably upgrades of the _esbuild_ 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\n```\n\nIf _peer_ and _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 esbuild @aws-cdk/core @aws-cdk/aws-lambda @aws-cdk/aws-s3-assets @aws-cdk/aws-s3-deployment @aws-cdk/aws-synthetics\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/latest/docs/@aws-cdk_aws-lambda.Function.html#code):\n\n```ts\nimport * as lambda from \"@aws-cdk/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_14_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/aws-s3\";\nimport * as s3deploy from \"@aws-cdk/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```ts\nimport * as synthetics from \"@aws-cdk/aws-synthetics\";\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/latest/docs/@aws-cdk_aws-lambda.Code.html)) and `synthetics.Code` ([reference](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-synthetics.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 plugin to high-level CDK features. They share the same set of parameters, props and build options._\n\nUnderlying 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/latest/docs/@aws-cdk_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/latest/docs/@aws-cdk_core.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 within the code completion of your IDE.\n\n## Migrating to v2\n\nThe main changes in cdk-esbuild v2 are:\n\n- The package is now `jsii` compliant and published in the [Construct Hub](https://constructs.dev/). This will also enable a possible feature release for other languages.\n- Deprecated properties and classes have been removed, most notably the previous support for bundling via a Docker container. The implementation had a few issues that cannot be easily resolved. However more generic support for custom executables might arrive in later versions.\n- `esbuild` is now installed as an optional dependency. It's not optional at all, but this is a ramification of using `jsii`. In practice this will have no impact on most people.\n- Interfaces have been streamlined and the names and setup of internal types have been changed. In the unlikely case that someone was relying on these, upgrading will be straight forward.\n\n### Upgrading\n\n- Update the package dependency to v2: `npm install --save @mrgrain/cdk-esbuild@^2.0.0`\n- `esbuild` is now installed as an optional dependency. If your setup does not automatically install optional dependencies, add it as an explicit dependency.\n- Remove any use of `bundlerPriority`.\n- Unstable construct `EsbuildBundling` has been renamed to `EsbuildBundler` and its interface has slightly changed. Like most other constructs, it now takes `entryPoints` as first parameter, with an optional `props` object as the second.\n\n## Versioning\n\nThis package _mostly_ 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\nAlthough great care is taken to avoid this, all features marked as `@unstable` may change with minor versions. Please note that the unstable flag is applied to all new or experimental features and internal classes.\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## Future releases\n\n### AWS CDK v2\n\nThe monolithic version 2 of CDK (aka Mono-CDK) is on the horizon. A new major release of this package will be marked alongside CDK. Support for AWS CDK v1.x.x will be continued, however no new features will be added.\n\n### Stable esbuild\n\nOnce `esbuild` has reached a stable version 1.0, a new major version will be released for _all_ breaking changes, including updates to minimum (peer) dependencies.\n\n## Library authors\n\nWhen developing a library consumed by other packages, you'll most likely have to set `buildOptions.absWorkingDir`. The easiest way to do this, is to resolve based on the directory name of the 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"
+    "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 v2](#migrating-to-v2) |\n[Documentation](#documentation) | [API Reference](#api-reference) | [Versioning](#versioning)\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 generally stable and ready to be used in production, as many do. However _esbuild_ not yet released a version 1.0.0 yet and its API is still in active development. Please check their guide on [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\n```\n\nIf _peer_ and _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 esbuild @aws-cdk/core @aws-cdk/aws-lambda @aws-cdk/aws-s3-assets @aws-cdk/aws-s3-deployment @aws-cdk/aws-synthetics\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/latest/docs/@aws-cdk_aws-lambda.Function.html#code):\n\n```ts\nimport * as lambda from \"@aws-cdk/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_14_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/aws-s3\";\nimport * as s3deploy from \"@aws-cdk/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```ts\nimport * as synthetics from \"@aws-cdk/aws-synthetics\";\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/latest/docs/@aws-cdk_aws-lambda.Code.html)) and `synthetics.Code` ([reference](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-synthetics.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 plugin to high-level CDK features. They share the same set of parameters, props and build options._\n\nUnderlying 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/latest/docs/@aws-cdk_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/latest/docs/@aws-cdk_core.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 within the code completion of your IDE.\n\n## Escape hatches\n\nIt's possible that you want to use a 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 version of esbuild that is installed by any other means than `npm`, including Docker\n- Plugin support is needed for the 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### Custom build function\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 v2\n\nThe main changes in cdk-esbuild v2 are:\n\n- The package is now `jsii` compliant and published in the [Construct Hub](https://constructs.dev/). This will also enable a possible feature release for other languages.\n- Deprecated properties and classes have been removed, most notably the previous support for bundling via a Docker container. The implementation had a few issues that cannot be easily resolved. However more generic support for custom executables might arrive in later versions.\n- `esbuild` is now installed as an optional dependency. It's not optional at all, but this is a ramification of using `jsii`. In practice this will have no impact on most people.\n- Interfaces have been streamlined and the names and setup of internal types have been changed. In the unlikely case that someone was relying on these, upgrading will be straight forward.\n\n### Upgrading\n\n- Update the package dependency to v2: `npm install --save @mrgrain/cdk-esbuild@^2.0.0`\n- `esbuild` is now installed as an optional dependency. If your setup does not automatically install optional dependencies, add it as an explicit dependency.\n- Remove any use of `bundlerPriority`.\n- Experimental construct `EsbuildBundling` has been renamed to `EsbuildBundler` and its interface has slightly changed. Like most other constructs, it now takes `entryPoints` as first parameter, with an optional `props` object as the second.\n\n## Versioning\n\nThis package _mostly_ 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\nAlthough great care is taken to avoid this, all features marked with `@stability experimental` may change with minor versions. The flag is only applied to new and experimental features and internal classes.\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## Future releases\n\n### AWS CDK v2\n\nThe monolithic version 2 of CDK (aka Mono-CDK) is on the horizon. A new major release of this package will be marked alongside CDK. Support for AWS CDK v1.x.x will be continued, however no new features will be added.\n\n### Stable esbuild\n\nOnce `esbuild` has reached a stable version 1.0, a new major version will be released for _all_ breaking changes, including updates to minimum (peer) dependencies.\n\n## Library authors\n\nWhen developing a library consumed by other packages, you'll most likely have to set `buildOptions.absWorkingDir`. The easiest way to do this, is to resolve based on the directory name of the 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"
   },
   "repository": {
     "type": "git",
@@ -2023,6 +2045,30 @@
       },
       "name": "BundlerProps",
       "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "custom": {
+              "throws": "esbuild.BuildFailure",
+              "type": "esbuild.buildSync"
+            },
+            "default": "esbuild.buildSync",
+            "remarks": "The function will receive the computed options from the bundler. It can use with these options as it wishes, however `outdir`/`outfile` must be respected to integrate with CDK.\nMust throw a `BuildFailure` on failure to correctly inform the bundler.",
+            "returns": "esbuild.BuildResult",
+            "stability": "experimental",
+            "summary": "Escape hatch to provide the bundler with a custom build function."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/bundler.ts",
+            "line": 63
+          },
+          "name": "buildFn",
+          "optional": true,
+          "type": {
+            "primitive": "any"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -2110,7 +2156,7 @@
         },
         "locationInModule": {
           "filename": "src/bundler.ts",
-          "line": 76
+          "line": 90
         },
         "parameters": [
           {
@@ -2161,7 +2207,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/bundler.ts",
-        "line": 58
+        "line": 72
       },
       "name": "EsbuildBundler",
       "properties": [
@@ -2174,7 +2220,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/bundler.ts",
-            "line": 83
+            "line": 97
           },
           "name": "entryPoints",
           "type": {
@@ -2211,7 +2257,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/bundler.ts",
-            "line": 71
+            "line": 85
           },
           "name": "image",
           "type": {
@@ -2226,7 +2272,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/bundler.ts",
-            "line": 64
+            "line": 78
           },
           "name": "local",
           "type": {
@@ -2241,7 +2287,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/bundler.ts",
-            "line": 90
+            "line": 104
           },
           "name": "props",
           "type": {
@@ -2265,7 +2311,7 @@
         },
         "locationInModule": {
           "filename": "src/inline-code.ts",
-          "line": 34
+          "line": 84
         },
         "parameters": [
           {
@@ -2280,15 +2326,24 @@
           },
           {
             "docs": {
-              "remarks": "Please refer to the esbuild Transform API docs for details. \\\nDefault values for `transformOptions`:\n- `loader='js'`",
+              "remarks": "Props to change the behaviour of the transformer.\n\nDefault values for `props.transformOptions`:\n- `loader='js'`",
               "see": "https://esbuild.github.io/api/#transform-api",
               "stability": "experimental",
-              "summary": "Transform options passed on to esbuild."
+              "summary": "Support for `TransformOptions` is deprecated. Please provide `TransformerProps`!"
             },
-            "name": "transformOptions",
+            "name": "props",
             "optional": true,
             "type": {
-              "fqn": "@mrgrain/cdk-esbuild.TransformOptions"
+              "union": {
+                "types": [
+                  {
+                    "fqn": "@mrgrain/cdk-esbuild.TransformOptions"
+                  },
+                  {
+                    "fqn": "@mrgrain/cdk-esbuild.TransformerProps"
+                  }
+                ]
+              }
             }
           }
         ]
@@ -2296,7 +2351,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/inline-code.ts",
-        "line": 33
+        "line": 83
       },
       "name": "InlineJavaScriptCode",
       "symbolId": "src/inline-code:InlineJavaScriptCode"
@@ -2315,7 +2370,7 @@
         },
         "locationInModule": {
           "filename": "src/inline-code.ts",
-          "line": 63
+          "line": 115
         },
         "parameters": [
           {
@@ -2330,15 +2385,24 @@
           },
           {
             "docs": {
-              "remarks": "Please refer to the esbuild Transform API docs for details. \\\nDefault values for `transformOptions`:\n- `loader='jsx'`",
+              "remarks": "Props to change the behaviour of the transformer.\n\nDefault values for `transformOptions`:\n- `loader='jsx'`",
               "see": "https://esbuild.github.io/api/#transform-api",
               "stability": "experimental",
-              "summary": "Transform options passed on to esbuild."
+              "summary": "Support for `TransformOptions` is deprecated. Please provide `TransformerProps`!"
             },
-            "name": "transformOptions",
+            "name": "props",
             "optional": true,
             "type": {
-              "fqn": "@mrgrain/cdk-esbuild.TransformOptions"
+              "union": {
+                "types": [
+                  {
+                    "fqn": "@mrgrain/cdk-esbuild.TransformOptions"
+                  },
+                  {
+                    "fqn": "@mrgrain/cdk-esbuild.TransformerProps"
+                  }
+                ]
+              }
             }
           }
         ]
@@ -2346,7 +2410,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/inline-code.ts",
-        "line": 62
+        "line": 114
       },
       "name": "InlineJsxCode",
       "symbolId": "src/inline-code:InlineJsxCode"
@@ -2365,7 +2429,7 @@
         },
         "locationInModule": {
           "filename": "src/inline-code.ts",
-          "line": 121
+          "line": 175
         },
         "parameters": [
           {
@@ -2380,15 +2444,24 @@
           },
           {
             "docs": {
-              "remarks": "Please refer to the esbuild Transform API docs for details. \\\nDefault values for `transformOptions`:\n- `loader='tsx'`",
+              "remarks": "Props to change the behaviour of the transformer.\n\nDefault values for `transformOptions`:\n- `loader='tsx'`",
               "see": "https://esbuild.github.io/api/#transform-api",
               "stability": "experimental",
-              "summary": "Transform options passed on to esbuild."
+              "summary": "Support for `TransformOptions` is deprecated. Please provide `TransformerProps`!"
             },
-            "name": "transformOptions",
+            "name": "props",
             "optional": true,
             "type": {
-              "fqn": "@mrgrain/cdk-esbuild.TransformOptions"
+              "union": {
+                "types": [
+                  {
+                    "fqn": "@mrgrain/cdk-esbuild.TransformOptions"
+                  },
+                  {
+                    "fqn": "@mrgrain/cdk-esbuild.TransformerProps"
+                  }
+                ]
+              }
             }
           }
         ]
@@ -2396,7 +2469,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/inline-code.ts",
-        "line": 120
+        "line": 174
       },
       "name": "InlineTsxCode",
       "symbolId": "src/inline-code:InlineTsxCode"
@@ -2415,7 +2488,7 @@
         },
         "locationInModule": {
           "filename": "src/inline-code.ts",
-          "line": 92
+          "line": 145
         },
         "parameters": [
           {
@@ -2430,15 +2503,24 @@
           },
           {
             "docs": {
-              "remarks": "Please refer to the esbuild Transform API docs for details. \\\nDefault values for `transformOptions`:\n- `loader='ts'`",
+              "remarks": "Props to change the behaviour of the transformer.\n\nDefault values for `transformOptions`:\n- `loader='ts'`",
               "see": "https://esbuild.github.io/api/#transform-api",
               "stability": "experimental",
-              "summary": "Transform options passed on to esbuild."
+              "summary": "Support for `TransformOptions` is deprecated. Please provide `TransformerProps`!"
             },
-            "name": "transformOptions",
+            "name": "props",
             "optional": true,
             "type": {
-              "fqn": "@mrgrain/cdk-esbuild.TransformOptions"
+              "union": {
+                "types": [
+                  {
+                    "fqn": "@mrgrain/cdk-esbuild.TransformOptions"
+                  },
+                  {
+                    "fqn": "@mrgrain/cdk-esbuild.TransformerProps"
+                  }
+                ]
+              }
             }
           }
         ]
@@ -2446,7 +2528,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/inline-code.ts",
-        "line": 91
+        "line": 144
       },
       "name": "InlineTypeScriptCode",
       "symbolId": "src/inline-code:InlineTypeScriptCode"
@@ -2491,7 +2573,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/asset.ts",
-        "line": 94
+        "line": 96
       },
       "name": "JavaScriptAsset",
       "symbolId": "src/asset:JavaScriptAsset"
@@ -3434,6 +3516,66 @@
       ],
       "symbolId": "src/esbuild-types:TransformOptions"
     },
+    "@mrgrain/cdk-esbuild.TransformerProps": {
+      "assembly": "@mrgrain/cdk-esbuild",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@mrgrain/cdk-esbuild.TransformerProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/inline-code.ts",
+        "line": 9
+      },
+      "name": "TransformerProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "custom": {
+              "throws": "esbuild.TransformFailure",
+              "type": "esbuild.transformSync"
+            },
+            "default": "esbuild.transformSync",
+            "remarks": "The function will receive the computed options from the bundler. It can use with these options as it wishes, however a TransformResult must be returned to integrate with CDK.\nMust throw a `TransformFailure` on failure to correctly inform the bundler.",
+            "returns": "esbuild.TransformResult",
+            "stability": "experimental",
+            "summary": "Escape hatch to provide the bundler with a custom transform function."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/inline-code.ts",
+            "line": 29
+          },
+          "name": "transformFn",
+          "optional": true,
+          "type": {
+            "primitive": "any"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Please refer to the esbuild Transform API docs for details.",
+            "see": "https://esbuild.github.io/api/#transform-api",
+            "stability": "stable",
+            "summary": "Transform options passed on to esbuild."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/inline-code.ts",
+            "line": 16
+          },
+          "name": "transformOptions",
+          "optional": true,
+          "type": {
+            "fqn": "@mrgrain/cdk-esbuild.TransformOptions"
+          }
+        }
+      ],
+      "symbolId": "src/inline-code:TransformerProps"
+    },
     "@mrgrain/cdk-esbuild.TypeScriptAsset": {
       "assembly": "@mrgrain/cdk-esbuild",
       "docs": {
@@ -3474,7 +3616,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/asset.ts",
-        "line": 103
+        "line": 105
       },
       "name": "TypeScriptAsset",
       "symbolId": "src/asset:TypeScriptAsset"
@@ -3897,6 +4039,6 @@
       "symbolId": "src/source:TypeScriptSourceProps"
     }
   },
-  "version": "2.0.0",
-  "fingerprint": "qYFeZI9jIpUpewjohRM1j7JDViBQkFa/+IEAbJfMxcM="
+  "version": "2.1.0",
+  "fingerprint": "iV/SCNYR0a26MqdqlTBpTB0j5TLb4ZU62TMY2r6v+WQ="
 }

package/.projenrc.ts

@@ -1,5 +1,6 @@
 import {
   AwsCdkConstructLibrary,
+  IgnoreFile,
   JsonFile,
   NodePackageManager,
   release,
@@ -17,6 +18,9 @@ const project = new AwsCdkConstructLibrary({
     lintProjenRc: false,
     dirs: ['src', 'projenrc', '.projenrc.ts'],
   },
+  depsUpgradeOptions: {
+    workflow: false,
+  },
 
   // Project info
   name: '@mrgrain/cdk-esbuild',
@@ -42,6 +46,15 @@ const project = new AwsCdkConstructLibrary({
   license: 'MIT',
   copyrightOwner: 'Moritz Kornher',
 
+  // Testing & Linting
+  githubOptions: {
+    pullRequestLintOptions: {
+      semanticTitleOptions: {
+        types: ['feat', 'fix', 'chore', 'docs', 'ci'],
+      },
+    },
+  },
+
   // Release
   packageManager: NodePackageManager.NPM,
   npmDistTag: 'latest',
@@ -114,11 +127,16 @@ eslintRc?.addOverride('ignorePatterns', [
   '*.js',
   '*.d.ts',
   'node_modules/',
+  'examples/',
   '*.generated.ts',
   'coverage',
   '!.projenrc.ts',
 ]);
 
+(project.tryFindFile('.gitignore') as IgnoreFile).addPatterns(
+  '!/examples/**',
+);
+
 new JsonFile(project, '.vscode/extensions.json', {
   readonly: false,
   marker: false,