@mrgrain/cdk-esbuild 2.0.0-alpha.0 → 2.0.0-alpha.5

package/CHANGELOG.md

@@ -0,0 +1,261 @@
+
+## [2.0.0-alpha.4](https://github.com/mrgrain/cdk-esbuild/compare/v2.0.0-alpha.2...v2.0.0-alpha.4) (2021-10-22)
+
+
+### Features
+
+* synthesize esbuild types from source ([#117](https://github.com/mrgrain/cdk-esbuild/issues/117)) ([af44d55](https://github.com/mrgrain/cdk-esbuild/commit/af44d55e97db6fd8fbda916eb0f25dae55513cba))
+
+## [2.0.0-alpha.2](https://github.com/mrgrain/cdk-esbuild/compare/v1.128.0...v2.0.0-alpha.2) (2021-10-17)
+
+
+### ⚠ BREAKING CHANGES
+
+* Alpha release of a jsii version of this package. Aim is
+that migration will be minimal, however probably not avoidable.
+
+### Features
+
+* jsii compatibility ([bdcba25](https://github.com/mrgrain/cdk-esbuild/commit/bdcba25981a3a32d36ba0054bfee5023b69b6497))
+* jsii project with projen ([f0ff7cb](https://github.com/mrgrain/cdk-esbuild/commit/f0ff7cb07e73f4e7b936d218f8aad7a2d8aa21f4))
+* more explict prop types ([680460a](https://github.com/mrgrain/cdk-esbuild/commit/680460a8ceabb5e45567784df8dca53ff974483c))
+* reduce number of exported structs ([c6e0cde](https://github.com/mrgrain/cdk-esbuild/commit/c6e0cdea4a39e5909ab102e15b5c4ba5acd02d14))
+
+## [1.128.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.127.0...v1.128.0) (2021-10-16)
+
+- works with cdk-1.128.0
+
+## [1.127.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.126.0...v1.127.0) (2021-10-09)
+
+- works with cdk-1.127.0
+- **example/website:** How to monitor a website with Synthetics ([621d2d4](https://github.com/mrgrain/cdk-esbuild/commit/621d2d4192da63fa385b76b59353ffe77023c38d))
+
+## [1.126.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.126.0-beta.0...v1.126.0) (2021-10-09)
+
+### Features
+
+- works with cdk-1.126.0
+- [Experimental] `Code` is now compatible with `@aws-cdk/aws-synthetics` ([#99](https://github.com/mrgrain/cdk-esbuild/issues/99)) ([f840300](https://github.com/mrgrain/cdk-esbuild/commit/f840300439f7175c46d173378d8e941b7dd80483))
+
+## [1.125.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.124.0...v1.125.0) (2021-10-01)
+
+### ⚠ BREAKING CHANGES
+
+- `esbuild` released a breaking change to the tree shaking options and introduced a new way how platform-specific binaries are installed. Please check the esbuild v0.13.0 [release notes](https://github.com/evanw/esbuild/releases/tag/v0.12.0) for details.
+
+### Features
+
+- works with cdk-1.125.0
+
+- upgrade `esbuild` minimum version to ^0.13.0 ([3d0b5ee](https://github.com/mrgrain/cdk-esbuild/commit/3d0b5ee5c01b7edcf7042a728932a0e1ce722d3c))
+
+## [1.124.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.123.0...v1.124.0) (2021-10-01)
+
+- works with cdk-1.124.0
+
+## [1.123.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.122.0...v1.123.0) (2021-09-22)
+
+- works with cdk-1.123.0
+
+## [1.122.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.121.0...v1.122.0) (2021-09-12)
+
+- works with cdk-1.122.0
+
+## [1.121.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.120.0...v1.121.0) (2021-09-12)
+
+- works with cdk-1.121.0
+
+## [1.120.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.119.0...v1.120.0) (2021-09-12)
+
+- works with cdk-1.120.0
+
+## [1.119.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.118.0...v1.119.0) (2021-09-12)
+
+- works with cdk-1.119.0
+
+## [1.118.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.117.0...v1.118.0) (2021-09-12)
+
+- works with cdk-1.118.0
+
+### Bug Fixes
+
+- fix error handling type issue in latest tsc version ([b5e36e2](https://github.com/mrgrain/cdk-esbuild/commit/b5e36e27481706ea5a7ac5f8c05d74418b07c125))
+
+## [1.117.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.116.0...v1.117.0) (2021-08-08)
+
+- works with cdk-1.117.0
+
+## [1.116.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.115.0...v1.116.0) (2021-08-08)
+
+- works with cdk-1.116.0
+
+## [1.115.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.114.0...v1.115.0) (2021-08-08)
+
+- works with cdk-1.115.0
+
+## [1.114.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.113.0...v1.114.0) (2021-08-08)
+
+- works with cdk-1.114.0
+
+## [1.113.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.112.0...v1.113.0) (2021-08-08)
+
+- works with cdk-1.113.0
+
+## [1.112.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.111.0...v1.112.0) (2021-08-08)
+
+- works with cdk-1.112.0
+
+## [1.111.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.110.0...v1.111.0) (2021-08-08)
+
+- works with cdk-1.111.0
+
+## [1.110.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.109.0...v1.110.0) (2021-06-24)
+
+- works with cdk-1.110.0
+
+## [1.109.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.108.0...v1.109.0) (2021-06-24)
+
+- works with cdk-1.109.0
+
+## [1.108.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.107.0...v1.108.0) (2021-06-09)
+
+- works with cdk-1.108.0
+
+## [1.107.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.106.0...v1.107.0) (2021-06-03)
+
+- works with cdk-1.107.0
+
+## [1.106.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.105.0...v1.106.0) (2021-05-31)
+
+- works with cdk-1.106.0
+
+## [1.105.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.104.0...v1.105.0) (2021-05-19)
+
+- works with cdk-1.105.0
+
+### ⚠️ BREAKING CHANGES TO EXPERIMENTAL FEATURES
+
+- upgraded esbuild to [v0.12.0](https://github.com/evanw/esbuild/releases/tag/v0.12.0) which contains backwards-incompatible changes (mostly related to CSS bundling)
+
+## [1.104.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.103.0...v1.104.0) (2021-05-19)
+
+- works with cdk-1.104.0 ([fb0de78](https://github.com/mrgrain/cdk-esbuild/commit/fb0de78faf29815045822b8e80b2bbb07b8f7cbf))
+
+## [1.103.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.102.0...v1.103.0) (2021-05-13)
+
+- works with cdk-1.103.0
+
+### ⚠️ BREAKING CHANGES TO EXPERIMENTAL FEATURES
+
+- removed deprecated `forceDockerBundling` and `localBundling` ([cc40b90](https://github.com/mrgrain/cdk-esbuild/commit/cc40b900acd8cba725e31db0a79cd3f8b711277e))
+
+## [1.102.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.101.0...v1.102.0) (2021-05-04)
+
+- works with cdk-1.102.0 ([c616c1b](https://github.com/mrgrain/cdk-esbuild/commit/c616c1ba07a9bdd11f3dc3369b1335918458800f))
+
+### Features
+
+- new high-level constructs prop `bundlerPriority` to replace deprecated `forceDockerBundling` ([cc4c933](https://github.com/mrgrain/cdk-esbuild/commit/cc4c93376cf3a8628edd696fe9fa8f65a09c7e21))
+- **examples/lambda:** added new complete example for lambda function ([f8ca3c0](https://github.com/mrgrain/cdk-esbuild/commit/f8ca3c093a11f1d56b9f08cd0a4f3b3eaecd5690))
+
+### Bug Fixes
+
+- **examples/website:** changed start command to work with latest esbuild versions ([45b4c91](https://github.com/mrgrain/cdk-esbuild/commit/45b4c91b454a9520e3aca4ff66ed75abc2ea7d4a))
+
+## [1.101.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.100.0...v1.101.0) (2021-05-01)
+
+- works with cdk-1.101.0
+
+### Features
+
+- pretty print esbuild build errors and warnings when using local bundler ([7f15bed](https://github.com/mrgrain/cdk-esbuild/commit/7f15bedbdfb619c2d0767bc37458108e01c3a85e))
+- pretty print esbuild transform errors and warnings ([1eeeb10](https://github.com/mrgrain/cdk-esbuild/commit/1eeeb10ca6b1e46452c55792d28429986eb4b09f))
+- set bundling priority explicitly, deprecating `localBundling` in favour of `priority` ([425665a](https://github.com/mrgrain/cdk-esbuild/commit/425665a2f8f20bb557119e79e3354a4d9d696d24))
+
+## [1.100.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.100.0-beta.1...v1.100.0) (2021-05-01)
+
+- no changes, cdk version constraints are now less strict
+
+## [1.99.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.98.0...v1.99.0) (2021-04-19)
+
+- update to cdk-1.99.0 ([cfffb19](https://github.com/mrgrain/cdk-esbuild/commit/cfffb1901f8567ea81de3e7f746d8cffd50b4bcc))
+
+## [1.98.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.97.0...v1.98.0) (2021-04-13)
+
+- update to cdk-1.98.0 ([0165256](https://github.com/mrgrain/cdk-esbuild/commit/0165256d26a2b24b45b17cb747f63eff26c983d1))
+
+## [1.97.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.96.0...v1.97.0) (2021-04-11)
+
+- update to cdk-1.97.0 ([fedb40a](https://github.com/mrgrain/cdk-esbuild/commit/fedb40a3098cd3b2de5b113d79a2edd185789fde))
+
+### ⚠️ BREAKING CHANGES TO EXPERIMENTAL FEATURES
+
+- esbuild minimum version updated to `^0.11.0` which includes [breaking changes re how some files are interpreted](https://github.com/evanw/esbuild/releases/tag/v0.10.0) as well as [updated behaviour for entry points](https://github.com/evanw/esbuild/releases/tag/v0.11.0); please check esbuild's change log ([35c9046](https://github.com/mrgrain/cdk-esbuild/commit/35c904666415797eb5e5f09add47edfe2979303e))
+- use esbuild's handling of `process.env.NODE_ENV`, notably the value will now be set to `development` unless [minification](https://esbuild.github.io/api/#minify) is enabled ([04bc5ed](https://github.com/mrgrain/cdk-esbuild/commit/04bc5edb1eb40b42499ffb9dfd78dac28fea7602))
+
+### Features
+
+- support object maps for entry points ([62a4431](https://github.com/mrgrain/cdk-esbuild/commit/62a4431572a4b32acd45c569405d19244b1aa76a))
+
+## [1.96.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.95.0...v1.96.0) (2021-04-11)
+
+- update to cdk-1.96.0 ([ae26510](https://github.com/mrgrain/cdk-esbuild/commit/ae2651026617646833303f0b9259d564765273d5))
+
+### ⚠️ BREAKING CHANGES TO EXPERIMENTAL FEATURES
+
+- removed deprecated `projectRoot` prop, please use `buildOptions.absWorkingPath` instead ([40e7ab0](https://github.com/mrgrain/cdk-esbuild/commit/40e7ab0ccd6fa52727f548168cbbc05afcfe4b16))
+
+## [1.95.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.94.1...v1.95.0) (2021-03-28)
+
+- update to cdk-1.95.0 ([0a98ef3](https://github.com/mrgrain/cdk-esbuild/commit/0a98ef311d92e1366f535bf18d7a5f10ac6ad02a))
+
+### ⚠️ BREAKING CHANGES TO EXPERIMENTAL FEATURES
+
+- exported `TypeScriptAsset` & `JavaScriptAsset` are now implementing `s3.Asset` and replace the previously deprecated aliases for code classes of the same name; replace any previous use with `TypeScriptCode` & `JavaScriptCode` for lambda functions ([9b86eab](https://github.com/mrgrain/cdk-esbuild/commit/9b86eab91f82e66088a25248d7a4c754dbe73d85))
+
+### Features
+
+- added various InlineCode constructs using the transform api ([6ef1c97](https://github.com/mrgrain/cdk-esbuild/commit/6ef1c9756f22256c008e1f9725ea3b5b5a176e3c))
+- support added for `outfile` build option ([90ef5ec](https://github.com/mrgrain/cdk-esbuild/commit/90ef5ecb5906e0f2fc76a933b9f0067f1aae6428))
+
+### [1.94.1](https://github.com/mrgrain/cdk-esbuild/compare/v1.94.0...v1.94.1) (2021-03-17)
+
+### Bug Fixes
+
+- change cdk version constraints to work with patches ([fa0fa5f](https://github.com/mrgrain/cdk-esbuild/commit/fa0fa5fbdf608b14faf7a5e6132016fb6f2e393e))
+
+## [1.94.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.93.1...v1.94.0) (2021-03-16)
+
+- update to cdk-1.94.0 ([1623339](https://github.com/mrgrain/cdk-esbuild/commit/162333930a7534277c5ce4318f81df1fc954fe5e))
+
+### ⚠️ BREAKING CHANGES TO EXPERIMENTAL FEATURES
+
+- deprecated ~~`TypeScriptAsset`~~ & ~~`JavaScriptAsset`~~ in favour of `TypeScriptCode` & `JavaScriptCode` ([f31074e](https://github.com/mrgrain/cdk-esbuild/commit/f31074eeeca039dc847f199eeff88313b61605a1))
+- deprecated ~~`projectRoot`~~ in favour of `buildOptions.absWorkDir` ([ef7ae23](https://github.com/mrgrain/cdk-esbuild/commit/ef7ae237827e381fa2708d67a2d68214a33ab41b)) \
+  Now `absWorkDir` will take priority, then `projectRoot`. If neither are provided it falls back to the current working directory, which is esbuild's default behaviour. \
+  **The automatic project root detection has been removed.**
+- upgraded esbuild dependency requirement to `^0.9.0` which [contains breaking changes](https://github.com/evanw/esbuild/releases/tag/v0.9.0) ([f27d987](https://github.com/mrgrain/cdk-esbuild/commit/f27d987183034d4fbf88905769d8cd7d3f93db4a))
+
+### Features
+
+- set sensible defaults for website deployment ([a7a925d](https://github.com/mrgrain/cdk-esbuild/commit/a7a925da367d88184058719a56af55882e7c7aff))
+- new `copyDir` prop to copy additional files into the output ([1dccb25](https://github.com/mrgrain/cdk-esbuild/commit/1dccb254c189500dc48371eeeeed0545c3116863))
+- support for multiple `entryPoints` ([e41757b](https://github.com/mrgrain/cdk-esbuild/commit/e41757bb634d24d4c45ecf98ba981d28df258ce6))
+- `bundleOptions.outdir` can now be provided as an additional path prefix for rendered files in the auto-generated cdk output directory ([9be0f62](https://github.com/mrgrain/cdk-esbuild/commit/9be0f626460b5fd1c4bfa131a5f57124bbdb4129))
+
+## [1.93.1](https://github.com/mrgrain/cdk-esbuild/compare/v1.93.0...v1.93.1) (2021-03-12)
+
+Required release to make version available on npm.
+
+## [1.93.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.92.0...v1.93.0) (2021-03-12)
+
+- update to cdk-1.93.0 ([2dd043b](https://github.com/mrgrain/cdk-esbuild/commit/2dd043b49b606dc6ebcf13c435a5665f5028fce5))
+
+### ⚠️ BREAKING CHANGES TO EXPERIMENTAL FEATURES
+
+- `projectRoot` auto detection now searches upwards from the entry point, instead of current working directory
+- deprecated ~~`TypeScriptAsset`~~ & ~~`JavaScriptAsset`~~ in favour of `TypeScriptCode` & `JavaScriptCode` ([f31074e](https://github.com/mrgrain/cdk-esbuild/commit/f31074eeeca039dc847f199eeff88313b61605a1))
+
+### Features
+
+- added implementation of S3 deployment source which can be used for static website deployment ([f31074e](https://github.com/mrgrain/cdk-esbuild/commit/f31074eeeca039dc847f199eeff88313b61605a1))

package/README.md

@@ -2,11 +2,8 @@
 
 _CDK constructs for [esbuild](https://github.com/evanw/esbuild), an extremely fast JavaScript bundler_
 
-[Getting started](#getting-started) | [Documentation](#documentation) | [Versioning](#versioning)
-
-## ⚠️ Alpha Version of `jsii` compatible package
-
-Documentation has not yet been updated.
+[Getting started](#getting-started) | [Migrating to v2](#migrating-to-v2) |
+[Documentation](#documentation) | [API Reference](#api-reference) | [Versioning](#versioning)
 
 ## Why?
 
@@ -17,6 +14,12 @@ AWS CDK [supports _esbuild_ with Lambda Functions](https://docs.aws.amazon.com/c
 
 This 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.
 
+**⚠️ A note on stability**
+
+This 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).
+
+Notably upgrades of the _esbuild_ version requirement will be introduced in **minor versions** of this package and will inherit breaking changes from _esbuild_.
+
 ## Getting started
 
 Install `cdk-esbuild`:
@@ -25,10 +28,10 @@ Install `cdk-esbuild`:
 npm install @mrgrain/cdk-esbuild
 ```
 
-⚠️ When using an older version of npm (4-6), the required peer dependencies have to be installed manually. Use this command instead:
+If _peer_ and _optional dependencies_ are not installed automatically (e.g. when using npm v4-6), please use this command to install all of them:
 
 ```
-npm install @mrgrain/cdk-esbuild @aws-cdk/core @aws-cdk/aws-lambda @aws-cdk/aws-s3-assets @aws-cdk/aws-s3-deployment @aws-cdk/aws-synthetics
+npm 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
 ```
 
 ### AWS Lambda: Serverless function
@@ -78,9 +81,6 @@ new s3deploy.BucketDeployment(stack, "DeployWebsite", {
 
 ### Amazon CloudWatch Synthetics: Canary monitoring
 
-> ⚠️ **Status: Experimental** \
-> Expect the interface to change. Please report any issues!
-
 > 💡 See [Monitored Website](examples/website) for a complete working example of a deployed and monitored website.
 
 Synthetics runs a canary to produce traffic to an application for monitoring purposes. Use `TypeScriptCode` as the `code` of a Canary test:
@@ -121,198 +121,77 @@ For use with **S3 bucket deployments**, classes implementing `s3deploy.ISource`
 
 - 🧺 `TypeScriptSource` & `JavaScriptSource`
 
-> _Code and Source constructs seamlessly plugin to high-level CDK features. They share the same set of parameters, props and build options:_
+> _Code and Source constructs seamlessly plugin to high-level CDK features. They share the same set of parameters, props and build options._
 
-Underlying classes the power the other features. You normally won't have to use them, but they are there if you need them:
+Underlying classes power the other features. You normally won't have to use them, but they are there if you need them:
 
 - `TypeScriptAsset` & `JavaScriptAsset` implements `s3.Asset` ([reference](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3-assets.Asset.html)) \
   creates an asset uploaded to S3 which can be referenced by other constructs
 
-- `EsbuildBundling` implements `core.BundlingOptions` ([reference](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.BundlingOptions.html)) \
-  provides a _esbuild_ bundling interface wherever needed
-
-## `TypeScriptCode`, `JavaScriptCode`
-
-> ℹ️ _Although these classes are currently identical, please use the appropriate class as functionality might diverge in future releases._
-
-**Default build options:**
-
-- `bundle=true`
-- `platform=node`
-- `target=nodeX` with `X` being the major node version running the code
-
-### Parameters
-
-- `entryPoints: string | string[] | Record<string, string>` \
-  A single or list of relative paths to the entry points of your code from the root of the project.
-
-### Props
-
-- `props.buildOptions?` as per esbuild [(reference)](https://esbuild.github.io/getting-started/#build-scripts) \
-  **All build options are optional.** \
-  Same defaults and functionalities apply, with a few changes as noted below. Generally speaking usage of entry and output options are different, as these are inferred by CDK.
-
-- ❌ `buildOptions.entryPoints` \
-  _Not available. Option is exposed as parameter._
-
-- `buildOptions.outdir: string` \
-  The actual path for the output directory is defined by CDK. However setting this option allows to write files into a subdirectory. \
-  For example `{ outdir: 'js' }` will create an asset with a single directory called `js`, which contains all built files. This approach can be useful for static website deployments, where JavaScript code should be placed into a subdirectory. \
-  _Cannot be used together with `outfile`._
-
-- `buildOptions.outfile: string` \
-  Relative path to a file inside the CDK asset output directory. \
-  For example `{ outfile: 'js/index.js' }` will create an asset with a single directory called `js`, which contains a single file `index.js`. This can be useful to rename the entry point.\
-  _Cannot be used with multiple `entryPoints` or together with `outdir`._
-
-- `buildOptions.absWorkingDir: string` \
-  Absolute path to the [esbuild working directory](https://esbuild.github.io/api/#working-directory) and defaults to the [current working directory](https://en.wikipedia.org/wiki/Working_directory).\
-  Docker-based builds also use this path to mount local files into the container. A large `absWorkingDir` can slow down the Docker build. \
-  If paths cannot be found, a good starting point is to look at the concatenation of `absWorkingDir + entryPoint`. It must always be a valid absolute path pointing to the entry point. When needed, the probably easiest way to set `absWorkingDir` is to use a combination of `resolve` and `__dirname` (see "A note for library authors" below).
-
-> **⚠️ A note for library authors**
->
-> When developing a library consumed by other packages, you'll most likely have to set `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):
->
-> ```ts
-> // file: project/src/index.ts
-> const props = {
->   buildOptions: {
->     absWorkingDir: path.resolve(__dirname, ".."), // now: /user/project
->   },
-> };
-> ```
->
-> This will dynamically resolve to the correct path, wherever the package is installed.
-
-- `props.copyDir?: string` \
-  **⚠️ Experimental** - _Likely to change once esbuild supports this natively_ \
-  Relative path to a directory copied to the output before the build is run (i.e esbuild will overwrite existing files).
-
-- `props.bundlerPriority?: BundlerPriority (BundlerPriority.AttemptLocal)` \
-  Set the priority order of available bundlers. It can be useful to limit use to one of the bundlers. For Docker, the `absWorkingDir` path (or current working directory) will be mounted into the container as context. By default bundling with a locally installed binary is attempted first and Docker will only be used if the local bundling fails.
-
-## `TypeScriptSource`, `JavaScriptSource`
-
-> ℹ️ _Although these classes are currently identical, please use the appropriate class as functionality might diverge in future releases._
-
-**Default build options:**
-
-- `bundle=true`
-- `platform=browser`
-
-> 💡 See [Static Website with React](examples/website) for a complete working example of a how to deploy a React app to S3.
-
-### Parameters & Props
+- `EsbuildBundler` implements `core.BundlingOptions` ([reference](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.BundlingOptions.html)) \
+  provides an interface for a _esbuild_ bundler wherever needed
 
-➡️ _Code and Source constructs share the same set of parameters, props and build options. Please see above for details._
+## [API Reference](API.md)
 
-## `InlineTypeScriptCode`, `InlineJavaScriptCode`, `InlineTsxCode`, `InlineJsxCode`
+Auto-generated reference for classes and structs. This information is also available within the code completion of your IDE.
 
-**⚠️ Status: Unstable**
+## Migrating to v2
 
-An implementation of `lambda.InlineCode` ([reference](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.InlineCode.html)) using the esbuild Transform API.
-Inline function code is limited to 4 KiB _after_ transformation.
+The main changes in cdk-esbuild v2 are:
 
-### Parameters
+- 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.
+- 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.
+- `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.
+- 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.
 
-- `code: string` \
-  The inline code to be transformed.
+### Upgrading
 
-- `transformOptions: TransformOptions` \
-  Options from the [esbuild Transform API](https://esbuild.github.io/api/#transform-api).
-
-  **Default transform options:** \
-  • `loader=ts|js|tsx|jsx` (one of `ts,js,tsx,jsx` depending on the used class)
-
-## `TypeScriptAsset`, `JavaScriptAsset`
-
-Bundles the entry points and creates a CDK asset which is uploaded to the bootstrapped CDK S3 bucket during deployment. The asset can be used by other constructs.
-
-> ℹ️ _The high-level constructs for `TypeScriptSource` and `TypeScriptCode` (and respective JavaScript classes) actually just use this asset._
-
-**Default build options:**
-
-- `bundle=true`
-
-### Parameters
-
-- `scope: cdk.Construct`
-- `id: string`
-- `props: TypeScriptAssetProps|JavaScriptAssetProps`
-
-### Props
-
-- `props.entryPoints: string | string[] | Record<string, string>` \
-  A single or list of relative paths to the entry points of your code from the root of the project.
-
-- `props.copyDir?: string` \
-   **⚠️ Experimental** - _Likely to change once esbuild supports this natively_ \
-   Relative path to a directory copied to the output before the build is run (i.e esbuild will overwrite existing files).
-
-- `props.bundlerPriority?: BundlerPriority (BundlerPriority.AttemptLocal)` \
-  Set the priority order of available bundlers. It can be useful to limit use to one of the bundlers. For Docker, the `absWorkingDir` path (or current working directory) will be mounted into the container as context. By default bundling with a locally installed binary is attempted first and Docker will only be used if the local bundling fails.
-
-- `props.buildOptions?` as per esbuild [(reference)](https://esbuild.github.io/getting-started/#build-scripts) \
-  **All build options are optional.** \
-  ➡️ See `TypeScriptCode` for detailed explanation on options.
-
-## `EsbuildBundling`
-
-**⚠️ Status: Unstable**
-
-Low-level class that can be used where a `BundlingOptions` are required. This class provides the local und Docker-based bundling but doesn't come with any kind of safeguards.
-
-### Parameters
-
-- `buildOptions?` \
-  All esbuild options are available, with adapted functionality as described above.
-
-- `props.priority?: BundlerPriority (BundlerPriority.AttemptLocal)` \
-  Priority order of available bundlers. Default `BundlerPriority.AttemptLocal` is to attempt using a locally installed binary first, retrying with Docker in case of failure. Can be set to only use either the local or Docker bundler.
-
-- `props.copyDir?: string` \
-  Copy additional files to the output directory, before the build runs.
-
-- `props.esbuildVersion?: string` \
-  _Docker build only._ A npm compatible version constraint. If not provided will attempt to read from a `package-lock.json` or `package.json` in the `absWorkingDir`. Otherwise uses the constraint provided by this package (usually `^0.x.0`).
+- Update the package dependency to v2: `npm install --save @mrgrain/cdk-esbuild@^2.0.0`
+- `esbuild` is now installed as an optional dependency. If your setup does not automatically install optional dependencies, add it as an explicit dependency.
+- Remove any use of `bundlerPriority`.
+- 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.
 
 ## Versioning
 
-**⚠️ Status: Unstable**
+This 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`.
 
-_Because esbuild is still in major version zero, this package must be considered unstable. Notably updates to the minimal version requirement of esbuild will be introduced in minor versions of this package and thus will contain any breaking changes esbuild introduces._
+Although 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.
 
-**Upcoming changes to versioning! See Future section below.**
+### Npm Tags
 
-The package tracks the **minor** version number of CDK releases. It might work with newer versions of CDK, but has not been tested. Features changes, including breaking changes, will only be introduced alongside minor releases.
+Some users prefer to use tags over version ranges. The following stable tags are available for use:
 
-**Patches releases** will contain fixes to this library only and do not necessarily reflect CDK patches.
+- `cdk-v1`, `cdk-v2` are provided for the latest release compatible with each version of the AWS CDK.
 
-Any parts of the code marked as `unstable` can change at any time. Please note that the unstable flag is applied to all new or experimental features and internal classes.
+- `latest` is the most recent stable release.
 
-### Future
+These tags also exist, but usage is strongly not recommended:
 
-### `jsii` compatibility
+- `unstable`, `next` are used for pre-release of the current and next major version respectively.
 
-I am actively working on a [jsii](https://aws.github.io/jsii/) compatible version of this constructs library, see the [next branch](https://github.com/mrgrain/cdk-esbuild/tree/next) for further details. Amongst other things, this will allow me to publish the package to the [Construct Hub](https://constructs.dev/).
+- ~~`cdk-1.x.x`~~ tags have been deprecated in favour of `cdk-v1`. Use that one instead.
 
-**The release of this will be in a new major version 2.** Versioning will evolve further towards semantic versioning,with `esbuild` upgrades being the exception. They will continue to be shipped as part of minor version updates and might include breaking changes.
-
-**Most of the package will remain the same** and migration will be easy. However some interfaces need to be updated for `jsii` and deprecated features will be removed.
+## Future releases
 
 ### AWS CDK v2
 
-With the monolithic version 2 of CDK (aka Mono-CDK) on the horizon, versioning for this library will change as well.
+The 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.
 
-A major release will be marked alongside CDK. From that point on, this package will mostly use _semantic versioning_ and not longer align version numbers with AWS CDK.
+### Stable esbuild
 
-The big exceptions will be updates to the minimal version requirement of esbuild. As long as esbuild is still in major version zero, these requirement updates will be introduced as minor version updates.
+Once `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.
 
-Additionally any parts of the code marked as `unstable` can change at any time. Please note that the unstable flag is applied to new experimental features and internal classes.
+## Library authors
 
-### Stable esbuild
+When 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):
 
-Once `esbuild` has reached a stable version 1.0, a new major version will be released for _all_ breaking changes, including updated of minimum (peer) dependencies.
+```ts
+// file: project/src/index.ts
+const props = {
+  buildOptions: {
+    absWorkingDir: path.resolve(__dirname, ".."), // now: /user/project
+  },
+};
+```
 
-Additionally any parts of the code marked as `unstable` can change at any time. Please note that the unstable flag is applied to new experimental features and internal classes.
+This will dynamically resolve to the correct path, wherever the package is installed.

package/SECURITY.md

@@ -2,12 +2,12 @@
 
 ## Supported Versions
 
-Use this section to tell people about which versions of your project are
-currently being supported with security updates.
+Only the latest release of each major version is supported.
 
-| Plugin Version | CDK Version | Supported                                        |
-| -------------- | ----------- | ------------------------------------------------ |
-| 1.x.x          | 1.x.x       | :white_check_mark: only the latest minor version |
+| Plugin Version | CDK Version | Supported                   |
+| -------------- | ----------- | --------------------------- |
+| v1             | ^1.99.0     | until release of AWS CDK v2 |
+| v2             | ^1.99.0     | :white_check_mark:          |
 
 ## Reporting a Vulnerability