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

package/.jsii

@@ -969,7 +969,7 @@
   },
   "name": "@mrgrain/cdk-esbuild",
   "readme": {
-    "markdown": "# cdk-esbuild\n\n_CDK constructs for [esbuild](https://github.com/evanw/esbuild), an extremely fast JavaScript bundler_\n\n[Getting started](#getting-started) | [Upgrading from 1.x](#upgrading-from-1x) |\n[Documentation](#documentation) | [API Reference](#api-reference) | [Versioning](#versioning)\n\n## Why?\n\n_esbuild_ is an extremely fast bundler and minifier for Typescript and JavaScript.\nThis package makes _esbuild_ available to deploy lambda functions, static websites or to publish build artefacts (assets) for further use.\n\nAWS CDK [supports _esbuild_ with Lambda Functions](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-lambda-nodejs-readme.html). However the implementation cannot be used with any other Constructs and doesn't expose all of _esbuild_'s build interface.\n\nThis package is running _esbuild_ directly in Node.js and bypasses Docker which the AWS CDK implementation uses. The approach is quicker and easier to use for Node.js users, but incompatible with other languages.\n\n**⚠️ Regarding stability**\n\nThis package is generally stable. However _esbuild_ is still on major version zero, which you should consider. Please check their guide on [production readiness](https://esbuild.github.io/faq/#production-readiness).\n\nNotably upgrades of the _esbuild_ version requirement will be introduced in **minor versions** of this package and will inherit breaking changes from _esbuild_.\n\n## Getting started\n\nInstall `cdk-esbuild`:\n\n```\nnpm install @mrgrain/cdk-esbuild\n```\n\nIf _peer_ and _optional dependencies_ are not installed automatically (e.g. when using npm v4-6), please use this command to install all of them:\n\n```\nnpm install @mrgrain/cdk-esbuild esbuild @aws-cdk/core @aws-cdk/aws-lambda @aws-cdk/aws-s3-assets @aws-cdk/aws-s3-deployment @aws-cdk/aws-synthetics\n```\n\n### AWS Lambda: Serverless function\n\n> 💡 See [Lambda Function](examples/lambda) for a complete working example of a how to deploy a lambda function.\n\nUse `TypeScriptCode` as the `code` of a [lambda function](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.Function.html#code):\n\n```ts\nimport * as lambda from \"@aws-cdk/aws-lambda\";\nimport { TypeScriptCode } from \"@mrgrain/cdk-esbuild\";\n\nconst bundledCode = new TypeScriptCode(\"src/index.ts\");\n\nconst fn = new lambda.Function(stack, \"MyFunction\", {\n  runtime: lambda.Runtime.NODEJS_14_X,\n  handler: \"index.handler\",\n  code: bundledCode,\n});\n```\n\n### AWS S3: Static Website\n\n> 💡 See [Static Website with React](examples/website) for a complete working example of a how to deploy a React app to S3.\n\nUse `TypeScriptSource` as one of the `sources` of a [static website deployment](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-s3-deployment-readme.html#roadmap):\n\n```ts\nimport * as s3 from \"@aws-cdk/aws-s3\";\nimport * as s3deploy from \"@aws-cdk/aws-s3-deployment\";\nimport { TypeScriptSource } from \"@mrgrain/cdk-esbuild\";\n\nconst websiteBundle = new TypeScriptSource(\"src/index.tsx\");\n\nconst websiteBucket = new s3.Bucket(stack, \"WebsiteBucket\", {\n  autoDeleteObjects: true,\n  publicReadAccess: true,\n  removalPolicy: RemovalPolicy.DESTROY,\n  websiteIndexDocument: \"index.html\",\n});\n\nnew s3deploy.BucketDeployment(stack, \"DeployWebsite\", {\n  destinationBucket: websiteBucket,\n  sources: [websiteBundle],\n});\n```\n\n### Amazon CloudWatch Synthetics: Canary monitoring\n\n> 💡 See [Monitored Website](examples/website) for a complete working example of a deployed and monitored website.\n\nSynthetics runs a canary to produce traffic to an application for monitoring purposes. Use `TypeScriptCode` as the `code` of a Canary test:\n\n```ts\nimport * as synthetics from \"@aws-cdk/aws-synthetics\";\nimport { TypeScriptCode } from \"@mrgrain/cdk-esbuild\";\n\nconst bundledCode = new TypeScriptCode(\"src/index.ts\", {\n  buildOptions: {\n    outdir: \"nodejs/node_modules\", // This is required by Synthetics\n  },\n});\n\nconst canary = new synthetics.Canary(stack, \"MyCanary\", {\n  runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_2,\n  test: synthetics.Test.custom({\n    code: bundledCode,\n    handler: \"index.handler\",\n  });\n});\n```\n\n# Documentation\n\nThe package exports various different constructs for use with existing CDK features. A major guiding design principal for this package is to _extend, don't replace_. Expect constructs that you can provide as props, not complete replacements.\n\nFor use in **Lambda Functions** and **Synthetic Canaries**, the following classes implement `lambda.Code` ([reference](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.Code.html)) and `synthetics.Code` ([reference](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-synthetics.Code.html)):\n\n- `TypeScriptCode` & `JavaScriptCode`\n\nInline code is only supported by **Lambda**:\n\n- `InlineTypeScriptCode` & `InlineJavaScriptCode`\n- `InlineTsxCode` & `InlineJsxCode`\n\nFor use with **S3 bucket deployments**, classes implementing `s3deploy.ISource` ([reference](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-s3-deployment-readme.html)):\n\n- 🧺 `TypeScriptSource` & `JavaScriptSource`\n\n> _Code and Source constructs seamlessly plugin to high-level CDK features. They share the same set of parameters, props and build options._\n\nUnderlying classes power the other features. You normally won't have to use them, but they are there if you need them:\n\n- `TypeScriptAsset` & `JavaScriptAsset` implements `s3.Asset` ([reference](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3-assets.Asset.html)) \\\n  creates an asset uploaded to S3 which can be referenced by other constructs\n\n- `EsbuildBundler` implements `core.BundlingOptions` ([reference](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.BundlingOptions.html)) \\\n  provides an interface for a _esbuild_ bundler wherever needed\n\n## [API Reference](API.md)\n\nAuto-generated reference for classes and structs. This information is also available within the code completion of your IDE.\n\n## Upgrading from 1.x\n\ntbd\n\n## Versioning\n\nThis package _mostly_ follows [Semantic Versioning](https://semver.org/), with the exception of upgrades to `esbuild`. These will be released as **minor versions** and often include breaking changes from `esbuild`.\n\nAlthough great care is taken to avoid this, all features marked as `@unstable` may change with minor versions. Please note that the unstable flag is applied to all new or experimental features and internal classes.\n\n## Future releases\n\n### AWS CDK v2\n\nThe monolithic version 2 of CDK (aka Mono-CDK) is on the horizon. A new major release of this package will be marked alongside CDK. Support for AWS CDK v1.x.x will be continued, however no new features will be added.\n\n### Stable esbuild\n\nOnce `esbuild` has reached a stable version 1.0, a new major version will be released for _all_ breaking changes, including updates to minimum (peer) dependencies.\n"
+    "markdown": "# cdk-esbuild\n\n_CDK constructs for [esbuild](https://github.com/evanw/esbuild), an extremely fast JavaScript bundler_\n\n[Getting started](#getting-started) | [Migrating to v2](#migrating-to-v2) |\n[Documentation](#documentation) | [API Reference](#api-reference) | [Versioning](#versioning)\n\n## Why?\n\n_esbuild_ is an extremely fast bundler and minifier for Typescript and JavaScript.\nThis package makes _esbuild_ available to deploy lambda functions, static websites or to publish build artefacts (assets) for further use.\n\nAWS CDK [supports _esbuild_ with Lambda Functions](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-lambda-nodejs-readme.html). However the implementation cannot be used with any other Constructs and doesn't expose all of _esbuild_'s build interface.\n\nThis package is running _esbuild_ directly in Node.js and bypasses Docker which the AWS CDK implementation uses. The approach is quicker and easier to use for Node.js users, but incompatible with other languages.\n\n**⚠️ A note on stability**\n\nThis package is generally stable and ready to be used in production as many do. However _esbuild_ is still on major version zero, which you should consider. Please check their guide on [production readiness](https://esbuild.github.io/faq/#production-readiness).\n\nNotably upgrades of the _esbuild_ version requirement will be introduced in **minor versions** of this package and will inherit breaking changes from _esbuild_.\n\n## Getting started\n\nInstall `cdk-esbuild`:\n\n```\nnpm install @mrgrain/cdk-esbuild\n```\n\nIf _peer_ and _optional dependencies_ are not installed automatically (e.g. when using npm v4-6), please use this command to install all of them:\n\n```\nnpm install @mrgrain/cdk-esbuild esbuild @aws-cdk/core @aws-cdk/aws-lambda @aws-cdk/aws-s3-assets @aws-cdk/aws-s3-deployment @aws-cdk/aws-synthetics\n```\n\n### AWS Lambda: Serverless function\n\n> 💡 See [Lambda Function](examples/lambda) for a complete working example of a how to deploy a lambda function.\n\nUse `TypeScriptCode` as the `code` of a [lambda function](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.Function.html#code):\n\n```ts\nimport * as lambda from \"@aws-cdk/aws-lambda\";\nimport { TypeScriptCode } from \"@mrgrain/cdk-esbuild\";\n\nconst bundledCode = new TypeScriptCode(\"src/index.ts\");\n\nconst fn = new lambda.Function(stack, \"MyFunction\", {\n  runtime: lambda.Runtime.NODEJS_14_X,\n  handler: \"index.handler\",\n  code: bundledCode,\n});\n```\n\n### AWS S3: Static Website\n\n> 💡 See [Static Website with React](examples/website) for a complete working example of a how to deploy a React app to S3.\n\nUse `TypeScriptSource` as one of the `sources` of a [static website deployment](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-s3-deployment-readme.html#roadmap):\n\n```ts\nimport * as s3 from \"@aws-cdk/aws-s3\";\nimport * as s3deploy from \"@aws-cdk/aws-s3-deployment\";\nimport { TypeScriptSource } from \"@mrgrain/cdk-esbuild\";\n\nconst websiteBundle = new TypeScriptSource(\"src/index.tsx\");\n\nconst websiteBucket = new s3.Bucket(stack, \"WebsiteBucket\", {\n  autoDeleteObjects: true,\n  publicReadAccess: true,\n  removalPolicy: RemovalPolicy.DESTROY,\n  websiteIndexDocument: \"index.html\",\n});\n\nnew s3deploy.BucketDeployment(stack, \"DeployWebsite\", {\n  destinationBucket: websiteBucket,\n  sources: [websiteBundle],\n});\n```\n\n### Amazon CloudWatch Synthetics: Canary monitoring\n\n> 💡 See [Monitored Website](examples/website) for a complete working example of a deployed and monitored website.\n\nSynthetics runs a canary to produce traffic to an application for monitoring purposes. Use `TypeScriptCode` as the `code` of a Canary test:\n\n```ts\nimport * as synthetics from \"@aws-cdk/aws-synthetics\";\nimport { TypeScriptCode } from \"@mrgrain/cdk-esbuild\";\n\nconst bundledCode = new TypeScriptCode(\"src/index.ts\", {\n  buildOptions: {\n    outdir: \"nodejs/node_modules\", // This is required by Synthetics\n  },\n});\n\nconst canary = new synthetics.Canary(stack, \"MyCanary\", {\n  runtime: synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_3_2,\n  test: synthetics.Test.custom({\n    code: bundledCode,\n    handler: \"index.handler\",\n  });\n});\n```\n\n# Documentation\n\nThe package exports various different constructs for use with existing CDK features. A major guiding design principal for this package is to _extend, don't replace_. Expect constructs that you can provide as props, not complete replacements.\n\nFor use in **Lambda Functions** and **Synthetic Canaries**, the following classes implement `lambda.Code` ([reference](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.Code.html)) and `synthetics.Code` ([reference](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-synthetics.Code.html)):\n\n- `TypeScriptCode` & `JavaScriptCode`\n\nInline code is only supported by **Lambda**:\n\n- `InlineTypeScriptCode` & `InlineJavaScriptCode`\n- `InlineTsxCode` & `InlineJsxCode`\n\nFor use with **S3 bucket deployments**, classes implementing `s3deploy.ISource` ([reference](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-s3-deployment-readme.html)):\n\n- 🧺 `TypeScriptSource` & `JavaScriptSource`\n\n> _Code and Source constructs seamlessly plugin to high-level CDK features. They share the same set of parameters, props and build options._\n\nUnderlying classes power the other features. You normally won't have to use them, but they are there if you need them:\n\n- `TypeScriptAsset` & `JavaScriptAsset` implements `s3.Asset` ([reference](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3-assets.Asset.html)) \\\n  creates an asset uploaded to S3 which can be referenced by other constructs\n\n- `EsbuildBundler` implements `core.BundlingOptions` ([reference](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.BundlingOptions.html)) \\\n  provides an interface for a _esbuild_ bundler wherever needed\n\n## [API Reference](API.md)\n\nAuto-generated reference for classes and structs. This information is also available within the code completion of your IDE.\n\n## Migrating to v2\n\nThe main changes in cdk-esbuild v2 are:\n\n- The package is now `jsii` compliant and published in the [Construct Hub](https://constructs.dev/). This will also enable a possible feature release for other languages.\n- Deprecated properties and classes have been removed, most notably the previous support for bundling via a Docker container. The implementation had a few issues that cannot be easily resolved. However more generic support for custom executables might arrive in later versions.\n- `esbuild` is now installed as an optional dependency. It's not optional at all, but this is a ramification of using `jsii`. In practice this will have no impact on most people.\n- Interfaces have been streamlined and the names and setup of internal types have been changed. In the unlikely case that someone was relying on these, upgrading will be straight forward.\n\n### Upgrading\n\n- Update the package dependency to v2: `npm install --save @mrgrain/cdk-esbuild@^2.0.0`\n- `esbuild` is now installed as an optional dependency. If your setup does not automatically install optional dependencies, add it as an explicit dependency.\n- Remove any use of `bundlerPriority`.\n- 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.\n\n## Versioning\n\nThis package _mostly_ follows [Semantic Versioning](https://semver.org/), with the exception of upgrades to `esbuild`. These will be released as **minor versions** and often include breaking changes from `esbuild`.\n\nAlthough great care is taken to avoid this, all features marked as `@unstable` may change with minor versions. Please note that the unstable flag is applied to all new or experimental features and internal classes.\n\n### Npm Tags\n\nSome users prefer to use tags over version ranges. The following stable tags are available for use:\n\n- `cdk-v1`, `cdk-v2` are provided for the latest release compatible with each version of the AWS CDK.\n\n- `latest` is the most recent stable release.\n\nThese tags also exist, but usage is strongly not recommended:\n\n- `unstable`, `next` are used for pre-release of the current and next major version respectively.\n\n- ~~`cdk-1.x.x`~~ tags have been deprecated in favour of `cdk-v1`. Use that one instead.\n\n## Future releases\n\n### AWS CDK v2\n\nThe monolithic version 2 of CDK (aka Mono-CDK) is on the horizon. A new major release of this package will be marked alongside CDK. Support for AWS CDK v1.x.x will be continued, however no new features will be added.\n\n### Stable esbuild\n\nOnce `esbuild` has reached a stable version 1.0, a new major version will be released for _all_ breaking changes, including updates to minimum (peer) dependencies.\n\n## Library authors\n\nWhen developing a library consumed by other packages, you'll most likely have to set `buildOptions.absWorkingDir`. The easiest way to do this, is to resolve based on the directory name of the file, and traverse the tree upwards to the root of your library package (that's where `package.json` and `tsconfig.json` are):\n\n```ts\n// file: project/src/index.ts\nconst props = {\n  buildOptions: {\n    absWorkingDir: path.resolve(__dirname, \"..\"), // now: /user/project\n  },\n};\n```\n\nThis will dynamically resolve to the correct path, wherever the package is installed.\n"
   },
   "repository": {
     "type": "git",
@@ -982,44 +982,6 @@
     }
   },
   "types": {
-    "@mrgrain/cdk-esbuild.AssetBaseProps": {
-      "assembly": "@mrgrain/cdk-esbuild",
-      "datatype": true,
-      "docs": {
-        "stability": "stable"
-      },
-      "fqn": "@mrgrain/cdk-esbuild.AssetBaseProps",
-      "interfaces": [
-        "@mrgrain/cdk-esbuild.BundlerProps"
-      ],
-      "kind": "interface",
-      "locationInModule": {
-        "filename": "src/asset.ts",
-        "line": 6
-      },
-      "name": "AssetBaseProps",
-      "properties": [
-        {
-          "abstract": true,
-          "docs": {
-            "remarks": "As this is a plain string, it\ncan be used in construct IDs in order to enforce creation of a new resource when the content\nhash has changed.",
-            "stability": "stable",
-            "summary": "A hash of this asset, which is available at construction time."
-          },
-          "immutable": true,
-          "locationInModule": {
-            "filename": "src/asset.ts",
-            "line": 14
-          },
-          "name": "assetHash",
-          "optional": true,
-          "type": {
-            "primitive": "string"
-          }
-        }
-      ],
-      "symbolId": "src/asset:AssetBaseProps"
-    },
     "@mrgrain/cdk-esbuild.AssetProps": {
       "assembly": "@mrgrain/cdk-esbuild",
       "datatype": true,
@@ -1028,25 +990,26 @@
       },
       "fqn": "@mrgrain/cdk-esbuild.AssetProps",
       "interfaces": [
-        "@mrgrain/cdk-esbuild.AssetBaseProps"
+        "@mrgrain/cdk-esbuild.BundlerProps"
       ],
       "kind": "interface",
       "locationInModule": {
         "filename": "src/asset.ts",
-        "line": 17
+        "line": 22
       },
       "name": "AssetProps",
       "properties": [
         {
           "abstract": true,
           "docs": {
+            "remarks": "E.g. `src/index.ts`.",
             "stability": "stable",
-            "summary": "Relative paths to the entrypoints of your code, e.g. `src/index.ts`."
+            "summary": "A relative path or list or map of relative paths to the entry points of your code from the root of the project."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/asset.ts",
-            "line": 21
+            "line": 28
           },
           "name": "entryPoints",
           "type": {
@@ -1074,6 +1037,24 @@
               ]
             }
           }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "As this is a plain string, it can be used in construct IDs in order to enforce creation of a new resource when the content hash has changed.\n\nDefaults to a hash of all files in the resulting bundle.",
+            "stability": "stable",
+            "summary": "A hash of this asset, which is available at construction time."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/asset.ts",
+            "line": 19
+          },
+          "name": "assetHash",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
         }
       ],
       "symbolId": "src/asset:AssetProps"
@@ -1982,26 +1963,28 @@
       "assembly": "@mrgrain/cdk-esbuild",
       "datatype": true,
       "docs": {
-        "stability": "experimental"
+        "stability": "stable"
       },
       "fqn": "@mrgrain/cdk-esbuild.BundlerProps",
       "kind": "interface",
       "locationInModule": {
         "filename": "src/bundler.ts",
-        "line": 20
+        "line": 22
       },
       "name": "BundlerProps",
       "properties": [
         {
           "abstract": true,
           "docs": {
-            "stability": "experimental",
-            "summary": "Options passed on to esbuild."
+            "remarks": "- `buildOptions.outdir: string` \\\nThe actual path for the output directory is defined by CDK. However setting this option allows to write files into a subdirectory. \\\nFor 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. \\\n*Cannot be used together with `outfile`*.\n- `buildOptions.outfile: string` \\\nRelative path to a file inside the CDK asset output directory. \\\nFor 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. \\\n*Cannot be used with multiple entryPoints or together with `outdir`.*\n- `buildOptions.absWorkingDir: string` \\\nAbsolute 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). \\\nIf 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).",
+            "see": "https://esbuild.github.io/api/#build-api",
+            "stability": "stable",
+            "summary": "Build options passed on to esbuild. Please refer to the esbuild Build API docs for details."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/bundler.ts",
-            "line": 24
+            "line": 41
           },
           "name": "buildOptions",
           "optional": true,
@@ -2012,13 +1995,14 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "experimental",
-            "summary": "Relative path to a directory copied to the output BEFORE esbuild is run (i.e esbuild will overwrite existing files)."
+            "remarks": "Files copied like this will be overwritten by esbuild if they share the same name as any of the outputs.",
+            "stability": "stable",
+            "summary": "Copy additional files to the output directory, before the build runs."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/bundler.ts",
-            "line": 29
+            "line": 49
           },
           "name": "copyDir",
           "optional": true,
@@ -2046,12 +2030,13 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "stability": "stable",
+            "summary": "The location of the code in S3."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/code.ts",
-            "line": 18
+            "line": 23
           },
           "name": "s3Location",
           "type": {
@@ -2064,7 +2049,9 @@
     "@mrgrain/cdk-esbuild.EsbuildBundler": {
       "assembly": "@mrgrain/cdk-esbuild",
       "docs": {
-        "stability": "experimental"
+        "remarks": "This class directly interfaces with esbuild and provides almost no configuration safeguards.",
+        "stability": "experimental",
+        "summary": "Low-level construct that can be used where `BundlingOptions` are required."
       },
       "fqn": "@mrgrain/cdk-esbuild.EsbuildBundler",
       "initializer": {
@@ -2073,12 +2060,14 @@
         },
         "locationInModule": {
           "filename": "src/bundler.ts",
-          "line": 40
+          "line": 76
         },
         "parameters": [
           {
             "docs": {
-              "summary": "Relative paths to the entrypoints of your code, e.g. `src/index.ts`."
+              "remarks": "E.g. `src/index.ts`.",
+              "stability": "experimental",
+              "summary": "A relative path or list or map of relative paths to the entry points of your code from the root of the project."
             },
             "name": "entryPoints",
             "type": {
@@ -2108,6 +2097,10 @@
             }
           },
           {
+            "docs": {
+              "stability": "experimental",
+              "summary": "Props to change the behaviour of the bundler."
+            },
             "name": "props",
             "type": {
               "fqn": "@mrgrain/cdk-esbuild.BundlerProps"
@@ -2118,19 +2111,20 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/bundler.ts",
-        "line": 35
+        "line": 58
       },
       "name": "EsbuildBundler",
       "properties": [
         {
           "docs": {
+            "remarks": "E.g. `src/index.ts`.",
             "stability": "experimental",
-            "summary": "Relative paths to the entrypoints of your code, e.g. `src/index.ts`."
+            "summary": "A relative path or list or map of relative paths to the entry points of your code from the root of the project."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/bundler.ts",
-            "line": 44
+            "line": 83
           },
           "name": "entryPoints",
           "type": {
@@ -2161,12 +2155,13 @@
         },
         {
           "docs": {
-            "stability": "experimental"
+            "deprecated": "This value is ignored since the bundler is always using a locally installed version of esbuild. However the property is required to comply with the `BundlingOptions` interface.",
+            "stability": "deprecated"
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/bundler.ts",
-            "line": 38
+            "line": 71
           },
           "name": "image",
           "type": {
@@ -2175,12 +2170,13 @@
         },
         {
           "docs": {
-            "stability": "experimental"
+            "stability": "experimental",
+            "summary": "Implementation of `ILocalBundling` interface, responsible for calling esbuild functions."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/bundler.ts",
-            "line": 36
+            "line": 64
           },
           "name": "local",
           "type": {
@@ -2189,12 +2185,13 @@
         },
         {
           "docs": {
-            "stability": "experimental"
+            "stability": "experimental",
+            "summary": "Props to change the behaviour of the bundler."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/bundler.ts",
-            "line": 45
+            "line": 90
           },
           "name": "props",
           "type": {
@@ -2208,7 +2205,8 @@
       "assembly": "@mrgrain/cdk-esbuild",
       "base": "@aws-cdk/aws-lambda.InlineCode",
       "docs": {
-        "stability": "experimental"
+        "stability": "experimental",
+        "summary": "An implementation of `lambda.InlineCode` using the esbuild Transform API. Inline function code is limited to 4 KiB after transformation."
       },
       "fqn": "@mrgrain/cdk-esbuild.InlineJavaScriptCode",
       "initializer": {
@@ -2217,16 +2215,26 @@
         },
         "locationInModule": {
           "filename": "src/inline-code.ts",
-          "line": 32
+          "line": 34
         },
         "parameters": [
           {
+            "docs": {
+              "stability": "experimental",
+              "summary": "The inline code to be transformed."
+            },
             "name": "code",
             "type": {
               "primitive": "string"
             }
           },
           {
+            "docs": {
+              "remarks": "Please refer to the esbuild Transform API docs for details. \\\nDefault values for `transformOptions`:\n- `loader='js'`",
+              "see": "https://esbuild.github.io/api/#transform-api",
+              "stability": "experimental",
+              "summary": "Transform options passed on to esbuild."
+            },
             "name": "transformOptions",
             "optional": true,
             "type": {
@@ -2238,7 +2246,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/inline-code.ts",
-        "line": 31
+        "line": 33
       },
       "name": "InlineJavaScriptCode",
       "symbolId": "src/inline-code:InlineJavaScriptCode"
@@ -2247,7 +2255,8 @@
       "assembly": "@mrgrain/cdk-esbuild",
       "base": "@aws-cdk/aws-lambda.InlineCode",
       "docs": {
-        "stability": "experimental"
+        "stability": "experimental",
+        "summary": "An implementation of `lambda.InlineCode` using the esbuild Transform API. Inline function code is limited to 4 KiB after transformation."
       },
       "fqn": "@mrgrain/cdk-esbuild.InlineJsxCode",
       "initializer": {
@@ -2256,16 +2265,26 @@
         },
         "locationInModule": {
           "filename": "src/inline-code.ts",
-          "line": 41
+          "line": 63
         },
         "parameters": [
           {
+            "docs": {
+              "stability": "experimental",
+              "summary": "The inline code to be transformed."
+            },
             "name": "code",
             "type": {
               "primitive": "string"
             }
           },
           {
+            "docs": {
+              "remarks": "Please refer to the esbuild Transform API docs for details. \\\nDefault values for `transformOptions`:\n- `loader='jsx'`",
+              "see": "https://esbuild.github.io/api/#transform-api",
+              "stability": "experimental",
+              "summary": "Transform options passed on to esbuild."
+            },
             "name": "transformOptions",
             "optional": true,
             "type": {
@@ -2277,7 +2296,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/inline-code.ts",
-        "line": 40
+        "line": 62
       },
       "name": "InlineJsxCode",
       "symbolId": "src/inline-code:InlineJsxCode"
@@ -2286,7 +2305,8 @@
       "assembly": "@mrgrain/cdk-esbuild",
       "base": "@aws-cdk/aws-lambda.InlineCode",
       "docs": {
-        "stability": "experimental"
+        "stability": "experimental",
+        "summary": "An implementation of `lambda.InlineCode` using the esbuild Transform API. Inline function code is limited to 4 KiB after transformation."
       },
       "fqn": "@mrgrain/cdk-esbuild.InlineTsxCode",
       "initializer": {
@@ -2295,16 +2315,26 @@
         },
         "locationInModule": {
           "filename": "src/inline-code.ts",
-          "line": 59
+          "line": 121
         },
         "parameters": [
           {
+            "docs": {
+              "stability": "experimental",
+              "summary": "The inline code to be transformed."
+            },
             "name": "code",
             "type": {
               "primitive": "string"
             }
           },
           {
+            "docs": {
+              "remarks": "Please refer to the esbuild Transform API docs for details. \\\nDefault values for `transformOptions`:\n- `loader='tsx'`",
+              "see": "https://esbuild.github.io/api/#transform-api",
+              "stability": "experimental",
+              "summary": "Transform options passed on to esbuild."
+            },
             "name": "transformOptions",
             "optional": true,
             "type": {
@@ -2316,7 +2346,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/inline-code.ts",
-        "line": 58
+        "line": 120
       },
       "name": "InlineTsxCode",
       "symbolId": "src/inline-code:InlineTsxCode"
@@ -2325,7 +2355,8 @@
       "assembly": "@mrgrain/cdk-esbuild",
       "base": "@aws-cdk/aws-lambda.InlineCode",
       "docs": {
-        "stability": "experimental"
+        "stability": "experimental",
+        "summary": "An implementation of `lambda.InlineCode` using the esbuild Transform API. Inline function code is limited to 4 KiB after transformation."
       },
       "fqn": "@mrgrain/cdk-esbuild.InlineTypeScriptCode",
       "initializer": {
@@ -2334,16 +2365,26 @@
         },
         "locationInModule": {
           "filename": "src/inline-code.ts",
-          "line": 50
+          "line": 92
         },
         "parameters": [
           {
+            "docs": {
+              "stability": "experimental",
+              "summary": "The inline code to be transformed."
+            },
             "name": "code",
             "type": {
               "primitive": "string"
             }
           },
           {
+            "docs": {
+              "remarks": "Please refer to the esbuild Transform API docs for details. \\\nDefault values for `transformOptions`:\n- `loader='ts'`",
+              "see": "https://esbuild.github.io/api/#transform-api",
+              "stability": "experimental",
+              "summary": "Transform options passed on to esbuild."
+            },
             "name": "transformOptions",
             "optional": true,
             "type": {
@@ -2355,7 +2396,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/inline-code.ts",
-        "line": 49
+        "line": 91
       },
       "name": "InlineTypeScriptCode",
       "symbolId": "src/inline-code:InlineTypeScriptCode"
@@ -2363,16 +2404,18 @@
     "@mrgrain/cdk-esbuild.JavaScriptAsset": {
       "assembly": "@mrgrain/cdk-esbuild",
       "docs": {
-        "stability": "experimental"
+        "remarks": "The asset can be used by other constructs.",
+        "stability": "stable",
+        "summary": "Bundles the entry points and creates a CDK asset which is uploaded to the bootstrapped CDK S3 bucket during deployment."
       },
       "fqn": "@mrgrain/cdk-esbuild.JavaScriptAsset",
       "initializer": {
         "docs": {
-          "stability": "experimental"
+          "stability": "stable"
         },
         "locationInModule": {
           "filename": "src/asset.ts",
-          "line": 28
+          "line": 41
         },
         "parameters": [
           {
@@ -2398,7 +2441,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/asset.ts",
-        "line": 77
+        "line": 94
       },
       "name": "JavaScriptAsset",
       "symbolId": "src/asset:JavaScriptAsset"
@@ -2406,7 +2449,8 @@
     "@mrgrain/cdk-esbuild.JavaScriptCode": {
       "assembly": "@mrgrain/cdk-esbuild",
       "docs": {
-        "stability": "stable"
+        "stability": "stable",
+        "summary": "Represents the deployed JavaScript Code."
       },
       "fqn": "@mrgrain/cdk-esbuild.JavaScriptCode",
       "initializer": {
@@ -2415,10 +2459,15 @@
         },
         "locationInModule": {
           "filename": "src/code.ts",
-          "line": 100
+          "line": 123
         },
         "parameters": [
           {
+            "docs": {
+              "remarks": "E.g. `src/index.ts`.",
+              "stability": "stable",
+              "summary": "A relative path or list or map of relative paths to the entry points of your code from the root of the project."
+            },
             "name": "entryPoints",
             "type": {
               "union": {
@@ -2447,6 +2496,11 @@
             }
           },
           {
+            "docs": {
+              "remarks": "Default values for `props.buildOptions`:\n- `bundle=true`\n- `platform=node`\n- `target=nodeX` with X being the major node version running locally",
+              "stability": "stable",
+              "summary": "Props to change the behavior of the bundler."
+            },
             "name": "props",
             "optional": true,
             "type": {
@@ -2458,7 +2512,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/code.ts",
-        "line": 97
+        "line": 120
       },
       "methods": [
         {
@@ -2467,7 +2521,7 @@
           },
           "locationInModule": {
             "filename": "src/code.ts",
-            "line": 63
+            "line": 73
           },
           "name": "bind",
           "parameters": [
@@ -2486,11 +2540,13 @@
         },
         {
           "docs": {
-            "stability": "stable"
+            "remarks": "Specifically it's required to allow assets to add\nmetadata for tooling like SAM CLI to be able to find their origins.",
+            "stability": "stable",
+            "summary": "Called after the CFN function resource has been created to allow the code class to bind to it."
           },
           "locationInModule": {
             "filename": "src/code.ts",
-            "line": 87
+            "line": 105
           },
           "name": "bindToResource",
           "parameters": [
@@ -2516,9 +2572,24 @@
           "docs": {
             "stability": "stable"
           },
+          "immutable": true,
           "locationInModule": {
             "filename": "src/code.ts",
-            "line": 36
+            "line": 121
+          },
+          "name": "assetClass",
+          "protected": true,
+          "type": {
+            "fqn": "@mrgrain/cdk-esbuild.JavaScriptAsset"
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/code.ts",
+            "line": 41
           },
           "name": "asset",
           "protected": true,
@@ -2537,24 +2608,13 @@
         },
         {
           "docs": {
-            "stability": "stable"
-          },
-          "locationInModule": {
-            "filename": "src/code.ts",
-            "line": 98
-          },
-          "name": "assetClass",
-          "type": {
-            "fqn": "@mrgrain/cdk-esbuild.JavaScriptAsset"
-          }
-        },
-        {
-          "docs": {
-            "stability": "stable"
+            "deprecated": "this value is ignored since inline is now determined based on the the inlineCode field of CodeConfig returned from bind().",
+            "stability": "deprecated",
+            "summary": "Determines whether this Code is inline code or not."
           },
           "locationInModule": {
             "filename": "src/code.ts",
-            "line": 38
+            "line": 48
           },
           "name": "isInline",
           "type": {
@@ -2567,7 +2627,7 @@
           },
           "locationInModule": {
             "filename": "src/code.ts",
-            "line": 34
+            "line": 39
           },
           "name": "props",
           "protected": true,
@@ -2586,14 +2646,34 @@
       },
       "fqn": "@mrgrain/cdk-esbuild.JavaScriptCodeProps",
       "interfaces": [
-        "@mrgrain/cdk-esbuild.AssetBaseProps"
+        "@mrgrain/cdk-esbuild.BundlerProps"
       ],
       "kind": "interface",
       "locationInModule": {
         "filename": "src/code.ts",
-        "line": 21
+        "line": 26
       },
       "name": "JavaScriptCodeProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "As this is a plain string, it can be used in construct IDs in order to enforce creation of a new resource when the content hash has changed.\n\nDefaults to a hash of all files in the resulting bundle.",
+            "stability": "stable",
+            "summary": "A hash of this asset, which is available at construction time."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/asset.ts",
+            "line": 19
+          },
+          "name": "assetHash",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
       "symbolId": "src/code:JavaScriptCodeProps"
     },
     "@mrgrain/cdk-esbuild.JavaScriptSource": {
@@ -2753,7 +2833,7 @@
       },
       "fqn": "@mrgrain/cdk-esbuild.JavaScriptSourceProps",
       "interfaces": [
-        "@mrgrain/cdk-esbuild.AssetBaseProps"
+        "@mrgrain/cdk-esbuild.BundlerProps"
       ],
       "kind": "interface",
       "locationInModule": {
@@ -2761,6 +2841,26 @@
         "line": 11
       },
       "name": "JavaScriptSourceProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "As this is a plain string, it can be used in construct IDs in order to enforce creation of a new resource when the content hash has changed.\n\nDefaults to a hash of all files in the resulting bundle.",
+            "stability": "stable",
+            "summary": "A hash of this asset, which is available at construction time."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/asset.ts",
+            "line": 19
+          },
+          "name": "assetHash",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
       "symbolId": "src/source:JavaScriptSourceProps"
     },
     "@mrgrain/cdk-esbuild.TransformOptions": {
@@ -3264,16 +3364,18 @@
     "@mrgrain/cdk-esbuild.TypeScriptAsset": {
       "assembly": "@mrgrain/cdk-esbuild",
       "docs": {
-        "stability": "experimental"
+        "remarks": "The asset can be used by other constructs.",
+        "stability": "stable",
+        "summary": "Bundles the entry points and creates a CDK asset which is uploaded to the bootstrapped CDK S3 bucket during deployment."
       },
       "fqn": "@mrgrain/cdk-esbuild.TypeScriptAsset",
       "initializer": {
         "docs": {
-          "stability": "experimental"
+          "stability": "stable"
         },
         "locationInModule": {
           "filename": "src/asset.ts",
-          "line": 28
+          "line": 41
         },
         "parameters": [
           {
@@ -3299,7 +3401,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/asset.ts",
-        "line": 82
+        "line": 103
       },
       "name": "TypeScriptAsset",
       "symbolId": "src/asset:TypeScriptAsset"
@@ -3307,7 +3409,8 @@
     "@mrgrain/cdk-esbuild.TypeScriptCode": {
       "assembly": "@mrgrain/cdk-esbuild",
       "docs": {
-        "stability": "stable"
+        "stability": "stable",
+        "summary": "Represents the deployed TypeScript Code."
       },
       "fqn": "@mrgrain/cdk-esbuild.TypeScriptCode",
       "initializer": {
@@ -3316,10 +3419,15 @@
         },
         "locationInModule": {
           "filename": "src/code.ts",
-          "line": 110
+          "line": 155
         },
         "parameters": [
           {
+            "docs": {
+              "remarks": "E.g. `src/index.ts`.",
+              "stability": "stable",
+              "summary": "A relative path or list or map of relative paths to the entry points of your code from the root of the project."
+            },
             "name": "entryPoints",
             "type": {
               "union": {
@@ -3348,6 +3456,11 @@
             }
           },
           {
+            "docs": {
+              "remarks": "Default values for `props.buildOptions`:\n- `bundle=true`\n- `platform=node`\n- `target=nodeX` with X being the major node version running locally",
+              "stability": "stable",
+              "summary": "Props to change the behavior of the bundler."
+            },
             "name": "props",
             "optional": true,
             "type": {
@@ -3359,7 +3472,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/code.ts",
-        "line": 107
+        "line": 152
       },
       "methods": [
         {
@@ -3368,7 +3481,7 @@
           },
           "locationInModule": {
             "filename": "src/code.ts",
-            "line": 63
+            "line": 73
           },
           "name": "bind",
           "parameters": [
@@ -3387,11 +3500,13 @@
         },
         {
           "docs": {
-            "stability": "stable"
+            "remarks": "Specifically it's required to allow assets to add\nmetadata for tooling like SAM CLI to be able to find their origins.",
+            "stability": "stable",
+            "summary": "Called after the CFN function resource has been created to allow the code class to bind to it."
           },
           "locationInModule": {
             "filename": "src/code.ts",
-            "line": 87
+            "line": 105
           },
           "name": "bindToResource",
           "parameters": [
@@ -3417,9 +3532,24 @@
           "docs": {
             "stability": "stable"
           },
+          "immutable": true,
           "locationInModule": {
             "filename": "src/code.ts",
-            "line": 36
+            "line": 153
+          },
+          "name": "assetClass",
+          "protected": true,
+          "type": {
+            "fqn": "@mrgrain/cdk-esbuild.TypeScriptAsset"
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/code.ts",
+            "line": 41
           },
           "name": "asset",
           "protected": true,
@@ -3438,24 +3568,13 @@
         },
         {
           "docs": {
-            "stability": "stable"
-          },
-          "locationInModule": {
-            "filename": "src/code.ts",
-            "line": 108
-          },
-          "name": "assetClass",
-          "type": {
-            "fqn": "@mrgrain/cdk-esbuild.TypeScriptAsset"
-          }
-        },
-        {
-          "docs": {
-            "stability": "stable"
+            "deprecated": "this value is ignored since inline is now determined based on the the inlineCode field of CodeConfig returned from bind().",
+            "stability": "deprecated",
+            "summary": "Determines whether this Code is inline code or not."
           },
           "locationInModule": {
             "filename": "src/code.ts",
-            "line": 38
+            "line": 48
           },
           "name": "isInline",
           "type": {
@@ -3468,7 +3587,7 @@
           },
           "locationInModule": {
             "filename": "src/code.ts",
-            "line": 34
+            "line": 39
           },
           "name": "props",
           "protected": true,
@@ -3487,14 +3606,34 @@
       },
       "fqn": "@mrgrain/cdk-esbuild.TypeScriptCodeProps",
       "interfaces": [
-        "@mrgrain/cdk-esbuild.AssetBaseProps"
+        "@mrgrain/cdk-esbuild.BundlerProps"
       ],
       "kind": "interface",
       "locationInModule": {
         "filename": "src/code.ts",
-        "line": 22
+        "line": 27
       },
       "name": "TypeScriptCodeProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "As this is a plain string, it can be used in construct IDs in order to enforce creation of a new resource when the content hash has changed.\n\nDefaults to a hash of all files in the resulting bundle.",
+            "stability": "stable",
+            "summary": "A hash of this asset, which is available at construction time."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/asset.ts",
+            "line": 19
+          },
+          "name": "assetHash",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
       "symbolId": "src/code:TypeScriptCodeProps"
     },
     "@mrgrain/cdk-esbuild.TypeScriptSource": {
@@ -3654,7 +3793,7 @@
       },
       "fqn": "@mrgrain/cdk-esbuild.TypeScriptSourceProps",
       "interfaces": [
-        "@mrgrain/cdk-esbuild.AssetBaseProps"
+        "@mrgrain/cdk-esbuild.BundlerProps"
       ],
       "kind": "interface",
       "locationInModule": {
@@ -3662,9 +3801,29 @@
         "line": 12
       },
       "name": "TypeScriptSourceProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "As this is a plain string, it can be used in construct IDs in order to enforce creation of a new resource when the content hash has changed.\n\nDefaults to a hash of all files in the resulting bundle.",
+            "stability": "stable",
+            "summary": "A hash of this asset, which is available at construction time."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/asset.ts",
+            "line": 19
+          },
+          "name": "assetHash",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
       "symbolId": "src/source:TypeScriptSourceProps"
     }
   },
-  "version": "2.0.0-alpha.4",
-  "fingerprint": "CIyrJ3R/XLnOmmNNYeZ/hT8G9cfZba4v+Kp1GzpeW6c="
+  "version": "2.0.0-alpha.5",
+  "fingerprint": "AdL6hJY8jZk+fh5n+ST+KSygY3qF3N0pEjQ75LE0OcQ="
 }