@mrgrain/cdk-esbuild 3.1.0 → 3.4.0

package/.projenrc.ts

@@ -85,14 +85,9 @@ const project = new awscdk.AwsCdkConstructLibrary({
 
   // Dependencies
   cdkVersion: '2.0.0',
-  peerDeps: [
-    'aws-cdk-lib@^2.0.0',
-  ],
   devDeps: [
-    '@aws-cdk/aws-synthetics-alpha',
+    '@aws-cdk/aws-synthetics-alpha@2.0.0-alpha.11',
     '@types/eslint',
-    'aws-cdk-lib@2.0.0',
-    'constructs@10.0.5',
     'esbuild@^0.14.0',
     'jest-mock',
     'ts-morph',
@@ -188,7 +183,10 @@ new TypeScriptSourceFile(project, 'src/esbuild-types.ts', {
 
     ['CommonOptions', 'BuildOptions', 'TransformOptions'].forEach(readonlyInterface);
     removeFromInterface('BuildOptions', ['entryPoints', 'stdin', 'plugins', 'watch']);
+    esbuildTypes.getInterface('CommonOptions')?.getProperty('mangleProps')?.setType('any');
+    esbuildTypes.getInterface('CommonOptions')?.getProperty('reserveProps')?.setType('any');
     esbuildTypes.getInterface('TransformOptions')?.getProperty('tsconfigRaw')?.setType('string');
+    esbuildTypes.getInterface('InitializeOptions')?.getProperty('wasmModule')?.setType('any');
   },
 });
 

package/API.md

@@ -39,15 +39,15 @@ public readonly buildOptions: BuildOptions;
 
 Build options passed on to esbuild. Please refer to the esbuild Build API docs for details.
 
-`buildOptions.outdir: string`
+* `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`
+* `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`
+* `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). \
 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 "Library authors" section in the documentation).
 
@@ -58,14 +58,27 @@ If paths cannot be found, a good starting point is to look at the concatenation
 ##### `copyDir`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.AssetProps.property.copyDir"></a>
 
 ```typescript
-public readonly copyDir: string;
+public readonly copyDir: string | string[] | {[ key: string ]: string | string[]};
 ```
 
-- *Type:* `string`
+- *Type:* `string` | `string`[] | {[ key: string ]: `string` | `string`[]}
+
+Copy additional files to the code [asset staging directory](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.AssetStaging.html#absolutestagedpath), before the build runs. Files copied like this will be overwritten by esbuild if they share the same name as any of the outputs.
 
-Copy additional files to the output directory, before the build runs.
+* When provided with a `string` or `array`, all files are copied to the root of asset staging directory.
+* When given a `map`, the key indicates the destination relative to the asset staging directory and the value is a list of all sources to be copied.
 
-Files copied like this will be overwritten by esbuild if they share the same name as any of the outputs.
+Therefore the following values for `copyDir` are all equivalent:
+```ts
+{ copyDir: "path/to/source" }
+{ copyDir: ["path/to/source"] }
+{ copyDir: { ".": "path/to/source" } }
+{ copyDir: { ".": ["path/to/source"] } }
+```
+The destination cannot be outside of the asset staging directory.
+If you are receiving the error "Cannot copy files to outside of the asset staging directory."
+you are likely using `..` or an absolute path as key on the `copyDir` map.
+Instead use only relative paths and avoid `..`.
 
 ---
 
@@ -237,6 +250,8 @@ public readonly drop: string[];
 
 - *Type:* `string`[]
 
+Documentation: https://esbuild.github.io/api/#drop.
+
 ---
 
 ##### `entryNames`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.entryNames"></a>
@@ -443,6 +458,42 @@ Documentation: https://esbuild.github.io/api/#mainFields.
 
 ---
 
+##### `mangleCache`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.mangleCache"></a>
+
+```typescript
+public readonly mangleCache: {[ key: string ]: string | boolean};
+```
+
+- *Type:* {[ key: string ]: `string` | `boolean`}
+
+Documentation: https://esbuild.github.io/api/#mangle-props.
+
+---
+
+##### `mangleProps`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.mangleProps"></a>
+
+```typescript
+public readonly mangleProps: any;
+```
+
+- *Type:* `any`
+
+Documentation: https://esbuild.github.io/api/#mangle-props.
+
+---
+
+##### `mangleQuoted`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.mangleQuoted"></a>
+
+```typescript
+public readonly mangleQuoted: boolean;
+```
+
+- *Type:* `boolean`
+
+Documentation: https://esbuild.github.io/api/#mangle-props.
+
+---
+
 ##### `metafile`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.metafile"></a>
 
 ```typescript
@@ -611,6 +662,18 @@ Documentation: https://esbuild.github.io/api/#pure.
 
 ---
 
+##### `reserveProps`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.reserveProps"></a>
+
+```typescript
+public readonly reserveProps: any;
+```
+
+- *Type:* `any`
+
+Documentation: https://esbuild.github.io/api/#mangle-props.
+
+---
+
 ##### `resolveExtensions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.resolveExtensions"></a>
 
 ```typescript
@@ -755,15 +818,15 @@ public readonly buildOptions: BuildOptions;
 
 Build options passed on to esbuild. Please refer to the esbuild Build API docs for details.
 
-`buildOptions.outdir: string`
+* `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`
+* `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`
+* `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). \
 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 "Library authors" section in the documentation).
 
@@ -774,14 +837,27 @@ If paths cannot be found, a good starting point is to look at the concatenation
 ##### `copyDir`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BundlerProps.property.copyDir"></a>
 
 ```typescript
-public readonly copyDir: string;
+public readonly copyDir: string | string[] | {[ key: string ]: string | string[]};
 ```
 
-- *Type:* `string`
+- *Type:* `string` | `string`[] | {[ key: string ]: `string` | `string`[]}
 
-Copy additional files to the output directory, before the build runs.
+Copy additional files to the code [asset staging directory](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.AssetStaging.html#absolutestagedpath), before the build runs. Files copied like this will be overwritten by esbuild if they share the same name as any of the outputs.
 
-Files copied like this will be overwritten by esbuild if they share the same name as any of the outputs.
+* When provided with a `string` or `array`, all files are copied to the root of asset staging directory.
+* When given a `map`, the key indicates the destination relative to the asset staging directory and the value is a list of all sources to be copied.
+
+Therefore the following values for `copyDir` are all equivalent:
+```ts
+{ copyDir: "path/to/source" }
+{ copyDir: ["path/to/source"] }
+{ copyDir: { ".": "path/to/source" } }
+{ copyDir: { ".": ["path/to/source"] } }
+```
+The destination cannot be outside of the asset staging directory.
+If you are receiving the error "Cannot copy files to outside of the asset staging directory."
+you are likely using `..` or an absolute path as key on the `copyDir` map.
+Instead use only relative paths and avoid `..`.
 
 ---
 
@@ -843,15 +919,15 @@ public readonly buildOptions: BuildOptions;
 
 Build options passed on to esbuild. Please refer to the esbuild Build API docs for details.
 
-`buildOptions.outdir: string`
+* `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`
+* `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`
+* `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). \
 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 "Library authors" section in the documentation).
 
@@ -862,14 +938,27 @@ If paths cannot be found, a good starting point is to look at the concatenation
 ##### `copyDir`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptCodeProps.property.copyDir"></a>
 
 ```typescript
-public readonly copyDir: string;
+public readonly copyDir: string | string[] | {[ key: string ]: string | string[]};
 ```
 
-- *Type:* `string`
+- *Type:* `string` | `string`[] | {[ key: string ]: `string` | `string`[]}
 
-Copy additional files to the output directory, before the build runs.
+Copy additional files to the code [asset staging directory](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.AssetStaging.html#absolutestagedpath), before the build runs. Files copied like this will be overwritten by esbuild if they share the same name as any of the outputs.
 
-Files copied like this will be overwritten by esbuild if they share the same name as any of the outputs.
+* When provided with a `string` or `array`, all files are copied to the root of asset staging directory.
+* When given a `map`, the key indicates the destination relative to the asset staging directory and the value is a list of all sources to be copied.
+
+Therefore the following values for `copyDir` are all equivalent:
+```ts
+{ copyDir: "path/to/source" }
+{ copyDir: ["path/to/source"] }
+{ copyDir: { ".": "path/to/source" } }
+{ copyDir: { ".": ["path/to/source"] } }
+```
+The destination cannot be outside of the asset staging directory.
+If you are receiving the error "Cannot copy files to outside of the asset staging directory."
+you are likely using `..` or an absolute path as key on the `copyDir` map.
+Instead use only relative paths and avoid `..`.
 
 ---
 
@@ -925,15 +1014,15 @@ public readonly buildOptions: BuildOptions;
 
 Build options passed on to esbuild. Please refer to the esbuild Build API docs for details.
 
-`buildOptions.outdir: string`
+* `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`
+* `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`
+* `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). \
 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 "Library authors" section in the documentation).
 
@@ -944,14 +1033,27 @@ If paths cannot be found, a good starting point is to look at the concatenation
 ##### `copyDir`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptSourceProps.property.copyDir"></a>
 
 ```typescript
-public readonly copyDir: string;
+public readonly copyDir: string | string[] | {[ key: string ]: string | string[]};
 ```
 
-- *Type:* `string`
+- *Type:* `string` | `string`[] | {[ key: string ]: `string` | `string`[]}
+
+Copy additional files to the code [asset staging directory](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.AssetStaging.html#absolutestagedpath), before the build runs. Files copied like this will be overwritten by esbuild if they share the same name as any of the outputs.
 
-Copy additional files to the output directory, before the build runs.
+* When provided with a `string` or `array`, all files are copied to the root of asset staging directory.
+* When given a `map`, the key indicates the destination relative to the asset staging directory and the value is a list of all sources to be copied.
 
-Files copied like this will be overwritten by esbuild if they share the same name as any of the outputs.
+Therefore the following values for `copyDir` are all equivalent:
+```ts
+{ copyDir: "path/to/source" }
+{ copyDir: ["path/to/source"] }
+{ copyDir: { ".": "path/to/source" } }
+{ copyDir: { ".": ["path/to/source"] } }
+```
+The destination cannot be outside of the asset staging directory.
+If you are receiving the error "Cannot copy files to outside of the asset staging directory."
+you are likely using `..` or an absolute path as key on the `copyDir` map.
+Instead use only relative paths and avoid `..`.
 
 ---
 
@@ -1077,6 +1179,8 @@ public readonly drop: string[];
 
 - *Type:* `string`[]
 
+Documentation: https://esbuild.github.io/api/#drop.
+
 ---
 
 ##### `footer`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.footer"></a>
@@ -1219,6 +1323,42 @@ Documentation: https://esbuild.github.io/api/#log-limit.
 
 ---
 
+##### `mangleCache`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.mangleCache"></a>
+
+```typescript
+public readonly mangleCache: {[ key: string ]: string | boolean};
+```
+
+- *Type:* {[ key: string ]: `string` | `boolean`}
+
+Documentation: https://esbuild.github.io/api/#mangle-props.
+
+---
+
+##### `mangleProps`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.mangleProps"></a>
+
+```typescript
+public readonly mangleProps: any;
+```
+
+- *Type:* `any`
+
+Documentation: https://esbuild.github.io/api/#mangle-props.
+
+---
+
+##### `mangleQuoted`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.mangleQuoted"></a>
+
+```typescript
+public readonly mangleQuoted: boolean;
+```
+
+- *Type:* `boolean`
+
+Documentation: https://esbuild.github.io/api/#mangle-props.
+
+---
+
 ##### `minify`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.minify"></a>
 
 ```typescript
@@ -1279,6 +1419,18 @@ Documentation: https://esbuild.github.io/api/#pure.
 
 ---
 
+##### `reserveProps`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.reserveProps"></a>
+
+```typescript
+public readonly reserveProps: any;
+```
+
+- *Type:* `any`
+
+Documentation: https://esbuild.github.io/api/#mangle-props.
+
+---
+
 ##### `sourcefile`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.sourcefile"></a>
 
 ```typescript
@@ -1395,15 +1547,15 @@ public readonly buildOptions: BuildOptions;
 
 Build options passed on to esbuild. Please refer to the esbuild Build API docs for details.
 
-`buildOptions.outdir: string`
+* `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`
+* `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`
+* `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). \
 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 "Library authors" section in the documentation).
 
@@ -1414,14 +1566,27 @@ If paths cannot be found, a good starting point is to look at the concatenation
 ##### `copyDir`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptCodeProps.property.copyDir"></a>
 
 ```typescript
-public readonly copyDir: string;
+public readonly copyDir: string | string[] | {[ key: string ]: string | string[]};
 ```
 
-- *Type:* `string`
+- *Type:* `string` | `string`[] | {[ key: string ]: `string` | `string`[]}
 
-Copy additional files to the output directory, before the build runs.
+Copy additional files to the code [asset staging directory](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.AssetStaging.html#absolutestagedpath), before the build runs. Files copied like this will be overwritten by esbuild if they share the same name as any of the outputs.
 
-Files copied like this will be overwritten by esbuild if they share the same name as any of the outputs.
+* When provided with a `string` or `array`, all files are copied to the root of asset staging directory.
+* When given a `map`, the key indicates the destination relative to the asset staging directory and the value is a list of all sources to be copied.
+
+Therefore the following values for `copyDir` are all equivalent:
+```ts
+{ copyDir: "path/to/source" }
+{ copyDir: ["path/to/source"] }
+{ copyDir: { ".": "path/to/source" } }
+{ copyDir: { ".": ["path/to/source"] } }
+```
+The destination cannot be outside of the asset staging directory.
+If you are receiving the error "Cannot copy files to outside of the asset staging directory."
+you are likely using `..` or an absolute path as key on the `copyDir` map.
+Instead use only relative paths and avoid `..`.
 
 ---
 
@@ -1477,15 +1642,15 @@ public readonly buildOptions: BuildOptions;
 
 Build options passed on to esbuild. Please refer to the esbuild Build API docs for details.
 
-`buildOptions.outdir: string`
+* `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`
+* `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`
+* `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). \
 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 "Library authors" section in the documentation).
 
@@ -1496,14 +1661,27 @@ If paths cannot be found, a good starting point is to look at the concatenation
 ##### `copyDir`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptSourceProps.property.copyDir"></a>
 
 ```typescript
-public readonly copyDir: string;
+public readonly copyDir: string | string[] | {[ key: string ]: string | string[]};
 ```
 
-- *Type:* `string`
+- *Type:* `string` | `string`[] | {[ key: string ]: `string` | `string`[]}
 
-Copy additional files to the output directory, before the build runs.
+Copy additional files to the code [asset staging directory](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.AssetStaging.html#absolutestagedpath), before the build runs. Files copied like this will be overwritten by esbuild if they share the same name as any of the outputs.
 
-Files copied like this will be overwritten by esbuild if they share the same name as any of the outputs.
+* When provided with a `string` or `array`, all files are copied to the root of asset staging directory.
+* When given a `map`, the key indicates the destination relative to the asset staging directory and the value is a list of all sources to be copied.
+
+Therefore the following values for `copyDir` are all equivalent:
+```ts
+{ copyDir: "path/to/source" }
+{ copyDir: ["path/to/source"] }
+{ copyDir: { ".": "path/to/source" } }
+{ copyDir: { ".": ["path/to/source"] } }
+```
+The destination cannot be outside of the asset staging directory.
+If you are receiving the error "Cannot copy files to outside of the asset staging directory."
+you are likely using `..` or an absolute path as key on the `copyDir` map.
+Instead use only relative paths and avoid `..`.
 
 ---
 

package/CHANGELOG.md

@@ -1,13 +1,7 @@
 
-## [3.1.0](https://github.com/mrgrain/cdk-esbuild/compare/v3.0.0...v3.1.0) (2022-01-28)
+## [3.4.0](https://github.com/mrgrain/cdk-esbuild/compare/v3.3.0...v3.4.0) (2022-05-26)
 
 
 ### Features
 
-* support new build option `drop` from esbuild ([54445ad](https://github.com/mrgrain/cdk-esbuild/commit/54445ad2490e7cba81e54a555a91ba86553ec67f))
-
-
-### Bug Fixes
-
-* replace mocked with version from jest-mock ([2e9761d](https://github.com/mrgrain/cdk-esbuild/commit/2e9761d5f53293a6a840897e218c2e79a6b71c66))
-* replace removed Node.js type ([e58b268](https://github.com/mrgrain/cdk-esbuild/commit/e58b2685c519cb9c4d7e1a148c4fc9f388d3ff90))
+* copyDir supports more complex scenarios ([08c59fb](https://github.com/mrgrain/cdk-esbuild/commit/08c59fba7bf1ee68ca103520b3e0b7ea5359a925))

package/README.md

@@ -2,11 +2,11 @@
 
 _CDK constructs for [esbuild](https://github.com/evanw/esbuild), an extremely fast JavaScript bundler_
 
-> ⚠️ 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)
-
 [Getting started](#getting-started) | [Migrating to v3](#migrating-to-v3) |
 [Documentation](#documentation) | [API Reference](#api-reference) | [Versioning](#versioning)
 
+> 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).
+
 ## Why?
 
 _esbuild_ is an extremely fast bundler and minifier for Typescript and JavaScript.
@@ -18,7 +18,7 @@ This package is running _esbuild_ directly in Node.js and bypasses Docker which
 
 **Production readiness**
 
-This 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).
+This 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).
 
 Notably upgrades of the _esbuild_ minimum version requirement will be introduced in **minor versions** of this package and will inherit breaking changes from _esbuild_.
 
@@ -27,13 +27,13 @@ Notably upgrades of the _esbuild_ minimum version requirement will be introduced
 Install `cdk-esbuild`:
 
 ```
-npm install @mrgrain/cdk-esbuild@^3.0.0
+npm install @mrgrain/cdk-esbuild@3
 ```
 
-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:
+If _peer_ or _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@^3.0.0 esbuild
+npm install @mrgrain/cdk-esbuild@3 esbuild
 ```
 
 ### AWS Lambda: Serverless function
@@ -49,7 +49,7 @@ import { TypeScriptCode } from "@mrgrain/cdk-esbuild";
 const bundledCode = new TypeScriptCode("src/index.ts");
 
 const fn = new lambda.Function(stack, "MyFunction", {
-  runtime: lambda.Runtime.NODEJS_14_X,
+  runtime: lambda.Runtime.NODEJS_16_X,
   handler: "index.handler",
   code: bundledCode,
 });
@@ -112,7 +112,7 @@ const canary = new synthetics.Canary(stack, "MyCanary", {
 });
 ```
 
-# Documentation
+## Documentation
 
 The 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.
 
@@ -129,9 +129,9 @@ 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 plug-in to other high-level CDK constructs. They share the same set of parameters, props and build options._
 
-Underlying classes power the other features. You normally won't have to use them, but they are there if you need them:
+The following 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/v2/docs/aws-cdk-lib.aws_s3_assets.Asset.html)) \
   creates an asset uploaded to S3 which can be referenced by other constructs
@@ -139,21 +139,21 @@ Underlying classes power the other features. You normally won't have to use them
 - `EsbuildBundler` implements `core.BundlingOptions` ([reference](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.BundlingOptions.html)) \
   provides an interface for a _esbuild_ bundler wherever needed
 
-## [API Reference](API.md)
+### [API Reference](API.md)
 
-Auto-generated reference for classes and structs. This information is also available within the code completion of your IDE.
+Auto-generated reference for classes and structs. This information is also available as part of your IDE's code completion.
 
-## Escape hatches
+### Escape hatches
 
-It's possible that you want to use a implementation of esbuild that's different to the default one. Common reasons are:
+It's possible that you want to use an implementation of esbuild that's different to the default one. Common reasons are:
 
 - The current version constraints for esbuild are not suitable
-- To use version of esbuild that is installed by any other means than `npm`, including Docker
-- Plugin support is needed for the building
+- To use a version of esbuild that is installed by any other means than `npm`, including Docker
+- Plugin support is needed for building
 
 For these situations, this package offers an escape hatch to bypass regular the implementation and provide a custom build and transform function.
 
-### Custom build function
+#### Custom build function
 
 > 💡 See [Using esbuild with plugins](examples/esbuild-with-plugins) for a complete working example of a custom build function using this escape hatch.
 
@@ -175,7 +175,7 @@ Instead of esbuild, the provided function will be invoked with the calculated bu
 
 Failures have to cause a `BuildFailure` exception in order to be fully handled.
 
-### Custom transform function
+#### Custom transform function
 
 Constructs 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.
 
@@ -195,11 +195,11 @@ Instead of esbuild, the provided function will be invoked with the calculated tr
 
 Failures have to cause a `TransformFailure` exception in order to be fully handled.
 
-## Migrating to v3
+### Migrating to v3
 
 The 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.
 
-### Upgrading
+#### Upgrading
 
 - 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.
 - Update the package dependency to v3: `npm install --save @mrgrain/cdk-esbuild@^3.0.0`
@@ -217,7 +217,7 @@ The release of cdk-esbuild v3 brings compatibility with AWS CDK v2. Furthermore
 
 ## Versioning
 
-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`.
+This 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`.
 
 ### Npm Tags
 
@@ -233,15 +233,15 @@ These tags also exist, but usage is strongly not recommended:
 
 - ~~`cdk-1.x.x`~~ tags have been deprecated in favour of `cdk-v1`. Use that one instead.
 
-## Future releases
+## Roadmap & Contributions
 
-### Stable esbuild
+[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.
 
-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.
+All contributions are welcome, no matter if they are for already planned or completely new features.
 
 ## Library authors
 
-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):
+Building 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):
 
 ```ts
 // file: project/src/index.ts
@@ -253,3 +253,5 @@ const props = {
 ```
 
 This will dynamically resolve to the correct path, wherever the package is installed.
+
+Please open an issue if you encounter any difficulties.