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

package/API.md

@@ -13,6 +13,22 @@ import { AssetProps } from '@mrgrain/cdk-esbuild'
 const assetProps: AssetProps = { ... }
 ```
 
+##### `buildFn`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.AssetProps.property.buildFn"></a>
+
+```typescript
+public readonly buildFn: any;
+```
+
+- *Type:* `any`
+- *Default:* esbuild.buildSync
+
+Escape hatch to provide the bundler with a custom build function.
+
+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.
+Must throw a `BuildFailure` on failure to correctly inform the bundler.
+
+---
+
 ##### `buildOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.AssetProps.property.buildOptions"></a>
 
 ```typescript
@@ -23,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` \
-Relative path to a file inside the CDK asset output directory. \
+- `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).
 
@@ -101,6 +117,8 @@ public readonly absWorkingDir: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#working-directory.
+
 ---
 
 ##### `allowOverwrite`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.allowOverwrite"></a>
@@ -111,6 +129,8 @@ public readonly allowOverwrite: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#allow-overwrite.
+
 ---
 
 ##### `assetNames`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.assetNames"></a>
@@ -121,6 +141,8 @@ public readonly assetNames: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#asset-names.
+
 ---
 
 ##### `banner`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.banner"></a>
@@ -131,6 +153,8 @@ public readonly banner: {[ key: string ]: string};
 
 - *Type:* {[ key: string ]: `string`}
 
+Documentation: https://esbuild.github.io/api/#banner.
+
 ---
 
 ##### `bundle`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.bundle"></a>
@@ -141,6 +165,8 @@ public readonly bundle: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#bundle.
+
 ---
 
 ##### `charset`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.charset"></a>
@@ -151,6 +177,8 @@ public readonly charset: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#charset.
+
 ---
 
 ##### `chunkNames`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.chunkNames"></a>
@@ -161,6 +189,8 @@ public readonly chunkNames: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#chunk-names.
+
 ---
 
 ##### `color`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.color"></a>
@@ -171,6 +201,8 @@ public readonly color: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#color.
+
 ---
 
 ##### `conditions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.conditions"></a>
@@ -181,6 +213,8 @@ public readonly conditions: string[];
 
 - *Type:* `string`[]
 
+Documentation: https://esbuild.github.io/api/#conditions.
+
 ---
 
 ##### `define`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.define"></a>
@@ -191,6 +225,8 @@ public readonly define: {[ key: string ]: string};
 
 - *Type:* {[ key: string ]: `string`}
 
+Documentation: https://esbuild.github.io/api/#define.
+
 ---
 
 ##### `entryNames`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.entryNames"></a>
@@ -201,6 +237,8 @@ public readonly entryNames: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#entry-names.
+
 ---
 
 ##### `external`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.external"></a>
@@ -211,6 +249,8 @@ public readonly external: string[];
 
 - *Type:* `string`[]
 
+Documentation: https://esbuild.github.io/api/#external.
+
 ---
 
 ##### `footer`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.footer"></a>
@@ -221,6 +261,8 @@ public readonly footer: {[ key: string ]: string};
 
 - *Type:* {[ key: string ]: `string`}
 
+Documentation: https://esbuild.github.io/api/#footer.
+
 ---
 
 ##### `format`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.format"></a>
@@ -231,6 +273,8 @@ public readonly format: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#format.
+
 ---
 
 ##### `globalName`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.globalName"></a>
@@ -241,6 +285,8 @@ public readonly globalName: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#globalName.
+
 ---
 
 ##### `ignoreAnnotations`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.ignoreAnnotations"></a>
@@ -251,6 +297,8 @@ public readonly ignoreAnnotations: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#ignore-annotations.
+
 ---
 
 ##### `incremental`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.incremental"></a>
@@ -261,6 +309,8 @@ public readonly incremental: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#incremental.
+
 ---
 
 ##### `inject`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.inject"></a>
@@ -271,6 +321,8 @@ public readonly inject: string[];
 
 - *Type:* `string`[]
 
+Documentation: https://esbuild.github.io/api/#inject.
+
 ---
 
 ##### `jsx`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.jsx"></a>
@@ -281,6 +333,8 @@ public readonly jsx: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#jsx.
+
 ---
 
 ##### `jsxFactory`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.jsxFactory"></a>
@@ -291,6 +345,8 @@ public readonly jsxFactory: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#jsx-factory.
+
 ---
 
 ##### `jsxFragment`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.jsxFragment"></a>
@@ -301,6 +357,8 @@ public readonly jsxFragment: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#jsx-fragment.
+
 ---
 
 ##### `keepNames`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.keepNames"></a>
@@ -311,6 +369,8 @@ public readonly keepNames: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#keep-names.
+
 ---
 
 ##### `legalComments`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.legalComments"></a>
@@ -321,6 +381,8 @@ public readonly legalComments: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#legal-comments.
+
 ---
 
 ##### `loader`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.loader"></a>
@@ -331,6 +393,8 @@ public readonly loader: {[ key: string ]: string};
 
 - *Type:* {[ key: string ]: `string`}
 
+Documentation: https://esbuild.github.io/api/#loader.
+
 ---
 
 ##### `logLevel`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.logLevel"></a>
@@ -341,6 +405,8 @@ public readonly logLevel: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#log-level.
+
 ---
 
 ##### `logLimit`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.logLimit"></a>
@@ -351,6 +417,8 @@ public readonly logLimit: number;
 
 - *Type:* `number`
 
+Documentation: https://esbuild.github.io/api/#log-limit.
+
 ---
 
 ##### `mainFields`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.mainFields"></a>
@@ -361,6 +429,8 @@ public readonly mainFields: string[];
 
 - *Type:* `string`[]
 
+Documentation: https://esbuild.github.io/api/#mainFields.
+
 ---
 
 ##### `metafile`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.metafile"></a>
@@ -371,6 +441,8 @@ public readonly metafile: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#metafile.
+
 ---
 
 ##### `minify`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.minify"></a>
@@ -381,6 +453,8 @@ public readonly minify: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#minify.
+
 ---
 
 ##### `minifyIdentifiers`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.minifyIdentifiers"></a>
@@ -391,6 +465,8 @@ public readonly minifyIdentifiers: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#minify.
+
 ---
 
 ##### `minifySyntax`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.minifySyntax"></a>
@@ -401,6 +477,8 @@ public readonly minifySyntax: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#minify.
+
 ---
 
 ##### `minifyWhitespace`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.minifyWhitespace"></a>
@@ -411,6 +489,8 @@ public readonly minifyWhitespace: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#minify.
+
 ---
 
 ##### `nodePaths`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.nodePaths"></a>
@@ -421,6 +501,8 @@ public readonly nodePaths: string[];
 
 - *Type:* `string`[]
 
+Documentation: https://esbuild.github.io/api/#node-paths.
+
 ---
 
 ##### `outbase`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.outbase"></a>
@@ -431,6 +513,8 @@ public readonly outbase: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#outbase.
+
 ---
 
 ##### `outdir`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.outdir"></a>
@@ -441,6 +525,8 @@ public readonly outdir: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#outdir.
+
 ---
 
 ##### `outExtension`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.outExtension"></a>
@@ -451,6 +537,8 @@ public readonly outExtension: {[ key: string ]: string};
 
 - *Type:* {[ key: string ]: `string`}
 
+Documentation: https://esbuild.github.io/api/#out-extension.
+
 ---
 
 ##### `outfile`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.outfile"></a>
@@ -461,6 +549,8 @@ public readonly outfile: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#outfile.
+
 ---
 
 ##### `platform`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.platform"></a>
@@ -471,6 +561,8 @@ public readonly platform: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#platform.
+
 ---
 
 ##### `preserveSymlinks`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.preserveSymlinks"></a>
@@ -481,6 +573,8 @@ public readonly preserveSymlinks: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#preserve-symlinks.
+
 ---
 
 ##### `publicPath`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.publicPath"></a>
@@ -491,6 +585,8 @@ public readonly publicPath: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#public-path.
+
 ---
 
 ##### `pure`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.pure"></a>
@@ -501,6 +597,8 @@ public readonly pure: string[];
 
 - *Type:* `string`[]
 
+Documentation: https://esbuild.github.io/api/#pure.
+
 ---
 
 ##### `resolveExtensions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.resolveExtensions"></a>
@@ -511,6 +609,8 @@ public readonly resolveExtensions: string[];
 
 - *Type:* `string`[]
 
+Documentation: https://esbuild.github.io/api/#resolve-extensions.
+
 ---
 
 ##### `sourcemap`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.sourcemap"></a>
@@ -521,6 +621,8 @@ public readonly sourcemap: boolean | string;
 
 - *Type:* `boolean` | `string`
 
+Documentation: https://esbuild.github.io/api/#sourcemap.
+
 ---
 
 ##### `sourceRoot`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.sourceRoot"></a>
@@ -531,6 +633,8 @@ public readonly sourceRoot: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#source-root.
+
 ---
 
 ##### `sourcesContent`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.sourcesContent"></a>
@@ -541,6 +645,8 @@ public readonly sourcesContent: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#sources-content.
+
 ---
 
 ##### `splitting`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.splitting"></a>
@@ -551,6 +657,8 @@ public readonly splitting: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#splitting.
+
 ---
 
 ##### `target`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.target"></a>
@@ -561,6 +669,8 @@ public readonly target: string | string[];
 
 - *Type:* `string` | `string`[]
 
+Documentation: https://esbuild.github.io/api/#target.
+
 ---
 
 ##### `treeShaking`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.treeShaking"></a>
@@ -571,6 +681,8 @@ public readonly treeShaking: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#tree-shaking.
+
 ---
 
 ##### `tsconfig`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.tsconfig"></a>
@@ -581,6 +693,8 @@ public readonly tsconfig: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#tsconfig.
+
 ---
 
 ##### `write`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.write"></a>
@@ -591,6 +705,8 @@ public readonly write: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#write.
+
 ---
 
 ### BundlerProps <a name="@mrgrain/cdk-esbuild.BundlerProps"></a>
@@ -603,6 +719,22 @@ import { BundlerProps } from '@mrgrain/cdk-esbuild'
 const bundlerProps: BundlerProps = { ... }
 ```
 
+##### `buildFn`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BundlerProps.property.buildFn"></a>
+
+```typescript
+public readonly buildFn: any;
+```
+
+- *Type:* `any`
+- *Default:* esbuild.buildSync
+
+Escape hatch to provide the bundler with a custom build function.
+
+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.
+Must throw a `BuildFailure` on failure to correctly inform the bundler.
+
+---
+
 ##### `buildOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BundlerProps.property.buildOptions"></a>
 
 ```typescript
@@ -613,15 +745,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` \
-Relative path to a file inside the CDK asset output directory. \
+- `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).
 
@@ -675,6 +807,22 @@ import { JavaScriptCodeProps } from '@mrgrain/cdk-esbuild'
 const javaScriptCodeProps: JavaScriptCodeProps = { ... }
 ```
 
+##### `buildFn`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptCodeProps.property.buildFn"></a>
+
+```typescript
+public readonly buildFn: any;
+```
+
+- *Type:* `any`
+- *Default:* esbuild.buildSync
+
+Escape hatch to provide the bundler with a custom build function.
+
+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.
+Must throw a `BuildFailure` on failure to correctly inform the bundler.
+
+---
+
 ##### `buildOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptCodeProps.property.buildOptions"></a>
 
 ```typescript
@@ -685,15 +833,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` \
-Relative path to a file inside the CDK asset output directory. \
+- `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).
 
@@ -741,6 +889,22 @@ import { JavaScriptSourceProps } from '@mrgrain/cdk-esbuild'
 const javaScriptSourceProps: JavaScriptSourceProps = { ... }
 ```
 
+##### `buildFn`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptSourceProps.property.buildFn"></a>
+
+```typescript
+public readonly buildFn: any;
+```
+
+- *Type:* `any`
+- *Default:* esbuild.buildSync
+
+Escape hatch to provide the bundler with a custom build function.
+
+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.
+Must throw a `BuildFailure` on failure to correctly inform the bundler.
+
+---
+
 ##### `buildOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptSourceProps.property.buildOptions"></a>
 
 ```typescript
@@ -751,15 +915,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` \
-Relative path to a file inside the CDK asset output directory. \
+- `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).
 
@@ -797,6 +961,48 @@ Defaults to a hash of all files in the resulting bundle.
 
 ---
 
+### TransformerProps <a name="@mrgrain/cdk-esbuild.TransformerProps"></a>
+
+#### Initializer <a name="[object Object].Initializer"></a>
+
+```typescript
+import { TransformerProps } from '@mrgrain/cdk-esbuild'
+
+const transformerProps: TransformerProps = { ... }
+```
+
+##### `transformFn`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformerProps.property.transformFn"></a>
+
+```typescript
+public readonly transformFn: any;
+```
+
+- *Type:* `any`
+- *Default:* esbuild.transformSync
+
+Escape hatch to provide the bundler with a custom transform function.
+
+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.
+Must throw a `TransformFailure` on failure to correctly inform the bundler.
+
+---
+
+##### `transformOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformerProps.property.transformOptions"></a>
+
+```typescript
+public readonly transformOptions: TransformOptions;
+```
+
+- *Type:* [`@mrgrain/cdk-esbuild.TransformOptions`](#@mrgrain/cdk-esbuild.TransformOptions)
+
+Transform options passed on to esbuild.
+
+Please refer to the esbuild Transform API docs for details.
+
+> https://esbuild.github.io/api/#transform-api
+
+---
+
 ### TransformOptions <a name="@mrgrain/cdk-esbuild.TransformOptions"></a>
 
 #### Initializer <a name="[object Object].Initializer"></a>
@@ -825,6 +1031,8 @@ public readonly charset: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#charset.
+
 ---
 
 ##### `color`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.color"></a>
@@ -835,6 +1043,8 @@ public readonly color: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#color.
+
 ---
 
 ##### `define`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.define"></a>
@@ -845,6 +1055,8 @@ public readonly define: {[ key: string ]: string};
 
 - *Type:* {[ key: string ]: `string`}
 
+Documentation: https://esbuild.github.io/api/#define.
+
 ---
 
 ##### `footer`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.footer"></a>
@@ -865,6 +1077,8 @@ public readonly format: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#format.
+
 ---
 
 ##### `globalName`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.globalName"></a>
@@ -875,6 +1089,8 @@ public readonly globalName: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#globalName.
+
 ---
 
 ##### `ignoreAnnotations`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.ignoreAnnotations"></a>
@@ -885,6 +1101,8 @@ public readonly ignoreAnnotations: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#ignore-annotations.
+
 ---
 
 ##### `jsx`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.jsx"></a>
@@ -895,6 +1113,8 @@ public readonly jsx: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#jsx.
+
 ---
 
 ##### `jsxFactory`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.jsxFactory"></a>
@@ -905,6 +1125,8 @@ public readonly jsxFactory: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#jsx-factory.
+
 ---
 
 ##### `jsxFragment`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.jsxFragment"></a>
@@ -915,6 +1137,8 @@ public readonly jsxFragment: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#jsx-fragment.
+
 ---
 
 ##### `keepNames`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.keepNames"></a>
@@ -925,6 +1149,8 @@ public readonly keepNames: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#keep-names.
+
 ---
 
 ##### `legalComments`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.legalComments"></a>
@@ -935,6 +1161,8 @@ public readonly legalComments: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#legal-comments.
+
 ---
 
 ##### `loader`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.loader"></a>
@@ -955,6 +1183,8 @@ public readonly logLevel: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#log-level.
+
 ---
 
 ##### `logLimit`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.logLimit"></a>
@@ -965,6 +1195,8 @@ public readonly logLimit: number;
 
 - *Type:* `number`
 
+Documentation: https://esbuild.github.io/api/#log-limit.
+
 ---
 
 ##### `minify`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.minify"></a>
@@ -975,6 +1207,8 @@ public readonly minify: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#minify.
+
 ---
 
 ##### `minifyIdentifiers`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.minifyIdentifiers"></a>
@@ -985,6 +1219,8 @@ public readonly minifyIdentifiers: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#minify.
+
 ---
 
 ##### `minifySyntax`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.minifySyntax"></a>
@@ -995,6 +1231,8 @@ public readonly minifySyntax: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#minify.
+
 ---
 
 ##### `minifyWhitespace`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.minifyWhitespace"></a>
@@ -1005,6 +1243,8 @@ public readonly minifyWhitespace: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#minify.
+
 ---
 
 ##### `pure`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.pure"></a>
@@ -1015,6 +1255,8 @@ public readonly pure: string[];
 
 - *Type:* `string`[]
 
+Documentation: https://esbuild.github.io/api/#pure.
+
 ---
 
 ##### `sourcefile`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.sourcefile"></a>
@@ -1035,6 +1277,8 @@ public readonly sourcemap: boolean | string;
 
 - *Type:* `boolean` | `string`
 
+Documentation: https://esbuild.github.io/api/#sourcemap.
+
 ---
 
 ##### `sourceRoot`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.sourceRoot"></a>
@@ -1045,6 +1289,8 @@ public readonly sourceRoot: string;
 
 - *Type:* `string`
 
+Documentation: https://esbuild.github.io/api/#source-root.
+
 ---
 
 ##### `sourcesContent`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.sourcesContent"></a>
@@ -1055,6 +1301,8 @@ public readonly sourcesContent: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#sources-content.
+
 ---
 
 ##### `target`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.target"></a>
@@ -1065,6 +1313,8 @@ public readonly target: string | string[];
 
 - *Type:* `string` | `string`[]
 
+Documentation: https://esbuild.github.io/api/#target.
+
 ---
 
 ##### `treeShaking`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.treeShaking"></a>
@@ -1075,6 +1325,8 @@ public readonly treeShaking: boolean;
 
 - *Type:* `boolean`
 
+Documentation: https://esbuild.github.io/api/#tree-shaking.
+
 ---
 
 ##### `tsconfigRaw`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.tsconfigRaw"></a>
@@ -1097,6 +1349,22 @@ import { TypeScriptCodeProps } from '@mrgrain/cdk-esbuild'
 const typeScriptCodeProps: TypeScriptCodeProps = { ... }
 ```
 
+##### `buildFn`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptCodeProps.property.buildFn"></a>
+
+```typescript
+public readonly buildFn: any;
+```
+
+- *Type:* `any`
+- *Default:* esbuild.buildSync
+
+Escape hatch to provide the bundler with a custom build function.
+
+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.
+Must throw a `BuildFailure` on failure to correctly inform the bundler.
+
+---
+
 ##### `buildOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptCodeProps.property.buildOptions"></a>
 
 ```typescript
@@ -1107,15 +1375,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` \
-Relative path to a file inside the CDK asset output directory. \
+- `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).
 
@@ -1163,6 +1431,22 @@ import { TypeScriptSourceProps } from '@mrgrain/cdk-esbuild'
 const typeScriptSourceProps: TypeScriptSourceProps = { ... }
 ```
 
+##### `buildFn`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptSourceProps.property.buildFn"></a>
+
+```typescript
+public readonly buildFn: any;
+```
+
+- *Type:* `any`
+- *Default:* esbuild.buildSync
+
+Escape hatch to provide the bundler with a custom build function.
+
+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.
+Must throw a `BuildFailure` on failure to correctly inform the bundler.
+
+---
+
 ##### `buildOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptSourceProps.property.buildOptions"></a>
 
 ```typescript
@@ -1173,15 +1457,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` \
-Relative path to a file inside the CDK asset output directory. \
+- `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).
 
@@ -1317,7 +1601,7 @@ An implementation of `lambda.InlineCode` using the esbuild Transform API. Inline
 ```typescript
 import { InlineJavaScriptCode } from '@mrgrain/cdk-esbuild'
 
-new InlineJavaScriptCode(code: string, transformOptions?: TransformOptions)
+new InlineJavaScriptCode(code: string, props?: TransformOptions | TransformerProps)
 ```
 
 ##### `code`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.InlineJavaScriptCode.parameter.code"></a>
@@ -1328,14 +1612,15 @@ The inline code to be transformed.
 
 ---
 
-##### `transformOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.InlineJavaScriptCode.parameter.transformOptions"></a>
+##### `props`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.InlineJavaScriptCode.parameter.props"></a>
 
-- *Type:* [`@mrgrain/cdk-esbuild.TransformOptions`](#@mrgrain/cdk-esbuild.TransformOptions)
+- *Type:* [`@mrgrain/cdk-esbuild.TransformOptions`](#@mrgrain/cdk-esbuild.TransformOptions) | [`@mrgrain/cdk-esbuild.TransformerProps`](#@mrgrain/cdk-esbuild.TransformerProps)
 
-Transform options passed on to esbuild.
+Support for `TransformOptions` is deprecated. Please provide `TransformerProps`!
 
-Please refer to the esbuild Transform API docs for details. \
-Default values for `transformOptions`:
+Props to change the behaviour of the transformer.
+
+Default values for `props.transformOptions`:
 - `loader='js'`
 
 > https://esbuild.github.io/api/#transform-api
@@ -1355,7 +1640,7 @@ An implementation of `lambda.InlineCode` using the esbuild Transform API. Inline
 ```typescript
 import { InlineJsxCode } from '@mrgrain/cdk-esbuild'
 
-new InlineJsxCode(code: string, transformOptions?: TransformOptions)
+new InlineJsxCode(code: string, props?: TransformOptions | TransformerProps)
 ```
 
 ##### `code`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.InlineJsxCode.parameter.code"></a>
@@ -1366,13 +1651,14 @@ The inline code to be transformed.
 
 ---
 
-##### `transformOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.InlineJsxCode.parameter.transformOptions"></a>
+##### `props`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.InlineJsxCode.parameter.props"></a>
 
-- *Type:* [`@mrgrain/cdk-esbuild.TransformOptions`](#@mrgrain/cdk-esbuild.TransformOptions)
+- *Type:* [`@mrgrain/cdk-esbuild.TransformOptions`](#@mrgrain/cdk-esbuild.TransformOptions) | [`@mrgrain/cdk-esbuild.TransformerProps`](#@mrgrain/cdk-esbuild.TransformerProps)
 
-Transform options passed on to esbuild.
+Support for `TransformOptions` is deprecated. Please provide `TransformerProps`!
+
+Props to change the behaviour of the transformer.
 
-Please refer to the esbuild Transform API docs for details. \
 Default values for `transformOptions`:
 - `loader='jsx'`
 
@@ -1393,7 +1679,7 @@ An implementation of `lambda.InlineCode` using the esbuild Transform API. Inline
 ```typescript
 import { InlineTsxCode } from '@mrgrain/cdk-esbuild'
 
-new InlineTsxCode(code: string, transformOptions?: TransformOptions)
+new InlineTsxCode(code: string, props?: TransformOptions | TransformerProps)
 ```
 
 ##### `code`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.InlineTsxCode.parameter.code"></a>
@@ -1404,13 +1690,14 @@ The inline code to be transformed.
 
 ---
 
-##### `transformOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.InlineTsxCode.parameter.transformOptions"></a>
+##### `props`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.InlineTsxCode.parameter.props"></a>
 
-- *Type:* [`@mrgrain/cdk-esbuild.TransformOptions`](#@mrgrain/cdk-esbuild.TransformOptions)
+- *Type:* [`@mrgrain/cdk-esbuild.TransformOptions`](#@mrgrain/cdk-esbuild.TransformOptions) | [`@mrgrain/cdk-esbuild.TransformerProps`](#@mrgrain/cdk-esbuild.TransformerProps)
 
-Transform options passed on to esbuild.
+Support for `TransformOptions` is deprecated. Please provide `TransformerProps`!
+
+Props to change the behaviour of the transformer.
 
-Please refer to the esbuild Transform API docs for details. \
 Default values for `transformOptions`:
 - `loader='tsx'`
 
@@ -1431,7 +1718,7 @@ An implementation of `lambda.InlineCode` using the esbuild Transform API. Inline
 ```typescript
 import { InlineTypeScriptCode } from '@mrgrain/cdk-esbuild'
 
-new InlineTypeScriptCode(code: string, transformOptions?: TransformOptions)
+new InlineTypeScriptCode(code: string, props?: TransformOptions | TransformerProps)
 ```
 
 ##### `code`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.InlineTypeScriptCode.parameter.code"></a>
@@ -1442,13 +1729,14 @@ The inline code to be transformed.
 
 ---
 
-##### `transformOptions`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.InlineTypeScriptCode.parameter.transformOptions"></a>
+##### `props`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.InlineTypeScriptCode.parameter.props"></a>
 
-- *Type:* [`@mrgrain/cdk-esbuild.TransformOptions`](#@mrgrain/cdk-esbuild.TransformOptions)
+- *Type:* [`@mrgrain/cdk-esbuild.TransformOptions`](#@mrgrain/cdk-esbuild.TransformOptions) | [`@mrgrain/cdk-esbuild.TransformerProps`](#@mrgrain/cdk-esbuild.TransformerProps)
 
-Transform options passed on to esbuild.
+Support for `TransformOptions` is deprecated. Please provide `TransformerProps`!
+
+Props to change the behaviour of the transformer.
 
-Please refer to the esbuild Transform API docs for details. \
 Default values for `transformOptions`:
 - `loader='ts'`