@mrgrain/cdk-esbuild 2.0.0 → 3.0.0-rc.1

package/.projenrc.ts

@@ -1,5 +1,6 @@
 import {
   AwsCdkConstructLibrary,
+  IgnoreFile,
   JsonFile,
   NodePackageManager,
   release,
@@ -17,6 +18,9 @@ const project = new AwsCdkConstructLibrary({
     lintProjenRc: false,
     dirs: ['src', 'projenrc', '.projenrc.ts'],
   },
+  depsUpgradeOptions: {
+    workflow: false,
+  },
 
   // Project info
   name: '@mrgrain/cdk-esbuild',
@@ -42,11 +46,21 @@ const project = new AwsCdkConstructLibrary({
   license: 'MIT',
   copyrightOwner: 'Moritz Kornher',
 
+  // Testing & Linting
+  githubOptions: {
+    pullRequestLintOptions: {
+      semanticTitleOptions: {
+        types: ['feat', 'fix', 'chore', 'docs', 'ci'],
+      },
+    },
+  },
+
   // Release
   packageManager: NodePackageManager.NPM,
-  npmDistTag: 'latest',
-  defaultReleaseBranch: 'main',
-  majorVersion: 2,
+  npmDistTag: 'next',
+  defaultReleaseBranch: 'next',
+  majorVersion: 3,
+  prerelease: 'rc',
   releaseTrigger: release.ReleaseTrigger.manual(),
   catalog: {
     twitter: '@mrgrain',
@@ -54,27 +68,19 @@ const project = new AwsCdkConstructLibrary({
   workflowContainerImage: 'jsii/superchain:1-buster-slim-node14',
 
   // Dependencies
-  cdkVersion: '1.99.0',
-  cdkDependencies: [
-    '@aws-cdk/aws-lambda',
-    '@aws-cdk/aws-s3',
-    '@aws-cdk/aws-s3-assets',
-    '@aws-cdk/aws-s3-deployment',
-    '@aws-cdk/aws-synthetics',
-    '@aws-cdk/core',
-  ],
-  cdkTestDependencies: [
-    '@aws-cdk/assert',
-    '@aws-cdk/aws-lambda',
-    '@aws-cdk/aws-s3',
-    '@aws-cdk/aws-s3-assets',
-    '@aws-cdk/aws-s3-deployment',
-    '@aws-cdk/aws-synthetics',
-    '@aws-cdk/core',
+  cdkVersion: '2.0.0',
+  peerDeps: [
+    'aws-cdk-lib@^2.0.0',
   ],
+  cdkDependencies: [],
+  cdkTestDependencies: [],
+  cdkAssert: false,
   devDeps: [
+    '@aws-cdk/aws-synthetics-alpha',
     '@types/eslint',
-    'esbuild@^0.13.0',
+    'aws-cdk-lib@2.0.0',
+    'constructs@10.0.5',
+    'esbuild@^0.14.0',
     'ts-morph',
   ],
 
@@ -105,7 +111,7 @@ const project = new AwsCdkConstructLibrary({
 
 const packageJson = project.tryFindObjectFile('package.json');
 packageJson?.addOverride('optionalDependencies', {
-  esbuild: '^0.13.0',
+  esbuild: '^0.14.0',
 });
 packageJson?.addOverride('jest.testPathIgnorePatterns.1', '/examples/');
 
@@ -114,11 +120,16 @@ eslintRc?.addOverride('ignorePatterns', [
   '*.js',
   '*.d.ts',
   'node_modules/',
+  'examples/',
   '*.generated.ts',
   'coverage',
   '!.projenrc.ts',
 ]);
 
+(project.tryFindFile('.gitignore') as IgnoreFile).addPatterns(
+  '!/examples/**',
+);
+
 new JsonFile(project, '.vscode/extensions.json', {
   readonly: false,
   marker: false,

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
@@ -703,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
@@ -759,7 +791,7 @@ const codeConfig: CodeConfig = { ... }
 public readonly s3Location: Location;
 ```
 
-- *Type:* [`@aws-cdk/aws-s3.Location`](#@aws-cdk/aws-s3.Location)
+- *Type:* [`aws-cdk-lib.aws_s3.Location`](#aws-cdk-lib.aws_s3.Location)
 
 The location of the code in S3.
 
@@ -775,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
@@ -841,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
@@ -897,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>
@@ -1243,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
@@ -1309,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
@@ -1425,7 +1563,7 @@ E.g. `src/index.ts`.
 public readonly image: DockerImage;
 ```
 
-- *Type:* [`@aws-cdk/core.DockerImage`](#@aws-cdk/core.DockerImage)
+- *Type:* [`aws-cdk-lib.DockerImage`](#aws-cdk-lib.DockerImage)
 
 ---
 
@@ -1435,7 +1573,7 @@ public readonly image: DockerImage;
 public readonly local: ILocalBundling;
 ```
 
-- *Type:* [`@aws-cdk/core.ILocalBundling`](#@aws-cdk/core.ILocalBundling)
+- *Type:* [`aws-cdk-lib.ILocalBundling`](#aws-cdk-lib.ILocalBundling)
 
 Implementation of `ILocalBundling` interface, responsible for calling esbuild functions.
 
@@ -1463,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>
@@ -1474,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
@@ -1501,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>
@@ -1512,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'`
 
@@ -1539,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>
@@ -1550,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'`
 
@@ -1577,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>
@@ -1588,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'`
 
@@ -1622,7 +1764,7 @@ new JavaScriptAsset(scope: Construct, id: string, props: AssetProps)
 
 ##### `scope`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptAsset.parameter.scope"></a>
 
-- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
+- *Type:* [`constructs.Construct`](#constructs.Construct)
 
 ---
 
@@ -1687,7 +1829,7 @@ public bind(scope: Construct)
 
 ###### `scope`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptCode.parameter.scope"></a>
 
-- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
+- *Type:* [`constructs.Construct`](#constructs.Construct)
 
 ---
 
@@ -1699,13 +1841,13 @@ public bindToResource(resource: CfnResource, options?: ResourceBindOptions)
 
 ###### `resource`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptCode.parameter.resource"></a>
 
-- *Type:* [`@aws-cdk/core.CfnResource`](#@aws-cdk/core.CfnResource)
+- *Type:* [`aws-cdk-lib.CfnResource`](#aws-cdk-lib.CfnResource)
 
 ---
 
 ###### `options`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptCode.parameter.options"></a>
 
-- *Type:* [`@aws-cdk/aws-lambda.ResourceBindOptions`](#@aws-cdk/aws-lambda.ResourceBindOptions)
+- *Type:* [`aws-cdk-lib.aws_lambda.ResourceBindOptions`](#aws-cdk-lib.aws_lambda.ResourceBindOptions)
 
 ---
 
@@ -1729,7 +1871,7 @@ Determines whether this Code is inline code or not.
 
 ### JavaScriptSource <a name="@mrgrain/cdk-esbuild.JavaScriptSource"></a>
 
-- *Implements:* [`@aws-cdk/aws-s3-deployment.ISource`](#@aws-cdk/aws-s3-deployment.ISource)
+- *Implements:* [`aws-cdk-lib.aws_s3_deployment.ISource`](#aws-cdk-lib.aws_s3_deployment.ISource)
 
 #### Initializers <a name="@mrgrain/cdk-esbuild.JavaScriptSource.Initializer"></a>
 
@@ -1761,13 +1903,13 @@ public bind(scope: Construct, context?: DeploymentSourceContext)
 
 ###### `scope`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptSource.parameter.scope"></a>
 
-- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
+- *Type:* [`constructs.Construct`](#constructs.Construct)
 
 ---
 
 ###### `context`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.JavaScriptSource.parameter.context"></a>
 
-- *Type:* [`@aws-cdk/aws-s3-deployment.DeploymentSourceContext`](#@aws-cdk/aws-s3-deployment.DeploymentSourceContext)
+- *Type:* [`aws-cdk-lib.aws_s3_deployment.DeploymentSourceContext`](#aws-cdk-lib.aws_s3_deployment.DeploymentSourceContext)
 
 ---
 
@@ -1801,7 +1943,7 @@ new TypeScriptAsset(scope: Construct, id: string, props: AssetProps)
 
 ##### `scope`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptAsset.parameter.scope"></a>
 
-- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
+- *Type:* [`constructs.Construct`](#constructs.Construct)
 
 ---
 
@@ -1866,7 +2008,7 @@ public bind(scope: Construct)
 
 ###### `scope`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptCode.parameter.scope"></a>
 
-- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
+- *Type:* [`constructs.Construct`](#constructs.Construct)
 
 ---
 
@@ -1878,13 +2020,13 @@ public bindToResource(resource: CfnResource, options?: ResourceBindOptions)
 
 ###### `resource`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptCode.parameter.resource"></a>
 
-- *Type:* [`@aws-cdk/core.CfnResource`](#@aws-cdk/core.CfnResource)
+- *Type:* [`aws-cdk-lib.CfnResource`](#aws-cdk-lib.CfnResource)
 
 ---
 
 ###### `options`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptCode.parameter.options"></a>
 
-- *Type:* [`@aws-cdk/aws-lambda.ResourceBindOptions`](#@aws-cdk/aws-lambda.ResourceBindOptions)
+- *Type:* [`aws-cdk-lib.aws_lambda.ResourceBindOptions`](#aws-cdk-lib.aws_lambda.ResourceBindOptions)
 
 ---
 
@@ -1908,7 +2050,7 @@ Determines whether this Code is inline code or not.
 
 ### TypeScriptSource <a name="@mrgrain/cdk-esbuild.TypeScriptSource"></a>
 
-- *Implements:* [`@aws-cdk/aws-s3-deployment.ISource`](#@aws-cdk/aws-s3-deployment.ISource)
+- *Implements:* [`aws-cdk-lib.aws_s3_deployment.ISource`](#aws-cdk-lib.aws_s3_deployment.ISource)
 
 #### Initializers <a name="@mrgrain/cdk-esbuild.TypeScriptSource.Initializer"></a>
 
@@ -1940,13 +2082,13 @@ public bind(scope: Construct, context?: DeploymentSourceContext)
 
 ###### `scope`<sup>Required</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptSource.parameter.scope"></a>
 
-- *Type:* [`@aws-cdk/core.Construct`](#@aws-cdk/core.Construct)
+- *Type:* [`constructs.Construct`](#constructs.Construct)
 
 ---
 
 ###### `context`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TypeScriptSource.parameter.context"></a>
 
-- *Type:* [`@aws-cdk/aws-s3-deployment.DeploymentSourceContext`](#@aws-cdk/aws-s3-deployment.DeploymentSourceContext)
+- *Type:* [`aws-cdk-lib.aws_s3_deployment.DeploymentSourceContext`](#aws-cdk-lib.aws_s3_deployment.DeploymentSourceContext)
 
 ---
 

package/CHANGELOG.md

@@ -1,36 +1,98 @@
 
-## [2.0.0-rc.1](https://github.com/mrgrain/cdk-esbuild/compare/v2.0.0-rc.0...v2.0.0-rc.1) (2021-10-28)
+## [3.0.0-rc.0](https://github.com/mrgrain/cdk-esbuild/compare/v2.2.0...v3.0.0-rc.0) (2021-12-04)
 
 
-### Features
+### ⚠ BREAKING CHANGES
 
-* generated docs for esbuild link to documentation ([#123](https://github.com/mrgrain/cdk-esbuild/issues/123)) ([95f2fd0](https://github.com/mrgrain/cdk-esbuild/commit/95f2fd07330cf9624dd05f23345bfe0f5754fc57))
+* package now requires  AWS CDK v2
 
-## [2.0.0-rc.0](https://github.com/mrgrain/cdk-esbuild/compare/v2.0.0-alpha.5...v2.0.0-rc.0) (2021-10-24)
+### Features
 
-## [2.0.0-alpha.5](https://github.com/mrgrain/cdk-esbuild/compare/v2.0.0-alpha.4...v2.0.0-alpha.5) (2021-10-23)
+* upgrade to AWS CDK v2 ([134caa8](https://github.com/mrgrain/cdk-esbuild/commit/134caa8848708a132c28d9140d2d569f90a2b178))
 
-## [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)
+## [2.2.0](https://github.com/mrgrain/cdk-esbuild/compare/v2.1.0...v2.2.0) (2021-12-04)
 
+**This release contains an upgrade of esbuild with backwards-incompatible changes.** This is inline with the versioning strategy for this package, which is to release esbuild upgrades with minor versions as long as esbuild has not reached version 1.0.0. The backwards-incompatible changes are fairly obscure this time around, but please make sure to read the [0.14.0 release notes](https://github.com/evanw/esbuild/releases/tag/v0.14.0).
 
 ### Features
 
-* synthesize esbuild types from source ([#117](https://github.com/mrgrain/cdk-esbuild/issues/117)) ([af44d55](https://github.com/mrgrain/cdk-esbuild/commit/af44d55e97db6fd8fbda916eb0f25dae55513cba))
+- upgrade esbuild to [^0.14.0](https://github.com/evanw/esbuild/releases/tag/v0.14.0) ([#143](https://github.com/mrgrain/cdk-esbuild/issues/143)) ([4568b92](https://github.com/mrgrain/cdk-esbuild/commit/4568b92011a3e38f23d85998dcbbca1afa06918e))
+- **examples/esbuild-with-plugins:** example of how to use the escape hatch to run esbuild with plugins ([#142](https://github.com/mrgrain/cdk-esbuild/issues/142)) ([0876f0e](https://github.com/mrgrain/cdk-esbuild/commit/0876f0e4d4bd65a792deef8adf43229568ab899b))
 
-## [2.0.0-alpha.2](https://github.com/mrgrain/cdk-esbuild/compare/v1.128.0...v2.0.0-alpha.2) (2021-10-17)
+## [2.1.0](https://github.com/mrgrain/cdk-esbuild/compare/v2.0.0...v2.1.0) (2021-11-25)
+
+### Features
 
+- escape hatch to provide a custom build or transform function ([#141](https://github.com/mrgrain/cdk-esbuild/issues/141)) ([aacfac1](https://github.com/mrgrain/cdk-esbuild/commit/aacfac1b71f1de78fbfdc1161c6e8cf32fd0629e))
+- `Inline*Code` now takes `TransformerProps` as second parameter, passing in `TransformOptions` is still supported but deprecated ([#141](https://github.com/mrgrain/cdk-esbuild/issues/141)) ([aacfac1](https://github.com/mrgrain/cdk-esbuild/commit/aacfac1b71f1de78fbfdc1161c6e8cf32fd0629e))
+
+## [2.0.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.129.0...v2.0.0) (2021-11-07)
 
 ### ⚠ BREAKING CHANGES
 
-* Alpha release of a jsii version of this package. Aim is
-that migration will be minimal, however probably not avoidable.
+- Major release of this package to make it JSII compatible (#114) ([727c78a](https://github.com/mrgrain/cdk-esbuild/commit/727c78aefa2079d0f561b8b664d75eb6c669e46b)), closes [#114](https://github.com/mrgrain/cdk-esbuild/issues/114) [#117](https://github.com/mrgrain/cdk-esbuild/issues/117) [#119](https://github.com/mrgrain/cdk-esbuild/issues/119) [#120](https://github.com/mrgrain/cdk-esbuild/issues/120) [#123](https://github.com/mrgrain/cdk-esbuild/issues/123)
+
+- Deprecated features from v1 have been removed. Please see upgrading instructions below.
+
+### Upgrading to v2
+
+- 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.
 
 ### 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))
+- JSII compatibility & v2 GA (#114) ([727c78a](https://github.com/mrgrain/cdk-esbuild/commit/727c78aefa2079d0f561b8b664d75eb6c669e46b)), closes [#114](https://github.com/mrgrain/cdk-esbuild/issues/114) [#117](https://github.com/mrgrain/cdk-esbuild/issues/117) [#119](https://github.com/mrgrain/cdk-esbuild/issues/119) [#120](https://github.com/mrgrain/cdk-esbuild/issues/120) [#123](https://github.com/mrgrain/cdk-esbuild/issues/123)
+
+- Synthesize `esbuild` types from source ([#117](https://github.com/mrgrain/cdk-esbuild/issues/117)) ([af44d55](https://github.com/mrgrain/cdk-esbuild/commit/af44d55e97db6fd8fbda916eb0f25dae55513cba))
+
+- Generated docs now contain links to esbuild documentation ([#123](https://github.com/mrgrain/cdk-esbuild/issues/123)) ([95f2fd0](https://github.com/mrgrain/cdk-esbuild/commit/95f2fd07330cf9624dd05f23345bfe0f5754fc57))
+
+## [1.133.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.132.0...v1.133.0) (2021-11-21)
+
+- **This is a release on the legacy v1 branch. Please upgrade to v2 as soon as possible.**
+- works with cdk-1.133.0
+
+### ⛔ EXTREMELY IMPORTANT NOTICE FOR USERS WHO HAVE NOT UPGRADE TO v2 OF THIS PACKAGE
+
+**tl;dr No more "versioned" release on this legacy branch.**
+
+Until now, I have release a new version of this package every time a new CDK version was released. Even if no updates where necessary. This practice will stop with this release and I will only release a new version on the legacy v1 branch, if an update is required for compatibility. **Please upgrade to v2 of this package as soon as possible!**
+
+[**Upgrading instructions to v2 of this package**](https://github.com/mrgrain/cdk-esbuild#migrating-to-v2)
+
+If you're using the tag `cdk-v1`, you will already receive the latest stable v2 release. If you're using a versioned tag (e.g. `cdk-1.29.0`), this tag format is deprecated and release have not been tagged for a while now.
+
+## [1.132.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.131.0...v1.132.0) (2021-11-21)
+
+- works with cdk-1.132.0
+
+### ⚠ IMPORTANT NOTICE
+
+This is a release on the legacy v1 branch. Please upgrade to v2 as soon as possible.
+
+If you're using the tag `cdk-v1`, you will already receive the latest stable v2 release. If you're using a versioned tag (e.g. `cdk-1.29.0`), this tag format is deprecated and future releases won't be tagged like this.
+
+## [1.131.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.130.0...v1.131.0) (2021-11-07)
+
+- works with cdk-1.131.0
+
+### ⚠ IMPORTANT NOTICE
+
+This is a release on the legacy v1 branch. Please upgrade to v2 as soon as possible.
+
+If you're using the tag `cdk-v1`, you will already receive the latest stable v2 release. If you're using a versioned tag (e.g. `cdk-1.29.0`), this tag format is deprecated and future releases won't be tagged like this.
+
+## [1.130.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.129.0...v1.130.0) (2021-11-07)
+
+- works with cdk-1.130.0
+
+### ⚠ IMPORTANT NOTICE
+
+This is the first release on the legacy v1 branch. Please upgrade to v2 as soon as possible.
+
+If you're using the tag `cdk-v1`, you will already receive the latest stable v2 release. If you're using a versioned tag (e.g. `cdk-1.29.0`), this tag format is deprecated and future releases won't be tagged like this.
 
 ## [1.129.0](https://github.com/mrgrain/cdk-esbuild/compare/v1.128.0...v1.129.0) (2021-10-28)