@mrgrain/cdk-esbuild 3.3.0 → 4.0.0-alpha.0

package/.projenrc.ts

@@ -19,7 +19,7 @@ const project = new awscdk.AwsCdkConstructLibrary({
 
   // Project info
   name: '@mrgrain/cdk-esbuild',
-  repositoryUrl: 'git@github.com:mrgrain/cdk-esbuild.git',
+  repositoryUrl: 'https://github.com/mrgrain/cdk-esbuild',
   description:
     'CDK constructs for esbuild, an extremely fast JavaScript bundler',
   homepage: 'https://github.com/mrgrain/cdk-esbuild',
@@ -58,22 +58,21 @@ const project = new awscdk.AwsCdkConstructLibrary({
   eslintOptions: {
     lintProjenRc: false,
     dirs: ['src', 'projenrc', '.projenrc.ts'],
-    ignorePatterns: [
-      '*.js',
-      '*.d.ts',
-      'node_modules/',
-      '*.generated.ts',
-      'coverage',
-      'examples/',
-    ],
   },
 
   // Release
   packageManager: javascript.NodePackageManager.NPM,
-  npmDistTag: 'latest',
-  defaultReleaseBranch: 'main',
-  majorVersion: 3,
-  releaseTrigger: release.ReleaseTrigger.manual(),
+  npmDistTag: 'next',
+  defaultReleaseBranch: 'support-other-langs',
+  majorVersion: 4,
+  prerelease: 'alpha',
+  releaseTrigger: release.ReleaseTrigger.scheduled({
+    schedule: '0 17 * * *',
+  }),
+  publishToPypi: {
+    module: 'mrgrain.cdk-esbuild',
+    distName: 'mrgrain.cdk_esbuild',
+  },
   catalog: {
     twitter: '@mrgrain',
   },
@@ -85,14 +84,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',
@@ -106,7 +100,6 @@ const project = new awscdk.AwsCdkConstructLibrary({
     'cdk.out',
     '.cdk.staging',
     'examples/template',
-    '!/.github/workflows/manual-release.yml',
     '!/examples/**',
   ],
   npmignore: [
@@ -124,6 +117,17 @@ const project = new awscdk.AwsCdkConstructLibrary({
   ],
 });
 
+// release only via manual trigger
+project.tryFindObjectFile('.github/workflows/release.yml')?.addOverride('on', 'workflow_dispatch');
+
+// eslint
+project.eslint?.allowDevDeps('projenrc/**');
+project.eslint?.addRules({
+  '@typescript-eslint/member-ordering': 'off',
+});
+project.eslint?.addIgnorePattern('examples/');
+project.eslint?.addIgnorePattern('!projenrc/*.ts');
+
 
 // VSCode config
 new JsonFile(project, '.vscode/extensions.json', {
@@ -167,10 +171,6 @@ project.tryFindObjectFile('package.json')?.addOverride('optionalDependencies', {
   esbuild: '^0.14.0',
 });
 
-project.eslint?.addRules({
-  '@typescript-eslint/member-ordering': 'off',
-});
-
 new TypeScriptSourceFile(project, 'src/esbuild-types.ts', {
   source: 'node_modules/esbuild/lib/main.d.ts',
   editGitignore: false,
@@ -191,6 +191,7 @@ new TypeScriptSourceFile(project, 'src/esbuild-types.ts', {
     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 `..`.
 
 ---
 
@@ -433,6 +446,18 @@ Documentation: https://esbuild.github.io/api/#log-limit.
 
 ---
 
+##### `logOverride`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.logOverride"></a>
+
+```typescript
+public readonly logOverride: {[ key: string ]: string};
+```
+
+- *Type:* {[ key: string ]: `string`}
+
+Documentation: https://esbuild.github.io/api/#log-override.
+
+---
+
 ##### `mainFields`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.BuildOptions.property.mainFields"></a>
 
 ```typescript
@@ -805,15 +830,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).
 
@@ -824,14 +849,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 `..`.
 
 ---
 
@@ -893,15 +931,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).
 
@@ -912,14 +950,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 `..`.
 
 ---
 
@@ -975,15 +1026,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).
 
@@ -994,14 +1045,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 `..`.
 
 ---
 
@@ -1271,6 +1335,18 @@ Documentation: https://esbuild.github.io/api/#log-limit.
 
 ---
 
+##### `logOverride`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.logOverride"></a>
+
+```typescript
+public readonly logOverride: {[ key: string ]: string};
+```
+
+- *Type:* {[ key: string ]: `string`}
+
+Documentation: https://esbuild.github.io/api/#log-override.
+
+---
+
 ##### `mangleCache`<sup>Optional</sup> <a name="@mrgrain/cdk-esbuild.TransformOptions.property.mangleCache"></a>
 
 ```typescript
@@ -1495,15 +1571,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).
 
@@ -1514,14 +1590,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 `..`.
 
 ---
 
@@ -1577,15 +1666,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).
 
@@ -1596,14 +1685,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 `..`.
 
 ---