cdk-serverless 2.0.1 → 2.0.3

package/docs/projen/assets/style.css

@@ -51,13 +51,13 @@
     --dark-color-text-aside: #dddddd;
     --dark-color-link: #00aff4;
 
-    --dark-color-ts-project: #e14dff;
+    --dark-color-ts-project: #e358ff;
     --dark-color-ts-module: var(--dark-color-ts-project);
     --dark-color-ts-namespace: var(--dark-color-ts-project);
     --dark-color-ts-enum: #f4d93e;
     --dark-color-ts-enum-member: var(--dark-color-ts-enum);
     --dark-color-ts-variable: #798dff;
-    --dark-color-ts-function: #9772ff;
+    --dark-color-ts-function: #a280ff;
     --dark-color-ts-class: #8ac4ff;
     --dark-color-ts-interface: #6cff87;
     --dark-color-ts-constructor: var(--dark-color-ts-class);
@@ -262,6 +262,16 @@ h6 {
     line-height: 1.2;
 }
 
+h1 > a,
+h2 > a,
+h3 > a,
+h4 > a,
+h5 > a,
+h6 > a {
+    text-decoration: none;
+    color: var(--color-text);
+}
+
 h1 {
     font-size: 1.875rem;
     margin: 0.67rem 0;
@@ -296,12 +306,6 @@ h6 {
     text-transform: uppercase;
 }
 
-pre {
-    white-space: pre;
-    white-space: pre-wrap;
-    word-wrap: break-word;
-}
-
 dl,
 menu,
 ol,
@@ -426,13 +430,29 @@ pre {
 }
 
 pre {
+    position: relative;
+    white-space: pre;
+    white-space: pre-wrap;
+    word-wrap: break-word;
     padding: 10px;
-    border: 0.1em solid var(--color-accent);
+    border: 1px solid var(--color-accent);
 }
 pre code {
     padding: 0;
     font-size: 100%;
 }
+pre > button {
+    position: absolute;
+    top: 10px;
+    right: 10px;
+    opacity: 0;
+    transition: opacity 0.1s;
+    box-sizing: border-box;
+}
+pre:hover > button,
+pre > button.visible {
+    opacity: 1;
+}
 
 blockquote {
     margin: 1em 0;
@@ -676,7 +696,12 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
 .tsd-navigation.settings {
     margin: 1rem 0;
 }
+.tsd-navigation > a,
+.tsd-navigation .tsd-accordion-summary {
+    width: calc(100% - 0.5rem);
+}
 .tsd-navigation a,
+.tsd-navigation summary > span,
 .tsd-page-navigation a {
     display: inline-flex;
     align-items: center;
@@ -685,14 +710,6 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
     text-decoration: none;
     box-sizing: border-box;
 }
-.tsd-navigation a {
-    /* why 3rem? No idea, but it seems to work. */
-    width: calc(100% - 3rem);
-}
-.tsd-page-navigation a {
-    /* why is this different? */
-    width: 100%;
-}
 .tsd-navigation a.current,
 .tsd-page-navigation a.current {
     background: var(--color-active-menu-item);
@@ -703,7 +720,8 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
 }
 .tsd-navigation ul,
 .tsd-page-navigation ul {
-    margin: 0;
+    margin-top: 0;
+    margin-bottom: 0;
     padding: 0;
     list-style: none;
 }
@@ -712,18 +730,24 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
     padding: 0;
     max-width: 100%;
 }
-.tsd-nested-navigation > li > a {
+.tsd-nested-navigation {
     margin-left: 3rem;
 }
 .tsd-nested-navigation > li > details {
-    margin-left: 1.5rem;
+    margin-left: -1.5rem;
 }
-.tsd-small-nested-navigation > li > a {
+.tsd-small-nested-navigation {
     margin-left: 1.5rem;
 }
 .tsd-small-nested-navigation > li > details {
-    margin-left: 0;
+    margin-left: -1.5rem;
+}
+
+.tsd-nested-navigation > li > a,
+.tsd-nested-navigation > li > span {
+    width: calc(100% - 1.75rem - 0.5rem);
 }
+
 .tsd-page-navigation ul {
     padding-left: 1.75rem;
 }
@@ -745,6 +769,11 @@ a.tsd-index-link {
     align-items: center;
     color: var(--color-text);
 }
+.tsd-accordion-summary {
+    list-style-type: none;
+    display: flex;
+    align-items: center;
+}
 .tsd-accordion-summary,
 .tsd-accordion-summary a {
     user-select: none;
@@ -752,21 +781,19 @@ a.tsd-index-link {
     -webkit-user-select: none;
     -ms-user-select: none;
 
-    display: flex;
-    align-items: center;
     cursor: pointer;
 }
+.tsd-accordion-summary a {
+    flex-grow: 1;
+}
 .tsd-accordion-summary > * {
     margin-top: 0;
     margin-bottom: 0;
     padding-top: 0;
     padding-bottom: 0;
 }
-.tsd-accordion-summary::-webkit-details-marker {
-    display: none;
-}
-.tsd-index-accordion .tsd-accordion-summary svg {
-    margin-right: 0.25rem;
+.tsd-index-accordion .tsd-accordion-summary > svg {
+    margin-left: 0.25rem;
 }
 .tsd-index-content > :not(:first-child) {
     margin-top: 0.75rem;

package/docs/projen/classes/ServerlessProject.html

@@ -952,8 +952,6 @@ repository statistics and language breakdown.</p>
 <li class="tsd-signature tsd-anchor-link" id="removeTask.removeTask-1"><span class="tsd-kind-call-signature">remove<wbr/>Task</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Task</span><a href="#removeTask.removeTask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
 <li class="tsd-description">
 <div class="tsd-comment tsd-typography"><p>Removes a task from a project.</p>
-
-<h3>Returns</h3><p>The <code>Task</code> that was removed, otherwise <code>undefined</code>.</p>
 </div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
@@ -962,7 +960,8 @@ repository statistics and language breakdown.</p>
 <h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
 <div class="tsd-comment tsd-typography"><p>The name of the task to remove.</p>
 </div></li></ul></div>
-<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Task</span></h4><aside class="tsd-sources">
+<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Task</span></h4><p>The <code>Task</code> that was removed, otherwise <code>undefined</code>.</p>
+<aside class="tsd-sources">
 <p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.removeTask</p></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="renderWorkflowSetup" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>render<wbr/>Workflow<wbr/>Setup</span><a href="#renderWorkflowSetup" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
@@ -971,8 +970,6 @@ repository statistics and language breakdown.</p>
 <li class="tsd-description">
 <div class="tsd-comment tsd-typography"><p>Returns the set of workflow steps which should be executed to bootstrap a
 workflow.</p>
-
-<h3>Returns</h3><p>Job steps</p>
 </div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
@@ -981,7 +978,8 @@ workflow.</p>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">RenderWorkflowSetupOptions</span></h5>
 <div class="tsd-comment tsd-typography"><p>Options.</p>
 </div></li></ul></div>
-<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">JobStep</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
+<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">JobStep</span><span class="tsd-signature-symbol">[]</span></h4><p>Job steps</p>
+<aside class="tsd-sources">
 <p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.renderWorkflowSetup</p></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="runTaskCommand" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>run<wbr/>Task<wbr/>Command</span><a href="#runTaskCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
@@ -1044,8 +1042,6 @@ typically be <code>npx projen TASK</code>.</p>
 <li class="tsd-description">
 <div class="tsd-comment tsd-typography"><p>Finds a file at the specified relative path within this project and all
 its subprojects.</p>
-
-<h3>Returns</h3><p>a <code>FileBase</code> or undefined if there is no file in that path</p>
 </div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
@@ -1055,7 +1051,8 @@ its subprojects.</p>
 <div class="tsd-comment tsd-typography"><p>The file path. If this path is relative, it will be resolved
 from the root of <em>this</em> project.</p>
 </div></li></ul></div>
-<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">FileBase</span></h4><aside class="tsd-sources">
+<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">FileBase</span></h4><p>a <code>FileBase</code> or undefined if there is no file in that path</p>
+<aside class="tsd-sources">
 <p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tryFindFile</p></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="tryFindJsonFile" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>try<wbr/>Find<wbr/>Json<wbr/>File</span><a href="#tryFindJsonFile" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
@@ -1098,9 +1095,6 @@ from the root of <em>this</em> project.</p>
 <li class="tsd-description">
 <div class="tsd-comment tsd-typography"><p>Finds a file at the specified relative path within this project and removes
 it.</p>
-
-<h3>Returns</h3><p>a <code>FileBase</code> if the file was found and removed, or undefined if
-the file was not found.</p>
 </div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
@@ -1110,7 +1104,9 @@ the file was not found.</p>
 <div class="tsd-comment tsd-typography"><p>The file path. If this path is relative, it will be
 resolved from the root of <em>this</em> project.</p>
 </div></li></ul></div>
-<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">FileBase</span></h4><aside class="tsd-sources">
+<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">FileBase</span></h4><p>a <code>FileBase</code> if the file was found and removed, or undefined if
+the file was not found.</p>
+<aside class="tsd-sources">
 <p>Inherited from pj.awscdk.AwsCdkTypeScriptApp.tryRemoveFile</p></aside></li></ul></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">

package/docs/projen/index.html

@@ -12,9 +12,9 @@
 <div class="col-content">
 <div class="tsd-page-title">
 <h2>cdk-serverless</h2></div>
-<div class="tsd-panel tsd-typography"><a id="md:cdk-serverless" class="tsd-anchor"></a><h1><a href="#$cdk-serverless" style="color:inherit;text-decoration:none">CDK Serverless</a></h1><p><a href="https://badge.fury.io/js/cdk-serverless"><img src="https://badge.fury.io/js/cdk-serverless.svg" alt="npm version"></a></p>
+<div class="tsd-panel tsd-typography"><a id="md:cdk-serverless" class="tsd-anchor"></a><h1><a href="#md:cdk-serverless">CDK Serverless</a></h1><p><a href="https://badge.fury.io/js/cdk-serverless"><img src="https://badge.fury.io/js/cdk-serverless.svg" alt="npm version"></a></p>
 <p>CDK Serverless is a tool suite to facilitate the use of the AWS Cloud Development Kit (CDK) in serverless architectures. It provides project management features to configure your TypeScript CDK app and also higher-level (L3) constructs for different APIs and resources needed for serverless applications. Additionally, it leverages utility libraries to write Lambda functions and do live updates to Lambda function code during development.</p>
-<a id="md:features" class="tsd-anchor"></a><h3><a href="#$features" style="color:inherit;text-decoration:none">Features</a></h3><ul>
+<a id="md:features" class="tsd-anchor"></a><h3><a href="#md:features">Features</a></h3><ul>
 <li>Projen helper classes to configure certain use cases easily</li>
 <li>AWS CDK L3-construct for RestApi and GraphQlApi</li>
 <li>Zero-config for Lambda functions and VTL templates</li>
@@ -25,37 +25,37 @@
 <li>Fully typed auto-completion for routes, resolvers, etc.</li>
 </ul>
 <p>Video about the idea behind it: <a href="https://www.youtube.com/watch?v=k5L8U39_16k">https://www.youtube.com/watch?v=k5L8U39_16k</a></p>
-<a id="md:quick-start" class="tsd-anchor"></a><h2><a href="#$quick-start" style="color:inherit;text-decoration:none">Quick Start</a></h2><p>To start a new project we recommend using projen. To use CDK Serverless you can create any projen CDK Typescript app and then add the appropriate aspect provided by this toolkit.</p>
+<a id="md:quick-start" class="tsd-anchor"></a><h2><a href="#md:quick-start">Quick Start</a></h2><p>To start a new project we recommend using projen. To use CDK Serverless you can create any projen CDK Typescript app and then add the appropriate aspect provided by this toolkit.</p>
 <pre><code class="language-bash"><span class="hl-0">$ </span><span class="hl-1">npx</span><span class="hl-0"> </span><span class="hl-1">projen</span><span class="hl-0"> </span><span class="hl-1">new</span><span class="hl-0"> </span><span class="hl-1">awscdk-app-ts</span>
-</code></pre>
+</code><button>Copy</button></pre>
 <p>Adding CDK Serverless is a two step process:</p>
 <ol>
 <li>Add &#39;cdk-serverless&#39; as a dependency to your project</li>
 <li>Run <code>npx projen</code> to install it</li>
 </ol>
-<a id="md:contribute" class="tsd-anchor"></a><h2><a href="#$contribute" style="color:inherit;text-decoration:none">Contribute</a></h2><a id="md:how-to-contribute-to-cdk-serverless" class="tsd-anchor"></a><h3><a href="#$how-to-contribute-to-cdk-serverless" style="color:inherit;text-decoration:none">How to contribute to CDK Serverless</a></h3><a id="md:did-you-find-a-bug" class="tsd-anchor"></a><h4><a href="#$did-you-find-a-bug" style="color:inherit;text-decoration:none"><strong>Did you find a bug?</strong></a></h4><ul>
+<a id="md:contribute" class="tsd-anchor"></a><h2><a href="#md:contribute">Contribute</a></h2><a id="md:how-to-contribute-to-cdk-serverless" class="tsd-anchor"></a><h3><a href="#md:how-to-contribute-to-cdk-serverless">How to contribute to CDK Serverless</a></h3><a id="md:did-you-find-a-bug" class="tsd-anchor"></a><h4><a href="#md:did-you-find-a-bug"><strong>Did you find a bug?</strong></a></h4><ul>
 <li><p><strong>Ensure the bug was not already reported</strong> by searching on GitHub under <a href="https://github.com/taimos/cdk-serverless/issues">Issues</a>.</p>
 </li>
 <li><p>If you&#39;re unable to find an open issue addressing the problem, <a href="https://github.com/taimos/cdk-serverless/issues/new">open a new one</a>. Be sure to include a <strong>title and clear description</strong>, as much relevant information as possible, and a <strong>code sample</strong> or an <strong>executable test case</strong> demonstrating the expected behavior that is not occurring.</p>
 </li>
 </ul>
-<a id="md:did-you-write-a-patch-that-fixes-a-bug" class="tsd-anchor"></a><h4><a href="#$did-you-write-a-patch-that-fixes-a-bug" style="color:inherit;text-decoration:none"><strong>Did you write a patch that fixes a bug?</strong></a></h4><ul>
+<a id="md:did-you-write-a-patch-that-fixes-a-bug" class="tsd-anchor"></a><h4><a href="#md:did-you-write-a-patch-that-fixes-a-bug"><strong>Did you write a patch that fixes a bug?</strong></a></h4><ul>
 <li><p>Open a new GitHub pull request with the patch.</p>
 </li>
 <li><p>Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.</p>
 </li>
 </ul>
-<a id="md:did-you-fix-whitespace-format-code-or-make-a-purely-cosmetic-patch" class="tsd-anchor"></a><h4><a href="#$did-you-fix-whitespace-format-code-or-make-a-purely-cosmetic-patch" style="color:inherit;text-decoration:none"><strong>Did you fix whitespace, format code, or make a purely cosmetic patch?</strong></a></h4><p>Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability will normally not be accepted.</p>
-<a id="md:do-you-intend-to-add-a-new-feature-or-change-an-existing-one" class="tsd-anchor"></a><h4><a href="#$do-you-intend-to-add-a-new-feature-or-change-an-existing-one" style="color:inherit;text-decoration:none"><strong>Do you intend to add a new feature or change an existing one?</strong></a></h4><ul>
+<a id="md:did-you-fix-whitespace-format-code-or-make-a-purely-cosmetic-patch" class="tsd-anchor"></a><h4><a href="#md:did-you-fix-whitespace-format-code-or-make-a-purely-cosmetic-patch"><strong>Did you fix whitespace, format code, or make a purely cosmetic patch?</strong></a></h4><p>Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability will normally not be accepted.</p>
+<a id="md:do-you-intend-to-add-a-new-feature-or-change-an-existing-one" class="tsd-anchor"></a><h4><a href="#md:do-you-intend-to-add-a-new-feature-or-change-an-existing-one"><strong>Do you intend to add a new feature or change an existing one?</strong></a></h4><ul>
 <li><p>Suggest your change under <a href="https://github.com/taimos/cdk-serverless/issues">Issues</a>.</p>
 </li>
 <li><p>Do not open a pull request on GitHub until you have collected positive feedback about the change.</p>
 </li>
 </ul>
-<a id="md:do-you-want-to-contribute-to-the-cdk-serverless-documentation" class="tsd-anchor"></a><h4><a href="#$do-you-want-to-contribute-to-the-cdk-serverless-documentation" style="color:inherit;text-decoration:none"><strong>Do you want to contribute to the CDK Serverless documentation?</strong></a></h4><ul>
+<a id="md:do-you-want-to-contribute-to-the-cdk-serverless-documentation" class="tsd-anchor"></a><h4><a href="#md:do-you-want-to-contribute-to-the-cdk-serverless-documentation"><strong>Do you want to contribute to the CDK Serverless documentation?</strong></a></h4><ul>
 <li>Just file a PR with your recommended changes</li>
 </ul>
-<a id="md:authors" class="tsd-anchor"></a><h2><a href="#$authors" style="color:inherit;text-decoration:none">Authors</a></h2><p>Brought to you by <a href="https://taimos.de">Taimos</a></p>
+<a id="md:authors" class="tsd-anchor"></a><h2><a href="#md:authors">Authors</a></h2><p>Brought to you by <a href="https://taimos.de">Taimos</a></p>
 </div></div>
 <div class="col-sidebar">
 <div class="page-menu">